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         // Skip over either a non-char inset or a full word
 593         if (pos != lastpos && !par.isLetter(pos) && !par.isChar(pos))
 594                 ++pos;
 595         else while (pos != lastpos && par.isLetter(pos))
 596                         ++pos;
 597
 598         // Skip through trailing punctuation and spaces.
 599         while (pos != lastpos && par.isChar(pos))
 600                 ++pos;
 601
 602         if (pos == lastpos && pit != cur.lastpit()) {
 603                 ++pit;
 604                 pos = 0;
 605         }
 606
 607         return setCursor(cur, pit, pos);
 608 }
 609
 610
 611 bool Text::cursorBackwardOneWord(Cursor & cur)
 612 {
 613         LASSERT(this == cur.text(), /**/);
 614
 615         pit_type pit = cur.pit();
 616         pos_type pos = cur.pos();
 617         Paragraph & par = cur.paragraph();
 618
 619         // Skip through puctuation and spaces.
 620         while (pos != 0 && par.isChar(pos - 1))
 621                 --pos;
 622
 623         // Skip over either a non-char inset or a full word
 624         if (pos != 0 && !par.isLetter(pos) && !par.isChar(pos - 1))
 625                 --pos;
 626         else while (pos != 0 && par.isLetter(pos - 1))
 627                         --pos;
 628
 629         if (pos == 0 && pit != 0) {
 630                 --pit;
 631                 pos = getPar(cur.pit() - 1).size();
 632         }
 633
 634         return setCursor(cur, pit, pos);
 635 }
 636
 637
 638 bool Text::cursorVisLeftOneWord(Cursor & cur)
 639 {
 640         LASSERT(this == cur.text(), /**/);
 641
 642         pos_type left_pos, right_pos;
 643         bool left_is_letter, right_is_letter;
 644
 645         Cursor temp_cur = cur;
 646
 647         // always try to move at least once...
 648         while (temp_cur.posVisLeft(true /* skip_inset */)) {
 649
 650                 // collect some information about current cursor position
 651                 temp_cur.getSurroundingPos(left_pos, right_pos);
 652                 left_is_letter =
 653                         (left_pos > -1 ? temp_cur.paragraph().isLetter(left_pos) : false);
 654                 right_is_letter =
 655                         (right_pos > -1 ? temp_cur.paragraph().isLetter(right_pos) : false);
 656
 657                 // if we're not at a letter/non-letter boundary, continue moving
 658                 if (left_is_letter == right_is_letter)
 659                         continue;
 660
 661                 // we should stop when we have an LTR word on our right or an RTL word
 662                 // on our left
 663                 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
 664                                 temp_cur.bv().buffer().params(),
 665                                 left_pos).isRightToLeft())
 666                         || (right_is_letter && !temp_cur.paragraph().getFontSettings(
 667                                 temp_cur.bv().buffer().params(),
 668                                 right_pos).isRightToLeft()))
 669                         break;
 670         }
 671
 672         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
 673                                          true, temp_cur.boundary());
 674 }
 675
 676
 677 bool Text::cursorVisRightOneWord(Cursor & cur)
 678 {
 679         LASSERT(this == cur.text(), /**/);
 680
 681         pos_type left_pos, right_pos;
 682         bool left_is_letter, right_is_letter;
 683
 684         Cursor temp_cur = cur;
 685
 686         // always try to move at least once...
 687         while (temp_cur.posVisRight(true /* skip_inset */)) {
 688
 689                 // collect some information about current cursor position
 690                 temp_cur.getSurroundingPos(left_pos, right_pos);
 691                 left_is_letter =
 692                         (left_pos > -1 ? temp_cur.paragraph().isLetter(left_pos) : false);
 693                 right_is_letter =
 694                         (right_pos > -1 ? temp_cur.paragraph().isLetter(right_pos) : false);
 695
 696                 // if we're not at a letter/non-letter boundary, continue moving
 697                 if (left_is_letter == right_is_letter)
 698                         continue;
 699
 700                 // we should stop when we have an LTR word on our right or an RTL word
 701                 // on our left
 702                 if ((left_is_letter && temp_cur.paragraph().getFontSettings(
 703                                 temp_cur.bv().buffer().params(),
 704                                 left_pos).isRightToLeft())
 705                         || (right_is_letter && !temp_cur.paragraph().getFontSettings(
 706                                 temp_cur.bv().buffer().params(),
 707                                 right_pos).isRightToLeft()))
 708                         break;
 709         }
 710
 711         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
 712                                          true, temp_cur.boundary());
 713 }
 714
 715
 716 void Text::selectWord(Cursor & cur, word_location loc)
 717 {
 718         LASSERT(this == cur.text(), /**/);
 719         CursorSlice from = cur.top();
 720         CursorSlice to = cur.top();
 721         getWord(from, to, loc);
 722         if (cur.top() != from)
 723                 setCursor(cur, from.pit(), from.pos());
 724         if (to == from)
 725                 return;
 726         cur.resetAnchor();
 727         setCursor(cur, to.pit(), to.pos());
 728         cur.setSelection();
 729 }
 730
 731
 732 // Select the word currently under the cursor when no
 733 // selection is currently set
 734 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
 735 {
 736         LASSERT(this == cur.text(), /**/);
 737         if (cur.selection())
 738                 return false;
 739         selectWord(cur, loc);
 740         return cur.selection();
 741 }
 742
 743
 744 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
 745 {
 746         LASSERT(this == cur.text(), /**/);
 747
 748         if (!cur.selection())
 749                 return;
 750
 751         cur.recordUndoSelection();
 752
 753         pit_type begPit = cur.selectionBegin().pit();
 754         pit_type endPit = cur.selectionEnd().pit();
 755
 756         pos_type begPos = cur.selectionBegin().pos();
 757         pos_type endPos = cur.selectionEnd().pos();
 758
 759         // keep selection info, because endPos becomes invalid after the first loop
 760         bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
 761
 762         // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
 763
 764         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 765                 pos_type parSize = pars_[pit].size();
 766
 767                 // ignore empty paragraphs; otherwise, an assertion will fail for
 768                 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
 769                 if (parSize == 0)
 770                         continue;
 771
 772                 // do not consider first paragraph if the cursor starts at pos size()
 773                 if (pit == begPit && begPos == parSize)
 774                         continue;
 775
 776                 // do not consider last paragraph if the cursor ends at pos 0
 777                 if (pit == endPit && endPos == 0)
 778                         break; // last iteration anyway
 779
 780                 pos_type left  = (pit == begPit ? begPos : 0);
 781                 pos_type right = (pit == endPit ? endPos : parSize);
 782
 783                 if (op == ACCEPT) {
 784                         pars_[pit].acceptChanges(cur.buffer().params(), left, right);
 785                 } else {
 786                         pars_[pit].rejectChanges(cur.buffer().params(), left, right);
 787                 }
 788         }
 789
 790         // next, accept/reject imaginary end-of-par characters
 791
 792         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 793                 pos_type pos = pars_[pit].size();
 794
 795                 // skip if the selection ends before the end-of-par
 796                 if (pit == endPit && endsBeforeEndOfPar)
 797                         break; // last iteration anyway
 798
 799                 // skip if this is not the last paragraph of the document
 800                 // note: the user should be able to accept/reject the par break of the last par!
 801                 if (pit == endPit && pit + 1 != int(pars_.size()))
 802                         break; // last iteration anway
 803
 804                 if (op == ACCEPT) {
 805                         if (pars_[pit].isInserted(pos)) {
 806                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 807                         } else if (pars_[pit].isDeleted(pos)) {
 808                                 if (pit + 1 == int(pars_.size())) {
 809                                         // we cannot remove a par break at the end of the last paragraph;
 810                                         // instead, we mark it unchanged
 811                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 812                                 } else {
 813                                         mergeParagraph(cur.buffer().params(), pars_, pit);
 814                                         --endPit;
 815                                         --pit;
 816                                 }
 817                         }
 818                 } else {
 819                         if (pars_[pit].isDeleted(pos)) {
 820                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 821                         } else if (pars_[pit].isInserted(pos)) {
 822                                 if (pit + 1 == int(pars_.size())) {
 823                                         // we mark the par break at the end of the last paragraph unchanged
 824                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 825                                 } else {
 826                                         mergeParagraph(cur.buffer().params(), pars_, pit);
 827                                         --endPit;
 828                                         --pit;
 829                                 }
 830                         }
 831                 }
 832         }
 833
 834         // finally, invoke the DEPM
 835
 836         deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer().params().trackChanges);
 837
 838         //
 839
 840         cur.finishUndo();
 841         cur.clearSelection();
 842         setCursorIntern(cur, begPit, begPos);
 843         cur.updateFlags(Update::Force);
 844         updateLabels(cur.buffer());
 845 }
 846
 847
 848 void Text::acceptChanges(BufferParams const & bparams)
 849 {
 850         lyx::acceptChanges(pars_, bparams);
 851         deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.trackChanges);
 852 }
 853
 854
 855 void Text::rejectChanges(BufferParams const & bparams)
 856 {
 857         pit_type pars_size = static_cast<pit_type>(pars_.size());
 858
 859         // first, reject changes within each individual paragraph
 860         // (do not consider end-of-par)
 861         for (pit_type pit = 0; pit < pars_size; ++pit) {
 862                 if (!pars_[pit].empty())   // prevent assertion failure
 863                         pars_[pit].rejectChanges(bparams, 0, pars_[pit].size());
 864         }
 865
 866         // next, reject imaginary end-of-par characters
 867         for (pit_type pit = 0; pit < pars_size; ++pit) {
 868                 pos_type pos = pars_[pit].size();
 869
 870                 if (pars_[pit].isDeleted(pos)) {
 871                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 872                 } else if (pars_[pit].isInserted(pos)) {
 873                         if (pit == pars_size - 1) {
 874                                 // we mark the par break at the end of the last
 875                                 // paragraph unchanged
 876                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 877                         } else {
 878                                 mergeParagraph(bparams, pars_, pit);
 879                                 --pit;
 880                                 --pars_size;
 881                         }
 882                 }
 883         }
 884
 885         // finally, invoke the DEPM
 886         deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.trackChanges);
 887 }
 888
 889
 890 void Text::deleteWordForward(Cursor & cur)
 891 {
 892         LASSERT(this == cur.text(), /**/);
 893         if (cur.lastpos() == 0)
 894                 cursorForward(cur);
 895         else {
 896                 cur.resetAnchor();
 897                 cur.selection() = true;
 898                 cursorForwardOneWord(cur);
 899                 cur.setSelection();
 900                 cutSelection(cur, true, false);
 901                 cur.checkBufferStructure();
 902         }
 903 }
 904
 905
 906 void Text::deleteWordBackward(Cursor & cur)
 907 {
 908         LASSERT(this == cur.text(), /**/);
 909         if (cur.lastpos() == 0)
 910                 cursorBackward(cur);
 911         else {
 912                 cur.resetAnchor();
 913                 cur.selection() = true;
 914                 cursorBackwardOneWord(cur);
 915                 cur.setSelection();
 916                 cutSelection(cur, true, false);
 917                 cur.checkBufferStructure();
 918         }
 919 }
 920
 921
 922 // Kill to end of line.
 923 void Text::changeCase(Cursor & cur, TextCase action)
 924 {
 925         LASSERT(this == cur.text(), /**/);
 926         CursorSlice from;
 927         CursorSlice to;
 928
 929         bool gotsel = false;
 930         if (cur.selection()) {
 931                 from = cur.selBegin();
 932                 to = cur.selEnd();
 933                 gotsel = true;
 934         } else {
 935                 from = cur.top();
 936                 getWord(from, to, PARTIAL_WORD);
 937                 cursorForwardOneWord(cur);
 938         }
 939
 940         cur.recordUndoSelection();
 941
 942         pit_type begPit = from.pit();
 943         pit_type endPit = to.pit();
 944
 945         pos_type begPos = from.pos();
 946         pos_type endPos = to.pos();
 947
 948         pos_type right = 0; // needed after the for loop
 949
 950         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 951                 Paragraph & par = pars_[pit];
 952                 pos_type const pos = (pit == begPit ? begPos : 0);
 953                 right = (pit == endPit ? endPos : par.size());
 954                 par.changeCase(cur.buffer().params(), pos, right, action);
 955         }
 956
 957         // the selection may have changed due to logically-only deleted chars
 958         if (gotsel) {
 959                 setCursor(cur, begPit, begPos);
 960                 cur.resetAnchor();
 961                 setCursor(cur, endPit, right);
 962                 cur.setSelection();
 963         } else
 964                 setCursor(cur, endPit, right);
 965
 966         cur.checkBufferStructure();
 967 }
 968
 969
 970 bool Text::handleBibitems(Cursor & cur)
 971 {
 972         if (cur.paragraph().layout().labeltype != LABEL_BIBLIO)
 973                 return false;
 974
 975         if (cur.pos() != 0)
 976                 return false;
 977
 978         BufferParams const & bufparams = cur.buffer().params();
 979         Paragraph const & par = cur.paragraph();
 980         Cursor prevcur = cur;
 981         if (cur.pit() > 0) {
 982                 --prevcur.pit();
 983                 prevcur.pos() = prevcur.lastpos();
 984         }
 985         Paragraph const & prevpar = prevcur.paragraph();
 986
 987         // if a bibitem is deleted, merge with previous paragraph
 988         // if this is a bibliography item as well
 989         if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
 990                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
 991                 mergeParagraph(bufparams, cur.text()->paragraphs(),
 992                                                         prevcur.pit());
 993                 updateLabels(cur.buffer());
 994                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
 995                 cur.updateFlags(Update::Force);
 996                 return true;
 997         }
 998
 999         // otherwise reset to default
1000         cur.paragraph().setEmptyOrDefaultLayout(bufparams.documentClass());
1001         return true;
1002 }
1003
1004
1005 bool Text::erase(Cursor & cur)
1006 {
1007         LASSERT(this == cur.text(), /**/);
1008         bool needsUpdate = false;
1009         Paragraph & par = cur.paragraph();
1010
1011         if (cur.pos() != cur.lastpos()) {
1012                 // this is the code for a normal delete, not pasting
1013                 // any paragraphs
1014                 cur.recordUndo(DELETE_UNDO);
1015                 bool const was_inset = cur.paragraph().isInset(cur.pos());
1016                 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges))
1017                         // the character has been logically deleted only => skip it
1018                         cur.top().forwardPos();
1019
1020                 if (was_inset)
1021                         updateLabels(cur.buffer());
1022                 else
1023                         cur.checkBufferStructure();
1024                 needsUpdate = true;
1025         } else {
1026                 if (cur.pit() == cur.lastpit())
1027                         return dissolveInset(cur);
1028
1029                 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1030                         par.setChange(cur.pos(), Change(Change::DELETED));
1031                         cur.forwardPos();
1032                         needsUpdate = true;
1033                 } else {
1034                         setCursorIntern(cur, cur.pit() + 1, 0);
1035                         needsUpdate = backspacePos0(cur);
1036                 }
1037         }
1038
1039         needsUpdate |= handleBibitems(cur);
1040
1041         if (needsUpdate) {
1042                 // Make sure the cursor is correct. Is this really needed?
1043                 // No, not really... at least not here!
1044                 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1045                 cur.checkBufferStructure();
1046         }
1047
1048         return needsUpdate;
1049 }
1050
1051
1052 bool Text::backspacePos0(Cursor & cur)
1053 {
1054         LASSERT(this == cur.text(), /**/);
1055         if (cur.pit() == 0)
1056                 return false;
1057
1058         bool needsUpdate = false;
1059
1060         BufferParams const & bufparams = cur.buffer().params();
1061         DocumentClass const & tclass = bufparams.documentClass();
1062         ParagraphList & plist = cur.text()->paragraphs();
1063         Paragraph const & par = cur.paragraph();
1064         Cursor prevcur = cur;
1065         --prevcur.pit();
1066         prevcur.pos() = prevcur.lastpos();
1067         Paragraph const & prevpar = prevcur.paragraph();
1068
1069         // is it an empty paragraph?
1070         if (cur.lastpos() == 0
1071             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1072                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1073                 plist.erase(boost::next(plist.begin(), cur.pit()));
1074                 needsUpdate = true;
1075         }
1076         // is previous par empty?
1077         else if (prevcur.lastpos() == 0
1078                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1079                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1080                 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1081                 needsUpdate = true;
1082         }
1083         // Pasting is not allowed, if the paragraphs have different
1084         // layouts. I think it is a real bug of all other
1085         // word processors to allow it. It confuses the user.
1086         // Correction: Pasting is always allowed with standard-layout
1087         // or the empty layout.
1088         else if (par.layout() == prevpar.layout()
1089                  || tclass.isDefaultLayout(par.layout())
1090                  || tclass.isEmptyLayout(par.layout())) {
1091                 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1092                 mergeParagraph(bufparams, plist, prevcur.pit());
1093                 needsUpdate = true;
1094         }
1095
1096         if (needsUpdate) {
1097                 updateLabels(cur.buffer());
1098                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1099         }
1100
1101         return needsUpdate;
1102 }
1103
1104
1105 bool Text::backspace(Cursor & cur)
1106 {
1107         LASSERT(this == cur.text(), /**/);
1108         bool needsUpdate = false;
1109         if (cur.pos() == 0) {
1110                 if (cur.pit() == 0)
1111                         return dissolveInset(cur);
1112
1113                 Paragraph & prev_par = pars_[cur.pit() - 1];
1114
1115                 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1116                         prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1117                         setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1118                         return true;
1119                 }
1120                 // The cursor is at the beginning of a paragraph, so
1121                 // the backspace will collapse two paragraphs into one.
1122                 needsUpdate = backspacePos0(cur);
1123
1124         } else {
1125                 // this is the code for a normal backspace, not pasting
1126                 // any paragraphs
1127                 cur.recordUndo(DELETE_UNDO);
1128                 // We used to do cursorBackwardIntern() here, but it is
1129                 // not a good idea since it triggers the auto-delete
1130                 // mechanism. So we do a cursorBackwardIntern()-lite,
1131                 // without the dreaded mechanism. (JMarc)
1132                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1133                                 false, cur.boundary());
1134                 bool const was_inset = cur.paragraph().isInset(cur.pos());
1135                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1136                 if (was_inset)
1137                         updateLabels(cur.buffer());
1138                 else
1139                         cur.checkBufferStructure();
1140         }
1141
1142         if (cur.pos() == cur.lastpos())
1143                 cur.setCurrentFont();
1144
1145         needsUpdate |= handleBibitems(cur);
1146
1147         // A singlePar update is not enough in this case.
1148 //              cur.updateFlags(Update::Force);
1149         setCursor(cur.top(), cur.pit(), cur.pos());
1150
1151         return needsUpdate;
1152 }
1153
1154
1155 bool Text::dissolveInset(Cursor & cur) {
1156         LASSERT(this == cur.text(), /**/);
1157
1158         if (isMainText(cur.bv().buffer()) || cur.inset().nargs() != 1)
1159                 return false;
1160
1161         cur.recordUndoInset();
1162         cur.mark() = false;
1163         cur.selHandle(false);
1164         // save position
1165         pos_type spos = cur.pos();
1166         pit_type spit = cur.pit();
1167         ParagraphList plist;
1168         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1169                 plist = paragraphs();
1170         cur.popBackward();
1171         // store cursor offset
1172         if (spit == 0)
1173                 spos += cur.pos();
1174         spit += cur.pit();
1175         Buffer & b = cur.buffer();
1176         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1177         if (!plist.empty()) {
1178                 // ERT paragraphs have the Language latex_language.
1179                 // This is invalid outside of ERT, so we need to
1180                 // change it to the buffer language.
1181                 ParagraphList::iterator it = plist.begin();
1182                 ParagraphList::iterator it_end = plist.end();
1183                 for (; it != it_end; it++)
1184                         it->changeLanguage(b.params(), latex_language, b.language());
1185
1186                 pasteParagraphList(cur, plist, b.params().documentClassPtr(),
1187                                    b.errorList("Paste"));
1188                 // restore position
1189                 cur.pit() = min(cur.lastpit(), spit);
1190                 cur.pos() = min(cur.lastpos(), spos);
1191         }
1192         cur.clearSelection();
1193         cur.resetAnchor();
1194         return true;
1195 }
1196
1197
1198 void Text::getWord(CursorSlice & from, CursorSlice & to,
1199         word_location const loc) const
1200 {
1201         Paragraph const & from_par = pars_[from.pit()];
1202         switch (loc) {
1203         case WHOLE_WORD_STRICT:
1204                 if (from.pos() == 0 || from.pos() == from_par.size()
1205                     || !from_par.isLetter(from.pos())
1206                     || !from_par.isLetter(from.pos() - 1)) {
1207                         to = from;
1208                         return;
1209                 }
1210                 // no break here, we go to the next
1211
1212         case WHOLE_WORD:
1213                 // If we are already at the beginning of a word, do nothing
1214                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1215                         break;
1216                 // no break here, we go to the next
1217
1218         case PREVIOUS_WORD:
1219                 // always move the cursor to the beginning of previous word
1220                 while (from.pos() && from_par.isLetter(from.pos() - 1))
1221                         --from.pos();
1222                 break;
1223         case NEXT_WORD:
1224                 LYXERR0("Text::getWord: NEXT_WORD not implemented yet");
1225                 break;
1226         case PARTIAL_WORD:
1227                 // no need to move the 'from' cursor
1228                 break;
1229         }
1230         to = from;
1231         Paragraph const & to_par = pars_[to.pit()];
1232         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1233                 ++to.pos();
1234 }
1235
1236
1237 void Text::write(Buffer const & buf, ostream & os) const
1238 {
1239         ParagraphList::const_iterator pit = paragraphs().begin();
1240         ParagraphList::const_iterator end = paragraphs().end();
1241         depth_type dth = 0;
1242         for (; pit != end; ++pit)
1243                 pit->write(os, buf.params(), dth);
1244
1245         // Close begin_deeper
1246         for(; dth > 0; --dth)
1247                 os << "\n\\end_deeper";
1248 }
1249
1250
1251 bool Text::read(Buffer const & buf, Lexer & lex,
1252                 ErrorList & errorList, InsetText * insetPtr)
1253 {
1254         depth_type depth = 0;
1255
1256         while (lex.isOK()) {
1257                 lex.nextToken();
1258                 string const token = lex.getString();
1259
1260                 if (token.empty())
1261                         continue;
1262
1263                 if (token == "\\end_inset")
1264                         break;
1265
1266                 if (token == "\\end_body")
1267                         continue;
1268
1269                 if (token == "\\begin_body")
1270                         continue;
1271
1272                 if (token == "\\end_document")
1273                         return false;
1274
1275                 if (token == "\\begin_layout") {
1276                         lex.pushToken(token);
1277
1278                         Paragraph par;
1279                         par.params().depth(depth);
1280                         par.setFont(0, Font(inherit_font, buf.params().language));
1281                         par.setInsetOwner(insetPtr);
1282                         pars_.push_back(par);
1283
1284                         // FIXME: goddamn InsetTabular makes us pass a Buffer
1285                         // not BufferParams
1286                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
1287
1288                         // register the words in the global word list
1289                         CursorSlice sl = CursorSlice(*insetPtr);
1290                         sl.pit() = pars_.size() - 1;
1291                         pars_.back().updateWords(sl);
1292                 } else if (token == "\\begin_deeper") {
1293                         ++depth;
1294                 } else if (token == "\\end_deeper") {
1295                         if (!depth)
1296                                 lex.printError("\\end_deeper: " "depth is already null");
1297                         else
1298                                 --depth;
1299                 } else {
1300                         LYXERR0("Handling unknown body token: `" << token << '\'');
1301                 }
1302         }
1303         return true;
1304 }
1305
1306 // Returns the current font and depth as a message.
1307 docstring Text::currentState(Cursor & cur)
1308 {
1309         LASSERT(this == cur.text(), /**/);
1310         Buffer & buf = cur.buffer();
1311         Paragraph const & par = cur.paragraph();
1312         odocstringstream os;
1313
1314         if (buf.params().trackChanges)
1315                 os << _("[Change Tracking] ");
1316
1317         Change change = par.lookupChange(cur.pos());
1318
1319         if (change.type != Change::UNCHANGED) {
1320                 Author const & a = buf.params().authors().get(change.author);
1321                 os << _("Change: ") << a.name();
1322                 if (!a.email().empty())
1323                         os << " (" << a.email() << ")";
1324                 // FIXME ctime is english, we should translate that
1325                 os << _(" at ") << ctime(&change.changetime);
1326                 os << " : ";
1327         }
1328
1329         // I think we should only show changes from the default
1330         // font. (Asger)
1331         // No, from the document font (MV)
1332         Font font = cur.real_current_font;
1333         font.fontInfo().reduce(buf.params().getFont().fontInfo());
1334
1335         os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1336
1337         // The paragraph depth
1338         int depth = cur.paragraph().getDepth();
1339         if (depth > 0)
1340                 os << bformat(_(", Depth: %1$d"), depth);
1341
1342         // The paragraph spacing, but only if different from
1343         // buffer spacing.
1344         Spacing const & spacing = par.params().spacing();
1345         if (!spacing.isDefault()) {
1346                 os << _(", Spacing: ");
1347                 switch (spacing.getSpace()) {
1348                 case Spacing::Single:
1349                         os << _("Single");
1350                         break;
1351                 case Spacing::Onehalf:
1352                         os << _("OneHalf");
1353                         break;
1354                 case Spacing::Double:
1355                         os << _("Double");
1356                         break;
1357                 case Spacing::Other:
1358                         os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1359                         break;
1360                 case Spacing::Default:
1361                         // should never happen, do nothing
1362                         break;
1363                 }
1364         }
1365
1366 #ifdef DEVEL_VERSION
1367         os << _(", Inset: ") << &cur.inset();
1368         os << _(", Paragraph: ") << cur.pit();
1369         os << _(", Id: ") << par.id();
1370         os << _(", Position: ") << cur.pos();
1371         // FIXME: Why is the check for par.size() needed?
1372         // We are called with cur.pos() == par.size() quite often.
1373         if (!par.empty() && cur.pos() < par.size()) {
1374                 // Force output of code point, not character
1375                 size_t const c = par.getChar(cur.pos());
1376                 os << _(", Char: 0x") << hex << c;
1377         }
1378         os << _(", Boundary: ") << cur.boundary();
1379 //      Row & row = cur.textRow();
1380 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1381 #endif
1382         return os.str();
1383 }
1384
1385
1386 docstring Text::getPossibleLabel(Cursor & cur) const
1387 {
1388         pit_type pit = cur.pit();
1389
1390         Layout const * layout = &(pars_[pit].layout());
1391
1392         docstring text;
1393         docstring par_text = pars_[pit].asString();
1394         string piece;
1395         // the return string of math matrices might contain linebreaks
1396         par_text = subst(par_text, '\n', '-');
1397         for (int i = 0; i < lyxrc.label_init_length; ++i) {
1398                 if (par_text.empty())
1399                         break;
1400                 docstring head;
1401                 par_text = split(par_text, head, ' ');
1402                 // Is it legal to use spaces in labels ?
1403                 if (i > 0)
1404                         text += '-';
1405                 text += head;
1406         }
1407
1408         // No need for a prefix if the user said so.
1409         if (lyxrc.label_init_length <= 0)
1410                 return text;
1411
1412         // Will contain the label type.
1413         docstring name;
1414
1415         // For section, subsection, etc...
1416         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1417                 Layout const * layout2 = &(pars_[pit - 1].layout());
1418                 if (layout2->latextype != LATEX_PARAGRAPH) {
1419                         --pit;
1420                         layout = layout2;
1421                 }
1422         }
1423         if (layout->latextype != LATEX_PARAGRAPH)
1424                 name = from_ascii(layout->latexname());
1425
1426         // for captions, we just take the caption type
1427         Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1428         if (caption_inset)
1429                 name = from_ascii(static_cast<InsetCaption *>(caption_inset)->type());
1430
1431         // If none of the above worked, we'll see if we're inside various
1432         // types of insets and take our abbreviation from them.
1433         if (name.empty()) {
1434                 InsetCode const codes[] = {
1435                         FLOAT_CODE,
1436                         WRAP_CODE,
1437                         FOOT_CODE
1438                 };
1439                 for (unsigned int i = 0; i < (sizeof codes / sizeof codes[0]); ++i) {
1440                         Inset * float_inset = cur.innerInsetOfType(codes[i]);
1441                         if (float_inset) {
1442                                 name = float_inset->name();
1443                                 break;
1444                         }
1445                 }
1446         }
1447
1448         // Create a correct prefix for prettyref
1449         if (name == "theorem")
1450                 name = from_ascii("thm");
1451         else if (name == "Foot")
1452                 name = from_ascii("fn");
1453         else if (name == "listing")
1454                 name = from_ascii("lst");
1455
1456         if (!name.empty())
1457                 text = name.substr(0, 3) + ':' + text;
1458
1459         return text;
1460 }
1461
1462
1463 void Text::charsTranspose(Cursor & cur)
1464 {
1465         LASSERT(this == cur.text(), /**/);
1466
1467         pos_type pos = cur.pos();
1468
1469         // If cursor is at beginning or end of paragraph, do nothing.
1470         if (pos == cur.lastpos() || pos == 0)
1471                 return;
1472
1473         Paragraph & par = cur.paragraph();
1474
1475         // Get the positions of the characters to be transposed.
1476         pos_type pos1 = pos - 1;
1477         pos_type pos2 = pos;
1478
1479         // In change tracking mode, ignore deleted characters.
1480         while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1481                 ++pos2;
1482         if (pos2 == cur.lastpos())
1483                 return;
1484
1485         while (pos1 >= 0 && par.isDeleted(pos1))
1486                 --pos1;
1487         if (pos1 < 0)
1488                 return;
1489
1490         // Don't do anything if one of the "characters" is not regular text.
1491         if (par.isInset(pos1) || par.isInset(pos2))
1492                 return;
1493
1494         // Store the characters to be transposed (including font information).
1495         char_type char1 = par.getChar(pos1);
1496         Font const font1 =
1497                 par.getFontSettings(cur.buffer().params(), pos1);
1498
1499         char_type char2 = par.getChar(pos2);
1500         Font const font2 =
1501                 par.getFontSettings(cur.buffer().params(), pos2);
1502
1503         // And finally, we are ready to perform the transposition.
1504         // Track the changes if Change Tracking is enabled.
1505         bool const trackChanges = cur.buffer().params().trackChanges;
1506
1507         cur.recordUndo();
1508
1509         par.eraseChar(pos2, trackChanges);
1510         par.eraseChar(pos1, trackChanges);
1511         par.insertChar(pos1, char2, font2, trackChanges);
1512         par.insertChar(pos2, char1, font1, trackChanges);
1513
1514         cur.checkBufferStructure();
1515
1516         // After the transposition, move cursor to after the transposition.
1517         setCursor(cur, cur.pit(), pos2);
1518         cur.forwardPos();
1519 }
1520
1521
1522 DocIterator Text::macrocontextPosition() const
1523 {
1524         return macrocontext_position_;
1525 }
1526
1527
1528 void Text::setMacrocontextPosition(DocIterator const & pos)
1529 {
1530         macrocontext_position_ = pos;
1531 }
1532
1533
1534 docstring Text::previousWord(CursorSlice const & sl) const
1535 {
1536         CursorSlice from = sl;
1537         CursorSlice to = sl;
1538         getWord(from, to, PREVIOUS_WORD);
1539         if (sl == from || to == from)
1540                 return docstring();
1541
1542         Paragraph const & par = sl.paragraph();
1543         return par.asString(from.pos(), to.pos());
1544 }
1545
1546
1547 bool Text::completionSupported(Cursor const & cur) const
1548 {
1549         Paragraph const & par = cur.paragraph();
1550         return cur.pos() > 0
1551                 && (cur.pos() >= par.size() || !par.isLetter(cur.pos()))
1552                 && par.isLetter(cur.pos() - 1);
1553 }
1554
1555
1556 CompletionList const * Text::createCompletionList(Cursor const & cur) const
1557 {
1558         return new TextCompletionList(cur);
1559 }
1560
1561
1562 bool Text::insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/)
1563 {
1564         LASSERT(cur.bv().cursor() == cur, /**/);
1565         cur.insert(s);
1566         cur.bv().cursor() = cur;
1567         if (!(cur.disp_.update() & Update::Force))
1568                 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
1569         return true;
1570 }
1571
1572
1573 docstring Text::completionPrefix(Cursor const & cur) const
1574 {
1575         return previousWord(cur.top());
1576 }
1577
1578 } // namespace lyx