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