src/TextMetrics.cpp

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