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 text_->isMainText() ? pm.rightMargin(*bv_) : 0;
 204 }
 205
 206
 207 int TextMetrics::rightMargin(pit_type const pit) const
 208 {
 209         return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
 210 }
 211
 212
 213 void TextMetrics::applyOuterFont(Font & font) const
 214 {
 215         FontInfo lf(font_.fontInfo());
 216         lf.reduce(bv_->buffer().params().getFont().fontInfo());
 217         font.fontInfo().realize(lf);
 218 }
 219
 220
 221 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
 222 {
 223         LASSERT(pos >= 0, { static Font f; return f; });
 224
 225         ParagraphList const & pars = text_->paragraphs();
 226         Paragraph const & par = pars[pit];
 227         Layout const & layout = par.layout();
 228         Buffer const & buffer = bv_->buffer();
 229         // FIXME: broken?
 230         BufferParams const & params = buffer.params();
 231         pos_type const body_pos = par.beginOfBody();
 232
 233         // We specialize the 95% common case:
 234         if (!par.getDepth()) {
 235                 Font f = par.getFontSettings(params, pos);
 236                 if (!text_->isMainText())
 237                         applyOuterFont(f);
 238                 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
 239
 240                 FontInfo const & lf = lab ? layout.labelfont : layout.font;
 241                 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
 242
 243                 // In case the default family has been customized
 244                 if (lf.family() == INHERIT_FAMILY)
 245                         rlf.setFamily(params.getFont().fontInfo().family());
 246                 f.fontInfo().realize(rlf);
 247                 return f;
 248         }
 249
 250         // The uncommon case need not be optimized as much
 251         FontInfo const & layoutfont = pos < body_pos ?
 252                 layout.labelfont : layout.font;
 253
 254         Font font = par.getFontSettings(params, pos);
 255         font.fontInfo().realize(layoutfont);
 256
 257         if (!text_->isMainText())
 258                 applyOuterFont(font);
 259
 260         // Realize against environment font information
 261         // NOTE: the cast to pit_type should be removed when pit_type
 262         // changes to a unsigned integer.
 263         if (pit < pit_type(pars.size()))
 264                 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
 265
 266         // Realize with the fonts of lesser depth.
 267         font.fontInfo().realize(params.getFont().fontInfo());
 268
 269         return font;
 270 }
 271
 272
 273 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
 274 {
 275         if (!sl.text())
 276                 return false;
 277
 278         int correction = 0;
 279         if (boundary && sl.pos() > 0)
 280                 correction = -1;
 281
 282         return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
 283 }
 284
 285
 286 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
 287 {
 288         // no RTL boundary at paragraph start
 289         if (pos == 0)
 290                 return false;
 291
 292         Font const & left_font = displayFont(pit, pos - 1);
 293
 294         return isRTLBoundary(pit, pos, left_font);
 295 }
 296
 297
 298 // isRTLBoundary returns false on a real end-of-line boundary,
 299 // because otherwise the two boundary types get mixed up.
 300 // This is the whole purpose of this being in TextMetrics.
 301 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
 302                 Font const & font) const
 303 {
 304         if (// no RTL boundary at paragraph start
 305             pos == 0
 306             // if the metrics have not been calculated, then we are not
 307             // on screen and can safely ignore issues about boundaries.
 308             || !contains(pit))
 309                 return false;
 310
 311         ParagraphMetrics & pm = par_metrics_[pit];
 312         // no RTL boundary in empty paragraph
 313         if (pm.rows().empty())
 314                 return false;
 315
 316         pos_type endpos = pm.getRow(pos - 1, false).endpos();
 317         pos_type startpos = pm.getRow(pos, false).pos();
 318         // no RTL boundary at line start:
 319         // abc\n   -> toggle to RTL ->    abc\n     (and not:    abc\n|
 320         // |                              |                               )
 321         if (pos == startpos && pos == endpos) // start of cur row, end of prev row
 322                 return false;
 323
 324         Paragraph const & par = text_->getPar(pit);
 325         // no RTL boundary at line break:
 326         // abc|\n    -> move right ->   abc\n       (and not:    abc\n|
 327         // FED                          FED|                     FED     )
 328         if (startpos == pos && endpos == pos && endpos != par.size()
 329                 && (par.isNewline(pos - 1)
 330                         || par.isEnvSeparator(pos - 1)
 331                         || par.isLineSeparator(pos - 1)
 332                         || par.isSeparator(pos - 1)))
 333                 return false;
 334
 335         bool left = font.isVisibleRightToLeft();
 336         bool right;
 337         if (pos == par.size())
 338                 right = par.isRTL(bv_->buffer().params());
 339         else
 340                 right = displayFont(pit, pos).isVisibleRightToLeft();
 341
 342         return left != right;
 343 }
 344
 345
 346 bool TextMetrics::redoParagraph(pit_type const pit)
 347 {
 348         Paragraph & par = text_->getPar(pit);
 349         // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
 350         // redoParagraph() recursively inside parMetrics.
 351         Dimension old_dim = parMetrics(pit, false).dim();
 352         ParagraphMetrics & pm = par_metrics_[pit];
 353         pm.reset(par);
 354
 355         Buffer & buffer = bv_->buffer();
 356         bool changed = false;
 357
 358         // Check whether there are InsetBibItems that need fixing
 359         // FIXME: This check ought to be done somewhere else. It is the reason
 360         // why text_ is not const. But then, where else to do it?
 361         // Well, how can you end up with either (a) a biblio environment that
 362         // has no InsetBibitem or (b) a biblio environment with more than one
 363         // InsetBibitem? I think the answer is: when paragraphs are merged;
 364         // when layout is set; when material is pasted.
 365         if (par.brokenBiblio()) {
 366                 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
 367                 // In some cases, we do not know how to record undo
 368                 if (&cur.inset() == &text_->inset())
 369                         cur.recordUndo(pit, pit);
 370
 371                 int const moveCursor = par.fixBiblio(buffer);
 372
 373                 // Is it necessary to update the cursor?
 374                 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
 375                         if (moveCursor > 0)
 376                                 cur.posForward();
 377                         else if (moveCursor < 0 && cur.pos() >= -moveCursor)
 378                                 cur.posBackward();
 379                 }
 380         }
 381
 382         // Optimisation: this is used in the next two loops
 383         // so better to calculate that once here.
 384         int const right_margin = rightMargin(pm);
 385
 386         // iterator pointing to paragraph to resolve macros
 387         DocIterator parPos = text_->macrocontextPosition();
 388         if (!parPos.empty())
 389                 parPos.pit() = pit;
 390         else {
 391                 LYXERR(Debug::INFO, "MacroContext not initialised!"
 392                         << " Going through the buffer again and hope"
 393                         << " the context is better then.");
 394                 // FIXME audit updateBuffer calls
 395                 // This should not be here, but it is not clear yet where else it
 396                 // should be.
 397                 bv_->buffer().updateBuffer();
 398                 parPos = text_->macrocontextPosition();
 399                 LBUFERR(!parPos.empty());
 400                 parPos.pit() = pit;
 401         }
 402
 403         // redo insets
 404         Font const bufferfont = buffer.params().getFont();
 405         CoordCache::Insets & insetCache = bv_->coordCache().insets();
 406         InsetList::const_iterator ii = par.insetList().begin();
 407         InsetList::const_iterator iend = par.insetList().end();
 408         for (; ii != iend; ++ii) {
 409                 // FIXME Doesn't this HAVE to be non-empty?
 410                 // position already initialized?
 411                 if (!parPos.empty()) {
 412                         parPos.pos() = ii->pos;
 413
 414                         // A macro template would normally not be visible
 415                         // by itself. But the tex macro semantics allow
 416                         // recursion, so we artifically take the context
 417                         // after the macro template to simulate this.
 418                         if (ii->inset->lyxCode() == MATHMACRO_CODE)
 419                                 parPos.pos()++;
 420                 }
 421
 422                 // do the metric calculation
 423                 Dimension dim;
 424                 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
 425                         - right_margin;
 426                 Font const & font = ii->inset->inheritFont() ?
 427                         displayFont(pit, ii->pos) : bufferfont;
 428                 MacroContext mc(&buffer, parPos);
 429                 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
 430                 ii->inset->metrics(mi, dim);
 431                 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
 432                         insetCache.add(ii->inset, dim);
 433                         changed = true;
 434                 }
 435         }
 436
 437         par.setBeginOfBody();
 438         pos_type first = 0;
 439         size_t row_index = 0;
 440         bool need_new_row = false;
 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.pit(pit);
 447                 row.pos(first);
 448                 row.pit(pit);
 449                 need_new_row = breakRow(row, right_margin);
 450                 setRowHeight(row);
 451                 row.setChanged(false);
 452                 if (row_index || row.endpos() < par.size()
 453                     || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
 454                         /* If there is more than one row or the row has been
 455                          * broken by a display inset or a newline, expand the text
 456                          * to the full allowable width. This setting here is
 457                          * needed for the computeRowMetrics() below. In the case
 458                          * of a display inset, we do nothing when inside a table
 459                          * cell, because the tabular code is not prepared for
 460                          * that, and it triggers when using a caption in a
 461                          * longtable (see bugs #9945 and #9757).
 462                          */
 463                         if (dim_.wid < max_width_)
 464                                 dim_.wid = max_width_;
 465                 }
 466                 int const max_row_width = max(dim_.wid, row.width());
 467                 computeRowMetrics(row, max_row_width);
 468                 first = row.endpos();
 469                 ++row_index;
 470
 471                 pm.dim().wid = max(pm.dim().wid, row.width());
 472                 pm.dim().des += row.height();
 473         } while (first < par.size() || need_new_row);
 474
 475         if (row_index < pm.rows().size())
 476                 pm.rows().resize(row_index);
 477
 478         // FIXME: It might be better to move this in another method
 479         // specially tailored for the main text.
 480         // Top and bottom margin of the document (only at top-level)
 481         if (text_->isMainText()) {
 482                 if (pit == 0) {
 483                         pm.rows().front().dimension().asc += 20;
 484                         /* coverity[copy_paste_error]: coverity thinks that we
 485                          * should update pm.dim().asc below, but all the rows
 486                          * heights are actually counted as part of the paragraph metric
 487                          * descent see loop above).
 488                          */
 489                         pm.dim().des += 20;
 490                 }
 491                 ParagraphList const & pars = text_->paragraphs();
 492                 if (pit + 1 == pit_type(pars.size())) {
 493                         pm.rows().back().dimension().des += 20;
 494                         pm.dim().des += 20;
 495                 }
 496         }
 497
 498         // The space above and below the paragraph.
 499         int const top = parTopSpacing(pit);
 500         pm.rows().front().dimension().asc += top;
 501         int const bottom = parBottomSpacing(pit);
 502         pm.rows().back().dimension().des += bottom;
 503         pm.dim().des += top + bottom;
 504
 505         pm.dim().asc += pm.rows()[0].ascent();
 506         pm.dim().des -= pm.rows()[0].ascent();
 507
 508         changed |= old_dim.height() != pm.dim().height();
 509
 510         return changed;
 511 }
 512
 513
 514 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 515 {
 516         Layout const & layout = par.layout();
 517
 518         LyXAlignment align;
 519         if (par.params().align() == LYX_ALIGN_LAYOUT)
 520                 align = layout.align;
 521         else
 522                 align = par.params().align();
 523
 524         // handle alignment inside tabular cells
 525         Inset const & owner = text_->inset();
 526         bool forced_block = false;
 527         switch (owner.contentAlignment()) {
 528         case LYX_ALIGN_BLOCK:
 529                 // In general block align is the default state, but here it is
 530                 // an explicit choice. Therefore it should not be overridden
 531                 // later.
 532                 forced_block = true;
 533                 // fall through
 534         case LYX_ALIGN_CENTER:
 535         case LYX_ALIGN_LEFT:
 536         case LYX_ALIGN_RIGHT:
 537                 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
 538                         align = owner.contentAlignment();
 539                 break;
 540         default:
 541                 // unchanged (use align)
 542                 break;
 543         }
 544
 545         // Display-style insets should always be on a centered row
 546         if (Inset const * inset = par.getInset(row.pos())) {
 547                 switch (inset->display()) {
 548                 case Inset::AlignLeft:
 549                         align = LYX_ALIGN_BLOCK;
 550                         break;
 551                 case Inset::AlignCenter:
 552                         align = LYX_ALIGN_CENTER;
 553                         break;
 554                 case Inset::Inline:
 555                         // unchanged (use align)
 556                         break;
 557                 case Inset::AlignRight:
 558                         align = LYX_ALIGN_RIGHT;
 559                         break;
 560                 }
 561         }
 562
 563         if (align == LYX_ALIGN_BLOCK) {
 564                 // If this row has been broken abruptly by a display inset, or
 565                 // it is the end of the paragraph, or the user requested we
 566                 // not justify stuff, then don't stretch.
 567                 // A forced block alignment can only be overridden the 'no
 568                 // justification on screen' setting.
 569                 if (((row.right_boundary() || row.endpos() == par.size())
 570                      && !forced_block)
 571                     || !bv_->buffer().params().justification)
 572                         align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
 573         }
 574
 575         return align;
 576 }
 577
 578
 579 void TextMetrics::computeRowMetrics(Row & row, int width) const
 580 {
 581         row.label_hfill = 0;
 582         row.separator = 0;
 583
 584         Paragraph const & par = text_->getPar(row.pit());
 585
 586         int const w = width - row.right_margin - row.width();
 587         // FIXME: put back this assertion when the crash on new doc is solved.
 588         //LASSERT(w >= 0, /**/);
 589
 590         // is there a manual margin with a manual label
 591         Layout const & layout = par.layout();
 592
 593         int nlh = 0;
 594         if (layout.margintype == MARGIN_MANUAL
 595             && layout.labeltype == LABEL_MANUAL) {
 596                 /// We might have real hfills in the label part
 597                 nlh = numberOfLabelHfills(par, row);
 598
 599                 // A manual label par (e.g. List) has an auto-hfill
 600                 // between the label text and the body of the
 601                 // paragraph too.
 602                 // But we don't want to do this auto hfill if the par
 603                 // is empty.
 604                 if (!par.empty())
 605                         ++nlh;
 606
 607                 if (nlh && !par.getLabelWidthString().empty())
 608                         row.label_hfill = labelFill(row) / double(nlh);
 609         }
 610
 611         // are there any hfills in the row?
 612         ParagraphMetrics & pm = par_metrics_[row.pit()];
 613         int nh = numberOfHfills(row, pm, par.beginOfBody());
 614         int hfill = 0;
 615         int hfill_rem = 0;
 616
 617         // We don't have to look at the alignment if the row is already
 618         // larger then the permitted width as then we force the
 619         // LEFT_ALIGN'edness!
 620         if (int(row.width()) >= max_width_)
 621                 return;
 622
 623         if (nh == 0) {
 624                 // Common case : there is no hfill, and the alignment will be
 625                 // meaningful
 626                 switch (getAlign(par, row)) {
 627                 case LYX_ALIGN_BLOCK: {
 628                         int const ns = row.countSeparators();
 629                         // If we have separators, then stretch the row
 630                         if (ns) {
 631                                 row.setSeparatorExtraWidth(double(w) / ns);
 632                                 row.dimension().wid += w;
 633                         } else if (text_->isRTL(par)) {
 634                                 row.left_margin += w;
 635                                 row.dimension().wid += w;
 636                         }
 637                         break;
 638                 }
 639                 case LYX_ALIGN_RIGHT:
 640                         row.left_margin += w;
 641                         row.dimension().wid += w;
 642                         break;
 643                 case LYX_ALIGN_CENTER:
 644                         row.dimension().wid += w / 2;
 645                         row.left_margin += w / 2;
 646                         break;
 647                 case LYX_ALIGN_LEFT:
 648                 case LYX_ALIGN_NONE:
 649                 case LYX_ALIGN_LAYOUT:
 650                 case LYX_ALIGN_SPECIAL:
 651                 case LYX_ALIGN_DECIMAL:
 652                         break;
 653                 }
 654                 return;
 655         }
 656
 657         hfill = w / nh;
 658         hfill_rem = w % nh;
 659         row.dimension().wid += w;
 660         // Set size of hfill insets
 661         pos_type const endpos = row.endpos();
 662         pos_type body_pos = par.beginOfBody();
 663         if (body_pos > 0
 664             && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
 665                 body_pos = 0;
 666
 667         CoordCache::Insets & insetCache = bv_->coordCache().insets();
 668         Row::iterator cit = row.begin();
 669         Row::iterator const cend = row.end();
 670         for ( ; cit != cend; ++cit) {
 671                 if (row.label_hfill && cit->endpos == body_pos
 672                     && cit->type == Row::SPACE)
 673                         cit->dim.wid -= int(row.label_hfill * (nlh - 1));
 674                 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
 675                         if (cit->pos >= body_pos) {
 676                                 cit->dim.wid += hfill;
 677                                 --nh;
 678                                 if (nh == 0)
 679                                         cit->dim.wid += hfill_rem;
 680                         } else
 681                                 cit->dim.wid += int(row.label_hfill);
 682                         // Cache the inset dimension.
 683                         insetCache.add(cit->inset, cit->dim);
 684                 }
 685         }
 686 }
 687
 688
 689 int TextMetrics::labelFill(Row const & row) const
 690 {
 691         Paragraph const & par = text_->getPar(row.pit());
 692         LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
 693
 694         int w = 0;
 695         Row::const_iterator cit = row.begin();
 696         Row::const_iterator const end = row.end();
 697         // iterate over elements before main body (except the last one,
 698         // which is extra space).
 699         while (cit!= end && cit->endpos < par.beginOfBody()) {
 700                 w += cit->dim.wid;
 701                 ++cit;
 702         }
 703
 704         docstring const & label = par.params().labelWidthString();
 705         if (label.empty())
 706                 return 0;
 707
 708         FontMetrics const & fm
 709                 = theFontMetrics(text_->labelFont(par));
 710
 711         return max(0, fm.width(label) - w);
 712 }
 713
 714
 715 #if 0
 716 // Not used, see TextMetrics::breakRow
 717 // this needs special handling - only newlines count as a break point
 718 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
 719 {
 720         pos_type const end = par.size();
 721
 722         for (; i < end; ++i)
 723                 if (par.isNewline(i))
 724                         return i + 1;
 725
 726         return end;
 727 }
 728 #endif
 729
 730
 731 int TextMetrics::labelEnd(pit_type const pit) const
 732 {
 733         // labelEnd is only needed if the layout fills a flushleft label.
 734         if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
 735                 return 0;
 736         // return the beginning of the body
 737         return leftMargin(max_width_, pit);
 738 }
 739
 740 namespace {
 741
 742 /**
 743  * Calling Text::getFont is slow. While rebreaking we scan a
 744  * paragraph from left to right calling getFont for every char.  This
 745  * simple class address this problem by hidding an optimization trick
 746  * (not mine btw -AB): the font is reused in the whole font span.  The
 747  * class handles transparently the "hidden" (not part of the fontlist)
 748  * label font (as getFont does).
 749  **/
 750 class FontIterator
 751 {
 752 public:
 753         ///
 754         FontIterator(TextMetrics const & tm,
 755                 Paragraph const & par, pit_type pit, pos_type pos)
 756                 : tm_(tm), par_(par), pit_(pit), pos_(pos),
 757                 font_(tm.displayFont(pit, pos)),
 758                 endspan_(par.fontSpan(pos).last),
 759                 bodypos_(par.beginOfBody())
 760         {}
 761
 762         ///
 763         Font const & operator*() const { return font_; }
 764
 765         ///
 766         FontIterator & operator++()
 767         {
 768                 ++pos_;
 769                 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
 770                         font_ = tm_.displayFont(pit_, pos_);
 771                         endspan_ = par_.fontSpan(pos_).last;
 772                 }
 773                 return *this;
 774         }
 775
 776         ///
 777         Font * operator->() { return &font_; }
 778
 779 private:
 780         ///
 781         TextMetrics const & tm_;
 782         ///
 783         Paragraph const & par_;
 784         ///
 785         pit_type pit_;
 786         ///
 787         pos_type pos_;
 788         ///
 789         Font font_;
 790         ///
 791         pos_type endspan_;
 792         ///
 793         pos_type bodypos_;
 794 };
 795
 796 } // anon namespace
 797
 798 /** This is the function where the hard work is done. The code here is
 799  * very sensitive to small changes :) Note that part of the
 800  * intelligence is also in Row::shortenIfNeeded.
 801  */
 802 bool TextMetrics::breakRow(Row & row, int const right_margin) const
 803 {
 804         Paragraph const & par = text_->getPar(row.pit());
 805         pos_type const end = par.size();
 806         pos_type const pos = row.pos();
 807         pos_type const body_pos = par.beginOfBody();
 808         bool const is_rtl = text_->isRTL(par);
 809         bool need_new_row = false;
 810
 811         row.clear();
 812         row.left_margin = leftMargin(max_width_, row.pit(), pos);
 813         row.right_margin = right_margin;
 814         if (is_rtl)
 815                 swap(row.left_margin, row.right_margin);
 816         // Remember that the row width takes into account the left_margin
 817         // but not the right_margin.
 818         row.dimension().wid = row.left_margin;
 819         // the width available for the row.
 820         int const width = max_width_ - row.right_margin;
 821
 822         if (pos >= end || row.width() > width) {
 823                 row.endpos(end);
 824                 return need_new_row;
 825         }
 826
 827 #if 0
 828         //FIXME: As long as leftMargin() is not correctly implemented for
 829         // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
 830         // Otherwise, long rows will be painted off the screen.
 831         if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
 832                 return addressBreakPoint(pos, par);
 833 #endif
 834
 835         // check for possible inline completion
 836         DocIterator const & ic_it = bv_->inlineCompletionPos();
 837         pos_type ic_pos = -1;
 838         if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
 839                 ic_pos = ic_it.pos();
 840
 841         // Now we iterate through until we reach the right margin
 842         // or the end of the par, then build a representation of the row.
 843         pos_type i = pos;
 844         FontIterator fi = FontIterator(*this, par, row.pit(), pos);
 845         do {
 846                 // this can happen for an empty row after a newline
 847                 if (i >= end)
 848                         break;
 849                 char_type c = par.getChar(i);
 850                 // The most special cases are handled first.
 851                 if (par.isInset(i)) {
 852                         Inset const * ins = par.getInset(i);
 853                         Dimension dim = bv_->coordCache().insets().dim(ins);
 854                         row.add(i, ins, dim, *fi, par.lookupChange(i));
 855                 } else if (c == ' ' && i + 1 == body_pos) {
 856                         // There is a space at i, but it should not be
 857                         // added as a separator, because it is just
 858                         // before body_pos. Instead, insert some spacing to
 859                         // align text
 860                         FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
 861                         // this is needed to make sure that the row width is correct
 862                         row.finalizeLast();
 863                         int const add = max(fm.width(par.layout().labelsep),
 864                                             labelEnd(row.pit()) - row.width());
 865                         row.addSpace(i, add, *fi, par.lookupChange(i));
 866                 } else if (c == '\t')
 867                         row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
 868                                      *fi, par.lookupChange(i));
 869                 else {
 870                         // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
 871                         // see also Paragraph::getUChar.
 872                         if (fi->language()->lang() == "hebrew") {
 873                                 if (c == '(')
 874                                         c = ')';
 875                                 else if (c == ')')
 876                                         c = '(';
 877                         }
 878                         row.add(i, c, *fi, par.lookupChange(i));
 879                 }
 880
 881                 // add inline completion width
 882                 // draw logically behind the previous character
 883                 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
 884                         docstring const comp = bv_->inlineCompletion();
 885                         size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
 886                         Font f = *fi;
 887
 888                         if (uniqueTo > 0) {
 889                                 f.fontInfo().setColor(Color_inlinecompletion);
 890                                 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
 891                         }
 892                         f.fontInfo().setColor(Color_nonunique_inlinecompletion);
 893                         row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
 894                 }
 895
 896                 // Handle some situations that abruptly terminate the row
 897                 // - A newline inset
 898                 // - Before a display inset
 899                 // - After a display inset
 900                 Inset const * inset = 0;
 901                 if (par.isNewline(i) || par.isEnvSeparator(i)
 902                     || (i + 1 < end && (inset = par.getInset(i + 1))
 903                         && inset->display())
 904                     || (!row.empty() && row.back().inset
 905                         && row.back().inset->display())) {
 906                         row.right_boundary(true);
 907                         need_new_row = par.isNewline(i);
 908                         ++i;
 909                         break;
 910                 }
 911
 912                 ++i;
 913                 ++fi;
 914         } while (i < end && row.width() <= width);
 915         row.finalizeLast();
 916         row.endpos(i);
 917
 918         // End of paragraph marker
 919         ParagraphList const & pars = text_->paragraphs();
 920         if (lyxrc.paragraph_markers && !need_new_row
 921             && i == end && size_type(row.pit() + 1) < pars.size()) {
 922                 // add a virtual element for the end-of-paragraph
 923                 // marker; it is shown on screen, but does not exist
 924                 // in the paragraph.
 925                 Font f(text_->layoutFont(row.pit()));
 926                 f.fontInfo().setColor(Color_paragraphmarker);
 927                 BufferParams const & bparams
 928                         = text_->inset().buffer().params();
 929                 f.setLanguage(par.getParLanguage(bparams));
 930                 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
 931         }
 932
 933         // if the row is too large, try to cut at last separator. In case
 934         // of success, reset indication that the row was broken abruptly.
 935         if (row.shortenIfNeeded(body_pos, width))
 936                 row.right_boundary(!row.empty() && row.back().endpos == row.endpos());
 937
 938         // make sure that the RTL elements are in reverse ordering
 939         row.reverseRTL(is_rtl);
 940         //LYXERR0("breakrow: row is " << row);
 941
 942         return need_new_row;
 943 }
 944
 945 int TextMetrics::parTopSpacing(pit_type const pit) const
 946 {
 947         Paragraph const & par = text_->getPar(pit);
 948         Layout const & layout = par.layout();
 949
 950         int asc = 0;
 951         ParagraphList const & pars = text_->paragraphs();
 952         double const dh = defaultRowHeight();
 953
 954         BufferParams const & bparams = bv_->buffer().params();
 955         Inset const & inset = text_->inset();
 956         // some parskips VERY EASY IMPLEMENTATION
 957         if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
 958                 && !inset.getLayout().parbreakIsNewline()
 959                 && !par.layout().parbreak_is_newline
 960                 && pit > 0
 961                 && ((layout.isParagraph() && par.getDepth() == 0)
 962                     || (pars[pit - 1].layout().isParagraph()
 963                         && pars[pit - 1].getDepth() == 0))) {
 964                 asc += bparams.getDefSkip().inPixels(*bv_);
 965         }
 966
 967         if (par.params().startOfAppendix())
 968                 asc += int(3 * dh);
 969
 970         // special code for the top label
 971         if (layout.labelIsAbove()
 972             && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
 973             && !par.labelString().empty()) {
 974                 FontInfo labelfont = text_->labelFont(par);
 975                 FontMetrics const & lfm = theFontMetrics(labelfont);
 976                 asc += int(lfm.maxHeight() * layout.spacing.getValue()
 977                                            * text_->spacing(par)
 978                            + (layout.topsep + layout.labelbottomsep) * dh);
 979         }
 980
 981         // Add the layout spaces, for example before and after
 982         // a section, or between the items of a itemize or enumerate
 983         // environment.
 984
 985         pit_type prev = text_->depthHook(pit, par.getDepth());
 986         Paragraph const & prevpar = pars[prev];
 987         double layoutasc = 0;
 988         if (prev != pit
 989             && prevpar.layout() == layout
 990             && prevpar.getDepth() == par.getDepth()
 991             && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
 992                 layoutasc = layout.itemsep * dh;
 993         } else if (pit != 0 && layout.topsep > 0)
 994                 layoutasc = layout.topsep * dh;
 995
 996         asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
 997
 998         prev = text_->outerHook(pit);
 999         if (prev != pit_type(pars.size())) {
1000                 asc += int(pars[prev].layout().parsep * dh);
1001         } else if (pit != 0) {
1002                 Paragraph const & prevpar = pars[pit - 1];
1003                 if (prevpar.getDepth() != 0 || prevpar.layout() == layout)
1004                         asc += int(layout.parsep * dh);
1005         }
1006
1007         return asc;
1008 }
1009
1010
1011 int TextMetrics::parBottomSpacing(pit_type const pit) const
1012 {
1013         double layoutdesc = 0;
1014         ParagraphList const & pars = text_->paragraphs();
1015         double const dh = defaultRowHeight();
1016
1017         // add the layout spaces, for example before and after
1018         // a section, or between the items of a itemize or enumerate
1019         // environment
1020         pit_type nextpit = pit + 1;
1021         if (nextpit != pit_type(pars.size())) {
1022                 pit_type cpit = pit;
1023
1024                 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1025                         double usual = pars[cpit].layout().bottomsep * dh;
1026                         double unusual = 0;
1027                         cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1028                         if (pars[cpit].layout() != pars[nextpit].layout()
1029                                 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1030                                 unusual = pars[cpit].layout().bottomsep * dh;
1031                         layoutdesc = max(unusual, usual);
1032                 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1033                         if (pars[cpit].layout() != pars[nextpit].layout()
1034                                 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1035                                 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1036                 }
1037         }
1038
1039         return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1040 }
1041
1042
1043 void TextMetrics::setRowHeight(Row & row) const
1044 {
1045         Paragraph const & par = text_->getPar(row.pit());
1046         Layout const & layout = par.layout();
1047         double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1048
1049         // Initial value for ascent (useful if row is empty).
1050         Font const font = displayFont(row.pit(), row.pos());
1051         FontMetrics const & fm = theFontMetrics(font);
1052         int maxasc = int(fm.maxAscent() * spacing_val);
1053         int maxdes = int(fm.maxDescent() * spacing_val);
1054
1055         // Find the ascent/descent of the row contents
1056         Row::const_iterator cit = row.begin();
1057         Row::const_iterator cend = row.end();
1058         for ( ; cit != cend; ++cit) {
1059                 if (cit->inset) {
1060                         maxasc = max(maxasc, cit->dim.ascent());
1061                         maxdes = max(maxdes, cit->dim.descent());
1062                 } else {
1063                         FontMetrics const & fm = theFontMetrics(cit->font);
1064                         maxasc = max(maxasc, int(fm.maxAscent() * spacing_val));
1065                         maxdes = max(maxdes, int(fm.maxDescent() * spacing_val));
1066                 }
1067         }
1068
1069         // This is nicer with box insets
1070         ++maxasc;
1071         ++maxdes;
1072
1073         row.dimension().asc = maxasc;
1074         row.dimension().des = maxdes;
1075 }
1076
1077
1078 // x is an absolute screen coord
1079 // returns the column near the specified x-coordinate of the row
1080 // x is set to the real beginning of this column
1081 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1082                                   bool & boundary) const
1083 {
1084         //LYXERR0("getPosNearX(" << x << ") row=" << row);
1085         /// For the main Text, it is possible that this pit is not
1086         /// yet in the CoordCache when moving cursor up.
1087         /// x Paragraph coordinate is always 0 for main text anyway.
1088         int const xo = origin_.x_;
1089         x -= xo;
1090
1091         // Adapt to cursor row scroll offset if applicable.
1092         int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1093         x += offset;
1094
1095         pos_type pos = row.pos();
1096         boundary = false;
1097         if (row.empty())
1098                 x = row.left_margin;
1099         else if (x <= row.left_margin) {
1100                 pos = row.front().left_pos();
1101                 x = row.left_margin;
1102         } else if (x >= row.width()) {
1103                 pos = row.back().right_pos();
1104                 x = row.width();
1105         } else {
1106                 double w = row.left_margin;
1107                 Row::const_iterator cit = row.begin();
1108                 Row::const_iterator cend = row.end();
1109                 for ( ; cit != cend; ++cit) {
1110                         if (w <= x &&  w + cit->full_width() > x) {
1111                                 int x_offset = int(x - w);
1112                                 pos = cit->x2pos(x_offset);
1113                                 x = int(x_offset + w);
1114                                 break;
1115                         }
1116                         w += cit->full_width();
1117                 }
1118                 if (cit == row.end()) {
1119                         pos = row.back().right_pos();
1120                         x = row.width();
1121                 }
1122                 /** This tests for the case where the cursor is placed
1123                  * just before a font direction change. See comment on
1124                  * the boundary_ member in DocIterator.h to understand
1125                  * how boundary helps here.
1126                  */
1127                 else if (pos == cit->endpos
1128                          && cit + 1 != row.end()
1129                          && cit->isRTL() != (cit + 1)->isRTL())
1130                         boundary = true;
1131         }
1132
1133         /** This tests for the case where the cursor is set at the end
1134          * of a row which has been broken due something else than a
1135          * separator (a display inset or a forced breaking of the
1136          * row). We know that there is a separator when the end of the
1137          * row is larger than the end of its last element.
1138          */
1139         if (!row.empty() && pos == row.back().endpos
1140             && row.back().endpos == row.endpos()) {
1141                 Inset const * inset = row.back().inset;
1142                 if (inset && (inset->lyxCode() == NEWLINE_CODE
1143                               || inset->lyxCode() == SEPARATOR_CODE))
1144                         pos = row.back().pos;
1145                 else
1146                         boundary = row.right_boundary();
1147         }
1148
1149         x += xo - offset;
1150         //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1151
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         } else if (cur.paragraph().isEnvSeparator(end-1))
1581                 --end;
1582         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1583 }
1584
1585
1586 void TextMetrics::deleteLineForward(Cursor & cur)
1587 {
1588         LASSERT(text_ == cur.text(), return);
1589         if (cur.lastpos() == 0) {
1590                 // Paragraph is empty, so we just go forward
1591                 text_->cursorForward(cur);
1592         } else {
1593                 cur.resetAnchor();
1594                 cur.selection(true); // to avoid deletion
1595                 cursorEnd(cur);
1596                 cur.setSelection();
1597                 // What is this test for ??? (JMarc)
1598                 if (!cur.selection())
1599                         text_->deleteWordForward(cur);
1600                 else
1601                         cap::cutSelection(cur, true, false);
1602                 cur.checkBufferStructure();
1603         }
1604 }
1605
1606
1607 bool TextMetrics::isLastRow(Row const & row) const
1608 {
1609         ParagraphList const & pars = text_->paragraphs();
1610         return row.endpos() >= pars[row.pit()].size()
1611                 && row.pit() + 1 == pit_type(pars.size());
1612 }
1613
1614
1615 bool TextMetrics::isFirstRow(Row const & row) const
1616 {
1617         return row.pos() == 0 && row.pit() == 0;
1618 }
1619
1620
1621 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1622 {
1623         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1624 }
1625
1626
1627 int TextMetrics::leftMargin(int max_width,
1628                 pit_type const pit, pos_type const pos) const
1629 {
1630         ParagraphList const & pars = text_->paragraphs();
1631
1632         LASSERT(pit >= 0, return 0);
1633         LASSERT(pit < int(pars.size()), return 0);
1634         Paragraph const & par = pars[pit];
1635         LASSERT(pos >= 0, return 0);
1636         LASSERT(pos <= par.size(), return 0);
1637         Buffer const & buffer = bv_->buffer();
1638         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1639         DocumentClass const & tclass = buffer.params().documentClass();
1640         Layout const & layout = par.layout();
1641         FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1642
1643         docstring parindent = layout.parindent;
1644
1645         int l_margin = 0;
1646
1647         if (text_->isMainText())
1648                 l_margin += bv_->leftMargin();
1649
1650         l_margin += bfm.signedWidth(tclass.leftmargin());
1651
1652         int depth = par.getDepth();
1653         if (depth != 0) {
1654                 // find the next level paragraph
1655                 pit_type newpar = text_->outerHook(pit);
1656                 if (newpar != pit_type(pars.size())) {
1657                         if (pars[newpar].layout().isEnvironment()) {
1658                                 int nestmargin = depth * nestMargin();
1659                                 if (text_->isMainText())
1660                                         nestmargin += changebarMargin();
1661                                 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1662                                 // Remove the parindent that has been added
1663                                 // if the paragraph was empty.
1664                                 if (pars[newpar].empty() &&
1665                                     buffer.params().paragraph_separation ==
1666                                     BufferParams::ParagraphIndentSeparation) {
1667                                         docstring pi = pars[newpar].layout().parindent;
1668                                         l_margin -= bfm.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 & lfm = theFontMetrics(labelfont);
1698
1699         switch (layout.margintype) {
1700         case MARGIN_DYNAMIC:
1701                 if (!layout.leftmargin.empty()) {
1702                         l_margin += bfm.signedWidth(layout.leftmargin);
1703                 }
1704                 if (!par.labelString().empty()) {
1705                         l_margin += lfm.signedWidth(layout.labelindent);
1706                         l_margin += lfm.width(par.labelString());
1707                         l_margin += lfm.width(layout.labelsep);
1708                 }
1709                 break;
1710
1711         case MARGIN_MANUAL: {
1712                 l_margin += lfm.signedWidth(layout.labelindent);
1713                 // The width of an empty par, even with manual label, should be 0
1714                 if (!par.empty() && pos >= par.beginOfBody()) {
1715                         if (!par.getLabelWidthString().empty()) {
1716                                 docstring labstr = par.getLabelWidthString();
1717                                 l_margin += lfm.width(labstr);
1718                                 l_margin += lfm.width(layout.labelsep);
1719                         }
1720                 }
1721                 break;
1722         }
1723
1724         case MARGIN_STATIC: {
1725                 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1726                              / (par.getDepth() + 4);
1727                 break;
1728         }
1729
1730         case MARGIN_FIRST_DYNAMIC:
1731                 if (layout.labeltype == LABEL_MANUAL) {
1732                         // if we are at position 0, we are never in the body
1733                         if (pos > 0 && pos >= par.beginOfBody())
1734                                 l_margin += lfm.signedWidth(layout.leftmargin);
1735                         else
1736                                 l_margin += lfm.signedWidth(layout.labelindent);
1737                 } else if (pos != 0
1738                            // Special case to fix problems with
1739                            // theorems (JMarc)
1740                            || (layout.labeltype == LABEL_STATIC
1741                                && layout.latextype == LATEX_ENVIRONMENT
1742                                && !text_->isFirstInSequence(pit))) {
1743                         l_margin += lfm.signedWidth(layout.leftmargin);
1744                 } else if (!layout.labelIsAbove()) {
1745                         l_margin += lfm.signedWidth(layout.labelindent);
1746                         l_margin += lfm.width(layout.labelsep);
1747                         l_margin += lfm.width(par.labelString());
1748                 }
1749                 break;
1750
1751         case MARGIN_RIGHT_ADDRESS_BOX: {
1752 #if 0
1753                 // The left margin depends on the widest row in this paragraph.
1754                 // This code is wrong because it depends on the rows, but at the
1755                 // same time this function is used in redoParagraph to construct
1756                 // the rows.
1757                 ParagraphMetrics const & pm = par_metrics_[pit];
1758                 RowList::const_iterator rit = pm.rows().begin();
1759                 RowList::const_iterator end = pm.rows().end();
1760                 int minfill = max_width;
1761                 for ( ; rit != end; ++rit)
1762                         if (rit->fill() < minfill)
1763                                 minfill = rit->fill();
1764                 l_margin += bfm.signedWidth(layout.leftmargin);
1765                 l_margin += minfill;
1766 #endif
1767                 // also wrong, but much shorter.
1768                 l_margin += max_width / 2;
1769                 break;
1770         }
1771         }
1772
1773         if (!par.params().leftIndent().zero())
1774                 l_margin += par.params().leftIndent().inPixels(max_width, lfm.em());
1775
1776         LyXAlignment align;
1777
1778         if (par.params().align() == LYX_ALIGN_LAYOUT)
1779                 align = layout.align;
1780         else
1781                 align = par.params().align();
1782
1783         // set the correct parindent
1784         if (pos == 0
1785             && (layout.labeltype == LABEL_NO_LABEL
1786                 || layout.labeltype == LABEL_ABOVE
1787                 || layout.labeltype == LABEL_CENTERED
1788                 || (layout.labeltype == LABEL_STATIC
1789                     && layout.latextype == LATEX_ENVIRONMENT
1790                     && !text_->isFirstInSequence(pit)))
1791             && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1792             && !par.params().noindent()
1793             // in some insets, paragraphs are never indented
1794             && !text_->inset().neverIndent()
1795             // display style insets are always centered, omit indentation
1796             && !(!par.empty()
1797                  && par.isInset(pos)
1798                  && par.getInset(pos)->display())
1799             && (!(tclass.isDefaultLayout(par.layout())
1800                   || tclass.isPlainLayout(par.layout()))
1801                 || buffer.params().paragraph_separation
1802                                 == BufferParams::ParagraphIndentSeparation)) {
1803                         // use the parindent of the layout when the
1804                         // default indentation is used otherwise use
1805                         // the indentation set in the document
1806                         // settings
1807                         if (buffer.params().getIndentation().asLyXCommand() == "default")
1808                                 l_margin += bfm.signedWidth(parindent);
1809                         else
1810                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1811                 }
1812
1813         return l_margin;
1814 }
1815
1816
1817 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1818 {
1819         if (par_metrics_.empty())
1820                 return;
1821
1822         origin_.x_ = x;
1823         origin_.y_ = y;
1824
1825         ParMetricsCache::iterator it = par_metrics_.begin();
1826         ParMetricsCache::iterator const pm_end = par_metrics_.end();
1827         y -= it->second.ascent();
1828         for (; it != pm_end; ++it) {
1829                 ParagraphMetrics const & pmi = it->second;
1830                 y += pmi.ascent();
1831                 pit_type const pit = it->first;
1832                 // Save the paragraph position in the cache.
1833                 it->second.setPosition(y);
1834                 drawParagraph(pi, pit, x, y);
1835                 y += pmi.descent();
1836         }
1837 }
1838
1839
1840 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1841 {
1842         ParagraphMetrics const & pm = par_metrics_[pit];
1843         if (pm.rows().empty())
1844                 return;
1845         size_t const nrows = pm.rows().size();
1846
1847         // Use fast lane when drawing is disabled.
1848         if (!pi.pain.isDrawingEnabled()) {
1849                 for (size_t i = 0; i != nrows; ++i) {
1850
1851                         Row const & row = pm.rows()[i];
1852                         // Adapt to cursor row scroll offset if applicable.
1853                         int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1854                         if (i)
1855                                 y += row.ascent();
1856
1857                         RowPainter rp(pi, *text_, row, row_x, y);
1858
1859                         rp.paintOnlyInsets();
1860                         y += row.descent();
1861                 }
1862                 return;
1863         }
1864
1865         int const ww = bv_->workHeight();
1866         Cursor const & cur = bv_->cursor();
1867         DocIterator sel_beg = cur.selectionBegin();
1868         DocIterator sel_end = cur.selectionEnd();
1869         bool selection = cur.selection()
1870                 // This is our text.
1871                 && cur.text() == text_
1872                 // if the anchor is outside, this is not our selection
1873                 && cur.normalAnchor().text() == text_
1874                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1875
1876         // We store the begin and end pos of the selection relative to this par
1877         DocIterator sel_beg_par = cur.selectionBegin();
1878         DocIterator sel_end_par = cur.selectionEnd();
1879
1880         // We care only about visible selection.
1881         if (selection) {
1882                 if (pit != sel_beg.pit()) {
1883                         sel_beg_par.pit() = pit;
1884                         sel_beg_par.pos() = 0;
1885                 }
1886                 if (pit != sel_end.pit()) {
1887                         sel_end_par.pit() = pit;
1888                         sel_end_par.pos() = sel_end_par.lastpos();
1889                 }
1890         }
1891
1892         for (size_t i = 0; i != nrows; ++i) {
1893
1894                 Row const & row = pm.rows()[i];
1895                 // Adapt to cursor row scroll offset if applicable.
1896                 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1897                 if (i)
1898                         y += row.ascent();
1899
1900                 RowPainter rp(pi, *text_, row, row_x, y);
1901
1902                 // It is not needed to draw on screen if we are not inside.
1903                 bool const inside = (y + row.descent() >= 0
1904                         && y - row.ascent() < ww);
1905                 pi.pain.setDrawingEnabled(inside);
1906                 if (!inside) {
1907                         // Paint only the insets to set inset cache correctly
1908                         // FIXME: remove paintOnlyInsets when we know that positions
1909                         // have already been set.
1910                         rp.paintOnlyInsets();
1911                         y += row.descent();
1912                         continue;
1913                 }
1914
1915                 if (selection)
1916                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1917                 else
1918                         row.setSelection(-1, -1);
1919
1920                 // The row knows nothing about the paragraph, so we have to check
1921                 // whether this row is the first or last and update the margins.
1922                 if (row.selection()) {
1923                         if (row.sel_beg == 0)
1924                                 row.begin_margin_sel = sel_beg.pit() < pit;
1925                         if (row.sel_end == sel_end_par.lastpos())
1926                                 row.end_margin_sel = sel_end.pit() > pit;
1927                 }
1928
1929                 // Row signature; has row changed since last paint?
1930                 row.setCrc(pm.computeRowSignature(row, *bv_));
1931                 bool row_has_changed = row.changed()
1932                         || bv_->hadHorizScrollOffset(text_, pit, row.pos());
1933
1934                 // Take this opportunity to spellcheck the row contents.
1935                 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1936                         text_->getPar(pit).spellCheck();
1937                 }
1938
1939                 // Don't paint the row if a full repaint has not been requested
1940                 // and if it has not changed.
1941                 if (!pi.full_repaint && !row_has_changed) {
1942                         // Paint only the insets if the text itself is
1943                         // unchanged.
1944                         rp.paintOnlyInsets();
1945                         y += row.descent();
1946                         continue;
1947                 }
1948
1949                 // Clear background of this row if paragraph background was not
1950                 // already cleared because of a full repaint.
1951                 if (!pi.full_repaint && row_has_changed) {
1952                         LYXERR(Debug::PAINTING, "Clear rect@("
1953                                << max(row_x, 0) << ", " << y - row.ascent() << ")="
1954                                << width() << " x " << row.height());
1955                         pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1956                                 width(), row.height(), pi.background_color);
1957                 }
1958
1959                 // Instrumentation for testing row cache (see also
1960                 // 12 lines lower):
1961                 if (lyxerr.debugging(Debug::PAINTING)
1962                         && (row.selection() || pi.full_repaint || row_has_changed)) {
1963                                 string const foreword = text_->isMainText() ?
1964                                         "main text redraw " : "inset text redraw: ";
1965                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1966                                 << " row_selection="    << row.selection()
1967                                 << " full_repaint="     << pi.full_repaint
1968                                 << " row_has_changed="  << row_has_changed
1969                                 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1970                 }
1971
1972                 // Backup full_repaint status and force full repaint
1973                 // for inner insets as the Row has been cleared out.
1974                 bool tmp = pi.full_repaint;
1975                 pi.full_repaint = true;
1976
1977                 rp.paintSelection();
1978                 rp.paintAppendix();
1979                 rp.paintDepthBar();
1980                 rp.paintChangeBar();
1981                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1982                 if (i == 0 && !is_rtl)
1983                         rp.paintFirst();
1984                 if (i == nrows - 1 && is_rtl)
1985                         rp.paintLast();
1986                 rp.paintText();
1987                 if (i == nrows - 1 && !is_rtl)
1988                         rp.paintLast();
1989                 if (i == 0 && is_rtl)
1990                         rp.paintFirst();
1991                 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1992                                       row_x + row.right_x() > bv_->workWidth());
1993                 y += row.descent();
1994
1995                 // Restore full_repaint status.
1996                 pi.full_repaint = tmp;
1997         }
1998         // Re-enable screen drawing for future use of the painter.
1999         pi.pain.setDrawingEnabled(true);
2000
2001         //LYXERR(Debug::PAINTING, ".");
2002 }
2003
2004
2005 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2006         Dimension & dim) const
2007 {
2008         Cursor const & bvcur = cur.bv().cursor();
2009
2010         // get word in front of cursor
2011         docstring word = text_->previousWord(bvcur.top());
2012         DocIterator wordStart = bvcur;
2013         wordStart.pos() -= word.length();
2014
2015         // calculate dimensions of the word
2016         Row row;
2017         row.pit(bvcur.pit());
2018         row.pos(wordStart.pos());
2019         row.endpos(bvcur.pos());
2020         setRowHeight(row);
2021         dim = row.dimension();
2022
2023         // get position on screen of the word start and end
2024         //FIXME: Is it necessary to explicitly set this to false?
2025         wordStart.boundary(false);
2026         Point lxy = cur.bv().getPos(wordStart);
2027         Point rxy = cur.bv().getPos(bvcur);
2028         dim.wid = abs(rxy.x_ - lxy.x_);
2029
2030         // calculate position of word
2031         y = lxy.y_;
2032         x = min(rxy.x_, lxy.x_);
2033
2034         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2035         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2036 }
2037
2038 int defaultRowHeight()
2039 {
2040         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
2041 }
2042
2043 } // namespace lyx