src/TextMetrics.cpp

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