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 "cursor.h"
  27 #include "pariterator.h"
  28 #include "coordcache.h"
  29 #include "CutAndPaste.h"
  30 #include "debug.h"
  31 #include "dispatchresult.h"
  32 #include "encoding.h"
  33 #include "errorlist.h"
  34 #include "funcrequest.h"
  35 #include "factory.h"
  36 #include "FontIterator.h"
  37 #include "gettext.h"
  38 #include "language.h"
  39 #include "LColor.h"
  40 #include "lyxlength.h"
  41 #include "lyxlex.h"
  42 #include "lyxrc.h"
  43 #include "lyxrow.h"
  44 #include "metricsinfo.h"
  45 #include "paragraph.h"
  46 #include "paragraph_funcs.h"
  47 #include "ParagraphParameters.h"
  48 #include "rowpainter.h"
  49 #include "undo.h"
  50 #include "vspace.h"
  51 #include "WordLangTuple.h"
  52
  53 #include "frontends/FontMetrics.h"
  54 #include "frontends/Painter.h"
  55
  56 #include "insets/insettext.h"
  57 #include "insets/insetbibitem.h"
  58 #include "insets/insethfill.h"
  59 #include "insets/insetlatexaccent.h"
  60 #include "insets/insetline.h"
  61 #include "insets/insetnewline.h"
  62 #include "insets/insetpagebreak.h"
  63 #include "insets/insetoptarg.h"
  64 #include "insets/insetspace.h"
  65 #include "insets/insetspecialchar.h"
  66 #include "insets/insettabular.h"
  67
  68 #include "support/lstrings.h"
  69 #include "support/textutils.h"
  70 #include "support/convert.h"
  71
  72 #include <boost/current_function.hpp>
  73
  74 #include <sstream>
  75
  76
  77 namespace lyx {
  78
  79 using support::bformat;
  80 using support::contains;
  81 using support::lowercase;
  82 using support::split;
  83 using support::uppercase;
  84
  85 using cap::cutSelection;
  86 using cap::pasteParagraphList;
  87
  88 using frontend::FontMetrics;
  89
  90 using std::auto_ptr;
  91 using std::advance;
  92 using std::distance;
  93 using std::max;
  94 using std::min;
  95 using std::endl;
  96 using std::string;
  97
  98
  99 namespace {
 100
 101 int numberOfSeparators(Paragraph const & par, Row const & row)
 102 {
 103         pos_type const first = max(row.pos(), par.beginOfBody());
 104         pos_type const last = row.endpos() - 1;
 105         int n = 0;
 106         for (pos_type p = first; p < last; ++p) {
 107                 if (par.isSeparator(p))
 108                         ++n;
 109         }
 110         return n;
 111 }
 112
 113
 114 int numberOfLabelHfills(Paragraph const & par, Row const & row)
 115 {
 116         pos_type last = row.endpos() - 1;
 117         pos_type first = row.pos();
 118
 119         // hfill *DO* count at the beginning of paragraphs!
 120         if (first) {
 121                 while (first < last && par.isHfill(first))
 122                         ++first;
 123         }
 124
 125         last = min(last, par.beginOfBody());
 126         int n = 0;
 127         for (pos_type p = first; p < last; ++p) {
 128                 if (par.isHfill(p))
 129                         ++n;
 130         }
 131         return n;
 132 }
 133
 134
 135 int numberOfHfills(Paragraph const & par, Row const & row)
 136 {
 137         pos_type const last = row.endpos();
 138         pos_type first = row.pos();
 139
 140         // hfill *DO* count at the beginning of paragraphs!
 141         if (first) {
 142                 while (first < last && par.isHfill(first))
 143                         ++first;
 144         }
 145
 146         first = max(first, par.beginOfBody());
 147
 148         int n = 0;
 149         for (pos_type p = first; p < last; ++p) {
 150                 if (par.isHfill(p))
 151                         ++n;
 152         }
 153         return n;
 154 }
 155
 156
 157 void readParToken(Buffer const & buf, Paragraph & par, LyXLex & lex,
 158         string const & token, LyXFont & font, Change & change, ErrorList & errorList)
 159 {
 160         BufferParams const & bp = buf.params();
 161
 162         if (token[0] != '\\') {
 163 #if 0
 164                 string::const_iterator cit = token.begin();
 165                 for (; cit != token.end(); ++cit)
 166                         par.insertChar(par.size(), (*cit), font, change);
 167 #else
 168                 docstring dstr = lex.getDocString();
 169                 docstring::const_iterator cit = dstr.begin();
 170                 docstring::const_iterator cend = dstr.end();
 171                 for (; cit != cend; ++cit)
 172                         par.insertChar(par.size(), *cit, font, change);
 173 #endif
 174         } else if (token == "\\begin_layout") {
 175                 lex.eatLine();
 176                 string layoutname = lex.getString();
 177
 178                 font = LyXFont(LyXFont::ALL_INHERIT, bp.language);
 179                 change = Change(Change::UNCHANGED);
 180
 181                 LyXTextClass const & tclass = bp.getLyXTextClass();
 182
 183                 if (layoutname.empty()) {
 184                         layoutname = tclass.defaultLayoutName();
 185                 }
 186
 187                 bool hasLayout = tclass.hasLayout(layoutname);
 188
 189                 if (!hasLayout) {
 190                         errorList.push_back(ErrorItem(_("Unknown layout"),
 191                         bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
 192                         from_utf8(layoutname), from_utf8(tclass.name())), par.id(), 0, par.size()));
 193                         layoutname = tclass.defaultLayoutName();
 194                 }
 195
 196                 par.layout(bp.getLyXTextClass()[layoutname]);
 197
 198                 // Test whether the layout is obsolete.
 199                 LyXLayout_ptr const & layout = par.layout();
 200                 if (!layout->obsoleted_by().empty())
 201                         par.layout(bp.getLyXTextClass()[layout->obsoleted_by()]);
 202
 203                 par.params().read(lex);
 204
 205         } else if (token == "\\end_layout") {
 206                 lyxerr << BOOST_CURRENT_FUNCTION
 207                        << ": Solitary \\end_layout in line "
 208                        << lex.getLineNo() << "\n"
 209                        << "Missing \\begin_layout?.\n";
 210         } else if (token == "\\end_inset") {
 211                 lyxerr << BOOST_CURRENT_FUNCTION
 212                        << ": Solitary \\end_inset in line "
 213                        << lex.getLineNo() << "\n"
 214                        << "Missing \\begin_inset?.\n";
 215         } else if (token == "\\begin_inset") {
 216                 InsetBase * inset = readInset(lex, buf);
 217                 if (inset)
 218                         par.insertInset(par.size(), inset, font, change);
 219                 else {
 220                         lex.eatLine();
 221                         docstring line = from_utf8(lex.getString());
 222                         errorList.push_back(ErrorItem(_("Unknown Inset"), line,
 223                                             par.id(), 0, par.size()));
 224                 }
 225         } else if (token == "\\family") {
 226                 lex.next();
 227                 font.setLyXFamily(lex.getString());
 228         } else if (token == "\\series") {
 229                 lex.next();
 230                 font.setLyXSeries(lex.getString());
 231         } else if (token == "\\shape") {
 232                 lex.next();
 233                 font.setLyXShape(lex.getString());
 234         } else if (token == "\\size") {
 235                 lex.next();
 236                 font.setLyXSize(lex.getString());
 237         } else if (token == "\\lang") {
 238                 lex.next();
 239                 string const tok = lex.getString();
 240                 Language const * lang = languages.getLanguage(tok);
 241                 if (lang) {
 242                         font.setLanguage(lang);
 243                 } else {
 244                         font.setLanguage(bp.language);
 245                         lex.printError("Unknown language `$$Token'");
 246                 }
 247         } else if (token == "\\numeric") {
 248                 lex.next();
 249                 font.setNumber(font.setLyXMisc(lex.getString()));
 250         } else if (token == "\\emph") {
 251                 lex.next();
 252                 font.setEmph(font.setLyXMisc(lex.getString()));
 253         } else if (token == "\\bar") {
 254                 lex.next();
 255                 string const tok = lex.getString();
 256
 257                 if (tok == "under")
 258                         font.setUnderbar(LyXFont::ON);
 259                 else if (tok == "no")
 260                         font.setUnderbar(LyXFont::OFF);
 261                 else if (tok == "default")
 262                         font.setUnderbar(LyXFont::INHERIT);
 263                 else
 264                         lex.printError("Unknown bar font flag "
 265                                        "`$$Token'");
 266         } else if (token == "\\noun") {
 267                 lex.next();
 268                 font.setNoun(font.setLyXMisc(lex.getString()));
 269         } else if (token == "\\color") {
 270                 lex.next();
 271                 font.setLyXColor(lex.getString());
 272         } else if (token == "\\InsetSpace" || token == "\\SpecialChar") {
 273
 274                 // Insets don't make sense in a free-spacing context! ---Kayvan
 275                 if (par.isFreeSpacing()) {
 276                         if (token == "\\InsetSpace")
 277                                 par.insertChar(par.size(), ' ', font, change);
 278                         else if (lex.isOK()) {
 279                                 lex.next();
 280                                 string const next_token = lex.getString();
 281                                 if (next_token == "\\-")
 282                                         par.insertChar(par.size(), '-', font, change);
 283                                 else {
 284                                         lex.printError("Token `$$Token' "
 285                                                        "is in free space "
 286                                                        "paragraph layout!");
 287                                 }
 288                         }
 289                 } else {
 290                         auto_ptr<InsetBase> inset;
 291                         if (token == "\\SpecialChar" )
 292                                 inset.reset(new InsetSpecialChar);
 293                         else
 294                                 inset.reset(new InsetSpace);
 295                         inset->read(buf, lex);
 296                         par.insertInset(par.size(), inset.release(),
 297                                         font, change);
 298                 }
 299         } else if (token == "\\i") {
 300                 auto_ptr<InsetBase> inset(new InsetLatexAccent);
 301                 inset->read(buf, lex);
 302                 par.insertInset(par.size(), inset.release(), font, change);
 303         } else if (token == "\\backslash") {
 304                 par.insertChar(par.size(), '\\', font, change);
 305         } else if (token == "\\newline") {
 306                 auto_ptr<InsetBase> inset(new InsetNewline);
 307                 inset->read(buf, lex);
 308                 par.insertInset(par.size(), inset.release(), font, change);
 309         } else if (token == "\\LyXTable") {
 310                 auto_ptr<InsetBase> inset(new InsetTabular(buf));
 311                 inset->read(buf, lex);
 312                 par.insertInset(par.size(), inset.release(), font, change);
 313         } else if (token == "\\hfill") {
 314                 par.insertInset(par.size(), new InsetHFill, font, change);
 315         } else if (token == "\\lyxline") {
 316                 par.insertInset(par.size(), new InsetLine, font, change);
 317         } else if (token == "\\newpage") {
 318                 par.insertInset(par.size(), new InsetPagebreak, font, change);
 319         } else if (token == "\\change_unchanged") {
 320                 change = Change(Change::UNCHANGED);
 321         } else if (token == "\\change_inserted") {
 322                 lex.eatLine();
 323                 std::istringstream is(lex.getString());
 324                 unsigned int aid;
 325                 time_type ct;
 326                 is >> aid >> ct;
 327                 if (aid >= bp.author_map.size()) {
 328                         errorList.push_back(ErrorItem(_("Change tracking error"),
 329                                             bformat(_("Unknown author index for insertion: %1$d\n"), aid),
 330                                             par.id(), 0, par.size()));
 331                         change = Change(Change::UNCHANGED);
 332                 } else
 333                         change = Change(Change::INSERTED, bp.author_map[aid], ct);
 334         } else if (token == "\\change_deleted") {
 335                 lex.eatLine();
 336                 std::istringstream is(lex.getString());
 337                 unsigned int aid;
 338                 time_type ct;
 339                 is >> aid >> ct;
 340                 if (aid >= bp.author_map.size()) {
 341                         errorList.push_back(ErrorItem(_("Change tracking error"),
 342                                             bformat(_("Unknown author index for deletion: %1$d\n"), aid),
 343                                             par.id(), 0, par.size()));
 344                         change = Change(Change::UNCHANGED);
 345                 } else
 346                         change = Change(Change::DELETED, bp.author_map[aid], ct);
 347         } else {
 348                 lex.eatLine();
 349                 errorList.push_back(ErrorItem(_("Unknown token"),
 350                         bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
 351                         from_utf8(lex.getString())),
 352                         par.id(), 0, par.size()));
 353         }
 354 }
 355
 356
 357 void readParagraph(Buffer const & buf, Paragraph & par, LyXLex & lex,
 358         ErrorList & errorList)
 359 {
 360         lex.nextToken();
 361         string token = lex.getString();
 362         LyXFont font;
 363         Change change(Change::UNCHANGED);
 364
 365         while (lex.isOK()) {
 366                 readParToken(buf, par, lex, token, font, change, errorList);
 367
 368                 lex.nextToken();
 369                 token = lex.getString();
 370
 371                 if (token.empty())
 372                         continue;
 373
 374                 if (token == "\\end_layout") {
 375                         //Ok, paragraph finished
 376                         break;
 377                 }
 378
 379                 lyxerr[Debug::PARSER] << "Handling paragraph token: `"
 380                                       << token << '\'' << endl;
 381                 if (token == "\\begin_layout" || token == "\\end_document"
 382                     || token == "\\end_inset" || token == "\\begin_deeper"
 383                     || token == "\\end_deeper") {
 384                         lex.pushToken(token);
 385                         lyxerr << "Paragraph ended in line "
 386                                << lex.getLineNo() << "\n"
 387                                << "Missing \\end_layout.\n";
 388                         break;
 389                 }
 390         }
 391         // Final change goes to paragraph break:
 392         par.setChange(par.size(), change);
 393
 394         // Initialize begin_of_body_ on load; redoParagraph maintains
 395         par.setBeginOfBody();
 396 }
 397
 398
 399 } // namespace anon
 400
 401
 402
 403 double LyXText::spacing(Buffer const & buffer,
 404                 Paragraph const & par) const
 405 {
 406         if (par.params().spacing().isDefault())
 407                 return buffer.params().spacing().getValue();
 408         return par.params().spacing().getValue();
 409 }
 410
 411
 412 int LyXText::width() const
 413 {
 414         return dim_.wid;
 415 }
 416
 417
 418 int LyXText::height() const
 419 {
 420         return dim_.height();
 421 }
 422
 423
 424 int LyXText::singleWidth(Buffer const & buffer, Paragraph const & par,
 425                 pos_type pos) const
 426 {
 427         return singleWidth(par, pos, par.getChar(pos),
 428                 getFont(buffer, par, pos));
 429 }
 430
 431
 432 int LyXText::singleWidth(Paragraph const & par,
 433                          pos_type pos, char_type c, LyXFont const & font) const
 434 {
 435         // The most common case is handled first (Asger)
 436         if (isPrintable(c)) {
 437                 Language const * language = font.language();
 438                 if (language->rightToLeft()) {
 439                         if ((lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
 440                              lyxrc.font_norm_type == LyXRC::ISO_10646_1)
 441                             && language->lang() == "arabic") {
 442                                 if (Encodings::isComposeChar_arabic(c))
 443                                         return 0;
 444                                 c = par.transformChar(c, pos);
 445                         } else if (language->lang() == "hebrew" &&
 446                                    Encodings::isComposeChar_hebrew(c))
 447                                 return 0;
 448                 }
 449                 return theFontMetrics(font).width(c);
 450         }
 451
 452         if (c == Paragraph::META_INSET)
 453                 return par.getInset(pos)->width();
 454
 455         return theFontMetrics(font).width(c);
 456 }
 457
 458
 459 int LyXText::leftMargin(Buffer const & buffer, pit_type pit) const
 460 {
 461         BOOST_ASSERT(pit >= 0);
 462         BOOST_ASSERT(pit < int(pars_.size()));
 463         return leftMargin(buffer, pit, pars_[pit].size());
 464 }
 465
 466
 467 int LyXText::leftMargin(Buffer const & buffer,
 468                 pit_type const pit, pos_type const pos) const
 469 {
 470         BOOST_ASSERT(pit >= 0);
 471         BOOST_ASSERT(pit < int(pars_.size()));
 472         Paragraph const & par = pars_[pit];
 473         BOOST_ASSERT(pos >= 0);
 474         BOOST_ASSERT(pos <= par.size());
 475         //lyxerr << "LyXText::leftMargin: pit: " << pit << " pos: " << pos << endl;
 476         LyXTextClass const & tclass = buffer.params().getLyXTextClass();
 477         LyXLayout_ptr const & layout = par.layout();
 478
 479         string parindent = layout->parindent;
 480
 481         int l_margin = 0;
 482
 483         if (isMainText(buffer))
 484                 l_margin += changebarMargin();
 485
 486         // FIXME UNICODE
 487         docstring leftm = from_utf8(tclass.leftmargin());
 488         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm);
 489
 490         if (par.getDepth() != 0) {
 491                 // find the next level paragraph
 492                 pit_type newpar = outerHook(pit, pars_);
 493                 if (newpar != pit_type(pars_.size())) {
 494                         if (pars_[newpar].layout()->isEnvironment()) {
 495                                 l_margin = leftMargin(buffer, newpar);
 496                         }
 497                         if (par.layout() == tclass.defaultLayout()) {
 498                                 if (pars_[newpar].params().noindent())
 499                                         parindent.erase();
 500                                 else
 501                                         parindent = pars_[newpar].layout()->parindent;
 502                         }
 503                 }
 504         }
 505
 506         // This happens after sections in standard classes. The 1.3.x
 507         // code compared depths too, but it does not seem necessary
 508         // (JMarc)
 509         if (par.layout() == tclass.defaultLayout()
 510             && pit > 0 && pars_[pit - 1].layout()->nextnoindent)
 511                 parindent.erase();
 512
 513         LyXFont const labelfont = getLabelFont(buffer, par);
 514         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 515
 516         switch (layout->margintype) {
 517         case MARGIN_DYNAMIC:
 518                 if (!layout->leftmargin.empty()) {
 519                         // FIXME UNICODE
 520                         docstring leftm = from_utf8(layout->leftmargin);
 521                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm);
 522                 }
 523                 if (!par.getLabelstring().empty()) {
 524                         // FIXME UNICODE
 525                         docstring labin = from_utf8(layout->labelindent);
 526                         l_margin += labelfont_metrics.signedWidth(labin);
 527                         docstring labstr = par.getLabelstring();
 528                         l_margin += labelfont_metrics.width(labstr);
 529                         docstring labsep = from_utf8(layout->labelsep);
 530                         l_margin += labelfont_metrics.width(labsep);
 531                 }
 532                 break;
 533
 534         case MARGIN_MANUAL: {
 535                 // FIXME UNICODE
 536                 docstring labin = from_utf8(layout->labelindent);
 537                 l_margin += labelfont_metrics.signedWidth(labin);
 538                 // The width of an empty par, even with manual label, should be 0
 539                 if (!par.empty() && pos >= par.beginOfBody()) {
 540                         if (!par.getLabelWidthString().empty()) {
 541                                 docstring labstr = par.getLabelWidthString();
 542                                 l_margin += labelfont_metrics.width(labstr);
 543                                 docstring labsep = from_utf8(layout->labelsep);
 544                                 l_margin += labelfont_metrics.width(labsep);
 545                         }
 546                 }
 547                 break;
 548         }
 549
 550         case MARGIN_STATIC: {
 551                 // FIXME UNICODE
 552                 docstring leftm = from_utf8(layout->leftmargin);
 553                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(leftm)
 554                         * 4     / (par.getDepth() + 4);
 555                 break;
 556         }
 557
 558         case MARGIN_FIRST_DYNAMIC:
 559                 if (layout->labeltype == LABEL_MANUAL) {
 560                         if (pos >= par.beginOfBody()) {
 561                                 // FIXME UNICODE
 562                                 l_margin += labelfont_metrics.signedWidth(
 563                                         from_utf8(layout->leftmargin));
 564                         } else {
 565                                 // FIXME UNICODE
 566                                 l_margin += labelfont_metrics.signedWidth(
 567                                         from_utf8(layout->labelindent));
 568                         }
 569                 } else if (pos != 0
 570                            // Special case to fix problems with
 571                            // theorems (JMarc)
 572                            || (layout->labeltype == LABEL_STATIC
 573                                && layout->latextype == LATEX_ENVIRONMENT
 574                                && !isFirstInSequence(pit, pars_))) {
 575                         // FIXME UNICODE
 576                         l_margin += labelfont_metrics.signedWidth(from_utf8(layout->leftmargin));
 577                 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
 578                            && layout->labeltype != LABEL_BIBLIO
 579                            && layout->labeltype !=
 580                            LABEL_CENTERED_TOP_ENVIRONMENT) {
 581                         l_margin += labelfont_metrics.signedWidth(from_utf8(layout->labelindent));
 582                         l_margin += labelfont_metrics.width(from_utf8(layout->labelsep));
 583                         l_margin += labelfont_metrics.width(par.getLabelstring());
 584                 }
 585                 break;
 586
 587         case MARGIN_RIGHT_ADDRESS_BOX: {
 588 #if 0
 589                 // ok, a terrible hack. The left margin depends on the widest
 590                 // row in this paragraph.
 591                 RowList::iterator rit = par.rows().begin();
 592                 RowList::iterator end = par.rows().end();
 593 #ifdef WITH_WARNINGS
 594 #warning This is wrong.
 595 #endif
 596                 int minfill = maxwidth_;
 597                 for ( ; rit != end; ++rit)
 598                         if (rit->fill() < minfill)
 599                                 minfill = rit->fill();
 600                 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
 601                 l_margin += minfill;
 602 #endif
 603                 // also wrong, but much shorter.
 604                 l_margin += maxwidth_ / 2;
 605                 break;
 606         }
 607         }
 608
 609         if (!par.params().leftIndent().zero())
 610                 l_margin += par.params().leftIndent().inPixels(maxwidth_);
 611
 612         LyXAlignment align;
 613
 614         if (par.params().align() == LYX_ALIGN_LAYOUT)
 615                 align = layout->align;
 616         else
 617                 align = par.params().align();
 618
 619         // set the correct parindent
 620         if (pos == 0
 621             && (layout->labeltype == LABEL_NO_LABEL
 622                || layout->labeltype == LABEL_TOP_ENVIRONMENT
 623                || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
 624                || (layout->labeltype == LABEL_STATIC
 625                    && layout->latextype == LATEX_ENVIRONMENT
 626                    && !isFirstInSequence(pit, pars_)))
 627             && align == LYX_ALIGN_BLOCK
 628             && !par.params().noindent()
 629             // in some insets, paragraphs are never indented
 630             && !(par.inInset() && par.inInset()->neverIndent(buffer))
 631             // display style insets are always centered, omit indentation
 632             && !(!par.empty()
 633                     && par.isInset(pos)
 634                     && par.getInset(pos)->display())
 635             && (par.layout() != tclass.defaultLayout()
 636                 || buffer.params().paragraph_separation ==
 637                    BufferParams::PARSEP_INDENT))
 638         {
 639                 docstring din = from_utf8(parindent);
 640                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(din);
 641         }
 642
 643         return l_margin;
 644 }
 645
 646
 647 int LyXText::rightMargin(Buffer const & buffer, Paragraph const & par) const
 648 {
 649         // FIXME: the correct way is to only call rightMargin() only
 650         // within the main LyXText. The following test is thus bogus.
 651         LyXText const & text = buffer.text();
 652         // We do not want rightmargins on inner texts.
 653         if (&text != this)
 654                 return 0;
 655
 656         BufferParams const & params = buffer.params();
 657         LyXTextClass const & tclass = params.getLyXTextClass();
 658         docstring trmarg = from_utf8(tclass.rightmargin());
 659         docstring lrmarg = from_utf8(par.layout()->rightmargin);
 660         FontMetrics const & fm = theFontMetrics(params.getFont());
 661         int const r_margin =
 662                 lyx::rightMargin()
 663                 + fm.signedWidth(trmarg)
 664                 + fm.signedWidth(lrmarg)
 665                 * 4 / (par.getDepth() + 4);
 666
 667         return r_margin;
 668 }
 669
 670
 671 int LyXText::labelEnd(Buffer const & buffer, pit_type const pit) const
 672 {
 673         // labelEnd is only needed if the layout fills a flushleft label.
 674         if (pars_[pit].layout()->margintype != MARGIN_MANUAL)
 675                 return 0;
 676         // return the beginning of the body
 677         return leftMargin(buffer, pit);
 678 }
 679
 680
 681 namespace {
 682
 683 // this needs special handling - only newlines count as a break point
 684 pos_type addressBreakPoint(pos_type i, Paragraph const & par)
 685 {
 686         pos_type const end = par.size();
 687
 688         for (; i < end; ++i)
 689                 if (par.isNewline(i))
 690                         return i + 1;
 691
 692         return end;
 693 }
 694
 695 };
 696
 697
 698 void LyXText::rowBreakPoint(Buffer const & buffer, int right_margin,
 699                 pit_type const pit,     Row & row) const
 700 {
 701         Paragraph const & par = pars_[pit];
 702         pos_type const end = par.size();
 703         pos_type const pos = row.pos();
 704         if (pos == end) {
 705                 row.endpos(end);
 706                 return;
 707         }
 708
 709         // maximum pixel width of a row
 710         int width = maxwidth_ - right_margin; // - leftMargin(buffer, pit, row);
 711         if (width < 0) {
 712                 row.endpos(end);
 713                 return;
 714         }
 715
 716         LyXLayout_ptr const & layout = par.layout();
 717
 718         if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX) {
 719                 row.endpos(addressBreakPoint(pos, par));
 720                 return;
 721         }
 722
 723         pos_type const body_pos = par.beginOfBody();
 724
 725
 726         // Now we iterate through until we reach the right margin
 727         // or the end of the par, then choose the possible break
 728         // nearest that.
 729
 730         int const left = leftMargin(buffer, pit, pos);
 731         int x = left;
 732
 733         // pixel width since last breakpoint
 734         int chunkwidth = 0;
 735
 736         FontIterator fi = FontIterator(buffer, *this, par, pos);
 737         pos_type point = end;
 738         pos_type i = pos;
 739         FontMetrics const & fm = theFontMetrics(getLabelFont(buffer, par));
 740         for ( ; i < end; ++i, ++fi) {
 741                 char_type const c = par.getChar(i);
 742                 int thiswidth = singleWidth(par, i, c, *fi);
 743
 744                 // add the auto-hfill from label end to the body
 745                 if (body_pos && i == body_pos) {
 746                         docstring lsep = from_utf8(layout->labelsep);
 747                         int add = fm.width(lsep);
 748                         if (par.isLineSeparator(i - 1))
 749                                 add -= singleWidth(buffer, par, i - 1);
 750
 751                         add = std::max(add, labelEnd(buffer, pit) - x);
 752                         thiswidth += add;
 753                 }
 754
 755                 x += thiswidth;
 756                 chunkwidth += thiswidth;
 757
 758                 // break before a character that will fall off
 759                 // the right of the row
 760                 if (x >= width) {
 761                         // if no break before, break here
 762                         if (point == end || chunkwidth >= width - left) {
 763                                 if (i > pos)
 764                                         point = i;
 765                                 else
 766                                         point = i + 1;
 767
 768                         }
 769                         // exit on last registered breakpoint:
 770                         break;
 771                 }
 772
 773                 if (par.isNewline(i)) {
 774                         point = i + 1;
 775                         break;
 776                 }
 777                 // Break before...
 778                 if (i + 1 < end) {
 779                         if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
 780                                 point = i + 1;
 781                                 break;
 782                         }
 783                         // ...and after.
 784                         if (par.isInset(i) && par.getInset(i)->display()) {
 785                                 point = i + 1;
 786                                 break;
 787                         }
 788                 }
 789
 790                 if (!par.isInset(i) || par.getInset(i)->isChar()) {
 791                         // some insets are line separators too
 792                         if (par.isLineSeparator(i)) {
 793                                 // register breakpoint:
 794                                 point = i + 1;
 795                                 chunkwidth = 0;
 796                         }
 797                 }
 798         }
 799
 800         // maybe found one, but the par is short enough.
 801         if (i == end && x < width)
 802                 point = end;
 803
 804         // manual labels cannot be broken in LaTeX. But we
 805         // want to make our on-screen rendering of footnotes
 806         // etc. still break
 807         if (body_pos && point < body_pos)
 808                 point = body_pos;
 809
 810         row.endpos(point);
 811 }
 812
 813
 814 void LyXText::setRowWidth(Buffer const & buffer, pit_type const pit, Row & row) const
 815 {
 816         // get the pure distance
 817         pos_type const end = row.endpos();
 818
 819         Paragraph const & par = pars_[pit];
 820         docstring const labelsep = from_utf8(par.layout()->labelsep);
 821         int w = leftMargin(buffer, pit, row.pos());
 822
 823         pos_type const body_pos = par.beginOfBody();
 824         pos_type i = row.pos();
 825
 826         FontMetrics const & fm = theFontMetrics(getLabelFont(buffer, par));
 827
 828         if (i < end) {
 829                 FontIterator fi = FontIterator(buffer, *this, par, i);
 830                 for ( ; i < end; ++i, ++fi) {
 831                         if (body_pos > 0 && i == body_pos) {
 832                                 w += fm.width(labelsep);
 833                                 if (par.isLineSeparator(i - 1))
 834                                         w -= singleWidth(buffer, par, i - 1);
 835                                 w = max(w, labelEnd(buffer, pit));
 836                         }
 837                         char_type const c = par.getChar(i);
 838                         w += singleWidth(par, i, c, *fi);
 839                 }
 840         }
 841
 842         if (body_pos > 0 && body_pos >= end) {
 843                 w += fm.width(labelsep);
 844                 if (end > 0 && par.isLineSeparator(end - 1))
 845                         w -= singleWidth(buffer, par, end - 1);
 846                 w = max(w, labelEnd(buffer, pit));
 847         }
 848
 849         row.width(w + rightMargin(buffer, par));
 850 }
 851
 852
 853 // returns the minimum space a manual label needs on the screen in pixel
 854 int LyXText::labelFill(Buffer const & buffer, Paragraph const & par,
 855                 Row const & row) const
 856 {
 857         pos_type last = par.beginOfBody();
 858
 859         BOOST_ASSERT(last > 0);
 860
 861         // -1 because a label ends with a space that is in the label
 862         --last;
 863
 864         // a separator at this end does not count
 865         if (par.isLineSeparator(last))
 866                 --last;
 867
 868         int w = 0;
 869         for (pos_type i = row.pos(); i <= last; ++i)
 870                 w += singleWidth(buffer, par, i);
 871
 872         docstring const & label = par.params().labelWidthString();
 873         if (label.empty())
 874                 return 0;
 875
 876         FontMetrics const & fm = theFontMetrics(getLabelFont(buffer, par));
 877
 878         return max(0, fm.width(label) - w);
 879 }
 880
 881
 882 LColor_color LyXText::backgroundColor() const
 883 {
 884         return LColor_color(LColor::color(background_color_));
 885 }
 886
 887
 888 void LyXText::setHeightOfRow(BufferView const & bv, pit_type const pit,
 889                 Row & row)
 890 {
 891         Paragraph const & par = pars_[pit];
 892         // get the maximum ascent and the maximum descent
 893         double layoutasc = 0;
 894         double layoutdesc = 0;
 895         double const dh = defaultRowHeight();
 896
 897         // ok, let us initialize the maxasc and maxdesc value.
 898         // Only the fontsize count. The other properties
 899         // are taken from the layoutfont. Nicer on the screen :)
 900         LyXLayout_ptr const & layout = par.layout();
 901
 902         // as max get the first character of this row then it can
 903         // increase but not decrease the height. Just some point to
 904         // start with so we don't have to do the assignment below too
 905         // often.
 906         Buffer const & buffer = *bv.buffer();
 907         LyXFont font = getFont(buffer, par, row.pos());
 908         LyXFont::FONT_SIZE const tmpsize = font.size();
 909         font = getLayoutFont(buffer, pit);
 910         LyXFont::FONT_SIZE const size = font.size();
 911         font.setSize(tmpsize);
 912
 913         LyXFont labelfont = getLabelFont(buffer, par);
 914
 915         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 916         FontMetrics const & fontmetrics = theFontMetrics(font);
 917
 918         // these are minimum values
 919         double const spacing_val = layout->spacing.getValue()
 920                 * spacing(*bv.buffer(), par);
 921         //lyxerr << "spacing_val = " << spacing_val << endl;
 922         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
 923         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
 924
 925         // insets may be taller
 926         InsetList::const_iterator ii = par.insetlist.begin();
 927         InsetList::const_iterator iend = par.insetlist.end();
 928         for ( ; ii != iend; ++ii) {
 929                 if (ii->pos >= row.pos() && ii->pos < row.endpos()) {
 930                         maxasc  = max(maxasc,  ii->inset->ascent());
 931                         maxdesc = max(maxdesc, ii->inset->descent());
 932                 }
 933         }
 934
 935         // Check if any custom fonts are larger (Asger)
 936         // This is not completely correct, but we can live with the small,
 937         // cosmetic error for now.
 938         int labeladdon = 0;
 939         pos_type const pos_end = row.endpos();
 940
 941         LyXFont::FONT_SIZE maxsize =
 942                 par.highestFontInRange(row.pos(), pos_end, size);
 943         if (maxsize > font.size()) {
 944                 font.setSize(maxsize);
 945                 maxasc  = max(maxasc,  fontmetrics.maxAscent());
 946                 maxdesc = max(maxdesc, fontmetrics.maxDescent());
 947         }
 948
 949         // This is nicer with box insets:
 950         ++maxasc;
 951         ++maxdesc;
 952
 953         row.ascent(maxasc);
 954
 955         // is it a top line?
 956         if (row.pos() == 0) {
 957                 Buffer const & buffer = *bv.buffer();
 958                 BufferParams const & bufparams = buffer.params();
 959                 // some parksips VERY EASY IMPLEMENTATION
 960                 if (bufparams.paragraph_separation
 961                     == BufferParams::PARSEP_SKIP
 962                         && pit != 0
 963                         && ((layout->isParagraph() && par.getDepth() == 0)
 964                             || (pars_[pit - 1].layout()->isParagraph()
 965                                 && pars_[pit - 1].getDepth() == 0)))
 966                 {
 967                                 maxasc += bufparams.getDefSkip().inPixels(bv);
 968                 }
 969
 970                 if (par.params().startOfAppendix())
 971                         maxasc += int(3 * dh);
 972
 973                 // This is special code for the chapter, since the label of this
 974                 // layout is printed in an extra row
 975                 if (layout->counter == "chapter"
 976                     && !par.params().labelString().empty()) {
 977                         labeladdon = int(labelfont_metrics.maxHeight()
 978                                      * layout->spacing.getValue()
 979                                      * spacing(buffer, par));
 980                 }
 981
 982                 // special code for the top label
 983                 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
 984                      || layout->labeltype == LABEL_BIBLIO
 985                      || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
 986                     && isFirstInSequence(pit, paragraphs())
 987                     && !par.getLabelstring().empty())
 988                 {
 989                         labeladdon = int(
 990                                   labelfont_metrics.maxHeight()
 991                                         * layout->spacing.getValue()
 992                                         * spacing(*bv.buffer(), par)
 993                                 + (layout->topsep + layout->labelbottomsep) * dh);
 994                 }
 995
 996                 // Add the layout spaces, for example before and after
 997                 // a section, or between the items of a itemize or enumerate
 998                 // environment.
 999
1000                 pit_type prev = depthHook(pit, pars_, par.getDepth());
1001                 if (prev != pit
1002                     && pars_[prev].layout() == layout
1003                     && pars_[prev].getDepth() == par.getDepth()
1004                     && pars_[prev].getLabelWidthString() == par.getLabelWidthString())
1005                 {
1006                         layoutasc = layout->itemsep * dh;
1007                 } else if (pit != 0 || row.pos() != 0) {
1008                         if (layout->topsep > 0)
1009                                 layoutasc = layout->topsep * dh;
1010                 }
1011
1012                 prev = outerHook(pit, pars_);
1013                 if (prev != pit_type(pars_.size())) {
1014                         maxasc += int(pars_[prev].layout()->parsep * dh);
1015                 } else if (pit != 0) {
1016                         if (pars_[pit - 1].getDepth() != 0 ||
1017                                         pars_[pit - 1].layout() == layout) {
1018                                 maxasc += int(layout->parsep * dh);
1019                         }
1020                 }
1021         }
1022
1023         // is it a bottom line?
1024         if (row.endpos() >= par.size()) {
1025                 // add the layout spaces, for example before and after
1026                 // a section, or between the items of a itemize or enumerate
1027                 // environment
1028                 pit_type nextpit = pit + 1;
1029                 if (nextpit != pit_type(pars_.size())) {
1030                         pit_type cpit = pit;
1031                         double usual = 0;
1032                         double unusual = 0;
1033
1034                         if (pars_[cpit].getDepth() > pars_[nextpit].getDepth()) {
1035                                 usual = pars_[cpit].layout()->bottomsep * dh;
1036                                 cpit = depthHook(cpit, paragraphs(), pars_[nextpit].getDepth());
1037                                 if (pars_[cpit].layout() != pars_[nextpit].layout()
1038                                         || pars_[nextpit].getLabelWidthString() != pars_[cpit].getLabelWidthString())
1039                                 {
1040                                         unusual = pars_[cpit].layout()->bottomsep * dh;
1041                                 }
1042                                 layoutdesc = max(unusual, usual);
1043                         } else if (pars_[cpit].getDepth() == pars_[nextpit].getDepth()) {
1044                                 if (pars_[cpit].layout() != pars_[nextpit].layout()
1045                                         || pars_[nextpit].getLabelWidthString() != pars_[cpit].getLabelWidthString())
1046                                         layoutdesc = int(pars_[cpit].layout()->bottomsep * dh);
1047                         }
1048                 }
1049         }
1050
1051         // incalculate the layout spaces
1052         maxasc  += int(layoutasc  * 2 / (2 + pars_[pit].getDepth()));
1053         maxdesc += int(layoutdesc * 2 / (2 + pars_[pit].getDepth()));
1054
1055         // FIXME: the correct way is to do the following is to move the
1056         // following code in another method specially tailored for the
1057         // main LyXText. The following test is thus bogus.
1058         LyXText const & text = buffer.text();
1059         // Top and bottom margin of the document (only at top-level)
1060         if (&text == this) {
1061                 if (pit == 0 && row.pos() == 0)
1062                         maxasc += 20;
1063                 if (pit + 1 == pit_type(pars_.size()) &&
1064                     row.endpos() == par.size())
1065                         maxdesc += 20;
1066         }
1067
1068         row.ascent(maxasc + labeladdon);
1069         row.descent(maxdesc);
1070 }
1071
1072
1073 namespace {
1074
1075 }
1076
1077 void LyXText::breakParagraph(LCursor & cur, bool keep_layout)
1078 {
1079         BOOST_ASSERT(this == cur.text());
1080
1081         Paragraph & cpar = cur.paragraph();
1082         pit_type cpit = cur.pit();
1083
1084         LyXTextClass const & tclass = cur.buffer().params().getLyXTextClass();
1085         LyXLayout_ptr const & layout = cpar.layout();
1086
1087         // this is only allowed, if the current paragraph is not empty
1088         // or caption and if it has not the keepempty flag active
1089         if (cur.lastpos() == 0 && !cpar.allowEmpty()
1090            && layout->labeltype != LABEL_SENSITIVE)
1091                 return;
1092
1093         // a layout change may affect also the following paragraph
1094         recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
1095
1096         // Always break behind a space
1097         // It is better to erase the space (Dekel)
1098         if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
1099                 // FIXME: change tracking (MG)
1100                 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1101
1102         // How should the layout for the new paragraph be?
1103         int preserve_layout = 0;
1104         if (keep_layout)
1105                 preserve_layout = 2;
1106         else
1107                 preserve_layout = layout->isEnvironment();
1108
1109         // We need to remember this before we break the paragraph, because
1110         // that invalidates the layout variable
1111         bool sensitive = layout->labeltype == LABEL_SENSITIVE;
1112
1113         // we need to set this before we insert the paragraph.
1114         bool const isempty = cpar.allowEmpty() && cpar.empty();
1115
1116         lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
1117                          cur.pos(), preserve_layout);
1118
1119         // After this, neither paragraph contains any rows!
1120
1121         cpit = cur.pit();
1122         pit_type next_par = cpit + 1;
1123
1124         // well this is the caption hack since one caption is really enough
1125         if (sensitive) {
1126                 if (cur.pos() == 0)
1127                         // set to standard-layout
1128                         pars_[cpit].applyLayout(tclass.defaultLayout());
1129                 else
1130                         // set to standard-layout
1131                         pars_[next_par].applyLayout(tclass.defaultLayout());
1132         }
1133
1134         while (!pars_[next_par].empty() && pars_[next_par].isNewline(0))
1135                 // FIXME: change tracking (MG)
1136                 pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges);
1137
1138         ParIterator current_it(cur);
1139         ParIterator last_it(cur);
1140         ++last_it;
1141         ++last_it;
1142
1143         updateLabels(cur.buffer(), current_it, last_it);
1144
1145         // Mark "carriage return" as inserted if change tracking:
1146         if (cur.buffer().params().trackChanges) {
1147                 // FIXME: Change tracking (MG)
1148                 cur.paragraph().setChange(cur.paragraph().size(),
1149                         Change(Change::INSERTED));
1150         }
1151
1152         // FIXME: Breaking a paragraph has nothing to do with setting a cursor.
1153         // Because of the mix between the model (the paragraph contents) and the
1154         // view (the paragraph breaking in rows, we have to do this here before
1155         // the setCursor() call below.
1156         redoParagraph(cur.bv(), cpit);
1157         redoParagraph(cur.bv(), cpit + 1);
1158
1159         // This check is necessary. Otherwise the new empty paragraph will
1160         // be deleted automatically. And it is more friendly for the user!
1161         if (cur.pos() != 0 || isempty)
1162                 setCursor(cur, cur.pit() + 1, 0);
1163         else
1164                 setCursor(cur, cur.pit(), 0);
1165 }
1166
1167
1168 // insert a character, moves all the following breaks in the
1169 // same Paragraph one to the right and make a rebreak
1170 void LyXText::insertChar(LCursor & cur, char_type c)
1171 {
1172         BOOST_ASSERT(this == cur.text());
1173         BOOST_ASSERT(c != Paragraph::META_INSET);
1174
1175         recordUndo(cur, Undo::INSERT);
1176
1177         Buffer const & buffer = cur.buffer();
1178         Paragraph & par = cur.paragraph();
1179         // try to remove this
1180         pit_type const pit = cur.pit();
1181
1182         bool const freeSpacing = par.layout()->free_spacing ||
1183                 par.isFreeSpacing();
1184
1185         if (lyxrc.auto_number) {
1186                 static docstring const number_operators = from_ascii("+-/*");
1187                 static docstring const number_unary_operators = from_ascii("+-");
1188                 static docstring const number_seperators = from_ascii(".,:");
1189
1190                 if (current_font.number() == LyXFont::ON) {
1191                         if (!isDigit(c) && !contains(number_operators, c) &&
1192                             !(contains(number_seperators, c) &&
1193                               cur.pos() != 0 &&
1194                               cur.pos() != cur.lastpos() &&
1195                               getFont(buffer, par, cur.pos()).number() == LyXFont::ON &&
1196                               getFont(buffer, par, cur.pos() - 1).number() == LyXFont::ON)
1197                            )
1198                                 number(cur); // Set current_font.number to OFF
1199                 } else if (isDigit(c) &&
1200                            real_current_font.isVisibleRightToLeft()) {
1201                         number(cur); // Set current_font.number to ON
1202
1203                         if (cur.pos() != 0) {
1204                                 char_type const c = par.getChar(cur.pos() - 1);
1205                                 if (contains(number_unary_operators, c) &&
1206                                     (cur.pos() == 1
1207                                      || par.isSeparator(cur.pos() - 2)
1208                                      || par.isNewline(cur.pos() - 2))
1209                                   ) {
1210                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
1211                                 } else if (contains(number_seperators, c)
1212                                      && cur.pos() >= 2
1213                                      && getFont(buffer, par, cur.pos() - 2).number() == LyXFont::ON) {
1214                                         setCharFont(buffer, pit, cur.pos() - 1, current_font);
1215                                 }
1216                         }
1217                 }
1218         }
1219
1220         // First check, if there will be two blanks together or a blank at
1221         // the beginning of a paragraph.
1222         // I decided to handle blanks like normal characters, the main
1223         // difference are the special checks when calculating the row.fill
1224         // (blank does not count at the end of a row) and the check here
1225
1226         // When the free-spacing option is set for the current layout,
1227         // disable the double-space checking
1228         if (!freeSpacing && isLineSeparatorChar(c)) {
1229                 if (cur.pos() == 0) {
1230                         static bool sent_space_message = false;
1231                         if (!sent_space_message) {
1232                                 cur.message(_("You cannot insert a space at the "
1233                                                            "beginning of a paragraph. Please read the Tutorial."));
1234                                 sent_space_message = true;
1235                         }
1236                         return;
1237                 }
1238                 BOOST_ASSERT(cur.pos() > 0);
1239                 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
1240                     && !par.isDeleted(cur.pos() - 1)) {
1241                         static bool sent_space_message = false;
1242                         if (!sent_space_message) {
1243                                 cur.message(_("You cannot type two spaces this way. "
1244                                                            "Please read the Tutorial."));
1245                                 sent_space_message = true;
1246                         }
1247                         return;
1248                 }
1249         }
1250
1251         par.insertChar(cur.pos(), c, current_font, cur.buffer().params().trackChanges);
1252
1253         // FIXME: Inserting a character has nothing to do with setting a cursor.
1254         // Because of the mix between the model (the paragraph contents) and the
1255         // view (the paragraph breaking in rows, we have to do this here.
1256         redoParagraph(cur.bv(), cur.pit());
1257         setCursor(cur, cur.pit(), cur.pos() + 1, false, cur.boundary());
1258         charInserted();
1259 }
1260
1261
1262 void LyXText::charInserted()
1263 {
1264         // Here we call finishUndo for every 20 characters inserted.
1265         // This is from my experience how emacs does it. (Lgb)
1266         static unsigned int counter;
1267         if (counter < 20) {
1268                 ++counter;
1269         } else {
1270                 finishUndo();
1271                 counter = 0;
1272         }
1273 }
1274
1275
1276 RowMetrics LyXText::computeRowMetrics(Buffer const & buffer,
1277                 pit_type const pit, Row const & row) const
1278 {
1279         RowMetrics result;
1280         Paragraph const & par = pars_[pit];
1281
1282         double w = dim_.wid - row.width();
1283
1284         bool const is_rtl = isRTL(buffer, par);
1285         if (is_rtl)
1286                 result.x = rightMargin(buffer, par);
1287         else
1288                 result.x = leftMargin(buffer, pit, row.pos());
1289
1290         // is there a manual margin with a manual label
1291         LyXLayout_ptr const & layout = par.layout();
1292
1293         if (layout->margintype == MARGIN_MANUAL
1294             && layout->labeltype == LABEL_MANUAL) {
1295                 /// We might have real hfills in the label part
1296                 int nlh = numberOfLabelHfills(par, row);
1297
1298                 // A manual label par (e.g. List) has an auto-hfill
1299                 // between the label text and the body of the
1300                 // paragraph too.
1301                 // But we don't want to do this auto hfill if the par
1302                 // is empty.
1303                 if (!par.empty())
1304                         ++nlh;
1305
1306                 if (nlh && !par.getLabelWidthString().empty())
1307                         result.label_hfill = labelFill(buffer, par, row) / double(nlh);
1308         }
1309
1310         // are there any hfills in the row?
1311         int const nh = numberOfHfills(par, row);
1312
1313         if (nh) {
1314                 if (w > 0)
1315                         result.hfill = w / nh;
1316         // we don't have to look at the alignment if it is ALIGN_LEFT and
1317         // if the row is already larger then the permitted width as then
1318         // we force the LEFT_ALIGN'edness!
1319         } else if (int(row.width()) < maxwidth_) {
1320                 // is it block, flushleft or flushright?
1321                 // set x how you need it
1322                 int align;
1323                 if (par.params().align() == LYX_ALIGN_LAYOUT)
1324                         align = layout->align;
1325                 else
1326                         align = par.params().align();
1327
1328                 // Display-style insets should always be on a centred row
1329                 // The test on par.size() is to catch zero-size pars, which
1330                 // would trigger the assert in Paragraph::getInset().
1331                 //inset = par.size() ? par.getInset(row.pos()) : 0;
1332                 if (!par.empty()
1333                     && par.isInset(row.pos())
1334                     && par.getInset(row.pos())->display())
1335                 {
1336                         align = LYX_ALIGN_CENTER;
1337                 }
1338
1339                 switch (align) {
1340                 case LYX_ALIGN_BLOCK: {
1341                         int const ns = numberOfSeparators(par, row);
1342                         bool disp_inset = false;
1343                         if (row.endpos() < par.size()) {
1344                                 InsetBase const * in = par.getInset(row.endpos());
1345                                 if (in)
1346                                         disp_inset = in->display();
1347                         }
1348                         // If we have separators, this is not the last row of a
1349                         // par, does not end in newline, and is not row above a
1350                         // display inset... then stretch it
1351                         if (ns
1352                             && row.endpos() < par.size()
1353                             && !par.isNewline(row.endpos() - 1)
1354                             && !disp_inset
1355                                 ) {
1356                                 result.separator = w / ns;
1357                         } else if (is_rtl) {
1358                                 result.x += w;
1359                         }
1360                         break;
1361                 }
1362                 case LYX_ALIGN_RIGHT:
1363                         result.x += w;
1364                         break;
1365                 case LYX_ALIGN_CENTER:
1366                         result.x += w / 2;
1367                         break;
1368                 }
1369         }
1370
1371         bidi.computeTables(par, buffer, row);
1372         if (is_rtl) {
1373                 pos_type body_pos = par.beginOfBody();
1374                 pos_type end = row.endpos();
1375
1376                 if (body_pos > 0
1377                     && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1378                 {
1379                         docstring const lsep = from_utf8(layout->labelsep);
1380                         result.x += theFontMetrics(getLabelFont(buffer, par)).width(lsep);
1381                         if (body_pos <= end)
1382                                 result.x += result.label_hfill;
1383                 }
1384         }
1385
1386         return result;
1387 }
1388
1389
1390 // the cursor set functions have a special mechanism. When they
1391 // realize, that you left an empty paragraph, they will delete it.
1392
1393 bool LyXText::cursorRightOneWord(LCursor & cur)
1394 {
1395         BOOST_ASSERT(this == cur.text());
1396
1397         LCursor old = cur;
1398
1399         if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
1400                 ++old.pit();
1401                 old.pos() = 0;
1402         } else {
1403                 // Advance through word.
1404                 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
1405                         ++old.pos();
1406                 // Skip through trailing nonword stuff.
1407                 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
1408                         ++old.pos();
1409         }
1410         return setCursor(cur, old.pit(), old.pos());
1411 }
1412
1413
1414 bool LyXText::cursorLeftOneWord(LCursor & cur)
1415 {
1416         BOOST_ASSERT(this == cur.text());
1417
1418         LCursor old = cur;
1419
1420         if (old.pos() == 0 && old.pit() != 0) {
1421                 --old.pit();
1422                 old.pos() = old.lastpos();
1423         } else {
1424                 // Skip through initial nonword stuff.
1425                 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
1426                         --old.pos();
1427                 // Advance through word.
1428                 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
1429                         --old.pos();
1430         }
1431         return setCursor(cur, old.pit(), old.pos());
1432 }
1433
1434
1435 void LyXText::selectWord(LCursor & cur, word_location loc)
1436 {
1437         BOOST_ASSERT(this == cur.text());
1438         CursorSlice from = cur.top();
1439         CursorSlice to = cur.top();
1440         getWord(from, to, loc);
1441         if (cur.top() != from)
1442                 setCursor(cur, from.pit(), from.pos());
1443         if (to == from)
1444                 return;
1445         cur.resetAnchor();
1446         setCursor(cur, to.pit(), to.pos());
1447         cur.setSelection();
1448 }
1449
1450
1451 // Select the word currently under the cursor when no
1452 // selection is currently set
1453 bool LyXText::selectWordWhenUnderCursor(LCursor & cur, word_location loc)
1454 {
1455         BOOST_ASSERT(this == cur.text());
1456         if (cur.selection())
1457                 return false;
1458         selectWord(cur, loc);
1459         return cur.selection();
1460 }
1461
1462
1463 void LyXText::acceptChange(LCursor & cur)
1464 {
1465         BOOST_ASSERT(this == cur.text());
1466         if (!cur.selection() && cur.lastpos() != 0)
1467                 return;
1468
1469         recordUndoSelection(cur, Undo::INSERT);
1470
1471         DocIterator it = cur.selectionBegin();
1472         DocIterator et = cur.selectionEnd();
1473         pit_type pit = it.pit();
1474         bool isDeleted = pars_[pit].isDeleted(it.pos());
1475         for (; pit <= et.pit(); ++pit) {
1476                 pos_type left  = ( pit == it.pit() ? it.pos() : 0 );
1477                 pos_type right =
1478                     ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1479                 pars_[pit].acceptChanges(left, right);
1480         }
1481         if (isDeleted) {
1482                 ParagraphList & plist = paragraphs();
1483                 if (it.pit() + 1 < et.pit())
1484                         pars_.erase(boost::next(plist.begin(), it.pit() + 1),
1485                                     boost::next(plist.begin(), et.pit()));
1486
1487                 // Paragraph merge if appropriate:
1488                 // FIXME: change tracking (MG)
1489                 if (pars_[it.pit()].isDeleted(pars_[it.pit()].size())) {
1490                         setCursorIntern(cur, it.pit() + 1, 0);
1491                         backspacePos0(cur);
1492                 }
1493         }
1494         finishUndo();
1495         cur.clearSelection();
1496         setCursorIntern(cur, it.pit(), 0);
1497 }
1498
1499
1500 void LyXText::rejectChange(LCursor & cur)
1501 {
1502         BOOST_ASSERT(this == cur.text());
1503         if (!cur.selection() && cur.lastpos() != 0)
1504                 return;
1505
1506         recordUndoSelection(cur, Undo::INSERT);
1507
1508         DocIterator it = cur.selectionBegin();
1509         DocIterator et = cur.selectionEnd();
1510         pit_type pit = it.pit();
1511         bool isInserted = pars_[pit].isInserted(it.pos());
1512         for (; pit <= et.pit(); ++pit) {
1513                 pos_type left  = ( pit == it.pit() ? it.pos() : 0 );
1514                 pos_type right =
1515                     ( pit == et.pit() ? et.pos() : pars_[pit].size() + 1 );
1516                 pars_[pit].rejectChanges(left, right);
1517         }
1518         if (isInserted) {
1519                 ParagraphList & plist = paragraphs();
1520                 if (it.pit() + 1 < et.pit())
1521                         pars_.erase(boost::next(plist.begin(), it.pit() + 1),
1522                                     boost::next(plist.begin(), et.pit()));
1523                 // Paragraph merge if appropriate:
1524                 // FIXME: change tracking (MG)
1525                 if (pars_[it.pit()].isInserted(pars_[it.pit()].size())) {
1526                         setCursorIntern(cur, it.pit() + 1, 0);
1527                         backspacePos0(cur);
1528                 }
1529         }
1530         finishUndo();
1531         cur.clearSelection();
1532         setCursorIntern(cur, it.pit(), 0);
1533 }
1534
1535
1536 // Delete from cursor up to the end of the current or next word.
1537 void LyXText::deleteWordForward(LCursor & cur)
1538 {
1539         BOOST_ASSERT(this == cur.text());
1540         if (cur.lastpos() == 0)
1541                 cursorRight(cur);
1542         else {
1543                 cur.resetAnchor();
1544                 cur.selection() = true;
1545                 cursorRightOneWord(cur);
1546                 cur.setSelection();
1547                 cutSelection(cur, true, false);
1548         }
1549 }
1550
1551
1552 // Delete from cursor to start of current or prior word.
1553 void LyXText::deleteWordBackward(LCursor & cur)
1554 {
1555         BOOST_ASSERT(this == cur.text());
1556         if (cur.lastpos() == 0)
1557                 cursorLeft(cur);
1558         else {
1559                 cur.resetAnchor();
1560                 cur.selection() = true;
1561                 cursorLeftOneWord(cur);
1562                 cur.setSelection();
1563                 cutSelection(cur, true, false);
1564         }
1565 }
1566
1567
1568 // Kill to end of line.
1569 void LyXText::deleteLineForward(LCursor & cur)
1570 {
1571         BOOST_ASSERT(this == cur.text());
1572         if (cur.lastpos() == 0) {
1573                 // Paragraph is empty, so we just go to the right
1574                 cursorRight(cur);
1575         } else {
1576                 cur.resetAnchor();
1577                 cur.selection() = true; // to avoid deletion
1578                 cursorEnd(cur);
1579                 cur.setSelection();
1580                 // What is this test for ??? (JMarc)
1581                 if (!cur.selection())
1582                         deleteWordForward(cur);
1583                 else
1584                         cutSelection(cur, true, false);
1585         }
1586 }
1587
1588
1589 void LyXText::changeCase(LCursor & cur, LyXText::TextCase action)
1590 {
1591         BOOST_ASSERT(this == cur.text());
1592         CursorSlice from;
1593         CursorSlice to;
1594
1595         if (cur.selection()) {
1596                 from = cur.selBegin();
1597                 to = cur.selEnd();
1598         } else {
1599                 from = cur.top();
1600                 getWord(from, to, PARTIAL_WORD);
1601                 cursorRightOneWord(cur);
1602         }
1603
1604         recordUndoSelection(cur);
1605
1606         pos_type pos = from.pos();
1607         int par = from.pit();
1608
1609         while (par != int(pars_.size()) && (pos != to.pos() || par != to.pit())) {
1610                 pit_type pit = par;
1611                 if (pos == pars_[pit].size()) {
1612                         ++par;
1613                         pos = 0;
1614                         continue;
1615                 }
1616                 char_type c = pars_[pit].getChar(pos);
1617                 if (c != Paragraph::META_INSET) {
1618                         switch (action) {
1619                         case text_lowercase:
1620                                 c = lowercase(c);
1621                                 break;
1622                         case text_capitalization:
1623                                 c = uppercase(c);
1624                                 action = text_lowercase;
1625                                 break;
1626                         case text_uppercase:
1627                                 c = uppercase(c);
1628                                 break;
1629                         }
1630                 }
1631
1632                 // FIXME: change tracking (MG)
1633                 // sorry but we are no longer allowed to set a single character directly
1634                 // we have to rewrite this method in terms of erase&insert operations
1635                 //pars_[pit].setChar(pos, c);
1636                 ++pos;
1637         }
1638 }
1639
1640
1641 bool LyXText::erase(LCursor & cur)
1642 {
1643         BOOST_ASSERT(this == cur.text());
1644         bool needsUpdate = false;
1645         Paragraph & par = cur.paragraph();
1646
1647         if (cur.pos() != cur.lastpos()) {
1648                 // this is the code for a normal delete, not pasting
1649                 // any paragraphs
1650                 recordUndo(cur, Undo::DELETE);
1651                 // FIXME: change tracking (MG)
1652                 par.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1653                 if (par.isDeleted(cur.pos()))
1654                         cur.forwardPos();
1655                 needsUpdate = true;
1656         } else if (cur.pit() != cur.lastpit()) {
1657                 if (cur.buffer().params().trackChanges
1658                     && par.isInserted(cur.pos())) {
1659                         // mark "carriage return" as deleted:
1660                         // FIXME: Change tracking (MG)
1661                         par.setChange(cur.pos(), Change(Change::DELETED));
1662                         cur.forwardPos();
1663                         needsUpdate = true;
1664                 } else {
1665                         setCursorIntern(cur, cur.pit() + 1, 0);
1666                         needsUpdate = backspacePos0(cur);
1667                         // FIXME: Change tracking (MG)
1668                         if (cur.paragraph().isDeleted(cur.pos()))
1669                                 cur.forwardPos();
1670                 }
1671         } else
1672                 needsUpdate = dissolveInset(cur);
1673
1674         // Make sure the cursor is correct. Is this really needed?
1675         // FIXME: Inserting characters has nothing to do with setting a cursor.
1676         // Because of the mix between the model (the paragraph contents)
1677         // and the view (the paragraph breaking in rows, we have to do this
1678         // here before the setCursorIntern() call.
1679         if (needsUpdate) {
1680                 redoParagraph(cur.bv(), cur.pit());
1681                 setCursorIntern(cur, cur.pit(), cur.pos());
1682         }
1683
1684         return needsUpdate;
1685 }
1686
1687
1688 bool LyXText::backspacePos0(LCursor & cur)
1689 {
1690         BOOST_ASSERT(this == cur.text());
1691         if (cur.pit() == 0)
1692                 return false;
1693
1694         bool needsUpdate = false;
1695
1696         BufferParams const & bufparams = cur.buffer().params();
1697         LyXTextClass const & tclass = bufparams.getLyXTextClass();
1698         ParagraphList & plist = cur.text()->paragraphs();
1699         Paragraph const & par = cur.paragraph();
1700         LCursor prevcur = cur;
1701         --prevcur.pit();
1702         prevcur.pos() = prevcur.lastpos();
1703         Paragraph const & prevpar = prevcur.paragraph();
1704
1705         // is it an empty paragraph?
1706         if (cur.lastpos() == 0
1707             || (cur.lastpos() == 1 && par.isSeparator(0))) {
1708                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1709                 plist.erase(boost::next(plist.begin(), cur.pit()));
1710                 needsUpdate = true;
1711         }
1712         // is previous par empty?
1713         else if (prevcur.lastpos() == 0
1714                  || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1715                 recordUndo(cur, Undo::ATOMIC, prevcur.pit(), cur.pit());
1716                 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1717                 needsUpdate = true;
1718         }
1719         // Pasting is not allowed, if the paragraphs have different
1720         // layout. I think it is a real bug of all other
1721         // word processors to allow it. It confuses the user.
1722         // Correction: Pasting is always allowed with standard-layout
1723         else if (par.layout() == prevpar.layout()
1724                  || par.layout() == tclass.defaultLayout()) {
1725                 recordUndo(cur, Undo::ATOMIC, prevcur.pit());
1726                 mergeParagraph(bufparams, plist, prevcur.pit());
1727                 needsUpdate = true;
1728         }
1729
1730         if (needsUpdate) {
1731                 updateLabels(cur.buffer());
1732                 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1733         }
1734
1735         return needsUpdate;
1736 }
1737
1738
1739
1740
1741 bool LyXText::backspace(LCursor & cur)
1742 {
1743         BOOST_ASSERT(this == cur.text());
1744         bool needsUpdate = false;
1745         if (cur.pos() == 0) {
1746                 if (cur.pit() == 0)
1747                         return dissolveInset(cur);
1748
1749                 if (cur.buffer().params().trackChanges) {
1750                         // FIXME: Change tracking (MG)
1751                         // Previous paragraph, mark "carriage return" as
1752                         // deleted:
1753                         Paragraph & par = pars_[cur.pit() - 1];
1754                         // Take care of a just inserted para break:
1755                         // FIXME: change tracking (MG)
1756                         if (!par.isInserted(par.size())) {
1757                                 // FIXME: change tracking (MG)
1758                                 par.setChange(par.size(), Change(Change::DELETED));
1759                                 setCursorIntern(cur, cur.pit() - 1, par.size());
1760                                 return true;
1761                         }
1762                 }
1763
1764                 // The cursor is at the beginning of a paragraph, so
1765                 // the backspace will collapse two paragraphs into one.
1766                 needsUpdate = backspacePos0(cur);
1767
1768         } else {
1769                 // this is the code for a normal backspace, not pasting
1770                 // any paragraphs
1771                 recordUndo(cur, Undo::DELETE);
1772                 // We used to do cursorLeftIntern() here, but it is
1773                 // not a good idea since it triggers the auto-delete
1774                 // mechanism. So we do a cursorLeftIntern()-lite,
1775                 // without the dreaded mechanism. (JMarc)
1776                 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1777                                 false, cur.boundary());
1778                 // FIXME: change tracking (MG)
1779                 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1780         }
1781
1782         if (cur.pos() == cur.lastpos())
1783                 setCurrentFont(cur);
1784
1785         // FIXME: Backspacing has nothing to do with setting a cursor.
1786         // Because of the mix between the model (the paragraph contents)
1787         // and the view (the paragraph breaking in rows, we have to do this
1788         // here before the setCursor() call.
1789         redoParagraph(cur.bv(), cur.pit());
1790         setCursor(cur, cur.pit(), cur.pos(), false, cur.boundary());
1791
1792         return needsUpdate;
1793 }
1794
1795
1796 bool LyXText::dissolveInset(LCursor & cur) {
1797         BOOST_ASSERT(this == cur.text());
1798
1799         if (isMainText(*cur.bv().buffer()) || cur.inset().nargs() != 1)
1800                 return false;
1801
1802         bool const in_ert = cur.inset().lyxCode() == InsetBase::ERT_CODE;
1803         recordUndoInset(cur);
1804         cur.selHandle(false);
1805         // save position
1806         pos_type spos = cur.pos();
1807         pit_type spit = cur.pit();
1808         ParagraphList plist;
1809         if (cur.lastpit() != 0 || cur.lastpos() != 0)
1810                 plist = paragraphs();
1811         cur.popLeft();
1812         // store cursor offset
1813         if (spit == 0)
1814                 spos += cur.pos();
1815         spit += cur.pit();
1816         Buffer & b = cur.buffer();
1817         // FIXME: change tracking (MG)
1818         cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1819         if (!plist.empty()) {
1820                 if (in_ert) {
1821                         // ERT paragraphs have the Language latex_language.
1822                         // This is invalid outside of ERT, so we need to
1823                         // change it to the buffer language.
1824                         ParagraphList::iterator it = plist.begin();
1825                         ParagraphList::iterator it_end = plist.end();
1826                         for (; it != it_end; it++) {
1827                                 it->changeLanguage(b.params(),
1828                                                 latex_language,
1829                                                 b.getLanguage());
1830                         }
1831                 }
1832
1833                 pasteParagraphList(cur, plist, b.params().textclass,
1834                                    b.errorList("Paste"));
1835                 // restore position
1836                 cur.pit() = std::min(cur.lastpit(), spit);
1837                 cur.pos() = std::min(cur.lastpos(), spos);
1838         }
1839         cur.clearSelection();
1840         cur.resetAnchor();
1841         return true;
1842 }
1843
1844
1845 Row const & LyXText::firstRow() const
1846 {
1847         return *paragraphs().front().rows().begin();
1848 }
1849
1850
1851 bool LyXText::redoParagraph(BufferView & bv, pit_type const pit)
1852 {
1853         // remove rows of paragraph, keep track of height changes
1854         Paragraph & par = pars_[pit];
1855         Buffer const & buffer = *bv.buffer();
1856
1857         // Add bibitem insets if necessary
1858         if (par.layout()->labeltype == LABEL_BIBLIO) {
1859                 bool hasbibitem(false);
1860                 if (!par.insetlist.empty()
1861                         // Insist on it being in pos 0
1862                         && par.getChar(0) == Paragraph::META_INSET) {
1863                         InsetBase * inset = par.insetlist.begin()->inset;
1864                         if (inset->lyxCode() == InsetBase::BIBITEM_CODE)
1865                                 hasbibitem = true;
1866                 }
1867                 if (!hasbibitem) {
1868                         InsetBibitem * inset(new
1869                                 InsetBibitem(InsetCommandParams("bibitem")));
1870                         par.insertInset(0, static_cast<InsetBase *>(inset),
1871                                         Change(buffer.params().trackChanges ?
1872                                                Change::INSERTED : Change::UNCHANGED));
1873                         bv.cursor().posRight();
1874                 }
1875         }
1876
1877         // Optimisation: this is used in the next two loops
1878         // so better to calculate that once here.
1879         int right_margin = rightMargin(buffer, par);
1880
1881         // redo insets
1882         // FIXME: We should always use getFont(), see documentation of
1883         // noFontChange() in insetbase.h.
1884         LyXFont const bufferfont = buffer.params().getFont();
1885         InsetList::iterator ii = par.insetlist.begin();
1886         InsetList::iterator iend = par.insetlist.end();
1887         for (; ii != iend; ++ii) {
1888                 Dimension dim;
1889                 int const w = maxwidth_ - leftMargin(buffer, pit, ii->pos)
1890                         - right_margin;
1891                 LyXFont const & font = ii->inset->noFontChange() ?
1892                         bufferfont :
1893                         getFont(buffer, par, ii->pos);
1894                 MetricsInfo mi(&bv, font, w);
1895                 ii->inset->metrics(mi, dim);
1896         }
1897
1898         // rebreak the paragraph
1899         par.rows().clear();
1900         Dimension dim;
1901
1902         par.setBeginOfBody();
1903         pos_type z = 0;
1904         do {
1905                 Row row(z);
1906                 rowBreakPoint(buffer, right_margin, pit, row);
1907                 setRowWidth(buffer, pit, row);
1908                 setHeightOfRow(bv, pit, row);
1909                 par.rows().push_back(row);
1910                 dim.wid = std::max(dim.wid, row.width());
1911                 dim.des += row.height();
1912                 z = row.endpos();
1913         } while (z < par.size());
1914
1915         // Make sure that if a par ends in newline, there is one more row
1916         // under it
1917         // FIXME this is a dirty trick. Now the _same_ position in the
1918         // paragraph occurs in _two_ different rows, and has two different
1919         // display positions, leading to weird behaviour when moving up/down.
1920         if (z > 0 && par.isNewline(z - 1)) {
1921                 Row row(z - 1);
1922                 row.endpos(z - 1);
1923                 setRowWidth(buffer, pit, row);
1924                 setHeightOfRow(bv, pit, row);
1925                 par.rows().push_back(row);
1926                 dim.des += row.height();
1927         }
1928
1929         dim.asc += par.rows()[0].ascent();
1930         dim.des -= par.rows()[0].ascent();
1931
1932         bool const same = dim == par.dim();
1933
1934         par.dim() = dim;
1935         //lyxerr << "redoParagraph: " << par.rows().size() << " rows\n";
1936
1937         return !same;
1938 }
1939
1940
1941 void LyXText::metrics(MetricsInfo & mi, Dimension & dim)
1942 {
1943         //BOOST_ASSERT(mi.base.textwidth);
1944         if (mi.base.textwidth)
1945                 maxwidth_ = mi.base.textwidth;
1946         //lyxerr << "LyXText::metrics: width: " << mi.base.textwidth
1947         //      << " maxWidth: " << maxwidth_ << "\nfont: " << mi.base.font << endl;
1948         // save the caller's font locally:
1949         font_ = mi.base.font;
1950
1951         unsigned int h = 0;
1952         unsigned int w = 0;
1953         for (pit_type pit = 0, n = paragraphs().size(); pit != n; ++pit) {
1954                 redoParagraph(*mi.base.bv, pit);
1955                 Paragraph & par = paragraphs()[pit];
1956                 h += par.height();
1957                 if (w < par.width())
1958                         w = par.width();
1959         }
1960
1961         dim.wid = w;
1962         dim.asc = pars_[0].ascent();
1963         dim.des = h - dim.asc;
1964
1965         dim_ = dim;
1966 }
1967
1968
1969 // only used for inset right now. should also be used for main text
1970 void LyXText::draw(PainterInfo & pi, int x, int y) const
1971 {
1972         paintTextInset(*this, pi, x, y);
1973 }
1974
1975
1976 // only used for inset right now. should also be used for main text
1977 void LyXText::drawSelection(PainterInfo & pi, int x, int) const
1978 {
1979         LCursor & cur = pi.base.bv->cursor();
1980         if (!cur.selection())
1981                 return;
1982         if (!ptr_cmp(cur.text(), this))
1983                 return;
1984
1985         if (lyxerr.debugging(Debug::DEBUG)) {
1986                 lyxerr[Debug::DEBUG]
1987                         << BOOST_CURRENT_FUNCTION
1988                         << "draw selection at " << x
1989                         << endl;
1990         }
1991
1992         DocIterator beg = cur.selectionBegin();
1993         DocIterator end = cur.selectionEnd();
1994
1995         BufferView & bv = *pi.base.bv;
1996         Buffer const & buffer = *bv.buffer();
1997
1998         // the selection doesn't touch the visible screen
1999         if (bv_funcs::status(&bv, beg) == bv_funcs::CUR_BELOW
2000             || bv_funcs::status(&bv, end) == bv_funcs::CUR_ABOVE)
2001                 return;
2002
2003         Paragraph const & par1 = pars_[beg.pit()];
2004         Paragraph const & par2 = pars_[end.pit()];
2005
2006         bool const above = (bv_funcs::status(&bv, beg)
2007                             == bv_funcs::CUR_ABOVE);
2008         bool const below = (bv_funcs::status(&bv, end)
2009                             == bv_funcs::CUR_BELOW);
2010         int y1,y2,x1,x2;
2011         if (above) {
2012                 y1 = 0;
2013                 y2 = 0;
2014                 x1 = 0;
2015                 x2 = dim_.wid;
2016         } else {
2017                 Row const & row1 = par1.getRow(beg.pos(), beg.boundary());
2018                 y1 = bv_funcs::getPos(bv, beg, beg.boundary()).y_ - row1.ascent();
2019                 y2 = y1 + row1.height();
2020                 int const startx = cursorX(buffer, beg.top(), beg.boundary());
2021                 if (!isRTL(buffer, par1)) {
2022                         x1 = startx;
2023                         x2 = 0 + dim_.wid;
2024                 }
2025                 else {
2026                         x1 = 0;
2027                         x2 = startx;
2028                 }
2029         }
2030
2031         int Y1,Y2,X1,X2;
2032         if (below) {
2033                 Y1 = bv.workHeight();
2034                 Y2 = bv.workHeight();
2035                 X1 = 0;
2036                 X2 = dim_.wid;
2037         } else {
2038                 Row const & row2 = par2.getRow(end.pos(), end.boundary());
2039                 Y1 = bv_funcs::getPos(bv, end, end.boundary()).y_ - row2.ascent();
2040                 Y2 = Y1 + row2.height();
2041                 int const endx = cursorX(buffer, end.top(), end.boundary());
2042                 if (!isRTL(buffer, par2)) {
2043                         X1 = 0;
2044                         X2 = endx;
2045                 }
2046                 else {
2047                         X1 = endx;
2048                         X2 = 0 + dim_.wid;
2049                 }
2050         }
2051
2052         if (!above && !below && &par1.getRow(beg.pos(), beg.boundary())
2053             == &par2.getRow(end.pos(), end.boundary()))
2054         {
2055                 // paint only one rectangle
2056                 int const b( !isRTL(*bv.buffer(), par1) ? x + x1 : x + X1 );
2057                 int const w( !isRTL(*bv.buffer(), par1) ? X2 - x1 : x2 - X1 );
2058                 pi.pain.fillRectangle(b, y1, w, y2 - y1, LColor::selection);
2059                 return;
2060         }
2061
2062         if (lyxerr.debugging(Debug::DEBUG)) {
2063                 lyxerr[Debug::DEBUG] << " y1: " << y1 << " y2: " << y2
2064                            << "X1:" << X1 << " x2: " << X2 << " wid: " << dim_.wid
2065                         << endl;
2066         }
2067
2068         // paint upper rectangle
2069         pi.pain.fillRectangle(x + x1, y1, x2 - x1, y2 - y1,
2070                                       LColor::selection);
2071         // paint bottom rectangle
2072         pi.pain.fillRectangle(x + X1, Y1, X2 - X1, Y2 - Y1,
2073                                       LColor::selection);
2074         // paint center rectangle
2075         pi.pain.fillRectangle(x, y2, dim_.wid,
2076                               Y1 - y2, LColor::selection);
2077 }
2078
2079 bool LyXText::isLastRow(pit_type pit, Row const & row) const
2080 {
2081         return row.endpos() >= pars_[pit].size()
2082                 && pit + 1 == pit_type(paragraphs().size());
2083 }
2084
2085
2086 bool LyXText::isFirstRow(pit_type pit, Row const & row) const
2087 {
2088         return row.pos() == 0 && pit == 0;
2089 }
2090
2091
2092 void LyXText::getWord(CursorSlice & from, CursorSlice & to,
2093         word_location const loc)
2094 {
2095         Paragraph const & from_par = pars_[from.pit()];
2096         switch (loc) {
2097         case WHOLE_WORD_STRICT:
2098                 if (from.pos() == 0 || from.pos() == from_par.size()
2099                     || !from_par.isLetter(from.pos())
2100                     || !from_par.isLetter(from.pos() - 1)) {
2101                         to = from;
2102                         return;
2103                 }
2104                 // no break here, we go to the next
2105
2106         case WHOLE_WORD:
2107                 // If we are already at the beginning of a word, do nothing
2108                 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
2109                         break;
2110                 // no break here, we go to the next
2111
2112         case PREVIOUS_WORD:
2113                 // always move the cursor to the beginning of previous word
2114                 while (from.pos() && from_par.isLetter(from.pos() - 1))
2115                         --from.pos();
2116                 break;
2117         case NEXT_WORD:
2118                 lyxerr << "LyXText::getWord: NEXT_WORD not implemented yet"
2119                        << endl;
2120                 break;
2121         case PARTIAL_WORD:
2122                 // no need to move the 'from' cursor
2123                 break;
2124         }
2125         to = from;
2126         Paragraph & to_par = pars_[to.pit()];
2127         while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
2128                 ++to.pos();
2129 }
2130
2131
2132 void LyXText::write(Buffer const & buf, std::ostream & os) const
2133 {
2134         ParagraphList::const_iterator pit = paragraphs().begin();
2135         ParagraphList::const_iterator end = paragraphs().end();
2136         depth_type dth = 0;
2137         for (; pit != end; ++pit)
2138                 pit->write(buf, os, buf.params(), dth);
2139 }
2140
2141
2142 bool LyXText::read(Buffer const & buf, LyXLex & lex, ErrorList & errorList)
2143 {
2144         depth_type depth = 0;
2145
2146         while (lex.isOK()) {
2147                 lex.nextToken();
2148                 string const token = lex.getString();
2149
2150                 if (token.empty())
2151                         continue;
2152
2153                 if (token == "\\end_inset")
2154                         break;
2155
2156                 if (token == "\\end_body")
2157                         continue;
2158
2159                 if (token == "\\begin_body")
2160                         continue;
2161
2162                 if (token == "\\end_document")
2163                         return false;
2164
2165                 if (token == "\\begin_layout") {
2166                         lex.pushToken(token);
2167
2168                         Paragraph par;
2169                         par.params().depth(depth);
2170                         par.setFont(0, LyXFont(LyXFont::ALL_INHERIT, buf.params().language));
2171                         pars_.push_back(par);
2172
2173                         // FIXME: goddamn InsetTabular makes us pass a Buffer
2174                         // not BufferParams
2175                         lyx::readParagraph(buf, pars_.back(), lex, errorList);
2176
2177                 } else if (token == "\\begin_deeper") {
2178                         ++depth;
2179                 } else if (token == "\\end_deeper") {
2180                         if (!depth) {
2181                                 lex.printError("\\end_deeper: " "depth is already null");
2182                         } else {
2183                                 --depth;
2184                         }
2185                 } else {
2186                         lyxerr << "Handling unknown body token: `"
2187                                << token << '\'' << endl;
2188                 }
2189         }
2190         return true;
2191 }
2192
2193
2194 int LyXText::ascent() const
2195 {
2196         return dim_.asc;
2197 }
2198
2199
2200 int LyXText::descent() const
2201 {
2202         return dim_.des;
2203 }
2204
2205
2206 int LyXText::cursorX(Buffer const & buffer, CursorSlice const & sl,
2207                 bool boundary) const
2208 {
2209         pit_type const pit = sl.pit();
2210         Paragraph const & par = pars_[pit];
2211         if (par.rows().empty())
2212                 return 0;
2213
2214         pos_type ppos = sl.pos();
2215         // Correct position in front of big insets
2216         bool const boundary_correction = ppos != 0 && boundary;
2217         if (boundary_correction)
2218                 --ppos;
2219
2220         Row const & row = par.getRow(sl.pos(), boundary);
2221
2222         pos_type cursor_vpos = 0;
2223
2224         RowMetrics const m = computeRowMetrics(buffer, pit, row);
2225         double x = m.x;
2226
2227         pos_type const row_pos  = row.pos();
2228         pos_type const end      = row.endpos();
2229
2230         if (end <= row_pos)
2231                 cursor_vpos = row_pos;
2232         else if (ppos >= end)
2233                 cursor_vpos = isRTL(buffer, par) ? row_pos : end;
2234         else if (ppos > row_pos && ppos >= end)
2235                 // Place cursor after char at (logical) position pos - 1
2236                 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
2237                         ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
2238         else
2239                 // Place cursor before char at (logical) position ppos
2240                 cursor_vpos = (bidi.level(ppos) % 2 == 0)
2241                         ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
2242
2243         pos_type body_pos = par.beginOfBody();
2244         if (body_pos > 0 &&
2245             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
2246                 body_pos = 0;
2247
2248         // Use font span to speed things up, see below
2249         FontSpan font_span;
2250         LyXFont font;
2251         FontMetrics const & labelfm = theFontMetrics(
2252                 getLabelFont(buffer, par));
2253
2254         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
2255                 pos_type pos = bidi.vis2log(vpos);
2256                 if (body_pos > 0 && pos == body_pos - 1) {
2257                         // FIXME UNICODE
2258                         docstring const lsep = from_utf8(par.layout()->labelsep);
2259                         x += m.label_hfill + labelfm.width(lsep);
2260                         if (par.isLineSeparator(body_pos - 1))
2261                                 x -= singleWidth(buffer, par, body_pos - 1);
2262                 }
2263
2264                 // Use font span to speed things up, see above
2265                 if (pos < font_span.first || pos > font_span.last) {
2266                         font_span = par.fontSpan(pos);
2267                         font = getFont(buffer, par, pos);
2268                 }
2269
2270                 x += singleWidth(par, pos, par.getChar(pos), font);
2271
2272                 if (par.hfillExpansion(row, pos))
2273                         x += (pos >= body_pos) ? m.hfill : m.label_hfill;
2274                 else if (par.isSeparator(pos) && pos >= body_pos)
2275                         x += m.separator;
2276         }
2277
2278         // see correction above
2279         if (boundary_correction)
2280                 if (getFont(buffer, par, ppos).isVisibleRightToLeft())
2281                         x -= singleWidth(buffer, par, ppos);
2282                 else
2283                         x += singleWidth(buffer, par, ppos);
2284
2285         // Make sure inside an inset we always count from the left
2286         // edge (bidi!) -- MV
2287         if (sl.pos() < par.size()) {
2288                 font = getFont(buffer, par, sl.pos());
2289                 if (!boundary && font.isVisibleRightToLeft()
2290                   && par.isInset(sl.pos()))
2291                         x -= par.getInset(sl.pos())->width();
2292         }
2293         return int(x);
2294 }
2295
2296
2297 int LyXText::cursorY(CursorSlice const & sl, bool boundary) const
2298 {
2299         //lyxerr << "LyXText::cursorY: boundary: " << boundary << std::endl;
2300         Paragraph const & par = getPar(sl.pit());
2301         if (par.rows().empty())
2302                 return 0;
2303
2304         int h = 0;
2305         h -= pars_[0].rows()[0].ascent();
2306         for (pit_type pit = 0; pit < sl.pit(); ++pit)
2307                 h += pars_[pit].height();
2308         int pos = sl.pos();
2309         if (pos && boundary)
2310                 --pos;
2311         size_t const rend = par.pos2row(pos);
2312         for (size_t rit = 0; rit != rend; ++rit)
2313                 h += par.rows()[rit].height();
2314         h += par.rows()[rend].ascent();
2315         return h;
2316 }
2317
2318
2319 // Returns the current font and depth as a message.
2320 string LyXText::currentState(LCursor & cur)
2321 {
2322         BOOST_ASSERT(this == cur.text());
2323         Buffer & buf = cur.buffer();
2324         Paragraph const & par = cur.paragraph();
2325         std::ostringstream os;
2326
2327         if (buf.params().trackChanges)
2328                 os << "[C] ";
2329
2330         Change change = par.lookupChange(cur.pos());
2331
2332         if (change.type != Change::UNCHANGED) {
2333                 Author const & a = buf.params().authors().get(change.author);
2334                 os << to_utf8(_("Change: ")) << a.name();
2335                 if (!a.email().empty())
2336                         os << " (" << a.email() << ")";
2337                 os << to_utf8(_(" at ")) << ctime(&change.changetime);
2338                 os << " : ";
2339         }
2340
2341         // I think we should only show changes from the default
2342         // font. (Asger)
2343         // No, from the document font (MV)
2344         LyXFont font = real_current_font;
2345         font.reduce(buf.params().getFont());
2346
2347         // avoid to_utf8(_(...)) re-entrance problem
2348         string const s = font.stateText(&buf.params());
2349         os << to_utf8(bformat(_("Font: %1$s"), from_utf8(s)));
2350
2351         // os << to_utf8(bformat(_("Font: %1$s"), font.stateText(&buf.params)));
2352
2353         // The paragraph depth
2354         int depth = cur.paragraph().getDepth();
2355         if (depth > 0)
2356                 os << to_utf8(bformat(_(", Depth: %1$d"), depth));
2357
2358         // The paragraph spacing, but only if different from
2359         // buffer spacing.
2360         Spacing const & spacing = par.params().spacing();
2361         if (!spacing.isDefault()) {
2362                 os << to_utf8(_(", Spacing: "));
2363                 switch (spacing.getSpace()) {
2364                 case Spacing::Single:
2365                         os << to_utf8(_("Single"));
2366                         break;
2367                 case Spacing::Onehalf:
2368                         os << to_utf8(_("OneHalf"));
2369                         break;
2370                 case Spacing::Double:
2371                         os << to_utf8(_("Double"));
2372                         break;
2373                 case Spacing::Other:
2374                         os << to_utf8(_("Other (")) << spacing.getValueAsString() << ')';
2375                         break;
2376                 case Spacing::Default:
2377                         // should never happen, do nothing
2378                         break;
2379                 }
2380         }
2381
2382 #ifdef DEVEL_VERSION
2383         os << to_utf8(_(", Inset: ")) << &cur.inset();
2384         os << to_utf8(_(", Paragraph: ")) << cur.pit();
2385         os << to_utf8(_(", Id: ")) << par.id();
2386         os << to_utf8(_(", Position: ")) << cur.pos();
2387         os << to_utf8(_(", Boundary: ")) << cur.boundary();
2388 //      Row & row = cur.textRow();
2389 //      os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
2390 #endif
2391         return os.str();
2392 }
2393
2394
2395 docstring LyXText::getPossibleLabel(LCursor & cur) const
2396 {
2397         pit_type pit = cur.pit();
2398
2399         LyXLayout_ptr layout = pars_[pit].layout();
2400
2401         if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
2402                 LyXLayout_ptr const & layout2 = pars_[pit - 1].layout();
2403                 if (layout2->latextype != LATEX_PARAGRAPH) {
2404                         --pit;
2405                         layout = layout2;
2406                 }
2407         }
2408
2409         docstring name = from_ascii(layout->latexname());
2410
2411         // for captions, we want the abbreviation of the float type
2412         if (layout->labeltype == LABEL_SENSITIVE) {
2413                 // Search for the first float or wrap inset in the iterator
2414                 for (int i = cur.depth(); --i >= 0; ) {
2415                         InsetBase * const in = &cur[i].inset();
2416                         if (in->lyxCode() == InsetBase::FLOAT_CODE
2417                             || in->lyxCode() == InsetBase::WRAP_CODE) {
2418                                 name = in->getInsetName();
2419                                 break;
2420                         }
2421                 }
2422         }
2423
2424         docstring text = name.substr(0, 3);
2425         if (name == "theorem")
2426                 text = from_ascii("thm"); // Create a correct prefix for prettyref
2427
2428         text += ':';
2429         if (layout->latextype == LATEX_PARAGRAPH || lyxrc.label_init_length < 0)
2430                 text.erase();
2431
2432         docstring par_text = pars_[pit].asString(cur.buffer(), false);
2433         for (int i = 0; i < lyxrc.label_init_length; ++i) {
2434                 if (par_text.empty())
2435                         break;
2436                 docstring head;
2437                 par_text = split(par_text, head, ' ');
2438                 // Is it legal to use spaces in labels ?
2439                 if (i > 0)
2440                         text += '-';
2441                 text += head;
2442         }
2443
2444         return text;
2445 }
2446
2447
2448 //pos_type LyXText::x2pos(pit_type pit, int row, int x) const
2449 //{
2450 //      int lastx = 0;
2451 //      int currx = 0;
2452 //      Paragraph const & par = pars_[pit];
2453 //      Row const & r = par.rows()[row];
2454 //      int pos = r.pos();
2455 //      for (; currx < x && pos < r.endpos(); ++pos) {
2456 //              lastx = currx;
2457 //              currx += singleWidth(buffer, par, pos);
2458 //      }
2459 //      if (abs(lastx - x) < abs(currx - x) && pos != r.pos())
2460 //              --pos;
2461 //      return pos;
2462 //}
2463
2464
2465 pos_type LyXText::x2pos(BufferView const & bv, pit_type pit, int row,
2466                 int x) const
2467 {
2468         BOOST_ASSERT(row < int(pars_[pit].rows().size()));
2469         bool bound = false;
2470         Row const & r = pars_[pit].rows()[row];
2471         return r.pos() + getColumnNearX(bv, pit, r, x, bound);
2472 }
2473
2474
2475 //int LyXText::pos2x(pit_type pit, pos_type pos) const
2476 //{
2477 //      Paragraph const & par = pars_[pit];
2478 //      Row const & r = par.rows()[row];
2479 //      int x = 0;
2480 //      pos -= r.pos();
2481 //}
2482
2483
2484 // x,y are screen coordinates
2485 // sets cursor only within this LyXText
2486 bool LyXText::setCursorFromCoordinates(LCursor & cur, int const x, int const y)
2487 {
2488         BOOST_ASSERT(this == cur.text());
2489         pit_type pit = getPitNearY(cur.bv(), y);
2490         int yy = cur.bv().coordCache().get(this, pit).y_ - pars_[pit].ascent();
2491         lyxerr[Debug::DEBUG]
2492                 << BOOST_CURRENT_FUNCTION
2493                 << ": x: " << x
2494                 << " y: " << y
2495                 << " pit: " << pit
2496                 << " yy: " << yy << endl;
2497
2498         Paragraph const & par = pars_[pit];
2499         int r = 0;
2500         BOOST_ASSERT(par.rows().size());
2501         for (; r < int(par.rows().size()) - 1; ++r) {
2502                 Row const & row = par.rows()[r];
2503                 if (int(yy + row.height()) > y)
2504                         break;
2505                 yy += row.height();
2506         }
2507
2508         Row const & row = par.rows()[r];
2509
2510         lyxerr[Debug::DEBUG]
2511                 << BOOST_CURRENT_FUNCTION
2512                 << ": row " << r
2513                 << " from pos: " << row.pos()
2514                 << endl;
2515
2516         bool bound = false;
2517         int xx = x;
2518         pos_type const pos = row.pos() + getColumnNearX(cur.bv(), pit, row,
2519                 xx, bound);
2520
2521         lyxerr[Debug::DEBUG]
2522                 << BOOST_CURRENT_FUNCTION
2523                 << ": setting cursor pit: " << pit
2524                 << " pos: " << pos
2525                 << endl;
2526
2527         return setCursor(cur, pit, pos, true, bound);
2528 }
2529
2530
2531 void LyXText::charsTranspose(LCursor & cur)
2532 {
2533         BOOST_ASSERT(this == cur.text());
2534
2535         pos_type pos = cur.pos();
2536
2537         // If cursor is at beginning or end of paragraph, do nothing.
2538         if (pos == cur.lastpos() || pos == 0)
2539                 return;
2540
2541         Paragraph & par = cur.paragraph();
2542
2543         // Get the positions of the characters to be transposed.
2544         pos_type pos1 = pos - 1;
2545         pos_type pos2 = pos;
2546
2547         // In change tracking mode, ignore deleted characters.
2548         while (pos2 < cur.lastpos() && par.isDeleted(pos2))
2549                 ++pos2;
2550         if (pos2 == cur.lastpos())
2551                 return;
2552
2553         while (pos1 >= 0 && par.isDeleted(pos1))
2554                 --pos1;
2555         if (pos1 < 0)
2556                 return;
2557
2558         // Don't do anything if one of the "characters" is not regular text.
2559         if (par.isInset(pos1) || par.isInset(pos2))
2560                 return;
2561
2562         // Store the characters to be transposed (including font information).
2563         char_type char1 = par.getChar(pos1);
2564         LyXFont const font1 =
2565                 par.getFontSettings(cur.buffer().params(), pos1);
2566
2567         char_type char2 = par.getChar(pos2);
2568         LyXFont const font2 =
2569                 par.getFontSettings(cur.buffer().params(), pos2);
2570
2571         // And finally, we are ready to perform the transposition.
2572         // Track the changes if Change Tracking is enabled.
2573         bool const trackChanges = cur.buffer().params().trackChanges;
2574
2575         recordUndo(cur);
2576
2577         par.eraseChar(pos2, trackChanges);
2578         par.eraseChar(pos1, trackChanges);
2579         par.insertChar(pos1, char2, font2, trackChanges);
2580         par.insertChar(pos2, char1, font1, trackChanges);
2581
2582         // After the transposition, move cursor to after the transposition.
2583         setCursor(cur, cur.pit(), pos2);
2584         cur.forwardPos();
2585 }
2586
2587
2588 } // namespace lyx