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