3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Dov Feldstern
9 * \author Jean-Marc Lasgouttes
11 * \author André Pönitz
12 * \author Stefan Schimanski
14 * \author Jürgen Vigna
16 * Full author contact details are available in file CREDITS.
25 #include "buffer_funcs.h"
26 #include "BufferParams.h"
27 #include "BufferView.h"
29 #include "CompletionList.h"
31 #include "CutAndPaste.h"
32 #include "DispatchResult.h"
34 #include "ErrorList.h"
35 #include "FuncRequest.h"
41 #include "Paragraph.h"
42 #include "paragraph_funcs.h"
43 #include "ParagraphParameters.h"
44 #include "ParIterator.h"
45 #include "TextClass.h"
46 #include "TextMetrics.h"
48 #include "WordLangTuple.h"
51 #include "insets/InsetText.h"
52 #include "insets/InsetBibitem.h"
53 #include "insets/InsetCaption.h"
54 #include "insets/InsetLine.h"
55 #include "insets/InsetNewline.h"
56 #include "insets/InsetNewpage.h"
57 #include "insets/InsetOptArg.h"
58 #include "insets/InsetSpace.h"
59 #include "insets/InsetSpecialChar.h"
60 #include "insets/InsetTabular.h"
62 #include "support/lassert.h"
63 #include "support/convert.h"
64 #include "support/debug.h"
65 #include "support/docstream.h"
66 #include "support/gettext.h"
67 #include "support/lstrings.h"
68 #include "support/textutils.h"
70 #include <boost/next_prior.hpp>
75 using namespace lyx::support;
79 using cap::cutSelection;
80 using cap::pasteParagraphList;
84 void readParToken(Buffer const & buf, Paragraph & par, Lexer & lex,
85 string const & token, Font & font, Change & change, ErrorList & errorList)
87 BufferParams const & bp = buf.params();
89 if (token[0] != '\\') {
90 docstring dstr = lex.getDocString();
91 par.appendString(dstr, font, change);
93 } else if (token == "\\begin_layout") {
95 docstring layoutname = lex.getDocString();
97 font = Font(inherit_font, bp.language);
98 change = Change(Change::UNCHANGED);
100 DocumentClass const & tclass = bp.documentClass();
102 if (layoutname.empty())
103 layoutname = tclass.defaultLayoutName();
105 if (par.forceEmptyLayout()) {
106 // in this case only the empty layout is allowed
107 layoutname = tclass.emptyLayoutName();
108 } else if (par.useEmptyLayout()) {
109 // in this case, default layout maps to empty layout
110 if (layoutname == tclass.defaultLayoutName())
111 layoutname = tclass.emptyLayoutName();
113 // otherwise, the empty layout maps to the default
114 if (layoutname == tclass.emptyLayoutName())
115 layoutname = tclass.defaultLayoutName();
118 bool hasLayout = tclass.hasLayout(layoutname);
121 errorList.push_back(ErrorItem(_("Unknown layout"),
122 bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
123 layoutname, from_utf8(tclass.name())), par.id(), 0, par.size()));
124 layoutname = par.useEmptyLayout() ?
125 tclass.emptyLayoutName() :
126 tclass.defaultLayoutName();
129 par.setLayout(bp.documentClass()[layoutname]);
131 // Test whether the layout is obsolete.
132 Layout const & layout = par.layout();
133 if (!layout.obsoleted_by().empty())
134 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
136 par.params().read(lex);
138 } else if (token == "\\end_layout") {
139 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
140 << "Missing \\begin_layout ?");
141 } else if (token == "\\end_inset") {
142 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
143 << "Missing \\begin_inset ?");
144 } else if (token == "\\begin_inset") {
145 Inset * inset = readInset(lex, buf);
147 par.insertInset(par.size(), inset, font, change);
150 docstring line = lex.getDocString();
151 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
152 par.id(), 0, par.size()));
154 } else if (token == "\\family") {
156 setLyXFamily(lex.getString(), font.fontInfo());
157 } else if (token == "\\series") {
159 setLyXSeries(lex.getString(), font.fontInfo());
160 } else if (token == "\\shape") {
162 setLyXShape(lex.getString(), font.fontInfo());
163 } else if (token == "\\size") {
165 setLyXSize(lex.getString(), font.fontInfo());
166 } else if (token == "\\lang") {
168 string const tok = lex.getString();
169 Language const * lang = languages.getLanguage(tok);
171 font.setLanguage(lang);
173 font.setLanguage(bp.language);
174 lex.printError("Unknown language `$$Token'");
176 } else if (token == "\\numeric") {
178 font.fontInfo().setNumber(font.setLyXMisc(lex.getString()));
179 } else if (token == "\\emph") {
181 font.fontInfo().setEmph(font.setLyXMisc(lex.getString()));
182 } else if (token == "\\bar") {
184 string const tok = lex.getString();
187 font.fontInfo().setUnderbar(FONT_ON);
188 else if (tok == "no")
189 font.fontInfo().setUnderbar(FONT_OFF);
190 else if (tok == "default")
191 font.fontInfo().setUnderbar(FONT_INHERIT);
193 lex.printError("Unknown bar font flag "
195 } else if (token == "\\noun") {
197 font.fontInfo().setNoun(font.setLyXMisc(lex.getString()));
198 } else if (token == "\\color") {
200 setLyXColor(lex.getString(), font.fontInfo());
201 } else if (token == "\\SpecialChar") {
202 auto_ptr<Inset> inset;
203 inset.reset(new InsetSpecialChar);
205 par.insertInset(par.size(), inset.release(),
207 } else if (token == "\\backslash") {
208 par.appendChar('\\', font, change);
209 } else if (token == "\\LyXTable") {
210 auto_ptr<Inset> inset(new InsetTabular(buf));
212 par.insertInset(par.size(), inset.release(), font, change);
213 } else if (token == "\\lyxline") {
214 par.insertInset(par.size(), new InsetLine, font, change);
215 } else if (token == "\\change_unchanged") {
216 change = Change(Change::UNCHANGED);
217 } else if (token == "\\change_inserted") {
219 istringstream is(lex.getString());
223 if (aid >= bp.author_map.size()) {
224 errorList.push_back(ErrorItem(_("Change tracking error"),
225 bformat(_("Unknown author index for insertion: %1$d\n"), aid),
226 par.id(), 0, par.size()));
227 change = Change(Change::UNCHANGED);
229 change = Change(Change::INSERTED, bp.author_map[aid], ct);
230 } else if (token == "\\change_deleted") {
232 istringstream is(lex.getString());
236 if (aid >= bp.author_map.size()) {
237 errorList.push_back(ErrorItem(_("Change tracking error"),
238 bformat(_("Unknown author index for deletion: %1$d\n"), aid),
239 par.id(), 0, par.size()));
240 change = Change(Change::UNCHANGED);
242 change = Change(Change::DELETED, bp.author_map[aid], ct);
245 errorList.push_back(ErrorItem(_("Unknown token"),
246 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
248 par.id(), 0, par.size()));
253 void readParagraph(Buffer const & buf, Paragraph & par, Lexer & lex,
254 ErrorList & errorList)
257 string token = lex.getString();
259 Change change(Change::UNCHANGED);
262 readParToken(buf, par, lex, token, font, change, errorList);
265 token = lex.getString();
270 if (token == "\\end_layout") {
271 //Ok, paragraph finished
275 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
276 if (token == "\\begin_layout" || token == "\\end_document"
277 || token == "\\end_inset" || token == "\\begin_deeper"
278 || token == "\\end_deeper") {
279 lex.pushToken(token);
280 lyxerr << "Paragraph ended in line "
281 << lex.lineNumber() << "\n"
282 << "Missing \\end_layout.\n";
286 // Final change goes to paragraph break:
287 par.setChange(par.size(), change);
289 // Initialize begin_of_body_ on load; redoParagraph maintains
290 par.setBeginOfBody();
296 class TextCompletionList : public CompletionList
300 TextCompletionList(Cursor const & cur)
301 : buf_(cur.buffer()), pos_(0) {}
303 virtual ~TextCompletionList() {}
306 virtual bool sorted() const { return true; }
308 virtual size_t size() const
310 return theWordList().size();
313 virtual docstring const & data(size_t idx) const
315 return theWordList().word(idx);
326 bool Text::empty() const
328 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
329 // FIXME: Should we consider the labeled type as empty too?
330 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
334 double Text::spacing(Buffer const & buffer, Paragraph const & par) const
336 if (par.params().spacing().isDefault())
337 return buffer.params().spacing().getValue();
338 return par.params().spacing().getValue();
342 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
344 LASSERT(this == cur.text(), /**/);
346 Paragraph & cpar = cur.paragraph();
347 pit_type cpit = cur.pit();
349 DocumentClass const & tclass = cur.buffer().params().documentClass();
350 Layout const & layout = cpar.layout();
352 // this is only allowed, if the current paragraph is not empty
353 // or caption and if it has not the keepempty flag active
354 if (cur.lastpos() == 0 && !cpar.allowEmpty() &&
355 layout.labeltype != LABEL_SENSITIVE)
358 // a layout change may affect also the following paragraph
359 recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
361 // Always break behind a space
362 // It is better to erase the space (Dekel)
363 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
364 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
366 // What should the layout for the new paragraph be?
367 bool keep_layout = inverse_logic ?
368 !layout.isEnvironment()
369 : layout.isEnvironment();
371 // We need to remember this before we break the paragraph, because
372 // that invalidates the layout variable
373 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
375 // we need to set this before we insert the paragraph.
376 bool const isempty = cpar.allowEmpty() && cpar.empty();
378 lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
379 cur.pos(), keep_layout);
381 // After this, neither paragraph contains any rows!
384 pit_type next_par = cpit + 1;
386 // well this is the caption hack since one caption is really enough
389 // set to standard-layout
390 //FIXME Check if this should be emptyLayout() in some cases
391 pars_[cpit].applyLayout(tclass.defaultLayout());
393 // set to standard-layout
394 //FIXME Check if this should be emptyLayout() in some cases
395 pars_[next_par].applyLayout(tclass.defaultLayout());
398 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
399 if (!pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges))
400 break; // the character couldn't be deleted physically due to change tracking
403 updateLabels(cur.buffer());
405 // A singlePar update is not enough in this case.
406 cur.updateFlags(Update::Force);
408 // This check is necessary. Otherwise the new empty paragraph will
409 // be deleted automatically. And it is more friendly for the user!
410 if (cur.pos() != 0 || isempty)
411 setCursor(cur, cur.pit() + 1, 0);
413 setCursor(cur, cur.pit(), 0);
417 // insert a character, moves all the following breaks in the
418 // same Paragraph one to the right and make a rebreak
419 void Text::insertChar(Cursor & cur, char_type c)
421 LASSERT(this == cur.text(), /**/);
423 cur.recordUndo(INSERT_UNDO);
425 TextMetrics const & tm = cur.bv().textMetrics(this);
426 Buffer const & buffer = cur.buffer();
427 Paragraph & par = cur.paragraph();
428 // try to remove this
429 pit_type const pit = cur.pit();
431 bool const freeSpacing = par.layout().free_spacing ||
434 if (lyxrc.auto_number) {
435 static docstring const number_operators = from_ascii("+-/*");
436 static docstring const number_unary_operators = from_ascii("+-");
437 static docstring const number_seperators = from_ascii(".,:");
439 if (cur.current_font.fontInfo().number() == FONT_ON) {
440 if (!isDigit(c) && !contains(number_operators, c) &&
441 !(contains(number_seperators, c) &&
443 cur.pos() != cur.lastpos() &&
444 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
445 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
447 number(cur); // Set current_font.number to OFF
448 } else if (isDigit(c) &&
449 cur.real_current_font.isVisibleRightToLeft()) {
450 number(cur); // Set current_font.number to ON
452 if (cur.pos() != 0) {
453 char_type const c = par.getChar(cur.pos() - 1);
454 if (contains(number_unary_operators, c) &&
456 || par.isSeparator(cur.pos() - 2)
457 || par.isNewline(cur.pos() - 2))
459 setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
461 } else if (contains(number_seperators, c)
463 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
464 setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
471 // In Bidi text, we want spaces to be treated in a special way: spaces
472 // which are between words in different languages should get the
473 // paragraph's language; otherwise, spaces should keep the language
474 // they were originally typed in. This is only in effect while typing;
475 // after the text is already typed in, the user can always go back and
476 // explicitly set the language of a space as desired. But 99.9% of the
477 // time, what we're doing here is what the user actually meant.
479 // The following cases are the ones in which the language of the space
480 // should be changed to match that of the containing paragraph. In the
481 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
482 // represents a space, pipe (|) represents the cursor position (so the
483 // character before it is the one just typed in). The different cases
484 // are depicted logically (not visually), from left to right:
489 // Theoretically, there are other situations that we should, perhaps, deal
490 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
491 // point (to understand why, just try to create this situation...).
493 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
494 // get font in front and behind the space in question. But do NOT
495 // use getFont(cur.pos()) because the character c is not inserted yet
496 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
497 Font const & post_space_font = cur.real_current_font;
498 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
499 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
501 if (pre_space_rtl != post_space_rtl) {
502 // Set the space's language to match the language of the
503 // adjacent character whose direction is the paragraph's
504 // direction; don't touch other properties of the font
505 Language const * lang =
506 (pre_space_rtl == par.isRTL(buffer.params())) ?
507 pre_space_font.language() : post_space_font.language();
509 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
510 space_font.setLanguage(lang);
511 par.setFont(cur.pos() - 1, space_font);
515 // Next check, if there will be two blanks together or a blank at
516 // the beginning of a paragraph.
517 // I decided to handle blanks like normal characters, the main
518 // difference are the special checks when calculating the row.fill
519 // (blank does not count at the end of a row) and the check here
521 // When the free-spacing option is set for the current layout,
522 // disable the double-space checking
523 if (!freeSpacing && isLineSeparatorChar(c)) {
524 if (cur.pos() == 0) {
525 static bool sent_space_message = false;
526 if (!sent_space_message) {
527 cur.message(_("You cannot insert a space at the "
528 "beginning of a paragraph. Please read the Tutorial."));
529 sent_space_message = true;
533 LASSERT(cur.pos() > 0, /**/);
534 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
535 && !par.isDeleted(cur.pos() - 1)) {
536 static bool sent_space_message = false;
537 if (!sent_space_message) {
538 cur.message(_("You cannot type two spaces this way. "
539 "Please read the Tutorial."));
540 sent_space_message = true;
546 par.insertChar(cur.pos(), c, cur.current_font, cur.buffer().params().trackChanges);
547 cur.checkBufferStructure();
549 // cur.updateFlags(Update::Force);
550 setCursor(cur.top(), cur.pit(), cur.pos() + 1);
555 void Text::charInserted(Cursor & cur)
557 Paragraph & par = cur.paragraph();
559 // Here we call finishUndo for every 20 characters inserted.
560 // This is from my experience how emacs does it. (Lgb)
561 static unsigned int counter;
569 // register word if a non-letter was entered
571 && par.isLetter(cur.pos() - 2)
572 && !par.isLetter(cur.pos() - 1)) {
573 // get the word in front of cursor
574 LASSERT(this == cur.text(), /**/);
575 cur.paragraph().updateWords(cur.top());
580 // the cursor set functions have a special mechanism. When they
581 // realize, that you left an empty paragraph, they will delete it.
583 bool Text::cursorForwardOneWord(Cursor & cur)
585 LASSERT(this == cur.text(), /**/);
587 pos_type const lastpos = cur.lastpos();
588 pit_type pit = cur.pit();
589 pos_type pos = cur.pos();
590 Paragraph const & par = cur.paragraph();
592 // Paragraph boundary is a word boundary
593 if (pos == lastpos) {
594 if (pit != cur.lastpit())
595 return setCursor(cur, pit + 1, 0);
600 if (lyxrc.mac_like_word_movement) {
601 // Skip through trailing punctuation and spaces.
602 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
605 // Skip over either a non-char inset or a full word
606 if (pos != lastpos && !par.isLetter(pos))
608 else while (pos != lastpos && par.isLetter(pos))
611 LASSERT(pos < lastpos, /**/); // see above
612 if (par.isLetter(pos))
613 while (pos != lastpos && par.isLetter(pos))
615 else if (par.isChar(pos))
616 while (pos != lastpos && par.isChar(pos))
618 else if (!par.isSpace(pos)) // non-char inset
621 // Skip over white space
622 while (pos != lastpos && par.isSpace(pos))
626 return setCursor(cur, pit, pos);
630 bool Text::cursorBackwardOneWord(Cursor & cur)
632 LASSERT(this == cur.text(), /**/);
634 pit_type pit = cur.pit();
635 pos_type pos = cur.pos();
636 Paragraph & par = cur.paragraph();
638 // Paragraph boundary is a word boundary
639 if (pos == 0 && pit != 0)
640 return setCursor(cur, pit - 1, getPar(pit - 1).size());
642 if (lyxrc.mac_like_word_movement) {
643 // Skip through punctuation and spaces.
644 while (pos != 0 && (par.isChar(pos - 1) || par.isSpace(pos - 1)))
647 // Skip over either a non-char inset or a full word
648 if (pos != 0 && !par.isLetter(pos - 1) && !par.isChar(pos - 1))
650 else while (pos != 0 && par.isLetter(pos - 1))
653 // Skip over white space
654 while (pos != 0 && par.isSpace(pos - 1))
657 if (pos != 0 && par.isLetter(pos - 1))
658 while (pos != 0 && par.isLetter(pos - 1))
660 else if (pos != 0 && par.isChar(pos - 1))
661 while (pos != 0 && par.isChar(pos - 1))
663 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
667 return setCursor(cur, pit, pos);
671 bool Text::cursorVisLeftOneWord(Cursor & cur)
673 LASSERT(this == cur.text(), /**/);
675 pos_type left_pos, right_pos;
676 bool left_is_letter, right_is_letter;
678 Cursor temp_cur = cur;
680 // always try to move at least once...
681 while (temp_cur.posVisLeft(true /* skip_inset */)) {
683 // collect some information about current cursor position
684 temp_cur.getSurroundingPos(left_pos, right_pos);
686 (left_pos > -1 ? temp_cur.paragraph().isLetter(left_pos) : false);
688 (right_pos > -1 ? temp_cur.paragraph().isLetter(right_pos) : false);
690 // if we're not at a letter/non-letter boundary, continue moving
691 if (left_is_letter == right_is_letter)
694 // we should stop when we have an LTR word on our right or an RTL word
696 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
697 temp_cur.bv().buffer().params(),
698 left_pos).isRightToLeft())
699 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
700 temp_cur.bv().buffer().params(),
701 right_pos).isRightToLeft()))
705 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
706 true, temp_cur.boundary());
710 bool Text::cursorVisRightOneWord(Cursor & cur)
712 LASSERT(this == cur.text(), /**/);
714 pos_type left_pos, right_pos;
715 bool left_is_letter, right_is_letter;
717 Cursor temp_cur = cur;
719 // always try to move at least once...
720 while (temp_cur.posVisRight(true /* skip_inset */)) {
722 // collect some information about current cursor position
723 temp_cur.getSurroundingPos(left_pos, right_pos);
725 (left_pos > -1 ? temp_cur.paragraph().isLetter(left_pos) : false);
727 (right_pos > -1 ? temp_cur.paragraph().isLetter(right_pos) : false);
729 // if we're not at a letter/non-letter boundary, continue moving
730 if (left_is_letter == right_is_letter)
733 // we should stop when we have an LTR word on our right or an RTL word
735 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
736 temp_cur.bv().buffer().params(),
737 left_pos).isRightToLeft())
738 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
739 temp_cur.bv().buffer().params(),
740 right_pos).isRightToLeft()))
744 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
745 true, temp_cur.boundary());
749 void Text::selectWord(Cursor & cur, word_location loc)
751 LASSERT(this == cur.text(), /**/);
752 CursorSlice from = cur.top();
753 CursorSlice to = cur.top();
754 getWord(from, to, loc);
755 if (cur.top() != from)
756 setCursor(cur, from.pit(), from.pos());
760 setCursor(cur, to.pit(), to.pos());
765 // Select the word currently under the cursor when no
766 // selection is currently set
767 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
769 LASSERT(this == cur.text(), /**/);
772 selectWord(cur, loc);
773 return cur.selection();
777 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
779 LASSERT(this == cur.text(), /**/);
781 if (!cur.selection())
784 cur.recordUndoSelection();
786 pit_type begPit = cur.selectionBegin().pit();
787 pit_type endPit = cur.selectionEnd().pit();
789 pos_type begPos = cur.selectionBegin().pos();
790 pos_type endPos = cur.selectionEnd().pos();
792 // keep selection info, because endPos becomes invalid after the first loop
793 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
795 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
797 for (pit_type pit = begPit; pit <= endPit; ++pit) {
798 pos_type parSize = pars_[pit].size();
800 // ignore empty paragraphs; otherwise, an assertion will fail for
801 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
805 // do not consider first paragraph if the cursor starts at pos size()
806 if (pit == begPit && begPos == parSize)
809 // do not consider last paragraph if the cursor ends at pos 0
810 if (pit == endPit && endPos == 0)
811 break; // last iteration anyway
813 pos_type left = (pit == begPit ? begPos : 0);
814 pos_type right = (pit == endPit ? endPos : parSize);
817 pars_[pit].acceptChanges(cur.buffer().params(), left, right);
819 pars_[pit].rejectChanges(cur.buffer().params(), left, right);
823 // next, accept/reject imaginary end-of-par characters
825 for (pit_type pit = begPit; pit <= endPit; ++pit) {
826 pos_type pos = pars_[pit].size();
828 // skip if the selection ends before the end-of-par
829 if (pit == endPit && endsBeforeEndOfPar)
830 break; // last iteration anyway
832 // skip if this is not the last paragraph of the document
833 // note: the user should be able to accept/reject the par break of the last par!
834 if (pit == endPit && pit + 1 != int(pars_.size()))
835 break; // last iteration anway
838 if (pars_[pit].isInserted(pos)) {
839 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
840 } else if (pars_[pit].isDeleted(pos)) {
841 if (pit + 1 == int(pars_.size())) {
842 // we cannot remove a par break at the end of the last paragraph;
843 // instead, we mark it unchanged
844 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
846 mergeParagraph(cur.buffer().params(), pars_, pit);
852 if (pars_[pit].isDeleted(pos)) {
853 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
854 } else if (pars_[pit].isInserted(pos)) {
855 if (pit + 1 == int(pars_.size())) {
856 // we mark the par break at the end of the last paragraph unchanged
857 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
859 mergeParagraph(cur.buffer().params(), pars_, pit);
867 // finally, invoke the DEPM
869 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer().params().trackChanges);
874 cur.clearSelection();
875 setCursorIntern(cur, begPit, begPos);
876 cur.updateFlags(Update::Force);
877 updateLabels(cur.buffer());
881 void Text::acceptChanges(BufferParams const & bparams)
883 lyx::acceptChanges(pars_, bparams);
884 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.trackChanges);
888 void Text::rejectChanges(BufferParams const & bparams)
890 pit_type pars_size = static_cast<pit_type>(pars_.size());
892 // first, reject changes within each individual paragraph
893 // (do not consider end-of-par)
894 for (pit_type pit = 0; pit < pars_size; ++pit) {
895 if (!pars_[pit].empty()) // prevent assertion failure
896 pars_[pit].rejectChanges(bparams, 0, pars_[pit].size());
899 // next, reject imaginary end-of-par characters
900 for (pit_type pit = 0; pit < pars_size; ++pit) {
901 pos_type pos = pars_[pit].size();
903 if (pars_[pit].isDeleted(pos)) {
904 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
905 } else if (pars_[pit].isInserted(pos)) {
906 if (pit == pars_size - 1) {
907 // we mark the par break at the end of the last
908 // paragraph unchanged
909 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
911 mergeParagraph(bparams, pars_, pit);
918 // finally, invoke the DEPM
919 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.trackChanges);
923 void Text::deleteWordForward(Cursor & cur)
925 LASSERT(this == cur.text(), /**/);
926 if (cur.lastpos() == 0)
930 cur.selection() = true;
931 cursorForwardOneWord(cur);
933 cutSelection(cur, true, false);
934 cur.checkBufferStructure();
939 void Text::deleteWordBackward(Cursor & cur)
941 LASSERT(this == cur.text(), /**/);
942 if (cur.lastpos() == 0)
946 cur.selection() = true;
947 cursorBackwardOneWord(cur);
949 cutSelection(cur, true, false);
950 cur.checkBufferStructure();
955 // Kill to end of line.
956 void Text::changeCase(Cursor & cur, TextCase action)
958 LASSERT(this == cur.text(), /**/);
963 if (cur.selection()) {
964 from = cur.selBegin();
969 getWord(from, to, PARTIAL_WORD);
970 cursorForwardOneWord(cur);
973 cur.recordUndoSelection();
975 pit_type begPit = from.pit();
976 pit_type endPit = to.pit();
978 pos_type begPos = from.pos();
979 pos_type endPos = to.pos();
981 pos_type right = 0; // needed after the for loop
983 for (pit_type pit = begPit; pit <= endPit; ++pit) {
984 Paragraph & par = pars_[pit];
985 pos_type const pos = (pit == begPit ? begPos : 0);
986 right = (pit == endPit ? endPos : par.size());
987 par.changeCase(cur.buffer().params(), pos, right, action);
990 // the selection may have changed due to logically-only deleted chars
992 setCursor(cur, begPit, begPos);
994 setCursor(cur, endPit, right);
997 setCursor(cur, endPit, right);
999 cur.checkBufferStructure();
1003 bool Text::handleBibitems(Cursor & cur)
1005 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1011 BufferParams const & bufparams = cur.buffer().params();
1012 Paragraph const & par = cur.paragraph();
1013 Cursor prevcur = cur;
1014 if (cur.pit() > 0) {
1016 prevcur.pos() = prevcur.lastpos();
1018 Paragraph const & prevpar = prevcur.paragraph();
1020 // if a bibitem is deleted, merge with previous paragraph
1021 // if this is a bibliography item as well
1022 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1023 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1024 mergeParagraph(bufparams, cur.text()->paragraphs(),
1026 updateLabels(cur.buffer());
1027 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1028 cur.updateFlags(Update::Force);
1032 // otherwise reset to default
1033 cur.paragraph().setEmptyOrDefaultLayout(bufparams.documentClass());
1038 bool Text::erase(Cursor & cur)
1040 LASSERT(this == cur.text(), /**/);
1041 bool needsUpdate = false;
1042 Paragraph & par = cur.paragraph();
1044 if (cur.pos() != cur.lastpos()) {
1045 // this is the code for a normal delete, not pasting
1047 cur.recordUndo(DELETE_UNDO);
1048 bool const was_inset = cur.paragraph().isInset(cur.pos());
1049 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges))
1050 // the character has been logically deleted only => skip it
1051 cur.top().forwardPos();
1054 updateLabels(cur.buffer());
1056 cur.checkBufferStructure();
1059 if (cur.pit() == cur.lastpit())
1060 return dissolveInset(cur);
1062 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1063 par.setChange(cur.pos(), Change(Change::DELETED));
1067 setCursorIntern(cur, cur.pit() + 1, 0);
1068 needsUpdate = backspacePos0(cur);
1072 needsUpdate |= handleBibitems(cur);
1075 // Make sure the cursor is correct. Is this really needed?
1076 // No, not really... at least not here!
1077 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1078 cur.checkBufferStructure();
1085 bool Text::backspacePos0(Cursor & cur)
1087 LASSERT(this == cur.text(), /**/);
1091 bool needsUpdate = false;
1093 BufferParams const & bufparams = cur.buffer().params();
1094 DocumentClass const & tclass = bufparams.documentClass();
1095 ParagraphList & plist = cur.text()->paragraphs();
1096 Paragraph const & par = cur.paragraph();
1097 Cursor prevcur = cur;
1099 prevcur.pos() = prevcur.lastpos();
1100 Paragraph const & prevpar = prevcur.paragraph();
1102 // is it an empty paragraph?
1103 if (cur.lastpos() == 0
1104 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1105 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1106 plist.erase(boost::next(plist.begin(), cur.pit()));
1109 // is previous par empty?
1110 else if (prevcur.lastpos() == 0
1111 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1112 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1113 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1116 // Pasting is not allowed, if the paragraphs have different
1117 // layouts. I think it is a real bug of all other
1118 // word processors to allow it. It confuses the user.
1119 // Correction: Pasting is always allowed with standard-layout
1120 // or the empty layout.
1121 else if (par.layout() == prevpar.layout()
1122 || tclass.isDefaultLayout(par.layout())
1123 || tclass.isEmptyLayout(par.layout())) {
1124 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1125 mergeParagraph(bufparams, plist, prevcur.pit());
1130 updateLabels(cur.buffer());
1131 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1138 bool Text::backspace(Cursor & cur)
1140 LASSERT(this == cur.text(), /**/);
1141 bool needsUpdate = false;
1142 if (cur.pos() == 0) {
1144 return dissolveInset(cur);
1146 Paragraph & prev_par = pars_[cur.pit() - 1];
1148 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1149 prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1150 setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1153 // The cursor is at the beginning of a paragraph, so
1154 // the backspace will collapse two paragraphs into one.
1155 needsUpdate = backspacePos0(cur);
1158 // this is the code for a normal backspace, not pasting
1160 cur.recordUndo(DELETE_UNDO);
1161 // We used to do cursorBackwardIntern() here, but it is
1162 // not a good idea since it triggers the auto-delete
1163 // mechanism. So we do a cursorBackwardIntern()-lite,
1164 // without the dreaded mechanism. (JMarc)
1165 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1166 false, cur.boundary());
1167 bool const was_inset = cur.paragraph().isInset(cur.pos());
1168 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1170 updateLabels(cur.buffer());
1172 cur.checkBufferStructure();
1175 if (cur.pos() == cur.lastpos())
1176 cur.setCurrentFont();
1178 needsUpdate |= handleBibitems(cur);
1180 // A singlePar update is not enough in this case.
1181 // cur.updateFlags(Update::Force);
1182 setCursor(cur.top(), cur.pit(), cur.pos());
1188 bool Text::dissolveInset(Cursor & cur) {
1189 LASSERT(this == cur.text(), /**/);
1191 if (isMainText(cur.bv().buffer()) || cur.inset().nargs() != 1)
1194 cur.recordUndoInset();
1196 cur.selHandle(false);
1198 pos_type spos = cur.pos();
1199 pit_type spit = cur.pit();
1200 ParagraphList plist;
1201 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1202 plist = paragraphs();
1204 // store cursor offset
1208 Buffer & b = cur.buffer();
1209 cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1210 if (!plist.empty()) {
1211 // ERT paragraphs have the Language latex_language.
1212 // This is invalid outside of ERT, so we need to
1213 // change it to the buffer language.
1214 ParagraphList::iterator it = plist.begin();
1215 ParagraphList::iterator it_end = plist.end();
1216 for (; it != it_end; it++)
1217 it->changeLanguage(b.params(), latex_language, b.language());
1219 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1220 b.errorList("Paste"));
1222 cur.pit() = min(cur.lastpit(), spit);
1223 cur.pos() = min(cur.lastpos(), spos);
1225 cur.clearSelection();
1231 void Text::getWord(CursorSlice & from, CursorSlice & to,
1232 word_location const loc) const
1234 Paragraph const & from_par = pars_[from.pit()];
1236 case WHOLE_WORD_STRICT:
1237 if (from.pos() == 0 || from.pos() == from_par.size()
1238 || !from_par.isLetter(from.pos())
1239 || !from_par.isLetter(from.pos() - 1)) {
1243 // no break here, we go to the next
1246 // If we are already at the beginning of a word, do nothing
1247 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1249 // no break here, we go to the next
1252 // always move the cursor to the beginning of previous word
1253 while (from.pos() && from_par.isLetter(from.pos() - 1))
1257 LYXERR0("Text::getWord: NEXT_WORD not implemented yet");
1260 // no need to move the 'from' cursor
1264 Paragraph const & to_par = pars_[to.pit()];
1265 while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1270 void Text::write(Buffer const & buf, ostream & os) const
1272 ParagraphList::const_iterator pit = paragraphs().begin();
1273 ParagraphList::const_iterator end = paragraphs().end();
1275 for (; pit != end; ++pit)
1276 pit->write(os, buf.params(), dth);
1278 // Close begin_deeper
1279 for(; dth > 0; --dth)
1280 os << "\n\\end_deeper";
1284 bool Text::read(Buffer const & buf, Lexer & lex,
1285 ErrorList & errorList, InsetText * insetPtr)
1287 depth_type depth = 0;
1289 while (lex.isOK()) {
1291 string const token = lex.getString();
1296 if (token == "\\end_inset")
1299 if (token == "\\end_body")
1302 if (token == "\\begin_body")
1305 if (token == "\\end_document")
1308 if (token == "\\begin_layout") {
1309 lex.pushToken(token);
1312 par.params().depth(depth);
1313 par.setFont(0, Font(inherit_font, buf.params().language));
1314 par.setInsetOwner(insetPtr);
1315 pars_.push_back(par);
1317 // FIXME: goddamn InsetTabular makes us pass a Buffer
1319 lyx::readParagraph(buf, pars_.back(), lex, errorList);
1321 // register the words in the global word list
1322 CursorSlice sl = CursorSlice(*insetPtr);
1323 sl.pit() = pars_.size() - 1;
1324 pars_.back().updateWords(sl);
1325 } else if (token == "\\begin_deeper") {
1327 } else if (token == "\\end_deeper") {
1329 lex.printError("\\end_deeper: " "depth is already null");
1333 LYXERR0("Handling unknown body token: `" << token << '\'');
1339 // Returns the current font and depth as a message.
1340 docstring Text::currentState(Cursor & cur)
1342 LASSERT(this == cur.text(), /**/);
1343 Buffer & buf = cur.buffer();
1344 Paragraph const & par = cur.paragraph();
1345 odocstringstream os;
1347 if (buf.params().trackChanges)
1348 os << _("[Change Tracking] ");
1350 Change change = par.lookupChange(cur.pos());
1352 if (change.type != Change::UNCHANGED) {
1353 Author const & a = buf.params().authors().get(change.author);
1354 os << _("Change: ") << a.name();
1355 if (!a.email().empty())
1356 os << " (" << a.email() << ")";
1357 // FIXME ctime is english, we should translate that
1358 os << _(" at ") << ctime(&change.changetime);
1362 // I think we should only show changes from the default
1364 // No, from the document font (MV)
1365 Font font = cur.real_current_font;
1366 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1368 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1370 // The paragraph depth
1371 int depth = cur.paragraph().getDepth();
1373 os << bformat(_(", Depth: %1$d"), depth);
1375 // The paragraph spacing, but only if different from
1377 Spacing const & spacing = par.params().spacing();
1378 if (!spacing.isDefault()) {
1379 os << _(", Spacing: ");
1380 switch (spacing.getSpace()) {
1381 case Spacing::Single:
1384 case Spacing::Onehalf:
1387 case Spacing::Double:
1390 case Spacing::Other:
1391 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1393 case Spacing::Default:
1394 // should never happen, do nothing
1399 #ifdef DEVEL_VERSION
1400 os << _(", Inset: ") << &cur.inset();
1401 os << _(", Paragraph: ") << cur.pit();
1402 os << _(", Id: ") << par.id();
1403 os << _(", Position: ") << cur.pos();
1404 // FIXME: Why is the check for par.size() needed?
1405 // We are called with cur.pos() == par.size() quite often.
1406 if (!par.empty() && cur.pos() < par.size()) {
1407 // Force output of code point, not character
1408 size_t const c = par.getChar(cur.pos());
1409 os << _(", Char: 0x") << hex << c;
1411 os << _(", Boundary: ") << cur.boundary();
1412 // Row & row = cur.textRow();
1413 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1419 docstring Text::getPossibleLabel(Cursor & cur) const
1421 pit_type pit = cur.pit();
1423 Layout const * layout = &(pars_[pit].layout());
1426 docstring par_text = pars_[pit].asString();
1428 // the return string of math matrices might contain linebreaks
1429 par_text = subst(par_text, '\n', '-');
1430 for (int i = 0; i < lyxrc.label_init_length; ++i) {
1431 if (par_text.empty())
1434 par_text = split(par_text, head, ' ');
1435 // Is it legal to use spaces in labels ?
1441 // No need for a prefix if the user said so.
1442 if (lyxrc.label_init_length <= 0)
1445 // Will contain the label type.
1448 // For section, subsection, etc...
1449 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1450 Layout const * layout2 = &(pars_[pit - 1].layout());
1451 if (layout2->latextype != LATEX_PARAGRAPH) {
1456 if (layout->latextype != LATEX_PARAGRAPH)
1457 name = from_ascii(layout->latexname());
1459 // for captions, we just take the caption type
1460 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1462 name = from_ascii(static_cast<InsetCaption *>(caption_inset)->type());
1464 // If none of the above worked, we'll see if we're inside various
1465 // types of insets and take our abbreviation from them.
1467 InsetCode const codes[] = {
1472 for (unsigned int i = 0; i < (sizeof codes / sizeof codes[0]); ++i) {
1473 Inset * float_inset = cur.innerInsetOfType(codes[i]);
1475 name = float_inset->name();
1481 // Create a correct prefix for prettyref
1482 if (name == "theorem")
1483 name = from_ascii("thm");
1484 else if (name == "Foot")
1485 name = from_ascii("fn");
1486 else if (name == "listing")
1487 name = from_ascii("lst");
1490 text = name.substr(0, 3) + ':' + text;
1496 void Text::charsTranspose(Cursor & cur)
1498 LASSERT(this == cur.text(), /**/);
1500 pos_type pos = cur.pos();
1502 // If cursor is at beginning or end of paragraph, do nothing.
1503 if (pos == cur.lastpos() || pos == 0)
1506 Paragraph & par = cur.paragraph();
1508 // Get the positions of the characters to be transposed.
1509 pos_type pos1 = pos - 1;
1510 pos_type pos2 = pos;
1512 // In change tracking mode, ignore deleted characters.
1513 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1515 if (pos2 == cur.lastpos())
1518 while (pos1 >= 0 && par.isDeleted(pos1))
1523 // Don't do anything if one of the "characters" is not regular text.
1524 if (par.isInset(pos1) || par.isInset(pos2))
1527 // Store the characters to be transposed (including font information).
1528 char_type char1 = par.getChar(pos1);
1530 par.getFontSettings(cur.buffer().params(), pos1);
1532 char_type char2 = par.getChar(pos2);
1534 par.getFontSettings(cur.buffer().params(), pos2);
1536 // And finally, we are ready to perform the transposition.
1537 // Track the changes if Change Tracking is enabled.
1538 bool const trackChanges = cur.buffer().params().trackChanges;
1542 par.eraseChar(pos2, trackChanges);
1543 par.eraseChar(pos1, trackChanges);
1544 par.insertChar(pos1, char2, font2, trackChanges);
1545 par.insertChar(pos2, char1, font1, trackChanges);
1547 cur.checkBufferStructure();
1549 // After the transposition, move cursor to after the transposition.
1550 setCursor(cur, cur.pit(), pos2);
1555 DocIterator Text::macrocontextPosition() const
1557 return macrocontext_position_;
1561 void Text::setMacrocontextPosition(DocIterator const & pos)
1563 macrocontext_position_ = pos;
1567 docstring Text::previousWord(CursorSlice const & sl) const
1569 CursorSlice from = sl;
1570 CursorSlice to = sl;
1571 getWord(from, to, PREVIOUS_WORD);
1572 if (sl == from || to == from)
1575 Paragraph const & par = sl.paragraph();
1576 return par.asString(from.pos(), to.pos());
1580 bool Text::completionSupported(Cursor const & cur) const
1582 Paragraph const & par = cur.paragraph();
1583 return cur.pos() > 0
1584 && (cur.pos() >= par.size() || !par.isLetter(cur.pos()))
1585 && par.isLetter(cur.pos() - 1);
1589 CompletionList const * Text::createCompletionList(Cursor const & cur) const
1591 return new TextCompletionList(cur);
1595 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
1597 LASSERT(cur.bv().cursor() == cur, /**/);
1599 cur.bv().cursor() = cur;
1600 if (!(cur.disp_.update() & Update::Force))
1601 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
1606 docstring Text::completionPrefix(Cursor const & cur) const
1608 return previousWord(cur.top());