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