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)
165 LBUFERR(mi.base.textwidth > 0);
166 max_width_ = mi.base.textwidth;
167 // backup old dimension.
168 Dimension const old_dim = dim_;
171 dim_.wid = min_width;
172 pit_type const npar = text_->paragraphs().size();
174 // If there is more than one row, expand the text to
175 // the full allowable width.
176 dim_.wid = max_width_;
178 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
179 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
181 bool changed = false;
183 for (pit_type pit = 0; pit != npar; ++pit) {
184 changed |= redoParagraph(pit);
185 ParagraphMetrics const & pm = par_metrics_[pit];
187 if (dim_.wid < pm.width())
188 dim_.wid = pm.width();
191 dim_.asc = par_metrics_[0].ascent();
192 dim_.des = h - dim_.asc;
193 //lyxerr << "dim_.wid " << dim_.wid << endl;
194 //lyxerr << "dim_.asc " << dim_.asc << endl;
195 //lyxerr << "dim_.des " << dim_.des << endl;
197 changed |= dim_ != old_dim;
203 void TextMetrics::updatePosCache(pit_type pit) const
205 frontend::NullPainter np;
206 PainterInfo pi(bv_, np);
207 drawParagraph(pi, pit, origin_.x_, par_metrics_[pit].position());
211 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
213 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
217 int TextMetrics::rightMargin(pit_type const pit) const
219 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
223 void TextMetrics::applyOuterFont(Font & font) const
225 FontInfo lf(font_.fontInfo());
226 lf.reduce(bv_->buffer().params().getFont().fontInfo());
227 font.fontInfo().realize(lf);
231 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
233 LASSERT(pos >= 0, { static Font f; return f; });
235 ParagraphList const & pars = text_->paragraphs();
236 Paragraph const & par = pars[pit];
237 Layout const & layout = par.layout();
238 Buffer const & buffer = bv_->buffer();
240 BufferParams const & params = buffer.params();
241 pos_type const body_pos = par.beginOfBody();
243 // We specialize the 95% common case:
244 if (!par.getDepth()) {
245 Font f = par.getFontSettings(params, pos);
246 if (!text_->isMainText())
248 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
250 FontInfo const & lf = lab ? layout.labelfont : layout.font;
251 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
253 // In case the default family has been customized
254 if (lf.family() == INHERIT_FAMILY)
255 rlf.setFamily(params.getFont().fontInfo().family());
256 f.fontInfo().realize(rlf);
260 // The uncommon case need not be optimized as much
261 FontInfo const & layoutfont = pos < body_pos ?
262 layout.labelfont : layout.font;
264 Font font = par.getFontSettings(params, pos);
265 font.fontInfo().realize(layoutfont);
267 if (!text_->isMainText())
268 applyOuterFont(font);
270 // Realize against environment font information
271 // NOTE: the cast to pit_type should be removed when pit_type
272 // changes to a unsigned integer.
273 if (pit < pit_type(pars.size()))
274 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
276 // Realize with the fonts of lesser depth.
277 font.fontInfo().realize(params.getFont().fontInfo());
283 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
289 if (boundary && sl.pos() > 0)
292 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
296 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
298 // no RTL boundary at paragraph start
302 Font const & left_font = displayFont(pit, pos - 1);
304 return isRTLBoundary(pit, pos, left_font);
308 // isRTLBoundary returns false on a real end-of-line boundary,
309 // because otherwise the two boundary types get mixed up.
310 // This is the whole purpose of this being in TextMetrics.
311 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
312 Font const & font) const
314 if (// no RTL boundary at paragraph start
316 // if the metrics have not been calculated, then we are not
317 // on screen and can safely ignore issues about boundaries.
321 ParagraphMetrics & pm = par_metrics_[pit];
322 // no RTL boundary in empty paragraph
323 if (pm.rows().empty())
326 pos_type endpos = pm.getRow(pos - 1, false).endpos();
327 pos_type startpos = pm.getRow(pos, false).pos();
328 // no RTL boundary at line start:
329 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
331 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
334 Paragraph const & par = text_->getPar(pit);
335 // no RTL boundary at line break:
336 // abc|\n -> move right -> abc\n (and not: abc\n|
338 if (startpos == pos && endpos == pos && endpos != par.size()
339 && (par.isNewline(pos - 1)
340 || par.isEnvSeparator(pos - 1)
341 || par.isLineSeparator(pos - 1)
342 || par.isSeparator(pos - 1)))
345 bool left = font.isVisibleRightToLeft();
347 if (pos == par.size())
348 right = par.isRTL(bv_->buffer().params());
350 right = displayFont(pit, pos).isVisibleRightToLeft();
352 return left != right;
356 bool TextMetrics::redoParagraph(pit_type const pit)
358 Paragraph & par = text_->getPar(pit);
359 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
360 // redoParagraph() recursively inside parMetrics.
361 Dimension old_dim = parMetrics(pit, false).dim();
362 ParagraphMetrics & pm = par_metrics_[pit];
365 Buffer & buffer = bv_->buffer();
366 bool changed = false;
368 // Check whether there are InsetBibItems that need fixing
369 // FIXME: This check ought to be done somewhere else. It is the reason
370 // why text_ is not const. But then, where else to do it?
371 // Well, how can you end up with either (a) a biblio environment that
372 // has no InsetBibitem or (b) a biblio environment with more than one
373 // InsetBibitem? I think the answer is: when paragraphs are merged;
374 // when layout is set; when material is pasted.
375 if (par.brokenBiblio()) {
376 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
377 // In some cases, we do not know how to record undo
378 if (&cur.inset() == &text_->inset())
379 cur.recordUndo(pit, pit);
381 int const moveCursor = par.fixBiblio(buffer);
383 // Is it necessary to update the cursor?
384 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
387 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
392 // Optimisation: this is used in the next two loops
393 // so better to calculate that once here.
394 int const right_margin = rightMargin(pm);
396 // iterator pointing to paragraph to resolve macros
397 DocIterator parPos = text_->macrocontextPosition();
401 LYXERR(Debug::INFO, "MacroContext not initialised!"
402 << " Going through the buffer again and hope"
403 << " the context is better then.");
404 // FIXME audit updateBuffer calls
405 // This should not be here, but it is not clear yet where else it
407 bv_->buffer().updateBuffer();
408 parPos = text_->macrocontextPosition();
409 LBUFERR(!parPos.empty());
414 par.setBeginOfBody();
415 Font const bufferfont = buffer.params().getFont();
416 CoordCache::Insets & insetCache = bv_->coordCache().insets();
417 InsetList::const_iterator ii = par.insetList().begin();
418 InsetList::const_iterator iend = par.insetList().end();
419 for (; ii != iend; ++ii) {
420 // FIXME Doesn't this HAVE to be non-empty?
421 // position already initialized?
422 if (!parPos.empty()) {
423 parPos.pos() = ii->pos;
425 // A macro template would normally not be visible
426 // by itself. But the tex macro semantics allow
427 // recursion, so we artifically take the context
428 // after the macro template to simulate this.
429 if (ii->inset->lyxCode() == MATHMACRO_CODE)
433 // If there is an end of paragraph marker, its size should be
434 // substracted to the available width. The logic here is
435 // almost the same as in breakRow, remember keep them in sync.
437 if (lyxrc.paragraph_markers && ii->pos + 1 == par.size()
438 && size_type(pit + 1) < text_->paragraphs().size()) {
439 Font f(text_->layoutFont(pit));
440 // ¶ U+00B6 PILCROW SIGN
441 eop = theFontMetrics(f).width(char_type(0x00B6));
444 // do the metric calculation
446 int const w = max_width_ - leftMargin(pit, ii->pos)
447 - right_margin - eop;
448 Font const & font = ii->inset->inheritFont() ?
449 displayFont(pit, ii->pos) : bufferfont;
450 MacroContext mc(&buffer, parPos);
451 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
452 ii->inset->metrics(mi, dim);
453 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
454 insetCache.add(ii->inset, dim);
460 size_t row_index = 0;
461 bool need_new_row = false;
462 // maximum pixel width of a row
464 if (row_index == pm.rows().size())
465 pm.rows().push_back(Row());
466 Row & row = pm.rows()[row_index];
470 need_new_row = breakRow(row, right_margin);
473 if (row_index || row.endpos() < par.size()
474 || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
475 /* If there is more than one row or the row has been
476 * broken by a display inset or a newline, expand the text
477 * to the full allowable width. This setting here is
478 * needed for the computeRowMetrics() below. In the case
479 * of a display inset, we do nothing when inside a table
480 * cell, because the tabular code is not prepared for
481 * that, and it triggers when using a caption in a
482 * longtable (see bugs #9945 and #9757).
484 if (dim_.wid < max_width_)
485 dim_.wid = max_width_;
487 int const max_row_width = max(dim_.wid, row.width());
488 computeRowMetrics(row, max_row_width);
489 first = row.endpos();
492 pm.dim().wid = max(pm.dim().wid, row.width());
493 pm.dim().des += row.height();
494 } while (first < par.size() || need_new_row);
496 if (row_index < pm.rows().size())
497 pm.rows().resize(row_index);
499 // FIXME: It might be better to move this in another method
500 // specially tailored for the main text.
501 // Top and bottom margin of the document (only at top-level)
502 if (text_->isMainText()) {
503 // original value was 20px, which is 0.2in at 100dpi
504 int const margin = bv_->zoomedPixels(20);
506 pm.rows().front().dimension().asc += margin;
507 /* coverity thinks that we should update pm.dim().asc
508 * below, but all the rows heights are actually counted as
509 * part of the paragraph metric descent see loop above).
511 // coverity[copy_paste_error]
512 pm.dim().des += margin;
514 ParagraphList const & pars = text_->paragraphs();
515 if (pit + 1 == pit_type(pars.size())) {
516 pm.rows().back().dimension().des += margin;
517 pm.dim().des += margin;
521 // The space above and below the paragraph.
522 int const top = parTopSpacing(pit);
523 pm.rows().front().dimension().asc += top;
524 int const bottom = parBottomSpacing(pit);
525 pm.rows().back().dimension().des += bottom;
526 pm.dim().des += top + bottom;
528 pm.dim().asc += pm.rows()[0].ascent();
529 pm.dim().des -= pm.rows()[0].ascent();
531 changed |= old_dim.height() != pm.dim().height();
537 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
539 LyXAlignment align = par.getAlign();
541 // handle alignment inside tabular cells
542 Inset const & owner = text_->inset();
543 bool forced_block = false;
544 switch (owner.contentAlignment()) {
545 case LYX_ALIGN_BLOCK:
546 // In general block align is the default state, but here it is
547 // an explicit choice. Therefore it should not be overridden
551 case LYX_ALIGN_CENTER:
553 case LYX_ALIGN_RIGHT:
554 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
555 align = owner.contentAlignment();
558 // unchanged (use align)
562 // Display-style insets should always be on a centered row
563 if (Inset const * inset = par.getInset(row.pos())) {
564 switch (inset->display()) {
565 case Inset::AlignLeft:
566 align = LYX_ALIGN_BLOCK;
568 case Inset::AlignCenter:
569 align = LYX_ALIGN_CENTER;
572 // unchanged (use align)
574 case Inset::AlignRight:
575 align = LYX_ALIGN_RIGHT;
580 if (align == LYX_ALIGN_BLOCK) {
581 // If this row has been broken abruptly by a display inset, or
582 // it is the end of the paragraph, or the user requested we
583 // not justify stuff, then don't stretch.
584 // A forced block alignment can only be overridden the 'no
585 // justification on screen' setting.
586 if ((row.flushed() && !forced_block)
587 || !bv_->buffer().params().justification)
588 align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
595 void TextMetrics::computeRowMetrics(Row & row, int width) const
600 Paragraph const & par = text_->getPar(row.pit());
602 int const w = width - row.right_margin - row.width();
603 // FIXME: put back this assertion when the crash on new doc is solved.
604 //LASSERT(w >= 0, /**/);
606 // is there a manual margin with a manual label
607 Layout const & layout = par.layout();
610 if (layout.margintype == MARGIN_MANUAL
611 && layout.labeltype == LABEL_MANUAL) {
612 /// We might have real hfills in the label part
613 nlh = numberOfLabelHfills(par, row);
615 // A manual label par (e.g. List) has an auto-hfill
616 // between the label text and the body of the
618 // But we don't want to do this auto hfill if the par
623 if (nlh && !par.getLabelWidthString().empty())
624 row.label_hfill = labelFill(row) / double(nlh);
627 // are there any hfills in the row?
628 ParagraphMetrics & pm = par_metrics_[row.pit()];
629 int nh = numberOfHfills(row, pm, par.beginOfBody());
633 // We don't have to look at the alignment if the row is already
634 // larger then the permitted width as then we force the
635 // LEFT_ALIGN'edness!
636 if (int(row.width()) >= max_width_)
640 // Common case : there is no hfill, and the alignment will be
642 switch (getAlign(par, row)) {
643 case LYX_ALIGN_BLOCK:
644 // Expand expanding characters by a total of w
645 if (!row.setExtraWidth(w) && row.isRTL()) {
646 // Justification failed and the text is RTL: align to the right
647 row.left_margin += w;
648 row.dimension().wid += w;
652 // a displayed inset that is flushed
653 if (Inset const * inset = par.getInset(row.pos())) {
654 row.left_margin += inset->indent(*bv_);
655 row.dimension().wid += inset->indent(*bv_);
658 case LYX_ALIGN_RIGHT:
659 if (Inset const * inset = par.getInset(row.pos())) {
660 int const new_w = max(w - inset->indent(*bv_), 0);
661 row.left_margin += new_w;
662 row.dimension().wid += new_w;
664 row.left_margin += w;
665 row.dimension().wid += w;
668 case LYX_ALIGN_CENTER:
669 row.dimension().wid += w / 2;
670 row.left_margin += w / 2;
673 case LYX_ALIGN_LAYOUT:
674 case LYX_ALIGN_SPECIAL:
675 case LYX_ALIGN_DECIMAL:
681 // Case nh > 0. There are hfill separators.
684 row.dimension().wid += w;
685 // Set size of hfill insets
686 pos_type const endpos = row.endpos();
687 pos_type body_pos = par.beginOfBody();
689 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
692 CoordCache::Insets & insetCache = bv_->coordCache().insets();
693 Row::iterator cit = row.begin();
694 Row::iterator const cend = row.end();
695 for ( ; cit != cend; ++cit) {
696 if (row.label_hfill && cit->endpos == body_pos
697 && cit->type == Row::SPACE)
698 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
699 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
700 if (cit->pos >= body_pos) {
701 cit->dim.wid += hfill;
704 cit->dim.wid += hfill_rem;
706 cit->dim.wid += int(row.label_hfill);
707 // Cache the inset dimension.
708 insetCache.add(cit->inset, cit->dim);
714 int TextMetrics::labelFill(Row const & row) const
716 Paragraph const & par = text_->getPar(row.pit());
717 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
720 Row::const_iterator cit = row.begin();
721 Row::const_iterator const end = row.end();
722 // iterate over elements before main body (except the last one,
723 // which is extra space).
724 while (cit!= end && cit->endpos < par.beginOfBody()) {
729 docstring const & label = par.params().labelWidthString();
733 FontMetrics const & fm
734 = theFontMetrics(text_->labelFont(par));
736 return max(0, fm.width(label) - w);
741 // Not used, see TextMetrics::breakRow
742 // this needs special handling - only newlines count as a break point
743 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
745 pos_type const end = par.size();
748 if (par.isNewline(i))
756 int TextMetrics::labelEnd(pit_type const pit) const
758 // labelEnd is only needed if the layout fills a flushleft label.
759 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
761 // return the beginning of the body
762 return leftMargin(pit);
768 * Calling Text::getFont is slow. While rebreaking we scan a
769 * paragraph from left to right calling getFont for every char. This
770 * simple class address this problem by hidding an optimization trick
771 * (not mine btw -AB): the font is reused in the whole font span. The
772 * class handles transparently the "hidden" (not part of the fontlist)
773 * label font (as getFont does).
779 FontIterator(TextMetrics const & tm,
780 Paragraph const & par, pit_type pit, pos_type pos)
781 : tm_(tm), par_(par), pit_(pit), pos_(pos),
782 font_(tm.displayFont(pit, pos)),
783 endspan_(par.fontSpan(pos).last),
784 bodypos_(par.beginOfBody())
788 Font const & operator*() const { return font_; }
791 FontIterator & operator++()
794 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
795 font_ = tm_.displayFont(pit_, pos_);
796 endspan_ = par_.fontSpan(pos_).last;
802 Font * operator->() { return &font_; }
806 TextMetrics const & tm_;
808 Paragraph const & par_;
823 /** This is the function where the hard work is done. The code here is
824 * very sensitive to small changes :) Note that part of the
825 * intelligence is also in Row::shortenIfNeeded.
827 bool TextMetrics::breakRow(Row & row, int const right_margin) const
829 Paragraph const & par = text_->getPar(row.pit());
830 pos_type const end = par.size();
831 pos_type const pos = row.pos();
832 pos_type const body_pos = par.beginOfBody();
833 bool const is_rtl = text_->isRTL(par);
834 bool need_new_row = false;
837 row.left_margin = leftMargin(row.pit(), pos);
838 row.right_margin = right_margin;
840 swap(row.left_margin, row.right_margin);
841 // Remember that the row width takes into account the left_margin
842 // but not the right_margin.
843 row.dimension().wid = row.left_margin;
844 // the width available for the row.
845 int const width = max_width_ - row.right_margin;
848 //FIXME: As long as leftMargin() is not correctly implemented for
849 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
850 // Otherwise, long rows will be painted off the screen.
851 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
852 return addressBreakPoint(pos, par);
855 // check for possible inline completion
856 DocIterator const & ic_it = bv_->inlineCompletionPos();
857 pos_type ic_pos = -1;
858 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
859 ic_pos = ic_it.pos();
861 // Now we iterate through until we reach the right margin
862 // or the end of the par, then build a representation of the row.
864 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
865 while (i < end && (i == pos || row.width() <= width)) {
866 char_type c = par.getChar(i);
867 // The most special cases are handled first.
868 if (par.isInset(i)) {
869 Inset const * ins = par.getInset(i);
870 Dimension dim = bv_->coordCache().insets().dim(ins);
871 row.add(i, ins, dim, *fi, par.lookupChange(i));
872 } else if (c == ' ' && i + 1 == body_pos) {
873 // There is a space at i, but it should not be
874 // added as a separator, because it is just
875 // before body_pos. Instead, insert some spacing to
877 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
878 // this is needed to make sure that the row width is correct
880 int const add = max(fm.width(par.layout().labelsep),
881 labelEnd(row.pit()) - row.width());
882 row.addSpace(i, add, *fi, par.lookupChange(i));
883 } else if (c == '\t')
884 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
885 *fi, par.lookupChange(i));
886 else if (c == 0x2028 || c == 0x2029) {
888 * U+2028 LINE SEPARATOR
889 * U+2029 PARAGRAPH SEPARATOR
891 * These are special unicode characters that break
892 * lines/pragraphs. Not handling them lead to trouble wrt
893 * Qt QTextLayout formatting. We add a visible character
894 * on screen so that the user can see that something is
898 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
899 // ¶ U+00B6 PILCROW SIGN
900 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
901 row.add(i, screen_char, *fi, par.lookupChange(i));
903 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
904 // see also Paragraph::getUChar.
905 if (fi->language()->lang() == "hebrew") {
911 row.add(i, c, *fi, par.lookupChange(i));
914 // add inline completion width
915 // draw logically behind the previous character
916 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
917 docstring const comp = bv_->inlineCompletion();
918 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
922 f.fontInfo().setColor(Color_inlinecompletion);
923 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
925 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
926 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
929 // Handle some situations that abruptly terminate the row
931 // - Before a display inset
932 // - After a display inset
933 Inset const * inset = 0;
934 if (par.isNewline(i) || par.isEnvSeparator(i)
935 || (i + 1 < end && (inset = par.getInset(i + 1))
937 || (!row.empty() && row.back().inset
938 && row.back().inset->display())) {
940 need_new_row = par.isNewline(i);
951 // End of paragraph marker. The logic here is almost the
952 // same as in redoParagraph, remember keep them in sync.
953 ParagraphList const & pars = text_->paragraphs();
954 if (lyxrc.paragraph_markers && !need_new_row
955 && i == end && size_type(row.pit() + 1) < pars.size()) {
956 // add a virtual element for the end-of-paragraph
957 // marker; it is shown on screen, but does not exist
959 Font f(text_->layoutFont(row.pit()));
960 f.fontInfo().setColor(Color_paragraphmarker);
961 BufferParams const & bparams
962 = text_->inset().buffer().params();
963 f.setLanguage(par.getParLanguage(bparams));
964 // ¶ U+00B6 PILCROW SIGN
965 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
968 // Is there a end-of-paragaph change?
969 if (i == end && par.lookupChange(end).changed() && !need_new_row)
970 row.needsChangeBar(true);
972 // if the row is too large, try to cut at last separator. In case
973 // of success, reset indication that the row was broken abruptly.
974 int const next_width = max_width_ - leftMargin(row.pit(), row.endpos())
975 - rightMargin(row.pit());
977 if (row.shortenIfNeeded(body_pos, width, next_width))
979 row.right_boundary(!row.empty() && row.endpos() < end
980 && row.back().endpos == row.endpos());
981 // Last row in paragraph is flushed
982 if (row.endpos() == end)
985 // make sure that the RTL elements are in reverse ordering
986 row.reverseRTL(is_rtl);
987 //LYXERR0("breakrow: row is " << row);
992 int TextMetrics::parTopSpacing(pit_type const pit) const
994 Paragraph const & par = text_->getPar(pit);
995 Layout const & layout = par.layout();
998 ParagraphList const & pars = text_->paragraphs();
999 double const dh = defaultRowHeight();
1001 BufferParams const & bparams = bv_->buffer().params();
1002 Inset const & inset = text_->inset();
1003 // some parskips VERY EASY IMPLEMENTATION
1004 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1005 && !inset.getLayout().parbreakIsNewline()
1006 && !par.layout().parbreak_is_newline
1008 && ((layout.isParagraph() && par.getDepth() == 0)
1009 || (pars[pit - 1].layout().isParagraph()
1010 && pars[pit - 1].getDepth() == 0))) {
1011 asc += bparams.getDefSkip().inPixels(*bv_);
1014 if (par.params().startOfAppendix())
1017 // special code for the top label
1018 if (layout.labelIsAbove()
1019 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1020 && !par.labelString().empty()) {
1021 FontInfo labelfont = text_->labelFont(par);
1022 FontMetrics const & lfm = theFontMetrics(labelfont);
1023 asc += int(lfm.maxHeight() * layout.spacing.getValue()
1024 * text_->spacing(par)
1025 + (layout.topsep + layout.labelbottomsep) * dh);
1028 // Add the layout spaces, for example before and after
1029 // a section, or between the items of a itemize or enumerate
1032 pit_type prev = text_->depthHook(pit, par.getDepth());
1033 Paragraph const & prevpar = pars[prev];
1034 double layoutasc = 0;
1036 && prevpar.layout() == layout
1037 && prevpar.getDepth() == par.getDepth()
1038 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1039 layoutasc = layout.itemsep * dh;
1040 } else if (pit != 0 && layout.topsep > 0)
1041 layoutasc = layout.topsep * dh;
1043 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1045 prev = text_->outerHook(pit);
1046 if (prev != pit_type(pars.size())) {
1047 asc += int(pars[prev].layout().parsep * dh);
1048 } else if (pit != 0) {
1049 Paragraph const & prevpar2 = pars[pit - 1];
1050 if (prevpar2.getDepth() != 0 || prevpar2.layout() == layout)
1051 asc += int(layout.parsep * dh);
1058 int TextMetrics::parBottomSpacing(pit_type const pit) const
1060 double layoutdesc = 0;
1061 ParagraphList const & pars = text_->paragraphs();
1062 double const dh = defaultRowHeight();
1064 // add the layout spaces, for example before and after
1065 // a section, or between the items of a itemize or enumerate
1067 pit_type nextpit = pit + 1;
1068 if (nextpit != pit_type(pars.size())) {
1069 pit_type cpit = pit;
1071 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1072 double usual = pars[cpit].layout().bottomsep * dh;
1074 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1075 if (pars[cpit].layout() != pars[nextpit].layout()
1076 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1077 unusual = pars[cpit].layout().bottomsep * dh;
1078 layoutdesc = max(unusual, usual);
1079 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1080 if (pars[cpit].layout() != pars[nextpit].layout()
1081 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1082 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1086 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1090 void TextMetrics::setRowHeight(Row & row) const
1092 Paragraph const & par = text_->getPar(row.pit());
1093 Layout const & layout = par.layout();
1094 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1096 // Initial value for ascent (useful if row is empty).
1097 Font const font = displayFont(row.pit(), row.pos());
1098 FontMetrics const & fm = theFontMetrics(font);
1099 int maxasc = int(fm.maxAscent() * spacing_val);
1100 int maxdes = int(fm.maxDescent() * spacing_val);
1102 // Find the ascent/descent of the row contents
1103 Row::const_iterator cit = row.begin();
1104 Row::const_iterator cend = row.end();
1105 for ( ; cit != cend; ++cit) {
1107 maxasc = max(maxasc, cit->dim.ascent());
1108 maxdes = max(maxdes, cit->dim.descent());
1110 FontMetrics const & fm2 = theFontMetrics(cit->font);
1111 maxasc = max(maxasc, int(fm2.maxAscent() * spacing_val));
1112 maxdes = max(maxdes, int(fm2.maxDescent() * spacing_val));
1116 // This is nicer with box insets
1120 row.dimension().asc = maxasc;
1121 row.dimension().des = maxdes;
1125 // x is an absolute screen coord
1126 // returns the column near the specified x-coordinate of the row
1127 // x is set to the real beginning of this column
1128 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1129 bool & boundary) const
1131 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1132 /// For the main Text, it is possible that this pit is not
1133 /// yet in the CoordCache when moving cursor up.
1134 /// x Paragraph coordinate is always 0 for main text anyway.
1135 int const xo = origin_.x_;
1138 // Adapt to cursor row scroll offset if applicable.
1139 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1142 pos_type pos = row.pos();
1145 x = row.left_margin;
1146 else if (x <= row.left_margin) {
1147 pos = row.front().left_pos();
1148 x = row.left_margin;
1149 } else if (x >= row.width()) {
1150 pos = row.back().right_pos();
1153 double w = row.left_margin;
1154 Row::const_iterator cit = row.begin();
1155 Row::const_iterator cend = row.end();
1156 for ( ; cit != cend; ++cit) {
1157 if (w <= x && w + cit->full_width() > x) {
1158 int x_offset = int(x - w);
1159 pos = cit->x2pos(x_offset);
1160 x = int(x_offset + w);
1163 w += cit->full_width();
1165 if (cit == row.end()) {
1166 pos = row.back().right_pos();
1169 /** This tests for the case where the cursor is placed
1170 * just before a font direction change. See comment on
1171 * the boundary_ member in DocIterator.h to understand
1172 * how boundary helps here.
1174 else if (pos == cit->endpos
1175 && ((!cit->isRTL() && cit + 1 != row.end()
1176 && (cit + 1)->isRTL())
1177 || (cit->isRTL() && cit != row.begin()
1178 && !(cit - 1)->isRTL())))
1182 /** This tests for the case where the cursor is set at the end
1183 * of a row which has been broken due something else than a
1184 * separator (a display inset or a forced breaking of the
1185 * row). We know that there is a separator when the end of the
1186 * row is larger than the end of its last element.
1188 if (!row.empty() && pos == row.back().endpos
1189 && row.back().endpos == row.endpos()) {
1190 Inset const * inset = row.back().inset;
1191 if (inset && (inset->lyxCode() == NEWLINE_CODE
1192 || inset->lyxCode() == SEPARATOR_CODE))
1193 pos = row.back().pos;
1195 boundary = row.right_boundary();
1199 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1205 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1207 // We play safe and use parMetrics(pit) to make sure the
1208 // ParagraphMetrics will be redone and OK to use if needed.
1209 // Otherwise we would use an empty ParagraphMetrics in
1210 // upDownInText() while in selection mode.
1211 ParagraphMetrics const & pm = parMetrics(pit);
1213 LBUFERR(row < int(pm.rows().size()));
1215 Row const & r = pm.rows()[row];
1216 return getPosNearX(r, x, bound);
1220 void TextMetrics::newParMetricsDown()
1222 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1223 pit_type const pit = last.first + 1;
1224 if (pit == int(text_->paragraphs().size()))
1227 // do it and update its position.
1229 par_metrics_[pit].setPosition(last.second.position()
1230 + last.second.descent() + par_metrics_[pit].ascent());
1231 updatePosCache(pit);
1235 void TextMetrics::newParMetricsUp()
1237 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1238 if (first.first == 0)
1241 pit_type const pit = first.first - 1;
1242 // do it and update its position.
1244 par_metrics_[pit].setPosition(first.second.position()
1245 - first.second.ascent() - par_metrics_[pit].descent());
1246 updatePosCache(pit);
1249 // y is screen coordinate
1250 pit_type TextMetrics::getPitNearY(int y)
1252 LASSERT(!text_->paragraphs().empty(), return -1);
1253 LASSERT(!par_metrics_.empty(), return -1);
1254 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1256 // look for highest numbered paragraph with y coordinate less than given y
1259 ParMetricsCache::const_iterator it = par_metrics_.begin();
1260 ParMetricsCache::const_iterator et = par_metrics_.end();
1261 ParMetricsCache::const_iterator last = et;
1264 ParagraphMetrics const & pm = it->second;
1266 if (y < it->second.position() - int(pm.ascent())) {
1267 // We are looking for a position that is before the first paragraph in
1268 // the cache (which is in priciple off-screen, that is before the
1271 // We are already at the first paragraph in the inset.
1273 // OK, this is the paragraph we are looking for.
1274 pit = it->first - 1;
1279 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1281 if (y >= last->second.position() + int(pm_last.descent())) {
1282 // We are looking for a position that is after the last paragraph in
1283 // the cache (which is in priciple off-screen), that is before the
1285 pit = last->first + 1;
1286 if (pit == int(text_->paragraphs().size()))
1287 // We are already at the last paragraph in the inset.
1289 // OK, this is the paragraph we are looking for.
1290 newParMetricsDown();
1294 for (; it != et; ++it) {
1295 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1296 << " y: " << it->second.position());
1298 ParagraphMetrics const & pm2 = par_metrics_[it->first];
1300 if (it->first >= pit && int(it->second.position()) - int(pm2.ascent()) <= y) {
1302 yy = it->second.position();
1306 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1312 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1313 bool assert_in_view, bool up)
1315 ParagraphMetrics const & pm = par_metrics_[pit];
1317 int yy = pm.position() - pm.ascent();
1318 LBUFERR(!pm.rows().empty());
1319 RowList::const_iterator rit = pm.rows().begin();
1320 RowList::const_iterator rlast = pm.rows().end();
1322 for (; rit != rlast; yy += rit->height(), ++rit)
1323 if (yy + rit->height() > y)
1326 if (assert_in_view) {
1327 if (!up && yy + rit->height() > y) {
1328 if (rit != pm.rows().begin()) {
1331 } else if (pit != 0) {
1334 ParagraphMetrics const & pm2 = par_metrics_[pit];
1335 rit = pm2.rows().end();
1339 } else if (up && yy != y) {
1341 y = yy + rit->height();
1343 } else if (pit < int(text_->paragraphs().size()) - 1) {
1345 newParMetricsDown();
1346 ParagraphMetrics const & pm2 = par_metrics_[pit];
1347 rit = pm2.rows().begin();
1356 // x,y are absolute screen coordinates
1357 // sets cursor recursively descending into nested editable insets
1358 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1359 bool assert_in_view, bool up)
1361 if (lyxerr.debugging(Debug::WORKAREA)) {
1362 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1363 cur.bv().coordCache().dump();
1365 pit_type pit = getPitNearY(y);
1366 LASSERT(pit != -1, return 0);
1367 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1370 // Do we cover an inset?
1371 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1374 // No inset, set position in the text
1375 bool bound = false; // is modified by getPosNearX
1376 cur.pos() = getPosNearX(row, x, bound);
1377 cur.boundary(bound);
1378 cur.setCurrentFont();
1383 Inset * inset = it->inset;
1384 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1386 // Set position in front of inset
1387 cur.pos() = it->pos;
1388 cur.boundary(false);
1391 // Try to descend recursively inside the inset.
1392 Inset * edited = inset->editXY(cur, x, y);
1393 // FIXME: it is not clear that the test on position is needed
1394 // Remove it if/when semantics of editXY is clarified
1395 if (cur.text() == text_ && cur.pos() == it->pos) {
1396 // non-editable inset, set cursor after the inset if x is
1397 // nearer to that position (bug 9628)
1398 bool bound = false; // is modified by getPosNearX
1399 cur.pos() = getPosNearX(row, x, bound);
1400 cur.boundary(bound);
1401 cur.setCurrentFont();
1405 if (cur.top().text() == text_)
1406 cur.setCurrentFont();
1411 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1413 LASSERT(text_ == cur.text(), return);
1414 pit_type const pit = getPitNearY(y);
1415 LASSERT(pit != -1, return);
1417 ParagraphMetrics const & pm = par_metrics_[pit];
1419 int yy = pm.position() - pm.ascent();
1420 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1421 " pit: " << pit << " yy: " << yy);
1424 LBUFERR(pm.rows().size());
1425 for (; r < int(pm.rows().size()) - 1; ++r) {
1426 Row const & row = pm.rows()[r];
1427 if (int(yy + row.height()) > y)
1432 Row const & row = pm.rows()[r];
1434 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1438 pos_type const pos = getPosNearX(row, xx, bound);
1440 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1442 text_->setCursor(cur, pit, pos, true, bound);
1443 // remember new position.
1448 //takes screen x,y coordinates
1449 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1451 Paragraph const & par = text_->paragraphs()[pit];
1452 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1454 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1456 for (auto const & it : par.insetList()) {
1457 LYXERR(Debug::DEBUG, "examining inset " << it.inset);
1459 if (insetCache.covers(it.inset, x, y)) {
1460 LYXERR(Debug::DEBUG, "Hit inset: " << it.inset);
1461 return const_cast<InsetList::InsetTable *>(&it);
1465 LYXERR(Debug::DEBUG, "No inset hit. ");
1470 //takes screen x,y coordinates
1471 Inset * TextMetrics::checkInsetHit(int x, int y)
1473 pit_type const pit = getPitNearY(y);
1474 LASSERT(pit != -1, return 0);
1475 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1484 int TextMetrics::cursorX(CursorSlice const & sl,
1485 bool boundary) const
1487 LASSERT(sl.text() == text_, return 0);
1489 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1490 if (pm.rows().empty())
1492 Row const & row = pm.getRow(sl.pos(), boundary);
1493 pos_type const pos = sl.pos();
1496 row.findElement(pos, boundary, x);
1502 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1504 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1505 ParagraphMetrics const & pm = parMetrics(sl.pit());
1506 if (pm.rows().empty())
1510 h -= parMetrics(0).rows()[0].ascent();
1511 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1512 h += parMetrics(pit).height();
1515 if (pos && boundary)
1517 size_t const rend = pm.pos2row(pos);
1518 for (size_t rit = 0; rit != rend; ++rit)
1519 h += pm.rows()[rit].height();
1520 h += pm.rows()[rend].ascent();
1525 // the cursor set functions have a special mechanism. When they
1526 // realize you left an empty paragraph, they will delete it.
1528 bool TextMetrics::cursorHome(Cursor & cur)
1530 LASSERT(text_ == cur.text(), return false);
1531 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1532 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1533 return text_->setCursor(cur, cur.pit(), row.pos());
1537 bool TextMetrics::cursorEnd(Cursor & cur)
1539 LASSERT(text_ == cur.text(), return false);
1540 // if not on the last row of the par, put the cursor before
1541 // the final space exept if I have a spanning inset or one string
1542 // is so long that we force a break.
1543 pos_type end = cur.textRow().endpos();
1545 // empty text, end-1 is no valid position
1547 bool boundary = false;
1548 if (end != cur.lastpos()) {
1549 if (!cur.paragraph().isLineSeparator(end-1)
1550 && !cur.paragraph().isNewline(end-1)
1551 && !cur.paragraph().isEnvSeparator(end-1))
1555 } else if (cur.paragraph().isEnvSeparator(end-1))
1557 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1561 void TextMetrics::deleteLineForward(Cursor & cur)
1563 LASSERT(text_ == cur.text(), return);
1564 if (cur.lastpos() == 0) {
1565 // Paragraph is empty, so we just go forward
1566 text_->cursorForward(cur);
1569 cur.selection(true); // to avoid deletion
1572 // What is this test for ??? (JMarc)
1573 if (!cur.selection())
1574 text_->deleteWordForward(cur);
1576 cap::cutSelection(cur, true, false);
1577 cur.checkBufferStructure();
1582 bool TextMetrics::isLastRow(Row const & row) const
1584 ParagraphList const & pars = text_->paragraphs();
1585 return row.endpos() >= pars[row.pit()].size()
1586 && row.pit() + 1 == pit_type(pars.size());
1590 bool TextMetrics::isFirstRow(Row const & row) const
1592 return row.pos() == 0 && row.pit() == 0;
1596 int TextMetrics::leftMargin(pit_type pit) const
1598 return leftMargin(pit, text_->paragraphs()[pit].size());
1602 int TextMetrics::leftMargin(pit_type const pit, pos_type const pos) const
1604 ParagraphList const & pars = text_->paragraphs();
1606 LASSERT(pit >= 0, return 0);
1607 LASSERT(pit < int(pars.size()), return 0);
1608 Paragraph const & par = pars[pit];
1609 LASSERT(pos >= 0, return 0);
1610 LASSERT(pos <= par.size(), return 0);
1611 Buffer const & buffer = bv_->buffer();
1612 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1613 DocumentClass const & tclass = buffer.params().documentClass();
1614 Layout const & layout = par.layout();
1615 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1617 docstring parindent = layout.parindent;
1621 if (text_->isMainText())
1622 l_margin += bv_->leftMargin();
1624 l_margin += bfm.signedWidth(tclass.leftmargin());
1626 int depth = par.getDepth();
1628 // find the next level paragraph
1629 pit_type newpar = text_->outerHook(pit);
1630 if (newpar != pit_type(pars.size())) {
1631 if (pars[newpar].layout().isEnvironment()) {
1632 int nestmargin = depth * nestMargin();
1633 if (text_->isMainText())
1634 nestmargin += changebarMargin();
1635 l_margin = max(leftMargin(newpar), nestmargin);
1636 // Remove the parindent that has been added
1637 // if the paragraph was empty.
1638 if (pars[newpar].empty() &&
1639 buffer.params().paragraph_separation ==
1640 BufferParams::ParagraphIndentSeparation) {
1641 docstring pi = pars[newpar].layout().parindent;
1642 l_margin -= bfm.signedWidth(pi);
1645 if (tclass.isDefaultLayout(par.layout())
1646 || tclass.isPlainLayout(par.layout())) {
1647 if (pars[newpar].params().noindent())
1650 parindent = pars[newpar].layout().parindent;
1655 // This happens after sections or environments in standard classes.
1656 // We have to check the previous layout at same depth.
1657 if (buffer.params().paragraph_separation ==
1658 BufferParams::ParagraphSkipSeparation)
1660 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1661 pit_type prev = text_->depthHook(pit, par.getDepth());
1662 if (par.layout() == pars[prev].layout()) {
1664 && pars[pit - 1].layout().nextnoindent)
1666 } else if (pars[prev].layout().nextnoindent)
1670 FontInfo const labelfont = text_->labelFont(par);
1671 FontMetrics const & lfm = theFontMetrics(labelfont);
1673 switch (layout.margintype) {
1674 case MARGIN_DYNAMIC:
1675 if (!layout.leftmargin.empty()) {
1676 l_margin += bfm.signedWidth(layout.leftmargin);
1678 if (!par.labelString().empty()) {
1679 l_margin += lfm.signedWidth(layout.labelindent);
1680 l_margin += lfm.width(par.labelString());
1681 l_margin += lfm.width(layout.labelsep);
1685 case MARGIN_MANUAL: {
1686 l_margin += lfm.signedWidth(layout.labelindent);
1687 // The width of an empty par, even with manual label, should be 0
1688 if (!par.empty() && pos >= par.beginOfBody()) {
1689 if (!par.getLabelWidthString().empty()) {
1690 docstring labstr = par.getLabelWidthString();
1691 l_margin += lfm.width(labstr);
1692 l_margin += lfm.width(layout.labelsep);
1698 case MARGIN_STATIC: {
1699 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1700 / (par.getDepth() + 4);
1704 case MARGIN_FIRST_DYNAMIC:
1705 if (layout.labeltype == LABEL_MANUAL) {
1706 // if we are at position 0, we are never in the body
1707 if (pos > 0 && pos >= par.beginOfBody())
1708 l_margin += lfm.signedWidth(layout.leftmargin);
1710 l_margin += lfm.signedWidth(layout.labelindent);
1712 // Special case to fix problems with
1714 || (layout.labeltype == LABEL_STATIC
1715 && layout.latextype == LATEX_ENVIRONMENT
1716 && !text_->isFirstInSequence(pit))) {
1717 l_margin += lfm.signedWidth(layout.leftmargin);
1718 } else if (!layout.labelIsAbove()) {
1719 l_margin += lfm.signedWidth(layout.labelindent);
1720 l_margin += lfm.width(layout.labelsep);
1721 l_margin += lfm.width(par.labelString());
1725 case MARGIN_RIGHT_ADDRESS_BOX: {
1727 // The left margin depends on the widest row in this paragraph.
1728 // This code is wrong because it depends on the rows, but at the
1729 // same time this function is used in redoParagraph to construct
1731 ParagraphMetrics const & pm = par_metrics_[pit];
1732 RowList::const_iterator rit = pm.rows().begin();
1733 RowList::const_iterator end = pm.rows().end();
1734 int minfill = max_width_;
1735 for ( ; rit != end; ++rit)
1736 if (rit->fill() < minfill)
1737 minfill = rit->fill();
1738 l_margin += bfm.signedWidth(layout.leftmargin);
1739 l_margin += minfill;
1741 // also wrong, but much shorter.
1742 l_margin += max_width_ / 2;
1747 if (!par.params().leftIndent().zero())
1748 l_margin += par.params().leftIndent().inPixels(max_width_, lfm.em());
1750 LyXAlignment align = par.getAlign();
1752 // set the correct parindent
1754 && (layout.labeltype == LABEL_NO_LABEL
1755 || layout.labeltype == LABEL_ABOVE
1756 || layout.labeltype == LABEL_CENTERED
1757 || (layout.labeltype == LABEL_STATIC
1758 && layout.latextype == LATEX_ENVIRONMENT
1759 && !text_->isFirstInSequence(pit)))
1760 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1761 && !par.params().noindent()
1762 // in some insets, paragraphs are never indented
1763 && !text_->inset().neverIndent()
1764 // display style insets are always centered, omit indentation
1767 && par.getInset(pos)->display())
1768 && (!(tclass.isDefaultLayout(par.layout())
1769 || tclass.isPlainLayout(par.layout()))
1770 || buffer.params().paragraph_separation
1771 == BufferParams::ParagraphIndentSeparation)) {
1772 /* use the parindent of the layout when the default
1773 * indentation is used otherwise use the indentation set in
1774 * the document settings
1776 if (buffer.params().getParIndent().empty())
1777 l_margin += bfm.signedWidth(parindent);
1779 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
1786 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1788 if (par_metrics_.empty())
1794 ParMetricsCache::iterator it = par_metrics_.begin();
1795 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1796 y -= it->second.ascent();
1797 for (; it != pm_end; ++it) {
1798 ParagraphMetrics const & pmi = it->second;
1800 pit_type const pit = it->first;
1801 // Save the paragraph position in the cache.
1802 it->second.setPosition(y);
1803 drawParagraph(pi, pit, x, y);
1809 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1811 ParagraphMetrics const & pm = par_metrics_[pit];
1812 if (pm.rows().empty())
1814 size_t const nrows = pm.rows().size();
1816 // Use fast lane in nodraw stage.
1817 if (pi.pain.isNull()) {
1818 for (size_t i = 0; i != nrows; ++i) {
1820 Row const & row = pm.rows()[i];
1821 // Adapt to cursor row scroll offset if applicable.
1822 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1826 RowPainter rp(pi, *text_, row, row_x, y);
1828 rp.paintOnlyInsets();
1834 int const ww = bv_->workHeight();
1835 Cursor const & cur = bv_->cursor();
1836 DocIterator sel_beg = cur.selectionBegin();
1837 DocIterator sel_end = cur.selectionEnd();
1838 bool selection = cur.selection()
1839 // This is our text.
1840 && cur.text() == text_
1841 // if the anchor is outside, this is not our selection
1842 && cur.normalAnchor().text() == text_
1843 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1845 // We store the begin and end pos of the selection relative to this par
1846 DocIterator sel_beg_par = cur.selectionBegin();
1847 DocIterator sel_end_par = cur.selectionEnd();
1849 // We care only about visible selection.
1851 if (pit != sel_beg.pit()) {
1852 sel_beg_par.pit() = pit;
1853 sel_beg_par.pos() = 0;
1855 if (pit != sel_end.pit()) {
1856 sel_end_par.pit() = pit;
1857 sel_end_par.pos() = sel_end_par.lastpos();
1861 for (size_t i = 0; i != nrows; ++i) {
1863 Row const & row = pm.rows()[i];
1864 // Adapt to cursor row scroll offset if applicable.
1865 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1869 // It is not needed to draw on screen if we are not inside.
1870 bool const inside = (y + row.descent() >= 0
1871 && y - row.ascent() < ww);
1873 // Inset positions have already been set in nodraw stage.
1879 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1881 row.clearSelectionAndMargins();
1883 // The row knows nothing about the paragraph, so we have to check
1884 // whether this row is the first or last and update the margins.
1885 if (row.selection()) {
1886 if (row.sel_beg == 0)
1887 row.change(row.begin_margin_sel, sel_beg.pit() < pit);
1888 if (row.sel_end == sel_end_par.lastpos())
1889 row.change(row.end_margin_sel, sel_end.pit() > pit);
1892 // has row changed since last paint?
1893 bool row_has_changed = row.changed()
1894 || bv_->hadHorizScrollOffset(text_, pit, row.pos())
1895 || bv_->needRepaint(text_, row);
1897 // Take this opportunity to spellcheck the row contents.
1898 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1899 text_->getPar(pit).spellCheck();
1902 RowPainter rp(pi, *text_, row, row_x, y);
1904 // Don't paint the row if a full repaint has not been requested
1905 // and if it has not changed.
1906 if (!pi.full_repaint && !row_has_changed) {
1907 // Paint only the insets if the text itself is
1909 rp.paintOnlyInsets();
1915 // Clear background of this row if paragraph background was not
1916 // already cleared because of a full repaint.
1917 if (!pi.full_repaint && row_has_changed) {
1918 LYXERR(Debug::PAINTING, "Clear rect@("
1919 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1920 << width() << " x " << row.height());
1921 // FIXME: this is a hack. We know that at least this
1922 // amount of pixels can be cleared on right and left.
1923 // Doing so gets rid of caret ghosts when the cursor is at
1924 // the begining/end of row. However, it will not work if
1925 // the caret has a ridiculous width like 6. (see ticket
1927 pi.pain.fillRectangle(max(row_x, 0) - Inset::TEXT_TO_INSET_OFFSET,
1929 width() + 2 * Inset::TEXT_TO_INSET_OFFSET,
1930 row.height(), pi.background_color);
1933 // Instrumentation for testing row cache (see also
1935 if (lyxerr.debugging(Debug::PAINTING)
1936 && (row.selection() || pi.full_repaint || row_has_changed)) {
1937 string const foreword = text_->isMainText() ? "main text redraw "
1938 : "inset text redraw: ";
1939 LYXERR0(foreword << "pit=" << pit << " row=" << i
1940 << (row.selection() ? " row_selection": "")
1941 << (pi.full_repaint ? " full_repaint" : "")
1942 << (row_has_changed ? " row_has_changed" : ""));
1945 // Backup full_repaint status and force full repaint
1946 // for inner insets as the Row has been cleared out.
1947 bool tmp = pi.full_repaint;
1948 pi.full_repaint = true;
1950 rp.paintSelection();
1953 if (row.needsChangeBar())
1954 rp.paintChangeBar();
1955 if (i == 0 && !row.isRTL())
1957 if (i == nrows - 1 && row.isRTL())
1960 if (i == nrows - 1 && !row.isRTL())
1962 if (i == 0 && row.isRTL())
1964 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1965 row_x + row.right_x() > bv_->workWidth());
1969 // This debug code shows on screen which rows are repainted.
1970 // FIXME: since the updates related to caret blinking restrict
1971 // the painter to a small rectangle, the numbers are not
1972 // updated when this happens. Change the code in
1973 // GuiWorkArea::Private::show/hideCaret if this is important.
1974 static int count = 0;
1976 FontInfo fi(sane_font);
1977 fi.setSize(FONT_SIZE_TINY);
1978 fi.setColor(Color_red);
1979 pi.pain.text(row_x, y, convert<docstring>(count), fi);
1982 // Restore full_repaint status.
1983 pi.full_repaint = tmp;
1988 //LYXERR(Debug::PAINTING, ".");
1992 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1993 Dimension & dim) const
1995 Cursor const & bvcur = cur.bv().cursor();
1997 // get word in front of cursor
1998 docstring word = text_->previousWord(bvcur.top());
1999 DocIterator wordStart = bvcur;
2000 wordStart.pos() -= word.length();
2002 // calculate dimensions of the word
2004 row.pit(bvcur.pit());
2005 row.pos(wordStart.pos());
2006 row.endpos(bvcur.pos());
2008 dim = row.dimension();
2010 // get position on screen of the word start and end
2011 //FIXME: Is it necessary to explicitly set this to false?
2012 wordStart.boundary(false);
2013 Point lxy = cur.bv().getPos(wordStart);
2014 Point rxy = cur.bv().getPos(bvcur);
2015 dim.wid = abs(rxy.x_ - lxy.x_);
2017 // calculate position of word
2019 x = min(rxy.x_, lxy.x_);
2021 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2022 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2025 int defaultRowHeight()
2027 return int(theFontMetrics(sane_font).maxHeight() * 1.2);