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