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"
42 #include "Paragraph.h"
43 #include "paragraph_funcs.h"
44 #include "ParagraphParameters.h"
45 #include "ParIterator.h"
46 #include "TextClass.h"
47 #include "TextMetrics.h"
49 #include "WordLangTuple.h"
52 #include "insets/InsetText.h"
53 #include "insets/InsetBibitem.h"
54 #include "insets/InsetCaption.h"
55 #include "insets/InsetLine.h"
56 #include "insets/InsetNewline.h"
57 #include "insets/InsetNewpage.h"
58 #include "insets/InsetOptArg.h"
59 #include "insets/InsetSpace.h"
60 #include "insets/InsetSpecialChar.h"
61 #include "insets/InsetTabular.h"
63 #include "support/debug.h"
64 #include "support/docstream.h"
65 #include "support/gettext.h"
66 #include "support/lassert.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;
82 void Text::readParToken(Paragraph & par, Lexer & lex,
83 string const & token, Font & font, Change & change, ErrorList & errorList)
85 Buffer const & buf = owner_->buffer();
86 BufferParams const & bp = buf.params();
88 if (token[0] != '\\') {
89 docstring dstr = lex.getDocString();
90 par.appendString(dstr, font, change);
92 } else if (token == "\\begin_layout") {
94 docstring layoutname = lex.getDocString();
96 font = Font(inherit_font, bp.language);
97 change = Change(Change::UNCHANGED);
99 DocumentClass const & tclass = bp.documentClass();
101 if (layoutname.empty())
102 layoutname = tclass.defaultLayoutName();
104 if (owner_->forcePlainLayout()) {
105 // in this case only the empty layout is allowed
106 layoutname = tclass.plainLayoutName();
107 } else if (par.usePlainLayout()) {
108 // in this case, default layout maps to empty layout
109 if (layoutname == tclass.defaultLayoutName())
110 layoutname = tclass.plainLayoutName();
112 // otherwise, the empty layout maps to the default
113 if (layoutname == tclass.plainLayoutName())
114 layoutname = tclass.defaultLayoutName();
117 // When we apply an unknown layout to a document, we add this layout to the textclass
118 // of this document. For example, when you apply class article to a beamer document,
119 // all unknown layouts such as frame will be added to document class article so that
120 // these layouts can keep their original names.
121 tclass.addLayoutIfNeeded(layoutname);
123 par.setLayout(bp.documentClass()[layoutname]);
125 // Test whether the layout is obsolete.
126 Layout const & layout = par.layout();
127 if (!layout.obsoleted_by().empty())
128 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
130 par.params().read(lex);
132 } else if (token == "\\end_layout") {
133 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
134 << "Missing \\begin_layout ?");
135 } else if (token == "\\end_inset") {
136 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
137 << "Missing \\begin_inset ?");
138 } else if (token == "\\begin_inset") {
139 Inset * inset = readInset(lex, buf);
141 par.insertInset(par.size(), inset, font, change);
144 docstring line = lex.getDocString();
145 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
146 par.id(), 0, par.size()));
148 } else if (token == "\\family") {
150 setLyXFamily(lex.getString(), font.fontInfo());
151 } else if (token == "\\series") {
153 setLyXSeries(lex.getString(), font.fontInfo());
154 } else if (token == "\\shape") {
156 setLyXShape(lex.getString(), font.fontInfo());
157 } else if (token == "\\size") {
159 setLyXSize(lex.getString(), font.fontInfo());
160 } else if (token == "\\lang") {
162 string const tok = lex.getString();
163 Language const * lang = languages.getLanguage(tok);
165 font.setLanguage(lang);
167 font.setLanguage(bp.language);
168 lex.printError("Unknown language `$$Token'");
170 } else if (token == "\\numeric") {
172 font.fontInfo().setNumber(font.setLyXMisc(lex.getString()));
173 } else if (token == "\\emph") {
175 font.fontInfo().setEmph(font.setLyXMisc(lex.getString()));
176 } else if (token == "\\bar") {
178 string const tok = lex.getString();
181 font.fontInfo().setUnderbar(FONT_ON);
182 else if (tok == "no")
183 font.fontInfo().setUnderbar(FONT_OFF);
184 else if (tok == "default")
185 font.fontInfo().setUnderbar(FONT_INHERIT);
187 lex.printError("Unknown bar font flag "
189 } else if (token == "\\strikeout") {
191 font.fontInfo().setStrikeout(font.setLyXMisc(lex.getString()));
192 } else if (token == "\\uuline") {
194 font.fontInfo().setUuline(font.setLyXMisc(lex.getString()));
195 } else if (token == "\\uwave") {
197 font.fontInfo().setUwave(font.setLyXMisc(lex.getString()));
198 } else if (token == "\\noun") {
200 font.fontInfo().setNoun(font.setLyXMisc(lex.getString()));
201 } else if (token == "\\color") {
203 setLyXColor(lex.getString(), font.fontInfo());
204 } else if (token == "\\SpecialChar") {
205 auto_ptr<Inset> inset;
206 inset.reset(new InsetSpecialChar);
208 par.insertInset(par.size(), inset.release(),
210 } else if (token == "\\backslash") {
211 par.appendChar('\\', font, change);
212 } else if (token == "\\LyXTable") {
213 auto_ptr<Inset> inset(new InsetTabular(const_cast<Buffer &>(buf)));
215 par.insertInset(par.size(), inset.release(), font, change);
216 } else if (token == "\\lyxline") {
217 par.insertInset(par.size(), new InsetLine, font, change);
218 } else if (token == "\\change_unchanged") {
219 change = Change(Change::UNCHANGED);
220 } else if (token == "\\change_inserted" || token == "\\change_deleted") {
222 istringstream is(lex.getString());
226 map<unsigned int, int> const & am = bp.author_map;
227 if (am.find(aid) == am.end()) {
228 errorList.push_back(ErrorItem(_("Change tracking error"),
229 bformat(_("Unknown author index for change: %1$d\n"), aid),
230 par.id(), 0, par.size()));
231 change = Change(Change::UNCHANGED);
233 if (token == "\\change_inserted")
234 change = Change(Change::INSERTED, am.find(aid)->second, ct);
236 change = Change(Change::DELETED, am.find(aid)->second, ct);
240 errorList.push_back(ErrorItem(_("Unknown token"),
241 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
243 par.id(), 0, par.size()));
248 void Text::readParagraph(Paragraph & par, Lexer & lex,
249 ErrorList & errorList)
252 string token = lex.getString();
254 Change change(Change::UNCHANGED);
257 readParToken(par, lex, token, font, change, errorList);
260 token = lex.getString();
265 if (token == "\\end_layout") {
266 //Ok, paragraph finished
270 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
271 if (token == "\\begin_layout" || token == "\\end_document"
272 || token == "\\end_inset" || token == "\\begin_deeper"
273 || token == "\\end_deeper") {
274 lex.pushToken(token);
275 lyxerr << "Paragraph ended in line "
276 << lex.lineNumber() << "\n"
277 << "Missing \\end_layout.\n";
281 // Final change goes to paragraph break:
282 par.setChange(par.size(), change);
284 // Initialize begin_of_body_ on load; redoParagraph maintains
285 par.setBeginOfBody();
289 class TextCompletionList : public CompletionList
293 TextCompletionList(Cursor const & cur)
294 : buffer_(cur.buffer()), pos_(0)
297 virtual ~TextCompletionList() {}
300 virtual bool sorted() const { return true; }
302 virtual size_t size() const
304 return theWordList().size();
307 virtual docstring const & data(size_t idx) const
309 return theWordList().word(idx);
314 Buffer const * buffer_;
320 bool Text::empty() const
322 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
323 // FIXME: Should we consider the labeled type as empty too?
324 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
328 double Text::spacing(Paragraph const & par) const
330 if (par.params().spacing().isDefault())
331 return owner_->buffer().params().spacing().getValue();
332 return par.params().spacing().getValue();
336 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
338 LASSERT(this == cur.text(), /**/);
340 Paragraph & cpar = cur.paragraph();
341 pit_type cpit = cur.pit();
343 DocumentClass const & tclass = cur.buffer()->params().documentClass();
344 Layout const & layout = cpar.layout();
346 // this is only allowed, if the current paragraph is not empty
347 // or caption and if it has not the keepempty flag active
348 if (cur.lastpos() == 0 && !cpar.allowEmpty() &&
349 layout.labeltype != LABEL_SENSITIVE)
352 // a layout change may affect also the following paragraph
353 recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
355 // Always break behind a space
356 // It is better to erase the space (Dekel)
357 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
358 cpar.eraseChar(cur.pos(), cur.buffer()->params().trackChanges);
360 // What should the layout for the new paragraph be?
361 bool keep_layout = inverse_logic ?
362 !layout.isEnvironment()
363 : layout.isEnvironment();
365 // We need to remember this before we break the paragraph, because
366 // that invalidates the layout variable
367 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
369 // we need to set this before we insert the paragraph.
370 bool const isempty = cpar.allowEmpty() && cpar.empty();
372 lyx::breakParagraph(cur.buffer()->params(), paragraphs(), cpit,
373 cur.pos(), keep_layout);
375 // After this, neither paragraph contains any rows!
378 pit_type next_par = cpit + 1;
380 // well this is the caption hack since one caption is really enough
383 // set to standard-layout
384 //FIXME Check if this should be plainLayout() in some cases
385 pars_[cpit].applyLayout(tclass.defaultLayout());
387 // set to standard-layout
388 //FIXME Check if this should be plainLayout() in some cases
389 pars_[next_par].applyLayout(tclass.defaultLayout());
392 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
393 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().trackChanges))
394 break; // the character couldn't be deleted physically due to change tracking
397 cur.buffer()->updateLabels();
399 // A singlePar update is not enough in this case.
400 cur.updateFlags(Update::Force);
402 // This check is necessary. Otherwise the new empty paragraph will
403 // be deleted automatically. And it is more friendly for the user!
404 if (cur.pos() != 0 || isempty)
405 setCursor(cur, cur.pit() + 1, 0);
407 setCursor(cur, cur.pit(), 0);
411 // insert a character, moves all the following breaks in the
412 // same Paragraph one to the right and make a rebreak
413 void Text::insertChar(Cursor & cur, char_type c)
415 LASSERT(this == cur.text(), /**/);
417 cur.recordUndo(INSERT_UNDO);
419 TextMetrics const & tm = cur.bv().textMetrics(this);
420 Buffer const & buffer = *cur.buffer();
421 Paragraph & par = cur.paragraph();
422 // try to remove this
423 pit_type const pit = cur.pit();
425 bool const freeSpacing = par.layout().free_spacing ||
428 if (lyxrc.auto_number) {
429 static docstring const number_operators = from_ascii("+-/*");
430 static docstring const number_unary_operators = from_ascii("+-");
431 static docstring const number_seperators = from_ascii(".,:");
433 if (cur.current_font.fontInfo().number() == FONT_ON) {
434 if (!isDigit(c) && !contains(number_operators, c) &&
435 !(contains(number_seperators, c) &&
437 cur.pos() != cur.lastpos() &&
438 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
439 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
441 number(cur); // Set current_font.number to OFF
442 } else if (isDigit(c) &&
443 cur.real_current_font.isVisibleRightToLeft()) {
444 number(cur); // Set current_font.number to ON
446 if (cur.pos() != 0) {
447 char_type const c = par.getChar(cur.pos() - 1);
448 if (contains(number_unary_operators, c) &&
450 || par.isSeparator(cur.pos() - 2)
451 || par.isNewline(cur.pos() - 2))
453 setCharFont(pit, cur.pos() - 1, cur.current_font,
455 } else if (contains(number_seperators, c)
457 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
458 setCharFont(pit, cur.pos() - 1, cur.current_font,
465 // In Bidi text, we want spaces to be treated in a special way: spaces
466 // which are between words in different languages should get the
467 // paragraph's language; otherwise, spaces should keep the language
468 // they were originally typed in. This is only in effect while typing;
469 // after the text is already typed in, the user can always go back and
470 // explicitly set the language of a space as desired. But 99.9% of the
471 // time, what we're doing here is what the user actually meant.
473 // The following cases are the ones in which the language of the space
474 // should be changed to match that of the containing paragraph. In the
475 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
476 // represents a space, pipe (|) represents the cursor position (so the
477 // character before it is the one just typed in). The different cases
478 // are depicted logically (not visually), from left to right:
483 // Theoretically, there are other situations that we should, perhaps, deal
484 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
485 // point (to understand why, just try to create this situation...).
487 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
488 // get font in front and behind the space in question. But do NOT
489 // use getFont(cur.pos()) because the character c is not inserted yet
490 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
491 Font const & post_space_font = cur.real_current_font;
492 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
493 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
495 if (pre_space_rtl != post_space_rtl) {
496 // Set the space's language to match the language of the
497 // adjacent character whose direction is the paragraph's
498 // direction; don't touch other properties of the font
499 Language const * lang =
500 (pre_space_rtl == par.isRTL(buffer.params())) ?
501 pre_space_font.language() : post_space_font.language();
503 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
504 space_font.setLanguage(lang);
505 par.setFont(cur.pos() - 1, space_font);
509 // Next check, if there will be two blanks together or a blank at
510 // the beginning of a paragraph.
511 // I decided to handle blanks like normal characters, the main
512 // difference are the special checks when calculating the row.fill
513 // (blank does not count at the end of a row) and the check here
515 // When the free-spacing option is set for the current layout,
516 // disable the double-space checking
517 if (!freeSpacing && isLineSeparatorChar(c)) {
518 if (cur.pos() == 0) {
519 static bool sent_space_message = false;
520 if (!sent_space_message) {
521 cur.message(_("You cannot insert a space at the "
522 "beginning of a paragraph. Please read the Tutorial."));
523 sent_space_message = true;
527 LASSERT(cur.pos() > 0, /**/);
528 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
529 && !par.isDeleted(cur.pos() - 1)) {
530 static bool sent_space_message = false;
531 if (!sent_space_message) {
532 cur.message(_("You cannot type two spaces this way. "
533 "Please read the Tutorial."));
534 sent_space_message = true;
540 par.insertChar(cur.pos(), c, cur.current_font,
541 cur.buffer()->params().trackChanges);
542 cur.checkBufferStructure();
544 // cur.updateFlags(Update::Force);
545 bool boundary = tm.isRTLBoundary(cur.pit(), cur.pos() + 1);
546 setCursor(cur, cur.pit(), cur.pos() + 1, false, boundary);
551 void Text::charInserted(Cursor & cur)
553 Paragraph & par = cur.paragraph();
555 // Here we call finishUndo for every 20 characters inserted.
556 // This is from my experience how emacs does it. (Lgb)
557 static unsigned int counter;
565 // register word if a non-letter was entered
567 && !par.isWordSeparator(cur.pos() - 2)
568 && par.isWordSeparator(cur.pos() - 1)) {
569 // get the word in front of cursor
570 LASSERT(this == cur.text(), /**/);
571 cur.paragraph().updateWords();
576 // the cursor set functions have a special mechanism. When they
577 // realize, that you left an empty paragraph, they will delete it.
579 bool Text::cursorForwardOneWord(Cursor & cur)
581 LASSERT(this == cur.text(), /**/);
583 pos_type const lastpos = cur.lastpos();
584 pit_type pit = cur.pit();
585 pos_type pos = cur.pos();
586 Paragraph const & par = cur.paragraph();
588 // Paragraph boundary is a word boundary
589 if (pos == lastpos) {
590 if (pit != cur.lastpit())
591 return setCursor(cur, pit + 1, 0);
596 if (lyxrc.mac_like_word_movement) {
597 // Skip through trailing punctuation and spaces.
598 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
601 // Skip over either a non-char inset or a full word
602 if (pos != lastpos && par.isWordSeparator(pos))
604 else while (pos != lastpos && !par.isWordSeparator(pos))
607 LASSERT(pos < lastpos, /**/); // see above
608 if (!par.isWordSeparator(pos))
609 while (pos != lastpos && !par.isWordSeparator(pos))
611 else if (par.isChar(pos))
612 while (pos != lastpos && par.isChar(pos))
614 else if (!par.isSpace(pos)) // non-char inset
617 // Skip over white space
618 while (pos != lastpos && par.isSpace(pos))
622 return setCursor(cur, pit, pos);
626 bool Text::cursorBackwardOneWord(Cursor & cur)
628 LASSERT(this == cur.text(), /**/);
630 pit_type pit = cur.pit();
631 pos_type pos = cur.pos();
632 Paragraph & par = cur.paragraph();
634 // Paragraph boundary is a word boundary
635 if (pos == 0 && pit != 0)
636 return setCursor(cur, pit - 1, getPar(pit - 1).size());
638 if (lyxrc.mac_like_word_movement) {
639 // Skip through punctuation and spaces.
640 while (pos != 0 && (par.isChar(pos - 1) || par.isSpace(pos - 1)))
643 // Skip over either a non-char inset or a full word
644 if (pos != 0 && par.isWordSeparator(pos - 1) && !par.isChar(pos - 1))
646 else while (pos != 0 && !par.isWordSeparator(pos - 1))
649 // Skip over white space
650 while (pos != 0 && par.isSpace(pos - 1))
653 if (pos != 0 && !par.isWordSeparator(pos - 1))
654 while (pos != 0 && !par.isWordSeparator(pos - 1))
656 else if (pos != 0 && par.isChar(pos - 1))
657 while (pos != 0 && par.isChar(pos - 1))
659 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
663 return setCursor(cur, pit, pos);
667 bool Text::cursorVisLeftOneWord(Cursor & cur)
669 LASSERT(this == cur.text(), /**/);
671 pos_type left_pos, right_pos;
672 bool left_is_letter, right_is_letter;
674 Cursor temp_cur = cur;
676 // always try to move at least once...
677 while (temp_cur.posVisLeft(true /* skip_inset */)) {
679 // collect some information about current cursor position
680 temp_cur.getSurroundingPos(left_pos, right_pos);
682 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
684 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
686 // if we're not at a letter/non-letter boundary, continue moving
687 if (left_is_letter == right_is_letter)
690 // we should stop when we have an LTR word on our right or an RTL word
692 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
693 temp_cur.buffer()->params(), left_pos).isRightToLeft())
694 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
695 temp_cur.buffer()->params(), right_pos).isRightToLeft()))
699 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
700 true, temp_cur.boundary());
704 bool Text::cursorVisRightOneWord(Cursor & cur)
706 LASSERT(this == cur.text(), /**/);
708 pos_type left_pos, right_pos;
709 bool left_is_letter, right_is_letter;
711 Cursor temp_cur = cur;
713 // always try to move at least once...
714 while (temp_cur.posVisRight(true /* skip_inset */)) {
716 // collect some information about current cursor position
717 temp_cur.getSurroundingPos(left_pos, right_pos);
719 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
721 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
723 // if we're not at a letter/non-letter boundary, continue moving
724 if (left_is_letter == right_is_letter)
727 // we should stop when we have an LTR word on our right or an RTL word
729 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
730 temp_cur.buffer()->params(),
731 left_pos).isRightToLeft())
732 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
733 temp_cur.buffer()->params(),
734 right_pos).isRightToLeft()))
738 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
739 true, temp_cur.boundary());
743 void Text::selectWord(Cursor & cur, word_location loc)
745 LASSERT(this == cur.text(), /**/);
746 CursorSlice from = cur.top();
747 CursorSlice to = cur.top();
748 getWord(from, to, loc);
749 if (cur.top() != from)
750 setCursor(cur, from.pit(), from.pos());
754 setCursor(cur, to.pit(), to.pos());
759 void Text::selectAll(Cursor & cur)
761 LASSERT(this == cur.text(), /**/);
762 if (cur.lastpos() == 0 && cur.lastpit() == 0)
764 // If the cursor is at the beginning, make sure the cursor ends there
765 if (cur.pit() == 0 && cur.pos() == 0) {
766 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
768 setCursor(cur, 0, 0);
770 setCursor(cur, 0, 0);
772 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
778 // Select the word currently under the cursor when no
779 // selection is currently set
780 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
782 LASSERT(this == cur.text(), /**/);
785 selectWord(cur, loc);
786 return cur.selection();
790 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
792 LASSERT(this == cur.text(), /**/);
794 if (!cur.selection()) {
795 bool const changed = cur.paragraph().isChanged(cur.pos());
796 if (!(changed && findNextChange(&cur.bv())))
800 cur.recordUndoSelection();
802 pit_type begPit = cur.selectionBegin().pit();
803 pit_type endPit = cur.selectionEnd().pit();
805 pos_type begPos = cur.selectionBegin().pos();
806 pos_type endPos = cur.selectionEnd().pos();
808 // keep selection info, because endPos becomes invalid after the first loop
809 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
811 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
813 for (pit_type pit = begPit; pit <= endPit; ++pit) {
814 pos_type parSize = pars_[pit].size();
816 // ignore empty paragraphs; otherwise, an assertion will fail for
817 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
821 // do not consider first paragraph if the cursor starts at pos size()
822 if (pit == begPit && begPos == parSize)
825 // do not consider last paragraph if the cursor ends at pos 0
826 if (pit == endPit && endPos == 0)
827 break; // last iteration anyway
829 pos_type left = (pit == begPit ? begPos : 0);
830 pos_type right = (pit == endPit ? endPos : parSize);
833 pars_[pit].acceptChanges(left, right);
835 pars_[pit].rejectChanges(left, right);
839 // next, accept/reject imaginary end-of-par characters
841 for (pit_type pit = begPit; pit <= endPit; ++pit) {
842 pos_type pos = pars_[pit].size();
844 // skip if the selection ends before the end-of-par
845 if (pit == endPit && endsBeforeEndOfPar)
846 break; // last iteration anyway
848 // skip if this is not the last paragraph of the document
849 // note: the user should be able to accept/reject the par break of the last par!
850 if (pit == endPit && pit + 1 != int(pars_.size()))
851 break; // last iteration anway
854 if (pars_[pit].isInserted(pos)) {
855 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
856 } else if (pars_[pit].isDeleted(pos)) {
857 if (pit + 1 == int(pars_.size())) {
858 // we cannot remove a par break at the end of the last paragraph;
859 // instead, we mark it unchanged
860 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
862 mergeParagraph(cur.buffer()->params(), pars_, pit);
868 if (pars_[pit].isDeleted(pos)) {
869 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
870 } else if (pars_[pit].isInserted(pos)) {
871 if (pit + 1 == int(pars_.size())) {
872 // we mark the par break at the end of the last paragraph unchanged
873 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
875 mergeParagraph(cur.buffer()->params(), pars_, pit);
883 // finally, invoke the DEPM
885 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer()->params().trackChanges);
890 cur.clearSelection();
891 setCursorIntern(cur, begPit, begPos);
892 cur.updateFlags(Update::Force);
893 cur.buffer()->updateLabels();
897 void Text::acceptChanges(BufferParams const & bparams)
899 lyx::acceptChanges(pars_, bparams);
900 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.trackChanges);
904 void Text::rejectChanges(BufferParams const & bparams)
906 pit_type pars_size = static_cast<pit_type>(pars_.size());
908 // first, reject changes within each individual paragraph
909 // (do not consider end-of-par)
910 for (pit_type pit = 0; pit < pars_size; ++pit) {
911 if (!pars_[pit].empty()) // prevent assertion failure
912 pars_[pit].rejectChanges(0, pars_[pit].size());
915 // next, reject imaginary end-of-par characters
916 for (pit_type pit = 0; pit < pars_size; ++pit) {
917 pos_type pos = pars_[pit].size();
919 if (pars_[pit].isDeleted(pos)) {
920 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
921 } else if (pars_[pit].isInserted(pos)) {
922 if (pit == pars_size - 1) {
923 // we mark the par break at the end of the last
924 // paragraph unchanged
925 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
927 mergeParagraph(bparams, pars_, pit);
934 // finally, invoke the DEPM
935 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.trackChanges);
939 void Text::deleteWordForward(Cursor & cur)
941 LASSERT(this == cur.text(), /**/);
942 if (cur.lastpos() == 0)
946 cur.setSelection(true);
947 cursorForwardOneWord(cur);
949 cutSelection(cur, true, false);
950 cur.checkBufferStructure();
955 void Text::deleteWordBackward(Cursor & cur)
957 LASSERT(this == cur.text(), /**/);
958 if (cur.lastpos() == 0)
962 cur.setSelection(true);
963 cursorBackwardOneWord(cur);
965 cutSelection(cur, true, false);
966 cur.checkBufferStructure();
971 // Kill to end of line.
972 void Text::changeCase(Cursor & cur, TextCase action)
974 LASSERT(this == cur.text(), /**/);
979 if (cur.selection()) {
980 from = cur.selBegin();
985 getWord(from, to, PARTIAL_WORD);
986 cursorForwardOneWord(cur);
989 cur.recordUndoSelection();
991 pit_type begPit = from.pit();
992 pit_type endPit = to.pit();
994 pos_type begPos = from.pos();
995 pos_type endPos = to.pos();
997 pos_type right = 0; // needed after the for loop
999 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1000 Paragraph & par = pars_[pit];
1001 pos_type const pos = (pit == begPit ? begPos : 0);
1002 right = (pit == endPit ? endPos : par.size());
1003 par.changeCase(cur.buffer()->params(), pos, right, action);
1006 // the selection may have changed due to logically-only deleted chars
1008 setCursor(cur, begPit, begPos);
1010 setCursor(cur, endPit, right);
1013 setCursor(cur, endPit, right);
1015 cur.checkBufferStructure();
1019 bool Text::handleBibitems(Cursor & cur)
1021 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1027 BufferParams const & bufparams = cur.buffer()->params();
1028 Paragraph const & par = cur.paragraph();
1029 Cursor prevcur = cur;
1030 if (cur.pit() > 0) {
1032 prevcur.pos() = prevcur.lastpos();
1034 Paragraph const & prevpar = prevcur.paragraph();
1036 // if a bibitem is deleted, merge with previous paragraph
1037 // if this is a bibliography item as well
1038 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1039 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1040 mergeParagraph(bufparams, cur.text()->paragraphs(),
1042 cur.buffer()->updateLabels();
1043 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1044 cur.updateFlags(Update::Force);
1048 // otherwise reset to default
1049 cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1054 bool Text::erase(Cursor & cur)
1056 LASSERT(this == cur.text(), return false);
1057 bool needsUpdate = false;
1058 Paragraph & par = cur.paragraph();
1060 if (cur.pos() != cur.lastpos()) {
1061 // this is the code for a normal delete, not pasting
1063 cur.recordUndo(DELETE_UNDO);
1064 bool const was_inset = cur.paragraph().isInset(cur.pos());
1065 if(!par.eraseChar(cur.pos(), cur.buffer()->params().trackChanges))
1066 // the character has been logically deleted only => skip it
1067 cur.top().forwardPos();
1070 cur.buffer()->updateLabels();
1072 cur.checkBufferStructure();
1075 if (cur.pit() == cur.lastpit())
1076 return dissolveInset(cur);
1078 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().trackChanges)) {
1079 par.setChange(cur.pos(), Change(Change::DELETED));
1083 setCursorIntern(cur, cur.pit() + 1, 0);
1084 needsUpdate = backspacePos0(cur);
1088 needsUpdate |= handleBibitems(cur);
1091 // Make sure the cursor is correct. Is this really needed?
1092 // No, not really... at least not here!
1093 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1094 cur.checkBufferStructure();
1101 bool Text::backspacePos0(Cursor & cur)
1103 LASSERT(this == cur.text(), /**/);
1107 bool needsUpdate = false;
1109 BufferParams const & bufparams = cur.buffer()->params();
1110 DocumentClass const & tclass = bufparams.documentClass();
1111 ParagraphList & plist = cur.text()->paragraphs();
1112 Paragraph const & par = cur.paragraph();
1113 Cursor prevcur = cur;
1115 prevcur.pos() = prevcur.lastpos();
1116 Paragraph const & prevpar = prevcur.paragraph();
1118 // is it an empty paragraph?
1119 if (cur.lastpos() == 0
1120 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1121 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1122 plist.erase(boost::next(plist.begin(), cur.pit()));
1125 // is previous par empty?
1126 else if (prevcur.lastpos() == 0
1127 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1128 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1129 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1132 // Pasting is not allowed, if the paragraphs have different
1133 // layouts. I think it is a real bug of all other
1134 // word processors to allow it. It confuses the user.
1135 // Correction: Pasting is always allowed with standard-layout
1136 // or the empty layout.
1137 else if (par.layout() == prevpar.layout()
1138 || tclass.isDefaultLayout(par.layout())
1139 || tclass.isPlainLayout(par.layout())) {
1140 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1141 mergeParagraph(bufparams, plist, prevcur.pit());
1146 cur.buffer()->updateLabels();
1147 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1154 bool Text::backspace(Cursor & cur)
1156 LASSERT(this == cur.text(), /**/);
1157 bool needsUpdate = false;
1158 if (cur.pos() == 0) {
1160 return dissolveInset(cur);
1162 Paragraph & prev_par = pars_[cur.pit() - 1];
1164 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer()->params().trackChanges)) {
1165 prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1166 setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1169 // The cursor is at the beginning of a paragraph, so
1170 // the backspace will collapse two paragraphs into one.
1171 needsUpdate = backspacePos0(cur);
1174 // this is the code for a normal backspace, not pasting
1176 cur.recordUndo(DELETE_UNDO);
1177 // We used to do cursorBackwardIntern() here, but it is
1178 // not a good idea since it triggers the auto-delete
1179 // mechanism. So we do a cursorBackwardIntern()-lite,
1180 // without the dreaded mechanism. (JMarc)
1181 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1182 false, cur.boundary());
1183 bool const was_inset = cur.paragraph().isInset(cur.pos());
1184 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().trackChanges);
1186 cur.buffer()->updateLabels();
1188 cur.checkBufferStructure();
1191 if (cur.pos() == cur.lastpos())
1192 cur.setCurrentFont();
1194 needsUpdate |= handleBibitems(cur);
1196 // A singlePar update is not enough in this case.
1197 // cur.updateFlags(Update::Force);
1198 setCursor(cur.top(), cur.pit(), cur.pos());
1204 bool Text::dissolveInset(Cursor & cur)
1206 LASSERT(this == cur.text(), return false);
1208 if (isMainText() || cur.inset().nargs() != 1)
1211 cur.recordUndoInset();
1213 cur.selHandle(false);
1215 pos_type spos = cur.pos();
1216 pit_type spit = cur.pit();
1217 ParagraphList plist;
1218 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1219 plist = paragraphs();
1221 // store cursor offset
1225 Buffer & b = *cur.buffer();
1226 cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1227 if (!plist.empty()) {
1228 // ERT paragraphs have the Language latex_language.
1229 // This is invalid outside of ERT, so we need to
1230 // change it to the buffer language.
1231 ParagraphList::iterator it = plist.begin();
1232 ParagraphList::iterator it_end = plist.end();
1233 for (; it != it_end; it++)
1234 it->changeLanguage(b.params(), latex_language, b.language());
1236 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1237 b.errorList("Paste"));
1239 cur.pit() = min(cur.lastpit(), spit);
1240 cur.pos() = min(cur.lastpos(), spos);
1242 // this is the least that needs to be done (bug 6003)
1243 // in the above case, pasteParagraphList handles this
1244 cur.buffer()->updateLabels();
1245 cur.clearSelection();
1251 void Text::getWord(CursorSlice & from, CursorSlice & to,
1252 word_location const loc) const
1255 pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1259 void Text::write(ostream & os) const
1261 Buffer const & buf = owner_->buffer();
1262 ParagraphList::const_iterator pit = paragraphs().begin();
1263 ParagraphList::const_iterator end = paragraphs().end();
1265 for (; pit != end; ++pit)
1266 pit->write(os, buf.params(), dth);
1268 // Close begin_deeper
1269 for(; dth > 0; --dth)
1270 os << "\n\\end_deeper";
1274 bool Text::read(Lexer & lex,
1275 ErrorList & errorList, InsetText * insetPtr)
1277 Buffer const & buf = owner_->buffer();
1278 depth_type depth = 0;
1281 while (lex.isOK()) {
1283 string const token = lex.getString();
1288 if (token == "\\end_inset")
1291 if (token == "\\end_body")
1294 if (token == "\\begin_body")
1297 if (token == "\\end_document") {
1302 if (token == "\\begin_layout") {
1303 lex.pushToken(token);
1306 par.setInsetOwner(insetPtr);
1307 par.params().depth(depth);
1308 par.setFont(0, Font(inherit_font, buf.params().language));
1309 pars_.push_back(par);
1310 readParagraph(pars_.back(), lex, errorList);
1312 // register the words in the global word list
1313 CursorSlice sl = CursorSlice(*insetPtr);
1314 sl.pit() = pars_.size() - 1;
1315 pars_.back().updateWords();
1316 } else if (token == "\\begin_deeper") {
1318 } else if (token == "\\end_deeper") {
1320 lex.printError("\\end_deeper: " "depth is already null");
1324 LYXERR0("Handling unknown body token: `" << token << '\'');
1328 // avoid a crash on weird documents (bug 4859)
1329 if (pars_.empty()) {
1331 par.setInsetOwner(insetPtr);
1332 par.params().depth(depth);
1333 par.setFont(0, Font(inherit_font,
1334 buf.params().language));
1335 par.setPlainOrDefaultLayout(buf.params().documentClass());
1336 pars_.push_back(par);
1342 // Returns the current font and depth as a message.
1343 docstring Text::currentState(Cursor const & cur) const
1345 LASSERT(this == cur.text(), /**/);
1346 Buffer & buf = *cur.buffer();
1347 Paragraph const & par = cur.paragraph();
1348 odocstringstream os;
1350 if (buf.params().trackChanges)
1351 os << _("[Change Tracking] ");
1353 Change change = par.lookupChange(cur.pos());
1355 if (change.changed()) {
1356 Author const & a = buf.params().authors().get(change.author);
1357 os << _("Change: ") << a.name();
1358 if (!a.email().empty())
1359 os << " (" << a.email() << ")";
1360 // FIXME ctime is english, we should translate that
1361 os << _(" at ") << ctime(&change.changetime);
1365 // I think we should only show changes from the default
1367 // No, from the document font (MV)
1368 Font font = cur.real_current_font;
1369 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1371 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1373 // The paragraph depth
1374 int depth = cur.paragraph().getDepth();
1376 os << bformat(_(", Depth: %1$d"), depth);
1378 // The paragraph spacing, but only if different from
1380 Spacing const & spacing = par.params().spacing();
1381 if (!spacing.isDefault()) {
1382 os << _(", Spacing: ");
1383 switch (spacing.getSpace()) {
1384 case Spacing::Single:
1387 case Spacing::Onehalf:
1390 case Spacing::Double:
1393 case Spacing::Other:
1394 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1396 case Spacing::Default:
1397 // should never happen, do nothing
1402 #ifdef DEVEL_VERSION
1403 os << _(", Inset: ") << &cur.inset();
1404 os << _(", Paragraph: ") << cur.pit();
1405 os << _(", Id: ") << par.id();
1406 os << _(", Position: ") << cur.pos();
1407 // FIXME: Why is the check for par.size() needed?
1408 // We are called with cur.pos() == par.size() quite often.
1409 if (!par.empty() && cur.pos() < par.size()) {
1410 // Force output of code point, not character
1411 size_t const c = par.getChar(cur.pos());
1412 os << _(", Char: 0x") << hex << c;
1414 os << _(", Boundary: ") << cur.boundary();
1415 // Row & row = cur.textRow();
1416 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1422 docstring Text::getPossibleLabel(Cursor const & cur) const
1424 pit_type pit = cur.pit();
1426 Layout const * layout = &(pars_[pit].layout());
1429 docstring par_text = pars_[pit].asString();
1431 // the return string of math matrices might contain linebreaks
1432 par_text = subst(par_text, '\n', '-');
1433 for (int i = 0; i < lyxrc.label_init_length; ++i) {
1434 if (par_text.empty())
1437 par_text = split(par_text, head, ' ');
1438 // Is it legal to use spaces in labels ?
1444 // No need for a prefix if the user said so.
1445 if (lyxrc.label_init_length <= 0)
1448 // Will contain the label type.
1451 // For section, subsection, etc...
1452 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1453 Layout const * layout2 = &(pars_[pit - 1].layout());
1454 if (layout2->latextype != LATEX_PARAGRAPH) {
1459 if (layout->latextype != LATEX_PARAGRAPH)
1460 name = from_ascii(layout->latexname());
1462 // for captions, we just take the caption type
1463 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1465 name = from_ascii(static_cast<InsetCaption *>(caption_inset)->type());
1467 // If none of the above worked, we'll see if we're inside various
1468 // types of insets and take our abbreviation from them.
1470 InsetCode const codes[] = {
1475 for (unsigned int i = 0; i < (sizeof codes / sizeof codes[0]); ++i) {
1476 Inset * float_inset = cur.innerInsetOfType(codes[i]);
1478 name = float_inset->name();
1484 // Create a correct prefix for prettyref
1485 if (name == "theorem")
1486 name = from_ascii("thm");
1487 else if (name == "Foot")
1488 name = from_ascii("fn");
1489 else if (name == "listing")
1490 name = from_ascii("lst");
1493 text = name.substr(0, 3) + ':' + text;
1499 docstring Text::asString(int options) const
1501 return asString(0, pars_.size(), options);
1505 docstring Text::asString(pit_type beg, pit_type end, int options) const
1507 size_t i = size_t(beg);
1508 docstring str = pars_[i].asString(options);
1509 for (++i; i != size_t(end); ++i) {
1511 str += pars_[i].asString(options);
1518 void Text::charsTranspose(Cursor & cur)
1520 LASSERT(this == cur.text(), /**/);
1522 pos_type pos = cur.pos();
1524 // If cursor is at beginning or end of paragraph, do nothing.
1525 if (pos == cur.lastpos() || pos == 0)
1528 Paragraph & par = cur.paragraph();
1530 // Get the positions of the characters to be transposed.
1531 pos_type pos1 = pos - 1;
1532 pos_type pos2 = pos;
1534 // In change tracking mode, ignore deleted characters.
1535 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1537 if (pos2 == cur.lastpos())
1540 while (pos1 >= 0 && par.isDeleted(pos1))
1545 // Don't do anything if one of the "characters" is not regular text.
1546 if (par.isInset(pos1) || par.isInset(pos2))
1549 // Store the characters to be transposed (including font information).
1550 char_type const char1 = par.getChar(pos1);
1552 par.getFontSettings(cur.buffer()->params(), pos1);
1554 char_type const char2 = par.getChar(pos2);
1556 par.getFontSettings(cur.buffer()->params(), pos2);
1558 // And finally, we are ready to perform the transposition.
1559 // Track the changes if Change Tracking is enabled.
1560 bool const trackChanges = cur.buffer()->params().trackChanges;
1564 par.eraseChar(pos2, trackChanges);
1565 par.eraseChar(pos1, trackChanges);
1566 par.insertChar(pos1, char2, font2, trackChanges);
1567 par.insertChar(pos2, char1, font1, trackChanges);
1569 cur.checkBufferStructure();
1571 // After the transposition, move cursor to after the transposition.
1572 setCursor(cur, cur.pit(), pos2);
1577 DocIterator Text::macrocontextPosition() const
1579 return macrocontext_position_;
1583 void Text::setMacrocontextPosition(DocIterator const & pos)
1585 macrocontext_position_ = pos;
1589 docstring Text::previousWord(CursorSlice const & sl) const
1591 CursorSlice from = sl;
1592 CursorSlice to = sl;
1593 getWord(from, to, PREVIOUS_WORD);
1594 if (sl == from || to == from)
1597 Paragraph const & par = sl.paragraph();
1598 return par.asString(from.pos(), to.pos());
1602 bool Text::completionSupported(Cursor const & cur) const
1604 Paragraph const & par = cur.paragraph();
1605 return cur.pos() > 0
1606 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
1607 && !par.isWordSeparator(cur.pos() - 1);
1611 CompletionList const * Text::createCompletionList(Cursor const & cur) const
1613 return new TextCompletionList(cur);
1617 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
1619 LASSERT(cur.bv().cursor() == cur, /**/);
1621 cur.bv().cursor() = cur;
1622 if (!(cur.disp_.update() & Update::Force))
1623 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
1628 docstring Text::completionPrefix(Cursor const & cur) const
1630 return previousWord(cur.top());