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 ParagraphList::iterator const end = pars_.end();
194 ParagraphList::iterator it = pars_.begin();
195 for (; it != end; ++it)
196 it->setInsetOwner(owner);
200 pit_type Text::depthHook(pit_type pit, depth_type depth) const
202 pit_type newpit = pit;
207 while (newpit != 0 && pars_[newpit].getDepth() > depth)
210 if (pars_[newpit].getDepth() > depth)
217 pit_type Text::outerHook(pit_type par_offset) const
219 Paragraph const & par = pars_[par_offset];
221 if (par.getDepth() == 0)
223 return depthHook(par_offset, depth_type(par.getDepth() - 1));
227 bool Text::isFirstInSequence(pit_type par_offset) const
229 Paragraph const & par = pars_[par_offset];
231 pit_type dhook_offset = depthHook(par_offset, par.getDepth());
233 if (dhook_offset == par_offset)
236 Paragraph const & dhook = pars_[dhook_offset];
238 return dhook.layout() != par.layout()
239 || dhook.getDepth() != par.getDepth();
243 pit_type Text::lastInSequence(pit_type pit) const
245 depth_type const depth = pars_[pit].getDepth();
246 pit_type newpit = pit;
248 while (size_t(newpit + 1) < pars_.size() &&
249 (pars_[newpit + 1].getDepth() > depth ||
250 (pars_[newpit + 1].getDepth() == depth &&
251 pars_[newpit + 1].layout() == pars_[pit].layout())))
258 int Text::getTocLevel(pit_type par_offset) const
260 Paragraph const & par = pars_[par_offset];
262 if (par.layout().isEnvironment() && !isFirstInSequence(par_offset))
263 return Layout::NOT_IN_TOC;
265 return par.layout().toclevel;
269 Font const Text::outerFont(pit_type par_offset) const
271 depth_type par_depth = pars_[par_offset].getDepth();
272 FontInfo tmpfont = inherit_font;
273 depth_type prev_par_depth = 0;
274 // Resolve against environment font information
275 while (par_offset != pit_type(pars_.size())
276 && par_depth != prev_par_depth
278 && !tmpfont.resolved()) {
279 prev_par_depth = par_depth;
280 par_offset = outerHook(par_offset);
281 if (par_offset != pit_type(pars_.size())) {
282 tmpfont.realize(pars_[par_offset].layout().font);
283 par_depth = pars_[par_offset].getDepth();
287 return Font(tmpfont);
291 static void acceptOrRejectChanges(ParagraphList & pars,
292 BufferParams const & bparams, Text::ChangeOp op)
294 pit_type pars_size = static_cast<pit_type>(pars.size());
296 // first, accept or reject changes within each individual
297 // paragraph (do not consider end-of-par)
298 for (pit_type pit = 0; pit < pars_size; ++pit) {
299 // prevent assertion failure
300 if (!pars[pit].empty()) {
301 if (op == Text::ACCEPT)
302 pars[pit].acceptChanges(0, pars[pit].size());
304 pars[pit].rejectChanges(0, pars[pit].size());
308 // next, accept or reject imaginary end-of-par characters
309 for (pit_type pit = 0; pit < pars_size; ++pit) {
310 pos_type pos = pars[pit].size();
311 if (pars[pit].isChanged(pos)) {
312 // keep the end-of-par char if it is inserted and accepted
313 // or when it is deleted and rejected.
314 if (pars[pit].isInserted(pos) == (op == Text::ACCEPT)) {
315 pars[pit].setChange(pos, Change(Change::UNCHANGED));
317 if (pit == pars_size - 1) {
318 // we cannot remove a par break at the end of the last
319 // paragraph; instead, we mark it unchanged
320 pars[pit].setChange(pos, Change(Change::UNCHANGED));
322 mergeParagraph(bparams, pars, pit);
332 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
334 acceptOrRejectChanges(pars, bparams, Text::ACCEPT);
338 void rejectChanges(ParagraphList & pars, BufferParams const & bparams)
340 acceptOrRejectChanges(pars, bparams, Text::REJECT);
344 InsetText const & Text::inset() const
351 void Text::readParToken(Paragraph & par, Lexer & lex,
352 string const & token, Font & font, Change & change, ErrorList & errorList)
354 Buffer * buf = const_cast<Buffer *>(&owner_->buffer());
355 BufferParams & bp = buf->params();
357 if (token[0] != '\\') {
358 docstring dstr = lex.getDocString();
359 par.appendString(dstr, font, change);
361 } else if (token == "\\begin_layout") {
363 docstring layoutname = lex.getDocString();
365 font = Font(inherit_font, bp.language);
366 change = Change(Change::UNCHANGED);
368 DocumentClass const & tclass = bp.documentClass();
370 if (layoutname.empty())
371 layoutname = tclass.defaultLayoutName();
373 if (owner_->forcePlainLayout()) {
374 // in this case only the empty layout is allowed
375 layoutname = tclass.plainLayoutName();
376 } else if (par.usePlainLayout()) {
377 // in this case, default layout maps to empty layout
378 if (layoutname == tclass.defaultLayoutName())
379 layoutname = tclass.plainLayoutName();
381 // otherwise, the empty layout maps to the default
382 if (layoutname == tclass.plainLayoutName())
383 layoutname = tclass.defaultLayoutName();
386 // When we apply an unknown layout to a document, we add this layout to the textclass
387 // of this document. For example, when you apply class article to a beamer document,
388 // all unknown layouts such as frame will be added to document class article so that
389 // these layouts can keep their original names.
390 bool const added_one = tclass.addLayoutIfNeeded(layoutname);
393 docstring const s = bformat(_("Layout `%1$s' was not found."), layoutname);
394 errorList.push_back(ErrorItem(_("Layout Not Found"), s,
395 {par.id(), 0}, {par.id(), -1}));
398 par.setLayout(bp.documentClass()[layoutname]);
400 // Test whether the layout is obsolete.
401 Layout const & layout = par.layout();
402 if (!layout.obsoleted_by().empty())
403 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
405 par.params().read(lex);
407 } else if (token == "\\end_layout") {
408 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
409 << "Missing \\begin_layout ?");
410 } else if (token == "\\end_inset") {
411 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
412 << "Missing \\begin_inset ?");
413 } else if (token == "\\begin_inset") {
414 Inset * inset = readInset(lex, buf);
416 par.insertInset(par.size(), inset, font, change);
419 docstring line = lex.getDocString();
420 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
421 {par.id(), 0}, {par.id(), -1}));
423 } else if (token == "\\family") {
425 setLyXFamily(lex.getString(), font.fontInfo());
426 } else if (token == "\\series") {
428 setLyXSeries(lex.getString(), font.fontInfo());
429 } else if (token == "\\shape") {
431 setLyXShape(lex.getString(), font.fontInfo());
432 } else if (token == "\\size") {
434 setLyXSize(lex.getString(), font.fontInfo());
435 } else if (token == "\\lang") {
437 string const tok = lex.getString();
438 Language const * lang = languages.getLanguage(tok);
440 font.setLanguage(lang);
442 font.setLanguage(bp.language);
443 lex.printError("Unknown language `$$Token'");
445 } else if (token == "\\numeric") {
447 font.fontInfo().setNumber(setLyXMisc(lex.getString()));
448 } else if (token == "\\emph") {
450 font.fontInfo().setEmph(setLyXMisc(lex.getString()));
451 } else if (token == "\\bar") {
453 string const tok = lex.getString();
456 font.fontInfo().setUnderbar(FONT_ON);
457 else if (tok == "no")
458 font.fontInfo().setUnderbar(FONT_OFF);
459 else if (tok == "default")
460 font.fontInfo().setUnderbar(FONT_INHERIT);
462 lex.printError("Unknown bar font flag "
464 } else if (token == "\\strikeout") {
466 font.fontInfo().setStrikeout(setLyXMisc(lex.getString()));
467 } else if (token == "\\uuline") {
469 font.fontInfo().setUuline(setLyXMisc(lex.getString()));
470 } else if (token == "\\uwave") {
472 font.fontInfo().setUwave(setLyXMisc(lex.getString()));
473 } else if (token == "\\noun") {
475 font.fontInfo().setNoun(setLyXMisc(lex.getString()));
476 } else if (token == "\\color") {
478 setLyXColor(lex.getString(), font.fontInfo());
479 } else if (token == "\\SpecialChar" ||
480 (token == "\\SpecialCharNoPassThru" &&
481 !par.layout().pass_thru && !inset().isPassThru())) {
482 auto inset = make_unique<InsetSpecialChar>();
484 inset->setBuffer(*buf);
485 par.insertInset(par.size(), inset.release(), font, change);
486 } else if (token == "\\SpecialCharNoPassThru") {
488 docstring const s = ltrim(lex.getDocString(), "\\");
489 par.insert(par.size(), s, font, change);
490 } else if (token == "\\IPAChar") {
491 auto inset = make_unique<InsetIPAChar>();
493 inset->setBuffer(*buf);
494 par.insertInset(par.size(), inset.release(), font, change);
495 } else if (token == "\\twohyphens" || token == "\\threehyphens") {
496 // Ideally, this should be done by lyx2lyx, but lyx2lyx does not know the
497 // running font and does not know anything about layouts (and CopyStyle).
498 Layout const & layout(par.layout());
499 FontInfo info = font.fontInfo();
500 info.realize(layout.resfont);
501 if (layout.pass_thru || inset().isPassThru() ||
502 info.family() == TYPEWRITER_FAMILY) {
503 if (token == "\\twohyphens")
504 par.insert(par.size(), from_ascii("--"), font, change);
506 par.insert(par.size(), from_ascii("---"), font, change);
508 if (token == "\\twohyphens")
509 par.insertChar(par.size(), 0x2013, font, change);
511 par.insertChar(par.size(), 0x2014, font, change);
513 } else if (token == "\\backslash") {
514 par.appendChar('\\', font, change);
515 } else if (token == "\\LyXTable") {
516 auto inset = make_unique<InsetTabular>(buf);
518 par.insertInset(par.size(), inset.release(), font, change);
519 } else if (token == "\\change_unchanged") {
520 change = Change(Change::UNCHANGED);
521 } else if (token == "\\change_inserted" || token == "\\change_deleted") {
523 istringstream is(lex.getString());
527 BufferParams::AuthorMap const & am = bp.author_map_;
528 if (am.find(aid) == am.end()) {
529 errorList.push_back(ErrorItem(
530 _("Change tracking author index missing"),
531 bformat(_("A change tracking author information for index "
532 "%1$d is missing. This can happen after a wrong "
533 "merge by a version control system. In this case, "
534 "either fix the merge, or have this information "
535 "missing until the corresponding tracked changes "
536 "are merged or this user edits the file again.\n"),
538 {par.id(), par.size()}, {par.id(), par.size() + 1}));
539 bp.addAuthor(Author(aid));
541 if (token == "\\change_inserted")
542 change = Change(Change::INSERTED, am.find(aid)->second, ct);
544 change = Change(Change::DELETED, am.find(aid)->second, ct);
547 errorList.push_back(ErrorItem(_("Unknown token"),
548 bformat(_("Unknown token: %1$s %2$s\n"),
551 {par.id(), 0}, {par.id(), -1}));
556 void Text::readParagraph(Paragraph & par, Lexer & lex,
557 ErrorList & errorList)
560 string token = lex.getString();
562 Change change(Change::UNCHANGED);
565 readParToken(par, lex, token, font, change, errorList);
568 token = lex.getString();
573 if (token == "\\end_layout") {
574 //Ok, paragraph finished
578 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
579 if (token == "\\begin_layout" || token == "\\end_document"
580 || token == "\\end_inset" || token == "\\begin_deeper"
581 || token == "\\end_deeper") {
582 lex.pushToken(token);
583 lyxerr << "Paragraph ended in line "
584 << lex.lineNumber() << "\n"
585 << "Missing \\end_layout.\n";
589 // Final change goes to paragraph break:
590 par.setChange(par.size(), change);
592 // Initialize begin_of_body_ on load; redoParagraph maintains
593 par.setBeginOfBody();
595 // mark paragraph for spell checking on load
596 // par.requestSpellCheck();
600 class TextCompletionList : public CompletionList
604 TextCompletionList(Cursor const & cur, WordList const & list)
605 : buffer_(cur.buffer()), list_(list)
608 virtual ~TextCompletionList() {}
611 virtual bool sorted() const { return true; }
613 virtual size_t size() const
618 virtual docstring const & data(size_t idx) const
620 return list_.word(idx);
625 Buffer const * buffer_;
627 WordList const & list_;
631 bool Text::empty() const
633 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
634 // FIXME: Should we consider the labeled type as empty too?
635 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
639 double Text::spacing(Paragraph const & par) const
641 if (par.params().spacing().isDefault())
642 return owner_->buffer().params().spacing().getValue();
643 return par.params().spacing().getValue();
648 * This breaks a paragraph at the specified position.
649 * The new paragraph will:
650 * - Decrease depth by one (or change layout to default layout) when
651 * keep_layout == false
652 * - keep current depth and layout when keep_layout == true
654 static void breakParagraph(Text & text, pit_type par_offset, pos_type pos,
657 BufferParams const & bparams = text.inset().buffer().params();
658 ParagraphList & pars = text.paragraphs();
659 // create a new paragraph, and insert into the list
660 ParagraphList::iterator tmp =
661 pars.insert(lyx::next(pars.begin(), par_offset + 1),
664 Paragraph & par = pars[par_offset];
666 // remember to set the inset_owner
667 tmp->setInsetOwner(&par.inInset());
668 // without doing that we get a crash when typing <Return> at the
669 // end of a paragraph
670 tmp->setPlainOrDefaultLayout(bparams.documentClass());
673 tmp->setLayout(par.layout());
674 tmp->setLabelWidthString(par.params().labelWidthString());
675 tmp->params().depth(par.params().depth());
676 } else if (par.params().depth() > 0) {
677 Paragraph const & hook = pars[text.outerHook(par_offset)];
678 tmp->setLayout(hook.layout());
679 // not sure the line below is useful
680 tmp->setLabelWidthString(par.params().labelWidthString());
681 tmp->params().depth(hook.params().depth());
684 bool const isempty = (par.allowEmpty() && par.empty());
686 if (!isempty && (par.size() > pos || par.empty())) {
687 tmp->setLayout(par.layout());
688 tmp->params().align(par.params().align());
689 tmp->setLabelWidthString(par.params().labelWidthString());
691 tmp->params().depth(par.params().depth());
692 tmp->params().noindent(par.params().noindent());
694 // move everything behind the break position
695 // to the new paragraph
697 /* Note: if !keepempty, empty() == true, then we reach
698 * here with size() == 0. So pos_end becomes - 1. This
699 * doesn't cause problems because both loops below
700 * enforce pos <= pos_end and 0 <= pos
702 pos_type pos_end = par.size() - 1;
704 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
705 if (moveItem(par, pos, *tmp, j, bparams)) {
711 // Move over the end-of-par change information
712 tmp->setChange(tmp->size(), par.lookupChange(par.size()));
713 par.setChange(par.size(), Change(bparams.track_changes ?
714 Change::INSERTED : Change::UNCHANGED));
717 // Make sure that we keep the language when
718 // breaking paragraph.
720 Font changed = tmp->getFirstFontSettings(bparams);
721 Font const & old = par.getFontSettings(bparams, par.size());
722 changed.setLanguage(old.language());
723 tmp->setFont(0, changed);
730 bool const soa = par.params().startOfAppendix();
731 par.params().clear();
732 // do not lose start of appendix marker (bug 4212)
733 par.params().startOfAppendix(soa);
734 par.setPlainOrDefaultLayout(bparams.documentClass());
738 par.setLayout(tmp->layout());
739 par.setLabelWidthString(tmp->params().labelWidthString());
740 par.params().depth(tmp->params().depth());
745 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
747 LBUFERR(this == cur.text());
749 Paragraph & cpar = cur.paragraph();
750 pit_type cpit = cur.pit();
752 DocumentClass const & tclass = cur.buffer()->params().documentClass();
753 Layout const & layout = cpar.layout();
755 if (cur.lastpos() == 0 && !cpar.allowEmpty()) {
756 if (changeDepthAllowed(cur, DEC_DEPTH)) {
757 changeDepth(cur, DEC_DEPTH);
758 pit_type const prev = depthHook(cpit, cpar.getDepth());
759 docstring const & lay = pars_[prev].layout().name();
760 if (lay != layout.name())
763 docstring const & lay = cur.paragraph().usePlainLayout()
764 ? tclass.plainLayoutName() : tclass.defaultLayoutName();
765 if (lay != layout.name())
773 // Always break behind a space
774 // It is better to erase the space (Dekel)
775 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
776 cpar.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
778 // What should the layout for the new paragraph be?
779 bool keep_layout = layout.isEnvironment()
780 || (layout.isParagraph() && layout.parbreak_is_newline);
782 keep_layout = !keep_layout;
784 // We need to remember this before we break the paragraph, because
785 // that invalidates the layout variable
786 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
788 // we need to set this before we insert the paragraph.
789 bool const isempty = cpar.allowEmpty() && cpar.empty();
791 lyx::breakParagraph(*this, cpit, cur.pos(), keep_layout);
793 // After this, neither paragraph contains any rows!
796 pit_type next_par = cpit + 1;
798 // well this is the caption hack since one caption is really enough
801 // set to standard-layout
802 //FIXME Check if this should be plainLayout() in some cases
803 pars_[cpit].applyLayout(tclass.defaultLayout());
805 // set to standard-layout
806 //FIXME Check if this should be plainLayout() in some cases
807 pars_[next_par].applyLayout(tclass.defaultLayout());
810 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
811 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().track_changes))
812 break; // the character couldn't be deleted physically due to change tracking
815 // A singlePar update is not enough in this case.
816 cur.screenUpdateFlags(Update::Force);
817 cur.forceBufferUpdate();
819 // This check is necessary. Otherwise the new empty paragraph will
820 // be deleted automatically. And it is more friendly for the user!
821 if (cur.pos() != 0 || isempty)
822 setCursor(cur, cur.pit() + 1, 0);
824 setCursor(cur, cur.pit(), 0);
828 // needed to insert the selection
829 void Text::insertStringAsLines(Cursor & cur, docstring const & str,
832 BufferParams const & bparams = owner_->buffer().params();
833 pit_type pit = cur.pit();
834 pos_type pos = cur.pos();
836 // insert the string, don't insert doublespace
837 bool space_inserted = true;
838 for (docstring::const_iterator cit = str.begin();
839 cit != str.end(); ++cit) {
840 Paragraph & par = pars_[pit];
842 if (inset().allowMultiPar() && (!par.empty() || par.allowEmpty())) {
843 lyx::breakParagraph(*this, pit, pos,
844 par.layout().isEnvironment());
847 space_inserted = true;
851 // do not insert consecutive spaces if !free_spacing
852 } else if ((*cit == ' ' || *cit == '\t') &&
853 space_inserted && !par.isFreeSpacing()) {
855 } else if (*cit == '\t') {
856 if (!par.isFreeSpacing()) {
857 // tabs are like spaces here
858 par.insertChar(pos, ' ', font, bparams.track_changes);
860 space_inserted = true;
862 par.insertChar(pos, *cit, font, bparams.track_changes);
864 space_inserted = true;
866 } else if (!isPrintable(*cit)) {
867 // Ignore unprintables
870 // just insert the character
871 par.insertChar(pos, *cit, font, bparams.track_changes);
873 space_inserted = (*cit == ' ');
876 setCursor(cur, pit, pos);
880 // turn double CR to single CR, others are converted into one
881 // blank. Then insertStringAsLines is called
882 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str,
885 docstring linestr = str;
886 bool newline_inserted = false;
888 for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
889 if (linestr[i] == '\n') {
890 if (newline_inserted) {
891 // we know that \r will be ignored by
892 // insertStringAsLines. Of course, it is a dirty
893 // trick, but it works...
894 linestr[i - 1] = '\r';
898 newline_inserted = true;
900 } else if (isPrintable(linestr[i])) {
901 newline_inserted = false;
904 insertStringAsLines(cur, linestr, font);
908 // insert a character, moves all the following breaks in the
909 // same Paragraph one to the right and make a rebreak
910 void Text::insertChar(Cursor & cur, char_type c)
912 LBUFERR(this == cur.text());
914 cur.recordUndo(INSERT_UNDO);
916 TextMetrics const & tm = cur.bv().textMetrics(this);
917 Buffer const & buffer = *cur.buffer();
918 Paragraph & par = cur.paragraph();
919 // try to remove this
920 pit_type const pit = cur.pit();
922 bool const freeSpacing = par.layout().free_spacing ||
925 if (lyxrc.auto_number) {
926 static docstring const number_operators = from_ascii("+-/*");
927 static docstring const number_unary_operators = from_ascii("+-");
928 static docstring const number_separators = from_ascii(".,:");
930 if (cur.current_font.fontInfo().number() == FONT_ON) {
931 if (!isDigitASCII(c) && !contains(number_operators, c) &&
932 !(contains(number_separators, c) &&
934 cur.pos() != cur.lastpos() &&
935 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
936 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
938 number(cur); // Set current_font.number to OFF
939 } else if (isDigitASCII(c) &&
940 cur.real_current_font.isVisibleRightToLeft()) {
941 number(cur); // Set current_font.number to ON
943 if (cur.pos() != 0) {
944 char_type const c = par.getChar(cur.pos() - 1);
945 if (contains(number_unary_operators, c) &&
947 || par.isSeparator(cur.pos() - 2)
948 || par.isEnvSeparator(cur.pos() - 2)
949 || par.isNewline(cur.pos() - 2))
951 setCharFont(pit, cur.pos() - 1, cur.current_font,
953 } else if (contains(number_separators, c)
955 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
956 setCharFont(pit, cur.pos() - 1, cur.current_font,
963 // In Bidi text, we want spaces to be treated in a special way: spaces
964 // which are between words in different languages should get the
965 // paragraph's language; otherwise, spaces should keep the language
966 // they were originally typed in. This is only in effect while typing;
967 // after the text is already typed in, the user can always go back and
968 // explicitly set the language of a space as desired. But 99.9% of the
969 // time, what we're doing here is what the user actually meant.
971 // The following cases are the ones in which the language of the space
972 // should be changed to match that of the containing paragraph. In the
973 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
974 // represents a space, pipe (|) represents the cursor position (so the
975 // character before it is the one just typed in). The different cases
976 // are depicted logically (not visually), from left to right:
981 // Theoretically, there are other situations that we should, perhaps, deal
982 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
983 // point (to understand why, just try to create this situation...).
985 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
986 // get font in front and behind the space in question. But do NOT
987 // use getFont(cur.pos()) because the character c is not inserted yet
988 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
989 Font const & post_space_font = cur.real_current_font;
990 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
991 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
993 if (pre_space_rtl != post_space_rtl) {
994 // Set the space's language to match the language of the
995 // adjacent character whose direction is the paragraph's
996 // direction; don't touch other properties of the font
997 Language const * lang =
998 (pre_space_rtl == par.isRTL(buffer.params())) ?
999 pre_space_font.language() : post_space_font.language();
1001 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
1002 space_font.setLanguage(lang);
1003 par.setFont(cur.pos() - 1, space_font);
1007 // Next check, if there will be two blanks together or a blank at
1008 // the beginning of a paragraph.
1009 // I decided to handle blanks like normal characters, the main
1010 // difference are the special checks when calculating the row.fill
1011 // (blank does not count at the end of a row) and the check here
1013 // When the free-spacing option is set for the current layout,
1014 // disable the double-space checking
1015 if (!freeSpacing && isLineSeparatorChar(c)) {
1016 if (cur.pos() == 0) {
1018 "You cannot insert a space at the "
1019 "beginning of a paragraph. Please read the Tutorial."));
1022 // LASSERT: Is it safe to continue here?
1023 LASSERT(cur.pos() > 0, /**/);
1024 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1025 && !par.isDeleted(cur.pos() - 1)) {
1027 "You cannot type two spaces this way. "
1028 "Please read the Tutorial."));
1033 // Prevent to insert uncodable characters in verbatim and ERT
1034 // (workaround for bug 9012)
1035 // Don't do it for listings inset, since InsetListings::latex() tries
1036 // to switch to a usable encoding which works in many cases (bug 9102).
1037 if (cur.paragraph().isPassThru() && owner_->lyxCode() != LISTINGS_CODE &&
1038 cur.current_font.language()) {
1039 Encoding const * e = cur.current_font.language()->encoding();
1040 if (!e->encodable(c)) {
1041 cur.message(_("Character is uncodable in verbatim paragraphs."));
1046 pos_type pos = cur.pos();
1047 if (!cur.paragraph().isPassThru() && owner_->lyxCode() != IPA_CODE &&
1048 cur.real_current_font.fontInfo().family() != TYPEWRITER_FAMILY &&
1049 c == '-' && pos > 0) {
1050 if (par.getChar(pos - 1) == '-') {
1051 // convert "--" to endash
1052 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1055 } else if (par.getChar(pos - 1) == 0x2013) {
1056 // convert "---" to emdash
1057 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1063 par.insertChar(pos, c, cur.current_font,
1064 cur.buffer()->params().track_changes);
1065 cur.checkBufferStructure();
1067 // cur.screenUpdateFlags(Update::Force);
1068 bool boundary = cur.boundary()
1069 || tm.isRTLBoundary(cur.pit(), pos + 1);
1070 setCursor(cur, cur.pit(), pos + 1, false, boundary);
1075 void Text::charInserted(Cursor & cur)
1077 Paragraph & par = cur.paragraph();
1079 // register word if a non-letter was entered
1081 && !par.isWordSeparator(cur.pos() - 2)
1082 && par.isWordSeparator(cur.pos() - 1)) {
1083 // get the word in front of cursor
1084 LBUFERR(this == cur.text());
1085 cur.paragraph().updateWords();
1090 // the cursor set functions have a special mechanism. When they
1091 // realize, that you left an empty paragraph, they will delete it.
1093 bool Text::cursorForwardOneWord(Cursor & cur)
1095 LBUFERR(this == cur.text());
1097 pos_type const lastpos = cur.lastpos();
1098 pit_type pit = cur.pit();
1099 pos_type pos = cur.pos();
1100 Paragraph const & par = cur.paragraph();
1102 // Paragraph boundary is a word boundary
1103 if (pos == lastpos || (pos + 1 == lastpos && par.isEnvSeparator(pos))) {
1104 if (pit != cur.lastpit())
1105 return setCursor(cur, pit + 1, 0);
1110 if (lyxrc.mac_like_cursor_movement) {
1111 // Skip through trailing punctuation and spaces.
1112 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
1115 // Skip over either a non-char inset or a full word
1116 if (pos != lastpos && par.isWordSeparator(pos))
1118 else while (pos != lastpos && !par.isWordSeparator(pos))
1121 LASSERT(pos < lastpos, return false); // see above
1122 if (!par.isWordSeparator(pos))
1123 while (pos != lastpos && !par.isWordSeparator(pos))
1125 else if (par.isChar(pos))
1126 while (pos != lastpos && par.isChar(pos))
1128 else if (!par.isSpace(pos)) // non-char inset
1131 // Skip over white space
1132 while (pos != lastpos && par.isSpace(pos))
1136 // Don't skip a separator inset at the end of a paragraph
1137 if (pos == lastpos && pos && par.isEnvSeparator(pos - 1))
1140 return setCursor(cur, pit, pos);
1144 bool Text::cursorBackwardOneWord(Cursor & cur)
1146 LBUFERR(this == cur.text());
1148 pit_type pit = cur.pit();
1149 pos_type pos = cur.pos();
1150 Paragraph & par = cur.paragraph();
1152 // Paragraph boundary is a word boundary
1153 if (pos == 0 && pit != 0) {
1154 Paragraph & prevpar = getPar(pit - 1);
1155 pos = prevpar.size();
1156 // Don't stop after an environment separator
1157 if (pos && prevpar.isEnvSeparator(pos - 1))
1159 return setCursor(cur, pit - 1, pos);
1162 if (lyxrc.mac_like_cursor_movement) {
1163 // Skip through punctuation and spaces.
1164 while (pos != 0 && (par.isChar(pos - 1) || par.isSpace(pos - 1)))
1167 // Skip over either a non-char inset or a full word
1168 if (pos != 0 && par.isWordSeparator(pos - 1) && !par.isChar(pos - 1))
1170 else while (pos != 0 && !par.isWordSeparator(pos - 1))
1173 // Skip over white space
1174 while (pos != 0 && par.isSpace(pos - 1))
1177 if (pos != 0 && !par.isWordSeparator(pos - 1))
1178 while (pos != 0 && !par.isWordSeparator(pos - 1))
1180 else if (pos != 0 && par.isChar(pos - 1))
1181 while (pos != 0 && par.isChar(pos - 1))
1183 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
1187 return setCursor(cur, pit, pos);
1191 bool Text::cursorVisLeftOneWord(Cursor & cur)
1193 LBUFERR(this == cur.text());
1195 pos_type left_pos, right_pos;
1197 Cursor temp_cur = cur;
1199 // always try to move at least once...
1200 while (temp_cur.posVisLeft(true /* skip_inset */)) {
1202 // collect some information about current cursor position
1203 temp_cur.getSurroundingPos(left_pos, right_pos);
1204 bool left_is_letter =
1205 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1206 bool right_is_letter =
1207 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1209 // if we're not at a letter/non-letter boundary, continue moving
1210 if (left_is_letter == right_is_letter)
1213 // we should stop when we have an LTR word on our right or an RTL word
1215 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1216 temp_cur.buffer()->params(), left_pos).isRightToLeft())
1217 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1218 temp_cur.buffer()->params(), right_pos).isRightToLeft()))
1222 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1223 true, temp_cur.boundary());
1227 bool Text::cursorVisRightOneWord(Cursor & cur)
1229 LBUFERR(this == cur.text());
1231 pos_type left_pos, right_pos;
1233 Cursor temp_cur = cur;
1235 // always try to move at least once...
1236 while (temp_cur.posVisRight(true /* skip_inset */)) {
1238 // collect some information about current cursor position
1239 temp_cur.getSurroundingPos(left_pos, right_pos);
1240 bool left_is_letter =
1241 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1242 bool right_is_letter =
1243 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1245 // if we're not at a letter/non-letter boundary, continue moving
1246 if (left_is_letter == right_is_letter)
1249 // we should stop when we have an LTR word on our right or an RTL word
1251 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1252 temp_cur.buffer()->params(),
1253 left_pos).isRightToLeft())
1254 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1255 temp_cur.buffer()->params(),
1256 right_pos).isRightToLeft()))
1260 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1261 true, temp_cur.boundary());
1265 void Text::selectWord(Cursor & cur, word_location loc)
1267 LBUFERR(this == cur.text());
1268 CursorSlice from = cur.top();
1270 getWord(from, to, loc);
1271 if (cur.top() != from)
1272 setCursor(cur, from.pit(), from.pos());
1275 if (!cur.selection())
1277 setCursor(cur, to.pit(), to.pos());
1279 cur.setWordSelection(true);
1283 void Text::selectAll(Cursor & cur)
1285 LBUFERR(this == cur.text());
1286 if (cur.lastpos() == 0 && cur.lastpit() == 0)
1288 // If the cursor is at the beginning, make sure the cursor ends there
1289 if (cur.pit() == 0 && cur.pos() == 0) {
1290 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1292 setCursor(cur, 0, 0);
1294 setCursor(cur, 0, 0);
1296 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1302 // Select the word currently under the cursor when no
1303 // selection is currently set
1304 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
1306 LBUFERR(this == cur.text());
1307 if (cur.selection())
1309 selectWord(cur, loc);
1310 return cur.selection();
1314 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
1316 LBUFERR(this == cur.text());
1318 if (!cur.selection()) {
1319 if (!selectChange(cur))
1323 cur.recordUndoSelection();
1325 pit_type begPit = cur.selectionBegin().pit();
1326 pit_type endPit = cur.selectionEnd().pit();
1328 pos_type begPos = cur.selectionBegin().pos();
1329 pos_type endPos = cur.selectionEnd().pos();
1331 // keep selection info, because endPos becomes invalid after the first loop
1332 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
1334 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
1335 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1336 pos_type parSize = pars_[pit].size();
1338 // ignore empty paragraphs; otherwise, an assertion will fail for
1339 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
1343 // do not consider first paragraph if the cursor starts at pos size()
1344 if (pit == begPit && begPos == parSize)
1347 // do not consider last paragraph if the cursor ends at pos 0
1348 if (pit == endPit && endPos == 0)
1349 break; // last iteration anyway
1351 pos_type left = (pit == begPit ? begPos : 0);
1352 pos_type right = (pit == endPit ? endPos : parSize);
1355 // there is no change here
1359 pars_[pit].acceptChanges(left, right);
1361 pars_[pit].rejectChanges(left, right);
1365 // next, accept/reject imaginary end-of-par characters
1367 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1368 pos_type pos = pars_[pit].size();
1370 // skip if the selection ends before the end-of-par
1371 if (pit == endPit && endsBeforeEndOfPar)
1372 break; // last iteration anyway
1374 // skip if this is not the last paragraph of the document
1375 // note: the user should be able to accept/reject the par break of the last par!
1376 if (pit == endPit && pit + 1 != int(pars_.size()))
1377 break; // last iteration anway
1380 if (pars_[pit].isInserted(pos)) {
1381 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1382 } else if (pars_[pit].isDeleted(pos)) {
1383 if (pit + 1 == int(pars_.size())) {
1384 // we cannot remove a par break at the end of the last paragraph;
1385 // instead, we mark it unchanged
1386 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1388 mergeParagraph(cur.buffer()->params(), pars_, pit);
1394 if (pars_[pit].isDeleted(pos)) {
1395 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1396 } else if (pars_[pit].isInserted(pos)) {
1397 if (pit + 1 == int(pars_.size())) {
1398 // we mark the par break at the end of the last paragraph unchanged
1399 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1401 mergeParagraph(cur.buffer()->params(), pars_, pit);
1409 // finally, invoke the DEPM
1410 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer()->params().track_changes);
1413 cur.clearSelection();
1414 setCursorIntern(cur, begPit, begPos);
1415 cur.screenUpdateFlags(Update::Force);
1416 cur.forceBufferUpdate();
1420 void Text::acceptChanges()
1422 BufferParams const & bparams = owner_->buffer().params();
1423 lyx::acceptChanges(pars_, bparams);
1424 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.track_changes);
1428 void Text::rejectChanges()
1430 BufferParams const & bparams = owner_->buffer().params();
1431 pit_type pars_size = static_cast<pit_type>(pars_.size());
1433 // first, reject changes within each individual paragraph
1434 // (do not consider end-of-par)
1435 for (pit_type pit = 0; pit < pars_size; ++pit) {
1436 if (!pars_[pit].empty()) // prevent assertion failure
1437 pars_[pit].rejectChanges(0, pars_[pit].size());
1440 // next, reject imaginary end-of-par characters
1441 for (pit_type pit = 0; pit < pars_size; ++pit) {
1442 pos_type pos = pars_[pit].size();
1444 if (pars_[pit].isDeleted(pos)) {
1445 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1446 } else if (pars_[pit].isInserted(pos)) {
1447 if (pit == pars_size - 1) {
1448 // we mark the par break at the end of the last
1449 // paragraph unchanged
1450 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1452 mergeParagraph(bparams, pars_, pit);
1459 // finally, invoke the DEPM
1460 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.track_changes);
1464 void Text::deleteWordForward(Cursor & cur, bool const force)
1466 LBUFERR(this == cur.text());
1467 if (cur.lastpos() == 0)
1471 cur.selection(true);
1472 cursorForwardOneWord(cur);
1474 if (force || !cur.confirmDeletion()) {
1475 cutSelection(cur, true, false);
1476 cur.checkBufferStructure();
1482 void Text::deleteWordBackward(Cursor & cur, bool const force)
1484 LBUFERR(this == cur.text());
1485 if (cur.lastpos() == 0)
1486 cursorBackward(cur);
1489 cur.selection(true);
1490 cursorBackwardOneWord(cur);
1492 if (force || !cur.confirmDeletion()) {
1493 cutSelection(cur, true, false);
1494 cur.checkBufferStructure();
1500 // Kill to end of line.
1501 void Text::changeCase(Cursor & cur, TextCase action, bool partial)
1503 LBUFERR(this == cur.text());
1507 bool const gotsel = cur.selection();
1509 from = cur.selBegin();
1513 getWord(from, to, partial ? PARTIAL_WORD : WHOLE_WORD);
1514 cursorForwardOneWord(cur);
1517 cur.recordUndoSelection();
1519 pit_type begPit = from.pit();
1520 pit_type endPit = to.pit();
1522 pos_type begPos = from.pos();
1523 pos_type endPos = to.pos();
1525 pos_type right = 0; // needed after the for loop
1527 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1528 Paragraph & par = pars_[pit];
1529 pos_type const pos = (pit == begPit ? begPos : 0);
1530 right = (pit == endPit ? endPos : par.size());
1531 par.changeCase(cur.buffer()->params(), pos, right, action);
1534 // the selection may have changed due to logically-only deleted chars
1536 setCursor(cur, begPit, begPos);
1538 setCursor(cur, endPit, right);
1541 setCursor(cur, endPit, right);
1543 cur.checkBufferStructure();
1547 bool Text::handleBibitems(Cursor & cur)
1549 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1555 BufferParams const & bufparams = cur.buffer()->params();
1556 Paragraph const & par = cur.paragraph();
1557 Cursor prevcur = cur;
1558 if (cur.pit() > 0) {
1560 prevcur.pos() = prevcur.lastpos();
1562 Paragraph const & prevpar = prevcur.paragraph();
1564 // if a bibitem is deleted, merge with previous paragraph
1565 // if this is a bibliography item as well
1566 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1567 cur.recordUndo(prevcur.pit());
1568 mergeParagraph(bufparams, cur.text()->paragraphs(),
1570 cur.forceBufferUpdate();
1571 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1572 cur.screenUpdateFlags(Update::Force);
1576 // otherwise reset to default
1577 cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1582 bool Text::erase(Cursor & cur)
1584 LASSERT(this == cur.text(), return false);
1585 bool needsUpdate = false;
1586 Paragraph & par = cur.paragraph();
1588 if (cur.pos() != cur.lastpos()) {
1589 // this is the code for a normal delete, not pasting
1591 cur.recordUndo(DELETE_UNDO);
1592 bool const was_inset = cur.paragraph().isInset(cur.pos());
1593 if(!par.eraseChar(cur.pos(), cur.buffer()->params().track_changes))
1594 // the character has been logically deleted only => skip it
1595 cur.top().forwardPos();
1598 cur.forceBufferUpdate();
1600 cur.checkBufferStructure();
1603 if (cur.pit() == cur.lastpit())
1604 return dissolveInset(cur);
1606 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1607 cur.recordUndo(DELETE_UNDO);
1608 par.setChange(cur.pos(), Change(Change::DELETED));
1612 setCursorIntern(cur, cur.pit() + 1, 0);
1613 needsUpdate = backspacePos0(cur);
1617 needsUpdate |= handleBibitems(cur);
1620 // Make sure the cursor is correct. Is this really needed?
1621 // No, not really... at least not here!
1622 cur.top().setPitPos(cur.pit(), cur.pos());
1623 cur.checkBufferStructure();
1630 bool Text::backspacePos0(Cursor & cur)
1632 LBUFERR(this == cur.text());
1636 bool needsUpdate = false;
1638 BufferParams const & bufparams = cur.buffer()->params();
1639 DocumentClass const & tclass = bufparams.documentClass();
1640 ParagraphList & plist = cur.text()->paragraphs();
1641 Paragraph const & par = cur.paragraph();
1642 Cursor prevcur = cur;
1644 prevcur.pos() = prevcur.lastpos();
1645 Paragraph const & prevpar = prevcur.paragraph();
1647 // is it an empty paragraph?
1648 if (cur.lastpos() == 0
1649 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1650 cur.recordUndo(prevcur.pit());
1651 plist.erase(lyx::next(plist.begin(), cur.pit()));
1654 // is previous par empty?
1655 else if (prevcur.lastpos() == 0
1656 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1657 cur.recordUndo(prevcur.pit());
1658 plist.erase(lyx::next(plist.begin(), prevcur.pit()));
1661 // Pasting is not allowed, if the paragraphs have different
1662 // layouts. I think it is a real bug of all other
1663 // word processors to allow it. It confuses the user.
1664 // Correction: Pasting is always allowed with standard-layout
1665 // or the empty layout.
1666 else if (par.layout() == prevpar.layout()
1667 || tclass.isDefaultLayout(par.layout())
1668 || tclass.isPlainLayout(par.layout())) {
1669 cur.recordUndo(prevcur.pit());
1670 mergeParagraph(bufparams, plist, prevcur.pit());
1675 cur.forceBufferUpdate();
1676 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1683 bool Text::backspace(Cursor & cur)
1685 LBUFERR(this == cur.text());
1686 bool needsUpdate = false;
1687 if (cur.pos() == 0) {
1689 return dissolveInset(cur);
1691 Cursor prev_cur = cur;
1694 if (!prev_cur.paragraph().isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1695 cur.recordUndo(prev_cur.pit(), prev_cur.pit());
1696 prev_cur.paragraph().setChange(prev_cur.lastpos(), Change(Change::DELETED));
1697 setCursorIntern(cur, prev_cur.pit(), prev_cur.lastpos());
1700 // The cursor is at the beginning of a paragraph, so
1701 // the backspace will collapse two paragraphs into one.
1702 needsUpdate = backspacePos0(cur);
1705 // this is the code for a normal backspace, not pasting
1707 cur.recordUndo(DELETE_UNDO);
1708 // We used to do cursorBackwardIntern() here, but it is
1709 // not a good idea since it triggers the auto-delete
1710 // mechanism. So we do a cursorBackwardIntern()-lite,
1711 // without the dreaded mechanism. (JMarc)
1712 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1713 false, cur.boundary());
1714 bool const was_inset = cur.paragraph().isInset(cur.pos());
1715 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().track_changes);
1717 cur.forceBufferUpdate();
1719 cur.checkBufferStructure();
1722 if (cur.pos() == cur.lastpos())
1723 cur.setCurrentFont();
1725 needsUpdate |= handleBibitems(cur);
1727 // A singlePar update is not enough in this case.
1728 // cur.screenUpdateFlags(Update::Force);
1729 cur.top().setPitPos(cur.pit(), cur.pos());
1735 bool Text::dissolveInset(Cursor & cur)
1737 LASSERT(this == cur.text(), return false);
1739 if (isMainText() || cur.inset().nargs() != 1)
1742 cur.recordUndoInset();
1744 cur.selHandle(false);
1746 pos_type spos = cur.pos();
1747 pit_type spit = cur.pit();
1748 ParagraphList plist;
1749 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1750 plist = paragraphs();
1752 // store cursor offset
1756 Buffer & b = *cur.buffer();
1757 cur.paragraph().eraseChar(cur.pos(), b.params().track_changes);
1759 if (!plist.empty()) {
1761 // we clear the cache so that we won't get conflicts with labels
1762 // that get pasted into the buffer. we should update this before
1763 // its being empty matters. if not (i.e., if we encounter bugs),
1764 // then this should instead be:
1765 // cur.buffer().updateBuffer();
1766 // but we'll try the cheaper solution here.
1767 cur.buffer()->clearReferenceCache();
1769 // ERT paragraphs have the Language latex_language.
1770 // This is invalid outside of ERT, so we need to
1771 // change it to the buffer language.
1772 ParagraphList::iterator it = plist.begin();
1773 ParagraphList::iterator it_end = plist.end();
1774 for (; it != it_end; ++it)
1775 it->changeLanguage(b.params(), latex_language, b.language());
1777 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1778 b.errorList("Paste"));
1780 cur.pit() = min(cur.lastpit(), spit);
1781 cur.pos() = min(cur.lastpos(), spos);
1784 cur.forceBufferUpdate();
1786 // Ensure the current language is set correctly (bug 6292)
1787 cur.text()->setCursor(cur, cur.pit(), cur.pos());
1788 cur.clearSelection();
1794 void Text::getWord(CursorSlice & from, CursorSlice & to,
1795 word_location const loc) const
1798 pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1802 void Text::write(ostream & os) const
1804 Buffer const & buf = owner_->buffer();
1805 ParagraphList::const_iterator pit = paragraphs().begin();
1806 ParagraphList::const_iterator end = paragraphs().end();
1808 for (; pit != end; ++pit)
1809 pit->write(os, buf.params(), dth);
1811 // Close begin_deeper
1812 for(; dth > 0; --dth)
1813 os << "\n\\end_deeper";
1817 bool Text::read(Lexer & lex,
1818 ErrorList & errorList, InsetText * insetPtr)
1820 Buffer const & buf = owner_->buffer();
1821 depth_type depth = 0;
1824 while (lex.isOK()) {
1826 string const token = lex.getString();
1831 if (token == "\\end_inset")
1834 if (token == "\\end_body")
1837 if (token == "\\begin_body")
1840 if (token == "\\end_document") {
1845 if (token == "\\begin_layout") {
1846 lex.pushToken(token);
1849 par.setInsetOwner(insetPtr);
1850 par.params().depth(depth);
1851 par.setFont(0, Font(inherit_font, buf.params().language));
1852 pars_.push_back(par);
1853 readParagraph(pars_.back(), lex, errorList);
1855 // register the words in the global word list
1856 pars_.back().updateWords();
1857 } else if (token == "\\begin_deeper") {
1859 } else if (token == "\\end_deeper") {
1861 lex.printError("\\end_deeper: " "depth is already null");
1865 LYXERR0("Handling unknown body token: `" << token << '\'');
1869 // avoid a crash on weird documents (bug 4859)
1870 if (pars_.empty()) {
1872 par.setInsetOwner(insetPtr);
1873 par.params().depth(depth);
1874 par.setFont(0, Font(inherit_font,
1875 buf.params().language));
1876 par.setPlainOrDefaultLayout(buf.params().documentClass());
1877 pars_.push_back(par);
1884 // Returns the current font and depth as a message.
1885 docstring Text::currentState(Cursor const & cur) const
1887 LBUFERR(this == cur.text());
1888 Buffer & buf = *cur.buffer();
1889 Paragraph const & par = cur.paragraph();
1890 odocstringstream os;
1892 if (buf.params().track_changes)
1893 os << _("[Change Tracking] ");
1895 Change change = par.lookupChange(cur.pos());
1897 if (change.changed()) {
1898 docstring const author =
1899 buf.params().authors().get(change.author).nameAndEmail();
1900 docstring const date = formatted_datetime(change.changetime);
1901 os << bformat(_("Changed by %1$s[[author]] on %2$s[[date]]. "),
1905 // I think we should only show changes from the default
1907 // No, from the document font (MV)
1908 Font font = cur.real_current_font;
1909 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1911 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1913 // The paragraph depth
1914 int depth = cur.paragraph().getDepth();
1916 os << bformat(_(", Depth: %1$d"), depth);
1918 // The paragraph spacing, but only if different from
1920 Spacing const & spacing = par.params().spacing();
1921 if (!spacing.isDefault()) {
1922 os << _(", Spacing: ");
1923 switch (spacing.getSpace()) {
1924 case Spacing::Single:
1927 case Spacing::Onehalf:
1930 case Spacing::Double:
1933 case Spacing::Other:
1934 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1936 case Spacing::Default:
1937 // should never happen, do nothing
1942 #ifdef DEVEL_VERSION
1943 os << _(", Inset: ") << &cur.inset();
1944 os << _(", Paragraph: ") << cur.pit();
1945 os << _(", Id: ") << par.id();
1946 os << _(", Position: ") << cur.pos();
1947 // FIXME: Why is the check for par.size() needed?
1948 // We are called with cur.pos() == par.size() quite often.
1949 if (!par.empty() && cur.pos() < par.size()) {
1950 // Force output of code point, not character
1951 size_t const c = par.getChar(cur.pos());
1952 os << _(", Char: 0x") << hex << c;
1954 os << _(", Boundary: ") << cur.boundary();
1955 // Row & row = cur.textRow();
1956 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1962 docstring Text::getPossibleLabel(Cursor const & cur) const
1964 pit_type pit = cur.pit();
1966 Layout const * layout = &(pars_[pit].layout());
1969 docstring par_text = pars_[pit].asString();
1971 // The return string of math matrices might contain linebreaks
1972 par_text = subst(par_text, '\n', '-');
1973 int const numwords = 3;
1974 for (int i = 0; i < numwords; ++i) {
1975 if (par_text.empty())
1978 par_text = split(par_text, head, ' ');
1979 // Is it legal to use spaces in labels ?
1985 // Make sure it isn't too long
1986 unsigned int const max_label_length = 32;
1987 if (text.size() > max_label_length)
1988 text.resize(max_label_length);
1990 // Will contain the label prefix.
1993 // For section, subsection, etc...
1994 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1995 Layout const * layout2 = &(pars_[pit - 1].layout());
1996 if (layout2->latextype != LATEX_PARAGRAPH) {
2001 if (layout->latextype != LATEX_PARAGRAPH)
2002 name = layout->refprefix;
2004 // For captions, we just take the caption type
2005 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
2006 if (caption_inset) {
2007 string const & ftype = static_cast<InsetCaption *>(caption_inset)->floattype();
2008 FloatList const & fl = cur.buffer()->params().documentClass().floats();
2009 if (fl.typeExist(ftype)) {
2010 Floating const & flt = fl.getType(ftype);
2011 name = from_utf8(flt.refPrefix());
2014 name = from_utf8(ftype.substr(0,3));
2017 // If none of the above worked, see if the inset knows.
2019 InsetLayout const & il = cur.inset().getLayout();
2020 name = il.refprefix();
2024 text = name + ':' + text;
2026 // We need a unique label
2027 docstring label = text;
2029 while (cur.buffer()->insetLabel(label)) {
2030 label = text + '-' + convert<docstring>(i);
2038 docstring Text::asString(int options) const
2040 return asString(0, pars_.size(), options);
2044 docstring Text::asString(pit_type beg, pit_type end, int options) const
2046 size_t i = size_t(beg);
2047 docstring str = pars_[i].asString(options);
2048 for (++i; i != size_t(end); ++i) {
2050 str += pars_[i].asString(options);
2056 void Text::shortenForOutliner(docstring & str, size_t const maxlen)
2058 support::truncateWithEllipsis(str, maxlen);
2059 for (char_type & c : str)
2060 if (c == L'\n' || c == L'\t')
2065 void Text::forOutliner(docstring & os, size_t const maxlen,
2066 bool const shorten) const
2068 pit_type end = pars_.size() - 1;
2069 if (0 <= end && !pars_[0].labelString().empty())
2070 os += pars_[0].labelString() + ' ';
2071 forOutliner(os, maxlen, 0, end, shorten);
2075 void Text::forOutliner(docstring & os, size_t const maxlen,
2076 pit_type pit_start, pit_type pit_end,
2077 bool const shorten) const
2079 size_t tmplen = shorten ? maxlen + 1 : maxlen;
2080 pit_type end = min(size_t(pit_end), pars_.size() - 1);
2082 for (pit_type i = pit_start; i <= end && os.length() < tmplen; ++i) {
2085 // This function lets the first label be treated separately
2086 pars_[i].forOutliner(os, tmplen, false, !first);
2090 shortenForOutliner(os, maxlen);
2094 void Text::charsTranspose(Cursor & cur)
2096 LBUFERR(this == cur.text());
2098 pos_type pos = cur.pos();
2100 // If cursor is at beginning or end of paragraph, do nothing.
2101 if (pos == cur.lastpos() || pos == 0)
2104 Paragraph & par = cur.paragraph();
2106 // Get the positions of the characters to be transposed.
2107 pos_type pos1 = pos - 1;
2108 pos_type pos2 = pos;
2110 // In change tracking mode, ignore deleted characters.
2111 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2113 if (pos2 == cur.lastpos())
2116 while (pos1 >= 0 && par.isDeleted(pos1))
2121 // Don't do anything if one of the "characters" is not regular text.
2122 if (par.isInset(pos1) || par.isInset(pos2))
2125 // Store the characters to be transposed (including font information).
2126 char_type const char1 = par.getChar(pos1);
2128 par.getFontSettings(cur.buffer()->params(), pos1);
2130 char_type const char2 = par.getChar(pos2);
2132 par.getFontSettings(cur.buffer()->params(), pos2);
2134 // And finally, we are ready to perform the transposition.
2135 // Track the changes if Change Tracking is enabled.
2136 bool const trackChanges = cur.buffer()->params().track_changes;
2140 par.eraseChar(pos2, trackChanges);
2141 par.eraseChar(pos1, trackChanges);
2142 par.insertChar(pos1, char2, font2, trackChanges);
2143 par.insertChar(pos2, char1, font1, trackChanges);
2145 cur.checkBufferStructure();
2147 // After the transposition, move cursor to after the transposition.
2148 setCursor(cur, cur.pit(), pos2);
2153 DocIterator Text::macrocontextPosition() const
2155 return macrocontext_position_;
2159 void Text::setMacrocontextPosition(DocIterator const & pos)
2161 macrocontext_position_ = pos;
2165 docstring Text::previousWord(CursorSlice const & sl) const
2167 CursorSlice from = sl;
2168 CursorSlice to = sl;
2169 getWord(from, to, PREVIOUS_WORD);
2170 if (sl == from || to == from)
2173 Paragraph const & par = sl.paragraph();
2174 return par.asString(from.pos(), to.pos());
2178 bool Text::completionSupported(Cursor const & cur) const
2180 Paragraph const & par = cur.paragraph();
2181 return cur.pos() > 0
2182 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
2183 && !par.isWordSeparator(cur.pos() - 1);
2187 CompletionList const * Text::createCompletionList(Cursor const & cur) const
2189 WordList const & list = theWordList(cur.getFont().language()->lang());
2190 return new TextCompletionList(cur, list);
2194 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
2196 LBUFERR(cur.bv().cursor() == cur);
2198 cur.bv().cursor() = cur;
2199 if (!(cur.result().screenUpdate() & Update::Force))
2200 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
2205 docstring Text::completionPrefix(Cursor const & cur) const
2207 return previousWord(cur.top());