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
  84 int numberOfHfills(Row const & row, pos_type const body_pos)
  85 {
  86         int n = 0;
  87         Row::const_iterator cit = row.begin();
  88         Row::const_iterator const end = row.end();
  89         for ( ; cit != end ; ++cit)
  90                 if (cit->pos >= body_pos
  91                     && cit->inset && cit->inset->isHfill())
  92                         ++n;
  93         return n;
  94 }
  95
  96
  97 }
  98
  99 /////////////////////////////////////////////////////////////////////
 100 //
 101 // TextMetrics
 102 //
 103 /////////////////////////////////////////////////////////////////////
 104
 105
 106 TextMetrics::TextMetrics(BufferView * bv, Text * text)
 107         : bv_(bv), text_(text)
 108 {
 109         LBUFERR(bv_);
 110         max_width_ = bv_->workWidth();
 111         dim_.wid = max_width_;
 112         dim_.asc = 10;
 113         dim_.des = 10;
 114 }
 115
 116
 117 bool TextMetrics::contains(pit_type pit) const
 118 {
 119         return par_metrics_.find(pit) != par_metrics_.end();
 120 }
 121
 122
 123 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
 124 {
 125         return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
 126 }
 127
 128
 129
 130 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
 131 {
 132         ParMetricsCache::const_iterator it = par_metrics_.begin();
 133         return make_pair(it->first, &it->second);
 134 }
 135
 136
 137 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
 138 {
 139         LBUFERR(!par_metrics_.empty());
 140         ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
 141         return make_pair(it->first, &it->second);
 142 }
 143
 144
 145 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
 146 {
 147         ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
 148         if (pmc_it == par_metrics_.end()) {
 149                 pmc_it = par_metrics_.insert(
 150                         make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
 151         }
 152         if (pmc_it->second.rows().empty() && redo)
 153                 redoParagraph(pit);
 154         return pmc_it->second;
 155 }
 156
 157
 158 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
 159 {
 160         LBUFERR(mi.base.textwidth > 0);
 161         max_width_ = mi.base.textwidth;
 162         // backup old dimension.
 163         Dimension const old_dim = dim_;
 164         // reset dimension.
 165         dim_ = Dimension();
 166         dim_.wid = min_width;
 167         pit_type const npar = text_->paragraphs().size();
 168         if (npar > 1)
 169                 // If there is more than one row, expand the text to
 170                 // the full allowable width.
 171                 dim_.wid = max_width_;
 172
 173         //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
 174         //      << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
 175
 176         bool changed = false;
 177         unsigned int h = 0;
 178         for (pit_type pit = 0; pit != npar; ++pit) {
 179                 changed |= redoParagraph(pit);
 180                 ParagraphMetrics const & pm = par_metrics_[pit];
 181                 h += pm.height();
 182                 if (dim_.wid < pm.width())
 183                         dim_.wid = pm.width();
 184         }
 185
 186         dim_.asc = par_metrics_[0].ascent();
 187         dim_.des = h - dim_.asc;
 188         //lyxerr << "dim_.wid " << dim_.wid << endl;
 189         //lyxerr << "dim_.asc " << dim_.asc << endl;
 190         //lyxerr << "dim_.des " << dim_.des << endl;
 191
 192         changed |= dim_ != old_dim;
 193         dim = dim_;
 194         return changed;
 195 }
 196
 197
 198 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
 199 {
 200         return main_text_? pm.rightMargin(*bv_) : 0;
 201 }
 202
 203
 204 int TextMetrics::rightMargin(pit_type const pit) const
 205 {
 206         return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
 207 }
 208
 209
 210 void TextMetrics::applyOuterFont(Font & font) const
 211 {
 212         FontInfo lf(font_.fontInfo());
 213         lf.reduce(bv_->buffer().params().getFont().fontInfo());
 214         font.fontInfo().realize(lf);
 215 }
 216
 217
 218 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
 219 {
 220         LASSERT(pos >= 0, { static Font f; return f; });
 221
 222         ParagraphList const & pars = text_->paragraphs();
 223         Paragraph const & par = pars[pit];
 224         Layout const & layout = par.layout();
 225         Buffer const & buffer = bv_->buffer();
 226         // FIXME: broken?
 227         BufferParams const & params = buffer.params();
 228         pos_type const body_pos = par.beginOfBody();
 229
 230         // We specialize the 95% common case:
 231         if (!par.getDepth()) {
 232                 Font f = par.getFontSettings(params, pos);
 233                 if (!text_->isMainText())
 234                         applyOuterFont(f);
 235                 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
 236
 237                 FontInfo const & lf = lab ? layout.labelfont : layout.font;
 238                 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
 239
 240                 // In case the default family has been customized
 241                 if (lf.family() == INHERIT_FAMILY)
 242                         rlf.setFamily(params.getFont().fontInfo().family());
 243                 f.fontInfo().realize(rlf);
 244                 return f;
 245         }
 246
 247         // The uncommon case need not be optimized as much
 248         FontInfo const & layoutfont = pos < body_pos ?
 249                 layout.labelfont : layout.font;
 250
 251         Font font = par.getFontSettings(params, pos);
 252         font.fontInfo().realize(layoutfont);
 253
 254         if (!text_->isMainText())
 255                 applyOuterFont(font);
 256
 257         // Realize against environment font information
 258         // NOTE: the cast to pit_type should be removed when pit_type
 259         // changes to a unsigned integer.
 260         if (pit < pit_type(pars.size()))
 261                 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
 262
 263         // Realize with the fonts of lesser depth.
 264         font.fontInfo().realize(params.getFont().fontInfo());
 265
 266         return font;
 267 }
 268
 269
 270 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
 271 {
 272         if (!sl.text())
 273                 return false;
 274
 275         int correction = 0;
 276         if (boundary && sl.pos() > 0)
 277                 correction = -1;
 278
 279         return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
 280 }
 281
 282
 283 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
 284 {
 285         // no RTL boundary at paragraph start
 286         if (pos == 0)
 287                 return false;
 288
 289         Font const & left_font = displayFont(pit, pos - 1);
 290
 291         return isRTLBoundary(pit, pos, left_font);
 292 }
 293
 294
 295 // isRTLBoundary returns false on a real end-of-line boundary,
 296 // because otherwise the two boundary types get mixed up.
 297 // This is the whole purpose of this being in TextMetrics.
 298 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
 299                 Font const & font) const
 300 {
 301         if (// no RTL boundary at paragraph start
 302             pos == 0
 303             // if the metrics have not been calculated, then we are not
 304             // on screen and can safely ignore issues about boundaries.
 305             || !contains(pit))
 306                 return false;
 307
 308         ParagraphMetrics & pm = par_metrics_[pit];
 309         // no RTL boundary in empty paragraph
 310         if (pm.rows().empty())
 311                 return false;
 312
 313         pos_type endpos = pm.getRow(pos - 1, false).endpos();
 314         pos_type startpos = pm.getRow(pos, false).pos();
 315         // no RTL boundary at line start:
 316         // abc\n   -> toggle to RTL ->    abc\n     (and not:    abc\n|
 317         // |                              |                               )
 318         if (pos == startpos && pos == endpos) // start of cur row, end of prev row
 319                 return false;
 320
 321         Paragraph const & par = text_->getPar(pit);
 322         // no RTL boundary at line break:
 323         // abc|\n    -> move right ->   abc\n       (and not:    abc\n|
 324         // FED                          FED|                     FED     )
 325         if (startpos == pos && endpos == pos && endpos != par.size()
 326                 && (par.isNewline(pos - 1)
 327                         || par.isEnvSeparator(pos - 1)
 328                         || par.isLineSeparator(pos - 1)
 329                         || par.isSeparator(pos - 1)))
 330                 return false;
 331
 332         bool left = font.isVisibleRightToLeft();
 333         bool right;
 334         if (pos == par.size())
 335                 right = par.isRTL(bv_->buffer().params());
 336         else
 337                 right = displayFont(pit, pos).isVisibleRightToLeft();
 338
 339         return left != right;
 340 }
 341
 342
 343 bool TextMetrics::redoParagraph(pit_type const pit)
 344 {
 345         Paragraph & par = text_->getPar(pit);
 346         // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
 347         // redoParagraph() recursively inside parMetrics.
 348         Dimension old_dim = parMetrics(pit, false).dim();
 349         ParagraphMetrics & pm = par_metrics_[pit];
 350         pm.reset(par);
 351
 352         Buffer & buffer = bv_->buffer();
 353         main_text_ = (text_ == &buffer.text());
 354         bool changed = false;
 355
 356         // Check whether there are InsetBibItems that need fixing
 357         // FIXME: This check ought to be done somewhere else. It is the reason
 358         // why text_ is not const. But then, where else to do it?
 359         // Well, how can you end up with either (a) a biblio environment that
 360         // has no InsetBibitem or (b) a biblio environment with more than one
 361         // InsetBibitem? I think the answer is: when paragraphs are merged;
 362         // when layout is set; when material is pasted.
 363         if (par.brokenBiblio()) {
 364                 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
 365                 // In some cases, we do not know how to record undo
 366                 if (&cur.inset() == &text_->inset())
 367                         cur.recordUndo(pit, pit);
 368
 369                 int const moveCursor = par.fixBiblio(buffer);
 370
 371                 // Is it necessary to update the cursor?
 372                 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
 373                         if (moveCursor > 0)
 374                                 cur.posForward();
 375                         else if (moveCursor < 0 && cur.pos() >= -moveCursor)
 376                                 cur.posBackward();
 377                 }
 378         }
 379
 380         // Optimisation: this is used in the next two loops
 381         // so better to calculate that once here.
 382         int const right_margin = rightMargin(pm);
 383
 384         // iterator pointing to paragraph to resolve macros
 385         DocIterator parPos = text_->macrocontextPosition();
 386         if (!parPos.empty())
 387                 parPos.pit() = pit;
 388         else {
 389                 LYXERR(Debug::INFO, "MacroContext not initialised!"
 390                         << " Going through the buffer again and hope"
 391                         << " the context is better then.");
 392                 // FIXME audit updateBuffer calls
 393                 // This should not be here, but it is not clear yet where else it
 394                 // should be.
 395                 bv_->buffer().updateBuffer();
 396                 parPos = text_->macrocontextPosition();
 397                 LBUFERR(!parPos.empty());
 398                 parPos.pit() = pit;
 399         }
 400
 401         // redo insets
 402         Font const bufferfont = buffer.params().getFont();
 403         CoordCache::Insets & insetCache = bv_->coordCache().insets();
 404         InsetList::const_iterator ii = par.insetList().begin();
 405         InsetList::const_iterator iend = par.insetList().end();
 406         for (; ii != iend; ++ii) {
 407                 // FIXME Doesn't this HAVE to be non-empty?
 408                 // position already initialized?
 409                 if (!parPos.empty()) {
 410                         parPos.pos() = ii->pos;
 411
 412                         // A macro template would normally not be visible
 413                         // by itself. But the tex macro semantics allow
 414                         // recursion, so we artifically take the context
 415                         // after the macro template to simulate this.
 416                         if (ii->inset->lyxCode() == MATHMACRO_CODE)
 417                                 parPos.pos()++;
 418                 }
 419
 420                 // do the metric calculation
 421                 Dimension dim;
 422                 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
 423                         - right_margin;
 424                 Font const & font = ii->inset->inheritFont() ?
 425                         displayFont(pit, ii->pos) : bufferfont;
 426                 MacroContext mc(&buffer, parPos);
 427                 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
 428                 ii->inset->metrics(mi, dim);
 429                 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
 430                         insetCache.add(ii->inset, dim);
 431                         changed = true;
 432                 }
 433         }
 434
 435         par.setBeginOfBody();
 436         pos_type first = 0;
 437         size_t row_index = 0;
 438         // maximum pixel width of a row
 439         do {
 440                 if (row_index == pm.rows().size())
 441                         pm.rows().push_back(Row());
 442                 Row & row = pm.rows()[row_index];
 443                 row.pos(first);
 444                 breakRow(row, right_margin, pit);
 445                 setRowHeight(row, pit);
 446                 row.setChanged(false);
 447                 if (row_index || row.right_boundary() || row.endpos() < par.size())
 448                         // If there is more than one row or the row has been
 449                         // broken by a display inset or a newline, expand the text
 450                         // to the full allowable width. This setting here is
 451                         // needed for the computeRowMetrics() below.
 452                         dim_.wid = max_width_;
 453                 int const max_row_width = max(dim_.wid, row.width());
 454                 computeRowMetrics(pit, row, max_row_width);
 455                 first = row.endpos();
 456                 ++row_index;
 457
 458                 pm.dim().wid = max(pm.dim().wid, row.width());
 459                 pm.dim().des += row.height();
 460         } while (first < par.size());
 461
 462         if (row_index < pm.rows().size())
 463                 pm.rows().resize(row_index);
 464
 465         // Make sure that if a par ends in newline, there is one more row
 466         // under it
 467         if (first > 0 && par.isNewline(first - 1)) {
 468                 if (row_index == pm.rows().size())
 469                         pm.rows().push_back(Row());
 470                 Row & row = pm.rows()[row_index];
 471                 row.pos(first);
 472                 row.endpos(first);
 473                 setRowHeight(row, pit);
 474                 row.setChanged(false);
 475                 int const max_row_width = max(dim_.wid, row.width());
 476                 computeRowMetrics(pit, row, max_row_width);
 477                 pm.dim().des += row.height();
 478         }
 479
 480         pm.dim().asc += pm.rows()[0].ascent();
 481         pm.dim().des -= pm.rows()[0].ascent();
 482
 483         changed |= old_dim.height() != pm.dim().height();
 484
 485         return changed;
 486 }
 487
 488
 489 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
 490 {
 491         Layout const & layout = par.layout();
 492
 493         LyXAlignment align;
 494         if (par.params().align() == LYX_ALIGN_LAYOUT)
 495                 align = layout.align;
 496         else
 497                 align = par.params().align();
 498
 499         // handle alignment inside tabular cells
 500         Inset const & owner = text_->inset();
 501         bool forced_block = false;
 502         switch (owner.contentAlignment()) {
 503         case LYX_ALIGN_BLOCK:
 504                 // In general block align is the default state, but here it is
 505                 // an explicit choice. Therefore it should not be overridden
 506                 // later.
 507                 forced_block = true;
 508                 // fall through
 509         case LYX_ALIGN_CENTER:
 510         case LYX_ALIGN_LEFT:
 511         case LYX_ALIGN_RIGHT:
 512                 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
 513                         align = owner.contentAlignment();
 514                 break;
 515         default:
 516                 // unchanged (use align)
 517                 break;
 518         }
 519
 520         // Display-style insets should always be on a centered row
 521         if (Inset const * inset = par.getInset(row.pos())) {
 522                 switch (inset->display()) {
 523                 case Inset::AlignLeft:
 524                         align = LYX_ALIGN_BLOCK;
 525                         break;
 526                 case Inset::AlignCenter:
 527                         align = LYX_ALIGN_CENTER;
 528                         break;
 529                 case Inset::Inline:
 530                         // unchanged (use align)
 531                         break;
 532                 case Inset::AlignRight:
 533                         align = LYX_ALIGN_RIGHT;
 534                         break;
 535                 }
 536         }
 537
 538         if (align == LYX_ALIGN_BLOCK) {
 539                 // If this row has been broken abruptly by a display inset, or
 540                 // it is the end of the paragraph, or the user requested we
 541                 // not justify stuff, then don't stretch.
 542                 // A forced block alignment can only be overridden the 'no
 543                 // justification on screen' setting.
 544                 if (((row.right_boundary() || row.endpos() == par.size())
 545                      && !forced_block)
 546                     || !bv_->buffer().params().justification)
 547                         align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
 548         }
 549
 550         return align;
 551 }
 552
 553
 554 void TextMetrics::computeRowMetrics(pit_type const pit,
 555                 Row & row, int width) const
 556 {
 557         row.label_hfill = 0;
 558         row.separator = 0;
 559
 560         Paragraph const & par = text_->getPar(pit);
 561
 562         int const w = width - row.right_margin - row.width();
 563         // FIXME: put back this assertion when the crash on new doc is solved.
 564         //LASSERT(w >= 0, /**/);
 565
 566         // is there a manual margin with a manual label
 567         Layout const & layout = par.layout();
 568
 569         int nlh = 0;
 570         if (layout.margintype == MARGIN_MANUAL
 571             && layout.labeltype == LABEL_MANUAL) {
 572                 /// We might have real hfills in the label part
 573                 nlh = numberOfLabelHfills(par, row);
 574
 575                 // A manual label par (e.g. List) has an auto-hfill
 576                 // between the label text and the body of the
 577                 // paragraph too.
 578                 // But we don't want to do this auto hfill if the par
 579                 // is empty.
 580                 if (!par.empty())
 581                         ++nlh;
 582
 583                 if (nlh && !par.getLabelWidthString().empty())
 584                         row.label_hfill = labelFill(pit, row) / double(nlh);
 585         }
 586
 587         double hfill = 0;
 588         // are there any hfills in the row?
 589         if (int const nh = numberOfHfills(row, par.beginOfBody())) {
 590                 if (w > 0)
 591                         hfill = double(w) / nh;
 592         // we don't have to look at the alignment if it is ALIGN_LEFT and
 593         // if the row is already larger then the permitted width as then
 594         // we force the LEFT_ALIGN'edness!
 595         } else if (int(row.width()) < max_width_) {
 596                 // is it block, flushleft or flushright?
 597                 // set x how you need it
 598                 switch (getAlign(par, row)) {
 599                 case LYX_ALIGN_BLOCK: {
 600                         int const ns = row.countSeparators();
 601                         // If we have separators, then stretch the row
 602                         if (ns) {
 603                                 row.setSeparatorExtraWidth(double(w) / ns);
 604                                 row.dimension().wid += w;
 605                         } else if (text_->isRTL(par)) {
 606                                 row.left_margin += w;
 607                                 row.dimension().wid += w;
 608                         }
 609                         break;
 610                 }
 611                 case LYX_ALIGN_RIGHT:
 612                         row.left_margin += w;
 613                         row.dimension().wid += w;
 614                         break;
 615                 case LYX_ALIGN_CENTER:
 616                         row.dimension().wid += w / 2;
 617                         row.left_margin += w / 2;
 618                         break;
 619                 case LYX_ALIGN_LEFT:
 620                 case LYX_ALIGN_NONE:
 621                 case LYX_ALIGN_LAYOUT:
 622                 case LYX_ALIGN_SPECIAL:
 623                 case LYX_ALIGN_DECIMAL:
 624                         break;
 625                 }
 626         }
 627
 628         // Finally,  handle hfill insets
 629         pos_type const endpos = row.endpos();
 630         pos_type body_pos = par.beginOfBody();
 631         if (body_pos > 0
 632             && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
 633                 body_pos = 0;
 634         ParagraphMetrics & pm = par_metrics_[pit];
 635         CoordCache::Insets & insetCache = bv_->coordCache().insets();
 636         Row::iterator cit = row.begin();
 637         Row::iterator const cend = row.end();
 638         for ( ; cit != cend; ++cit) {
 639                 if (row.label_hfill && cit->endpos == body_pos
 640                     && cit->type == Row::SPACE)
 641                         cit->dim.wid -= int(row.label_hfill * (nlh - 1));
 642                 if (!cit->inset || !cit->inset->isHfill())
 643                         continue;
 644                 if (pm.hfillExpansion(row, cit->pos))
 645                         cit->dim.wid = int(cit->pos >= body_pos ?
 646                                            max(hfill, 5.0) : row.label_hfill);
 647                 else
 648                         cit->dim.wid = 5;
 649                 // Cache the inset dimension.
 650                 insetCache.add(cit->inset, cit->dim);
 651         }
 652 }
 653
 654
 655 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
 656 {
 657         Paragraph const & par = text_->getPar(pit);
 658         LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
 659
 660         int w = 0;
 661         Row::const_iterator cit = row.begin();
 662         Row::const_iterator const end = row.end();
 663         // iterate over elements before main body (except the last one,
 664         // which is extra space).
 665         while (cit!= end && cit->endpos < par.beginOfBody()) {
 666                 w += cit->dim.wid;
 667                 ++cit;
 668         }
 669
 670         docstring const & label = par.params().labelWidthString();
 671         if (label.empty())
 672                 return 0;
 673
 674         FontMetrics const & fm
 675                 = theFontMetrics(text_->labelFont(par));
 676
 677         return max(0, fm.width(label) - w);
 678 }
 679
 680
 681 #if 0
 682 // Not used, see TextMetrics::breakRow
 683 // this needs special handling - only newlines count as a break point
 684 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
 685 {
 686         pos_type const end = par.size();
 687
 688         for (; i < end; ++i)
 689                 if (par.isNewline(i))
 690                         return i + 1;
 691
 692         return end;
 693 }
 694 #endif
 695
 696
 697 int TextMetrics::labelEnd(pit_type const pit) const
 698 {
 699         // labelEnd is only needed if the layout fills a flushleft label.
 700         if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
 701                 return 0;
 702         // return the beginning of the body
 703         return leftMargin(max_width_, pit);
 704 }
 705
 706 namespace {
 707
 708 /**
 709  * Calling Text::getFont is slow. While rebreaking we scan a
 710  * paragraph from left to right calling getFont for every char.  This
 711  * simple class address this problem by hidding an optimization trick
 712  * (not mine btw -AB): the font is reused in the whole font span.  The
 713  * class handles transparently the "hidden" (not part of the fontlist)
 714  * label font (as getFont does).
 715  **/
 716 class FontIterator
 717 {
 718 public:
 719         ///
 720         FontIterator(TextMetrics const & tm,
 721                 Paragraph const & par, pit_type pit, pos_type pos)
 722                 : tm_(tm), par_(par), pit_(pit), pos_(pos),
 723                 font_(tm.displayFont(pit, pos)),
 724                 endspan_(par.fontSpan(pos).last),
 725                 bodypos_(par.beginOfBody())
 726         {}
 727
 728         ///
 729         Font const & operator*() const { return font_; }
 730
 731         ///
 732         FontIterator & operator++()
 733         {
 734                 ++pos_;
 735                 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
 736                         font_ = tm_.displayFont(pit_, pos_);
 737                         endspan_ = par_.fontSpan(pos_).last;
 738                 }
 739                 return *this;
 740         }
 741
 742         ///
 743         Font * operator->() { return &font_; }
 744
 745 private:
 746         ///
 747         TextMetrics const & tm_;
 748         ///
 749         Paragraph const & par_;
 750         ///
 751         pit_type pit_;
 752         ///
 753         pos_type pos_;
 754         ///
 755         Font font_;
 756         ///
 757         pos_type endspan_;
 758         ///
 759         pos_type bodypos_;
 760 };
 761
 762 } // anon namespace
 763
 764 /** This is the function where the hard work is done. The code here is
 765  * very sensitive to small changes :) Note that part of the
 766  * intelligence is also in Row::shortenIfNeeded.
 767  */
 768 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
 769 {
 770         Paragraph const & par = text_->getPar(pit);
 771         pos_type const end = par.size();
 772         pos_type const pos = row.pos();
 773         pos_type const body_pos = par.beginOfBody();
 774         bool const is_rtl = text_->isRTL(par);
 775
 776         row.clear();
 777         row.left_margin = leftMargin(max_width_, pit, pos);
 778         row.right_margin = right_margin;
 779         if (is_rtl)
 780                 swap(row.left_margin, row.right_margin);
 781         // Remember that the row width takes into account the left_margin
 782         // but not the right_margin.
 783         row.dimension().wid = row.left_margin;
 784         // the width available for the row.
 785         int const width = max_width_ - row.right_margin;
 786
 787         if (pos >= end || row.width() > width) {
 788                 row.endpos(end);
 789                 return;
 790         }
 791
 792         ParagraphList const & pars = text_->paragraphs();
 793
 794 #if 0
 795         //FIXME: As long as leftMargin() is not correctly implemented for
 796         // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
 797         // Otherwise, long rows will be painted off the screen.
 798         if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
 799                 return addressBreakPoint(pos, par);
 800 #endif
 801
 802         // check for possible inline completion
 803         DocIterator const & ic_it = bv_->inlineCompletionPos();
 804         pos_type ic_pos = -1;
 805         if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
 806                 ic_pos = ic_it.pos();
 807
 808         // Now we iterate through until we reach the right margin
 809         // or the end of the par, then build a representation of the row.
 810         pos_type i = pos;
 811         FontIterator fi = FontIterator(*this, par, pit, pos);
 812         while (i < end && row.width() <= width) {
 813                 char_type c = par.getChar(i);
 814                 // The most special cases are handled first.
 815                 if (par.isInset(i)) {
 816                         Inset const * ins = par.getInset(i);
 817                         Dimension dim = bv_->coordCache().insets().dim(ins);
 818                         row.add(i, ins, dim, *fi, par.lookupChange(i));
 819                 } else if (c == ' ' && i + 1 == body_pos) {
 820                         // There is a space at i, but it should not be
 821                         // added as a separator, because it is just
 822                         // before body_pos. Instead, insert some spacing to
 823                         // align text
 824                         FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
 825                         // this is needed to make sure that the row width is correct
 826                         row.finalizeLast();
 827                         int const add = max(fm.width(par.layout().labelsep),
 828                                             labelEnd(pit) - row.width());
 829                         row.addSpace(i, add, *fi, par.lookupChange(i));
 830                 } else if (c == '\t')
 831                         row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
 832                                      *fi, par.lookupChange(i));
 833                 else {
 834                         // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
 835                         // see also Paragraph::getUChar.
 836                         if (fi->language()->lang() == "hebrew") {
 837                                 if (c == '(')
 838                                         c = ')';
 839                                 else if (c == ')')
 840                                         c = '(';
 841                         }
 842                         row.add(i, c, *fi, par.lookupChange(i));
 843                 }
 844
 845                 // add inline completion width
 846                 // draw logically behind the previous character
 847                 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
 848                         docstring const comp = bv_->inlineCompletion();
 849                         size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
 850                         Font f = *fi;
 851
 852                         if (uniqueTo > 0) {
 853                                 f.fontInfo().setColor(Color_inlinecompletion);
 854                                 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
 855                         }
 856                         f.fontInfo().setColor(Color_nonunique_inlinecompletion);
 857                         row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
 858                 }
 859
 860                 // Handle some situations that abruptly terminate the row
 861                 // - A newline inset
 862                 // - Before a display inset
 863                 // - After a display inset
 864                 Inset const * inset = 0;
 865                 if (par.isNewline(i) || par.isEnvSeparator(i)
 866                     || (i + 1 < end && (inset = par.getInset(i + 1))
 867                         && inset->display())
 868                     || (!row.empty() && row.back().inset
 869                         && row.back().inset->display())) {
 870                         row.right_boundary(true);
 871                         ++i;
 872                         break;
 873                 }
 874
 875                 ++i;
 876                 ++fi;
 877         }
 878         row.finalizeLast();
 879         row.endpos(i);
 880
 881         // End of paragraph marker
 882         if (lyxrc.paragraph_markers
 883             && i == end && size_type(pit + 1) < pars.size()) {
 884                 // add a virtual element for the end-of-paragraph
 885                 // marker; it is shown on screen, but does not exist
 886                 // in the paragraph.
 887                 Font f(text_->layoutFont(pit));
 888                 f.fontInfo().setColor(Color_paragraphmarker);
 889                 BufferParams const & bparams
 890                         = text_->inset().buffer().params();
 891                 f.setLanguage(par.getParLanguage(bparams));
 892                 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
 893         }
 894
 895         // if the row is too large, try to cut at last separator.
 896         row.shortenIfNeeded(body_pos, width);
 897
 898         // make sure that the RTL elements are in reverse ordering
 899         row.reverseRTL(is_rtl);
 900         //LYXERR0("breakrow: row is " << row);
 901 }
 902
 903
 904 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
 905                                     bool topBottomSpace) const
 906 {
 907         Paragraph const & par = text_->getPar(pit);
 908         // get the maximum ascent and the maximum descent
 909         double layoutasc = 0;
 910         double layoutdesc = 0;
 911         double const dh = defaultRowHeight();
 912
 913         // ok, let us initialize the maxasc and maxdesc value.
 914         // Only the fontsize count. The other properties
 915         // are taken from the layoutfont. Nicer on the screen :)
 916         Layout const & layout = par.layout();
 917
 918         // as max get the first character of this row then it can
 919         // increase but not decrease the height. Just some point to
 920         // start with so we don't have to do the assignment below too
 921         // often.
 922         Buffer const & buffer = bv_->buffer();
 923         Font font = displayFont(pit, row.pos());
 924         FontSize const tmpsize = font.fontInfo().size();
 925         font.fontInfo() = text_->layoutFont(pit);
 926         FontSize const size = font.fontInfo().size();
 927         font.fontInfo().setSize(tmpsize);
 928
 929         FontInfo labelfont = text_->labelFont(par);
 930
 931         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 932         FontMetrics const & fontmetrics = theFontMetrics(font);
 933
 934         // these are minimum values
 935         double const spacing_val = layout.spacing.getValue()
 936                 * text_->spacing(par);
 937         //lyxerr << "spacing_val = " << spacing_val << endl;
 938         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
 939         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
 940
 941         // insets may be taller
 942         CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
 943         Row::const_iterator cit = row.begin();
 944         Row::const_iterator cend = row.end();
 945         for ( ; cit != cend; ++cit) {
 946                 if (cit->inset) {
 947                         Dimension const & dim = insetCache.dim(cit->inset);
 948                         maxasc  = max(maxasc,  dim.ascent());
 949                         maxdesc = max(maxdesc, dim.descent());
 950                 }
 951         }
 952
 953         // Check if any custom fonts are larger (Asger)
 954         // This is not completely correct, but we can live with the small,
 955         // cosmetic error for now.
 956         int labeladdon = 0;
 957
 958         FontSize maxsize =
 959                 par.highestFontInRange(row.pos(), row.endpos(), size);
 960         if (maxsize > font.fontInfo().size()) {
 961                 // use standard paragraph font with the maximal size
 962                 FontInfo maxfont = font.fontInfo();
 963                 maxfont.setSize(maxsize);
 964                 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
 965                 maxasc  = max(maxasc,  maxfontmetrics.maxAscent());
 966                 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
 967         }
 968
 969         // This is nicer with box insets:
 970         ++maxasc;
 971         ++maxdesc;
 972
 973         ParagraphList const & pars = text_->paragraphs();
 974         Inset const & inset = text_->inset();
 975
 976         // is it a top line?
 977         if (row.pos() == 0 && topBottomSpace) {
 978                 BufferParams const & bufparams = buffer.params();
 979                 // some parskips VERY EASY IMPLEMENTATION
 980                 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
 981                     && !inset.getLayout().parbreakIsNewline()
 982                     && !par.layout().parbreak_is_newline
 983                     && pit > 0
 984                     && ((layout.isParagraph() && par.getDepth() == 0)
 985                         || (pars[pit - 1].layout().isParagraph()
 986                             && pars[pit - 1].getDepth() == 0))) {
 987                         maxasc += bufparams.getDefSkip().inPixels(*bv_);
 988                 }
 989
 990                 if (par.params().startOfAppendix())
 991                         maxasc += int(3 * dh);
 992
 993                 // special code for the top label
 994                 if (layout.labelIsAbove()
 995                     && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
 996                     && !par.labelString().empty()) {
 997                         labeladdon = int(
 998                                   labelfont_metrics.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         maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1061
1062         // FIXME: the correct way is to do the following is to move the
1063         // following code in another method specially tailored for the
1064         // main Text. The following test is thus bogus.
1065         // Top and bottom margin of the document (only at top-level)
1066         if (main_text_ && topBottomSpace) {
1067                 if (pit == 0 && row.pos() == 0)
1068                         maxasc += 20;
1069                 if (pit + 1 == pit_type(pars.size()) &&
1070                     row.endpos() == par.size() &&
1071                                 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1072                         maxdesc += 20;
1073         }
1074
1075         row.dimension().asc = maxasc + labeladdon;
1076         row.dimension().des = maxdesc;
1077 }
1078
1079
1080 // x is an absolute screen coord
1081 // returns the column near the specified x-coordinate of the row
1082 // x is set to the real beginning of this column
1083 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1084                                   bool & boundary) const
1085 {
1086         //LYXERR0("getPosNearX(" << x << ") row=" << row);
1087         /// For the main Text, it is possible that this pit is not
1088         /// yet in the CoordCache when moving cursor up.
1089         /// x Paragraph coordinate is always 0 for main text anyway.
1090         int const xo = origin_.x_;
1091         x -= xo;
1092
1093         pos_type pos = row.pos();
1094         boundary = false;
1095         if (row.empty())
1096                 x = row.left_margin;
1097         else if (x <= row.left_margin) {
1098                 pos = row.front().left_pos();
1099                 x = row.left_margin;
1100         } else if (x >= row.width()) {
1101                 pos = row.back().right_pos();
1102                 x = row.width();
1103         } else {
1104                 double w = row.left_margin;
1105                 Row::const_iterator cit = row.begin();
1106                 Row::const_iterator cend = row.end();
1107                 for ( ; cit != cend; ++cit) {
1108                         if (w <= x &&  w + cit->full_width() > x) {
1109                                 int x_offset = int(x - w);
1110                                 pos = cit->x2pos(x_offset);
1111                                 x = int(x_offset + w);
1112                                 break;
1113                         }
1114                         w += cit->full_width();
1115                 }
1116                 if (cit == row.end()) {
1117                         pos = row.back().right_pos();
1118                         x = row.width();
1119                 }
1120                 /** This tests for the case where the cursor is placed
1121                  * just before a font direction change. See comment on
1122                  * the boundary_ member in DocIterator.h to understand
1123                  * how boundary helps here.
1124                  */
1125                 else if (pos == cit->endpos
1126                          && cit + 1 != row.end()
1127                          && cit->isRTL() != (cit + 1)->isRTL())
1128                         boundary = true;
1129         }
1130
1131         /** This tests for the case where the cursor is set at the end
1132          * of a row which has been broken due something else than a
1133          * separator (a display inset or a forced breaking of the
1134          * row). We know that there is a separator when the end of the
1135          * row is larger than the end of its last element.
1136          */
1137         if (!row.empty() && pos == row.back().endpos
1138             && row.back().endpos == row.endpos())
1139                 boundary = true;
1140
1141         x += xo;
1142         //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1143         return pos;
1144 }
1145
1146
1147 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1148 {
1149         // We play safe and use parMetrics(pit) to make sure the
1150         // ParagraphMetrics will be redone and OK to use if needed.
1151         // Otherwise we would use an empty ParagraphMetrics in
1152         // upDownInText() while in selection mode.
1153         ParagraphMetrics const & pm = parMetrics(pit);
1154
1155         LBUFERR(row < int(pm.rows().size()));
1156         bool bound = false;
1157         Row const & r = pm.rows()[row];
1158         return getPosNearX(r, x, bound);
1159 }
1160
1161
1162 void TextMetrics::newParMetricsDown()
1163 {
1164         pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1165         pit_type const pit = last.first + 1;
1166         if (pit == int(text_->paragraphs().size()))
1167                 return;
1168
1169         // do it and update its position.
1170         redoParagraph(pit);
1171         par_metrics_[pit].setPosition(last.second.position()
1172                 + last.second.descent() + par_metrics_[pit].ascent());
1173 }
1174
1175
1176 void TextMetrics::newParMetricsUp()
1177 {
1178         pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1179         if (first.first == 0)
1180                 return;
1181
1182         pit_type const pit = first.first - 1;
1183         // do it and update its position.
1184         redoParagraph(pit);
1185         par_metrics_[pit].setPosition(first.second.position()
1186                 - first.second.ascent() - par_metrics_[pit].descent());
1187 }
1188
1189 // y is screen coordinate
1190 pit_type TextMetrics::getPitNearY(int y)
1191 {
1192         LASSERT(!text_->paragraphs().empty(), return -1);
1193         LASSERT(!par_metrics_.empty(), return -1);
1194         LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1195
1196         // look for highest numbered paragraph with y coordinate less than given y
1197         pit_type pit = -1;
1198         int yy = -1;
1199         ParMetricsCache::const_iterator it = par_metrics_.begin();
1200         ParMetricsCache::const_iterator et = par_metrics_.end();
1201         ParMetricsCache::const_iterator last = et;
1202         --last;
1203
1204         ParagraphMetrics const & pm = it->second;
1205
1206         if (y < it->second.position() - int(pm.ascent())) {
1207                 // We are looking for a position that is before the first paragraph in
1208                 // the cache (which is in priciple off-screen, that is before the
1209                 // visible part.
1210                 if (it->first == 0)
1211                         // We are already at the first paragraph in the inset.
1212                         return 0;
1213                 // OK, this is the paragraph we are looking for.
1214                 pit = it->first - 1;
1215                 newParMetricsUp();
1216                 return pit;
1217         }
1218
1219         ParagraphMetrics const & pm_last = par_metrics_[last->first];
1220
1221         if (y >= last->second.position() + int(pm_last.descent())) {
1222                 // We are looking for a position that is after the last paragraph in
1223                 // the cache (which is in priciple off-screen), that is before the
1224                 // visible part.
1225                 pit = last->first + 1;
1226                 if (pit == int(text_->paragraphs().size()))
1227                         //  We are already at the last paragraph in the inset.
1228                         return last->first;
1229                 // OK, this is the paragraph we are looking for.
1230                 newParMetricsDown();
1231                 return pit;
1232         }
1233
1234         for (; it != et; ++it) {
1235                 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1236                         << " y: " << it->second.position());
1237
1238                 ParagraphMetrics const & pm = par_metrics_[it->first];
1239
1240                 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1241                         pit = it->first;
1242                         yy = it->second.position();
1243                 }
1244         }
1245
1246         LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1247
1248         return pit;
1249 }
1250
1251
1252 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1253         bool assert_in_view, bool up)
1254 {
1255         ParagraphMetrics const & pm = par_metrics_[pit];
1256
1257         int yy = pm.position() - pm.ascent();
1258         LBUFERR(!pm.rows().empty());
1259         RowList::const_iterator rit = pm.rows().begin();
1260         RowList::const_iterator rlast = pm.rows().end();
1261         --rlast;
1262         for (; rit != rlast; yy += rit->height(), ++rit)
1263                 if (yy + rit->height() > y)
1264                         break;
1265
1266         if (assert_in_view) {
1267                 if (!up && yy + rit->height() > y) {
1268                         if (rit != pm.rows().begin()) {
1269                                 y = yy;
1270                                 --rit;
1271                         } else if (pit != 0) {
1272                                 --pit;
1273                                 newParMetricsUp();
1274                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1275                                 rit = pm2.rows().end();
1276                                 --rit;
1277                                 y = yy;
1278                         }
1279                 } else if (up && yy != y) {
1280                         if (rit != rlast) {
1281                                 y = yy + rit->height();
1282                                 ++rit;
1283                         } else if (pit < int(text_->paragraphs().size()) - 1) {
1284                                 ++pit;
1285                                 newParMetricsDown();
1286                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1287                                 rit = pm2.rows().begin();
1288                                 y = pm2.position();
1289                         }
1290                 }
1291         }
1292         return *rit;
1293 }
1294
1295
1296 // x,y are absolute screen coordinates
1297 // sets cursor recursively descending into nested editable insets
1298 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1299         bool assert_in_view, bool up)
1300 {
1301         if (lyxerr.debugging(Debug::WORKAREA)) {
1302                 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1303                 cur.bv().coordCache().dump();
1304         }
1305         pit_type pit = getPitNearY(y);
1306         LASSERT(pit != -1, return 0);
1307
1308         int yy = y; // is modified by getPitAndRowNearY
1309         Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1310
1311         cur.pit() = pit;
1312
1313         // Do we cover an inset?
1314         InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1315
1316         if (!it) {
1317                 // No inset, set position in the text
1318                 bool bound = false; // is modified by getPosNearX
1319                 int xx = x; // is modified by getPosNearX
1320                 cur.pos() = getPosNearX(row, xx, bound);
1321                 cur.boundary(bound);
1322                 cur.setCurrentFont();
1323                 cur.setTargetX(xx);
1324                 return 0;
1325         }
1326
1327         Inset * inset = it->inset;
1328         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1329
1330         // Set position in front of inset
1331         cur.pos() = it->pos;
1332         cur.boundary(false);
1333         cur.setTargetX(x);
1334
1335         // Try to descend recursively inside the inset.
1336         Inset * edited = inset->editXY(cur, x, yy);
1337         if (edited == inset && cur.pos() == it->pos) {
1338                 // non-editable inset, set cursor after the inset if x is
1339                 // nearer to that position (bug 9628)
1340                 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1341                 Dimension const & dim = insetCache.dim(inset);
1342                 Point p = insetCache.xy(inset);
1343                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1344                 if (is_rtl) {
1345                         // "in front of" == "right of"
1346                         if (abs(p.x_ - x) < abs(p.x_ + dim.wid - x))
1347                                 cur.posForward();
1348                 } else {
1349                         // "in front of" == "left of"
1350                         if (abs(p.x_ + dim.wid - x) < abs(p.x_ - x))
1351                                 cur.posForward();
1352                 }
1353         }
1354
1355         if (cur.top().text() == text_)
1356                 cur.setCurrentFont();
1357         return edited;
1358 }
1359
1360
1361 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1362 {
1363         LASSERT(text_ == cur.text(), return);
1364         pit_type const pit = getPitNearY(y);
1365         LASSERT(pit != -1, return);
1366
1367         ParagraphMetrics const & pm = par_metrics_[pit];
1368
1369         int yy = pm.position() - pm.ascent();
1370         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1371                 " pit: " << pit << " yy: " << yy);
1372
1373         int r = 0;
1374         LBUFERR(pm.rows().size());
1375         for (; r < int(pm.rows().size()) - 1; ++r) {
1376                 Row const & row = pm.rows()[r];
1377                 if (int(yy + row.height()) > y)
1378                         break;
1379                 yy += row.height();
1380         }
1381
1382         Row const & row = pm.rows()[r];
1383
1384         LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1385
1386         bool bound = false;
1387         int xx = x;
1388         pos_type const pos = getPosNearX(row, xx, bound);
1389
1390         LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1391
1392         text_->setCursor(cur, pit, pos, true, bound);
1393         // remember new position.
1394         cur.setTargetX();
1395 }
1396
1397
1398 //takes screen x,y coordinates
1399 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1400 {
1401         Paragraph const & par = text_->paragraphs()[pit];
1402         CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1403
1404         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
1405
1406         InsetList::const_iterator iit = par.insetList().begin();
1407         InsetList::const_iterator iend = par.insetList().end();
1408         for (; iit != iend; ++iit) {
1409                 Inset * inset = iit->inset;
1410
1411                 LYXERR(Debug::DEBUG, "examining inset " << inset);
1412
1413                 if (!insetCache.has(inset)) {
1414                         LYXERR(Debug::DEBUG, "inset has no cached position");
1415                         return 0;
1416                 }
1417
1418                 Dimension const & dim = insetCache.dim(inset);
1419                 Point p = insetCache.xy(inset);
1420
1421                 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1422                         << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1423
1424                 if (x >= p.x_ && x <= p.x_ + dim.wid
1425                     && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1426                         LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1427                         return const_cast<InsetList::InsetTable *>(&(*iit));
1428                 }
1429         }
1430
1431         LYXERR(Debug::DEBUG, "No inset hit. ");
1432         return 0;
1433 }
1434
1435
1436 //takes screen x,y coordinates
1437 Inset * TextMetrics::checkInsetHit(int x, int y)
1438 {
1439         pit_type const pit = getPitNearY(y);
1440         LASSERT(pit != -1, return 0);
1441         InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1442
1443         if (!it)
1444                 return 0;
1445
1446         return it->inset;
1447 }
1448
1449
1450 Row::const_iterator const
1451 TextMetrics::findRowElement(Row const & row, pos_type const pos,
1452                             bool const boundary, double & x) const
1453 {
1454         /**
1455          * When boundary is true, position i is in the row element (pos, endpos)
1456          * if
1457          *    pos < i <= endpos
1458          * whereas, when boundary is false, the test is
1459          *    pos <= i < endpos
1460          * The correction below allows to handle both cases.
1461         */
1462         int const boundary_corr = (boundary && pos) ? -1 : 0;
1463
1464         x = row.left_margin;
1465
1466         /** Early return in trivial cases
1467          * 1) the row is empty
1468          * 2) the position is the left-most position of the row; there
1469          * is a quirk here however: if the first element is virtual
1470          * (end-of-par marker for example), then we have to look
1471          * closer
1472          */
1473         if (row.empty()
1474             || (pos == row.begin()->left_pos() && !boundary
1475                         && !row.begin()->isVirtual()))
1476                 return row.begin();
1477
1478         Row::const_iterator cit = row.begin();
1479         for ( ; cit != row.end() ; ++cit) {
1480                 /** Look whether the cursor is inside the element's
1481                  * span. Note that it is necessary to take the
1482                  * boundary into account, and to accept virtual
1483                  * elements, which have pos == endpos.
1484                  */
1485                 if (pos + boundary_corr >= cit->pos
1486                     && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
1487                                 x += cit->pos2x(pos);
1488                                 break;
1489                 }
1490                 x += cit->full_width();
1491         }
1492
1493         if (cit == row.end())
1494                 --cit;
1495
1496         return cit;
1497 }
1498
1499
1500 int TextMetrics::cursorX(CursorSlice const & sl,
1501                 bool boundary) const
1502 {
1503         LASSERT(sl.text() == text_, return 0);
1504
1505         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1506         if (pm.rows().empty())
1507                 return 0;
1508         Row const & row = pm.getRow(sl.pos(), boundary);
1509         pos_type const pos = sl.pos();
1510
1511         double x = 0;
1512         findRowElement(row, pos, boundary, x);
1513         return int(x);
1514
1515 }
1516
1517
1518 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1519 {
1520         //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1521         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1522         if (pm.rows().empty())
1523                 return 0;
1524
1525         int h = 0;
1526         h -= par_metrics_[0].rows()[0].ascent();
1527         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1528                 h += par_metrics_[pit].height();
1529         }
1530         int pos = sl.pos();
1531         if (pos && boundary)
1532                 --pos;
1533         size_t const rend = pm.pos2row(pos);
1534         for (size_t rit = 0; rit != rend; ++rit)
1535                 h += pm.rows()[rit].height();
1536         h += pm.rows()[rend].ascent();
1537         return h;
1538 }
1539
1540
1541 // the cursor set functions have a special mechanism. When they
1542 // realize you left an empty paragraph, they will delete it.
1543
1544 bool TextMetrics::cursorHome(Cursor & cur)
1545 {
1546         LASSERT(text_ == cur.text(), return false);
1547         ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1548         Row const & row = pm.getRow(cur.pos(),cur.boundary());
1549         return text_->setCursor(cur, cur.pit(), row.pos());
1550 }
1551
1552
1553 bool TextMetrics::cursorEnd(Cursor & cur)
1554 {
1555         LASSERT(text_ == cur.text(), return false);
1556         // if not on the last row of the par, put the cursor before
1557         // the final space exept if I have a spanning inset or one string
1558         // is so long that we force a break.
1559         pos_type end = cur.textRow().endpos();
1560         if (end == 0)
1561                 // empty text, end-1 is no valid position
1562                 return false;
1563         bool boundary = false;
1564         if (end != cur.lastpos()) {
1565                 if (!cur.paragraph().isLineSeparator(end-1)
1566                     && !cur.paragraph().isNewline(end-1)
1567                     && !cur.paragraph().isEnvSeparator(end-1))
1568                         boundary = true;
1569                 else
1570                         --end;
1571         }
1572         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1573 }
1574
1575
1576 void TextMetrics::deleteLineForward(Cursor & cur)
1577 {
1578         LASSERT(text_ == cur.text(), return);
1579         if (cur.lastpos() == 0) {
1580                 // Paragraph is empty, so we just go forward
1581                 text_->cursorForward(cur);
1582         } else {
1583                 cur.resetAnchor();
1584                 cur.setSelection(true); // to avoid deletion
1585                 cursorEnd(cur);
1586                 cur.setSelection();
1587                 // What is this test for ??? (JMarc)
1588                 if (!cur.selection())
1589                         text_->deleteWordForward(cur);
1590                 else
1591                         cap::cutSelection(cur, true, false);
1592                 cur.checkBufferStructure();
1593         }
1594 }
1595
1596
1597 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1598 {
1599         ParagraphList const & pars = text_->paragraphs();
1600         return row.endpos() >= pars[pit].size()
1601                 && pit + 1 == pit_type(pars.size());
1602 }
1603
1604
1605 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1606 {
1607         return row.pos() == 0 && pit == 0;
1608 }
1609
1610
1611 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1612 {
1613         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1614 }
1615
1616
1617 int TextMetrics::leftMargin(int max_width,
1618                 pit_type const pit, pos_type const pos) const
1619 {
1620         ParagraphList const & pars = text_->paragraphs();
1621
1622         LASSERT(pit >= 0, return 0);
1623         LASSERT(pit < int(pars.size()), return 0);
1624         Paragraph const & par = pars[pit];
1625         LASSERT(pos >= 0, return 0);
1626         LASSERT(pos <= par.size(), return 0);
1627         Buffer const & buffer = bv_->buffer();
1628         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1629         DocumentClass const & tclass = buffer.params().documentClass();
1630         Layout const & layout = par.layout();
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 += theFontMetrics(buffer.params().getFont()).signedWidth(
1640                 tclass.leftmargin());
1641
1642         int depth = par.getDepth();
1643         if (depth != 0) {
1644                 // find the next level paragraph
1645                 pit_type newpar = text_->outerHook(pit);
1646                 if (newpar != pit_type(pars.size())) {
1647                         if (pars[newpar].layout().isEnvironment()) {
1648                                 int nestmargin = depth * nestMargin();
1649                                 if (text_->isMainText())
1650                                         nestmargin += changebarMargin();
1651                                 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1652                                 // Remove the parindent that has been added
1653                                 // if the paragraph was empty.
1654                                 if (pars[newpar].empty() &&
1655                                     buffer.params().paragraph_separation ==
1656                                     BufferParams::ParagraphIndentSeparation) {
1657                                         docstring pi = pars[newpar].layout().parindent;
1658                                         l_margin -= theFontMetrics(
1659                                                 buffer.params().getFont()).signedWidth(pi);
1660                                 }
1661                         }
1662                         if (tclass.isDefaultLayout(par.layout())
1663                             || tclass.isPlainLayout(par.layout())) {
1664                                 if (pars[newpar].params().noindent())
1665                                         parindent.erase();
1666                                 else
1667                                         parindent = pars[newpar].layout().parindent;
1668                         }
1669                 }
1670         }
1671
1672         // This happens after sections or environments in standard classes.
1673         // We have to check the previous layout at same depth.
1674         if (buffer.params().paragraph_separation ==
1675                         BufferParams::ParagraphSkipSeparation)
1676                 parindent.erase();
1677         else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1678                 pit_type prev = text_->depthHook(pit, par.getDepth());
1679                 if (par.layout() == pars[prev].layout()) {
1680                         if (prev != pit - 1
1681                             && pars[pit - 1].layout().nextnoindent)
1682                                 parindent.erase();
1683                 } else if (pars[prev].layout().nextnoindent)
1684                         parindent.erase();
1685         }
1686
1687         FontInfo const labelfont = text_->labelFont(par);
1688         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1689
1690         switch (layout.margintype) {
1691         case MARGIN_DYNAMIC:
1692                 if (!layout.leftmargin.empty()) {
1693                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1694                                 layout.leftmargin);
1695                 }
1696                 if (!par.labelString().empty()) {
1697                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1698                         l_margin += labelfont_metrics.width(par.labelString());
1699                         l_margin += labelfont_metrics.width(layout.labelsep);
1700                 }
1701                 break;
1702
1703         case MARGIN_MANUAL: {
1704                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1705                 // The width of an empty par, even with manual label, should be 0
1706                 if (!par.empty() && pos >= par.beginOfBody()) {
1707                         if (!par.getLabelWidthString().empty()) {
1708                                 docstring labstr = par.getLabelWidthString();
1709                                 l_margin += labelfont_metrics.width(labstr);
1710                                 l_margin += labelfont_metrics.width(layout.labelsep);
1711                         }
1712                 }
1713                 break;
1714         }
1715
1716         case MARGIN_STATIC: {
1717                 l_margin += theFontMetrics(buffer.params().getFont()).
1718                         signedWidth(layout.leftmargin) * 4      / (par.getDepth() + 4);
1719                 break;
1720         }
1721
1722         case MARGIN_FIRST_DYNAMIC:
1723                 if (layout.labeltype == LABEL_MANUAL) {
1724                         // if we are at position 0, we are never in the body
1725                         if (pos > 0 && pos >= par.beginOfBody())
1726                                 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1727                         else
1728                                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1729                 } else if (pos != 0
1730                            // Special case to fix problems with
1731                            // theorems (JMarc)
1732                            || (layout.labeltype == LABEL_STATIC
1733                                && layout.latextype == LATEX_ENVIRONMENT
1734                                && !text_->isFirstInSequence(pit))) {
1735                         l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1736                 } else if (!layout.labelIsAbove()) {
1737                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1738                         l_margin += labelfont_metrics.width(layout.labelsep);
1739                         l_margin += labelfont_metrics.width(par.labelString());
1740                 }
1741                 break;
1742
1743         case MARGIN_RIGHT_ADDRESS_BOX: {
1744 #if 0
1745                 // The left margin depends on the widest row in this paragraph.
1746                 // This code is wrong because it depends on the rows, but at the
1747                 // same time this function is used in redoParagraph to construct
1748                 // the rows.
1749                 ParagraphMetrics const & pm = par_metrics_[pit];
1750                 RowList::const_iterator rit = pm.rows().begin();
1751                 RowList::const_iterator end = pm.rows().end();
1752                 int minfill = max_width;
1753                 for ( ; rit != end; ++rit)
1754                         if (rit->fill() < minfill)
1755                                 minfill = rit->fill();
1756                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1757                 l_margin += minfill;
1758 #endif
1759                 // also wrong, but much shorter.
1760                 l_margin += max_width / 2;
1761                 break;
1762         }
1763         }
1764
1765         if (!par.params().leftIndent().zero())
1766                 l_margin += par.params().leftIndent().inPixels(max_width, labelfont_metrics.em());
1767
1768         LyXAlignment align;
1769
1770         if (par.params().align() == LYX_ALIGN_LAYOUT)
1771                 align = layout.align;
1772         else
1773                 align = par.params().align();
1774
1775         // set the correct parindent
1776         if (pos == 0
1777             && (layout.labeltype == LABEL_NO_LABEL
1778                 || layout.labeltype == LABEL_ABOVE
1779                 || layout.labeltype == LABEL_CENTERED
1780                 || (layout.labeltype == LABEL_STATIC
1781                     && layout.latextype == LATEX_ENVIRONMENT
1782                     && !text_->isFirstInSequence(pit)))
1783             && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1784             && !par.params().noindent()
1785             // in some insets, paragraphs are never indented
1786             && !text_->inset().neverIndent()
1787             // display style insets are always centered, omit indentation
1788             && !(!par.empty()
1789                  && par.isInset(pos)
1790                  && par.getInset(pos)->display())
1791             && (!(tclass.isDefaultLayout(par.layout())
1792                   || tclass.isPlainLayout(par.layout()))
1793                 || buffer.params().paragraph_separation
1794                                 == BufferParams::ParagraphIndentSeparation)) {
1795                         // use the parindent of the layout when the
1796                         // default indentation is used otherwise use
1797                         // the indentation set in the document
1798                         // settings
1799                         if (buffer.params().getIndentation().asLyXCommand() == "default")
1800                                 l_margin += theFontMetrics(
1801                                         buffer.params().getFont()).signedWidth(parindent);
1802                         else
1803                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1804                 }
1805
1806         return l_margin;
1807 }
1808
1809
1810 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1811 {
1812         if (par_metrics_.empty())
1813                 return;
1814
1815         origin_.x_ = x;
1816         origin_.y_ = y;
1817
1818         ParMetricsCache::iterator it = par_metrics_.begin();
1819         ParMetricsCache::iterator const pm_end = par_metrics_.end();
1820         y -= it->second.ascent();
1821         for (; it != pm_end; ++it) {
1822                 ParagraphMetrics const & pmi = it->second;
1823                 y += pmi.ascent();
1824                 pit_type const pit = it->first;
1825                 // Save the paragraph position in the cache.
1826                 it->second.setPosition(y);
1827                 drawParagraph(pi, pit, x, y);
1828                 y += pmi.descent();
1829         }
1830 }
1831
1832
1833 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1834 {
1835         BufferParams const & bparams = bv_->buffer().params();
1836         ParagraphMetrics const & pm = par_metrics_[pit];
1837         if (pm.rows().empty())
1838                 return;
1839
1840         bool const original_drawing_state = pi.pain.isDrawingEnabled();
1841         int const ww = bv_->workHeight();
1842         size_t const nrows = pm.rows().size();
1843
1844         Cursor const & cur = bv_->cursor();
1845         DocIterator sel_beg = cur.selectionBegin();
1846         DocIterator sel_end = cur.selectionEnd();
1847         bool selection = cur.selection()
1848                 // This is our text.
1849                 && cur.text() == text_
1850                 // if the anchor is outside, this is not our selection
1851                 && cur.normalAnchor().text() == text_
1852                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1853
1854         // We store the begin and end pos of the selection relative to this par
1855         DocIterator sel_beg_par = cur.selectionBegin();
1856         DocIterator sel_end_par = cur.selectionEnd();
1857
1858         // We care only about visible selection.
1859         if (selection) {
1860                 if (pit != sel_beg.pit()) {
1861                         sel_beg_par.pit() = pit;
1862                         sel_beg_par.pos() = 0;
1863                 }
1864                 if (pit != sel_end.pit()) {
1865                         sel_end_par.pit() = pit;
1866                         sel_end_par.pos() = sel_end_par.lastpos();
1867                 }
1868         }
1869
1870         for (size_t i = 0; i != nrows; ++i) {
1871
1872                 Row const & row = pm.rows()[i];
1873                 int row_x = x;
1874                 if (i)
1875                         y += row.ascent();
1876
1877                 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1878                 rowSlice.pit() = pit;
1879                 rowSlice.pos() = row.pos();
1880
1881                 bool const inside = (y + row.descent() >= 0
1882                         && y - row.ascent() < ww);
1883
1884                 // Adapt to cursor row scroll offset if applicable.
1885                 if (bv_->currentRowSlice() == rowSlice)
1886                         row_x -= bv_->horizScrollOffset();
1887
1888                 // It is not needed to draw on screen if we are not inside.
1889                 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1890
1891                 RowPainter rp(pi, *text_, pit, row, row_x, y);
1892
1893                 if (selection)
1894                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1895                 else
1896                         row.setSelection(-1, -1);
1897
1898                 // The row knows nothing about the paragraph, so we have to check
1899                 // whether this row is the first or last and update the margins.
1900                 if (row.selection()) {
1901                         if (row.sel_beg == 0)
1902                                 row.begin_margin_sel = sel_beg.pit() < pit;
1903                         if (row.sel_end == sel_end_par.lastpos())
1904                                 row.end_margin_sel = sel_end.pit() > pit;
1905                 }
1906
1907                 // Row signature; has row changed since last paint?
1908                 if (pi.pain.isDrawingEnabled())
1909                         row.setCrc(pm.computeRowSignature(row, bparams));
1910                 bool row_has_changed = row.changed()
1911                         || rowSlice == bv_->lastRowSlice();
1912
1913                 // Take this opportunity to spellcheck the row contents.
1914                 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1915                         text_->getPar(pit).spellCheck();
1916                 }
1917
1918                 // Don't paint the row if a full repaint has not been requested
1919                 // and if it has not changed.
1920                 if (!pi.full_repaint && !row_has_changed) {
1921                         // Paint only the insets if the text itself is
1922                         // unchanged.
1923                         rp.paintOnlyInsets();
1924                         y += row.descent();
1925                         continue;
1926                 }
1927
1928                 // Clear background of this row if paragraph background was not
1929                 // already cleared because of a full repaint.
1930                 if (!pi.full_repaint && row_has_changed) {
1931                         LYXERR(Debug::PAINTING, "Clear rect@("
1932                                << max(row_x, 0) << ", " << y - row.ascent() << ")="
1933                                << width() << " x " << row.height());
1934                         pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1935                                 width(), row.height(), pi.background_color);
1936                 }
1937
1938                 // Instrumentation for testing row cache (see also
1939                 // 12 lines lower):
1940                 if (lyxerr.debugging(Debug::PAINTING) && inside
1941                         && (row.selection() || pi.full_repaint || row_has_changed)) {
1942                                 string const foreword = text_->isMainText() ?
1943                                         "main text redraw " : "inset text redraw: ";
1944                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1945                                 << " row_selection="    << row.selection()
1946                                 << " full_repaint="     << pi.full_repaint
1947                                 << " row_has_changed="  << row_has_changed
1948                                 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1949                 }
1950
1951                 // Backup full_repaint status and force full repaint
1952                 // for inner insets as the Row has been cleared out.
1953                 bool tmp = pi.full_repaint;
1954                 pi.full_repaint = true;
1955
1956                 rp.paintSelection();
1957                 rp.paintAppendix();
1958                 rp.paintDepthBar();
1959                 rp.paintChangeBar();
1960                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1961                 if (i == 0 && !is_rtl)
1962                         rp.paintFirst();
1963                 if (i == nrows - 1 && is_rtl)
1964                         rp.paintLast();
1965                 rp.paintText();
1966                 if (i == nrows - 1 && !is_rtl)
1967                         rp.paintLast();
1968                 if (i == 0 && is_rtl)
1969                         rp.paintFirst();
1970                 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1971                                       row_x + row.right_x() > bv_->workWidth());
1972                 y += row.descent();
1973
1974                 // Restore full_repaint status.
1975                 pi.full_repaint = tmp;
1976         }
1977         // Re-enable screen drawing for future use of the painter.
1978         pi.pain.setDrawingEnabled(original_drawing_state);
1979
1980         //LYXERR(Debug::PAINTING, ".");
1981 }
1982
1983
1984 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1985         Dimension & dim) const
1986 {
1987         Cursor const & bvcur = cur.bv().cursor();
1988
1989         // get word in front of cursor
1990         docstring word = text_->previousWord(bvcur.top());
1991         DocIterator wordStart = bvcur;
1992         wordStart.pos() -= word.length();
1993
1994         // get position on screen of the word start and end
1995         //FIXME: Is it necessary to explicitly set this to false?
1996         wordStart.boundary(false);
1997         Point lxy = cur.bv().getPos(wordStart);
1998         Point rxy = cur.bv().getPos(bvcur);
1999
2000         // calculate dimensions of the word
2001         Row row;
2002         row.pos(wordStart.pos());
2003         row.endpos(bvcur.pos());
2004         setRowHeight(row, bvcur.pit(), false);
2005         dim = row.dimension();
2006         dim.wid = abs(rxy.x_ - lxy.x_);
2007
2008         // calculate position of word
2009         y = lxy.y_;
2010         x = min(rxy.x_, lxy.x_);
2011
2012         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2013         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2014 }
2015
2016 int defaultRowHeight()
2017 {
2018         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
2019 }
2020
2021 } // namespace lyx