src/TextMetrics.cpp

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