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