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