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 int Text::getTocLevel(pit_type par_offset) const
245 Paragraph const & par = pars_[par_offset];
247 if (par.layout().isEnvironment() && !isFirstInSequence(par_offset))
248 return Layout::NOT_IN_TOC;
250 return par.layout().toclevel;
254 Font const Text::outerFont(pit_type par_offset) const
256 depth_type par_depth = pars_[par_offset].getDepth();
257 FontInfo tmpfont = inherit_font;
258 depth_type prev_par_depth = 0;
259 // Resolve against environment font information
260 while (par_offset != pit_type(pars_.size())
261 && par_depth != prev_par_depth
263 && !tmpfont.resolved()) {
264 prev_par_depth = par_depth;
265 par_offset = outerHook(par_offset);
266 if (par_offset != pit_type(pars_.size())) {
267 tmpfont.realize(pars_[par_offset].layout().font);
268 par_depth = pars_[par_offset].getDepth();
272 return Font(tmpfont);
276 static void acceptOrRejectChanges(ParagraphList & pars,
277 BufferParams const & bparams, Text::ChangeOp op)
279 pit_type pars_size = static_cast<pit_type>(pars.size());
281 // first, accept or reject changes within each individual
282 // paragraph (do not consider end-of-par)
283 for (pit_type pit = 0; pit < pars_size; ++pit) {
284 // prevent assertion failure
285 if (!pars[pit].empty()) {
286 if (op == Text::ACCEPT)
287 pars[pit].acceptChanges(0, pars[pit].size());
289 pars[pit].rejectChanges(0, pars[pit].size());
293 // next, accept or reject imaginary end-of-par characters
294 for (pit_type pit = 0; pit < pars_size; ++pit) {
295 pos_type pos = pars[pit].size();
296 if (pars[pit].isChanged(pos)) {
297 // keep the end-of-par char if it is inserted and accepted
298 // or when it is deleted and rejected.
299 if (pars[pit].isInserted(pos) == (op == Text::ACCEPT)) {
300 pars[pit].setChange(pos, Change(Change::UNCHANGED));
302 if (pit == pars_size - 1) {
303 // we cannot remove a par break at the end of the last
304 // paragraph; instead, we mark it unchanged
305 pars[pit].setChange(pos, Change(Change::UNCHANGED));
307 mergeParagraph(bparams, pars, pit);
317 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
319 acceptOrRejectChanges(pars, bparams, Text::ACCEPT);
323 void rejectChanges(ParagraphList & pars, BufferParams const & bparams)
325 acceptOrRejectChanges(pars, bparams, Text::REJECT);
329 InsetText const & Text::inset() const
336 void Text::readParToken(Paragraph & par, Lexer & lex,
337 string const & token, Font & font, Change & change, ErrorList & errorList)
339 Buffer * buf = const_cast<Buffer *>(&owner_->buffer());
340 BufferParams & bp = buf->params();
342 if (token[0] != '\\') {
343 docstring dstr = lex.getDocString();
344 par.appendString(dstr, font, change);
346 } else if (token == "\\begin_layout") {
348 docstring layoutname = lex.getDocString();
350 font = Font(inherit_font, bp.language);
351 change = Change(Change::UNCHANGED);
353 DocumentClass const & tclass = bp.documentClass();
355 if (layoutname.empty())
356 layoutname = tclass.defaultLayoutName();
358 if (owner_->forcePlainLayout()) {
359 // in this case only the empty layout is allowed
360 layoutname = tclass.plainLayoutName();
361 } else if (par.usePlainLayout()) {
362 // in this case, default layout maps to empty layout
363 if (layoutname == tclass.defaultLayoutName())
364 layoutname = tclass.plainLayoutName();
366 // otherwise, the empty layout maps to the default
367 if (layoutname == tclass.plainLayoutName())
368 layoutname = tclass.defaultLayoutName();
371 // When we apply an unknown layout to a document, we add this layout to the textclass
372 // of this document. For example, when you apply class article to a beamer document,
373 // all unknown layouts such as frame will be added to document class article so that
374 // these layouts can keep their original names.
375 bool const added_one = tclass.addLayoutIfNeeded(layoutname);
378 docstring const s = bformat(_("Layout `%1$s' was not found."), layoutname);
380 ErrorItem(_("Layout Not Found"), s, par.id(), 0, par.size()));
383 par.setLayout(bp.documentClass()[layoutname]);
385 // Test whether the layout is obsolete.
386 Layout const & layout = par.layout();
387 if (!layout.obsoleted_by().empty())
388 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
390 par.params().read(lex);
392 } else if (token == "\\end_layout") {
393 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
394 << "Missing \\begin_layout ?");
395 } else if (token == "\\end_inset") {
396 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
397 << "Missing \\begin_inset ?");
398 } else if (token == "\\begin_inset") {
399 Inset * inset = readInset(lex, buf);
401 par.insertInset(par.size(), inset, font, change);
404 docstring line = lex.getDocString();
405 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
406 par.id(), 0, par.size()));
408 } else if (token == "\\family") {
410 setLyXFamily(lex.getString(), font.fontInfo());
411 } else if (token == "\\series") {
413 setLyXSeries(lex.getString(), font.fontInfo());
414 } else if (token == "\\shape") {
416 setLyXShape(lex.getString(), font.fontInfo());
417 } else if (token == "\\size") {
419 setLyXSize(lex.getString(), font.fontInfo());
420 } else if (token == "\\lang") {
422 string const tok = lex.getString();
423 Language const * lang = languages.getLanguage(tok);
425 font.setLanguage(lang);
427 font.setLanguage(bp.language);
428 lex.printError("Unknown language `$$Token'");
430 } else if (token == "\\numeric") {
432 font.fontInfo().setNumber(setLyXMisc(lex.getString()));
433 } else if (token == "\\emph") {
435 font.fontInfo().setEmph(setLyXMisc(lex.getString()));
436 } else if (token == "\\bar") {
438 string const tok = lex.getString();
441 font.fontInfo().setUnderbar(FONT_ON);
442 else if (tok == "no")
443 font.fontInfo().setUnderbar(FONT_OFF);
444 else if (tok == "default")
445 font.fontInfo().setUnderbar(FONT_INHERIT);
447 lex.printError("Unknown bar font flag "
449 } else if (token == "\\strikeout") {
451 font.fontInfo().setStrikeout(setLyXMisc(lex.getString()));
452 } else if (token == "\\uuline") {
454 font.fontInfo().setUuline(setLyXMisc(lex.getString()));
455 } else if (token == "\\uwave") {
457 font.fontInfo().setUwave(setLyXMisc(lex.getString()));
458 } else if (token == "\\noun") {
460 font.fontInfo().setNoun(setLyXMisc(lex.getString()));
461 } else if (token == "\\color") {
463 setLyXColor(lex.getString(), font.fontInfo());
464 } else if (token == "\\SpecialChar" ||
465 (token == "\\SpecialCharNoPassThru" &&
466 !par.layout().pass_thru && !inset().isPassThru())) {
467 auto inset = make_unique<InsetSpecialChar>();
469 inset->setBuffer(*buf);
470 par.insertInset(par.size(), inset.release(), font, change);
471 } else if (token == "\\SpecialCharNoPassThru") {
473 docstring const s = ltrim(lex.getDocString(), "\\");
474 par.insert(par.size(), s, font, change);
475 } else if (token == "\\IPAChar") {
476 auto inset = make_unique<InsetIPAChar>();
478 inset->setBuffer(*buf);
479 par.insertInset(par.size(), inset.release(), font, change);
480 } else if (token == "\\twohyphens" || token == "\\threehyphens") {
481 // Ideally, this should be done by lyx2lyx, but lyx2lyx does not know the
482 // running font and does not know anything about layouts (and CopyStyle).
483 Layout const & layout(par.layout());
484 FontInfo info = font.fontInfo();
485 info.realize(layout.resfont);
486 if (layout.pass_thru || inset().isPassThru() ||
487 info.family() == TYPEWRITER_FAMILY) {
488 if (token == "\\twohyphens")
489 par.insert(par.size(), from_ascii("--"), font, change);
491 par.insert(par.size(), from_ascii("---"), font, change);
493 if (token == "\\twohyphens")
494 par.insertChar(par.size(), 0x2013, font, change);
496 par.insertChar(par.size(), 0x2014, font, change);
498 } else if (token == "\\backslash") {
499 par.appendChar('\\', font, change);
500 } else if (token == "\\LyXTable") {
501 auto inset = make_unique<InsetTabular>(buf);
503 par.insertInset(par.size(), inset.release(), font, change);
504 } else if (token == "\\change_unchanged") {
505 change = Change(Change::UNCHANGED);
506 } else if (token == "\\change_inserted" || token == "\\change_deleted") {
508 istringstream is(lex.getString());
512 BufferParams::AuthorMap const & am = bp.author_map_;
513 if (am.find(aid) == am.end()) {
514 errorList.push_back(ErrorItem(
515 _("Change tracking author index missing"),
516 bformat(_("A change tracking author information for index "
517 "%1$d is missing. This can happen after a wrong "
518 "merge by a version control system. In this case, "
519 "either fix the merge, or have this information "
520 "missing until the corresponding tracked changes "
521 "are merged or this user edits the file again.\n"),
523 par.id(), par.size(), par.size() + 1
525 bp.addAuthor(Author(aid));
527 if (token == "\\change_inserted")
528 change = Change(Change::INSERTED, am.find(aid)->second, ct);
530 change = Change(Change::DELETED, am.find(aid)->second, ct);
533 errorList.push_back(ErrorItem(_("Unknown token"),
534 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
536 par.id(), 0, par.size()));
541 void Text::readParagraph(Paragraph & par, Lexer & lex,
542 ErrorList & errorList)
545 string token = lex.getString();
547 Change change(Change::UNCHANGED);
550 readParToken(par, lex, token, font, change, errorList);
553 token = lex.getString();
558 if (token == "\\end_layout") {
559 //Ok, paragraph finished
563 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
564 if (token == "\\begin_layout" || token == "\\end_document"
565 || token == "\\end_inset" || token == "\\begin_deeper"
566 || token == "\\end_deeper") {
567 lex.pushToken(token);
568 lyxerr << "Paragraph ended in line "
569 << lex.lineNumber() << "\n"
570 << "Missing \\end_layout.\n";
574 // Final change goes to paragraph break:
575 par.setChange(par.size(), change);
577 // Initialize begin_of_body_ on load; redoParagraph maintains
578 par.setBeginOfBody();
580 // mark paragraph for spell checking on load
581 // par.requestSpellCheck();
585 class TextCompletionList : public CompletionList
589 TextCompletionList(Cursor const & cur, WordList const * list)
590 : buffer_(cur.buffer()), list_(list)
593 virtual ~TextCompletionList() {}
596 virtual bool sorted() const { return true; }
598 virtual size_t size() const
600 return list_->size();
603 virtual docstring const & data(size_t idx) const
605 return list_->word(idx);
610 Buffer const * buffer_;
612 WordList const * list_;
616 bool Text::empty() const
618 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
619 // FIXME: Should we consider the labeled type as empty too?
620 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
624 double Text::spacing(Paragraph const & par) const
626 if (par.params().spacing().isDefault())
627 return owner_->buffer().params().spacing().getValue();
628 return par.params().spacing().getValue();
633 * This breaks a paragraph at the specified position.
634 * The new paragraph will:
635 * - Decrease depth by one (or change layout to default layout) when
636 * keep_layout == false
637 * - keep current depth and layout when keep_layout == true
639 static void breakParagraph(Text & text, pit_type par_offset, pos_type pos,
642 BufferParams const & bparams = text.inset().buffer().params();
643 ParagraphList & pars = text.paragraphs();
644 // create a new paragraph, and insert into the list
645 ParagraphList::iterator tmp =
646 pars.insert(lyx::next(pars.begin(), par_offset + 1),
649 Paragraph & par = pars[par_offset];
651 // remember to set the inset_owner
652 tmp->setInsetOwner(&par.inInset());
653 // without doing that we get a crash when typing <Return> at the
654 // end of a paragraph
655 tmp->setPlainOrDefaultLayout(bparams.documentClass());
658 tmp->setLayout(par.layout());
659 tmp->setLabelWidthString(par.params().labelWidthString());
660 tmp->params().depth(par.params().depth());
661 } else if (par.params().depth() > 0) {
662 Paragraph const & hook = pars[text.outerHook(par_offset)];
663 tmp->setLayout(hook.layout());
664 // not sure the line below is useful
665 tmp->setLabelWidthString(par.params().labelWidthString());
666 tmp->params().depth(hook.params().depth());
669 bool const isempty = (par.allowEmpty() && par.empty());
671 if (!isempty && (par.size() > pos || par.empty())) {
672 tmp->setLayout(par.layout());
673 tmp->params().align(par.params().align());
674 tmp->setLabelWidthString(par.params().labelWidthString());
676 tmp->params().depth(par.params().depth());
677 tmp->params().noindent(par.params().noindent());
679 // move everything behind the break position
680 // to the new paragraph
682 /* Note: if !keepempty, empty() == true, then we reach
683 * here with size() == 0. So pos_end becomes - 1. This
684 * doesn't cause problems because both loops below
685 * enforce pos <= pos_end and 0 <= pos
687 pos_type pos_end = par.size() - 1;
689 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
690 if (moveItem(par, pos, *tmp, j, bparams)) {
696 // Move over the end-of-par change information
697 tmp->setChange(tmp->size(), par.lookupChange(par.size()));
698 par.setChange(par.size(), Change(bparams.track_changes ?
699 Change::INSERTED : Change::UNCHANGED));
702 // Make sure that we keep the language when
703 // breaking paragraph.
705 Font changed = tmp->getFirstFontSettings(bparams);
706 Font const & old = par.getFontSettings(bparams, par.size());
707 changed.setLanguage(old.language());
708 tmp->setFont(0, changed);
715 bool const soa = par.params().startOfAppendix();
716 par.params().clear();
717 // do not lose start of appendix marker (bug 4212)
718 par.params().startOfAppendix(soa);
719 par.setPlainOrDefaultLayout(bparams.documentClass());
723 par.setLayout(tmp->layout());
724 par.setLabelWidthString(tmp->params().labelWidthString());
725 par.params().depth(tmp->params().depth());
730 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
732 LBUFERR(this == cur.text());
734 Paragraph & cpar = cur.paragraph();
735 pit_type cpit = cur.pit();
737 DocumentClass const & tclass = cur.buffer()->params().documentClass();
738 Layout const & layout = cpar.layout();
740 if (cur.lastpos() == 0 && !cpar.allowEmpty()) {
741 if (changeDepthAllowed(cur, DEC_DEPTH))
742 changeDepth(cur, DEC_DEPTH);
744 docstring const & lay = cur.paragraph().usePlainLayout()
745 ? tclass.plainLayoutName() : tclass.defaultLayoutName();
746 if (lay != layout.name())
754 // Always break behind a space
755 // It is better to erase the space (Dekel)
756 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
757 cpar.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
759 // What should the layout for the new paragraph be?
760 bool keep_layout = layout.isEnvironment()
761 || (layout.isParagraph() && layout.parbreak_is_newline);
763 keep_layout = !keep_layout;
765 // We need to remember this before we break the paragraph, because
766 // that invalidates the layout variable
767 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
769 // we need to set this before we insert the paragraph.
770 bool const isempty = cpar.allowEmpty() && cpar.empty();
772 lyx::breakParagraph(*this, cpit, cur.pos(), keep_layout);
774 // After this, neither paragraph contains any rows!
777 pit_type next_par = cpit + 1;
779 // well this is the caption hack since one caption is really enough
782 // set to standard-layout
783 //FIXME Check if this should be plainLayout() in some cases
784 pars_[cpit].applyLayout(tclass.defaultLayout());
786 // set to standard-layout
787 //FIXME Check if this should be plainLayout() in some cases
788 pars_[next_par].applyLayout(tclass.defaultLayout());
791 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
792 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().track_changes))
793 break; // the character couldn't be deleted physically due to change tracking
796 // A singlePar update is not enough in this case.
797 cur.screenUpdateFlags(Update::Force);
798 cur.forceBufferUpdate();
800 // This check is necessary. Otherwise the new empty paragraph will
801 // be deleted automatically. And it is more friendly for the user!
802 if (cur.pos() != 0 || isempty)
803 setCursor(cur, cur.pit() + 1, 0);
805 setCursor(cur, cur.pit(), 0);
809 // needed to insert the selection
810 void Text::insertStringAsLines(Cursor & cur, docstring const & str,
813 BufferParams const & bparams = owner_->buffer().params();
814 pit_type pit = cur.pit();
815 pos_type pos = cur.pos();
817 // insert the string, don't insert doublespace
818 bool space_inserted = true;
819 for (docstring::const_iterator cit = str.begin();
820 cit != str.end(); ++cit) {
821 Paragraph & par = pars_[pit];
823 if (inset().allowMultiPar() && (!par.empty() || par.allowEmpty())) {
824 lyx::breakParagraph(*this, pit, pos,
825 par.layout().isEnvironment());
828 space_inserted = true;
832 // do not insert consecutive spaces if !free_spacing
833 } else if ((*cit == ' ' || *cit == '\t') &&
834 space_inserted && !par.isFreeSpacing()) {
836 } else if (*cit == '\t') {
837 if (!par.isFreeSpacing()) {
838 // tabs are like spaces here
839 par.insertChar(pos, ' ', font, bparams.track_changes);
841 space_inserted = true;
843 par.insertChar(pos, *cit, font, bparams.track_changes);
845 space_inserted = true;
847 } else if (!isPrintable(*cit)) {
848 // Ignore unprintables
851 // just insert the character
852 par.insertChar(pos, *cit, font, bparams.track_changes);
854 space_inserted = (*cit == ' ');
857 setCursor(cur, pit, pos);
861 // turn double CR to single CR, others are converted into one
862 // blank. Then insertStringAsLines is called
863 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str,
866 docstring linestr = str;
867 bool newline_inserted = false;
869 for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
870 if (linestr[i] == '\n') {
871 if (newline_inserted) {
872 // we know that \r will be ignored by
873 // insertStringAsLines. Of course, it is a dirty
874 // trick, but it works...
875 linestr[i - 1] = '\r';
879 newline_inserted = true;
881 } else if (isPrintable(linestr[i])) {
882 newline_inserted = false;
885 insertStringAsLines(cur, linestr, font);
889 // insert a character, moves all the following breaks in the
890 // same Paragraph one to the right and make a rebreak
891 void Text::insertChar(Cursor & cur, char_type c)
893 LBUFERR(this == cur.text());
895 cur.recordUndo(INSERT_UNDO);
897 TextMetrics const & tm = cur.bv().textMetrics(this);
898 Buffer const & buffer = *cur.buffer();
899 Paragraph & par = cur.paragraph();
900 // try to remove this
901 pit_type const pit = cur.pit();
903 bool const freeSpacing = par.layout().free_spacing ||
906 if (lyxrc.auto_number) {
907 static docstring const number_operators = from_ascii("+-/*");
908 static docstring const number_unary_operators = from_ascii("+-");
909 static docstring const number_separators = from_ascii(".,:");
911 if (cur.current_font.fontInfo().number() == FONT_ON) {
912 if (!isDigitASCII(c) && !contains(number_operators, c) &&
913 !(contains(number_separators, c) &&
915 cur.pos() != cur.lastpos() &&
916 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
917 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
919 number(cur); // Set current_font.number to OFF
920 } else if (isDigitASCII(c) &&
921 cur.real_current_font.isVisibleRightToLeft()) {
922 number(cur); // Set current_font.number to ON
924 if (cur.pos() != 0) {
925 char_type const c = par.getChar(cur.pos() - 1);
926 if (contains(number_unary_operators, c) &&
928 || par.isSeparator(cur.pos() - 2)
929 || par.isEnvSeparator(cur.pos() - 2)
930 || par.isNewline(cur.pos() - 2))
932 setCharFont(pit, cur.pos() - 1, cur.current_font,
934 } else if (contains(number_separators, c)
936 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
937 setCharFont(pit, cur.pos() - 1, cur.current_font,
944 // In Bidi text, we want spaces to be treated in a special way: spaces
945 // which are between words in different languages should get the
946 // paragraph's language; otherwise, spaces should keep the language
947 // they were originally typed in. This is only in effect while typing;
948 // after the text is already typed in, the user can always go back and
949 // explicitly set the language of a space as desired. But 99.9% of the
950 // time, what we're doing here is what the user actually meant.
952 // The following cases are the ones in which the language of the space
953 // should be changed to match that of the containing paragraph. In the
954 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
955 // represents a space, pipe (|) represents the cursor position (so the
956 // character before it is the one just typed in). The different cases
957 // are depicted logically (not visually), from left to right:
962 // Theoretically, there are other situations that we should, perhaps, deal
963 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
964 // point (to understand why, just try to create this situation...).
966 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
967 // get font in front and behind the space in question. But do NOT
968 // use getFont(cur.pos()) because the character c is not inserted yet
969 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
970 Font const & post_space_font = cur.real_current_font;
971 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
972 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
974 if (pre_space_rtl != post_space_rtl) {
975 // Set the space's language to match the language of the
976 // adjacent character whose direction is the paragraph's
977 // direction; don't touch other properties of the font
978 Language const * lang =
979 (pre_space_rtl == par.isRTL(buffer.params())) ?
980 pre_space_font.language() : post_space_font.language();
982 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
983 space_font.setLanguage(lang);
984 par.setFont(cur.pos() - 1, space_font);
988 // Next check, if there will be two blanks together or a blank at
989 // the beginning of a paragraph.
990 // I decided to handle blanks like normal characters, the main
991 // difference are the special checks when calculating the row.fill
992 // (blank does not count at the end of a row) and the check here
994 // When the free-spacing option is set for the current layout,
995 // disable the double-space checking
996 if (!freeSpacing && isLineSeparatorChar(c)) {
997 if (cur.pos() == 0) {
999 "You cannot insert a space at the "
1000 "beginning of a paragraph. Please read the Tutorial."));
1003 // LASSERT: Is it safe to continue here?
1004 LASSERT(cur.pos() > 0, /**/);
1005 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1006 && !par.isDeleted(cur.pos() - 1)) {
1008 "You cannot type two spaces this way. "
1009 "Please read the Tutorial."));
1014 // Prevent to insert uncodable characters in verbatim and ERT
1015 // (workaround for bug 9012)
1016 // Don't do it for listings inset, since InsetListings::latex() tries
1017 // to switch to a usable encoding which works in many cases (bug 9102).
1018 if (cur.paragraph().isPassThru() && owner_->lyxCode() != LISTINGS_CODE &&
1019 cur.current_font.language()) {
1020 Encoding const * e = cur.current_font.language()->encoding();
1021 if (!e->encodable(c)) {
1022 cur.message(_("Character is uncodable in verbatim paragraphs."));
1027 pos_type pos = cur.pos();
1028 if (!cur.paragraph().isPassThru() && owner_->lyxCode() != IPA_CODE &&
1029 cur.real_current_font.fontInfo().family() != TYPEWRITER_FAMILY &&
1030 c == '-' && pos > 0) {
1031 if (par.getChar(pos - 1) == '-') {
1032 // convert "--" to endash
1033 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1036 } else if (par.getChar(pos - 1) == 0x2013) {
1037 // convert "---" to emdash
1038 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1041 } else if (par.getChar(pos - 1) == 0x2014) {
1042 // convert "----" to "-"
1043 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1049 par.insertChar(pos, c, cur.current_font,
1050 cur.buffer()->params().track_changes);
1051 cur.checkBufferStructure();
1053 // cur.screenUpdateFlags(Update::Force);
1054 bool boundary = cur.boundary()
1055 || tm.isRTLBoundary(cur.pit(), pos + 1);
1056 setCursor(cur, cur.pit(), pos + 1, false, boundary);
1061 void Text::charInserted(Cursor & cur)
1063 Paragraph & par = cur.paragraph();
1065 // register word if a non-letter was entered
1067 && !par.isWordSeparator(cur.pos() - 2)
1068 && par.isWordSeparator(cur.pos() - 1)) {
1069 // get the word in front of cursor
1070 LBUFERR(this == cur.text());
1071 cur.paragraph().updateWords();
1076 // the cursor set functions have a special mechanism. When they
1077 // realize, that you left an empty paragraph, they will delete it.
1079 bool Text::cursorForwardOneWord(Cursor & cur)
1081 LBUFERR(this == cur.text());
1083 pos_type const lastpos = cur.lastpos();
1084 pit_type pit = cur.pit();
1085 pos_type pos = cur.pos();
1086 Paragraph const & par = cur.paragraph();
1088 // Paragraph boundary is a word boundary
1089 if (pos == lastpos || (pos + 1 == lastpos && par.isEnvSeparator(pos))) {
1090 if (pit != cur.lastpit())
1091 return setCursor(cur, pit + 1, 0);
1096 if (lyxrc.mac_like_cursor_movement) {
1097 // Skip through trailing punctuation and spaces.
1098 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
1101 // Skip over either a non-char inset or a full word
1102 if (pos != lastpos && par.isWordSeparator(pos))
1104 else while (pos != lastpos && !par.isWordSeparator(pos))
1107 LASSERT(pos < lastpos, return false); // see above
1108 if (!par.isWordSeparator(pos))
1109 while (pos != lastpos && !par.isWordSeparator(pos))
1111 else if (par.isChar(pos))
1112 while (pos != lastpos && par.isChar(pos))
1114 else if (!par.isSpace(pos)) // non-char inset
1117 // Skip over white space
1118 while (pos != lastpos && par.isSpace(pos))
1122 // Don't skip a separator inset at the end of a paragraph
1123 if (pos == lastpos && pos && par.isEnvSeparator(pos - 1))
1126 return setCursor(cur, pit, pos);
1130 bool Text::cursorBackwardOneWord(Cursor & cur)
1132 LBUFERR(this == cur.text());
1134 pit_type pit = cur.pit();
1135 pos_type pos = cur.pos();
1136 Paragraph & par = cur.paragraph();
1138 // Paragraph boundary is a word boundary
1139 if (pos == 0 && pit != 0) {
1140 Paragraph & prevpar = getPar(pit - 1);
1141 pos = prevpar.size();
1142 // Don't stop after an environment separator
1143 if (pos && prevpar.isEnvSeparator(pos - 1))
1145 return setCursor(cur, pit - 1, pos);
1148 if (lyxrc.mac_like_cursor_movement) {
1149 // Skip through punctuation and spaces.
1150 while (pos != 0 && (par.isChar(pos - 1) || par.isSpace(pos - 1)))
1153 // Skip over either a non-char inset or a full word
1154 if (pos != 0 && par.isWordSeparator(pos - 1) && !par.isChar(pos - 1))
1156 else while (pos != 0 && !par.isWordSeparator(pos - 1))
1159 // Skip over white space
1160 while (pos != 0 && par.isSpace(pos - 1))
1163 if (pos != 0 && !par.isWordSeparator(pos - 1))
1164 while (pos != 0 && !par.isWordSeparator(pos - 1))
1166 else if (pos != 0 && par.isChar(pos - 1))
1167 while (pos != 0 && par.isChar(pos - 1))
1169 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
1173 return setCursor(cur, pit, pos);
1177 bool Text::cursorVisLeftOneWord(Cursor & cur)
1179 LBUFERR(this == cur.text());
1181 pos_type left_pos, right_pos;
1183 Cursor temp_cur = cur;
1185 // always try to move at least once...
1186 while (temp_cur.posVisLeft(true /* skip_inset */)) {
1188 // collect some information about current cursor position
1189 temp_cur.getSurroundingPos(left_pos, right_pos);
1190 bool left_is_letter =
1191 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1192 bool right_is_letter =
1193 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1195 // if we're not at a letter/non-letter boundary, continue moving
1196 if (left_is_letter == right_is_letter)
1199 // we should stop when we have an LTR word on our right or an RTL word
1201 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1202 temp_cur.buffer()->params(), left_pos).isRightToLeft())
1203 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1204 temp_cur.buffer()->params(), right_pos).isRightToLeft()))
1208 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1209 true, temp_cur.boundary());
1213 bool Text::cursorVisRightOneWord(Cursor & cur)
1215 LBUFERR(this == cur.text());
1217 pos_type left_pos, right_pos;
1219 Cursor temp_cur = cur;
1221 // always try to move at least once...
1222 while (temp_cur.posVisRight(true /* skip_inset */)) {
1224 // collect some information about current cursor position
1225 temp_cur.getSurroundingPos(left_pos, right_pos);
1226 bool left_is_letter =
1227 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1228 bool right_is_letter =
1229 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1231 // if we're not at a letter/non-letter boundary, continue moving
1232 if (left_is_letter == right_is_letter)
1235 // we should stop when we have an LTR word on our right or an RTL word
1237 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1238 temp_cur.buffer()->params(),
1239 left_pos).isRightToLeft())
1240 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1241 temp_cur.buffer()->params(),
1242 right_pos).isRightToLeft()))
1246 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1247 true, temp_cur.boundary());
1251 void Text::selectWord(Cursor & cur, word_location loc)
1253 LBUFERR(this == cur.text());
1254 CursorSlice from = cur.top();
1256 getWord(from, to, loc);
1257 if (cur.top() != from)
1258 setCursor(cur, from.pit(), from.pos());
1261 if (!cur.selection())
1263 setCursor(cur, to.pit(), to.pos());
1265 cur.setWordSelection(true);
1269 void Text::selectAll(Cursor & cur)
1271 LBUFERR(this == cur.text());
1272 if (cur.lastpos() == 0 && cur.lastpit() == 0)
1274 // If the cursor is at the beginning, make sure the cursor ends there
1275 if (cur.pit() == 0 && cur.pos() == 0) {
1276 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1278 setCursor(cur, 0, 0);
1280 setCursor(cur, 0, 0);
1282 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1288 // Select the word currently under the cursor when no
1289 // selection is currently set
1290 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
1292 LBUFERR(this == cur.text());
1293 if (cur.selection())
1295 selectWord(cur, loc);
1296 return cur.selection();
1300 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
1302 LBUFERR(this == cur.text());
1304 if (!cur.selection()) {
1305 if (!selectChange(cur))
1309 cur.recordUndoSelection();
1311 pit_type begPit = cur.selectionBegin().pit();
1312 pit_type endPit = cur.selectionEnd().pit();
1314 pos_type begPos = cur.selectionBegin().pos();
1315 pos_type endPos = cur.selectionEnd().pos();
1317 // keep selection info, because endPos becomes invalid after the first loop
1318 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
1320 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
1321 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1322 pos_type parSize = pars_[pit].size();
1324 // ignore empty paragraphs; otherwise, an assertion will fail for
1325 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
1329 // do not consider first paragraph if the cursor starts at pos size()
1330 if (pit == begPit && begPos == parSize)
1333 // do not consider last paragraph if the cursor ends at pos 0
1334 if (pit == endPit && endPos == 0)
1335 break; // last iteration anyway
1337 pos_type left = (pit == begPit ? begPos : 0);
1338 pos_type right = (pit == endPit ? endPos : parSize);
1341 // there is no change here
1345 pars_[pit].acceptChanges(left, right);
1347 pars_[pit].rejectChanges(left, right);
1351 // next, accept/reject imaginary end-of-par characters
1353 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1354 pos_type pos = pars_[pit].size();
1356 // skip if the selection ends before the end-of-par
1357 if (pit == endPit && endsBeforeEndOfPar)
1358 break; // last iteration anyway
1360 // skip if this is not the last paragraph of the document
1361 // note: the user should be able to accept/reject the par break of the last par!
1362 if (pit == endPit && pit + 1 != int(pars_.size()))
1363 break; // last iteration anway
1366 if (pars_[pit].isInserted(pos)) {
1367 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1368 } else if (pars_[pit].isDeleted(pos)) {
1369 if (pit + 1 == int(pars_.size())) {
1370 // we cannot remove a par break at the end of the last paragraph;
1371 // instead, we mark it unchanged
1372 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1374 mergeParagraph(cur.buffer()->params(), pars_, pit);
1380 if (pars_[pit].isDeleted(pos)) {
1381 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1382 } else if (pars_[pit].isInserted(pos)) {
1383 if (pit + 1 == int(pars_.size())) {
1384 // we mark the par break at the end of the last paragraph unchanged
1385 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1387 mergeParagraph(cur.buffer()->params(), pars_, pit);
1395 // finally, invoke the DEPM
1396 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer()->params().track_changes);
1399 cur.clearSelection();
1400 setCursorIntern(cur, begPit, begPos);
1401 cur.screenUpdateFlags(Update::Force);
1402 cur.forceBufferUpdate();
1406 void Text::acceptChanges()
1408 BufferParams const & bparams = owner_->buffer().params();
1409 lyx::acceptChanges(pars_, bparams);
1410 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.track_changes);
1414 void Text::rejectChanges()
1416 BufferParams const & bparams = owner_->buffer().params();
1417 pit_type pars_size = static_cast<pit_type>(pars_.size());
1419 // first, reject changes within each individual paragraph
1420 // (do not consider end-of-par)
1421 for (pit_type pit = 0; pit < pars_size; ++pit) {
1422 if (!pars_[pit].empty()) // prevent assertion failure
1423 pars_[pit].rejectChanges(0, pars_[pit].size());
1426 // next, reject imaginary end-of-par characters
1427 for (pit_type pit = 0; pit < pars_size; ++pit) {
1428 pos_type pos = pars_[pit].size();
1430 if (pars_[pit].isDeleted(pos)) {
1431 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1432 } else if (pars_[pit].isInserted(pos)) {
1433 if (pit == pars_size - 1) {
1434 // we mark the par break at the end of the last
1435 // paragraph unchanged
1436 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1438 mergeParagraph(bparams, pars_, pit);
1445 // finally, invoke the DEPM
1446 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.track_changes);
1450 void Text::deleteWordForward(Cursor & cur)
1452 LBUFERR(this == cur.text());
1453 if (cur.lastpos() == 0)
1457 cur.selection(true);
1458 cursorForwardOneWord(cur);
1460 cutSelection(cur, true, false);
1461 cur.checkBufferStructure();
1466 void Text::deleteWordBackward(Cursor & cur)
1468 LBUFERR(this == cur.text());
1469 if (cur.lastpos() == 0)
1470 cursorBackward(cur);
1473 cur.selection(true);
1474 cursorBackwardOneWord(cur);
1476 cutSelection(cur, true, false);
1477 cur.checkBufferStructure();
1482 // Kill to end of line.
1483 void Text::changeCase(Cursor & cur, TextCase action, bool partial)
1485 LBUFERR(this == cur.text());
1489 bool const gotsel = cur.selection();
1491 from = cur.selBegin();
1495 getWord(from, to, partial ? PARTIAL_WORD : WHOLE_WORD);
1496 cursorForwardOneWord(cur);
1499 cur.recordUndoSelection();
1501 pit_type begPit = from.pit();
1502 pit_type endPit = to.pit();
1504 pos_type begPos = from.pos();
1505 pos_type endPos = to.pos();
1507 pos_type right = 0; // needed after the for loop
1509 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1510 Paragraph & par = pars_[pit];
1511 pos_type const pos = (pit == begPit ? begPos : 0);
1512 right = (pit == endPit ? endPos : par.size());
1513 par.changeCase(cur.buffer()->params(), pos, right, action);
1516 // the selection may have changed due to logically-only deleted chars
1518 setCursor(cur, begPit, begPos);
1520 setCursor(cur, endPit, right);
1523 setCursor(cur, endPit, right);
1525 cur.checkBufferStructure();
1529 bool Text::handleBibitems(Cursor & cur)
1531 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1537 BufferParams const & bufparams = cur.buffer()->params();
1538 Paragraph const & par = cur.paragraph();
1539 Cursor prevcur = cur;
1540 if (cur.pit() > 0) {
1542 prevcur.pos() = prevcur.lastpos();
1544 Paragraph const & prevpar = prevcur.paragraph();
1546 // if a bibitem is deleted, merge with previous paragraph
1547 // if this is a bibliography item as well
1548 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1549 cur.recordUndo(prevcur.pit());
1550 mergeParagraph(bufparams, cur.text()->paragraphs(),
1552 cur.forceBufferUpdate();
1553 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1554 cur.screenUpdateFlags(Update::Force);
1558 // otherwise reset to default
1559 cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1564 bool Text::erase(Cursor & cur)
1566 LASSERT(this == cur.text(), return false);
1567 bool needsUpdate = false;
1568 Paragraph & par = cur.paragraph();
1570 if (cur.pos() != cur.lastpos()) {
1571 // this is the code for a normal delete, not pasting
1573 cur.recordUndo(DELETE_UNDO);
1574 bool const was_inset = cur.paragraph().isInset(cur.pos());
1575 if(!par.eraseChar(cur.pos(), cur.buffer()->params().track_changes))
1576 // the character has been logically deleted only => skip it
1577 cur.top().forwardPos();
1580 cur.forceBufferUpdate();
1582 cur.checkBufferStructure();
1585 if (cur.pit() == cur.lastpit())
1586 return dissolveInset(cur);
1588 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1589 cur.recordUndo(DELETE_UNDO);
1590 par.setChange(cur.pos(), Change(Change::DELETED));
1594 setCursorIntern(cur, cur.pit() + 1, 0);
1595 needsUpdate = backspacePos0(cur);
1599 needsUpdate |= handleBibitems(cur);
1602 // Make sure the cursor is correct. Is this really needed?
1603 // No, not really... at least not here!
1604 cur.top().setPitPos(cur.pit(), cur.pos());
1605 cur.checkBufferStructure();
1612 bool Text::backspacePos0(Cursor & cur)
1614 LBUFERR(this == cur.text());
1618 bool needsUpdate = false;
1620 BufferParams const & bufparams = cur.buffer()->params();
1621 DocumentClass const & tclass = bufparams.documentClass();
1622 ParagraphList & plist = cur.text()->paragraphs();
1623 Paragraph const & par = cur.paragraph();
1624 Cursor prevcur = cur;
1626 prevcur.pos() = prevcur.lastpos();
1627 Paragraph const & prevpar = prevcur.paragraph();
1629 // is it an empty paragraph?
1630 if (cur.lastpos() == 0
1631 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1632 cur.recordUndo(prevcur.pit());
1633 plist.erase(lyx::next(plist.begin(), cur.pit()));
1636 // is previous par empty?
1637 else if (prevcur.lastpos() == 0
1638 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1639 cur.recordUndo(prevcur.pit());
1640 plist.erase(lyx::next(plist.begin(), prevcur.pit()));
1643 // Pasting is not allowed, if the paragraphs have different
1644 // layouts. I think it is a real bug of all other
1645 // word processors to allow it. It confuses the user.
1646 // Correction: Pasting is always allowed with standard-layout
1647 // or the empty layout.
1648 else if (par.layout() == prevpar.layout()
1649 || tclass.isDefaultLayout(par.layout())
1650 || tclass.isPlainLayout(par.layout())) {
1651 cur.recordUndo(prevcur.pit());
1652 mergeParagraph(bufparams, plist, prevcur.pit());
1657 cur.forceBufferUpdate();
1658 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1665 bool Text::backspace(Cursor & cur)
1667 LBUFERR(this == cur.text());
1668 bool needsUpdate = false;
1669 if (cur.pos() == 0) {
1671 return dissolveInset(cur);
1673 Cursor prev_cur = cur;
1676 if (!prev_cur.paragraph().isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1677 cur.recordUndo(prev_cur.pit(), prev_cur.pit());
1678 prev_cur.paragraph().setChange(prev_cur.lastpos(), Change(Change::DELETED));
1679 setCursorIntern(cur, prev_cur.pit(), prev_cur.lastpos());
1682 // The cursor is at the beginning of a paragraph, so
1683 // the backspace will collapse two paragraphs into one.
1684 needsUpdate = backspacePos0(cur);
1687 // this is the code for a normal backspace, not pasting
1689 cur.recordUndo(DELETE_UNDO);
1690 // We used to do cursorBackwardIntern() here, but it is
1691 // not a good idea since it triggers the auto-delete
1692 // mechanism. So we do a cursorBackwardIntern()-lite,
1693 // without the dreaded mechanism. (JMarc)
1694 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1695 false, cur.boundary());
1696 bool const was_inset = cur.paragraph().isInset(cur.pos());
1697 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().track_changes);
1699 cur.forceBufferUpdate();
1701 cur.checkBufferStructure();
1704 if (cur.pos() == cur.lastpos())
1705 cur.setCurrentFont();
1707 needsUpdate |= handleBibitems(cur);
1709 // A singlePar update is not enough in this case.
1710 // cur.screenUpdateFlags(Update::Force);
1711 cur.top().setPitPos(cur.pit(), cur.pos());
1717 bool Text::dissolveInset(Cursor & cur)
1719 LASSERT(this == cur.text(), return false);
1721 if (isMainText() || cur.inset().nargs() != 1)
1724 cur.recordUndoInset();
1726 cur.selHandle(false);
1728 pos_type spos = cur.pos();
1729 pit_type spit = cur.pit();
1730 ParagraphList plist;
1731 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1732 plist = paragraphs();
1734 // store cursor offset
1738 Buffer & b = *cur.buffer();
1739 cur.paragraph().eraseChar(cur.pos(), b.params().track_changes);
1741 if (!plist.empty()) {
1743 // we clear the cache so that we won't get conflicts with labels
1744 // that get pasted into the buffer. we should update this before
1745 // its being empty matters. if not (i.e., if we encounter bugs),
1746 // then this should instead be:
1747 // cur.buffer().updateBuffer();
1748 // but we'll try the cheaper solution here.
1749 cur.buffer()->clearReferenceCache();
1751 // ERT paragraphs have the Language latex_language.
1752 // This is invalid outside of ERT, so we need to
1753 // change it to the buffer language.
1754 ParagraphList::iterator it = plist.begin();
1755 ParagraphList::iterator it_end = plist.end();
1756 for (; it != it_end; ++it)
1757 it->changeLanguage(b.params(), latex_language, b.language());
1759 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1760 b.errorList("Paste"));
1762 cur.pit() = min(cur.lastpit(), spit);
1763 cur.pos() = min(cur.lastpos(), spos);
1766 cur.forceBufferUpdate();
1768 // Ensure the current language is set correctly (bug 6292)
1769 cur.text()->setCursor(cur, cur.pit(), cur.pos());
1770 cur.clearSelection();
1776 void Text::getWord(CursorSlice & from, CursorSlice & to,
1777 word_location const loc) const
1780 pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1784 void Text::write(ostream & os) const
1786 Buffer const & buf = owner_->buffer();
1787 ParagraphList::const_iterator pit = paragraphs().begin();
1788 ParagraphList::const_iterator end = paragraphs().end();
1790 for (; pit != end; ++pit)
1791 pit->write(os, buf.params(), dth);
1793 // Close begin_deeper
1794 for(; dth > 0; --dth)
1795 os << "\n\\end_deeper";
1799 bool Text::read(Lexer & lex,
1800 ErrorList & errorList, InsetText * insetPtr)
1802 Buffer const & buf = owner_->buffer();
1803 depth_type depth = 0;
1806 while (lex.isOK()) {
1808 string const token = lex.getString();
1813 if (token == "\\end_inset")
1816 if (token == "\\end_body")
1819 if (token == "\\begin_body")
1822 if (token == "\\end_document") {
1827 if (token == "\\begin_layout") {
1828 lex.pushToken(token);
1831 par.setInsetOwner(insetPtr);
1832 par.params().depth(depth);
1833 par.setFont(0, Font(inherit_font, buf.params().language));
1834 pars_.push_back(par);
1835 readParagraph(pars_.back(), lex, errorList);
1837 // register the words in the global word list
1838 pars_.back().updateWords();
1839 } else if (token == "\\begin_deeper") {
1841 } else if (token == "\\end_deeper") {
1843 lex.printError("\\end_deeper: " "depth is already null");
1847 LYXERR0("Handling unknown body token: `" << token << '\'');
1851 // avoid a crash on weird documents (bug 4859)
1852 if (pars_.empty()) {
1854 par.setInsetOwner(insetPtr);
1855 par.params().depth(depth);
1856 par.setFont(0, Font(inherit_font,
1857 buf.params().language));
1858 par.setPlainOrDefaultLayout(buf.params().documentClass());
1859 pars_.push_back(par);
1866 // Returns the current font and depth as a message.
1867 docstring Text::currentState(Cursor const & cur) const
1869 LBUFERR(this == cur.text());
1870 Buffer & buf = *cur.buffer();
1871 Paragraph const & par = cur.paragraph();
1872 odocstringstream os;
1874 if (buf.params().track_changes)
1875 os << _("[Change Tracking] ");
1877 Change change = par.lookupChange(cur.pos());
1879 if (change.changed()) {
1880 docstring const author =
1881 buf.params().authors().get(change.author).nameAndEmail();
1882 docstring const date = formatted_datetime(change.changetime);
1883 os << bformat(_("Changed by %1$s[[author]] on %2$s[[date]]. "),
1887 // I think we should only show changes from the default
1889 // No, from the document font (MV)
1890 Font font = cur.real_current_font;
1891 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1893 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1895 // The paragraph depth
1896 int depth = cur.paragraph().getDepth();
1898 os << bformat(_(", Depth: %1$d"), depth);
1900 // The paragraph spacing, but only if different from
1902 Spacing const & spacing = par.params().spacing();
1903 if (!spacing.isDefault()) {
1904 os << _(", Spacing: ");
1905 switch (spacing.getSpace()) {
1906 case Spacing::Single:
1909 case Spacing::Onehalf:
1912 case Spacing::Double:
1915 case Spacing::Other:
1916 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1918 case Spacing::Default:
1919 // should never happen, do nothing
1924 #ifdef DEVEL_VERSION
1925 os << _(", Inset: ") << &cur.inset();
1926 os << _(", Paragraph: ") << cur.pit();
1927 os << _(", Id: ") << par.id();
1928 os << _(", Position: ") << cur.pos();
1929 // FIXME: Why is the check for par.size() needed?
1930 // We are called with cur.pos() == par.size() quite often.
1931 if (!par.empty() && cur.pos() < par.size()) {
1932 // Force output of code point, not character
1933 size_t const c = par.getChar(cur.pos());
1934 os << _(", Char: 0x") << hex << c;
1936 os << _(", Boundary: ") << cur.boundary();
1937 // Row & row = cur.textRow();
1938 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1944 docstring Text::getPossibleLabel(Cursor const & cur) const
1946 pit_type pit = cur.pit();
1948 Layout const * layout = &(pars_[pit].layout());
1951 docstring par_text = pars_[pit].asString();
1953 // The return string of math matrices might contain linebreaks
1954 par_text = subst(par_text, '\n', '-');
1955 int const numwords = 3;
1956 for (int i = 0; i < numwords; ++i) {
1957 if (par_text.empty())
1960 par_text = split(par_text, head, ' ');
1961 // Is it legal to use spaces in labels ?
1967 // Make sure it isn't too long
1968 unsigned int const max_label_length = 32;
1969 if (text.size() > max_label_length)
1970 text.resize(max_label_length);
1972 // Will contain the label prefix.
1975 // For section, subsection, etc...
1976 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1977 Layout const * layout2 = &(pars_[pit - 1].layout());
1978 if (layout2->latextype != LATEX_PARAGRAPH) {
1983 if (layout->latextype != LATEX_PARAGRAPH)
1984 name = layout->refprefix;
1986 // For captions, we just take the caption type
1987 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1988 if (caption_inset) {
1989 string const & ftype = static_cast<InsetCaption *>(caption_inset)->floattype();
1990 FloatList const & fl = cur.buffer()->params().documentClass().floats();
1991 if (fl.typeExist(ftype)) {
1992 Floating const & flt = fl.getType(ftype);
1993 name = from_utf8(flt.refPrefix());
1996 name = from_utf8(ftype.substr(0,3));
1999 // If none of the above worked, see if the inset knows.
2001 InsetLayout const & il = cur.inset().getLayout();
2002 name = il.refprefix();
2006 text = name + ':' + text;
2008 // We need a unique label
2009 docstring label = text;
2011 while (cur.buffer()->insetLabel(label)) {
2012 label = text + '-' + convert<docstring>(i);
2020 docstring Text::asString(int options) const
2022 return asString(0, pars_.size(), options);
2026 docstring Text::asString(pit_type beg, pit_type end, int options) const
2028 size_t i = size_t(beg);
2029 docstring str = pars_[i].asString(options);
2030 for (++i; i != size_t(end); ++i) {
2032 str += pars_[i].asString(options);
2038 void Text::shortenForOutliner(docstring & str, size_t const maxlen)
2040 support::truncateWithEllipsis(str, maxlen);
2041 docstring::iterator it = str.begin();
2042 docstring::iterator end = str.end();
2043 for (; it != end; ++it)
2044 if ((*it) == L'\n' || (*it) == L'\t')
2049 void Text::forOutliner(docstring & os, size_t const maxlen,
2050 bool const shorten) const
2052 size_t tmplen = shorten ? maxlen + 1 : maxlen;
2053 for (size_t i = 0; i != pars_.size() && os.length() < tmplen; ++i)
2054 pars_[i].forOutliner(os, tmplen, false);
2056 shortenForOutliner(os, maxlen);
2060 void Text::charsTranspose(Cursor & cur)
2062 LBUFERR(this == cur.text());
2064 pos_type pos = cur.pos();
2066 // If cursor is at beginning or end of paragraph, do nothing.
2067 if (pos == cur.lastpos() || pos == 0)
2070 Paragraph & par = cur.paragraph();
2072 // Get the positions of the characters to be transposed.
2073 pos_type pos1 = pos - 1;
2074 pos_type pos2 = pos;
2076 // In change tracking mode, ignore deleted characters.
2077 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2079 if (pos2 == cur.lastpos())
2082 while (pos1 >= 0 && par.isDeleted(pos1))
2087 // Don't do anything if one of the "characters" is not regular text.
2088 if (par.isInset(pos1) || par.isInset(pos2))
2091 // Store the characters to be transposed (including font information).
2092 char_type const char1 = par.getChar(pos1);
2094 par.getFontSettings(cur.buffer()->params(), pos1);
2096 char_type const char2 = par.getChar(pos2);
2098 par.getFontSettings(cur.buffer()->params(), pos2);
2100 // And finally, we are ready to perform the transposition.
2101 // Track the changes if Change Tracking is enabled.
2102 bool const trackChanges = cur.buffer()->params().track_changes;
2106 par.eraseChar(pos2, trackChanges);
2107 par.eraseChar(pos1, trackChanges);
2108 par.insertChar(pos1, char2, font2, trackChanges);
2109 par.insertChar(pos2, char1, font1, trackChanges);
2111 cur.checkBufferStructure();
2113 // After the transposition, move cursor to after the transposition.
2114 setCursor(cur, cur.pit(), pos2);
2119 DocIterator Text::macrocontextPosition() const
2121 return macrocontext_position_;
2125 void Text::setMacrocontextPosition(DocIterator const & pos)
2127 macrocontext_position_ = pos;
2131 docstring Text::previousWord(CursorSlice const & sl) const
2133 CursorSlice from = sl;
2134 CursorSlice to = sl;
2135 getWord(from, to, PREVIOUS_WORD);
2136 if (sl == from || to == from)
2139 Paragraph const & par = sl.paragraph();
2140 return par.asString(from.pos(), to.pos());
2144 bool Text::completionSupported(Cursor const & cur) const
2146 Paragraph const & par = cur.paragraph();
2147 return cur.pos() > 0
2148 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
2149 && !par.isWordSeparator(cur.pos() - 1);
2153 CompletionList const * Text::createCompletionList(Cursor const & cur) const
2155 WordList const * list = theWordList(cur.getFont().language()->lang());
2156 return new TextCompletionList(cur, list);
2160 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
2162 LBUFERR(cur.bv().cursor() == cur);
2164 cur.bv().cursor() = cur;
2165 if (!(cur.result().screenUpdate() & Update::Force))
2166 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
2171 docstring Text::completionPrefix(Cursor const & cur) const
2173 return previousWord(cur.top());