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"
30 #include "ParIterator.h"
31 #include "CutAndPaste.h"
32 #include "DispatchResult.h"
34 #include "ErrorList.h"
35 #include "FuncRequest.h"
37 #include "FontIterator.h"
42 #include "Paragraph.h"
43 #include "paragraph_funcs.h"
44 #include "ParagraphParameters.h"
45 #include "TextClass.h"
46 #include "TextMetrics.h"
48 #include "WordLangTuple.h"
50 #include "insets/InsetText.h"
51 #include "insets/InsetBibitem.h"
52 #include "insets/InsetCaption.h"
53 #include "insets/InsetHFill.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/convert.h"
63 #include "support/debug.h"
64 #include "support/docstream.h"
65 #include "support/gettext.h"
66 #include "support/lstrings.h"
67 #include "support/textutils.h"
69 #include <boost/next_prior.hpp>
74 using namespace lyx::support;
78 using cap::cutSelection;
79 using cap::pasteParagraphList;
83 void readParToken(Buffer const & buf, Paragraph & par, Lexer & lex,
84 string const & token, Font & font, Change & change, ErrorList & errorList)
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 TextClass const & tclass = bp.getTextClass();
101 if (layoutname.empty())
102 layoutname = tclass.defaultLayoutName();
104 if (par.forceEmptyLayout())
105 // in this case only the empty layout is allowed
106 layoutname = tclass.emptyLayoutName();
107 else if (par.useEmptyLayout()) {
108 // in this case, default layout maps to empty layout
109 if (layoutname == tclass.defaultLayoutName())
110 layoutname = tclass.emptyLayoutName();
112 // otherwise, the empty layout maps to the default
113 if (layoutname == tclass.emptyLayoutName())
114 layoutname = tclass.defaultLayoutName();
117 bool hasLayout = tclass.hasLayout(layoutname);
120 errorList.push_back(ErrorItem(_("Unknown layout"),
121 bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
122 layoutname, from_utf8(tclass.name())), par.id(), 0, par.size()));
123 layoutname = par.useEmptyLayout() ?
124 tclass.emptyLayoutName() :
125 tclass.defaultLayoutName();
128 par.layout(bp.getTextClass()[layoutname]);
130 // Test whether the layout is obsolete.
131 LayoutPtr const & layout = par.layout();
132 if (!layout->obsoleted_by().empty())
133 par.layout(bp.getTextClass()[layout->obsoleted_by()]);
135 par.params().read(lex);
137 } else if (token == "\\end_layout") {
138 LYXERR0("Solitary \\end_layout in line " << lex.getLineNo() << "\n"
139 << "Missing \\begin_layout ?");
140 } else if (token == "\\end_inset") {
141 LYXERR0("Solitary \\end_inset in line " << lex.getLineNo() << "\n"
142 << "Missing \\begin_inset ?");
143 } else if (token == "\\begin_inset") {
144 Inset * inset = readInset(lex, buf);
146 par.insertInset(par.size(), inset, font, change);
149 docstring line = lex.getDocString();
150 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
151 par.id(), 0, par.size()));
153 } else if (token == "\\family") {
155 setLyXFamily(lex.getString(), font.fontInfo());
156 } else if (token == "\\series") {
158 setLyXSeries(lex.getString(), font.fontInfo());
159 } else if (token == "\\shape") {
161 setLyXShape(lex.getString(), font.fontInfo());
162 } else if (token == "\\size") {
164 setLyXSize(lex.getString(), font.fontInfo());
165 } else if (token == "\\lang") {
167 string const tok = lex.getString();
168 Language const * lang = languages.getLanguage(tok);
170 font.setLanguage(lang);
172 font.setLanguage(bp.language);
173 lex.printError("Unknown language `$$Token'");
175 } else if (token == "\\numeric") {
177 font.fontInfo().setNumber(font.setLyXMisc(lex.getString()));
178 } else if (token == "\\emph") {
180 font.fontInfo().setEmph(font.setLyXMisc(lex.getString()));
181 } else if (token == "\\bar") {
183 string const tok = lex.getString();
186 font.fontInfo().setUnderbar(FONT_ON);
187 else if (tok == "no")
188 font.fontInfo().setUnderbar(FONT_OFF);
189 else if (tok == "default")
190 font.fontInfo().setUnderbar(FONT_INHERIT);
192 lex.printError("Unknown bar font flag "
194 } else if (token == "\\noun") {
196 font.fontInfo().setNoun(font.setLyXMisc(lex.getString()));
197 } else if (token == "\\color") {
199 setLyXColor(lex.getString(), font.fontInfo());
200 } else if (token == "\\InsetSpace" || token == "\\SpecialChar") {
202 // Insets don't make sense in a free-spacing context! ---Kayvan
203 if (par.isFreeSpacing()) {
204 if (token == "\\InsetSpace")
205 par.appendChar(' ', font, change);
206 else if (lex.isOK()) {
208 string const next_token = lex.getString();
209 if (next_token == "\\-")
210 par.appendChar('-', font, change);
212 lex.printError("Token `$$Token' "
214 "paragraph layout!");
218 auto_ptr<Inset> inset;
219 if (token == "\\SpecialChar" )
220 inset.reset(new InsetSpecialChar);
222 inset.reset(new InsetSpace);
223 inset->read(buf, lex);
224 par.insertInset(par.size(), inset.release(),
227 } else if (token == "\\backslash") {
228 par.appendChar('\\', font, change);
229 } else if (token == "\\linebreak") {
230 auto_ptr<Inset> inset(new InsetLinebreak);
231 inset->read(buf, lex);
232 par.insertInset(par.size(), inset.release(), font, change);
233 } else if (token == "\\newline") {
234 auto_ptr<Inset> inset(new InsetNewline);
235 inset->read(buf, lex);
236 par.insertInset(par.size(), inset.release(), font, change);
237 } else if (token == "\\LyXTable") {
238 auto_ptr<Inset> inset(new InsetTabular(buf));
239 inset->read(buf, lex);
240 par.insertInset(par.size(), inset.release(), font, change);
241 } else if (token == "\\hfill") {
242 par.insertInset(par.size(), new InsetHFill, font, change);
243 } else if (token == "\\lyxline") {
244 par.insertInset(par.size(), new InsetLine, font, change);
245 } else if (token == "\\newpage") {
246 par.insertInset(par.size(), new InsetNewpage, font, change);
247 } else if (token == "\\pagebreak") {
248 par.insertInset(par.size(), new InsetPagebreak, font, change);
249 } else if (token == "\\clearpage") {
250 par.insertInset(par.size(), new InsetClearPage, font, change);
251 } else if (token == "\\cleardoublepage") {
252 par.insertInset(par.size(), new InsetClearDoublePage, font, change);
253 } else if (token == "\\change_unchanged") {
254 change = Change(Change::UNCHANGED);
255 } else if (token == "\\change_inserted") {
257 istringstream is(lex.getString());
261 if (aid >= bp.author_map.size()) {
262 errorList.push_back(ErrorItem(_("Change tracking error"),
263 bformat(_("Unknown author index for insertion: %1$d\n"), aid),
264 par.id(), 0, par.size()));
265 change = Change(Change::UNCHANGED);
267 change = Change(Change::INSERTED, bp.author_map[aid], ct);
268 } else if (token == "\\change_deleted") {
270 istringstream is(lex.getString());
274 if (aid >= bp.author_map.size()) {
275 errorList.push_back(ErrorItem(_("Change tracking error"),
276 bformat(_("Unknown author index for deletion: %1$d\n"), aid),
277 par.id(), 0, par.size()));
278 change = Change(Change::UNCHANGED);
280 change = Change(Change::DELETED, bp.author_map[aid], ct);
283 errorList.push_back(ErrorItem(_("Unknown token"),
284 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
286 par.id(), 0, par.size()));
291 void readParagraph(Buffer const & buf, Paragraph & par, Lexer & lex,
292 ErrorList & errorList)
295 string token = lex.getString();
297 Change change(Change::UNCHANGED);
300 readParToken(buf, par, lex, token, font, change, errorList);
303 token = lex.getString();
308 if (token == "\\end_layout") {
309 //Ok, paragraph finished
313 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
314 if (token == "\\begin_layout" || token == "\\end_document"
315 || token == "\\end_inset" || token == "\\begin_deeper"
316 || token == "\\end_deeper") {
317 lex.pushToken(token);
318 lyxerr << "Paragraph ended in line "
319 << lex.getLineNo() << "\n"
320 << "Missing \\end_layout.\n";
324 // Final change goes to paragraph break:
325 par.setChange(par.size(), change);
327 // Initialize begin_of_body_ on load; redoParagraph maintains
328 par.setBeginOfBody();
335 bool Text::empty() const
337 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
338 // FIXME: Should we consider the labeled type as empty too?
339 && pars_[0].layout()->labeltype == LABEL_NO_LABEL);
343 double Text::spacing(Buffer const & buffer,
344 Paragraph const & par) const
346 if (par.params().spacing().isDefault())
347 return buffer.params().spacing().getValue();
348 return par.params().spacing().getValue();
352 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
354 BOOST_ASSERT(this == cur.text());
356 Paragraph & cpar = cur.paragraph();
357 pit_type cpit = cur.pit();
359 TextClass const & tclass = cur.buffer().params().getTextClass();
360 LayoutPtr const & layout = cpar.layout();
362 // this is only allowed, if the current paragraph is not empty
363 // or caption and if it has not the keepempty flag active
364 if (cur.lastpos() == 0 && !cpar.allowEmpty() &&
365 layout->labeltype != LABEL_SENSITIVE)
368 // a layout change may affect also the following paragraph
369 recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
371 // Always break behind a space
372 // It is better to erase the space (Dekel)
373 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
374 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
376 // What should the layout for the new paragraph be?
377 bool keep_layout = inverse_logic ?
378 !layout->isEnvironment()
379 : layout->isEnvironment();
381 // We need to remember this before we break the paragraph, because
382 // that invalidates the layout variable
383 bool sensitive = layout->labeltype == LABEL_SENSITIVE;
385 // we need to set this before we insert the paragraph.
386 bool const isempty = cpar.allowEmpty() && cpar.empty();
388 lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
389 cur.pos(), keep_layout);
391 // After this, neither paragraph contains any rows!
394 pit_type next_par = cpit + 1;
396 // well this is the caption hack since one caption is really enough
399 // set to standard-layout
400 //FIXME Check if this should be emptyLayout() in some cases
401 pars_[cpit].applyLayout(tclass.defaultLayout());
403 // set to standard-layout
404 //FIXME Check if this should be emptyLayout() in some cases
405 pars_[next_par].applyLayout(tclass.defaultLayout());
408 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
409 if (!pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges))
410 break; // the character couldn't be deleted physically due to change tracking
413 updateLabels(cur.buffer());
415 // A singlePar update is not enough in this case.
416 cur.updateFlags(Update::Force);
418 // This check is necessary. Otherwise the new empty paragraph will
419 // be deleted automatically. And it is more friendly for the user!
420 if (cur.pos() != 0 || isempty)
421 setCursor(cur, cur.pit() + 1, 0);
423 setCursor(cur, cur.pit(), 0);
427 // insert a character, moves all the following breaks in the
428 // same Paragraph one to the right and make a rebreak
429 void Text::insertChar(Cursor & cur, char_type c)
431 BOOST_ASSERT(this == cur.text());
433 cur.recordUndo(INSERT_UNDO);
435 TextMetrics const & tm = cur.bv().textMetrics(this);
436 Buffer const & buffer = cur.buffer();
437 Paragraph & par = cur.paragraph();
438 // try to remove this
439 pit_type const pit = cur.pit();
441 bool const freeSpacing = par.layout()->free_spacing ||
444 if (lyxrc.auto_number) {
445 static docstring const number_operators = from_ascii("+-/*");
446 static docstring const number_unary_operators = from_ascii("+-");
447 static docstring const number_seperators = from_ascii(".,:");
449 if (cur.current_font.fontInfo().number() == FONT_ON) {
450 if (!isDigit(c) && !contains(number_operators, c) &&
451 !(contains(number_seperators, c) &&
453 cur.pos() != cur.lastpos() &&
454 tm.getDisplayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
455 tm.getDisplayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
457 number(cur); // Set current_font.number to OFF
458 } else if (isDigit(c) &&
459 cur.real_current_font.isVisibleRightToLeft()) {
460 number(cur); // Set current_font.number to ON
462 if (cur.pos() != 0) {
463 char_type const c = par.getChar(cur.pos() - 1);
464 if (contains(number_unary_operators, c) &&
466 || par.isSeparator(cur.pos() - 2)
467 || par.isNewline(cur.pos() - 2))
469 setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
471 } else if (contains(number_seperators, c)
473 && tm.getDisplayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
474 setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
481 // In Bidi text, we want spaces to be treated in a special way: spaces
482 // which are between words in different languages should get the
483 // paragraph's language; otherwise, spaces should keep the language
484 // they were originally typed in. This is only in effect while typing;
485 // after the text is already typed in, the user can always go back and
486 // explicitly set the language of a space as desired. But 99.9% of the
487 // time, what we're doing here is what the user actually meant.
489 // The following cases are the ones in which the language of the space
490 // should be changed to match that of the containing paragraph. In the
491 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
492 // represents a space, pipe (|) represents the cursor position (so the
493 // character before it is the one just typed in). The different cases
494 // are depicted logically (not visually), from left to right:
499 // Theoretically, there are other situations that we should, perhaps, deal
500 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
501 // point (to understand why, just try to create this situation...).
503 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
504 // get font in front and behind the space in question. But do NOT
505 // use getFont(cur.pos()) because the character c is not inserted yet
506 Font const pre_space_font = tm.getDisplayFont(cur.pit(), cur.pos() - 2);
507 Font const & post_space_font = cur.real_current_font;
508 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
509 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
511 if (pre_space_rtl != post_space_rtl) {
512 // Set the space's language to match the language of the
513 // adjacent character whose direction is the paragraph's
514 // direction; don't touch other properties of the font
515 Language const * lang =
516 (pre_space_rtl == par.isRTL(buffer.params())) ?
517 pre_space_font.language() : post_space_font.language();
519 Font space_font = tm.getDisplayFont(cur.pit(), cur.pos() - 1);
520 space_font.setLanguage(lang);
521 par.setFont(cur.pos() - 1, space_font);
525 // Next check, if there will be two blanks together or a blank at
526 // the beginning of a paragraph.
527 // I decided to handle blanks like normal characters, the main
528 // difference are the special checks when calculating the row.fill
529 // (blank does not count at the end of a row) and the check here
531 // When the free-spacing option is set for the current layout,
532 // disable the double-space checking
533 if (!freeSpacing && isLineSeparatorChar(c)) {
534 if (cur.pos() == 0) {
535 static bool sent_space_message = false;
536 if (!sent_space_message) {
537 cur.message(_("You cannot insert a space at the "
538 "beginning of a paragraph. Please read the Tutorial."));
539 sent_space_message = true;
543 BOOST_ASSERT(cur.pos() > 0);
544 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
545 && !par.isDeleted(cur.pos() - 1)) {
546 static bool sent_space_message = false;
547 if (!sent_space_message) {
548 cur.message(_("You cannot type two spaces this way. "
549 "Please read the Tutorial."));
550 sent_space_message = true;
556 par.insertChar(cur.pos(), c, cur.current_font, cur.buffer().params().trackChanges);
557 cur.checkBufferStructure();
559 // cur.updateFlags(Update::Force);
560 setCursor(cur.top(), cur.pit(), cur.pos() + 1);
565 void Text::charInserted(Cursor & cur)
567 // Here we call finishUndo for every 20 characters inserted.
568 // This is from my experience how emacs does it. (Lgb)
569 static unsigned int counter;
579 // the cursor set functions have a special mechanism. When they
580 // realize, that you left an empty paragraph, they will delete it.
582 bool Text::cursorForwardOneWord(Cursor & cur)
584 BOOST_ASSERT(this == cur.text());
588 if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
592 // Advance through word.
593 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
595 // Skip through trailing nonword stuff.
596 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
599 return setCursor(cur, old.pit(), old.pos());
603 bool Text::cursorBackwardOneWord(Cursor & cur)
605 BOOST_ASSERT(this == cur.text());
609 if (old.pos() == 0 && old.pit() != 0) {
611 old.pos() = old.lastpos();
613 // Skip through initial nonword stuff.
614 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
616 // Advance through word.
617 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
620 return setCursor(cur, old.pit(), old.pos());
624 void Text::selectWord(Cursor & cur, word_location loc)
626 BOOST_ASSERT(this == cur.text());
627 CursorSlice from = cur.top();
628 CursorSlice to = cur.top();
629 getWord(from, to, loc);
630 if (cur.top() != from)
631 setCursor(cur, from.pit(), from.pos());
635 setCursor(cur, to.pit(), to.pos());
640 // Select the word currently under the cursor when no
641 // selection is currently set
642 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
644 BOOST_ASSERT(this == cur.text());
647 selectWord(cur, loc);
648 return cur.selection();
652 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
654 BOOST_ASSERT(this == cur.text());
656 if (!cur.selection())
659 cur.recordUndoSelection();
661 pit_type begPit = cur.selectionBegin().pit();
662 pit_type endPit = cur.selectionEnd().pit();
664 pos_type begPos = cur.selectionBegin().pos();
665 pos_type endPos = cur.selectionEnd().pos();
667 // keep selection info, because endPos becomes invalid after the first loop
668 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
670 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
672 for (pit_type pit = begPit; pit <= endPit; ++pit) {
673 pos_type parSize = pars_[pit].size();
675 // ignore empty paragraphs; otherwise, an assertion will fail for
676 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
680 // do not consider first paragraph if the cursor starts at pos size()
681 if (pit == begPit && begPos == parSize)
684 // do not consider last paragraph if the cursor ends at pos 0
685 if (pit == endPit && endPos == 0)
686 break; // last iteration anyway
688 pos_type left = (pit == begPit ? begPos : 0);
689 pos_type right = (pit == endPit ? endPos : parSize);
692 pars_[pit].acceptChanges(cur.buffer().params(), left, right);
694 pars_[pit].rejectChanges(cur.buffer().params(), left, right);
698 // next, accept/reject imaginary end-of-par characters
700 for (pit_type pit = begPit; pit <= endPit; ++pit) {
701 pos_type pos = pars_[pit].size();
703 // skip if the selection ends before the end-of-par
704 if (pit == endPit && endsBeforeEndOfPar)
705 break; // last iteration anyway
707 // skip if this is not the last paragraph of the document
708 // note: the user should be able to accept/reject the par break of the last par!
709 if (pit == endPit && pit + 1 != int(pars_.size()))
710 break; // last iteration anway
713 if (pars_[pit].isInserted(pos)) {
714 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
715 } else if (pars_[pit].isDeleted(pos)) {
716 if (pit + 1 == int(pars_.size())) {
717 // we cannot remove a par break at the end of the last paragraph;
718 // instead, we mark it unchanged
719 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
721 mergeParagraph(cur.buffer().params(), pars_, pit);
727 if (pars_[pit].isDeleted(pos)) {
728 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
729 } else if (pars_[pit].isInserted(pos)) {
730 if (pit + 1 == int(pars_.size())) {
731 // we mark the par break at the end of the last paragraph unchanged
732 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
734 mergeParagraph(cur.buffer().params(), pars_, pit);
742 // finally, invoke the DEPM
744 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer().params().trackChanges);
749 cur.clearSelection();
750 setCursorIntern(cur, begPit, begPos);
751 cur.updateFlags(Update::Force);
752 updateLabels(cur.buffer());
756 void Text::acceptChanges(BufferParams const & bparams)
758 lyx::acceptChanges(pars_, bparams);
759 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.trackChanges);
763 void Text::rejectChanges(BufferParams const & bparams)
765 pit_type pars_size = static_cast<pit_type>(pars_.size());
767 // first, reject changes within each individual paragraph
768 // (do not consider end-of-par)
769 for (pit_type pit = 0; pit < pars_size; ++pit) {
770 if (!pars_[pit].empty()) // prevent assertion failure
771 pars_[pit].rejectChanges(bparams, 0, pars_[pit].size());
774 // next, reject imaginary end-of-par characters
775 for (pit_type pit = 0; pit < pars_size; ++pit) {
776 pos_type pos = pars_[pit].size();
778 if (pars_[pit].isDeleted(pos)) {
779 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
780 } else if (pars_[pit].isInserted(pos)) {
781 if (pit == pars_size - 1) {
782 // we mark the par break at the end of the last
783 // paragraph unchanged
784 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
786 mergeParagraph(bparams, pars_, pit);
793 // finally, invoke the DEPM
794 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.trackChanges);
798 void Text::deleteWordForward(Cursor & cur)
800 BOOST_ASSERT(this == cur.text());
801 if (cur.lastpos() == 0)
805 cur.selection() = true;
806 cursorForwardOneWord(cur);
808 cutSelection(cur, true, false);
809 cur.checkBufferStructure();
814 void Text::deleteWordBackward(Cursor & cur)
816 BOOST_ASSERT(this == cur.text());
817 if (cur.lastpos() == 0)
821 cur.selection() = true;
822 cursorBackwardOneWord(cur);
824 cutSelection(cur, true, false);
825 cur.checkBufferStructure();
830 // Kill to end of line.
831 void Text::changeCase(Cursor & cur, TextCase action)
833 BOOST_ASSERT(this == cur.text());
838 if (cur.selection()) {
839 from = cur.selBegin();
844 getWord(from, to, PARTIAL_WORD);
845 cursorForwardOneWord(cur);
848 cur.recordUndoSelection();
850 pit_type begPit = from.pit();
851 pit_type endPit = to.pit();
853 pos_type begPos = from.pos();
854 pos_type endPos = to.pos();
856 pos_type right = 0; // needed after the for loop
858 for (pit_type pit = begPit; pit <= endPit; ++pit) {
859 Paragraph & par = pars_[pit];
860 pos_type const pos = (pit == begPit ? begPos : 0);
861 right = (pit == endPit ? endPos : par.size());
862 par.changeCase(cur.buffer().params(), pos, right, action);
865 // the selection may have changed due to logically-only deleted chars
867 setCursor(cur, begPit, begPos);
869 setCursor(cur, endPit, right);
872 setCursor(cur, endPit, right);
874 cur.checkBufferStructure();
878 bool Text::handleBibitems(Cursor & cur)
880 if (cur.paragraph().layout()->labeltype != LABEL_BIBLIO)
886 BufferParams const & bufparams = cur.buffer().params();
887 Paragraph const & par = cur.paragraph();
888 Cursor prevcur = cur;
891 prevcur.pos() = prevcur.lastpos();
893 Paragraph const & prevpar = prevcur.paragraph();
895 // if a bibitem is deleted, merge with previous paragraph
896 // if this is a bibliography item as well
897 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
898 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
899 mergeParagraph(bufparams, cur.text()->paragraphs(),
901 updateLabels(cur.buffer());
902 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
903 cur.updateFlags(Update::Force);
907 // otherwise reset to default
908 if (par.useEmptyLayout())
909 cur.paragraph().layout(bufparams.getTextClass().emptyLayout());
911 cur.paragraph().layout(bufparams.getTextClass().defaultLayout());
916 bool Text::erase(Cursor & cur)
918 BOOST_ASSERT(this == cur.text());
919 bool needsUpdate = false;
920 Paragraph & par = cur.paragraph();
922 if (cur.pos() != cur.lastpos()) {
923 // this is the code for a normal delete, not pasting
925 cur.recordUndo(DELETE_UNDO);
926 bool const was_inset = cur.paragraph().isInset(cur.pos());
927 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges))
928 // the character has been logically deleted only => skip it
929 cur.top().forwardPos();
932 updateLabels(cur.buffer());
934 cur.checkBufferStructure();
937 if (cur.pit() == cur.lastpit())
938 return dissolveInset(cur);
940 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
941 par.setChange(cur.pos(), Change(Change::DELETED));
945 setCursorIntern(cur, cur.pit() + 1, 0);
946 needsUpdate = backspacePos0(cur);
950 needsUpdate |= handleBibitems(cur);
953 // Make sure the cursor is correct. Is this really needed?
954 // No, not really... at least not here!
955 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
956 cur.checkBufferStructure();
963 bool Text::backspacePos0(Cursor & cur)
965 BOOST_ASSERT(this == cur.text());
969 bool needsUpdate = false;
971 BufferParams const & bufparams = cur.buffer().params();
972 TextClass const & tclass = bufparams.getTextClass();
973 ParagraphList & plist = cur.text()->paragraphs();
974 Paragraph const & par = cur.paragraph();
975 Cursor prevcur = cur;
977 prevcur.pos() = prevcur.lastpos();
978 Paragraph const & prevpar = prevcur.paragraph();
980 // is it an empty paragraph?
981 if (cur.lastpos() == 0
982 || (cur.lastpos() == 1 && par.isSeparator(0))) {
983 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
984 plist.erase(boost::next(plist.begin(), cur.pit()));
987 // is previous par empty?
988 else if (prevcur.lastpos() == 0
989 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
990 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
991 plist.erase(boost::next(plist.begin(), prevcur.pit()));
994 // Pasting is not allowed, if the paragraphs have different
995 // layouts. I think it is a real bug of all other
996 // word processors to allow it. It confuses the user.
997 // Correction: Pasting is always allowed with standard-layout
998 // or the empty layout.
999 else if (par.layout() == prevpar.layout()
1000 || par.layout() == tclass.defaultLayout()
1001 || par.layout() == tclass.emptyLayout()) {
1002 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1003 mergeParagraph(bufparams, plist, prevcur.pit());
1008 updateLabels(cur.buffer());
1009 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1016 bool Text::backspace(Cursor & cur)
1018 BOOST_ASSERT(this == cur.text());
1019 bool needsUpdate = false;
1020 if (cur.pos() == 0) {
1022 return dissolveInset(cur);
1024 Paragraph & prev_par = pars_[cur.pit() - 1];
1026 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1027 prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1028 setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1031 // The cursor is at the beginning of a paragraph, so
1032 // the backspace will collapse two paragraphs into one.
1033 needsUpdate = backspacePos0(cur);
1036 // this is the code for a normal backspace, not pasting
1038 cur.recordUndo(DELETE_UNDO);
1039 // We used to do cursorBackwardIntern() here, but it is
1040 // not a good idea since it triggers the auto-delete
1041 // mechanism. So we do a cursorBackwardIntern()-lite,
1042 // without the dreaded mechanism. (JMarc)
1043 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1044 false, cur.boundary());
1045 bool const was_inset = cur.paragraph().isInset(cur.pos());
1046 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1048 updateLabels(cur.buffer());
1050 cur.checkBufferStructure();
1053 if (cur.pos() == cur.lastpos())
1054 cur.setCurrentFont();
1056 needsUpdate |= handleBibitems(cur);
1058 // A singlePar update is not enough in this case.
1059 // cur.updateFlags(Update::Force);
1060 setCursor(cur.top(), cur.pit(), cur.pos());
1066 bool Text::dissolveInset(Cursor & cur) {
1067 BOOST_ASSERT(this == cur.text());
1069 if (isMainText(cur.bv().buffer()) || cur.inset().nargs() != 1)
1072 cur.recordUndoInset();
1074 cur.selHandle(false);
1076 pos_type spos = cur.pos();
1077 pit_type spit = cur.pit();
1078 ParagraphList plist;
1079 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1080 plist = paragraphs();
1082 // store cursor offset
1086 Buffer & b = cur.buffer();
1087 cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1088 if (!plist.empty()) {
1089 // ERT paragraphs have the Language latex_language.
1090 // This is invalid outside of ERT, so we need to
1091 // change it to the buffer language.
1092 ParagraphList::iterator it = plist.begin();
1093 ParagraphList::iterator it_end = plist.end();
1094 for (; it != it_end; it++)
1095 it->changeLanguage(b.params(), latex_language, b.language());
1097 pasteParagraphList(cur, plist, b.params().getTextClassPtr(),
1098 b.errorList("Paste"));
1100 cur.pit() = min(cur.lastpit(), spit);
1101 cur.pos() = min(cur.lastpos(), spos);
1103 cur.clearSelection();
1109 void Text::getWord(CursorSlice & from, CursorSlice & to,
1110 word_location const loc)
1112 Paragraph const & from_par = pars_[from.pit()];
1114 case WHOLE_WORD_STRICT:
1115 if (from.pos() == 0 || from.pos() == from_par.size()
1116 || !from_par.isLetter(from.pos())
1117 || !from_par.isLetter(from.pos() - 1)) {
1121 // no break here, we go to the next
1124 // If we are already at the beginning of a word, do nothing
1125 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1127 // no break here, we go to the next
1130 // always move the cursor to the beginning of previous word
1131 while (from.pos() && from_par.isLetter(from.pos() - 1))
1135 LYXERR0("Text::getWord: NEXT_WORD not implemented yet");
1138 // no need to move the 'from' cursor
1142 Paragraph & to_par = pars_[to.pit()];
1143 while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1148 void Text::write(Buffer const & buf, ostream & os) const
1150 ParagraphList::const_iterator pit = paragraphs().begin();
1151 ParagraphList::const_iterator end = paragraphs().end();
1153 for (; pit != end; ++pit)
1154 pit->write(buf, os, buf.params(), dth);
1156 // Close begin_deeper
1157 for(; dth > 0; --dth)
1158 os << "\n\\end_deeper";
1162 bool Text::read(Buffer const & buf, Lexer & lex, ErrorList & errorList)
1164 depth_type depth = 0;
1166 while (lex.isOK()) {
1168 string const token = lex.getString();
1173 if (token == "\\end_inset")
1176 if (token == "\\end_body")
1179 if (token == "\\begin_body")
1182 if (token == "\\end_document")
1185 if (token == "\\begin_layout") {
1186 lex.pushToken(token);
1189 par.params().depth(depth);
1190 par.setFont(0, Font(inherit_font, buf.params().language));
1191 pars_.push_back(par);
1193 // FIXME: goddamn InsetTabular makes us pass a Buffer
1195 lyx::readParagraph(buf, pars_.back(), lex, errorList);
1197 } else if (token == "\\begin_deeper") {
1199 } else if (token == "\\end_deeper") {
1201 lex.printError("\\end_deeper: " "depth is already null");
1205 LYXERR0("Handling unknown body token: `" << token << '\'');
1211 // Returns the current font and depth as a message.
1212 docstring Text::currentState(Cursor & cur)
1214 BOOST_ASSERT(this == cur.text());
1215 Buffer & buf = cur.buffer();
1216 Paragraph const & par = cur.paragraph();
1217 odocstringstream os;
1219 if (buf.params().trackChanges)
1220 os << _("[Change Tracking] ");
1222 Change change = par.lookupChange(cur.pos());
1224 if (change.type != Change::UNCHANGED) {
1225 Author const & a = buf.params().authors().get(change.author);
1226 os << _("Change: ") << a.name();
1227 if (!a.email().empty())
1228 os << " (" << a.email() << ")";
1229 // FIXME ctime is english, we should translate that
1230 os << _(" at ") << ctime(&change.changetime);
1234 // I think we should only show changes from the default
1236 // No, from the document font (MV)
1237 Font font = cur.real_current_font;
1238 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1240 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1242 // The paragraph depth
1243 int depth = cur.paragraph().getDepth();
1245 os << bformat(_(", Depth: %1$d"), depth);
1247 // The paragraph spacing, but only if different from
1249 Spacing const & spacing = par.params().spacing();
1250 if (!spacing.isDefault()) {
1251 os << _(", Spacing: ");
1252 switch (spacing.getSpace()) {
1253 case Spacing::Single:
1256 case Spacing::Onehalf:
1259 case Spacing::Double:
1262 case Spacing::Other:
1263 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1265 case Spacing::Default:
1266 // should never happen, do nothing
1271 #ifdef DEVEL_VERSION
1272 os << _(", Inset: ") << &cur.inset();
1273 os << _(", Paragraph: ") << cur.pit();
1274 os << _(", Id: ") << par.id();
1275 os << _(", Position: ") << cur.pos();
1276 // FIXME: Why is the check for par.size() needed?
1277 // We are called with cur.pos() == par.size() quite often.
1278 if (!par.empty() && cur.pos() < par.size()) {
1279 // Force output of code point, not character
1280 size_t const c = par.getChar(cur.pos());
1281 os << _(", Char: 0x") << hex << c;
1283 os << _(", Boundary: ") << cur.boundary();
1284 // Row & row = cur.textRow();
1285 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1291 docstring Text::getPossibleLabel(Cursor & cur) const
1293 pit_type pit = cur.pit();
1295 LayoutPtr layout = pars_[pit].layout();
1298 docstring par_text = pars_[pit].asString(cur.buffer(), false);
1300 // the return string of math matrices might contain linebreaks
1301 par_text = subst(par_text, '\n', '-');
1302 for (int i = 0; i < lyxrc.label_init_length; ++i) {
1303 if (par_text.empty())
1306 par_text = split(par_text, head, ' ');
1307 // Is it legal to use spaces in labels ?
1313 // No need for a prefix if the user said so.
1314 if (lyxrc.label_init_length <= 0)
1317 // Will contain the label type.
1320 // For section, subsection, etc...
1321 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1322 LayoutPtr const & layout2 = pars_[pit - 1].layout();
1323 if (layout2->latextype != LATEX_PARAGRAPH) {
1328 if (layout->latextype != LATEX_PARAGRAPH)
1329 name = from_ascii(layout->latexname());
1331 // for captions, we just take the caption type
1332 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1334 name = from_ascii(static_cast<InsetCaption *>(caption_inset)->type());
1336 // If none of the above worked, we'll see if we're inside various
1337 // types of insets and take our abbreviation from them.
1339 InsetCode const codes[] = {
1344 for (unsigned int i = 0; i < (sizeof codes / sizeof codes[0]); ++i) {
1345 Inset * float_inset = cur.innerInsetOfType(codes[i]);
1347 name = float_inset->name();
1353 // Create a correct prefix for prettyref
1354 if (name == "theorem")
1355 name = from_ascii("thm");
1356 else if (name == "Foot")
1357 name = from_ascii("fn");
1358 else if (name == "listing")
1359 name = from_ascii("lst");
1362 text = name.substr(0, 3) + ':' + text;
1368 void Text::charsTranspose(Cursor & cur)
1370 BOOST_ASSERT(this == cur.text());
1372 pos_type pos = cur.pos();
1374 // If cursor is at beginning or end of paragraph, do nothing.
1375 if (pos == cur.lastpos() || pos == 0)
1378 Paragraph & par = cur.paragraph();
1380 // Get the positions of the characters to be transposed.
1381 pos_type pos1 = pos - 1;
1382 pos_type pos2 = pos;
1384 // In change tracking mode, ignore deleted characters.
1385 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1387 if (pos2 == cur.lastpos())
1390 while (pos1 >= 0 && par.isDeleted(pos1))
1395 // Don't do anything if one of the "characters" is not regular text.
1396 if (par.isInset(pos1) || par.isInset(pos2))
1399 // Store the characters to be transposed (including font information).
1400 char_type char1 = par.getChar(pos1);
1402 par.getFontSettings(cur.buffer().params(), pos1);
1404 char_type char2 = par.getChar(pos2);
1406 par.getFontSettings(cur.buffer().params(), pos2);
1408 // And finally, we are ready to perform the transposition.
1409 // Track the changes if Change Tracking is enabled.
1410 bool const trackChanges = cur.buffer().params().trackChanges;
1414 par.eraseChar(pos2, trackChanges);
1415 par.eraseChar(pos1, trackChanges);
1416 par.insertChar(pos1, char2, font2, trackChanges);
1417 par.insertChar(pos2, char1, font1, trackChanges);
1419 cur.checkBufferStructure();
1421 // After the transposition, move cursor to after the transposition.
1422 setCursor(cur, cur.pit(), pos2);
1427 DocIterator Text::macrocontextPosition() const
1429 return macrocontext_position_;
1433 void Text::setMacrocontextPosition(DocIterator const & pos)
1435 macrocontext_position_ = pos;