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