src/TextMetrics.cpp

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