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