src/TextMetrics.cpp

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