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"
76 // TODO: replace if in Text::readParToken() with compile time switch
79 #include "support/metahash.h"
81 typedef boost::mpl::string<'\\end','_lay','out'> end_layout;
82 typedef boost::mpl::string<'\\end','in','set'> end_inset;
86 std::string token = "\\end_layout";
88 switch (boost::hash_value(token)) {
89 case lyx::support::hash_string<end_layout>::value:
91 case lyx::support::hash_string<end_inset>::value:
101 using namespace lyx::support;
105 using cap::cutSelection;
106 using cap::pasteParagraphList;
108 static bool moveItem(Paragraph & fromPar, pos_type fromPos,
109 Paragraph & toPar, pos_type toPos, BufferParams const & params)
111 // Note: moveItem() does not honour change tracking!
112 // Therefore, it should only be used for breaking and merging paragraphs
114 // We need a copy here because the character at fromPos is going to be erased.
115 Font const tmpFont = fromPar.getFontSettings(params, fromPos);
116 Change const tmpChange = fromPar.lookupChange(fromPos);
118 if (Inset * tmpInset = fromPar.getInset(fromPos)) {
119 fromPar.releaseInset(fromPos);
120 // The inset is not in fromPar any more.
121 if (!toPar.insertInset(toPos, tmpInset, tmpFont, tmpChange)) {
128 char_type const tmpChar = fromPar.getChar(fromPos);
129 fromPar.eraseChar(fromPos, false);
130 toPar.insertChar(toPos, tmpChar, tmpFont, tmpChange);
135 void breakParagraphConservative(BufferParams const & bparams,
136 ParagraphList & pars, pit_type par_offset, pos_type pos)
138 // create a new paragraph
139 Paragraph & tmp = *pars.insert(next(pars.begin(), par_offset + 1),
141 Paragraph & par = pars[par_offset];
143 tmp.setInsetOwner(&par.inInset());
144 tmp.makeSameLayout(par);
146 LASSERT(pos <= par.size(), return);
148 if (pos < par.size()) {
149 // move everything behind the break position to the new paragraph
150 pos_type pos_end = par.size() - 1;
152 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
153 if (moveItem(par, pos, tmp, j, bparams)) {
157 // Move over the end-of-par change information
158 tmp.setChange(tmp.size(), par.lookupChange(par.size()));
159 par.setChange(par.size(), Change(bparams.track_changes ?
160 Change::INSERTED : Change::UNCHANGED));
165 void mergeParagraph(BufferParams const & bparams,
166 ParagraphList & pars, pit_type par_offset)
168 Paragraph & next = pars[par_offset + 1];
169 Paragraph & par = pars[par_offset];
171 pos_type pos_end = next.size() - 1;
172 pos_type pos_insert = par.size();
174 // the imaginary end-of-paragraph character (at par.size()) has to be
175 // marked as unmodified. Otherwise, its change is adopted by the first
176 // character of the next paragraph.
177 if (par.isChanged(par.size())) {
178 LYXERR(Debug::CHANGES,
179 "merging par with inserted/deleted end-of-par character");
180 par.setChange(par.size(), Change(Change::UNCHANGED));
183 Change change = next.lookupChange(next.size());
185 // move the content of the second paragraph to the end of the first one
186 for (pos_type i = 0, j = pos_insert; i <= pos_end; ++i) {
187 if (moveItem(next, 0, par, j, bparams)) {
192 // move the change of the end-of-paragraph character
193 par.setChange(par.size(), change);
195 pars.erase(lyx::next(pars.begin(), par_offset + 1));
199 Text::Text(InsetText * owner, bool use_default_layout)
202 pars_.push_back(Paragraph());
203 Paragraph & par = pars_.back();
204 par.setInsetOwner(owner);
205 DocumentClass const & dc = owner->buffer().params().documentClass();
206 if (use_default_layout)
207 par.setDefaultLayout(dc);
209 par.setPlainLayout(dc);
213 Text::Text(InsetText * owner, Text const & text)
217 ParagraphList::iterator const end = pars_.end();
218 ParagraphList::iterator it = pars_.begin();
219 for (; it != end; ++it)
220 it->setInsetOwner(owner);
224 pit_type Text::depthHook(pit_type pit, depth_type depth) const
226 pit_type newpit = pit;
231 while (newpit != 0 && pars_[newpit].getDepth() > depth)
234 if (pars_[newpit].getDepth() > depth)
241 pit_type Text::outerHook(pit_type par_offset) const
243 Paragraph const & par = pars_[par_offset];
245 if (par.getDepth() == 0)
247 return depthHook(par_offset, depth_type(par.getDepth() - 1));
251 bool Text::isFirstInSequence(pit_type par_offset) const
253 Paragraph const & par = pars_[par_offset];
255 pit_type dhook_offset = depthHook(par_offset, par.getDepth());
257 if (dhook_offset == par_offset)
260 Paragraph const & dhook = pars_[dhook_offset];
262 return dhook.layout() != par.layout()
263 || dhook.getDepth() != par.getDepth();
267 int Text::getTocLevel(pit_type par_offset) const
269 Paragraph const & par = pars_[par_offset];
271 if (par.layout().isEnvironment() && !isFirstInSequence(par_offset))
272 return Layout::NOT_IN_TOC;
274 return par.layout().toclevel;
278 Font const Text::outerFont(pit_type par_offset) const
280 depth_type par_depth = pars_[par_offset].getDepth();
281 FontInfo tmpfont = inherit_font;
282 depth_type prev_par_depth = 0;
283 // Resolve against environment font information
284 while (par_offset != pit_type(pars_.size())
285 && par_depth != prev_par_depth
287 && !tmpfont.resolved()) {
288 prev_par_depth = par_depth;
289 par_offset = outerHook(par_offset);
290 if (par_offset != pit_type(pars_.size())) {
291 tmpfont.realize(pars_[par_offset].layout().font);
292 par_depth = pars_[par_offset].getDepth();
296 return Font(tmpfont);
300 static void acceptOrRejectChanges(ParagraphList & pars,
301 BufferParams const & bparams, Text::ChangeOp op)
303 pit_type pars_size = static_cast<pit_type>(pars.size());
305 // first, accept or reject changes within each individual
306 // paragraph (do not consider end-of-par)
307 for (pit_type pit = 0; pit < pars_size; ++pit) {
308 // prevent assertion failure
309 if (!pars[pit].empty()) {
310 if (op == Text::ACCEPT)
311 pars[pit].acceptChanges(0, pars[pit].size());
313 pars[pit].rejectChanges(0, pars[pit].size());
317 // next, accept or reject imaginary end-of-par characters
318 for (pit_type pit = 0; pit < pars_size; ++pit) {
319 pos_type pos = pars[pit].size();
320 if (pars[pit].isChanged(pos)) {
321 // keep the end-of-par char if it is inserted and accepted
322 // or when it is deleted and rejected.
323 if (pars[pit].isInserted(pos) == (op == Text::ACCEPT)) {
324 pars[pit].setChange(pos, Change(Change::UNCHANGED));
326 if (pit == pars_size - 1) {
327 // we cannot remove a par break at the end of the last
328 // paragraph; instead, we mark it unchanged
329 pars[pit].setChange(pos, Change(Change::UNCHANGED));
331 mergeParagraph(bparams, pars, pit);
341 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
343 acceptOrRejectChanges(pars, bparams, Text::ACCEPT);
347 void rejectChanges(ParagraphList & pars, BufferParams const & bparams)
349 acceptOrRejectChanges(pars, bparams, Text::REJECT);
353 InsetText const & Text::inset() const
360 void Text::readParToken(Paragraph & par, Lexer & lex,
361 string const & token, Font & font, Change & change, ErrorList & errorList)
363 Buffer * buf = const_cast<Buffer *>(&owner_->buffer());
364 BufferParams const & bp = buf->params();
366 if (token[0] != '\\') {
367 docstring dstr = lex.getDocString();
368 par.appendString(dstr, font, change);
370 } else if (token == "\\begin_layout") {
372 docstring layoutname = lex.getDocString();
374 font = Font(inherit_font, bp.language);
375 change = Change(Change::UNCHANGED);
377 DocumentClass const & tclass = bp.documentClass();
379 if (layoutname.empty())
380 layoutname = tclass.defaultLayoutName();
382 if (owner_->forcePlainLayout()) {
383 // in this case only the empty layout is allowed
384 layoutname = tclass.plainLayoutName();
385 } else if (par.usePlainLayout()) {
386 // in this case, default layout maps to empty layout
387 if (layoutname == tclass.defaultLayoutName())
388 layoutname = tclass.plainLayoutName();
390 // otherwise, the empty layout maps to the default
391 if (layoutname == tclass.plainLayoutName())
392 layoutname = tclass.defaultLayoutName();
395 // When we apply an unknown layout to a document, we add this layout to the textclass
396 // of this document. For example, when you apply class article to a beamer document,
397 // all unknown layouts such as frame will be added to document class article so that
398 // these layouts can keep their original names.
399 bool const added_one = tclass.addLayoutIfNeeded(layoutname);
402 docstring const s = bformat(_("Layout `%1$s' was not found."), layoutname);
404 ErrorItem(_("Layout Not Found"), s, par.id(), 0, par.size()));
407 par.setLayout(bp.documentClass()[layoutname]);
409 // Test whether the layout is obsolete.
410 Layout const & layout = par.layout();
411 if (!layout.obsoleted_by().empty())
412 par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
414 par.params().read(lex);
416 } else if (token == "\\end_layout") {
417 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
418 << "Missing \\begin_layout ?");
419 } else if (token == "\\end_inset") {
420 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
421 << "Missing \\begin_inset ?");
422 } else if (token == "\\begin_inset") {
423 Inset * inset = readInset(lex, buf);
425 par.insertInset(par.size(), inset, font, change);
428 docstring line = lex.getDocString();
429 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
430 par.id(), 0, par.size()));
432 } else if (token == "\\family") {
434 setLyXFamily(lex.getString(), font.fontInfo());
435 } else if (token == "\\series") {
437 setLyXSeries(lex.getString(), font.fontInfo());
438 } else if (token == "\\shape") {
440 setLyXShape(lex.getString(), font.fontInfo());
441 } else if (token == "\\size") {
443 setLyXSize(lex.getString(), font.fontInfo());
444 } else if (token == "\\lang") {
446 string const tok = lex.getString();
447 Language const * lang = languages.getLanguage(tok);
449 font.setLanguage(lang);
451 font.setLanguage(bp.language);
452 lex.printError("Unknown language `$$Token'");
454 } else if (token == "\\numeric") {
456 font.fontInfo().setNumber(setLyXMisc(lex.getString()));
457 } else if (token == "\\emph") {
459 font.fontInfo().setEmph(setLyXMisc(lex.getString()));
460 } else if (token == "\\bar") {
462 string const tok = lex.getString();
465 font.fontInfo().setUnderbar(FONT_ON);
466 else if (tok == "no")
467 font.fontInfo().setUnderbar(FONT_OFF);
468 else if (tok == "default")
469 font.fontInfo().setUnderbar(FONT_INHERIT);
471 lex.printError("Unknown bar font flag "
473 } else if (token == "\\strikeout") {
475 font.fontInfo().setStrikeout(setLyXMisc(lex.getString()));
476 } else if (token == "\\uuline") {
478 font.fontInfo().setUuline(setLyXMisc(lex.getString()));
479 } else if (token == "\\uwave") {
481 font.fontInfo().setUwave(setLyXMisc(lex.getString()));
482 } else if (token == "\\noun") {
484 font.fontInfo().setNoun(setLyXMisc(lex.getString()));
485 } else if (token == "\\color") {
487 setLyXColor(lex.getString(), font.fontInfo());
488 } else if (token == "\\SpecialChar" ||
489 (token == "\\SpecialCharNoPassThru" &&
490 !par.layout().pass_thru && !inset().isPassThru())) {
491 auto_ptr<Inset> inset;
492 inset.reset(new InsetSpecialChar);
494 inset->setBuffer(*buf);
495 par.insertInset(par.size(), inset.release(), font, change);
496 } else if (token == "\\SpecialCharNoPassThru") {
498 docstring const s = ltrim(lex.getDocString(), "\\");
499 par.insert(par.size(), s, font, change);
500 } else if (token == "\\IPAChar") {
501 auto_ptr<Inset> inset;
502 inset.reset(new InsetIPAChar);
504 inset->setBuffer(*buf);
505 par.insertInset(par.size(), inset.release(), font, change);
506 } else if (token == "\\twohyphens" || token == "\\threehyphens") {
507 // Ideally, this should be done by lyx2lyx, but lyx2lyx does not know the
508 // running font and does not know anything about layouts (and CopyStyle).
509 Layout const & layout(par.layout());
510 FontInfo info = font.fontInfo();
511 info.realize(layout.resfont);
512 if (layout.pass_thru || inset().isPassThru() ||
513 info.family() == TYPEWRITER_FAMILY) {
514 if (token == "\\twohyphens")
515 par.insert(par.size(), from_ascii("--"), font, change);
517 par.insert(par.size(), from_ascii("---"), font, change);
519 if (token == "\\twohyphens")
520 par.insertChar(par.size(), 0x2013, font, change);
522 par.insertChar(par.size(), 0x2014, font, change);
524 } else if (token == "\\backslash") {
525 par.appendChar('\\', font, change);
526 } else if (token == "\\LyXTable") {
527 auto_ptr<Inset> inset(new InsetTabular(buf));
529 par.insertInset(par.size(), inset.release(), font, change);
530 } else if (token == "\\change_unchanged") {
531 change = Change(Change::UNCHANGED);
532 } else if (token == "\\change_inserted" || token == "\\change_deleted") {
534 istringstream is(lex.getString());
538 BufferParams::AuthorMap const & am = bp.author_map;
539 if (am.find(aid) == am.end()) {
540 errorList.push_back(ErrorItem(_("Change tracking error"),
541 bformat(_("Unknown author index for change: %1$d\n"), aid),
542 par.id(), 0, par.size()));
543 change = Change(Change::UNCHANGED);
545 if (token == "\\change_inserted")
546 change = Change(Change::INSERTED, am.find(aid)->second, ct);
548 change = Change(Change::DELETED, am.find(aid)->second, ct);
552 errorList.push_back(ErrorItem(_("Unknown token"),
553 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
555 par.id(), 0, par.size()));
560 void Text::readParagraph(Paragraph & par, Lexer & lex,
561 ErrorList & errorList)
564 string token = lex.getString();
566 Change change(Change::UNCHANGED);
569 readParToken(par, lex, token, font, change, errorList);
572 token = lex.getString();
577 if (token == "\\end_layout") {
578 //Ok, paragraph finished
582 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
583 if (token == "\\begin_layout" || token == "\\end_document"
584 || token == "\\end_inset" || token == "\\begin_deeper"
585 || token == "\\end_deeper") {
586 lex.pushToken(token);
587 lyxerr << "Paragraph ended in line "
588 << lex.lineNumber() << "\n"
589 << "Missing \\end_layout.\n";
593 // Final change goes to paragraph break:
594 par.setChange(par.size(), change);
596 // Initialize begin_of_body_ on load; redoParagraph maintains
597 par.setBeginOfBody();
599 // mark paragraph for spell checking on load
600 // par.requestSpellCheck();
604 class TextCompletionList : public CompletionList
608 TextCompletionList(Cursor const & cur, WordList const * list)
609 : buffer_(cur.buffer()), list_(list)
612 virtual ~TextCompletionList() {}
615 virtual bool sorted() const { return true; }
617 virtual size_t size() const
619 return list_->size();
622 virtual docstring const & data(size_t idx) const
624 return list_->word(idx);
629 Buffer const * buffer_;
631 WordList const * list_;
635 bool Text::empty() const
637 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
638 // FIXME: Should we consider the labeled type as empty too?
639 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
643 double Text::spacing(Paragraph const & par) const
645 if (par.params().spacing().isDefault())
646 return owner_->buffer().params().spacing().getValue();
647 return par.params().spacing().getValue();
652 * This breaks a paragraph at the specified position.
653 * The new paragraph will:
654 * - Decrease depth by one (or change layout to default layout) when
655 * keep_layout == false
656 * - keep current depth and layout when keep_layout == true
658 static void breakParagraph(Text & text, pit_type par_offset, pos_type pos,
661 BufferParams const & bparams = text.inset().buffer().params();
662 ParagraphList & pars = text.paragraphs();
663 // create a new paragraph, and insert into the list
664 ParagraphList::iterator tmp =
665 pars.insert(next(pars.begin(), par_offset + 1),
668 Paragraph & par = pars[par_offset];
670 // remember to set the inset_owner
671 tmp->setInsetOwner(&par.inInset());
672 // without doing that we get a crash when typing <Return> at the
673 // end of a paragraph
674 tmp->setPlainOrDefaultLayout(bparams.documentClass());
677 tmp->setLayout(par.layout());
678 tmp->setLabelWidthString(par.params().labelWidthString());
679 tmp->params().depth(par.params().depth());
680 } else if (par.params().depth() > 0) {
681 Paragraph const & hook = pars[text.outerHook(par_offset)];
682 tmp->setLayout(hook.layout());
683 // not sure the line below is useful
684 tmp->setLabelWidthString(par.params().labelWidthString());
685 tmp->params().depth(hook.params().depth());
688 bool const isempty = (par.allowEmpty() && par.empty());
690 if (!isempty && (par.size() > pos || par.empty())) {
691 tmp->setLayout(par.layout());
692 tmp->params().align(par.params().align());
693 tmp->setLabelWidthString(par.params().labelWidthString());
695 tmp->params().depth(par.params().depth());
696 tmp->params().noindent(par.params().noindent());
698 // move everything behind the break position
699 // to the new paragraph
701 /* Note: if !keepempty, empty() == true, then we reach
702 * here with size() == 0. So pos_end becomes - 1. This
703 * doesn't cause problems because both loops below
704 * enforce pos <= pos_end and 0 <= pos
706 pos_type pos_end = par.size() - 1;
708 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
709 if (moveItem(par, pos, *tmp, j, bparams)) {
715 // Move over the end-of-par change information
716 tmp->setChange(tmp->size(), par.lookupChange(par.size()));
717 par.setChange(par.size(), Change(bparams.track_changes ?
718 Change::INSERTED : Change::UNCHANGED));
721 // Make sure that we keep the language when
722 // breaking paragraph.
724 Font changed = tmp->getFirstFontSettings(bparams);
725 Font const & old = par.getFontSettings(bparams, par.size());
726 changed.setLanguage(old.language());
727 tmp->setFont(0, changed);
734 bool const soa = par.params().startOfAppendix();
735 par.params().clear();
736 // do not lose start of appendix marker (bug 4212)
737 par.params().startOfAppendix(soa);
738 par.setPlainOrDefaultLayout(bparams.documentClass());
742 par.setLayout(tmp->layout());
743 par.setLabelWidthString(tmp->params().labelWidthString());
744 par.params().depth(tmp->params().depth());
749 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
751 LBUFERR(this == cur.text());
753 Paragraph & cpar = cur.paragraph();
754 pit_type cpit = cur.pit();
756 DocumentClass const & tclass = cur.buffer()->params().documentClass();
757 Layout const & layout = cpar.layout();
759 if (cur.lastpos() == 0 && !cpar.allowEmpty()) {
760 if (changeDepthAllowed(cur, DEC_DEPTH))
761 changeDepth(cur, DEC_DEPTH);
763 docstring const & lay = cur.paragraph().usePlainLayout()
764 ? tclass.plainLayoutName() : tclass.defaultLayoutName();
772 // Always break behind a space
773 // It is better to erase the space (Dekel)
774 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
775 cpar.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
777 // What should the layout for the new paragraph be?
778 bool keep_layout = layout.isEnvironment()
779 || (layout.isParagraph() && layout.parbreak_is_newline);
781 keep_layout = !keep_layout;
783 // We need to remember this before we break the paragraph, because
784 // that invalidates the layout variable
785 bool sensitive = layout.labeltype == LABEL_SENSITIVE;
787 // we need to set this before we insert the paragraph.
788 bool const isempty = cpar.allowEmpty() && cpar.empty();
790 lyx::breakParagraph(*this, cpit, cur.pos(), keep_layout);
792 // After this, neither paragraph contains any rows!
795 pit_type next_par = cpit + 1;
797 // well this is the caption hack since one caption is really enough
800 // set to standard-layout
801 //FIXME Check if this should be plainLayout() in some cases
802 pars_[cpit].applyLayout(tclass.defaultLayout());
804 // set to standard-layout
805 //FIXME Check if this should be plainLayout() in some cases
806 pars_[next_par].applyLayout(tclass.defaultLayout());
809 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
810 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().track_changes))
811 break; // the character couldn't be deleted physically due to change tracking
814 // A singlePar update is not enough in this case.
815 cur.screenUpdateFlags(Update::Force);
816 cur.forceBufferUpdate();
818 // This check is necessary. Otherwise the new empty paragraph will
819 // be deleted automatically. And it is more friendly for the user!
820 if (cur.pos() != 0 || isempty)
821 setCursor(cur, cur.pit() + 1, 0);
823 setCursor(cur, cur.pit(), 0);
827 // needed to insert the selection
828 void Text::insertStringAsLines(Cursor & cur, docstring const & str,
831 BufferParams const & bparams = owner_->buffer().params();
832 pit_type pit = cur.pit();
833 pos_type pos = cur.pos();
835 // insert the string, don't insert doublespace
836 bool space_inserted = true;
837 for (docstring::const_iterator cit = str.begin();
838 cit != str.end(); ++cit) {
839 Paragraph & par = pars_[pit];
841 if (inset().allowMultiPar() && (!par.empty() || par.allowEmpty())) {
842 lyx::breakParagraph(*this, pit, pos,
843 par.layout().isEnvironment());
846 space_inserted = true;
850 // do not insert consecutive spaces if !free_spacing
851 } else if ((*cit == ' ' || *cit == '\t') &&
852 space_inserted && !par.isFreeSpacing()) {
854 } else if (*cit == '\t') {
855 if (!par.isFreeSpacing()) {
856 // tabs are like spaces here
857 par.insertChar(pos, ' ', font, bparams.track_changes);
859 space_inserted = true;
861 par.insertChar(pos, *cit, font, bparams.track_changes);
863 space_inserted = true;
865 } else if (!isPrintable(*cit)) {
866 // Ignore unprintables
869 // just insert the character
870 par.insertChar(pos, *cit, font, bparams.track_changes);
872 space_inserted = (*cit == ' ');
875 setCursor(cur, pit, pos);
879 // turn double CR to single CR, others are converted into one
880 // blank. Then insertStringAsLines is called
881 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str,
884 docstring linestr = str;
885 bool newline_inserted = false;
887 for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
888 if (linestr[i] == '\n') {
889 if (newline_inserted) {
890 // we know that \r will be ignored by
891 // insertStringAsLines. Of course, it is a dirty
892 // trick, but it works...
893 linestr[i - 1] = '\r';
897 newline_inserted = true;
899 } else if (isPrintable(linestr[i])) {
900 newline_inserted = false;
903 insertStringAsLines(cur, linestr, font);
907 // insert a character, moves all the following breaks in the
908 // same Paragraph one to the right and make a rebreak
909 void Text::insertChar(Cursor & cur, char_type c)
911 LBUFERR(this == cur.text());
913 cur.recordUndo(INSERT_UNDO);
915 TextMetrics const & tm = cur.bv().textMetrics(this);
916 Buffer const & buffer = *cur.buffer();
917 Paragraph & par = cur.paragraph();
918 // try to remove this
919 pit_type const pit = cur.pit();
921 bool const freeSpacing = par.layout().free_spacing ||
924 if (lyxrc.auto_number) {
925 static docstring const number_operators = from_ascii("+-/*");
926 static docstring const number_unary_operators = from_ascii("+-");
927 static docstring const number_seperators = from_ascii(".,:");
929 if (cur.current_font.fontInfo().number() == FONT_ON) {
930 if (!isDigitASCII(c) && !contains(number_operators, c) &&
931 !(contains(number_seperators, c) &&
933 cur.pos() != cur.lastpos() &&
934 tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
935 tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
937 number(cur); // Set current_font.number to OFF
938 } else if (isDigitASCII(c) &&
939 cur.real_current_font.isVisibleRightToLeft()) {
940 number(cur); // Set current_font.number to ON
942 if (cur.pos() != 0) {
943 char_type const c = par.getChar(cur.pos() - 1);
944 if (contains(number_unary_operators, c) &&
946 || par.isSeparator(cur.pos() - 2)
947 || par.isEnvSeparator(cur.pos() - 2)
948 || par.isNewline(cur.pos() - 2))
950 setCharFont(pit, cur.pos() - 1, cur.current_font,
952 } else if (contains(number_seperators, c)
954 && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
955 setCharFont(pit, cur.pos() - 1, cur.current_font,
962 // In Bidi text, we want spaces to be treated in a special way: spaces
963 // which are between words in different languages should get the
964 // paragraph's language; otherwise, spaces should keep the language
965 // they were originally typed in. This is only in effect while typing;
966 // after the text is already typed in, the user can always go back and
967 // explicitly set the language of a space as desired. But 99.9% of the
968 // time, what we're doing here is what the user actually meant.
970 // The following cases are the ones in which the language of the space
971 // should be changed to match that of the containing paragraph. In the
972 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
973 // represents a space, pipe (|) represents the cursor position (so the
974 // character before it is the one just typed in). The different cases
975 // are depicted logically (not visually), from left to right:
980 // Theoretically, there are other situations that we should, perhaps, deal
981 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
982 // point (to understand why, just try to create this situation...).
984 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
985 // get font in front and behind the space in question. But do NOT
986 // use getFont(cur.pos()) because the character c is not inserted yet
987 Font const pre_space_font = tm.displayFont(cur.pit(), cur.pos() - 2);
988 Font const & post_space_font = cur.real_current_font;
989 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
990 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
992 if (pre_space_rtl != post_space_rtl) {
993 // Set the space's language to match the language of the
994 // adjacent character whose direction is the paragraph's
995 // direction; don't touch other properties of the font
996 Language const * lang =
997 (pre_space_rtl == par.isRTL(buffer.params())) ?
998 pre_space_font.language() : post_space_font.language();
1000 Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
1001 space_font.setLanguage(lang);
1002 par.setFont(cur.pos() - 1, space_font);
1006 // Next check, if there will be two blanks together or a blank at
1007 // the beginning of a paragraph.
1008 // I decided to handle blanks like normal characters, the main
1009 // difference are the special checks when calculating the row.fill
1010 // (blank does not count at the end of a row) and the check here
1012 // When the free-spacing option is set for the current layout,
1013 // disable the double-space checking
1014 if (!freeSpacing && isLineSeparatorChar(c)) {
1015 if (cur.pos() == 0) {
1017 "You cannot insert a space at the "
1018 "beginning of a paragraph. Please read the Tutorial."));
1021 // LASSERT: Is it safe to continue here?
1022 LASSERT(cur.pos() > 0, /**/);
1023 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1024 && !par.isDeleted(cur.pos() - 1)) {
1026 "You cannot type two spaces this way. "
1027 "Please read the Tutorial."));
1032 // Prevent to insert uncodable characters in verbatim and ERT
1033 // (workaround for bug 9012)
1034 // Don't do it for listings inset, since InsetListings::latex() tries
1035 // to switch to a usable encoding which works in many cases (bug 9102).
1036 if (cur.paragraph().isPassThru() && owner_->lyxCode() != LISTINGS_CODE &&
1037 cur.current_font.language()) {
1038 Encoding const * e = cur.current_font.language()->encoding();
1039 if (!e->encodable(c)) {
1040 cur.message(_("Character is uncodable in verbatim paragraphs."));
1045 pos_type pos = cur.pos();
1046 if (!cur.paragraph().isPassThru() && owner_->lyxCode() != IPA_CODE &&
1047 cur.current_font.fontInfo().family() != TYPEWRITER_FAMILY &&
1048 c == '-' && pos > 0) {
1049 if (par.getChar(pos - 1) == '-') {
1050 // convert "--" to endash
1051 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1054 } else if (par.getChar(pos - 1) == 0x2013) {
1055 // convert "---" to emdash
1056 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1059 } else if (par.getChar(pos - 1) == 0x2014) {
1060 // convert "----" to "-"
1061 par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1067 par.insertChar(pos, c, cur.current_font,
1068 cur.buffer()->params().track_changes);
1069 cur.checkBufferStructure();
1071 // cur.screenUpdateFlags(Update::Force);
1072 bool boundary = cur.boundary()
1073 || tm.isRTLBoundary(cur.pit(), pos + 1);
1074 setCursor(cur, cur.pit(), pos + 1, false, boundary);
1079 void Text::charInserted(Cursor & cur)
1081 Paragraph & par = cur.paragraph();
1083 // register word if a non-letter was entered
1085 && !par.isWordSeparator(cur.pos() - 2)
1086 && par.isWordSeparator(cur.pos() - 1)) {
1087 // get the word in front of cursor
1088 LBUFERR(this == cur.text());
1089 cur.paragraph().updateWords();
1094 // the cursor set functions have a special mechanism. When they
1095 // realize, that you left an empty paragraph, they will delete it.
1097 bool Text::cursorForwardOneWord(Cursor & cur)
1099 LBUFERR(this == cur.text());
1101 pos_type const lastpos = cur.lastpos();
1102 pit_type pit = cur.pit();
1103 pos_type pos = cur.pos();
1104 Paragraph const & par = cur.paragraph();
1106 // Paragraph boundary is a word boundary
1107 if (pos == lastpos) {
1108 if (pit != cur.lastpit())
1109 return setCursor(cur, pit + 1, 0);
1114 if (lyxrc.mac_like_cursor_movement) {
1115 // Skip through trailing punctuation and spaces.
1116 while (pos != lastpos && (par.isChar(pos) || par.isSpace(pos)))
1119 // Skip over either a non-char inset or a full word
1120 if (pos != lastpos && par.isWordSeparator(pos))
1122 else while (pos != lastpos && !par.isWordSeparator(pos))
1125 LASSERT(pos < lastpos, return false); // see above
1126 if (!par.isWordSeparator(pos))
1127 while (pos != lastpos && !par.isWordSeparator(pos))
1129 else if (par.isChar(pos))
1130 while (pos != lastpos && par.isChar(pos))
1132 else if (!par.isSpace(pos)) // non-char inset
1135 // Skip over white space
1136 while (pos != lastpos && par.isSpace(pos))
1140 return setCursor(cur, pit, pos);
1144 bool Text::cursorBackwardOneWord(Cursor & cur)
1146 LBUFERR(this == cur.text());
1148 pit_type pit = cur.pit();
1149 pos_type pos = cur.pos();
1150 Paragraph & par = cur.paragraph();
1152 // Paragraph boundary is a word boundary
1153 if (pos == 0 && pit != 0)
1154 return setCursor(cur, pit - 1, getPar(pit - 1).size());
1156 if (lyxrc.mac_like_cursor_movement) {
1157 // Skip through punctuation and spaces.
1158 while (pos != 0 && (par.isChar(pos - 1) || par.isSpace(pos - 1)))
1161 // Skip over either a non-char inset or a full word
1162 if (pos != 0 && par.isWordSeparator(pos - 1) && !par.isChar(pos - 1))
1164 else while (pos != 0 && !par.isWordSeparator(pos - 1))
1167 // Skip over white space
1168 while (pos != 0 && par.isSpace(pos - 1))
1171 if (pos != 0 && !par.isWordSeparator(pos - 1))
1172 while (pos != 0 && !par.isWordSeparator(pos - 1))
1174 else if (pos != 0 && par.isChar(pos - 1))
1175 while (pos != 0 && par.isChar(pos - 1))
1177 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
1181 return setCursor(cur, pit, pos);
1185 bool Text::cursorVisLeftOneWord(Cursor & cur)
1187 LBUFERR(this == cur.text());
1189 pos_type left_pos, right_pos;
1190 bool left_is_letter, right_is_letter;
1192 Cursor temp_cur = cur;
1194 // always try to move at least once...
1195 while (temp_cur.posVisLeft(true /* skip_inset */)) {
1197 // collect some information about current cursor position
1198 temp_cur.getSurroundingPos(left_pos, right_pos);
1200 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1202 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1204 // if we're not at a letter/non-letter boundary, continue moving
1205 if (left_is_letter == right_is_letter)
1208 // we should stop when we have an LTR word on our right or an RTL word
1210 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1211 temp_cur.buffer()->params(), left_pos).isRightToLeft())
1212 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1213 temp_cur.buffer()->params(), right_pos).isRightToLeft()))
1217 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1218 true, temp_cur.boundary());
1222 bool Text::cursorVisRightOneWord(Cursor & cur)
1224 LBUFERR(this == cur.text());
1226 pos_type left_pos, right_pos;
1227 bool left_is_letter, right_is_letter;
1229 Cursor temp_cur = cur;
1231 // always try to move at least once...
1232 while (temp_cur.posVisRight(true /* skip_inset */)) {
1234 // collect some information about current cursor position
1235 temp_cur.getSurroundingPos(left_pos, right_pos);
1237 (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1239 (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1241 // if we're not at a letter/non-letter boundary, continue moving
1242 if (left_is_letter == right_is_letter)
1245 // we should stop when we have an LTR word on our right or an RTL word
1247 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1248 temp_cur.buffer()->params(),
1249 left_pos).isRightToLeft())
1250 || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1251 temp_cur.buffer()->params(),
1252 right_pos).isRightToLeft()))
1256 return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1257 true, temp_cur.boundary());
1261 void Text::selectWord(Cursor & cur, word_location loc)
1263 LBUFERR(this == cur.text());
1264 CursorSlice from = cur.top();
1265 CursorSlice to = cur.top();
1266 getWord(from, to, loc);
1267 if (cur.top() != from)
1268 setCursor(cur, from.pit(), from.pos());
1271 if (!cur.selection())
1273 setCursor(cur, to.pit(), to.pos());
1275 cur.setWordSelection(true);
1279 void Text::selectAll(Cursor & cur)
1281 LBUFERR(this == cur.text());
1282 if (cur.lastpos() == 0 && cur.lastpit() == 0)
1284 // If the cursor is at the beginning, make sure the cursor ends there
1285 if (cur.pit() == 0 && cur.pos() == 0) {
1286 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1288 setCursor(cur, 0, 0);
1290 setCursor(cur, 0, 0);
1292 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1298 // Select the word currently under the cursor when no
1299 // selection is currently set
1300 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
1302 LBUFERR(this == cur.text());
1303 if (cur.selection())
1305 selectWord(cur, loc);
1306 return cur.selection();
1310 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
1312 LBUFERR(this == cur.text());
1314 if (!cur.selection()) {
1315 if (!selectChange(cur))
1319 cur.recordUndoSelection();
1321 pit_type begPit = cur.selectionBegin().pit();
1322 pit_type endPit = cur.selectionEnd().pit();
1324 pos_type begPos = cur.selectionBegin().pos();
1325 pos_type endPos = cur.selectionEnd().pos();
1327 // keep selection info, because endPos becomes invalid after the first loop
1328 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
1330 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
1331 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1332 pos_type parSize = pars_[pit].size();
1334 // ignore empty paragraphs; otherwise, an assertion will fail for
1335 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
1339 // do not consider first paragraph if the cursor starts at pos size()
1340 if (pit == begPit && begPos == parSize)
1343 // do not consider last paragraph if the cursor ends at pos 0
1344 if (pit == endPit && endPos == 0)
1345 break; // last iteration anyway
1347 pos_type left = (pit == begPit ? begPos : 0);
1348 pos_type right = (pit == endPit ? endPos : parSize);
1351 // there is no change here
1355 pars_[pit].acceptChanges(left, right);
1357 pars_[pit].rejectChanges(left, right);
1361 // next, accept/reject imaginary end-of-par characters
1363 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1364 pos_type pos = pars_[pit].size();
1366 // skip if the selection ends before the end-of-par
1367 if (pit == endPit && endsBeforeEndOfPar)
1368 break; // last iteration anyway
1370 // skip if this is not the last paragraph of the document
1371 // note: the user should be able to accept/reject the par break of the last par!
1372 if (pit == endPit && pit + 1 != int(pars_.size()))
1373 break; // last iteration anway
1376 if (pars_[pit].isInserted(pos)) {
1377 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1378 } else if (pars_[pit].isDeleted(pos)) {
1379 if (pit + 1 == int(pars_.size())) {
1380 // we cannot remove a par break at the end of the last paragraph;
1381 // instead, we mark it unchanged
1382 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1384 mergeParagraph(cur.buffer()->params(), pars_, pit);
1390 if (pars_[pit].isDeleted(pos)) {
1391 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1392 } else if (pars_[pit].isInserted(pos)) {
1393 if (pit + 1 == int(pars_.size())) {
1394 // we mark the par break at the end of the last paragraph unchanged
1395 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1397 mergeParagraph(cur.buffer()->params(), pars_, pit);
1405 // finally, invoke the DEPM
1406 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer()->params().track_changes);
1409 cur.clearSelection();
1410 setCursorIntern(cur, begPit, begPos);
1411 cur.screenUpdateFlags(Update::Force);
1412 cur.forceBufferUpdate();
1416 void Text::acceptChanges()
1418 BufferParams const & bparams = owner_->buffer().params();
1419 lyx::acceptChanges(pars_, bparams);
1420 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.track_changes);
1424 void Text::rejectChanges()
1426 BufferParams const & bparams = owner_->buffer().params();
1427 pit_type pars_size = static_cast<pit_type>(pars_.size());
1429 // first, reject changes within each individual paragraph
1430 // (do not consider end-of-par)
1431 for (pit_type pit = 0; pit < pars_size; ++pit) {
1432 if (!pars_[pit].empty()) // prevent assertion failure
1433 pars_[pit].rejectChanges(0, pars_[pit].size());
1436 // next, reject imaginary end-of-par characters
1437 for (pit_type pit = 0; pit < pars_size; ++pit) {
1438 pos_type pos = pars_[pit].size();
1440 if (pars_[pit].isDeleted(pos)) {
1441 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1442 } else if (pars_[pit].isInserted(pos)) {
1443 if (pit == pars_size - 1) {
1444 // we mark the par break at the end of the last
1445 // paragraph unchanged
1446 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1448 mergeParagraph(bparams, pars_, pit);
1455 // finally, invoke the DEPM
1456 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.track_changes);
1460 void Text::deleteWordForward(Cursor & cur)
1462 LBUFERR(this == cur.text());
1463 if (cur.lastpos() == 0)
1467 cur.setSelection(true);
1468 cursorForwardOneWord(cur);
1470 cutSelection(cur, true, false);
1471 cur.checkBufferStructure();
1476 void Text::deleteWordBackward(Cursor & cur)
1478 LBUFERR(this == cur.text());
1479 if (cur.lastpos() == 0)
1480 cursorBackward(cur);
1483 cur.setSelection(true);
1484 cursorBackwardOneWord(cur);
1486 cutSelection(cur, true, false);
1487 cur.checkBufferStructure();
1492 // Kill to end of line.
1493 void Text::changeCase(Cursor & cur, TextCase action)
1495 LBUFERR(this == cur.text());
1499 bool gotsel = false;
1500 if (cur.selection()) {
1501 from = cur.selBegin();
1506 getWord(from, to, PARTIAL_WORD);
1507 cursorForwardOneWord(cur);
1510 cur.recordUndoSelection();
1512 pit_type begPit = from.pit();
1513 pit_type endPit = to.pit();
1515 pos_type begPos = from.pos();
1516 pos_type endPos = to.pos();
1518 pos_type right = 0; // needed after the for loop
1520 for (pit_type pit = begPit; pit <= endPit; ++pit) {
1521 Paragraph & par = pars_[pit];
1522 pos_type const pos = (pit == begPit ? begPos : 0);
1523 right = (pit == endPit ? endPos : par.size());
1524 par.changeCase(cur.buffer()->params(), pos, right, action);
1527 // the selection may have changed due to logically-only deleted chars
1529 setCursor(cur, begPit, begPos);
1531 setCursor(cur, endPit, right);
1534 setCursor(cur, endPit, right);
1536 cur.checkBufferStructure();
1540 bool Text::handleBibitems(Cursor & cur)
1542 if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1548 BufferParams const & bufparams = cur.buffer()->params();
1549 Paragraph const & par = cur.paragraph();
1550 Cursor prevcur = cur;
1551 if (cur.pit() > 0) {
1553 prevcur.pos() = prevcur.lastpos();
1555 Paragraph const & prevpar = prevcur.paragraph();
1557 // if a bibitem is deleted, merge with previous paragraph
1558 // if this is a bibliography item as well
1559 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1560 cur.recordUndo(prevcur.pit());
1561 mergeParagraph(bufparams, cur.text()->paragraphs(),
1563 cur.forceBufferUpdate();
1564 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1565 cur.screenUpdateFlags(Update::Force);
1569 // otherwise reset to default
1570 cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1575 bool Text::erase(Cursor & cur)
1577 LASSERT(this == cur.text(), return false);
1578 bool needsUpdate = false;
1579 Paragraph & par = cur.paragraph();
1581 if (cur.pos() != cur.lastpos()) {
1582 // this is the code for a normal delete, not pasting
1584 cur.recordUndo(DELETE_UNDO);
1585 bool const was_inset = cur.paragraph().isInset(cur.pos());
1586 if(!par.eraseChar(cur.pos(), cur.buffer()->params().track_changes))
1587 // the character has been logically deleted only => skip it
1588 cur.top().forwardPos();
1591 cur.forceBufferUpdate();
1593 cur.checkBufferStructure();
1596 if (cur.pit() == cur.lastpit())
1597 return dissolveInset(cur);
1599 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1600 par.setChange(cur.pos(), Change(Change::DELETED));
1604 setCursorIntern(cur, cur.pit() + 1, 0);
1605 needsUpdate = backspacePos0(cur);
1609 needsUpdate |= handleBibitems(cur);
1612 // Make sure the cursor is correct. Is this really needed?
1613 // No, not really... at least not here!
1614 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1615 cur.checkBufferStructure();
1622 bool Text::backspacePos0(Cursor & cur)
1624 LBUFERR(this == cur.text());
1628 bool needsUpdate = false;
1630 BufferParams const & bufparams = cur.buffer()->params();
1631 DocumentClass const & tclass = bufparams.documentClass();
1632 ParagraphList & plist = cur.text()->paragraphs();
1633 Paragraph const & par = cur.paragraph();
1634 Cursor prevcur = cur;
1636 prevcur.pos() = prevcur.lastpos();
1637 Paragraph const & prevpar = prevcur.paragraph();
1639 // is it an empty paragraph?
1640 if (cur.lastpos() == 0
1641 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1642 cur.recordUndo(prevcur.pit());
1643 plist.erase(next(plist.begin(), cur.pit()));
1646 // is previous par empty?
1647 else if (prevcur.lastpos() == 0
1648 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1649 cur.recordUndo(prevcur.pit());
1650 plist.erase(next(plist.begin(), prevcur.pit()));
1653 // Pasting is not allowed, if the paragraphs have different
1654 // layouts. I think it is a real bug of all other
1655 // word processors to allow it. It confuses the user.
1656 // Correction: Pasting is always allowed with standard-layout
1657 // or the empty layout.
1658 else if (par.layout() == prevpar.layout()
1659 || tclass.isDefaultLayout(par.layout())
1660 || tclass.isPlainLayout(par.layout())) {
1661 cur.recordUndo(prevcur.pit());
1662 mergeParagraph(bufparams, plist, prevcur.pit());
1667 cur.forceBufferUpdate();
1668 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1675 bool Text::backspace(Cursor & cur)
1677 LBUFERR(this == cur.text());
1678 bool needsUpdate = false;
1679 if (cur.pos() == 0) {
1681 return dissolveInset(cur);
1683 Cursor prev_cur = cur;
1686 if (!prev_cur.paragraph().isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1687 cur.recordUndo(prev_cur.pit(), prev_cur.pit());
1688 prev_cur.paragraph().setChange(prev_cur.lastpos(), Change(Change::DELETED));
1689 setCursorIntern(cur, prev_cur.pit(), prev_cur.lastpos());
1692 // The cursor is at the beginning of a paragraph, so
1693 // the backspace will collapse two paragraphs into one.
1694 needsUpdate = backspacePos0(cur);
1697 // this is the code for a normal backspace, not pasting
1699 cur.recordUndo(DELETE_UNDO);
1700 // We used to do cursorBackwardIntern() here, but it is
1701 // not a good idea since it triggers the auto-delete
1702 // mechanism. So we do a cursorBackwardIntern()-lite,
1703 // without the dreaded mechanism. (JMarc)
1704 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1705 false, cur.boundary());
1706 bool const was_inset = cur.paragraph().isInset(cur.pos());
1707 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().track_changes);
1709 cur.forceBufferUpdate();
1711 cur.checkBufferStructure();
1714 if (cur.pos() == cur.lastpos())
1715 cur.setCurrentFont();
1717 needsUpdate |= handleBibitems(cur);
1719 // A singlePar update is not enough in this case.
1720 // cur.screenUpdateFlags(Update::Force);
1721 setCursor(cur.top(), cur.pit(), cur.pos());
1727 bool Text::dissolveInset(Cursor & cur)
1729 LASSERT(this == cur.text(), return false);
1731 if (isMainText() || cur.inset().nargs() != 1)
1734 cur.recordUndoInset();
1736 cur.selHandle(false);
1738 pos_type spos = cur.pos();
1739 pit_type spit = cur.pit();
1740 ParagraphList plist;
1741 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1742 plist = paragraphs();
1744 // store cursor offset
1748 Buffer & b = *cur.buffer();
1749 cur.paragraph().eraseChar(cur.pos(), b.params().track_changes);
1751 if (!plist.empty()) {
1753 // we clear the cache so that we won't get conflicts with labels
1754 // that get pasted into the buffer. we should update this before
1755 // its being empty matters. if not (i.e., if we encounter bugs),
1756 // then this should instead be:
1757 // cur.buffer().updateBuffer();
1758 // but we'll try the cheaper solution here.
1759 cur.buffer()->clearReferenceCache();
1761 // ERT paragraphs have the Language latex_language.
1762 // This is invalid outside of ERT, so we need to
1763 // change it to the buffer language.
1764 ParagraphList::iterator it = plist.begin();
1765 ParagraphList::iterator it_end = plist.end();
1766 for (; it != it_end; ++it)
1767 it->changeLanguage(b.params(), latex_language, b.language());
1769 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1770 b.errorList("Paste"));
1772 cur.pit() = min(cur.lastpit(), spit);
1773 cur.pos() = min(cur.lastpos(), spos);
1776 cur.forceBufferUpdate();
1778 // Ensure the current language is set correctly (bug 6292)
1779 cur.text()->setCursor(cur, cur.pit(), cur.pos());
1780 cur.clearSelection();
1786 void Text::getWord(CursorSlice & from, CursorSlice & to,
1787 word_location const loc) const
1790 pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1794 void Text::write(ostream & os) const
1796 Buffer const & buf = owner_->buffer();
1797 ParagraphList::const_iterator pit = paragraphs().begin();
1798 ParagraphList::const_iterator end = paragraphs().end();
1800 for (; pit != end; ++pit)
1801 pit->write(os, buf.params(), dth);
1803 // Close begin_deeper
1804 for(; dth > 0; --dth)
1805 os << "\n\\end_deeper";
1809 bool Text::read(Lexer & lex,
1810 ErrorList & errorList, InsetText * insetPtr)
1812 Buffer const & buf = owner_->buffer();
1813 depth_type depth = 0;
1816 while (lex.isOK()) {
1818 string const token = lex.getString();
1823 if (token == "\\end_inset")
1826 if (token == "\\end_body")
1829 if (token == "\\begin_body")
1832 if (token == "\\end_document") {
1837 if (token == "\\begin_layout") {
1838 lex.pushToken(token);
1841 par.setInsetOwner(insetPtr);
1842 par.params().depth(depth);
1843 par.setFont(0, Font(inherit_font, buf.params().language));
1844 pars_.push_back(par);
1845 readParagraph(pars_.back(), lex, errorList);
1847 // register the words in the global word list
1848 pars_.back().updateWords();
1849 } else if (token == "\\begin_deeper") {
1851 } else if (token == "\\end_deeper") {
1853 lex.printError("\\end_deeper: " "depth is already null");
1857 LYXERR0("Handling unknown body token: `" << token << '\'');
1861 // avoid a crash on weird documents (bug 4859)
1862 if (pars_.empty()) {
1864 par.setInsetOwner(insetPtr);
1865 par.params().depth(depth);
1866 par.setFont(0, Font(inherit_font,
1867 buf.params().language));
1868 par.setPlainOrDefaultLayout(buf.params().documentClass());
1869 pars_.push_back(par);
1876 // Returns the current font and depth as a message.
1877 docstring Text::currentState(Cursor const & cur) const
1879 LBUFERR(this == cur.text());
1880 Buffer & buf = *cur.buffer();
1881 Paragraph const & par = cur.paragraph();
1882 odocstringstream os;
1884 if (buf.params().track_changes)
1885 os << _("[Change Tracking] ");
1887 Change change = par.lookupChange(cur.pos());
1889 if (change.changed()) {
1890 Author const & a = buf.params().authors().get(change.author);
1891 os << _("Change: ") << a.name();
1892 if (!a.email().empty())
1893 os << " (" << a.email() << ")";
1894 // FIXME ctime is english, we should translate that
1895 os << _(" at ") << ctime(&change.changetime);
1899 // I think we should only show changes from the default
1901 // No, from the document font (MV)
1902 Font font = cur.real_current_font;
1903 font.fontInfo().reduce(buf.params().getFont().fontInfo());
1905 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1907 // The paragraph depth
1908 int depth = cur.paragraph().getDepth();
1910 os << bformat(_(", Depth: %1$d"), depth);
1912 // The paragraph spacing, but only if different from
1914 Spacing const & spacing = par.params().spacing();
1915 if (!spacing.isDefault()) {
1916 os << _(", Spacing: ");
1917 switch (spacing.getSpace()) {
1918 case Spacing::Single:
1921 case Spacing::Onehalf:
1924 case Spacing::Double:
1927 case Spacing::Other:
1928 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1930 case Spacing::Default:
1931 // should never happen, do nothing
1936 #ifdef DEVEL_VERSION
1937 os << _(", Inset: ") << &cur.inset();
1938 os << _(", Paragraph: ") << cur.pit();
1939 os << _(", Id: ") << par.id();
1940 os << _(", Position: ") << cur.pos();
1941 // FIXME: Why is the check for par.size() needed?
1942 // We are called with cur.pos() == par.size() quite often.
1943 if (!par.empty() && cur.pos() < par.size()) {
1944 // Force output of code point, not character
1945 size_t const c = par.getChar(cur.pos());
1946 os << _(", Char: 0x") << hex << c;
1948 os << _(", Boundary: ") << cur.boundary();
1949 // Row & row = cur.textRow();
1950 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1956 docstring Text::getPossibleLabel(Cursor const & cur) const
1958 pit_type pit = cur.pit();
1960 Layout const * layout = &(pars_[pit].layout());
1963 docstring par_text = pars_[pit].asString();
1965 // The return string of math matrices might contain linebreaks
1966 par_text = subst(par_text, '\n', '-');
1967 int const numwords = 3;
1968 for (int i = 0; i < numwords; ++i) {
1969 if (par_text.empty())
1972 par_text = split(par_text, head, ' ');
1973 // Is it legal to use spaces in labels ?
1979 // Make sure it isn't too long
1980 unsigned int const max_label_length = 32;
1981 if (text.size() > max_label_length)
1982 text.resize(max_label_length);
1984 // Will contain the label prefix.
1987 // For section, subsection, etc...
1988 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1989 Layout const * layout2 = &(pars_[pit - 1].layout());
1990 if (layout2->latextype != LATEX_PARAGRAPH) {
1995 if (layout->latextype != LATEX_PARAGRAPH)
1996 name = layout->refprefix;
1998 // For captions, we just take the caption type
1999 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
2000 if (caption_inset) {
2001 string const & ftype = static_cast<InsetCaption *>(caption_inset)->floattype();
2002 FloatList const & fl = cur.buffer()->params().documentClass().floats();
2003 if (fl.typeExist(ftype)) {
2004 Floating const & flt = fl.getType(ftype);
2005 name = from_utf8(flt.refPrefix());
2008 name = from_utf8(ftype.substr(0,3));
2011 // If none of the above worked, see if the inset knows.
2013 InsetLayout const & il = cur.inset().getLayout();
2014 name = il.refprefix();
2018 text = name + ':' + text;
2020 // We need a unique label
2021 docstring label = text;
2023 while (cur.buffer()->insetLabel(label)) {
2024 label = text + '-' + convert<docstring>(i);
2032 docstring Text::asString(int options) const
2034 return asString(0, pars_.size(), options);
2038 docstring Text::asString(pit_type beg, pit_type end, int options) const
2040 size_t i = size_t(beg);
2041 docstring str = pars_[i].asString(options);
2042 for (++i; i != size_t(end); ++i) {
2044 str += pars_[i].asString(options);
2050 void Text::forOutliner(docstring & os, size_t maxlen, bool shorten) const
2053 maxlen = std::numeric_limits<std::size_t>::max();
2055 LASSERT(maxlen >= 8, maxlen = TOC_ENTRY_LENGTH);
2056 for (size_t i = 0; i != pars_.size() && os.length() < maxlen; ++i)
2057 pars_[i].forOutliner(os, maxlen);
2058 if (shorten && os.length() >= maxlen)
2059 os = os.substr(0, maxlen - 3) + from_ascii("...");
2063 void Text::charsTranspose(Cursor & cur)
2065 LBUFERR(this == cur.text());
2067 pos_type pos = cur.pos();
2069 // If cursor is at beginning or end of paragraph, do nothing.
2070 if (pos == cur.lastpos() || pos == 0)
2073 Paragraph & par = cur.paragraph();
2075 // Get the positions of the characters to be transposed.
2076 pos_type pos1 = pos - 1;
2077 pos_type pos2 = pos;
2079 // In change tracking mode, ignore deleted characters.
2080 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2082 if (pos2 == cur.lastpos())
2085 while (pos1 >= 0 && par.isDeleted(pos1))
2090 // Don't do anything if one of the "characters" is not regular text.
2091 if (par.isInset(pos1) || par.isInset(pos2))
2094 // Store the characters to be transposed (including font information).
2095 char_type const char1 = par.getChar(pos1);
2097 par.getFontSettings(cur.buffer()->params(), pos1);
2099 char_type const char2 = par.getChar(pos2);
2101 par.getFontSettings(cur.buffer()->params(), pos2);
2103 // And finally, we are ready to perform the transposition.
2104 // Track the changes if Change Tracking is enabled.
2105 bool const trackChanges = cur.buffer()->params().track_changes;
2109 par.eraseChar(pos2, trackChanges);
2110 par.eraseChar(pos1, trackChanges);
2111 par.insertChar(pos1, char2, font2, trackChanges);
2112 par.insertChar(pos2, char1, font1, trackChanges);
2114 cur.checkBufferStructure();
2116 // After the transposition, move cursor to after the transposition.
2117 setCursor(cur, cur.pit(), pos2);
2122 DocIterator Text::macrocontextPosition() const
2124 return macrocontext_position_;
2128 void Text::setMacrocontextPosition(DocIterator const & pos)
2130 macrocontext_position_ = pos;
2134 docstring Text::previousWord(CursorSlice const & sl) const
2136 CursorSlice from = sl;
2137 CursorSlice to = sl;
2138 getWord(from, to, PREVIOUS_WORD);
2139 if (sl == from || to == from)
2142 Paragraph const & par = sl.paragraph();
2143 return par.asString(from.pos(), to.pos());
2147 bool Text::completionSupported(Cursor const & cur) const
2149 Paragraph const & par = cur.paragraph();
2150 return cur.pos() > 0
2151 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
2152 && !par.isWordSeparator(cur.pos() - 1);
2156 CompletionList const * Text::createCompletionList(Cursor const & cur) const
2158 WordList const * list = theWordList(cur.getFont().language()->lang());
2159 return new TextCompletionList(cur, list);
2163 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
2165 LBUFERR(cur.bv().cursor() == cur);
2167 cur.bv().cursor() = cur;
2168 if (!(cur.result().screenUpdate() & Update::Force))
2169 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
2174 docstring Text::completionPrefix(Cursor const & cur) const
2176 return previousWord(cur.top());