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/textutils.h"
75 // TODO: replace if in Text::readParToken() with compile time switch
78 #include "support/metahash.h"
80 typedef boost::mpl::string<'\\end','_lay','out'> end_layout;
81 typedef boost::mpl::string<'\\end','in','set'> end_inset;
85 std::string token = "\\end_layout";
87 switch (boost::hash_value(token)) {
88 case lyx::support::hash_string<end_layout>::value:
90 case lyx::support::hash_string<end_inset>::value:
100 using namespace lyx::support;
104 using cap::cutSelection;
105 using cap::pasteParagraphList;
107 static bool moveItem(Paragraph & fromPar, pos_type fromPos,
108 Paragraph & toPar, pos_type toPos, BufferParams const & params)
110 // Note: moveItem() does not honour change tracking!
111 // Therefore, it should only be used for breaking and merging paragraphs
113 // We need a copy here because the character at fromPos is going to be erased.
114 Font const tmpFont = fromPar.getFontSettings(params, fromPos);
115 Change const tmpChange = fromPar.lookupChange(fromPos);
117 if (Inset * tmpInset = fromPar.getInset(fromPos)) {
118 fromPar.releaseInset(fromPos);
119 // The inset is not in fromPar any more.
120 if (!toPar.insertInset(toPos, tmpInset, tmpFont, tmpChange)) {
127 char_type const tmpChar = fromPar.getChar(fromPos);
128 fromPar.eraseChar(fromPos, false);
129 toPar.insertChar(toPos, tmpChar, tmpFont, tmpChange);
134 void breakParagraphConservative(BufferParams const & bparams,
135 ParagraphList & pars, pit_type par_offset, pos_type pos)
137 // create a new paragraph
138 Paragraph & tmp = *pars.insert(next(pars.begin(), par_offset + 1),
140 Paragraph & par = pars[par_offset];
142 tmp.setInsetOwner(&par.inInset());
143 tmp.makeSameLayout(par);
145 LASSERT(pos <= par.size(), return);
147 if (pos < par.size()) {
148 // move everything behind the break position to the new paragraph
149 pos_type pos_end = par.size() - 1;
151 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
152 if (moveItem(par, pos, tmp, j, bparams)) {
156 // Move over the end-of-par change information
157 tmp.setChange(tmp.size(), par.lookupChange(par.size()));
158 par.setChange(par.size(), Change(bparams.track_changes ?
159 Change::INSERTED : Change::UNCHANGED));
164 void mergeParagraph(BufferParams const & bparams,
165 ParagraphList & pars, pit_type par_offset)
167 Paragraph & next = pars[par_offset + 1];
168 Paragraph & par = pars[par_offset];
170 pos_type pos_end = next.size() - 1;
171 pos_type pos_insert = par.size();
173 // the imaginary end-of-paragraph character (at par.size()) has to be
174 // marked as unmodified. Otherwise, its change is adopted by the first
175 // character of the next paragraph.
176 if (par.isChanged(par.size())) {
177 LYXERR(Debug::CHANGES,
178 "merging par with inserted/deleted end-of-par character");
179 par.setChange(par.size(), Change(Change::UNCHANGED));
182 Change change = next.lookupChange(next.size());
184 // move the content of the second paragraph to the end of the first one
185 for (pos_type i = 0, j = pos_insert; i <= pos_end; ++i) {
186 if (moveItem(next, 0, par, j, bparams)) {
191 // move the change of the end-of-paragraph character
192 par.setChange(par.size(), change);
194 pars.erase(lyx::next(pars.begin(), par_offset + 1));
198 Text::Text(InsetText * owner, bool use_default_layout)
201 pars_.push_back(Paragraph());
202 Paragraph & par = pars_.back();
203 par.setInsetOwner(owner);
204 DocumentClass const & dc = owner->buffer().params().documentClass();
205 if (use_default_layout)
206 par.setDefaultLayout(dc);
208 par.setPlainLayout(dc);
212 Text::Text(InsetText * owner, Text const & text)
216 ParagraphList::iterator const end = pars_.end();
217 ParagraphList::iterator it = pars_.begin();
218 for (; it != end; ++it)
219 it->setInsetOwner(owner);
223 pit_type Text::depthHook(pit_type pit, depth_type depth) const
225 pit_type newpit = pit;
230 while (newpit != 0 && pars_[newpit].getDepth() > depth)
233 if (pars_[newpit].getDepth() > depth)
240 pit_type Text::outerHook(pit_type par_offset) const
242 Paragraph const & par = pars_[par_offset];
244 if (par.getDepth() == 0)
246 return depthHook(par_offset, depth_type(par.getDepth() - 1));
250 bool Text::isFirstInSequence(pit_type par_offset) const
252 Paragraph const & par = pars_[par_offset];
254 pit_type dhook_offset = depthHook(par_offset, par.getDepth());
256 if (dhook_offset == par_offset)
259 Paragraph const & dhook = pars_[dhook_offset];
261 return dhook.layout() != par.layout()
262 || dhook.getDepth() != par.getDepth();
266 int Text::getTocLevel(pit_type par_offset) const
268 Paragraph const & par = pars_[par_offset];
270 if (par.layout().isEnvironment() && !isFirstInSequence(par_offset))
271 return Layout::NOT_IN_TOC;
273 return par.layout().toclevel;
277 Font const Text::outerFont(pit_type par_offset) const
279 depth_type par_depth = pars_[par_offset].getDepth();
280 FontInfo tmpfont = inherit_font;
281 depth_type prev_par_depth = 0;
282 // Resolve against environment font information
283 while (par_offset != pit_type(pars_.size())
284 && par_depth != prev_par_depth
286 && !tmpfont.resolved()) {
287 prev_par_depth = par_depth;
288 par_offset = outerHook(par_offset);
289 if (par_offset != pit_type(pars_.size())) {
290 tmpfont.realize(pars_[par_offset].layout().font);
291 par_depth = pars_[par_offset].getDepth();
295 return Font(tmpfont);
299 static void acceptOrRejectChanges(ParagraphList & pars,
300 BufferParams const & bparams, Text::ChangeOp op)
302 pit_type pars_size = static_cast<pit_type>(pars.size());
304 // first, accept or reject changes within each individual
305 // paragraph (do not consider end-of-par)
306 for (pit_type pit = 0; pit < pars_size; ++pit) {
307 // prevent assertion failure
308 if (!pars[pit].empty()) {
309 if (op == Text::ACCEPT)
310 pars[pit].acceptChanges(0, pars[pit].size());
312 pars[pit].rejectChanges(0, pars[pit].size());
316 // next, accept or reject imaginary end-of-par characters
317 for (pit_type pit = 0; pit < pars_size; ++pit) {
318 pos_type pos = pars[pit].size();
319 if (pars[pit].isChanged(pos)) {
320 // keep the end-of-par char if it is inserted and accepted
321 // or when it is deleted and rejected.
322 if (pars[pit].isInserted(pos) == (op == Text::ACCEPT)) {
323 pars[pit].setChange(pos, Change(Change::UNCHANGED));
325 if (pit == pars_size - 1) {
326 // we cannot remove a par break at the end of the last
327 // paragraph; instead, we mark it unchanged
328 pars[pit].setChange(pos, Change(Change::UNCHANGED));
330 mergeParagraph(bparams, pars, pit);
340 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
342 acceptOrRejectChanges(pars, bparams, Text::ACCEPT);
346 void rejectChanges(ParagraphList & pars, BufferParams const & bparams)
348 acceptOrRejectChanges(pars, bparams, Text::REJECT);
352 InsetText const & Text::inset() const
359 void Text::readParToken(Paragraph & par, Lexer & lex,
360 string const & token, Font & font, Change & change, ErrorList & errorList)
362 Buffer * buf = const_cast<Buffer *>(&owner_->buffer());
363 BufferParams & bp = buf->params();
365 if (token[0] != '\\') {
366 docstring dstr = lex.getDocString();
367 par.appendString(dstr, font, change);
369 } else if (token == "\\begin_layout") {
371 docstring layoutname = lex.getDocString();
373 font = Font(inherit_font, bp.language);
374 change = Change(Change::UNCHANGED);
376 DocumentClass const & tclass = bp.documentClass();
378 if (layoutname.empty())
379 layoutname = tclass.defaultLayoutName();
381 if (owner_->forcePlainLayout()) {
382 // in this case only the empty layout is allowed
383 layoutname = tclass.plainLayoutName();
384 } else if (par.usePlainLayout()) {
385 // in this case, default layout maps to empty layout
386 if (layoutname == tclass.defaultLayoutName())
387 layoutname = tclass.plainLayoutName();
389 // otherwise, the empty layout maps to the default
390 if (layoutname == tclass.plainLayoutName())
391 layoutname = tclass.defaultLayoutName();
394 // When we apply an unknown layout to a document, we add this layout to the textclass
395 // of this document. For example, when you apply class article to a beamer document,
396 // all unknown layouts such as frame will be added to document class article so that
397 // these layouts can keep their original names.
398 bool const added_one = tclass.addLayoutIfNeeded(layoutname);
401 docstring const s = bformat(_("Layout `%1$s' was not found."), layoutname);
403 ErrorItem(_("Layout Not Found"), s, par.id(), 0, par.size()));
406 par.setLayout(bp.documentClass()[layoutname]);
408 // Test whether the layout is obsolete.
409 Layout const & layout = par.layout();
410 if (!layout.obsoleted_by().empty())
411 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
413 par.params().read(lex);
415 } else if (token == "\\end_layout") {
416 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
417 << "Missing \\begin_layout ?");
418 } else if (token == "\\end_inset") {
419 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
420 << "Missing \\begin_inset ?");
421 } else if (token == "\\begin_inset") {
422 Inset * inset = readInset(lex, buf);
424 par.insertInset(par.size(), inset, font, change);
427 docstring line = lex.getDocString();
428 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
429 par.id(), 0, par.size()));
431 } else if (token == "\\family") {
433 setLyXFamily(lex.getString(), font.fontInfo());
434 } else if (token == "\\series") {
436 setLyXSeries(lex.getString(), font.fontInfo());
437 } else if (token == "\\shape") {
439 setLyXShape(lex.getString(), font.fontInfo());
440 } else if (token == "\\size") {
442 setLyXSize(lex.getString(), font.fontInfo());
443 } else if (token == "\\lang") {
445 string const tok = lex.getString();
446 Language const * lang = languages.getLanguage(tok);
448 font.setLanguage(lang);
450 font.setLanguage(bp.language);
451 lex.printError("Unknown language `$$Token'");
453 } else if (token == "\\numeric") {
455 font.fontInfo().setNumber(setLyXMisc(lex.getString()));
456 } else if (token == "\\emph") {
458 font.fontInfo().setEmph(setLyXMisc(lex.getString()));
459 } else if (token == "\\bar") {
461 string const tok = lex.getString();
464 font.fontInfo().setUnderbar(FONT_ON);
465 else if (tok == "no")
466 font.fontInfo().setUnderbar(FONT_OFF);
467 else if (tok == "default")
468 font.fontInfo().setUnderbar(FONT_INHERIT);
470 lex.printError("Unknown bar font flag "
472 } else if (token == "\\strikeout") {
474 font.fontInfo().setStrikeout(setLyXMisc(lex.getString()));
475 } else if (token == "\\uuline") {
477 font.fontInfo().setUuline(setLyXMisc(lex.getString()));
478 } else if (token == "\\uwave") {
480 font.fontInfo().setUwave(setLyXMisc(lex.getString()));
481 } else if (token == "\\noun") {
483 font.fontInfo().setNoun(setLyXMisc(lex.getString()));
484 } else if (token == "\\color") {
486 setLyXColor(lex.getString(), font.fontInfo());
487 } else if (token == "\\SpecialChar" ||
488 (token == "\\SpecialCharNoPassThru" &&
489 !par.layout().pass_thru && !inset().isPassThru())) {
490 auto_ptr<Inset> inset;
491 inset.reset(new InsetSpecialChar);
493 inset->setBuffer(*buf);
494 par.insertInset(par.size(), inset.release(), font, change);
495 } else if (token == "\\SpecialCharNoPassThru") {
497 docstring const s = ltrim(lex.getDocString(), "\\");
498 par.insert(par.size(), s, font, change);
499 } else if (token == "\\IPAChar") {
500 auto_ptr<Inset> inset;
501 inset.reset(new InsetIPAChar);
503 inset->setBuffer(*buf);
504 par.insertInset(par.size(), inset.release(), font, change);
505 } else if (token == "\\twohyphens" || token == "\\threehyphens") {
506 // Ideally, this should be done by lyx2lyx, but lyx2lyx does not know the
507 // running font and does not know anything about layouts (and CopyStyle).
508 Layout const & layout(par.layout());
509 FontInfo info = font.fontInfo();
510 info.realize(layout.resfont);
511 if (layout.pass_thru || inset().isPassThru() ||
512 info.family() == TYPEWRITER_FAMILY) {
513 if (token == "\\twohyphens")
514 par.insert(par.size(), from_ascii("--"), font, change);
516 par.insert(par.size(), from_ascii("---"), font, change);
518 if (token == "\\twohyphens")
519 par.insertChar(par.size(), 0x2013, font, change);
521 par.insertChar(par.size(), 0x2014, font, change);
523 } else if (token == "\\backslash") {
524 par.appendChar('\\', font, change);
525 } else if (token == "\\LyXTable") {
526 auto_ptr<Inset> inset(new InsetTabular(buf));
528 par.insertInset(par.size(), inset.release(), font, change);
529 } else if (token == "\\change_unchanged") {
530 change = Change(Change::UNCHANGED);
531 } else if (token == "\\change_inserted" || token == "\\change_deleted") {
533 istringstream is(lex.getString());
537 BufferParams::AuthorMap const & am = bp.author_map_;
538 if (am.find(aid) == am.end()) {
539 errorList.push_back(ErrorItem(
540 _("Change tracking author index missing"),
541 bformat(_("A change tracking author information for index "
542 "%1$d is missing. This can happen after a wrong "
543 "merge by a version control system. In this case, "
544 "either fix the merge, or have this information "
545 "missing until the corresponding tracked changes "
546 "are merged or this user edits the file again.\n"),
548 par.id(), par.size(), par.size() + 1
550 bp.addAuthor(Author(aid));
552 if (token == "\\change_inserted")
553 change = Change(Change::INSERTED, am.find(aid)->second, ct);
555 change = Change(Change::DELETED, am.find(aid)->second, ct);
558 errorList.push_back(ErrorItem(_("Unknown token"),
559 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
561 par.id(), 0, par.size()));
566 void Text::readParagraph(Paragraph & par, Lexer & lex,
567 ErrorList & errorList)
570 string token = lex.getString();
572 Change change(Change::UNCHANGED);
575 readParToken(par, lex, token, font, change, errorList);
578 token = lex.getString();
583 if (token == "\\end_layout") {
584 //Ok, paragraph finished
588 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
589 if (token == "\\begin_layout" || token == "\\end_document"
590 || token == "\\end_inset" || token == "\\begin_deeper"
591 || token == "\\end_deeper") {
592 lex.pushToken(token);
593 lyxerr << "Paragraph ended in line "
594 << lex.lineNumber() << "\n"
595 << "Missing \\end_layout.\n";
599 // Final change goes to paragraph break:
600 par.setChange(par.size(), change);
602 // Initialize begin_of_body_ on load; redoParagraph maintains
603 par.setBeginOfBody();
605 // mark paragraph for spell checking on load
606 // par.requestSpellCheck();
610 class TextCompletionList : public CompletionList
614 TextCompletionList(Cursor const & cur, WordList const * list)
615 : buffer_(cur.buffer()), list_(list)
618 virtual ~TextCompletionList() {}
621 virtual bool sorted() const { return true; }
623 virtual size_t size() const
625 return list_->size();
628 virtual docstring const & data(size_t idx) const
630 return list_->word(idx);
635 Buffer const * buffer_;
637 WordList const * list_;
641 bool Text::empty() const
643 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
644 // FIXME: Should we consider the labeled type as empty too?
645 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
649 double Text::spacing(Paragraph const & par) const
651 if (par.params().spacing().isDefault())
652 return owner_->buffer().params().spacing().getValue();
653 return par.params().spacing().getValue();
658 * This breaks a paragraph at the specified position.
659 * The new paragraph will:
660 * - Decrease depth by one (or change layout to default layout) when
661 * keep_layout == false
662 * - keep current depth and layout when keep_layout == true
664 static void breakParagraph(Text & text, pit_type par_offset, pos_type pos,
667 BufferParams const & bparams = text.inset().buffer().params();
668 ParagraphList & pars = text.paragraphs();
669 // create a new paragraph, and insert into the list
670 ParagraphList::iterator tmp =
671 pars.insert(next(pars.begin(), par_offset + 1),
674 Paragraph & par = pars[par_offset];
676 // remember to set the inset_owner
677 tmp->setInsetOwner(&par.inInset());
678 // without doing that we get a crash when typing <Return> at the
679 // end of a paragraph
680 tmp->setPlainOrDefaultLayout(bparams.documentClass());
683 tmp->setLayout(par.layout());
684 tmp->setLabelWidthString(par.params().labelWidthString());
685 tmp->params().depth(par.params().depth());
686 } else if (par.params().depth() > 0) {
687 Paragraph const & hook = pars[text.outerHook(par_offset)];
688 tmp->setLayout(hook.layout());
689 // not sure the line below is useful
690 tmp->setLabelWidthString(par.params().labelWidthString());
691 tmp->params().depth(hook.params().depth());
694 bool const isempty = (par.allowEmpty() && par.empty());
696 if (!isempty && (par.size() > pos || par.empty())) {
697 tmp->setLayout(par.layout());
698 tmp->params().align(par.params().align());
699 tmp->setLabelWidthString(par.params().labelWidthString());
701 tmp->params().depth(par.params().depth());
702 tmp->params().noindent(par.params().noindent());
704 // move everything behind the break position
705 // to the new paragraph
707 /* Note: if !keepempty, empty() == true, then we reach
708 * here with size() == 0. So pos_end becomes - 1. This
709 * doesn't cause problems because both loops below
710 * enforce pos <= pos_end and 0 <= pos
712 pos_type pos_end = par.size() - 1;
714 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
715 if (moveItem(par, pos, *tmp, j, bparams)) {
721 // Move over the end-of-par change information
722 tmp->setChange(tmp->size(), par.lookupChange(par.size()));
723 par.setChange(par.size(), Change(bparams.track_changes ?
724 Change::INSERTED : Change::UNCHANGED));
727 // Make sure that we keep the language when
728 // breaking paragraph.
730 Font changed = tmp->getFirstFontSettings(bparams);
731 Font const & old = par.getFontSettings(bparams, par.size());
732 changed.setLanguage(old.language());
733 tmp->setFont(0, changed);
740 bool const soa = par.params().startOfAppendix();
741 par.params().clear();
742 // do not lose start of appendix marker (bug 4212)
743 par.params().startOfAppendix(soa);
744 par.setPlainOrDefaultLayout(bparams.documentClass());
748 par.setLayout(tmp->layout());
749 par.setLabelWidthString(tmp->params().labelWidthString());
750 par.params().depth(tmp->params().depth());
755 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
757 LBUFERR(this == cur.text());
759 Paragraph & cpar = cur.paragraph();
760 pit_type cpit = cur.pit();
762 DocumentClass const & tclass = cur.buffer()->params().documentClass();
763 Layout const & layout = cpar.layout();
765 if (cur.lastpos() == 0 && !cpar.allowEmpty()) {
766 if (changeDepthAllowed(cur, DEC_DEPTH))
767 changeDepth(cur, DEC_DEPTH);
769 docstring const & lay = cur.paragraph().usePlainLayout()
770 ? tclass.plainLayoutName() : tclass.defaultLayoutName();
778 // Always break behind a space
779 // It is better to erase the space (Dekel)
780 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
781 cpar.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
783 // What should the layout for the new paragraph be?
784 bool keep_layout = layout.isEnvironment()
785 || (layout.isParagraph() && layout.parbreak_is_newline);
787 keep_layout = !keep_layout;
789 // We need to remember this before we break the paragraph, because
790 // that invalidates the layout variable
791 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
793 // we need to set this before we insert the paragraph.
794 bool const isempty = cpar.allowEmpty() && cpar.empty();
796 lyx::breakParagraph(*this, cpit, cur.pos(), keep_layout);
798 // After this, neither paragraph contains any rows!
801 pit_type next_par = cpit + 1;
803 // well this is the caption hack since one caption is really enough
806 // set to standard-layout
807 //FIXME Check if this should be plainLayout() in some cases
808 pars_[cpit].applyLayout(tclass.defaultLayout());
810 // set to standard-layout
811 //FIXME Check if this should be plainLayout() in some cases
812 pars_[next_par].applyLayout(tclass.defaultLayout());
815 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
816 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().track_changes))
817 break; // the character couldn't be deleted physically due to change tracking
820 // A singlePar update is not enough in this case.
821 cur.screenUpdateFlags(Update::Force);
822 cur.forceBufferUpdate();
824 // This check is necessary. Otherwise the new empty paragraph will
825 // be deleted automatically. And it is more friendly for the user!
826 if (cur.pos() != 0 || isempty)
827 setCursor(cur, cur.pit() + 1, 0);
829 setCursor(cur, cur.pit(), 0);
833 // needed to insert the selection
834 void Text::insertStringAsLines(Cursor & cur, docstring const & str,
837 BufferParams const & bparams = owner_->buffer().params();
838 pit_type pit = cur.pit();
839 pos_type pos = cur.pos();
841 // insert the string, don't insert doublespace
842 bool space_inserted = true;
843 for (docstring::const_iterator cit = str.begin();
844 cit != str.end(); ++cit) {
845 Paragraph & par = pars_[pit];
847 if (inset().allowMultiPar() && (!par.empty() || par.allowEmpty())) {
848 lyx::breakParagraph(*this, pit, pos,
849 par.layout().isEnvironment());
852 space_inserted = true;
856 // do not insert consecutive spaces if !free_spacing
857 } else if ((*cit == ' ' || *cit == '\t') &&
858 space_inserted && !par.isFreeSpacing()) {
860 } else if (*cit == '\t') {
861 if (!par.isFreeSpacing()) {
862 // tabs are like spaces here
863 par.insertChar(pos, ' ', font, bparams.track_changes);
865 space_inserted = true;
867 par.insertChar(pos, *cit, font, bparams.track_changes);
869 space_inserted = true;
871 } else if (!isPrintable(*cit)) {
872 // Ignore unprintables
875 // just insert the character
876 par.insertChar(pos, *cit, font, bparams.track_changes);
878 space_inserted = (*cit == ' ');
881 setCursor(cur, pit, pos);
885 // turn double CR to single CR, others are converted into one
886 // blank. Then insertStringAsLines is called
887 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str,
890 docstring linestr = str;
891 bool newline_inserted = false;
893 for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
894 if (linestr[i] == '\n') {
895 if (newline_inserted) {
896 // we know that \r will be ignored by
897 // insertStringAsLines. Of course, it is a dirty
898 // trick, but it works...
899 linestr[i - 1] = '\r';
903 newline_inserted = true;
905 } else if (isPrintable(linestr[i])) {
906 newline_inserted = false;
909 insertStringAsLines(cur, linestr, font);
913 // insert a character, moves all the following breaks in the
914 // same Paragraph one to the right and make a rebreak
915 void Text::insertChar(Cursor & cur, char_type c)
917 LBUFERR(this == cur.text());
919 cur.recordUndo(INSERT_UNDO);
921 TextMetrics const & tm = cur.bv().textMetrics(this);
922 Buffer const & buffer = *cur.buffer();
923 Paragraph & par = cur.paragraph();
924 // try to remove this
925 pit_type const pit = cur.pit();
927 bool const freeSpacing = par.layout().free_spacing ||
930 if (lyxrc.auto_number) {
931 static docstring const number_operators = from_ascii("+-/*");
932 static docstring const number_unary_operators = from_ascii("+-");
933 static docstring const number_seperators = from_ascii(".,:");
935 if (cur.current_font.fontInfo().number() == FONT_ON) {
936 if (!isDigitASCII(c) && !contains(number_operators, c) &&
937 !(contains(number_seperators, c) &&
939 cur.pos() != cur.lastpos() &&
940 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
941 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
943 number(cur); // Set current_font.number to OFF
944 } else if (isDigitASCII(c) &&
945 cur.real_current_font.isVisibleRightToLeft()) {
946 number(cur); // Set current_font.number to ON
948 if (cur.pos() != 0) {
949 char_type const c = par.getChar(cur.pos() - 1);
950 if (contains(number_unary_operators, c) &&
952 || par.isSeparator(cur.pos() - 2)
953 || par.isEnvSeparator(cur.pos() - 2)
954 || par.isNewline(cur.pos() - 2))
956 setCharFont(pit, cur.pos() - 1, cur.current_font,
958 } else if (contains(number_seperators, c)
960 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
961 setCharFont(pit, cur.pos() - 1, cur.current_font,
968 // In Bidi text, we want spaces to be treated in a special way: spaces
969 // which are between words in different languages should get the
970 // paragraph's language; otherwise, spaces should keep the language
971 // they were originally typed in. This is only in effect while typing;
972 // after the text is already typed in, the user can always go back and
973 // explicitly set the language of a space as desired. But 99.9% of the
974 // time, what we're doing here is what the user actually meant.
976 // The following cases are the ones in which the language of the space
977 // should be changed to match that of the containing paragraph. In the
978 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
979 // represents a space, pipe (|) represents the cursor position (so the
980 // character before it is the one just typed in). The different cases
981 // are depicted logically (not visually), from left to right:
986 // Theoretically, there are other situations that we should, perhaps, deal
987 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
988 // point (to understand why, just try to create this situation...).
990 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
991 // get font in front and behind the space in question. But do NOT
992 // use getFont(cur.pos()) because the character c is not inserted yet
993 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
994 Font const & post_space_font = cur.real_current_font;
995 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
996 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
998 if (pre_space_rtl != post_space_rtl) {
999 // Set the space's language to match the language of the
1000 // adjacent character whose direction is the paragraph's
1001 // direction; don't touch other properties of the font
1002 Language const * lang =
1003 (pre_space_rtl == par.isRTL(buffer.params())) ?
1004 pre_space_font.language() : post_space_font.language();
1006 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
1007 space_font.setLanguage(lang);
1008 par.setFont(cur.pos() - 1, space_font);
1012 // Next check, if there will be two blanks together or a blank at
1013 // the beginning of a paragraph.
1014 // I decided to handle blanks like normal characters, the main
1015 // difference are the special checks when calculating the row.fill
1016 // (blank does not count at the end of a row) and the check here
1018 // When the free-spacing option is set for the current layout,
1019 // disable the double-space checking
1020 if (!freeSpacing && isLineSeparatorChar(c)) {
1021 if (cur.pos() == 0) {
1023 "You cannot insert a space at the "
1024 "beginning of a paragraph. Please read the Tutorial."));
1027 // LASSERT: Is it safe to continue here?
1028 LASSERT(cur.pos() > 0, /**/);
1029 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1030 && !par.isDeleted(cur.pos() - 1)) {
1032 "You cannot type two spaces this way. "
1033 "Please read the Tutorial."));
1038 // Prevent to insert uncodable characters in verbatim and ERT
1039 // (workaround for bug 9012)
1040 // Don't do it for listings inset, since InsetListings::latex() tries
1041 // to switch to a usable encoding which works in many cases (bug 9102).
1042 if (cur.paragraph().isPassThru() && owner_->lyxCode() != LISTINGS_CODE &&
1043 cur.current_font.language()) {
1044 Encoding const * e = cur.current_font.language()->encoding();
1045 if (!e->encodable(c)) {
1046 cur.message(_("Character is uncodable in verbatim paragraphs."));
1051 pos_type pos = cur.pos();
1052 if (!cur.paragraph().isPassThru() && owner_->lyxCode() != IPA_CODE &&
1053 cur.current_font.fontInfo().family() != TYPEWRITER_FAMILY &&
1054 c == '-' && pos > 0) {
1055 if (par.getChar(pos - 1) == '-') {
1056 // convert "--" to endash
1057 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1060 } else if (par.getChar(pos - 1) == 0x2013) {
1061 // convert "---" to emdash
1062 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1065 } else if (par.getChar(pos - 1) == 0x2014) {
1066 // convert "----" to "-"
1067 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1073 par.insertChar(pos, c, cur.current_font,
1074 cur.buffer()->params().track_changes);
1075 cur.checkBufferStructure();
1077 // cur.screenUpdateFlags(Update::Force);
1078 bool boundary = cur.boundary()
1079 || tm.isRTLBoundary(cur.pit(), pos + 1);
1080 setCursor(cur, cur.pit(), pos + 1, false, boundary);
1085 void Text::charInserted(Cursor & cur)
1087 Paragraph & par = cur.paragraph();
1089 // register word if a non-letter was entered
1091 && !par.isWordSeparator(cur.pos() - 2)
1092 && par.isWordSeparator(cur.pos() - 1)) {
1093 // get the word in front of cursor
1094 LBUFERR(this == cur.text());
1095 cur.paragraph().updateWords();
1100 // the cursor set functions have a special mechanism. When they
1101 // realize, that you left an empty paragraph, they will delete it.
1103 bool Text::cursorForwardOneWord(Cursor & cur)
1105 LBUFERR(this == cur.text());
1107 pos_type const lastpos = cur.lastpos();
1108 pit_type pit = cur.pit();
1109 pos_type pos = cur.pos();
1110 Paragraph const & par = cur.paragraph();
1112 // Paragraph boundary is a word boundary
1113 if (pos == lastpos) {
1114 if (pit != cur.lastpit())
1115 return setCursor(cur, pit + 1, 0);
1120 if (lyxrc.mac_like_cursor_movement) {
1121 // Skip through trailing punctuation and spaces.
1122 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
1125 // Skip over either a non-char inset or a full word
1126 if (pos != lastpos && par.isWordSeparator(pos))
1128 else while (pos != lastpos && !par.isWordSeparator(pos))
1131 LASSERT(pos < lastpos, return false); // see above
1132 if (!par.isWordSeparator(pos))
1133 while (pos != lastpos && !par.isWordSeparator(pos))
1135 else if (par.isChar(pos))
1136 while (pos != lastpos && par.isChar(pos))
1138 else if (!par.isSpace(pos)) // non-char inset
1141 // Skip over white space
1142 while (pos != lastpos && par.isSpace(pos))
1146 return setCursor(cur, pit, pos);
1150 bool Text::cursorBackwardOneWord(Cursor & cur)
1152 LBUFERR(this == cur.text());
1154 pit_type pit = cur.pit();
1155 pos_type pos = cur.pos();
1156 Paragraph & par = cur.paragraph();
1158 // Paragraph boundary is a word boundary
1159 if (pos == 0 && pit != 0)
1160 return setCursor(cur, pit - 1, getPar(pit - 1).size());
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)
1466 LBUFERR(this == cur.text());
1467 if (cur.lastpos() == 0)
1471 cur.setSelection(true);
1472 cursorForwardOneWord(cur);
1474 cutSelection(cur, true, false);
1475 cur.checkBufferStructure();
1480 void Text::deleteWordBackward(Cursor & cur)
1482 LBUFERR(this == cur.text());
1483 if (cur.lastpos() == 0)
1484 cursorBackward(cur);
1487 cur.setSelection(true);
1488 cursorBackwardOneWord(cur);
1490 cutSelection(cur, true, false);
1491 cur.checkBufferStructure();
1496 // Kill to end of line.
1497 void Text::changeCase(Cursor & cur, TextCase action, bool partial)
1499 LBUFERR(this == cur.text());
1503 bool const gotsel = cur.selection();
1505 from = cur.selBegin();
1509 getWord(from, to, partial ? PARTIAL_WORD : WHOLE_WORD);
1510 cursorForwardOneWord(cur);
1513 cur.recordUndoSelection();
1515 pit_type begPit = from.pit();
1516 pit_type endPit = to.pit();
1518 pos_type begPos = from.pos();
1519 pos_type endPos = to.pos();
1521 pos_type right = 0; // needed after the for loop
1523 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1524 Paragraph & par = pars_[pit];
1525 pos_type const pos = (pit == begPit ? begPos : 0);
1526 right = (pit == endPit ? endPos : par.size());
1527 par.changeCase(cur.buffer()->params(), pos, right, action);
1530 // the selection may have changed due to logically-only deleted chars
1532 setCursor(cur, begPit, begPos);
1534 setCursor(cur, endPit, right);
1537 setCursor(cur, endPit, right);
1539 cur.checkBufferStructure();
1543 bool Text::handleBibitems(Cursor & cur)
1545 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1551 BufferParams const & bufparams = cur.buffer()->params();
1552 Paragraph const & par = cur.paragraph();
1553 Cursor prevcur = cur;
1554 if (cur.pit() > 0) {
1556 prevcur.pos() = prevcur.lastpos();
1558 Paragraph const & prevpar = prevcur.paragraph();
1560 // if a bibitem is deleted, merge with previous paragraph
1561 // if this is a bibliography item as well
1562 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1563 cur.recordUndo(prevcur.pit());
1564 mergeParagraph(bufparams, cur.text()->paragraphs(),
1566 cur.forceBufferUpdate();
1567 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1568 cur.screenUpdateFlags(Update::Force);
1572 // otherwise reset to default
1573 cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1578 bool Text::erase(Cursor & cur)
1580 LASSERT(this == cur.text(), return false);
1581 bool needsUpdate = false;
1582 Paragraph & par = cur.paragraph();
1584 if (cur.pos() != cur.lastpos()) {
1585 // this is the code for a normal delete, not pasting
1587 cur.recordUndo(DELETE_UNDO);
1588 bool const was_inset = cur.paragraph().isInset(cur.pos());
1589 if(!par.eraseChar(cur.pos(), cur.buffer()->params().track_changes))
1590 // the character has been logically deleted only => skip it
1591 cur.top().forwardPos();
1594 cur.forceBufferUpdate();
1596 cur.checkBufferStructure();
1599 if (cur.pit() == cur.lastpit())
1600 return dissolveInset(cur);
1602 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1603 par.setChange(cur.pos(), Change(Change::DELETED));
1607 setCursorIntern(cur, cur.pit() + 1, 0);
1608 needsUpdate = backspacePos0(cur);
1612 needsUpdate |= handleBibitems(cur);
1615 // Make sure the cursor is correct. Is this really needed?
1616 // No, not really... at least not here!
1617 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1618 cur.checkBufferStructure();
1625 bool Text::backspacePos0(Cursor & cur)
1627 LBUFERR(this == cur.text());
1631 bool needsUpdate = false;
1633 BufferParams const & bufparams = cur.buffer()->params();
1634 DocumentClass const & tclass = bufparams.documentClass();
1635 ParagraphList & plist = cur.text()->paragraphs();
1636 Paragraph const & par = cur.paragraph();
1637 Cursor prevcur = cur;
1639 prevcur.pos() = prevcur.lastpos();
1640 Paragraph const & prevpar = prevcur.paragraph();
1642 // is it an empty paragraph?
1643 if (cur.lastpos() == 0
1644 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1645 cur.recordUndo(prevcur.pit());
1646 plist.erase(next(plist.begin(), cur.pit()));
1649 // is previous par empty?
1650 else if (prevcur.lastpos() == 0
1651 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1652 cur.recordUndo(prevcur.pit());
1653 plist.erase(next(plist.begin(), prevcur.pit()));
1656 // Pasting is not allowed, if the paragraphs have different
1657 // layouts. I think it is a real bug of all other
1658 // word processors to allow it. It confuses the user.
1659 // Correction: Pasting is always allowed with standard-layout
1660 // or the empty layout.
1661 else if (par.layout() == prevpar.layout()
1662 || tclass.isDefaultLayout(par.layout())
1663 || tclass.isPlainLayout(par.layout())) {
1664 cur.recordUndo(prevcur.pit());
1665 mergeParagraph(bufparams, plist, prevcur.pit());
1670 cur.forceBufferUpdate();
1671 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1678 bool Text::backspace(Cursor & cur)
1680 LBUFERR(this == cur.text());
1681 bool needsUpdate = false;
1682 if (cur.pos() == 0) {
1684 return dissolveInset(cur);
1686 Cursor prev_cur = cur;
1689 if (!prev_cur.paragraph().isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1690 cur.recordUndo(prev_cur.pit(), prev_cur.pit());
1691 prev_cur.paragraph().setChange(prev_cur.lastpos(), Change(Change::DELETED));
1692 setCursorIntern(cur, prev_cur.pit(), prev_cur.lastpos());
1695 // The cursor is at the beginning of a paragraph, so
1696 // the backspace will collapse two paragraphs into one.
1697 needsUpdate = backspacePos0(cur);
1700 // this is the code for a normal backspace, not pasting
1702 cur.recordUndo(DELETE_UNDO);
1703 // We used to do cursorBackwardIntern() here, but it is
1704 // not a good idea since it triggers the auto-delete
1705 // mechanism. So we do a cursorBackwardIntern()-lite,
1706 // without the dreaded mechanism. (JMarc)
1707 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1708 false, cur.boundary());
1709 bool const was_inset = cur.paragraph().isInset(cur.pos());
1710 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().track_changes);
1712 cur.forceBufferUpdate();
1714 cur.checkBufferStructure();
1717 if (cur.pos() == cur.lastpos())
1718 cur.setCurrentFont();
1720 needsUpdate |= handleBibitems(cur);
1722 // A singlePar update is not enough in this case.
1723 // cur.screenUpdateFlags(Update::Force);
1724 setCursor(cur.top(), cur.pit(), cur.pos());
1730 bool Text::dissolveInset(Cursor & cur)
1732 LASSERT(this == cur.text(), return false);
1734 if (isMainText() || cur.inset().nargs() != 1)
1737 cur.recordUndoInset();
1739 cur.selHandle(false);
1741 pos_type spos = cur.pos();
1742 pit_type spit = cur.pit();
1743 ParagraphList plist;
1744 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1745 plist = paragraphs();
1747 // store cursor offset
1751 Buffer & b = *cur.buffer();
1752 cur.paragraph().eraseChar(cur.pos(), b.params().track_changes);
1754 if (!plist.empty()) {
1756 // we clear the cache so that we won't get conflicts with labels
1757 // that get pasted into the buffer. we should update this before
1758 // its being empty matters. if not (i.e., if we encounter bugs),
1759 // then this should instead be:
1760 // cur.buffer().updateBuffer();
1761 // but we'll try the cheaper solution here.
1762 cur.buffer()->clearReferenceCache();
1764 // ERT paragraphs have the Language latex_language.
1765 // This is invalid outside of ERT, so we need to
1766 // change it to the buffer language.
1767 ParagraphList::iterator it = plist.begin();
1768 ParagraphList::iterator it_end = plist.end();
1769 for (; it != it_end; ++it)
1770 it->changeLanguage(b.params(), latex_language, b.language());
1772 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1773 b.errorList("Paste"));
1775 cur.pit() = min(cur.lastpit(), spit);
1776 cur.pos() = min(cur.lastpos(), spos);
1779 cur.forceBufferUpdate();
1781 // Ensure the current language is set correctly (bug 6292)
1782 cur.text()->setCursor(cur, cur.pit(), cur.pos());
1783 cur.clearSelection();
1789 void Text::getWord(CursorSlice & from, CursorSlice & to,
1790 word_location const loc) const
1793 pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1797 void Text::write(ostream & os) const
1799 Buffer const & buf = owner_->buffer();
1800 ParagraphList::const_iterator pit = paragraphs().begin();
1801 ParagraphList::const_iterator end = paragraphs().end();
1803 for (; pit != end; ++pit)
1804 pit->write(os, buf.params(), dth);
1806 // Close begin_deeper
1807 for(; dth > 0; --dth)
1808 os << "\n\\end_deeper";
1812 bool Text::read(Lexer & lex,
1813 ErrorList & errorList, InsetText * insetPtr)
1815 Buffer const & buf = owner_->buffer();
1816 depth_type depth = 0;
1819 while (lex.isOK()) {
1821 string const token = lex.getString();
1826 if (token == "\\end_inset")
1829 if (token == "\\end_body")
1832 if (token == "\\begin_body")
1835 if (token == "\\end_document") {
1840 if (token == "\\begin_layout") {
1841 lex.pushToken(token);
1844 par.setInsetOwner(insetPtr);
1845 par.params().depth(depth);
1846 par.setFont(0, Font(inherit_font, buf.params().language));
1847 pars_.push_back(par);
1848 readParagraph(pars_.back(), lex, errorList);
1850 // register the words in the global word list
1851 pars_.back().updateWords();
1852 } else if (token == "\\begin_deeper") {
1854 } else if (token == "\\end_deeper") {
1856 lex.printError("\\end_deeper: " "depth is already null");
1860 LYXERR0("Handling unknown body token: `" << token << '\'');
1864 // avoid a crash on weird documents (bug 4859)
1865 if (pars_.empty()) {
1867 par.setInsetOwner(insetPtr);
1868 par.params().depth(depth);
1869 par.setFont(0, Font(inherit_font,
1870 buf.params().language));
1871 par.setPlainOrDefaultLayout(buf.params().documentClass());
1872 pars_.push_back(par);
1879 // Returns the current font and depth as a message.
1880 docstring Text::currentState(Cursor const & cur) const
1882 LBUFERR(this == cur.text());
1883 Buffer & buf = *cur.buffer();
1884 Paragraph const & par = cur.paragraph();
1885 odocstringstream os;
1887 if (buf.params().track_changes)
1888 os << _("[Change Tracking] ");
1890 Change change = par.lookupChange(cur.pos());
1892 if (change.changed()) {
1893 Author const & a = buf.params().authors().get(change.author);
1894 os << _("Change: ") << a.name();
1895 if (!a.email().empty())
1896 os << " (" << a.email() << ")";
1897 // FIXME ctime is english, we should translate that
1898 os << _(" at ") << ctime(&change.changetime);
1902 // I think we should only show changes from the default
1904 // No, from the document font (MV)
1905 Font font = cur.real_current_font;
1906 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1908 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1910 // The paragraph depth
1911 int depth = cur.paragraph().getDepth();
1913 os << bformat(_(", Depth: %1$d"), depth);
1915 // The paragraph spacing, but only if different from
1917 Spacing const & spacing = par.params().spacing();
1918 if (!spacing.isDefault()) {
1919 os << _(", Spacing: ");
1920 switch (spacing.getSpace()) {
1921 case Spacing::Single:
1924 case Spacing::Onehalf:
1927 case Spacing::Double:
1930 case Spacing::Other:
1931 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1933 case Spacing::Default:
1934 // should never happen, do nothing
1939 #ifdef DEVEL_VERSION
1940 os << _(", Inset: ") << &cur.inset();
1941 os << _(", Paragraph: ") << cur.pit();
1942 os << _(", Id: ") << par.id();
1943 os << _(", Position: ") << cur.pos();
1944 // FIXME: Why is the check for par.size() needed?
1945 // We are called with cur.pos() == par.size() quite often.
1946 if (!par.empty() && cur.pos() < par.size()) {
1947 // Force output of code point, not character
1948 size_t const c = par.getChar(cur.pos());
1949 os << _(", Char: 0x") << hex << c;
1951 os << _(", Boundary: ") << cur.boundary();
1952 // Row & row = cur.textRow();
1953 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1959 docstring Text::getPossibleLabel(Cursor const & cur) const
1961 pit_type pit = cur.pit();
1963 Layout const * layout = &(pars_[pit].layout());
1966 docstring par_text = pars_[pit].asString();
1968 // The return string of math matrices might contain linebreaks
1969 par_text = subst(par_text, '\n', '-');
1970 int const numwords = 3;
1971 for (int i = 0; i < numwords; ++i) {
1972 if (par_text.empty())
1975 par_text = split(par_text, head, ' ');
1976 // Is it legal to use spaces in labels ?
1982 // Make sure it isn't too long
1983 unsigned int const max_label_length = 32;
1984 if (text.size() > max_label_length)
1985 text.resize(max_label_length);
1987 // Will contain the label prefix.
1990 // For section, subsection, etc...
1991 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1992 Layout const * layout2 = &(pars_[pit - 1].layout());
1993 if (layout2->latextype != LATEX_PARAGRAPH) {
1998 if (layout->latextype != LATEX_PARAGRAPH)
1999 name = layout->refprefix;
2001 // For captions, we just take the caption type
2002 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
2003 if (caption_inset) {
2004 string const & ftype = static_cast<InsetCaption *>(caption_inset)->floattype();
2005 FloatList const & fl = cur.buffer()->params().documentClass().floats();
2006 if (fl.typeExist(ftype)) {
2007 Floating const & flt = fl.getType(ftype);
2008 name = from_utf8(flt.refPrefix());
2011 name = from_utf8(ftype.substr(0,3));
2014 // If none of the above worked, see if the inset knows.
2016 InsetLayout const & il = cur.inset().getLayout();
2017 name = il.refprefix();
2021 text = name + ':' + text;
2023 // We need a unique label
2024 docstring label = text;
2026 while (cur.buffer()->insetLabel(label)) {
2027 label = text + '-' + convert<docstring>(i);
2035 docstring Text::asString(int options) const
2037 return asString(0, pars_.size(), options);
2041 docstring Text::asString(pit_type beg, pit_type end, int options) const
2043 size_t i = size_t(beg);
2044 docstring str = pars_[i].asString(options);
2045 for (++i; i != size_t(end); ++i) {
2047 str += pars_[i].asString(options);
2053 void Text::shortenForOutliner(docstring & str, size_t const maxlen)
2055 support::truncateWithEllipsis(str, maxlen);
2056 docstring::iterator it = str.begin();
2057 docstring::iterator end = str.end();
2058 for (; it != end; ++it)
2059 if ((*it) == L'\n' || (*it) == L'\t')
2064 void Text::forOutliner(docstring & os, size_t const maxlen,
2065 bool const shorten) const
2067 size_t tmplen = shorten ? maxlen + 1 : maxlen;
2068 for (size_t i = 0; i != pars_.size() && os.length() < tmplen; ++i)
2069 pars_[i].forOutliner(os, tmplen, false);
2071 shortenForOutliner(os, maxlen);
2075 void Text::charsTranspose(Cursor & cur)
2077 LBUFERR(this == cur.text());
2079 pos_type pos = cur.pos();
2081 // If cursor is at beginning or end of paragraph, do nothing.
2082 if (pos == cur.lastpos() || pos == 0)
2085 Paragraph & par = cur.paragraph();
2087 // Get the positions of the characters to be transposed.
2088 pos_type pos1 = pos - 1;
2089 pos_type pos2 = pos;
2091 // In change tracking mode, ignore deleted characters.
2092 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2094 if (pos2 == cur.lastpos())
2097 while (pos1 >= 0 && par.isDeleted(pos1))
2102 // Don't do anything if one of the "characters" is not regular text.
2103 if (par.isInset(pos1) || par.isInset(pos2))
2106 // Store the characters to be transposed (including font information).
2107 char_type const char1 = par.getChar(pos1);
2109 par.getFontSettings(cur.buffer()->params(), pos1);
2111 char_type const char2 = par.getChar(pos2);
2113 par.getFontSettings(cur.buffer()->params(), pos2);
2115 // And finally, we are ready to perform the transposition.
2116 // Track the changes if Change Tracking is enabled.
2117 bool const trackChanges = cur.buffer()->params().track_changes;
2121 par.eraseChar(pos2, trackChanges);
2122 par.eraseChar(pos1, trackChanges);
2123 par.insertChar(pos1, char2, font2, trackChanges);
2124 par.insertChar(pos2, char1, font1, trackChanges);
2126 cur.checkBufferStructure();
2128 // After the transposition, move cursor to after the transposition.
2129 setCursor(cur, cur.pit(), pos2);
2134 DocIterator Text::macrocontextPosition() const
2136 return macrocontext_position_;
2140 void Text::setMacrocontextPosition(DocIterator const & pos)
2142 macrocontext_position_ = pos;
2146 docstring Text::previousWord(CursorSlice const & sl) const
2148 CursorSlice from = sl;
2149 CursorSlice to = sl;
2150 getWord(from, to, PREVIOUS_WORD);
2151 if (sl == from || to == from)
2154 Paragraph const & par = sl.paragraph();
2155 return par.asString(from.pos(), to.pos());
2159 bool Text::completionSupported(Cursor const & cur) const
2161 Paragraph const & par = cur.paragraph();
2162 return cur.pos() > 0
2163 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
2164 && !par.isWordSeparator(cur.pos() - 1);
2168 CompletionList const * Text::createCompletionList(Cursor const & cur) const
2170 WordList const * list = theWordList(cur.getFont().language()->lang());
2171 return new TextCompletionList(cur, list);
2175 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
2177 LBUFERR(cur.bv().cursor() == cur);
2179 cur.bv().cursor() = cur;
2180 if (!(cur.result().screenUpdate() & Update::Force))
2181 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
2186 docstring Text::completionPrefix(Cursor const & cur) const
2188 return previousWord(cur.top());