src/TextMetrics.cpp

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