]> git.lyx.org Git - lyx.git/blob - src/Text.cpp
Fix #4658: showing diff between original and emergency files.
[lyx.git] / src / Text.cpp
1 /**
2  * \file src/Text.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Asger Alstrup
7  * \author Lars Gullik Bjønnes
8  * \author Dov Feldstern
9  * \author Jean-Marc Lasgouttes
10  * \author John Levon
11  * \author André Pönitz
12  * \author Stefan Schimanski
13  * \author Dekel Tsur
14  * \author Jürgen Vigna
15  *
16  * Full author contact details are available in file CREDITS.
17  */
18
19 #include <config.h>
20
21 #include "Text.h"
22
23 #include "Author.h"
24 #include "Buffer.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "Changes.h"
28 #include "CompletionList.h"
29 #include "Cursor.h"
30 #include "CursorSlice.h"
31 #include "CutAndPaste.h"
32 #include "Encoding.h"
33 #include "ErrorList.h"
34 #include "factory.h"
35 #include "Font.h"
36 #include "FuncRequest.h"
37 #include "Language.h"
38 #include "Layout.h"
39 #include "Lexer.h"
40 #include "lyxfind.h"
41 #include "LyXRC.h"
42 #include "Paragraph.h"
43 #include "ParagraphParameters.h"
44 #include "TextClass.h"
45 #include "TextMetrics.h"
46 #include "WordList.h"
47
48 #include "insets/Inset.h"
49 #include "insets/InsetText.h"
50 #include "insets/InsetCaption.h"
51 #include "insets/InsetIPAMacro.h"
52 #include "insets/InsetSpecialChar.h"
53 #include "insets/InsetTabular.h"
54
55 #include "support/convert.h"
56 #include "support/debug.h"
57 #include "support/docstream.h"
58 #include "support/docstring.h"
59 #include "support/gettext.h"
60 #include "support/lassert.h"
61 #include "support/lstrings.h"
62 #include "support/lyxtime.h"
63 #include "support/textutils.h"
64 #include "support/unique_ptr.h"
65
66 #include <sstream>
67
68
69 using namespace std;
70 using namespace lyx::support;
71
72 namespace lyx {
73
74 using cap::cutSelection;
75 using cap::pasteParagraphList;
76
77 static bool moveItem(Paragraph & fromPar, pos_type fromPos,
78         Paragraph & toPar, pos_type toPos, BufferParams const & params)
79 {
80         // Note: moveItem() does not honour change tracking!
81         // Therefore, it should only be used for breaking and merging paragraphs
82
83         // We need a copy here because the character at fromPos is going to be erased.
84         Font const tmpFont = fromPar.getFontSettings(params, fromPos);
85         Change const tmpChange = fromPar.lookupChange(fromPos);
86
87         if (Inset * tmpInset = fromPar.getInset(fromPos)) {
88                 fromPar.releaseInset(fromPos);
89                 // The inset is not in fromPar any more.
90                 if (!toPar.insertInset(toPos, tmpInset, tmpFont, tmpChange)) {
91                         delete tmpInset;
92                         return false;
93                 }
94                 return true;
95         }
96
97         char_type const tmpChar = fromPar.getChar(fromPos);
98         fromPar.eraseChar(fromPos, false);
99         toPar.insertChar(toPos, tmpChar, tmpFont, tmpChange);
100         return true;
101 }
102
103
104 void breakParagraphConservative(BufferParams const & bparams,
105         ParagraphList & pars, pit_type pit, pos_type pos)
106 {
107         // create a new paragraph
108         Paragraph & tmp = *pars.insert(pars.iterator_at(pit + 1), Paragraph());
109         Paragraph & par = pars[pit];
110
111         tmp.setInsetOwner(&par.inInset());
112         tmp.makeSameLayout(par);
113
114         LASSERT(pos <= par.size(), return);
115
116         if (pos < par.size()) {
117                 // move everything behind the break position to the new paragraph
118                 pos_type pos_end = par.size() - 1;
119
120                 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
121                         if (moveItem(par, pos, tmp, j, bparams)) {
122                                 ++j;
123                         }
124                 }
125                 // Move over the end-of-par change information
126                 tmp.setChange(tmp.size(), par.lookupChange(par.size()));
127                 par.setChange(par.size(), Change(bparams.track_changes ?
128                                            Change::INSERTED : Change::UNCHANGED));
129         }
130 }
131
132
133 void mergeParagraph(BufferParams const & bparams,
134         ParagraphList & pars, pit_type par_offset)
135 {
136         Paragraph & next = pars[par_offset + 1];
137         Paragraph & par = pars[par_offset];
138
139         pos_type pos_end = next.size() - 1;
140         pos_type pos_insert = par.size();
141
142         // the imaginary end-of-paragraph character (at par.size()) has to be
143         // marked as unmodified. Otherwise, its change is adopted by the first
144         // character of the next paragraph.
145         if (par.isChanged(par.size())) {
146                 LYXERR(Debug::CHANGES,
147                    "merging par with inserted/deleted end-of-par character");
148                 par.setChange(par.size(), Change(Change::UNCHANGED));
149         }
150
151         Change change = next.lookupChange(next.size());
152
153         // move the content of the second paragraph to the end of the first one
154         for (pos_type i = 0, j = pos_insert; i <= pos_end; ++i) {
155                 if (moveItem(next, 0, par, j, bparams)) {
156                         ++j;
157                 }
158         }
159
160         // move the change of the end-of-paragraph character
161         par.setChange(par.size(), change);
162
163         pars.erase(pars.iterator_at(par_offset + 1));
164 }
165
166
167 Text::Text(InsetText * owner, bool use_default_layout)
168         : owner_(owner)
169 {
170         pars_.push_back(Paragraph());
171         Paragraph & par = pars_.back();
172         par.setInsetOwner(owner);
173         DocumentClass const & dc = owner->buffer().params().documentClass();
174         if (use_default_layout)
175                 par.setDefaultLayout(dc);
176         else
177                 par.setPlainLayout(dc);
178 }
179
180
181 Text::Text(InsetText * owner, Text const & text)
182         : owner_(owner), pars_(text.pars_)
183 {
184         for (auto & p : pars_)
185                 p.setInsetOwner(owner);
186 }
187
188
189 pit_type Text::depthHook(pit_type pit, depth_type depth) const
190 {
191         pit_type newpit = pit;
192
193         if (newpit != 0)
194                 --newpit;
195
196         while (newpit != 0 && pars_[newpit].getDepth() > depth)
197                 --newpit;
198
199         if (pars_[newpit].getDepth() > depth)
200                 return pit;
201
202         return newpit;
203 }
204
205
206 pit_type Text::outerHook(pit_type par_offset) const
207 {
208         Paragraph const & par = pars_[par_offset];
209
210         if (par.getDepth() == 0)
211                 return pars_.size();
212         return depthHook(par_offset, depth_type(par.getDepth() - 1));
213 }
214
215
216 bool Text::isFirstInSequence(pit_type par_offset) const
217 {
218         Paragraph const & par = pars_[par_offset];
219
220         pit_type dhook_offset = depthHook(par_offset, par.getDepth());
221
222         if (dhook_offset == par_offset)
223                 return true;
224
225         Paragraph const & dhook = pars_[dhook_offset];
226
227         return dhook.layout() != par.layout()
228                 || dhook.getDepth() != par.getDepth();
229 }
230
231
232 pit_type Text::lastInSequence(pit_type pit) const
233 {
234         depth_type const depth = pars_[pit].getDepth();
235         pit_type newpit = pit;
236
237         while (size_t(newpit + 1) < pars_.size() &&
238                (pars_[newpit + 1].getDepth() > depth ||
239                 (pars_[newpit + 1].getDepth() == depth &&
240                  pars_[newpit + 1].layout() == pars_[pit].layout())))
241                 ++newpit;
242
243         return newpit;
244 }
245
246
247 int Text::getTocLevel(pit_type par_offset) const
248 {
249         Paragraph const & par = pars_[par_offset];
250
251         if (par.layout().isEnvironment() && !isFirstInSequence(par_offset))
252                 return Layout::NOT_IN_TOC;
253
254         return par.layout().toclevel;
255 }
256
257
258 Font const Text::outerFont(pit_type par_offset) const
259 {
260         depth_type par_depth = pars_[par_offset].getDepth();
261         FontInfo tmpfont = inherit_font;
262         depth_type prev_par_depth = 0;
263         // Resolve against environment font information
264         while (par_offset != pit_type(pars_.size())
265                && par_depth != prev_par_depth
266                && par_depth
267                && !tmpfont.resolved()) {
268                 prev_par_depth = par_depth;
269                 par_offset = outerHook(par_offset);
270                 if (par_offset != pit_type(pars_.size())) {
271                         tmpfont.realize(pars_[par_offset].layout().font);
272                         par_depth = pars_[par_offset].getDepth();
273                 }
274         }
275
276         return Font(tmpfont);
277 }
278
279
280 int Text::getEndLabel(pit_type p) const
281 {
282         pit_type pit = p;
283         depth_type par_depth = pars_[p].getDepth();
284         while (pit != pit_type(pars_.size())) {
285                 Layout const & layout = pars_[pit].layout();
286                 int const endlabeltype = layout.endlabeltype;
287
288                 if (endlabeltype != END_LABEL_NO_LABEL) {
289                         if (p + 1 == pit_type(pars_.size()))
290                                 return endlabeltype;
291
292                         depth_type const next_depth =
293                                 pars_[p + 1].getDepth();
294                         if (par_depth > next_depth ||
295                             (par_depth == next_depth && layout != pars_[p + 1].layout()))
296                                 return endlabeltype;
297                         break;
298                 }
299                 if (par_depth == 0)
300                         break;
301                 pit = outerHook(pit);
302                 if (pit != pit_type(pars_.size()))
303                         par_depth = pars_[pit].getDepth();
304         }
305         return END_LABEL_NO_LABEL;
306 }
307
308
309 static void acceptOrRejectChanges(ParagraphList & pars,
310         BufferParams const & bparams, Text::ChangeOp op)
311 {
312         pit_type pars_size = static_cast<pit_type>(pars.size());
313
314         // first, accept or reject changes within each individual
315         // paragraph (do not consider end-of-par)
316         for (pit_type pit = 0; pit < pars_size; ++pit) {
317                 // prevent assertion failure
318                 if (!pars[pit].empty()) {
319                         if (op == Text::ACCEPT)
320                                 pars[pit].acceptChanges(0, pars[pit].size());
321                         else
322                                 pars[pit].rejectChanges(0, pars[pit].size());
323                 }
324         }
325
326         // next, accept or reject imaginary end-of-par characters
327         for (pit_type pit = 0; pit < pars_size; ++pit) {
328                 pos_type pos = pars[pit].size();
329                 if (pars[pit].isChanged(pos)) {
330                         // keep the end-of-par char if it is inserted and accepted
331                         // or when it is deleted and rejected.
332                         if (pars[pit].isInserted(pos) == (op == Text::ACCEPT)) {
333                                 pars[pit].setChange(pos, Change(Change::UNCHANGED));
334                         } else {
335                                 if (pit == pars_size - 1) {
336                                         // we cannot remove a par break at the end of the last
337                                         // paragraph; instead, we mark it unchanged
338                                         pars[pit].setChange(pos, Change(Change::UNCHANGED));
339                                 } else {
340                                         mergeParagraph(bparams, pars, pit);
341                                         --pit;
342                                         --pars_size;
343                                 }
344                         }
345                 }
346         }
347 }
348
349
350 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
351 {
352         acceptOrRejectChanges(pars, bparams, Text::ACCEPT);
353 }
354
355
356 void rejectChanges(ParagraphList & pars, BufferParams const & bparams)
357 {
358         acceptOrRejectChanges(pars, bparams, Text::REJECT);
359 }
360
361
362 InsetText const & Text::inset() const
363 {
364         return *owner_;
365 }
366
367
368
369 void Text::readParToken(Paragraph & par, Lexer & lex,
370         string const & token, Font & font, Change & change, ErrorList & errorList)
371 {
372         Buffer * buf = const_cast<Buffer *>(&owner_->buffer());
373         BufferParams & bp = buf->params();
374
375         if (token[0] != '\\') {
376                 docstring dstr = lex.getDocString();
377                 par.appendString(dstr, font, change);
378
379         } else if (token == "\\begin_layout") {
380                 lex.eatLine();
381                 docstring layoutname = lex.getDocString();
382
383                 font = Font(inherit_font, bp.language);
384                 change = Change(Change::UNCHANGED);
385
386                 DocumentClass const & tclass = bp.documentClass();
387
388                 if (layoutname.empty())
389                         layoutname = tclass.defaultLayoutName();
390
391                 if (owner_->forcePlainLayout()) {
392                         // in this case only the empty layout is allowed
393                         layoutname = tclass.plainLayoutName();
394                 } else if (par.usePlainLayout()) {
395                         // in this case, default layout maps to empty layout
396                         if (layoutname == tclass.defaultLayoutName())
397                                 layoutname = tclass.plainLayoutName();
398                 } else {
399                         // otherwise, the empty layout maps to the default
400                         if (layoutname == tclass.plainLayoutName())
401                                 layoutname = tclass.defaultLayoutName();
402                 }
403
404                 // When we apply an unknown layout to a document, we add this layout to the textclass
405                 // of this document. For example, when you apply class article to a beamer document,
406                 // all unknown layouts such as frame will be added to document class article so that
407                 // these layouts can keep their original names.
408                 bool const added_one = tclass.addLayoutIfNeeded(layoutname);
409                 if (added_one) {
410                         // Warn the user.
411                         docstring const s = bformat(_("Layout `%1$s' was not found."), layoutname);
412                         errorList.push_back(ErrorItem(_("Layout Not Found"), s,
413                                                       {par.id(), 0}, {par.id(), -1}));
414                 }
415
416                 par.setLayout(bp.documentClass()[layoutname]);
417
418                 // Test whether the layout is obsolete.
419                 Layout const & layout = par.layout();
420                 if (!layout.obsoleted_by().empty())
421                         par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
422
423                 par.params().read(lex);
424
425         } else if (token == "\\end_layout") {
426                 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
427                        << "Missing \\begin_layout ?");
428         } else if (token == "\\end_inset") {
429                 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
430                        << "Missing \\begin_inset ?");
431         } else if (token == "\\begin_inset") {
432                 Inset * inset = readInset(lex, buf);
433                 if (inset)
434                         par.insertInset(par.size(), inset, font, change);
435                 else {
436                         lex.eatLine();
437                         docstring line = lex.getDocString();
438                         errorList.push_back(ErrorItem(_("Unknown Inset"), line,
439                                                       {par.id(), 0}, {par.id(), -1}));
440                 }
441         } else if (token == "\\family") {
442                 lex.next();
443                 setLyXFamily(lex.getString(), font.fontInfo());
444         } else if (token == "\\series") {
445                 lex.next();
446                 setLyXSeries(lex.getString(), font.fontInfo());
447         } else if (token == "\\shape") {
448                 lex.next();
449                 setLyXShape(lex.getString(), font.fontInfo());
450         } else if (token == "\\size") {
451                 lex.next();
452                 setLyXSize(lex.getString(), font.fontInfo());
453         } else if (token == "\\lang") {
454                 lex.next();
455                 string const tok = lex.getString();
456                 Language const * lang = languages.getLanguage(tok);
457                 if (lang) {
458                         font.setLanguage(lang);
459                 } else {
460                         font.setLanguage(bp.language);
461                         lex.printError("Unknown language `$$Token'");
462                 }
463         } else if (token == "\\numeric") {
464                 lex.next();
465                 font.fontInfo().setNumber(setLyXMisc(lex.getString()));
466         } else if (token == "\\nospellcheck") {
467                 lex.next();
468                 font.fontInfo().setNoSpellcheck(setLyXMisc(lex.getString()));
469         } else if (token == "\\emph") {
470                 lex.next();
471                 font.fontInfo().setEmph(setLyXMisc(lex.getString()));
472         } else if (token == "\\bar") {
473                 lex.next();
474                 string const tok = lex.getString();
475
476                 if (tok == "under")
477                         font.fontInfo().setUnderbar(FONT_ON);
478                 else if (tok == "no")
479                         font.fontInfo().setUnderbar(FONT_OFF);
480                 else if (tok == "default")
481                         font.fontInfo().setUnderbar(FONT_INHERIT);
482                 else
483                         lex.printError("Unknown bar font flag "
484                                        "`$$Token'");
485         } else if (token == "\\strikeout") {
486                 lex.next();
487                 font.fontInfo().setStrikeout(setLyXMisc(lex.getString()));
488         } else if (token == "\\xout") {
489                 lex.next();
490                 font.fontInfo().setXout(setLyXMisc(lex.getString()));
491         } else if (token == "\\uuline") {
492                 lex.next();
493                 font.fontInfo().setUuline(setLyXMisc(lex.getString()));
494         } else if (token == "\\uwave") {
495                 lex.next();
496                 font.fontInfo().setUwave(setLyXMisc(lex.getString()));
497         } else if (token == "\\noun") {
498                 lex.next();
499                 font.fontInfo().setNoun(setLyXMisc(lex.getString()));
500         } else if (token == "\\color") {
501                 lex.next();
502                 setLyXColor(lex.getString(), font.fontInfo());
503         } else if (token == "\\SpecialChar" ||
504                    (token == "\\SpecialCharNoPassThru" &&
505                     !par.layout().pass_thru && !inset().isPassThru())) {
506                 auto inset = make_unique<InsetSpecialChar>();
507                 inset->read(lex);
508                 inset->setBuffer(*buf);
509                 par.insertInset(par.size(), inset.release(), font, change);
510         } else if (token == "\\SpecialCharNoPassThru") {
511                 lex.next();
512                 docstring const s = ltrim(lex.getDocString(), "\\");
513                 par.insert(par.size(), s, font, change);
514         } else if (token == "\\IPAChar") {
515                 auto inset = make_unique<InsetIPAChar>();
516                 inset->read(lex);
517                 inset->setBuffer(*buf);
518                 par.insertInset(par.size(), inset.release(), font, change);
519         } else if (token == "\\twohyphens" || token == "\\threehyphens") {
520                 // Ideally, this should be done by lyx2lyx, but lyx2lyx does not know the
521                 // running font and does not know anything about layouts (and CopyStyle).
522                 Layout const & layout(par.layout());
523                 FontInfo info = font.fontInfo();
524                 info.realize(layout.resfont);
525                 if (layout.pass_thru || inset().isPassThru() ||
526                     info.family() == TYPEWRITER_FAMILY) {
527                         if (token == "\\twohyphens")
528                                 par.insert(par.size(), from_ascii("--"), font, change);
529                         else
530                                 par.insert(par.size(), from_ascii("---"), font, change);
531                 } else {
532                         if (token == "\\twohyphens")
533                                 par.insertChar(par.size(), 0x2013, font, change);
534                         else
535                                 par.insertChar(par.size(), 0x2014, font, change);
536                 }
537         } else if (token == "\\backslash") {
538                 par.appendChar('\\', font, change);
539         } else if (token == "\\LyXTable") {
540                 auto inset = make_unique<InsetTabular>(buf);
541                 inset->read(lex);
542                 par.insertInset(par.size(), inset.release(), font, change);
543         } else if (token == "\\change_unchanged") {
544                 change = Change(Change::UNCHANGED);
545         } else if (token == "\\change_inserted" || token == "\\change_deleted") {
546                 lex.eatLine();
547                 istringstream is(lex.getString());
548                 int aid;
549                 time_t ct;
550                 is >> aid >> ct;
551                 BufferParams::AuthorMap const & am = bp.author_map_;
552                 if (am.find(aid) == am.end()) {
553                         errorList.push_back(ErrorItem(
554                                 _("Change tracking author index missing"),
555                                 bformat(_("A change tracking author information for index "
556                                           "%1$d is missing. This can happen after a wrong "
557                                           "merge by a version control system. In this case, "
558                                           "either fix the merge, or have this information "
559                                           "missing until the corresponding tracked changes "
560                                           "are merged or this user edits the file again.\n"),
561                                         aid),
562                                 {par.id(), par.size()}, {par.id(), par.size() + 1}));
563                         bp.addAuthor(Author(aid));
564                 }
565                 if (token == "\\change_inserted")
566                         change = Change(Change::INSERTED, am.find(aid)->second, ct);
567                 else
568                         change = Change(Change::DELETED, am.find(aid)->second, ct);
569         } else {
570                 lex.eatLine();
571                 errorList.push_back(ErrorItem(_("Unknown token"),
572                                               bformat(_("Unknown token: %1$s %2$s\n"),
573                                                       from_utf8(token),
574                                                       lex.getDocString()),
575                                               {par.id(), 0}, {par.id(), -1}));
576         }
577 }
578
579
580 void Text::readParagraph(Paragraph & par, Lexer & lex,
581         ErrorList & errorList)
582 {
583         lex.nextToken();
584         string token = lex.getString();
585         Font font;
586         Change change(Change::UNCHANGED);
587
588         while (lex.isOK()) {
589                 readParToken(par, lex, token, font, change, errorList);
590
591                 lex.nextToken();
592                 token = lex.getString();
593
594                 if (token.empty())
595                         continue;
596
597                 if (token == "\\end_layout") {
598                         //Ok, paragraph finished
599                         break;
600                 }
601
602                 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
603                 if (token == "\\begin_layout" || token == "\\end_document"
604                     || token == "\\end_inset" || token == "\\begin_deeper"
605                     || token == "\\end_deeper") {
606                         lex.pushToken(token);
607                         lyxerr << "Paragraph ended in line "
608                                << lex.lineNumber() << "\n"
609                                << "Missing \\end_layout.\n";
610                         break;
611                 }
612         }
613         // Final change goes to paragraph break:
614         if (inset().allowMultiPar())
615                 par.setChange(par.size(), change);
616
617         // Initialize begin_of_body_ on load; redoParagraph maintains
618         par.setBeginOfBody();
619
620         // mark paragraph for spell checking on load
621         // par.requestSpellCheck();
622 }
623
624
625 class TextCompletionList : public CompletionList
626 {
627 public:
628         ///
629         TextCompletionList(Cursor const & cur, WordList const & list)
630                 : buffer_(cur.buffer()), list_(list)
631         {}
632         ///
633         virtual ~TextCompletionList() {}
634
635         ///
636         bool sorted() const override { return true; }
637         ///
638         size_t size() const override
639         {
640                 return list_.size();
641         }
642         ///
643         docstring const & data(size_t idx) const override
644         {
645                 return list_.word(idx);
646         }
647
648 private:
649         ///
650         Buffer const * buffer_;
651         ///
652         WordList const & list_;
653 };
654
655
656 bool Text::empty() const
657 {
658         return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
659                 // FIXME: Should we consider the labeled type as empty too?
660                 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
661 }
662
663
664 double Text::spacing(Paragraph const & par) const
665 {
666         if (par.params().spacing().isDefault())
667                 return owner_->buffer().params().spacing().getValue();
668         return par.params().spacing().getValue();
669 }
670
671
672 /**
673  * This breaks a paragraph at the specified position.
674  * The new paragraph will:
675  * - Decrease depth by one (or change layout to default layout) when
676  *    keep_layout == false
677  * - keep current depth and layout when keep_layout == true
678  */
679 static void breakParagraph(Text & text, pit_type par_offset, pos_type pos,
680                     bool keep_layout)
681 {
682         BufferParams const & bparams = text.inset().buffer().params();
683         ParagraphList & pars = text.paragraphs();
684         // create a new paragraph, and insert into the list
685         ParagraphList::iterator tmp =
686                 pars.insert(pars.iterator_at(par_offset + 1), Paragraph());
687
688         Paragraph & par = pars[par_offset];
689
690         // remember to set the inset_owner
691         tmp->setInsetOwner(&par.inInset());
692         // without doing that we get a crash when typing <Return> at the
693         // end of a paragraph
694         tmp->setPlainOrDefaultLayout(bparams.documentClass());
695
696         if (keep_layout) {
697                 tmp->setLayout(par.layout());
698                 tmp->setLabelWidthString(par.params().labelWidthString());
699                 tmp->params().depth(par.params().depth());
700         } else if (par.params().depth() > 0) {
701                 Paragraph const & hook = pars[text.outerHook(par_offset)];
702                 tmp->setLayout(hook.layout());
703                 // not sure the line below is useful
704                 tmp->setLabelWidthString(par.params().labelWidthString());
705                 tmp->params().depth(hook.params().depth());
706         }
707
708         bool const isempty = (par.allowEmpty() && par.empty());
709
710         if (!isempty && (par.size() > pos || par.empty())) {
711                 tmp->setLayout(par.layout());
712                 tmp->params().align(par.params().align());
713                 tmp->setLabelWidthString(par.params().labelWidthString());
714
715                 tmp->params().depth(par.params().depth());
716                 tmp->params().noindent(par.params().noindent());
717                 tmp->params().spacing(par.params().spacing());
718
719                 // move everything behind the break position
720                 // to the new paragraph
721
722                 /* Note: if !keepempty, empty() == true, then we reach
723                  * here with size() == 0. So pos_end becomes - 1. This
724                  * doesn't cause problems because both loops below
725                  * enforce pos <= pos_end and 0 <= pos
726                  */
727                 pos_type pos_end = par.size() - 1;
728
729                 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
730                         if (moveItem(par, pos, *tmp, j, bparams)) {
731                                 ++j;
732                         }
733                 }
734         }
735
736         // Move over the end-of-par change information
737         tmp->setChange(tmp->size(), par.lookupChange(par.size()));
738         par.setChange(par.size(), Change(bparams.track_changes ?
739                                            Change::INSERTED : Change::UNCHANGED));
740
741         if (pos) {
742                 // Make sure that we keep the language when
743                 // breaking paragraph.
744                 if (tmp->empty()) {
745                         Font changed = tmp->getFirstFontSettings(bparams);
746                         Font const & old = par.getFontSettings(bparams, par.size());
747                         changed.setLanguage(old.language());
748                         tmp->setFont(0, changed);
749                 }
750
751                 return;
752         }
753
754         if (!isempty) {
755                 bool const soa = par.params().startOfAppendix();
756                 par.params().clear();
757                 // do not lose start of appendix marker (bug 4212)
758                 par.params().startOfAppendix(soa);
759                 par.setPlainOrDefaultLayout(bparams.documentClass());
760         }
761
762         if (keep_layout) {
763                 par.setLayout(tmp->layout());
764                 par.setLabelWidthString(tmp->params().labelWidthString());
765                 par.params().depth(tmp->params().depth());
766         }
767 }
768
769
770 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
771 {
772         LBUFERR(this == cur.text());
773
774         Paragraph & cpar = cur.paragraph();
775         pit_type cpit = cur.pit();
776
777         DocumentClass const & tclass = cur.buffer()->params().documentClass();
778         Layout const & layout = cpar.layout();
779
780         if (cur.lastpos() == 0 && !cpar.allowEmpty()) {
781                 if (changeDepthAllowed(cur, DEC_DEPTH)) {
782                         changeDepth(cur, DEC_DEPTH);
783                         pit_type const prev = depthHook(cpit, cpar.getDepth());
784                         docstring const & lay = pars_[prev].layout().name();
785                         if (lay != layout.name())
786                                 setLayout(cur, lay);
787                 } else {
788                         docstring const & lay = cur.paragraph().usePlainLayout()
789                             ? tclass.plainLayoutName() : tclass.defaultLayoutName();
790                         if (lay != layout.name())
791                                 setLayout(cur, lay);
792                 }
793                 return;
794         }
795
796         cur.recordUndo();
797
798         // Always break behind a space
799         // It is better to erase the space (Dekel)
800         if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
801                 cpar.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
802
803         // What should the layout for the new paragraph be?
804         bool keep_layout = layout.isEnvironment()
805                 || (layout.isParagraph() && layout.parbreak_is_newline);
806         if (inverse_logic)
807                 keep_layout = !keep_layout;
808
809         // We need to remember this before we break the paragraph, because
810         // that invalidates the layout variable
811         bool sensitive = layout.labeltype == LABEL_SENSITIVE;
812
813         // we need to set this before we insert the paragraph.
814         bool const isempty = cpar.allowEmpty() && cpar.empty();
815
816         lyx::breakParagraph(*this, cpit, cur.pos(), keep_layout);
817
818         // After this, neither paragraph contains any rows!
819
820         cpit = cur.pit();
821         pit_type next_par = cpit + 1;
822
823         // well this is the caption hack since one caption is really enough
824         if (sensitive) {
825                 if (cur.pos() == 0)
826                         // set to standard-layout
827                 //FIXME Check if this should be plainLayout() in some cases
828                         pars_[cpit].applyLayout(tclass.defaultLayout());
829                 else
830                         // set to standard-layout
831                         //FIXME Check if this should be plainLayout() in some cases
832                         pars_[next_par].applyLayout(tclass.defaultLayout());
833         }
834
835         while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
836                 if (!pars_[next_par].eraseChar(0, cur.buffer()->params().track_changes))
837                         break; // the character couldn't be deleted physically due to change tracking
838         }
839
840         // A singlePar update is not enough in this case.
841         cur.screenUpdateFlags(Update::Force);
842         cur.forceBufferUpdate();
843
844         // This check is necessary. Otherwise the new empty paragraph will
845         // be deleted automatically. And it is more friendly for the user!
846         if (cur.pos() != 0 || isempty)
847                 setCursor(cur, cur.pit() + 1, 0);
848         else
849                 setCursor(cur, cur.pit(), 0);
850 }
851
852
853 // needed to insert the selection
854 void Text::insertStringAsLines(Cursor & cur, docstring const & str,
855                 Font const & font)
856 {
857         BufferParams const & bparams = owner_->buffer().params();
858         pit_type pit = cur.pit();
859         pos_type pos = cur.pos();
860
861         // The special chars we handle
862         static map<wchar_t, InsetSpecialChar::Kind> specialchars = {
863                 { 0x200c, InsetSpecialChar::LIGATURE_BREAK },
864                 { 0x200b, InsetSpecialChar::ALLOWBREAK },
865                 { 0x2026, InsetSpecialChar::LDOTS },
866                 { 0x2011, InsetSpecialChar::NOBREAKDASH }
867         };
868
869         // insert the string, don't insert doublespace
870         bool space_inserted = true;
871         for (auto const & ch : str) {
872                 Paragraph & par = pars_[pit];
873                 if (ch == '\n') {
874                         if (inset().allowMultiPar() && (!par.empty() || par.allowEmpty())) {
875                                 lyx::breakParagraph(*this, pit, pos,
876                                         par.layout().isEnvironment());
877                                 ++pit;
878                                 pos = 0;
879                                 space_inserted = true;
880                         } else {
881                                 continue;
882                         }
883                 // do not insert consecutive spaces if !free_spacing
884                 } else if ((ch == ' ' || ch == '\t') &&
885                            space_inserted && !par.isFreeSpacing()) {
886                         continue;
887                 } else if (ch == '\t') {
888                         if (!par.isFreeSpacing()) {
889                                 // tabs are like spaces here
890                                 par.insertChar(pos, ' ', font, bparams.track_changes);
891                                 ++pos;
892                                 space_inserted = true;
893                         } else {
894                                 par.insertChar(pos, ch, font, bparams.track_changes);
895                                 ++pos;
896                                 space_inserted = true;
897                         }
898                 } else if (specialchars.find(ch) != specialchars.end()
899                            && (par.insertInset(pos, new InsetSpecialChar(specialchars.find(ch)->second),
900                                                font, bparams.track_changes
901                                                ? Change(Change::INSERTED)
902                                                : Change(Change::UNCHANGED)))) {
903                         ++pos;
904                         space_inserted = false;
905                 } else if (!isPrintable(ch)) {
906                         // Ignore (other) unprintables
907                         continue;
908                 } else {
909                         // just insert the character
910                         par.insertChar(pos, ch, font, bparams.track_changes);
911                         ++pos;
912                         space_inserted = (ch == ' ');
913                 }
914         }
915         setCursor(cur, pit, pos);
916 }
917
918
919 // turn double CR to single CR, others are converted into one
920 // blank. Then insertStringAsLines is called
921 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str,
922                 Font const & font)
923 {
924         docstring linestr = str;
925         bool newline_inserted = false;
926
927         for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
928                 if (linestr[i] == '\n') {
929                         if (newline_inserted) {
930                                 // we know that \r will be ignored by
931                                 // insertStringAsLines. Of course, it is a dirty
932                                 // trick, but it works...
933                                 linestr[i - 1] = '\r';
934                                 linestr[i] = '\n';
935                         } else {
936                                 linestr[i] = ' ';
937                                 newline_inserted = true;
938                         }
939                 } else if (isPrintable(linestr[i])) {
940                         newline_inserted = false;
941                 }
942         }
943         insertStringAsLines(cur, linestr, font);
944 }
945
946
947 namespace {
948
949 bool canInsertChar(Cursor const & cur, char_type c)
950 {
951         Paragraph const & par = cur.paragraph();
952         // If not in free spacing mode, check if there will be two blanks together or a blank at
953         // the beginning of a paragraph.
954         if (!par.isFreeSpacing() && isLineSeparatorChar(c)) {
955                 if (cur.pos() == 0) {
956                         cur.message(_(
957                                         "You cannot insert a space at the "
958                                         "beginning of a paragraph. Please read the Tutorial."));
959                         return false;
960                 }
961                 // If something is wrong, ignore this character.
962                 LASSERT(cur.pos() > 0, return false);
963                 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
964                                 && !par.isDeleted(cur.pos() - 1)) {
965                         cur.message(_(
966                                         "You cannot type two spaces this way. "
967                                         "Please read the Tutorial."));
968                         return false;
969                 }
970         }
971
972         // Prevent to insert uncodable characters in verbatim and ERT.
973         // The encoding is inherited from the context here.
974         if (par.isPassThru() && cur.getEncoding()) {
975                 Encoding const * e = cur.getEncoding();
976                 if (!e->encodable(c)) {
977                         cur.message(_("Character is uncodable in this verbatim context."));
978                         return false;
979                 }
980         }
981         return true;
982 }
983
984 } // namespace
985
986
987 // insert a character, moves all the following breaks in the
988 // same Paragraph one to the right and make a rebreak
989 void Text::insertChar(Cursor & cur, char_type c)
990 {
991         LBUFERR(this == cur.text());
992
993         if (!canInsertChar(cur,c))
994                 return;
995
996         cur.recordUndo(INSERT_UNDO);
997
998         TextMetrics const & tm = cur.bv().textMetrics(this);
999         Buffer const & buffer = *cur.buffer();
1000         Paragraph & par = cur.paragraph();
1001         // try to remove this
1002         pit_type const pit = cur.pit();
1003
1004         if (lyxrc.auto_number) {
1005                 static docstring const number_operators = from_ascii("+-/*");
1006                 static docstring const number_unary_operators = from_ascii("+-");
1007
1008                 // Common Number Separators: comma, dot etc.
1009                 // European Number Terminators: percent, permille, degree, euro etc.
1010                 if (cur.current_font.fontInfo().number() == FONT_ON) {
1011                         if (!isDigitASCII(c) && !contains(number_operators, c) &&
1012                             !(isCommonNumberSeparator(c) &&
1013                               cur.pos() != 0 &&
1014                               cur.pos() != cur.lastpos() &&
1015                               tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
1016                               tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON) &&
1017                             !(isEuropeanNumberTerminator(c) &&
1018                               cur.pos() != 0 &&
1019                               tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
1020                               tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
1021                            )
1022                                 number(cur); // Set current_font.number to OFF
1023                 } else if (isDigitASCII(c) &&
1024                            cur.real_current_font.isVisibleRightToLeft()) {
1025                         number(cur); // Set current_font.number to ON
1026
1027                         if (cur.pos() != 0) {
1028                                 char_type const ch = par.getChar(cur.pos() - 1);
1029                                 if (contains(number_unary_operators, ch) &&
1030                                     (cur.pos() == 1
1031                                      || par.isSeparator(cur.pos() - 2)
1032                                      || par.isEnvSeparator(cur.pos() - 2)
1033                                      || par.isNewline(cur.pos() - 2))
1034                                   ) {
1035                                         setCharFont(pit, cur.pos() - 1, cur.current_font,
1036                                                 tm.font_);
1037                                 } else if (isCommonNumberSeparator(ch)
1038                                      && cur.pos() >= 2
1039                                      && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
1040                                         setCharFont(pit, cur.pos() - 1, cur.current_font,
1041                                                 tm.font_);
1042                                 }
1043                         }
1044                 }
1045         }
1046
1047         // In Bidi text, we want spaces to be treated in a special way: spaces
1048         // which are between words in different languages should get the
1049         // paragraph's language; otherwise, spaces should keep the language
1050         // they were originally typed in. This is only in effect while typing;
1051         // after the text is already typed in, the user can always go back and
1052         // explicitly set the language of a space as desired. But 99.9% of the
1053         // time, what we're doing here is what the user actually meant.
1054         //
1055         // The following cases are the ones in which the language of the space
1056         // should be changed to match that of the containing paragraph. In the
1057         // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
1058         // represents a space, pipe (|) represents the cursor position (so the
1059         // character before it is the one just typed in). The different cases
1060         // are depicted logically (not visually), from left to right:
1061         //
1062         // 1. A_a|
1063         // 2. a_A|
1064         //
1065         // Theoretically, there are other situations that we should, perhaps, deal
1066         // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
1067         // point (to understand why, just try to create this situation...).
1068
1069         if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
1070                 // get font in front and behind the space in question. But do NOT
1071                 // use getFont(cur.pos()) because the character c is not inserted yet
1072                 Font const pre_space_font  = tm.displayFont(cur.pit(), cur.pos() - 2);
1073                 Font const & post_space_font = cur.real_current_font;
1074                 bool pre_space_rtl  = pre_space_font.isVisibleRightToLeft();
1075                 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
1076
1077                 if (pre_space_rtl != post_space_rtl) {
1078                         // Set the space's language to match the language of the
1079                         // adjacent character whose direction is the paragraph's
1080                         // direction; don't touch other properties of the font
1081                         Language const * lang =
1082                                 (pre_space_rtl == par.isRTL(buffer.params())) ?
1083                                 pre_space_font.language() : post_space_font.language();
1084
1085                         Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
1086                         space_font.setLanguage(lang);
1087                         par.setFont(cur.pos() - 1, space_font);
1088                 }
1089         }
1090
1091         pos_type pos = cur.pos();
1092         if (!cur.paragraph().isPassThru() && owner_->lyxCode() != IPA_CODE &&
1093             cur.real_current_font.fontInfo().family() != TYPEWRITER_FAMILY &&
1094             c == '-' && pos > 0) {
1095                 if (par.getChar(pos - 1) == '-') {
1096                         // convert "--" to endash
1097                         par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1098                         c = 0x2013;
1099                         pos--;
1100                 } else if (par.getChar(pos - 1) == 0x2013) {
1101                         // convert "---" to emdash
1102                         par.eraseChar(pos - 1, cur.buffer()->params().track_changes);
1103                         c = 0x2014;
1104                         pos--;
1105                 }
1106         }
1107
1108         par.insertChar(pos, c, cur.current_font,
1109                 cur.buffer()->params().track_changes);
1110         cur.checkBufferStructure();
1111
1112 //              cur.screenUpdateFlags(Update::Force);
1113         bool boundary = cur.boundary()
1114                 || tm.isRTLBoundary(cur.pit(), pos + 1);
1115         setCursor(cur, cur.pit(), pos + 1, false, boundary);
1116         charInserted(cur);
1117 }
1118
1119
1120 void Text::charInserted(Cursor & cur)
1121 {
1122         Paragraph & par = cur.paragraph();
1123
1124         // register word if a non-letter was entered
1125         if (cur.pos() > 1
1126             && !par.isWordSeparator(cur.pos() - 2)
1127             && par.isWordSeparator(cur.pos() - 1)) {
1128                 // get the word in front of cursor
1129                 LBUFERR(this == cur.text());
1130                 par.updateWords();
1131         }
1132 }
1133
1134
1135 // the cursor set functions have a special mechanism. When they
1136 // realize, that you left an empty paragraph, they will delete it.
1137
1138 bool Text::cursorForwardOneWord(Cursor & cur)
1139 {
1140         LBUFERR(this == cur.text());
1141
1142         if (lyxrc.mac_like_cursor_movement) {
1143                 DocIterator dit(cur);
1144                 DocIterator prv(cur);
1145                 bool inword = false;
1146                 bool intext = dit.inTexted();
1147                 while (!dit.atEnd()) {
1148                         if (dit.inTexted()) { // no paragraphs in mathed
1149                                 Paragraph const & par = dit.paragraph();
1150                                 pos_type const pos = dit.pos();
1151
1152                                 if (!par.isDeleted(pos)) {
1153                                         bool wordsep = par.isWordSeparator(pos);
1154                                         if (inword && wordsep)
1155                                                 break; // stop at word end
1156                                         else if (!inword && !wordsep)
1157                                                 inword = true;
1158                                 }
1159                                 intext = true;
1160                         } else if (intext) {
1161                                 // move to end of math
1162                                 while (!dit.inTexted() && !dit.atEnd()) dit.forwardPos();
1163                                 break;
1164                         }
1165                         prv = dit;
1166                         dit.forwardPosIgnoreCollapsed();
1167                 }
1168                 if (dit.atEnd()) dit = prv;
1169                 if (dit == cur) return false; // we didn't move
1170                 Cursor orig(cur);
1171                 cur.setCursor(dit);
1172                 // see comment above
1173                 cur.bv().checkDepm(cur, orig);
1174                 return true;
1175         } else {
1176                 pos_type const lastpos = cur.lastpos();
1177                 pit_type pit = cur.pit();
1178                 pos_type pos = cur.pos();
1179                 Paragraph const & par = cur.paragraph();
1180
1181                 // Paragraph boundary is a word boundary
1182                 if (pos == lastpos || (pos + 1 == lastpos && par.isEnvSeparator(pos))) {
1183                         if (pit != cur.lastpit())
1184                                 return setCursor(cur, pit + 1, 0);
1185                         else
1186                                 return false;
1187                 }
1188
1189                 LASSERT(pos < lastpos, return false); // see above
1190                 if (!par.isWordSeparator(pos))
1191                         while (pos != lastpos && !par.isWordSeparator(pos))
1192                                 ++pos;
1193                 else if (par.isChar(pos))
1194                         while (pos != lastpos && par.isChar(pos))
1195                                 ++pos;
1196                 else if (!par.isSpace(pos)) // non-char inset
1197                         ++pos;
1198
1199                 // Skip over white space
1200                 while (pos != lastpos && par.isSpace(pos))
1201                              ++pos;
1202
1203                 // Don't skip a separator inset at the end of a paragraph
1204                 if (pos == lastpos && pos && par.isEnvSeparator(pos - 1))
1205                         --pos;
1206
1207                 return setCursor(cur, pit, pos);
1208         }
1209 }
1210
1211
1212 bool Text::cursorBackwardOneWord(Cursor & cur)
1213 {
1214         LBUFERR(this == cur.text());
1215
1216         if (lyxrc.mac_like_cursor_movement) {
1217                 DocIterator dit(cur);
1218                 bool inword = false;
1219                 bool intext = dit.inTexted();
1220                 while (!dit.atBegin()) {
1221                         DocIterator prv(dit);
1222                         dit.backwardPosIgnoreCollapsed();
1223                         if (dit.inTexted()) { // no paragraphs in mathed
1224                                 Paragraph const & par = dit.paragraph();
1225                                 pos_type pos = dit.pos();
1226
1227                                 if (!par.isDeleted(pos)) {
1228                                         bool wordsep = par.isWordSeparator(pos);
1229                                         if (inword && wordsep) {
1230                                                 dit = prv;
1231                                                 break; // stop at word begin
1232                                         } else if (!inword && !wordsep)
1233                                                 inword = true;
1234                                 }
1235                                 intext = true;
1236                         } else if (intext) {
1237                                 // move to begin of math
1238                                 while (!dit.inTexted() && !dit.atBegin()) dit.backwardPos();
1239                                 break;
1240                         }
1241                 }
1242                 if (dit == cur) return false; // we didn't move
1243                 Cursor orig(cur);
1244                 cur.setCursor(dit);
1245                 // see comment above cursorForwardOneWord
1246                 cur.bv().checkDepm(cur, orig);
1247                 return true;
1248         } else {
1249                 Paragraph const & par = cur.paragraph();
1250                 pit_type const pit = cur.pit();
1251                 pos_type pos = cur.pos();
1252
1253                 // Paragraph boundary is a word boundary
1254                 if (pos == 0 && pit != 0) {
1255                         Paragraph & prevpar = getPar(pit - 1);
1256                         pos = prevpar.size();
1257                         // Don't stop after an environment separator
1258                         if (pos && prevpar.isEnvSeparator(pos - 1))
1259                                 --pos;
1260                         return setCursor(cur, pit - 1, pos);
1261                 }
1262                 // Skip over white space
1263                 while (pos != 0 && par.isSpace(pos - 1))
1264                         --pos;
1265
1266                 if (pos != 0 && !par.isWordSeparator(pos - 1))
1267                         while (pos != 0 && !par.isWordSeparator(pos - 1))
1268                                 --pos;
1269                 else if (pos != 0 && par.isChar(pos - 1))
1270                         while (pos != 0 && par.isChar(pos - 1))
1271                                 --pos;
1272                 else if (pos != 0 && !par.isSpace(pos - 1)) // non-char inset
1273                         --pos;
1274
1275                 return setCursor(cur, pit, pos);
1276         }
1277 }
1278
1279
1280 bool Text::cursorVisLeftOneWord(Cursor & cur)
1281 {
1282         LBUFERR(this == cur.text());
1283
1284         pos_type left_pos, right_pos;
1285
1286         Cursor temp_cur = cur;
1287
1288         // always try to move at least once...
1289         while (temp_cur.posVisLeft(true /* skip_inset */)) {
1290
1291                 // collect some information about current cursor position
1292                 temp_cur.getSurroundingPos(left_pos, right_pos);
1293                 bool left_is_letter =
1294                         (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1295                 bool right_is_letter =
1296                         (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1297
1298                 // if we're not at a letter/non-letter boundary, continue moving
1299                 if (left_is_letter == right_is_letter)
1300                         continue;
1301
1302                 // we should stop when we have an LTR word on our right or an RTL word
1303                 // on our left
1304                 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1305                                 temp_cur.buffer()->params(), left_pos).isRightToLeft())
1306                         || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1307                                 temp_cur.buffer()->params(), right_pos).isRightToLeft()))
1308                         break;
1309         }
1310
1311         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1312                                          true, temp_cur.boundary());
1313 }
1314
1315
1316 bool Text::cursorVisRightOneWord(Cursor & cur)
1317 {
1318         LBUFERR(this == cur.text());
1319
1320         pos_type left_pos, right_pos;
1321
1322         Cursor temp_cur = cur;
1323
1324         // always try to move at least once...
1325         while (temp_cur.posVisRight(true /* skip_inset */)) {
1326
1327                 // collect some information about current cursor position
1328                 temp_cur.getSurroundingPos(left_pos, right_pos);
1329                 bool left_is_letter =
1330                         (left_pos > -1 ? !temp_cur.paragraph().isWordSeparator(left_pos) : false);
1331                 bool right_is_letter =
1332                         (right_pos > -1 ? !temp_cur.paragraph().isWordSeparator(right_pos) : false);
1333
1334                 // if we're not at a letter/non-letter boundary, continue moving
1335                 if (left_is_letter == right_is_letter)
1336                         continue;
1337
1338                 // we should stop when we have an LTR word on our right or an RTL word
1339                 // on our left
1340                 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
1341                                 temp_cur.buffer()->params(),
1342                                 left_pos).isRightToLeft())
1343                         || (right_is_letter && !temp_cur.paragraph().getFontSettings(
1344                                 temp_cur.buffer()->params(),
1345                                 right_pos).isRightToLeft()))
1346                         break;
1347         }
1348
1349         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
1350                                          true, temp_cur.boundary());
1351 }
1352
1353
1354 void Text::selectWord(Cursor & cur, word_location loc)
1355 {
1356         LBUFERR(this == cur.text());
1357         CursorSlice from = cur.top();
1358         CursorSlice to;
1359         getWord(from, to, loc);
1360         if (cur.top() != from)
1361                 setCursor(cur, from.pit(), from.pos());
1362         if (to == from)
1363                 return;
1364         if (!cur.selection())
1365                 cur.resetAnchor();
1366         setCursor(cur, to.pit(), to.pos());
1367         cur.setSelection();
1368         cur.setWordSelection(true);
1369 }
1370
1371
1372 void Text::selectAll(Cursor & cur)
1373 {
1374         LBUFERR(this == cur.text());
1375         if (cur.lastpos() == 0 && cur.lastpit() == 0)
1376                 return;
1377         // If the cursor is at the beginning, make sure the cursor ends there
1378         if (cur.pit() == 0 && cur.pos() == 0) {
1379                 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1380                 cur.resetAnchor();
1381                 setCursor(cur, 0, 0);
1382         } else {
1383                 setCursor(cur, 0, 0);
1384                 cur.resetAnchor();
1385                 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1386         }
1387         cur.setSelection();
1388 }
1389
1390
1391 // Select the word currently under the cursor when no
1392 // selection is currently set
1393 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
1394 {
1395         LBUFERR(this == cur.text());
1396         if (cur.selection())
1397                 return false;
1398         selectWord(cur, loc);
1399         return cur.selection();
1400 }
1401
1402
1403 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
1404 {
1405         LBUFERR(this == cur.text());
1406
1407         if (!cur.selection()) {
1408                 if (!selectChange(cur))
1409                         return;
1410         }
1411
1412         cur.recordUndoSelection();
1413
1414         pit_type begPit = cur.selectionBegin().pit();
1415         pit_type endPit = cur.selectionEnd().pit();
1416
1417         pos_type begPos = cur.selectionBegin().pos();
1418         pos_type endPos = cur.selectionEnd().pos();
1419
1420         // keep selection info, because endPos becomes invalid after the first loop
1421         bool const endsBeforeEndOfPar = (endPos < pars_[endPit].size());
1422
1423         // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
1424         for (pit_type pit = begPit; pit <= endPit; ++pit) {
1425                 pos_type parSize = pars_[pit].size();
1426
1427                 // ignore empty paragraphs; otherwise, an assertion will fail for
1428                 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
1429                 if (parSize == 0)
1430                         continue;
1431
1432                 // do not consider first paragraph if the cursor starts at pos size()
1433                 if (pit == begPit && begPos == parSize)
1434                         continue;
1435
1436                 // do not consider last paragraph if the cursor ends at pos 0
1437                 if (pit == endPit && endPos == 0)
1438                         break; // last iteration anyway
1439
1440                 pos_type const left  = (pit == begPit ? begPos : 0);
1441                 pos_type const right = (pit == endPit ? endPos : parSize);
1442
1443                 if (left == right)
1444                         // there is no change here
1445                         continue;
1446
1447                 if (op == ACCEPT) {
1448                         pars_[pit].acceptChanges(left, right);
1449                 } else {
1450                         pars_[pit].rejectChanges(left, right);
1451                 }
1452         }
1453
1454         // next, accept/reject imaginary end-of-par characters
1455
1456         for (pit_type pit = begPit; pit <= endPit; ++pit) {
1457                 pos_type pos = pars_[pit].size();
1458
1459                 // skip if the selection ends before the end-of-par
1460                 if (pit == endPit && endsBeforeEndOfPar)
1461                         break; // last iteration anyway
1462
1463                 // skip if this is not the last paragraph of the document
1464                 // note: the user should be able to accept/reject the par break of the last par!
1465                 if (pit == endPit && pit + 1 != int(pars_.size()))
1466                         break; // last iteration anway
1467
1468                 if (op == ACCEPT) {
1469                         if (pars_[pit].isInserted(pos)) {
1470                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1471                         } else if (pars_[pit].isDeleted(pos)) {
1472                                 if (pit + 1 == int(pars_.size())) {
1473                                         // we cannot remove a par break at the end of the last paragraph;
1474                                         // instead, we mark it unchanged
1475                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1476                                 } else {
1477                                         mergeParagraph(cur.buffer()->params(), pars_, pit);
1478                                         --endPit;
1479                                         --pit;
1480                                 }
1481                         }
1482                 } else {
1483                         if (pars_[pit].isDeleted(pos)) {
1484                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1485                         } else if (pars_[pit].isInserted(pos)) {
1486                                 if (pit + 1 == int(pars_.size())) {
1487                                         // we mark the par break at the end of the last paragraph unchanged
1488                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1489                                 } else {
1490                                         mergeParagraph(cur.buffer()->params(), pars_, pit);
1491                                         --endPit;
1492                                         --pit;
1493                                 }
1494                         }
1495                 }
1496         }
1497
1498         // finally, invoke the DEPM
1499         deleteEmptyParagraphMechanism(begPit, endPit, begPos, endPos,
1500                                       cur.buffer()->params().track_changes);
1501
1502         cur.finishUndo();
1503         cur.clearSelection();
1504         setCursorIntern(cur, begPit, begPos);
1505         cur.screenUpdateFlags(Update::Force);
1506         cur.forceBufferUpdate();
1507 }
1508
1509
1510 void Text::acceptChanges()
1511 {
1512         BufferParams const & bparams = owner_->buffer().params();
1513         lyx::acceptChanges(pars_, bparams);
1514         deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.track_changes);
1515 }
1516
1517
1518 void Text::rejectChanges()
1519 {
1520         BufferParams const & bparams = owner_->buffer().params();
1521         pit_type pars_size = static_cast<pit_type>(pars_.size());
1522
1523         // first, reject changes within each individual paragraph
1524         // (do not consider end-of-par)
1525         for (pit_type pit = 0; pit < pars_size; ++pit) {
1526                 if (!pars_[pit].empty())   // prevent assertion failure
1527                         pars_[pit].rejectChanges(0, pars_[pit].size());
1528         }
1529
1530         // next, reject imaginary end-of-par characters
1531         for (pit_type pit = 0; pit < pars_size; ++pit) {
1532                 pos_type pos = pars_[pit].size();
1533
1534                 if (pars_[pit].isDeleted(pos)) {
1535                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1536                 } else if (pars_[pit].isInserted(pos)) {
1537                         if (pit == pars_size - 1) {
1538                                 // we mark the par break at the end of the last
1539                                 // paragraph unchanged
1540                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
1541                         } else {
1542                                 mergeParagraph(bparams, pars_, pit);
1543                                 --pit;
1544                                 --pars_size;
1545                         }
1546                 }
1547         }
1548
1549         // finally, invoke the DEPM
1550         deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.track_changes);
1551 }
1552
1553
1554 void Text::deleteWordForward(Cursor & cur, bool const force)
1555 {
1556         LBUFERR(this == cur.text());
1557         if (cur.lastpos() == 0)
1558                 cursorForward(cur);
1559         else {
1560                 cur.resetAnchor();
1561                 cur.selection(true);
1562                 cursorForwardOneWord(cur);
1563                 cur.setSelection();
1564                 if (force || !cur.confirmDeletion()) {
1565                         cutSelection(cur, false);
1566                         cur.checkBufferStructure();
1567                 }
1568         }
1569 }
1570
1571
1572 void Text::deleteWordBackward(Cursor & cur, bool const force)
1573 {
1574         LBUFERR(this == cur.text());
1575         if (cur.lastpos() == 0)
1576                 cursorBackward(cur);
1577         else {
1578                 cur.resetAnchor();
1579                 cur.selection(true);
1580                 cursorBackwardOneWord(cur);
1581                 cur.setSelection();
1582                 if (force || !cur.confirmDeletion()) {
1583                         cutSelection(cur, false);
1584                         cur.checkBufferStructure();
1585                 }
1586         }
1587 }
1588
1589
1590 // Kill to end of line.
1591 void Text::changeCase(Cursor & cur, TextCase action, bool partial)
1592 {
1593         LBUFERR(this == cur.text());
1594         CursorSlice from;
1595         CursorSlice to;
1596
1597         bool const gotsel = cur.selection();
1598         if (gotsel) {
1599                 from = cur.selBegin();
1600                 to = cur.selEnd();
1601         } else {
1602                 from = cur.top();
1603                 getWord(from, to, partial ? PARTIAL_WORD : WHOLE_WORD);
1604                 cursorForwardOneWord(cur);
1605         }
1606
1607         cur.recordUndoSelection();
1608
1609         pit_type begPit = from.pit();
1610         pit_type endPit = to.pit();
1611
1612         pos_type begPos = from.pos();
1613         pos_type endPos = to.pos();
1614
1615         pos_type right = 0; // needed after the for loop
1616
1617         for (pit_type pit = begPit; pit <= endPit; ++pit) {
1618                 Paragraph & par = pars_[pit];
1619                 pos_type const pos = (pit == begPit ? begPos : 0);
1620                 right = (pit == endPit ? endPos : par.size());
1621                 par.changeCase(cur.buffer()->params(), pos, right, action);
1622         }
1623
1624         // the selection may have changed due to logically-only deleted chars
1625         if (gotsel) {
1626                 setCursor(cur, begPit, begPos);
1627                 cur.resetAnchor();
1628                 setCursor(cur, endPit, right);
1629                 cur.setSelection();
1630         } else
1631                 setCursor(cur, endPit, right);
1632
1633         cur.checkBufferStructure();
1634 }
1635
1636
1637 bool Text::handleBibitems(Cursor & cur)
1638 {
1639         if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
1640                 return false;
1641
1642         if (cur.pos() != 0)
1643                 return false;
1644
1645         BufferParams const & bufparams = cur.buffer()->params();
1646         Paragraph const & par = cur.paragraph();
1647         Cursor prevcur = cur;
1648         if (cur.pit() > 0) {
1649                 --prevcur.pit();
1650                 prevcur.pos() = prevcur.lastpos();
1651         }
1652         Paragraph const & prevpar = prevcur.paragraph();
1653
1654         // if a bibitem is deleted, merge with previous paragraph
1655         // if this is a bibliography item as well
1656         if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
1657                 cur.recordUndo(prevcur.pit());
1658                 mergeParagraph(bufparams, cur.text()->paragraphs(),
1659                                                         prevcur.pit());
1660                 cur.forceBufferUpdate();
1661                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1662                 cur.screenUpdateFlags(Update::Force);
1663                 return true;
1664         }
1665
1666         // otherwise reset to default
1667         cur.paragraph().setPlainOrDefaultLayout(bufparams.documentClass());
1668         return true;
1669 }
1670
1671
1672 bool Text::erase(Cursor & cur)
1673 {
1674         LASSERT(this == cur.text(), return false);
1675         bool needsUpdate = false;
1676         Paragraph & par = cur.paragraph();
1677
1678         if (cur.pos() != cur.lastpos()) {
1679                 // this is the code for a normal delete, not pasting
1680                 // any paragraphs
1681                 cur.recordUndo(DELETE_UNDO);
1682                 bool const was_inset = cur.paragraph().isInset(cur.pos());
1683                 if(!par.eraseChar(cur.pos(), cur.buffer()->params().track_changes))
1684                         // the character has been logically deleted only => skip it
1685                         cur.top().forwardPos();
1686
1687                 if (was_inset)
1688                         cur.forceBufferUpdate();
1689                 else
1690                         cur.checkBufferStructure();
1691                 needsUpdate = true;
1692         } else {
1693                 if (cur.pit() == cur.lastpit())
1694                         return dissolveInset(cur);
1695
1696                 if (!par.isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1697                         cur.recordUndo(DELETE_UNDO);
1698                         par.setChange(cur.pos(), Change(Change::DELETED));
1699                         cur.forwardPos();
1700                         needsUpdate = true;
1701                 } else {
1702                         setCursorIntern(cur, cur.pit() + 1, 0);
1703                         needsUpdate = backspacePos0(cur);
1704                 }
1705         }
1706
1707         needsUpdate |= handleBibitems(cur);
1708
1709         if (needsUpdate) {
1710                 // Make sure the cursor is correct. Is this really needed?
1711                 // No, not really... at least not here!
1712                 cur.top().setPitPos(cur.pit(), cur.pos());
1713                 cur.checkBufferStructure();
1714         }
1715
1716         return needsUpdate;
1717 }
1718
1719
1720 bool Text::backspacePos0(Cursor & cur)
1721 {
1722         LBUFERR(this == cur.text());
1723         if (cur.pit() == 0)
1724                 return false;
1725
1726         BufferParams const & bufparams = cur.buffer()->params();
1727         ParagraphList & plist = cur.text()->paragraphs();
1728         Paragraph const & par = cur.paragraph();
1729         Cursor prevcur = cur;
1730         --prevcur.pit();
1731         prevcur.pos() = prevcur.lastpos();
1732         Paragraph const & prevpar = prevcur.paragraph();
1733
1734         // is it an empty paragraph?
1735         if (cur.lastpos() == 0
1736             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1737                 cur.recordUndo(prevcur.pit());
1738                 plist.erase(plist.iterator_at(cur.pit()));
1739         }
1740         // is previous par empty?
1741         else if (prevcur.lastpos() == 0
1742                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1743                 cur.recordUndo(prevcur.pit());
1744                 plist.erase(plist.iterator_at(prevcur.pit()));
1745         }
1746         // FIXME: Do we really not want to allow this???
1747         // Pasting is not allowed, if the paragraphs have different
1748         // layouts. I think it is a real bug of all other
1749         // word processors to allow it. It confuses the user.
1750         // Correction: Pasting is always allowed with standard-layout
1751         // or the empty layout.
1752         else {
1753                 cur.recordUndo(prevcur.pit());
1754                 mergeParagraph(bufparams, plist, prevcur.pit());
1755         }
1756
1757         cur.forceBufferUpdate();
1758         setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1759
1760         return true;
1761 }
1762
1763
1764 bool Text::backspace(Cursor & cur)
1765 {
1766         LBUFERR(this == cur.text());
1767         bool needsUpdate = false;
1768         if (cur.pos() == 0) {
1769                 if (cur.pit() == 0)
1770                         return dissolveInset(cur);
1771
1772                 Cursor prev_cur = cur;
1773                 --prev_cur.pit();
1774
1775                 if (!cur.paragraph().empty()
1776                     && !prev_cur.paragraph().isMergedOnEndOfParDeletion(cur.buffer()->params().track_changes)) {
1777                         cur.recordUndo(prev_cur.pit(), prev_cur.pit());
1778                         prev_cur.paragraph().setChange(prev_cur.lastpos(), Change(Change::DELETED));
1779                         setCursorIntern(cur, prev_cur.pit(), prev_cur.lastpos());
1780                         return true;
1781                 }
1782                 // The cursor is at the beginning of a paragraph, so
1783                 // the backspace will collapse two paragraphs into one.
1784                 needsUpdate = backspacePos0(cur);
1785
1786         } else {
1787                 // this is the code for a normal backspace, not pasting
1788                 // any paragraphs
1789                 cur.recordUndo(DELETE_UNDO);
1790                 // We used to do cursorBackwardIntern() here, but it is
1791                 // not a good idea since it triggers the auto-delete
1792                 // mechanism. So we do a cursorBackwardIntern()-lite,
1793                 // without the dreaded mechanism. (JMarc)
1794                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1795                                 false, cur.boundary());
1796                 bool const was_inset = cur.paragraph().isInset(cur.pos());
1797                 cur.paragraph().eraseChar(cur.pos(), cur.buffer()->params().track_changes);
1798                 if (was_inset)
1799                         cur.forceBufferUpdate();
1800                 else
1801                         cur.checkBufferStructure();
1802         }
1803
1804         if (cur.pos() == cur.lastpos())
1805                 cur.setCurrentFont();
1806
1807         needsUpdate |= handleBibitems(cur);
1808
1809         // A singlePar update is not enough in this case.
1810         // cur.screenUpdateFlags(Update::Force);
1811         cur.top().setPitPos(cur.pit(), cur.pos());
1812
1813         return needsUpdate;
1814 }
1815
1816
1817 bool Text::dissolveInset(Cursor & cur)
1818 {
1819         LASSERT(this == cur.text(), return false);
1820
1821         if (isMainText() || cur.inset().nargs() != 1)
1822                 return false;
1823
1824         cur.recordUndoInset();
1825         cur.setMark(false);
1826         cur.selHandle(false);
1827         // save position inside inset
1828         pos_type spos = cur.pos();
1829         pit_type spit = cur.pit();
1830         bool const inset_non_empty = cur.lastpit() != 0 || cur.lastpos() != 0;
1831         cur.popBackward();
1832         // update cursor offset
1833         if (spit == 0)
1834                 spos += cur.pos();
1835         spit += cur.pit();
1836         // remember position outside inset to delete inset later
1837         // we do not do it now to avoid memory reuse issues (see #10667).
1838         DocIterator inset_it = cur;
1839         // jump over inset
1840         ++cur.pos();
1841
1842         Buffer & b = *cur.buffer();
1843         // Is there anything in this text?
1844         if (inset_non_empty) {
1845                 // see bug 7319
1846                 // we clear the cache so that we won't get conflicts with labels
1847                 // that get pasted into the buffer. we should update this before
1848                 // its being empty matters. if not (i.e., if we encounter bugs),
1849                 // then this should instead be:
1850                 //        cur.buffer().updateBuffer();
1851                 // but we'll try the cheaper solution here.
1852                 cur.buffer()->clearReferenceCache();
1853
1854                 ParagraphList & plist = paragraphs();
1855                 if (!lyxrc.ct_markup_copied)
1856                         // Do not revive deleted text
1857                         lyx::acceptChanges(plist, b.params());
1858
1859                 // ERT paragraphs have the Language latex_language.
1860                 // This is invalid outside of ERT, so we need to
1861                 // change it to the buffer language.
1862                 for (auto & p : plist)
1863                         p.changeLanguage(b.params(), latex_language, b.language());
1864
1865                 /* If the inset is the only thing in paragraph and the layout
1866                  * is not plain, then the layout of the first paragraph of
1867                  * inset should be remembered.
1868                  * FIXME: this does not work as expected when change tracking
1869                  *   is on However, we do not really know what to do in this
1870                  *   case.
1871                  */
1872                 DocumentClass const & tclass = cur.buffer()->params().documentClass();
1873                 if (inset_it.lastpos() == 1
1874                     && !tclass.isPlainLayout(plist[0].layout())
1875                     && !tclass.isDefaultLayout(plist[0].layout())) {
1876                         // Copy all parameters except depth.
1877                         Paragraph & par = cur.paragraph();
1878                         par.setLayout(plist[0].layout());
1879                         depth_type const dpth = par.getDepth();
1880                         par.params() = plist[0].params();
1881                         par.params().depth(dpth);
1882                 }
1883
1884                 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1885                                    b.params().authors(),
1886                                    b.errorList("Paste"));
1887         }
1888
1889         // delete the inset now
1890         inset_it.paragraph().eraseChar(inset_it.pos(), b.params().track_changes);
1891
1892         // restore position
1893         cur.pit() = min(cur.lastpit(), spit);
1894         cur.pos() = min(cur.lastpos(), spos);
1895         // Ensure the current language is set correctly (bug 6292)
1896         cur.text()->setCursor(cur, cur.pit(), cur.pos());
1897         cur.clearSelection();
1898         cur.resetAnchor();
1899         cur.forceBufferUpdate();
1900
1901         return true;
1902 }
1903
1904
1905 bool Text::splitInset(Cursor & cur)
1906 {
1907         LASSERT(this == cur.text(), return false);
1908
1909         if (isMainText() || cur.inset().nargs() != 1)
1910                 return false;
1911
1912         cur.recordUndo();
1913         if (cur.selection()) {
1914                 // start from selection begin
1915                 setCursor(cur, cur.selBegin().pit(), cur.selBegin().pos());
1916                 cur.clearSelection();
1917         }
1918         // save split position inside inset
1919         // (we need to copy the whole inset first)
1920         pos_type spos = cur.pos();
1921         pit_type spit = cur.pit();
1922         // some things only need to be done if the inset has content
1923         bool const inset_non_empty = cur.lastpit() != 0 || cur.lastpos() != 0;
1924
1925         // move right before the inset
1926         cur.popBackward();
1927         cur.resetAnchor();
1928         // remember position outside inset
1929         pos_type ipos = cur.pos();
1930         pit_type ipit = cur.pit();
1931         // select inset ...
1932         ++cur.pos();
1933         cur.setSelection();
1934         // ... and copy
1935         cap::copySelectionToTemp(cur);
1936         cur.clearSelection();
1937         cur.resetAnchor();
1938         // paste copied inset
1939         cap::pasteFromTemp(cur, cur.buffer()->errorList("Paste"));
1940         cur.forceBufferUpdate();
1941
1942         // if the inset has text, cut after split position
1943         // and paste to new inset
1944         if (inset_non_empty) {
1945                 // go back to first inset
1946                 cur.text()->setCursor(cur, ipit, ipos);
1947                 cur.forwardPos();
1948                 setCursor(cur, spit, spos);
1949                 cur.resetAnchor();
1950                 setCursor(cur, cur.lastpit(), getPar(cur.lastpit()).size());
1951                 cur.setSelection();
1952                 cap::cutSelectionToTemp(cur);
1953                 cur.setMark(false);
1954                 cur.selHandle(false);
1955                 cur.resetAnchor();
1956                 bool atlastpos = false;
1957                 if (cur.pos() == 0 && cur.pit() > 0) {
1958                         // if we are at par start, remove this par
1959                         cur.text()->backspace(cur);
1960                         cur.forceBufferUpdate();
1961                 } else if (cur.pos() == cur.lastpos())
1962                         atlastpos = true;
1963                 // Move out of and jump over inset
1964                 cur.popBackward();
1965                 ++cur.pos();
1966
1967                 // enter new inset
1968                 cur.forwardPos();
1969                 cur.setCursor(cur);
1970                 cur.resetAnchor();
1971                 cur.text()->selectAll(cur);
1972                 cutSelection(cur, false);
1973                 cap::pasteFromTemp(cur, cur.buffer()->errorList("Paste"));
1974                 cur.text()->setCursor(cur, 0, 0);
1975                 if (atlastpos && cur.paragraph().isFreeSpacing() && cur.paragraph().empty()) {
1976                         // We started from par end, remove extra empty par in free spacing insets
1977                         cur.text()->erase(cur);
1978                         cur.forceBufferUpdate();
1979                 }
1980         }
1981
1982         cur.finishUndo();
1983         return true;
1984 }
1985
1986
1987 void Text::getWord(CursorSlice & from, CursorSlice & to,
1988         word_location const loc) const
1989 {
1990         to = from;
1991         pars_[to.pit()].locateWord(from.pos(), to.pos(), loc);
1992 }
1993
1994
1995 void Text::write(ostream & os) const
1996 {
1997         Buffer const & buf = owner_->buffer();
1998         ParagraphList::const_iterator pit = paragraphs().begin();
1999         ParagraphList::const_iterator end = paragraphs().end();
2000         depth_type dth = 0;
2001         for (; pit != end; ++pit)
2002                 pit->write(os, buf.params(), dth);
2003
2004         // Close begin_deeper
2005         for(; dth > 0; --dth)
2006                 os << "\n\\end_deeper";
2007 }
2008
2009
2010 bool Text::read(Lexer & lex,
2011                 ErrorList & errorList, InsetText * insetPtr)
2012 {
2013         Buffer const & buf = owner_->buffer();
2014         depth_type depth = 0;
2015         bool res = true;
2016
2017         while (lex.isOK()) {
2018                 lex.nextToken();
2019                 string const token = lex.getString();
2020
2021                 if (token.empty())
2022                         continue;
2023
2024                 if (token == "\\end_inset")
2025                         break;
2026
2027                 if (token == "\\end_body")
2028                         continue;
2029
2030                 if (token == "\\begin_body")
2031                         continue;
2032
2033                 if (token == "\\end_document") {
2034                         res = false;
2035                         break;
2036                 }
2037
2038                 if (token == "\\begin_layout") {
2039                         lex.pushToken(token);
2040
2041                         Paragraph par;
2042                         par.setInsetOwner(insetPtr);
2043                         par.params().depth(depth);
2044                         par.setFont(0, Font(inherit_font, buf.params().language));
2045                         pars_.push_back(par);
2046                         readParagraph(pars_.back(), lex, errorList);
2047
2048                         // register the words in the global word list
2049                         pars_.back().updateWords();
2050                 } else if (token == "\\begin_deeper") {
2051                         ++depth;
2052                 } else if (token == "\\end_deeper") {
2053                         if (!depth)
2054                                 lex.printError("\\end_deeper: " "depth is already null");
2055                         else
2056                                 --depth;
2057                 } else {
2058                         LYXERR0("Handling unknown body token: `" << token << '\'');
2059                 }
2060         }
2061
2062         // avoid a crash on weird documents (bug 4859)
2063         if (pars_.empty()) {
2064                 Paragraph par;
2065                 par.setInsetOwner(insetPtr);
2066                 par.params().depth(depth);
2067                 par.setFont(0, Font(inherit_font,
2068                                     buf.params().language));
2069                 par.setPlainOrDefaultLayout(buf.params().documentClass());
2070                 pars_.push_back(par);
2071         }
2072
2073         return res;
2074 }
2075
2076
2077 // Returns the current state (font, depth etc.) as a message for status bar.
2078 docstring Text::currentState(CursorData const & cur, bool devel_mode) const
2079 {
2080         LBUFERR(this == cur.text());
2081         Buffer & buf = *cur.buffer();
2082         Paragraph const & par = cur.paragraph();
2083         odocstringstream os;
2084
2085         if (buf.params().track_changes)
2086                 os << _("[Change Tracking] ");
2087
2088         Change change = par.lookupChange(cur.pos());
2089
2090         if (change.changed()) {
2091                 docstring const author =
2092                         buf.params().authors().get(change.author).nameAndEmail();
2093                 docstring const date = formatted_datetime(change.changetime);
2094                 os << bformat(_("Changed by %1$s[[author]] on %2$s[[date]]. "),
2095                               author, date);
2096         }
2097
2098         // I think we should only show changes from the default
2099         // font. (Asger)
2100         // No, from the document font (MV)
2101         Font font = cur.real_current_font;
2102         font.fontInfo().reduce(buf.params().getFont().fontInfo());
2103
2104         os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
2105
2106         // The paragraph depth
2107         int depth = par.getDepth();
2108         if (depth > 0)
2109                 os << bformat(_(", Depth: %1$d"), depth);
2110
2111         // The paragraph spacing, but only if different from
2112         // buffer spacing.
2113         Spacing const & spacing = par.params().spacing();
2114         if (!spacing.isDefault()) {
2115                 os << _(", Spacing: ");
2116                 switch (spacing.getSpace()) {
2117                 case Spacing::Single:
2118                         os << _("Single");
2119                         break;
2120                 case Spacing::Onehalf:
2121                         os << _("OneHalf");
2122                         break;
2123                 case Spacing::Double:
2124                         os << _("Double");
2125                         break;
2126                 case Spacing::Other:
2127                         os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
2128                         break;
2129                 case Spacing::Default:
2130                         // should never happen, do nothing
2131                         break;
2132                 }
2133         }
2134
2135         // Custom text style
2136         InsetLayout const & layout = cur.inset().getLayout();
2137         if (layout.lyxtype() == InsetLyXType::CHARSTYLE)
2138                 os << _(", Style: ") << translateIfPossible(layout.labelstring());
2139
2140         if (devel_mode) {
2141                 os << _(", Inset: ") << &cur.inset();
2142                 if (cur.lastidx() > 0)
2143                         os << _(", Cell: ") << cur.idx();
2144                 os << _(", Paragraph: ") << cur.pit();
2145                 os << _(", Id: ") << par.id();
2146                 os << _(", Position: ") << cur.pos();
2147                 // FIXME: Why is the check for par.size() needed?
2148                 // We are called with cur.pos() == par.size() quite often.
2149                 if (!par.empty() && cur.pos() < par.size()) {
2150                         // Force output of code point, not character
2151                         size_t const c = par.getChar(cur.pos());
2152                         os << _(", Char: 0x") << hex << c;
2153                 }
2154                 os << _(", Boundary: ") << cur.boundary();
2155 //              Row & row = cur.textRow();
2156 //              os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
2157         }
2158         return os.str();
2159 }
2160
2161
2162 docstring Text::getPossibleLabel(DocIterator const & cur) const
2163 {
2164         pit_type textpit = cur.pit();
2165         Layout const * layout = &(pars_[textpit].layout());
2166
2167         // Will contain the label prefix.
2168         docstring name;
2169
2170         // For captions, we just take the caption type
2171         Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
2172         if (caption_inset) {
2173                 string const & ftype = static_cast<InsetCaption *>(caption_inset)->floattype();
2174                 FloatList const & fl = cur.buffer()->params().documentClass().floats();
2175                 if (fl.typeExist(ftype)) {
2176                         Floating const & flt = fl.getType(ftype);
2177                         name = from_utf8(flt.refPrefix());
2178                 }
2179                 if (name.empty())
2180                         name = from_utf8(ftype.substr(0,3));
2181         } else {
2182                 // For section, subsection, etc...
2183                 if (layout->latextype == LATEX_PARAGRAPH && textpit != 0) {
2184                         Layout const * layout2 = &(pars_[textpit - 1].layout());
2185                         if (layout2->latextype != LATEX_PARAGRAPH) {
2186                                 --textpit;
2187                                 layout = layout2;
2188                         }
2189                 }
2190                 if (layout->latextype != LATEX_PARAGRAPH)
2191                         name = layout->refprefix;
2192
2193                 // If none of the above worked, see if the inset knows.
2194                 if (name.empty()) {
2195                         InsetLayout const & il = cur.inset().getLayout();
2196                         name = il.refprefix();
2197                 }
2198         }
2199
2200         docstring text;
2201         docstring par_text = pars_[textpit].asString(AS_STR_SKIPDELETE);
2202
2203         // The return string of math matrices might contain linebreaks
2204         par_text = subst(par_text, '\n', '-');
2205         int const numwords = 3;
2206         for (int i = 0; i < numwords; ++i) {
2207                 if (par_text.empty())
2208                         break;
2209                 docstring head;
2210                 par_text = split(par_text, head, ' ');
2211                 // Is it legal to use spaces in labels ?
2212                 if (i > 0)
2213                         text += '-';
2214                 text += head;
2215         }
2216
2217         // Make sure it isn't too long
2218         unsigned int const max_label_length = 32;
2219         if (text.size() > max_label_length)
2220                 text.resize(max_label_length);
2221
2222         if (!name.empty())
2223                 text = name + ':' + text;
2224
2225         // We need a unique label
2226         docstring label = text;
2227         int i = 1;
2228         while (cur.buffer()->activeLabel(label)) {
2229                         label = text + '-' + convert<docstring>(i);
2230                         ++i;
2231                 }
2232
2233         return label;
2234 }
2235
2236
2237 docstring Text::asString(int options) const
2238 {
2239         return asString(0, pars_.size(), options);
2240 }
2241
2242
2243 docstring Text::asString(pit_type beg, pit_type end, int options) const
2244 {
2245         size_t i = size_t(beg);
2246         docstring str = pars_[i].asString(options);
2247         for (++i; i != size_t(end); ++i) {
2248                 str += '\n';
2249                 str += pars_[i].asString(options);
2250         }
2251         return str;
2252 }
2253
2254
2255 void Text::shortenForOutliner(docstring & str, size_t const maxlen)
2256 {
2257         support::truncateWithEllipsis(str, maxlen);
2258         for (char_type & c : str)
2259                 if (c == L'\n' || c == L'\t')
2260                         c = L' ';
2261 }
2262
2263
2264 void Text::forOutliner(docstring & os, size_t const maxlen,
2265                        bool const shorten) const
2266 {
2267         pit_type end = pars_.size() - 1;
2268         if (0 <= end && !pars_[0].labelString().empty())
2269                 os += pars_[0].labelString() + ' ';
2270         forOutliner(os, maxlen, 0, end, shorten);
2271 }
2272
2273
2274 void Text::forOutliner(docstring & os, size_t const maxlen,
2275                        pit_type pit_start, pit_type pit_end,
2276                        bool const shorten) const
2277 {
2278         size_t tmplen = shorten ? maxlen + 1 : maxlen;
2279         pit_type end = min(size_t(pit_end), pars_.size() - 1);
2280         bool first = true;
2281         for (pit_type i = pit_start; i <= end && os.length() < tmplen; ++i) {
2282                 if (!first)
2283                         os += ' ';
2284                 // This function lets the first label be treated separately
2285                 pars_[i].forOutliner(os, tmplen, false, !first);
2286                 first = false;
2287         }
2288         if (shorten)
2289                 shortenForOutliner(os, maxlen);
2290 }
2291
2292
2293 void Text::charsTranspose(Cursor & cur)
2294 {
2295         LBUFERR(this == cur.text());
2296
2297         pos_type pos = cur.pos();
2298
2299         // If cursor is at beginning or end of paragraph, do nothing.
2300         if (pos == cur.lastpos() || pos == 0)
2301                 return;
2302
2303         Paragraph & par = cur.paragraph();
2304
2305         // Get the positions of the characters to be transposed.
2306         pos_type pos1 = pos - 1;
2307         pos_type pos2 = pos;
2308
2309         // In change tracking mode, ignore deleted characters.
2310         while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2311                 ++pos2;
2312         if (pos2 == cur.lastpos())
2313                 return;
2314
2315         while (pos1 >= 0 && par.isDeleted(pos1))
2316                 --pos1;
2317         if (pos1 < 0)
2318                 return;
2319
2320         // Don't do anything if one of the "characters" is not regular text.
2321         if (par.isInset(pos1) || par.isInset(pos2))
2322                 return;
2323
2324         // Store the characters to be transposed (including font information).
2325         char_type const char1 = par.getChar(pos1);
2326         Font const font1 =
2327                 par.getFontSettings(cur.buffer()->params(), pos1);
2328
2329         char_type const char2 = par.getChar(pos2);
2330         Font const font2 =
2331                 par.getFontSettings(cur.buffer()->params(), pos2);
2332
2333         // And finally, we are ready to perform the transposition.
2334         // Track the changes if Change Tracking is enabled.
2335         bool const trackChanges = cur.buffer()->params().track_changes;
2336
2337         cur.recordUndo();
2338
2339         par.eraseChar(pos2, trackChanges);
2340         par.eraseChar(pos1, trackChanges);
2341         par.insertChar(pos1, char2, font2, trackChanges);
2342         par.insertChar(pos2, char1, font1, trackChanges);
2343
2344         cur.checkBufferStructure();
2345
2346         // After the transposition, move cursor to after the transposition.
2347         setCursor(cur, cur.pit(), pos2);
2348         cur.forwardPos();
2349 }
2350
2351
2352 DocIterator Text::macrocontextPosition() const
2353 {
2354         return macrocontext_position_;
2355 }
2356
2357
2358 void Text::setMacrocontextPosition(DocIterator const & pos)
2359 {
2360         macrocontext_position_ = pos;
2361 }
2362
2363
2364 bool Text::completionSupported(Cursor const & cur) const
2365 {
2366         Paragraph const & par = cur.paragraph();
2367         return !cur.selection()
2368                 && cur.pos() > 0
2369                 && (cur.pos() >= par.size() || par.isWordSeparator(cur.pos()))
2370                 && !par.isWordSeparator(cur.pos() - 1);
2371 }
2372
2373
2374 CompletionList const * Text::createCompletionList(Cursor const & cur) const
2375 {
2376         WordList const & list = theWordList(cur.getFont().language()->lang());
2377         return new TextCompletionList(cur, list);
2378 }
2379
2380
2381 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
2382 {
2383         LBUFERR(cur.bv().cursor() == cur);
2384         cur.insert(s);
2385         cur.bv().cursor() = cur;
2386         if (!(cur.result().screenUpdate() & Update::Force))
2387                 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
2388         return true;
2389 }
2390
2391
2392 docstring Text::completionPrefix(Cursor const & cur) const
2393 {
2394         CursorSlice from = cur.top();
2395         CursorSlice to = from;
2396         getWord(from, to, PREVIOUS_WORD);
2397
2398         return cur.paragraph().asString(from.pos(), to.pos());
2399 }
2400
2401 } // namespace lyx