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