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 "Language.h"
  38 #include "Length.h"
  39 #include "Lexer.h"
  40 #include "LyXRC.h"
  41 #include "Paragraph.h"
  42 #include "paragraph_funcs.h"
  43 #include "ParagraphParameters.h"
  44 #include "ParIterator.h"
  45 #include "TextClass.h"
  46 #include "TextMetrics.h"
  47 #include "VSpace.h"
  48 #include "WordLangTuple.h"
  49 #include "WordList.h"
  50
  51 #include "insets/InsetText.h"
  52 #include "insets/InsetBibitem.h"
  53 #include "insets/InsetCaption.h"
  54 #include "insets/InsetLine.h"
  55 #include "insets/InsetNewline.h"
  56 #include "insets/InsetNewpage.h"
  57 #include "insets/InsetOptArg.h"
  58 #include "insets/InsetSpace.h"
  59 #include "insets/InsetSpecialChar.h"
  60 #include "insets/InsetTabular.h"
  61
  62 #include "support/lassert.h"
  63 #include "support/convert.h"
  64 #include "support/debug.h"
  65 #include "support/docstream.h"
  66 #include "support/gettext.h"
  67 #include "support/lstrings.h"
  68 #include "support/textutils.h"
  69
  70 #include <boost/next_prior.hpp>
  71
  72 #include <sstream>
  73
  74 using namespace std;
  75 using namespace lyx::support;
  76
  77 namespace lyx {
  78
  79 using cap::cutSelection;
  80 using cap::pasteParagraphList;
  81
  82 namespace {
  83
  84 void readParToken(Buffer const & buf, Paragraph & par, Lexer & lex,
  85         string const & token, Font & font, Change & change, ErrorList & errorList)
  86 {
  87         BufferParams const & bp = buf.params();
  88
  89         if (token[0] != '\\') {
  90                 docstring dstr = lex.getDocString();
  91                 par.appendString(dstr, font, change);
  92
  93         } else if (token == "\\begin_layout") {
  94                 lex.eatLine();
  95                 docstring layoutname = lex.getDocString();
  96
  97                 font = Font(inherit_font, bp.language);
  98                 change = Change(Change::UNCHANGED);
  99
 100                 DocumentClass const & tclass = bp.documentClass();
 101
 102                 if (layoutname.empty())
 103                         layoutname = tclass.defaultLayoutName();
 104
 105                 if (par.forceEmptyLayout()) {
 106                         // in this case only the empty layout is allowed
 107                         layoutname = tclass.emptyLayoutName();
 108                 } else if (par.useEmptyLayout()) {
 109                         // in this case, default layout maps to empty layout
 110                         if (layoutname == tclass.defaultLayoutName())
 111                                 layoutname = tclass.emptyLayoutName();
 112                 } else {
 113                         // otherwise, the empty layout maps to the default
 114                         if (layoutname == tclass.emptyLayoutName())
 115                                 layoutname = tclass.defaultLayoutName();
 116                 }
 117
 118                 bool hasLayout = tclass.hasLayout(layoutname);
 119
 120                 if (!hasLayout) {
 121                         errorList.push_back(ErrorItem(_("Unknown layout"),
 122                         bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
 123                         layoutname, from_utf8(tclass.name())), par.id(), 0, par.size()));
 124                         layoutname = par.useEmptyLayout() ?
 125                                         tclass.emptyLayoutName() :
 126                                         tclass.defaultLayoutName();
 127                 }
 128
 129                 par.setLayout(bp.documentClass()[layoutname]);
 130
 131                 // Test whether the layout is obsolete.
 132                 Layout const & layout = par.layout();
 133                 if (!layout.obsoleted_by().empty())
 134                         par.setLayout(bp.documentClass()[layout.obsoleted_by()]);
 135
 136                 par.params().read(lex);
 137
 138         } else if (token == "\\end_layout") {
 139                 LYXERR0("Solitary \\end_layout in line " << lex.lineNumber() << "\n"
 140                        << "Missing \\begin_layout ?");
 141         } else if (token == "\\end_inset") {
 142                 LYXERR0("Solitary \\end_inset in line " << lex.lineNumber() << "\n"
 143                        << "Missing \\begin_inset ?");
 144         } else if (token == "\\begin_inset") {
 145                 Inset * inset = readInset(lex, buf);
 146                 if (inset)
 147                         par.insertInset(par.size(), inset, font, change);
 148                 else {
 149                         lex.eatLine();
 150                         docstring line = lex.getDocString();
 151                         errorList.push_back(ErrorItem(_("Unknown Inset"), line,
 152                                             par.id(), 0, par.size()));
 153                 }
 154         } else if (token == "\\family") {
 155                 lex.next();
 156                 setLyXFamily(lex.getString(), font.fontInfo());
 157         } else if (token == "\\series") {
 158                 lex.next();
 159                 setLyXSeries(lex.getString(), font.fontInfo());
 160         } else if (token == "\\shape") {
 161                 lex.next();
 162                 setLyXShape(lex.getString(), font.fontInfo());
 163         } else if (token == "\\size") {
 164                 lex.next();
 165                 setLyXSize(lex.getString(), font.fontInfo());
 166         } else if (token == "\\lang") {
 167                 lex.next();
 168                 string const tok = lex.getString();
 169                 Language const * lang = languages.getLanguage(tok);
 170                 if (lang) {
 171                         font.setLanguage(lang);
 172                 } else {
 173                         font.setLanguage(bp.language);
 174                         lex.printError("Unknown language `$$Token'");
 175                 }
 176         } else if (token == "\\numeric") {
 177                 lex.next();
 178                 font.fontInfo().setNumber(font.setLyXMisc(lex.getString()));
 179         } else if (token == "\\emph") {
 180                 lex.next();
 181                 font.fontInfo().setEmph(font.setLyXMisc(lex.getString()));
 182         } else if (token == "\\bar") {
 183                 lex.next();
 184                 string const tok = lex.getString();
 185
 186                 if (tok == "under")
 187                         font.fontInfo().setUnderbar(FONT_ON);
 188                 else if (tok == "no")
 189                         font.fontInfo().setUnderbar(FONT_OFF);
 190                 else if (tok == "default")
 191                         font.fontInfo().setUnderbar(FONT_INHERIT);
 192                 else
 193                         lex.printError("Unknown bar font flag "
 194                                        "`$$Token'");
 195         } else if (token == "\\noun") {
 196                 lex.next();
 197                 font.fontInfo().setNoun(font.setLyXMisc(lex.getString()));
 198         } else if (token == "\\color") {
 199                 lex.next();
 200                 setLyXColor(lex.getString(), font.fontInfo());
 201         } else if (token == "\\SpecialChar") {
 202                         auto_ptr<Inset> inset;
 203                         inset.reset(new InsetSpecialChar);
 204                         inset->read(lex);
 205                         par.insertInset(par.size(), inset.release(),
 206                                         font, change);
 207         } else if (token == "\\backslash") {
 208                 par.appendChar('\\', font, change);
 209         } else if (token == "\\LyXTable") {
 210                 auto_ptr<Inset> inset(new InsetTabular(buf));
 211                 inset->read(lex);
 212                 par.insertInset(par.size(), inset.release(), font, change);
 213         } else if (token == "\\lyxline") {
 214                 par.insertInset(par.size(), new InsetLine, font, change);
 215         } else if (token == "\\change_unchanged") {
 216                 change = Change(Change::UNCHANGED);
 217         } else if (token == "\\change_inserted") {
 218                 lex.eatLine();
 219                 istringstream is(lex.getString());
 220                 unsigned int aid;
 221                 time_t ct;
 222                 is >> aid >> ct;
 223                 if (aid >= bp.author_map.size()) {
 224                         errorList.push_back(ErrorItem(_("Change tracking error"),
 225                                             bformat(_("Unknown author index for insertion: %1$d\n"), aid),
 226                                             par.id(), 0, par.size()));
 227                         change = Change(Change::UNCHANGED);
 228                 } else
 229                         change = Change(Change::INSERTED, bp.author_map[aid], ct);
 230         } else if (token == "\\change_deleted") {
 231                 lex.eatLine();
 232                 istringstream is(lex.getString());
 233                 unsigned int aid;
 234                 time_t ct;
 235                 is >> aid >> ct;
 236                 if (aid >= bp.author_map.size()) {
 237                         errorList.push_back(ErrorItem(_("Change tracking error"),
 238                                             bformat(_("Unknown author index for deletion: %1$d\n"), aid),
 239                                             par.id(), 0, par.size()));
 240                         change = Change(Change::UNCHANGED);
 241                 } else
 242                         change = Change(Change::DELETED, bp.author_map[aid], ct);
 243         } else {
 244                 lex.eatLine();
 245                 errorList.push_back(ErrorItem(_("Unknown token"),
 246                         bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
 247                         lex.getDocString()),
 248                         par.id(), 0, par.size()));
 249         }
 250 }
 251
 252
 253 void readParagraph(Buffer const & buf, Paragraph & par, Lexer & lex,
 254         ErrorList & errorList)
 255 {
 256         lex.nextToken();
 257         string token = lex.getString();
 258         Font font;
 259         Change change(Change::UNCHANGED);
 260
 261         while (lex.isOK()) {
 262                 readParToken(buf, par, lex, token, font, change, errorList);
 263
 264                 lex.nextToken();
 265                 token = lex.getString();
 266
 267                 if (token.empty())
 268                         continue;
 269
 270                 if (token == "\\end_layout") {
 271                         //Ok, paragraph finished
 272                         break;
 273                 }
 274
 275                 LYXERR(Debug::PARSER, "Handling paragraph token: `" << token << '\'');
 276                 if (token == "\\begin_layout" || token == "\\end_document"
 277                     || token == "\\end_inset" || token == "\\begin_deeper"
 278                     || token == "\\end_deeper") {
 279                         lex.pushToken(token);
 280                         lyxerr << "Paragraph ended in line "
 281                                << lex.lineNumber() << "\n"
 282                                << "Missing \\end_layout.\n";
 283                         break;
 284                 }
 285         }
 286         // Final change goes to paragraph break:
 287         par.setChange(par.size(), change);
 288
 289         // Initialize begin_of_body_ on load; redoParagraph maintains
 290         par.setBeginOfBody();
 291 }
 292
 293
 294 } // namespace anon
 295
 296 class TextCompletionList : public CompletionList
 297 {
 298 public:
 299         ///
 300         TextCompletionList(Cursor const & cur)
 301         : buf_(cur.buffer()), pos_(0) {}
 302         ///
 303         virtual ~TextCompletionList() {}
 304
 305         ///
 306         virtual bool sorted() const { return true; }
 307         ///
 308         virtual size_t size() const
 309         {
 310                 return theWordList().size();
 311         }
 312         ///
 313         virtual docstring const & data(size_t idx) const
 314         {
 315                 return theWordList().word(idx);
 316         }
 317
 318 private:
 319         ///
 320         Buffer const & buf_;
 321         ///
 322         size_t pos_;
 323 };
 324
 325
 326 bool Text::empty() const
 327 {
 328         return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
 329                 // FIXME: Should we consider the labeled type as empty too?
 330                 && pars_[0].layout().labeltype == LABEL_NO_LABEL);
 331 }
 332
 333
 334 double Text::spacing(Buffer const & buffer, Paragraph const & par) const
 335 {
 336         if (par.params().spacing().isDefault())
 337                 return buffer.params().spacing().getValue();
 338         return par.params().spacing().getValue();
 339 }
 340
 341
 342 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
 343 {
 344         LASSERT(this == cur.text(), /**/);
 345
 346         Paragraph & cpar = cur.paragraph();
 347         pit_type cpit = cur.pit();
 348
 349         DocumentClass const & tclass = cur.buffer().params().documentClass();
 350         Layout const & layout = cpar.layout();
 351
 352         // this is only allowed, if the current paragraph is not empty
 353         // or caption and if it has not the keepempty flag active
 354         if (cur.lastpos() == 0 && !cpar.allowEmpty() &&
 355             layout.labeltype != LABEL_SENSITIVE)
 356                 return;
 357
 358         // a layout change may affect also the following paragraph
 359         recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
 360
 361         // Always break behind a space
 362         // It is better to erase the space (Dekel)
 363         if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
 364                 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
 365
 366         // What should the layout for the new paragraph be?
 367         bool keep_layout = inverse_logic ?
 368                 !layout.isEnvironment()
 369                 : layout.isEnvironment();
 370
 371         // We need to remember this before we break the paragraph, because
 372         // that invalidates the layout variable
 373         bool sensitive = layout.labeltype == LABEL_SENSITIVE;
 374
 375         // we need to set this before we insert the paragraph.
 376         bool const isempty = cpar.allowEmpty() && cpar.empty();
 377
 378         lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
 379                          cur.pos(), keep_layout);
 380
 381         // After this, neither paragraph contains any rows!
 382
 383         cpit = cur.pit();
 384         pit_type next_par = cpit + 1;
 385
 386         // well this is the caption hack since one caption is really enough
 387         if (sensitive) {
 388                 if (cur.pos() == 0)
 389                         // set to standard-layout
 390                 //FIXME Check if this should be emptyLayout() in some cases
 391                         pars_[cpit].applyLayout(tclass.defaultLayout());
 392                 else
 393                         // set to standard-layout
 394                         //FIXME Check if this should be emptyLayout() in some cases
 395                         pars_[next_par].applyLayout(tclass.defaultLayout());
 396         }
 397
 398         while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
 399                 if (!pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges))
 400                         break; // the character couldn't be deleted physically due to change tracking
 401         }
 402
 403         updateLabels(cur.buffer());
 404
 405         // A singlePar update is not enough in this case.
 406         cur.updateFlags(Update::Force);
 407
 408         // This check is necessary. Otherwise the new empty paragraph will
 409         // be deleted automatically. And it is more friendly for the user!
 410         if (cur.pos() != 0 || isempty)
 411                 setCursor(cur, cur.pit() + 1, 0);
 412         else
 413                 setCursor(cur, cur.pit(), 0);
 414 }
 415
 416
 417 // insert a character, moves all the following breaks in the
 418 // same Paragraph one to the right and make a rebreak
 419 void Text::insertChar(Cursor & cur, char_type c)
 420 {
 421         LASSERT(this == cur.text(), /**/);
 422
 423         cur.recordUndo(INSERT_UNDO);
 424
 425         TextMetrics const & tm = cur.bv().textMetrics(this);
 426         Buffer const & buffer = cur.buffer();
 427         Paragraph & par = cur.paragraph();
 428         // try to remove this
 429         pit_type const pit = cur.pit();
 430
 431         bool const freeSpacing = par.layout().free_spacing ||
 432                 par.isFreeSpacing();
 433
 434         if (lyxrc.auto_number) {
 435                 static docstring const number_operators = from_ascii("+-/*");
 436                 static docstring const number_unary_operators = from_ascii("+-");
 437                 static docstring const number_seperators = from_ascii(".,:");
 438
 439                 if (cur.current_font.fontInfo().number() == FONT_ON) {
 440                         if (!isDigit(c) && !contains(number_operators, c) &&
 441                             !(contains(number_seperators, c) &&
 442                               cur.pos() != 0 &&
 443                               cur.pos() != cur.lastpos() &&
 444                               tm.displayFont(pit, cur.pos()).fontInfo().number() == FONT_ON &&
 445                               tm.displayFont(pit, cur.pos() - 1).fontInfo().number() == FONT_ON)
 446                            )
 447                                 number(cur); // Set current_font.number to OFF
 448                 } else if (isDigit(c) &&
 449                            cur.real_current_font.isVisibleRightToLeft()) {
 450                         number(cur); // Set current_font.number to ON
 451
 452                         if (cur.pos() != 0) {
 453                                 char_type const c = par.getChar(cur.pos() - 1);
 454                                 if (contains(number_unary_operators, c) &&
 455                                     (cur.pos() == 1
 456                                      || par.isSeparator(cur.pos() - 2)
 457                                      || par.isNewline(cur.pos() - 2))
 458                                   ) {
 459                                         setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
 460                                                 tm.font_);
 461                                 } else if (contains(number_seperators, c)
 462                                      && cur.pos() >= 2
 463                                      && tm.displayFont(pit, cur.pos() - 2).fontInfo().number() == FONT_ON) {
 464                                         setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
 465                                                 tm.font_);
 466                                 }
 467                         }
 468                 }
 469         }
 470
 471         // In Bidi text, we want spaces to be treated in a special way: spaces
 472         // which are between words in different languages should get the
 473         // paragraph's language; otherwise, spaces should keep the language
 474         // they were originally typed in. This is only in effect while typing;
 475         // after the text is already typed in, the user can always go back and
 476         // explicitly set the language of a space as desired. But 99.9% of the
 477         // time, what we're doing here is what the user actually meant.
 478         //
 479         // The following cases are the ones in which the language of the space
 480         // should be changed to match that of the containing paragraph. In the
 481         // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
 482         // represents a space, pipe (|) represents the cursor position (so the
 483         // character before it is the one just typed in). The different cases
 484         // are depicted logically (not visually), from left to right:
 485         //
 486         // 1. A_a|
 487         // 2. a_A|
 488         //
 489         // Theoretically, there are other situations that we should, perhaps, deal
 490         // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
 491         // point (to understand why, just try to create this situation...).
 492
 493         if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
 494                 // get font in front and behind the space in question. But do NOT
 495                 // use getFont(cur.pos()) because the character c is not inserted yet
 496                 Font const pre_space_font  = tm.displayFont(cur.pit(), cur.pos() - 2);
 497                 Font const & post_space_font = cur.real_current_font;
 498                 bool pre_space_rtl  = pre_space_font.isVisibleRightToLeft();
 499                 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
 500
 501                 if (pre_space_rtl != post_space_rtl) {
 502                         // Set the space's language to match the language of the
 503                         // adjacent character whose direction is the paragraph's
 504                         // direction; don't touch other properties of the font
 505                         Language const * lang =
 506                                 (pre_space_rtl == par.isRTL(buffer.params())) ?
 507                                 pre_space_font.language() : post_space_font.language();
 508
 509                         Font space_font = tm.displayFont(cur.pit(), cur.pos() - 1);
 510                         space_font.setLanguage(lang);
 511                         par.setFont(cur.pos() - 1, space_font);
 512                 }
 513         }
 514
 515         // Next check, if there will be two blanks together or a blank at
 516         // the beginning of a paragraph.
 517         // I decided to handle blanks like normal characters, the main
 518         // difference are the special checks when calculating the row.fill
 519         // (blank does not count at the end of a row) and the check here
 520
 521         // When the free-spacing option is set for the current layout,
 522         // disable the double-space checking
 523         if (!freeSpacing && isLineSeparatorChar(c)) {
 524                 if (cur.pos() == 0) {
 525                         static bool sent_space_message = false;
 526                         if (!sent_space_message) {
 527                                 cur.message(_("You cannot insert a space at the "
 528                                                            "beginning of a paragraph. Please read the Tutorial."));
 529                                 sent_space_message = true;
 530                         }
 531                         return;
 532                 }
 533                 LASSERT(cur.pos() > 0, /**/);
 534                 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
 535                     && !par.isDeleted(cur.pos() - 1)) {
 536                         static bool sent_space_message = false;
 537                         if (!sent_space_message) {
 538                                 cur.message(_("You cannot type two spaces this way. "
 539                                                            "Please read the Tutorial."));
 540                                 sent_space_message = true;
 541                         }
 542                         return;
 543                 }
 544         }
 545
 546         par.insertChar(cur.pos(), c, cur.current_font, cur.buffer().params().trackChanges);
 547         cur.checkBufferStructure();
 548
 549 //              cur.updateFlags(Update::Force);
 550         setCursor(cur.top(), cur.pit(), cur.pos() + 1);
 551         charInserted(cur);
 552 }
 553
 554
 555 void Text::charInserted(Cursor & cur)
 556 {
 557         Paragraph & par = cur.paragraph();
 558
 559         // Here we call finishUndo for every 20 characters inserted.
 560         // This is from my experience how emacs does it. (Lgb)
 561         static unsigned int counter;
 562         if (counter < 20) {
 563                 ++counter;
 564         } else {
 565                 cur.finishUndo();
 566                 counter = 0;
 567         }
 568
 569         // register word if a non-letter was entered
 570         if (cur.pos() > 1
 571             && par.isLetter(cur.pos() - 2)
 572             && !par.isLetter(cur.pos() - 1)) {
 573                 // get the word in front of cursor
 574                 LASSERT(this == cur.text(), /**/);
 575                 cur.paragraph().updateWords(cur.top());
 576         }
 577 }
 578
 579
 580 // the cursor set functions have a special mechanism. When they
 581 // realize, that you left an empty paragraph, they will delete it.
 582
 583 bool Text::cursorForwardOneWord(Cursor & cur)
 584 {
 585         LASSERT(this == cur.text(), /**/);
 586
 587         pos_type const lastpos = cur.lastpos();
 588         pit_type pit = cur.pit();
 589         pos_type pos = cur.pos();
 590         Paragraph const & par = cur.paragraph();
 591
 592         // Paragraph boundary is a word boundary
 593         if (pos == lastpos && pit != cur.lastpit())
 594                 return setCursor(cur, pit + 1, 0);
 595
 596         // Skip over either a non-char inset or a full word
 597         if (pos != lastpos && !par.isLetter(pos) && !par.isChar(pos))
 598                 ++pos;
 599         else while (pos != lastpos && par.isLetter(pos))
 600                         ++pos;
 601
 602         // Skip through trailing punctuation and spaces.
 603         while (pos != lastpos && par.isChar(pos))
 604                 ++pos;
 605
 606         return setCursor(cur, pit, pos);
 607 }
 608
 609
 610 bool Text::cursorBackwardOneWord(Cursor & cur)
 611 {
 612         LASSERT(this == cur.text(), /**/);
 613
 614         pit_type pit = cur.pit();
 615         pos_type pos = cur.pos();
 616         Paragraph & par = cur.paragraph();
 617
 618         // Paragraph boundary is a word boundary
 619         if (pos == 0 && pit != 0)
 620                 return setCursor(cur, pit - 1, getPar(pit - 1).size());
 621
 622         // Skip through puctuation and spaces.
 623         while (pos != 0 && par.isChar(pos - 1))
 624                 --pos;
 625
 626         // Skip over either a non-char inset or a full word
 627         if (pos != 0 && !par.isLetter(pos - 1) && !par.isChar(pos - 1))
 628                 --pos;
 629         else while (pos != 0 && par.isLetter(pos - 1))
 630                         --pos;
 631
 632         return setCursor(cur, pit, pos);
 633 }
 634
 635
 636 bool Text::cursorVisLeftOneWord(Cursor & cur)
 637 {
 638         LASSERT(this == cur.text(), /**/);
 639
 640         pos_type left_pos, right_pos;
 641         bool left_is_letter, right_is_letter;
 642
 643         Cursor temp_cur = cur;
 644
 645         // always try to move at least once...
 646         while (temp_cur.posVisLeft(true /* skip_inset */)) {
 647
 648                 // collect some information about current cursor position
 649                 temp_cur.getSurroundingPos(left_pos, right_pos);
 650                 left_is_letter =
 651                         (left_pos > -1 ? temp_cur.paragraph().isLetter(left_pos) : false);
 652                 right_is_letter =
 653                         (right_pos > -1 ? temp_cur.paragraph().isLetter(right_pos) : false);
 654
 655                 // if we're not at a letter/non-letter boundary, continue moving
 656                 if (left_is_letter == right_is_letter)
 657                         continue;
 658
 659                 // we should stop when we have an LTR word on our right or an RTL word
 660                 // on our left
 661                 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
 662                                 temp_cur.bv().buffer().params(),
 663                                 left_pos).isRightToLeft())
 664                         || (right_is_letter && !temp_cur.paragraph().getFontSettings(
 665                                 temp_cur.bv().buffer().params(),
 666                                 right_pos).isRightToLeft()))
 667                         break;
 668         }
 669
 670         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
 671                                          true, temp_cur.boundary());
 672 }
 673
 674
 675 bool Text::cursorVisRightOneWord(Cursor & cur)
 676 {
 677         LASSERT(this == cur.text(), /**/);
 678
 679         pos_type left_pos, right_pos;
 680         bool left_is_letter, right_is_letter;
 681
 682         Cursor temp_cur = cur;
 683
 684         // always try to move at least once...
 685         while (temp_cur.posVisRight(true /* skip_inset */)) {
 686
 687                 // collect some information about current cursor position
 688                 temp_cur.getSurroundingPos(left_pos, right_pos);
 689                 left_is_letter =
 690                         (left_pos > -1 ? temp_cur.paragraph().isLetter(left_pos) : false);
 691                 right_is_letter =
 692                         (right_pos > -1 ? temp_cur.paragraph().isLetter(right_pos) : false);
 693
 694                 // if we're not at a letter/non-letter boundary, continue moving
 695                 if (left_is_letter == right_is_letter)
 696                         continue;
 697
 698                 // we should stop when we have an LTR word on our right or an RTL word
 699                 // on our left
 700                 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
 701                                 temp_cur.bv().buffer().params(),
 702                                 left_pos).isRightToLeft())
 703                         || (right_is_letter && !temp_cur.paragraph().getFontSettings(
 704                                 temp_cur.bv().buffer().params(),
 705                                 right_pos).isRightToLeft()))
 706                         break;
 707         }
 708
 709         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
 710                                          true, temp_cur.boundary());
 711 }
 712
 713
 714 void Text::selectWord(Cursor & cur, word_location loc)
 715 {
 716         LASSERT(this == cur.text(), /**/);
 717         CursorSlice from = cur.top();
 718         CursorSlice to = cur.top();
 719         getWord(from, to, loc);
 720         if (cur.top() != from)
 721                 setCursor(cur, from.pit(), from.pos());
 722         if (to == from)
 723                 return;
 724         cur.resetAnchor();
 725         setCursor(cur, to.pit(), to.pos());
 726         cur.setSelection();
 727 }
 728
 729
 730 // Select the word currently under the cursor when no
 731 // selection is currently set
 732 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
 733 {
 734         LASSERT(this == cur.text(), /**/);
 735         if (cur.selection())
 736                 return false;
 737         selectWord(cur, loc);
 738         return cur.selection();
 739 }
 740
 741
 742 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
 743 {
 744         LASSERT(this == cur.text(), /**/);
 745
 746         if (!cur.selection())
 747                 return;
 748
 749         cur.recordUndoSelection();
 750
 751         pit_type begPit = cur.selectionBegin().pit();
 752         pit_type endPit = cur.selectionEnd().pit();
 753
 754         pos_type begPos = cur.selectionBegin().pos();
 755         pos_type endPos = cur.selectionEnd().pos();
 756
 757         // keep selection info, because endPos becomes invalid after the first loop
 758         bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
 759
 760         // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
 761
 762         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 763                 pos_type parSize = pars_[pit].size();
 764
 765                 // ignore empty paragraphs; otherwise, an assertion will fail for
 766                 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
 767                 if (parSize == 0)
 768                         continue;
 769
 770                 // do not consider first paragraph if the cursor starts at pos size()
 771                 if (pit == begPit && begPos == parSize)
 772                         continue;
 773
 774                 // do not consider last paragraph if the cursor ends at pos 0
 775                 if (pit == endPit && endPos == 0)
 776                         break; // last iteration anyway
 777
 778                 pos_type left  = (pit == begPit ? begPos : 0);
 779                 pos_type right = (pit == endPit ? endPos : parSize);
 780
 781                 if (op == ACCEPT) {
 782                         pars_[pit].acceptChanges(cur.buffer().params(), left, right);
 783                 } else {
 784                         pars_[pit].rejectChanges(cur.buffer().params(), left, right);
 785                 }
 786         }
 787
 788         // next, accept/reject imaginary end-of-par characters
 789
 790         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 791                 pos_type pos = pars_[pit].size();
 792
 793                 // skip if the selection ends before the end-of-par
 794                 if (pit == endPit && endsBeforeEndOfPar)
 795                         break; // last iteration anyway
 796
 797                 // skip if this is not the last paragraph of the document
 798                 // note: the user should be able to accept/reject the par break of the last par!
 799                 if (pit == endPit && pit + 1 != int(pars_.size()))
 800                         break; // last iteration anway
 801
 802                 if (op == ACCEPT) {
 803                         if (pars_[pit].isInserted(pos)) {
 804                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 805                         } else if (pars_[pit].isDeleted(pos)) {
 806                                 if (pit + 1 == int(pars_.size())) {
 807                                         // we cannot remove a par break at the end of the last paragraph;
 808                                         // instead, we mark it unchanged
 809                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 810                                 } else {
 811                                         mergeParagraph(cur.buffer().params(), pars_, pit);
 812                                         --endPit;
 813                                         --pit;
 814                                 }
 815                         }
 816                 } else {
 817                         if (pars_[pit].isDeleted(pos)) {
 818                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 819                         } else if (pars_[pit].isInserted(pos)) {
 820                                 if (pit + 1 == int(pars_.size())) {
 821                                         // we mark the par break at the end of the last paragraph unchanged
 822                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 823                                 } else {
 824                                         mergeParagraph(cur.buffer().params(), pars_, pit);
 825                                         --endPit;
 826                                         --pit;
 827                                 }
 828                         }
 829                 }
 830         }
 831
 832         // finally, invoke the DEPM
 833
 834         deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer().params().trackChanges);
 835
 836         //
 837
 838         cur.finishUndo();
 839         cur.clearSelection();
 840         setCursorIntern(cur, begPit, begPos);
 841         cur.updateFlags(Update::Force);
 842         updateLabels(cur.buffer());
 843 }
 844
 845
 846 void Text::acceptChanges(BufferParams const & bparams)
 847 {
 848         lyx::acceptChanges(pars_, bparams);
 849         deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.trackChanges);
 850 }
 851
 852
 853 void Text::rejectChanges(BufferParams const & bparams)
 854 {
 855         pit_type pars_size = static_cast<pit_type>(pars_.size());
 856
 857         // first, reject changes within each individual paragraph
 858         // (do not consider end-of-par)
 859         for (pit_type pit = 0; pit < pars_size; ++pit) {
 860                 if (!pars_[pit].empty())   // prevent assertion failure
 861                         pars_[pit].rejectChanges(bparams, 0, pars_[pit].size());
 862         }
 863
 864         // next, reject imaginary end-of-par characters
 865         for (pit_type pit = 0; pit < pars_size; ++pit) {
 866                 pos_type pos = pars_[pit].size();
 867
 868                 if (pars_[pit].isDeleted(pos)) {
 869                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 870                 } else if (pars_[pit].isInserted(pos)) {
 871                         if (pit == pars_size - 1) {
 872                                 // we mark the par break at the end of the last
 873                                 // paragraph unchanged
 874                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 875                         } else {
 876                                 mergeParagraph(bparams, pars_, pit);
 877                                 --pit;
 878                                 --pars_size;
 879                         }
 880                 }
 881         }
 882
 883         // finally, invoke the DEPM
 884         deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.trackChanges);
 885 }
 886
 887
 888 void Text::deleteWordForward(Cursor & cur)
 889 {
 890         LASSERT(this == cur.text(), /**/);
 891         if (cur.lastpos() == 0)
 892                 cursorForward(cur);
 893         else {
 894                 cur.resetAnchor();
 895                 cur.selection() = true;
 896                 cursorForwardOneWord(cur);
 897                 cur.setSelection();
 898                 cutSelection(cur, true, false);
 899                 cur.checkBufferStructure();
 900         }
 901 }
 902
 903
 904 void Text::deleteWordBackward(Cursor & cur)
 905 {
 906         LASSERT(this == cur.text(), /**/);
 907         if (cur.lastpos() == 0)
 908                 cursorBackward(cur);
 909         else {
 910                 cur.resetAnchor();
 911                 cur.selection() = true;
 912                 cursorBackwardOneWord(cur);
 913                 cur.setSelection();
 914                 cutSelection(cur, true, false);
 915                 cur.checkBufferStructure();
 916         }
 917 }
 918
 919
 920 // Kill to end of line.
 921 void Text::changeCase(Cursor & cur, TextCase action)
 922 {
 923         LASSERT(this == cur.text(), /**/);
 924         CursorSlice from;
 925         CursorSlice to;
 926
 927         bool gotsel = false;
 928         if (cur.selection()) {
 929                 from = cur.selBegin();
 930                 to = cur.selEnd();
 931                 gotsel = true;
 932         } else {
 933                 from = cur.top();
 934                 getWord(from, to, PARTIAL_WORD);
 935                 cursorForwardOneWord(cur);
 936         }
 937
 938         cur.recordUndoSelection();
 939
 940         pit_type begPit = from.pit();
 941         pit_type endPit = to.pit();
 942
 943         pos_type begPos = from.pos();
 944         pos_type endPos = to.pos();
 945
 946         pos_type right = 0; // needed after the for loop
 947
 948         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 949                 Paragraph & par = pars_[pit];
 950                 pos_type const pos = (pit == begPit ? begPos : 0);
 951                 right = (pit == endPit ? endPos : par.size());
 952                 par.changeCase(cur.buffer().params(), pos, right, action);
 953         }
 954
 955         // the selection may have changed due to logically-only deleted chars
 956         if (gotsel) {
 957                 setCursor(cur, begPit, begPos);
 958                 cur.resetAnchor();
 959                 setCursor(cur, endPit, right);
 960                 cur.setSelection();
 961         } else
 962                 setCursor(cur, endPit, right);
 963
 964         cur.checkBufferStructure();
 965 }
 966
 967
 968 bool Text::handleBibitems(Cursor & cur)
 969 {
 970         if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
 971                 return false;
 972
 973         if (cur.pos() != 0)
 974                 return false;
 975
 976         BufferParams const & bufparams = cur.buffer().params();
 977         Paragraph const & par = cur.paragraph();
 978         Cursor prevcur = cur;
 979         if (cur.pit() > 0) {
 980                 --prevcur.pit();
 981                 prevcur.pos() = prevcur.lastpos();
 982         }
 983         Paragraph const & prevpar = prevcur.paragraph();
 984
 985         // if a bibitem is deleted, merge with previous paragraph
 986         // if this is a bibliography item as well
 987         if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
 988                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
 989                 mergeParagraph(bufparams, cur.text()->paragraphs(),
 990                                                         prevcur.pit());
 991                 updateLabels(cur.buffer());
 992                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
 993                 cur.updateFlags(Update::Force);
 994                 return true;
 995         }
 996
 997         // otherwise reset to default
 998         cur.paragraph().setEmptyOrDefaultLayout(bufparams.documentClass());
 999         return true;
1000 }
1001
1002
1003 bool Text::erase(Cursor & cur)
1004 {
1005         LASSERT(this == cur.text(), /**/);
1006         bool needsUpdate = false;
1007         Paragraph & par = cur.paragraph();
1008
1009         if (cur.pos() != cur.lastpos()) {
1010                 // this is the code for a normal delete, not pasting
1011                 // any paragraphs
1012                 cur.recordUndo(DELETE_UNDO);
1013                 bool const was_inset = cur.paragraph().isInset(cur.pos());
1014                 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges))
1015                         // the character has been logically deleted only => skip it
1016                         cur.top().forwardPos();
1017
1018                 if (was_inset)
1019                         updateLabels(cur.buffer());
1020                 else
1021                         cur.checkBufferStructure();
1022                 needsUpdate = true;
1023         } else {
1024                 if (cur.pit() == cur.lastpit())
1025                         return dissolveInset(cur);
1026
1027                 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1028                         par.setChange(cur.pos(), Change(Change::DELETED));
1029                         cur.forwardPos();
1030                         needsUpdate = true;
1031                 } else {
1032                         setCursorIntern(cur, cur.pit() + 1, 0);
1033                         needsUpdate = backspacePos0(cur);
1034                 }
1035         }
1036
1037         needsUpdate |= handleBibitems(cur);
1038
1039         if (needsUpdate) {
1040                 // Make sure the cursor is correct. Is this really needed?
1041                 // No, not really... at least not here!
1042                 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1043                 cur.checkBufferStructure();
1044         }
1045
1046         return needsUpdate;
1047 }
1048
1049
1050 bool Text::backspacePos0(Cursor & cur)
1051 {
1052         LASSERT(this == cur.text(), /**/);
1053         if (cur.pit() == 0)
1054                 return false;
1055
1056         bool needsUpdate = false;
1057
1058         BufferParams const & bufparams = cur.buffer().params();
1059         DocumentClass const & tclass = bufparams.documentClass();
1060         ParagraphList & plist = cur.text()->paragraphs();
1061         Paragraph const & par = cur.paragraph();
1062         Cursor prevcur = cur;
1063         --prevcur.pit();
1064         prevcur.pos() = prevcur.lastpos();
1065         Paragraph const & prevpar = prevcur.paragraph();
1066
1067         // is it an empty paragraph?
1068         if (cur.lastpos() == 0
1069             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1070                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1071                 plist.erase(boost::next(plist.begin(), cur.pit()));
1072                 needsUpdate = true;
1073         }
1074         // is previous par empty?
1075         else if (prevcur.lastpos() == 0
1076                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1077                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1078                 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1079                 needsUpdate = true;
1080         }
1081         // Pasting is not allowed, if the paragraphs have different
1082         // layouts. I think it is a real bug of all other
1083         // word processors to allow it. It confuses the user.
1084         // Correction: Pasting is always allowed with standard-layout
1085         // or the empty layout.
1086         else if (par.layout() == prevpar.layout()
1087                  || tclass.isDefaultLayout(par.layout())
1088                  || tclass.isEmptyLayout(par.layout())) {
1089                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1090                 mergeParagraph(bufparams, plist, prevcur.pit());
1091                 needsUpdate = true;
1092         }
1093
1094         if (needsUpdate) {
1095                 updateLabels(cur.buffer());
1096                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1097         }
1098
1099         return needsUpdate;
1100 }
1101
1102
1103 bool Text::backspace(Cursor & cur)
1104 {
1105         LASSERT(this == cur.text(), /**/);
1106         bool needsUpdate = false;
1107         if (cur.pos() == 0) {
1108                 if (cur.pit() == 0)
1109                         return dissolveInset(cur);
1110
1111                 Paragraph & prev_par = pars_[cur.pit() - 1];
1112
1113                 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1114                         prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1115                         setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1116                         return true;
1117                 }
1118                 // The cursor is at the beginning of a paragraph, so
1119                 // the backspace will collapse two paragraphs into one.
1120                 needsUpdate = backspacePos0(cur);
1121
1122         } else {
1123                 // this is the code for a normal backspace, not pasting
1124                 // any paragraphs
1125                 cur.recordUndo(DELETE_UNDO);
1126                 // We used to do cursorBackwardIntern() here, but it is
1127                 // not a good idea since it triggers the auto-delete
1128                 // mechanism. So we do a cursorBackwardIntern()-lite,
1129                 // without the dreaded mechanism. (JMarc)
1130                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1131                                 false, cur.boundary());
1132                 bool const was_inset = cur.paragraph().isInset(cur.pos());
1133                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1134                 if (was_inset)
1135                         updateLabels(cur.buffer());
1136                 else
1137                         cur.checkBufferStructure();
1138         }
1139
1140         if (cur.pos() == cur.lastpos())
1141                 cur.setCurrentFont();
1142
1143         needsUpdate |= handleBibitems(cur);
1144
1145         // A singlePar update is not enough in this case.
1146 //              cur.updateFlags(Update::Force);
1147         setCursor(cur.top(), cur.pit(), cur.pos());
1148
1149         return needsUpdate;
1150 }
1151
1152
1153 bool Text::dissolveInset(Cursor & cur) {
1154         LASSERT(this == cur.text(), /**/);
1155
1156         if (isMainText(cur.bv().buffer()) || cur.inset().nargs() != 1)
1157                 return false;
1158
1159         cur.recordUndoInset();
1160         cur.mark() = false;
1161         cur.selHandle(false);
1162         // save position
1163         pos_type spos = cur.pos();
1164         pit_type spit = cur.pit();
1165         ParagraphList plist;
1166         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1167                 plist = paragraphs();
1168         cur.popBackward();
1169         // store cursor offset
1170         if (spit == 0)
1171                 spos += cur.pos();
1172         spit += cur.pit();
1173         Buffer & b = cur.buffer();
1174         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1175         if (!plist.empty()) {
1176                 // ERT paragraphs have the Language latex_language.
1177                 // This is invalid outside of ERT, so we need to
1178                 // change it to the buffer language.
1179                 ParagraphList::iterator it = plist.begin();
1180                 ParagraphList::iterator it_end = plist.end();
1181                 for (; it != it_end; it++)
1182                         it->changeLanguage(b.params(), latex_language, b.language());
1183
1184                 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1185                                    b.errorList("Paste"));
1186                 // restore position
1187                 cur.pit() = min(cur.lastpit(), spit);
1188                 cur.pos() = min(cur.lastpos(), spos);
1189         }
1190         cur.clearSelection();
1191         cur.resetAnchor();
1192         return true;
1193 }
1194
1195
1196 void Text::getWord(CursorSlice & from, CursorSlice & to,
1197         word_location const loc) const
1198 {
1199         Paragraph const & from_par = pars_[from.pit()];
1200         switch (loc) {
1201         case WHOLE_WORD_STRICT:
1202                 if (from.pos() == 0 || from.pos() == from_par.size()
1203                     || !from_par.isLetter(from.pos())
1204                     || !from_par.isLetter(from.pos() - 1)) {
1205                         to = from;
1206                         return;
1207                 }
1208                 // no break here, we go to the next
1209
1210         case WHOLE_WORD:
1211                 // If we are already at the beginning of a word, do nothing
1212                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1213                         break;
1214                 // no break here, we go to the next
1215
1216         case PREVIOUS_WORD:
1217                 // always move the cursor to the beginning of previous word
1218                 while (from.pos() && from_par.isLetter(from.pos() - 1))
1219                         --from.pos();
1220                 break;
1221         case NEXT_WORD:
1222                 LYXERR0("Text::getWord: NEXT_WORD not implemented yet");
1223                 break;
1224         case PARTIAL_WORD:
1225                 // no need to move the 'from' cursor
1226                 break;
1227         }
1228         to = from;
1229         Paragraph const & to_par = pars_[to.pit()];
1230         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1231                 ++to.pos();
1232 }
1233
1234
1235 void Text::write(Buffer const & buf, ostream & os) const
1236 {
1237         ParagraphList::const_iterator pit = paragraphs().begin();
1238         ParagraphList::const_iterator end = paragraphs().end();
1239         depth_type dth = 0;
1240         for (; pit != end; ++pit)
1241                 pit->write(os, buf.params(), dth);
1242
1243         // Close begin_deeper
1244         for(; dth > 0; --dth)
1245                 os << "\n\\end_deeper";
1246 }
1247
1248
1249 bool Text::read(Buffer const & buf, Lexer & lex,
1250                 ErrorList & errorList, InsetText * insetPtr)
1251 {
1252         depth_type depth = 0;
1253
1254         while (lex.isOK()) {
1255                 lex.nextToken();
1256                 string const token = lex.getString();
1257
1258                 if (token.empty())
1259                         continue;
1260
1261                 if (token == "\\end_inset")
1262                         break;
1263
1264                 if (token == "\\end_body")
1265                         continue;
1266
1267                 if (token == "\\begin_body")
1268                         continue;
1269
1270                 if (token == "\\end_document")
1271                         return false;
1272
1273                 if (token == "\\begin_layout") {
1274                         lex.pushToken(token);
1275
1276                         Paragraph par;
1277                         par.params().depth(depth);
1278                         par.setFont(0, Font(inherit_font, buf.params().language));
1279                         par.setInsetOwner(insetPtr);
1280                         pars_.push_back(par);
1281
1282                         // FIXME: goddamn InsetTabular makes us pass a Buffer
1283                         // not BufferParams
1284                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
1285
1286                         // register the words in the global word list
1287                         CursorSlice sl = CursorSlice(*insetPtr);
1288                         sl.pit() = pars_.size() - 1;
1289                         pars_.back().updateWords(sl);
1290                 } else if (token == "\\begin_deeper") {
1291                         ++depth;
1292                 } else if (token == "\\end_deeper") {
1293                         if (!depth)
1294                                 lex.printError("\\end_deeper: " "depth is already null");
1295                         else
1296                                 --depth;
1297                 } else {
1298                         LYXERR0("Handling unknown body token: `" << token << '\'');
1299                 }
1300         }
1301         return true;
1302 }
1303
1304 // Returns the current font and depth as a message.
1305 docstring Text::currentState(Cursor & cur)
1306 {
1307         LASSERT(this == cur.text(), /**/);
1308         Buffer & buf = cur.buffer();
1309         Paragraph const & par = cur.paragraph();
1310         odocstringstream os;
1311
1312         if (buf.params().trackChanges)
1313                 os << _("[Change Tracking] ");
1314
1315         Change change = par.lookupChange(cur.pos());
1316
1317         if (change.type != Change::UNCHANGED) {
1318                 Author const & a = buf.params().authors().get(change.author);
1319                 os << _("Change: ") << a.name();
1320                 if (!a.email().empty())
1321                         os << " (" << a.email() << ")";
1322                 // FIXME ctime is english, we should translate that
1323                 os << _(" at ") << ctime(&change.changetime);
1324                 os << " : ";
1325         }
1326
1327         // I think we should only show changes from the default
1328         // font. (Asger)
1329         // No, from the document font (MV)
1330         Font font = cur.real_current_font;
1331         font.fontInfo().reduce(buf.params().getFont().fontInfo());
1332
1333         os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1334
1335         // The paragraph depth
1336         int depth = cur.paragraph().getDepth();
1337         if (depth > 0)
1338                 os << bformat(_(", Depth: %1$d"), depth);
1339
1340         // The paragraph spacing, but only if different from
1341         // buffer spacing.
1342         Spacing const & spacing = par.params().spacing();
1343         if (!spacing.isDefault()) {
1344                 os << _(", Spacing: ");
1345                 switch (spacing.getSpace()) {
1346                 case Spacing::Single:
1347                         os << _("Single");
1348                         break;
1349                 case Spacing::Onehalf:
1350                         os << _("OneHalf");
1351                         break;
1352                 case Spacing::Double:
1353                         os << _("Double");
1354                         break;
1355                 case Spacing::Other:
1356                         os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1357                         break;
1358                 case Spacing::Default:
1359                         // should never happen, do nothing
1360                         break;
1361                 }
1362         }
1363
1364 #ifdef DEVEL_VERSION
1365         os << _(", Inset: ") << &cur.inset();
1366         os << _(", Paragraph: ") << cur.pit();
1367         os << _(", Id: ") << par.id();
1368         os << _(", Position: ") << cur.pos();
1369         // FIXME: Why is the check for par.size() needed?
1370         // We are called with cur.pos() == par.size() quite often.
1371         if (!par.empty() && cur.pos() < par.size()) {
1372                 // Force output of code point, not character
1373                 size_t const c = par.getChar(cur.pos());
1374                 os << _(", Char: 0x") << hex << c;
1375         }
1376         os << _(", Boundary: ") << cur.boundary();
1377 //      Row & row = cur.textRow();
1378 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1379 #endif
1380         return os.str();
1381 }
1382
1383
1384 docstring Text::getPossibleLabel(Cursor & cur) const
1385 {
1386         pit_type pit = cur.pit();
1387
1388         Layout const * layout = &(pars_[pit].layout());
1389
1390         docstring text;
1391         docstring par_text = pars_[pit].asString();
1392         string piece;
1393         // the return string of math matrices might contain linebreaks
1394         par_text = subst(par_text, '\n', '-');
1395         for (int i = 0; i < lyxrc.label_init_length; ++i) {
1396                 if (par_text.empty())
1397                         break;
1398                 docstring head;
1399                 par_text = split(par_text, head, ' ');
1400                 // Is it legal to use spaces in labels ?
1401                 if (i > 0)
1402                         text += '-';
1403                 text += head;
1404         }
1405
1406         // No need for a prefix if the user said so.
1407         if (lyxrc.label_init_length <= 0)
1408                 return text;
1409
1410         // Will contain the label type.
1411         docstring name;
1412
1413         // For section, subsection, etc...
1414         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1415                 Layout const * layout2 = &(pars_[pit - 1].layout());
1416                 if (layout2->latextype != LATEX_PARAGRAPH) {
1417                         --pit;
1418                         layout = layout2;
1419                 }
1420         }
1421         if (layout->latextype != LATEX_PARAGRAPH)
1422                 name = from_ascii(layout->latexname());
1423
1424         // for captions, we just take the caption type
1425         Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1426         if (caption_inset)
1427                 name = from_ascii(static_cast<InsetCaption *>(caption_inset)->type());
1428
1429         // If none of the above worked, we'll see if we're inside various
1430         // types of insets and take our abbreviation from them.
1431         if (name.empty()) {
1432                 InsetCode const codes[] = {
1433                         FLOAT_CODE,
1434                         WRAP_CODE,
1435                         FOOT_CODE
1436                 };
1437                 for (unsigned int i = 0; i < (sizeof codes / sizeof codes[0]); ++i) {
1438                         Inset * float_inset = cur.innerInsetOfType(codes[i]);
1439                         if (float_inset) {
1440                                 name = float_inset->name();
1441                                 break;
1442                         }
1443                 }
1444         }
1445
1446         // Create a correct prefix for prettyref
1447         if (name == "theorem")
1448                 name = from_ascii("thm");
1449         else if (name == "Foot")
1450                 name = from_ascii("fn");
1451         else if (name == "listing")
1452                 name = from_ascii("lst");
1453
1454         if (!name.empty())
1455                 text = name.substr(0, 3) + ':' + text;
1456
1457         return text;
1458 }
1459
1460
1461 void Text::charsTranspose(Cursor & cur)
1462 {
1463         LASSERT(this == cur.text(), /**/);
1464
1465         pos_type pos = cur.pos();
1466
1467         // If cursor is at beginning or end of paragraph, do nothing.
1468         if (pos == cur.lastpos() || pos == 0)
1469                 return;
1470
1471         Paragraph & par = cur.paragraph();
1472
1473         // Get the positions of the characters to be transposed.
1474         pos_type pos1 = pos - 1;
1475         pos_type pos2 = pos;
1476
1477         // In change tracking mode, ignore deleted characters.
1478         while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1479                 ++pos2;
1480         if (pos2 == cur.lastpos())
1481                 return;
1482
1483         while (pos1 >= 0 && par.isDeleted(pos1))
1484                 --pos1;
1485         if (pos1 < 0)
1486                 return;
1487
1488         // Don't do anything if one of the "characters" is not regular text.
1489         if (par.isInset(pos1) || par.isInset(pos2))
1490                 return;
1491
1492         // Store the characters to be transposed (including font information).
1493         char_type char1 = par.getChar(pos1);
1494         Font const font1 =
1495                 par.getFontSettings(cur.buffer().params(), pos1);
1496
1497         char_type char2 = par.getChar(pos2);
1498         Font const font2 =
1499                 par.getFontSettings(cur.buffer().params(), pos2);
1500
1501         // And finally, we are ready to perform the transposition.
1502         // Track the changes if Change Tracking is enabled.
1503         bool const trackChanges = cur.buffer().params().trackChanges;
1504
1505         cur.recordUndo();
1506
1507         par.eraseChar(pos2, trackChanges);
1508         par.eraseChar(pos1, trackChanges);
1509         par.insertChar(pos1, char2, font2, trackChanges);
1510         par.insertChar(pos2, char1, font1, trackChanges);
1511
1512         cur.checkBufferStructure();
1513
1514         // After the transposition, move cursor to after the transposition.
1515         setCursor(cur, cur.pit(), pos2);
1516         cur.forwardPos();
1517 }
1518
1519
1520 DocIterator Text::macrocontextPosition() const
1521 {
1522         return macrocontext_position_;
1523 }
1524
1525
1526 void Text::setMacrocontextPosition(DocIterator const & pos)
1527 {
1528         macrocontext_position_ = pos;
1529 }
1530
1531
1532 docstring Text::previousWord(CursorSlice const & sl) const
1533 {
1534         CursorSlice from = sl;
1535         CursorSlice to = sl;
1536         getWord(from, to, PREVIOUS_WORD);
1537         if (sl == from || to == from)
1538                 return docstring();
1539
1540         Paragraph const & par = sl.paragraph();
1541         return par.asString(from.pos(), to.pos());
1542 }
1543
1544
1545 bool Text::completionSupported(Cursor const & cur) const
1546 {
1547         Paragraph const & par = cur.paragraph();
1548         return cur.pos() > 0
1549                 && (cur.pos() >= par.size() || !par.isLetter(cur.pos()))
1550                 && par.isLetter(cur.pos() - 1);
1551 }
1552
1553
1554 CompletionList const * Text::createCompletionList(Cursor const & cur) const
1555 {
1556         return new TextCompletionList(cur);
1557 }
1558
1559
1560 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
1561 {
1562         LASSERT(cur.bv().cursor() == cur, /**/);
1563         cur.insert(s);
1564         cur.bv().cursor() = cur;
1565         if (!(cur.disp_.update() & Update::Force))
1566                 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
1567         return true;
1568 }
1569
1570
1571 docstring Text::completionPrefix(Cursor const & cur) const
1572 {
1573         return previousWord(cur.top());
1574 }
1575
1576 } // namespace lyx