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