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