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