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 "BufferParams.h"
24 #include "BufferView.h"
25 #include "CoordCache.h"
27 #include "CutAndPaste.h"
30 #include "MetricsInfo.h"
31 #include "ParagraphParameters.h"
32 #include "RowPainter.h"
35 #include "TextClass.h"
38 #include "insets/InsetText.h"
40 #include "mathed/MacroTable.h"
42 #include "frontends/FontMetrics.h"
43 #include "frontends/NullPainter.h"
45 #include "support/debug.h"
46 #include "support/lassert.h"
47 #include "support/Changer.h"
57 using frontend::FontMetrics;
62 int numberOfLabelHfills(Paragraph const & par, Row const & row)
64 pos_type last = row.endpos() - 1;
65 pos_type first = row.pos();
67 // hfill *DO* count at the beginning of paragraphs!
69 while (first < last && par.isHfill(first))
73 last = min(last, par.beginOfBody());
75 for (pos_type p = first; p < last; ++p) {
82 // FIXME: this needs to be rewritten, probably by merging it into some
83 // code that, besides counting, sets the active status of the space
84 // inset in the row element.
85 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
86 pos_type const body_pos)
89 Row::const_iterator cit = row.begin();
90 Row::const_iterator const end = row.end();
91 for ( ; cit != end ; ++cit)
92 if (cit->pos >= body_pos
93 && cit->inset && pm.hfillExpansion(row, cit->pos))
101 /////////////////////////////////////////////////////////////////////
105 /////////////////////////////////////////////////////////////////////
108 TextMetrics::TextMetrics(BufferView * bv, Text * text)
109 : bv_(bv), text_(text), dim_(bv_->workWidth(), 10, 10),
110 max_width_(dim_.wid), tight_(false)
114 bool TextMetrics::contains(pit_type pit) const
116 return par_metrics_.find(pit) != par_metrics_.end();
120 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
122 ParMetricsCache::const_iterator it = par_metrics_.begin();
123 return make_pair(it->first, &it->second);
127 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
129 LBUFERR(!par_metrics_.empty());
130 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
131 return make_pair(it->first, &it->second);
135 bool TextMetrics::isLastRow(Row const & row) const
137 ParagraphList const & pars = text_->paragraphs();
138 return row.endpos() >= pars[row.pit()].size()
139 && row.pit() + 1 == pit_type(pars.size());
143 bool TextMetrics::isFirstRow(Row const & row) const
145 return row.pos() == 0 && row.pit() == 0;
149 void TextMetrics::setRowChanged(pit_type pit, pos_type pos)
151 for (auto & pm_pair : par_metrics_)
152 if (pm_pair.first == pit)
153 for (Row & row : pm_pair.second.rows())
154 if (row.pos() == pos)
159 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
161 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
162 if (pmc_it == par_metrics_.end()) {
163 pmc_it = par_metrics_.insert(
164 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
166 if (pmc_it->second.rows().empty() && redo)
168 return pmc_it->second;
172 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
174 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
178 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit)
180 return parMetrics(pit, true);
184 void TextMetrics::newParMetricsDown()
186 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
187 pit_type const pit = last.first + 1;
188 if (pit == int(text_->paragraphs().size()))
191 // do it and update its position.
193 par_metrics_[pit].setPosition(last.second.position()
194 + last.second.descent() + par_metrics_[pit].ascent());
199 void TextMetrics::newParMetricsUp()
201 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
202 if (first.first == 0)
205 pit_type const pit = first.first - 1;
206 // do it and update its position.
208 par_metrics_[pit].setPosition(first.second.position()
209 - first.second.ascent() - par_metrics_[pit].descent());
214 bool TextMetrics::metrics(MetricsInfo const & mi, Dimension & dim, int min_width)
216 LBUFERR(mi.base.textwidth > 0);
217 max_width_ = mi.base.textwidth;
218 tight_ = mi.tight_insets;
219 // backup old dimension.
220 Dimension const old_dim = dim_;
223 dim_.wid = min_width;
224 pit_type const npar = text_->paragraphs().size();
225 if (npar > 1 && !tight_)
226 // If there is more than one row, expand the text to
227 // the full allowable width.
228 dim_.wid = max_width_;
230 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
231 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
233 bool changed = false;
235 for (pit_type pit = 0; pit != npar; ++pit) {
236 // create rows, but do not set alignment yet
237 changed |= redoParagraph(pit, false);
238 ParagraphMetrics const & pm = par_metrics_[pit];
240 if (dim_.wid < pm.width())
241 dim_.wid = pm.width();
244 // Now set alignment for all rows (the width might not have been known before).
245 for (pit_type pit = 0; pit != npar; ++pit) {
246 ParagraphMetrics & pm = par_metrics_[pit];
247 for (Row & row : pm.rows())
248 setRowAlignment(row, dim_.wid);
251 dim_.asc = par_metrics_[0].ascent();
252 dim_.des = h - dim_.asc;
253 //lyxerr << "dim_.wid " << dim_.wid << endl;
254 //lyxerr << "dim_.asc " << dim_.asc << endl;
255 //lyxerr << "dim_.des " << dim_.des << endl;
257 changed |= dim_ != old_dim;
263 void TextMetrics::updatePosCache(pit_type pit) const
265 frontend::NullPainter np;
266 PainterInfo pi(bv_, np);
267 drawParagraph(pi, pit, origin_.x_, par_metrics_[pit].position());
271 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
273 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
277 int TextMetrics::rightMargin(pit_type const pit) const
279 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
283 void TextMetrics::applyOuterFont(Font & font) const
285 FontInfo lf(font_.fontInfo());
286 lf.reduce(bv_->buffer().params().getFont().fontInfo());
287 font.fontInfo().realize(lf);
291 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
293 LASSERT(pos >= 0, { static Font f; return f; });
295 ParagraphList const & pars = text_->paragraphs();
296 Paragraph const & par = pars[pit];
297 Layout const & layout = par.layout();
298 Buffer const & buffer = bv_->buffer();
300 BufferParams const & params = buffer.params();
301 pos_type const body_pos = par.beginOfBody();
303 // We specialize the 95% common case:
304 if (!par.getDepth()) {
305 Font f = par.getFontSettings(params, pos);
306 if (!text_->isMainText())
308 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
310 FontInfo const & lf = lab ? layout.labelfont : layout.font;
311 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
313 // In case the default family has been customized
314 if (lf.family() == INHERIT_FAMILY)
315 rlf.setFamily(params.getFont().fontInfo().family());
316 f.fontInfo().realize(rlf);
320 // The uncommon case need not be optimized as much
321 FontInfo const & layoutfont = pos < body_pos ?
322 layout.labelfont : layout.font;
324 Font font = par.getFontSettings(params, pos);
325 font.fontInfo().realize(layoutfont);
327 if (!text_->isMainText())
328 applyOuterFont(font);
330 // Realize against environment font information
331 // NOTE: the cast to pit_type should be removed when pit_type
332 // changes to a unsigned integer.
333 if (pit < pit_type(pars.size()))
334 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
336 // Realize with the fonts of lesser depth.
337 font.fontInfo().realize(params.getFont().fontInfo());
343 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
349 if (boundary && sl.pos() > 0)
352 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
356 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
358 // no RTL boundary at paragraph start
362 Font const & left_font = displayFont(pit, pos - 1);
364 return isRTLBoundary(pit, pos, left_font);
368 // isRTLBoundary returns false on a real end-of-line boundary,
369 // because otherwise the two boundary types get mixed up.
370 // This is the whole purpose of this being in TextMetrics.
371 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
372 Font const & font) const
374 if (// no RTL boundary at paragraph start
376 // if the metrics have not been calculated, then we are not
377 // on screen and can safely ignore issues about boundaries.
381 ParagraphMetrics const & pm = par_metrics_[pit];
382 // no RTL boundary in empty paragraph
383 if (pm.rows().empty())
386 pos_type const endpos = pm.getRow(pos - 1, false).endpos();
387 pos_type const startpos = pm.getRow(pos, false).pos();
388 // no RTL boundary at line start:
389 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
391 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
394 Paragraph const & par = text_->getPar(pit);
395 // no RTL boundary at line break:
396 // abc|\n -> move right -> abc\n (and not: abc\n|
398 if (startpos == pos && endpos == pos && endpos != par.size()
399 && (par.isNewline(pos - 1)
400 || par.isEnvSeparator(pos - 1)
401 || par.isLineSeparator(pos - 1)
402 || par.isSeparator(pos - 1)))
405 bool const left = font.isVisibleRightToLeft();
407 if (pos == par.size())
408 right = par.isRTL(bv_->buffer().params());
410 right = displayFont(pit, pos).isVisibleRightToLeft();
412 return left != right;
416 bool TextMetrics::redoParagraph(pit_type const pit, bool const align_rows)
418 Paragraph & par = text_->getPar(pit);
419 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
420 // redoParagraph() recursively inside parMetrics.
421 Dimension old_dim = parMetrics(pit, false).dim();
422 ParagraphMetrics & pm = par_metrics_[pit];
425 Buffer & buffer = bv_->buffer();
426 bool changed = false;
428 // Check whether there are InsetBibItems that need fixing
429 // FIXME: This check ought to be done somewhere else. It is the reason
430 // why text_ is not const. But then, where else to do it?
431 // Well, how can you end up with either (a) a biblio environment that
432 // has no InsetBibitem, (b) a biblio environment with more than one
433 // InsetBibitem or (c) a paragraph that has a bib item but is no biblio
434 // environment? I think the answer is: when paragraphs are merged;
435 // when layout is set; when material is pasted.
436 if (par.brokenBiblio()) {
437 Cursor & cur = bv_->cursor();
438 // In some cases, we do not know how to record undo
439 if (&cur.inset() == &text_->inset())
440 cur.recordUndo(pit, pit);
442 int const moveCursor = par.fixBiblio(buffer);
444 // Is it necessary to update the cursor?
445 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
448 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
453 // Optimisation: this is used in the next two loops
454 // so better to calculate that once here.
455 int const right_margin = rightMargin(pm);
457 // iterator pointing to paragraph to resolve macros
458 DocIterator parPos = text_->macrocontextPosition();
462 LYXERR(Debug::INFO, "MacroContext not initialised!"
463 << " Going through the buffer again and hope"
464 << " the context is better then.");
465 // FIXME audit updateBuffer calls
466 // This should not be here, but it is not clear yet where else it
468 bv_->buffer().updateBuffer();
469 parPos = text_->macrocontextPosition();
470 LBUFERR(!parPos.empty());
475 par.setBeginOfBody();
476 Font const bufferfont = buffer.params().getFont();
477 CoordCache::Insets & insetCache = bv_->coordCache().insets();
478 for (auto const & e : par.insetList()) {
479 // FIXME Doesn't this HAVE to be non-empty?
480 // position already initialized?
481 if (!parPos.empty()) {
482 parPos.pos() = e.pos;
484 // A macro template would normally not be visible
485 // by itself. But the tex macro semantics allow
486 // recursion, so we artifically take the context
487 // after the macro template to simulate this.
488 if (e.inset->lyxCode() == MATHMACRO_CODE)
492 // If there is an end of paragraph marker, its size should be
493 // substracted to the available width. The logic here is
494 // almost the same as in breakRow, remember keep them in sync.
496 if (e.pos + 1 == par.size()
497 && (lyxrc.paragraph_markers || par.lookupChange(par.size()).changed())
498 && size_type(pit + 1) < text_->paragraphs().size()) {
499 Font f(text_->layoutFont(pit));
500 // ¶ U+00B6 PILCROW SIGN
501 eop = theFontMetrics(f).width(char_type(0x00B6));
504 // do the metric calculation
506 int const w = max_width_ - leftMargin(pit, e.pos)
507 - right_margin - eop;
508 Font const & font = e.inset->inheritFont() ?
509 displayFont(pit, e.pos) : bufferfont;
510 MacroContext mc(&buffer, parPos);
511 MetricsInfo mi(bv_, font.fontInfo(), w, mc, e.pos == 0, tight_);
512 e.inset->metrics(mi, dim);
513 if (!insetCache.has(e.inset) || insetCache.dim(e.inset) != dim) {
514 insetCache.add(e.inset, dim);
519 // Transform the paragraph into a single row containing all the elements.
520 Row const bigrow = tokenizeParagraph(pit);
521 // Split the row in several rows fitting in available width
522 pm.rows() = breakParagraph(bigrow);
524 /* If there is more than one row, expand the text to the full
525 * allowable width. This setting here is needed for the
526 * setRowAlignment() below. We do nothing when tight insets are
529 if (pm.rows().size() > 1 && !tight_ && dim_.wid < max_width_)
530 dim_.wid = max_width_;
532 // Compute height and alignment of the rows.
533 for (Row & row : pm.rows()) {
536 setRowAlignment(row, max(dim_.wid, row.width()));
538 pm.dim().wid = max(pm.dim().wid, row.width() + row.right_margin);
539 pm.dim().des += row.height();
542 // This type of margin can only be handled at the global paragraph level
543 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX) {
545 if (par.isRTL(buffer.params())) {
546 // globally align the paragraph to the left.
547 int minleft = max_width_;
548 for (Row const & row : pm.rows())
549 minleft = min(minleft, row.left_margin);
550 offset = right_margin - minleft;
552 // globally align the paragraph to the right.
554 for (Row const & row : pm.rows())
555 maxwid = max(maxwid, row.width());
556 offset = max_width_ - right_margin - maxwid;
559 for (Row & row : pm.rows()) {
560 row.left_margin += offset;
561 row.dim().wid += offset;
565 // The space above and below the paragraph.
566 int top = parTopSpacing(pit);
567 int bottom = parBottomSpacing(pit);
569 // Top and bottom margin of the document (only at top-level)
570 // FIXME: It might be better to move this in another method
571 // specially tailored for the main text.
572 if (text_->isMainText()) {
574 top += bv_->topMargin();
575 if (pit + 1 == pit_type(text_->paragraphs().size())) {
576 bottom += bv_->bottomMargin();
580 // Add the top/bottom space to rows and paragraph metrics
581 pm.rows().front().dim().asc += top;
582 pm.rows().back().dim().des += bottom;
583 pm.dim().des += top + bottom;
585 // Move the pm ascent to be the same as the first row ascent
586 pm.dim().asc += pm.rows().front().ascent();
587 pm.dim().des -= pm.rows().front().ascent();
589 changed |= old_dim.height() != pm.dim().height();
595 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
597 LyXAlignment align = par.getAlign(bv_->buffer().params());
599 // handle alignment inside tabular cells
600 Inset const & owner = text_->inset();
601 bool forced_block = false;
602 switch (owner.contentAlignment()) {
603 case LYX_ALIGN_BLOCK:
604 // In general block align is the default state, but here it is
605 // an explicit choice. Therefore it should not be overridden
609 case LYX_ALIGN_CENTER:
611 case LYX_ALIGN_RIGHT:
612 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
613 align = owner.contentAlignment();
616 // unchanged (use align)
620 // Display-style insets should always be on a centered row
621 if (Inset const * inset = par.getInset(row.pos())) {
622 if (inset->rowFlags() & Display) {
623 if (inset->rowFlags() & AlignLeft)
624 align = LYX_ALIGN_BLOCK;
625 else if (inset->rowFlags() & AlignRight)
626 align = LYX_ALIGN_RIGHT;
628 align = LYX_ALIGN_CENTER;
632 if (align == LYX_ALIGN_BLOCK) {
633 // If this row has been broken abruptly by a display inset, or
634 // it is the end of the paragraph, or the user requested we
635 // not justify stuff, then don't stretch.
636 // A forced block alignment can only be overridden the 'no
637 // justification on screen' setting.
638 if ((row.flushed() && !forced_block)
639 || !bv_->buffer().params().justification)
640 align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
647 void TextMetrics::setRowAlignment(Row & row, int width) const
652 Paragraph const & par = text_->getPar(row.pit());
654 int const w = width - row.right_margin - row.width();
655 // FIXME: put back this assertion when the crash on new doc is solved.
656 //LASSERT(w >= 0, /**/);
658 // is there a manual margin with a manual label
659 Layout const & layout = par.layout();
662 if (layout.margintype == MARGIN_MANUAL
663 && layout.labeltype == LABEL_MANUAL) {
664 /// We might have real hfills in the label part
665 nlh = numberOfLabelHfills(par, row);
667 // A manual label par (e.g. List) has an auto-hfill
668 // between the label text and the body of the
670 // But we don't want to do this auto hfill if the par
675 if (nlh && !par.getLabelWidthString().empty())
676 row.label_hfill = labelFill(row) / double(nlh);
679 // are there any hfills in the row?
680 ParagraphMetrics const & pm = par_metrics_[row.pit()];
681 int nh = numberOfHfills(row, pm, par.beginOfBody());
685 // We don't have to look at the alignment if the row is already
686 // larger then the permitted width as then we force the
687 // LEFT_ALIGN'edness!
688 if (row.width() >= max_width_)
692 // Common case : there is no hfill, and the alignment will be
694 switch (getAlign(par, row)) {
695 case LYX_ALIGN_BLOCK:
696 // Expand expanding characters by a total of w
697 if (!row.setExtraWidth(w) && row.isRTL()) {
698 // Justification failed and the text is RTL: align to the right
699 row.left_margin += w;
704 // a displayed inset that is flushed
705 if (Inset const * inset = par.getInset(row.pos())) {
706 row.left_margin += inset->indent(*bv_);
707 row.dim().wid += inset->indent(*bv_);
710 case LYX_ALIGN_RIGHT:
711 if (Inset const * inset = par.getInset(row.pos())) {
712 int const new_w = max(w - inset->indent(*bv_), 0);
713 row.left_margin += new_w;
714 row.dim().wid += new_w;
716 row.left_margin += w;
720 case LYX_ALIGN_CENTER:
721 row.dim().wid += w / 2;
722 row.left_margin += w / 2;
725 case LYX_ALIGN_LAYOUT:
726 case LYX_ALIGN_SPECIAL:
727 case LYX_ALIGN_DECIMAL:
733 // Case nh > 0. There are hfill separators.
737 // Set size of hfill insets
738 pos_type const endpos = row.endpos();
739 pos_type body_pos = par.beginOfBody();
741 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
744 CoordCache::Insets & insetCache = bv_->coordCache().insets();
745 for (Row::Element & e : row) {
746 if (row.label_hfill && e.endpos == body_pos
747 && e.type == Row::SPACE)
748 e.dim.wid -= int(row.label_hfill * (nlh - 1));
749 if (e.inset && pm.hfillExpansion(row, e.pos)) {
750 if (e.pos >= body_pos) {
754 e.dim.wid += hfill_rem;
756 e.dim.wid += int(row.label_hfill);
757 // Cache the inset dimension.
758 insetCache.add(e.inset, e.dim);
764 int TextMetrics::labelFill(Row const & row) const
766 Paragraph const & par = text_->getPar(row.pit());
767 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
770 // iterate over elements before main body (except the last one,
771 // which is extra space).
772 for (Row::Element const & e : row) {
773 if (e.endpos >= par.beginOfBody())
778 docstring const & label = par.params().labelWidthString();
782 FontMetrics const & fm
783 = theFontMetrics(text_->labelFont(par));
785 return max(0, fm.width(label) - w);
789 int TextMetrics::labelEnd(pit_type const pit) const
791 // labelEnd is only needed if the layout fills a flushleft label.
792 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
794 // return the beginning of the body
795 return leftMargin(pit);
801 * Calling Text::getFont is slow. While rebreaking we scan a
802 * paragraph from left to right calling getFont for every char. This
803 * simple class address this problem by hidding an optimization trick
804 * (not mine btw -AB): the font is reused in the whole font span. The
805 * class handles transparently the "hidden" (not part of the fontlist)
806 * label font (as getFont does).
812 FontIterator(TextMetrics const & tm,
813 Paragraph const & par, pit_type pit, pos_type pos)
814 : tm_(tm), par_(par), pit_(pit), pos_(pos),
815 font_(tm.displayFont(pit, pos)),
816 endspan_(par.fontSpan(pos).last),
817 bodypos_(par.beginOfBody())
821 Font const & operator*() const { return font_; }
824 FontIterator & operator++()
827 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
828 font_ = tm_.displayFont(pit_, pos_);
829 endspan_ = par_.fontSpan(pos_).last;
835 Font * operator->() { return &font_; }
839 TextMetrics const & tm_;
841 Paragraph const & par_;
857 Row TextMetrics::tokenizeParagraph(pit_type const pit) const
861 Paragraph const & par = text_->getPar(pit);
862 Buffer const & buf = text_->inset().buffer();
863 BookmarksSection::BookmarkPosList bpl =
864 theSession().bookmarks().bookmarksInPar(buf.fileName(), par.id());
866 pos_type const end = par.size();
867 pos_type const body_pos = par.beginOfBody();
869 // check for possible inline completion
870 DocIterator const & ic_it = bv_->inlineCompletionPos();
871 pos_type ic_pos = -1;
872 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
873 ic_pos = ic_it.pos();
875 // Now we iterate through until we reach the right margin
876 // or the end of the par, then build a representation of the row.
878 FontIterator fi = FontIterator(*this, par, pit, 0);
879 // The real stopping condition is a few lines below.
881 // Firstly, check whether there is a bookmark here.
882 if (lyxrc.bookmarks_visibility == LyXRC::BMK_INLINE)
883 for (auto const & bp_p : bpl)
884 if (bp_p.second == i) {
886 f.fontInfo().setColor(Color_bookmark);
887 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
888 char_type const ch = 0x2775 + bp_p.first;
889 row.addVirtual(i, docstring(1, ch), f, Change());
892 // The stopping condition is here so that the display of a
893 // bookmark can take place at paragraph start too.
897 char_type c = par.getChar(i);
898 // The most special cases are handled first.
899 if (par.isInset(i)) {
900 Inset const * ins = par.getInset(i);
901 Dimension dim = bv_->coordCache().insets().dim(ins);
902 row.add(i, ins, dim, *fi, par.lookupChange(i));
903 } else if (c == ' ' && i + 1 == body_pos) {
904 // There is a space at i, but it should not be
905 // added as a separator, because it is just
906 // before body_pos. Instead, insert some spacing to
908 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
909 // this is needed to make sure that the row width is correct
911 int const add = max(fm.width(par.layout().labelsep),
912 labelEnd(pit) - row.width());
913 row.addSpace(i, add, *fi, par.lookupChange(i));
914 } else if (c == '\t')
915 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
916 *fi, par.lookupChange(i));
917 else if (c == 0x2028 || c == 0x2029) {
919 * U+2028 LINE SEPARATOR
920 * U+2029 PARAGRAPH SEPARATOR
922 * These are special unicode characters that break
923 * lines/pragraphs. Not handling them lead to trouble wrt
924 * Qt QTextLayout formatting. We add a visible character
925 * on screen so that the user can see that something is
929 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
930 // ¶ U+00B6 PILCROW SIGN
931 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
932 row.add(i, screen_char, *fi, par.lookupChange(i), i >= body_pos);
934 // row elements before body are unbreakable
935 row.add(i, c, *fi, par.lookupChange(i), i >= body_pos);
937 // add inline completion width
938 // draw logically behind the previous character
939 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
940 docstring const comp = bv_->inlineCompletion();
941 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
945 f.fontInfo().setColor(Color_inlinecompletion);
946 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
948 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
949 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
958 // End of paragraph marker, either if LyXRc requires it, or there
959 // is an end of paragraph change. The logic here is almost the
960 // same as in redoParagraph, remember keep them in sync.
961 ParagraphList const & pars = text_->paragraphs();
962 Change const & endchange = par.lookupChange(end);
963 if (endchange.changed())
964 row.needsChangeBar(true);
965 if ((lyxrc.paragraph_markers || endchange.changed())
966 && size_type(pit + 1) < pars.size()) {
967 // add a virtual element for the end-of-paragraph
968 // marker; it is shown on screen, but does not exist
970 Font f(text_->layoutFont(pit));
971 f.fontInfo().setColor(Color_paragraphmarker);
972 f.setLanguage(par.getParLanguage(buf.params()));
973 // ¶ U+00B6 PILCROW SIGN
974 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, endchange);
983 Row newRow(TextMetrics const & tm, pit_type pit, pos_type pos, bool is_rtl)
988 nrow.left_margin = tm.leftMargin(pit, pos);
989 nrow.right_margin = tm.rightMargin(pit);
991 swap(nrow.left_margin, nrow.right_margin);
992 // Remember that the row width takes into account the left_margin
993 // but not the right_margin.
994 nrow.dim().wid = nrow.left_margin;
999 /** Helper template flexible_const_iterator<T>
1000 * A way to iterate over a const container, but insert fake elements in it.
1001 * In the case of a row, we will have to break some elements, which
1002 * create new ones. This class allows to abstract this.
1003 * Only the required parts are implemented for now.
1006 class flexible_const_iterator {
1007 typedef typename T::value_type value_type;
1011 flexible_const_iterator operator++() {
1019 value_type operator*() const { return pile_.empty() ? *cit_ : pile_.back(); }
1021 void put(value_type const & e) { pile_.push_back(e); }
1023 // This should be private, but declaring the friend functions is too much work
1025 typename T::const_iterator cit_;
1026 // A vector that is used as like a pile to store the elements to
1027 // consider before incrementing the underlying iterator.
1028 vector<value_type> pile_;
1033 flexible_const_iterator<T> flexible_begin(T const & t)
1035 return { t.begin(), vector<typename T::value_type>() };
1040 flexible_const_iterator<T> flexible_end(T const & t)
1042 return { t.end(), vector<typename T::value_type>() };
1046 // Equality is only possible if respective piles are empty
1048 bool operator==(flexible_const_iterator<T> const & t1,
1049 flexible_const_iterator<T> const & t2)
1051 return t1.cit_ == t2.cit_ && t1.pile_.empty() && t2.pile_.empty();
1057 RowList TextMetrics::breakParagraph(Row const & bigrow) const
1060 bool const is_rtl = text_->isRTL(bigrow.pit());
1062 bool need_new_row = true;
1065 flexible_const_iterator<Row> fcit = flexible_begin(bigrow);
1066 flexible_const_iterator<Row> const end = flexible_end(bigrow);
1069 if (!rows.empty()) {
1070 Row & rb = rows.back();
1072 rb.right_boundary(!rb.empty() && rb.endpos() < bigrow.endpos()
1073 && rb.back().endpos == rb.endpos());
1074 // make sure that the RTL elements are in reverse ordering
1075 rb.reverseRTL(is_rtl);
1077 rows.push_back(newRow(*this, bigrow.pit(), pos, is_rtl));
1078 // the width available for the row.
1079 width = max_width_ - rows.back().right_margin;
1080 need_new_row = false;
1083 // The stopping condition is here because we may need a new
1084 // empty row at the end.
1088 // Next element to consider is either the top of the temporary
1089 // pile, or the place when we were in main row
1090 Row::Element elt = *fcit;
1091 Row::Element next_elt = elt.splitAt(width - rows.back().width(),
1092 !elt.font.language()->wordWrap());
1093 // a new element in the row
1094 rows.back().push_back(elt);
1095 rows.back().finalizeLast();
1098 // Go to next element
1101 // Add a new next element on the pile
1102 if (next_elt.isValid()) {
1103 // do as if we inserted this element in the original row
1105 need_new_row = true;
1109 if (!rows.empty()) {
1110 Row & rb = rows.back();
1111 // Last row in paragraph is flushed
1113 rb.endpos(bigrow.endpos());
1114 rb.right_boundary(false);
1115 // make sure that the RTL elements are in reverse ordering
1116 rb.reverseRTL(is_rtl);
1122 /** This is the function where the hard work is done. The code here is
1123 * very sensitive to small changes :) Note that part of the
1124 * intelligence is also in Row::shortenIfNeeded.
1126 bool TextMetrics::breakRow(Row & row, int const right_margin) const
1128 LATTEST(row.empty());//
1129 Paragraph const & par = text_->getPar(row.pit());//
1130 Buffer const & buf = text_->inset().buffer();//
1131 BookmarksSection::BookmarkPosList bpl =//
1132 theSession().bookmarks().bookmarksInPar(buf.fileName(), par.id());//
1134 pos_type const end = par.size();//
1135 pos_type const pos = row.pos();//
1136 pos_type const body_pos = par.beginOfBody();//
1137 bool const is_rtl = text_->isRTL(row.pit());//
1138 bool need_new_row = false;//
1140 row.left_margin = leftMargin(row.pit(), pos);//
1141 row.right_margin = right_margin;//
1143 swap(row.left_margin, row.right_margin);//
1144 // Remember that the row width takes into account the left_margin
1145 // but not the right_margin.
1146 row.dim().wid = row.left_margin;//
1147 // the width available for the row.
1148 int const width = max_width_ - row.right_margin;//
1150 // check for possible inline completion
1151 DocIterator const & ic_it = bv_->inlineCompletionPos();//
1152 pos_type ic_pos = -1;//
1153 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())//
1154 ic_pos = ic_it.pos();//
1156 // Now we iterate through until we reach the right margin
1157 // or the end of the par, then build a representation of the row.
1158 pos_type i = pos;//---------------------------------------------------vvv
1159 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
1160 // The real stopping condition is a few lines below.
1162 // Firstly, check whether there is a bookmark here.
1163 if (lyxrc.bookmarks_visibility == LyXRC::BMK_INLINE)
1164 for (auto const & bp_p : bpl)
1165 if (bp_p.second == i) {
1167 f.fontInfo().setColor(Color_bookmark);
1168 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
1169 char_type const ch = 0x2775 + bp_p.first;
1170 row.addVirtual(i, docstring(1, ch), f, Change());
1173 // The stopping condition is here so that the display of a
1174 // bookmark can take place at paragraph start too.
1175 if (i >= end || (i != pos && row.width() > width))//^width
1178 char_type c = par.getChar(i);
1179 // The most special cases are handled first.
1180 if (par.isInset(i)) {
1181 Inset const * ins = par.getInset(i);
1182 Dimension dim = bv_->coordCache().insets().dim(ins);
1183 row.add(i, ins, dim, *fi, par.lookupChange(i));
1184 } else if (c == ' ' && i + 1 == body_pos) {
1185 // There is a space at i, but it should not be
1186 // added as a separator, because it is just
1187 // before body_pos. Instead, insert some spacing to
1189 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
1190 // this is needed to make sure that the row width is correct
1192 int const add = max(fm.width(par.layout().labelsep),
1193 labelEnd(row.pit()) - row.width());
1194 row.addSpace(i, add, *fi, par.lookupChange(i));
1195 } else if (c == '\t')
1196 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
1197 *fi, par.lookupChange(i));
1198 else if (c == 0x2028 || c == 0x2029) {
1200 * U+2028 LINE SEPARATOR
1201 * U+2029 PARAGRAPH SEPARATOR
1203 * These are special unicode characters that break
1204 * lines/pragraphs. Not handling them lead to trouble wrt
1205 * Qt QTextLayout formatting. We add a visible character
1206 * on screen so that the user can see that something is
1210 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
1211 // ¶ U+00B6 PILCROW SIGN
1212 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
1213 row.add(i, screen_char, *fi, par.lookupChange(i), i >= body_pos);
1215 row.add(i, c, *fi, par.lookupChange(i), i >= body_pos);
1217 // add inline completion width
1218 // draw logically behind the previous character
1219 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
1220 docstring const comp = bv_->inlineCompletion();
1221 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
1225 f.fontInfo().setColor(Color_inlinecompletion);
1226 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
1228 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
1229 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
1230 }//---------------------------------------------------------------^^^
1232 // FIXME: Handle when breaking the rows
1233 // Handle some situations that abruptly terminate the row
1234 // - Before an inset with BreakBefore
1235 // - After an inset with BreakAfter
1236 Inset const * prevInset = !row.empty() ? row.back().inset : 0;
1237 Inset const * nextInset = (i + 1 < end) ? par.getInset(i + 1) : 0;
1238 if ((nextInset && nextInset->rowFlags() & BreakBefore)
1239 || (prevInset && prevInset->rowFlags() & BreakAfter)) {
1241 // Force a row creation after this one if it is ended by
1242 // an inset that either
1243 // - has row flag RowAfter that enforces that;
1244 // - or (1) did force the row breaking, (2) is at end of
1245 // paragraph and (3) the said paragraph has an end label.
1246 need_new_row = prevInset &&
1247 (prevInset->rowFlags() & AlwaysBreakAfter
1248 || (prevInset->rowFlags() & BreakAfter && i + 1 == end
1249 && text_->getEndLabel(row.pit()) != END_LABEL_NO_LABEL));
1257 //--------------------------------------------------------------------vvv
1261 // End of paragraph marker. The logic here is almost the
1262 // same as in redoParagraph, remember keep them in sync.
1263 ParagraphList const & pars = text_->paragraphs();
1264 Change const & change = par.lookupChange(i);
1265 if ((lyxrc.paragraph_markers || change.changed())
1266 && !need_new_row // not this
1267 && i == end && size_type(row.pit() + 1) < pars.size()) {
1268 // add a virtual element for the end-of-paragraph
1269 // marker; it is shown on screen, but does not exist
1270 // in the paragraph.
1271 Font f(text_->layoutFont(row.pit()));
1272 f.fontInfo().setColor(Color_paragraphmarker);
1273 f.setLanguage(par.getParLanguage(buf.params()));
1274 // ¶ U+00B6 PILCROW SIGN
1275 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, change);
1278 // Is there a end-of-paragaph change?
1279 if (i == end && par.lookupChange(end).changed() && !need_new_row)
1280 row.needsChangeBar(true);
1281 //--------------------------------------------------------------------^^^
1282 // FIXME : nothing below this
1284 // if the row is too large, try to cut at last separator. In case
1285 // of success, reset indication that the row was broken abruptly.
1286 int const next_width = max_width_ - leftMargin(row.pit(), row.endpos())
1287 - rightMargin(row.pit());
1289 if (row.shortenIfNeeded(width, next_width))
1291 row.right_boundary(!row.empty() && row.endpos() < end//
1292 && row.back().endpos == row.endpos());//
1293 // Last row in paragraph is flushed
1294 if (row.endpos() == end)//
1295 row.flushed(true);//
1297 // make sure that the RTL elements are in reverse ordering
1298 row.reverseRTL(is_rtl);//
1299 //LYXERR0("breakrow: row is " << row);
1301 return need_new_row;
1304 int TextMetrics::parTopSpacing(pit_type const pit) const
1306 Paragraph const & par = text_->getPar(pit);
1307 Layout const & layout = par.layout();
1310 ParagraphList const & pars = text_->paragraphs();
1311 double const dh = defaultRowHeight();
1313 BufferParams const & bparams = bv_->buffer().params();
1314 Inset const & inset = text_->inset();
1315 // some parskips VERY EASY IMPLEMENTATION
1316 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1317 && !inset.getLayout().parbreakIsNewline()
1318 && !par.layout().parbreak_is_newline
1320 && ((layout.isParagraph() && par.getDepth() == 0)
1321 || (pars[pit - 1].layout().isParagraph()
1322 && pars[pit - 1].getDepth() == 0))) {
1323 asc += bparams.getDefSkip().inPixels(*bv_);
1326 if (par.params().startOfAppendix())
1329 // special code for the top label
1330 if (layout.labelIsAbove()
1331 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1332 && !par.labelString().empty()) {
1333 FontInfo labelfont = text_->labelFont(par);
1334 FontMetrics const & lfm = theFontMetrics(labelfont);
1335 asc += int(lfm.maxHeight() * layout.spacing.getValue()
1336 * text_->spacing(par)
1337 + (layout.topsep + layout.labelbottomsep) * dh);
1340 // Add the layout spaces, for example before and after
1341 // a section, or between the items of a itemize or enumerate
1344 pit_type prev = text_->depthHook(pit, par.getDepth());
1345 Paragraph const & prevpar = pars[prev];
1346 double layoutasc = 0;
1348 && prevpar.layout() == layout
1349 && prevpar.getDepth() == par.getDepth()
1350 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1351 layoutasc = layout.itemsep * dh;
1352 } else if (pit != 0 && layout.topsep > 0)
1353 layoutasc = layout.topsep * dh;
1355 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1357 prev = text_->outerHook(pit);
1358 if (prev != pit_type(pars.size())) {
1359 asc += int(pars[prev].layout().parsep * dh);
1360 } else if (pit != 0) {
1361 Paragraph const & prevpar2 = pars[pit - 1];
1362 if (prevpar2.getDepth() != 0 || prevpar2.layout() == layout)
1363 asc += int(layout.parsep * dh);
1370 int TextMetrics::parBottomSpacing(pit_type const pit) const
1372 double layoutdesc = 0;
1373 ParagraphList const & pars = text_->paragraphs();
1374 double const dh = defaultRowHeight();
1376 // add the layout spaces, for example before and after
1377 // a section, or between the items of a itemize or enumerate
1379 pit_type nextpit = pit + 1;
1380 if (nextpit != pit_type(pars.size())) {
1381 pit_type cpit = pit;
1383 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1384 double usual = pars[cpit].layout().bottomsep * dh;
1386 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1387 if (pars[cpit].layout() != pars[nextpit].layout()
1388 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1389 unusual = pars[cpit].layout().bottomsep * dh;
1390 layoutdesc = max(unusual, usual);
1391 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1392 if (pars[cpit].layout() != pars[nextpit].layout()
1393 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1394 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1398 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1402 void TextMetrics::setRowHeight(Row & row) const
1404 Paragraph const & par = text_->getPar(row.pit());
1405 Layout const & layout = par.layout();
1406 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1408 // Initial value for ascent (useful if row is empty).
1409 Font const font = displayFont(row.pit(), row.pos());
1410 FontMetrics const & fm = theFontMetrics(font);
1411 int maxasc = int(fm.maxAscent() * spacing_val);
1412 int maxdes = int(fm.maxDescent() * spacing_val);
1414 // Take label string into account (useful if labelfont is large)
1415 if (row.pos() == 0 && layout.labelIsInline()) {
1416 FontInfo const labelfont = text_->labelFont(par);
1417 FontMetrics const & lfm = theFontMetrics(labelfont);
1418 maxasc = max(maxasc, int(lfm.maxAscent() * spacing_val));
1419 maxdes = max(maxdes, int(lfm.maxDescent() * spacing_val));
1422 // Find the ascent/descent of the row contents
1423 for (Row::Element const & e : row) {
1425 maxasc = max(maxasc, e.dim.ascent());
1426 maxdes = max(maxdes, e.dim.descent());
1428 FontMetrics const & fm2 = theFontMetrics(e.font);
1429 maxasc = max(maxasc, int(fm2.maxAscent() * spacing_val));
1430 maxdes = max(maxdes, int(fm2.maxDescent() * spacing_val));
1434 // This is nicer with box insets
1438 row.dim().asc = maxasc;
1439 row.dim().des = maxdes;
1441 // This is useful for selections
1442 row.contents_dim() = row.dim();
1446 // x is an absolute screen coord
1447 // returns the column near the specified x-coordinate of the row
1448 // x is set to the real beginning of this column
1449 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1450 bool & boundary) const
1452 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1453 /// For the main Text, it is possible that this pit is not
1454 /// yet in the CoordCache when moving cursor up.
1455 /// x Paragraph coordinate is always 0 for main text anyway.
1456 int const xo = origin_.x_;
1459 // Adapt to cursor row scroll offset if applicable.
1460 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1463 pos_type pos = row.pos();
1466 x = row.left_margin;
1467 else if (x <= row.left_margin) {
1468 pos = row.front().left_pos();
1469 x = row.left_margin;
1470 } else if (x >= row.width()) {
1471 pos = row.back().right_pos();
1474 double w = row.left_margin;
1475 Row::const_iterator cit = row.begin();
1476 Row::const_iterator cend = row.end();
1477 for ( ; cit != cend; ++cit) {
1478 if (w <= x && w + cit->full_width() > x) {
1479 int x_offset = int(x - w);
1480 pos = cit->x2pos(x_offset);
1481 x = int(x_offset + w);
1484 w += cit->full_width();
1486 if (cit == row.end()) {
1487 pos = row.back().right_pos();
1490 /** This tests for the case where the cursor is placed
1491 * just before a font direction change. See comment on
1492 * the boundary_ member in DocIterator.h to understand
1493 * how boundary helps here.
1495 else if (pos == cit->endpos
1496 && ((!cit->isRTL() && cit + 1 != row.end()
1497 && (cit + 1)->isRTL())
1498 || (cit->isRTL() && cit != row.begin()
1499 && !(cit - 1)->isRTL())))
1503 /** This tests for the case where the cursor is set at the end
1504 * of a row which has been broken due something else than a
1505 * separator (a display inset or a forced breaking of the
1506 * row). We know that there is a separator when the end of the
1507 * row is larger than the end of its last element.
1509 if (!row.empty() && pos == row.back().endpos
1510 && row.back().endpos == row.endpos()) {
1511 Inset const * inset = row.back().inset;
1512 if (inset && (inset->lyxCode() == NEWLINE_CODE
1513 || inset->lyxCode() == SEPARATOR_CODE))
1514 pos = row.back().pos;
1516 boundary = row.right_boundary();
1520 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1526 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1528 // We play safe and use parMetrics(pit) to make sure the
1529 // ParagraphMetrics will be redone and OK to use if needed.
1530 // Otherwise we would use an empty ParagraphMetrics in
1531 // upDownInText() while in selection mode.
1532 ParagraphMetrics const & pm = parMetrics(pit);
1534 LBUFERR(row < int(pm.rows().size()));
1536 Row const & r = pm.rows()[row];
1537 return getPosNearX(r, x, bound);
1541 // y is screen coordinate
1542 pit_type TextMetrics::getPitNearY(int y)
1544 LASSERT(!text_->paragraphs().empty(), return -1);
1545 LASSERT(!par_metrics_.empty(), return -1);
1546 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1548 // look for highest numbered paragraph with y coordinate less than given y
1551 ParMetricsCache::const_iterator it = par_metrics_.begin();
1552 ParMetricsCache::const_iterator et = par_metrics_.end();
1553 ParMetricsCache::const_iterator last = et;
1556 ParagraphMetrics const & pm = it->second;
1558 if (y < it->second.position() - pm.ascent()) {
1559 // We are looking for a position that is before the first paragraph in
1560 // the cache (which is in priciple off-screen, that is before the
1563 // We are already at the first paragraph in the inset.
1565 // OK, this is the paragraph we are looking for.
1566 pit = it->first - 1;
1571 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1573 if (y >= last->second.position() + pm_last.descent()) {
1574 // We are looking for a position that is after the last paragraph in
1575 // the cache (which is in priciple off-screen), that is before the
1577 pit = last->first + 1;
1578 if (pit == int(text_->paragraphs().size()))
1579 // We are already at the last paragraph in the inset.
1581 // OK, this is the paragraph we are looking for.
1582 newParMetricsDown();
1586 for (; it != et; ++it) {
1587 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1588 << " y: " << it->second.position());
1590 ParagraphMetrics const & pm2 = par_metrics_[it->first];
1592 if (it->first >= pit && it->second.position() - pm2.ascent() <= y) {
1594 yy = it->second.position();
1598 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1604 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1605 bool assert_in_view, bool up)
1607 ParagraphMetrics const & pm = par_metrics_[pit];
1609 int yy = pm.position() - pm.ascent();
1610 LBUFERR(!pm.rows().empty());
1611 RowList::const_iterator rit = pm.rows().begin();
1612 RowList::const_iterator rlast = pm.rows().end();
1614 for (; rit != rlast; yy += rit->height(), ++rit)
1615 if (yy + rit->height() > y)
1618 if (assert_in_view) {
1619 if (!up && yy + rit->height() > y) {
1620 if (rit != pm.rows().begin()) {
1623 } else if (pit != 0) {
1626 ParagraphMetrics const & pm2 = par_metrics_[pit];
1627 rit = pm2.rows().end();
1631 } else if (up && yy != y) {
1633 y = yy + rit->height();
1635 } else if (pit < int(text_->paragraphs().size()) - 1) {
1637 newParMetricsDown();
1638 ParagraphMetrics const & pm2 = par_metrics_[pit];
1639 rit = pm2.rows().begin();
1648 // x,y are absolute screen coordinates
1649 // sets cursor recursively descending into nested editable insets
1650 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1651 bool assert_in_view, bool up)
1653 if (lyxerr.debugging(Debug::WORKAREA)) {
1654 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1655 cur.bv().coordCache().dump();
1657 pit_type pit = getPitNearY(y);
1658 LASSERT(pit != -1, return 0);
1659 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1662 // Do we cover an inset?
1663 InsetList::Element * e = checkInsetHit(pit, x, y);
1666 // No inset, set position in the text
1667 bool bound = false; // is modified by getPosNearX
1668 cur.pos() = getPosNearX(row, x, bound);
1669 cur.boundary(bound);
1670 cur.setCurrentFont();
1675 Inset * inset = e->inset;
1676 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1678 // Set position in front of inset
1680 cur.boundary(false);
1683 // Try to descend recursively inside the inset.
1684 Inset * edited = inset->editXY(cur, x, y);
1685 // FIXME: it is not clear that the test on position is needed
1686 // Remove it if/when semantics of editXY is clarified
1687 if (cur.text() == text_ && cur.pos() == e->pos) {
1688 // non-editable inset, set cursor after the inset if x is
1689 // nearer to that position (bug 9628)
1690 bool bound = false; // is modified by getPosNearX
1691 cur.pos() = getPosNearX(row, x, bound);
1692 cur.boundary(bound);
1693 cur.setCurrentFont();
1697 if (cur.top().text() == text_)
1698 cur.setCurrentFont();
1703 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1705 LASSERT(text_ == cur.text(), return);
1706 pit_type const pit = getPitNearY(y);
1707 LASSERT(pit != -1, return);
1709 ParagraphMetrics const & pm = par_metrics_[pit];
1711 int yy = pm.position() - pm.rows().front().ascent();
1712 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1713 " pit: " << pit << " yy: " << yy);
1716 LBUFERR(pm.rows().size());
1717 for (; r < int(pm.rows().size()) - 1; ++r) {
1718 Row const & row = pm.rows()[r];
1719 if (yy + row.height() > y)
1724 Row const & row = pm.rows()[r];
1726 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1730 pos_type const pos = getPosNearX(row, xx, bound);
1732 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1734 text_->setCursor(cur, pit, pos, true, bound);
1735 // remember new position.
1740 //takes screen x,y coordinates
1741 InsetList::Element * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1743 Paragraph const & par = text_->paragraphs()[pit];
1744 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1746 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1748 for (InsetList::Element const & e : par.insetList()) {
1749 LYXERR(Debug::DEBUG, "examining inset " << e.inset);
1751 if (insetCache.covers(e.inset, x, y)) {
1752 LYXERR(Debug::DEBUG, "Hit inset: " << e.inset);
1753 return const_cast<InsetList::Element *>(&e);
1757 LYXERR(Debug::DEBUG, "No inset hit. ");
1762 //takes screen x,y coordinates
1763 Inset * TextMetrics::checkInsetHit(int x, int y)
1765 pit_type const pit = getPitNearY(y);
1766 LASSERT(pit != -1, return 0);
1767 InsetList::Element * e = checkInsetHit(pit, x, y);
1776 int TextMetrics::cursorX(CursorSlice const & sl,
1777 bool boundary) const
1779 LASSERT(sl.text() == text_, return 0);
1781 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1782 if (pm.rows().empty())
1784 Row const & row = pm.getRow(sl.pos(), boundary);
1785 pos_type const pos = sl.pos();
1788 row.findElement(pos, boundary, x);
1794 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1796 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1797 ParagraphMetrics const & pm = parMetrics(sl.pit());
1798 if (pm.rows().empty())
1802 h -= parMetrics(0).rows()[0].ascent();
1803 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1804 h += parMetrics(pit).height();
1807 if (pos && boundary)
1809 size_t const rend = pm.pos2row(pos);
1810 for (size_t rit = 0; rit != rend; ++rit)
1811 h += pm.rows()[rit].height();
1812 h += pm.rows()[rend].ascent();
1817 // the cursor set functions have a special mechanism. When they
1818 // realize you left an empty paragraph, they will delete it.
1820 bool TextMetrics::cursorHome(Cursor & cur)
1822 LASSERT(text_ == cur.text(), return false);
1823 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1824 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1825 return text_->setCursor(cur, cur.pit(), row.pos());
1829 bool TextMetrics::cursorEnd(Cursor & cur)
1831 LASSERT(text_ == cur.text(), return false);
1832 // if not on the last row of the par, put the cursor before
1833 // the final space exept if I have a spanning inset or one string
1834 // is so long that we force a break.
1835 pos_type end = cur.textRow().endpos();
1837 // empty text, end-1 is no valid position
1839 bool boundary = false;
1840 if (end != cur.lastpos()) {
1841 if (!cur.paragraph().isLineSeparator(end-1)
1842 && !cur.paragraph().isNewline(end-1)
1843 && !cur.paragraph().isEnvSeparator(end-1))
1847 } else if (cur.paragraph().isEnvSeparator(end-1))
1849 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1853 void TextMetrics::deleteLineForward(Cursor & cur)
1855 LASSERT(text_ == cur.text(), return);
1856 if (cur.lastpos() == 0) {
1857 // Paragraph is empty, so we just go forward
1858 text_->cursorForward(cur);
1861 cur.selection(true); // to avoid deletion
1864 // What is this test for ??? (JMarc)
1865 if (!cur.selection())
1866 text_->deleteWordForward(cur);
1868 cap::cutSelection(cur, false);
1869 cur.checkBufferStructure();
1874 int TextMetrics::leftMargin(pit_type pit) const
1876 // FIXME: what is the semantics? It depends on whether the
1877 // paragraph is empty!
1878 return leftMargin(pit, text_->paragraphs()[pit].size());
1882 int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
1884 ParagraphList const & pars = text_->paragraphs();
1886 LASSERT(pit >= 0, return 0);
1887 LASSERT(pit < int(pars.size()), return 0);
1888 Paragraph const & par = pars[pit];
1889 LASSERT(pos >= 0, return 0);
1890 // We do not really care whether pos > par.size(), since we do not
1891 // access the data. It can be actually useful, when querying the
1892 // margin without indentation (see leftMargin(pit_type).
1894 Buffer const & buffer = bv_->buffer();
1895 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1896 DocumentClass const & tclass = buffer.params().documentClass();
1897 Layout const & layout = par.layout();
1898 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1900 docstring parindent = layout.parindent;
1904 if (text_->isMainText()) {
1905 l_margin += bv_->leftMargin();
1906 l_margin += bfm.signedWidth(tclass.leftmargin());
1909 int depth = par.getDepth();
1911 // find the next level paragraph
1912 pit_type newpar = text_->outerHook(pit);
1913 if (newpar != pit_type(pars.size())) {
1914 if (pars[newpar].layout().isEnvironment()) {
1915 int nestmargin = depth * nestMargin();
1916 if (text_->isMainText())
1917 nestmargin += changebarMargin();
1918 l_margin = max(leftMargin(newpar), nestmargin);
1919 // Remove the parindent that has been added
1920 // if the paragraph was empty.
1921 if (pars[newpar].empty() &&
1922 buffer.params().paragraph_separation ==
1923 BufferParams::ParagraphIndentSeparation) {
1924 docstring pi = pars[newpar].layout().parindent;
1925 l_margin -= bfm.signedWidth(pi);
1928 if (tclass.isDefaultLayout(par.layout())
1929 || tclass.isPlainLayout(par.layout())) {
1930 if (pars[newpar].params().noindent())
1933 parindent = pars[newpar].layout().parindent;
1938 // This happens after sections or environments in standard classes.
1939 // We have to check the previous layout at same depth.
1940 if (buffer.params().paragraph_separation ==
1941 BufferParams::ParagraphSkipSeparation)
1943 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1944 pit_type prev = text_->depthHook(pit, par.getDepth());
1945 if (par.layout() == pars[prev].layout()) {
1947 && pars[pit - 1].layout().nextnoindent)
1949 } else if (pars[prev].layout().nextnoindent)
1953 FontInfo const labelfont = text_->labelFont(par);
1954 FontMetrics const & lfm = theFontMetrics(labelfont);
1956 switch (layout.margintype) {
1957 case MARGIN_DYNAMIC:
1958 if (!layout.leftmargin.empty()) {
1959 l_margin += bfm.signedWidth(layout.leftmargin);
1961 if (!par.labelString().empty()) {
1962 l_margin += lfm.signedWidth(layout.labelindent);
1963 l_margin += lfm.width(par.labelString());
1964 l_margin += lfm.width(layout.labelsep);
1968 case MARGIN_MANUAL: {
1969 l_margin += lfm.signedWidth(layout.labelindent);
1970 // The width of an empty par, even with manual label, should be 0
1971 if (!par.empty() && pos >= par.beginOfBody()) {
1972 if (!par.getLabelWidthString().empty()) {
1973 docstring labstr = par.getLabelWidthString();
1974 l_margin += lfm.width(labstr);
1975 l_margin += lfm.width(layout.labelsep);
1981 case MARGIN_STATIC: {
1982 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1983 / (par.getDepth() + 4);
1987 case MARGIN_FIRST_DYNAMIC:
1988 if (layout.labeltype == LABEL_MANUAL) {
1989 // if we are at position 0, we are never in the body
1990 if (pos > 0 && pos >= par.beginOfBody())
1991 l_margin += lfm.signedWidth(layout.leftmargin);
1993 l_margin += lfm.signedWidth(layout.labelindent);
1995 // Special case to fix problems with
1997 || (layout.labeltype == LABEL_STATIC
1998 && layout.latextype == LATEX_ENVIRONMENT
1999 && !text_->isFirstInSequence(pit))) {
2000 l_margin += lfm.signedWidth(layout.leftmargin);
2001 } else if (!layout.labelIsAbove()) {
2002 l_margin += lfm.signedWidth(layout.labelindent);
2003 l_margin += lfm.width(layout.labelsep);
2004 l_margin += lfm.width(par.labelString());
2008 case MARGIN_RIGHT_ADDRESS_BOX:
2009 // This is handled globally in redoParagraph().
2013 if (!par.params().leftIndent().zero())
2014 l_margin += par.params().leftIndent().inPixels(max_width_, lfm.em());
2016 LyXAlignment align = par.getAlign(bv_->buffer().params());
2018 // set the correct parindent
2020 && (layout.labeltype == LABEL_NO_LABEL
2021 || layout.labeltype == LABEL_ABOVE
2022 || layout.labeltype == LABEL_CENTERED
2023 || (layout.labeltype == LABEL_STATIC
2024 && layout.latextype == LATEX_ENVIRONMENT
2025 && !text_->isFirstInSequence(pit)))
2026 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2027 && !par.params().noindent()
2028 // in some insets, paragraphs are never indented
2029 && !text_->inset().neverIndent()
2030 // display style insets do not need indentation
2033 && par.getInset(0)->rowFlags() & Display)
2034 && (!(tclass.isDefaultLayout(par.layout())
2035 || tclass.isPlainLayout(par.layout()))
2036 || buffer.params().paragraph_separation
2037 == BufferParams::ParagraphIndentSeparation)) {
2038 /* use the parindent of the layout when the default
2039 * indentation is used otherwise use the indentation set in
2040 * the document settings
2042 if (buffer.params().getParIndent().empty())
2043 l_margin += bfm.signedWidth(parindent);
2045 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
2052 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2054 if (par_metrics_.empty())
2060 y -= par_metrics_.begin()->second.ascent();
2061 for (auto & pm_pair : par_metrics_) {
2062 pit_type const pit = pm_pair.first;
2063 ParagraphMetrics & pm = pm_pair.second;
2065 // Save the paragraph position in the cache.
2067 drawParagraph(pi, pit, x, y);
2073 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
2075 ParagraphMetrics const & pm = par_metrics_[pit];
2076 if (pm.rows().empty())
2078 size_t const nrows = pm.rows().size();
2079 // Remember left and right margin for drawing math numbers
2080 Changer changeleft = changeVar(pi.leftx, x + leftMargin(pit));
2081 Changer changeright = changeVar(pi.rightx, x + width() - rightMargin(pit));
2083 // Use fast lane in nodraw stage.
2084 if (pi.pain.isNull()) {
2085 for (size_t i = 0; i != nrows; ++i) {
2087 Row const & row = pm.rows()[i];
2088 // Adapt to cursor row scroll offset if applicable.
2089 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
2093 RowPainter rp(pi, *text_, row, row_x, y);
2095 rp.paintOnlyInsets();
2101 int const ww = bv_->workHeight();
2102 Cursor const & cur = bv_->cursor();
2103 DocIterator sel_beg = cur.selectionBegin();
2104 DocIterator sel_end = cur.selectionEnd();
2105 bool selection = cur.selection()
2106 // This is our text.
2107 && cur.text() == text_
2108 // if the anchor is outside, this is not our selection
2109 && cur.normalAnchor().text() == text_
2110 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2112 // We store the begin and end pos of the selection relative to this par
2113 DocIterator sel_beg_par = cur.selectionBegin();
2114 DocIterator sel_end_par = cur.selectionEnd();
2116 // We care only about visible selection.
2118 if (pit != sel_beg.pit()) {
2119 sel_beg_par.pit() = pit;
2120 sel_beg_par.pos() = 0;
2122 if (pit != sel_end.pit()) {
2123 sel_end_par.pit() = pit;
2124 sel_end_par.pos() = sel_end_par.lastpos();
2128 if (text_->isRTL(pit))
2129 swap(pi.leftx, pi.rightx);
2131 BookmarksSection::BookmarkPosList bpl =
2132 theSession().bookmarks().bookmarksInPar(bv_->buffer().fileName(), pm.par().id());
2134 for (size_t i = 0; i != nrows; ++i) {
2136 Row const & row = pm.rows()[i];
2137 // Adapt to cursor row scroll offset if applicable.
2138 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
2142 // It is not needed to draw on screen if we are not inside.
2143 bool const inside = (y + row.descent() >= 0
2144 && y - row.ascent() < ww);
2146 // Inset positions have already been set in nodraw stage.
2152 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2154 row.clearSelectionAndMargins();
2156 // The row knows nothing about the paragraph, so we have to check
2157 // whether this row is the first or last and update the margins.
2158 if (row.selection()) {
2159 if (row.sel_beg == 0)
2160 row.change(row.begin_margin_sel, sel_beg.pit() < pit);
2161 if (row.sel_end == sel_end_par.lastpos())
2162 row.change(row.end_margin_sel, sel_end.pit() > pit);
2165 // Take this opportunity to spellcheck the row contents.
2166 if (row.changed() && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
2167 text_->getPar(pit).spellCheck();
2170 RowPainter rp(pi, *text_, row, row_x, y);
2172 // Don't paint the row if a full repaint has not been requested
2173 // and if it has not changed.
2174 if (!pi.full_repaint && !row.changed()) {
2175 // Paint only the insets if the text itself is
2177 rp.paintOnlyInsets();
2178 rp.paintTooLargeMarks(
2179 row_x + row.left_x() < bv_->leftMargin(),
2180 row_x + row.right_x() > bv_->workWidth() - bv_->rightMargin());
2186 // Clear background of this row if paragraph background was not
2187 // already cleared because of a full repaint.
2188 if (!pi.full_repaint && row.changed()) {
2189 LYXERR(Debug::PAINTING, "Clear rect@("
2190 << max(row_x, 0) << ", " << y - row.ascent() << ")="
2191 << width() << " x " << row.height());
2192 pi.pain.fillRectangle(row_x, y - row.ascent(),
2193 width(), row.height(), pi.background_color);
2196 // Instrumentation for testing row cache (see also
2198 if (lyxerr.debugging(Debug::PAINTING)
2199 && (row.selection() || pi.full_repaint || row.changed())) {
2200 string const foreword = text_->isMainText() ? "main text redraw "
2201 : "inset text redraw: ";
2202 LYXERR0(foreword << "pit=" << pit << " row=" << i
2203 << (row.selection() ? " row_selection": "")
2204 << (pi.full_repaint ? " full_repaint" : "")
2205 << (row.changed() ? " row.changed" : ""));
2208 // Backup full_repaint status and force full repaint
2209 // for inner insets as the Row has been cleared out.
2210 bool tmp = pi.full_repaint;
2211 pi.full_repaint = true;
2213 rp.paintSelection();
2216 if (row.needsChangeBar())
2217 rp.paintChangeBar();
2223 rp.paintTooLargeMarks(
2224 row_x + row.left_x() < bv_->leftMargin(),
2225 row_x + row.right_x() > bv_->workWidth() - bv_->rightMargin());
2226 // indicate bookmarks presence in margin
2227 if (lyxrc.bookmarks_visibility == LyXRC::BMK_MARGIN)
2228 for (auto const & bp_p : bpl)
2229 if (bp_p.second >= row.pos() && bp_p.second < row.endpos())
2230 rp.paintBookmark(bp_p.first);
2235 // This debug code shows on screen which rows are repainted.
2236 // FIXME: since the updates related to caret blinking restrict
2237 // the painter to a small rectangle, the numbers are not
2238 // updated when this happens. Change the code in
2239 // GuiWorkArea::Private::show/hideCaret if this is important.
2240 static int count = 0;
2242 FontInfo fi(sane_font);
2243 fi.setSize(TINY_SIZE);
2244 fi.setColor(Color_red);
2245 pi.pain.text(row_x, y, convert<docstring>(count), fi);
2248 // Restore full_repaint status.
2249 pi.full_repaint = tmp;
2254 //LYXERR(Debug::PAINTING, ".");
2258 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2259 Dimension & dim) const
2261 DocIterator from = cur.bv().cursor();
2262 DocIterator to = from;
2263 text_->getWord(from.top(), to.top(), PREVIOUS_WORD);
2265 // The vertical dimension of the word
2266 Font const font = displayFont(cur.pit(), from.pos());
2267 FontMetrics const & fm = theFontMetrics(font);
2268 // the +1's below are related to the extra pixels added in setRowHeight
2269 dim.asc = fm.maxAscent() + 1;
2270 dim.des = fm.maxDescent() + 1;
2272 // get position on screen of the word start and end
2273 //FIXME: Is it necessary to explicitly set this to false?
2274 from.boundary(false);
2275 Point lxy = cur.bv().getPos(from);
2276 Point rxy = cur.bv().getPos(to);
2277 dim.wid = abs(rxy.x_ - lxy.x_);
2279 // calculate position of word
2281 x = min(rxy.x_, lxy.x_);
2283 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2284 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2287 int defaultRowHeight()
2289 return int(theFontMetrics(sane_font).maxHeight() * 1.2);