src/TextMetrics.cpp

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