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"
23 #include "buffer_funcs.h"
24 #include "BufferParams.h"
25 #include "BufferView.h"
26 #include "CoordCache.h"
28 #include "CutAndPaste.h"
29 #include "InsetList.h"
33 #include "MetricsInfo.h"
34 #include "ParagraphParameters.h"
35 #include "RowPainter.h"
37 #include "TextClass.h"
40 #include "insets/InsetText.h"
42 #include "mathed/InsetMathMacroTemplate.h"
44 #include "frontends/FontMetrics.h"
45 #include "frontends/Painter.h"
46 #include "frontends/NullPainter.h"
48 #include "support/convert.h"
49 #include "support/debug.h"
50 #include "support/lassert.h"
51 #include "support/lyxlib.h"
61 using frontend::FontMetrics;
65 // the somewhat arbitrary leading added between rows. This is 20% of
66 // the characters height, inluding the possible leading of the font.
67 // 20% is a standard value used by LaTeX and word processors.
68 double const extra_leading = 0.2;
70 int numberOfLabelHfills(Paragraph const & par, Row const & row)
72 pos_type last = row.endpos() - 1;
73 pos_type first = row.pos();
75 // hfill *DO* count at the beginning of paragraphs!
77 while (first < last && par.isHfill(first))
81 last = min(last, par.beginOfBody());
83 for (pos_type p = first; p < last; ++p) {
90 // FIXME: this needs to be rewritten, probably by merging it into some
91 // code that, besides counting, sets the active status of the space
92 // inset in the row element.
93 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
94 pos_type const body_pos)
97 Row::const_iterator cit = row.begin();
98 Row::const_iterator const end = row.end();
99 for ( ; cit != end ; ++cit)
100 if (cit->pos >= body_pos
101 && cit->inset && pm.hfillExpansion(row, cit->pos))
109 /////////////////////////////////////////////////////////////////////
113 /////////////////////////////////////////////////////////////////////
116 TextMetrics::TextMetrics(BufferView * bv, Text * text)
117 : bv_(bv), text_(text)
120 max_width_ = bv_->workWidth();
121 dim_.wid = max_width_;
127 bool TextMetrics::contains(pit_type pit) const
129 return par_metrics_.find(pit) != par_metrics_.end();
133 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
135 ParMetricsCache::const_iterator it = par_metrics_.begin();
136 return make_pair(it->first, &it->second);
140 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
142 LBUFERR(!par_metrics_.empty());
143 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
144 return make_pair(it->first, &it->second);
148 bool TextMetrics::isLastRow(Row const & row) const
150 ParagraphList const & pars = text_->paragraphs();
151 return row.endpos() >= pars[row.pit()].size()
152 && row.pit() + 1 == pit_type(pars.size());
156 bool TextMetrics::isFirstRow(Row const & row) const
158 return row.pos() == 0 && row.pit() == 0;
162 void TextMetrics::setRowChanged(pit_type pit, pos_type pos)
164 for (auto & pm_pair : par_metrics_)
165 if (pm_pair.first == pit)
166 for (Row & row : pm_pair.second.rows())
167 if (row.pos() == pos)
172 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
174 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
175 if (pmc_it == par_metrics_.end()) {
176 pmc_it = par_metrics_.insert(
177 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
179 if (pmc_it->second.rows().empty() && redo)
181 return pmc_it->second;
185 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
187 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
191 void TextMetrics::newParMetricsDown()
193 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
194 pit_type const pit = last.first + 1;
195 if (pit == int(text_->paragraphs().size()))
198 // do it and update its position.
200 par_metrics_[pit].setPosition(last.second.position()
201 + last.second.descent() + par_metrics_[pit].ascent());
206 void TextMetrics::newParMetricsUp()
208 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
209 if (first.first == 0)
212 pit_type const pit = first.first - 1;
213 // do it and update its position.
215 par_metrics_[pit].setPosition(first.second.position()
216 - first.second.ascent() - par_metrics_[pit].descent());
221 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width,
222 bool const expand_on_multipars)
224 LBUFERR(mi.base.textwidth > 0);
225 max_width_ = mi.base.textwidth;
226 // backup old dimension.
227 Dimension const old_dim = dim_;
230 dim_.wid = min_width;
231 pit_type const npar = text_->paragraphs().size();
232 if (npar > 1 && expand_on_multipars)
233 // If there is more than one row, expand the text to
234 // the full allowable width.
235 dim_.wid = max_width_;
237 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
238 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
240 bool changed = false;
242 for (pit_type pit = 0; pit != npar; ++pit) {
243 // create rows, but do not set alignment yet
244 changed |= redoParagraph(pit, false);
245 ParagraphMetrics const & pm = par_metrics_[pit];
247 if (dim_.wid < pm.width())
248 dim_.wid = pm.width();
251 // Now set alignment for all rows (the width might not have been known before).
252 for (pit_type pit = 0; pit != npar; ++pit) {
253 ParagraphMetrics & pm = par_metrics_[pit];
254 for (Row & row : pm.rows())
255 setRowAlignment(row, dim_.wid);
258 dim_.asc = par_metrics_[0].ascent();
259 dim_.des = h - dim_.asc;
260 //lyxerr << "dim_.wid " << dim_.wid << endl;
261 //lyxerr << "dim_.asc " << dim_.asc << endl;
262 //lyxerr << "dim_.des " << dim_.des << endl;
264 changed |= dim_ != old_dim;
270 void TextMetrics::updatePosCache(pit_type pit) const
272 frontend::NullPainter np;
273 PainterInfo pi(bv_, np);
274 drawParagraph(pi, pit, origin_.x_, par_metrics_[pit].position());
278 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
280 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
284 int TextMetrics::rightMargin(pit_type const pit) const
286 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
290 void TextMetrics::applyOuterFont(Font & font) const
292 FontInfo lf(font_.fontInfo());
293 lf.reduce(bv_->buffer().params().getFont().fontInfo());
294 font.fontInfo().realize(lf);
298 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
300 LASSERT(pos >= 0, { static Font f; return f; });
302 ParagraphList const & pars = text_->paragraphs();
303 Paragraph const & par = pars[pit];
304 Layout const & layout = par.layout();
305 Buffer const & buffer = bv_->buffer();
307 BufferParams const & params = buffer.params();
308 pos_type const body_pos = par.beginOfBody();
310 // We specialize the 95% common case:
311 if (!par.getDepth()) {
312 Font f = par.getFontSettings(params, pos);
313 if (!text_->isMainText())
315 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
317 FontInfo const & lf = lab ? layout.labelfont : layout.font;
318 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
320 // In case the default family has been customized
321 if (lf.family() == INHERIT_FAMILY)
322 rlf.setFamily(params.getFont().fontInfo().family());
323 f.fontInfo().realize(rlf);
327 // The uncommon case need not be optimized as much
328 FontInfo const & layoutfont = pos < body_pos ?
329 layout.labelfont : layout.font;
331 Font font = par.getFontSettings(params, pos);
332 font.fontInfo().realize(layoutfont);
334 if (!text_->isMainText())
335 applyOuterFont(font);
337 // Realize against environment font information
338 // NOTE: the cast to pit_type should be removed when pit_type
339 // changes to a unsigned integer.
340 if (pit < pit_type(pars.size()))
341 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
343 // Realize with the fonts of lesser depth.
344 font.fontInfo().realize(params.getFont().fontInfo());
350 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
356 if (boundary && sl.pos() > 0)
359 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
363 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
365 // no RTL boundary at paragraph start
369 Font const & left_font = displayFont(pit, pos - 1);
371 return isRTLBoundary(pit, pos, left_font);
375 // isRTLBoundary returns false on a real end-of-line boundary,
376 // because otherwise the two boundary types get mixed up.
377 // This is the whole purpose of this being in TextMetrics.
378 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
379 Font const & font) const
381 if (// no RTL boundary at paragraph start
383 // if the metrics have not been calculated, then we are not
384 // on screen and can safely ignore issues about boundaries.
388 ParagraphMetrics & pm = par_metrics_[pit];
389 // no RTL boundary in empty paragraph
390 if (pm.rows().empty())
393 pos_type endpos = pm.getRow(pos - 1, false).endpos();
394 pos_type startpos = pm.getRow(pos, false).pos();
395 // no RTL boundary at line start:
396 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
398 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
401 Paragraph const & par = text_->getPar(pit);
402 // no RTL boundary at line break:
403 // abc|\n -> move right -> abc\n (and not: abc\n|
405 if (startpos == pos && endpos == pos && endpos != par.size()
406 && (par.isNewline(pos - 1)
407 || par.isEnvSeparator(pos - 1)
408 || par.isLineSeparator(pos - 1)
409 || par.isSeparator(pos - 1)))
412 bool left = font.isVisibleRightToLeft();
414 if (pos == par.size())
415 right = par.isRTL(bv_->buffer().params());
417 right = displayFont(pit, pos).isVisibleRightToLeft();
419 return left != right;
423 bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
425 Paragraph & par = text_->getPar(pit);
426 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
427 // redoParagraph() recursively inside parMetrics.
428 Dimension old_dim = parMetrics(pit, false).dim();
429 ParagraphMetrics & pm = par_metrics_[pit];
432 Buffer & buffer = bv_->buffer();
433 bool changed = false;
435 // Check whether there are InsetBibItems that need fixing
436 // FIXME: This check ought to be done somewhere else. It is the reason
437 // why text_ is not const. But then, where else to do it?
438 // Well, how can you end up with either (a) a biblio environment that
439 // has no InsetBibitem or (b) a biblio environment with more than one
440 // InsetBibitem? I think the answer is: when paragraphs are merged;
441 // when layout is set; when material is pasted.
442 if (par.brokenBiblio()) {
443 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
444 // In some cases, we do not know how to record undo
445 if (&cur.inset() == &text_->inset())
446 cur.recordUndo(pit, pit);
448 int const moveCursor = par.fixBiblio(buffer);
450 // Is it necessary to update the cursor?
451 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
454 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
459 // Optimisation: this is used in the next two loops
460 // so better to calculate that once here.
461 int const right_margin = rightMargin(pm);
463 // iterator pointing to paragraph to resolve macros
464 DocIterator parPos = text_->macrocontextPosition();
468 LYXERR(Debug::INFO, "MacroContext not initialised!"
469 << " Going through the buffer again and hope"
470 << " the context is better then.");
471 // FIXME audit updateBuffer calls
472 // This should not be here, but it is not clear yet where else it
474 bv_->buffer().updateBuffer();
475 parPos = text_->macrocontextPosition();
476 LBUFERR(!parPos.empty());
481 par.setBeginOfBody();
482 Font const bufferfont = buffer.params().getFont();
483 CoordCache::Insets & insetCache = bv_->coordCache().insets();
484 for (auto const & e : par.insetList()) {
485 // FIXME Doesn't this HAVE to be non-empty?
486 // position already initialized?
487 if (!parPos.empty()) {
488 parPos.pos() = e.pos;
490 // A macro template would normally not be visible
491 // by itself. But the tex macro semantics allow
492 // recursion, so we artifically take the context
493 // after the macro template to simulate this.
494 if (e.inset->lyxCode() == MATHMACRO_CODE)
498 // If there is an end of paragraph marker, its size should be
499 // substracted to the available width. The logic here is
500 // almost the same as in breakRow, remember keep them in sync.
502 if (lyxrc.paragraph_markers && e.pos + 1 == par.size()
503 && size_type(pit + 1) < text_->paragraphs().size()) {
504 Font f(text_->layoutFont(pit));
505 // ¶ U+00B6 PILCROW SIGN
506 eop = theFontMetrics(f).width(char_type(0x00B6));
509 // do the metric calculation
511 int const w = max_width_ - leftMargin(pit, e.pos)
512 - right_margin - eop;
513 Font const & font = e.inset->inheritFont() ?
514 displayFont(pit, e.pos) : bufferfont;
515 MacroContext mc(&buffer, parPos);
516 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
517 e.inset->metrics(mi, dim);
518 if (!insetCache.has(e.inset) || insetCache.dim(e.inset) != dim) {
519 insetCache.add(e.inset, dim);
525 size_t row_index = 0;
526 bool need_new_row = false;
527 // maximum pixel width of a row
529 if (row_index == pm.rows().size())
530 pm.rows().push_back(Row());
531 Row & row = pm.rows()[row_index];
535 need_new_row = breakRow(row, right_margin);
538 if ((row_index || row.endpos() < par.size() || row.right_boundary())
539 && par.inInset().lyxCode() != CELL_CODE) {
540 /* If there is more than one row or the row has been
541 * broken by a display inset or a newline, expand the text
542 * to the full allowable width. This setting here is
543 * needed for the setRowAlignment() below.
544 * We do nothing when inside a table cell.
546 if (dim_.wid < max_width_)
547 dim_.wid = max_width_;
550 setRowAlignment(row, max(dim_.wid, row.width()));
551 first = row.endpos();
554 pm.dim().wid = max(pm.dim().wid, row.width());
555 pm.dim().des += row.height();
556 } while (first < par.size() || need_new_row);
558 if (row_index < pm.rows().size())
559 pm.rows().resize(row_index);
561 // FIXME: It might be better to move this in another method
562 // specially tailored for the main text.
563 // Top and bottom margin of the document (only at top-level)
564 if (text_->isMainText()) {
565 // original value was 20px, which is 0.2in at 100dpi
566 int const margin = bv_->zoomedPixels(20);
568 pm.rows().front().dim().asc += margin;
569 /* coverity thinks that we should update pm.dim().asc
570 * below, but all the rows heights are actually counted as
571 * part of the paragraph metric descent see loop above).
573 // coverity[copy_paste_error]
574 pm.dim().des += margin;
576 ParagraphList const & pars = text_->paragraphs();
577 if (pit + 1 == pit_type(pars.size())) {
578 pm.rows().back().dim().des += margin;
579 pm.dim().des += margin;
583 // The space above and below the paragraph.
584 int const top = parTopSpacing(pit);
585 pm.rows().front().dim().asc += top;
586 int const bottom = parBottomSpacing(pit);
587 pm.rows().back().dim().des += bottom;
588 pm.dim().des += top + bottom;
590 pm.dim().asc += pm.rows()[0].ascent();
591 pm.dim().des -= pm.rows()[0].ascent();
593 changed |= old_dim.height() != pm.dim().height();
599 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
601 LyXAlignment align = par.getAlign();
603 // handle alignment inside tabular cells
604 Inset const & owner = text_->inset();
605 bool forced_block = false;
606 switch (owner.contentAlignment()) {
607 case LYX_ALIGN_BLOCK:
608 // In general block align is the default state, but here it is
609 // an explicit choice. Therefore it should not be overridden
613 case LYX_ALIGN_CENTER:
615 case LYX_ALIGN_RIGHT:
616 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
617 align = owner.contentAlignment();
620 // unchanged (use align)
624 // Display-style insets should always be on a centered row
625 if (Inset const * inset = par.getInset(row.pos())) {
626 switch (inset->display()) {
627 case Inset::AlignLeft:
628 align = LYX_ALIGN_BLOCK;
630 case Inset::AlignCenter:
631 align = LYX_ALIGN_CENTER;
634 // unchanged (use align)
636 case Inset::AlignRight:
637 align = LYX_ALIGN_RIGHT;
642 if (align == LYX_ALIGN_BLOCK) {
643 // If this row has been broken abruptly by a display inset, or
644 // it is the end of the paragraph, or the user requested we
645 // not justify stuff, then don't stretch.
646 // A forced block alignment can only be overridden the 'no
647 // justification on screen' setting.
648 if ((row.flushed() && !forced_block)
649 || !bv_->buffer().params().justification)
650 align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
657 void TextMetrics::setRowAlignment(Row & row, int width) const
662 Paragraph const & par = text_->getPar(row.pit());
664 int const w = width - row.right_margin - row.width();
665 // FIXME: put back this assertion when the crash on new doc is solved.
666 //LASSERT(w >= 0, /**/);
668 // is there a manual margin with a manual label
669 Layout const & layout = par.layout();
672 if (layout.margintype == MARGIN_MANUAL
673 && layout.labeltype == LABEL_MANUAL) {
674 /// We might have real hfills in the label part
675 nlh = numberOfLabelHfills(par, row);
677 // A manual label par (e.g. List) has an auto-hfill
678 // between the label text and the body of the
680 // But we don't want to do this auto hfill if the par
685 if (nlh && !par.getLabelWidthString().empty())
686 row.label_hfill = labelFill(row) / double(nlh);
689 // are there any hfills in the row?
690 ParagraphMetrics & pm = par_metrics_[row.pit()];
691 int nh = numberOfHfills(row, pm, par.beginOfBody());
695 // We don't have to look at the alignment if the row is already
696 // larger then the permitted width as then we force the
697 // LEFT_ALIGN'edness!
698 if (int(row.width()) >= max_width_)
702 // Common case : there is no hfill, and the alignment will be
704 switch (getAlign(par, row)) {
705 case LYX_ALIGN_BLOCK:
706 // Expand expanding characters by a total of w
707 if (!row.setExtraWidth(w) && row.isRTL()) {
708 // Justification failed and the text is RTL: align to the right
709 row.left_margin += w;
714 // a displayed inset that is flushed
715 if (Inset const * inset = par.getInset(row.pos())) {
716 row.left_margin += inset->indent(*bv_);
717 row.dim().wid += inset->indent(*bv_);
720 case LYX_ALIGN_RIGHT:
721 if (Inset const * inset = par.getInset(row.pos())) {
722 int const new_w = max(w - inset->indent(*bv_), 0);
723 row.left_margin += new_w;
724 row.dim().wid += new_w;
726 row.left_margin += w;
730 case LYX_ALIGN_CENTER:
731 row.dim().wid += w / 2;
732 row.left_margin += w / 2;
735 case LYX_ALIGN_LAYOUT:
736 case LYX_ALIGN_SPECIAL:
737 case LYX_ALIGN_DECIMAL:
743 // Case nh > 0. There are hfill separators.
747 // Set size of hfill insets
748 pos_type const endpos = row.endpos();
749 pos_type body_pos = par.beginOfBody();
751 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
754 CoordCache::Insets & insetCache = bv_->coordCache().insets();
755 for (Row::Element & e : row) {
756 if (row.label_hfill && e.endpos == body_pos
757 && e.type == Row::SPACE)
758 e.dim.wid -= int(row.label_hfill * (nlh - 1));
759 if (e.inset && pm.hfillExpansion(row, e.pos)) {
760 if (e.pos >= body_pos) {
764 e.dim.wid += hfill_rem;
766 e.dim.wid += int(row.label_hfill);
767 // Cache the inset dimension.
768 insetCache.add(e.inset, e.dim);
774 int TextMetrics::labelFill(Row const & row) const
776 Paragraph const & par = text_->getPar(row.pit());
777 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
780 // iterate over elements before main body (except the last one,
781 // which is extra space).
782 for (Row::Element const & e : row) {
783 if (e.endpos >= par.beginOfBody())
788 docstring const & label = par.params().labelWidthString();
792 FontMetrics const & fm
793 = theFontMetrics(text_->labelFont(par));
795 return max(0, fm.width(label) - w);
800 // Not used, see TextMetrics::breakRow
801 // this needs special handling - only newlines count as a break point
802 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
804 pos_type const end = par.size();
807 if (par.isNewline(i))
815 int TextMetrics::labelEnd(pit_type const pit) const
817 // labelEnd is only needed if the layout fills a flushleft label.
818 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
820 // return the beginning of the body
821 return leftMargin(pit);
827 * Calling Text::getFont is slow. While rebreaking we scan a
828 * paragraph from left to right calling getFont for every char. This
829 * simple class address this problem by hidding an optimization trick
830 * (not mine btw -AB): the font is reused in the whole font span. The
831 * class handles transparently the "hidden" (not part of the fontlist)
832 * label font (as getFont does).
838 FontIterator(TextMetrics const & tm,
839 Paragraph const & par, pit_type pit, pos_type pos)
840 : tm_(tm), par_(par), pit_(pit), pos_(pos),
841 font_(tm.displayFont(pit, pos)),
842 endspan_(par.fontSpan(pos).last),
843 bodypos_(par.beginOfBody())
847 Font const & operator*() const { return font_; }
850 FontIterator & operator++()
853 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
854 font_ = tm_.displayFont(pit_, pos_);
855 endspan_ = par_.fontSpan(pos_).last;
861 Font * operator->() { return &font_; }
865 TextMetrics const & tm_;
867 Paragraph const & par_;
882 /** This is the function where the hard work is done. The code here is
883 * very sensitive to small changes :) Note that part of the
884 * intelligence is also in Row::shortenIfNeeded.
886 bool TextMetrics::breakRow(Row & row, int const right_margin) const
888 Paragraph const & par = text_->getPar(row.pit());
889 pos_type const end = par.size();
890 pos_type const pos = row.pos();
891 pos_type const body_pos = par.beginOfBody();
892 bool const is_rtl = text_->isRTL(row.pit());
893 bool need_new_row = false;
896 row.left_margin = leftMargin(row.pit(), pos);
897 row.right_margin = right_margin;
899 swap(row.left_margin, row.right_margin);
900 // Remember that the row width takes into account the left_margin
901 // but not the right_margin.
902 row.dim().wid = row.left_margin;
903 // the width available for the row.
904 int const width = max_width_ - row.right_margin;
907 //FIXME: As long as leftMargin() is not correctly implemented for
908 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
909 // Otherwise, long rows will be painted off the screen.
910 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
911 return addressBreakPoint(pos, par);
914 // check for possible inline completion
915 DocIterator const & ic_it = bv_->inlineCompletionPos();
916 pos_type ic_pos = -1;
917 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
918 ic_pos = ic_it.pos();
920 // Now we iterate through until we reach the right margin
921 // or the end of the par, then build a representation of the row.
923 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
924 while (i < end && (i == pos || row.width() <= width)) {
925 char_type c = par.getChar(i);
926 // The most special cases are handled first.
927 if (par.isInset(i)) {
928 Inset const * ins = par.getInset(i);
929 Dimension dim = bv_->coordCache().insets().dim(ins);
930 row.add(i, ins, dim, *fi, par.lookupChange(i));
931 } else if (c == ' ' && i + 1 == body_pos) {
932 // There is a space at i, but it should not be
933 // added as a separator, because it is just
934 // before body_pos. Instead, insert some spacing to
936 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
937 // this is needed to make sure that the row width is correct
939 int const add = max(fm.width(par.layout().labelsep),
940 labelEnd(row.pit()) - row.width());
941 row.addSpace(i, add, *fi, par.lookupChange(i));
942 } else if (c == '\t')
943 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
944 *fi, par.lookupChange(i));
945 else if (c == 0x2028 || c == 0x2029) {
947 * U+2028 LINE SEPARATOR
948 * U+2029 PARAGRAPH SEPARATOR
950 * These are special unicode characters that break
951 * lines/pragraphs. Not handling them lead to trouble wrt
952 * Qt QTextLayout formatting. We add a visible character
953 * on screen so that the user can see that something is
957 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
958 // ¶ U+00B6 PILCROW SIGN
959 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
960 row.add(i, screen_char, *fi, par.lookupChange(i));
962 row.add(i, c, *fi, par.lookupChange(i));
964 // add inline completion width
965 // draw logically behind the previous character
966 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
967 docstring const comp = bv_->inlineCompletion();
968 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
972 f.fontInfo().setColor(Color_inlinecompletion);
973 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
975 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
976 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
979 // Handle some situations that abruptly terminate the row
981 // - Before a display inset
982 // - After a display inset
983 Inset const * inset = 0;
984 if (par.isNewline(i) || par.isEnvSeparator(i)
985 || (i + 1 < end && (inset = par.getInset(i + 1))
987 || (!row.empty() && row.back().inset
988 && row.back().inset->display())) {
990 need_new_row = par.isNewline(i);
1001 // End of paragraph marker. The logic here is almost the
1002 // same as in redoParagraph, remember keep them in sync.
1003 ParagraphList const & pars = text_->paragraphs();
1004 Change const & change = par.lookupChange(i);
1005 if ((lyxrc.paragraph_markers || change.changed())
1007 && i == end && size_type(row.pit() + 1) < pars.size()) {
1008 // add a virtual element for the end-of-paragraph
1009 // marker; it is shown on screen, but does not exist
1010 // in the paragraph.
1011 Font f(text_->layoutFont(row.pit()));
1012 f.fontInfo().setColor(Color_paragraphmarker);
1013 BufferParams const & bparams
1014 = text_->inset().buffer().params();
1015 f.setLanguage(par.getParLanguage(bparams));
1016 // ¶ U+00B6 PILCROW SIGN
1017 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, change);
1020 // Is there a end-of-paragaph change?
1021 if (i == end && par.lookupChange(end).changed() && !need_new_row)
1022 row.needsChangeBar(true);
1024 // if the row is too large, try to cut at last separator. In case
1025 // of success, reset indication that the row was broken abruptly.
1026 int const next_width = max_width_ - leftMargin(row.pit(), row.endpos())
1027 - rightMargin(row.pit());
1029 if (row.shortenIfNeeded(body_pos, width, next_width))
1031 row.right_boundary(!row.empty() && row.endpos() < end
1032 && row.back().endpos == row.endpos());
1033 // Last row in paragraph is flushed
1034 if (row.endpos() == end)
1037 // make sure that the RTL elements are in reverse ordering
1038 row.reverseRTL(is_rtl);
1039 //LYXERR0("breakrow: row is " << row);
1041 return need_new_row;
1044 int TextMetrics::parTopSpacing(pit_type const pit) const
1046 Paragraph const & par = text_->getPar(pit);
1047 Layout const & layout = par.layout();
1050 ParagraphList const & pars = text_->paragraphs();
1051 double const dh = defaultRowHeight();
1053 BufferParams const & bparams = bv_->buffer().params();
1054 Inset const & inset = text_->inset();
1055 // some parskips VERY EASY IMPLEMENTATION
1056 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1057 && !inset.getLayout().parbreakIsNewline()
1058 && !par.layout().parbreak_is_newline
1060 && ((layout.isParagraph() && par.getDepth() == 0)
1061 || (pars[pit - 1].layout().isParagraph()
1062 && pars[pit - 1].getDepth() == 0))) {
1063 asc += bparams.getDefSkip().inPixels(*bv_);
1066 if (par.params().startOfAppendix())
1069 // special code for the top label
1070 if (layout.labelIsAbove()
1071 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1072 && !par.labelString().empty()) {
1073 FontInfo labelfont = text_->labelFont(par);
1074 FontMetrics const & lfm = theFontMetrics(labelfont);
1075 asc += int(lfm.maxHeight() * layout.spacing.getValue()
1076 * text_->spacing(par)
1077 + (layout.topsep + layout.labelbottomsep) * dh);
1080 // Add the layout spaces, for example before and after
1081 // a section, or between the items of a itemize or enumerate
1084 pit_type prev = text_->depthHook(pit, par.getDepth());
1085 Paragraph const & prevpar = pars[prev];
1086 double layoutasc = 0;
1088 && prevpar.layout() == layout
1089 && prevpar.getDepth() == par.getDepth()
1090 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1091 layoutasc = layout.itemsep * dh;
1092 } else if (pit != 0 && layout.topsep > 0)
1093 layoutasc = layout.topsep * dh;
1095 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1097 prev = text_->outerHook(pit);
1098 if (prev != pit_type(pars.size())) {
1099 asc += int(pars[prev].layout().parsep * dh);
1100 } else if (pit != 0) {
1101 Paragraph const & prevpar2 = pars[pit - 1];
1102 if (prevpar2.getDepth() != 0 || prevpar2.layout() == layout)
1103 asc += int(layout.parsep * dh);
1110 int TextMetrics::parBottomSpacing(pit_type const pit) const
1112 double layoutdesc = 0;
1113 ParagraphList const & pars = text_->paragraphs();
1114 double const dh = defaultRowHeight();
1116 // add the layout spaces, for example before and after
1117 // a section, or between the items of a itemize or enumerate
1119 pit_type nextpit = pit + 1;
1120 if (nextpit != pit_type(pars.size())) {
1121 pit_type cpit = pit;
1123 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1124 double usual = pars[cpit].layout().bottomsep * dh;
1126 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1127 if (pars[cpit].layout() != pars[nextpit].layout()
1128 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1129 unusual = pars[cpit].layout().bottomsep * dh;
1130 layoutdesc = max(unusual, usual);
1131 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1132 if (pars[cpit].layout() != pars[nextpit].layout()
1133 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1134 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1138 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1142 void TextMetrics::setRowHeight(Row & row) const
1144 Paragraph const & par = text_->getPar(row.pit());
1145 Layout const & layout = par.layout();
1146 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1148 // Initial value for ascent (useful if row is empty).
1149 Font const font = displayFont(row.pit(), row.pos());
1150 FontMetrics const & fm = theFontMetrics(font);
1151 int maxasc = fm.maxAscent() + fm.leading();
1152 int maxdes = fm.maxDescent();
1154 // Find the ascent/descent of the row contents
1155 for (Row::Element const & e : row) {
1156 maxasc = max(maxasc, e.dim.ascent());
1157 maxdes = max(maxdes, e.dim.descent());
1160 // Add some leading (split between before and after)
1161 int const leading = support::iround(extra_leading * (maxasc + maxdes));
1162 row.dim().asc = int((maxasc + leading - leading / 2) * spacing_val);
1163 row.dim().des = int((maxdes + leading / 2) * spacing_val);
1167 // x is an absolute screen coord
1168 // returns the column near the specified x-coordinate of the row
1169 // x is set to the real beginning of this column
1170 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1171 bool & boundary) const
1173 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1174 /// For the main Text, it is possible that this pit is not
1175 /// yet in the CoordCache when moving cursor up.
1176 /// x Paragraph coordinate is always 0 for main text anyway.
1177 int const xo = origin_.x_;
1180 // Adapt to cursor row scroll offset if applicable.
1181 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1184 pos_type pos = row.pos();
1187 x = row.left_margin;
1188 else if (x <= row.left_margin) {
1189 pos = row.front().left_pos();
1190 x = row.left_margin;
1191 } else if (x >= row.width()) {
1192 pos = row.back().right_pos();
1195 double w = row.left_margin;
1196 Row::const_iterator cit = row.begin();
1197 Row::const_iterator cend = row.end();
1198 for ( ; cit != cend; ++cit) {
1199 if (w <= x && w + cit->full_width() > x) {
1200 int x_offset = int(x - w);
1201 pos = cit->x2pos(x_offset);
1202 x = int(x_offset + w);
1205 w += cit->full_width();
1207 if (cit == row.end()) {
1208 pos = row.back().right_pos();
1211 /** This tests for the case where the cursor is placed
1212 * just before a font direction change. See comment on
1213 * the boundary_ member in DocIterator.h to understand
1214 * how boundary helps here.
1216 else if (pos == cit->endpos
1217 && ((!cit->isRTL() && cit + 1 != row.end()
1218 && (cit + 1)->isRTL())
1219 || (cit->isRTL() && cit != row.begin()
1220 && !(cit - 1)->isRTL())))
1224 /** This tests for the case where the cursor is set at the end
1225 * of a row which has been broken due something else than a
1226 * separator (a display inset or a forced breaking of the
1227 * row). We know that there is a separator when the end of the
1228 * row is larger than the end of its last element.
1230 if (!row.empty() && pos == row.back().endpos
1231 && row.back().endpos == row.endpos()) {
1232 Inset const * inset = row.back().inset;
1233 if (inset && (inset->lyxCode() == NEWLINE_CODE
1234 || inset->lyxCode() == SEPARATOR_CODE))
1235 pos = row.back().pos;
1237 boundary = row.right_boundary();
1241 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1247 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1249 // We play safe and use parMetrics(pit) to make sure the
1250 // ParagraphMetrics will be redone and OK to use if needed.
1251 // Otherwise we would use an empty ParagraphMetrics in
1252 // upDownInText() while in selection mode.
1253 ParagraphMetrics const & pm = parMetrics(pit);
1255 LBUFERR(row < int(pm.rows().size()));
1257 Row const & r = pm.rows()[row];
1258 return getPosNearX(r, x, bound);
1262 // y is screen coordinate
1263 pit_type TextMetrics::getPitNearY(int y)
1265 LASSERT(!text_->paragraphs().empty(), return -1);
1266 LASSERT(!par_metrics_.empty(), return -1);
1267 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1269 // look for highest numbered paragraph with y coordinate less than given y
1272 ParMetricsCache::const_iterator it = par_metrics_.begin();
1273 ParMetricsCache::const_iterator et = par_metrics_.end();
1274 ParMetricsCache::const_iterator last = et;
1277 ParagraphMetrics const & pm = it->second;
1279 if (y < it->second.position() - int(pm.ascent())) {
1280 // We are looking for a position that is before the first paragraph in
1281 // the cache (which is in priciple off-screen, that is before the
1284 // We are already at the first paragraph in the inset.
1286 // OK, this is the paragraph we are looking for.
1287 pit = it->first - 1;
1292 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1294 if (y >= last->second.position() + int(pm_last.descent())) {
1295 // We are looking for a position that is after the last paragraph in
1296 // the cache (which is in priciple off-screen), that is before the
1298 pit = last->first + 1;
1299 if (pit == int(text_->paragraphs().size()))
1300 // We are already at the last paragraph in the inset.
1302 // OK, this is the paragraph we are looking for.
1303 newParMetricsDown();
1307 for (; it != et; ++it) {
1308 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1309 << " y: " << it->second.position());
1311 ParagraphMetrics const & pm2 = par_metrics_[it->first];
1313 if (it->first >= pit && int(it->second.position()) - int(pm2.ascent()) <= y) {
1315 yy = it->second.position();
1319 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1325 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1326 bool assert_in_view, bool up)
1328 ParagraphMetrics const & pm = par_metrics_[pit];
1330 int yy = pm.position() - pm.ascent();
1331 LBUFERR(!pm.rows().empty());
1332 RowList::const_iterator rit = pm.rows().begin();
1333 RowList::const_iterator rlast = pm.rows().end();
1335 for (; rit != rlast; yy += rit->height(), ++rit)
1336 if (yy + rit->height() > y)
1339 if (assert_in_view) {
1340 if (!up && yy + rit->height() > y) {
1341 if (rit != pm.rows().begin()) {
1344 } else if (pit != 0) {
1347 ParagraphMetrics const & pm2 = par_metrics_[pit];
1348 rit = pm2.rows().end();
1352 } else if (up && yy != y) {
1354 y = yy + rit->height();
1356 } else if (pit < int(text_->paragraphs().size()) - 1) {
1358 newParMetricsDown();
1359 ParagraphMetrics const & pm2 = par_metrics_[pit];
1360 rit = pm2.rows().begin();
1369 // x,y are absolute screen coordinates
1370 // sets cursor recursively descending into nested editable insets
1371 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1372 bool assert_in_view, bool up)
1374 if (lyxerr.debugging(Debug::WORKAREA)) {
1375 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1376 cur.bv().coordCache().dump();
1378 pit_type pit = getPitNearY(y);
1379 LASSERT(pit != -1, return 0);
1380 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1383 // Do we cover an inset?
1384 InsetList::Element * e = checkInsetHit(pit, x, y);
1387 // No inset, set position in the text
1388 bool bound = false; // is modified by getPosNearX
1389 cur.pos() = getPosNearX(row, x, bound);
1390 cur.boundary(bound);
1391 cur.setCurrentFont();
1396 Inset * inset = e->inset;
1397 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1399 // Set position in front of inset
1401 cur.boundary(false);
1404 // Try to descend recursively inside the inset.
1405 Inset * edited = inset->editXY(cur, x, y);
1406 // FIXME: it is not clear that the test on position is needed
1407 // Remove it if/when semantics of editXY is clarified
1408 if (cur.text() == text_ && cur.pos() == e->pos) {
1409 // non-editable inset, set cursor after the inset if x is
1410 // nearer to that position (bug 9628)
1411 bool bound = false; // is modified by getPosNearX
1412 cur.pos() = getPosNearX(row, x, bound);
1413 cur.boundary(bound);
1414 cur.setCurrentFont();
1418 if (cur.top().text() == text_)
1419 cur.setCurrentFont();
1424 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1426 LASSERT(text_ == cur.text(), return);
1427 pit_type const pit = getPitNearY(y);
1428 LASSERT(pit != -1, return);
1430 ParagraphMetrics const & pm = par_metrics_[pit];
1432 int yy = pm.position() - pm.ascent();
1433 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1434 " pit: " << pit << " yy: " << yy);
1437 LBUFERR(pm.rows().size());
1438 for (; r < int(pm.rows().size()) - 1; ++r) {
1439 Row const & row = pm.rows()[r];
1440 if (int(yy + row.height()) > y)
1445 Row const & row = pm.rows()[r];
1447 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1451 pos_type const pos = getPosNearX(row, xx, bound);
1453 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1455 text_->setCursor(cur, pit, pos, true, bound);
1456 // remember new position.
1461 //takes screen x,y coordinates
1462 InsetList::Element * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1464 Paragraph const & par = text_->paragraphs()[pit];
1465 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1467 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1469 for (InsetList::Element const & e : par.insetList()) {
1470 LYXERR(Debug::DEBUG, "examining inset " << e.inset);
1472 if (insetCache.covers(e.inset, x, y)) {
1473 LYXERR(Debug::DEBUG, "Hit inset: " << e.inset);
1474 return const_cast<InsetList::Element *>(&e);
1478 LYXERR(Debug::DEBUG, "No inset hit. ");
1483 //takes screen x,y coordinates
1484 Inset * TextMetrics::checkInsetHit(int x, int y)
1486 pit_type const pit = getPitNearY(y);
1487 LASSERT(pit != -1, return 0);
1488 InsetList::Element * e = checkInsetHit(pit, x, y);
1497 int TextMetrics::cursorX(CursorSlice const & sl,
1498 bool boundary) const
1500 LASSERT(sl.text() == text_, return 0);
1502 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1503 if (pm.rows().empty())
1505 Row const & row = pm.getRow(sl.pos(), boundary);
1506 pos_type const pos = sl.pos();
1509 row.findElement(pos, boundary, x);
1515 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1517 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1518 ParagraphMetrics const & pm = parMetrics(sl.pit());
1519 if (pm.rows().empty())
1523 h -= parMetrics(0).rows()[0].ascent();
1524 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1525 h += parMetrics(pit).height();
1528 if (pos && boundary)
1530 size_t const rend = pm.pos2row(pos);
1531 for (size_t rit = 0; rit != rend; ++rit)
1532 h += pm.rows()[rit].height();
1533 h += pm.rows()[rend].ascent();
1538 // the cursor set functions have a special mechanism. When they
1539 // realize you left an empty paragraph, they will delete it.
1541 bool TextMetrics::cursorHome(Cursor & cur)
1543 LASSERT(text_ == cur.text(), return false);
1544 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1545 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1546 return text_->setCursor(cur, cur.pit(), row.pos());
1550 bool TextMetrics::cursorEnd(Cursor & cur)
1552 LASSERT(text_ == cur.text(), return false);
1553 // if not on the last row of the par, put the cursor before
1554 // the final space exept if I have a spanning inset or one string
1555 // is so long that we force a break.
1556 pos_type end = cur.textRow().endpos();
1558 // empty text, end-1 is no valid position
1560 bool boundary = false;
1561 if (end != cur.lastpos()) {
1562 if (!cur.paragraph().isLineSeparator(end-1)
1563 && !cur.paragraph().isNewline(end-1)
1564 && !cur.paragraph().isEnvSeparator(end-1))
1568 } else if (cur.paragraph().isEnvSeparator(end-1))
1570 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1574 void TextMetrics::deleteLineForward(Cursor & cur)
1576 LASSERT(text_ == cur.text(), return);
1577 if (cur.lastpos() == 0) {
1578 // Paragraph is empty, so we just go forward
1579 text_->cursorForward(cur);
1582 cur.selection(true); // to avoid deletion
1585 // What is this test for ??? (JMarc)
1586 if (!cur.selection())
1587 text_->deleteWordForward(cur);
1589 cap::cutSelection(cur, false);
1590 cur.checkBufferStructure();
1595 int TextMetrics::leftMargin(pit_type pit) const
1597 return leftMargin(pit, text_->paragraphs()[pit].size());
1601 int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
1603 ParagraphList const & pars = text_->paragraphs();
1605 LASSERT(pit >= 0, return 0);
1606 LASSERT(pit < int(pars.size()), return 0);
1607 Paragraph const & par = pars[pit];
1608 LASSERT(pos >= 0, return 0);
1609 LASSERT(pos <= par.size(), return 0);
1610 Buffer const & buffer = bv_->buffer();
1611 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1612 DocumentClass const & tclass = buffer.params().documentClass();
1613 Layout const & layout = par.layout();
1614 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1616 docstring parindent = layout.parindent;
1620 if (text_->isMainText()) {
1621 l_margin += bv_->leftMargin();
1622 l_margin += bfm.signedWidth(tclass.leftmargin());
1625 int depth = par.getDepth();
1627 // find the next level paragraph
1628 pit_type newpar = text_->outerHook(pit);
1629 if (newpar != pit_type(pars.size())) {
1630 if (pars[newpar].layout().isEnvironment()) {
1631 int nestmargin = depth * nestMargin();
1632 if (text_->isMainText())
1633 nestmargin += changebarMargin();
1634 l_margin = max(leftMargin(newpar), nestmargin);
1635 // Remove the parindent that has been added
1636 // if the paragraph was empty.
1637 if (pars[newpar].empty() &&
1638 buffer.params().paragraph_separation ==
1639 BufferParams::ParagraphIndentSeparation) {
1640 docstring pi = pars[newpar].layout().parindent;
1641 l_margin -= bfm.signedWidth(pi);
1644 if (tclass.isDefaultLayout(par.layout())
1645 || tclass.isPlainLayout(par.layout())) {
1646 if (pars[newpar].params().noindent())
1649 parindent = pars[newpar].layout().parindent;
1654 // This happens after sections or environments in standard classes.
1655 // We have to check the previous layout at same depth.
1656 if (buffer.params().paragraph_separation ==
1657 BufferParams::ParagraphSkipSeparation)
1659 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1660 pit_type prev = text_->depthHook(pit, par.getDepth());
1661 if (par.layout() == pars[prev].layout()) {
1663 && pars[pit - 1].layout().nextnoindent)
1665 } else if (pars[prev].layout().nextnoindent)
1669 FontInfo const labelfont = text_->labelFont(par);
1670 FontMetrics const & lfm = theFontMetrics(labelfont);
1672 switch (layout.margintype) {
1673 case MARGIN_DYNAMIC:
1674 if (!layout.leftmargin.empty()) {
1675 l_margin += bfm.signedWidth(layout.leftmargin);
1677 if (!par.labelString().empty()) {
1678 l_margin += lfm.signedWidth(layout.labelindent);
1679 l_margin += lfm.width(par.labelString());
1680 l_margin += lfm.width(layout.labelsep);
1684 case MARGIN_MANUAL: {
1685 l_margin += lfm.signedWidth(layout.labelindent);
1686 // The width of an empty par, even with manual label, should be 0
1687 if (!par.empty() && pos >= par.beginOfBody()) {
1688 if (!par.getLabelWidthString().empty()) {
1689 docstring labstr = par.getLabelWidthString();
1690 l_margin += lfm.width(labstr);
1691 l_margin += lfm.width(layout.labelsep);
1697 case MARGIN_STATIC: {
1698 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1699 / (par.getDepth() + 4);
1703 case MARGIN_FIRST_DYNAMIC:
1704 if (layout.labeltype == LABEL_MANUAL) {
1705 // if we are at position 0, we are never in the body
1706 if (pos > 0 && pos >= par.beginOfBody())
1707 l_margin += lfm.signedWidth(layout.leftmargin);
1709 l_margin += lfm.signedWidth(layout.labelindent);
1711 // Special case to fix problems with
1713 || (layout.labeltype == LABEL_STATIC
1714 && layout.latextype == LATEX_ENVIRONMENT
1715 && !text_->isFirstInSequence(pit))) {
1716 l_margin += lfm.signedWidth(layout.leftmargin);
1717 } else if (!layout.labelIsAbove()) {
1718 l_margin += lfm.signedWidth(layout.labelindent);
1719 l_margin += lfm.width(layout.labelsep);
1720 l_margin += lfm.width(par.labelString());
1724 case MARGIN_RIGHT_ADDRESS_BOX: {
1726 // The left margin depends on the widest row in this paragraph.
1727 // This code is wrong because it depends on the rows, but at the
1728 // same time this function is used in redoParagraph to construct
1730 ParagraphMetrics const & pm = par_metrics_[pit];
1731 int minfill = max_width_;
1732 for (row : pm.rows())
1733 if (row.fill() < minfill)
1734 minfill = row.fill();
1735 l_margin += bfm.signedWidth(layout.leftmargin);
1736 l_margin += minfill;
1738 // also wrong, but much shorter.
1739 l_margin += max_width_ / 2;
1744 if (!par.params().leftIndent().zero())
1745 l_margin += par.params().leftIndent().inPixels(max_width_, lfm.em());
1747 LyXAlignment align = par.getAlign();
1749 // set the correct parindent
1751 && (layout.labeltype == LABEL_NO_LABEL
1752 || layout.labeltype == LABEL_ABOVE
1753 || layout.labeltype == LABEL_CENTERED
1754 || (layout.labeltype == LABEL_STATIC
1755 && layout.latextype == LATEX_ENVIRONMENT
1756 && !text_->isFirstInSequence(pit)))
1757 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1758 && !par.params().noindent()
1759 // in some insets, paragraphs are never indented
1760 && !text_->inset().neverIndent()
1761 // display style insets are always centered, omit indentation
1764 && par.getInset(pos)->display())
1765 && (!(tclass.isDefaultLayout(par.layout())
1766 || tclass.isPlainLayout(par.layout()))
1767 || buffer.params().paragraph_separation
1768 == BufferParams::ParagraphIndentSeparation)) {
1769 /* use the parindent of the layout when the default
1770 * indentation is used otherwise use the indentation set in
1771 * the document settings
1773 if (buffer.params().getParIndent().empty())
1774 l_margin += bfm.signedWidth(parindent);
1776 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
1783 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1785 if (par_metrics_.empty())
1791 y -= par_metrics_.begin()->second.ascent();
1792 for (auto & pm_pair : par_metrics_) {
1793 pit_type const pit = pm_pair.first;
1794 ParagraphMetrics & pm = pm_pair.second;
1796 // Save the paragraph position in the cache.
1798 drawParagraph(pi, pit, x, y);
1804 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1806 ParagraphMetrics const & pm = par_metrics_[pit];
1807 if (pm.rows().empty())
1809 size_t const nrows = pm.rows().size();
1811 // Use fast lane in nodraw stage.
1812 if (pi.pain.isNull()) {
1813 for (size_t i = 0; i != nrows; ++i) {
1815 Row const & row = pm.rows()[i];
1816 // Adapt to cursor row scroll offset if applicable.
1817 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1821 RowPainter rp(pi, *text_, row, row_x, y);
1823 rp.paintOnlyInsets();
1829 int const ww = bv_->workHeight();
1830 Cursor const & cur = bv_->cursor();
1831 DocIterator sel_beg = cur.selectionBegin();
1832 DocIterator sel_end = cur.selectionEnd();
1833 bool selection = cur.selection()
1834 // This is our text.
1835 && cur.text() == text_
1836 // if the anchor is outside, this is not our selection
1837 && cur.normalAnchor().text() == text_
1838 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1840 // We store the begin and end pos of the selection relative to this par
1841 DocIterator sel_beg_par = cur.selectionBegin();
1842 DocIterator sel_end_par = cur.selectionEnd();
1844 // We care only about visible selection.
1846 if (pit != sel_beg.pit()) {
1847 sel_beg_par.pit() = pit;
1848 sel_beg_par.pos() = 0;
1850 if (pit != sel_end.pit()) {
1851 sel_end_par.pit() = pit;
1852 sel_end_par.pos() = sel_end_par.lastpos();
1856 for (size_t i = 0; i != nrows; ++i) {
1858 Row const & row = pm.rows()[i];
1859 // Adapt to cursor row scroll offset if applicable.
1860 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1864 // It is not needed to draw on screen if we are not inside.
1865 bool const inside = (y + row.descent() >= 0
1866 && y - row.ascent() < ww);
1868 // Inset positions have already been set in nodraw stage.
1874 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1876 row.clearSelectionAndMargins();
1878 // The row knows nothing about the paragraph, so we have to check
1879 // whether this row is the first or last and update the margins.
1880 if (row.selection()) {
1881 if (row.sel_beg == 0)
1882 row.change(row.begin_margin_sel, sel_beg.pit() < pit);
1883 if (row.sel_end == sel_end_par.lastpos())
1884 row.change(row.end_margin_sel, sel_end.pit() > pit);
1887 // Take this opportunity to spellcheck the row contents.
1888 if (row.changed() && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1889 text_->getPar(pit).spellCheck();
1892 RowPainter rp(pi, *text_, row, row_x, y);
1894 // Don't paint the row if a full repaint has not been requested
1895 // and if it has not changed.
1896 if (!pi.full_repaint && !row.changed()) {
1897 // Paint only the insets if the text itself is
1899 rp.paintOnlyInsets();
1905 // Clear background of this row if paragraph background was not
1906 // already cleared because of a full repaint.
1907 if (!pi.full_repaint && row.changed()) {
1908 LYXERR(Debug::PAINTING, "Clear rect@("
1909 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1910 << width() << " x " << row.height());
1911 // FIXME: this is a hack. We know that at least this
1912 // amount of pixels can be cleared on right and left.
1913 // Doing so gets rid of caret ghosts when the cursor is at
1914 // the begining/end of row. However, it will not work if
1915 // the caret has a ridiculous width like 6. (see ticket
1917 pi.pain.fillRectangle(max(row_x, 0) - Inset::TEXT_TO_INSET_OFFSET,
1919 width() + 2 * Inset::TEXT_TO_INSET_OFFSET,
1920 row.height(), pi.background_color);
1923 // Instrumentation for testing row cache (see also
1925 if (lyxerr.debugging(Debug::PAINTING)
1926 && (row.selection() || pi.full_repaint || row.changed())) {
1927 string const foreword = text_->isMainText() ? "main text redraw "
1928 : "inset text redraw: ";
1929 LYXERR0(foreword << "pit=" << pit << " row=" << i
1930 << (row.selection() ? " row_selection": "")
1931 << (pi.full_repaint ? " full_repaint" : "")
1932 << (row.changed() ? " row.changed" : ""));
1935 // Backup full_repaint status and force full repaint
1936 // for inner insets as the Row has been cleared out.
1937 bool tmp = pi.full_repaint;
1938 pi.full_repaint = true;
1940 rp.paintSelection();
1943 if (row.needsChangeBar())
1944 rp.paintChangeBar();
1950 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1951 row_x + row.right_x() > bv_->workWidth());
1955 // This debug code shows on screen which rows are repainted.
1956 // FIXME: since the updates related to caret blinking restrict
1957 // the painter to a small rectangle, the numbers are not
1958 // updated when this happens. Change the code in
1959 // GuiWorkArea::Private::show/hideCaret if this is important.
1960 static int count = 0;
1962 FontInfo fi(sane_font);
1963 fi.setSize(FONT_SIZE_TINY);
1964 fi.setColor(Color_red);
1965 pi.pain.text(row_x, y, convert<docstring>(count), fi);
1968 // Restore full_repaint status.
1969 pi.full_repaint = tmp;
1974 //LYXERR(Debug::PAINTING, ".");
1978 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1979 Dimension & dim) const
1981 Cursor const & bvcur = cur.bv().cursor();
1983 // get word in front of cursor
1984 docstring word = text_->previousWord(bvcur.top());
1985 DocIterator wordStart = bvcur;
1986 wordStart.pos() -= word.length();
1988 // calculate dimensions of the word
1990 row.pit(bvcur.pit());
1991 row.pos(wordStart.pos());
1992 row.endpos(bvcur.pos());
1996 // get position on screen of the word start and end
1997 //FIXME: Is it necessary to explicitly set this to false?
1998 wordStart.boundary(false);
1999 Point lxy = cur.bv().getPos(wordStart);
2000 Point rxy = cur.bv().getPos(bvcur);
2001 dim.wid = abs(rxy.x_ - lxy.x_);
2003 // calculate position of word
2005 x = min(rxy.x_, lxy.x_);
2007 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2008 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2011 int defaultRowHeight()
2013 FontMetrics const & fm = theFontMetrics(sane_font);
2014 return support::iround(fm.maxHeight() * (1 + extra_leading) + fm.leading());