src/TextMetrics.cpp

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