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 "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "BufferView.h"
  25 #include "paragraph_funcs.h"
  26 #include "ParIterator.h"
  27 #include "CoordCache.h"
  28 #include "debug.h"
  29 #include "FuncRequest.h"
  30 #include "FontIterator.h"
  31 #include "Color.h"
  32 #include "Length.h"
  33 #include "LyXRC.h"
  34 #include "Text.h"
  35 #include "MetricsInfo.h"
  36 #include "ParagraphParameters.h"
  37 #include "VSpace.h"
  38
  39 #include "frontends/FontMetrics.h"
  40 #include "frontends/Painter.h"
  41
  42 using std::max;
  43 using std::min;
  44 using std::endl;
  45
  46 namespace lyx {
  47
  48 using frontend::FontMetrics;
  49
  50 namespace {
  51
  52 int numberOfSeparators(Paragraph const & par, Row const & row)
  53 {
  54         pos_type const first = max(row.pos(), par.beginOfBody());
  55         pos_type const last = row.endpos() - 1;
  56         int n = 0;
  57         for (pos_type p = first; p < last; ++p) {
  58                 if (par.isSeparator(p))
  59                         ++n;
  60         }
  61         return n;
  62 }
  63
  64
  65 int numberOfLabelHfills(Paragraph const & par, Row const & row)
  66 {
  67         pos_type last = row.endpos() - 1;
  68         pos_type first = row.pos();
  69
  70         // hfill *DO* count at the beginning of paragraphs!
  71         if (first) {
  72                 while (first < last && par.isHfill(first))
  73                         ++first;
  74         }
  75
  76         last = min(last, par.beginOfBody());
  77         int n = 0;
  78         for (pos_type p = first; p < last; ++p) {
  79                 if (par.isHfill(p))
  80                         ++n;
  81         }
  82         return n;
  83 }
  84
  85
  86 int numberOfHfills(Paragraph const & par, Row const & row)
  87 {
  88         pos_type const last = row.endpos();
  89         pos_type first = row.pos();
  90
  91         // hfill *DO* count at the beginning of paragraphs!
  92         if (first) {
  93                 while (first < last && par.isHfill(first))
  94                         ++first;
  95         }
  96
  97         first = max(first, par.beginOfBody());
  98
  99         int n = 0;
 100         for (pos_type p = first; p < last; ++p) {
 101                 if (par.isHfill(p))
 102                         ++n;
 103         }
 104         return n;
 105 }
 106
 107 } // namespace anon
 108
 109 TextMetrics::TextMetrics(BufferView * bv, Text * text)
 110         : bv_(bv), text_(text)
 111 {
 112         BOOST_ASSERT(bv_);
 113         max_width_ = bv_->workWidth();
 114         dim_.wid = max_width_;
 115         dim_.asc = 10;
 116         dim_.des = 10;
 117
 118         //text_->updateLabels(*bv->buffer());
 119 }
 120
 121
 122 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
 123 {
 124         return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
 125 }
 126
 127
 128 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit,
 129                 bool redo)
 130 {
 131         ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
 132         if (pmc_it == par_metrics_.end()) {
 133                 pmc_it = par_metrics_.insert(
 134                         std::make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
 135         }
 136         if (pmc_it->second.rows().empty() && redo) {
 137                 redoParagraph(pit);
 138         }
 139         return pmc_it->second;
 140 }
 141
 142
 143 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim)
 144 {
 145         BOOST_ASSERT(mi.base.textwidth);
 146         max_width_ = mi.base.textwidth;
 147
 148         //lyxerr << "Text::metrics: width: " << mi.base.textwidth
 149         //      << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
 150
 151         bool changed = false;
 152
 153         unsigned int h = 0;
 154         unsigned int w = 0;
 155         for (pit_type pit = 0, n = text_->paragraphs().size(); pit != n; ++pit) {
 156                 changed |= redoParagraph(pit);
 157                 ParagraphMetrics const & pm = parMetrics(pit);
 158                 h += pm.height();
 159                 if (w < pm.width())
 160                         w = pm.width();
 161         }
 162
 163         dim.wid = w;
 164         dim.asc = parMetrics(0).ascent();
 165         dim.des = h - dim.asc;
 166
 167         changed |= dim_ != dim;
 168         dim_ = dim;
 169         return changed;
 170 }
 171
 172
 173 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
 174 {
 175         return main_text_? pm.rightMargin(*bv_->buffer()) : 0;
 176 }
 177
 178
 179 int TextMetrics::rightMargin(pit_type const pit) const
 180 {
 181         return main_text_? par_metrics_[pit].rightMargin(*bv_->buffer()) : 0;
 182 }
 183
 184
 185 bool TextMetrics::redoParagraph(pit_type const pit)
 186 {
 187         Paragraph & par = text_->getPar(pit);
 188         ParagraphMetrics pm(par);
 189         Buffer & buffer = *bv_->buffer();
 190         main_text_ = (text_ == &buffer.text());
 191         bool changed = false;
 192
 193         // FIXME: this has nothing to do here and is the reason why text_ is not
 194         // const.
 195         if (par.checkBiblio(buffer.params().trackChanges))
 196                 const_cast<Cursor &>(bv_->cursor()).posRight();
 197
 198         // Optimisation: this is used in the next two loops
 199         // so better to calculate that once here.
 200         int const right_margin = rightMargin(pm);
 201
 202         // redo insets
 203         // FIXME: We should always use getFont(), see documentation of
 204         // noFontChange() in Inset.h.
 205         Font const bufferfont = buffer.params().getFont();
 206         InsetList::const_iterator ii = par.insetlist.begin();
 207         InsetList::const_iterator iend = par.insetlist.end();
 208         for (; ii != iend; ++ii) {
 209                 Dimension dim;
 210                 int const w = max_width_ - text_->leftMargin(buffer, max_width_, pit, ii->pos)
 211                         - right_margin;
 212                 Font const & font = ii->inset->noFontChange() ?
 213                         bufferfont : text_->getFont(buffer, par, ii->pos);
 214                 MetricsInfo mi(bv_, font, w);
 215                 changed |= ii->inset->metrics(mi, dim);
 216         }
 217
 218         // rebreak the paragraph
 219         pm.rows().clear();
 220
 221         par.setBeginOfBody();
 222         pos_type z = 0;
 223         // maximum pixel width of a row
 224         int width = max_width_ - right_margin; // - leftMargin(buffer, max_width_, pit, row);
 225         do {
 226                 Row row(z);
 227                 rowBreakPoint(width, pit, row);
 228                 setRowWidth(right_margin, pit, row);
 229                 setHeightOfRow(pit, row);
 230                 pm.rows().push_back(row);
 231                 pm.dim().wid = std::max(pm.dim().wid, row.width());
 232                 pm.dim().des += row.height();
 233                 z = row.endpos();
 234         } while (z < par.size());
 235
 236         // Make sure that if a par ends in newline, there is one more row
 237         // under it
 238         // FIXME this is a dirty trick. Now the _same_ position in the
 239         // paragraph occurs in _two_ different rows, and has two different
 240         // display positions, leading to weird behaviour when moving up/down.
 241         if (z > 0 && par.isNewline(z - 1)) {
 242                 Row row(z - 1);
 243                 row.endpos(z - 1);
 244                 setRowWidth(right_margin, pit, row);
 245                 setHeightOfRow(pit, row);
 246                 pm.rows().push_back(row);
 247                 pm.dim().des += row.height();
 248         }
 249
 250         pm.dim().asc += pm.rows()[0].ascent();
 251         pm.dim().des -= pm.rows()[0].ascent();
 252
 253         // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
 254         // redoParagraph() recursively inside parMetrics.
 255         Dimension old_dim = parMetrics(pit, false).dim();
 256
 257         changed |= old_dim.height() != pm.dim().height();
 258
 259         par_metrics_[pit] = pm;
 260
 261         // Update the row change statuses. The painter will need that info
 262         // in order to know which row has to be repainted.
 263         par_metrics_[pit].updateRowChangeStatus();
 264
 265         return changed;
 266 }
 267
 268 RowMetrics TextMetrics::computeRowMetrics(pit_type const pit,
 269                 Row const & row) const
 270 {
 271         RowMetrics result;
 272         Buffer & buffer = *bv_->buffer();
 273         Paragraph const & par = text_->getPar(pit);
 274
 275         double w = dim_.wid - row.width();
 276
 277         bool const is_rtl = text_->isRTL(buffer, par);
 278         if (is_rtl)
 279                 result.x = rightMargin(pit);
 280         else
 281                 result.x = text_->leftMargin(buffer, max_width_, pit, row.pos());
 282
 283         // is there a manual margin with a manual label
 284         Layout_ptr const & layout = par.layout();
 285
 286         if (layout->margintype == MARGIN_MANUAL
 287             && layout->labeltype == LABEL_MANUAL) {
 288                 /// We might have real hfills in the label part
 289                 int nlh = numberOfLabelHfills(par, row);
 290
 291                 // A manual label par (e.g. List) has an auto-hfill
 292                 // between the label text and the body of the
 293                 // paragraph too.
 294                 // But we don't want to do this auto hfill if the par
 295                 // is empty.
 296                 if (!par.empty())
 297                         ++nlh;
 298
 299                 if (nlh && !par.getLabelWidthString().empty())
 300                         result.label_hfill = labelFill(par, row) / double(nlh);
 301         }
 302
 303         // are there any hfills in the row?
 304         int const nh = numberOfHfills(par, row);
 305
 306         if (nh) {
 307                 if (w > 0)
 308                         result.hfill = w / nh;
 309         // we don't have to look at the alignment if it is ALIGN_LEFT and
 310         // if the row is already larger then the permitted width as then
 311         // we force the LEFT_ALIGN'edness!
 312         } else if (int(row.width()) < max_width_) {
 313                 // is it block, flushleft or flushright?
 314                 // set x how you need it
 315                 int align;
 316                 if (par.params().align() == LYX_ALIGN_LAYOUT)
 317                         align = layout->align;
 318                 else
 319                         align = par.params().align();
 320
 321                 // Display-style insets should always be on a centred row
 322                 // The test on par.size() is to catch zero-size pars, which
 323                 // would trigger the assert in Paragraph::getInset().
 324                 //inset = par.size() ? par.getInset(row.pos()) : 0;
 325                 if (!par.empty()
 326                     && par.isInset(row.pos())
 327                     && par.getInset(row.pos())->display())
 328                 {
 329                         align = LYX_ALIGN_CENTER;
 330                 }
 331
 332                 switch (align) {
 333                 case LYX_ALIGN_BLOCK: {
 334                         int const ns = numberOfSeparators(par, row);
 335                         bool disp_inset = false;
 336                         if (row.endpos() < par.size()) {
 337                                 Inset const * in = par.getInset(row.endpos());
 338                                 if (in)
 339                                         disp_inset = in->display();
 340                         }
 341                         // If we have separators, this is not the last row of a
 342                         // par, does not end in newline, and is not row above a
 343                         // display inset... then stretch it
 344                         if (ns
 345                             && row.endpos() < par.size()
 346                             && !par.isNewline(row.endpos() - 1)
 347                             && !disp_inset
 348                                 ) {
 349                                 result.separator = w / ns;
 350                         } else if (is_rtl) {
 351                                 result.x += w;
 352                         }
 353                         break;
 354                 }
 355                 case LYX_ALIGN_RIGHT:
 356                         result.x += w;
 357                         break;
 358                 case LYX_ALIGN_CENTER:
 359                         result.x += w / 2;
 360                         break;
 361                 }
 362         }
 363
 364         text_->bidi.computeTables(par, buffer, row);
 365         if (is_rtl) {
 366                 pos_type body_pos = par.beginOfBody();
 367                 pos_type end = row.endpos();
 368
 369                 if (body_pos > 0
 370                     && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
 371                 {
 372                         docstring const lsep = from_utf8(layout->labelsep);
 373                         result.x += theFontMetrics(text_->getLabelFont(buffer, par)).width(lsep);
 374                         if (body_pos <= end)
 375                                 result.x += result.label_hfill;
 376                 }
 377         }
 378
 379         return result;
 380 }
 381
 382
 383 int TextMetrics::labelFill(Paragraph const & par, Row const & row) const
 384 {
 385         Buffer & buffer = *bv_->buffer();
 386
 387         pos_type last = par.beginOfBody();
 388         BOOST_ASSERT(last > 0);
 389
 390         // -1 because a label ends with a space that is in the label
 391         --last;
 392
 393         // a separator at this end does not count
 394         if (par.isLineSeparator(last))
 395                 --last;
 396
 397         int w = 0;
 398         for (pos_type i = row.pos(); i <= last; ++i)
 399                 w += text_->singleWidth(buffer, par, i);
 400
 401         docstring const & label = par.params().labelWidthString();
 402         if (label.empty())
 403                 return 0;
 404
 405         FontMetrics const & fm
 406                 = theFontMetrics(text_->getLabelFont(buffer, par));
 407
 408         return max(0, fm.width(label) - w);
 409 }
 410
 411
 412 namespace {
 413
 414 // this needs special handling - only newlines count as a break point
 415 pos_type addressBreakPoint(pos_type i, Paragraph const & par)
 416 {
 417         pos_type const end = par.size();
 418
 419         for (; i < end; ++i)
 420                 if (par.isNewline(i))
 421                         return i + 1;
 422
 423         return end;
 424 }
 425
 426 };
 427
 428
 429 int TextMetrics::labelEnd(pit_type const pit) const
 430 {
 431         // labelEnd is only needed if the layout fills a flushleft label.
 432         if (text_->getPar(pit).layout()->margintype != MARGIN_MANUAL)
 433                 return 0;
 434         // return the beginning of the body
 435         return text_->leftMargin(*bv_->buffer(), max_width_, pit);
 436 }
 437
 438
 439 void TextMetrics::rowBreakPoint(int width, pit_type const pit,
 440                 Row & row) const
 441 {
 442         Buffer & buffer = *bv_->buffer();
 443         Paragraph const & par = text_->getPar(pit);
 444         pos_type const end = par.size();
 445         pos_type const pos = row.pos();
 446         if (pos == end) {
 447                 row.endpos(end);
 448                 return;
 449         }
 450
 451         if (width < 0) {
 452                 row.endpos(end);
 453                 return;
 454         }
 455
 456         Layout_ptr const & layout = par.layout();
 457
 458         if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX) {
 459                 row.endpos(addressBreakPoint(pos, par));
 460                 return;
 461         }
 462
 463         pos_type const body_pos = par.beginOfBody();
 464
 465
 466         // Now we iterate through until we reach the right margin
 467         // or the end of the par, then choose the possible break
 468         // nearest that.
 469
 470         int label_end = labelEnd(pit);
 471         int const left = text_->leftMargin(buffer, max_width_, pit, pos);
 472         int x = left;
 473
 474         // pixel width since last breakpoint
 475         int chunkwidth = 0;
 476
 477         FontIterator fi = FontIterator(buffer, *text_, par, pos);
 478         pos_type point = end;
 479         pos_type i = pos;
 480         FontMetrics const & fm = theFontMetrics(text_->getLabelFont(buffer, par));
 481         for ( ; i < end; ++i, ++fi) {
 482                 char_type const c = par.getChar(i);
 483                 int thiswidth = text_->singleWidth(par, i, c, *fi);
 484
 485                 // add the auto-hfill from label end to the body
 486                 if (body_pos && i == body_pos) {
 487                         docstring lsep = from_utf8(layout->labelsep);
 488                         int add = fm.width(lsep);
 489                         if (par.isLineSeparator(i - 1))
 490                                 add -= text_->singleWidth(buffer, par, i - 1);
 491
 492                         add = std::max(add, label_end - x);
 493                         thiswidth += add;
 494                 }
 495
 496                 x += thiswidth;
 497                 chunkwidth += thiswidth;
 498
 499                 // break before a character that will fall off
 500                 // the right of the row
 501                 if (x >= width) {
 502                         // if no break before, break here
 503                         if (point == end || chunkwidth >= width - left) {
 504                                 if (i > pos)
 505                                         point = i;
 506                                 else
 507                                         point = i + 1;
 508
 509                         }
 510                         // exit on last registered breakpoint:
 511                         break;
 512                 }
 513
 514                 if (par.isNewline(i)) {
 515                         point = i + 1;
 516                         break;
 517                 }
 518                 // Break before...
 519                 if (i + 1 < end) {
 520                         if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
 521                                 point = i + 1;
 522                                 break;
 523                         }
 524                         // ...and after.
 525                         if (par.isInset(i) && par.getInset(i)->display()) {
 526                                 point = i + 1;
 527                                 break;
 528                         }
 529                 }
 530
 531                 if (!par.isInset(i) || par.getInset(i)->isChar()) {
 532                         // some insets are line separators too
 533                         if (par.isLineSeparator(i)) {
 534                                 // register breakpoint:
 535                                 point = i + 1;
 536                                 chunkwidth = 0;
 537                         }
 538                 }
 539         }
 540
 541         // maybe found one, but the par is short enough.
 542         if (i == end && x < width)
 543                 point = end;
 544
 545         // manual labels cannot be broken in LaTeX. But we
 546         // want to make our on-screen rendering of footnotes
 547         // etc. still break
 548         if (body_pos && point < body_pos)
 549                 point = body_pos;
 550
 551         row.endpos(point);
 552 }
 553
 554
 555 void TextMetrics::setRowWidth(int right_margin,
 556                 pit_type const pit, Row & row) const
 557 {
 558         Buffer & buffer = *bv_->buffer();
 559         // get the pure distance
 560         pos_type const end = row.endpos();
 561
 562         Paragraph const & par = text_->getPar(pit);
 563         docstring const labelsep = from_utf8(par.layout()->labelsep);
 564         int w = text_->leftMargin(buffer, max_width_, pit, row.pos());
 565         int label_end = labelEnd(pit);
 566
 567         pos_type const body_pos = par.beginOfBody();
 568         pos_type i = row.pos();
 569
 570         FontMetrics const & fm = theFontMetrics(text_->getLabelFont(buffer, par));
 571
 572         if (i < end) {
 573                 FontIterator fi = FontIterator(buffer, *text_, par, i);
 574                 for ( ; i < end; ++i, ++fi) {
 575                         if (body_pos > 0 && i == body_pos) {
 576                                 w += fm.width(labelsep);
 577                                 if (par.isLineSeparator(i - 1))
 578                                         w -= text_->singleWidth(buffer, par, i - 1);
 579                                 w = max(w, label_end);
 580                         }
 581                         char_type const c = par.getChar(i);
 582                         w += text_->singleWidth(par, i, c, *fi);
 583                 }
 584         }
 585
 586         if (body_pos > 0 && body_pos >= end) {
 587                 w += fm.width(labelsep);
 588                 if (end > 0 && par.isLineSeparator(end - 1))
 589                         w -= text_->singleWidth(buffer, par, end - 1);
 590                 w = max(w, label_end);
 591         }
 592
 593         row.width(w + right_margin);
 594 }
 595
 596
 597 void TextMetrics::setHeightOfRow(pit_type const pit,
 598                 Row & row)
 599 {
 600         Paragraph const & par = text_->getPar(pit);
 601         // get the maximum ascent and the maximum descent
 602         double layoutasc = 0;
 603         double layoutdesc = 0;
 604         double const dh = defaultRowHeight();
 605
 606         // ok, let us initialize the maxasc and maxdesc value.
 607         // Only the fontsize count. The other properties
 608         // are taken from the layoutfont. Nicer on the screen :)
 609         Layout_ptr const & layout = par.layout();
 610
 611         // as max get the first character of this row then it can
 612         // increase but not decrease the height. Just some point to
 613         // start with so we don't have to do the assignment below too
 614         // often.
 615         Buffer const & buffer = *bv_->buffer();
 616         Font font = text_->getFont(buffer, par, row.pos());
 617         Font::FONT_SIZE const tmpsize = font.size();
 618         font = text_->getLayoutFont(buffer, pit);
 619         Font::FONT_SIZE const size = font.size();
 620         font.setSize(tmpsize);
 621
 622         Font labelfont = text_->getLabelFont(buffer, par);
 623
 624         FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
 625         FontMetrics const & fontmetrics = theFontMetrics(font);
 626
 627         // these are minimum values
 628         double const spacing_val = layout->spacing.getValue()
 629                 * text_->spacing(buffer, par);
 630         //lyxerr << "spacing_val = " << spacing_val << endl;
 631         int maxasc  = int(fontmetrics.maxAscent()  * spacing_val);
 632         int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
 633
 634         // insets may be taller
 635         InsetList::const_iterator ii = par.insetlist.begin();
 636         InsetList::const_iterator iend = par.insetlist.end();
 637         for ( ; ii != iend; ++ii) {
 638                 if (ii->pos >= row.pos() && ii->pos < row.endpos()) {
 639                         maxasc  = max(maxasc,  ii->inset->ascent());
 640                         maxdesc = max(maxdesc, ii->inset->descent());
 641                 }
 642         }
 643
 644         // Check if any custom fonts are larger (Asger)
 645         // This is not completely correct, but we can live with the small,
 646         // cosmetic error for now.
 647         int labeladdon = 0;
 648         pos_type const pos_end = row.endpos();
 649
 650         Font::FONT_SIZE maxsize =
 651                 par.highestFontInRange(row.pos(), pos_end, size);
 652         if (maxsize > font.size()) {
 653                 font.setSize(maxsize);
 654                 maxasc  = max(maxasc,  fontmetrics.maxAscent());
 655                 maxdesc = max(maxdesc, fontmetrics.maxDescent());
 656         }
 657
 658         // This is nicer with box insets:
 659         ++maxasc;
 660         ++maxdesc;
 661
 662         row.ascent(maxasc);
 663         ParagraphList const & pars = text_->paragraphs();
 664
 665         // is it a top line?
 666         if (row.pos() == 0) {
 667                 BufferParams const & bufparams = buffer.params();
 668                 // some parskips VERY EASY IMPLEMENTATION
 669                 if (bufparams.paragraph_separation
 670                     == BufferParams::PARSEP_SKIP
 671                         && par.ownerCode() != Inset::ERT_CODE
 672                         && pit > 0
 673                         && ((layout->isParagraph() && par.getDepth() == 0)
 674                             || (pars[pit - 1].layout()->isParagraph()
 675                                 && pars[pit - 1].getDepth() == 0)))
 676                 {
 677                                 maxasc += bufparams.getDefSkip().inPixels(*bv_);
 678                 }
 679
 680                 if (par.params().startOfAppendix())
 681                         maxasc += int(3 * dh);
 682
 683                 // This is special code for the chapter, since the label of this
 684                 // layout is printed in an extra row
 685                 if (layout->counter == "chapter"
 686                     && !par.params().labelString().empty()) {
 687                         labeladdon = int(labelfont_metrics.maxHeight()
 688                                      * layout->spacing.getValue()
 689                                      * text_->spacing(buffer, par));
 690                 }
 691
 692                 // special code for the top label
 693                 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
 694                      || layout->labeltype == LABEL_BIBLIO
 695                      || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
 696                     && isFirstInSequence(pit, pars)
 697                     && !par.getLabelstring().empty())
 698                 {
 699                         labeladdon = int(
 700                                   labelfont_metrics.maxHeight()
 701                                         * layout->spacing.getValue()
 702                                         * text_->spacing(buffer, par)
 703                                 + (layout->topsep + layout->labelbottomsep) * dh);
 704                 }
 705
 706                 // Add the layout spaces, for example before and after
 707                 // a section, or between the items of a itemize or enumerate
 708                 // environment.
 709
 710                 pit_type prev = depthHook(pit, pars, par.getDepth());
 711                 Paragraph const & prevpar = pars[prev];
 712                 if (prev != pit
 713                     && prevpar.layout() == layout
 714                     && prevpar.getDepth() == par.getDepth()
 715                     && prevpar.getLabelWidthString()
 716                                         == par.getLabelWidthString()) {
 717                         layoutasc = layout->itemsep * dh;
 718                 } else if (pit != 0 || row.pos() != 0) {
 719                         if (layout->topsep > 0)
 720                                 layoutasc = layout->topsep * dh;
 721                 }
 722
 723                 prev = outerHook(pit, pars);
 724                 if (prev != pit_type(pars.size())) {
 725                         maxasc += int(pars[prev].layout()->parsep * dh);
 726                 } else if (pit != 0) {
 727                         Paragraph const & prevpar = pars[pit - 1];
 728                         if (prevpar.getDepth() != 0 ||
 729                                         prevpar.layout() == layout) {
 730                                 maxasc += int(layout->parsep * dh);
 731                         }
 732                 }
 733         }
 734
 735         // is it a bottom line?
 736         if (row.endpos() >= par.size()) {
 737                 // add the layout spaces, for example before and after
 738                 // a section, or between the items of a itemize or enumerate
 739                 // environment
 740                 pit_type nextpit = pit + 1;
 741                 if (nextpit != pit_type(pars.size())) {
 742                         pit_type cpit = pit;
 743                         double usual = 0;
 744                         double unusual = 0;
 745
 746                         if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
 747                                 usual = pars[cpit].layout()->bottomsep * dh;
 748                                 cpit = depthHook(cpit, pars, pars[nextpit].getDepth());
 749                                 if (pars[cpit].layout() != pars[nextpit].layout()
 750                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
 751                                 {
 752                                         unusual = pars[cpit].layout()->bottomsep * dh;
 753                                 }
 754                                 layoutdesc = max(unusual, usual);
 755                         } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
 756                                 if (pars[cpit].layout() != pars[nextpit].layout()
 757                                         || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
 758                                         layoutdesc = int(pars[cpit].layout()->bottomsep * dh);
 759                         }
 760                 }
 761         }
 762
 763         // incalculate the layout spaces
 764         maxasc  += int(layoutasc  * 2 / (2 + pars[pit].getDepth()));
 765         maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
 766
 767         // FIXME: the correct way is to do the following is to move the
 768         // following code in another method specially tailored for the
 769         // main Text. The following test is thus bogus.
 770         // Top and bottom margin of the document (only at top-level)
 771         if (main_text_) {
 772                 if (pit == 0 && row.pos() == 0)
 773                         maxasc += 20;
 774                 if (pit + 1 == pit_type(pars.size()) &&
 775                     row.endpos() == par.size())
 776                         maxdesc += 20;
 777         }
 778
 779         row.ascent(maxasc + labeladdon);
 780         row.descent(maxdesc);
 781 }
 782
 783
 784 // x is an absolute screen coord
 785 // returns the column near the specified x-coordinate of the row
 786 // x is set to the real beginning of this column
 787 pos_type TextMetrics::getColumnNearX(pit_type const pit,
 788                 Row const & row, int & x, bool & boundary) const
 789 {
 790         Buffer const & buffer = *bv_->buffer();
 791
 792         /// For the main Text, it is possible that this pit is not
 793         /// yet in the CoordCache when moving cursor up.
 794         /// x Paragraph coordinate is always 0 for main text anyway.
 795         int const xo = main_text_? 0 : bv_->coordCache().get(text_, pit).x_;
 796         x -= xo;
 797         RowMetrics const r = computeRowMetrics(pit, row);
 798         Paragraph const & par = text_->getPar(pit);
 799
 800         pos_type vc = row.pos();
 801         pos_type end = row.endpos();
 802         pos_type c = 0;
 803         Layout_ptr const & layout = par.layout();
 804
 805         bool left_side = false;
 806
 807         pos_type body_pos = par.beginOfBody();
 808
 809         double tmpx = r.x;
 810         double last_tmpx = tmpx;
 811
 812         if (body_pos > 0 &&
 813             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
 814                 body_pos = 0;
 815
 816         // check for empty row
 817         if (vc == end) {
 818                 x = int(tmpx) + xo;
 819                 return 0;
 820         }
 821
 822         frontend::FontMetrics const & fm
 823                 = theFontMetrics(text_->getLabelFont(buffer, par));
 824
 825         while (vc < end && tmpx <= x) {
 826                 c = text_->bidi.vis2log(vc);
 827                 last_tmpx = tmpx;
 828                 if (body_pos > 0 && c == body_pos - 1) {
 829                         // FIXME UNICODE
 830                         docstring const lsep = from_utf8(layout->labelsep);
 831                         tmpx += r.label_hfill + fm.width(lsep);
 832                         if (par.isLineSeparator(body_pos - 1))
 833                                 tmpx -= text_->singleWidth(buffer, par, body_pos - 1);
 834                 }
 835
 836                 if (par.hfillExpansion(row, c)) {
 837                         tmpx += text_->singleWidth(buffer, par, c);
 838                         if (c >= body_pos)
 839                                 tmpx += r.hfill;
 840                         else
 841                                 tmpx += r.label_hfill;
 842                 } else if (par.isSeparator(c)) {
 843                         tmpx += text_->singleWidth(buffer, par, c);
 844                         if (c >= body_pos)
 845                                 tmpx += r.separator;
 846                 } else {
 847                         tmpx += text_->singleWidth(buffer, par, c);
 848                 }
 849                 ++vc;
 850         }
 851
 852         if ((tmpx + last_tmpx) / 2 > x) {
 853                 tmpx = last_tmpx;
 854                 left_side = true;
 855         }
 856
 857         BOOST_ASSERT(vc <= end);  // This shouldn't happen.
 858
 859         boundary = false;
 860         // This (rtl_support test) is not needed, but gives
 861         // some speedup if rtl_support == false
 862         bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
 863
 864         // If lastrow is false, we don't need to compute
 865         // the value of rtl.
 866         bool const rtl = lastrow ? text_->isRTL(buffer, par) : false;
 867         if (lastrow &&
 868             ((rtl  &&  left_side && vc == row.pos() && x < tmpx - 5) ||
 869              (!rtl && !left_side && vc == end  && x > tmpx + 5)))
 870                 c = end;
 871         else if (vc == row.pos()) {
 872                 c = text_->bidi.vis2log(vc);
 873                 if (text_->bidi.level(c) % 2 == 1)
 874                         ++c;
 875         } else {
 876                 c = text_->bidi.vis2log(vc - 1);
 877                 bool const rtl = (text_->bidi.level(c) % 2 == 1);
 878                 if (left_side == rtl) {
 879                         ++c;
 880                         boundary = text_->bidi.isBoundary(buffer, par, c);
 881                 }
 882         }
 883
 884 // I believe this code is not needed anymore (Jug 20050717)
 885 #if 0
 886         // The following code is necessary because the cursor position past
 887         // the last char in a row is logically equivalent to that before
 888         // the first char in the next row. That's why insets causing row
 889         // divisions -- Newline and display-style insets -- must be treated
 890         // specially, so cursor up/down doesn't get stuck in an air gap -- MV
 891         // Newline inset, air gap below:
 892         if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
 893                 if (text_->bidi.level(end -1) % 2 == 0)
 894                         tmpx -= text_->singleWidth(buffer, par, end - 1);
 895                 else
 896                         tmpx += text_->singleWidth(buffer, par, end - 1);
 897                 c = end - 1;
 898         }
 899
 900         // Air gap above display inset:
 901         if (row.pos() < end && c >= end && end < par.size()
 902             && par.isInset(end) && par.getInset(end)->display()) {
 903                 c = end - 1;
 904         }
 905         // Air gap below display inset:
 906         if (row.pos() < end && c >= end && par.isInset(end - 1)
 907             && par.getInset(end - 1)->display()) {
 908                 c = end - 1;
 909         }
 910 #endif
 911
 912         x = int(tmpx) + xo;
 913         pos_type const col = c - row.pos();
 914
 915         if (!c || end == par.size())
 916                 return col;
 917
 918         if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
 919                 boundary = true;
 920                 return col;
 921         }
 922
 923         return min(col, end - 1 - row.pos());
 924 }
 925
 926
 927 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
 928 {
 929         ParagraphMetrics const & pm = parMetrics(pit);
 930         BOOST_ASSERT(!pm.rows().empty());
 931         BOOST_ASSERT(row < int(pm.rows().size()));
 932         bool bound = false;
 933         Row const & r = pm.rows()[row];
 934         return r.pos() + getColumnNearX(pit, r, x, bound);
 935 }
 936
 937
 938 //int Text::pos2x(pit_type pit, pos_type pos) const
 939 //{
 940 //      ParagraphMetrics const & pm = parMetrics(pit);
 941 //      Row const & r = pm.rows()[row];
 942 //      int x = 0;
 943 //      pos -= r.pos();
 944 //}
 945
 946
 947 int defaultRowHeight()
 948 {
 949         return int(theFontMetrics(Font(Font::ALL_SANE)).maxHeight() *  1.2);
 950 }
 951
 952 } // namespace lyx