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"
37 #include "InsetList.h"
44 #include "Paragraph.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
47 #include "TextClass.h"
48 #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/InsetNewline.h"
56 #include "insets/InsetNewpage.h"
57 #include "insets/InsetArgument.h"
58 #include "insets/InsetIPAMacro.h"
59 #include "insets/InsetSpace.h"
60 #include "insets/InsetSpecialChar.h"
61 #include "insets/InsetTabular.h"
63 #include "support/convert.h"
64 #include "support/debug.h"
65 #include "support/docstream.h"
66 #include "support/gettext.h"
67 #include "support/lassert.h"
68 #include "support/lstrings.h"
69 #include "support/lyxalgo.h"
70 #include "support/lyxtime.h"
71 #include "support/textutils.h"
72 #include "support/unique_ptr.h"
78 using namespace lyx::support;
82 using cap::cutSelection;
83 using cap::pasteParagraphList;
85 static bool moveItem(Paragraph & fromPar, pos_type fromPos,
86 Paragraph & toPar, pos_type toPos, BufferParams const & params)
88 // Note: moveItem() does not honour change tracking!
89 // Therefore, it should only be used for breaking and merging paragraphs
91 // We need a copy here because the character at fromPos is going to be erased.
92 Font const tmpFont = fromPar.getFontSettings(params, fromPos);
93 Change const tmpChange = fromPar.lookupChange(fromPos);
95 if (Inset * tmpInset = fromPar.getInset(fromPos)) {
96 fromPar.releaseInset(fromPos);
97 // The inset is not in fromPar any more.
98 if (!toPar.insertInset(toPos, tmpInset, tmpFont, tmpChange)) {
105 char_type const tmpChar = fromPar.getChar(fromPos);
106 fromPar.eraseChar(fromPos, false);
107 toPar.insertChar(toPos, tmpChar, tmpFont, tmpChange);
112 void breakParagraphConservative(BufferParams const & bparams,
113 ParagraphList & pars, pit_type pit, pos_type pos)
115 // create a new paragraph
116 Paragraph & tmp = *pars.insert(lyx::next(pars.begin(), pit + 1),
118 Paragraph & par = pars[pit];
120 tmp.setInsetOwner(&par.inInset());
121 tmp.makeSameLayout(par);
123 LASSERT(pos <= par.size(), return);
125 if (pos < par.size()) {
126 // move everything behind the break position to the new paragraph
127 pos_type pos_end = par.size() - 1;
129 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
130 if (moveItem(par, pos, tmp, j, bparams)) {
134 // Move over the end-of-par change information
135 tmp.setChange(tmp.size(), par.lookupChange(par.size()));
136 par.setChange(par.size(), Change(bparams.track_changes ?
137 Change::INSERTED : Change::UNCHANGED));
142 void mergeParagraph(BufferParams const & bparams,
143 ParagraphList & pars, pit_type par_offset)
145 Paragraph & next = pars[par_offset + 1];
146 Paragraph & par = pars[par_offset];
148 pos_type pos_end = next.size() - 1;
149 pos_type pos_insert = par.size();
151 // the imaginary end-of-paragraph character (at par.size()) has to be
152 // marked as unmodified. Otherwise, its change is adopted by the first
153 // character of the next paragraph.
154 if (par.isChanged(par.size())) {
155 LYXERR(Debug::CHANGES,
156 "merging par with inserted/deleted end-of-par character");
157 par.setChange(par.size(), Change(Change::UNCHANGED));
160 Change change = next.lookupChange(next.size());
162 // move the content of the second paragraph to the end of the first one
163 for (pos_type i = 0, j = pos_insert; i <= pos_end; ++i) {
164 if (moveItem(next, 0, par, j, bparams)) {
169 // move the change of the end-of-paragraph character
170 par.setChange(par.size(), change);
172 pars.erase(lyx::next(pars.begin(), par_offset + 1));
176 Text::Text(InsetText * owner, bool use_default_layout)
179 pars_.push_back(Paragraph());
180 Paragraph & par = pars_.back();
181 par.setInsetOwner(owner);
182 DocumentClass const & dc = owner->buffer().params().documentClass();
183 if (use_default_layout)
184 par.setDefaultLayout(dc);
186 par.setPlainLayout(dc);
190 Text::Text(InsetText * owner, Text const & text)
191 : owner_(owner), pars_(text.pars_)
193 for (auto & p : pars_)
194 p.setInsetOwner(owner);
198 pit_type Text::depthHook(pit_type pit, depth_type depth) const
200 pit_type newpit = pit;
205 while (newpit != 0 && pars_[newpit].getDepth() > depth)
208 if (pars_[newpit].getDepth() > depth)
215 pit_type Text::outerHook(pit_type par_offset) const
217 Paragraph const & par = pars_[par_offset];
219 if (par.getDepth() == 0)
221 return depthHook(par_offset, depth_type(par.getDepth() - 1));
225 bool Text::isFirstInSequence(pit_type par_offset) const
227 Paragraph const & par = pars_[par_offset];
229 pit_type dhook_offset = depthHook(par_offset, par.getDepth());
231 if (dhook_offset == par_offset)
234 Paragraph const & dhook = pars_[dhook_offset];
236 return dhook.layout() != par.layout()
237 || dhook.getDepth() != par.getDepth();
241 pit_type Text::lastInSequence(pit_type pit) const
243 depth_type const depth = pars_[pit].getDepth();
244 pit_type newpit = pit;
246 while (size_t(newpit + 1) < pars_.size() &&
247 (pars_[newpit + 1].getDepth() > depth ||
248 (pars_[newpit + 1].getDepth() == depth &&
249 pars_[newpit + 1].layout() == pars_[pit].layout())))
256 int Text::getTocLevel(pit_type par_offset) const
258 Paragraph const & par = pars_[par_offset];
260 if (par.layout().isEnvironment() && !isFirstInSequence(par_offset))
261 return Layout::NOT_IN_TOC;
263 return par.layout().toclevel;
267 Font const Text::outerFont(pit_type par_offset) const
269 depth_type par_depth = pars_[par_offset].getDepth();
270 FontInfo tmpfont = inherit_font;
271 depth_type prev_par_depth = 0;
272 // Resolve against environment font information
273 while (par_offset != pit_type(pars_.size())
274 && par_depth != prev_par_depth
276 && !tmpfont.resolved()) {
277 prev_par_depth = par_depth;
278 par_offset = outerHook(par_offset);
279 if (par_offset != pit_type(pars_.size())) {
280 tmpfont.realize(pars_[par_offset].layout().font);
281 par_depth = pars_[par_offset].getDepth();
285 return Font(tmpfont);
289 int Text::getEndLabel(pit_type p) const
292 depth_type par_depth = pars_[p].getDepth();
293 while (pit != pit_type(pars_.size())) {
294 Layout const & layout = pars_[pit].layout();
295 int const endlabeltype = layout.endlabeltype;
297 if (endlabeltype != END_LABEL_NO_LABEL) {
298 if (p + 1 == pit_type(pars_.size()))
301 depth_type const next_depth =
302 pars_[p + 1].getDepth();
303 if (par_depth > next_depth ||
304 (par_depth == next_depth && layout != pars_[p + 1].layout()))
310 pit = outerHook(pit);
311 if (pit != pit_type(pars_.size()))
312 par_depth = pars_[pit].getDepth();
314 return END_LABEL_NO_LABEL;
318 static void acceptOrRejectChanges(ParagraphList & pars,
319 BufferParams const & bparams, Text::ChangeOp op)
321 pit_type pars_size = static_cast<pit_type>(pars.size());
323 // first, accept or reject changes within each individual
324 // paragraph (do not consider end-of-par)
325 for (pit_type pit = 0; pit < pars_size; ++pit) {
326 // prevent assertion failure
327 if (!pars[pit].empty()) {
328 if (op == Text::ACCEPT)
329 pars[pit].acceptChanges(0, pars[pit].size());
331 pars[pit].rejectChanges(0, pars[pit].size());
335 // next, accept or reject imaginary end-of-par characters
336 for (pit_type pit = 0; pit < pars_size; ++pit) {
337 pos_type pos = pars[pit].size();
338 if (pars[pit].isChanged(pos)) {
339 // keep the end-of-par char if it is inserted and accepted
340 // or when it is deleted and rejected.
341 if (pars[pit].isInserted(pos) == (op == Text::ACCEPT)) {
342 pars[pit].setChange(pos, Change(Change::UNCHANGED));
344 if (pit == pars_size - 1) {
345 // we cannot remove a par break at the end of the last
346 // paragraph; instead, we mark it unchanged
347 pars[pit].setChange(pos, Change(Change::UNCHANGED));
349 mergeParagraph(bparams, pars, pit);
359 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
361 acceptOrRejectChanges(pars, bparams, Text::ACCEPT);
365 void rejectChanges(ParagraphList & pars, BufferParams const & bparams)
367 acceptOrRejectChanges(pars, bparams, Text::REJECT);
371 InsetText const & Text::inset() const
378 void Text::readParToken(Paragraph & par, Lexer & lex,
379 string const & token, Font & font, Change & change, ErrorList & errorList)
381 Buffer * buf = const_cast<Buffer *>(&owner_->buffer());
382 BufferParams & bp = buf->params();
384 if (token[0] != '\\') {
385 docstring dstr = lex.getDocString();
386 par.appendString(dstr, font, change);
388 } else if (token == "\\begin_layout") {
390 docstring layoutname = lex.getDocString();
392 font = Font(inherit_font, bp.language);
393 change = Change(Change::UNCHANGED);
395 DocumentClass const & tclass = bp.documentClass();
397 if (layoutname.empty())
398 layoutname = tclass.defaultLayoutName();
400 if (owner_->forcePlainLayout()) {
401 // in this case only the empty layout is allowed
402 layoutname = tclass.plainLayoutName();
403 } else if (par.usePlainLayout()) {
404 // in this case, default layout maps to empty layout
405 if (layoutname == tclass.defaultLayoutName())
406 layoutname = tclass.plainLayoutName();
408 // otherwise, the empty layout maps to the default
409 if (layoutname == tclass.plainLayoutName())
410 layoutname = tclass.defaultLayoutName();
413 // When we apply an unknown layout to a document, we add this layout to the textclass
414 // of this document. For example, when you apply class article to a beamer document,
415 // all unknown layouts such as frame will be added to document class article so that
416 // these layouts can keep their original names.
417 bool const added_one = tclass.addLayoutIfNeeded(layoutname);
420 docstring const s = bformat(_("Layout `%1$s' was not found."), layoutname);
421 errorList.push_back(ErrorItem(_("Layout Not Found"), s,
422 {par.id(), 0}, {par.id(), -1}));
425 par.setLayout(bp.documentClass()[layoutname]);
427 // Test whether the layout is obsolete.
428 Layout const & layout = par.layout();
429 if (!layout.obsoleted_by().empty())
430 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
432 par.params().read(lex);
434 } else if (token == "\\end_layout") {
435 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
436 << "Missing \\begin_layout ?");
437 } else if (token == "\\end_inset") {
438 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
439 << "Missing \\begin_inset ?");
440 } else if (token == "\\begin_inset") {
441 Inset * inset = readInset(lex, buf);
443 par.insertInset(par.size(), inset, font, change);
446 docstring line = lex.getDocString();
447 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
448 {par.id(), 0}, {par.id(), -1}));
450 } else if (token == "\\family") {
452 setLyXFamily(lex.getString(), font.fontInfo());
453 } else if (token == "\\series") {
455 setLyXSeries(lex.getString(), font.fontInfo());
456 } else if (token == "\\shape") {
458 setLyXShape(lex.getString(), font.fontInfo());
459 } else if (token == "\\size") {
461 setLyXSize(lex.getString(), font.fontInfo());
462 } else if (token == "\\lang") {
464 string const tok = lex.getString();
465 Language const * lang = languages.getLanguage(tok);
467 font.setLanguage(lang);
469 font.setLanguage(bp.language);
470 lex.printError("Unknown language `$$Token'");
472 } else if (token == "\\numeric") {
474 font.fontInfo().setNumber(setLyXMisc(lex.getString()));
475 } else if (token == "\\nospellcheck") {
477 font.fontInfo().setNoSpellcheck(setLyXMisc(lex.getString()));
478 } else if (token == "\\emph") {
480 font.fontInfo().setEmph(setLyXMisc(lex.getString()));
481 } else if (token == "\\bar") {
483 string const tok = lex.getString();
486 font.fontInfo().setUnderbar(FONT_ON);
487 else if (tok == "no")
488 font.fontInfo().setUnderbar(FONT_OFF);
489 else if (tok == "default")
490 font.fontInfo().setUnderbar(FONT_INHERIT);
492 lex.printError("Unknown bar font flag "
494 } else if (token == "\\strikeout") {
496 font.fontInfo().setStrikeout(setLyXMisc(lex.getString()));
497 } else if (token == "\\xout") {
499 font.fontInfo().setXout(setLyXMisc(lex.getString()));
500 } else if (token == "\\uuline") {
502 font.fontInfo().setUuline(setLyXMisc(lex.getString()));
503 } else if (token == "\\uwave") {
505 font.fontInfo().setUwave(setLyXMisc(lex.getString()));
506 } else if (token == "\\noun") {
508 font.fontInfo().setNoun(setLyXMisc(lex.getString()));
509 } else if (token == "\\color") {
511 setLyXColor(lex.getString(), font.fontInfo());
512 } else if (token == "\\SpecialChar" ||
513 (token == "\\SpecialCharNoPassThru" &&
514 !par.layout().pass_thru && !inset().isPassThru())) {
515 auto inset = make_unique<InsetSpecialChar>();
517 inset->setBuffer(*buf);
518 par.insertInset(par.size(), inset.release(), font, change);
519 } else if (token == "\\SpecialCharNoPassThru") {
521 docstring const s = ltrim(lex.getDocString(), "\\");
522 par.insert(par.size(), s, font, change);
523 } else if (token == "\\IPAChar") {
524 auto inset = make_unique<InsetIPAChar>();
526 inset->setBuffer(*buf);
527 par.insertInset(par.size(), inset.release(), font, change);
528 } else if (token == "\\twohyphens" || token == "\\threehyphens") {
529 // Ideally, this should be done by lyx2lyx, but lyx2lyx does not know the
530 // running font and does not know anything about layouts (and CopyStyle).
531 Layout const & layout(par.layout());
532 FontInfo info = font.fontInfo();
533 info.realize(layout.resfont);
534 if (layout.pass_thru || inset().isPassThru() ||
535 info.family() == TYPEWRITER_FAMILY) {
536 if (token == "\\twohyphens")
537 par.insert(par.size(), from_ascii("--"), font, change);
539 par.insert(par.size(), from_ascii("---"), font, change);
541 if (token == "\\twohyphens")
542 par.insertChar(par.size(), 0x2013, font, change);
544 par.insertChar(par.size(), 0x2014, font, change);
546 } else if (token == "\\backslash") {
547 par.appendChar('\\', font, change);
548 } else if (token == "\\LyXTable") {
549 auto inset = make_unique<InsetTabular>(buf);
551 par.insertInset(par.size(), inset.release(), font, change);
552 } else if (token == "\\change_unchanged") {
553 change = Change(Change::UNCHANGED);
554 } else if (token == "\\change_inserted" || token == "\\change_deleted") {
556 istringstream is(lex.getString());
560 BufferParams::AuthorMap const & am = bp.author_map_;
561 if (am.find(aid) == am.end()) {
562 errorList.push_back(ErrorItem(
563 _("Change tracking author index missing"),
564 bformat(_("A change tracking author information for index "
565 "%1$d is missing. This can happen after a wrong "
566 "merge by a version control system. In this case, "
567 "either fix the merge, or have this information "
568 "missing until the corresponding tracked changes "
569 "are merged or this user edits the file again.\n"),
571 {par.id(), par.size()}, {par.id(), par.size() + 1}));
572 bp.addAuthor(Author(aid));
574 if (token == "\\change_inserted")
575 change = Change(Change::INSERTED, am.find(aid)->second, ct);
577 change = Change(Change::DELETED, am.find(aid)->second, ct);
580 errorList.push_back(ErrorItem(_("Unknown token"),
581 bformat(_("Unknown token: %1$s %2$s\n"),
584 {par.id(), 0}, {par.id(), -1}));
589 void Text::readParagraph(Paragraph & par, Lexer & lex,
590 ErrorList & errorList)
593 string token = lex.getString();
595 Change change(Change::UNCHANGED);
598 readParToken(par, lex, token, font, change, errorList);
601 token = lex.getString();
606 if (token == "\\end_layout") {
607 //Ok, paragraph finished
611 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
612 if (token == "\\begin_layout" || token == "\\end_document"
613 || token == "\\end_inset" || token == "\\begin_deeper"
614 || token == "\\end_deeper") {
615 lex.pushToken(token);
616 lyxerr << "Paragraph ended in line "
617 << lex.lineNumber() << "\n"
618 << "Missing \\end_layout.\n";
622 // Final change goes to paragraph break:
623 par.setChange(par.size(), change);
625 // Initialize begin_of_body_ on load; redoParagraph maintains
626 par.setBeginOfBody();
628 // mark paragraph for spell checking on load
629 // par.requestSpellCheck();
633 class TextCompletionList : public CompletionList
637 TextCompletionList(Cursor const & cur, WordList const & list)
638 : buffer_(cur.buffer()), list_(list)
641 virtual ~TextCompletionList() {}
644 virtual bool sorted() const { return true; }
646 virtual size_t size() const
651 virtual docstring const & data(size_t idx) const
653 return list_.word(idx);
658 Buffer const * buffer_;
660 WordList const & list_;
664 bool Text::empty() const
666 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
667 // FIXME: Should we consider the labeled type as empty too?
668 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
672 double Text::spacing(Paragraph const & par) const
674 if (par.params().spacing().isDefault())
675 return owner_->buffer().params().spacing().getValue();
676 return par.params().spacing().getValue();
681 * This breaks a paragraph at the specified position.
682 * The new paragraph will:
683 * - Decrease depth by one (or change layout to default layout) when
684 * keep_layout == false
685 * - keep current depth and layout when keep_layout == true
687 static void breakParagraph(Text & text, pit_type par_offset, pos_type pos,
690 BufferParams const & bparams = text.inset().buffer().params();
691 ParagraphList & pars = text.paragraphs();
692 // create a new paragraph, and insert into the list
693 ParagraphList::iterator tmp =
694 pars.insert(lyx::next(pars.begin(), par_offset + 1),
697 Paragraph & par = pars[par_offset];
699 // remember to set the inset_owner
700 tmp->setInsetOwner(&par.inInset());
701 // without doing that we get a crash when typing <Return> at the
702 // end of a paragraph
703 tmp->setPlainOrDefaultLayout(bparams.documentClass());
706 tmp->setLayout(par.layout());
707 tmp->setLabelWidthString(par.params().labelWidthString());
708 tmp->params().depth(par.params().depth());
709 } else if (par.params().depth() > 0) {
710 Paragraph const & hook = pars[text.outerHook(par_offset)];
711 tmp->setLayout(hook.layout());
712 // not sure the line below is useful
713 tmp->setLabelWidthString(par.params().labelWidthString());
714 tmp->params().depth(hook.params().depth());
717 bool const isempty = (par.allowEmpty() && par.empty());
719 if (!isempty && (par.size() > pos || par.empty())) {
720 tmp->setLayout(par.layout());
721 tmp->params().align(par.params().align());
722 tmp->setLabelWidthString(par.params().labelWidthString());
724 tmp->params().depth(par.params().depth());
725 tmp->params().noindent(par.params().noindent());
726 tmp->params().spacing(par.params().spacing());
728 // move everything behind the break position
729 // to the new paragraph
731 /* Note: if !keepempty, empty() == true, then we reach
732 * here with size() == 0. So pos_end becomes - 1. This
733 * doesn't cause problems because both loops below
734 * enforce pos <= pos_end and 0 <= pos
736 pos_type pos_end = par.size() - 1;
738 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
739 if (moveItem(par, pos, *tmp, j, bparams)) {
745 // Move over the end-of-par change information
746 tmp->setChange(tmp->size(), par.lookupChange(par.size()));
747 par.setChange(par.size(), Change(bparams.track_changes ?
748 Change::INSERTED : Change::UNCHANGED));
751 // Make sure that we keep the language when
752 // breaking paragraph.
754 Font changed = tmp->getFirstFontSettings(bparams);
755 Font const & old = par.getFontSettings(bparams, par.size());
756 changed.setLanguage(old.language());
757 tmp->setFont(0, changed);
764 bool const soa = par.params().startOfAppendix();
765 par.params().clear();
766 // do not lose start of appendix marker (bug 4212)
767 par.params().startOfAppendix(soa);
768 par.setPlainOrDefaultLayout(bparams.documentClass());
772 par.setLayout(tmp->layout());
773 par.setLabelWidthString(tmp->params().labelWidthString());
774 par.params().depth(tmp->params().depth());
779 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
781 LBUFERR(this == cur.text());
783 Paragraph & cpar = cur.paragraph();
784 pit_type cpit = cur.pit();
786 DocumentClass const & tclass = cur.buffer()->params().documentClass();
787 Layout const & layout = cpar.layout();
789 if (cur.lastpos() == 0 && !cpar.allowEmpty()) {
790 if (changeDepthAllowed(cur, DEC_DEPTH)) {
791 changeDepth(cur, DEC_DEPTH);
792 pit_type const prev = depthHook(cpit, cpar.getDepth());
793 docstring const & lay = pars_[prev].layout().name();
794 if (lay != layout.name())
797 docstring const & lay = cur.paragraph().usePlainLayout()
798 ? tclass.plainLayoutName() : tclass.defaultLayoutName();
799 if (lay != layout.name())
807 // Always break behind a space
808 // It is better to erase the space (Dekel)
809 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
810 cpar.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
812 // What should the layout for the new paragraph be?
813 bool keep_layout = layout.isEnvironment()
814 || (layout.isParagraph() && layout.parbreak_is_newline);
816 keep_layout = !keep_layout;
818 // We need to remember this before we break the paragraph, because
819 // that invalidates the layout variable
820 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
822 // we need to set this before we insert the paragraph.
823 bool const isempty = cpar.allowEmpty() && cpar.empty();
825 lyx::breakParagraph(*this, cpit, cur.pos(), keep_layout);
827 // After this, neither paragraph contains any rows!
830 pit_type next_par = cpit + 1;
832 // well this is the caption hack since one caption is really enough
835 // set to standard-layout
836 //FIXME Check if this should be plainLayout() in some cases
837 pars_[cpit].applyLayout(tclass.defaultLayout());
839 // set to standard-layout
840 //FIXME Check if this should be plainLayout() in some cases
841 pars_[next_par].applyLayout(tclass.defaultLayout());
844 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
845 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().track_changes))
846 break; // the character couldn't be deleted physically due to change tracking
849 // A singlePar update is not enough in this case.
850 cur.screenUpdateFlags(Update::Force);
851 cur.forceBufferUpdate();
853 // This check is necessary. Otherwise the new empty paragraph will
854 // be deleted automatically. And it is more friendly for the user!
855 if (cur.pos() != 0 || isempty)
856 setCursor(cur, cur.pit() + 1, 0);
858 setCursor(cur, cur.pit(), 0);
862 // needed to insert the selection
863 void Text::insertStringAsLines(Cursor & cur, docstring const & str,
866 BufferParams const & bparams = owner_->buffer().params();
867 pit_type pit = cur.pit();
868 pos_type pos = cur.pos();
870 // The special chars we handle
871 map<wchar_t, InsetSpecialChar::Kind> specialchars;
872 specialchars[0x200c] = InsetSpecialChar::LIGATURE_BREAK;
873 specialchars[0x200b] = InsetSpecialChar::ALLOWBREAK;
874 specialchars[0x2026] = InsetSpecialChar::LDOTS;
875 specialchars[0x2011] = InsetSpecialChar::NOBREAKDASH;
877 // insert the string, don't insert doublespace
878 bool space_inserted = true;
879 for (auto const & ch : str) {
880 Paragraph & par = pars_[pit];
882 if (inset().allowMultiPar() && (!par.empty() || par.allowEmpty())) {
883 lyx::breakParagraph(*this, pit, pos,
884 par.layout().isEnvironment());
887 space_inserted = true;
891 // do not insert consecutive spaces if !free_spacing
892 } else if ((ch == ' ' || ch == '\t') &&
893 space_inserted && !par.isFreeSpacing()) {
895 } else if (ch == '\t') {
896 if (!par.isFreeSpacing()) {
897 // tabs are like spaces here
898 par.insertChar(pos, ' ', font, bparams.track_changes);
900 space_inserted = true;
902 par.insertChar(pos, ch, font, bparams.track_changes);
904 space_inserted = true;
906 } else if (specialchars.find(ch) != specialchars.end()) {
907 par.insertInset(pos, new InsetSpecialChar(specialchars.find(ch)->second),
908 font, bparams.track_changes ?
909 Change(Change::INSERTED)
910 : Change(Change::UNCHANGED));
912 space_inserted = false;
913 } else if (!isPrintable(ch)) {
914 // Ignore (other) unprintables
917 // just insert the character
918 par.insertChar(pos, ch, font, bparams.track_changes);
920 space_inserted = (ch == ' ');
923 setCursor(cur, pit, pos);
927 // turn double CR to single CR, others are converted into one
928 // blank. Then insertStringAsLines is called
929 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str,
932 docstring linestr = str;
933 bool newline_inserted = false;
935 for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
936 if (linestr[i] == '\n') {
937 if (newline_inserted) {
938 // we know that \r will be ignored by
939 // insertStringAsLines. Of course, it is a dirty
940 // trick, but it works...
941 linestr[i - 1] = '\r';
945 newline_inserted = true;
947 } else if (isPrintable(linestr[i])) {
948 newline_inserted = false;
951 insertStringAsLines(cur, linestr, font);
957 bool canInsertChar(Cursor const & cur, char_type c)
959 Paragraph const & par = cur.paragraph();
960 // If not in free spacing mode, check if there will be two blanks together or a blank at
961 // the beginning of a paragraph.
962 if (!par.isFreeSpacing() && isLineSeparatorChar(c)) {
963 if (cur.pos() == 0) {
965 "You cannot insert a space at the "
966 "beginning of a paragraph. Please read the Tutorial."));
969 // If something is wrong, ignore this character.
970 LASSERT(cur.pos() > 0, return false);
971 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
972 && !par.isDeleted(cur.pos() - 1)) {
974 "You cannot type two spaces this way. "
975 "Please read the Tutorial."));
980 // Prevent to insert uncodable characters in verbatim and ERT.
981 // The encoding is inherited from the context here.
982 if (par.isPassThru() && cur.getEncoding()) {
983 Encoding const * e = cur.getEncoding();
984 if (!e->encodable(c)) {
985 cur.message(_("Character is uncodable in this verbatim context."));
995 // insert a character, moves all the following breaks in the
996 // same Paragraph one to the right and make a rebreak
997 void Text::insertChar(Cursor & cur, char_type c)
999 LBUFERR(this == cur.text());
1001 if (!canInsertChar(cur,c))
1004 cur.recordUndo(INSERT_UNDO);
1006 TextMetrics const & tm = cur.bv().textMetrics(this);
1007 Buffer const & buffer = *cur.buffer();
1008 Paragraph & par = cur.paragraph();
1009 // try to remove this
1010 pit_type const pit = cur.pit();
1012 if (lyxrc.auto_number) {
1013 static docstring const number_operators = from_ascii("+-/*");
1014 static docstring const number_unary_operators = from_ascii("+-");
1016 // European Number Separators: comma, dot etc.
1017 // European Number Terminators: percent, permille, degree, euro etc.
1018 if (cur.current_font.fontInfo().number() == FONT_ON) {
1019 if (!isDigitASCII(c) && !contains(number_operators, c) &&
1020 !(isEuropeanNumberSeparator(c) &&
1022 cur.pos() != cur.lastpos() &&
1023 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
1024 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON) &&
1025 !(isEuropeanNumberTerminator(c) &&
1027 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
1028 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
1030 number(cur); // Set current_font.number to OFF
1031 } else if (isDigitASCII(c) &&
1032 cur.real_current_font.isVisibleRightToLeft()) {
1033 number(cur); // Set current_font.number to ON
1035 if (cur.pos() != 0) {
1036 char_type const ch = par.getChar(cur.pos() - 1);
1037 if (contains(number_unary_operators, ch) &&
1039 || par.isSeparator(cur.pos() - 2)
1040 || par.isEnvSeparator(cur.pos() - 2)
1041 || par.isNewline(cur.pos() - 2))
1043 setCharFont(pit, cur.pos() - 1, cur.current_font,
1045 } else if (isEuropeanNumberSeparator(ch)
1047 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
1048 setCharFont(pit, cur.pos() - 1, cur.current_font,
1055 // In Bidi text, we want spaces to be treated in a special way: spaces
1056 // which are between words in different languages should get the
1057 // paragraph's language; otherwise, spaces should keep the language
1058 // they were originally typed in. This is only in effect while typing;
1059 // after the text is already typed in, the user can always go back and
1060 // explicitly set the language of a space as desired. But 99.9% of the
1061 // time, what we're doing here is what the user actually meant.
1063 // The following cases are the ones in which the language of the space
1064 // should be changed to match that of the containing paragraph. In the
1065 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
1066 // represents a space, pipe (|) represents the cursor position (so the
1067 // character before it is the one just typed in). The different cases
1068 // are depicted logically (not visually), from left to right:
1073 // Theoretically, there are other situations that we should, perhaps, deal
1074 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
1075 // point (to understand why, just try to create this situation...).
1077 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
1078 // get font in front and behind the space in question. But do NOT
1079 // use getFont(cur.pos()) because the character c is not inserted yet
1080 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
1081 Font const & post_space_font = cur.real_current_font;
1082 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
1083 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
1085 if (pre_space_rtl != post_space_rtl) {
1086 // Set the space's language to match the language of the
1087 // adjacent character whose direction is the paragraph's
1088 // direction; don't touch other properties of the font
1089 Language const * lang =
1090 (pre_space_rtl == par.isRTL(buffer.params())) ?
1091 pre_space_font.language() : post_space_font.language();
1093 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
1094 space_font.setLanguage(lang);
1095 par.setFont(cur.pos() - 1, space_font);
1099 pos_type pos = cur.pos();
1100 if (!cur.paragraph().isPassThru() && owner_->lyxCode() != IPA_CODE &&
1101 cur.real_current_font.fontInfo().family() != TYPEWRITER_FAMILY &&
1102 c == '-' && pos > 0) {
1103 if (par.getChar(pos - 1) == '-') {
1104 // convert "--" to endash
1105 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1108 } else if (par.getChar(pos - 1) == 0x2013) {
1109 // convert "---" to emdash
1110 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1116 par.insertChar(pos, c, cur.current_font,
1117 cur.buffer()->params().track_changes);
1118 cur.checkBufferStructure();
1120 // cur.screenUpdateFlags(Update::Force);
1121 bool boundary = cur.boundary()
1122 || tm.isRTLBoundary(cur.pit(), pos + 1);
1123 setCursor(cur, cur.pit(), pos + 1, false, boundary);
1128 void Text::charInserted(Cursor & cur)
1130 Paragraph & par = cur.paragraph();
1132 // register word if a non-letter was entered
1134 && !par.isWordSeparator(cur.pos() - 2)
1135 && par.isWordSeparator(cur.pos() - 1)) {
1136 // get the word in front of cursor
1137 LBUFERR(this == cur.text());
1138 cur.paragraph().updateWords();
1143 // the cursor set functions have a special mechanism. When they
1144 // realize, that you left an empty paragraph, they will delete it.
1146 bool Text::cursorForwardOneWord(Cursor & cur)
1148 LBUFERR(this == cur.text());
1150 pos_type const lastpos = cur.lastpos();
1151 pit_type pit = cur.pit();
1152 pos_type pos = cur.pos();
1153 Paragraph const & par = cur.paragraph();
1155 // Paragraph boundary is a word boundary
1156 if (pos == lastpos || (pos + 1 == lastpos && par.isEnvSeparator(pos))) {
1157 if (pit != cur.lastpit())
1158 return setCursor(cur, pit + 1, 0);
1163 if (lyxrc.mac_like_cursor_movement) {
1164 // Skip through trailing punctuation and spaces.
1165 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
1168 // Skip over either a non-char inset or a full word
1169 if (pos != lastpos && par.isWordSeparator(pos))
1171 else while (pos != lastpos && !par.isWordSeparator(pos))
1174 LASSERT(pos < lastpos, return false); // see above
1175 if (!par.isWordSeparator(pos))
1176 while (pos != lastpos && !par.isWordSeparator(pos))
1178 else if (par.isChar(pos))
1179 while (pos != lastpos && par.isChar(pos))
1181 else if (!par.isSpace(pos)) // non-char inset
1184 // Skip over white space
1185 while (pos != lastpos && par.isSpace(pos))
1189 // Don't skip a separator inset at the end of a paragraph
1190 if (pos == lastpos && pos && par.isEnvSeparator(pos - 1))
1193 return setCursor(cur, pit, pos);
1197 bool Text::cursorBackwardOneWord(Cursor & cur)
1199 LBUFERR(this == cur.text());
1201 pit_type pit = cur.pit();
1202 pos_type pos = cur.pos();
1203 Paragraph & par = cur.paragraph();
1205 // Paragraph boundary is a word boundary
1206 if (pos == 0 && pit != 0) {
1207 Paragraph & prevpar = getPar(pit - 1);
1208 pos = prevpar.size();
1209 // Don't stop after an environment separator
1210 if (pos && prevpar.isEnvSeparator(pos - 1))
1212 return setCursor(cur, pit - 1, pos);
1215 if (lyxrc.mac_like_cursor_movement) {
1216 // Skip through punctuation and spaces.
1217 while (pos != 0 && (par.isChar(pos - 1) || par.isSpace(pos - 1)))
1220 // Skip over either a non-char inset or a full word
1221 if (pos != 0 && par.isWordSeparator(pos - 1) && !par.isChar(pos - 1))
1223 else while (pos != 0 && !par.isWordSeparator(pos - 1))
1226 // Skip over white space
1227 while (pos != 0 && par.isSpace(pos - 1))
1230 if (pos != 0 && !par.isWordSeparator(pos - 1))
1231 while (pos != 0 && !par.isWordSeparator(pos - 1))
1233 else if (pos != 0 && par.isChar(pos - 1))
1234 while (pos != 0 && par.isChar(pos - 1))
1236 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
1240 return setCursor(cur, pit, pos);
1244 bool Text::cursorVisLeftOneWord(Cursor & cur)
1246 LBUFERR(this == cur.text());
1248 pos_type left_pos, right_pos;
1250 Cursor temp_cur = cur;
1252 // always try to move at least once...
1253 while (temp_cur.posVisLeft(true /* skip_inset */)) {
1255 // collect some information about current cursor position
1256 temp_cur.getSurroundingPos(left_pos, right_pos);
1257 bool left_is_letter =
1258 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1259 bool right_is_letter =
1260 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1262 // if we're not at a letter/non-letter boundary, continue moving
1263 if (left_is_letter == right_is_letter)
1266 // we should stop when we have an LTR word on our right or an RTL word
1268 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1269 temp_cur.buffer()->params(), left_pos).isRightToLeft())
1270 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1271 temp_cur.buffer()->params(), right_pos).isRightToLeft()))
1275 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1276 true, temp_cur.boundary());
1280 bool Text::cursorVisRightOneWord(Cursor & cur)
1282 LBUFERR(this == cur.text());
1284 pos_type left_pos, right_pos;
1286 Cursor temp_cur = cur;
1288 // always try to move at least once...
1289 while (temp_cur.posVisRight(true /* skip_inset */)) {
1291 // collect some information about current cursor position
1292 temp_cur.getSurroundingPos(left_pos, right_pos);
1293 bool left_is_letter =
1294 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1295 bool right_is_letter =
1296 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1298 // if we're not at a letter/non-letter boundary, continue moving
1299 if (left_is_letter == right_is_letter)
1302 // we should stop when we have an LTR word on our right or an RTL word
1304 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1305 temp_cur.buffer()->params(),
1306 left_pos).isRightToLeft())
1307 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1308 temp_cur.buffer()->params(),
1309 right_pos).isRightToLeft()))
1313 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1314 true, temp_cur.boundary());
1318 void Text::selectWord(Cursor & cur, word_location loc)
1320 LBUFERR(this == cur.text());
1321 CursorSlice from = cur.top();
1323 getWord(from, to, loc);
1324 if (cur.top() != from)
1325 setCursor(cur, from.pit(), from.pos());
1328 if (!cur.selection())
1330 setCursor(cur, to.pit(), to.pos());
1332 cur.setWordSelection(true);
1336 void Text::selectAll(Cursor & cur)
1338 LBUFERR(this == cur.text());
1339 if (cur.lastpos() == 0 && cur.lastpit() == 0)
1341 // If the cursor is at the beginning, make sure the cursor ends there
1342 if (cur.pit() == 0 && cur.pos() == 0) {
1343 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1345 setCursor(cur, 0, 0);
1347 setCursor(cur, 0, 0);
1349 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1355 // Select the word currently under the cursor when no
1356 // selection is currently set
1357 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
1359 LBUFERR(this == cur.text());
1360 if (cur.selection())
1362 selectWord(cur, loc);
1363 return cur.selection();
1367 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
1369 LBUFERR(this == cur.text());
1371 if (!cur.selection()) {
1372 if (!selectChange(cur))
1376 cur.recordUndoSelection();
1378 pit_type begPit = cur.selectionBegin().pit();
1379 pit_type endPit = cur.selectionEnd().pit();
1381 pos_type begPos = cur.selectionBegin().pos();
1382 pos_type endPos = cur.selectionEnd().pos();
1384 // keep selection info, because endPos becomes invalid after the first loop
1385 bool const endsBeforeEndOfPar = (endPos < pars_[endPit].size());
1387 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
1388 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1389 pos_type parSize = pars_[pit].size();
1391 // ignore empty paragraphs; otherwise, an assertion will fail for
1392 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
1396 // do not consider first paragraph if the cursor starts at pos size()
1397 if (pit == begPit && begPos == parSize)
1400 // do not consider last paragraph if the cursor ends at pos 0
1401 if (pit == endPit && endPos == 0)
1402 break; // last iteration anyway
1404 pos_type const left = (pit == begPit ? begPos : 0);
1405 pos_type const right = (pit == endPit ? endPos : parSize);
1408 // there is no change here
1412 pars_[pit].acceptChanges(left, right);
1414 pars_[pit].rejectChanges(left, right);
1418 // next, accept/reject imaginary end-of-par characters
1420 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1421 pos_type pos = pars_[pit].size();
1423 // skip if the selection ends before the end-of-par
1424 if (pit == endPit && endsBeforeEndOfPar)
1425 break; // last iteration anyway
1427 // skip if this is not the last paragraph of the document
1428 // note: the user should be able to accept/reject the par break of the last par!
1429 if (pit == endPit && pit + 1 != int(pars_.size()))
1430 break; // last iteration anway
1433 if (pars_[pit].isInserted(pos)) {
1434 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1435 } else if (pars_[pit].isDeleted(pos)) {
1436 if (pit + 1 == int(pars_.size())) {
1437 // we cannot remove a par break at the end of the last paragraph;
1438 // instead, we mark it unchanged
1439 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1441 mergeParagraph(cur.buffer()->params(), pars_, pit);
1447 if (pars_[pit].isDeleted(pos)) {
1448 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1449 } else if (pars_[pit].isInserted(pos)) {
1450 if (pit + 1 == int(pars_.size())) {
1451 // we mark the par break at the end of the last paragraph unchanged
1452 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1454 mergeParagraph(cur.buffer()->params(), pars_, pit);
1462 // finally, invoke the DEPM
1463 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer()->params().track_changes);
1466 cur.clearSelection();
1467 setCursorIntern(cur, begPit, begPos);
1468 cur.screenUpdateFlags(Update::Force);
1469 cur.forceBufferUpdate();
1473 void Text::acceptChanges()
1475 BufferParams const & bparams = owner_->buffer().params();
1476 lyx::acceptChanges(pars_, bparams);
1477 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.track_changes);
1481 void Text::rejectChanges()
1483 BufferParams const & bparams = owner_->buffer().params();
1484 pit_type pars_size = static_cast<pit_type>(pars_.size());
1486 // first, reject changes within each individual paragraph
1487 // (do not consider end-of-par)
1488 for (pit_type pit = 0; pit < pars_size; ++pit) {
1489 if (!pars_[pit].empty()) // prevent assertion failure
1490 pars_[pit].rejectChanges(0, pars_[pit].size());
1493 // next, reject imaginary end-of-par characters
1494 for (pit_type pit = 0; pit < pars_size; ++pit) {
1495 pos_type pos = pars_[pit].size();
1497 if (pars_[pit].isDeleted(pos)) {
1498 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1499 } else if (pars_[pit].isInserted(pos)) {
1500 if (pit == pars_size - 1) {
1501 // we mark the par break at the end of the last
1502 // paragraph unchanged
1503 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1505 mergeParagraph(bparams, pars_, pit);
1512 // finally, invoke the DEPM
1513 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.track_changes);
1517 void Text::deleteWordForward(Cursor & cur, bool const force)
1519 LBUFERR(this == cur.text());
1520 if (cur.lastpos() == 0)
1524 cur.selection(true);
1525 cursorForwardOneWord(cur);
1527 if (force || !cur.confirmDeletion()) {
1528 cutSelection(cur, false);
1529 cur.checkBufferStructure();
1535 void Text::deleteWordBackward(Cursor & cur, bool const force)
1537 LBUFERR(this == cur.text());
1538 if (cur.lastpos() == 0)
1539 cursorBackward(cur);
1542 cur.selection(true);
1543 cursorBackwardOneWord(cur);
1545 if (force || !cur.confirmDeletion()) {
1546 cutSelection(cur, false);
1547 cur.checkBufferStructure();
1553 // Kill to end of line.
1554 void Text::changeCase(Cursor & cur, TextCase action, bool partial)
1556 LBUFERR(this == cur.text());
1560 bool const gotsel = cur.selection();
1562 from = cur.selBegin();
1566 getWord(from, to, partial ? PARTIAL_WORD : WHOLE_WORD);
1567 cursorForwardOneWord(cur);
1570 cur.recordUndoSelection();
1572 pit_type begPit = from.pit();
1573 pit_type endPit = to.pit();
1575 pos_type begPos = from.pos();
1576 pos_type endPos = to.pos();
1578 pos_type right = 0; // needed after the for loop
1580 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1581 Paragraph & par = pars_[pit];
1582 pos_type const pos = (pit == begPit ? begPos : 0);
1583 right = (pit == endPit ? endPos : par.size());
1584 par.changeCase(cur.buffer()->params(), pos, right, action);
1587 // the selection may have changed due to logically-only deleted chars
1589 setCursor(cur, begPit, begPos);
1591 setCursor(cur, endPit, right);
1594 setCursor(cur, endPit, right);
1596 cur.checkBufferStructure();
1600 bool Text::handleBibitems(Cursor & cur)
1602 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1608 BufferParams const & bufparams = cur.buffer()->params();
1609 Paragraph const & par = cur.paragraph();
1610 Cursor prevcur = cur;
1611 if (cur.pit() > 0) {
1613 prevcur.pos() = prevcur.lastpos();
1615 Paragraph const & prevpar = prevcur.paragraph();
1617 // if a bibitem is deleted, merge with previous paragraph
1618 // if this is a bibliography item as well
1619 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1620 cur.recordUndo(prevcur.pit());
1621 mergeParagraph(bufparams, cur.text()->paragraphs(),
1623 cur.forceBufferUpdate();
1624 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1625 cur.screenUpdateFlags(Update::Force);
1629 // otherwise reset to default
1630 cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1635 bool Text::erase(Cursor & cur)
1637 LASSERT(this == cur.text(), return false);
1638 bool needsUpdate = false;
1639 Paragraph & par = cur.paragraph();
1641 if (cur.pos() != cur.lastpos()) {
1642 // this is the code for a normal delete, not pasting
1644 cur.recordUndo(DELETE_UNDO);
1645 bool const was_inset = cur.paragraph().isInset(cur.pos());
1646 if(!par.eraseChar(cur.pos(), cur.buffer()->params().track_changes))
1647 // the character has been logically deleted only => skip it
1648 cur.top().forwardPos();
1651 cur.forceBufferUpdate();
1653 cur.checkBufferStructure();
1656 if (cur.pit() == cur.lastpit())
1657 return dissolveInset(cur);
1659 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1660 cur.recordUndo(DELETE_UNDO);
1661 par.setChange(cur.pos(), Change(Change::DELETED));
1665 setCursorIntern(cur, cur.pit() + 1, 0);
1666 needsUpdate = backspacePos0(cur);
1670 needsUpdate |= handleBibitems(cur);
1673 // Make sure the cursor is correct. Is this really needed?
1674 // No, not really... at least not here!
1675 cur.top().setPitPos(cur.pit(), cur.pos());
1676 cur.checkBufferStructure();
1683 bool Text::backspacePos0(Cursor & cur)
1685 LBUFERR(this == cur.text());
1689 bool needsUpdate = false;
1691 BufferParams const & bufparams = cur.buffer()->params();
1692 DocumentClass const & tclass = bufparams.documentClass();
1693 ParagraphList & plist = cur.text()->paragraphs();
1694 Paragraph const & par = cur.paragraph();
1695 Cursor prevcur = cur;
1697 prevcur.pos() = prevcur.lastpos();
1698 Paragraph const & prevpar = prevcur.paragraph();
1700 // is it an empty paragraph?
1701 if (cur.lastpos() == 0
1702 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1703 cur.recordUndo(prevcur.pit());
1704 plist.erase(lyx::next(plist.begin(), cur.pit()));
1707 // is previous par empty?
1708 else if (prevcur.lastpos() == 0
1709 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1710 cur.recordUndo(prevcur.pit());
1711 plist.erase(lyx::next(plist.begin(), prevcur.pit()));
1714 // FIXME: Do we really not want to allow this???
1715 // Pasting is not allowed, if the paragraphs have different
1716 // layouts. I think it is a real bug of all other
1717 // word processors to allow it. It confuses the user.
1718 // Correction: Pasting is always allowed with standard-layout
1719 // or the empty layout.
1720 else if (par.layout() == prevpar.layout()
1721 || tclass.isDefaultLayout(par.layout())
1722 || tclass.isPlainLayout(par.layout())) {
1723 cur.recordUndo(prevcur.pit());
1724 mergeParagraph(bufparams, plist, prevcur.pit());
1729 cur.forceBufferUpdate();
1730 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1737 bool Text::backspace(Cursor & cur)
1739 LBUFERR(this == cur.text());
1740 bool needsUpdate = false;
1741 if (cur.pos() == 0) {
1743 return dissolveInset(cur);
1745 Cursor prev_cur = cur;
1748 if (cur.paragraph().size() > 0
1749 && !prev_cur.paragraph().isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1750 cur.recordUndo(prev_cur.pit(), prev_cur.pit());
1751 prev_cur.paragraph().setChange(prev_cur.lastpos(), Change(Change::DELETED));
1752 setCursorIntern(cur, prev_cur.pit(), prev_cur.lastpos());
1755 // The cursor is at the beginning of a paragraph, so
1756 // the backspace will collapse two paragraphs into one.
1757 needsUpdate = backspacePos0(cur);
1760 // this is the code for a normal backspace, not pasting
1762 cur.recordUndo(DELETE_UNDO);
1763 // We used to do cursorBackwardIntern() here, but it is
1764 // not a good idea since it triggers the auto-delete
1765 // mechanism. So we do a cursorBackwardIntern()-lite,
1766 // without the dreaded mechanism. (JMarc)
1767 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1768 false, cur.boundary());
1769 bool const was_inset = cur.paragraph().isInset(cur.pos());
1770 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().track_changes);
1772 cur.forceBufferUpdate();
1774 cur.checkBufferStructure();
1777 if (cur.pos() == cur.lastpos())
1778 cur.setCurrentFont();
1780 needsUpdate |= handleBibitems(cur);
1782 // A singlePar update is not enough in this case.
1783 // cur.screenUpdateFlags(Update::Force);
1784 cur.top().setPitPos(cur.pit(), cur.pos());
1790 bool Text::dissolveInset(Cursor & cur)
1792 LASSERT(this == cur.text(), return false);
1794 if (isMainText() || cur.inset().nargs() != 1)
1797 cur.recordUndoInset();
1799 cur.selHandle(false);
1800 // save position inside inset
1801 pos_type spos = cur.pos();
1802 pit_type spit = cur.pit();
1803 ParagraphList plist;
1804 if (cur.lastpit() != 0 || cur.lastpos() != 0) {
1805 plist = paragraphs();
1806 for (auto & p : plist)
1807 p.setInsetBuffers(*cur.buffer());
1810 // update cursor offset
1814 // remember position outside inset to delete inset later
1815 // we do not do it now to avoid memory reuse issues (see #10667).
1816 DocIterator inset_it = cur;
1820 Buffer & b = *cur.buffer();
1821 if (!plist.empty()) {
1823 // we clear the cache so that we won't get conflicts with labels
1824 // that get pasted into the buffer. we should update this before
1825 // its being empty matters. if not (i.e., if we encounter bugs),
1826 // then this should instead be:
1827 // cur.buffer().updateBuffer();
1828 // but we'll try the cheaper solution here.
1829 cur.buffer()->clearReferenceCache();
1831 if (!lyxrc.ct_markup_copied)
1832 // Do not revive deleted text
1833 lyx::acceptChanges(plist, b.params());
1835 // ERT paragraphs have the Language latex_language.
1836 // This is invalid outside of ERT, so we need to
1837 // change it to the buffer language.
1838 for (auto & p : plist)
1839 p.changeLanguage(b.params(), latex_language, b.language());
1841 /* If the inset is the only thing in paragraph and the layout
1842 * is not plain, then the layout of the first paragraph of
1843 * inset should be remembered.
1844 * FIXME: this does not work as expected when change tracking
1845 * is on However, we do not really know what to do in this
1848 DocumentClass const & tclass = cur.buffer()->params().documentClass();
1849 if (inset_it.lastpos() == 1
1850 && plist[0].layout().name() != tclass.plainLayoutName())
1851 cur.paragraph().makeSameLayout(plist[0]);
1853 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1854 b.errorList("Paste"));
1857 // delete the inset now
1858 inset_it.paragraph().eraseChar(inset_it.pos(), b.params().track_changes);
1861 cur.pit() = min(cur.lastpit(), spit);
1862 cur.pos() = min(cur.lastpos(), spos);
1863 // Ensure the current language is set correctly (bug 6292)
1864 cur.text()->setCursor(cur, cur.pit(), cur.pos());
1865 cur.clearSelection();
1867 cur.forceBufferUpdate();
1873 void Text::getWord(CursorSlice & from, CursorSlice & to,
1874 word_location const loc) const
1877 pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1881 void Text::write(ostream & os) const
1883 Buffer const & buf = owner_->buffer();
1884 ParagraphList::const_iterator pit = paragraphs().begin();
1885 ParagraphList::const_iterator end = paragraphs().end();
1887 for (; pit != end; ++pit)
1888 pit->write(os, buf.params(), dth);
1890 // Close begin_deeper
1891 for(; dth > 0; --dth)
1892 os << "\n\\end_deeper";
1896 bool Text::read(Lexer & lex,
1897 ErrorList & errorList, InsetText * insetPtr)
1899 Buffer const & buf = owner_->buffer();
1900 depth_type depth = 0;
1903 while (lex.isOK()) {
1905 string const token = lex.getString();
1910 if (token == "\\end_inset")
1913 if (token == "\\end_body")
1916 if (token == "\\begin_body")
1919 if (token == "\\end_document") {
1924 if (token == "\\begin_layout") {
1925 lex.pushToken(token);
1928 par.setInsetOwner(insetPtr);
1929 par.params().depth(depth);
1930 par.setFont(0, Font(inherit_font, buf.params().language));
1931 pars_.push_back(par);
1932 readParagraph(pars_.back(), lex, errorList);
1934 // register the words in the global word list
1935 pars_.back().updateWords();
1936 } else if (token == "\\begin_deeper") {
1938 } else if (token == "\\end_deeper") {
1940 lex.printError("\\end_deeper: " "depth is already null");
1944 LYXERR0("Handling unknown body token: `" << token << '\'');
1948 // avoid a crash on weird documents (bug 4859)
1949 if (pars_.empty()) {
1951 par.setInsetOwner(insetPtr);
1952 par.params().depth(depth);
1953 par.setFont(0, Font(inherit_font,
1954 buf.params().language));
1955 par.setPlainOrDefaultLayout(buf.params().documentClass());
1956 pars_.push_back(par);
1963 // Returns the current font and depth as a message.
1964 docstring Text::currentState(CursorData const & cur, bool devel_mode) const
1966 LBUFERR(this == cur.text());
1967 Buffer & buf = *cur.buffer();
1968 Paragraph const & par = cur.paragraph();
1969 odocstringstream os;
1971 if (buf.params().track_changes)
1972 os << _("[Change Tracking] ");
1974 Change change = par.lookupChange(cur.pos());
1976 if (change.changed()) {
1977 docstring const author =
1978 buf.params().authors().get(change.author).nameAndEmail();
1979 docstring const date = formatted_datetime(change.changetime);
1980 os << bformat(_("Changed by %1$s[[author]] on %2$s[[date]]. "),
1984 // I think we should only show changes from the default
1986 // No, from the document font (MV)
1987 Font font = cur.real_current_font;
1988 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1990 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1992 // The paragraph depth
1993 int depth = cur.paragraph().getDepth();
1995 os << bformat(_(", Depth: %1$d"), depth);
1997 // The paragraph spacing, but only if different from
1999 Spacing const & spacing = par.params().spacing();
2000 if (!spacing.isDefault()) {
2001 os << _(", Spacing: ");
2002 switch (spacing.getSpace()) {
2003 case Spacing::Single:
2006 case Spacing::Onehalf:
2009 case Spacing::Double:
2012 case Spacing::Other:
2013 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
2015 case Spacing::Default:
2016 // should never happen, do nothing
2022 os << _(", Inset: ") << &cur.inset();
2023 if (cur.lastidx() > 0)
2024 os << _(", Cell: ") << cur.idx();
2025 os << _(", Paragraph: ") << cur.pit();
2026 os << _(", Id: ") << par.id();
2027 os << _(", Position: ") << cur.pos();
2028 // FIXME: Why is the check for par.size() needed?
2029 // We are called with cur.pos() == par.size() quite often.
2030 if (!par.empty() && cur.pos() < par.size()) {
2031 // Force output of code point, not character
2032 size_t const c = par.getChar(cur.pos());
2033 os << _(", Char: 0x") << hex << c;
2035 os << _(", Boundary: ") << cur.boundary();
2036 // Row & row = cur.textRow();
2037 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
2043 docstring Text::getPossibleLabel(DocIterator const & cur) const
2045 pit_type textpit = cur.pit();
2046 Layout const * layout = &(pars_[textpit].layout());
2048 // Will contain the label prefix.
2051 // For captions, we just take the caption type
2052 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
2053 if (caption_inset) {
2054 string const & ftype = static_cast<InsetCaption *>(caption_inset)->floattype();
2055 FloatList const & fl = cur.buffer()->params().documentClass().floats();
2056 if (fl.typeExist(ftype)) {
2057 Floating const & flt = fl.getType(ftype);
2058 name = from_utf8(flt.refPrefix());
2061 name = from_utf8(ftype.substr(0,3));
2063 // For section, subsection, etc...
2064 if (layout->latextype == LATEX_PARAGRAPH && textpit != 0) {
2065 Layout const * layout2 = &(pars_[textpit - 1].layout());
2066 if (layout2->latextype != LATEX_PARAGRAPH) {
2071 if (layout->latextype != LATEX_PARAGRAPH)
2072 name = layout->refprefix;
2074 // If none of the above worked, see if the inset knows.
2076 InsetLayout const & il = cur.inset().getLayout();
2077 name = il.refprefix();
2082 docstring par_text = pars_[textpit].asString(AS_STR_SKIPDELETE);
2084 // The return string of math matrices might contain linebreaks
2085 par_text = subst(par_text, '\n', '-');
2086 int const numwords = 3;
2087 for (int i = 0; i < numwords; ++i) {
2088 if (par_text.empty())
2091 par_text = split(par_text, head, ' ');
2092 // Is it legal to use spaces in labels ?
2098 // Make sure it isn't too long
2099 unsigned int const max_label_length = 32;
2100 if (text.size() > max_label_length)
2101 text.resize(max_label_length);
2104 text = name + ':' + text;
2106 // We need a unique label
2107 docstring label = text;
2109 while (cur.buffer()->activeLabel(label)) {
2110 label = text + '-' + convert<docstring>(i);
2118 docstring Text::asString(int options) const
2120 return asString(0, pars_.size(), options);
2124 docstring Text::asString(pit_type beg, pit_type end, int options) const
2126 size_t i = size_t(beg);
2127 docstring str = pars_[i].asString(options);
2128 for (++i; i != size_t(end); ++i) {
2130 str += pars_[i].asString(options);
2136 void Text::shortenForOutliner(docstring & str, size_t const maxlen)
2138 support::truncateWithEllipsis(str, maxlen);
2139 for (char_type & c : str)
2140 if (c == L'\n' || c == L'\t')
2145 void Text::forOutliner(docstring & os, size_t const maxlen,
2146 bool const shorten) const
2148 pit_type end = pars_.size() - 1;
2149 if (0 <= end && !pars_[0].labelString().empty())
2150 os += pars_[0].labelString() + ' ';
2151 forOutliner(os, maxlen, 0, end, shorten);
2155 void Text::forOutliner(docstring & os, size_t const maxlen,
2156 pit_type pit_start, pit_type pit_end,
2157 bool const shorten) const
2159 size_t tmplen = shorten ? maxlen + 1 : maxlen;
2160 pit_type end = min(size_t(pit_end), pars_.size() - 1);
2162 for (pit_type i = pit_start; i <= end && os.length() < tmplen; ++i) {
2165 // This function lets the first label be treated separately
2166 pars_[i].forOutliner(os, tmplen, false, !first);
2170 shortenForOutliner(os, maxlen);
2174 void Text::charsTranspose(Cursor & cur)
2176 LBUFERR(this == cur.text());
2178 pos_type pos = cur.pos();
2180 // If cursor is at beginning or end of paragraph, do nothing.
2181 if (pos == cur.lastpos() || pos == 0)
2184 Paragraph & par = cur.paragraph();
2186 // Get the positions of the characters to be transposed.
2187 pos_type pos1 = pos - 1;
2188 pos_type pos2 = pos;
2190 // In change tracking mode, ignore deleted characters.
2191 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2193 if (pos2 == cur.lastpos())
2196 while (pos1 >= 0 && par.isDeleted(pos1))
2201 // Don't do anything if one of the "characters" is not regular text.
2202 if (par.isInset(pos1) || par.isInset(pos2))
2205 // Store the characters to be transposed (including font information).
2206 char_type const char1 = par.getChar(pos1);
2208 par.getFontSettings(cur.buffer()->params(), pos1);
2210 char_type const char2 = par.getChar(pos2);
2212 par.getFontSettings(cur.buffer()->params(), pos2);
2214 // And finally, we are ready to perform the transposition.
2215 // Track the changes if Change Tracking is enabled.
2216 bool const trackChanges = cur.buffer()->params().track_changes;
2220 par.eraseChar(pos2, trackChanges);
2221 par.eraseChar(pos1, trackChanges);
2222 par.insertChar(pos1, char2, font2, trackChanges);
2223 par.insertChar(pos2, char1, font1, trackChanges);
2225 cur.checkBufferStructure();
2227 // After the transposition, move cursor to after the transposition.
2228 setCursor(cur, cur.pit(), pos2);
2233 DocIterator Text::macrocontextPosition() const
2235 return macrocontext_position_;
2239 void Text::setMacrocontextPosition(DocIterator const & pos)
2241 macrocontext_position_ = pos;
2245 docstring Text::previousWord(CursorSlice const & sl) const
2247 CursorSlice from = sl;
2248 CursorSlice to = sl;
2249 getWord(from, to, PREVIOUS_WORD);
2250 if (sl == from || to == from)
2253 Paragraph const & par = sl.paragraph();
2254 return par.asString(from.pos(), to.pos());
2258 bool Text::completionSupported(Cursor const & cur) const
2260 Paragraph const & par = cur.paragraph();
2261 return !cur.selection()
2263 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
2264 && !par.isWordSeparator(cur.pos() - 1);
2268 CompletionList const * Text::createCompletionList(Cursor const & cur) const
2270 WordList const & list = theWordList(cur.getFont().language()->lang());
2271 return new TextCompletionList(cur, list);
2275 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
2277 LBUFERR(cur.bv().cursor() == cur);
2279 cur.bv().cursor() = cur;
2280 if (!(cur.result().screenUpdate() & Update::Force))
2281 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
2286 docstring Text::completionPrefix(Cursor const & cur) const
2288 return previousWord(cur.top());