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/debug.h"
49 #include "support/lassert.h"
59 using frontend::FontMetrics;
64 int numberOfLabelHfills(Paragraph const & par, Row const & row)
66 pos_type last = row.endpos() - 1;
67 pos_type first = row.pos();
69 // hfill *DO* count at the beginning of paragraphs!
71 while (first < last && par.isHfill(first))
75 last = min(last, par.beginOfBody());
77 for (pos_type p = first; p < last; ++p) {
84 // FIXME: this needs to be rewritten, probably by merging it into some
85 // code that, besides counting, sets the active status of the space
86 // inset in the row element.
87 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
88 pos_type const body_pos)
91 Row::const_iterator cit = row.begin();
92 Row::const_iterator const end = row.end();
93 for ( ; cit != end ; ++cit)
94 if (cit->pos >= body_pos
95 && cit->inset && pm.hfillExpansion(row, cit->pos))
103 /////////////////////////////////////////////////////////////////////
107 /////////////////////////////////////////////////////////////////////
110 TextMetrics::TextMetrics(BufferView * bv, Text * text)
111 : bv_(bv), text_(text)
114 max_width_ = bv_->workWidth();
115 dim_.wid = max_width_;
121 bool TextMetrics::contains(pit_type pit) const
123 return par_metrics_.find(pit) != par_metrics_.end();
127 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
129 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
134 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
136 ParMetricsCache::const_iterator it = par_metrics_.begin();
137 return make_pair(it->first, &it->second);
141 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
143 LBUFERR(!par_metrics_.empty());
144 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
145 return make_pair(it->first, &it->second);
149 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
151 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
152 if (pmc_it == par_metrics_.end()) {
153 pmc_it = par_metrics_.insert(
154 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
156 if (pmc_it->second.rows().empty() && redo)
158 return pmc_it->second;
162 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
164 LBUFERR(mi.base.textwidth > 0);
165 max_width_ = mi.base.textwidth;
166 // backup old dimension.
167 Dimension const old_dim = dim_;
170 dim_.wid = min_width;
171 pit_type const npar = text_->paragraphs().size();
173 // If there is more than one row, expand the text to
174 // the full allowable width.
175 dim_.wid = max_width_;
177 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
178 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
180 bool changed = false;
182 for (pit_type pit = 0; pit != npar; ++pit) {
183 changed |= redoParagraph(pit);
184 ParagraphMetrics const & pm = par_metrics_[pit];
186 if (dim_.wid < pm.width())
187 dim_.wid = pm.width();
190 dim_.asc = par_metrics_[0].ascent();
191 dim_.des = h - dim_.asc;
192 //lyxerr << "dim_.wid " << dim_.wid << endl;
193 //lyxerr << "dim_.asc " << dim_.asc << endl;
194 //lyxerr << "dim_.des " << dim_.des << endl;
196 changed |= dim_ != old_dim;
202 void TextMetrics::updatePosCache(pit_type pit) const
204 frontend::NullPainter np;
205 PainterInfo pi(bv_, np);
206 drawParagraph(pi, pit, origin_.x_, par_metrics_[pit].position());
210 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
212 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
216 int TextMetrics::rightMargin(pit_type const pit) const
218 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
222 void TextMetrics::applyOuterFont(Font & font) const
224 FontInfo lf(font_.fontInfo());
225 lf.reduce(bv_->buffer().params().getFont().fontInfo());
226 font.fontInfo().realize(lf);
230 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
232 LASSERT(pos >= 0, { static Font f; return f; });
234 ParagraphList const & pars = text_->paragraphs();
235 Paragraph const & par = pars[pit];
236 Layout const & layout = par.layout();
237 Buffer const & buffer = bv_->buffer();
239 BufferParams const & params = buffer.params();
240 pos_type const body_pos = par.beginOfBody();
242 // We specialize the 95% common case:
243 if (!par.getDepth()) {
244 Font f = par.getFontSettings(params, pos);
245 if (!text_->isMainText())
247 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
249 FontInfo const & lf = lab ? layout.labelfont : layout.font;
250 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
252 // In case the default family has been customized
253 if (lf.family() == INHERIT_FAMILY)
254 rlf.setFamily(params.getFont().fontInfo().family());
255 f.fontInfo().realize(rlf);
259 // The uncommon case need not be optimized as much
260 FontInfo const & layoutfont = pos < body_pos ?
261 layout.labelfont : layout.font;
263 Font font = par.getFontSettings(params, pos);
264 font.fontInfo().realize(layoutfont);
266 if (!text_->isMainText())
267 applyOuterFont(font);
269 // Realize against environment font information
270 // NOTE: the cast to pit_type should be removed when pit_type
271 // changes to a unsigned integer.
272 if (pit < pit_type(pars.size()))
273 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
275 // Realize with the fonts of lesser depth.
276 font.fontInfo().realize(params.getFont().fontInfo());
282 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
288 if (boundary && sl.pos() > 0)
291 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
295 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
297 // no RTL boundary at paragraph start
301 Font const & left_font = displayFont(pit, pos - 1);
303 return isRTLBoundary(pit, pos, left_font);
307 // isRTLBoundary returns false on a real end-of-line boundary,
308 // because otherwise the two boundary types get mixed up.
309 // This is the whole purpose of this being in TextMetrics.
310 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
311 Font const & font) const
313 if (// no RTL boundary at paragraph start
315 // if the metrics have not been calculated, then we are not
316 // on screen and can safely ignore issues about boundaries.
320 ParagraphMetrics & pm = par_metrics_[pit];
321 // no RTL boundary in empty paragraph
322 if (pm.rows().empty())
325 pos_type endpos = pm.getRow(pos - 1, false).endpos();
326 pos_type startpos = pm.getRow(pos, false).pos();
327 // no RTL boundary at line start:
328 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
330 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
333 Paragraph const & par = text_->getPar(pit);
334 // no RTL boundary at line break:
335 // abc|\n -> move right -> abc\n (and not: abc\n|
337 if (startpos == pos && endpos == pos && endpos != par.size()
338 && (par.isNewline(pos - 1)
339 || par.isEnvSeparator(pos - 1)
340 || par.isLineSeparator(pos - 1)
341 || par.isSeparator(pos - 1)))
344 bool left = font.isVisibleRightToLeft();
346 if (pos == par.size())
347 right = par.isRTL(bv_->buffer().params());
349 right = displayFont(pit, pos).isVisibleRightToLeft();
351 return left != right;
355 bool TextMetrics::redoParagraph(pit_type const pit)
357 Paragraph & par = text_->getPar(pit);
358 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
359 // redoParagraph() recursively inside parMetrics.
360 Dimension old_dim = parMetrics(pit, false).dim();
361 ParagraphMetrics & pm = par_metrics_[pit];
364 Buffer & buffer = bv_->buffer();
365 bool changed = false;
367 // Check whether there are InsetBibItems that need fixing
368 // FIXME: This check ought to be done somewhere else. It is the reason
369 // why text_ is not const. But then, where else to do it?
370 // Well, how can you end up with either (a) a biblio environment that
371 // has no InsetBibitem or (b) a biblio environment with more than one
372 // InsetBibitem? I think the answer is: when paragraphs are merged;
373 // when layout is set; when material is pasted.
374 if (par.brokenBiblio()) {
375 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
376 // In some cases, we do not know how to record undo
377 if (&cur.inset() == &text_->inset())
378 cur.recordUndo(pit, pit);
380 int const moveCursor = par.fixBiblio(buffer);
382 // Is it necessary to update the cursor?
383 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
386 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
391 // Optimisation: this is used in the next two loops
392 // so better to calculate that once here.
393 int const right_margin = rightMargin(pm);
395 // iterator pointing to paragraph to resolve macros
396 DocIterator parPos = text_->macrocontextPosition();
400 LYXERR(Debug::INFO, "MacroContext not initialised!"
401 << " Going through the buffer again and hope"
402 << " the context is better then.");
403 // FIXME audit updateBuffer calls
404 // This should not be here, but it is not clear yet where else it
406 bv_->buffer().updateBuffer();
407 parPos = text_->macrocontextPosition();
408 LBUFERR(!parPos.empty());
413 par.setBeginOfBody();
414 Font const bufferfont = buffer.params().getFont();
415 CoordCache::Insets & insetCache = bv_->coordCache().insets();
416 InsetList::const_iterator ii = par.insetList().begin();
417 InsetList::const_iterator iend = par.insetList().end();
418 for (; ii != iend; ++ii) {
419 // FIXME Doesn't this HAVE to be non-empty?
420 // position already initialized?
421 if (!parPos.empty()) {
422 parPos.pos() = ii->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 (ii->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 && ii->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, ii->pos)
446 - right_margin - eop;
447 Font const & font = ii->inset->inheritFont() ?
448 displayFont(pit, ii->pos) : bufferfont;
449 MacroContext mc(&buffer, parPos);
450 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
451 ii->inset->metrics(mi, dim);
452 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
453 insetCache.add(ii->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);
471 row.setChanged(false);
472 if (row_index || row.endpos() < par.size()
473 || (row.right_boundary() && 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. In the case
478 * of a display inset, we do nothing when inside a table
479 * cell, because the tabular code is not prepared for
480 * that, and it triggers when using a caption in a
481 * longtable (see bugs #9945 and #9757).
483 if (dim_.wid < max_width_)
484 dim_.wid = max_width_;
486 int const max_row_width = max(dim_.wid, row.width());
487 computeRowMetrics(row, max_row_width);
488 first = row.endpos();
491 pm.dim().wid = max(pm.dim().wid, row.width());
492 pm.dim().des += row.height();
493 } while (first < par.size() || need_new_row);
495 if (row_index < pm.rows().size())
496 pm.rows().resize(row_index);
498 // FIXME: It might be better to move this in another method
499 // specially tailored for the main text.
500 // Top and bottom margin of the document (only at top-level)
501 if (text_->isMainText()) {
502 // original value was 20px, which is 0.2in at 100dpi
503 int const margin = Length(0.2, Length::IN).inPixels(0);
505 pm.rows().front().dimension().asc += margin;
506 /* coverity thinks that we should update pm.dim().asc
507 * below, but all the rows heights are actually counted as
508 * part of the paragraph metric descent see loop above).
510 // coverity[copy_paste_error]
511 pm.dim().des += margin;
513 ParagraphList const & pars = text_->paragraphs();
514 if (pit + 1 == pit_type(pars.size())) {
515 pm.rows().back().dimension().des += margin;
516 pm.dim().des += margin;
520 // The space above and below the paragraph.
521 int const top = parTopSpacing(pit);
522 pm.rows().front().dimension().asc += top;
523 int const bottom = parBottomSpacing(pit);
524 pm.rows().back().dimension().des += bottom;
525 pm.dim().des += top + bottom;
527 pm.dim().asc += pm.rows()[0].ascent();
528 pm.dim().des -= pm.rows()[0].ascent();
530 changed |= old_dim.height() != pm.dim().height();
536 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
538 LyXAlignment align = par.getAlign();
540 // handle alignment inside tabular cells
541 Inset const & owner = text_->inset();
542 bool forced_block = false;
543 switch (owner.contentAlignment()) {
544 case LYX_ALIGN_BLOCK:
545 // In general block align is the default state, but here it is
546 // an explicit choice. Therefore it should not be overridden
550 case LYX_ALIGN_CENTER:
552 case LYX_ALIGN_RIGHT:
553 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
554 align = owner.contentAlignment();
557 // unchanged (use align)
561 // Display-style insets should always be on a centered row
562 if (Inset const * inset = par.getInset(row.pos())) {
563 switch (inset->display()) {
564 case Inset::AlignLeft:
565 align = LYX_ALIGN_BLOCK;
567 case Inset::AlignCenter:
568 align = LYX_ALIGN_CENTER;
571 // unchanged (use align)
573 case Inset::AlignRight:
574 align = LYX_ALIGN_RIGHT;
579 if (align == LYX_ALIGN_BLOCK) {
580 // If this row has been broken abruptly by a display inset, or
581 // it is the end of the paragraph, or the user requested we
582 // not justify stuff, then don't stretch.
583 // A forced block alignment can only be overridden the 'no
584 // justification on screen' setting.
585 if ((row.flushed() && !forced_block)
586 || !bv_->buffer().params().justification)
587 align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
594 void TextMetrics::computeRowMetrics(Row & row, int width) const
599 Paragraph const & par = text_->getPar(row.pit());
601 int const w = width - row.right_margin - row.width();
602 // FIXME: put back this assertion when the crash on new doc is solved.
603 //LASSERT(w >= 0, /**/);
605 // is there a manual margin with a manual label
606 Layout const & layout = par.layout();
609 if (layout.margintype == MARGIN_MANUAL
610 && layout.labeltype == LABEL_MANUAL) {
611 /// We might have real hfills in the label part
612 nlh = numberOfLabelHfills(par, row);
614 // A manual label par (e.g. List) has an auto-hfill
615 // between the label text and the body of the
617 // But we don't want to do this auto hfill if the par
622 if (nlh && !par.getLabelWidthString().empty())
623 row.label_hfill = labelFill(row) / double(nlh);
626 // are there any hfills in the row?
627 ParagraphMetrics & pm = par_metrics_[row.pit()];
628 int nh = numberOfHfills(row, pm, par.beginOfBody());
632 // We don't have to look at the alignment if the row is already
633 // larger then the permitted width as then we force the
634 // LEFT_ALIGN'edness!
635 if (int(row.width()) >= max_width_)
639 // Common case : there is no hfill, and the alignment will be
641 switch (getAlign(par, row)) {
642 case LYX_ALIGN_BLOCK:
643 // Expand expanding characters by a total of w
644 if (!row.setExtraWidth(w) && row.isRTL()) {
645 // Justification failed and the text is RTL: align to the right
646 row.left_margin += w;
647 row.dimension().wid += w;
651 // a displayed inset that is flushed
652 if (Inset const * inset = par.getInset(row.pos()))
653 row.left_margin += inset->indent(*bv_);
655 case LYX_ALIGN_RIGHT:
656 if (Inset const * inset = par.getInset(row.pos())) {
657 int const new_w = max(w - inset->indent(*bv_), 0);
658 row.left_margin += new_w;
659 row.dimension().wid += new_w;
661 row.left_margin += w;
662 row.dimension().wid += w;
665 case LYX_ALIGN_CENTER:
666 row.dimension().wid += w / 2;
667 row.left_margin += w / 2;
670 case LYX_ALIGN_LAYOUT:
671 case LYX_ALIGN_SPECIAL:
672 case LYX_ALIGN_DECIMAL:
678 // Case nh > 0. There are hfill separators.
681 row.dimension().wid += w;
682 // Set size of hfill insets
683 pos_type const endpos = row.endpos();
684 pos_type body_pos = par.beginOfBody();
686 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
689 CoordCache::Insets & insetCache = bv_->coordCache().insets();
690 Row::iterator cit = row.begin();
691 Row::iterator const cend = row.end();
692 for ( ; cit != cend; ++cit) {
693 if (row.label_hfill && cit->endpos == body_pos
694 && cit->type == Row::SPACE)
695 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
696 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
697 if (cit->pos >= body_pos) {
698 cit->dim.wid += hfill;
701 cit->dim.wid += hfill_rem;
703 cit->dim.wid += int(row.label_hfill);
704 // Cache the inset dimension.
705 insetCache.add(cit->inset, cit->dim);
711 int TextMetrics::labelFill(Row const & row) const
713 Paragraph const & par = text_->getPar(row.pit());
714 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
717 Row::const_iterator cit = row.begin();
718 Row::const_iterator const end = row.end();
719 // iterate over elements before main body (except the last one,
720 // which is extra space).
721 while (cit!= end && cit->endpos < par.beginOfBody()) {
726 docstring const & label = par.params().labelWidthString();
730 FontMetrics const & fm
731 = theFontMetrics(text_->labelFont(par));
733 return max(0, fm.width(label) - w);
738 // Not used, see TextMetrics::breakRow
739 // this needs special handling - only newlines count as a break point
740 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
742 pos_type const end = par.size();
745 if (par.isNewline(i))
753 int TextMetrics::labelEnd(pit_type const pit) const
755 // labelEnd is only needed if the layout fills a flushleft label.
756 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
758 // return the beginning of the body
759 return leftMargin(pit);
765 * Calling Text::getFont is slow. While rebreaking we scan a
766 * paragraph from left to right calling getFont for every char. This
767 * simple class address this problem by hidding an optimization trick
768 * (not mine btw -AB): the font is reused in the whole font span. The
769 * class handles transparently the "hidden" (not part of the fontlist)
770 * label font (as getFont does).
776 FontIterator(TextMetrics const & tm,
777 Paragraph const & par, pit_type pit, pos_type pos)
778 : tm_(tm), par_(par), pit_(pit), pos_(pos),
779 font_(tm.displayFont(pit, pos)),
780 endspan_(par.fontSpan(pos).last),
781 bodypos_(par.beginOfBody())
785 Font const & operator*() const { return font_; }
788 FontIterator & operator++()
791 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
792 font_ = tm_.displayFont(pit_, pos_);
793 endspan_ = par_.fontSpan(pos_).last;
799 Font * operator->() { return &font_; }
803 TextMetrics const & tm_;
805 Paragraph const & par_;
820 /** This is the function where the hard work is done. The code here is
821 * very sensitive to small changes :) Note that part of the
822 * intelligence is also in Row::shortenIfNeeded.
824 bool TextMetrics::breakRow(Row & row, int const right_margin) const
826 Paragraph const & par = text_->getPar(row.pit());
827 pos_type const end = par.size();
828 pos_type const pos = row.pos();
829 pos_type const body_pos = par.beginOfBody();
830 bool const is_rtl = text_->isRTL(par);
831 bool need_new_row = false;
834 row.left_margin = leftMargin(row.pit(), pos);
835 row.right_margin = right_margin;
837 swap(row.left_margin, row.right_margin);
838 // Remember that the row width takes into account the left_margin
839 // but not the right_margin.
840 row.dimension().wid = row.left_margin;
841 // the width available for the row.
842 int const width = max_width_ - row.right_margin;
844 if (pos >= end || row.width() > width) {
850 //FIXME: As long as leftMargin() is not correctly implemented for
851 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
852 // Otherwise, long rows will be painted off the screen.
853 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
854 return addressBreakPoint(pos, par);
857 // check for possible inline completion
858 DocIterator const & ic_it = bv_->inlineCompletionPos();
859 pos_type ic_pos = -1;
860 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
861 ic_pos = ic_it.pos();
863 // Now we iterate through until we reach the right margin
864 // or the end of the par, then build a representation of the row.
866 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
868 // this can happen for an empty row after a newline
871 char_type c = par.getChar(i);
872 // The most special cases are handled first.
873 if (par.isInset(i)) {
874 Inset const * ins = par.getInset(i);
875 Dimension dim = bv_->coordCache().insets().dim(ins);
876 row.add(i, ins, dim, *fi, par.lookupChange(i));
877 } else if (c == ' ' && i + 1 == body_pos) {
878 // There is a space at i, but it should not be
879 // added as a separator, because it is just
880 // before body_pos. Instead, insert some spacing to
882 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
883 // this is needed to make sure that the row width is correct
885 int const add = max(fm.width(par.layout().labelsep),
886 labelEnd(row.pit()) - row.width());
887 row.addSpace(i, add, *fi, par.lookupChange(i));
888 } else if (c == '\t')
889 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
890 *fi, par.lookupChange(i));
891 else if (c == 0x2028 || c == 0x2029) {
893 * U+2028 LINE SEPARATOR
894 * U+2029 PARAGRAPH SEPARATOR
896 * These are special unicode characters that break
897 * lines/pragraphs. Not handling them lead to trouble wrt
898 * Qt QTextLayout formatting. We add a visible character
899 * on screen so that the user can see that something is
903 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
904 // ¶ U+00B6 PILCROW SIGN
905 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
906 row.add(i, screen_char, *fi, par.lookupChange(i));
908 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
909 // see also Paragraph::getUChar.
910 if (fi->language()->lang() == "hebrew") {
916 row.add(i, c, *fi, par.lookupChange(i));
919 // add inline completion width
920 // draw logically behind the previous character
921 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
922 docstring const comp = bv_->inlineCompletion();
923 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
927 f.fontInfo().setColor(Color_inlinecompletion);
928 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
930 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
931 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
934 // Handle some situations that abruptly terminate the row
936 // - Before a display inset
937 // - After a display inset
938 Inset const * inset = 0;
939 if (par.isNewline(i) || par.isEnvSeparator(i)
940 || (i + 1 < end && (inset = par.getInset(i + 1))
942 || (!row.empty() && row.back().inset
943 && row.back().inset->display())) {
945 need_new_row = par.isNewline(i);
952 } while (i < end && row.width() <= width);
956 // End of paragraph marker. The logic here is almost the
957 // same as in redoParagraph, remember keep them in sync.
958 ParagraphList const & pars = text_->paragraphs();
959 if (lyxrc.paragraph_markers && !need_new_row
960 && i == end && size_type(row.pit() + 1) < pars.size()) {
961 // add a virtual element for the end-of-paragraph
962 // marker; it is shown on screen, but does not exist
964 Font f(text_->layoutFont(row.pit()));
965 f.fontInfo().setColor(Color_paragraphmarker);
966 BufferParams const & bparams
967 = text_->inset().buffer().params();
968 f.setLanguage(par.getParLanguage(bparams));
969 // ¶ U+00B6 PILCROW SIGN
970 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
973 // if the row is too large, try to cut at last separator. In case
974 // of success, reset indication that the row was broken abruptly.
975 int const next_width = max_width_ - leftMargin(row.pit(), row.endpos())
976 - rightMargin(row.pit());
978 if (row.shortenIfNeeded(body_pos, width, next_width))
980 row.right_boundary(!row.empty() && row.endpos() < end
981 && row.back().endpos == row.endpos());
982 // Last row in paragraph is flushed
983 if (row.endpos() == end)
986 // make sure that the RTL elements are in reverse ordering
987 row.reverseRTL(is_rtl);
988 //LYXERR0("breakrow: row is " << row);
993 int TextMetrics::parTopSpacing(pit_type const pit) const
995 Paragraph const & par = text_->getPar(pit);
996 Layout const & layout = par.layout();
999 ParagraphList const & pars = text_->paragraphs();
1000 double const dh = defaultRowHeight();
1002 BufferParams const & bparams = bv_->buffer().params();
1003 Inset const & inset = text_->inset();
1004 // some parskips VERY EASY IMPLEMENTATION
1005 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1006 && !inset.getLayout().parbreakIsNewline()
1007 && !par.layout().parbreak_is_newline
1009 && ((layout.isParagraph() && par.getDepth() == 0)
1010 || (pars[pit - 1].layout().isParagraph()
1011 && pars[pit - 1].getDepth() == 0))) {
1012 asc += bparams.getDefSkip().inPixels(*bv_);
1015 if (par.params().startOfAppendix())
1018 // special code for the top label
1019 if (layout.labelIsAbove()
1020 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1021 && !par.labelString().empty()) {
1022 FontInfo labelfont = text_->labelFont(par);
1023 FontMetrics const & lfm = theFontMetrics(labelfont);
1024 asc += int(lfm.maxHeight() * layout.spacing.getValue()
1025 * text_->spacing(par)
1026 + (layout.topsep + layout.labelbottomsep) * dh);
1029 // Add the layout spaces, for example before and after
1030 // a section, or between the items of a itemize or enumerate
1033 pit_type prev = text_->depthHook(pit, par.getDepth());
1034 Paragraph const & prevpar = pars[prev];
1035 double layoutasc = 0;
1037 && prevpar.layout() == layout
1038 && prevpar.getDepth() == par.getDepth()
1039 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1040 layoutasc = layout.itemsep * dh;
1041 } else if (pit != 0 && layout.topsep > 0)
1042 layoutasc = layout.topsep * dh;
1044 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1046 prev = text_->outerHook(pit);
1047 if (prev != pit_type(pars.size())) {
1048 asc += int(pars[prev].layout().parsep * dh);
1049 } else if (pit != 0) {
1050 Paragraph const & prevpar = pars[pit - 1];
1051 if (prevpar.getDepth() != 0 || prevpar.layout() == layout)
1052 asc += int(layout.parsep * dh);
1059 int TextMetrics::parBottomSpacing(pit_type const pit) const
1061 double layoutdesc = 0;
1062 ParagraphList const & pars = text_->paragraphs();
1063 double const dh = defaultRowHeight();
1065 // add the layout spaces, for example before and after
1066 // a section, or between the items of a itemize or enumerate
1068 pit_type nextpit = pit + 1;
1069 if (nextpit != pit_type(pars.size())) {
1070 pit_type cpit = pit;
1072 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1073 double usual = pars[cpit].layout().bottomsep * dh;
1075 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1076 if (pars[cpit].layout() != pars[nextpit].layout()
1077 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1078 unusual = pars[cpit].layout().bottomsep * dh;
1079 layoutdesc = max(unusual, usual);
1080 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1081 if (pars[cpit].layout() != pars[nextpit].layout()
1082 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1083 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1087 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1091 void TextMetrics::setRowHeight(Row & row) const
1093 Paragraph const & par = text_->getPar(row.pit());
1094 Layout const & layout = par.layout();
1095 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1097 // Initial value for ascent (useful if row is empty).
1098 Font const font = displayFont(row.pit(), row.pos());
1099 FontMetrics const & fm = theFontMetrics(font);
1100 int maxasc = int(fm.maxAscent() * spacing_val);
1101 int maxdes = int(fm.maxDescent() * spacing_val);
1103 // Find the ascent/descent of the row contents
1104 Row::const_iterator cit = row.begin();
1105 Row::const_iterator cend = row.end();
1106 for ( ; cit != cend; ++cit) {
1108 maxasc = max(maxasc, cit->dim.ascent());
1109 maxdes = max(maxdes, cit->dim.descent());
1111 FontMetrics const & fm = theFontMetrics(cit->font);
1112 maxasc = max(maxasc, int(fm.maxAscent() * spacing_val));
1113 maxdes = max(maxdes, int(fm.maxDescent() * spacing_val));
1117 // This is nicer with box insets
1121 row.dimension().asc = maxasc;
1122 row.dimension().des = maxdes;
1126 // x is an absolute screen coord
1127 // returns the column near the specified x-coordinate of the row
1128 // x is set to the real beginning of this column
1129 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1130 bool & boundary) const
1132 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1133 /// For the main Text, it is possible that this pit is not
1134 /// yet in the CoordCache when moving cursor up.
1135 /// x Paragraph coordinate is always 0 for main text anyway.
1136 int const xo = origin_.x_;
1139 // Adapt to cursor row scroll offset if applicable.
1140 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1143 pos_type pos = row.pos();
1146 x = row.left_margin;
1147 else if (x <= row.left_margin) {
1148 pos = row.front().left_pos();
1149 x = row.left_margin;
1150 } else if (x >= row.width()) {
1151 pos = row.back().right_pos();
1154 double w = row.left_margin;
1155 Row::const_iterator cit = row.begin();
1156 Row::const_iterator cend = row.end();
1157 for ( ; cit != cend; ++cit) {
1158 if (w <= x && w + cit->full_width() > x) {
1159 int x_offset = int(x - w);
1160 pos = cit->x2pos(x_offset);
1161 x = int(x_offset + w);
1164 w += cit->full_width();
1166 if (cit == row.end()) {
1167 pos = row.back().right_pos();
1170 /** This tests for the case where the cursor is placed
1171 * just before a font direction change. See comment on
1172 * the boundary_ member in DocIterator.h to understand
1173 * how boundary helps here.
1175 else if (pos == cit->endpos
1176 && ((!cit->isRTL() && cit + 1 != row.end()
1177 && (cit + 1)->isRTL())
1178 || (cit->isRTL() && cit != row.begin()
1179 && !(cit - 1)->isRTL())))
1183 /** This tests for the case where the cursor is set at the end
1184 * of a row which has been broken due something else than a
1185 * separator (a display inset or a forced breaking of the
1186 * row). We know that there is a separator when the end of the
1187 * row is larger than the end of its last element.
1189 if (!row.empty() && pos == row.back().endpos
1190 && row.back().endpos == row.endpos()) {
1191 Inset const * inset = row.back().inset;
1192 if (inset && (inset->lyxCode() == NEWLINE_CODE
1193 || inset->lyxCode() == SEPARATOR_CODE))
1194 pos = row.back().pos;
1196 boundary = row.right_boundary();
1200 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1206 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1208 // We play safe and use parMetrics(pit) to make sure the
1209 // ParagraphMetrics will be redone and OK to use if needed.
1210 // Otherwise we would use an empty ParagraphMetrics in
1211 // upDownInText() while in selection mode.
1212 ParagraphMetrics const & pm = parMetrics(pit);
1214 LBUFERR(row < int(pm.rows().size()));
1216 Row const & r = pm.rows()[row];
1217 return getPosNearX(r, x, bound);
1221 void TextMetrics::newParMetricsDown()
1223 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1224 pit_type const pit = last.first + 1;
1225 if (pit == int(text_->paragraphs().size()))
1228 // do it and update its position.
1230 par_metrics_[pit].setPosition(last.second.position()
1231 + last.second.descent() + par_metrics_[pit].ascent());
1232 updatePosCache(pit);
1236 void TextMetrics::newParMetricsUp()
1238 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1239 if (first.first == 0)
1242 pit_type const pit = first.first - 1;
1243 // do it and update its position.
1245 par_metrics_[pit].setPosition(first.second.position()
1246 - first.second.ascent() - par_metrics_[pit].descent());
1247 updatePosCache(pit);
1250 // y is screen coordinate
1251 pit_type TextMetrics::getPitNearY(int y)
1253 LASSERT(!text_->paragraphs().empty(), return -1);
1254 LASSERT(!par_metrics_.empty(), return -1);
1255 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1257 // look for highest numbered paragraph with y coordinate less than given y
1260 ParMetricsCache::const_iterator it = par_metrics_.begin();
1261 ParMetricsCache::const_iterator et = par_metrics_.end();
1262 ParMetricsCache::const_iterator last = et;
1265 ParagraphMetrics const & pm = it->second;
1267 if (y < it->second.position() - int(pm.ascent())) {
1268 // We are looking for a position that is before the first paragraph in
1269 // the cache (which is in priciple off-screen, that is before the
1272 // We are already at the first paragraph in the inset.
1274 // OK, this is the paragraph we are looking for.
1275 pit = it->first - 1;
1280 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1282 if (y >= last->second.position() + int(pm_last.descent())) {
1283 // We are looking for a position that is after the last paragraph in
1284 // the cache (which is in priciple off-screen), that is before the
1286 pit = last->first + 1;
1287 if (pit == int(text_->paragraphs().size()))
1288 // We are already at the last paragraph in the inset.
1290 // OK, this is the paragraph we are looking for.
1291 newParMetricsDown();
1295 for (; it != et; ++it) {
1296 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1297 << " y: " << it->second.position());
1299 ParagraphMetrics const & pm = par_metrics_[it->first];
1301 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1303 yy = it->second.position();
1307 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1313 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1314 bool assert_in_view, bool up)
1316 ParagraphMetrics const & pm = par_metrics_[pit];
1318 int yy = pm.position() - pm.ascent();
1319 LBUFERR(!pm.rows().empty());
1320 RowList::const_iterator rit = pm.rows().begin();
1321 RowList::const_iterator rlast = pm.rows().end();
1323 for (; rit != rlast; yy += rit->height(), ++rit)
1324 if (yy + rit->height() > y)
1327 if (assert_in_view) {
1328 if (!up && yy + rit->height() > y) {
1329 if (rit != pm.rows().begin()) {
1332 } else if (pit != 0) {
1335 ParagraphMetrics const & pm2 = par_metrics_[pit];
1336 rit = pm2.rows().end();
1340 } else if (up && yy != y) {
1342 y = yy + rit->height();
1344 } else if (pit < int(text_->paragraphs().size()) - 1) {
1346 newParMetricsDown();
1347 ParagraphMetrics const & pm2 = par_metrics_[pit];
1348 rit = pm2.rows().begin();
1357 // x,y are absolute screen coordinates
1358 // sets cursor recursively descending into nested editable insets
1359 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1360 bool assert_in_view, bool up)
1362 if (lyxerr.debugging(Debug::WORKAREA)) {
1363 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1364 cur.bv().coordCache().dump();
1366 pit_type pit = getPitNearY(y);
1367 LASSERT(pit != -1, return 0);
1368 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1371 // Do we cover an inset?
1372 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1375 // No inset, set position in the text
1376 bool bound = false; // is modified by getPosNearX
1377 cur.pos() = getPosNearX(row, x, bound);
1378 cur.boundary(bound);
1379 cur.setCurrentFont();
1384 Inset * inset = it->inset;
1385 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1387 // Set position in front of inset
1388 cur.pos() = it->pos;
1389 cur.boundary(false);
1392 // Try to descend recursively inside the inset.
1393 Inset * edited = inset->editXY(cur, x, y);
1394 // FIXME: it is not clear that the test on position is needed
1395 // Remove it if/when semantics of editXY is clarified
1396 if (cur.text() == text_ && cur.pos() == it->pos) {
1397 // non-editable inset, set cursor after the inset if x is
1398 // nearer to that position (bug 9628)
1399 bool bound = false; // is modified by getPosNearX
1400 cur.pos() = getPosNearX(row, x, bound);
1401 cur.boundary(bound);
1402 cur.setCurrentFont();
1406 if (cur.top().text() == text_)
1407 cur.setCurrentFont();
1412 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1414 LASSERT(text_ == cur.text(), return);
1415 pit_type const pit = getPitNearY(y);
1416 LASSERT(pit != -1, return);
1418 ParagraphMetrics const & pm = par_metrics_[pit];
1420 int yy = pm.position() - pm.ascent();
1421 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1422 " pit: " << pit << " yy: " << yy);
1425 LBUFERR(pm.rows().size());
1426 for (; r < int(pm.rows().size()) - 1; ++r) {
1427 Row const & row = pm.rows()[r];
1428 if (int(yy + row.height()) > y)
1433 Row const & row = pm.rows()[r];
1435 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1439 pos_type const pos = getPosNearX(row, xx, bound);
1441 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1443 text_->setCursor(cur, pit, pos, true, bound);
1444 // remember new position.
1449 //takes screen x,y coordinates
1450 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1452 Paragraph const & par = text_->paragraphs()[pit];
1453 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1455 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1457 for (auto const & it : par.insetList()) {
1458 LYXERR(Debug::DEBUG, "examining inset " << it.inset);
1460 if (insetCache.covers(it.inset, x, y)) {
1461 LYXERR(Debug::DEBUG, "Hit inset: " << it.inset);
1462 return const_cast<InsetList::InsetTable *>(&it);
1466 LYXERR(Debug::DEBUG, "No inset hit. ");
1471 //takes screen x,y coordinates
1472 Inset * TextMetrics::checkInsetHit(int x, int y)
1474 pit_type const pit = getPitNearY(y);
1475 LASSERT(pit != -1, return 0);
1476 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1485 int TextMetrics::cursorX(CursorSlice const & sl,
1486 bool boundary) const
1488 LASSERT(sl.text() == text_, return 0);
1490 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1491 if (pm.rows().empty())
1493 Row const & row = pm.getRow(sl.pos(), boundary);
1494 pos_type const pos = sl.pos();
1497 row.findElement(pos, boundary, x);
1503 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1505 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1506 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1507 if (pm.rows().empty())
1511 h -= par_metrics_[0].rows()[0].ascent();
1512 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1513 h += par_metrics_[pit].height();
1516 if (pos && boundary)
1518 size_t const rend = pm.pos2row(pos);
1519 for (size_t rit = 0; rit != rend; ++rit)
1520 h += pm.rows()[rit].height();
1521 h += pm.rows()[rend].ascent();
1526 // the cursor set functions have a special mechanism. When they
1527 // realize you left an empty paragraph, they will delete it.
1529 bool TextMetrics::cursorHome(Cursor & cur)
1531 LASSERT(text_ == cur.text(), return false);
1532 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1533 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1534 return text_->setCursor(cur, cur.pit(), row.pos());
1538 bool TextMetrics::cursorEnd(Cursor & cur)
1540 LASSERT(text_ == cur.text(), return false);
1541 // if not on the last row of the par, put the cursor before
1542 // the final space exept if I have a spanning inset or one string
1543 // is so long that we force a break.
1544 pos_type end = cur.textRow().endpos();
1546 // empty text, end-1 is no valid position
1548 bool boundary = false;
1549 if (end != cur.lastpos()) {
1550 if (!cur.paragraph().isLineSeparator(end-1)
1551 && !cur.paragraph().isNewline(end-1)
1552 && !cur.paragraph().isEnvSeparator(end-1))
1556 } else if (cur.paragraph().isEnvSeparator(end-1))
1558 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1562 void TextMetrics::deleteLineForward(Cursor & cur)
1564 LASSERT(text_ == cur.text(), return);
1565 if (cur.lastpos() == 0) {
1566 // Paragraph is empty, so we just go forward
1567 text_->cursorForward(cur);
1570 cur.selection(true); // to avoid deletion
1573 // What is this test for ??? (JMarc)
1574 if (!cur.selection())
1575 text_->deleteWordForward(cur);
1577 cap::cutSelection(cur, true, false);
1578 cur.checkBufferStructure();
1583 bool TextMetrics::isLastRow(Row const & row) const
1585 ParagraphList const & pars = text_->paragraphs();
1586 return row.endpos() >= pars[row.pit()].size()
1587 && row.pit() + 1 == pit_type(pars.size());
1591 bool TextMetrics::isFirstRow(Row const & row) const
1593 return row.pos() == 0 && row.pit() == 0;
1597 int TextMetrics::leftMargin(pit_type pit) const
1599 return leftMargin(pit, text_->paragraphs()[pit].size());
1603 int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
1605 ParagraphList const & pars = text_->paragraphs();
1607 LASSERT(pit >= 0, return 0);
1608 LASSERT(pit < int(pars.size()), return 0);
1609 Paragraph const & par = pars[pit];
1610 LASSERT(pos >= 0, return 0);
1611 LASSERT(pos <= par.size(), return 0);
1612 Buffer const & buffer = bv_->buffer();
1613 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1614 DocumentClass const & tclass = buffer.params().documentClass();
1615 Layout const & layout = par.layout();
1616 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1618 docstring parindent = layout.parindent;
1622 if (text_->isMainText())
1623 l_margin += bv_->leftMargin();
1625 l_margin += bfm.signedWidth(tclass.leftmargin());
1627 int depth = par.getDepth();
1629 // find the next level paragraph
1630 pit_type newpar = text_->outerHook(pit);
1631 if (newpar != pit_type(pars.size())) {
1632 if (pars[newpar].layout().isEnvironment()) {
1633 int nestmargin = depth * nestMargin();
1634 if (text_->isMainText())
1635 nestmargin += changebarMargin();
1636 l_margin = max(leftMargin(newpar), nestmargin);
1637 // Remove the parindent that has been added
1638 // if the paragraph was empty.
1639 if (pars[newpar].empty() &&
1640 buffer.params().paragraph_separation ==
1641 BufferParams::ParagraphIndentSeparation) {
1642 docstring pi = pars[newpar].layout().parindent;
1643 l_margin -= bfm.signedWidth(pi);
1646 if (tclass.isDefaultLayout(par.layout())
1647 || tclass.isPlainLayout(par.layout())) {
1648 if (pars[newpar].params().noindent())
1651 parindent = pars[newpar].layout().parindent;
1656 // This happens after sections or environments in standard classes.
1657 // We have to check the previous layout at same depth.
1658 if (buffer.params().paragraph_separation ==
1659 BufferParams::ParagraphSkipSeparation)
1661 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1662 pit_type prev = text_->depthHook(pit, par.getDepth());
1663 if (par.layout() == pars[prev].layout()) {
1665 && pars[pit - 1].layout().nextnoindent)
1667 } else if (pars[prev].layout().nextnoindent)
1671 FontInfo const labelfont = text_->labelFont(par);
1672 FontMetrics const & lfm = theFontMetrics(labelfont);
1674 switch (layout.margintype) {
1675 case MARGIN_DYNAMIC:
1676 if (!layout.leftmargin.empty()) {
1677 l_margin += bfm.signedWidth(layout.leftmargin);
1679 if (!par.labelString().empty()) {
1680 l_margin += lfm.signedWidth(layout.labelindent);
1681 l_margin += lfm.width(par.labelString());
1682 l_margin += lfm.width(layout.labelsep);
1686 case MARGIN_MANUAL: {
1687 l_margin += lfm.signedWidth(layout.labelindent);
1688 // The width of an empty par, even with manual label, should be 0
1689 if (!par.empty() && pos >= par.beginOfBody()) {
1690 if (!par.getLabelWidthString().empty()) {
1691 docstring labstr = par.getLabelWidthString();
1692 l_margin += lfm.width(labstr);
1693 l_margin += lfm.width(layout.labelsep);
1699 case MARGIN_STATIC: {
1700 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1701 / (par.getDepth() + 4);
1705 case MARGIN_FIRST_DYNAMIC:
1706 if (layout.labeltype == LABEL_MANUAL) {
1707 // if we are at position 0, we are never in the body
1708 if (pos > 0 && pos >= par.beginOfBody())
1709 l_margin += lfm.signedWidth(layout.leftmargin);
1711 l_margin += lfm.signedWidth(layout.labelindent);
1713 // Special case to fix problems with
1715 || (layout.labeltype == LABEL_STATIC
1716 && layout.latextype == LATEX_ENVIRONMENT
1717 && !text_->isFirstInSequence(pit))) {
1718 l_margin += lfm.signedWidth(layout.leftmargin);
1719 } else if (!layout.labelIsAbove()) {
1720 l_margin += lfm.signedWidth(layout.labelindent);
1721 l_margin += lfm.width(layout.labelsep);
1722 l_margin += lfm.width(par.labelString());
1726 case MARGIN_RIGHT_ADDRESS_BOX: {
1728 // The left margin depends on the widest row in this paragraph.
1729 // This code is wrong because it depends on the rows, but at the
1730 // same time this function is used in redoParagraph to construct
1732 ParagraphMetrics const & pm = par_metrics_[pit];
1733 RowList::const_iterator rit = pm.rows().begin();
1734 RowList::const_iterator end = pm.rows().end();
1735 int minfill = max_width_;
1736 for ( ; rit != end; ++rit)
1737 if (rit->fill() < minfill)
1738 minfill = rit->fill();
1739 l_margin += bfm.signedWidth(layout.leftmargin);
1740 l_margin += minfill;
1742 // also wrong, but much shorter.
1743 l_margin += max_width_ / 2;
1748 if (!par.params().leftIndent().zero())
1749 l_margin += par.params().leftIndent().inPixels(max_width_, lfm.em());
1751 LyXAlignment align = par.getAlign();
1753 // set the correct parindent
1755 && (layout.labeltype == LABEL_NO_LABEL
1756 || layout.labeltype == LABEL_ABOVE
1757 || layout.labeltype == LABEL_CENTERED
1758 || (layout.labeltype == LABEL_STATIC
1759 && layout.latextype == LATEX_ENVIRONMENT
1760 && !text_->isFirstInSequence(pit)))
1761 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1762 && !par.params().noindent()
1763 // in some insets, paragraphs are never indented
1764 && !text_->inset().neverIndent()
1765 // display style insets are always centered, omit indentation
1768 && par.getInset(pos)->display())
1769 && (!(tclass.isDefaultLayout(par.layout())
1770 || tclass.isPlainLayout(par.layout()))
1771 || buffer.params().paragraph_separation
1772 == BufferParams::ParagraphIndentSeparation)) {
1773 /* use the parindent of the layout when the default
1774 * indentation is used otherwise use the indentation set in
1775 * the document settings
1777 if (buffer.params().getParIndent().empty())
1778 l_margin += bfm.signedWidth(parindent);
1780 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
1787 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1789 if (par_metrics_.empty())
1795 ParMetricsCache::iterator it = par_metrics_.begin();
1796 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1797 y -= it->second.ascent();
1798 for (; it != pm_end; ++it) {
1799 ParagraphMetrics const & pmi = it->second;
1801 pit_type const pit = it->first;
1802 // Save the paragraph position in the cache.
1803 it->second.setPosition(y);
1804 drawParagraph(pi, pit, x, y);
1810 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1812 ParagraphMetrics const & pm = par_metrics_[pit];
1813 if (pm.rows().empty())
1815 size_t const nrows = pm.rows().size();
1817 // Use fast lane in nodraw stage.
1818 if (pi.pain.isNull()) {
1819 for (size_t i = 0; i != nrows; ++i) {
1821 Row const & row = pm.rows()[i];
1822 // Adapt to cursor row scroll offset if applicable.
1823 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1827 RowPainter rp(pi, *text_, row, row_x, y);
1829 rp.paintOnlyInsets();
1835 int const ww = bv_->workHeight();
1836 Cursor const & cur = bv_->cursor();
1837 DocIterator sel_beg = cur.selectionBegin();
1838 DocIterator sel_end = cur.selectionEnd();
1839 bool selection = cur.selection()
1840 // This is our text.
1841 && cur.text() == text_
1842 // if the anchor is outside, this is not our selection
1843 && cur.normalAnchor().text() == text_
1844 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1846 // We store the begin and end pos of the selection relative to this par
1847 DocIterator sel_beg_par = cur.selectionBegin();
1848 DocIterator sel_end_par = cur.selectionEnd();
1850 // We care only about visible selection.
1852 if (pit != sel_beg.pit()) {
1853 sel_beg_par.pit() = pit;
1854 sel_beg_par.pos() = 0;
1856 if (pit != sel_end.pit()) {
1857 sel_end_par.pit() = pit;
1858 sel_end_par.pos() = sel_end_par.lastpos();
1862 for (size_t i = 0; i != nrows; ++i) {
1864 Row const & row = pm.rows()[i];
1865 // Adapt to cursor row scroll offset if applicable.
1866 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1870 // It is not needed to draw on screen if we are not inside.
1871 bool const inside = (y + row.descent() >= 0
1872 && y - row.ascent() < ww);
1874 // Inset positions have already been set in nodraw stage.
1880 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1882 row.setSelection(-1, -1);
1884 // The row knows nothing about the paragraph, so we have to check
1885 // whether this row is the first or last and update the margins.
1886 if (row.selection()) {
1887 if (row.sel_beg == 0)
1888 row.begin_margin_sel = sel_beg.pit() < pit;
1889 if (row.sel_end == sel_end_par.lastpos())
1890 row.end_margin_sel = sel_end.pit() > pit;
1893 // Row signature; has row changed since last paint?
1894 row.setCrc(pm.computeRowSignature(row, *bv_));
1895 bool row_has_changed = row.changed()
1896 || bv_->hadHorizScrollOffset(text_, pit, row.pos())
1897 || bv_->needRepaint(text_, row);
1899 // Take this opportunity to spellcheck the row contents.
1900 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1901 text_->getPar(pit).spellCheck();
1904 RowPainter rp(pi, *text_, row, row_x, y);
1906 // Don't paint the row if a full repaint has not been requested
1907 // and if it has not changed.
1908 if (!pi.full_repaint && !row_has_changed) {
1909 // Paint only the insets if the text itself is
1911 rp.paintOnlyInsets();
1916 // Clear background of this row if paragraph background was not
1917 // already cleared because of a full repaint.
1918 if (!pi.full_repaint && row_has_changed) {
1919 LYXERR(Debug::PAINTING, "Clear rect@("
1920 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1921 << width() << " x " << row.height());
1922 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1923 width(), row.height(), pi.background_color);
1926 // Instrumentation for testing row cache (see also
1928 if (lyxerr.debugging(Debug::PAINTING)
1929 && (row.selection() || pi.full_repaint || row_has_changed)) {
1930 string const foreword = text_->isMainText() ?
1931 "main text redraw " : "inset text redraw: ";
1932 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1933 << " row_selection=" << row.selection()
1934 << " full_repaint=" << pi.full_repaint
1935 << " row_has_changed=" << row_has_changed
1936 << " null painter=" << pi.pain.isNull());
1939 // Backup full_repaint status and force full repaint
1940 // for inner insets as the Row has been cleared out.
1941 bool tmp = pi.full_repaint;
1942 pi.full_repaint = true;
1944 rp.paintSelection();
1947 rp.paintChangeBar();
1948 if (i == 0 && !row.isRTL())
1950 if (i == nrows - 1 && row.isRTL())
1953 if (i == nrows - 1 && !row.isRTL())
1955 if (i == 0 && row.isRTL())
1957 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1958 row_x + row.right_x() > bv_->workWidth());
1961 // Restore full_repaint status.
1962 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);