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