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