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"
60 using frontend::FontMetrics;
65 int numberOfLabelHfills(Paragraph const & par, Row const & row)
67 pos_type last = row.endpos() - 1;
68 pos_type first = row.pos();
70 // hfill *DO* count at the beginning of paragraphs!
72 while (first < last && par.isHfill(first))
76 last = min(last, par.beginOfBody());
78 for (pos_type p = first; p < last; ++p) {
85 // FIXME: this needs to be rewritten, probably by merging it into some
86 // code that, besides counting, sets the active status of the space
87 // inset in the row element.
88 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
89 pos_type const body_pos)
92 Row::const_iterator cit = row.begin();
93 Row::const_iterator const end = row.end();
94 for ( ; cit != end ; ++cit)
95 if (cit->pos >= body_pos
96 && cit->inset && pm.hfillExpansion(row, cit->pos))
104 /////////////////////////////////////////////////////////////////////
108 /////////////////////////////////////////////////////////////////////
111 TextMetrics::TextMetrics(BufferView * bv, Text * text)
112 : bv_(bv), text_(text)
115 max_width_ = bv_->workWidth();
116 dim_.wid = max_width_;
122 bool TextMetrics::contains(pit_type pit) const
124 return par_metrics_.find(pit) != par_metrics_.end();
128 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
130 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
135 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
137 ParMetricsCache::const_iterator it = par_metrics_.begin();
138 return make_pair(it->first, &it->second);
142 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
144 LBUFERR(!par_metrics_.empty());
145 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
146 return make_pair(it->first, &it->second);
150 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
152 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
153 if (pmc_it == par_metrics_.end()) {
154 pmc_it = par_metrics_.insert(
155 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
157 if (pmc_it->second.rows().empty() && redo)
159 return pmc_it->second;
163 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width,
164 bool const expand_on_multipars)
166 LBUFERR(mi.base.textwidth > 0);
167 max_width_ = mi.base.textwidth;
168 // backup old dimension.
169 Dimension const old_dim = dim_;
172 dim_.wid = min_width;
173 pit_type const npar = text_->paragraphs().size();
174 if (npar > 1 && expand_on_multipars)
175 // If there is more than one row, expand the text to
176 // the full allowable width.
177 dim_.wid = max_width_;
179 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
180 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
182 bool changed = false;
184 for (pit_type pit = 0; pit != npar; ++pit) {
185 changed |= redoParagraph(pit);
186 ParagraphMetrics const & pm = par_metrics_[pit];
188 if (dim_.wid < pm.width())
189 dim_.wid = pm.width();
192 dim_.asc = par_metrics_[0].ascent();
193 dim_.des = h - dim_.asc;
194 //lyxerr << "dim_.wid " << dim_.wid << endl;
195 //lyxerr << "dim_.asc " << dim_.asc << endl;
196 //lyxerr << "dim_.des " << dim_.des << endl;
198 changed |= dim_ != old_dim;
204 void TextMetrics::updatePosCache(pit_type pit) const
206 frontend::NullPainter np;
207 PainterInfo pi(bv_, np);
208 drawParagraph(pi, pit, origin_.x_, par_metrics_[pit].position());
212 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
214 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
218 int TextMetrics::rightMargin(pit_type const pit) const
220 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
224 void TextMetrics::applyOuterFont(Font & font) const
226 FontInfo lf(font_.fontInfo());
227 lf.reduce(bv_->buffer().params().getFont().fontInfo());
228 font.fontInfo().realize(lf);
232 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
234 LASSERT(pos >= 0, { static Font f; return f; });
236 ParagraphList const & pars = text_->paragraphs();
237 Paragraph const & par = pars[pit];
238 Layout const & layout = par.layout();
239 Buffer const & buffer = bv_->buffer();
241 BufferParams const & params = buffer.params();
242 pos_type const body_pos = par.beginOfBody();
244 // We specialize the 95% common case:
245 if (!par.getDepth()) {
246 Font f = par.getFontSettings(params, pos);
247 if (!text_->isMainText())
249 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
251 FontInfo const & lf = lab ? layout.labelfont : layout.font;
252 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
254 // In case the default family has been customized
255 if (lf.family() == INHERIT_FAMILY)
256 rlf.setFamily(params.getFont().fontInfo().family());
257 f.fontInfo().realize(rlf);
261 // The uncommon case need not be optimized as much
262 FontInfo const & layoutfont = pos < body_pos ?
263 layout.labelfont : layout.font;
265 Font font = par.getFontSettings(params, pos);
266 font.fontInfo().realize(layoutfont);
268 if (!text_->isMainText())
269 applyOuterFont(font);
271 // Realize against environment font information
272 // NOTE: the cast to pit_type should be removed when pit_type
273 // changes to a unsigned integer.
274 if (pit < pit_type(pars.size()))
275 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
277 // Realize with the fonts of lesser depth.
278 font.fontInfo().realize(params.getFont().fontInfo());
284 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
290 if (boundary && sl.pos() > 0)
293 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
297 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
299 // no RTL boundary at paragraph start
303 Font const & left_font = displayFont(pit, pos - 1);
305 return isRTLBoundary(pit, pos, left_font);
309 // isRTLBoundary returns false on a real end-of-line boundary,
310 // because otherwise the two boundary types get mixed up.
311 // This is the whole purpose of this being in TextMetrics.
312 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
313 Font const & font) const
315 if (// no RTL boundary at paragraph start
317 // if the metrics have not been calculated, then we are not
318 // on screen and can safely ignore issues about boundaries.
322 ParagraphMetrics & pm = par_metrics_[pit];
323 // no RTL boundary in empty paragraph
324 if (pm.rows().empty())
327 pos_type endpos = pm.getRow(pos - 1, false).endpos();
328 pos_type startpos = pm.getRow(pos, false).pos();
329 // no RTL boundary at line start:
330 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
332 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
335 Paragraph const & par = text_->getPar(pit);
336 // no RTL boundary at line break:
337 // abc|\n -> move right -> abc\n (and not: abc\n|
339 if (startpos == pos && endpos == pos && endpos != par.size()
340 && (par.isNewline(pos - 1)
341 || par.isEnvSeparator(pos - 1)
342 || par.isLineSeparator(pos - 1)
343 || par.isSeparator(pos - 1)))
346 bool left = font.isVisibleRightToLeft();
348 if (pos == par.size())
349 right = par.isRTL(bv_->buffer().params());
351 right = displayFont(pit, pos).isVisibleRightToLeft();
353 return left != right;
357 bool TextMetrics::redoParagraph(pit_type const pit)
359 Paragraph & par = text_->getPar(pit);
360 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
361 // redoParagraph() recursively inside parMetrics.
362 Dimension old_dim = parMetrics(pit, false).dim();
363 ParagraphMetrics & pm = par_metrics_[pit];
366 Buffer & buffer = bv_->buffer();
367 bool changed = false;
369 // Check whether there are InsetBibItems that need fixing
370 // FIXME: This check ought to be done somewhere else. It is the reason
371 // why text_ is not const. But then, where else to do it?
372 // Well, how can you end up with either (a) a biblio environment that
373 // has no InsetBibitem or (b) a biblio environment with more than one
374 // InsetBibitem? I think the answer is: when paragraphs are merged;
375 // when layout is set; when material is pasted.
376 if (par.brokenBiblio()) {
377 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
378 // In some cases, we do not know how to record undo
379 if (&cur.inset() == &text_->inset())
380 cur.recordUndo(pit, pit);
382 int const moveCursor = par.fixBiblio(buffer);
384 // Is it necessary to update the cursor?
385 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
388 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
393 // Optimisation: this is used in the next two loops
394 // so better to calculate that once here.
395 int const right_margin = rightMargin(pm);
397 // iterator pointing to paragraph to resolve macros
398 DocIterator parPos = text_->macrocontextPosition();
402 LYXERR(Debug::INFO, "MacroContext not initialised!"
403 << " Going through the buffer again and hope"
404 << " the context is better then.");
405 // FIXME audit updateBuffer calls
406 // This should not be here, but it is not clear yet where else it
408 bv_->buffer().updateBuffer();
409 parPos = text_->macrocontextPosition();
410 LBUFERR(!parPos.empty());
415 par.setBeginOfBody();
416 Font const bufferfont = buffer.params().getFont();
417 CoordCache::Insets & insetCache = bv_->coordCache().insets();
418 for (auto const & e : par.insetList()) {
419 // FIXME Doesn't this HAVE to be non-empty?
420 // position already initialized?
421 if (!parPos.empty()) {
422 parPos.pos() = e.pos;
424 // A macro template would normally not be visible
425 // by itself. But the tex macro semantics allow
426 // recursion, so we artifically take the context
427 // after the macro template to simulate this.
428 if (e.inset->lyxCode() == MATHMACRO_CODE)
432 // If there is an end of paragraph marker, its size should be
433 // substracted to the available width. The logic here is
434 // almost the same as in breakRow, remember keep them in sync.
436 if (lyxrc.paragraph_markers && e.pos + 1 == par.size()
437 && size_type(pit + 1) < text_->paragraphs().size()) {
438 Font f(text_->layoutFont(pit));
439 // ¶ U+00B6 PILCROW SIGN
440 eop = theFontMetrics(f).width(char_type(0x00B6));
443 // do the metric calculation
445 int const w = max_width_ - leftMargin(pit, e.pos)
446 - right_margin - eop;
447 Font const & font = e.inset->inheritFont() ?
448 displayFont(pit, e.pos) : bufferfont;
449 MacroContext mc(&buffer, parPos);
450 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
451 e.inset->metrics(mi, dim);
452 if (!insetCache.has(e.inset) || insetCache.dim(e.inset) != dim) {
453 insetCache.add(e.inset, dim);
459 size_t row_index = 0;
460 bool need_new_row = false;
461 // maximum pixel width of a row
463 if (row_index == pm.rows().size())
464 pm.rows().push_back(Row());
465 Row & row = pm.rows()[row_index];
469 need_new_row = breakRow(row, right_margin);
472 if ((row_index || row.endpos() < par.size() || row.right_boundary())
473 && par.inInset().lyxCode() != CELL_CODE) {
474 /* If there is more than one row or the row has been
475 * broken by a display inset or a newline, expand the text
476 * to the full allowable width. This setting here is
477 * needed for the computeRowMetrics() below.
478 * We do nothing when inside a table cell.
480 if (dim_.wid < max_width_)
481 dim_.wid = max_width_;
483 int const max_row_width = max(dim_.wid, row.width());
484 computeRowMetrics(row, max_row_width);
485 first = row.endpos();
488 pm.dim().wid = max(pm.dim().wid, row.width());
489 pm.dim().des += row.height();
490 } while (first < par.size() || need_new_row);
492 if (row_index < pm.rows().size())
493 pm.rows().resize(row_index);
495 // FIXME: It might be better to move this in another method
496 // specially tailored for the main text.
497 // Top and bottom margin of the document (only at top-level)
498 if (text_->isMainText()) {
499 // original value was 20px, which is 0.2in at 100dpi
500 int const margin = bv_->zoomedPixels(20);
502 pm.rows().front().dimension().asc += margin;
503 /* coverity thinks that we should update pm.dim().asc
504 * below, but all the rows heights are actually counted as
505 * part of the paragraph metric descent see loop above).
507 // coverity[copy_paste_error]
508 pm.dim().des += margin;
510 ParagraphList const & pars = text_->paragraphs();
511 if (pit + 1 == pit_type(pars.size())) {
512 pm.rows().back().dimension().des += margin;
513 pm.dim().des += margin;
517 // The space above and below the paragraph.
518 int const top = parTopSpacing(pit);
519 pm.rows().front().dimension().asc += top;
520 int const bottom = parBottomSpacing(pit);
521 pm.rows().back().dimension().des += bottom;
522 pm.dim().des += top + bottom;
524 pm.dim().asc += pm.rows()[0].ascent();
525 pm.dim().des -= pm.rows()[0].ascent();
527 changed |= old_dim.height() != pm.dim().height();
533 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
535 LyXAlignment align = par.getAlign();
537 // handle alignment inside tabular cells
538 Inset const & owner = text_->inset();
539 bool forced_block = false;
540 switch (owner.contentAlignment()) {
541 case LYX_ALIGN_BLOCK:
542 // In general block align is the default state, but here it is
543 // an explicit choice. Therefore it should not be overridden
547 case LYX_ALIGN_CENTER:
549 case LYX_ALIGN_RIGHT:
550 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
551 align = owner.contentAlignment();
554 // unchanged (use align)
558 // Display-style insets should always be on a centered row
559 if (Inset const * inset = par.getInset(row.pos())) {
560 switch (inset->display()) {
561 case Inset::AlignLeft:
562 align = LYX_ALIGN_BLOCK;
564 case Inset::AlignCenter:
565 align = LYX_ALIGN_CENTER;
568 // unchanged (use align)
570 case Inset::AlignRight:
571 align = LYX_ALIGN_RIGHT;
576 if (align == LYX_ALIGN_BLOCK) {
577 // If this row has been broken abruptly by a display inset, or
578 // it is the end of the paragraph, or the user requested we
579 // not justify stuff, then don't stretch.
580 // A forced block alignment can only be overridden the 'no
581 // justification on screen' setting.
582 if ((row.flushed() && !forced_block)
583 || !bv_->buffer().params().justification)
584 align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
591 void TextMetrics::computeRowMetrics(Row & row, int width) const
596 Paragraph const & par = text_->getPar(row.pit());
598 int const w = width - row.right_margin - row.width();
599 // FIXME: put back this assertion when the crash on new doc is solved.
600 //LASSERT(w >= 0, /**/);
602 // is there a manual margin with a manual label
603 Layout const & layout = par.layout();
606 if (layout.margintype == MARGIN_MANUAL
607 && layout.labeltype == LABEL_MANUAL) {
608 /// We might have real hfills in the label part
609 nlh = numberOfLabelHfills(par, row);
611 // A manual label par (e.g. List) has an auto-hfill
612 // between the label text and the body of the
614 // But we don't want to do this auto hfill if the par
619 if (nlh && !par.getLabelWidthString().empty())
620 row.label_hfill = labelFill(row) / double(nlh);
623 // are there any hfills in the row?
624 ParagraphMetrics & pm = par_metrics_[row.pit()];
625 int nh = numberOfHfills(row, pm, par.beginOfBody());
629 // We don't have to look at the alignment if the row is already
630 // larger then the permitted width as then we force the
631 // LEFT_ALIGN'edness!
632 if (int(row.width()) >= max_width_)
636 // Common case : there is no hfill, and the alignment will be
638 switch (getAlign(par, row)) {
639 case LYX_ALIGN_BLOCK:
640 // Expand expanding characters by a total of w
641 if (!row.setExtraWidth(w) && row.isRTL()) {
642 // Justification failed and the text is RTL: align to the right
643 row.left_margin += w;
644 row.dimension().wid += w;
648 // a displayed inset that is flushed
649 if (Inset const * inset = par.getInset(row.pos())) {
650 row.left_margin += inset->indent(*bv_);
651 row.dimension().wid += inset->indent(*bv_);
654 case LYX_ALIGN_RIGHT:
655 if (Inset const * inset = par.getInset(row.pos())) {
656 int const new_w = max(w - inset->indent(*bv_), 0);
657 row.left_margin += new_w;
658 row.dimension().wid += new_w;
660 row.left_margin += w;
661 row.dimension().wid += w;
664 case LYX_ALIGN_CENTER:
665 row.dimension().wid += w / 2;
666 row.left_margin += w / 2;
669 case LYX_ALIGN_LAYOUT:
670 case LYX_ALIGN_SPECIAL:
671 case LYX_ALIGN_DECIMAL:
677 // Case nh > 0. There are hfill separators.
680 row.dimension().wid += w;
681 // Set size of hfill insets
682 pos_type const endpos = row.endpos();
683 pos_type body_pos = par.beginOfBody();
685 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
688 CoordCache::Insets & insetCache = bv_->coordCache().insets();
689 for (Row::Element & e : row) {
690 if (row.label_hfill && e.endpos == body_pos
691 && e.type == Row::SPACE)
692 e.dim.wid -= int(row.label_hfill * (nlh - 1));
693 if (e.inset && pm.hfillExpansion(row, e.pos)) {
694 if (e.pos >= body_pos) {
698 e.dim.wid += hfill_rem;
700 e.dim.wid += int(row.label_hfill);
701 // Cache the inset dimension.
702 insetCache.add(e.inset, e.dim);
708 int TextMetrics::labelFill(Row const & row) const
710 Paragraph const & par = text_->getPar(row.pit());
711 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
714 // iterate over elements before main body (except the last one,
715 // which is extra space).
716 for (Row::Element const & e : row) {
717 if (e.endpos >= par.beginOfBody())
722 docstring const & label = par.params().labelWidthString();
726 FontMetrics const & fm
727 = theFontMetrics(text_->labelFont(par));
729 return max(0, fm.width(label) - w);
734 // Not used, see TextMetrics::breakRow
735 // this needs special handling - only newlines count as a break point
736 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
738 pos_type const end = par.size();
741 if (par.isNewline(i))
749 int TextMetrics::labelEnd(pit_type const pit) const
751 // labelEnd is only needed if the layout fills a flushleft label.
752 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
754 // return the beginning of the body
755 return leftMargin(pit);
761 * Calling Text::getFont is slow. While rebreaking we scan a
762 * paragraph from left to right calling getFont for every char. This
763 * simple class address this problem by hidding an optimization trick
764 * (not mine btw -AB): the font is reused in the whole font span. The
765 * class handles transparently the "hidden" (not part of the fontlist)
766 * label font (as getFont does).
772 FontIterator(TextMetrics const & tm,
773 Paragraph const & par, pit_type pit, pos_type pos)
774 : tm_(tm), par_(par), pit_(pit), pos_(pos),
775 font_(tm.displayFont(pit, pos)),
776 endspan_(par.fontSpan(pos).last),
777 bodypos_(par.beginOfBody())
781 Font const & operator*() const { return font_; }
784 FontIterator & operator++()
787 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
788 font_ = tm_.displayFont(pit_, pos_);
789 endspan_ = par_.fontSpan(pos_).last;
795 Font * operator->() { return &font_; }
799 TextMetrics const & tm_;
801 Paragraph const & par_;
816 /** This is the function where the hard work is done. The code here is
817 * very sensitive to small changes :) Note that part of the
818 * intelligence is also in Row::shortenIfNeeded.
820 bool TextMetrics::breakRow(Row & row, int const right_margin) const
822 Paragraph const & par = text_->getPar(row.pit());
823 pos_type const end = par.size();
824 pos_type const pos = row.pos();
825 pos_type const body_pos = par.beginOfBody();
826 bool const is_rtl = text_->isRTL(par);
827 bool need_new_row = false;
830 row.left_margin = leftMargin(row.pit(), pos);
831 row.right_margin = right_margin;
833 swap(row.left_margin, row.right_margin);
834 // Remember that the row width takes into account the left_margin
835 // but not the right_margin.
836 row.dimension().wid = row.left_margin;
837 // the width available for the row.
838 int const width = max_width_ - row.right_margin;
841 //FIXME: As long as leftMargin() is not correctly implemented for
842 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
843 // Otherwise, long rows will be painted off the screen.
844 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
845 return addressBreakPoint(pos, par);
848 // check for possible inline completion
849 DocIterator const & ic_it = bv_->inlineCompletionPos();
850 pos_type ic_pos = -1;
851 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
852 ic_pos = ic_it.pos();
854 // Now we iterate through until we reach the right margin
855 // or the end of the par, then build a representation of the row.
857 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
858 while (i < end && (i == pos || row.width() <= width)) {
859 char_type c = par.getChar(i);
860 // The most special cases are handled first.
861 if (par.isInset(i)) {
862 Inset const * ins = par.getInset(i);
863 Dimension dim = bv_->coordCache().insets().dim(ins);
864 row.add(i, ins, dim, *fi, par.lookupChange(i));
865 } else if (c == ' ' && i + 1 == body_pos) {
866 // There is a space at i, but it should not be
867 // added as a separator, because it is just
868 // before body_pos. Instead, insert some spacing to
870 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
871 // this is needed to make sure that the row width is correct
873 int const add = max(fm.width(par.layout().labelsep),
874 labelEnd(row.pit()) - row.width());
875 row.addSpace(i, add, *fi, par.lookupChange(i));
876 } else if (c == '\t')
877 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
878 *fi, par.lookupChange(i));
879 else if (c == 0x2028 || c == 0x2029) {
881 * U+2028 LINE SEPARATOR
882 * U+2029 PARAGRAPH SEPARATOR
884 * These are special unicode characters that break
885 * lines/pragraphs. Not handling them lead to trouble wrt
886 * Qt QTextLayout formatting. We add a visible character
887 * on screen so that the user can see that something is
891 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
892 // ¶ U+00B6 PILCROW SIGN
893 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
894 row.add(i, screen_char, *fi, par.lookupChange(i));
896 row.add(i, c, *fi, par.lookupChange(i));
898 // add inline completion width
899 // draw logically behind the previous character
900 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
901 docstring const comp = bv_->inlineCompletion();
902 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
906 f.fontInfo().setColor(Color_inlinecompletion);
907 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
909 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
910 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
913 // Handle some situations that abruptly terminate the row
915 // - Before a display inset
916 // - After a display inset
917 Inset const * inset = 0;
918 if (par.isNewline(i) || par.isEnvSeparator(i)
919 || (i + 1 < end && (inset = par.getInset(i + 1))
921 || (!row.empty() && row.back().inset
922 && row.back().inset->display())) {
924 need_new_row = par.isNewline(i);
935 // End of paragraph marker. The logic here is almost the
936 // same as in redoParagraph, remember keep them in sync.
937 ParagraphList const & pars = text_->paragraphs();
938 if (lyxrc.paragraph_markers && !need_new_row
939 && i == end && size_type(row.pit() + 1) < pars.size()) {
940 // add a virtual element for the end-of-paragraph
941 // marker; it is shown on screen, but does not exist
943 Font f(text_->layoutFont(row.pit()));
944 f.fontInfo().setColor(Color_paragraphmarker);
945 BufferParams const & bparams
946 = text_->inset().buffer().params();
947 f.setLanguage(par.getParLanguage(bparams));
948 // ¶ U+00B6 PILCROW SIGN
949 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
952 // Is there a end-of-paragaph change?
953 if (i == end && par.lookupChange(end).changed() && !need_new_row)
954 row.needsChangeBar(true);
956 // if the row is too large, try to cut at last separator. In case
957 // of success, reset indication that the row was broken abruptly.
958 int const next_width = max_width_ - leftMargin(row.pit(), row.endpos())
959 - rightMargin(row.pit());
961 if (row.shortenIfNeeded(body_pos, width, next_width))
963 row.right_boundary(!row.empty() && row.endpos() < end
964 && row.back().endpos == row.endpos());
965 // Last row in paragraph is flushed
966 if (row.endpos() == end)
969 // make sure that the RTL elements are in reverse ordering
970 row.reverseRTL(is_rtl);
971 //LYXERR0("breakrow: row is " << row);
976 int TextMetrics::parTopSpacing(pit_type const pit) const
978 Paragraph const & par = text_->getPar(pit);
979 Layout const & layout = par.layout();
982 ParagraphList const & pars = text_->paragraphs();
983 double const dh = defaultRowHeight();
985 BufferParams const & bparams = bv_->buffer().params();
986 Inset const & inset = text_->inset();
987 // some parskips VERY EASY IMPLEMENTATION
988 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
989 && !inset.getLayout().parbreakIsNewline()
990 && !par.layout().parbreak_is_newline
992 && ((layout.isParagraph() && par.getDepth() == 0)
993 || (pars[pit - 1].layout().isParagraph()
994 && pars[pit - 1].getDepth() == 0))) {
995 asc += bparams.getDefSkip().inPixels(*bv_);
998 if (par.params().startOfAppendix())
1001 // special code for the top label
1002 if (layout.labelIsAbove()
1003 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1004 && !par.labelString().empty()) {
1005 FontInfo labelfont = text_->labelFont(par);
1006 FontMetrics const & lfm = theFontMetrics(labelfont);
1007 asc += int(lfm.maxHeight() * layout.spacing.getValue()
1008 * text_->spacing(par)
1009 + (layout.topsep + layout.labelbottomsep) * dh);
1012 // Add the layout spaces, for example before and after
1013 // a section, or between the items of a itemize or enumerate
1016 pit_type prev = text_->depthHook(pit, par.getDepth());
1017 Paragraph const & prevpar = pars[prev];
1018 double layoutasc = 0;
1020 && prevpar.layout() == layout
1021 && prevpar.getDepth() == par.getDepth()
1022 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1023 layoutasc = layout.itemsep * dh;
1024 } else if (pit != 0 && layout.topsep > 0)
1025 layoutasc = layout.topsep * dh;
1027 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1029 prev = text_->outerHook(pit);
1030 if (prev != pit_type(pars.size())) {
1031 asc += int(pars[prev].layout().parsep * dh);
1032 } else if (pit != 0) {
1033 Paragraph const & prevpar2 = pars[pit - 1];
1034 if (prevpar2.getDepth() != 0 || prevpar2.layout() == layout)
1035 asc += int(layout.parsep * dh);
1042 int TextMetrics::parBottomSpacing(pit_type const pit) const
1044 double layoutdesc = 0;
1045 ParagraphList const & pars = text_->paragraphs();
1046 double const dh = defaultRowHeight();
1048 // add the layout spaces, for example before and after
1049 // a section, or between the items of a itemize or enumerate
1051 pit_type nextpit = pit + 1;
1052 if (nextpit != pit_type(pars.size())) {
1053 pit_type cpit = pit;
1055 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1056 double usual = pars[cpit].layout().bottomsep * dh;
1058 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1059 if (pars[cpit].layout() != pars[nextpit].layout()
1060 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1061 unusual = pars[cpit].layout().bottomsep * dh;
1062 layoutdesc = max(unusual, usual);
1063 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1064 if (pars[cpit].layout() != pars[nextpit].layout()
1065 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1066 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1070 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1074 void TextMetrics::setRowHeight(Row & row) const
1076 Paragraph const & par = text_->getPar(row.pit());
1077 Layout const & layout = par.layout();
1078 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1080 // Initial value for ascent (useful if row is empty).
1081 Font const font = displayFont(row.pit(), row.pos());
1082 FontMetrics const & fm = theFontMetrics(font);
1083 int maxasc = int(fm.maxAscent() * spacing_val);
1084 int maxdes = int(fm.maxDescent() * spacing_val);
1086 // Find the ascent/descent of the row contents
1087 for (Row::Element const & e : row) {
1089 maxasc = max(maxasc, e.dim.ascent());
1090 maxdes = max(maxdes, e.dim.descent());
1092 FontMetrics const & fm2 = theFontMetrics(e.font);
1093 maxasc = max(maxasc, int(fm2.maxAscent() * spacing_val));
1094 maxdes = max(maxdes, int(fm2.maxDescent() * spacing_val));
1098 // This is nicer with box insets
1102 row.dimension().asc = maxasc;
1103 row.dimension().des = maxdes;
1107 // x is an absolute screen coord
1108 // returns the column near the specified x-coordinate of the row
1109 // x is set to the real beginning of this column
1110 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1111 bool & boundary) const
1113 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1114 /// For the main Text, it is possible that this pit is not
1115 /// yet in the CoordCache when moving cursor up.
1116 /// x Paragraph coordinate is always 0 for main text anyway.
1117 int const xo = origin_.x_;
1120 // Adapt to cursor row scroll offset if applicable.
1121 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1124 pos_type pos = row.pos();
1127 x = row.left_margin;
1128 else if (x <= row.left_margin) {
1129 pos = row.front().left_pos();
1130 x = row.left_margin;
1131 } else if (x >= row.width()) {
1132 pos = row.back().right_pos();
1135 double w = row.left_margin;
1136 Row::const_iterator cit = row.begin();
1137 Row::const_iterator cend = row.end();
1138 for ( ; cit != cend; ++cit) {
1139 if (w <= x && w + cit->full_width() > x) {
1140 int x_offset = int(x - w);
1141 pos = cit->x2pos(x_offset);
1142 x = int(x_offset + w);
1145 w += cit->full_width();
1147 if (cit == row.end()) {
1148 pos = row.back().right_pos();
1151 /** This tests for the case where the cursor is placed
1152 * just before a font direction change. See comment on
1153 * the boundary_ member in DocIterator.h to understand
1154 * how boundary helps here.
1156 else if (pos == cit->endpos
1157 && ((!cit->isRTL() && cit + 1 != row.end()
1158 && (cit + 1)->isRTL())
1159 || (cit->isRTL() && cit != row.begin()
1160 && !(cit - 1)->isRTL())))
1164 /** This tests for the case where the cursor is set at the end
1165 * of a row which has been broken due something else than a
1166 * separator (a display inset or a forced breaking of the
1167 * row). We know that there is a separator when the end of the
1168 * row is larger than the end of its last element.
1170 if (!row.empty() && pos == row.back().endpos
1171 && row.back().endpos == row.endpos()) {
1172 Inset const * inset = row.back().inset;
1173 if (inset && (inset->lyxCode() == NEWLINE_CODE
1174 || inset->lyxCode() == SEPARATOR_CODE))
1175 pos = row.back().pos;
1177 boundary = row.right_boundary();
1181 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1187 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1189 // We play safe and use parMetrics(pit) to make sure the
1190 // ParagraphMetrics will be redone and OK to use if needed.
1191 // Otherwise we would use an empty ParagraphMetrics in
1192 // upDownInText() while in selection mode.
1193 ParagraphMetrics const & pm = parMetrics(pit);
1195 LBUFERR(row < int(pm.rows().size()));
1197 Row const & r = pm.rows()[row];
1198 return getPosNearX(r, x, bound);
1202 void TextMetrics::newParMetricsDown()
1204 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1205 pit_type const pit = last.first + 1;
1206 if (pit == int(text_->paragraphs().size()))
1209 // do it and update its position.
1211 par_metrics_[pit].setPosition(last.second.position()
1212 + last.second.descent() + par_metrics_[pit].ascent());
1213 updatePosCache(pit);
1217 void TextMetrics::newParMetricsUp()
1219 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1220 if (first.first == 0)
1223 pit_type const pit = first.first - 1;
1224 // do it and update its position.
1226 par_metrics_[pit].setPosition(first.second.position()
1227 - first.second.ascent() - par_metrics_[pit].descent());
1228 updatePosCache(pit);
1231 // y is screen coordinate
1232 pit_type TextMetrics::getPitNearY(int y)
1234 LASSERT(!text_->paragraphs().empty(), return -1);
1235 LASSERT(!par_metrics_.empty(), return -1);
1236 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1238 // look for highest numbered paragraph with y coordinate less than given y
1241 ParMetricsCache::const_iterator it = par_metrics_.begin();
1242 ParMetricsCache::const_iterator et = par_metrics_.end();
1243 ParMetricsCache::const_iterator last = et;
1246 ParagraphMetrics const & pm = it->second;
1248 if (y < it->second.position() - int(pm.ascent())) {
1249 // We are looking for a position that is before the first paragraph in
1250 // the cache (which is in priciple off-screen, that is before the
1253 // We are already at the first paragraph in the inset.
1255 // OK, this is the paragraph we are looking for.
1256 pit = it->first - 1;
1261 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1263 if (y >= last->second.position() + int(pm_last.descent())) {
1264 // We are looking for a position that is after the last paragraph in
1265 // the cache (which is in priciple off-screen), that is before the
1267 pit = last->first + 1;
1268 if (pit == int(text_->paragraphs().size()))
1269 // We are already at the last paragraph in the inset.
1271 // OK, this is the paragraph we are looking for.
1272 newParMetricsDown();
1276 for (; it != et; ++it) {
1277 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1278 << " y: " << it->second.position());
1280 ParagraphMetrics const & pm2 = par_metrics_[it->first];
1282 if (it->first >= pit && int(it->second.position()) - int(pm2.ascent()) <= y) {
1284 yy = it->second.position();
1288 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1294 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1295 bool assert_in_view, bool up)
1297 ParagraphMetrics const & pm = par_metrics_[pit];
1299 int yy = pm.position() - pm.ascent();
1300 LBUFERR(!pm.rows().empty());
1301 RowList::const_iterator rit = pm.rows().begin();
1302 RowList::const_iterator rlast = pm.rows().end();
1304 for (; rit != rlast; yy += rit->height(), ++rit)
1305 if (yy + rit->height() > y)
1308 if (assert_in_view) {
1309 if (!up && yy + rit->height() > y) {
1310 if (rit != pm.rows().begin()) {
1313 } else if (pit != 0) {
1316 ParagraphMetrics const & pm2 = par_metrics_[pit];
1317 rit = pm2.rows().end();
1321 } else if (up && yy != y) {
1323 y = yy + rit->height();
1325 } else if (pit < int(text_->paragraphs().size()) - 1) {
1327 newParMetricsDown();
1328 ParagraphMetrics const & pm2 = par_metrics_[pit];
1329 rit = pm2.rows().begin();
1338 // x,y are absolute screen coordinates
1339 // sets cursor recursively descending into nested editable insets
1340 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1341 bool assert_in_view, bool up)
1343 if (lyxerr.debugging(Debug::WORKAREA)) {
1344 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1345 cur.bv().coordCache().dump();
1347 pit_type pit = getPitNearY(y);
1348 LASSERT(pit != -1, return 0);
1349 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1352 // Do we cover an inset?
1353 InsetList::Element * e = checkInsetHit(pit, x, y);
1356 // No inset, set position in the text
1357 bool bound = false; // is modified by getPosNearX
1358 cur.pos() = getPosNearX(row, x, bound);
1359 cur.boundary(bound);
1360 cur.setCurrentFont();
1365 Inset * inset = e->inset;
1366 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1368 // Set position in front of inset
1370 cur.boundary(false);
1373 // Try to descend recursively inside the inset.
1374 Inset * edited = inset->editXY(cur, x, y);
1375 // FIXME: it is not clear that the test on position is needed
1376 // Remove it if/when semantics of editXY is clarified
1377 if (cur.text() == text_ && cur.pos() == e->pos) {
1378 // non-editable inset, set cursor after the inset if x is
1379 // nearer to that position (bug 9628)
1380 bool bound = false; // is modified by getPosNearX
1381 cur.pos() = getPosNearX(row, x, bound);
1382 cur.boundary(bound);
1383 cur.setCurrentFont();
1387 if (cur.top().text() == text_)
1388 cur.setCurrentFont();
1393 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1395 LASSERT(text_ == cur.text(), return);
1396 pit_type const pit = getPitNearY(y);
1397 LASSERT(pit != -1, return);
1399 ParagraphMetrics const & pm = par_metrics_[pit];
1401 int yy = pm.position() - pm.ascent();
1402 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1403 " pit: " << pit << " yy: " << yy);
1406 LBUFERR(pm.rows().size());
1407 for (; r < int(pm.rows().size()) - 1; ++r) {
1408 Row const & row = pm.rows()[r];
1409 if (int(yy + row.height()) > y)
1414 Row const & row = pm.rows()[r];
1416 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1420 pos_type const pos = getPosNearX(row, xx, bound);
1422 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1424 text_->setCursor(cur, pit, pos, true, bound);
1425 // remember new position.
1430 //takes screen x,y coordinates
1431 InsetList::Element * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1433 Paragraph const & par = text_->paragraphs()[pit];
1434 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1436 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1438 for (InsetList::Element const & e : par.insetList()) {
1439 LYXERR(Debug::DEBUG, "examining inset " << e.inset);
1441 if (insetCache.covers(e.inset, x, y)) {
1442 LYXERR(Debug::DEBUG, "Hit inset: " << e.inset);
1443 return const_cast<InsetList::Element *>(&e);
1447 LYXERR(Debug::DEBUG, "No inset hit. ");
1452 //takes screen x,y coordinates
1453 Inset * TextMetrics::checkInsetHit(int x, int y)
1455 pit_type const pit = getPitNearY(y);
1456 LASSERT(pit != -1, return 0);
1457 InsetList::Element * e = checkInsetHit(pit, x, y);
1466 int TextMetrics::cursorX(CursorSlice const & sl,
1467 bool boundary) const
1469 LASSERT(sl.text() == text_, return 0);
1471 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1472 if (pm.rows().empty())
1474 Row const & row = pm.getRow(sl.pos(), boundary);
1475 pos_type const pos = sl.pos();
1478 row.findElement(pos, boundary, x);
1484 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1486 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1487 ParagraphMetrics const & pm = parMetrics(sl.pit());
1488 if (pm.rows().empty())
1492 h -= parMetrics(0).rows()[0].ascent();
1493 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1494 h += parMetrics(pit).height();
1497 if (pos && boundary)
1499 size_t const rend = pm.pos2row(pos);
1500 for (size_t rit = 0; rit != rend; ++rit)
1501 h += pm.rows()[rit].height();
1502 h += pm.rows()[rend].ascent();
1507 // the cursor set functions have a special mechanism. When they
1508 // realize you left an empty paragraph, they will delete it.
1510 bool TextMetrics::cursorHome(Cursor & cur)
1512 LASSERT(text_ == cur.text(), return false);
1513 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1514 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1515 return text_->setCursor(cur, cur.pit(), row.pos());
1519 bool TextMetrics::cursorEnd(Cursor & cur)
1521 LASSERT(text_ == cur.text(), return false);
1522 // if not on the last row of the par, put the cursor before
1523 // the final space exept if I have a spanning inset or one string
1524 // is so long that we force a break.
1525 pos_type end = cur.textRow().endpos();
1527 // empty text, end-1 is no valid position
1529 bool boundary = false;
1530 if (end != cur.lastpos()) {
1531 if (!cur.paragraph().isLineSeparator(end-1)
1532 && !cur.paragraph().isNewline(end-1)
1533 && !cur.paragraph().isEnvSeparator(end-1))
1537 } else if (cur.paragraph().isEnvSeparator(end-1))
1539 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1543 void TextMetrics::deleteLineForward(Cursor & cur)
1545 LASSERT(text_ == cur.text(), return);
1546 if (cur.lastpos() == 0) {
1547 // Paragraph is empty, so we just go forward
1548 text_->cursorForward(cur);
1551 cur.selection(true); // to avoid deletion
1554 // What is this test for ??? (JMarc)
1555 if (!cur.selection())
1556 text_->deleteWordForward(cur);
1558 cap::cutSelection(cur, false);
1559 cur.checkBufferStructure();
1564 bool TextMetrics::isLastRow(Row const & row) const
1566 ParagraphList const & pars = text_->paragraphs();
1567 return row.endpos() >= pars[row.pit()].size()
1568 && row.pit() + 1 == pit_type(pars.size());
1572 bool TextMetrics::isFirstRow(Row const & row) const
1574 return row.pos() == 0 && row.pit() == 0;
1578 int TextMetrics::leftMargin(pit_type pit) const
1580 return leftMargin(pit, text_->paragraphs()[pit].size());
1584 int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
1586 ParagraphList const & pars = text_->paragraphs();
1588 LASSERT(pit >= 0, return 0);
1589 LASSERT(pit < int(pars.size()), return 0);
1590 Paragraph const & par = pars[pit];
1591 LASSERT(pos >= 0, return 0);
1592 LASSERT(pos <= par.size(), return 0);
1593 Buffer const & buffer = bv_->buffer();
1594 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1595 DocumentClass const & tclass = buffer.params().documentClass();
1596 Layout const & layout = par.layout();
1597 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1599 docstring parindent = layout.parindent;
1603 if (text_->isMainText()) {
1604 l_margin += bv_->leftMargin();
1605 l_margin += bfm.signedWidth(tclass.leftmargin());
1608 int depth = par.getDepth();
1610 // find the next level paragraph
1611 pit_type newpar = text_->outerHook(pit);
1612 if (newpar != pit_type(pars.size())) {
1613 if (pars[newpar].layout().isEnvironment()) {
1614 int nestmargin = depth * nestMargin();
1615 if (text_->isMainText())
1616 nestmargin += changebarMargin();
1617 l_margin = max(leftMargin(newpar), nestmargin);
1618 // Remove the parindent that has been added
1619 // if the paragraph was empty.
1620 if (pars[newpar].empty() &&
1621 buffer.params().paragraph_separation ==
1622 BufferParams::ParagraphIndentSeparation) {
1623 docstring pi = pars[newpar].layout().parindent;
1624 l_margin -= bfm.signedWidth(pi);
1627 if (tclass.isDefaultLayout(par.layout())
1628 || tclass.isPlainLayout(par.layout())) {
1629 if (pars[newpar].params().noindent())
1632 parindent = pars[newpar].layout().parindent;
1637 // This happens after sections or environments in standard classes.
1638 // We have to check the previous layout at same depth.
1639 if (buffer.params().paragraph_separation ==
1640 BufferParams::ParagraphSkipSeparation)
1642 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1643 pit_type prev = text_->depthHook(pit, par.getDepth());
1644 if (par.layout() == pars[prev].layout()) {
1646 && pars[pit - 1].layout().nextnoindent)
1648 } else if (pars[prev].layout().nextnoindent)
1652 FontInfo const labelfont = text_->labelFont(par);
1653 FontMetrics const & lfm = theFontMetrics(labelfont);
1655 switch (layout.margintype) {
1656 case MARGIN_DYNAMIC:
1657 if (!layout.leftmargin.empty()) {
1658 l_margin += bfm.signedWidth(layout.leftmargin);
1660 if (!par.labelString().empty()) {
1661 l_margin += lfm.signedWidth(layout.labelindent);
1662 l_margin += lfm.width(par.labelString());
1663 l_margin += lfm.width(layout.labelsep);
1667 case MARGIN_MANUAL: {
1668 l_margin += lfm.signedWidth(layout.labelindent);
1669 // The width of an empty par, even with manual label, should be 0
1670 if (!par.empty() && pos >= par.beginOfBody()) {
1671 if (!par.getLabelWidthString().empty()) {
1672 docstring labstr = par.getLabelWidthString();
1673 l_margin += lfm.width(labstr);
1674 l_margin += lfm.width(layout.labelsep);
1680 case MARGIN_STATIC: {
1681 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1682 / (par.getDepth() + 4);
1686 case MARGIN_FIRST_DYNAMIC:
1687 if (layout.labeltype == LABEL_MANUAL) {
1688 // if we are at position 0, we are never in the body
1689 if (pos > 0 && pos >= par.beginOfBody())
1690 l_margin += lfm.signedWidth(layout.leftmargin);
1692 l_margin += lfm.signedWidth(layout.labelindent);
1694 // Special case to fix problems with
1696 || (layout.labeltype == LABEL_STATIC
1697 && layout.latextype == LATEX_ENVIRONMENT
1698 && !text_->isFirstInSequence(pit))) {
1699 l_margin += lfm.signedWidth(layout.leftmargin);
1700 } else if (!layout.labelIsAbove()) {
1701 l_margin += lfm.signedWidth(layout.labelindent);
1702 l_margin += lfm.width(layout.labelsep);
1703 l_margin += lfm.width(par.labelString());
1707 case MARGIN_RIGHT_ADDRESS_BOX: {
1709 // The left margin depends on the widest row in this paragraph.
1710 // This code is wrong because it depends on the rows, but at the
1711 // same time this function is used in redoParagraph to construct
1713 ParagraphMetrics const & pm = par_metrics_[pit];
1714 int minfill = max_width_;
1715 for (row : pm.rows())
1716 if (row.fill() < minfill)
1717 minfill = row.fill();
1718 l_margin += bfm.signedWidth(layout.leftmargin);
1719 l_margin += minfill;
1721 // also wrong, but much shorter.
1722 l_margin += max_width_ / 2;
1727 if (!par.params().leftIndent().zero())
1728 l_margin += par.params().leftIndent().inPixels(max_width_, lfm.em());
1730 LyXAlignment align = par.getAlign();
1732 // set the correct parindent
1734 && (layout.labeltype == LABEL_NO_LABEL
1735 || layout.labeltype == LABEL_ABOVE
1736 || layout.labeltype == LABEL_CENTERED
1737 || (layout.labeltype == LABEL_STATIC
1738 && layout.latextype == LATEX_ENVIRONMENT
1739 && !text_->isFirstInSequence(pit)))
1740 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1741 && !par.params().noindent()
1742 // in some insets, paragraphs are never indented
1743 && !text_->inset().neverIndent()
1744 // display style insets are always centered, omit indentation
1747 && par.getInset(pos)->display())
1748 && (!(tclass.isDefaultLayout(par.layout())
1749 || tclass.isPlainLayout(par.layout()))
1750 || buffer.params().paragraph_separation
1751 == BufferParams::ParagraphIndentSeparation)) {
1752 /* use the parindent of the layout when the default
1753 * indentation is used otherwise use the indentation set in
1754 * the document settings
1756 if (buffer.params().getParIndent().empty())
1757 l_margin += bfm.signedWidth(parindent);
1759 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
1766 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1768 if (par_metrics_.empty())
1774 y -= par_metrics_.begin()->second.ascent();
1775 for (auto & pm_pair : par_metrics_) {
1776 pit_type const pit = pm_pair.first;
1777 ParagraphMetrics & pm = pm_pair.second;
1779 // Save the paragraph position in the cache.
1781 drawParagraph(pi, pit, x, y);
1787 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1789 ParagraphMetrics const & pm = par_metrics_[pit];
1790 if (pm.rows().empty())
1792 size_t const nrows = pm.rows().size();
1794 // Use fast lane in nodraw stage.
1795 if (pi.pain.isNull()) {
1796 for (size_t i = 0; i != nrows; ++i) {
1798 Row const & row = pm.rows()[i];
1799 // Adapt to cursor row scroll offset if applicable.
1800 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1804 RowPainter rp(pi, *text_, row, row_x, y);
1806 rp.paintOnlyInsets();
1812 int const ww = bv_->workHeight();
1813 Cursor const & cur = bv_->cursor();
1814 DocIterator sel_beg = cur.selectionBegin();
1815 DocIterator sel_end = cur.selectionEnd();
1816 bool selection = cur.selection()
1817 // This is our text.
1818 && cur.text() == text_
1819 // if the anchor is outside, this is not our selection
1820 && cur.normalAnchor().text() == text_
1821 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1823 // We store the begin and end pos of the selection relative to this par
1824 DocIterator sel_beg_par = cur.selectionBegin();
1825 DocIterator sel_end_par = cur.selectionEnd();
1827 // We care only about visible selection.
1829 if (pit != sel_beg.pit()) {
1830 sel_beg_par.pit() = pit;
1831 sel_beg_par.pos() = 0;
1833 if (pit != sel_end.pit()) {
1834 sel_end_par.pit() = pit;
1835 sel_end_par.pos() = sel_end_par.lastpos();
1839 for (size_t i = 0; i != nrows; ++i) {
1841 Row const & row = pm.rows()[i];
1842 // Adapt to cursor row scroll offset if applicable.
1843 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1847 // It is not needed to draw on screen if we are not inside.
1848 bool const inside = (y + row.descent() >= 0
1849 && y - row.ascent() < ww);
1851 // Inset positions have already been set in nodraw stage.
1857 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1859 row.clearSelectionAndMargins();
1861 // The row knows nothing about the paragraph, so we have to check
1862 // whether this row is the first or last and update the margins.
1863 if (row.selection()) {
1864 if (row.sel_beg == 0)
1865 row.change(row.begin_margin_sel, sel_beg.pit() < pit);
1866 if (row.sel_end == sel_end_par.lastpos())
1867 row.change(row.end_margin_sel, sel_end.pit() > pit);
1870 // has row changed since last paint?
1871 bool row_has_changed = row.changed()
1872 || bv_->hadHorizScrollOffset(text_, pit, row.pos());
1874 // Take this opportunity to spellcheck the row contents.
1875 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1876 text_->getPar(pit).spellCheck();
1879 RowPainter rp(pi, *text_, row, row_x, y);
1881 // Don't paint the row if a full repaint has not been requested
1882 // and if it has not changed.
1883 if (!pi.full_repaint && !row_has_changed) {
1884 // Paint only the insets if the text itself is
1886 rp.paintOnlyInsets();
1892 // Clear background of this row if paragraph background was not
1893 // already cleared because of a full repaint.
1894 if (!pi.full_repaint && row_has_changed) {
1895 LYXERR(Debug::PAINTING, "Clear rect@("
1896 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1897 << width() << " x " << row.height());
1898 // FIXME: this is a hack. We know that at least this
1899 // amount of pixels can be cleared on right and left.
1900 // Doing so gets rid of caret ghosts when the cursor is at
1901 // the begining/end of row. However, it will not work if
1902 // the caret has a ridiculous width like 6. (see ticket
1904 pi.pain.fillRectangle(max(row_x, 0) - Inset::TEXT_TO_INSET_OFFSET,
1906 width() + 2 * Inset::TEXT_TO_INSET_OFFSET,
1907 row.height(), pi.background_color);
1910 // Instrumentation for testing row cache (see also
1912 if (lyxerr.debugging(Debug::PAINTING)
1913 && (row.selection() || pi.full_repaint || row_has_changed)) {
1914 string const foreword = text_->isMainText() ? "main text redraw "
1915 : "inset text redraw: ";
1916 LYXERR0(foreword << "pit=" << pit << " row=" << i
1917 << (row.selection() ? " row_selection": "")
1918 << (pi.full_repaint ? " full_repaint" : "")
1919 << (row_has_changed ? " row_has_changed" : ""));
1922 // Backup full_repaint status and force full repaint
1923 // for inner insets as the Row has been cleared out.
1924 bool tmp = pi.full_repaint;
1925 pi.full_repaint = true;
1927 rp.paintSelection();
1930 if (row.needsChangeBar())
1931 rp.paintChangeBar();
1932 if (i == 0 && !row.isRTL())
1934 if (i == nrows - 1 && row.isRTL())
1937 if (i == nrows - 1 && !row.isRTL())
1939 if (i == 0 && row.isRTL())
1941 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1942 row_x + row.right_x() > bv_->workWidth());
1946 // This debug code shows on screen which rows are repainted.
1947 // FIXME: since the updates related to caret blinking restrict
1948 // the painter to a small rectangle, the numbers are not
1949 // updated when this happens. Change the code in
1950 // GuiWorkArea::Private::show/hideCaret if this is important.
1951 static int count = 0;
1953 FontInfo fi(sane_font);
1954 fi.setSize(FONT_SIZE_TINY);
1955 fi.setColor(Color_red);
1956 pi.pain.text(row_x, y, convert<docstring>(count), fi);
1959 // Restore full_repaint status.
1960 pi.full_repaint = tmp;
1965 //LYXERR(Debug::PAINTING, ".");
1969 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1970 Dimension & dim) const
1972 Cursor const & bvcur = cur.bv().cursor();
1974 // get word in front of cursor
1975 docstring word = text_->previousWord(bvcur.top());
1976 DocIterator wordStart = bvcur;
1977 wordStart.pos() -= word.length();
1979 // calculate dimensions of the word
1981 row.pit(bvcur.pit());
1982 row.pos(wordStart.pos());
1983 row.endpos(bvcur.pos());
1985 dim = row.dimension();
1987 // get position on screen of the word start and end
1988 //FIXME: Is it necessary to explicitly set this to false?
1989 wordStart.boundary(false);
1990 Point lxy = cur.bv().getPos(wordStart);
1991 Point rxy = cur.bv().getPos(bvcur);
1992 dim.wid = abs(rxy.x_ - lxy.x_);
1994 // calculate position of word
1996 x = min(rxy.x_, lxy.x_);
1998 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1999 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2002 int defaultRowHeight()
2004 return int(theFontMetrics(sane_font).maxHeight() * 1.2);