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