src/TextMetrics.cpp

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