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