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.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
30 #include "support/debug.h"
31 #include "FontIterator.h"
32 #include "FuncRequest.h"
33 #include "InsetList.h"
37 #include "MetricsInfo.h"
38 #include "paragraph_funcs.h"
39 #include "ParagraphParameters.h"
40 #include "ParIterator.h"
41 #include "rowpainter.h"
43 #include "TextClass.h"
46 #include "mathed/MacroTable.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
56 using frontend::FontMetrics;
60 int numberOfSeparators(Paragraph const & par, Row const & row)
62 pos_type const first = max(row.pos(), par.beginOfBody());
63 pos_type const last = row.endpos() - 1;
65 for (pos_type p = first; p < last; ++p) {
66 if (par.isSeparator(p))
73 int numberOfLabelHfills(Paragraph const & par, Row const & row)
75 pos_type last = row.endpos() - 1;
76 pos_type first = row.pos();
78 // hfill *DO* count at the beginning of paragraphs!
80 while (first < last && par.isHfill(first))
84 last = min(last, par.beginOfBody());
86 for (pos_type p = first; p < last; ++p) {
94 int numberOfHfills(Paragraph const & par, Row const & row)
96 pos_type const last = row.endpos();
97 pos_type first = row.pos();
99 // hfill *DO* count at the beginning of paragraphs!
101 while (first < last && par.isHfill(first))
105 first = max(first, par.beginOfBody());
108 for (pos_type p = first; p < last; ++p) {
117 TextMetrics::TextMetrics(BufferView * bv, Text * text)
118 : bv_(bv), text_(text)
121 max_width_ = bv_->workWidth();
122 dim_.wid = max_width_;
126 //text_->updateLabels(bv->buffer());
130 bool TextMetrics::has(pit_type pit) const
132 return par_metrics_.find(pit) != par_metrics_.end();
136 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
138 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
143 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
145 ParMetricsCache::const_iterator it = par_metrics_.begin();
146 return make_pair(it->first, &it->second);
150 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
152 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
153 return make_pair(it->first, &it->second);
157 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
159 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
160 if (pmc_it == par_metrics_.end()) {
161 pmc_it = par_metrics_.insert(
162 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
164 if (pmc_it->second.rows().empty() && redo)
166 return pmc_it->second;
170 int TextMetrics::parPosition(pit_type pit) const
172 if (pit < par_metrics_.begin()->first)
174 if (pit > par_metrics_.rbegin()->first)
177 return par_metrics_[pit].position();
181 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
183 BOOST_ASSERT(mi.base.textwidth);
184 max_width_ = mi.base.textwidth;
185 // backup old dimension.
186 Dimension const old_dim = dim_;
189 dim_.wid = min_width;
190 pit_type const npar = text_->paragraphs().size();
192 // If there is more than one row, expand the text to
193 // the full allowable width.
194 dim_.wid = max_width_;
196 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
197 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
199 bool changed = false;
201 for (pit_type pit = 0; pit != npar; ++pit) {
202 changed |= redoParagraph(pit);
203 ParagraphMetrics const & pm = par_metrics_[pit];
205 if (dim_.wid < pm.width())
206 dim_.wid = pm.width();
209 dim_.asc = par_metrics_[0].ascent();
210 dim_.des = h - dim_.asc;
211 //lyxerr << "dim_.wid " << dim_.wid << endl;
212 //lyxerr << "dim_.asc " << dim_.asc << endl;
213 //lyxerr << "dim_.des " << dim_.des << endl;
215 changed |= dim_ != old_dim;
221 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
223 return main_text_? pm.rightMargin(bv_->buffer()) : 0;
227 int TextMetrics::rightMargin(pit_type const pit) const
229 return main_text_? par_metrics_[pit].rightMargin(bv_->buffer()) : 0;
233 void TextMetrics::applyOuterFont(Font & font) const
236 lf.fontInfo().reduce(bv_->buffer().params().getFont().fontInfo());
237 lf.fontInfo().realize(font.fontInfo());
238 lf.setLanguage(font.language());
243 Font TextMetrics::getDisplayFont(pit_type pit, pos_type pos) const
245 BOOST_ASSERT(pos >= 0);
247 ParagraphList const & pars = text_->paragraphs();
248 Paragraph const & par = pars[pit];
249 LayoutPtr const & layout = par.layout();
250 Buffer const & buffer = bv_->buffer();
252 BufferParams const & params = buffer.params();
253 pos_type const body_pos = par.beginOfBody();
255 // We specialize the 95% common case:
256 if (!par.getDepth()) {
257 Font f = par.getFontSettings(params, pos);
258 if (!text_->isMainText(buffer))
260 bool lab = layout->labeltype == LABEL_MANUAL && pos < body_pos;
262 FontInfo const & lf = lab ? layout->labelfont : layout->font;
263 FontInfo rlf = lab ? layout->reslabelfont : layout->resfont;
265 // In case the default family has been customized
266 if (lf.family() == INHERIT_FAMILY)
267 rlf.setFamily(params.getFont().fontInfo().family());
268 f.fontInfo().realize(rlf);
272 // The uncommon case need not be optimized as much
273 FontInfo const & layoutfont = pos < body_pos ?
274 layout->labelfont : layout->font;
276 Font font = par.getFontSettings(params, pos);
277 font.fontInfo().realize(layoutfont);
279 if (!text_->isMainText(buffer))
280 applyOuterFont(font);
282 // Realize against environment font information
283 // NOTE: the cast to pit_type should be removed when pit_type
284 // changes to a unsigned integer.
285 if (pit < pit_type(pars.size()))
286 font.fontInfo().realize(outerFont(pit, pars).fontInfo());
288 // Realize with the fonts of lesser depth.
289 font.fontInfo().realize(params.getFont().fontInfo());
295 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
297 if (!lyxrc.rtl_support || !sl.text())
301 if (boundary && sl.pos() > 0)
304 return getDisplayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
308 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
310 if (!lyxrc.rtl_support)
313 // no RTL boundary at line start
317 Paragraph const & par = text_->getPar(pit);
319 bool left = getDisplayFont(pit, pos - 1).isVisibleRightToLeft();
321 if (pos == par.size())
322 right = par.isRTL(bv_->buffer().params());
324 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
325 return left != right;
329 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
330 Font const & font) const
332 if (!lyxrc.rtl_support)
335 Paragraph const & par = text_->getPar(pit);
336 bool left = font.isVisibleRightToLeft();
338 if (pos == par.size())
339 right = par.isRTL(bv_->buffer().params());
341 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
342 return left != right;
346 bool TextMetrics::redoParagraph(pit_type const pit)
348 Paragraph & par = text_->getPar(pit);
349 // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
350 // redoParagraph() recursively inside parMetrics.
351 Dimension old_dim = parMetrics(pit, false).dim();
352 ParagraphMetrics & pm = par_metrics_[pit];
355 Buffer & buffer = bv_->buffer();
356 main_text_ = (text_ == &buffer.text());
357 bool changed = false;
359 // FIXME This check ought to be done somewhere else. It is the reason
360 // why text_ is not const. But then, where else to do it?
361 // Well, how can you end up with either (a) a biblio environment that
362 // has no InsetBibitem or (b) a biblio environment with more than one
363 // InsetBibitem? I think the answer is: when paragraphs are merged;
364 // when layout is set; when material is pasted.
365 int const moveCursor = par.checkBiblio(buffer.params().trackChanges);
367 const_cast<Cursor &>(bv_->cursor()).posForward();
368 else if (moveCursor < 0) {
369 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
370 if (cursor.pos() >= -moveCursor)
371 cursor.posBackward();
374 // Optimisation: this is used in the next two loops
375 // so better to calculate that once here.
376 int const right_margin = rightMargin(pm);
378 // iterator pointing to paragraph to resolve macros
379 DocIterator parPos = text_->macrocontextPosition();
384 // FIXME: We should always use getFont(), see documentation of
385 // noFontChange() in Inset.h.
386 Font const bufferfont = buffer.params().getFont();
387 InsetList::const_iterator ii = par.insetList().begin();
388 InsetList::const_iterator iend = par.insetList().end();
389 for (; ii != iend; ++ii) {
390 // position already initialized?
391 if (!parPos.empty()) {
392 parPos.pos() = ii->pos;
394 // A macro template would normally not be visible
395 // by itself. But the tex macro semantics allow
396 // recursion, so we artifically take the context
397 // after the macro template to simulate this.
398 if (ii->inset->lyxCode() == MATHMACRO_CODE)
402 // do the metric calculation
404 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
406 Font const & font = ii->inset->noFontChange() ?
407 bufferfont : getDisplayFont(pit, ii->pos);
408 MacroContext mc(buffer, parPos);
409 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
410 ii->inset->metrics(mi, dim);
411 Dimension const old_dim = pm.insetDimension(ii->inset);
412 pm.setInsetDimension(ii->inset, dim);
413 changed |= (old_dim != dim);
416 Cursor const & cur = bv_->cursor();
417 DocIterator sel_beg = cur.selectionBegin();
418 DocIterator sel_end = cur.selectionEnd();
419 bool selection = cur.selection()
421 && cur.text() == text_
422 // if the anchor is outside, this is not our selection
423 && cur.anchor().text() == text_
424 && pit >= sel_beg.pit() && pit <= sel_end.pit();
426 // We care only about visible selection.
428 if (pit != sel_beg.pit()) {
432 if (pit != sel_end.pit()) {
434 sel_end.pos() = sel_end.lastpos();
438 par.setBeginOfBody();
440 size_t row_index = 0;
441 // maximum pixel width of a row
442 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
445 pos_type end = rowBreakPoint(width, pit, first);
446 if (row_index || end < par.size())
447 // If there is more than one row, expand the text to
448 // the full allowable width. This setting here is needed
449 // for the computeRowMetrics() below.
450 dim_.wid = max_width_;
452 dim = rowHeight(pit, first, end);
453 dim.wid = rowWidth(right_margin, pit, first, end);
454 if (row_index == pm.rows().size())
455 pm.rows().push_back(Row());
456 Row & row = pm.rows()[row_index];
457 row.setChanged(false);
461 row.setSelection(sel_beg.pos(), sel_end.pos());
463 row.setSelection(-1, -1);
464 row.setDimension(dim);
465 int const max_row_width = max(dim_.wid, dim.wid);
466 computeRowMetrics(pit, row, max_row_width);
470 pm.dim().wid = max(pm.dim().wid, dim.wid);
471 pm.dim().des += dim.height();
472 } while (first < par.size());
474 if (row_index < pm.rows().size())
475 pm.rows().resize(row_index);
477 // Make sure that if a par ends in newline, there is one more row
479 if (first > 0 && par.isNewline(first - 1)) {
480 Dimension dim = rowHeight(pit, first, first);
481 dim.wid = rowWidth(right_margin, pit, first, first);
482 if (row_index == pm.rows().size())
483 pm.rows().push_back(Row());
484 Row & row = pm.rows()[row_index];
485 row.setChanged(false);
488 row.setDimension(dim);
489 int const max_row_width = max(dim_.wid, dim.wid);
490 computeRowMetrics(pit, row, max_row_width);
491 pm.dim().des += dim.height();
494 pm.dim().asc += pm.rows()[0].ascent();
495 pm.dim().des -= pm.rows()[0].ascent();
497 changed |= old_dim.height() != pm.dim().height();
503 void TextMetrics::computeRowMetrics(pit_type const pit,
504 Row & row, int width) const
509 Buffer & buffer = bv_->buffer();
510 Paragraph const & par = text_->getPar(pit);
512 double w = width - row.width();
513 // FIXME: put back this assertion when the crash on new doc is solved.
514 //BOOST_ASSERT(w >= 0);
516 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
517 //lyxerr << "row.width() " << row.width() << endl;
518 //lyxerr << "w " << w << endl;
520 bool const is_rtl = text_->isRTL(buffer, par);
522 row.x = rightMargin(pit);
524 row.x = leftMargin(max_width_, pit, row.pos());
526 // is there a manual margin with a manual label
527 LayoutPtr const & layout = par.layout();
529 if (layout->margintype == MARGIN_MANUAL
530 && layout->labeltype == LABEL_MANUAL) {
531 /// We might have real hfills in the label part
532 int nlh = numberOfLabelHfills(par, row);
534 // A manual label par (e.g. List) has an auto-hfill
535 // between the label text and the body of the
537 // But we don't want to do this auto hfill if the par
542 if (nlh && !par.getLabelWidthString().empty())
543 row.label_hfill = labelFill(pit, row) / double(nlh);
547 // are there any hfills in the row?
548 if (int const nh = numberOfHfills(par, row)) {
550 hfill = w / double(nh);
551 // we don't have to look at the alignment if it is ALIGN_LEFT and
552 // if the row is already larger then the permitted width as then
553 // we force the LEFT_ALIGN'edness!
554 } else if (int(row.width()) < max_width_) {
555 // is it block, flushleft or flushright?
556 // set x how you need it
558 if (par.params().align() == LYX_ALIGN_LAYOUT)
559 align = layout->align;
561 align = par.params().align();
563 // Display-style insets should always be on a centred row
564 // The test on par.size() is to catch zero-size pars, which
565 // would trigger the assert in Paragraph::getInset().
566 //inset = par.size() ? par.getInset(row.pos()) : 0;
567 if (row.pos() < par.size() && par.isInset(row.pos())) {
568 switch(par.getInset(row.pos())->display()) {
569 case Inset::AlignLeft:
570 align = LYX_ALIGN_BLOCK;
572 case Inset::AlignCenter:
573 align = LYX_ALIGN_CENTER;
576 case Inset::AlignRight:
577 // unchanged (use align)
583 case LYX_ALIGN_BLOCK: {
584 int const ns = numberOfSeparators(par, row);
585 bool disp_inset = false;
586 if (row.endpos() < par.size()) {
587 Inset const * in = par.getInset(row.endpos());
589 disp_inset = in->display();
591 // If we have separators, this is not the last row of a
592 // par, does not end in newline, and is not row above a
593 // display inset... then stretch it
595 && row.endpos() < par.size()
596 && !par.isNewline(row.endpos() - 1)
599 row.separator = w / ns;
600 //lyxerr << "row.separator " << row.separator << endl;
601 //lyxerr << "ns " << ns << endl;
607 case LYX_ALIGN_RIGHT:
610 case LYX_ALIGN_CENTER:
617 pos_type body_pos = par.beginOfBody();
618 pos_type end = row.endpos();
621 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
623 row.x += theFontMetrics(text_->getLabelFont(buffer, par)).
624 width(layout->labelsep);
626 row.x += row.label_hfill;
630 pos_type const endpos = row.endpos();
631 pos_type body_pos = par.beginOfBody();
633 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
636 ParagraphMetrics & pm = par_metrics_[pit];
637 InsetList::const_iterator ii = par.insetList().begin();
638 InsetList::const_iterator iend = par.insetList().end();
639 for ( ; ii != iend; ++ii) {
640 if (ii->pos >= endpos || ii->pos < row.pos()
641 || ii->inset->lyxCode() != HFILL_CODE)
643 Dimension dim = row.dimension();
644 if (pm.hfillExpansion(row, ii->pos))
645 dim.wid = int(ii->pos >= body_pos ?
646 max(hfill, 5.0) : row.label_hfill);
649 // Cache the inset dimension.
650 bv_->coordCache().insets().add(ii->inset, dim);
651 pm.setInsetDimension(ii->inset, dim);
656 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
658 Buffer & buffer = bv_->buffer();
659 Paragraph const & par = text_->getPar(pit);
661 pos_type last = par.beginOfBody();
662 BOOST_ASSERT(last > 0);
664 // -1 because a label ends with a space that is in the label
667 // a separator at this end does not count
668 if (par.isLineSeparator(last))
672 for (pos_type i = row.pos(); i <= last; ++i)
673 w += singleWidth(pit, i);
675 docstring const & label = par.params().labelWidthString();
679 FontMetrics const & fm
680 = theFontMetrics(text_->getLabelFont(buffer, par));
682 return max(0, fm.width(label) - w);
686 // this needs special handling - only newlines count as a break point
687 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
689 pos_type const end = par.size();
692 if (par.isNewline(i))
699 int TextMetrics::labelEnd(pit_type const pit) const
701 // labelEnd is only needed if the layout fills a flushleft label.
702 if (text_->getPar(pit).layout()->margintype != MARGIN_MANUAL)
704 // return the beginning of the body
705 return leftMargin(max_width_, pit);
709 pit_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
712 Buffer & buffer = bv_->buffer();
713 ParagraphMetrics const & pm = par_metrics_[pit];
714 Paragraph const & par = text_->getPar(pit);
715 pos_type const end = par.size();
716 if (pos == end || width < 0)
719 LayoutPtr const & layout = par.layout();
721 if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX)
722 return addressBreakPoint(pos, par);
724 pos_type const body_pos = par.beginOfBody();
727 // Now we iterate through until we reach the right margin
728 // or the end of the par, then choose the possible break
731 int label_end = labelEnd(pit);
732 int const left = leftMargin(max_width_, pit, pos);
735 // pixel width since last breakpoint
738 FontIterator fi = FontIterator(*this, par, pit, pos);
739 pos_type point = end;
741 for ( ; i < end; ++i, ++fi) {
742 int thiswidth = pm.singleWidth(i, *fi);
744 // add the auto-hfill from label end to the body
745 if (body_pos && i == body_pos) {
746 FontMetrics const & fm = theFontMetrics(
747 text_->getLabelFont(buffer, par));
748 int add = fm.width(layout->labelsep);
749 if (par.isLineSeparator(i - 1))
750 add -= singleWidth(pit, i - 1);
752 add = max(add, label_end - x);
757 chunkwidth += thiswidth;
759 // break before a character that will fall off
760 // the right of the row
762 // if no break before, break here
763 if (point == end || chunkwidth >= width - left) {
769 // exit on last registered breakpoint:
773 if (par.isNewline(i)) {
779 if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
784 if (par.isInset(i) && par.getInset(i)->display()) {
790 if (!par.isInset(i) || par.getInset(i)->isChar()) {
791 // some insets are line separators too
792 if (par.isLineSeparator(i)) {
793 // register breakpoint:
800 // maybe found one, but the par is short enough.
801 if (i == end && x < width)
804 // manual labels cannot be broken in LaTeX. But we
805 // want to make our on-screen rendering of footnotes
807 if (body_pos && point < body_pos)
814 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
815 pos_type const first, pos_type const end) const
817 Buffer & buffer = bv_->buffer();
818 // get the pure distance
819 ParagraphMetrics const & pm = par_metrics_[pit];
820 Paragraph const & par = text_->getPar(pit);
821 int w = leftMargin(max_width_, pit, first);
822 int label_end = labelEnd(pit);
824 pos_type const body_pos = par.beginOfBody();
828 FontIterator fi = FontIterator(*this, par, pit, i);
829 for ( ; i < end; ++i, ++fi) {
830 if (body_pos > 0 && i == body_pos) {
831 FontMetrics const & fm = theFontMetrics(
832 text_->getLabelFont(buffer, par));
833 w += fm.width(par.layout()->labelsep);
834 if (par.isLineSeparator(i - 1))
835 w -= singleWidth(pit, i - 1);
836 w = max(w, label_end);
838 w += pm.singleWidth(i, *fi);
842 if (body_pos > 0 && body_pos >= end) {
843 FontMetrics const & fm = theFontMetrics(
844 text_->getLabelFont(buffer, par));
845 w += fm.width(par.layout()->labelsep);
846 if (end > 0 && par.isLineSeparator(end - 1))
847 w -= singleWidth(pit, end - 1);
848 w = max(w, label_end);
851 return w + right_margin;
855 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
856 pos_type const end) const
858 Paragraph const & par = text_->getPar(pit);
859 // get the maximum ascent and the maximum descent
860 double layoutasc = 0;
861 double layoutdesc = 0;
862 double const dh = defaultRowHeight();
864 // ok, let us initialize the maxasc and maxdesc value.
865 // Only the fontsize count. The other properties
866 // are taken from the layoutfont. Nicer on the screen :)
867 LayoutPtr const & layout = par.layout();
869 // as max get the first character of this row then it can
870 // increase but not decrease the height. Just some point to
871 // start with so we don't have to do the assignment below too
873 Buffer const & buffer = bv_->buffer();
874 Font font = getDisplayFont(pit, first);
875 FontSize const tmpsize = font.fontInfo().size();
876 font.fontInfo() = text_->getLayoutFont(buffer, pit);
877 FontSize const size = font.fontInfo().size();
878 font.fontInfo().setSize(tmpsize);
880 FontInfo labelfont = text_->getLabelFont(buffer, par);
882 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
883 FontMetrics const & fontmetrics = theFontMetrics(font);
885 // these are minimum values
886 double const spacing_val = layout->spacing.getValue()
887 * text_->spacing(buffer, par);
888 //lyxerr << "spacing_val = " << spacing_val << endl;
889 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
890 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
892 // insets may be taller
893 ParagraphMetrics const & pm = par_metrics_[pit];
894 InsetList::const_iterator ii = par.insetList().begin();
895 InsetList::const_iterator iend = par.insetList().end();
896 for ( ; ii != iend; ++ii) {
897 Dimension const & dim = pm.insetDimension(ii->inset);
898 if (ii->pos >= first && ii->pos < end) {
899 maxasc = max(maxasc, dim.ascent());
900 maxdesc = max(maxdesc, dim.descent());
904 // Check if any custom fonts are larger (Asger)
905 // This is not completely correct, but we can live with the small,
906 // cosmetic error for now.
910 par.highestFontInRange(first, end, size);
911 if (maxsize > font.fontInfo().size()) {
912 // use standard paragraph font with the maximal size
913 FontInfo maxfont = font.fontInfo();
914 maxfont.setSize(maxsize);
915 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
916 maxasc = max(maxasc, maxfontmetrics.maxAscent());
917 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
920 // This is nicer with box insets:
924 ParagraphList const & pars = text_->paragraphs();
928 BufferParams const & bufparams = buffer.params();
929 // some parskips VERY EASY IMPLEMENTATION
930 if (bufparams.paragraph_separation
931 == BufferParams::PARSEP_SKIP
932 && par.ownerCode() != ERT_CODE
933 && par.ownerCode() != LISTINGS_CODE
935 && ((layout->isParagraph() && par.getDepth() == 0)
936 || (pars[pit - 1].layout()->isParagraph()
937 && pars[pit - 1].getDepth() == 0)))
939 maxasc += bufparams.getDefSkip().inPixels(*bv_);
942 if (par.params().startOfAppendix())
943 maxasc += int(3 * dh);
945 // This is special code for the chapter, since the label of this
946 // layout is printed in an extra row
947 if (layout->counter == "chapter"
948 && !par.params().labelString().empty()) {
949 labeladdon = int(labelfont_metrics.maxHeight()
950 * layout->spacing.getValue()
951 * text_->spacing(buffer, par));
954 // special code for the top label
955 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
956 || layout->labeltype == LABEL_BIBLIO
957 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
958 && isFirstInSequence(pit, pars)
959 && !par.getLabelstring().empty())
962 labelfont_metrics.maxHeight()
963 * layout->spacing.getValue()
964 * text_->spacing(buffer, par)
965 + (layout->topsep + layout->labelbottomsep) * dh);
968 // Add the layout spaces, for example before and after
969 // a section, or between the items of a itemize or enumerate
972 pit_type prev = depthHook(pit, pars, par.getDepth());
973 Paragraph const & prevpar = pars[prev];
975 && prevpar.layout() == layout
976 && prevpar.getDepth() == par.getDepth()
977 && prevpar.getLabelWidthString()
978 == par.getLabelWidthString()) {
979 layoutasc = layout->itemsep * dh;
980 } else if (pit != 0 || first != 0) {
981 if (layout->topsep > 0)
982 layoutasc = layout->topsep * dh;
985 prev = outerHook(pit, pars);
986 if (prev != pit_type(pars.size())) {
987 maxasc += int(pars[prev].layout()->parsep * dh);
988 } else if (pit != 0) {
989 Paragraph const & prevpar = pars[pit - 1];
990 if (prevpar.getDepth() != 0 ||
991 prevpar.layout() == layout) {
992 maxasc += int(layout->parsep * dh);
997 // is it a bottom line?
998 if (end >= par.size()) {
999 // add the layout spaces, for example before and after
1000 // a section, or between the items of a itemize or enumerate
1002 pit_type nextpit = pit + 1;
1003 if (nextpit != pit_type(pars.size())) {
1004 pit_type cpit = pit;
1008 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1009 usual = pars[cpit].layout()->bottomsep * dh;
1010 cpit = depthHook(cpit, pars, pars[nextpit].getDepth());
1011 if (pars[cpit].layout() != pars[nextpit].layout()
1012 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1014 unusual = pars[cpit].layout()->bottomsep * dh;
1016 layoutdesc = max(unusual, usual);
1017 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1018 if (pars[cpit].layout() != pars[nextpit].layout()
1019 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1020 layoutdesc = int(pars[cpit].layout()->bottomsep * dh);
1025 // incalculate the layout spaces
1026 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1027 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1029 // FIXME: the correct way is to do the following is to move the
1030 // following code in another method specially tailored for the
1031 // main Text. The following test is thus bogus.
1032 // Top and bottom margin of the document (only at top-level)
1034 if (pit == 0 && first == 0)
1036 if (pit + 1 == pit_type(pars.size()) &&
1037 end == par.size() &&
1038 !(end > 0 && par.isNewline(end - 1)))
1042 return Dimension(0, maxasc + labeladdon, maxdesc);
1046 // x is an absolute screen coord
1047 // returns the column near the specified x-coordinate of the row
1048 // x is set to the real beginning of this column
1049 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1050 Row const & row, int & x, bool & boundary) const
1052 Buffer const & buffer = bv_->buffer();
1054 /// For the main Text, it is possible that this pit is not
1055 /// yet in the CoordCache when moving cursor up.
1056 /// x Paragraph coordinate is always 0 for main text anyway.
1057 int const xo = origin_.x_;
1059 Paragraph const & par = text_->getPar(pit);
1061 bidi.computeTables(par, buffer, row);
1063 pos_type vc = row.pos();
1064 pos_type end = row.endpos();
1066 LayoutPtr const & layout = par.layout();
1068 bool left_side = false;
1070 pos_type body_pos = par.beginOfBody();
1072 double tmpx = row.x;
1073 double last_tmpx = tmpx;
1076 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1079 // check for empty row
1085 while (vc < end && tmpx <= x) {
1086 c = bidi.vis2log(vc);
1088 if (body_pos > 0 && c == body_pos - 1) {
1089 FontMetrics const & fm = theFontMetrics(
1090 text_->getLabelFont(buffer, par));
1091 tmpx += row.label_hfill + fm.width(layout->labelsep);
1092 if (par.isLineSeparator(body_pos - 1))
1093 tmpx -= singleWidth(pit, body_pos - 1);
1096 tmpx += singleWidth(pit, c);
1097 if (par.isSeparator(c) && c >= body_pos)
1098 tmpx += row.separator;
1102 if ((tmpx + last_tmpx) / 2 > x) {
1107 BOOST_ASSERT(vc <= end); // This shouldn't happen.
1110 // This (rtl_support test) is not needed, but gives
1111 // some speedup if rtl_support == false
1112 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1114 // If lastrow is false, we don't need to compute
1115 // the value of rtl.
1116 bool const rtl = lastrow ? text_->isRTL(buffer, par) : false;
1118 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1119 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1120 if (!par.isNewline(end - 1))
1122 } else if (vc == row.pos()) {
1123 c = bidi.vis2log(vc);
1124 if (bidi.level(c) % 2 == 1)
1127 c = bidi.vis2log(vc - 1);
1128 bool const rtl = (bidi.level(c) % 2 == 1);
1129 if (left_side == rtl) {
1131 boundary = isRTLBoundary(pit, c);
1135 // I believe this code is not needed anymore (Jug 20050717)
1137 // The following code is necessary because the cursor position past
1138 // the last char in a row is logically equivalent to that before
1139 // the first char in the next row. That's why insets causing row
1140 // divisions -- Newline and display-style insets -- must be treated
1141 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1142 // Newline inset, air gap below:
1143 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1144 if (bidi.level(end -1) % 2 == 0)
1145 tmpx -= singleWidth(pit, end - 1);
1147 tmpx += singleWidth(pit, end - 1);
1151 // Air gap above display inset:
1152 if (row.pos() < end && c >= end && end < par.size()
1153 && par.isInset(end) && par.getInset(end)->display()) {
1156 // Air gap below display inset:
1157 if (row.pos() < end && c >= end && par.isInset(end - 1)
1158 && par.getInset(end - 1)->display()) {
1164 pos_type const col = c - row.pos();
1166 if (!c || end == par.size())
1169 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1174 return min(col, end - 1 - row.pos());
1178 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1180 // We play safe and use parMetrics(pit) to make sure the
1181 // ParagraphMetrics will be redone and OK to use if needed.
1182 // Otherwise we would use an empty ParagraphMetrics in
1183 // upDownInText() while in selection mode.
1184 ParagraphMetrics const & pm = parMetrics(pit);
1186 BOOST_ASSERT(row < int(pm.rows().size()));
1188 Row const & r = pm.rows()[row];
1189 return r.pos() + getColumnNearX(pit, r, x, bound);
1193 void TextMetrics::newParMetricsDown()
1195 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1196 pit_type const pit = last.first + 1;
1197 if (pit == int(text_->paragraphs().size()))
1200 // do it and update its position.
1202 par_metrics_[pit].setPosition(last.second.position()
1203 + last.second.descent() + par_metrics_[pit].ascent());
1207 void TextMetrics::newParMetricsUp()
1209 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1210 if (first.first == 0)
1213 pit_type const pit = first.first - 1;
1214 // do it and update its position.
1216 par_metrics_[pit].setPosition(first.second.position()
1217 - first.second.ascent() - par_metrics_[pit].descent());
1220 // y is screen coordinate
1221 pit_type TextMetrics::getPitNearY(int y)
1223 BOOST_ASSERT(!text_->paragraphs().empty());
1224 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1226 // look for highest numbered paragraph with y coordinate less than given y
1229 ParMetricsCache::const_iterator it = par_metrics_.begin();
1230 ParMetricsCache::const_iterator et = par_metrics_.end();
1231 ParMetricsCache::const_iterator last = et; last--;
1233 ParagraphMetrics const & pm = it->second;
1235 if (y < it->second.position() - int(pm.ascent())) {
1236 // We are looking for a position that is before the first paragraph in
1237 // the cache (which is in priciple off-screen, that is before the
1240 // We are already at the first paragraph in the inset.
1242 // OK, this is the paragraph we are looking for.
1243 pit = it->first - 1;
1248 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1250 if (y >= last->second.position() + int(pm_last.descent())) {
1251 // We are looking for a position that is after the last paragraph in
1252 // the cache (which is in priciple off-screen, that is before the
1254 pit = last->first + 1;
1255 if (pit == int(text_->paragraphs().size()))
1256 // We are already at the last paragraph in the inset.
1258 // OK, this is the paragraph we are looking for.
1259 newParMetricsDown();
1263 for (; it != et; ++it) {
1264 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1265 << " y: " << it->second.position());
1267 ParagraphMetrics const & pm = par_metrics_[it->first];
1269 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1271 yy = it->second.position();
1275 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1281 Row const & TextMetrics::getRowNearY(int y, pit_type pit) const
1283 ParagraphMetrics const & pm = par_metrics_[pit];
1285 int yy = pm.position() - pm.ascent();
1286 BOOST_ASSERT(!pm.rows().empty());
1287 RowList::const_iterator rit = pm.rows().begin();
1288 RowList::const_iterator rlast = pm.rows().end();
1290 for (; rit != rlast; yy += rit->height(), ++rit)
1291 if (yy + rit->height() > y)
1297 // x,y are absolute screen coordinates
1298 // sets cursor recursively descending into nested editable insets
1299 Inset * TextMetrics::editXY(Cursor & cur, int x, int y)
1301 if (lyxerr.debugging(Debug::WORKAREA)) {
1302 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1303 cur.bv().coordCache().dump();
1305 pit_type pit = getPitNearY(y);
1306 BOOST_ASSERT(pit != -1);
1308 Row const & row = getRowNearY(y, pit);
1311 int xx = x; // is modified by getColumnNearX
1312 pos_type const pos = row.pos()
1313 + getColumnNearX(pit, row, xx, bound);
1316 cur.boundary(bound);
1319 // try to descend into nested insets
1320 Inset * inset = checkInsetHit(x, y);
1321 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1323 // Either we deconst editXY or better we move current_font
1324 // and real_current_font to Cursor
1325 // FIXME: what is needed now that current_font and real_current_font
1327 cur.setCurrentFont();
1331 ParagraphList const & pars = text_->paragraphs();
1332 Inset const * insetBefore = pos? pars[pit].getInset(pos - 1): 0;
1333 //Inset * insetBehind = pars[pit].getInset(pos);
1335 // This should be just before or just behind the
1336 // cursor position set above.
1337 BOOST_ASSERT((pos != 0 && inset == insetBefore)
1338 || inset == pars[pit].getInset(pos));
1340 // Make sure the cursor points to the position before
1342 if (inset == insetBefore) {
1344 cur.boundary(false);
1347 // Try to descend recursively inside the inset.
1348 inset = inset->editXY(cur, x, y);
1350 if (cur.top().text() == text_)
1351 cur.setCurrentFont();
1356 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1358 BOOST_ASSERT(text_ == cur.text());
1359 pit_type pit = getPitNearY(y);
1361 ParagraphMetrics const & pm = par_metrics_[pit];
1363 int yy = pm.position() - pm.ascent();
1364 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1365 " pit: " << pit << " yy: " << yy);
1368 BOOST_ASSERT(pm.rows().size());
1369 for (; r < int(pm.rows().size()) - 1; ++r) {
1370 Row const & row = pm.rows()[r];
1371 if (int(yy + row.height()) > y)
1376 Row const & row = pm.rows()[r];
1378 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1382 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1384 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1386 text_->setCursor(cur, pit, pos, true, bound);
1387 // remember new position.
1392 //takes screen x,y coordinates
1393 Inset * TextMetrics::checkInsetHit(int x, int y)
1395 pit_type pit = getPitNearY(y);
1396 BOOST_ASSERT(pit != -1);
1398 Paragraph const & par = text_->paragraphs()[pit];
1399 ParagraphMetrics const & pm = par_metrics_[pit];
1401 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1403 InsetList::const_iterator iit = par.insetList().begin();
1404 InsetList::const_iterator iend = par.insetList().end();
1405 for (; iit != iend; ++iit) {
1406 Inset * inset = iit->inset;
1408 LYXERR(Debug::DEBUG, "examining inset " << inset);
1410 if (!bv_->coordCache().getInsets().has(inset)) {
1411 LYXERR(Debug::DEBUG, "inset has no cached position");
1415 Dimension const & dim = pm.insetDimension(inset);
1416 Point p = bv_->coordCache().getInsets().xy(inset);
1418 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1419 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1422 && x <= p.x_ + dim.wid
1423 && y >= p.y_ - dim.asc
1424 && y <= p.y_ + dim.des) {
1425 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1430 LYXERR(Debug::DEBUG, "No inset hit. ");
1435 int TextMetrics::cursorX(CursorSlice const & sl,
1436 bool boundary) const
1438 BOOST_ASSERT(sl.text() == text_);
1439 pit_type const pit = sl.pit();
1440 Paragraph const & par = text_->paragraphs()[pit];
1441 ParagraphMetrics const & pm = par_metrics_[pit];
1442 if (pm.rows().empty())
1445 pos_type ppos = sl.pos();
1446 // Correct position in front of big insets
1447 bool const boundary_correction = ppos != 0 && boundary;
1448 if (boundary_correction)
1451 Row const & row = pm.getRow(sl.pos(), boundary);
1453 pos_type cursor_vpos = 0;
1455 Buffer const & buffer = bv_->buffer();
1458 bidi.computeTables(par, buffer, row);
1460 pos_type const row_pos = row.pos();
1461 pos_type const end = row.endpos();
1462 // Spaces at logical line breaks in bidi text must be skipped during
1463 // cursor positioning. However, they may appear visually in the middle
1464 // of a row; they must be skipped, wherever they are...
1465 // * logically "abc_[HEBREW_\nHEBREW]"
1466 // * visually "abc_[_WERBEH\nWERBEH]"
1467 pos_type skipped_sep_vpos = -1;
1470 cursor_vpos = row_pos;
1471 else if (ppos >= end)
1472 cursor_vpos = text_->isRTL(buffer, par) ? row_pos : end;
1473 else if (ppos > row_pos && ppos >= end)
1474 // Place cursor after char at (logical) position pos - 1
1475 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1476 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1478 // Place cursor before char at (logical) position ppos
1479 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1480 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1482 pos_type body_pos = par.beginOfBody();
1484 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1487 // Use font span to speed things up, see below
1491 // If the last logical character is a separator, skip it, unless
1492 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1493 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1494 skipped_sep_vpos = bidi.log2vis(end - 1);
1496 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1497 // Skip the separator which is at the logical end of the row
1498 if (vpos == skipped_sep_vpos)
1500 pos_type pos = bidi.vis2log(vpos);
1501 if (body_pos > 0 && pos == body_pos - 1) {
1502 FontMetrics const & labelfm = theFontMetrics(
1503 text_->getLabelFont(buffer, par));
1504 x += row.label_hfill + labelfm.width(par.layout()->labelsep);
1505 if (par.isLineSeparator(body_pos - 1))
1506 x -= singleWidth(pit, body_pos - 1);
1509 // Use font span to speed things up, see above
1510 if (pos < font_span.first || pos > font_span.last) {
1511 font_span = par.fontSpan(pos);
1512 font = getDisplayFont(pit, pos);
1515 x += pm.singleWidth(pos, font);
1517 if (par.isSeparator(pos) && pos >= body_pos)
1521 // see correction above
1522 if (boundary_correction) {
1523 if (isRTL(sl, boundary))
1524 x -= singleWidth(pit, ppos);
1526 x += singleWidth(pit, ppos);
1533 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1535 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1536 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1537 if (pm.rows().empty())
1541 h -= par_metrics_[0].rows()[0].ascent();
1542 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1543 h += par_metrics_[pit].height();
1546 if (pos && boundary)
1548 size_t const rend = pm.pos2row(pos);
1549 for (size_t rit = 0; rit != rend; ++rit)
1550 h += pm.rows()[rit].height();
1551 h += pm.rows()[rend].ascent();
1556 void TextMetrics::cursorPrevious(Cursor & cur)
1558 pos_type cpos = cur.pos();
1559 pit_type cpar = cur.pit();
1561 int x = cur.x_target();
1562 setCursorFromCoordinates(cur, x, 0);
1563 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1565 if (cpar == cur.pit() && cpos == cur.pos())
1566 // we have a row which is taller than the workarea. The
1567 // simplest solution is to move to the previous row instead.
1568 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1571 cur.updateFlags(Update::Force | Update::FitCursor);
1575 void TextMetrics::cursorNext(Cursor & cur)
1577 pos_type cpos = cur.pos();
1578 pit_type cpar = cur.pit();
1580 int x = cur.x_target();
1581 setCursorFromCoordinates(cur, x, cur.bv().workHeight() - 1);
1582 cur.dispatch(FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1584 if (cpar == cur.pit() && cpos == cur.pos())
1585 // we have a row which is taller than the workarea. The
1586 // simplest solution is to move to the next row instead.
1588 FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1591 cur.updateFlags(Update::Force | Update::FitCursor);
1595 // the cursor set functions have a special mechanism. When they
1596 // realize you left an empty paragraph, they will delete it.
1598 bool TextMetrics::cursorHome(Cursor & cur)
1600 BOOST_ASSERT(text_ == cur.text());
1601 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1602 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1603 return text_->setCursor(cur, cur.pit(), row.pos());
1607 bool TextMetrics::cursorEnd(Cursor & cur)
1609 BOOST_ASSERT(text_ == cur.text());
1610 // if not on the last row of the par, put the cursor before
1611 // the final space exept if I have a spanning inset or one string
1612 // is so long that we force a break.
1613 pos_type end = cur.textRow().endpos();
1615 // empty text, end-1 is no valid position
1617 bool boundary = false;
1618 if (end != cur.lastpos()) {
1619 if (!cur.paragraph().isLineSeparator(end-1)
1620 && !cur.paragraph().isNewline(end-1))
1625 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1629 void TextMetrics::deleteLineForward(Cursor & cur)
1631 BOOST_ASSERT(text_ == cur.text());
1632 if (cur.lastpos() == 0) {
1633 // Paragraph is empty, so we just go forward
1634 text_->cursorForward(cur);
1637 cur.selection() = true; // to avoid deletion
1640 // What is this test for ??? (JMarc)
1641 if (!cur.selection())
1642 text_->deleteWordForward(cur);
1644 cap::cutSelection(cur, true, false);
1645 cur.checkBufferStructure();
1650 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1652 ParagraphList const & pars = text_->paragraphs();
1653 return row.endpos() >= pars[pit].size()
1654 && pit + 1 == pit_type(pars.size());
1658 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1660 return row.pos() == 0 && pit == 0;
1664 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1666 BOOST_ASSERT(pit >= 0);
1667 BOOST_ASSERT(pit < int(text_->paragraphs().size()));
1668 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1672 int TextMetrics::leftMargin(int max_width,
1673 pit_type const pit, pos_type const pos) const
1675 ParagraphList const & pars = text_->paragraphs();
1677 BOOST_ASSERT(pit >= 0);
1678 BOOST_ASSERT(pit < int(pars.size()));
1679 Paragraph const & par = pars[pit];
1680 BOOST_ASSERT(pos >= 0);
1681 BOOST_ASSERT(pos <= par.size());
1682 Buffer const & buffer = bv_->buffer();
1683 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1684 TextClass const & tclass = buffer.params().getTextClass();
1685 LayoutPtr const & layout = par.layout();
1687 docstring parindent = layout->parindent;
1691 if (text_->isMainText(buffer))
1692 l_margin += changebarMargin();
1694 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1695 tclass.leftmargin());
1697 if (par.getDepth() != 0) {
1698 // find the next level paragraph
1699 pit_type newpar = outerHook(pit, pars);
1700 if (newpar != pit_type(pars.size())) {
1701 if (pars[newpar].layout()->isEnvironment()) {
1702 l_margin = leftMargin(max_width, newpar);
1704 if (par.layout() == tclass.defaultLayout()) {
1705 if (pars[newpar].params().noindent())
1708 parindent = pars[newpar].layout()->parindent;
1713 // This happens after sections in standard classes. The 1.3.x
1714 // code compared depths too, but it does not seem necessary
1716 if (par.layout() == tclass.defaultLayout()
1717 && pit > 0 && pars[pit - 1].layout()->nextnoindent)
1720 FontInfo const labelfont = text_->getLabelFont(buffer, par);
1721 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1723 switch (layout->margintype) {
1724 case MARGIN_DYNAMIC:
1725 if (!layout->leftmargin.empty()) {
1726 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1727 layout->leftmargin);
1729 if (!par.getLabelstring().empty()) {
1730 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1731 l_margin += labelfont_metrics.width(par.getLabelstring());
1732 l_margin += labelfont_metrics.width(layout->labelsep);
1736 case MARGIN_MANUAL: {
1737 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1738 // The width of an empty par, even with manual label, should be 0
1739 if (!par.empty() && pos >= par.beginOfBody()) {
1740 if (!par.getLabelWidthString().empty()) {
1741 docstring labstr = par.getLabelWidthString();
1742 l_margin += labelfont_metrics.width(labstr);
1743 l_margin += labelfont_metrics.width(layout->labelsep);
1749 case MARGIN_STATIC: {
1750 l_margin += theFontMetrics(buffer.params().getFont()).
1751 signedWidth(layout->leftmargin) * 4 / (par.getDepth() + 4);
1755 case MARGIN_FIRST_DYNAMIC:
1756 if (layout->labeltype == LABEL_MANUAL) {
1757 if (pos >= par.beginOfBody()) {
1758 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1760 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1763 // Special case to fix problems with
1765 || (layout->labeltype == LABEL_STATIC
1766 && layout->latextype == LATEX_ENVIRONMENT
1767 && !isFirstInSequence(pit, pars))) {
1768 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1769 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
1770 && layout->labeltype != LABEL_BIBLIO
1771 && layout->labeltype !=
1772 LABEL_CENTERED_TOP_ENVIRONMENT) {
1773 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1774 l_margin += labelfont_metrics.width(layout->labelsep);
1775 l_margin += labelfont_metrics.width(par.getLabelstring());
1779 case MARGIN_RIGHT_ADDRESS_BOX: {
1781 // ok, a terrible hack. The left margin depends on the widest
1782 // row in this paragraph.
1783 RowList::iterator rit = par.rows().begin();
1784 RowList::iterator end = par.rows().end();
1785 // FIXME: This is wrong.
1786 int minfill = max_width;
1787 for ( ; rit != end; ++rit)
1788 if (rit->fill() < minfill)
1789 minfill = rit->fill();
1790 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
1791 l_margin += minfill;
1793 // also wrong, but much shorter.
1794 l_margin += max_width / 2;
1799 if (!par.params().leftIndent().zero())
1800 l_margin += par.params().leftIndent().inPixels(max_width);
1804 if (par.params().align() == LYX_ALIGN_LAYOUT)
1805 align = layout->align;
1807 align = par.params().align();
1809 // set the correct parindent
1811 && (layout->labeltype == LABEL_NO_LABEL
1812 || layout->labeltype == LABEL_TOP_ENVIRONMENT
1813 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1814 || (layout->labeltype == LABEL_STATIC
1815 && layout->latextype == LATEX_ENVIRONMENT
1816 && !isFirstInSequence(pit, pars)))
1817 && align == LYX_ALIGN_BLOCK
1818 && !par.params().noindent()
1819 // in some insets, paragraphs are never indented
1820 && !(par.inInset() && par.inInset()->neverIndent(buffer))
1821 // display style insets are always centered, omit indentation
1824 && par.getInset(pos)->display())
1825 && (par.layout() != tclass.defaultLayout()
1826 || buffer.params().paragraph_separation ==
1827 BufferParams::PARSEP_INDENT))
1829 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1837 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
1839 ParagraphMetrics const & pm = par_metrics_[pit];
1841 return pm.singleWidth(pos, getDisplayFont(pit, pos));
1845 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1847 if (par_metrics_.empty())
1853 ParMetricsCache::iterator it = par_metrics_.begin();
1854 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1855 y -= it->second.ascent();
1856 for (; it != pm_end; ++it) {
1857 ParagraphMetrics const & pmi = it->second;
1859 pit_type const pit = it->first;
1860 // Save the paragraph position in the cache.
1861 it->second.setPosition(y);
1862 drawParagraph(pi, pit, x, y);
1868 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1870 BufferParams const & bparams = bv_->buffer().params();
1871 ParagraphMetrics const & pm = par_metrics_[pit];
1872 if (pm.rows().empty())
1876 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1877 int const ww = bv_->workHeight();
1878 size_t const nrows = pm.rows().size();
1880 for (size_t i = 0; i != nrows; ++i) {
1882 Row const & row = pm.rows()[i];
1886 bool const inside = (y + row.descent() >= 0
1887 && y - row.ascent() < ww);
1888 // It is not needed to draw on screen if we are not inside.
1889 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1890 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
1892 // Row signature; has row changed since last paint?
1893 row.setCrc(pm.computeRowSignature(row, bparams));
1894 bool row_has_changed = row.changed();
1896 // Don't paint the row if a full repaint has not been requested
1897 // and if it has not changed.
1898 if (!pi.full_repaint && !row_has_changed) {
1899 // Paint only the insets if the text itself is
1901 rp.paintOnlyInsets();
1906 // Clear background of this row if paragraph background was not
1907 // already cleared because of a full repaint.
1908 if (!pi.full_repaint && row_has_changed) {
1909 pi.pain.fillRectangle(x, y - row.ascent(),
1910 width(), row.height(), pi.background_color);
1913 bool row_selection = row.sel_beg != -1 && row.sel_end != -1;
1914 if (row_selection) {
1915 DocIterator beg = bv_->cursor().selectionBegin();
1916 DocIterator end = bv_->cursor().selectionEnd();
1917 bool const beg_margin = beg.pit() < pit && i == 0;
1918 bool const end_margin = end.pit() > pit && i == nrows - 1;
1920 beg.pos() = row.sel_beg;
1922 end.pos() = row.sel_end;
1923 drawRowSelection(pi, x, row, beg, end, beg_margin, end_margin);
1926 // Instrumentation for testing row cache (see also
1928 if (lyxerr.debugging(Debug::PAINTING) && inside
1929 && (row_selection || pi.full_repaint || row_has_changed)) {
1930 string const foreword = text_->isMainText(bv_->buffer()) ?
1931 "main text redraw " : "inset text redraw: ";
1932 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1933 << " row_selection=" << row_selection
1934 << " full_repaint=" << pi.full_repaint
1935 << " row_has_changed=" << row_has_changed);
1938 // Backup full_repaint status and force full repaint
1939 // for inner insets as the Row has been cleared out.
1940 bool tmp = pi.full_repaint;
1941 pi.full_repaint = true;
1944 rp.paintChangeBar();
1951 // Restore full_repaint status.
1952 pi.full_repaint = tmp;
1954 // Re-enable screen drawing for future use of the painter.
1955 pi.pain.setDrawingEnabled(original_drawing_state);
1957 //LYXERR(Debug::PAINTING, ".");
1961 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
1962 DocIterator const & beg, DocIterator const & end,
1963 bool drawOnBegMargin, bool drawOnEndMargin) const
1965 Buffer & buffer = bv_->buffer();
1966 DocIterator cur = beg;
1967 int x1 = cursorX(beg.top(), beg.boundary());
1968 int x2 = cursorX(end.top(), end.boundary());
1969 int y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
1970 int y2 = y1 + row.height();
1973 if (drawOnBegMargin) {
1974 if (text_->isRTL(buffer, beg.paragraph()))
1975 pi.pain.fillRectangle(x + x1, y1, width() - x1, y2 - y1, Color_selection);
1977 pi.pain.fillRectangle(x, y1, x1, y2 - y1, Color_selection);
1980 if (drawOnEndMargin) {
1981 if (text_->isRTL(buffer, beg.paragraph()))
1982 pi.pain.fillRectangle(x, y1, x2, y2 - y1, Color_selection);
1984 pi.pain.fillRectangle(x + x2, y1, width() - x2, y2 - y1, Color_selection);
1987 // if we are on a boundary from the beginning, it's probably
1988 // a RTL boundary and we jump to the other side directly as this
1989 // segement is 0-size and confuses the logic below
1991 cur.boundary(false);
1993 // go through row and draw from RTL boundary to RTL boundary
1995 bool drawNow = false;
1997 // simplified cursorForward code below which does not
1998 // descend into insets and which does not go into the
1999 // next line. Compare the logic with the original cursorForward
2001 // if left of boundary -> just jump to right side
2002 // but for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2003 if (cur.boundary()) {
2004 cur.boundary(false);
2005 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2006 // in front of RTL boundary -> Stay on this side of the boundary because:
2007 // ab|cDDEEFFghi -> abc|DDEEFFghi
2016 if (cur.pos() == row.endpos())
2021 // the previous segment was just drawn, now the next starts
2022 x1 = cursorX(cur.top(), cur.boundary());
2025 if (!(cur < end) || drawNow) {
2026 x2 = cursorX(cur.top(), cur.boundary());
2027 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2030 // reset x1, so it is set again next round (which will be on the
2031 // right side of a boundary or at the selection end)
2037 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2039 // ParagraphMetrics const & pm = par_metrics_[pit];
2040 // Row const & r = pm.rows()[row];
2046 int defaultRowHeight()
2048 return int(theFontMetrics(sane_font).maxHeight() * 1.2);