src/TextMetrics.cpp

   1 /**
   2  * \file src/TextMetrics.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Dekel Tsur
  12  * \author Jürgen Vigna
  13  * \author Abdelrazak Younes
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #include <config.h>
  19
  20 #include "TextMetrics.h"
  21
  22 #include "Buffer.h"
  23 #include "buffer_funcs.h"
  24 #include "BufferParams.h"
  25 #include "BufferView.h"
  26 #include "CoordCache.h"
  27 #include "Cursor.h"
  28 #include "CutAndPaste.h"
  29 #include "HSpace.h"
  30 #include "InsetList.h"
  31 #include "Language.h"
  32 #include "Layout.h"
  33 #include "LyXRC.h"
  34 #include "MetricsInfo.h"
  35 #include "ParagraphParameters.h"
  36 #include "RowPainter.h"
  37 #include "Text.h"
  38 #include "TextClass.h"
  39 #include "VSpace.h"
  40
  41 #include "insets/InsetText.h"
  42
  43 #include "mathed/MathMacroTemplate.h"
  44
  45 #include "frontends/FontMetrics.h"
  46 #include "frontends/Painter.h"
  47
  48 #include "support/debug.h"
  49 #include "support/lassert.h"
  50
  51 #include <cmath>
  52
  53 using namespace std;
  54
  55
  56 namespace lyx {
  57
  58 using frontend::FontMetrics;
  59
  60 namespace {
  61
  62
  63 int numberOfLabelHfills(Paragraph const & par, Row const & row)
  64 {
  65         pos_type last = row.endpos() - 1;
  66         pos_type first = row.pos();
  67
  68         // hfill *DO* count at the beginning of paragraphs!
  69         if (first) {
  70                 while (first < last && par.isHfill(first))
  71                         ++first;
  72         }
  73
  74         last = min(last, par.beginOfBody());
  75         int n = 0;
  76         for (pos_type p = first; p < last; ++p) {
  77                 if (par.isHfill(p))
  78                         ++n;
  79         }
  80         return n;
  81 }
  82
  83 // FIXME: this needs to be rewritten, probably by merging it into some
  84 // code that, besides counting, sets the active status of the space
  85 // inset in the row element.
  86 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
  87                    pos_type const body_pos)
  88 {
  89         int n = 0;
  90         Row::const_iterator cit = row.begin();
  91         Row::const_iterator const end = row.end();
  92         for ( ; cit != end ; ++cit)
  93                 if (cit->pos >= body_pos
  94                     && cit->inset && pm.hfillExpansion(row, cit->pos))
  95                         ++n;
  96         return n;
  97 }
  98
  99
 100 }
 101
 102 /////////////////////////////////////////////////////////////////////
 103 //
 104 // TextMetrics
 105 //
 106 /////////////////////////////////////////////////////////////////////
 107
 108
 109 TextMetrics::TextMetrics(BufferView * bv, Text * text)
 110         : bv_(bv), text_(text)
 111 {
 112         LBUFERR(bv_);
 113         max_width_ = bv_->workWidth();
 114         dim_.wid = max_width_;
 115         dim_.asc = 10;
 116         dim_.des = 10;
 117 }
 118
 119
 120 bool TextMetrics::contains(pit_type pit) const
 121 {
 122         return par_metrics_.find(pit) != par_metrics_.end();
 123 }
 124
 125
 126 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
 127 {
 128         return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
 129 }
 130
 131
 132
 133 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
 134 {
 135         ParMetricsCache::const_iterator it = par_metrics_.begin();
 136         return make_pair(it->first, &it->second);
 137 }
 138
 139
 140 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
 141 {
 142         LBUFERR(!par_metrics_.empty());
 143         ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
 144         return make_pair(it->first, &it->second);
 145 }
 146
 147
 148 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
 149 {
 150         ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
 151         if (pmc_it == par_metrics_.end()) {
 152                 pmc_it = par_metrics_.insert(
 153                         make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
 154         }
 155         if (pmc_it->second.rows().empty() && redo)
 156                 redoParagraph(pit);
 157         return pmc_it->second;
 158 }
 159
 160
 161 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
 162 {
 163         LBUFERR(mi.base.textwidth > 0);
 164         max_width_ = mi.base.textwidth;
 165         // backup old dimension.
 166         Dimension const old_dim = dim_;
 167         // reset dimension.
 168         dim_ = Dimension();
 169         dim_.wid = min_width;
 170         pit_type const npar = text_->paragraphs().size();
 171         if (npar > 1)
 172                 // If there is more than one row, expand the text to
 173                 // the full allowable width.
 174                 dim_.wid = max_width_;
 175
 176         //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
 177         //      << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
 178
 179         bool changed = false;
 180         unsigned int h = 0;
 181         for (pit_type pit = 0; pit != npar; ++pit) {
 182                 changed |= redoParagraph(pit);
 183                 ParagraphMetrics const & pm = par_metrics_[pit];
 184                 h += pm.height();
 185                 if (dim_.wid < pm.width())
 186                         dim_.wid = pm.width();
 187         }
 188
 189         dim_.asc = par_metrics_[0].ascent();
 190         dim_.des = h - dim_.asc;
 191         //lyxerr << "dim_.wid " << dim_.wid << endl;
 192         //lyxerr << "dim_.asc " << dim_.asc << endl;
 193         //lyxerr << "dim_.des " << dim_.des << endl;
 194
 195         changed |= dim_ != old_dim;
 196         dim = dim_;
 197         return changed;
 198 }
 199
 200
 201 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
 202 {
 203         return main_text_? pm.rightMargin(*bv_) : 0;
 204 }
 205
 206
 207 int TextMetrics::rightMargin(pit_type const pit) const
 208 {
 209         return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
 210 }
 211
 212
 213 void TextMetrics::applyOuterFont(Font & font) const
 214 {
 215         FontInfo lf(font_.fontInfo());
 216         lf.reduce(bv_->buffer().params().getFont().fontInfo());
 217         font.fontInfo().realize(lf);
 218 }
 219
 220
 221 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
 222 {
 223         LASSERT(pos >= 0, { static Font f; return f; });
 224
 225         ParagraphList const & pars = text_->paragraphs();
 226         Paragraph const & par = pars[pit];
 227         Layout const & layout = par.layout();
 228         Buffer const & buffer = bv_->buffer();
 229         // FIXME: broken?
 230         BufferParams const & params = buffer.params();
 231         pos_type const body_pos = par.beginOfBody();
 232
 233         // We specialize the 95% common case:
 234         if (!par.getDepth()) {
 235                 Font f = par.getFontSettings(params, pos);
 236                 if (!text_->isMainText())
 237                         applyOuterFont(f);
 238                 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
 239
 240                 FontInfo const & lf = lab ? layout.labelfont : layout.font;
 241                 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
 242
 243                 // In case the default family has been customized
 244                 if (lf.family() == INHERIT_FAMILY)
 245                         rlf.setFamily(params.getFont().fontInfo().family());
 246                 f.fontInfo().realize(rlf);
 247                 return f;
 248         }
 249
 250         // The uncommon case need not be optimized as much
 251         FontInfo const & layoutfont = pos < body_pos ?
 252                 layout.labelfont : layout.font;
 253
 254         Font font = par.getFontSettings(params, pos);
 255         font.fontInfo().realize(layoutfont);
 256
 257         if (!text_->isMainText())
 258                 applyOuterFont(font);
 259
 260         // Realize against environment font information
 261         // NOTE: the cast to pit_type should be removed when pit_type
 262         // changes to a unsigned integer.
 263         if (pit < pit_type(pars.size()))
 264                 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
 265
 266         // Realize with the fonts of lesser depth.
 267         font.fontInfo().realize(params.getFont().fontInfo());
 268
 269         return font;
 270 }
 271
 272
 273 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
 274 {
 275         if (!sl.text())
 276                 return false;
 277
 278         int correction = 0;
 279         if (boundary && sl.pos() > 0)
 280                 correction = -1;
 281
 282         return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
 283 }
 284
 285
 286 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
 287 {
 288         // no RTL boundary at paragraph start
 289         if (pos == 0)
 290                 return false;
 291
 292         Font const & left_font = displayFont(pit, pos - 1);
 293
 294         return isRTLBoundary(pit, pos, left_font);
 295 }
 296
 297
 298 // isRTLBoundary returns false on a real end-of-line boundary,
 299 // because otherwise the two boundary types get mixed up.
 300 // This is the whole purpose of this being in TextMetrics.
 301 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
 302                 Font const & font) const
 303 {
 304         if (// no RTL boundary at paragraph start
 305             pos == 0
 306             // if the metrics have not been calculated, then we are not
 307             // on screen and can safely ignore issues about boundaries.
 308             || !contains(pit))
 309                 return false;
 310
 311         ParagraphMetrics & pm = par_metrics_[pit];
 312         // no RTL boundary in empty paragraph
 313         if (pm.rows().empty())
 314                 return false;
 315
 316         pos_type endpos = pm.getRow(pos - 1, false).endpos();
 317         pos_type startpos = pm.getRow(pos, false).pos();
 318         // no RTL boundary at line start:
 319         // abc\n   -> toggle to RTL ->    abc\n     (and not:    abc\n|
 320         // |                              |                               )
 321         if (pos == startpos && pos == endpos) // start of cur row, end of prev row
 322                 return false;
 323
 324         Paragraph const & par = text_->getPar(pit);
 325         // no RTL boundary at line break:
 326         // abc|\n    -> move right ->   abc\n       (and not:    abc\n|
 327         // FED                          FED|                     FED     )
 328         if (startpos == pos && endpos == pos && endpos != par.size()
 329                 && (par.isNewline(pos - 1)
 330                         || par.isEnvSeparator(pos - 1)
 331                         || par.isLineSeparator(pos - 1)
 332                         || par.isSeparator(pos - 1)))
 333                 return false;
 334
 335         bool left = font.isVisibleRightToLeft();
 336         bool right;
 337         if (pos == par.size())
 338                 right = par.isRTL(bv_->buffer().params());
 339         else
 340                 right = displayFont(pit, pos).isVisibleRightToLeft();
 341
 342         return left != right;
 343 }
 344
 345
 346 bool TextMetrics::redoParagraph(pit_type const pit)
 347 {
 348         Paragraph & par = text_->getPar(pit);
 349         // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
 350         // redoParagraph() recursively inside parMetrics.
 351         Dimension old_dim = parMetrics(pit, false).dim();
 352         ParagraphMetrics & pm = par_metrics_[pit];
 353         pm.reset(par);
 354
 355         Buffer & buffer = bv_->buffer();
 356         main_text_ = (text_ == &buffer.text());
 357         bool changed = false;
 358
 359         // Check whether there are InsetBibItems that need fixing
 360         // FIXME: This check ought to be done somewhere else. It is the reason
 361         // why text_ is not const. But then, where else to do it?
 362         // Well, how can you end up with either (a) a biblio environment that
 363         // has no InsetBibitem or (b) a biblio environment with more than one
 364         // InsetBibitem? I think the answer is: when paragraphs are merged;
 365         // when layout is set; when material is pasted.
 366         if (par.brokenBiblio()) {
 367                 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
 368                 // In some cases, we do not know how to record undo
 369                 if (&cur.inset() == &text_->inset())
 370                         cur.recordUndo(pit, pit);
 371
 372                 int const moveCursor = par.fixBiblio(buffer);
 373
 374                 // Is it necessary to update the cursor?
 375                 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
 376                         if (moveCursor > 0)
 377                                 cur.posForward();
 378                         else if (moveCursor < 0 && cur.pos() >= -moveCursor)
 379                                 cur.posBackward();
 380                 }
 381         }
 382
 383         // Optimisation: this is used in the next two loops
 384         // so better to calculate that once here.
 385         int const right_margin = rightMargin(pm);
 386
 387         // iterator pointing to paragraph to resolve macros
 388         DocIterator parPos = text_->macrocontextPosition();
 389         if (!parPos.empty())
 390                 parPos.pit() = pit;
 391         else {
 392                 LYXERR(Debug::INFO, "MacroContext not initialised!"
 393                         << " Going through the buffer again and hope"
 394                         << " the context is better then.");
 395                 // FIXME audit updateBuffer calls
 396                 // This should not be here, but it is not clear yet where else it
 397                 // should be.
 398                 bv_->buffer().updateBuffer();
 399                 parPos = text_->macrocontextPosition();
 400                 LBUFERR(!parPos.empty());
 401                 parPos.pit() = pit;
 402         }
 403
 404         // redo insets
 405         Font const bufferfont = buffer.params().getFont();
 406         CoordCache::Insets & insetCache = bv_->coordCache().insets();
 407         InsetList::const_iterator ii = par.insetList().begin();
 408         InsetList::const_iterator iend = par.insetList().end();
 409         for (; ii != iend; ++ii) {
 410                 // FIXME Doesn't this HAVE to be non-empty?
 411                 // position already initialized?
 412                 if (!parPos.empty()) {
 413                         parPos.pos() = ii->pos;
 414
 415                         // A macro template would normally not be visible
 416                         // by itself. But the tex macro semantics allow
 417                         // recursion, so we artifically take the context
 418                         // after the macro template to simulate this.
 419                         if (ii->inset->lyxCode() == MATHMACRO_CODE)
 420                                 parPos.pos()++;
 421                 }
 422
 423                 // do the metric calculation
 424                 Dimension dim;
 425                 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
 426                         - right_margin;
 427                 Font const & font = ii->inset->inheritFont() ?
 428                         displayFont(pit, ii->pos) : bufferfont;
 429                 MacroContext mc(&buffer, parPos);
 430                 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
 431                 ii->inset->metrics(mi, dim);
 432                 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
 433                         insetCache.add(ii->inset, dim);
 434                         changed = true;
 435                 }
 436         }
 437
 438         par.setBeginOfBody();
 439         pos_type first = 0;
 440         size_t row_index = 0;
 441         // maximum pixel width of a row
 442         do {
 443                 if (row_index == pm.rows().size())
 444                         pm.rows().push_back(Row());
 445                 Row & row = pm.rows()[row_index];
 446                 row.pos(first);
 447                 breakRow(row, right_margin, pit);
 448                 setRowHeight(row, pit);
 449                 row.setChanged(false);
 450                 if (row_index || row.endpos() < par.size()
 451                     || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
 452                         /* If there is more than one row or the row has been
 453                          * broken by a display inset or a newline, expand the text
 454                          * to the full allowable width. This setting here is
 455                          * needed for the computeRowMetrics() below. In the case
 456                          * of a display inset, we do nothing when inside a table
 457                          * cell, because the tabular code is not prepared for
 458                          * that, and it triggers when using a caption in a
 459                          * longtable (see bugs #9945 and #9757).
 460                          */
 461                         if (dim_.wid < max_width_)
 462                                 dim_.wid = max_width_;
 463                 }
 464                 int const max_row_width = max(dim_.wid, row.width());
 465                 computeRowMetrics(pit, row, max_row_width);
 466                 first = row.endpos();
 467                 ++row_index;
 468
 469                 pm.dim().wid = max(pm.dim().wid, row.width());
 470                 pm.dim().des += row.height();
 471         } while (first < par.size());
 472
 473         if (row_index < pm.rows().size())
 474                 pm.rows().resize(row_index);
 475
 476         // Make sure that if a par ends in newline, there is one more row
 477         // under it
 478         if (first > 0 && par.isNewline(first - 1)) {
 479                 if (row_index == pm.rows().size())
 480                         pm.rows().push_back(Row());
 481                 Row & row = pm.rows()[row_index];
 482                 row.pos(first);
 483                 breakRow(row, right_margin, pit);
 484                 setRowHeight(row, pit);
 485                 row.setChanged(false);
 486                 int const max_row_width = max(dim_.wid, row.width());
 487                 computeRowMetrics(pit, row, max_row_width);
 488                 pm.dim().des += row.height();
 489         }
 490
 491         pm.dim().asc += pm.rows()[0].ascent();
 492         pm.dim().des -= pm.rows()[0].ascent();
 493
 494         changed |= old_dim.height() != pm.dim().height();
 495
 496         return changed;
 497 }
 498
 499
 500 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 501 {
 502         Layout const & layout = par.layout();
 503
 504         LyXAlignment align;
 505         if (par.params().align() == LYX_ALIGN_LAYOUT)
 506                 align = layout.align;
 507         else
 508                 align = par.params().align();
 509
 510         // handle alignment inside tabular cells
 511         Inset const & owner = text_->inset();
 512         bool forced_block = false;
 513         switch (owner.contentAlignment()) {
 514         case LYX_ALIGN_BLOCK:
 515                 // In general block align is the default state, but here it is
 516                 // an explicit choice. Therefore it should not be overridden
 517                 // later.
 518                 forced_block = true;
 519                 // fall through
 520         case LYX_ALIGN_CENTER:
 521         case LYX_ALIGN_LEFT:
 522         case LYX_ALIGN_RIGHT:
 523                 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
 524                         align = owner.contentAlignment();
 525                 break;
 526         default:
 527                 // unchanged (use align)
 528                 break;
 529         }
 530
 531         // Display-style insets should always be on a centered row
 532         if (Inset const * inset = par.getInset(row.pos())) {
 533                 switch (inset->display()) {
 534                 case Inset::AlignLeft:
 535                         align = LYX_ALIGN_BLOCK;
 536                         break;
 537                 case Inset::AlignCenter:
 538                         align = LYX_ALIGN_CENTER;
 539                         break;
 540                 case Inset::Inline:
 541                         // unchanged (use align)
 542                         break;
 543                 case Inset::AlignRight:
 544                         align = LYX_ALIGN_RIGHT;
 545                         break;
 546                 }
 547         }
 548
 549         if (align == LYX_ALIGN_BLOCK) {
 550                 // If this row has been broken abruptly by a display inset, or
 551                 // it is the end of the paragraph, or the user requested we
 552                 // not justify stuff, then don't stretch.
 553                 // A forced block alignment can only be overridden the 'no
 554                 // justification on screen' setting.
 555                 if (((row.right_boundary() || row.endpos() == par.size())
 556                      && !forced_block)
 557                     || !bv_->buffer().params().justification)
 558                         align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
 559         }
 560
 561         return align;
 562 }
 563
 564
 565 void TextMetrics::computeRowMetrics(pit_type const pit,
 566                 Row & row, int width) const
 567 {
 568         row.label_hfill = 0;
 569         row.separator = 0;
 570
 571         Paragraph const & par = text_->getPar(pit);
 572
 573         int const w = width - row.right_margin - row.width();
 574         // FIXME: put back this assertion when the crash on new doc is solved.
 575         //LASSERT(w >= 0, /**/);
 576
 577         // is there a manual margin with a manual label
 578         Layout const & layout = par.layout();
 579
 580         int nlh = 0;
 581         if (layout.margintype == MARGIN_MANUAL
 582             && layout.labeltype == LABEL_MANUAL) {
 583                 /// We might have real hfills in the label part
 584                 nlh = numberOfLabelHfills(par, row);
 585
 586                 // A manual label par (e.g. List) has an auto-hfill
 587                 // between the label text and the body of the
 588                 // paragraph too.
 589                 // But we don't want to do this auto hfill if the par
 590                 // is empty.
 591                 if (!par.empty())
 592                         ++nlh;
 593
 594                 if (nlh && !par.getLabelWidthString().empty())
 595                         row.label_hfill = labelFill(pit, row) / double(nlh);
 596         }
 597
 598         // are there any hfills in the row?
 599         ParagraphMetrics & pm = par_metrics_[pit];
 600         int nh = numberOfHfills(row, pm, par.beginOfBody());
 601         int hfill = 0;
 602         int hfill_rem = 0;
 603
 604         // We don't have to look at the alignment if the row is already
 605         // larger then the permitted width as then we force the
 606         // LEFT_ALIGN'edness!
 607         if (int(row.width()) >= max_width_)
 608                 return;
 609
 610         if (nh == 0) {
 611                 // Common case : there is no hfill, and the alignment will be
 612                 // meaningful
 613                 switch (getAlign(par, row)) {
 614                 case LYX_ALIGN_BLOCK: {
 615                         int const ns = row.countSeparators();
 616                         // If we have separators, then stretch the row
 617                         if (ns) {
 618                                 row.setSeparatorExtraWidth(double(w) / ns);
 619                                 row.dimension().wid += w;
 620                         } else if (text_->isRTL(par)) {
 621                                 row.left_margin += w;
 622                                 row.dimension().wid += w;
 623                         }
 624                         break;
 625                 }
 626                 case LYX_ALIGN_RIGHT:
 627                         row.left_margin += w;
 628                         row.dimension().wid += w;
 629                         break;
 630                 case LYX_ALIGN_CENTER:
 631                         row.dimension().wid += w / 2;
 632                         row.left_margin += w / 2;
 633                         break;
 634                 case LYX_ALIGN_LEFT:
 635                 case LYX_ALIGN_NONE:
 636                 case LYX_ALIGN_LAYOUT:
 637                 case LYX_ALIGN_SPECIAL:
 638                 case LYX_ALIGN_DECIMAL:
 639                         break;
 640                 }
 641                 return;
 642         }
 643
 644         hfill = w / nh;
 645         hfill_rem = w % nh;
 646         row.dimension().wid += w;
 647         // Set size of hfill insets
 648         pos_type const endpos = row.endpos();
 649         pos_type body_pos = par.beginOfBody();
 650         if (body_pos > 0
 651             && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
 652                 body_pos = 0;
 653
 654         CoordCache::Insets & insetCache = bv_->coordCache().insets();
 655         Row::iterator cit = row.begin();
 656         Row::iterator const cend = row.end();
 657         for ( ; cit != cend; ++cit) {
 658                 if (row.label_hfill && cit->endpos == body_pos
 659                     && cit->type == Row::SPACE)
 660                         cit->dim.wid -= int(row.label_hfill * (nlh - 1));
 661                 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
 662                         if (cit->pos >= body_pos) {
 663                                 cit->dim.wid += hfill;
 664                                 --nh;
 665                                 if (nh == 0)
 666                                         cit->dim.wid += hfill_rem;
 667                         } else
 668                                 cit->dim.wid += int(row.label_hfill);
 669                         // Cache the inset dimension.
 670                         insetCache.add(cit->inset, cit->dim);
 671                 }
 672         }
 673 }
 674
 675
 676 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
 677 {
 678         Paragraph const & par = text_->getPar(pit);
 679         LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
 680
 681         int w = 0;
 682         Row::const_iterator cit = row.begin();
 683         Row::const_iterator const end = row.end();
 684         // iterate over elements before main body (except the last one,
 685         // which is extra space).
 686         while (cit!= end && cit->endpos < par.beginOfBody()) {
 687                 w += cit->dim.wid;
 688                 ++cit;
 689         }
 690
 691         docstring const & label = par.params().labelWidthString();
 692         if (label.empty())
 693                 return 0;
 694
 695         FontMetrics const & fm
 696                 = theFontMetrics(text_->labelFont(par));
 697
 698         return max(0, fm.width(label) - w);
 699 }
 700
 701
 702 #if 0
 703 // Not used, see TextMetrics::breakRow
 704 // this needs special handling - only newlines count as a break point
 705 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
 706 {
 707         pos_type const end = par.size();
 708
 709         for (; i < end; ++i)
 710                 if (par.isNewline(i))
 711                         return i + 1;
 712
 713         return end;
 714 }
 715 #endif
 716
 717
 718 int TextMetrics::labelEnd(pit_type const pit) const
 719 {
 720         // labelEnd is only needed if the layout fills a flushleft label.
 721         if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
 722                 return 0;
 723         // return the beginning of the body
 724         return leftMargin(max_width_, pit);
 725 }
 726
 727 namespace {
 728
 729 /**
 730  * Calling Text::getFont is slow. While rebreaking we scan a
 731  * paragraph from left to right calling getFont for every char.  This
 732  * simple class address this problem by hidding an optimization trick
 733  * (not mine btw -AB): the font is reused in the whole font span.  The
 734  * class handles transparently the "hidden" (not part of the fontlist)
 735  * label font (as getFont does).
 736  **/
 737 class FontIterator
 738 {
 739 public:
 740         ///
 741         FontIterator(TextMetrics const & tm,
 742                 Paragraph const & par, pit_type pit, pos_type pos)
 743                 : tm_(tm), par_(par), pit_(pit), pos_(pos),
 744                 font_(tm.displayFont(pit, pos)),
 745                 endspan_(par.fontSpan(pos).last),
 746                 bodypos_(par.beginOfBody())
 747         {}
 748
 749         ///
 750         Font const & operator*() const { return font_; }
 751
 752         ///
 753         FontIterator & operator++()
 754         {
 755                 ++pos_;
 756                 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
 757                         font_ = tm_.displayFont(pit_, pos_);
 758                         endspan_ = par_.fontSpan(pos_).last;
 759                 }
 760                 return *this;
 761         }
 762
 763         ///
 764         Font * operator->() { return &font_; }
 765
 766 private:
 767         ///
 768         TextMetrics const & tm_;
 769         ///
 770         Paragraph const & par_;
 771         ///
 772         pit_type pit_;
 773         ///
 774         pos_type pos_;
 775         ///
 776         Font font_;
 777         ///
 778         pos_type endspan_;
 779         ///
 780         pos_type bodypos_;
 781 };
 782
 783 } // anon namespace
 784
 785 /** This is the function where the hard work is done. The code here is
 786  * very sensitive to small changes :) Note that part of the
 787  * intelligence is also in Row::shortenIfNeeded.
 788  */
 789 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
 790 {
 791         Paragraph const & par = text_->getPar(pit);
 792         pos_type const end = par.size();
 793         pos_type const pos = row.pos();
 794         pos_type const body_pos = par.beginOfBody();
 795         bool const is_rtl = text_->isRTL(par);
 796         bool need_new_row = false;
 797
 798         row.clear();
 799         row.left_margin = leftMargin(max_width_, pit, pos);
 800         row.right_margin = right_margin;
 801         if (is_rtl)
 802                 swap(row.left_margin, row.right_margin);
 803         // Remember that the row width takes into account the left_margin
 804         // but not the right_margin.
 805         row.dimension().wid = row.left_margin;
 806         // the width available for the row.
 807         int const width = max_width_ - row.right_margin;
 808
 809         ParagraphList const & pars = text_->paragraphs();
 810
 811 #if 0
 812         //FIXME: As long as leftMargin() is not correctly implemented for
 813         // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
 814         // Otherwise, long rows will be painted off the screen.
 815         if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
 816                 return addressBreakPoint(pos, par);
 817 #endif
 818
 819         // check for possible inline completion
 820         DocIterator const & ic_it = bv_->inlineCompletionPos();
 821         pos_type ic_pos = -1;
 822         if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
 823                 ic_pos = ic_it.pos();
 824
 825         // Now we iterate through until we reach the right margin
 826         // or the end of the par, then build a representation of the row.
 827         pos_type i = pos;
 828         FontIterator fi = FontIterator(*this, par, pit, pos);
 829         do {
 830                 // this can happen for an empty row after a newline
 831                 if (i >= end)
 832                         break;
 833                 char_type c = par.getChar(i);
 834                 // The most special cases are handled first.
 835                 if (par.isInset(i)) {
 836                         Inset const * ins = par.getInset(i);
 837                         Dimension dim = bv_->coordCache().insets().dim(ins);
 838                         row.add(i, ins, dim, *fi, par.lookupChange(i));
 839                 } else if (c == ' ' && i + 1 == body_pos) {
 840                         // There is a space at i, but it should not be
 841                         // added as a separator, because it is just
 842                         // before body_pos. Instead, insert some spacing to
 843                         // align text
 844                         FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
 845                         // this is needed to make sure that the row width is correct
 846                         row.finalizeLast();
 847                         int const add = max(fm.width(par.layout().labelsep),
 848                                             labelEnd(pit) - row.width());
 849                         row.addSpace(i, add, *fi, par.lookupChange(i));
 850                 } else if (c == '\t')
 851                         row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
 852                                      *fi, par.lookupChange(i));
 853                 else {
 854                         // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
 855                         // see also Paragraph::getUChar.
 856                         if (fi->language()->lang() == "hebrew") {
 857                                 if (c == '(')
 858                                         c = ')';
 859                                 else if (c == ')')
 860                                         c = '(';
 861                         }
 862                         row.add(i, c, *fi, par.lookupChange(i));
 863                 }
 864
 865                 // add inline completion width
 866                 // draw logically behind the previous character
 867                 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
 868                         docstring const comp = bv_->inlineCompletion();
 869                         size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
 870                         Font f = *fi;
 871
 872                         if (uniqueTo > 0) {
 873                                 f.fontInfo().setColor(Color_inlinecompletion);
 874                                 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
 875                         }
 876                         f.fontInfo().setColor(Color_nonunique_inlinecompletion);
 877                         row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
 878                 }
 879
 880                 // Handle some situations that abruptly terminate the row
 881                 // - A newline inset
 882                 // - Before a display inset
 883                 // - After a display inset
 884                 Inset const * inset = 0;
 885                 if (par.isNewline(i) || par.isEnvSeparator(i)
 886                     || (i + 1 < end && (inset = par.getInset(i + 1))
 887                         && inset->display())
 888                     || (!row.empty() && row.back().inset
 889                         && row.back().inset->display())) {
 890                         row.right_boundary(true);
 891                         need_new_row = par.isNewline(i);
 892                         ++i;
 893                         break;
 894                 }
 895
 896                 ++i;
 897                 ++fi;
 898         } while (i < end && row.width() <= width);
 899         row.finalizeLast();
 900         row.endpos(i);
 901
 902         // End of paragraph marker
 903         if (lyxrc.paragraph_markers && !need_new_row
 904             && i == end && size_type(pit + 1) < pars.size()) {
 905                 // add a virtual element for the end-of-paragraph
 906                 // marker; it is shown on screen, but does not exist
 907                 // in the paragraph.
 908                 Font f(text_->layoutFont(pit));
 909                 f.fontInfo().setColor(Color_paragraphmarker);
 910                 BufferParams const & bparams
 911                         = text_->inset().buffer().params();
 912                 f.setLanguage(par.getParLanguage(bparams));
 913                 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
 914         }
 915
 916         // if the row is too large, try to cut at last separator. In case
 917         // of success, reset indication that the row was broken abruptly.
 918         if (row.shortenIfNeeded(body_pos, width))
 919                 row.right_boundary(false);
 920
 921         // make sure that the RTL elements are in reverse ordering
 922         row.reverseRTL(is_rtl);
 923         //LYXERR0("breakrow: row is " << row);
 924 }
 925
 926
 927 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
 928                                     bool topBottomSpace) const
 929 {
 930         Paragraph const & par = text_->getPar(pit);
 931         // get the maximum ascent and the maximum descent
 932         double layoutasc = 0;
 933         double layoutdesc = 0;
 934         double const dh = defaultRowHeight();
 935
 936         // ok, let us initialize the maxasc and maxdesc value.
 937         // Only the fontsize count. The other properties
 938         // are taken from the layoutfont. Nicer on the screen :)
 939         Layout const & layout = par.layout();
 940
 941         // as max get the first character of this row then it can
 942         // increase but not decrease the height. Just some point to
 943         // start with so we don't have to do the assignment below too
 944         // often.
 945         Buffer const & buffer = bv_->buffer();
 946         Font font = displayFont(pit, row.pos());
 947         FontSize const tmpsize = font.fontInfo().size();
 948         font.fontInfo() = text_->layoutFont(pit);
 949         FontSize const size = font.fontInfo().size();
 950         font.fontInfo().setSize(tmpsize);
 951
 952         FontInfo labelfont = text_->labelFont(par);
 953
 954         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 955         FontMetrics const & fontmetrics = theFontMetrics(font);
 956
 957         // these are minimum values
 958         double const spacing_val = layout.spacing.getValue()
 959                 * text_->spacing(par);
 960         //lyxerr << "spacing_val = " << spacing_val << endl;
 961         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
 962         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
 963
 964         // insets may be taller
 965         CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
 966         Row::const_iterator cit = row.begin();
 967         Row::const_iterator cend = row.end();
 968         for ( ; cit != cend; ++cit) {
 969                 if (cit->inset) {
 970                         Dimension const & dim = insetCache.dim(cit->inset);
 971                         maxasc  = max(maxasc,  dim.ascent());
 972                         maxdesc = max(maxdesc, dim.descent());
 973                 }
 974         }
 975
 976         // Check if any custom fonts are larger (Asger)
 977         // This is not completely correct, but we can live with the small,
 978         // cosmetic error for now.
 979         int labeladdon = 0;
 980
 981         FontSize maxsize =
 982                 par.highestFontInRange(row.pos(), row.endpos(), size);
 983         if (maxsize > font.fontInfo().size()) {
 984                 // use standard paragraph font with the maximal size
 985                 FontInfo maxfont = font.fontInfo();
 986                 maxfont.setSize(maxsize);
 987                 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
 988                 maxasc  = max(maxasc,  maxfontmetrics.maxAscent());
 989                 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
 990         }
 991
 992         // This is nicer with box insets:
 993         ++maxasc;
 994         ++maxdesc;
 995
 996         ParagraphList const & pars = text_->paragraphs();
 997         Inset const & inset = text_->inset();
 998
 999         // is it a top line?
1000         if (row.pos() == 0 && topBottomSpace) {
1001                 BufferParams const & bufparams = buffer.params();
1002                 // some parskips VERY EASY IMPLEMENTATION
1003                 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1004                     && !inset.getLayout().parbreakIsNewline()
1005                     && !par.layout().parbreak_is_newline
1006                     && pit > 0
1007                     && ((layout.isParagraph() && par.getDepth() == 0)
1008                         || (pars[pit - 1].layout().isParagraph()
1009                             && pars[pit - 1].getDepth() == 0))) {
1010                         maxasc += bufparams.getDefSkip().inPixels(*bv_);
1011                 }
1012
1013                 if (par.params().startOfAppendix())
1014                         maxasc += int(3 * dh);
1015
1016                 // special code for the top label
1017                 if (layout.labelIsAbove()
1018                     && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1019                     && !par.labelString().empty()) {
1020                         labeladdon = int(
1021                                   labelfont_metrics.maxHeight()
1022                                         * layout.spacing.getValue()
1023                                         * text_->spacing(par)
1024                                 + (layout.topsep + layout.labelbottomsep) * dh);
1025                 }
1026
1027                 // Add the layout spaces, for example before and after
1028                 // a section, or between the items of a itemize or enumerate
1029                 // environment.
1030
1031                 pit_type prev = text_->depthHook(pit, par.getDepth());
1032                 Paragraph const & prevpar = pars[prev];
1033                 if (prev != pit
1034                     && prevpar.layout() == layout
1035                     && prevpar.getDepth() == par.getDepth()
1036                     && prevpar.getLabelWidthString()
1037                                         == par.getLabelWidthString()) {
1038                         layoutasc = layout.itemsep * dh;
1039                 } else if (pit != 0 || row.pos() != 0) {
1040                         if (layout.topsep > 0)
1041                                 layoutasc = layout.topsep * dh;
1042                 }
1043
1044                 prev = text_->outerHook(pit);
1045                 if (prev != pit_type(pars.size())) {
1046                         maxasc += int(pars[prev].layout().parsep * dh);
1047                 } else if (pit != 0) {
1048                         Paragraph const & prevpar = pars[pit - 1];
1049                         if (prevpar.getDepth() != 0 ||
1050                                         prevpar.layout() == layout) {
1051                                 maxasc += int(layout.parsep * dh);
1052                         }
1053                 }
1054         }
1055
1056         // is it a bottom line?
1057         if (row.endpos() >= par.size() && topBottomSpace) {
1058                 // add the layout spaces, for example before and after
1059                 // a section, or between the items of a itemize or enumerate
1060                 // environment
1061                 pit_type nextpit = pit + 1;
1062                 if (nextpit != pit_type(pars.size())) {
1063                         pit_type cpit = pit;
1064
1065                         if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1066                                 double usual = pars[cpit].layout().bottomsep * dh;
1067                                 double unusual = 0;
1068                                 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1069                                 if (pars[cpit].layout() != pars[nextpit].layout()
1070                                     || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1071                                         unusual = pars[cpit].layout().bottomsep * dh;
1072                                 layoutdesc = max(unusual, usual);
1073                         } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1074                                 if (pars[cpit].layout() != pars[nextpit].layout()
1075                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1076                                         layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1077                         }
1078                 }
1079         }
1080
1081         // incalculate the layout spaces
1082         maxasc  += int(layoutasc  * 2 / (2 + pars[pit].getDepth()));
1083         maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1084
1085         // FIXME: the correct way is to do the following is to move the
1086         // following code in another method specially tailored for the
1087         // main Text. The following test is thus bogus.
1088         // Top and bottom margin of the document (only at top-level)
1089         if (main_text_ && topBottomSpace) {
1090                 if (pit == 0 && row.pos() == 0)
1091                         maxasc += 20;
1092                 if (pit + 1 == pit_type(pars.size()) &&
1093                     row.endpos() == par.size() &&
1094                                 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1095                         maxdesc += 20;
1096         }
1097
1098         row.dimension().asc = maxasc + labeladdon;
1099         row.dimension().des = maxdesc;
1100 }
1101
1102
1103 // x is an absolute screen coord
1104 // returns the column near the specified x-coordinate of the row
1105 // x is set to the real beginning of this column
1106 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1107                                   bool & boundary) const
1108 {
1109         //LYXERR0("getPosNearX(" << x << ") row=" << row);
1110         /// For the main Text, it is possible that this pit is not
1111         /// yet in the CoordCache when moving cursor up.
1112         /// x Paragraph coordinate is always 0 for main text anyway.
1113         int const xo = origin_.x_;
1114         x -= xo;
1115
1116         pos_type pos = row.pos();
1117         boundary = false;
1118         if (row.empty())
1119                 x = row.left_margin;
1120         else if (x <= row.left_margin) {
1121                 pos = row.front().left_pos();
1122                 x = row.left_margin;
1123         } else if (x >= row.width()) {
1124                 pos = row.back().right_pos();
1125                 x = row.width();
1126         } else {
1127                 double w = row.left_margin;
1128                 Row::const_iterator cit = row.begin();
1129                 Row::const_iterator cend = row.end();
1130                 for ( ; cit != cend; ++cit) {
1131                         if (w <= x &&  w + cit->full_width() > x) {
1132                                 int x_offset = int(x - w);
1133                                 pos = cit->x2pos(x_offset);
1134                                 x = int(x_offset + w);
1135                                 break;
1136                         }
1137                         w += cit->full_width();
1138                 }
1139                 if (cit == row.end()) {
1140                         pos = row.back().right_pos();
1141                         x = row.width();
1142                 }
1143                 /** This tests for the case where the cursor is placed
1144                  * just before a font direction change. See comment on
1145                  * the boundary_ member in DocIterator.h to understand
1146                  * how boundary helps here.
1147                  */
1148                 else if (pos == cit->endpos
1149                          && cit + 1 != row.end()
1150                          && cit->isRTL() != (cit + 1)->isRTL())
1151                         boundary = true;
1152         }
1153
1154         /** This tests for the case where the cursor is set at the end
1155          * of a row which has been broken due something else than a
1156          * separator (a display inset or a forced breaking of the
1157          * row). We know that there is a separator when the end of the
1158          * row is larger than the end of its last element.
1159          */
1160         if (!row.empty() && pos == row.back().endpos
1161             && row.back().endpos == row.endpos()) {
1162                 Inset const * inset = row.back().inset;
1163                 if (inset && (inset->lyxCode() == NEWLINE_CODE
1164                               || inset->lyxCode() == SEPARATOR_CODE))
1165                         pos = row.back().pos;
1166                 else
1167                         boundary = row.right_boundary();
1168         }
1169         x += xo;
1170         //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1171         return pos;
1172 }
1173
1174
1175 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1176 {
1177         // We play safe and use parMetrics(pit) to make sure the
1178         // ParagraphMetrics will be redone and OK to use if needed.
1179         // Otherwise we would use an empty ParagraphMetrics in
1180         // upDownInText() while in selection mode.
1181         ParagraphMetrics const & pm = parMetrics(pit);
1182
1183         LBUFERR(row < int(pm.rows().size()));
1184         bool bound = false;
1185         Row const & r = pm.rows()[row];
1186         return getPosNearX(r, x, bound);
1187 }
1188
1189
1190 void TextMetrics::newParMetricsDown()
1191 {
1192         pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1193         pit_type const pit = last.first + 1;
1194         if (pit == int(text_->paragraphs().size()))
1195                 return;
1196
1197         // do it and update its position.
1198         redoParagraph(pit);
1199         par_metrics_[pit].setPosition(last.second.position()
1200                 + last.second.descent() + par_metrics_[pit].ascent());
1201 }
1202
1203
1204 void TextMetrics::newParMetricsUp()
1205 {
1206         pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1207         if (first.first == 0)
1208                 return;
1209
1210         pit_type const pit = first.first - 1;
1211         // do it and update its position.
1212         redoParagraph(pit);
1213         par_metrics_[pit].setPosition(first.second.position()
1214                 - first.second.ascent() - par_metrics_[pit].descent());
1215 }
1216
1217 // y is screen coordinate
1218 pit_type TextMetrics::getPitNearY(int y)
1219 {
1220         LASSERT(!text_->paragraphs().empty(), return -1);
1221         LASSERT(!par_metrics_.empty(), return -1);
1222         LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1223
1224         // look for highest numbered paragraph with y coordinate less than given y
1225         pit_type pit = -1;
1226         int yy = -1;
1227         ParMetricsCache::const_iterator it = par_metrics_.begin();
1228         ParMetricsCache::const_iterator et = par_metrics_.end();
1229         ParMetricsCache::const_iterator last = et;
1230         --last;
1231
1232         ParagraphMetrics const & pm = it->second;
1233
1234         if (y < it->second.position() - int(pm.ascent())) {
1235                 // We are looking for a position that is before the first paragraph in
1236                 // the cache (which is in priciple off-screen, that is before the
1237                 // visible part.
1238                 if (it->first == 0)
1239                         // We are already at the first paragraph in the inset.
1240                         return 0;
1241                 // OK, this is the paragraph we are looking for.
1242                 pit = it->first - 1;
1243                 newParMetricsUp();
1244                 return pit;
1245         }
1246
1247         ParagraphMetrics const & pm_last = par_metrics_[last->first];
1248
1249         if (y >= last->second.position() + int(pm_last.descent())) {
1250                 // We are looking for a position that is after the last paragraph in
1251                 // the cache (which is in priciple off-screen), that is before the
1252                 // visible part.
1253                 pit = last->first + 1;
1254                 if (pit == int(text_->paragraphs().size()))
1255                         //  We are already at the last paragraph in the inset.
1256                         return last->first;
1257                 // OK, this is the paragraph we are looking for.
1258                 newParMetricsDown();
1259                 return pit;
1260         }
1261
1262         for (; it != et; ++it) {
1263                 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1264                         << " y: " << it->second.position());
1265
1266                 ParagraphMetrics const & pm = par_metrics_[it->first];
1267
1268                 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1269                         pit = it->first;
1270                         yy = it->second.position();
1271                 }
1272         }
1273
1274         LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1275
1276         return pit;
1277 }
1278
1279
1280 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1281         bool assert_in_view, bool up)
1282 {
1283         ParagraphMetrics const & pm = par_metrics_[pit];
1284
1285         int yy = pm.position() - pm.ascent();
1286         LBUFERR(!pm.rows().empty());
1287         RowList::const_iterator rit = pm.rows().begin();
1288         RowList::const_iterator rlast = pm.rows().end();
1289         --rlast;
1290         for (; rit != rlast; yy += rit->height(), ++rit)
1291                 if (yy + rit->height() > y)
1292                         break;
1293
1294         if (assert_in_view) {
1295                 if (!up && yy + rit->height() > y) {
1296                         if (rit != pm.rows().begin()) {
1297                                 y = yy;
1298                                 --rit;
1299                         } else if (pit != 0) {
1300                                 --pit;
1301                                 newParMetricsUp();
1302                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1303                                 rit = pm2.rows().end();
1304                                 --rit;
1305                                 y = yy;
1306                         }
1307                 } else if (up && yy != y) {
1308                         if (rit != rlast) {
1309                                 y = yy + rit->height();
1310                                 ++rit;
1311                         } else if (pit < int(text_->paragraphs().size()) - 1) {
1312                                 ++pit;
1313                                 newParMetricsDown();
1314                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1315                                 rit = pm2.rows().begin();
1316                                 y = pm2.position();
1317                         }
1318                 }
1319         }
1320         return *rit;
1321 }
1322
1323
1324 // x,y are absolute screen coordinates
1325 // sets cursor recursively descending into nested editable insets
1326 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1327         bool assert_in_view, bool up)
1328 {
1329         if (lyxerr.debugging(Debug::WORKAREA)) {
1330                 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1331                 cur.bv().coordCache().dump();
1332         }
1333         pit_type pit = getPitNearY(y);
1334         LASSERT(pit != -1, return 0);
1335
1336         int yy = y; // is modified by getPitAndRowNearY
1337         Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1338
1339         cur.pit() = pit;
1340
1341         // Do we cover an inset?
1342         InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1343
1344         if (!it) {
1345                 // No inset, set position in the text
1346                 bool bound = false; // is modified by getPosNearX
1347                 int xx = x; // is modified by getPosNearX
1348                 cur.pos() = getPosNearX(row, xx, bound);
1349                 cur.boundary(bound);
1350                 cur.setCurrentFont();
1351                 cur.setTargetX(xx);
1352                 return 0;
1353         }
1354
1355         Inset * inset = it->inset;
1356         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1357
1358         // Set position in front of inset
1359         cur.pos() = it->pos;
1360         cur.boundary(false);
1361         cur.setTargetX(x);
1362
1363         // Try to descend recursively inside the inset.
1364         Inset * edited = inset->editXY(cur, x, yy);
1365         if (edited == inset && cur.pos() == it->pos) {
1366                 // non-editable inset, set cursor after the inset if x is
1367                 // nearer to that position (bug 9628)
1368                 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1369                 Dimension const & dim = insetCache.dim(inset);
1370                 Point p = insetCache.xy(inset);
1371                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1372                 if (is_rtl) {
1373                         // "in front of" == "right of"
1374                         if (abs(p.x_ - x) < abs(p.x_ + dim.wid - x))
1375                                 cur.posForward();
1376                 } else {
1377                         // "in front of" == "left of"
1378                         if (abs(p.x_ + dim.wid - x) < abs(p.x_ - x))
1379                                 cur.posForward();
1380                 }
1381         }
1382
1383         if (cur.top().text() == text_)
1384                 cur.setCurrentFont();
1385         return edited;
1386 }
1387
1388
1389 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1390 {
1391         LASSERT(text_ == cur.text(), return);
1392         pit_type const pit = getPitNearY(y);
1393         LASSERT(pit != -1, return);
1394
1395         ParagraphMetrics const & pm = par_metrics_[pit];
1396
1397         int yy = pm.position() - pm.ascent();
1398         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1399                 " pit: " << pit << " yy: " << yy);
1400
1401         int r = 0;
1402         LBUFERR(pm.rows().size());
1403         for (; r < int(pm.rows().size()) - 1; ++r) {
1404                 Row const & row = pm.rows()[r];
1405                 if (int(yy + row.height()) > y)
1406                         break;
1407                 yy += row.height();
1408         }
1409
1410         Row const & row = pm.rows()[r];
1411
1412         LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1413
1414         bool bound = false;
1415         int xx = x;
1416         pos_type const pos = getPosNearX(row, xx, bound);
1417
1418         LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1419
1420         text_->setCursor(cur, pit, pos, true, bound);
1421         // remember new position.
1422         cur.setTargetX();
1423 }
1424
1425
1426 //takes screen x,y coordinates
1427 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1428 {
1429         Paragraph const & par = text_->paragraphs()[pit];
1430         CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1431
1432         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
1433
1434         InsetList::const_iterator iit = par.insetList().begin();
1435         InsetList::const_iterator iend = par.insetList().end();
1436         for (; iit != iend; ++iit) {
1437                 Inset * inset = iit->inset;
1438
1439                 LYXERR(Debug::DEBUG, "examining inset " << inset);
1440
1441                 if (!insetCache.has(inset)) {
1442                         LYXERR(Debug::DEBUG, "inset has no cached position");
1443                         return 0;
1444                 }
1445
1446                 Dimension const & dim = insetCache.dim(inset);
1447                 Point p = insetCache.xy(inset);
1448
1449                 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1450                         << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1451
1452                 if (x >= p.x_ && x <= p.x_ + dim.wid
1453                     && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1454                         LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1455                         return const_cast<InsetList::InsetTable *>(&(*iit));
1456                 }
1457         }
1458
1459         LYXERR(Debug::DEBUG, "No inset hit. ");
1460         return 0;
1461 }
1462
1463
1464 //takes screen x,y coordinates
1465 Inset * TextMetrics::checkInsetHit(int x, int y)
1466 {
1467         pit_type const pit = getPitNearY(y);
1468         LASSERT(pit != -1, return 0);
1469         InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1470
1471         if (!it)
1472                 return 0;
1473
1474         return it->inset;
1475 }
1476
1477
1478 Row::const_iterator const
1479 TextMetrics::findRowElement(Row const & row, pos_type const pos,
1480                             bool const boundary, double & x) const
1481 {
1482         /**
1483          * When boundary is true, position i is in the row element (pos, endpos)
1484          * if
1485          *    pos < i <= endpos
1486          * whereas, when boundary is false, the test is
1487          *    pos <= i < endpos
1488          * The correction below allows to handle both cases.
1489         */
1490         int const boundary_corr = (boundary && pos) ? -1 : 0;
1491
1492         x = row.left_margin;
1493
1494         /** Early return in trivial cases
1495          * 1) the row is empty
1496          * 2) the position is the left-most position of the row; there
1497          * is a quirk here however: if the first element is virtual
1498          * (end-of-par marker for example), then we have to look
1499          * closer
1500          */
1501         if (row.empty()
1502             || (pos == row.begin()->left_pos() && !boundary
1503                         && !row.begin()->isVirtual()))
1504                 return row.begin();
1505
1506         Row::const_iterator cit = row.begin();
1507         for ( ; cit != row.end() ; ++cit) {
1508                 /** Look whether the cursor is inside the element's
1509                  * span. Note that it is necessary to take the
1510                  * boundary into account, and to accept virtual
1511                  * elements, which have pos == endpos.
1512                  */
1513                 if (pos + boundary_corr >= cit->pos
1514                     && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
1515                                 x += cit->pos2x(pos);
1516                                 break;
1517                 }
1518                 x += cit->full_width();
1519         }
1520
1521         if (cit == row.end())
1522                 --cit;
1523
1524         return cit;
1525 }
1526
1527
1528 int TextMetrics::cursorX(CursorSlice const & sl,
1529                 bool boundary) const
1530 {
1531         LASSERT(sl.text() == text_, return 0);
1532
1533         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1534         if (pm.rows().empty())
1535                 return 0;
1536         Row const & row = pm.getRow(sl.pos(), boundary);
1537         pos_type const pos = sl.pos();
1538
1539         double x = 0;
1540         findRowElement(row, pos, boundary, x);
1541         return int(x);
1542
1543 }
1544
1545
1546 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1547 {
1548         //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1549         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1550         if (pm.rows().empty())
1551                 return 0;
1552
1553         int h = 0;
1554         h -= par_metrics_[0].rows()[0].ascent();
1555         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1556                 h += par_metrics_[pit].height();
1557         }
1558         int pos = sl.pos();
1559         if (pos && boundary)
1560                 --pos;
1561         size_t const rend = pm.pos2row(pos);
1562         for (size_t rit = 0; rit != rend; ++rit)
1563                 h += pm.rows()[rit].height();
1564         h += pm.rows()[rend].ascent();
1565         return h;
1566 }
1567
1568
1569 // the cursor set functions have a special mechanism. When they
1570 // realize you left an empty paragraph, they will delete it.
1571
1572 bool TextMetrics::cursorHome(Cursor & cur)
1573 {
1574         LASSERT(text_ == cur.text(), return false);
1575         ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1576         Row const & row = pm.getRow(cur.pos(),cur.boundary());
1577         return text_->setCursor(cur, cur.pit(), row.pos());
1578 }
1579
1580
1581 bool TextMetrics::cursorEnd(Cursor & cur)
1582 {
1583         LASSERT(text_ == cur.text(), return false);
1584         // if not on the last row of the par, put the cursor before
1585         // the final space exept if I have a spanning inset or one string
1586         // is so long that we force a break.
1587         pos_type end = cur.textRow().endpos();
1588         if (end == 0)
1589                 // empty text, end-1 is no valid position
1590                 return false;
1591         bool boundary = false;
1592         if (end != cur.lastpos()) {
1593                 if (!cur.paragraph().isLineSeparator(end-1)
1594                     && !cur.paragraph().isNewline(end-1)
1595                     && !cur.paragraph().isEnvSeparator(end-1))
1596                         boundary = true;
1597                 else
1598                         --end;
1599         }
1600         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1601 }
1602
1603
1604 void TextMetrics::deleteLineForward(Cursor & cur)
1605 {
1606         LASSERT(text_ == cur.text(), return);
1607         if (cur.lastpos() == 0) {
1608                 // Paragraph is empty, so we just go forward
1609                 text_->cursorForward(cur);
1610         } else {
1611                 cur.resetAnchor();
1612                 cur.setSelection(true); // to avoid deletion
1613                 cursorEnd(cur);
1614                 cur.setSelection();
1615                 // What is this test for ??? (JMarc)
1616                 if (!cur.selection())
1617                         text_->deleteWordForward(cur);
1618                 else
1619                         cap::cutSelection(cur, true, false);
1620                 cur.checkBufferStructure();
1621         }
1622 }
1623
1624
1625 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1626 {
1627         ParagraphList const & pars = text_->paragraphs();
1628         return row.endpos() >= pars[pit].size()
1629                 && pit + 1 == pit_type(pars.size());
1630 }
1631
1632
1633 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1634 {
1635         return row.pos() == 0 && pit == 0;
1636 }
1637
1638
1639 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1640 {
1641         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1642 }
1643
1644
1645 int TextMetrics::leftMargin(int max_width,
1646                 pit_type const pit, pos_type const pos) const
1647 {
1648         ParagraphList const & pars = text_->paragraphs();
1649
1650         LASSERT(pit >= 0, return 0);
1651         LASSERT(pit < int(pars.size()), return 0);
1652         Paragraph const & par = pars[pit];
1653         LASSERT(pos >= 0, return 0);
1654         LASSERT(pos <= par.size(), return 0);
1655         Buffer const & buffer = bv_->buffer();
1656         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1657         DocumentClass const & tclass = buffer.params().documentClass();
1658         Layout const & layout = par.layout();
1659
1660         docstring parindent = layout.parindent;
1661
1662         int l_margin = 0;
1663
1664         if (text_->isMainText())
1665                 l_margin += bv_->leftMargin();
1666
1667         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1668                 tclass.leftmargin());
1669
1670         int depth = par.getDepth();
1671         if (depth != 0) {
1672                 // find the next level paragraph
1673                 pit_type newpar = text_->outerHook(pit);
1674                 if (newpar != pit_type(pars.size())) {
1675                         if (pars[newpar].layout().isEnvironment()) {
1676                                 int nestmargin = depth * nestMargin();
1677                                 if (text_->isMainText())
1678                                         nestmargin += changebarMargin();
1679                                 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1680                                 // Remove the parindent that has been added
1681                                 // if the paragraph was empty.
1682                                 if (pars[newpar].empty() &&
1683                                     buffer.params().paragraph_separation ==
1684                                     BufferParams::ParagraphIndentSeparation) {
1685                                         docstring pi = pars[newpar].layout().parindent;
1686                                         l_margin -= theFontMetrics(
1687                                                 buffer.params().getFont()).signedWidth(pi);
1688                                 }
1689                         }
1690                         if (tclass.isDefaultLayout(par.layout())
1691                             || tclass.isPlainLayout(par.layout())) {
1692                                 if (pars[newpar].params().noindent())
1693                                         parindent.erase();
1694                                 else
1695                                         parindent = pars[newpar].layout().parindent;
1696                         }
1697                 }
1698         }
1699
1700         // This happens after sections or environments in standard classes.
1701         // We have to check the previous layout at same depth.
1702         if (buffer.params().paragraph_separation ==
1703                         BufferParams::ParagraphSkipSeparation)
1704                 parindent.erase();
1705         else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1706                 pit_type prev = text_->depthHook(pit, par.getDepth());
1707                 if (par.layout() == pars[prev].layout()) {
1708                         if (prev != pit - 1
1709                             && pars[pit - 1].layout().nextnoindent)
1710                                 parindent.erase();
1711                 } else if (pars[prev].layout().nextnoindent)
1712                         parindent.erase();
1713         }
1714
1715         FontInfo const labelfont = text_->labelFont(par);
1716         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1717
1718         switch (layout.margintype) {
1719         case MARGIN_DYNAMIC:
1720                 if (!layout.leftmargin.empty()) {
1721                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1722                                 layout.leftmargin);
1723                 }
1724                 if (!par.labelString().empty()) {
1725                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1726                         l_margin += labelfont_metrics.width(par.labelString());
1727                         l_margin += labelfont_metrics.width(layout.labelsep);
1728                 }
1729                 break;
1730
1731         case MARGIN_MANUAL: {
1732                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1733                 // The width of an empty par, even with manual label, should be 0
1734                 if (!par.empty() && pos >= par.beginOfBody()) {
1735                         if (!par.getLabelWidthString().empty()) {
1736                                 docstring labstr = par.getLabelWidthString();
1737                                 l_margin += labelfont_metrics.width(labstr);
1738                                 l_margin += labelfont_metrics.width(layout.labelsep);
1739                         }
1740                 }
1741                 break;
1742         }
1743
1744         case MARGIN_STATIC: {
1745                 l_margin += theFontMetrics(buffer.params().getFont()).
1746                         signedWidth(layout.leftmargin) * 4      / (par.getDepth() + 4);
1747                 break;
1748         }
1749
1750         case MARGIN_FIRST_DYNAMIC:
1751                 if (layout.labeltype == LABEL_MANUAL) {
1752                         // if we are at position 0, we are never in the body
1753                         if (pos > 0 && pos >= par.beginOfBody())
1754                                 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1755                         else
1756                                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1757                 } else if (pos != 0
1758                            // Special case to fix problems with
1759                            // theorems (JMarc)
1760                            || (layout.labeltype == LABEL_STATIC
1761                                && layout.latextype == LATEX_ENVIRONMENT
1762                                && !text_->isFirstInSequence(pit))) {
1763                         l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1764                 } else if (!layout.labelIsAbove()) {
1765                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1766                         l_margin += labelfont_metrics.width(layout.labelsep);
1767                         l_margin += labelfont_metrics.width(par.labelString());
1768                 }
1769                 break;
1770
1771         case MARGIN_RIGHT_ADDRESS_BOX: {
1772 #if 0
1773                 // The left margin depends on the widest row in this paragraph.
1774                 // This code is wrong because it depends on the rows, but at the
1775                 // same time this function is used in redoParagraph to construct
1776                 // the rows.
1777                 ParagraphMetrics const & pm = par_metrics_[pit];
1778                 RowList::const_iterator rit = pm.rows().begin();
1779                 RowList::const_iterator end = pm.rows().end();
1780                 int minfill = max_width;
1781                 for ( ; rit != end; ++rit)
1782                         if (rit->fill() < minfill)
1783                                 minfill = rit->fill();
1784                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1785                 l_margin += minfill;
1786 #endif
1787                 // also wrong, but much shorter.
1788                 l_margin += max_width / 2;
1789                 break;
1790         }
1791         }
1792
1793         if (!par.params().leftIndent().zero())
1794                 l_margin += par.params().leftIndent().inPixels(max_width, labelfont_metrics.em());
1795
1796         LyXAlignment align;
1797
1798         if (par.params().align() == LYX_ALIGN_LAYOUT)
1799                 align = layout.align;
1800         else
1801                 align = par.params().align();
1802
1803         // set the correct parindent
1804         if (pos == 0
1805             && (layout.labeltype == LABEL_NO_LABEL
1806                 || layout.labeltype == LABEL_ABOVE
1807                 || layout.labeltype == LABEL_CENTERED
1808                 || (layout.labeltype == LABEL_STATIC
1809                     && layout.latextype == LATEX_ENVIRONMENT
1810                     && !text_->isFirstInSequence(pit)))
1811             && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1812             && !par.params().noindent()
1813             // in some insets, paragraphs are never indented
1814             && !text_->inset().neverIndent()
1815             // display style insets are always centered, omit indentation
1816             && !(!par.empty()
1817                  && par.isInset(pos)
1818                  && par.getInset(pos)->display())
1819             && (!(tclass.isDefaultLayout(par.layout())
1820                   || tclass.isPlainLayout(par.layout()))
1821                 || buffer.params().paragraph_separation
1822                                 == BufferParams::ParagraphIndentSeparation)) {
1823                         // use the parindent of the layout when the
1824                         // default indentation is used otherwise use
1825                         // the indentation set in the document
1826                         // settings
1827                         if (buffer.params().getIndentation().asLyXCommand() == "default")
1828                                 l_margin += theFontMetrics(
1829                                         buffer.params().getFont()).signedWidth(parindent);
1830                         else
1831                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1832                 }
1833
1834         return l_margin;
1835 }
1836
1837
1838 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1839 {
1840         if (par_metrics_.empty())
1841                 return;
1842
1843         origin_.x_ = x;
1844         origin_.y_ = y;
1845
1846         ParMetricsCache::iterator it = par_metrics_.begin();
1847         ParMetricsCache::iterator const pm_end = par_metrics_.end();
1848         y -= it->second.ascent();
1849         for (; it != pm_end; ++it) {
1850                 ParagraphMetrics const & pmi = it->second;
1851                 y += pmi.ascent();
1852                 pit_type const pit = it->first;
1853                 // Save the paragraph position in the cache.
1854                 it->second.setPosition(y);
1855                 drawParagraph(pi, pit, x, y);
1856                 y += pmi.descent();
1857         }
1858 }
1859
1860
1861 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1862 {
1863         BufferParams const & bparams = bv_->buffer().params();
1864         ParagraphMetrics const & pm = par_metrics_[pit];
1865         if (pm.rows().empty())
1866                 return;
1867
1868         bool const original_drawing_state = pi.pain.isDrawingEnabled();
1869         int const ww = bv_->workHeight();
1870         size_t const nrows = pm.rows().size();
1871
1872         Cursor const & cur = bv_->cursor();
1873         DocIterator sel_beg = cur.selectionBegin();
1874         DocIterator sel_end = cur.selectionEnd();
1875         bool selection = cur.selection()
1876                 // This is our text.
1877                 && cur.text() == text_
1878                 // if the anchor is outside, this is not our selection
1879                 && cur.normalAnchor().text() == text_
1880                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1881
1882         // We store the begin and end pos of the selection relative to this par
1883         DocIterator sel_beg_par = cur.selectionBegin();
1884         DocIterator sel_end_par = cur.selectionEnd();
1885
1886         // We care only about visible selection.
1887         if (selection) {
1888                 if (pit != sel_beg.pit()) {
1889                         sel_beg_par.pit() = pit;
1890                         sel_beg_par.pos() = 0;
1891                 }
1892                 if (pit != sel_end.pit()) {
1893                         sel_end_par.pit() = pit;
1894                         sel_end_par.pos() = sel_end_par.lastpos();
1895                 }
1896         }
1897
1898         for (size_t i = 0; i != nrows; ++i) {
1899
1900                 Row const & row = pm.rows()[i];
1901                 int row_x = x;
1902                 if (i)
1903                         y += row.ascent();
1904
1905                 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1906                 rowSlice.pit() = pit;
1907                 rowSlice.pos() = row.pos();
1908
1909                 bool const inside = (y + row.descent() >= 0
1910                         && y - row.ascent() < ww);
1911
1912                 // Adapt to cursor row scroll offset if applicable.
1913                 if (bv_->currentRowSlice() == rowSlice)
1914                         row_x -= bv_->horizScrollOffset();
1915
1916                 // It is not needed to draw on screen if we are not inside.
1917                 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1918
1919                 RowPainter rp(pi, *text_, pit, row, row_x, y);
1920
1921                 if (selection)
1922                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1923                 else
1924                         row.setSelection(-1, -1);
1925
1926                 // The row knows nothing about the paragraph, so we have to check
1927                 // whether this row is the first or last and update the margins.
1928                 if (row.selection()) {
1929                         if (row.sel_beg == 0)
1930                                 row.begin_margin_sel = sel_beg.pit() < pit;
1931                         if (row.sel_end == sel_end_par.lastpos())
1932                                 row.end_margin_sel = sel_end.pit() > pit;
1933                 }
1934
1935                 // Row signature; has row changed since last paint?
1936                 if (pi.pain.isDrawingEnabled())
1937                         row.setCrc(pm.computeRowSignature(row, bparams));
1938                 bool row_has_changed = row.changed()
1939                         || rowSlice == bv_->lastRowSlice();
1940
1941                 // Take this opportunity to spellcheck the row contents.
1942                 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1943                         text_->getPar(pit).spellCheck();
1944                 }
1945
1946                 // Don't paint the row if a full repaint has not been requested
1947                 // and if it has not changed.
1948                 if (!pi.full_repaint && !row_has_changed) {
1949                         // Paint only the insets if the text itself is
1950                         // unchanged.
1951                         rp.paintOnlyInsets();
1952                         y += row.descent();
1953                         continue;
1954                 }
1955
1956                 // Clear background of this row if paragraph background was not
1957                 // already cleared because of a full repaint.
1958                 if (!pi.full_repaint && row_has_changed) {
1959                         LYXERR(Debug::PAINTING, "Clear rect@("
1960                                << max(row_x, 0) << ", " << y - row.ascent() << ")="
1961                                << width() << " x " << row.height());
1962                         pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1963                                 width(), row.height(), pi.background_color);
1964                 }
1965
1966                 // Instrumentation for testing row cache (see also
1967                 // 12 lines lower):
1968                 if (lyxerr.debugging(Debug::PAINTING) && inside
1969                         && (row.selection() || pi.full_repaint || row_has_changed)) {
1970                                 string const foreword = text_->isMainText() ?
1971                                         "main text redraw " : "inset text redraw: ";
1972                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1973                                 << " row_selection="    << row.selection()
1974                                 << " full_repaint="     << pi.full_repaint
1975                                 << " row_has_changed="  << row_has_changed
1976                                 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1977                 }
1978
1979                 // Backup full_repaint status and force full repaint
1980                 // for inner insets as the Row has been cleared out.
1981                 bool tmp = pi.full_repaint;
1982                 pi.full_repaint = true;
1983
1984                 rp.paintSelection();
1985                 rp.paintAppendix();
1986                 rp.paintDepthBar();
1987                 rp.paintChangeBar();
1988                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1989                 if (i == 0 && !is_rtl)
1990                         rp.paintFirst();
1991                 if (i == nrows - 1 && is_rtl)
1992                         rp.paintLast();
1993                 rp.paintText();
1994                 if (i == nrows - 1 && !is_rtl)
1995                         rp.paintLast();
1996                 if (i == 0 && is_rtl)
1997                         rp.paintFirst();
1998                 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1999                                       row_x + row.right_x() > bv_->workWidth());
2000                 y += row.descent();
2001
2002                 // Restore full_repaint status.
2003                 pi.full_repaint = tmp;
2004         }
2005         // Re-enable screen drawing for future use of the painter.
2006         pi.pain.setDrawingEnabled(original_drawing_state);
2007
2008         //LYXERR(Debug::PAINTING, ".");
2009 }
2010
2011
2012 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2013         Dimension & dim) const
2014 {
2015         Cursor const & bvcur = cur.bv().cursor();
2016
2017         // get word in front of cursor
2018         docstring word = text_->previousWord(bvcur.top());
2019         DocIterator wordStart = bvcur;
2020         wordStart.pos() -= word.length();
2021
2022         // get position on screen of the word start and end
2023         //FIXME: Is it necessary to explicitly set this to false?
2024         wordStart.boundary(false);
2025         Point lxy = cur.bv().getPos(wordStart);
2026         Point rxy = cur.bv().getPos(bvcur);
2027
2028         // calculate dimensions of the word
2029         Row row;
2030         row.pos(wordStart.pos());
2031         row.endpos(bvcur.pos());
2032         setRowHeight(row, bvcur.pit(), false);
2033         dim = row.dimension();
2034         dim.wid = abs(rxy.x_ - lxy.x_);
2035
2036         // calculate position of word
2037         y = lxy.y_;
2038         x = min(rxy.x_, lxy.x_);
2039
2040         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2041         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2042 }
2043
2044 int defaultRowHeight()
2045 {
2046         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
2047 }
2048
2049 } // namespace lyx