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