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.width();
 574         // FIXME: put back this assertion when the crash on new doc is solved.
 575         //LASSERT(w >= 0, /**/);
 576
 577         //lyxerr << "\ndim_.wid " << dim_.wid << endl;
 578         //lyxerr << "row.width() " << row.width() << endl;
 579         //lyxerr << "w " << w << endl;
 580
 581         bool const is_rtl = text_->isRTL(par);
 582         if (is_rtl)
 583                 row.x = rightMargin(pit);
 584         else
 585                 row.x = leftMargin(max_width_, pit, row.pos());
 586
 587         // is there a manual margin with a manual label
 588         Layout const & layout = par.layout();
 589
 590         int nlh = 0;
 591         if (layout.margintype == MARGIN_MANUAL
 592             && layout.labeltype == LABEL_MANUAL) {
 593                 /// We might have real hfills in the label part
 594                 nlh = numberOfLabelHfills(par, row);
 595
 596                 // A manual label par (e.g. List) has an auto-hfill
 597                 // between the label text and the body of the
 598                 // paragraph too.
 599                 // But we don't want to do this auto hfill if the par
 600                 // is empty.
 601                 if (!par.empty())
 602                         ++nlh;
 603
 604                 if (nlh && !par.getLabelWidthString().empty())
 605                         row.label_hfill = labelFill(pit, row) / double(nlh);
 606         }
 607
 608         double hfill = 0;
 609         // are there any hfills in the row?
 610         if (int const nh = numberOfHfills(row, par.beginOfBody())) {
 611                 if (w > 0)
 612                         hfill = w / double(nh);
 613         // we don't have to look at the alignment if it is ALIGN_LEFT and
 614         // if the row is already larger then the permitted width as then
 615         // we force the LEFT_ALIGN'edness!
 616         } else if (int(row.width()) < max_width_) {
 617                 // is it block, flushleft or flushright?
 618                 // set x how you need it
 619                 int const align = getAlign(par, row.pos());
 620
 621                 switch (align) {
 622                 case LYX_ALIGN_BLOCK: {
 623                         int const ns = numberOfSeparators(row);
 624                         /** If we have separators, and this row has
 625                          * not be broken abruptly by a display inset
 626                          * or newline, then stretch it */
 627                         if (ns && !row.right_boundary()
 628                             && row.endpos() != par.size()) {
 629                                 setSeparatorWidth(row, w / ns);
 630                                 row.dimension().wid = width;
 631                                 //lyxerr << "row.separator " << row.separator << endl;
 632                                 //lyxerr << "ns " << ns << endl;
 633                         } else if (is_rtl) {
 634                                 row.dimension().wid = width;
 635                                 row.x += w;
 636                         }
 637                         break;
 638                 }
 639                 case LYX_ALIGN_RIGHT:
 640                         row.dimension().wid = width;
 641                         row.x += w;
 642                         break;
 643                 case LYX_ALIGN_CENTER:
 644                         row.dimension().wid += w / 2;
 645                         row.x += w / 2;
 646                         break;
 647                 }
 648         }
 649
 650 #if 0
 651         if (is_rtl) {
 652                 pos_type body_pos = par.beginOfBody();
 653                 pos_type end = row.endpos();
 654
 655                 if (body_pos > 0
 656                     && (body_pos > end || !par.isLineSeparator(body_pos - 1))) {
 657                         row.x += theFontMetrics(text_->labelFont(par)).
 658                                 width(layout.labelsep);
 659                         if (body_pos <= end)
 660                                 row.x += row.label_hfill;
 661                 }
 662         }
 663 #endif
 664
 665         pos_type const endpos = row.endpos();
 666         pos_type body_pos = par.beginOfBody();
 667         if (body_pos > 0
 668             && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
 669                 body_pos = 0;
 670
 671         ParagraphMetrics & pm = par_metrics_[pit];
 672         Row::iterator cit = row.begin();
 673         Row::iterator const cend = row.end();
 674         for ( ; cit != cend; ++cit) {
 675                 if (row.label_hfill && cit->endpos == body_pos
 676                     && cit->type == Row::SPACE)
 677                         cit->dim.wid -= row.label_hfill * (nlh - 1);
 678                 if (!cit->inset || !cit->inset->isHfill())
 679                         continue;
 680                 if (pm.hfillExpansion(row, cit->pos))
 681                         cit->dim.wid = int(cit->pos >= body_pos ?
 682                                            max(hfill, 5.0) : row.label_hfill);
 683                 else
 684                         cit->dim.wid = 5;
 685                 // Cache the inset dimension.
 686                 bv_->coordCache().insets().add(cit->inset, cit->dim);
 687                 pm.setInsetDimension(cit->inset, cit->dim);
 688         }
 689 }
 690
 691
 692 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
 693 {
 694         Paragraph const & par = text_->getPar(pit);
 695         LBUFERR(par.beginOfBody() > 0);
 696
 697         int w = 0;
 698         Row::const_iterator cit = row.begin();
 699         Row::const_iterator const end = row.end();
 700         // iterate over elements before main body (except the last one,
 701         // which is extra space).
 702         while (cit!= end && cit->endpos < par.beginOfBody()) {
 703                 w += cit->width();
 704                 ++cit;
 705         }
 706
 707         docstring const & label = par.params().labelWidthString();
 708         if (label.empty())
 709                 return 0;
 710
 711         FontMetrics const & fm
 712                 = theFontMetrics(text_->labelFont(par));
 713
 714         return max(0, fm.width(label) - w);
 715 }
 716
 717
 718 #if 0
 719 // Not used, see TextMetrics::breakRow
 720 // this needs special handling - only newlines count as a break point
 721 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
 722 {
 723         pos_type const end = par.size();
 724
 725         for (; i < end; ++i)
 726                 if (par.isNewline(i))
 727                         return i + 1;
 728
 729         return end;
 730 }
 731 #endif
 732
 733
 734 int TextMetrics::labelEnd(pit_type const pit) const
 735 {
 736         // labelEnd is only needed if the layout fills a flushleft label.
 737         if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
 738                 return 0;
 739         // return the beginning of the body
 740         return leftMargin(max_width_, pit);
 741 }
 742
 743 namespace {
 744
 745 /**
 746  * Calling Text::getFont is slow. While rebreaking we scan a
 747  * paragraph from left to right calling getFont for every char.  This
 748  * simple class address this problem by hidding an optimization trick
 749  * (not mine btw -AB): the font is reused in the whole font span.  The
 750  * class handles transparently the "hidden" (not part of the fontlist)
 751  * label font (as getFont does).
 752  **/
 753 class FontIterator
 754 {
 755 public:
 756         ///
 757         FontIterator(TextMetrics const & tm,
 758                 Paragraph const & par, pit_type pit, pos_type pos)
 759                 : tm_(tm), par_(par), pit_(pit), pos_(pos),
 760                 font_(tm.displayFont(pit, pos)),
 761                 endspan_(par.fontSpan(pos).last),
 762                 bodypos_(par.beginOfBody())
 763         {}
 764
 765         ///
 766         Font const & operator*() const { return font_; }
 767
 768         ///
 769         FontIterator & operator++()
 770         {
 771                 ++pos_;
 772                 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
 773                         font_ = tm_.displayFont(pit_, pos_);
 774                         endspan_ = par_.fontSpan(pos_).last;
 775                 }
 776                 return *this;
 777         }
 778
 779         ///
 780         Font * operator->() { return &font_; }
 781
 782 private:
 783         ///
 784         TextMetrics const & tm_;
 785         ///
 786         Paragraph const & par_;
 787         ///
 788         pit_type pit_;
 789         ///
 790         pos_type pos_;
 791         ///
 792         Font font_;
 793         ///
 794         pos_type endspan_;
 795         ///
 796         pos_type bodypos_;
 797 };
 798
 799 } // anon namespace
 800
 801 /** This is the function where the hard work is done. The code here is
 802  * very sensitive to small changes :) Note that part of the
 803  * intelligence is also in Row::shorten_if_needed
 804  */
 805 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
 806 {
 807         Paragraph const & par = text_->getPar(pit);
 808         pos_type const end = par.size();
 809         pos_type const pos = row.pos();
 810         int const width = max_width_ - right_margin;
 811         pos_type const body_pos = par.beginOfBody();
 812         row.clear();
 813         row.dimension().wid = leftMargin(max_width_, pit, pos);
 814         row.x = row.width();
 815         row.right_margin = right_margin;
 816
 817         if (pos >= end || row.width() > width) {
 818                 row.dimension().wid += right_margin;
 819                 row.endpos(end);
 820                 return;
 821         }
 822
 823         ParagraphMetrics const & pm = par_metrics_[pit];
 824         ParagraphList const & pars = text_->paragraphs();
 825
 826 #if 0
 827         //FIXME: As long as leftMargin() is not correctly implemented for
 828         // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
 829         // Otherwise, long rows will be painted off the screen.
 830         if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
 831                 return addressBreakPoint(pos, par);
 832 #endif
 833
 834         // check for possible inline completion
 835         DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
 836         pos_type inlineCompletionLPos = -1;
 837         if (inlineCompletionPos.inTexted()
 838             && inlineCompletionPos.text() == text_
 839             && inlineCompletionPos.pit() == pit) {
 840                 // draw logically behind the previous character
 841                 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
 842         }
 843
 844         // Now we iterate through until we reach the right margin
 845         // or the end of the par, then build a representation of the row.
 846         pos_type i = pos;
 847         FontIterator fi = FontIterator(*this, par, pit, pos);
 848         while (i < end && row.width() < width) {
 849                 char_type c = par.getChar(i);
 850                 // The most special cases are handled first.
 851                 if (par.isInset(i)) {
 852                         Inset const * ins = par.getInset(i);
 853                         Dimension dim = pm.insetDimension(ins);
 854                         row.add(i, ins, dim, *fi, par.lookupChange(i));
 855                 } else if (par.isLineSeparator(i)) {
 856                         // In theory, no inset has this property. If
 857                         // this is done, a new addSeparator which
 858                         // takes an inset as parameter should be
 859                         // added.
 860                         LATTEST(!par.isInset(i));
 861                         row.addSeparator(i, c, *fi, par.lookupChange(i));
 862                 } else if (c == '\t')
 863                         row.addSpace(i, theFontMetrics(*fi).width(from_ascii("    ")),
 864                                      *fi, par.lookupChange(i));
 865                 else
 866                         row.add(i, c, *fi, par.lookupChange(i));
 867
 868                 // end of paragraph marker
 869                 if (lyxrc.paragraph_markers
 870                     && i == end - 1 && size_type(pit + 1) < pars.size()) {
 871                         // enlarge the last character to hold the end-of-par marker
 872                         Font f(text_->layoutFont(pit));
 873                         f.fontInfo().setColor(Color_paragraphmarker);
 874                         row.addVirtual(i + 1, docstring(1, char_type(0x00B6)), f, Change());
 875                 }
 876
 877                 // add inline completion width
 878                 if (inlineCompletionLPos == i &&
 879                     !bv_->inlineCompletion().empty()) {
 880                         Font f = *fi;
 881                         f.fontInfo().setColor(Color_inlinecompletion);
 882                         row.addVirtual(i + 1, bv_->inlineCompletion(),
 883                                           f, Change());
 884                 }
 885
 886                 // Handle some situations that abruptly terminate the row
 887                 // - A newline inset
 888                 // - Before a display inset
 889                 // - After a display inset
 890                 Inset const * inset = 0;
 891                 if (par.isNewline(i)
 892                     || (i + 1 < end && (inset = par.getInset(i + 1))
 893                         && inset->display())
 894                     || (!row.empty() && row.back().inset
 895                         && row.back().inset->display())) {
 896                         row.right_boundary(true);
 897                         ++i;
 898                         break;
 899                 }
 900
 901                 ++i;
 902                 ++fi;
 903
 904                 // add the auto-hfill from label end to the body
 905                 if (body_pos && i == body_pos) {
 906                         FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
 907                         pos_type j = i;
 908                         if (!row.empty()
 909                             && row.back().type == Row::SEPARATOR) {
 910                                 row.pop_back();
 911                                 --j;
 912                         }
 913                         int const add = max(fm.width(par.layout().labelsep),
 914                                             labelEnd(pit) - row.width());
 915                         row.addSpace(j, add, *fi, par.lookupChange(i));
 916                 }
 917
 918         }
 919
 920         row.finalizeLast();
 921         row.endpos(i);
 922         // if the row is too large, try to cut at last separator.
 923         row.shorten_if_needed(body_pos, width);
 924
 925         // if the row ends with a separator that is not at end of
 926         // paragraph, remove it
 927         if (!row.empty() && row.back().type == Row::SEPARATOR
 928             && row.endpos() < par.size())
 929                 row.pop_back();
 930
 931         // make sure that the RTL elements are in reverse ordering
 932         row.reverseRTL(text_->isRTL(par));
 933
 934         row.dimension().wid += right_margin;
 935 }
 936
 937
 938 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
 939                                     bool topBottomSpace) const
 940 {
 941         Paragraph const & par = text_->getPar(pit);
 942         // get the maximum ascent and the maximum descent
 943         double layoutasc = 0;
 944         double layoutdesc = 0;
 945         double const dh = defaultRowHeight();
 946
 947         // ok, let us initialize the maxasc and maxdesc value.
 948         // Only the fontsize count. The other properties
 949         // are taken from the layoutfont. Nicer on the screen :)
 950         Layout const & layout = par.layout();
 951
 952         // as max get the first character of this row then it can
 953         // increase but not decrease the height. Just some point to
 954         // start with so we don't have to do the assignment below too
 955         // often.
 956         Buffer const & buffer = bv_->buffer();
 957         Font font = displayFont(pit, row.pos());
 958         FontSize const tmpsize = font.fontInfo().size();
 959         font.fontInfo() = text_->layoutFont(pit);
 960         FontSize const size = font.fontInfo().size();
 961         font.fontInfo().setSize(tmpsize);
 962
 963         FontInfo labelfont = text_->labelFont(par);
 964
 965         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 966         FontMetrics const & fontmetrics = theFontMetrics(font);
 967
 968         // these are minimum values
 969         double const spacing_val = layout.spacing.getValue()
 970                 * text_->spacing(par);
 971         //lyxerr << "spacing_val = " << spacing_val << endl;
 972         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
 973         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
 974
 975         // insets may be taller
 976         ParagraphMetrics const & pm = par_metrics_[pit];
 977         Row::const_iterator cit = row.begin();
 978         Row::const_iterator cend = row.end();
 979         for ( ; cit != cend; ++cit) {
 980                 if (cit->inset) {
 981                         Dimension const & dim = pm.insetDimension(cit->inset);
 982                         maxasc  = max(maxasc,  dim.ascent());
 983                         maxdesc = max(maxdesc, dim.descent());
 984                 }
 985         }
 986
 987         // Check if any custom fonts are larger (Asger)
 988         // This is not completely correct, but we can live with the small,
 989         // cosmetic error for now.
 990         int labeladdon = 0;
 991
 992         FontSize maxsize =
 993                 par.highestFontInRange(row.pos(), row.endpos(), size);
 994         if (maxsize > font.fontInfo().size()) {
 995                 // use standard paragraph font with the maximal size
 996                 FontInfo maxfont = font.fontInfo();
 997                 maxfont.setSize(maxsize);
 998                 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
 999                 maxasc  = max(maxasc,  maxfontmetrics.maxAscent());
1000                 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1001         }
1002
1003         // This is nicer with box insets:
1004         ++maxasc;
1005         ++maxdesc;
1006
1007         ParagraphList const & pars = text_->paragraphs();
1008         Inset const & inset = text_->inset();
1009
1010         // is it a top line?
1011         if (row.pos() == 0 && topBottomSpace) {
1012                 BufferParams const & bufparams = buffer.params();
1013                 // some parskips VERY EASY IMPLEMENTATION
1014                 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1015                     && !inset.getLayout().parbreakIsNewline()
1016                     && !par.layout().parbreak_is_newline
1017                     && pit > 0
1018                     && ((layout.isParagraph() && par.getDepth() == 0)
1019                         || (pars[pit - 1].layout().isParagraph()
1020                             && pars[pit - 1].getDepth() == 0))) {
1021                         maxasc += bufparams.getDefSkip().inPixels(*bv_);
1022                 }
1023
1024                 if (par.params().startOfAppendix())
1025                         maxasc += int(3 * dh);
1026
1027                 // special code for the top label
1028                 if (layout.labelIsAbove()
1029                     && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1030                     && !par.labelString().empty()) {
1031                         labeladdon = int(
1032                                   labelfont_metrics.maxHeight()
1033                                         * layout.spacing.getValue()
1034                                         * text_->spacing(par)
1035                                 + (layout.topsep + layout.labelbottomsep) * dh);
1036                 }
1037
1038                 // Add the layout spaces, for example before and after
1039                 // a section, or between the items of a itemize or enumerate
1040                 // environment.
1041
1042                 pit_type prev = text_->depthHook(pit, par.getDepth());
1043                 Paragraph const & prevpar = pars[prev];
1044                 if (prev != pit
1045                     && prevpar.layout() == layout
1046                     && prevpar.getDepth() == par.getDepth()
1047                     && prevpar.getLabelWidthString()
1048                                         == par.getLabelWidthString()) {
1049                         layoutasc = layout.itemsep * dh;
1050                 } else if (pit != 0 || row.pos() != 0) {
1051                         if (layout.topsep > 0)
1052                                 layoutasc = layout.topsep * dh;
1053                 }
1054
1055                 prev = text_->outerHook(pit);
1056                 if (prev != pit_type(pars.size())) {
1057                         maxasc += int(pars[prev].layout().parsep * dh);
1058                 } else if (pit != 0) {
1059                         Paragraph const & prevpar = pars[pit - 1];
1060                         if (prevpar.getDepth() != 0 ||
1061                                         prevpar.layout() == layout) {
1062                                 maxasc += int(layout.parsep * dh);
1063                         }
1064                 }
1065         }
1066
1067         // is it a bottom line?
1068         if (row.endpos() >= par.size() && topBottomSpace) {
1069                 // add the layout spaces, for example before and after
1070                 // a section, or between the items of a itemize or enumerate
1071                 // environment
1072                 pit_type nextpit = pit + 1;
1073                 if (nextpit != pit_type(pars.size())) {
1074                         pit_type cpit = pit;
1075
1076                         if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1077                                 double usual = pars[cpit].layout().bottomsep * dh;
1078                                 double unusual = 0;
1079                                 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1080                                 if (pars[cpit].layout() != pars[nextpit].layout()
1081                                     || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1082                                         unusual = pars[cpit].layout().bottomsep * dh;
1083                                 layoutdesc = max(unusual, usual);
1084                         } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1085                                 if (pars[cpit].layout() != pars[nextpit].layout()
1086                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1087                                         layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1088                         }
1089                 }
1090         }
1091
1092         // incalculate the layout spaces
1093         maxasc  += int(layoutasc  * 2 / (2 + pars[pit].getDepth()));
1094         maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1095
1096         // FIXME: the correct way is to do the following is to move the
1097         // following code in another method specially tailored for the
1098         // main Text. The following test is thus bogus.
1099         // Top and bottom margin of the document (only at top-level)
1100         if (main_text_ && topBottomSpace) {
1101                 if (pit == 0 && row.pos() == 0)
1102                         maxasc += 20;
1103                 if (pit + 1 == pit_type(pars.size()) &&
1104                     row.endpos() == par.size() &&
1105                                 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1106                         maxdesc += 20;
1107         }
1108
1109         row.dimension().asc = maxasc + labeladdon;
1110         row.dimension().des = maxdesc;
1111 }
1112
1113
1114 // x is an absolute screen coord
1115 // returns the column near the specified x-coordinate of the row
1116 // x is set to the real beginning of this column
1117 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1118                 Row const & row, int & x, bool & boundary) const
1119 {
1120
1121         /// For the main Text, it is possible that this pit is not
1122         /// yet in the CoordCache when moving cursor up.
1123         /// x Paragraph coordinate is always 0 for main text anyway.
1124         int const xo = origin_.x_;
1125         x -= xo;
1126 #ifdef KEEP_OLD_METRICS_CODE
1127         int const x_orig = x;
1128 #endif
1129
1130         pos_type pos = row.pos();
1131         boundary = false;
1132         if (row.x >= x || row.empty())
1133                 x = row.x;
1134         else if (x >= row.width() - row.right_margin) {
1135                 x = row.width() - row.right_margin;
1136                 pos = row.back().endpos;
1137         } else {
1138                 double w = row.x;
1139                 Row::const_iterator cit = row.begin();
1140                 Row::const_iterator cend = row.end();
1141                 for ( ; cit != cend; ++cit) {
1142                         if (w <= x &&  w + cit->width() > x) {
1143                                 double x_offset = x - w;
1144                                 pos = cit->x2pos(x_offset);
1145                                 x = x_offset + w;
1146                                 break;
1147                         }
1148                         w += cit->width();
1149                 }
1150                 if (cit == row.end())
1151                         lyxerr << "NOT FOUND!! x=" << x
1152                                << ", wid=" << row.width() << endl;
1153                 /** This tests for the case where the cursor is placed
1154                  * just before a font direction change. See comment on
1155                  * the boundary_ member in DocIterator.h to understand
1156                  * how bounddary helps here.
1157                  */
1158                 else if (pos == cit->endpos
1159                          && cit + 1 != row.end()
1160                          && cit->font.isVisibleRightToLeft() != (cit + 1)->font.isVisibleRightToLeft())
1161                         boundary = true;
1162         }
1163
1164         /** This tests for the case where the cursor is set at the end
1165          * of a row which has been broken due to a display inset on
1166          * next row. This is indicated by Row::right_boundary.
1167          */
1168         if (!row.empty() && pos == row.back().endpos
1169             && row.back().endpos == row.endpos())
1170                 boundary = row.right_boundary();
1171
1172         x += xo;
1173 #if !defined(KEEP_OLD_METRICS_CODE)
1174         return pos - row.pos();
1175 #else
1176         Buffer const & buffer = bv_->buffer();
1177
1178         int x2 = x_orig;
1179         Paragraph const & par = text_->getPar(pit);
1180         Bidi bidi;
1181         bidi.computeTables(par, buffer, row);
1182
1183         pos_type vc = row.pos();
1184         pos_type const end = row.endpos();
1185         pos_type c = 0;
1186         Layout const & layout = par.layout();
1187
1188         bool left_side = false;
1189
1190         pos_type body_pos = par.beginOfBody();
1191
1192         double tmpx = row.x;
1193         double last_tmpx = tmpx;
1194
1195         if (body_pos > 0 &&
1196             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1197                 body_pos = 0;
1198
1199         // check for empty row
1200         if (vc == end) {
1201                 x2 = int(tmpx) + xo;
1202                 return 0;
1203         }
1204
1205         // This (rtl_support test) is not needed, but gives
1206         // some speedup if rtl_support == false
1207         bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1208
1209         // If lastrow is false, we don't need to compute
1210         // the value of rtl.
1211         bool const rtl_on_lastrow = lastrow ? text_->isRTL(par) : false;
1212
1213         while (vc < end && tmpx <= x2) {
1214                 c = bidi.vis2log(vc);
1215                 last_tmpx = tmpx;
1216                 if (body_pos > 0 && c == body_pos - 1) {
1217                         FontMetrics const & fm = theFontMetrics(
1218                                 text_->labelFont(par));
1219                         tmpx += row.label_hfill + fm.width(layout.labelsep);
1220                         if (par.isLineSeparator(body_pos - 1))
1221                                 tmpx -= singleWidth(pit, body_pos - 1);
1222                 }
1223
1224                 tmpx += singleWidth(pit, c);
1225                 if (par.isSeparator(c) && c >= body_pos)
1226                                 tmpx += row.separator;
1227                 ++vc;
1228         }
1229
1230         if ((tmpx + last_tmpx) / 2 > x2) {
1231                 tmpx = last_tmpx;
1232                 left_side = true;
1233         }
1234
1235         // This shouldn't happen. But we can reset and try to continue.
1236         LASSERT(vc <= end, vc = end);
1237
1238         bool boundary2 = false;
1239
1240         if (lastrow &&
1241             ((rtl_on_lastrow  &&  left_side && vc == row.pos() && x2 < tmpx - 5) ||
1242              (!rtl_on_lastrow && !left_side && vc == end  && x2 > tmpx + 5))) {
1243                 if (!par.isNewline(end - 1))
1244                         c = end;
1245         } else if (vc == row.pos()) {
1246                 c = bidi.vis2log(vc);
1247                 if (bidi.level(c) % 2 == 1)
1248                         ++c;
1249         } else {
1250                 c = bidi.vis2log(vc - 1);
1251                 bool const rtl = (bidi.level(c) % 2 == 1);
1252                 if (left_side == rtl) {
1253                         ++c;
1254                         boundary2 = isRTLBoundary(pit, c);
1255                 }
1256         }
1257
1258 // I believe this code is not needed anymore (Jug 20050717)
1259 #if 0
1260         // The following code is necessary because the cursor position past
1261         // the last char in a row is logically equivalent to that before
1262         // the first char in the next row. That's why insets causing row
1263         // divisions -- Newline and display-style insets -- must be treated
1264         // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1265         // Newline inset, air gap below:
1266         if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1267                 if (bidi.level(end -1) % 2 == 0)
1268                         tmpx -= singleWidth(pit, end - 1);
1269                 else
1270                         tmpx += singleWidth(pit, end - 1);
1271                 c = end - 1;
1272         }
1273
1274         // Air gap above display inset:
1275         if (row.pos() < end && c >= end && end < par.size()
1276             && par.isInset(end) && par.getInset(end)->display()) {
1277                 c = end - 1;
1278         }
1279         // Air gap below display inset:
1280         if (row.pos() < end && c >= end && par.isInset(end - 1)
1281             && par.getInset(end - 1)->display()) {
1282                 c = end - 1;
1283         }
1284 #endif
1285
1286         x2 = int(tmpx) + xo;
1287         pos_type const col = c - row.pos();
1288
1289         if (abs(x2 - x) > 0.1 || boundary != boundary
1290             || c != pos) {
1291                 lyxerr << "getColumnNearX: new=(x=" << x - xo << ", b=" << boundary << ", p=" << pos << "), "
1292                        << "old=(x=" << x2 - xo << ", b=" << boundary2 << ", p=" << c << "), " << row;
1293         }
1294
1295         if (!c || end == par.size())
1296                 return col;
1297
1298         if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1299                 boundary2 = true;
1300                 return col;
1301         }
1302
1303         return min(col, end - 1 - row.pos());
1304 #endif
1305 }
1306
1307
1308 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1309 {
1310         // We play safe and use parMetrics(pit) to make sure the
1311         // ParagraphMetrics will be redone and OK to use if needed.
1312         // Otherwise we would use an empty ParagraphMetrics in
1313         // upDownInText() while in selection mode.
1314         ParagraphMetrics const & pm = parMetrics(pit);
1315
1316         LBUFERR(row < int(pm.rows().size()));
1317         bool bound = false;
1318         Row const & r = pm.rows()[row];
1319         return r.pos() + getColumnNearX(pit, r, x, bound);
1320 }
1321
1322
1323 void TextMetrics::newParMetricsDown()
1324 {
1325         pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1326         pit_type const pit = last.first + 1;
1327         if (pit == int(text_->paragraphs().size()))
1328                 return;
1329
1330         // do it and update its position.
1331         redoParagraph(pit);
1332         par_metrics_[pit].setPosition(last.second.position()
1333                 + last.second.descent() + par_metrics_[pit].ascent());
1334 }
1335
1336
1337 void TextMetrics::newParMetricsUp()
1338 {
1339         pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1340         if (first.first == 0)
1341                 return;
1342
1343         pit_type const pit = first.first - 1;
1344         // do it and update its position.
1345         redoParagraph(pit);
1346         par_metrics_[pit].setPosition(first.second.position()
1347                 - first.second.ascent() - par_metrics_[pit].descent());
1348 }
1349
1350 // y is screen coordinate
1351 pit_type TextMetrics::getPitNearY(int y)
1352 {
1353         LASSERT(!text_->paragraphs().empty(), return -1);
1354         LASSERT(!par_metrics_.empty(), return -1);
1355         LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1356
1357         // look for highest numbered paragraph with y coordinate less than given y
1358         pit_type pit = -1;
1359         int yy = -1;
1360         ParMetricsCache::const_iterator it = par_metrics_.begin();
1361         ParMetricsCache::const_iterator et = par_metrics_.end();
1362         ParMetricsCache::const_iterator last = et;
1363         --last;
1364
1365         ParagraphMetrics const & pm = it->second;
1366
1367         if (y < it->second.position() - int(pm.ascent())) {
1368                 // We are looking for a position that is before the first paragraph in
1369                 // the cache (which is in priciple off-screen, that is before the
1370                 // visible part.
1371                 if (it->first == 0)
1372                         // We are already at the first paragraph in the inset.
1373                         return 0;
1374                 // OK, this is the paragraph we are looking for.
1375                 pit = it->first - 1;
1376                 newParMetricsUp();
1377                 return pit;
1378         }
1379
1380         ParagraphMetrics const & pm_last = par_metrics_[last->first];
1381
1382         if (y >= last->second.position() + int(pm_last.descent())) {
1383                 // We are looking for a position that is after the last paragraph in
1384                 // the cache (which is in priciple off-screen), that is before the
1385                 // visible part.
1386                 pit = last->first + 1;
1387                 if (pit == int(text_->paragraphs().size()))
1388                         //  We are already at the last paragraph in the inset.
1389                         return last->first;
1390                 // OK, this is the paragraph we are looking for.
1391                 newParMetricsDown();
1392                 return pit;
1393         }
1394
1395         for (; it != et; ++it) {
1396                 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1397                         << " y: " << it->second.position());
1398
1399                 ParagraphMetrics const & pm = par_metrics_[it->first];
1400
1401                 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1402                         pit = it->first;
1403                         yy = it->second.position();
1404                 }
1405         }
1406
1407         LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1408
1409         return pit;
1410 }
1411
1412
1413 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1414         bool assert_in_view, bool up)
1415 {
1416         ParagraphMetrics const & pm = par_metrics_[pit];
1417
1418         int yy = pm.position() - pm.ascent();
1419         LBUFERR(!pm.rows().empty());
1420         RowList::const_iterator rit = pm.rows().begin();
1421         RowList::const_iterator rlast = pm.rows().end();
1422         --rlast;
1423         for (; rit != rlast; yy += rit->height(), ++rit)
1424                 if (yy + rit->height() > y)
1425                         break;
1426
1427         if (assert_in_view) {
1428                 if (!up && yy + rit->height() > y) {
1429                         if (rit != pm.rows().begin()) {
1430                                 y = yy;
1431                                 --rit;
1432                         } else if (pit != 0) {
1433                                 --pit;
1434                                 newParMetricsUp();
1435                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1436                                 rit = pm2.rows().end();
1437                                 --rit;
1438                                 y = yy;
1439                         }
1440                 } else if (up && yy != y) {
1441                         if (rit != rlast) {
1442                                 y = yy + rit->height();
1443                                 ++rit;
1444                         } else if (pit < int(text_->paragraphs().size()) - 1) {
1445                                 ++pit;
1446                                 newParMetricsDown();
1447                                 ParagraphMetrics const & pm2 = par_metrics_[pit];
1448                                 rit = pm2.rows().begin();
1449                                 y = pm2.position();
1450                         }
1451                 }
1452         }
1453         return *rit;
1454 }
1455
1456
1457 // x,y are absolute screen coordinates
1458 // sets cursor recursively descending into nested editable insets
1459 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1460         bool assert_in_view, bool up)
1461 {
1462         if (lyxerr.debugging(Debug::WORKAREA)) {
1463                 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1464                 cur.bv().coordCache().dump();
1465         }
1466         pit_type pit = getPitNearY(y);
1467         LASSERT(pit != -1, return 0);
1468
1469         int yy = y; // is modified by getPitAndRowNearY
1470         Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1471
1472         cur.pit() = pit;
1473
1474         // Do we cover an inset?
1475         InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1476
1477         if (!it) {
1478                 // No inset, set position in the text
1479                 bool bound = false; // is modified by getColumnNearX
1480                 int xx = x; // is modified by getColumnNearX
1481                 cur.pos() = row.pos()
1482                         + getColumnNearX(pit, row, xx, bound);
1483                 cur.boundary(bound);
1484                 cur.setCurrentFont();
1485                 cur.setTargetX(xx);
1486                 return 0;
1487         }
1488
1489         Inset * inset = it->inset;
1490         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1491
1492         // Set position in front of inset
1493         cur.pos() = it->pos;
1494         cur.boundary(false);
1495         cur.setTargetX(x);
1496
1497         // Try to descend recursively inside the inset.
1498         inset = inset->editXY(cur, x, yy);
1499
1500         if (cur.top().text() == text_)
1501                 cur.setCurrentFont();
1502         return inset;
1503 }
1504
1505
1506 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1507 {
1508         LASSERT(text_ == cur.text(), return);
1509         pit_type const pit = getPitNearY(y);
1510         LASSERT(pit != -1, return);
1511
1512         ParagraphMetrics const & pm = par_metrics_[pit];
1513
1514         int yy = pm.position() - pm.ascent();
1515         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1516                 " pit: " << pit << " yy: " << yy);
1517
1518         int r = 0;
1519         LBUFERR(pm.rows().size());
1520         for (; r < int(pm.rows().size()) - 1; ++r) {
1521                 Row const & row = pm.rows()[r];
1522                 if (int(yy + row.height()) > y)
1523                         break;
1524                 yy += row.height();
1525         }
1526
1527         Row const & row = pm.rows()[r];
1528
1529         LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1530
1531         bool bound = false;
1532         int xx = x;
1533         pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1534
1535         LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1536
1537         text_->setCursor(cur, pit, pos, true, bound);
1538         // remember new position.
1539         cur.setTargetX();
1540 }
1541
1542
1543 //takes screen x,y coordinates
1544 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1545 {
1546         Paragraph const & par = text_->paragraphs()[pit];
1547         ParagraphMetrics const & pm = par_metrics_[pit];
1548
1549         LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << "  pit: " << pit);
1550
1551         InsetList::const_iterator iit = par.insetList().begin();
1552         InsetList::const_iterator iend = par.insetList().end();
1553         for (; iit != iend; ++iit) {
1554                 Inset * inset = iit->inset;
1555
1556                 LYXERR(Debug::DEBUG, "examining inset " << inset);
1557
1558                 if (!bv_->coordCache().getInsets().has(inset)) {
1559                         LYXERR(Debug::DEBUG, "inset has no cached position");
1560                         return 0;
1561                 }
1562
1563                 Dimension const & dim = pm.insetDimension(inset);
1564                 Point p = bv_->coordCache().getInsets().xy(inset);
1565
1566                 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1567                         << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1568
1569                 if (x >= p.x_ && x <= p.x_ + dim.wid
1570                     && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1571                         LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1572                         return const_cast<InsetList::InsetTable *>(&(*iit));
1573                 }
1574         }
1575
1576         LYXERR(Debug::DEBUG, "No inset hit. ");
1577         return 0;
1578 }
1579
1580
1581 //takes screen x,y coordinates
1582 Inset * TextMetrics::checkInsetHit(int x, int y)
1583 {
1584         pit_type const pit = getPitNearY(y);
1585         LASSERT(pit != -1, return 0);
1586         InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1587
1588         if (!it)
1589                 return 0;
1590
1591         return it->inset;
1592 }
1593
1594
1595 int TextMetrics::cursorX(CursorSlice const & sl,
1596                 bool boundary) const
1597 {
1598         LASSERT(sl.text() == text_, return 0);
1599         pit_type const pit = sl.pit();
1600         pos_type pos = sl.pos();
1601
1602         ParagraphMetrics const & pm = par_metrics_[pit];
1603         if (pm.rows().empty())
1604                 return 0;
1605         Row const & row = pm.getRow(sl.pos(), boundary);
1606
1607         double x = row.x;
1608
1609         /**
1610          * When boundary is true, position is on the row element (pos, endpos)
1611          * if
1612          *    pos < pos <= endpos
1613          * whereas, when boundary is false, the test is
1614          *    pos <= pos < endpos
1615          * The correction below allows to handle both cases.
1616         */
1617         int const boundary_corr = (boundary && pos) ? -1 : 0;
1618
1619         if (row.empty()
1620             || (row.begin()->font.isRightToLeft()
1621                 && pos == row.begin()->endpos))
1622                 return int(x);
1623
1624         Row::const_iterator cit = row.begin();
1625         for ( ; cit != row.end() ; ++cit) {
1626                 if (pos + boundary_corr >= cit->pos
1627                     && pos + boundary_corr < cit->endpos) {
1628                                 x += cit->pos2x(pos);
1629                                 break;
1630                 }
1631                 x += cit->width();
1632         }
1633
1634         if (cit == row.end()
1635             && (row.back().font.isRightToLeft() || pos != row.back().endpos))
1636                 lyxerr << "NOT FOUND!"
1637                        << "pos=" << pos << "(" << boundary_corr << ")" << "\n"
1638                        << row;
1639
1640 #ifdef KEEP_OLD_METRICS_CODE
1641         Paragraph const & par = text_->paragraphs()[pit];
1642
1643         // Correct position in front of big insets
1644         bool const boundary_correction = pos != 0 && boundary;
1645         if (boundary_correction)
1646                 --pos;
1647
1648         pos_type cursor_vpos = 0;
1649
1650         Buffer const & buffer = bv_->buffer();
1651         double x2 = row.x;
1652         Bidi bidi;
1653         bidi.computeTables(par, buffer, row);
1654
1655         pos_type const row_pos  = row.pos();
1656         pos_type const end      = row.endpos();
1657         // Spaces at logical line breaks in bidi text must be skipped during
1658         // cursor positioning. However, they may appear visually in the middle
1659         // of a row; they must be skipped, wherever they are...
1660         // * logically "abc_[HEBREW_\nHEBREW]"
1661         // * visually "abc_[_WERBEH\nWERBEH]"
1662         pos_type skipped_sep_vpos = -1;
1663
1664         if (end <= row_pos)
1665                 cursor_vpos = row_pos;
1666         else if (pos >= end)
1667                 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1668         else if (pos > row_pos && pos >= end)
1669                 //FIXME: this code is never reached!
1670                 //       (see http://www.lyx.org/trac/changeset/8251)
1671                 // Place cursor after char at (logical) position pos - 1
1672                 cursor_vpos = (bidi.level(pos - 1) % 2 == 0)
1673                         ? bidi.log2vis(pos - 1) + 1 : bidi.log2vis(pos - 1);
1674         else
1675                 // Place cursor before char at (logical) position pos
1676                 cursor_vpos = (bidi.level(pos) % 2 == 0)
1677                         ? bidi.log2vis(pos) : bidi.log2vis(pos) + 1;
1678
1679         pos_type body_pos = par.beginOfBody();
1680         if (body_pos > 0 &&
1681             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1682                 body_pos = 0;
1683
1684         // check for possible inline completion in this row
1685         DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1686         pos_type inlineCompletionVPos = -1;
1687         if (inlineCompletionPos.inTexted()
1688             && inlineCompletionPos.text() == text_
1689             && inlineCompletionPos.pit() == pit
1690             && inlineCompletionPos.pos() - 1 >= row_pos
1691             && inlineCompletionPos.pos() - 1 < end) {
1692                 // draw logically behind the previous character
1693                 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1694         }
1695
1696         // Use font span to speed things up, see below
1697         FontSpan font_span;
1698         Font font;
1699
1700         // If the last logical character is a separator, skip it, unless
1701         // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1702         if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1703                 skipped_sep_vpos = bidi.log2vis(end - 1);
1704
1705         if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1706                 ParagraphList const & pars_ = text_->paragraphs();
1707                 if (size_type(pit + 1) < pars_.size()) {
1708                         FontInfo f(text_->layoutFont(pit));
1709                         docstring const s = docstring(1, char_type(0x00B6));
1710                         x2 += theFontMetrics(f).width(s);
1711                 }
1712         }
1713
1714         // Inline completion RTL special case row_pos == cursor_pos:
1715         // "__|b" => cursor_pos is right of __
1716         if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1717                 font = displayFont(pit, row_pos + 1);
1718                 docstring const & completion = bv_->inlineCompletion();
1719                 if (font.isRightToLeft() && completion.length() > 0)
1720                         x2 += theFontMetrics(font.fontInfo()).width(completion);
1721         }
1722
1723         for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1724                 // Skip the separator which is at the logical end of the row
1725                 if (vpos == skipped_sep_vpos)
1726                         continue;
1727                 pos_type pos = bidi.vis2log(vpos);
1728                 if (body_pos > 0 && pos == body_pos - 1) {
1729                         FontMetrics const & labelfm = theFontMetrics(
1730                                 text_->labelFont(par));
1731                         x2 += row.label_hfill + labelfm.width(par.layout().labelsep);
1732                         if (par.isLineSeparator(body_pos - 1))
1733                                 x2 -= singleWidth(pit, body_pos - 1);
1734                 }
1735
1736                 // Use font span to speed things up, see above
1737                 if (pos < font_span.first || pos > font_span.last) {
1738                         font_span = par.fontSpan(pos);
1739                         font = displayFont(pit, pos);
1740                 }
1741
1742                 x2 += pm.singleWidth(pos, font);
1743
1744                 // Inline completion RTL case:
1745                 // "a__|b", __ of b => non-boundary a-pos is right of __
1746                 if (vpos + 1 == inlineCompletionVPos
1747                     && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1748                         font = displayFont(pit, vpos + 1);
1749                         docstring const & completion = bv_->inlineCompletion();
1750                         if (font.isRightToLeft() && completion.length() > 0)
1751                                 x2 += theFontMetrics(font.fontInfo()).width(completion);
1752                 }
1753
1754                 //  Inline completion LTR case:
1755                 // "b|__a", __ of b => non-boundary a-pos is in front of __
1756                 if (vpos == inlineCompletionVPos
1757                     && (vpos + 1 < cursor_vpos || boundary_correction)) {
1758                         font = displayFont(pit, vpos);
1759                         docstring const & completion = bv_->inlineCompletion();
1760                         if (!font.isRightToLeft() && completion.length() > 0)
1761                                 x2 += theFontMetrics(font.fontInfo()).width(completion);
1762                 }
1763
1764                 if (par.isSeparator(pos) && pos >= body_pos)
1765                         x2 += row.separator;
1766         }
1767
1768         // see correction above
1769         if (boundary_correction) {
1770                 if (isRTL(sl, boundary))
1771                         x2 -= singleWidth(pit, pos);
1772                 else
1773                         x2 += singleWidth(pit, pos);
1774         }
1775
1776         if (abs(x2 - x) > 0.01) {
1777                 lyxerr << "cursorX: x2=" << x2 << ", x=" << x;
1778                 if (cit == row.end())
1779                         lyxerr << "Element not found for "
1780                                << pos - boundary_corr << "(" << boundary_corr << ")";
1781                 else
1782                         lyxerr << " in [" << cit->pos << "/"
1783                                << pos - boundary_corr << "(" << boundary_corr << ")"
1784                                << "/" << cit->endpos << "] of " << *cit << "\n";
1785                 lyxerr << row <<endl;
1786         }
1787 #endif
1788
1789         return int(x);
1790 }
1791
1792
1793 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1794 {
1795         //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1796         ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1797         if (pm.rows().empty())
1798                 return 0;
1799
1800         int h = 0;
1801         h -= par_metrics_[0].rows()[0].ascent();
1802         for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1803                 h += par_metrics_[pit].height();
1804         }
1805         int pos = sl.pos();
1806         if (pos && boundary)
1807                 --pos;
1808         size_t const rend = pm.pos2row(pos);
1809         for (size_t rit = 0; rit != rend; ++rit)
1810                 h += pm.rows()[rit].height();
1811         h += pm.rows()[rend].ascent();
1812         return h;
1813 }
1814
1815
1816 // the cursor set functions have a special mechanism. When they
1817 // realize you left an empty paragraph, they will delete it.
1818
1819 bool TextMetrics::cursorHome(Cursor & cur)
1820 {
1821         LASSERT(text_ == cur.text(), return false);
1822         ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1823         Row const & row = pm.getRow(cur.pos(),cur.boundary());
1824         return text_->setCursor(cur, cur.pit(), row.pos());
1825 }
1826
1827
1828 bool TextMetrics::cursorEnd(Cursor & cur)
1829 {
1830         LASSERT(text_ == cur.text(), return false);
1831         // if not on the last row of the par, put the cursor before
1832         // the final space exept if I have a spanning inset or one string
1833         // is so long that we force a break.
1834         pos_type end = cur.textRow().endpos();
1835         if (end == 0)
1836                 // empty text, end-1 is no valid position
1837                 return false;
1838         bool boundary = false;
1839         if (end != cur.lastpos()) {
1840                 if (!cur.paragraph().isLineSeparator(end-1)
1841                     && !cur.paragraph().isNewline(end-1))
1842                         boundary = true;
1843                 else
1844                         --end;
1845         }
1846         return text_->setCursor(cur, cur.pit(), end, true, boundary);
1847 }
1848
1849
1850 void TextMetrics::deleteLineForward(Cursor & cur)
1851 {
1852         LASSERT(text_ == cur.text(), return);
1853         if (cur.lastpos() == 0) {
1854                 // Paragraph is empty, so we just go forward
1855                 text_->cursorForward(cur);
1856         } else {
1857                 cur.resetAnchor();
1858                 cur.setSelection(true); // to avoid deletion
1859                 cursorEnd(cur);
1860                 cur.setSelection();
1861                 // What is this test for ??? (JMarc)
1862                 if (!cur.selection())
1863                         text_->deleteWordForward(cur);
1864                 else
1865                         cap::cutSelection(cur, true, false);
1866                 cur.checkBufferStructure();
1867         }
1868 }
1869
1870
1871 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1872 {
1873         ParagraphList const & pars = text_->paragraphs();
1874         return row.endpos() >= pars[pit].size()
1875                 && pit + 1 == pit_type(pars.size());
1876 }
1877
1878
1879 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1880 {
1881         return row.pos() == 0 && pit == 0;
1882 }
1883
1884
1885 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1886 {
1887         return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1888 }
1889
1890
1891 int TextMetrics::leftMargin(int max_width,
1892                 pit_type const pit, pos_type const pos) const
1893 {
1894         ParagraphList const & pars = text_->paragraphs();
1895
1896         LASSERT(pit >= 0, return 0);
1897         LASSERT(pit < int(pars.size()), return 0);
1898         Paragraph const & par = pars[pit];
1899         LASSERT(pos >= 0, return 0);
1900         LASSERT(pos <= par.size(), return 0);
1901         Buffer const & buffer = bv_->buffer();
1902         //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1903         DocumentClass const & tclass = buffer.params().documentClass();
1904         Layout const & layout = par.layout();
1905
1906         docstring parindent = layout.parindent;
1907
1908         int l_margin = 0;
1909
1910         if (text_->isMainText())
1911                 l_margin += bv_->leftMargin();
1912
1913         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1914                 tclass.leftmargin());
1915
1916         if (par.getDepth() != 0) {
1917                 // find the next level paragraph
1918                 pit_type newpar = text_->outerHook(pit);
1919                 if (newpar != pit_type(pars.size())) {
1920                         if (pars[newpar].layout().isEnvironment()) {
1921                                 l_margin = leftMargin(max_width, newpar);
1922                                 // Remove the parindent that has been added
1923                                 // if the paragraph was empty.
1924                                 if (pars[newpar].empty()) {
1925                                         docstring pi = pars[newpar].layout().parindent;
1926                                         l_margin -= theFontMetrics(
1927                                                 buffer.params().getFont()).signedWidth(pi);
1928                                 }
1929                         }
1930                         if (tclass.isDefaultLayout(par.layout())
1931                             || tclass.isPlainLayout(par.layout())) {
1932                                 if (pars[newpar].params().noindent())
1933                                         parindent.erase();
1934                                 else
1935                                         parindent = pars[newpar].layout().parindent;
1936                         }
1937                 }
1938         }
1939
1940         // This happens after sections or environments in standard classes.
1941         // We have to check the previous layout at same depth.
1942         if (tclass.isDefaultLayout(par.layout()) && pit > 0
1943             && pars[pit - 1].getDepth() >= par.getDepth()) {
1944                 pit_type prev = text_->depthHook(pit, par.getDepth());
1945                 if (pars[prev < pit ? prev : pit - 1].layout().nextnoindent)
1946                         parindent.erase();
1947         }
1948
1949         FontInfo const labelfont = text_->labelFont(par);
1950         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1951
1952         switch (layout.margintype) {
1953         case MARGIN_DYNAMIC:
1954                 if (!layout.leftmargin.empty()) {
1955                         l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1956                                 layout.leftmargin);
1957                 }
1958                 if (!par.labelString().empty()) {
1959                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1960                         l_margin += labelfont_metrics.width(par.labelString());
1961                         l_margin += labelfont_metrics.width(layout.labelsep);
1962                 }
1963                 break;
1964
1965         case MARGIN_MANUAL: {
1966                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1967                 // The width of an empty par, even with manual label, should be 0
1968                 if (!par.empty() && pos >= par.beginOfBody()) {
1969                         if (!par.getLabelWidthString().empty()) {
1970                                 docstring labstr = par.getLabelWidthString();
1971                                 l_margin += labelfont_metrics.width(labstr);
1972                                 l_margin += labelfont_metrics.width(layout.labelsep);
1973                         }
1974                 }
1975                 break;
1976         }
1977
1978         case MARGIN_STATIC: {
1979                 l_margin += theFontMetrics(buffer.params().getFont()).
1980                         signedWidth(layout.leftmargin) * 4      / (par.getDepth() + 4);
1981                 break;
1982         }
1983
1984         case MARGIN_FIRST_DYNAMIC:
1985                 if (layout.labeltype == LABEL_MANUAL) {
1986                         // if we are at position 0, we are never in the body
1987                         if (pos > 0 && pos >= par.beginOfBody())
1988                                 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1989                         else
1990                                 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1991                 } else if (pos != 0
1992                            // Special case to fix problems with
1993                            // theorems (JMarc)
1994                            || (layout.labeltype == LABEL_STATIC
1995                                && layout.latextype == LATEX_ENVIRONMENT
1996                                && !text_->isFirstInSequence(pit))) {
1997                         l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1998                 } else if (!layout.labelIsAbove()) {
1999                         l_margin += labelfont_metrics.signedWidth(layout.labelindent);
2000                         l_margin += labelfont_metrics.width(layout.labelsep);
2001                         l_margin += labelfont_metrics.width(par.labelString());
2002                 }
2003                 break;
2004
2005         case MARGIN_RIGHT_ADDRESS_BOX: {
2006 #if 0
2007                 // The left margin depends on the widest row in this paragraph.
2008                 // This code is wrong because it depends on the rows, but at the
2009                 // same time this function is used in redoParagraph to construct
2010                 // the rows.
2011                 ParagraphMetrics const & pm = par_metrics_[pit];
2012                 RowList::const_iterator rit = pm.rows().begin();
2013                 RowList::const_iterator end = pm.rows().end();
2014                 int minfill = max_width;
2015                 for ( ; rit != end; ++rit)
2016                         if (rit->fill() < minfill)
2017                                 minfill = rit->fill();
2018                 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
2019                 l_margin += minfill;
2020 #endif
2021                 // also wrong, but much shorter.
2022                 l_margin += max_width / 2;
2023                 break;
2024         }
2025         }
2026
2027         if (!par.params().leftIndent().zero())
2028                 l_margin += par.params().leftIndent().inPixels(max_width);
2029
2030         LyXAlignment align;
2031
2032         if (par.params().align() == LYX_ALIGN_LAYOUT)
2033                 align = layout.align;
2034         else
2035                 align = par.params().align();
2036
2037         // set the correct parindent
2038         if (pos == 0
2039             && (layout.labeltype == LABEL_NO_LABEL
2040                 || layout.labeltype == LABEL_ABOVE
2041                 || layout.labeltype == LABEL_CENTERED
2042                 || (layout.labeltype == LABEL_STATIC
2043                     && layout.latextype == LATEX_ENVIRONMENT
2044                     && !text_->isFirstInSequence(pit)))
2045             && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2046             && !par.params().noindent()
2047             // in some insets, paragraphs are never indented
2048             && !text_->inset().neverIndent()
2049             // display style insets are always centered, omit indentation
2050             && !(!par.empty()
2051                  && par.isInset(pos)
2052                  && par.getInset(pos)->display())
2053             && (!(tclass.isDefaultLayout(par.layout())
2054                   || tclass.isPlainLayout(par.layout()))
2055                 || buffer.params().paragraph_separation
2056                                 == BufferParams::ParagraphIndentSeparation)) {
2057                         // use the parindent of the layout when the
2058                         // default indentation is used otherwise use
2059                         // the indentation set in the document
2060                         // settings
2061                         if (buffer.params().getIndentation().asLyXCommand() == "default")
2062                                 l_margin += theFontMetrics(
2063                                         buffer.params().getFont()).signedWidth(parindent);
2064                         else
2065                                 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2066                 }
2067
2068         return l_margin;
2069 }
2070
2071
2072 #ifdef KEEP_OLD_METRICS_CODE
2073 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2074 {
2075         ParagraphMetrics const & pm = par_metrics_[pit];
2076
2077         return pm.singleWidth(pos, displayFont(pit, pos));
2078 }
2079 #endif
2080
2081 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2082 {
2083         if (par_metrics_.empty())
2084                 return;
2085
2086         origin_.x_ = x;
2087         origin_.y_ = y;
2088
2089         ParMetricsCache::iterator it = par_metrics_.begin();
2090         ParMetricsCache::iterator const pm_end = par_metrics_.end();
2091         y -= it->second.ascent();
2092         for (; it != pm_end; ++it) {
2093                 ParagraphMetrics const & pmi = it->second;
2094                 y += pmi.ascent();
2095                 pit_type const pit = it->first;
2096                 // Save the paragraph position in the cache.
2097                 it->second.setPosition(y);
2098                 drawParagraph(pi, pit, x, y);
2099                 y += pmi.descent();
2100         }
2101 }
2102
2103
2104 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2105 {
2106         BufferParams const & bparams = bv_->buffer().params();
2107         ParagraphMetrics const & pm = par_metrics_[pit];
2108         if (pm.rows().empty())
2109                 return;
2110
2111         bool const original_drawing_state = pi.pain.isDrawingEnabled();
2112         int const ww = bv_->workHeight();
2113         size_t const nrows = pm.rows().size();
2114
2115         Cursor const & cur = bv_->cursor();
2116         DocIterator sel_beg = cur.selectionBegin();
2117         DocIterator sel_end = cur.selectionEnd();
2118         bool selection = cur.selection()
2119                 // This is our text.
2120                 && cur.text() == text_
2121                 // if the anchor is outside, this is not our selection
2122                 && cur.normalAnchor().text() == text_
2123                 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2124
2125         // We store the begin and end pos of the selection relative to this par
2126         DocIterator sel_beg_par = cur.selectionBegin();
2127         DocIterator sel_end_par = cur.selectionEnd();
2128
2129         // We care only about visible selection.
2130         if (selection) {
2131                 if (pit != sel_beg.pit()) {
2132                         sel_beg_par.pit() = pit;
2133                         sel_beg_par.pos() = 0;
2134                 }
2135                 if (pit != sel_end.pit()) {
2136                         sel_end_par.pit() = pit;
2137                         sel_end_par.pos() = sel_end_par.lastpos();
2138                 }
2139         }
2140
2141         for (size_t i = 0; i != nrows; ++i) {
2142
2143                 Row const & row = pm.rows()[i];
2144                 if (i)
2145                         y += row.ascent();
2146
2147                 bool const inside = (y + row.descent() >= 0
2148                         && y - row.ascent() < ww);
2149                 // It is not needed to draw on screen if we are not inside.
2150                 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2151                 RowPainter rp(pi, *text_, pit, row, x, y);
2152
2153                 if (selection)
2154                         row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2155                 else
2156                         row.setSelection(-1, -1);
2157
2158                 // The row knows nothing about the paragraph, so we have to check
2159                 // whether this row is the first or last and update the margins.
2160                 if (row.selection()) {
2161                         if (row.sel_beg == 0)
2162                                 row.begin_margin_sel = sel_beg.pit() < pit;
2163                         if (row.sel_end == sel_end_par.lastpos())
2164                                 row.end_margin_sel = sel_end.pit() > pit;
2165                 }
2166
2167                 // Row signature; has row changed since last paint?
2168                 row.setCrc(pm.computeRowSignature(row, bparams));
2169                 bool row_has_changed = row.changed();
2170
2171                 // Take this opportunity to spellcheck the row contents.
2172                 if (row_has_changed && lyxrc.spellcheck_continuously) {
2173                         text_->getPar(pit).spellCheck();
2174                 }
2175
2176                 // Don't paint the row if a full repaint has not been requested
2177                 // and if it has not changed.
2178                 if (!pi.full_repaint && !row_has_changed) {
2179                         // Paint only the insets if the text itself is
2180                         // unchanged.
2181                         rp.paintOnlyInsets();
2182                         y += row.descent();
2183                         continue;
2184                 }
2185
2186                 // Clear background of this row if paragraph background was not
2187                 // already cleared because of a full repaint.
2188                 if (!pi.full_repaint && row_has_changed) {
2189                         pi.pain.fillRectangle(x, y - row.ascent(),
2190                                 width(), row.height(), pi.background_color);
2191                 }
2192
2193                 // Instrumentation for testing row cache (see also
2194                 // 12 lines lower):
2195                 if (lyxerr.debugging(Debug::PAINTING) && inside
2196                         && (row.selection() || pi.full_repaint || row_has_changed)) {
2197                                 string const foreword = text_->isMainText() ?
2198                                         "main text redraw " : "inset text redraw: ";
2199                         LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2200                                 << " row_selection="    << row.selection()
2201                                 << " full_repaint="     << pi.full_repaint
2202                                 << " row_has_changed="  << row_has_changed);
2203                 }
2204
2205                 // Backup full_repaint status and force full repaint
2206                 // for inner insets as the Row has been cleared out.
2207                 bool tmp = pi.full_repaint;
2208                 pi.full_repaint = true;
2209
2210                 rp.paintSelection();
2211                 rp.paintAppendix();
2212                 rp.paintDepthBar();
2213                 rp.paintChangeBar();
2214                 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2215                 if (i == 0 && !is_rtl)
2216                         rp.paintFirst();
2217                 if (i == nrows - 1 && is_rtl)
2218                         rp.paintLast();
2219                 rp.paintText();
2220                 if (i == nrows - 1 && !is_rtl)
2221                         rp.paintLast();
2222                 if (i == 0 && is_rtl)
2223                         rp.paintFirst();
2224                 y += row.descent();
2225
2226                 // Restore full_repaint status.
2227                 pi.full_repaint = tmp;
2228         }
2229         // Re-enable screen drawing for future use of the painter.
2230         pi.pain.setDrawingEnabled(original_drawing_state);
2231
2232         //LYXERR(Debug::PAINTING, ".");
2233 }
2234
2235
2236 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2237         Dimension & dim) const
2238 {
2239         Cursor const & bvcur = cur.bv().cursor();
2240
2241         // get word in front of cursor
2242         docstring word = text_->previousWord(bvcur.top());
2243         DocIterator wordStart = bvcur;
2244         wordStart.pos() -= word.length();
2245
2246         // get position on screen of the word start and end
2247         //FIXME: Is it necessary to explicitly set this to false?
2248         wordStart.boundary(false);
2249         Point lxy = cur.bv().getPos(wordStart);
2250         Point rxy = cur.bv().getPos(bvcur);
2251
2252         // calculate dimensions of the word
2253         Row row;
2254         row.pos(wordStart.pos());
2255         row.endpos(bvcur.pos());
2256         setRowHeight(row, bvcur.pit(), false);
2257         dim = row.dimension();
2258         dim.wid = abs(rxy.x_ - lxy.x_);
2259
2260         // calculate position of word
2261         y = lxy.y_;
2262         x = min(rxy.x_, lxy.x_);
2263
2264         //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2265         //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2266 }
2267
2268 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2269 //{
2270 //      ParagraphMetrics const & pm = par_metrics_[pit];
2271 //      Row const & r = pm.rows()[row];
2272 //      int x = 0;
2273 //      pos -= r.pos();
2274 //}
2275
2276
2277 int defaultRowHeight()
2278 {
2279         return int(theFontMetrics(sane_font).maxHeight() *  1.2);
2280 }
2281
2282 } // namespace lyx