src/TextMetrics.cpp

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