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::acceptChange(LCursor & cur)
 849 {
 850         // FIXME: change tracking (MG)
 851
 852         BOOST_ASSERT(this == cur.text());
 853
 854         if (!cur.selection() && cur.lastpos() != 0)
 855                 return;
 856
 857         // FIXME: we must handle start = end = 0
 858
 859         recordUndoSelection(cur, Undo::INSERT);
 860
 861         DocIterator it = cur.selectionBegin();
 862         DocIterator et = cur.selectionEnd();
 863         pit_type pit = it.pit();
 864         for (; pit <= et.pit(); ++pit) {
 865                 pos_type left  = (pit == it.pit() ? it.pos() : 0);
 866                 pos_type right = (pit == et.pit() ? et.pos() : pars_[pit].size());
 867
 868                 // handle imaginary end-of-par character first
 869                 if (right == pars_[pit].size() && !pars_[pit].isUnchanged(right)) {
 870                         if (pars_[pit].isInserted(right)) {
 871                                 pars_[pit].setChange(right, Change(Change::UNCHANGED));
 872                         } else {
 873                                 // if (pit + 1 < et.pit()) {
 874                                 //      setCursorIntern(cur, pit + 1, 0);
 875                                 //      backspacePos0(cur);
 876                                 // }
 877                         }
 878                 }
 879
 880                 pars_[pit].acceptChanges(left, right);
 881         }
 882         finishUndo();
 883         cur.clearSelection();
 884         setCursorIntern(cur, it.pit(), it.pos());
 885         cur.updateFlags(Update::Force);
 886 }
 887
 888
 889 void LyXText::rejectChange(LCursor & cur)
 890 {
 891         // FIXME: change tracking (MG)
 892
 893         BOOST_ASSERT(this == cur.text());
 894
 895         if (!cur.selection() && cur.lastpos() != 0)
 896                 return;
 897
 898         // FIXME: we must handle start = end = 0
 899
 900         recordUndoSelection(cur, Undo::INSERT);
 901
 902         DocIterator it = cur.selectionBegin();
 903         DocIterator et = cur.selectionEnd();
 904         pit_type pit = it.pit();
 905         for (; pit <= et.pit(); ++pit) {
 906                 pos_type left  = (pit == it.pit() ? it.pos() : 0);
 907                 pos_type right = (pit == et.pit() ? et.pos() : pars_[pit].size());
 908
 909                 // handle imaginary end-of-par character first
 910                 if (right == pars_[pit].size() && !pars_[pit].isUnchanged(right)) {
 911                         if (pars_[pit].isDeleted(right)) {
 912                                 pars_[pit].setChange(right, Change(Change::UNCHANGED));
 913                         } else {
 914                                 // if (pit + 1 < et.pit()) {
 915                                 //      setCursorIntern(cur, pit + 1, 0);
 916                                 //      backspacePos0(cur);
 917                                 // }
 918                         }
 919                 }
 920
 921                 pars_[pit].rejectChanges(left, right);
 922         }
 923         finishUndo();
 924         cur.clearSelection();
 925         setCursorIntern(cur, it.pit(), it.pos());
 926         cur.updateFlags(Update::Force);
 927 }
 928
 929
 930 // Delete from cursor up to the end of the current or next word.
 931 void LyXText::deleteWordForward(LCursor & cur)
 932 {
 933         BOOST_ASSERT(this == cur.text());
 934         if (cur.lastpos() == 0)
 935                 cursorRight(cur);
 936         else {
 937                 cur.resetAnchor();
 938                 cur.selection() = true;
 939                 cursorRightOneWord(cur);
 940                 cur.setSelection();
 941                 cutSelection(cur, true, false);
 942         }
 943 }
 944
 945
 946 // Delete from cursor to start of current or prior word.
 947 void LyXText::deleteWordBackward(LCursor & cur)
 948 {
 949         BOOST_ASSERT(this == cur.text());
 950         if (cur.lastpos() == 0)
 951                 cursorLeft(cur);
 952         else {
 953                 cur.resetAnchor();
 954                 cur.selection() = true;
 955                 cursorLeftOneWord(cur);
 956                 cur.setSelection();
 957                 cutSelection(cur, true, false);
 958         }
 959 }
 960
 961
 962 // Kill to end of line.
 963 void LyXText::deleteLineForward(LCursor & cur)
 964 {
 965         BOOST_ASSERT(this == cur.text());
 966         if (cur.lastpos() == 0) {
 967                 // Paragraph is empty, so we just go to the right
 968                 cursorRight(cur);
 969         } else {
 970                 cur.resetAnchor();
 971                 cur.selection() = true; // to avoid deletion
 972                 cursorEnd(cur);
 973                 cur.setSelection();
 974                 // What is this test for ??? (JMarc)
 975                 if (!cur.selection())
 976                         deleteWordForward(cur);
 977                 else
 978                         cutSelection(cur, true, false);
 979         }
 980 }
 981
 982
 983 void LyXText::changeCase(LCursor & cur, LyXText::TextCase action)
 984 {
 985         BOOST_ASSERT(this == cur.text());
 986         CursorSlice from;
 987         CursorSlice to;
 988
 989         if (cur.selection()) {
 990                 from = cur.selBegin();
 991                 to = cur.selEnd();
 992         } else {
 993                 from = cur.top();
 994                 getWord(from, to, PARTIAL_WORD);
 995                 cursorRightOneWord(cur);
 996         }
 997
 998         recordUndoSelection(cur);
 999
1000         pos_type pos = from.pos();
1001         int par = from.pit();
1002
1003         while (par != int(pars_.size()) && (pos != to.pos() || par != to.pit())) {
1004                 pit_type pit = par;
1005                 if (pos == pars_[pit].size()) {
1006                         ++par;
1007                         pos = 0;
1008                         continue;
1009                 }
1010                 char_type c = pars_[pit].getChar(pos);
1011                 if (c != Paragraph::META_INSET) {
1012                         switch (action) {
1013                         case text_lowercase:
1014                                 c = lowercase(c);
1015                                 break;
1016                         case text_capitalization:
1017                                 c = uppercase(c);
1018                                 action = text_lowercase;
1019                                 break;
1020                         case text_uppercase:
1021                                 c = uppercase(c);
1022                                 break;
1023                         }
1024                 }
1025
1026                 // FIXME: change tracking (MG)
1027                 // sorry but we are no longer allowed to set a single character directly
1028                 // we have to rewrite this method in terms of erase&insert operations
1029                 //pars_[pit].setChar(pos, c);
1030                 ++pos;
1031         }
1032 }
1033
1034
1035 bool LyXText::erase(LCursor & cur)
1036 {
1037         BOOST_ASSERT(this == cur.text());
1038         bool needsUpdate = false;
1039         Paragraph & par = cur.paragraph();
1040
1041         if (cur.pos() != cur.lastpos()) {
1042                 // this is the code for a normal delete, not pasting
1043                 // any paragraphs
1044                 recordUndo(cur, Undo::DELETE);
1045                 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges)) {
1046                         // the character has been logically deleted only => skip it
1047                         cur.forwardPosNoDescend();
1048                 }
1049                 needsUpdate = true;
1050         } else {
1051                 if (cur.pit() == cur.lastpit())
1052                         return dissolveInset(cur);
1053
1054                 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1055                         par.setChange(cur.pos(), Change(Change::DELETED));
1056                         cur.forwardPos();
1057                         needsUpdate = true;
1058                 } else {
1059                         setCursorIntern(cur, cur.pit() + 1, 0);
1060                         needsUpdate = backspacePos0(cur);
1061                 }
1062         }
1063
1064         if (needsUpdate) {
1065                 // Make sure the cursor is correct. Is this really needed?
1066                 // No, not really... at least not here!
1067                 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
1068         }
1069
1070         return needsUpdate;
1071 }
1072
1073
1074 bool LyXText::backspacePos0(LCursor & cur)
1075 {
1076         BOOST_ASSERT(this == cur.text());
1077         if (cur.pit() == 0)
1078                 return false;
1079
1080         bool needsUpdate = false;
1081
1082         BufferParams const & bufparams = cur.buffer().params();
1083         LyXTextClass const & tclass = bufparams.getLyXTextClass();
1084         ParagraphList & plist = cur.text()->paragraphs();
1085         Paragraph const & par = cur.paragraph();
1086         LCursor prevcur = cur;
1087         --prevcur.pit();
1088         prevcur.pos() = prevcur.lastpos();
1089         Paragraph const & prevpar = prevcur.paragraph();
1090
1091         // is it an empty paragraph?
1092         if (cur.lastpos() == 0
1093             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1094                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1095                 plist.erase(boost::next(plist.begin(), cur.pit()));
1096                 needsUpdate = true;
1097         }
1098         // is previous par empty?
1099         else if (prevcur.lastpos() == 0
1100                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1101                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1102                 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1103                 needsUpdate = true;
1104         }
1105         // Pasting is not allowed, if the paragraphs have different
1106         // layouts. I think it is a real bug of all other
1107         // word processors to allow it. It confuses the user.
1108         // Correction: Pasting is always allowed with standard-layout
1109         else if (par.layout() == prevpar.layout()
1110                  || par.layout() == tclass.defaultLayout()) {
1111                 recordUndo(cur, Undo::ATOMIC, prevcur.pit());
1112                 mergeParagraph(bufparams, plist, prevcur.pit());
1113                 needsUpdate = true;
1114         }
1115
1116         if (needsUpdate) {
1117                 updateLabels(cur.buffer());
1118                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1119         }
1120
1121         return needsUpdate;
1122 }
1123
1124
1125 bool LyXText::backspace(LCursor & cur)
1126 {
1127         BOOST_ASSERT(this == cur.text());
1128         bool needsUpdate = false;
1129         if (cur.pos() == 0) {
1130                 if (cur.pit() == 0)
1131                         return dissolveInset(cur);
1132
1133                 Paragraph & prev_par = pars_[cur.pit() - 1];
1134
1135                 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1136                         prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1137                         setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1138                         return true;
1139                 }
1140                 // The cursor is at the beginning of a paragraph, so
1141                 // the backspace will collapse two paragraphs into one.
1142                 needsUpdate = backspacePos0(cur);
1143
1144         } else {
1145                 // this is the code for a normal backspace, not pasting
1146                 // any paragraphs
1147                 recordUndo(cur, Undo::DELETE);
1148                 // We used to do cursorLeftIntern() here, but it is
1149                 // not a good idea since it triggers the auto-delete
1150                 // mechanism. So we do a cursorLeftIntern()-lite,
1151                 // without the dreaded mechanism. (JMarc)
1152                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1153                                 false, cur.boundary());
1154                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1155         }
1156
1157         if (cur.pos() == cur.lastpos())
1158                 setCurrentFont(cur);
1159
1160         // A singlePar update is not enough in this case.
1161 //              cur.updateFlags(Update::Force);
1162         setCursor(cur.top(), cur.pit(), cur.pos());
1163
1164         return needsUpdate;
1165 }
1166
1167
1168 bool LyXText::dissolveInset(LCursor & cur) {
1169         BOOST_ASSERT(this == cur.text());
1170
1171         if (isMainText(*cur.bv().buffer()) || cur.inset().nargs() != 1)
1172                 return false;
1173
1174         recordUndoInset(cur);
1175         cur.selHandle(false);
1176         // save position
1177         pos_type spos = cur.pos();
1178         pit_type spit = cur.pit();
1179         ParagraphList plist;
1180         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1181                 plist = paragraphs();
1182         cur.popLeft();
1183         // store cursor offset
1184         if (spit == 0)
1185                 spos += cur.pos();
1186         spit += cur.pit();
1187         Buffer & b = cur.buffer();
1188         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1189         if (!plist.empty()) {
1190                 // ERT paragraphs have the Language latex_language.
1191                 // This is invalid outside of ERT, so we need to
1192                 // change it to the buffer language.
1193                 ParagraphList::iterator it = plist.begin();
1194                 ParagraphList::iterator it_end = plist.end();
1195                 for (; it != it_end; it++) {
1196                         it->changeLanguage(b.params(), latex_language,
1197                                         b.getLanguage());
1198                 }
1199
1200                 pasteParagraphList(cur, plist, b.params().textclass,
1201                                    b.errorList("Paste"));
1202                 // restore position
1203                 cur.pit() = std::min(cur.lastpit(), spit);
1204                 cur.pos() = std::min(cur.lastpos(), spos);
1205         }
1206         cur.clearSelection();
1207         cur.resetAnchor();
1208         return true;
1209 }
1210
1211
1212 // only used for inset right now. should also be used for main text
1213 void LyXText::draw(PainterInfo & pi, int x, int y) const
1214 {
1215         paintTextInset(*this, pi, x, y);
1216 }
1217
1218
1219 // only used for inset right now. should also be used for main text
1220 void LyXText::drawSelection(PainterInfo & pi, int x, int) const
1221 {
1222         LCursor & cur = pi.base.bv->cursor();
1223         if (!cur.selection())
1224                 return;
1225         if (!ptr_cmp(cur.text(), this))
1226                 return;
1227
1228         if (lyxerr.debugging(Debug::DEBUG)) {
1229                 lyxerr[Debug::DEBUG]
1230                         << BOOST_CURRENT_FUNCTION
1231                         << "draw selection at " << x
1232                         << endl;
1233         }
1234
1235         DocIterator beg = cur.selectionBegin();
1236         DocIterator end = cur.selectionEnd();
1237
1238         BufferView & bv = *pi.base.bv;
1239         Buffer const & buffer = *bv.buffer();
1240
1241         // the selection doesn't touch the visible screen
1242         if (bv_funcs::status(&bv, beg) == bv_funcs::CUR_BELOW
1243             || bv_funcs::status(&bv, end) == bv_funcs::CUR_ABOVE)
1244                 return;
1245
1246         Paragraph const & par1 = pars_[beg.pit()];
1247         Paragraph const & par2 = pars_[end.pit()];
1248         TextMetrics const & tm = bv.textMetrics(this);
1249         ParagraphMetrics const & pm1 = tm.parMetrics(beg.pit());
1250         ParagraphMetrics const & pm2 = tm.parMetrics(end.pit());
1251
1252         bool const above = (bv_funcs::status(&bv, beg)
1253                             == bv_funcs::CUR_ABOVE);
1254         bool const below = (bv_funcs::status(&bv, end)
1255                             == bv_funcs::CUR_BELOW);
1256         int y1,y2,x1,x2;
1257         if (above) {
1258                 y1 = 0;
1259                 y2 = 0;
1260                 x1 = 0;
1261                 x2 = tm.width();
1262         } else {
1263                 Row const & row1 = pm1.getRow(beg.pos(), beg.boundary());
1264                 y1 = bv_funcs::getPos(bv, beg, beg.boundary()).y_ - row1.ascent();
1265                 y2 = y1 + row1.height();
1266                 int const startx = cursorX(bv, beg.top(), beg.boundary());
1267                 if (!isRTL(buffer, par1)) {
1268                         x1 = startx;
1269                         x2 = 0 + tm.width();
1270                 }
1271                 else {
1272                         x1 = 0;
1273                         x2 = startx;
1274                 }
1275         }
1276
1277         int Y1,Y2,X1,X2;
1278         if (below) {
1279                 Y1 = bv.workHeight();
1280                 Y2 = bv.workHeight();
1281                 X1 = 0;
1282                 X2 = tm.width();
1283         } else {
1284                 Row const & row2 = pm2.getRow(end.pos(), end.boundary());
1285                 Y1 = bv_funcs::getPos(bv, end, end.boundary()).y_ - row2.ascent();
1286                 Y2 = Y1 + row2.height();
1287                 int const endx = cursorX(bv, end.top(), end.boundary());
1288                 if (!isRTL(buffer, par2)) {
1289                         X1 = 0;
1290                         X2 = endx;
1291                 }
1292                 else {
1293                         X1 = endx;
1294                         X2 = 0 + tm.width();
1295                 }
1296         }
1297
1298         if (!above && !below && &pm1.getRow(beg.pos(), beg.boundary())
1299             == &pm2.getRow(end.pos(), end.boundary()))
1300         {
1301                 // paint only one rectangle
1302                 int const b( !isRTL(*bv.buffer(), par1) ? x + x1 : x + X1 );
1303                 int const w( !isRTL(*bv.buffer(), par1) ? X2 - x1 : x2 - X1 );
1304                 pi.pain.fillRectangle(b, y1, w, y2 - y1, LColor::selection);
1305                 return;
1306         }
1307
1308         if (lyxerr.debugging(Debug::DEBUG)) {
1309                 lyxerr[Debug::DEBUG] << " y1: " << y1 << " y2: " << y2
1310                            << "X1:" << X1 << " x2: " << X2 << " wid: " << tm.width()
1311                         << endl;
1312         }
1313
1314         // paint upper rectangle
1315         pi.pain.fillRectangle(x + x1, y1, x2 - x1, y2 - y1,
1316                                       LColor::selection);
1317         // paint bottom rectangle
1318         pi.pain.fillRectangle(x + X1, Y1, X2 - X1, Y2 - Y1,
1319                                       LColor::selection);
1320         // paint center rectangle
1321         pi.pain.fillRectangle(x, y2, tm.width(),
1322                               Y1 - y2, LColor::selection);
1323 }
1324
1325
1326 bool LyXText::isLastRow(pit_type pit, Row const & row) const
1327 {
1328         return row.endpos() >= pars_[pit].size()
1329                 && pit + 1 == pit_type(paragraphs().size());
1330 }
1331
1332
1333 bool LyXText::isFirstRow(pit_type pit, Row const & row) const
1334 {
1335         return row.pos() == 0 && pit == 0;
1336 }
1337
1338
1339 void LyXText::getWord(CursorSlice & from, CursorSlice & to,
1340         word_location const loc)
1341 {
1342         Paragraph const & from_par = pars_[from.pit()];
1343         switch (loc) {
1344         case WHOLE_WORD_STRICT:
1345                 if (from.pos() == 0 || from.pos() == from_par.size()
1346                     || !from_par.isLetter(from.pos())
1347                     || !from_par.isLetter(from.pos() - 1)) {
1348                         to = from;
1349                         return;
1350                 }
1351                 // no break here, we go to the next
1352
1353         case WHOLE_WORD:
1354                 // If we are already at the beginning of a word, do nothing
1355                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1356                         break;
1357                 // no break here, we go to the next
1358
1359         case PREVIOUS_WORD:
1360                 // always move the cursor to the beginning of previous word
1361                 while (from.pos() && from_par.isLetter(from.pos() - 1))
1362                         --from.pos();
1363                 break;
1364         case NEXT_WORD:
1365                 lyxerr << "LyXText::getWord: NEXT_WORD not implemented yet"
1366                        << endl;
1367                 break;
1368         case PARTIAL_WORD:
1369                 // no need to move the 'from' cursor
1370                 break;
1371         }
1372         to = from;
1373         Paragraph & to_par = pars_[to.pit()];
1374         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1375                 ++to.pos();
1376 }
1377
1378
1379 void LyXText::write(Buffer const & buf, std::ostream & os) const
1380 {
1381         ParagraphList::const_iterator pit = paragraphs().begin();
1382         ParagraphList::const_iterator end = paragraphs().end();
1383         depth_type dth = 0;
1384         for (; pit != end; ++pit)
1385                 pit->write(buf, os, buf.params(), dth);
1386 }
1387
1388
1389 bool LyXText::read(Buffer const & buf, LyXLex & lex, ErrorList & errorList)
1390 {
1391         depth_type depth = 0;
1392
1393         while (lex.isOK()) {
1394                 lex.nextToken();
1395                 string const token = lex.getString();
1396
1397                 if (token.empty())
1398                         continue;
1399
1400                 if (token == "\\end_inset")
1401                         break;
1402
1403                 if (token == "\\end_body")
1404                         continue;
1405
1406                 if (token == "\\begin_body")
1407                         continue;
1408
1409                 if (token == "\\end_document")
1410                         return false;
1411
1412                 if (token == "\\begin_layout") {
1413                         lex.pushToken(token);
1414
1415                         Paragraph par;
1416                         par.params().depth(depth);
1417                         par.setFont(0, LyXFont(LyXFont::ALL_INHERIT, buf.params().language));
1418                         pars_.push_back(par);
1419
1420                         // FIXME: goddamn InsetTabular makes us pass a Buffer
1421                         // not BufferParams
1422                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
1423
1424                 } else if (token == "\\begin_deeper") {
1425                         ++depth;
1426                 } else if (token == "\\end_deeper") {
1427                         if (!depth) {
1428                                 lex.printError("\\end_deeper: " "depth is already null");
1429                         } else {
1430                                 --depth;
1431                         }
1432                 } else {
1433                         lyxerr << "Handling unknown body token: `"
1434                                << token << '\'' << endl;
1435                 }
1436         }
1437         return true;
1438 }
1439
1440 int LyXText::cursorX(BufferView const & bv, CursorSlice const & sl,
1441                 bool boundary) const
1442 {
1443         TextMetrics const & tm = bv.textMetrics(sl.text());
1444         pit_type const pit = sl.pit();
1445         Paragraph const & par = pars_[pit];
1446         ParagraphMetrics const & pm = tm.parMetrics(pit);
1447         if (pm.rows().empty())
1448                 return 0;
1449
1450         pos_type ppos = sl.pos();
1451         // Correct position in front of big insets
1452         bool const boundary_correction = ppos != 0 && boundary;
1453         if (boundary_correction)
1454                 --ppos;
1455
1456         Row const & row = pm.getRow(sl.pos(), boundary);
1457
1458         pos_type cursor_vpos = 0;
1459
1460         Buffer const & buffer = *bv.buffer();
1461         RowMetrics const m = tm.computeRowMetrics(pit, row);
1462         double x = m.x;
1463
1464         pos_type const row_pos  = row.pos();
1465         pos_type const end      = row.endpos();
1466
1467         if (end <= row_pos)
1468                 cursor_vpos = row_pos;
1469         else if (ppos >= end)
1470                 cursor_vpos = isRTL(buffer, par) ? row_pos : end;
1471         else if (ppos > row_pos && ppos >= end)
1472                 // Place cursor after char at (logical) position pos - 1
1473                 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1474                         ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1475         else
1476                 // Place cursor before char at (logical) position ppos
1477                 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1478                         ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1479
1480         pos_type body_pos = par.beginOfBody();
1481         if (body_pos > 0 &&
1482             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1483                 body_pos = 0;
1484
1485         // Use font span to speed things up, see below
1486         FontSpan font_span;
1487         LyXFont font;
1488         FontMetrics const & labelfm = theFontMetrics(
1489                 getLabelFont(buffer, par));
1490
1491         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1492                 pos_type pos = bidi.vis2log(vpos);
1493                 if (body_pos > 0 && pos == body_pos - 1) {
1494                         // FIXME UNICODE
1495                         docstring const lsep = from_utf8(par.layout()->labelsep);
1496                         x += m.label_hfill + labelfm.width(lsep);
1497                         if (par.isLineSeparator(body_pos - 1))
1498                                 x -= singleWidth(buffer, par, body_pos - 1);
1499                 }
1500
1501                 // Use font span to speed things up, see above
1502                 if (pos < font_span.first || pos > font_span.last) {
1503                         font_span = par.fontSpan(pos);
1504                         font = getFont(buffer, par, pos);
1505                 }
1506
1507                 x += singleWidth(par, pos, par.getChar(pos), font);
1508
1509                 if (par.hfillExpansion(row, pos))
1510                         x += (pos >= body_pos) ? m.hfill : m.label_hfill;
1511                 else if (par.isSeparator(pos) && pos >= body_pos)
1512                         x += m.separator;
1513         }
1514
1515         // see correction above
1516         if (boundary_correction)
1517                 if (getFont(buffer, par, ppos).isVisibleRightToLeft())
1518                         x -= singleWidth(buffer, par, ppos);
1519                 else
1520                         x += singleWidth(buffer, par, ppos);
1521
1522         // Make sure inside an inset we always count from the left
1523         // edge (bidi!) -- MV
1524         if (sl.pos() < par.size()) {
1525                 font = getFont(buffer, par, sl.pos());
1526                 if (!boundary && font.isVisibleRightToLeft()
1527                   && par.isInset(sl.pos()))
1528                         x -= par.getInset(sl.pos())->width();
1529         }
1530         return int(x);
1531 }
1532
1533
1534 int LyXText::cursorY(BufferView const & bv, CursorSlice const & sl, bool boundary) const
1535 {
1536         //lyxerr << "LyXText::cursorY: boundary: " << boundary << std::endl;
1537         ParagraphMetrics const & pm = bv.parMetrics(this, sl.pit());
1538         if (pm.rows().empty())
1539                 return 0;
1540
1541         int h = 0;
1542         h -= bv.parMetrics(this, 0).rows()[0].ascent();
1543         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1544                 h += bv.parMetrics(this, pit).height();
1545         }
1546         int pos = sl.pos();
1547         if (pos && boundary)
1548                 --pos;
1549         size_t const rend = pm.pos2row(pos);
1550         for (size_t rit = 0; rit != rend; ++rit)
1551                 h += pm.rows()[rit].height();
1552         h += pm.rows()[rend].ascent();
1553         return h;
1554 }
1555
1556
1557 // Returns the current font and depth as a message.
1558 docstring LyXText::currentState(LCursor & cur)
1559 {
1560         BOOST_ASSERT(this == cur.text());
1561         Buffer & buf = cur.buffer();
1562         Paragraph const & par = cur.paragraph();
1563         odocstringstream os;
1564
1565         if (buf.params().trackChanges)
1566                 os << _("[Change Tracking] ");
1567
1568         Change change = par.lookupChange(cur.pos());
1569
1570         if (change.type != Change::UNCHANGED) {
1571                 Author const & a = buf.params().authors().get(change.author);
1572                 os << _("Change: ") << a.name();
1573                 if (!a.email().empty())
1574                         os << " (" << a.email() << ")";
1575                 // FIXME ctime is english, we should translate that
1576                 os << _(" at ") << ctime(&change.changetime);
1577                 os << " : ";
1578         }
1579
1580         // I think we should only show changes from the default
1581         // font. (Asger)
1582         // No, from the document font (MV)
1583         LyXFont font = real_current_font;
1584         font.reduce(buf.params().getFont());
1585
1586         os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1587
1588         // The paragraph depth
1589         int depth = cur.paragraph().getDepth();
1590         if (depth > 0)
1591                 os << bformat(_(", Depth: %1$d"), depth);
1592
1593         // The paragraph spacing, but only if different from
1594         // buffer spacing.
1595         Spacing const & spacing = par.params().spacing();
1596         if (!spacing.isDefault()) {
1597                 os << _(", Spacing: ");
1598                 switch (spacing.getSpace()) {
1599                 case Spacing::Single:
1600                         os << _("Single");
1601                         break;
1602                 case Spacing::Onehalf:
1603                         os << _("OneHalf");
1604                         break;
1605                 case Spacing::Double:
1606                         os << _("Double");
1607                         break;
1608                 case Spacing::Other:
1609                         os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1610                         break;
1611                 case Spacing::Default:
1612                         // should never happen, do nothing
1613                         break;
1614                 }
1615         }
1616
1617 #ifdef DEVEL_VERSION
1618         os << _(", Inset: ") << &cur.inset();
1619         os << _(", Paragraph: ") << cur.pit();
1620         os << _(", Id: ") << par.id();
1621         os << _(", Position: ") << cur.pos();
1622         os << _(", Boundary: ") << cur.boundary();
1623 //      Row & row = cur.textRow();
1624 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1625 #endif
1626         return os.str();
1627 }
1628
1629
1630 docstring LyXText::getPossibleLabel(LCursor & cur) const
1631 {
1632         pit_type pit = cur.pit();
1633
1634         LyXLayout_ptr layout = pars_[pit].layout();
1635
1636         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1637                 LyXLayout_ptr const & layout2 = pars_[pit - 1].layout();
1638                 if (layout2->latextype != LATEX_PARAGRAPH) {
1639                         --pit;
1640                         layout = layout2;
1641                 }
1642         }
1643
1644         docstring name = from_ascii(layout->latexname());
1645
1646         // for captions, we want the abbreviation of the float type
1647         if (layout->labeltype == LABEL_SENSITIVE) {
1648                 // Search for the first float or wrap inset in the iterator
1649                 for (int i = cur.depth(); --i >= 0; ) {
1650                         InsetBase * const in = &cur[i].inset();
1651                         if (in->lyxCode() == InsetBase::FLOAT_CODE
1652                             || in->lyxCode() == InsetBase::WRAP_CODE) {
1653                                 name = in->getInsetName();
1654                                 break;
1655                         }
1656                 }
1657         }
1658
1659         docstring text = name.substr(0, 3);
1660         if (name == "theorem")
1661                 text = from_ascii("thm"); // Create a correct prefix for prettyref
1662
1663         text += ':';
1664         if (layout->latextype == LATEX_PARAGRAPH || lyxrc.label_init_length < 0)
1665                 text.erase();
1666
1667         docstring par_text = pars_[pit].asString(cur.buffer(), false);
1668         for (int i = 0; i < lyxrc.label_init_length; ++i) {
1669                 if (par_text.empty())
1670                         break;
1671                 docstring head;
1672                 par_text = split(par_text, head, ' ');
1673                 // Is it legal to use spaces in labels ?
1674                 if (i > 0)
1675                         text += '-';
1676                 text += head;
1677         }
1678
1679         return text;
1680 }
1681
1682
1683 void LyXText::setCursorFromCoordinates(LCursor & cur, int const x, int const y)
1684 {
1685         BOOST_ASSERT(this == cur.text());
1686         pit_type pit = getPitNearY(cur.bv(), y);
1687
1688         TextMetrics const & tm = cur.bv().textMetrics(this);
1689         ParagraphMetrics const & pm = tm.parMetrics(pit);
1690
1691         int yy = cur.bv().coordCache().get(this, pit).y_ - pm.ascent();
1692         lyxerr[Debug::DEBUG]
1693                 << BOOST_CURRENT_FUNCTION
1694                 << ": x: " << x
1695                 << " y: " << y
1696                 << " pit: " << pit
1697                 << " yy: " << yy << endl;
1698
1699         int r = 0;
1700         BOOST_ASSERT(pm.rows().size());
1701         for (; r < int(pm.rows().size()) - 1; ++r) {
1702                 Row const & row = pm.rows()[r];
1703                 if (int(yy + row.height()) > y)
1704                         break;
1705                 yy += row.height();
1706         }
1707
1708         Row const & row = pm.rows()[r];
1709
1710         lyxerr[Debug::DEBUG]
1711                 << BOOST_CURRENT_FUNCTION
1712                 << ": row " << r
1713                 << " from pos: " << row.pos()
1714                 << endl;
1715
1716         bool bound = false;
1717         int xx = x;
1718         pos_type const pos = row.pos()
1719                 + tm.getColumnNearX(pit, row, xx, bound);
1720
1721         lyxerr[Debug::DEBUG]
1722                 << BOOST_CURRENT_FUNCTION
1723                 << ": setting cursor pit: " << pit
1724                 << " pos: " << pos
1725                 << endl;
1726
1727         setCursor(cur, pit, pos, true, bound);
1728         // remember new position.
1729         cur.setTargetX();
1730 }
1731
1732
1733 void LyXText::charsTranspose(LCursor & cur)
1734 {
1735         BOOST_ASSERT(this == cur.text());
1736
1737         pos_type pos = cur.pos();
1738
1739         // If cursor is at beginning or end of paragraph, do nothing.
1740         if (pos == cur.lastpos() || pos == 0)
1741                 return;
1742
1743         Paragraph & par = cur.paragraph();
1744
1745         // Get the positions of the characters to be transposed.
1746         pos_type pos1 = pos - 1;
1747         pos_type pos2 = pos;
1748
1749         // In change tracking mode, ignore deleted characters.
1750         while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1751                 ++pos2;
1752         if (pos2 == cur.lastpos())
1753                 return;
1754
1755         while (pos1 >= 0 && par.isDeleted(pos1))
1756                 --pos1;
1757         if (pos1 < 0)
1758                 return;
1759
1760         // Don't do anything if one of the "characters" is not regular text.
1761         if (par.isInset(pos1) || par.isInset(pos2))
1762                 return;
1763
1764         // Store the characters to be transposed (including font information).
1765         char_type char1 = par.getChar(pos1);
1766         LyXFont const font1 =
1767                 par.getFontSettings(cur.buffer().params(), pos1);
1768
1769         char_type char2 = par.getChar(pos2);
1770         LyXFont const font2 =
1771                 par.getFontSettings(cur.buffer().params(), pos2);
1772
1773         // And finally, we are ready to perform the transposition.
1774         // Track the changes if Change Tracking is enabled.
1775         bool const trackChanges = cur.buffer().params().trackChanges;
1776
1777         recordUndo(cur);
1778
1779         par.eraseChar(pos2, trackChanges);
1780         par.eraseChar(pos1, trackChanges);
1781         par.insertChar(pos1, char2, font2, trackChanges);
1782         par.insertChar(pos2, char1, font1, trackChanges);
1783
1784         // After the transposition, move cursor to after the transposition.
1785         setCursor(cur, cur.pit(), pos2);
1786         cur.forwardPos();
1787 }
1788
1789
1790 } // namespace lyx