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