src/text.C

   1 /**
   2  * \file src/text.C
   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 Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Dekel Tsur
  12  * \author Jürgen Vigna
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "lyxtext.h"
  20
  21 #include "author.h"
  22 #include "buffer.h"
  23 #include "buffer_funcs.h"
  24 #include "bufferparams.h"
  25 #include "BufferView.h"
  26 #include "bufferview_funcs.h"
  27 #include "cursor.h"
  28 #include "pariterator.h"
  29 #include "coordcache.h"
  30 #include "CutAndPaste.h"
  31 #include "debug.h"
  32 #include "dispatchresult.h"
  33 #include "encoding.h"
  34 #include "errorlist.h"
  35 #include "funcrequest.h"
  36 #include "factory.h"
  37 #include "FontIterator.h"
  38 #include "gettext.h"
  39 #include "language.h"
  40 #include "LColor.h"
  41 #include "lyxlength.h"
  42 #include "lyxlex.h"
  43 #include "lyxrc.h"
  44 #include "lyxrow.h"
  45 #include "metricsinfo.h"
  46 #include "paragraph.h"
  47 #include "paragraph_funcs.h"
  48 #include "ParagraphParameters.h"
  49 #include "rowpainter.h"
  50 #include "undo.h"
  51 #include "vspace.h"
  52 #include "WordLangTuple.h"
  53
  54 #include "frontends/FontMetrics.h"
  55 #include "frontends/Painter.h"
  56 #include "frontends/Selection.h"
  57
  58 #include "insets/insettext.h"
  59 #include "insets/insetbibitem.h"
  60 #include "insets/insethfill.h"
  61 #include "insets/insetlatexaccent.h"
  62 #include "insets/insetline.h"
  63 #include "insets/insetnewline.h"
  64 #include "insets/insetpagebreak.h"
  65 #include "insets/insetoptarg.h"
  66 #include "insets/insetspace.h"
  67 #include "insets/insetspecialchar.h"
  68 #include "insets/insettabular.h"
  69
  70 #include "support/lstrings.h"
  71 #include "support/textutils.h"
  72 #include "support/convert.h"
  73
  74 #include <boost/current_function.hpp>
  75
  76 #include <sstream>
  77
  78 using std::auto_ptr;
  79 using std::advance;
  80 using std::distance;
  81 using std::max;
  82 using std::min;
  83 using std::endl;
  84 using std::string;
  85
  86 namespace lyx {
  87
  88 using support::bformat;
  89 using support::contains;
  90 using support::lowercase;
  91 using support::split;
  92 using support::uppercase;
  93
  94 using cap::cutSelection;
  95 using cap::pasteParagraphList;
  96
  97 using frontend::FontMetrics;
  98
  99 namespace {
 100
 101 void readParToken(Buffer const & buf, Paragraph & par, LyXLex & lex,
 102         string const & token, LyXFont & font, Change & change, ErrorList & errorList)
 103 {
 104         BufferParams const & bp = buf.params();
 105
 106         if (token[0] != '\\') {
 107 #if 0
 108                 string::const_iterator cit = token.begin();
 109                 for (; cit != token.end(); ++cit)
 110                         par.insertChar(par.size(), (*cit), font, change);
 111 #else
 112                 docstring dstr = lex.getDocString();
 113                 docstring::const_iterator cit = dstr.begin();
 114                 docstring::const_iterator cend = dstr.end();
 115                 for (; cit != cend; ++cit)
 116                         par.insertChar(par.size(), *cit, font, change);
 117 #endif
 118         } else if (token == "\\begin_layout") {
 119                 lex.eatLine();
 120                 string layoutname = lex.getString();
 121
 122                 font = LyXFont(LyXFont::ALL_INHERIT, bp.language);
 123                 change = Change(Change::UNCHANGED);
 124
 125                 LyXTextClass const & tclass = bp.getLyXTextClass();
 126
 127                 if (layoutname.empty()) {
 128                         layoutname = tclass.defaultLayoutName();
 129                 }
 130
 131                 bool hasLayout = tclass.hasLayout(layoutname);
 132
 133                 if (!hasLayout) {
 134                         errorList.push_back(ErrorItem(_("Unknown layout"),
 135                         bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
 136                         from_utf8(layoutname), from_utf8(tclass.name())), par.id(), 0, par.size()));
 137                         layoutname = tclass.defaultLayoutName();
 138                 }
 139
 140                 par.layout(bp.getLyXTextClass()[layoutname]);
 141
 142                 // Test whether the layout is obsolete.
 143                 LyXLayout_ptr const & layout = par.layout();
 144                 if (!layout->obsoleted_by().empty())
 145                         par.layout(bp.getLyXTextClass()[layout->obsoleted_by()]);
 146
 147                 par.params().read(lex);
 148
 149         } else if (token == "\\end_layout") {
 150                 lyxerr << BOOST_CURRENT_FUNCTION
 151                        << ": Solitary \\end_layout in line "
 152                        << lex.getLineNo() << "\n"
 153                        << "Missing \\begin_layout?.\n";
 154         } else if (token == "\\end_inset") {
 155                 lyxerr << BOOST_CURRENT_FUNCTION
 156                        << ": Solitary \\end_inset in line "
 157                        << lex.getLineNo() << "\n"
 158                        << "Missing \\begin_inset?.\n";
 159         } else if (token == "\\begin_inset") {
 160                 InsetBase * inset = readInset(lex, buf);
 161                 if (inset)
 162                         par.insertInset(par.size(), inset, font, change);
 163                 else {
 164                         lex.eatLine();
 165                         docstring line = lex.getDocString();
 166                         errorList.push_back(ErrorItem(_("Unknown Inset"), line,
 167                                             par.id(), 0, par.size()));
 168                 }
 169         } else if (token == "\\family") {
 170                 lex.next();
 171                 font.setLyXFamily(lex.getString());
 172         } else if (token == "\\series") {
 173                 lex.next();
 174                 font.setLyXSeries(lex.getString());
 175         } else if (token == "\\shape") {
 176                 lex.next();
 177                 font.setLyXShape(lex.getString());
 178         } else if (token == "\\size") {
 179                 lex.next();
 180                 font.setLyXSize(lex.getString());
 181         } else if (token == "\\lang") {
 182                 lex.next();
 183                 string const tok = lex.getString();
 184                 Language const * lang = languages.getLanguage(tok);
 185                 if (lang) {
 186                         font.setLanguage(lang);
 187                 } else {
 188                         font.setLanguage(bp.language);
 189                         lex.printError("Unknown language `$$Token'");
 190                 }
 191         } else if (token == "\\numeric") {
 192                 lex.next();
 193                 font.setNumber(font.setLyXMisc(lex.getString()));
 194         } else if (token == "\\emph") {
 195                 lex.next();
 196                 font.setEmph(font.setLyXMisc(lex.getString()));
 197         } else if (token == "\\bar") {
 198                 lex.next();
 199                 string const tok = lex.getString();
 200
 201                 if (tok == "under")
 202                         font.setUnderbar(LyXFont::ON);
 203                 else if (tok == "no")
 204                         font.setUnderbar(LyXFont::OFF);
 205                 else if (tok == "default")
 206                         font.setUnderbar(LyXFont::INHERIT);
 207                 else
 208                         lex.printError("Unknown bar font flag "
 209                                        "`$$Token'");
 210         } else if (token == "\\noun") {
 211                 lex.next();
 212                 font.setNoun(font.setLyXMisc(lex.getString()));
 213         } else if (token == "\\color") {
 214                 lex.next();
 215                 font.setLyXColor(lex.getString());
 216         } else if (token == "\\InsetSpace" || token == "\\SpecialChar") {
 217
 218                 // Insets don't make sense in a free-spacing context! ---Kayvan
 219                 if (par.isFreeSpacing()) {
 220                         if (token == "\\InsetSpace")
 221                                 par.insertChar(par.size(), ' ', font, change);
 222                         else if (lex.isOK()) {
 223                                 lex.next();
 224                                 string const next_token = lex.getString();
 225                                 if (next_token == "\\-")
 226                                         par.insertChar(par.size(), '-', font, change);
 227                                 else {
 228                                         lex.printError("Token `$$Token' "
 229                                                        "is in free space "
 230                                                        "paragraph layout!");
 231                                 }
 232                         }
 233                 } else {
 234                         auto_ptr<InsetBase> inset;
 235                         if (token == "\\SpecialChar" )
 236                                 inset.reset(new InsetSpecialChar);
 237                         else
 238                                 inset.reset(new InsetSpace);
 239                         inset->read(buf, lex);
 240                         par.insertInset(par.size(), inset.release(),
 241                                         font, change);
 242                 }
 243         } else if (token == "\\i") {
 244                 auto_ptr<InsetBase> inset(new InsetLatexAccent);
 245                 inset->read(buf, lex);
 246                 par.insertInset(par.size(), inset.release(), font, change);
 247         } else if (token == "\\backslash") {
 248                 par.insertChar(par.size(), '\\', font, change);
 249         } else if (token == "\\newline") {
 250                 auto_ptr<InsetBase> inset(new InsetNewline);
 251                 inset->read(buf, lex);
 252                 par.insertInset(par.size(), inset.release(), font, change);
 253         } else if (token == "\\LyXTable") {
 254                 auto_ptr<InsetBase> inset(new InsetTabular(buf));
 255                 inset->read(buf, lex);
 256                 par.insertInset(par.size(), inset.release(), font, change);
 257         } else if (token == "\\hfill") {
 258                 par.insertInset(par.size(), new InsetHFill, font, change);
 259         } else if (token == "\\lyxline") {
 260                 par.insertInset(par.size(), new InsetLine, font, change);
 261         } else if (token == "\\newpage") {
 262                 par.insertInset(par.size(), new InsetPagebreak, font, change);
 263         } else if (token == "\\clearpage") {
 264                 par.insertInset(par.size(), new InsetClearPage, font, change);
 265         } else if (token == "\\cleardoublepage") {
 266                 par.insertInset(par.size(), new InsetClearDoublePage, font, change);
 267         } else if (token == "\\change_unchanged") {
 268                 change = Change(Change::UNCHANGED);
 269         } else if (token == "\\change_inserted") {
 270                 lex.eatLine();
 271                 std::istringstream is(lex.getString());
 272                 unsigned int aid;
 273                 time_type ct;
 274                 is >> aid >> ct;
 275                 if (aid >= bp.author_map.size()) {
 276                         errorList.push_back(ErrorItem(_("Change tracking error"),
 277                                             bformat(_("Unknown author index for insertion: %1$d\n"), aid),
 278                                             par.id(), 0, par.size()));
 279                         change = Change(Change::UNCHANGED);
 280                 } else
 281                         change = Change(Change::INSERTED, bp.author_map[aid], ct);
 282         } else if (token == "\\change_deleted") {
 283                 lex.eatLine();
 284                 std::istringstream is(lex.getString());
 285                 unsigned int aid;
 286                 time_type ct;
 287                 is >> aid >> ct;
 288                 if (aid >= bp.author_map.size()) {
 289                         errorList.push_back(ErrorItem(_("Change tracking error"),
 290                                             bformat(_("Unknown author index for deletion: %1$d\n"), aid),
 291                                             par.id(), 0, par.size()));
 292                         change = Change(Change::UNCHANGED);
 293                 } else
 294                         change = Change(Change::DELETED, bp.author_map[aid], ct);
 295         } else {
 296                 lex.eatLine();
 297                 errorList.push_back(ErrorItem(_("Unknown token"),
 298                         bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
 299                         lex.getDocString()),
 300                         par.id(), 0, par.size()));
 301         }
 302 }
 303
 304
 305 void readParagraph(Buffer const & buf, Paragraph & par, LyXLex & lex,
 306         ErrorList & errorList)
 307 {
 308         lex.nextToken();
 309         string token = lex.getString();
 310         LyXFont font;
 311         Change change(Change::UNCHANGED);
 312
 313         while (lex.isOK()) {
 314                 readParToken(buf, par, lex, token, font, change, errorList);
 315
 316                 lex.nextToken();
 317                 token = lex.getString();
 318
 319                 if (token.empty())
 320                         continue;
 321
 322                 if (token == "\\end_layout") {
 323                         //Ok, paragraph finished
 324                         break;
 325                 }
 326
 327                 lyxerr[Debug::PARSER] << "Handling paragraph token: `"
 328                                       << token << '\'' << endl;
 329                 if (token == "\\begin_layout" || token == "\\end_document"
 330                     || token == "\\end_inset" || token == "\\begin_deeper"
 331                     || token == "\\end_deeper") {
 332                         lex.pushToken(token);
 333                         lyxerr << "Paragraph ended in line "
 334                                << lex.getLineNo() << "\n"
 335                                << "Missing \\end_layout.\n";
 336                         break;
 337                 }
 338         }
 339         // Final change goes to paragraph break:
 340         par.setChange(par.size(), change);
 341
 342         // Initialize begin_of_body_ on load; redoParagraph maintains
 343         par.setBeginOfBody();
 344 }
 345
 346
 347 } // namespace anon
 348
 349
 350
 351 double LyXText::spacing(Buffer const & buffer,
 352                 Paragraph const & par) const
 353 {
 354         if (par.params().spacing().isDefault())
 355                 return buffer.params().spacing().getValue();
 356         return par.params().spacing().getValue();
 357 }
 358
 359
 360 int LyXText::singleWidth(Buffer const & buffer, Paragraph const & par,
 361                 pos_type pos) const
 362 {
 363         return singleWidth(par, pos, par.getChar(pos),
 364                 getFont(buffer, par, pos));
 365 }
 366
 367
 368 int LyXText::singleWidth(Paragraph const & par,
 369                          pos_type pos, char_type c, LyXFont const & font) const
 370 {
 371         // The most common case is handled first (Asger)
 372         if (isPrintable(c)) {
 373                 Language const * language = font.language();
 374                 if (language->rightToLeft()) {
 375                         if ((lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
 376                              lyxrc.font_norm_type == LyXRC::ISO_10646_1)
 377                             && language->lang() == "arabic") {
 378                                 if (Encodings::isComposeChar_arabic(c))
 379                                         return 0;
 380                                 c = par.transformChar(c, pos);
 381                         } else if (language->lang() == "hebrew" &&
 382                                    Encodings::isComposeChar_hebrew(c))
 383                                 return 0;
 384                 }
 385                 return theFontMetrics(font).width(c);
 386         }
 387
 388         if (c == Paragraph::META_INSET)
 389                 return par.getInset(pos)->width();
 390
 391         return theFontMetrics(font).width(c);
 392 }
 393
 394
 395 int LyXText::leftMargin(Buffer const & buffer, int max_width, pit_type pit) const
 396 {
 397         BOOST_ASSERT(pit >= 0);
 398         BOOST_ASSERT(pit < int(pars_.size()));
 399         return leftMargin(buffer, max_width, pit, pars_[pit].size());
 400 }
 401
 402
 403 int LyXText::leftMargin(Buffer const & buffer, int max_width,
 404                 pit_type const pit, pos_type const pos) const
 405 {
 406         BOOST_ASSERT(pit >= 0);
 407         BOOST_ASSERT(pit < int(pars_.size()));
 408         Paragraph const & par = pars_[pit];
 409         BOOST_ASSERT(pos >= 0);
 410         BOOST_ASSERT(pos <= par.size());
 411         //lyxerr << "LyXText::leftMargin: pit: " << pit << " pos: " << pos << endl;
 412         LyXTextClass const & tclass = buffer.params().getLyXTextClass();
 413         LyXLayout_ptr const & layout = par.layout();
 414
 415         string parindent = layout->parindent;
 416
 417         int l_margin = 0;
 418
 419         if (isMainText(buffer))
 420                 l_margin += changebarMargin();
 421
 422         // FIXME UNICODE
 423         docstring leftm = from_utf8(tclass.leftmargin());
 424         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm);
 425
 426         if (par.getDepth() != 0) {
 427                 // find the next level paragraph
 428                 pit_type newpar = outerHook(pit, pars_);
 429                 if (newpar != pit_type(pars_.size())) {
 430                         if (pars_[newpar].layout()->isEnvironment()) {
 431                                 l_margin = leftMargin(buffer, max_width, newpar);
 432                         }
 433                         if (par.layout() == tclass.defaultLayout()) {
 434                                 if (pars_[newpar].params().noindent())
 435                                         parindent.erase();
 436                                 else
 437                                         parindent = pars_[newpar].layout()->parindent;
 438                         }
 439                 }
 440         }
 441
 442         // This happens after sections in standard classes. The 1.3.x
 443         // code compared depths too, but it does not seem necessary
 444         // (JMarc)
 445         if (par.layout() == tclass.defaultLayout()
 446             && pit > 0 && pars_[pit - 1].layout()->nextnoindent)
 447                 parindent.erase();
 448
 449         LyXFont const labelfont = getLabelFont(buffer, par);
 450         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 451
 452         switch (layout->margintype) {
 453         case MARGIN_DYNAMIC:
 454                 if (!layout->leftmargin.empty()) {
 455                         // FIXME UNICODE
 456                         docstring leftm = from_utf8(layout->leftmargin);
 457                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm);
 458                 }
 459                 if (!par.getLabelstring().empty()) {
 460                         // FIXME UNICODE
 461                         docstring labin = from_utf8(layout->labelindent);
 462                         l_margin += labelfont_metrics.signedWidth(labin);
 463                         docstring labstr = par.getLabelstring();
 464                         l_margin += labelfont_metrics.width(labstr);
 465                         docstring labsep = from_utf8(layout->labelsep);
 466                         l_margin += labelfont_metrics.width(labsep);
 467                 }
 468                 break;
 469
 470         case MARGIN_MANUAL: {
 471                 // FIXME UNICODE
 472                 docstring labin = from_utf8(layout->labelindent);
 473                 l_margin += labelfont_metrics.signedWidth(labin);
 474                 // The width of an empty par, even with manual label, should be 0
 475                 if (!par.empty() && pos >= par.beginOfBody()) {
 476                         if (!par.getLabelWidthString().empty()) {
 477                                 docstring labstr = par.getLabelWidthString();
 478                                 l_margin += labelfont_metrics.width(labstr);
 479                                 docstring labsep = from_utf8(layout->labelsep);
 480                                 l_margin += labelfont_metrics.width(labsep);
 481                         }
 482                 }
 483                 break;
 484         }
 485
 486         case MARGIN_STATIC: {
 487                 // FIXME UNICODE
 488                 docstring leftm = from_utf8(layout->leftmargin);
 489                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm)
 490                         * 4     / (par.getDepth() + 4);
 491                 break;
 492         }
 493
 494         case MARGIN_FIRST_DYNAMIC:
 495                 if (layout->labeltype == LABEL_MANUAL) {
 496                         if (pos >= par.beginOfBody()) {
 497                                 // FIXME UNICODE
 498                                 l_margin += labelfont_metrics.signedWidth(
 499                                         from_utf8(layout->leftmargin));
 500                         } else {
 501                                 // FIXME UNICODE
 502                                 l_margin += labelfont_metrics.signedWidth(
 503                                         from_utf8(layout->labelindent));
 504                         }
 505                 } else if (pos != 0
 506                            // Special case to fix problems with
 507                            // theorems (JMarc)
 508                            || (layout->labeltype == LABEL_STATIC
 509                                && layout->latextype == LATEX_ENVIRONMENT
 510                                && !isFirstInSequence(pit, pars_))) {
 511                         // FIXME UNICODE
 512                         l_margin += labelfont_metrics.signedWidth(from_utf8(layout->leftmargin));
 513                 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
 514                            && layout->labeltype != LABEL_BIBLIO
 515                            && layout->labeltype !=
 516                            LABEL_CENTERED_TOP_ENVIRONMENT) {
 517                         l_margin += labelfont_metrics.signedWidth(from_utf8(layout->labelindent));
 518                         l_margin += labelfont_metrics.width(from_utf8(layout->labelsep));
 519                         l_margin += labelfont_metrics.width(par.getLabelstring());
 520                 }
 521                 break;
 522
 523         case MARGIN_RIGHT_ADDRESS_BOX: {
 524 #if 0
 525                 // ok, a terrible hack. The left margin depends on the widest
 526                 // row in this paragraph.
 527                 RowList::iterator rit = par.rows().begin();
 528                 RowList::iterator end = par.rows().end();
 529 #ifdef WITH_WARNINGS
 530 #warning This is wrong.
 531 #endif
 532                 int minfill = max_width;
 533                 for ( ; rit != end; ++rit)
 534                         if (rit->fill() < minfill)
 535                                 minfill = rit->fill();
 536                 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
 537                 l_margin += minfill;
 538 #endif
 539                 // also wrong, but much shorter.
 540                 l_margin += max_width / 2;
 541                 break;
 542         }
 543         }
 544
 545         if (!par.params().leftIndent().zero())
 546                 l_margin += par.params().leftIndent().inPixels(max_width);
 547
 548         LyXAlignment align;
 549
 550         if (par.params().align() == LYX_ALIGN_LAYOUT)
 551                 align = layout->align;
 552         else
 553                 align = par.params().align();
 554
 555         // set the correct parindent
 556         if (pos == 0
 557             && (layout->labeltype == LABEL_NO_LABEL
 558                || layout->labeltype == LABEL_TOP_ENVIRONMENT
 559                || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
 560                || (layout->labeltype == LABEL_STATIC
 561                    && layout->latextype == LATEX_ENVIRONMENT
 562                    && !isFirstInSequence(pit, pars_)))
 563             && align == LYX_ALIGN_BLOCK
 564             && !par.params().noindent()
 565             // in some insets, paragraphs are never indented
 566             && !(par.inInset() && par.inInset()->neverIndent(buffer))
 567             // display style insets are always centered, omit indentation
 568             && !(!par.empty()
 569                     && par.isInset(pos)
 570                     && par.getInset(pos)->display())
 571             && (par.layout() != tclass.defaultLayout()
 572                 || buffer.params().paragraph_separation ==
 573                    BufferParams::PARSEP_INDENT))
 574         {
 575                 docstring din = from_utf8(parindent);
 576                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(din);
 577         }
 578
 579         return l_margin;
 580 }
 581
 582
 583 LColor_color LyXText::backgroundColor() const
 584 {
 585         return LColor_color(LColor::color(background_color_));
 586 }
 587
 588
 589 void LyXText::breakParagraph(LCursor & cur, bool keep_layout)
 590 {
 591         BOOST_ASSERT(this == cur.text());
 592
 593         Paragraph & cpar = cur.paragraph();
 594         pit_type cpit = cur.pit();
 595
 596         LyXTextClass const & tclass = cur.buffer().params().getLyXTextClass();
 597         LyXLayout_ptr const & layout = cpar.layout();
 598
 599         // this is only allowed, if the current paragraph is not empty
 600         // or caption and if it has not the keepempty flag active
 601         if (cur.lastpos() == 0 && !cpar.allowEmpty() &&
 602             layout->labeltype != LABEL_SENSITIVE)
 603                 return;
 604
 605         // a layout change may affect also the following paragraph
 606         recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
 607
 608         // Always break behind a space
 609         // It is better to erase the space (Dekel)
 610         if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
 611                 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
 612
 613         // What should the layout for the new paragraph be?
 614         int preserve_layout = 0;
 615         if (keep_layout)
 616                 preserve_layout = 2;
 617         else
 618                 preserve_layout = layout->isEnvironment();
 619
 620         // We need to remember this before we break the paragraph, because
 621         // that invalidates the layout variable
 622         bool sensitive = layout->labeltype == LABEL_SENSITIVE;
 623
 624         // we need to set this before we insert the paragraph.
 625         bool const isempty = cpar.allowEmpty() && cpar.empty();
 626
 627         lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
 628                          cur.pos(), preserve_layout);
 629
 630         // After this, neither paragraph contains any rows!
 631
 632         cpit = cur.pit();
 633         pit_type next_par = cpit + 1;
 634
 635         // well this is the caption hack since one caption is really enough
 636         if (sensitive) {
 637                 if (cur.pos() == 0)
 638                         // set to standard-layout
 639                         pars_[cpit].applyLayout(tclass.defaultLayout());
 640                 else
 641                         // set to standard-layout
 642                         pars_[next_par].applyLayout(tclass.defaultLayout());
 643         }
 644
 645         while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
 646                 if (!pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges))
 647                         break; // the character couldn't be deleted physically due to change tracking
 648         }
 649
 650         ParIterator current_it(cur);
 651         ParIterator last_it(cur);
 652         ++last_it;
 653         ++last_it;
 654
 655         updateLabels(cur.buffer(), current_it, last_it);
 656
 657         // A singlePar update is not enough in this case.
 658         cur.updateFlags(Update::Force);
 659
 660         // This check is necessary. Otherwise the new empty paragraph will
 661         // be deleted automatically. And it is more friendly for the user!
 662         if (cur.pos() != 0 || isempty)
 663                 setCursor(cur.top(), cur.pit() + 1, 0);
 664         else
 665                 setCursor(cur.top(), cur.pit(), 0);
 666 }
 667
 668
 669 // insert a character, moves all the following breaks in the
 670 // same Paragraph one to the right and make a rebreak
 671 void LyXText::insertChar(LCursor & cur, char_type c)
 672 {
 673         BOOST_ASSERT(this == cur.text());
 674         BOOST_ASSERT(c != Paragraph::META_INSET);
 675
 676         recordUndo(cur, Undo::INSERT);
 677
 678         Buffer const & buffer = cur.buffer();
 679         Paragraph & par = cur.paragraph();
 680         // try to remove this
 681         pit_type const pit = cur.pit();
 682
 683         bool const freeSpacing = par.layout()->free_spacing ||
 684                 par.isFreeSpacing();
 685
 686         if (lyxrc.auto_number) {
 687                 static docstring const number_operators = from_ascii("+-/*");
 688                 static docstring const number_unary_operators = from_ascii("+-");
 689                 static docstring const number_seperators = from_ascii(".,:");
 690
 691                 if (current_font.number() == LyXFont::ON) {
 692                         if (!isDigit(c) && !contains(number_operators, c) &&
 693                             !(contains(number_seperators, c) &&
 694                               cur.pos() != 0 &&
 695                               cur.pos() != cur.lastpos() &&
 696                               getFont(buffer, par, cur.pos()).number() == LyXFont::ON &&
 697                               getFont(buffer, par, cur.pos() - 1).number() == LyXFont::ON)
 698                            )
 699                                 number(cur); // Set current_font.number to OFF
 700                 } else if (isDigit(c) &&
 701                            real_current_font.isVisibleRightToLeft()) {
 702                         number(cur); // Set current_font.number to ON
 703
 704                         if (cur.pos() != 0) {
 705                                 char_type const c = par.getChar(cur.pos() - 1);
 706                                 if (contains(number_unary_operators, c) &&
 707                                     (cur.pos() == 1
 708                                      || par.isSeparator(cur.pos() - 2)
 709                                      || par.isNewline(cur.pos() - 2))
 710                                   ) {
 711                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
 712                                 } else if (contains(number_seperators, c)
 713                                      && cur.pos() >= 2
 714                                      && getFont(buffer, par, cur.pos() - 2).number() == LyXFont::ON) {
 715                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
 716                                 }
 717                         }
 718                 }
 719         }
 720
 721         // First check, if there will be two blanks together or a blank at
 722         // the beginning of a paragraph.
 723         // I decided to handle blanks like normal characters, the main
 724         // difference are the special checks when calculating the row.fill
 725         // (blank does not count at the end of a row) and the check here
 726
 727         // When the free-spacing option is set for the current layout,
 728         // disable the double-space checking
 729         if (!freeSpacing && isLineSeparatorChar(c)) {
 730                 if (cur.pos() == 0) {
 731                         static bool sent_space_message = false;
 732                         if (!sent_space_message) {
 733                                 cur.message(_("You cannot insert a space at the "
 734                                                            "beginning of a paragraph. Please read the Tutorial."));
 735                                 sent_space_message = true;
 736                         }
 737                         return;
 738                 }
 739                 BOOST_ASSERT(cur.pos() > 0);
 740                 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
 741                     && !par.isDeleted(cur.pos() - 1)) {
 742                         static bool sent_space_message = false;
 743                         if (!sent_space_message) {
 744                                 cur.message(_("You cannot type two spaces this way. "
 745                                                            "Please read the Tutorial."));
 746                                 sent_space_message = true;
 747                         }
 748                         return;
 749                 }
 750         }
 751
 752         par.insertChar(cur.pos(), c, current_font, cur.buffer().params().trackChanges);
 753
 754 //              cur.updateFlags(Update::Force);
 755         setCursor(cur.top(), cur.pit(), cur.pos() + 1);
 756         charInserted();
 757 }
 758
 759
 760 void LyXText::charInserted()
 761 {
 762         // Here we call finishUndo for every 20 characters inserted.
 763         // This is from my experience how emacs does it. (Lgb)
 764         static unsigned int counter;
 765         if (counter < 20) {
 766                 ++counter;
 767         } else {
 768                 finishUndo();
 769                 counter = 0;
 770         }
 771 }
 772
 773
 774 // the cursor set functions have a special mechanism. When they
 775 // realize, that you left an empty paragraph, they will delete it.
 776
 777 bool LyXText::cursorRightOneWord(LCursor & cur)
 778 {
 779         BOOST_ASSERT(this == cur.text());
 780
 781         LCursor old = cur;
 782
 783         if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
 784                 ++old.pit();
 785                 old.pos() = 0;
 786         } else {
 787                 // Advance through word.
 788                 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
 789                         ++old.pos();
 790                 // Skip through trailing nonword stuff.
 791                 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
 792                         ++old.pos();
 793         }
 794         return setCursor(cur, old.pit(), old.pos());
 795 }
 796
 797
 798 bool LyXText::cursorLeftOneWord(LCursor & cur)
 799 {
 800         BOOST_ASSERT(this == cur.text());
 801
 802         LCursor old = cur;
 803
 804         if (old.pos() == 0 && old.pit() != 0) {
 805                 --old.pit();
 806                 old.pos() = old.lastpos();
 807         } else {
 808                 // Skip through initial nonword stuff.
 809                 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
 810                         --old.pos();
 811                 // Advance through word.
 812                 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
 813                         --old.pos();
 814         }
 815         return setCursor(cur, old.pit(), old.pos());
 816 }
 817
 818
 819 void LyXText::selectWord(LCursor & cur, word_location loc)
 820 {
 821         BOOST_ASSERT(this == cur.text());
 822         CursorSlice from = cur.top();
 823         CursorSlice to = cur.top();
 824         getWord(from, to, loc);
 825         if (cur.top() != from)
 826                 setCursor(cur, from.pit(), from.pos());
 827         if (to == from)
 828                 return;
 829         cur.resetAnchor();
 830         setCursor(cur, to.pit(), to.pos());
 831         cur.setSelection();
 832         theSelection().haveSelection(cur.selection());
 833 }
 834
 835
 836 // Select the word currently under the cursor when no
 837 // selection is currently set
 838 bool LyXText::selectWordWhenUnderCursor(LCursor & cur, word_location loc)
 839 {
 840         BOOST_ASSERT(this == cur.text());
 841         if (cur.selection())
 842                 return false;
 843         selectWord(cur, loc);
 844         return cur.selection();
 845 }
 846
 847
 848 void LyXText::acceptOrRejectChange(LCursor & cur, ChangeOp op)
 849 {
 850         BOOST_ASSERT(this == cur.text());
 851
 852         if (!cur.selection())
 853                 return;
 854
 855         recordUndoSelection(cur, Undo::ATOMIC);
 856
 857         pit_type begPit = cur.selectionBegin().pit();
 858         pit_type endPit = cur.selectionEnd().pit();
 859
 860         pos_type begPos = cur.selectionBegin().pos();
 861         pos_type endPos = cur.selectionEnd().pos();
 862
 863         // keep selection info, because endPos becomes invalid after the first loop
 864         bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
 865
 866         // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
 867
 868         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 869                 pos_type parSize = pars_[pit].size();
 870
 871                 // ignore empty paragraphs; otherwise, an assertion will fail for
 872                 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
 873                 if (parSize == 0)
 874                         continue;
 875
 876                 // do not consider first paragraph if the cursor starts at pos size()
 877                 if (pit == begPit && begPos == parSize)
 878                         continue;
 879
 880                 // do not consider last paragraph if the cursor ends at pos 0
 881                 if (pit == endPit && endPos == 0)
 882                         break; // last iteration anyway
 883
 884                 pos_type left  = (pit == begPit ? begPos : 0);
 885                 pos_type right = (pit == endPit ? endPos : parSize);
 886
 887                 if (op == ACCEPT) {
 888                         pars_[pit].acceptChanges(cur.buffer().params(), left, right);
 889                 } else {
 890                         pars_[pit].rejectChanges(cur.buffer().params(), left, right);
 891                 }
 892         }
 893
 894         // next, accept/reject imaginary end-of-par characters
 895
 896         for (pit_type pit = begPit; pit <= endPit; ++pit) {
 897                 pos_type pos = pars_[pit].size();
 898
 899                 // skip if the selection ends before the end-of-par
 900                 if (pit == endPit && endsBeforeEndOfPar)
 901                         break; // last iteration anyway
 902
 903                 // skip if this is not the last paragraph of the document
 904                 // note: the user should be able to accept/reject the par break of the last par!
 905                 if (pit == endPit && pit != pars_.size() - 1)
 906                         break; // last iteration anway
 907
 908                 if (op == ACCEPT) {
 909                         if (pars_[pit].isInserted(pos)) {
 910                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 911                         } else if (pars_[pit].isDeleted(pos)) {
 912                                 if (pit == pars_.size() - 1) {
 913                                         // we cannot remove a par break at the end of the last paragraph;
 914                                         // instead, we mark it unchanged
 915                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 916                                 } else {
 917                                         mergeParagraph(cur.buffer().params(), pars_, pit);
 918                                         --endPit;
 919                                         --pit;
 920                                 }
 921                         }
 922                 } else {
 923                         if (pars_[pit].isDeleted(pos)) {
 924                                 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 925                         } else if (pars_[pit].isInserted(pos)) {
 926                                 if (pit == pars_.size() - 1) {
 927                                         // we mark the par break at the end of the last paragraph unchanged
 928                                         pars_[pit].setChange(pos, Change(Change::UNCHANGED));
 929                                 } else {
 930                                         mergeParagraph(cur.buffer().params(), pars_, pit);
 931                                         --endPit;
 932                                         --pit;
 933                                 }
 934                         }
 935                 }
 936         }
 937
 938         // finally, invoke the DEPM
 939
 940         deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer().params().trackChanges);
 941
 942         //
 943
 944         finishUndo();
 945         cur.clearSelection();
 946         setCursorIntern(cur, begPit, begPos);
 947         cur.updateFlags(Update::Force);
 948         updateLabels(cur.buffer());
 949 }
 950
 951
 952 // Delete from cursor up to the end of the current or next word.
 953 void LyXText::deleteWordForward(LCursor & cur)
 954 {
 955         BOOST_ASSERT(this == cur.text());
 956         if (cur.lastpos() == 0)
 957                 cursorRight(cur);
 958         else {
 959                 cur.resetAnchor();
 960                 cur.selection() = true;
 961                 cursorRightOneWord(cur);
 962                 cur.setSelection();
 963                 cutSelection(cur, true, false);
 964         }
 965 }
 966
 967
 968 // Delete from cursor to start of current or prior word.
 969 void LyXText::deleteWordBackward(LCursor & cur)
 970 {
 971         BOOST_ASSERT(this == cur.text());
 972         if (cur.lastpos() == 0)
 973                 cursorLeft(cur);
 974         else {
 975                 cur.resetAnchor();
 976                 cur.selection() = true;
 977                 cursorLeftOneWord(cur);
 978                 cur.setSelection();
 979                 cutSelection(cur, true, false);
 980         }
 981 }
 982
 983
 984 // Kill to end of line.
 985 void LyXText::deleteLineForward(LCursor & cur)
 986 {
 987         BOOST_ASSERT(this == cur.text());
 988         if (cur.lastpos() == 0) {
 989                 // Paragraph is empty, so we just go to the right
 990                 cursorRight(cur);
 991         } else {
 992                 cur.resetAnchor();
 993                 cur.selection() = true; // to avoid deletion
 994                 cursorEnd(cur);
 995                 cur.setSelection();
 996                 // What is this test for ??? (JMarc)
 997                 if (!cur.selection())
 998                         deleteWordForward(cur);
 999                 else
1000                         cutSelection(cur, true, false);
1001         }
1002 }
1003
1004
1005 void LyXText::changeCase(LCursor & cur, LyXText::TextCase action)
1006 {
1007         BOOST_ASSERT(this == cur.text());
1008         CursorSlice from;
1009         CursorSlice to;
1010
1011         if (cur.selection()) {
1012                 from = cur.selBegin();
1013                 to = cur.selEnd();
1014         } else {
1015                 from = cur.top();
1016                 getWord(from, to, PARTIAL_WORD);
1017                 cursorRightOneWord(cur);
1018         }
1019
1020         recordUndoSelection(cur);
1021
1022         pos_type pos = from.pos();
1023         int par = from.pit();
1024
1025         while (par != int(pars_.size()) && (pos != to.pos() || par != to.pit())) {
1026                 pit_type pit = par;
1027                 if (pos == pars_[pit].size()) {
1028                         ++par;
1029                         pos = 0;
1030                         continue;
1031                 }
1032                 char_type c = pars_[pit].getChar(pos);
1033                 if (c != Paragraph::META_INSET) {
1034                         switch (action) {
1035                         case text_lowercase:
1036                                 c = lowercase(c);
1037                                 break;
1038                         case text_capitalization:
1039                                 c = uppercase(c);
1040                                 action = text_lowercase;
1041                                 break;
1042                         case text_uppercase:
1043                                 c = uppercase(c);
1044                                 break;
1045                         }
1046                 }
1047
1048                 // FIXME: change tracking (MG)
1049                 // sorry but we are no longer allowed to set a single character directly
1050                 // we have to rewrite this method in terms of erase&insert operations
1051                 //pars_[pit].setChar(pos, c);
1052                 ++pos;
1053         }
1054 }
1055
1056
1057 bool LyXText::erase(LCursor & cur)
1058 {
1059         BOOST_ASSERT(this == cur.text());
1060         bool needsUpdate = false;
1061         Paragraph & par = cur.paragraph();
1062
1063         if (cur.pos() != cur.lastpos()) {
1064                 // this is the code for a normal delete, not pasting
1065                 // any paragraphs
1066                 recordUndo(cur, Undo::DELETE);
1067                 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges)) {
1068                         // the character has been logically deleted only => skip it
1069                         cur.forwardPosNoDescend();
1070                 }
1071                 needsUpdate = true;
1072         } else {
1073                 if (cur.pit() == cur.lastpit())
1074                         return dissolveInset(cur);
1075
1076                 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1077                         par.setChange(cur.pos(), Change(Change::DELETED));
1078                         cur.forwardPos();
1079                         needsUpdate = true;
1080                 } else {
1081                         setCursorIntern(cur, cur.pit() + 1, 0);
1082                         needsUpdate = backspacePos0(cur);
1083                 }
1084         }
1085
1086         if (needsUpdate) {
1087                 // Make sure the cursor is correct. Is this really needed?
1088                 // No, not really... at least not here!
1089                 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1090         }
1091
1092         return needsUpdate;
1093 }
1094
1095
1096 bool LyXText::backspacePos0(LCursor & cur)
1097 {
1098         BOOST_ASSERT(this == cur.text());
1099         if (cur.pit() == 0)
1100                 return false;
1101
1102         bool needsUpdate = false;
1103
1104         BufferParams const & bufparams = cur.buffer().params();
1105         LyXTextClass const & tclass = bufparams.getLyXTextClass();
1106         ParagraphList & plist = cur.text()->paragraphs();
1107         Paragraph const & par = cur.paragraph();
1108         LCursor prevcur = cur;
1109         --prevcur.pit();
1110         prevcur.pos() = prevcur.lastpos();
1111         Paragraph const & prevpar = prevcur.paragraph();
1112
1113         // is it an empty paragraph?
1114         if (cur.lastpos() == 0
1115             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1116                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1117                 plist.erase(boost::next(plist.begin(), cur.pit()));
1118                 needsUpdate = true;
1119         }
1120         // is previous par empty?
1121         else if (prevcur.lastpos() == 0
1122                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1123                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1124                 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1125                 needsUpdate = true;
1126         }
1127         // Pasting is not allowed, if the paragraphs have different
1128         // layouts. I think it is a real bug of all other
1129         // word processors to allow it. It confuses the user.
1130         // Correction: Pasting is always allowed with standard-layout
1131         else if (par.layout() == prevpar.layout()
1132                  || par.layout() == tclass.defaultLayout()) {
1133                 recordUndo(cur, Undo::ATOMIC, prevcur.pit());
1134                 mergeParagraph(bufparams, plist, prevcur.pit());
1135                 needsUpdate = true;
1136         }
1137
1138         if (needsUpdate) {
1139                 updateLabels(cur.buffer());
1140                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1141         }
1142
1143         return needsUpdate;
1144 }
1145
1146
1147 bool LyXText::backspace(LCursor & cur)
1148 {
1149         BOOST_ASSERT(this == cur.text());
1150         bool needsUpdate = false;
1151         if (cur.pos() == 0) {
1152                 if (cur.pit() == 0)
1153                         return dissolveInset(cur);
1154
1155                 Paragraph & prev_par = pars_[cur.pit() - 1];
1156
1157                 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1158                         prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1159                         setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1160                         return true;
1161                 }
1162                 // The cursor is at the beginning of a paragraph, so
1163                 // the backspace will collapse two paragraphs into one.
1164                 needsUpdate = backspacePos0(cur);
1165
1166         } else {
1167                 // this is the code for a normal backspace, not pasting
1168                 // any paragraphs
1169                 recordUndo(cur, Undo::DELETE);
1170                 // We used to do cursorLeftIntern() here, but it is
1171                 // not a good idea since it triggers the auto-delete
1172                 // mechanism. So we do a cursorLeftIntern()-lite,
1173                 // without the dreaded mechanism. (JMarc)
1174                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1175                                 false, cur.boundary());
1176                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1177         }
1178
1179         if (cur.pos() == cur.lastpos())
1180                 setCurrentFont(cur);
1181
1182         // A singlePar update is not enough in this case.
1183 //              cur.updateFlags(Update::Force);
1184         setCursor(cur.top(), cur.pit(), cur.pos());
1185
1186         return needsUpdate;
1187 }
1188
1189
1190 bool LyXText::dissolveInset(LCursor & cur) {
1191         BOOST_ASSERT(this == cur.text());
1192
1193         if (isMainText(*cur.bv().buffer()) || cur.inset().nargs() != 1)
1194                 return false;
1195
1196         recordUndoInset(cur);
1197         cur.selHandle(false);
1198         // save position
1199         pos_type spos = cur.pos();
1200         pit_type spit = cur.pit();
1201         ParagraphList plist;
1202         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1203                 plist = paragraphs();
1204         cur.popLeft();
1205         // store cursor offset
1206         if (spit == 0)
1207                 spos += cur.pos();
1208         spit += cur.pit();
1209         Buffer & b = cur.buffer();
1210         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1211         if (!plist.empty()) {
1212                 // ERT paragraphs have the Language latex_language.
1213                 // This is invalid outside of ERT, so we need to
1214                 // change it to the buffer language.
1215                 ParagraphList::iterator it = plist.begin();
1216                 ParagraphList::iterator it_end = plist.end();
1217                 for (; it != it_end; it++) {
1218                         it->changeLanguage(b.params(), latex_language,
1219                                         b.getLanguage());
1220                 }
1221
1222                 pasteParagraphList(cur, plist, b.params().textclass,
1223                                    b.errorList("Paste"));
1224                 // restore position
1225                 cur.pit() = std::min(cur.lastpit(), spit);
1226                 cur.pos() = std::min(cur.lastpos(), spos);
1227         }
1228         cur.clearSelection();
1229         cur.resetAnchor();
1230         return true;
1231 }
1232
1233
1234 // only used for inset right now. should also be used for main text
1235 void LyXText::draw(PainterInfo & pi, int x, int y) const
1236 {
1237         paintTextInset(*this, pi, x, y);
1238 }
1239
1240
1241 // only used for inset right now. should also be used for main text
1242 void LyXText::drawSelection(PainterInfo & pi, int x, int) const
1243 {
1244         LCursor & cur = pi.base.bv->cursor();
1245         if (!cur.selection())
1246                 return;
1247         if (!ptr_cmp(cur.text(), this))
1248                 return;
1249
1250         if (lyxerr.debugging(Debug::DEBUG)) {
1251                 lyxerr[Debug::DEBUG]
1252                         << BOOST_CURRENT_FUNCTION
1253                         << "draw selection at " << x
1254                         << endl;
1255         }
1256
1257         DocIterator beg = cur.selectionBegin();
1258         DocIterator end = cur.selectionEnd();
1259
1260         BufferView & bv = *pi.base.bv;
1261         Buffer const & buffer = *bv.buffer();
1262
1263         // the selection doesn't touch the visible screen
1264         if (bv_funcs::status(&bv, beg) == bv_funcs::CUR_BELOW
1265             || bv_funcs::status(&bv, end) == bv_funcs::CUR_ABOVE)
1266                 return;
1267
1268         Paragraph const & par1 = pars_[beg.pit()];
1269         Paragraph const & par2 = pars_[end.pit()];
1270         TextMetrics const & tm = bv.textMetrics(this);
1271         ParagraphMetrics const & pm1 = tm.parMetrics(beg.pit());
1272         ParagraphMetrics const & pm2 = tm.parMetrics(end.pit());
1273
1274         bool const above = (bv_funcs::status(&bv, beg)
1275                             == bv_funcs::CUR_ABOVE);
1276         bool const below = (bv_funcs::status(&bv, end)
1277                             == bv_funcs::CUR_BELOW);
1278         int y1,y2,x1,x2;
1279         if (above) {
1280                 y1 = 0;
1281                 y2 = 0;
1282                 x1 = 0;
1283                 x2 = tm.width();
1284         } else {
1285                 Row const & row1 = pm1.getRow(beg.pos(), beg.boundary());
1286                 y1 = bv_funcs::getPos(bv, beg, beg.boundary()).y_ - row1.ascent();
1287                 y2 = y1 + row1.height();
1288                 int const startx = cursorX(bv, beg.top(), beg.boundary());
1289                 if (!isRTL(buffer, par1)) {
1290                         x1 = startx;
1291                         x2 = 0 + tm.width();
1292                 }
1293                 else {
1294                         x1 = 0;
1295                         x2 = startx;
1296                 }
1297         }
1298
1299         int Y1,Y2,X1,X2;
1300         if (below) {
1301                 Y1 = bv.workHeight();
1302                 Y2 = bv.workHeight();
1303                 X1 = 0;
1304                 X2 = tm.width();
1305         } else {
1306                 Row const & row2 = pm2.getRow(end.pos(), end.boundary());
1307                 Y1 = bv_funcs::getPos(bv, end, end.boundary()).y_ - row2.ascent();
1308                 Y2 = Y1 + row2.height();
1309                 int const endx = cursorX(bv, end.top(), end.boundary());
1310                 if (!isRTL(buffer, par2)) {
1311                         X1 = 0;
1312                         X2 = endx;
1313                 }
1314                 else {
1315                         X1 = endx;
1316                         X2 = 0 + tm.width();
1317                 }
1318         }
1319
1320         if (!above && !below && &pm1.getRow(beg.pos(), beg.boundary())
1321             == &pm2.getRow(end.pos(), end.boundary()))
1322         {
1323                 // paint only one rectangle
1324                 int const b( !isRTL(*bv.buffer(), par1) ? x + x1 : x + X1 );
1325                 int const w( !isRTL(*bv.buffer(), par1) ? X2 - x1 : x2 - X1 );
1326                 pi.pain.fillRectangle(b, y1, w, y2 - y1, LColor::selection);
1327                 return;
1328         }
1329
1330         if (lyxerr.debugging(Debug::DEBUG)) {
1331                 lyxerr[Debug::DEBUG] << " y1: " << y1 << " y2: " << y2
1332                            << "X1:" << X1 << " x2: " << X2 << " wid: " << tm.width()
1333                         << endl;
1334         }
1335
1336         // paint upper rectangle
1337         pi.pain.fillRectangle(x + x1, y1, x2 - x1, y2 - y1,
1338                                       LColor::selection);
1339         // paint bottom rectangle
1340         pi.pain.fillRectangle(x + X1, Y1, X2 - X1, Y2 - Y1,
1341                                       LColor::selection);
1342         // paint center rectangle
1343         pi.pain.fillRectangle(x, y2, tm.width(),
1344                               Y1 - y2, LColor::selection);
1345 }
1346
1347
1348 bool LyXText::isLastRow(pit_type pit, Row const & row) const
1349 {
1350         return row.endpos() >= pars_[pit].size()
1351                 && pit + 1 == pit_type(paragraphs().size());
1352 }
1353
1354
1355 bool LyXText::isFirstRow(pit_type pit, Row const & row) const
1356 {
1357         return row.pos() == 0 && pit == 0;
1358 }
1359
1360
1361 void LyXText::getWord(CursorSlice & from, CursorSlice & to,
1362         word_location const loc)
1363 {
1364         Paragraph const & from_par = pars_[from.pit()];
1365         switch (loc) {
1366         case WHOLE_WORD_STRICT:
1367                 if (from.pos() == 0 || from.pos() == from_par.size()
1368                     || !from_par.isLetter(from.pos())
1369                     || !from_par.isLetter(from.pos() - 1)) {
1370                         to = from;
1371                         return;
1372                 }
1373                 // no break here, we go to the next
1374
1375         case WHOLE_WORD:
1376                 // If we are already at the beginning of a word, do nothing
1377                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1378                         break;
1379                 // no break here, we go to the next
1380
1381         case PREVIOUS_WORD:
1382                 // always move the cursor to the beginning of previous word
1383                 while (from.pos() && from_par.isLetter(from.pos() - 1))
1384                         --from.pos();
1385                 break;
1386         case NEXT_WORD:
1387                 lyxerr << "LyXText::getWord: NEXT_WORD not implemented yet"
1388                        << endl;
1389                 break;
1390         case PARTIAL_WORD:
1391                 // no need to move the 'from' cursor
1392                 break;
1393         }
1394         to = from;
1395         Paragraph & to_par = pars_[to.pit()];
1396         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1397                 ++to.pos();
1398 }
1399
1400
1401 void LyXText::write(Buffer const & buf, std::ostream & os) const
1402 {
1403         ParagraphList::const_iterator pit = paragraphs().begin();
1404         ParagraphList::const_iterator end = paragraphs().end();
1405         depth_type dth = 0;
1406         for (; pit != end; ++pit)
1407                 pit->write(buf, os, buf.params(), dth);
1408 }
1409
1410
1411 bool LyXText::read(Buffer const & buf, LyXLex & lex, ErrorList & errorList)
1412 {
1413         depth_type depth = 0;
1414
1415         while (lex.isOK()) {
1416                 lex.nextToken();
1417                 string const token = lex.getString();
1418
1419                 if (token.empty())
1420                         continue;
1421
1422                 if (token == "\\end_inset")
1423                         break;
1424
1425                 if (token == "\\end_body")
1426                         continue;
1427
1428                 if (token == "\\begin_body")
1429                         continue;
1430
1431                 if (token == "\\end_document")
1432                         return false;
1433
1434                 if (token == "\\begin_layout") {
1435                         lex.pushToken(token);
1436
1437                         Paragraph par;
1438                         par.params().depth(depth);
1439                         par.setFont(0, LyXFont(LyXFont::ALL_INHERIT, buf.params().language));
1440                         pars_.push_back(par);
1441
1442                         // FIXME: goddamn InsetTabular makes us pass a Buffer
1443                         // not BufferParams
1444                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
1445
1446                 } else if (token == "\\begin_deeper") {
1447                         ++depth;
1448                 } else if (token == "\\end_deeper") {
1449                         if (!depth) {
1450                                 lex.printError("\\end_deeper: " "depth is already null");
1451                         } else {
1452                                 --depth;
1453                         }
1454                 } else {
1455                         lyxerr << "Handling unknown body token: `"
1456                                << token << '\'' << endl;
1457                 }
1458         }
1459         return true;
1460 }
1461
1462 int LyXText::cursorX(BufferView const & bv, CursorSlice const & sl,
1463                 bool boundary) const
1464 {
1465         TextMetrics const & tm = bv.textMetrics(sl.text());
1466         pit_type const pit = sl.pit();
1467         Paragraph const & par = pars_[pit];
1468         ParagraphMetrics const & pm = tm.parMetrics(pit);
1469         if (pm.rows().empty())
1470                 return 0;
1471
1472         pos_type ppos = sl.pos();
1473         // Correct position in front of big insets
1474         bool const boundary_correction = ppos != 0 && boundary;
1475         if (boundary_correction)
1476                 --ppos;
1477
1478         Row const & row = pm.getRow(sl.pos(), boundary);
1479
1480         pos_type cursor_vpos = 0;
1481
1482         Buffer const & buffer = *bv.buffer();
1483         RowMetrics const m = tm.computeRowMetrics(pit, row);
1484         double x = m.x;
1485
1486         pos_type const row_pos  = row.pos();
1487         pos_type const end      = row.endpos();
1488
1489         if (end <= row_pos)
1490                 cursor_vpos = row_pos;
1491         else if (ppos >= end)
1492                 cursor_vpos = isRTL(buffer, par) ? row_pos : end;
1493         else if (ppos > row_pos && ppos >= end)
1494                 // Place cursor after char at (logical) position pos - 1
1495                 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1496                         ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1497         else
1498                 // Place cursor before char at (logical) position ppos
1499                 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1500                         ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1501
1502         pos_type body_pos = par.beginOfBody();
1503         if (body_pos > 0 &&
1504             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1505                 body_pos = 0;
1506
1507         // Use font span to speed things up, see below
1508         FontSpan font_span;
1509         LyXFont font;
1510         FontMetrics const & labelfm = theFontMetrics(
1511                 getLabelFont(buffer, par));
1512
1513         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1514                 pos_type pos = bidi.vis2log(vpos);
1515                 if (body_pos > 0 && pos == body_pos - 1) {
1516                         // FIXME UNICODE
1517                         docstring const lsep = from_utf8(par.layout()->labelsep);
1518                         x += m.label_hfill + labelfm.width(lsep);
1519                         if (par.isLineSeparator(body_pos - 1))
1520                                 x -= singleWidth(buffer, par, body_pos - 1);
1521                 }
1522
1523                 // Use font span to speed things up, see above
1524                 if (pos < font_span.first || pos > font_span.last) {
1525                         font_span = par.fontSpan(pos);
1526                         font = getFont(buffer, par, pos);
1527                 }
1528
1529                 x += singleWidth(par, pos, par.getChar(pos), font);
1530
1531                 if (par.hfillExpansion(row, pos))
1532                         x += (pos >= body_pos) ? m.hfill : m.label_hfill;
1533                 else if (par.isSeparator(pos) && pos >= body_pos)
1534                         x += m.separator;
1535         }
1536
1537         // see correction above
1538         if (boundary_correction)
1539                 if (getFont(buffer, par, ppos).isVisibleRightToLeft())
1540                         x -= singleWidth(buffer, par, ppos);
1541                 else
1542                         x += singleWidth(buffer, par, ppos);
1543
1544         // Make sure inside an inset we always count from the left
1545         // edge (bidi!) -- MV
1546         if (sl.pos() < par.size()) {
1547                 font = getFont(buffer, par, sl.pos());
1548                 if (!boundary && font.isVisibleRightToLeft()
1549                   && par.isInset(sl.pos()))
1550                         x -= par.getInset(sl.pos())->width();
1551         }
1552         return int(x);
1553 }
1554
1555
1556 int LyXText::cursorY(BufferView const & bv, CursorSlice const & sl, bool boundary) const
1557 {
1558         //lyxerr << "LyXText::cursorY: boundary: " << boundary << std::endl;
1559         ParagraphMetrics const & pm = bv.parMetrics(this, sl.pit());
1560         if (pm.rows().empty())
1561                 return 0;
1562
1563         int h = 0;
1564         h -= bv.parMetrics(this, 0).rows()[0].ascent();
1565         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1566                 h += bv.parMetrics(this, pit).height();
1567         }
1568         int pos = sl.pos();
1569         if (pos && boundary)
1570                 --pos;
1571         size_t const rend = pm.pos2row(pos);
1572         for (size_t rit = 0; rit != rend; ++rit)
1573                 h += pm.rows()[rit].height();
1574         h += pm.rows()[rend].ascent();
1575         return h;
1576 }
1577
1578
1579 // Returns the current font and depth as a message.
1580 docstring LyXText::currentState(LCursor & cur)
1581 {
1582         BOOST_ASSERT(this == cur.text());
1583         Buffer & buf = cur.buffer();
1584         Paragraph const & par = cur.paragraph();
1585         odocstringstream os;
1586
1587         if (buf.params().trackChanges)
1588                 os << _("[Change Tracking] ");
1589
1590         Change change = par.lookupChange(cur.pos());
1591
1592         if (change.type != Change::UNCHANGED) {
1593                 Author const & a = buf.params().authors().get(change.author);
1594                 os << _("Change: ") << a.name();
1595                 if (!a.email().empty())
1596                         os << " (" << a.email() << ")";
1597                 // FIXME ctime is english, we should translate that
1598                 os << _(" at ") << ctime(&change.changetime);
1599                 os << " : ";
1600         }
1601
1602         // I think we should only show changes from the default
1603         // font. (Asger)
1604         // No, from the document font (MV)
1605         LyXFont font = real_current_font;
1606         font.reduce(buf.params().getFont());
1607
1608         os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1609
1610         // The paragraph depth
1611         int depth = cur.paragraph().getDepth();
1612         if (depth > 0)
1613                 os << bformat(_(", Depth: %1$d"), depth);
1614
1615         // The paragraph spacing, but only if different from
1616         // buffer spacing.
1617         Spacing const & spacing = par.params().spacing();
1618         if (!spacing.isDefault()) {
1619                 os << _(", Spacing: ");
1620                 switch (spacing.getSpace()) {
1621                 case Spacing::Single:
1622                         os << _("Single");
1623                         break;
1624                 case Spacing::Onehalf:
1625                         os << _("OneHalf");
1626                         break;
1627                 case Spacing::Double:
1628                         os << _("Double");
1629                         break;
1630                 case Spacing::Other:
1631                         os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1632                         break;
1633                 case Spacing::Default:
1634                         // should never happen, do nothing
1635                         break;
1636                 }
1637         }
1638
1639 #ifdef DEVEL_VERSION
1640         os << _(", Inset: ") << &cur.inset();
1641         os << _(", Paragraph: ") << cur.pit();
1642         os << _(", Id: ") << par.id();
1643         os << _(", Position: ") << cur.pos();
1644         os << _(", Boundary: ") << cur.boundary();
1645 //      Row & row = cur.textRow();
1646 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1647 #endif
1648         return os.str();
1649 }
1650
1651
1652 docstring LyXText::getPossibleLabel(LCursor & cur) const
1653 {
1654         pit_type pit = cur.pit();
1655
1656         LyXLayout_ptr layout = pars_[pit].layout();
1657
1658         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1659                 LyXLayout_ptr const & layout2 = pars_[pit - 1].layout();
1660                 if (layout2->latextype != LATEX_PARAGRAPH) {
1661                         --pit;
1662                         layout = layout2;
1663                 }
1664         }
1665
1666         docstring name = from_ascii(layout->latexname());
1667
1668         // for captions, we want the abbreviation of the float type
1669         if (layout->labeltype == LABEL_SENSITIVE) {
1670                 // Search for the first float or wrap inset in the iterator
1671                 for (int i = cur.depth(); --i >= 0; ) {
1672                         InsetBase * const in = &cur[i].inset();
1673                         if (in->lyxCode() == InsetBase::FLOAT_CODE
1674                             || in->lyxCode() == InsetBase::WRAP_CODE) {
1675                                 name = in->getInsetName();
1676                                 break;
1677                         }
1678                 }
1679         }
1680
1681         docstring text = name.substr(0, 3);
1682         if (name == "theorem")
1683                 text = from_ascii("thm"); // Create a correct prefix for prettyref
1684
1685         text += ':';
1686         if (layout->latextype == LATEX_PARAGRAPH || lyxrc.label_init_length < 0)
1687                 text.erase();
1688
1689         docstring par_text = pars_[pit].asString(cur.buffer(), false);
1690         for (int i = 0; i < lyxrc.label_init_length; ++i) {
1691                 if (par_text.empty())
1692                         break;
1693                 docstring head;
1694                 par_text = split(par_text, head, ' ');
1695                 // Is it legal to use spaces in labels ?
1696                 if (i > 0)
1697                         text += '-';
1698                 text += head;
1699         }
1700
1701         return text;
1702 }
1703
1704
1705 void LyXText::setCursorFromCoordinates(LCursor & cur, int const x, int const y)
1706 {
1707         BOOST_ASSERT(this == cur.text());
1708         pit_type pit = getPitNearY(cur.bv(), y);
1709
1710         TextMetrics const & tm = cur.bv().textMetrics(this);
1711         ParagraphMetrics const & pm = tm.parMetrics(pit);
1712
1713         int yy = cur.bv().coordCache().get(this, pit).y_ - pm.ascent();
1714         lyxerr[Debug::DEBUG]
1715                 << BOOST_CURRENT_FUNCTION
1716                 << ": x: " << x
1717                 << " y: " << y
1718                 << " pit: " << pit
1719                 << " yy: " << yy << endl;
1720
1721         int r = 0;
1722         BOOST_ASSERT(pm.rows().size());
1723         for (; r < int(pm.rows().size()) - 1; ++r) {
1724                 Row const & row = pm.rows()[r];
1725                 if (int(yy + row.height()) > y)
1726                         break;
1727                 yy += row.height();
1728         }
1729
1730         Row const & row = pm.rows()[r];
1731
1732         lyxerr[Debug::DEBUG]
1733                 << BOOST_CURRENT_FUNCTION
1734                 << ": row " << r
1735                 << " from pos: " << row.pos()
1736                 << endl;
1737
1738         bool bound = false;
1739         int xx = x;
1740         pos_type const pos = row.pos()
1741                 + tm.getColumnNearX(pit, row, xx, bound);
1742
1743         lyxerr[Debug::DEBUG]
1744                 << BOOST_CURRENT_FUNCTION
1745                 << ": setting cursor pit: " << pit
1746                 << " pos: " << pos
1747                 << endl;
1748
1749         setCursor(cur, pit, pos, true, bound);
1750         // remember new position.
1751         cur.setTargetX();
1752 }
1753
1754
1755 void LyXText::charsTranspose(LCursor & cur)
1756 {
1757         BOOST_ASSERT(this == cur.text());
1758
1759         pos_type pos = cur.pos();
1760
1761         // If cursor is at beginning or end of paragraph, do nothing.
1762         if (pos == cur.lastpos() || pos == 0)
1763                 return;
1764
1765         Paragraph & par = cur.paragraph();
1766
1767         // Get the positions of the characters to be transposed.
1768         pos_type pos1 = pos - 1;
1769         pos_type pos2 = pos;
1770
1771         // In change tracking mode, ignore deleted characters.
1772         while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1773                 ++pos2;
1774         if (pos2 == cur.lastpos())
1775                 return;
1776
1777         while (pos1 >= 0 && par.isDeleted(pos1))
1778                 --pos1;
1779         if (pos1 < 0)
1780                 return;
1781
1782         // Don't do anything if one of the "characters" is not regular text.
1783         if (par.isInset(pos1) || par.isInset(pos2))
1784                 return;
1785
1786         // Store the characters to be transposed (including font information).
1787         char_type char1 = par.getChar(pos1);
1788         LyXFont const font1 =
1789                 par.getFontSettings(cur.buffer().params(), pos1);
1790
1791         char_type char2 = par.getChar(pos2);
1792         LyXFont const font2 =
1793                 par.getFontSettings(cur.buffer().params(), pos2);
1794
1795         // And finally, we are ready to perform the transposition.
1796         // Track the changes if Change Tracking is enabled.
1797         bool const trackChanges = cur.buffer().params().trackChanges;
1798
1799         recordUndo(cur);
1800
1801         par.eraseChar(pos2, trackChanges);
1802         par.eraseChar(pos1, trackChanges);
1803         par.insertChar(pos1, char2, font2, trackChanges);
1804         par.insertChar(pos2, char1, font1, trackChanges);
1805
1806         // After the transposition, move cursor to after the transposition.
1807         setCursor(cur, cur.pit(), pos2);
1808         cur.forwardPos();
1809 }
1810
1811
1812 } // namespace lyx