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/MathMacroTemplate.h"
44 #include "frontends/FontMetrics.h"
45 #include "frontends/Painter.h"
47 #include "support/debug.h"
48 #include "support/lassert.h"
58 using frontend::FontMetrics;
63 int numberOfLabelHfills(Paragraph const & par, Row const & row)
65 pos_type last = row.endpos() - 1;
66 pos_type first = row.pos();
68 // hfill *DO* count at the beginning of paragraphs!
70 while (first < last && par.isHfill(first))
74 last = min(last, par.beginOfBody());
76 for (pos_type p = first; p < last; ++p) {
83 // FIXME: this needs to be rewritten, probably by merging it into some
84 // code that, besides counting, sets the active status of the space
85 // inset in the row element.
86 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
87 pos_type const body_pos)
90 Row::const_iterator cit = row.begin();
91 Row::const_iterator const end = row.end();
92 for ( ; cit != end ; ++cit)
93 if (cit->pos >= body_pos
94 && cit->inset && pm.hfillExpansion(row, cit->pos))
102 /////////////////////////////////////////////////////////////////////
106 /////////////////////////////////////////////////////////////////////
109 TextMetrics::TextMetrics(BufferView * bv, Text * text)
110 : bv_(bv), text_(text)
113 max_width_ = bv_->workWidth();
114 dim_.wid = max_width_;
120 bool TextMetrics::contains(pit_type pit) const
122 return par_metrics_.find(pit) != par_metrics_.end();
126 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
128 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
133 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
135 ParMetricsCache::const_iterator it = par_metrics_.begin();
136 return make_pair(it->first, &it->second);
140 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
142 LBUFERR(!par_metrics_.empty());
143 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
144 return make_pair(it->first, &it->second);
148 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
150 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
151 if (pmc_it == par_metrics_.end()) {
152 pmc_it = par_metrics_.insert(
153 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
155 if (pmc_it->second.rows().empty() && redo)
157 return pmc_it->second;
161 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
163 LBUFERR(mi.base.textwidth > 0);
164 max_width_ = mi.base.textwidth;
165 // backup old dimension.
166 Dimension const old_dim = dim_;
169 dim_.wid = min_width;
170 pit_type const npar = text_->paragraphs().size();
172 // If there is more than one row, expand the text to
173 // the full allowable width.
174 dim_.wid = max_width_;
176 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
177 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
179 bool changed = false;
181 for (pit_type pit = 0; pit != npar; ++pit) {
182 changed |= redoParagraph(pit);
183 ParagraphMetrics const & pm = par_metrics_[pit];
185 if (dim_.wid < pm.width())
186 dim_.wid = pm.width();
189 dim_.asc = par_metrics_[0].ascent();
190 dim_.des = h - dim_.asc;
191 //lyxerr << "dim_.wid " << dim_.wid << endl;
192 //lyxerr << "dim_.asc " << dim_.asc << endl;
193 //lyxerr << "dim_.des " << dim_.des << endl;
195 changed |= dim_ != old_dim;
201 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
203 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
207 int TextMetrics::rightMargin(pit_type const pit) const
209 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
213 void TextMetrics::applyOuterFont(Font & font) const
215 FontInfo lf(font_.fontInfo());
216 lf.reduce(bv_->buffer().params().getFont().fontInfo());
217 font.fontInfo().realize(lf);
221 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
223 LASSERT(pos >= 0, { static Font f; return f; });
225 ParagraphList const & pars = text_->paragraphs();
226 Paragraph const & par = pars[pit];
227 Layout const & layout = par.layout();
228 Buffer const & buffer = bv_->buffer();
230 BufferParams const & params = buffer.params();
231 pos_type const body_pos = par.beginOfBody();
233 // We specialize the 95% common case:
234 if (!par.getDepth()) {
235 Font f = par.getFontSettings(params, pos);
236 if (!text_->isMainText())
238 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
240 FontInfo const & lf = lab ? layout.labelfont : layout.font;
241 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
243 // In case the default family has been customized
244 if (lf.family() == INHERIT_FAMILY)
245 rlf.setFamily(params.getFont().fontInfo().family());
246 f.fontInfo().realize(rlf);
250 // The uncommon case need not be optimized as much
251 FontInfo const & layoutfont = pos < body_pos ?
252 layout.labelfont : layout.font;
254 Font font = par.getFontSettings(params, pos);
255 font.fontInfo().realize(layoutfont);
257 if (!text_->isMainText())
258 applyOuterFont(font);
260 // Realize against environment font information
261 // NOTE: the cast to pit_type should be removed when pit_type
262 // changes to a unsigned integer.
263 if (pit < pit_type(pars.size()))
264 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
266 // Realize with the fonts of lesser depth.
267 font.fontInfo().realize(params.getFont().fontInfo());
273 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
279 if (boundary && sl.pos() > 0)
282 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
286 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
288 // no RTL boundary at paragraph start
292 Font const & left_font = displayFont(pit, pos - 1);
294 return isRTLBoundary(pit, pos, left_font);
298 // isRTLBoundary returns false on a real end-of-line boundary,
299 // because otherwise the two boundary types get mixed up.
300 // This is the whole purpose of this being in TextMetrics.
301 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
302 Font const & font) const
304 if (// no RTL boundary at paragraph start
306 // if the metrics have not been calculated, then we are not
307 // on screen and can safely ignore issues about boundaries.
311 ParagraphMetrics & pm = par_metrics_[pit];
312 // no RTL boundary in empty paragraph
313 if (pm.rows().empty())
316 pos_type endpos = pm.getRow(pos - 1, false).endpos();
317 pos_type startpos = pm.getRow(pos, false).pos();
318 // no RTL boundary at line start:
319 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
321 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
324 Paragraph const & par = text_->getPar(pit);
325 // no RTL boundary at line break:
326 // abc|\n -> move right -> abc\n (and not: abc\n|
328 if (startpos == pos && endpos == pos && endpos != par.size()
329 && (par.isNewline(pos - 1)
330 || par.isEnvSeparator(pos - 1)
331 || par.isLineSeparator(pos - 1)
332 || par.isSeparator(pos - 1)))
335 bool left = font.isVisibleRightToLeft();
337 if (pos == par.size())
338 right = par.isRTL(bv_->buffer().params());
340 right = displayFont(pit, pos).isVisibleRightToLeft();
342 return left != right;
346 bool TextMetrics::redoParagraph(pit_type const pit)
348 Paragraph & par = text_->getPar(pit);
349 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
350 // redoParagraph() recursively inside parMetrics.
351 Dimension old_dim = parMetrics(pit, false).dim();
352 ParagraphMetrics & pm = par_metrics_[pit];
355 Buffer & buffer = bv_->buffer();
356 bool changed = false;
358 // Check whether there are InsetBibItems that need fixing
359 // FIXME: This check ought to be done somewhere else. It is the reason
360 // why text_ is not const. But then, where else to do it?
361 // Well, how can you end up with either (a) a biblio environment that
362 // has no InsetBibitem or (b) a biblio environment with more than one
363 // InsetBibitem? I think the answer is: when paragraphs are merged;
364 // when layout is set; when material is pasted.
365 if (par.brokenBiblio()) {
366 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
367 // In some cases, we do not know how to record undo
368 if (&cur.inset() == &text_->inset())
369 cur.recordUndo(pit, pit);
371 int const moveCursor = par.fixBiblio(buffer);
373 // Is it necessary to update the cursor?
374 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
377 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
382 // Optimisation: this is used in the next two loops
383 // so better to calculate that once here.
384 int const right_margin = rightMargin(pm);
386 // iterator pointing to paragraph to resolve macros
387 DocIterator parPos = text_->macrocontextPosition();
391 LYXERR(Debug::INFO, "MacroContext not initialised!"
392 << " Going through the buffer again and hope"
393 << " the context is better then.");
394 // FIXME audit updateBuffer calls
395 // This should not be here, but it is not clear yet where else it
397 bv_->buffer().updateBuffer();
398 parPos = text_->macrocontextPosition();
399 LBUFERR(!parPos.empty());
404 par.setBeginOfBody();
405 Font const bufferfont = buffer.params().getFont();
406 CoordCache::Insets & insetCache = bv_->coordCache().insets();
407 InsetList::const_iterator ii = par.insetList().begin();
408 InsetList::const_iterator iend = par.insetList().end();
409 for (; ii != iend; ++ii) {
410 // FIXME Doesn't this HAVE to be non-empty?
411 // position already initialized?
412 if (!parPos.empty()) {
413 parPos.pos() = ii->pos;
415 // A macro template would normally not be visible
416 // by itself. But the tex macro semantics allow
417 // recursion, so we artifically take the context
418 // after the macro template to simulate this.
419 if (ii->inset->lyxCode() == MATHMACRO_CODE)
423 // do the metric calculation
425 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
427 Font const & font = ii->inset->inheritFont() ?
428 displayFont(pit, ii->pos) : bufferfont;
429 MacroContext mc(&buffer, parPos);
430 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
431 ii->inset->metrics(mi, dim);
432 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
433 insetCache.add(ii->inset, dim);
439 size_t row_index = 0;
440 bool need_new_row = false;
441 // maximum pixel width of a row
443 if (row_index == pm.rows().size())
444 pm.rows().push_back(Row());
445 Row & row = pm.rows()[row_index];
449 need_new_row = breakRow(row, right_margin);
451 row.setChanged(false);
452 if (row_index || row.endpos() < par.size()
453 || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
454 /* If there is more than one row or the row has been
455 * broken by a display inset or a newline, expand the text
456 * to the full allowable width. This setting here is
457 * needed for the computeRowMetrics() below. In the case
458 * of a display inset, we do nothing when inside a table
459 * cell, because the tabular code is not prepared for
460 * that, and it triggers when using a caption in a
461 * longtable (see bugs #9945 and #9757).
463 if (dim_.wid < max_width_)
464 dim_.wid = max_width_;
466 int const max_row_width = max(dim_.wid, row.width());
467 computeRowMetrics(row, max_row_width);
468 first = row.endpos();
471 pm.dim().wid = max(pm.dim().wid, row.width());
472 pm.dim().des += row.height();
473 } while (first < par.size() || need_new_row);
475 if (row_index < pm.rows().size())
476 pm.rows().resize(row_index);
478 // FIXME: It might be better to move this in another method
479 // specially tailored for the main text.
480 // Top and bottom margin of the document (only at top-level)
481 if (text_->isMainText()) {
482 // original value was 20px, which is 0.2in at 100dpi
483 int const margin = Length(0.2, Length::IN).inPixels(0);
485 pm.rows().front().dimension().asc += margin;
486 /* coverity thinks that we should update pm.dim().asc
487 * below, but all the rows heights are actually counted as
488 * part of the paragraph metric descent see loop above).
490 // coverity[copy_paste_error]
491 pm.dim().des += margin;
493 ParagraphList const & pars = text_->paragraphs();
494 if (pit + 1 == pit_type(pars.size())) {
495 pm.rows().back().dimension().des += margin;
496 pm.dim().des += margin;
500 // The space above and below the paragraph.
501 int const top = parTopSpacing(pit);
502 pm.rows().front().dimension().asc += top;
503 int const bottom = parBottomSpacing(pit);
504 pm.rows().back().dimension().des += bottom;
505 pm.dim().des += top + bottom;
507 pm.dim().asc += pm.rows()[0].ascent();
508 pm.dim().des -= pm.rows()[0].ascent();
510 changed |= old_dim.height() != pm.dim().height();
516 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
518 LyXAlignment align = par.getAlign();
520 // handle alignment inside tabular cells
521 Inset const & owner = text_->inset();
522 bool forced_block = false;
523 switch (owner.contentAlignment()) {
524 case LYX_ALIGN_BLOCK:
525 // In general block align is the default state, but here it is
526 // an explicit choice. Therefore it should not be overridden
530 case LYX_ALIGN_CENTER:
532 case LYX_ALIGN_RIGHT:
533 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
534 align = owner.contentAlignment();
537 // unchanged (use align)
541 // Display-style insets should always be on a centered row
542 if (Inset const * inset = par.getInset(row.pos())) {
543 switch (inset->display()) {
544 case Inset::AlignLeft:
545 align = LYX_ALIGN_BLOCK;
547 case Inset::AlignCenter:
548 align = LYX_ALIGN_CENTER;
551 // unchanged (use align)
553 case Inset::AlignRight:
554 align = LYX_ALIGN_RIGHT;
559 if (align == LYX_ALIGN_BLOCK) {
560 // If this row has been broken abruptly by a display inset, or
561 // it is the end of the paragraph, or the user requested we
562 // not justify stuff, then don't stretch.
563 // A forced block alignment can only be overridden the 'no
564 // justification on screen' setting.
565 if ((row.flushed() && !forced_block)
566 || !bv_->buffer().params().justification)
567 align = row.isRTL() ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
574 void TextMetrics::computeRowMetrics(Row & row, int width) const
579 Paragraph const & par = text_->getPar(row.pit());
581 int const w = width - row.right_margin - row.width();
582 // FIXME: put back this assertion when the crash on new doc is solved.
583 //LASSERT(w >= 0, /**/);
585 // is there a manual margin with a manual label
586 Layout const & layout = par.layout();
589 if (layout.margintype == MARGIN_MANUAL
590 && layout.labeltype == LABEL_MANUAL) {
591 /// We might have real hfills in the label part
592 nlh = numberOfLabelHfills(par, row);
594 // A manual label par (e.g. List) has an auto-hfill
595 // between the label text and the body of the
597 // But we don't want to do this auto hfill if the par
602 if (nlh && !par.getLabelWidthString().empty())
603 row.label_hfill = labelFill(row) / double(nlh);
606 // are there any hfills in the row?
607 ParagraphMetrics & pm = par_metrics_[row.pit()];
608 int nh = numberOfHfills(row, pm, par.beginOfBody());
612 // We don't have to look at the alignment if the row is already
613 // larger then the permitted width as then we force the
614 // LEFT_ALIGN'edness!
615 if (int(row.width()) >= max_width_)
619 // Common case : there is no hfill, and the alignment will be
621 switch (getAlign(par, row)) {
622 case LYX_ALIGN_BLOCK:
623 // Expand expanding characters by a total of w
624 if (!row.setExtraWidth(w) && row.isRTL()) {
625 // Justification failed and the text is RTL: align to the right
626 row.left_margin += w;
627 row.dimension().wid += w;
630 case LYX_ALIGN_RIGHT:
631 row.left_margin += w;
632 row.dimension().wid += w;
634 case LYX_ALIGN_CENTER:
635 row.dimension().wid += w / 2;
636 row.left_margin += w / 2;
640 case LYX_ALIGN_LAYOUT:
641 case LYX_ALIGN_SPECIAL:
642 case LYX_ALIGN_DECIMAL:
648 // Case nh > 0. There are hfill separators.
651 row.dimension().wid += w;
652 // Set size of hfill insets
653 pos_type const endpos = row.endpos();
654 pos_type body_pos = par.beginOfBody();
656 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
659 CoordCache::Insets & insetCache = bv_->coordCache().insets();
660 Row::iterator cit = row.begin();
661 Row::iterator const cend = row.end();
662 for ( ; cit != cend; ++cit) {
663 if (row.label_hfill && cit->endpos == body_pos
664 && cit->type == Row::SPACE)
665 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
666 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
667 if (cit->pos >= body_pos) {
668 cit->dim.wid += hfill;
671 cit->dim.wid += hfill_rem;
673 cit->dim.wid += int(row.label_hfill);
674 // Cache the inset dimension.
675 insetCache.add(cit->inset, cit->dim);
681 int TextMetrics::labelFill(Row const & row) const
683 Paragraph const & par = text_->getPar(row.pit());
684 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
687 Row::const_iterator cit = row.begin();
688 Row::const_iterator const end = row.end();
689 // iterate over elements before main body (except the last one,
690 // which is extra space).
691 while (cit!= end && cit->endpos < par.beginOfBody()) {
696 docstring const & label = par.params().labelWidthString();
700 FontMetrics const & fm
701 = theFontMetrics(text_->labelFont(par));
703 return max(0, fm.width(label) - w);
708 // Not used, see TextMetrics::breakRow
709 // this needs special handling - only newlines count as a break point
710 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
712 pos_type const end = par.size();
715 if (par.isNewline(i))
723 int TextMetrics::labelEnd(pit_type const pit) const
725 // labelEnd is only needed if the layout fills a flushleft label.
726 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
728 // return the beginning of the body
729 return leftMargin(max_width_, pit);
735 * Calling Text::getFont is slow. While rebreaking we scan a
736 * paragraph from left to right calling getFont for every char. This
737 * simple class address this problem by hidding an optimization trick
738 * (not mine btw -AB): the font is reused in the whole font span. The
739 * class handles transparently the "hidden" (not part of the fontlist)
740 * label font (as getFont does).
746 FontIterator(TextMetrics const & tm,
747 Paragraph const & par, pit_type pit, pos_type pos)
748 : tm_(tm), par_(par), pit_(pit), pos_(pos),
749 font_(tm.displayFont(pit, pos)),
750 endspan_(par.fontSpan(pos).last),
751 bodypos_(par.beginOfBody())
755 Font const & operator*() const { return font_; }
758 FontIterator & operator++()
761 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
762 font_ = tm_.displayFont(pit_, pos_);
763 endspan_ = par_.fontSpan(pos_).last;
769 Font * operator->() { return &font_; }
773 TextMetrics const & tm_;
775 Paragraph const & par_;
790 /** This is the function where the hard work is done. The code here is
791 * very sensitive to small changes :) Note that part of the
792 * intelligence is also in Row::shortenIfNeeded.
794 bool TextMetrics::breakRow(Row & row, int const right_margin) const
796 Paragraph const & par = text_->getPar(row.pit());
797 pos_type const end = par.size();
798 pos_type const pos = row.pos();
799 pos_type const body_pos = par.beginOfBody();
800 bool const is_rtl = text_->isRTL(par);
801 bool need_new_row = false;
804 row.left_margin = leftMargin(max_width_, row.pit(), pos);
805 row.right_margin = right_margin;
807 swap(row.left_margin, row.right_margin);
808 // Remember that the row width takes into account the left_margin
809 // but not the right_margin.
810 row.dimension().wid = row.left_margin;
811 // the width available for the row.
812 int const width = max_width_ - row.right_margin;
814 if (pos >= end || row.width() > width) {
820 //FIXME: As long as leftMargin() is not correctly implemented for
821 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
822 // Otherwise, long rows will be painted off the screen.
823 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
824 return addressBreakPoint(pos, par);
827 // check for possible inline completion
828 DocIterator const & ic_it = bv_->inlineCompletionPos();
829 pos_type ic_pos = -1;
830 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
831 ic_pos = ic_it.pos();
833 // Now we iterate through until we reach the right margin
834 // or the end of the par, then build a representation of the row.
836 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
838 // this can happen for an empty row after a newline
841 char_type c = par.getChar(i);
842 // The most special cases are handled first.
843 if (par.isInset(i)) {
844 Inset const * ins = par.getInset(i);
845 Dimension dim = bv_->coordCache().insets().dim(ins);
846 row.add(i, ins, dim, *fi, par.lookupChange(i));
847 } else if (c == ' ' && i + 1 == body_pos) {
848 // There is a space at i, but it should not be
849 // added as a separator, because it is just
850 // before body_pos. Instead, insert some spacing to
852 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
853 // this is needed to make sure that the row width is correct
855 int const add = max(fm.width(par.layout().labelsep),
856 labelEnd(row.pit()) - row.width());
857 row.addSpace(i, add, *fi, par.lookupChange(i));
858 } else if (c == '\t')
859 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
860 *fi, par.lookupChange(i));
861 else if (c == 0x2028 || c == 0x2029) {
863 * U+2028 LINE SEPARATOR
864 * U+2029 PARAGRAPH SEPARATOR
866 * These are special unicode characters that break
867 * lines/pragraphs. Not handling them lead to trouble wrt
868 * Qt QTextLayout formatting. We add a visible character
869 * on screen so that the user can see that something is
873 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
874 // ¶ U+00B6 PILCROW SIGN
875 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
876 row.add(i, screen_char, *fi, par.lookupChange(i));
878 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
879 // see also Paragraph::getUChar.
880 if (fi->language()->lang() == "hebrew") {
886 row.add(i, c, *fi, par.lookupChange(i));
889 // add inline completion width
890 // draw logically behind the previous character
891 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
892 docstring const comp = bv_->inlineCompletion();
893 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
897 f.fontInfo().setColor(Color_inlinecompletion);
898 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
900 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
901 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
904 // Handle some situations that abruptly terminate the row
906 // - Before a display inset
907 // - After a display inset
908 Inset const * inset = 0;
909 if (par.isNewline(i) || par.isEnvSeparator(i)
910 || (i + 1 < end && (inset = par.getInset(i + 1))
912 || (!row.empty() && row.back().inset
913 && row.back().inset->display())) {
915 need_new_row = par.isNewline(i);
922 } while (i < end && row.width() <= width);
926 // End of paragraph marker
927 ParagraphList const & pars = text_->paragraphs();
928 if (lyxrc.paragraph_markers && !need_new_row
929 && i == end && size_type(row.pit() + 1) < pars.size()) {
930 // add a virtual element for the end-of-paragraph
931 // marker; it is shown on screen, but does not exist
933 Font f(text_->layoutFont(row.pit()));
934 f.fontInfo().setColor(Color_paragraphmarker);
935 BufferParams const & bparams
936 = text_->inset().buffer().params();
937 f.setLanguage(par.getParLanguage(bparams));
938 // ¶ U+00B6 PILCROW SIGN
939 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
942 // if the row is too large, try to cut at last separator. In case
943 // of success, reset indication that the row was broken abruptly.
944 int const next_width = max_width_ - leftMargin(max_width_, row.pit(), row.endpos())
945 - rightMargin(row.pit());
947 row.shortenIfNeeded(body_pos, width, next_width);
948 row.right_boundary(!row.empty() && row.endpos() < end
949 && row.back().endpos == row.endpos());
950 // Last row in paragraph is flushed
951 if (row.endpos() == end)
954 // make sure that the RTL elements are in reverse ordering
955 row.reverseRTL(is_rtl);
956 //LYXERR0("breakrow: row is " << row);
961 int TextMetrics::parTopSpacing(pit_type const pit) const
963 Paragraph const & par = text_->getPar(pit);
964 Layout const & layout = par.layout();
967 ParagraphList const & pars = text_->paragraphs();
968 double const dh = defaultRowHeight();
970 BufferParams const & bparams = bv_->buffer().params();
971 Inset const & inset = text_->inset();
972 // some parskips VERY EASY IMPLEMENTATION
973 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
974 && !inset.getLayout().parbreakIsNewline()
975 && !par.layout().parbreak_is_newline
977 && ((layout.isParagraph() && par.getDepth() == 0)
978 || (pars[pit - 1].layout().isParagraph()
979 && pars[pit - 1].getDepth() == 0))) {
980 asc += bparams.getDefSkip().inPixels(*bv_);
983 if (par.params().startOfAppendix())
986 // special code for the top label
987 if (layout.labelIsAbove()
988 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
989 && !par.labelString().empty()) {
990 FontInfo labelfont = text_->labelFont(par);
991 FontMetrics const & lfm = theFontMetrics(labelfont);
992 asc += int(lfm.maxHeight() * layout.spacing.getValue()
993 * text_->spacing(par)
994 + (layout.topsep + layout.labelbottomsep) * dh);
997 // Add the layout spaces, for example before and after
998 // a section, or between the items of a itemize or enumerate
1001 pit_type prev = text_->depthHook(pit, par.getDepth());
1002 Paragraph const & prevpar = pars[prev];
1003 double layoutasc = 0;
1005 && prevpar.layout() == layout
1006 && prevpar.getDepth() == par.getDepth()
1007 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1008 layoutasc = layout.itemsep * dh;
1009 } else if (pit != 0 && layout.topsep > 0)
1010 layoutasc = layout.topsep * dh;
1012 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1014 prev = text_->outerHook(pit);
1015 if (prev != pit_type(pars.size())) {
1016 asc += int(pars[prev].layout().parsep * dh);
1017 } else if (pit != 0) {
1018 Paragraph const & prevpar = pars[pit - 1];
1019 if (prevpar.getDepth() != 0 || prevpar.layout() == layout)
1020 asc += int(layout.parsep * dh);
1027 int TextMetrics::parBottomSpacing(pit_type const pit) const
1029 double layoutdesc = 0;
1030 ParagraphList const & pars = text_->paragraphs();
1031 double const dh = defaultRowHeight();
1033 // add the layout spaces, for example before and after
1034 // a section, or between the items of a itemize or enumerate
1036 pit_type nextpit = pit + 1;
1037 if (nextpit != pit_type(pars.size())) {
1038 pit_type cpit = pit;
1040 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1041 double usual = pars[cpit].layout().bottomsep * dh;
1043 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1044 if (pars[cpit].layout() != pars[nextpit].layout()
1045 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1046 unusual = pars[cpit].layout().bottomsep * dh;
1047 layoutdesc = max(unusual, usual);
1048 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1049 if (pars[cpit].layout() != pars[nextpit].layout()
1050 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1051 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1055 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1059 void TextMetrics::setRowHeight(Row & row) const
1061 Paragraph const & par = text_->getPar(row.pit());
1062 Layout const & layout = par.layout();
1063 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1065 // Initial value for ascent (useful if row is empty).
1066 Font const font = displayFont(row.pit(), row.pos());
1067 FontMetrics const & fm = theFontMetrics(font);
1068 int maxasc = int(fm.maxAscent() * spacing_val);
1069 int maxdes = int(fm.maxDescent() * spacing_val);
1071 // Find the ascent/descent of the row contents
1072 Row::const_iterator cit = row.begin();
1073 Row::const_iterator cend = row.end();
1074 for ( ; cit != cend; ++cit) {
1076 maxasc = max(maxasc, cit->dim.ascent());
1077 maxdes = max(maxdes, cit->dim.descent());
1079 FontMetrics const & fm = theFontMetrics(cit->font);
1080 maxasc = max(maxasc, int(fm.maxAscent() * spacing_val));
1081 maxdes = max(maxdes, int(fm.maxDescent() * spacing_val));
1085 // This is nicer with box insets
1089 row.dimension().asc = maxasc;
1090 row.dimension().des = maxdes;
1094 // x is an absolute screen coord
1095 // returns the column near the specified x-coordinate of the row
1096 // x is set to the real beginning of this column
1097 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1098 bool & boundary) const
1100 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1101 /// For the main Text, it is possible that this pit is not
1102 /// yet in the CoordCache when moving cursor up.
1103 /// x Paragraph coordinate is always 0 for main text anyway.
1104 int const xo = origin_.x_;
1107 // Adapt to cursor row scroll offset if applicable.
1108 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1111 pos_type pos = row.pos();
1114 x = row.left_margin;
1115 else if (x <= row.left_margin) {
1116 pos = row.front().left_pos();
1117 x = row.left_margin;
1118 } else if (x >= row.width()) {
1119 pos = row.back().right_pos();
1122 double w = row.left_margin;
1123 Row::const_iterator cit = row.begin();
1124 Row::const_iterator cend = row.end();
1125 for ( ; cit != cend; ++cit) {
1126 if (w <= x && w + cit->full_width() > x) {
1127 int x_offset = int(x - w);
1128 pos = cit->x2pos(x_offset);
1129 x = int(x_offset + w);
1132 w += cit->full_width();
1134 if (cit == row.end()) {
1135 pos = row.back().right_pos();
1138 /** This tests for the case where the cursor is placed
1139 * just before a font direction change. See comment on
1140 * the boundary_ member in DocIterator.h to understand
1141 * how boundary helps here.
1143 else if (pos == cit->endpos
1144 && ((!cit->isRTL() && cit + 1 != row.end()
1145 && (cit + 1)->isRTL())
1146 || (cit->isRTL() && cit != row.begin()
1147 && !(cit - 1)->isRTL())))
1151 /** This tests for the case where the cursor is set at the end
1152 * of a row which has been broken due something else than a
1153 * separator (a display inset or a forced breaking of the
1154 * row). We know that there is a separator when the end of the
1155 * row is larger than the end of its last element.
1157 if (!row.empty() && pos == row.back().endpos
1158 && row.back().endpos == row.endpos()) {
1159 Inset const * inset = row.back().inset;
1160 if (inset && (inset->lyxCode() == NEWLINE_CODE
1161 || inset->lyxCode() == SEPARATOR_CODE))
1162 pos = row.back().pos;
1164 boundary = row.right_boundary();
1168 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1174 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1176 // We play safe and use parMetrics(pit) to make sure the
1177 // ParagraphMetrics will be redone and OK to use if needed.
1178 // Otherwise we would use an empty ParagraphMetrics in
1179 // upDownInText() while in selection mode.
1180 ParagraphMetrics const & pm = parMetrics(pit);
1182 LBUFERR(row < int(pm.rows().size()));
1184 Row const & r = pm.rows()[row];
1185 return getPosNearX(r, x, bound);
1189 void TextMetrics::newParMetricsDown()
1191 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1192 pit_type const pit = last.first + 1;
1193 if (pit == int(text_->paragraphs().size()))
1196 // do it and update its position.
1198 par_metrics_[pit].setPosition(last.second.position()
1199 + last.second.descent() + par_metrics_[pit].ascent());
1203 void TextMetrics::newParMetricsUp()
1205 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1206 if (first.first == 0)
1209 pit_type const pit = first.first - 1;
1210 // do it and update its position.
1212 par_metrics_[pit].setPosition(first.second.position()
1213 - first.second.ascent() - par_metrics_[pit].descent());
1216 // y is screen coordinate
1217 pit_type TextMetrics::getPitNearY(int y)
1219 LASSERT(!text_->paragraphs().empty(), return -1);
1220 LASSERT(!par_metrics_.empty(), return -1);
1221 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1223 // look for highest numbered paragraph with y coordinate less than given y
1226 ParMetricsCache::const_iterator it = par_metrics_.begin();
1227 ParMetricsCache::const_iterator et = par_metrics_.end();
1228 ParMetricsCache::const_iterator last = et;
1231 ParagraphMetrics const & pm = it->second;
1233 if (y < it->second.position() - int(pm.ascent())) {
1234 // We are looking for a position that is before the first paragraph in
1235 // the cache (which is in priciple off-screen, that is before the
1238 // We are already at the first paragraph in the inset.
1240 // OK, this is the paragraph we are looking for.
1241 pit = it->first - 1;
1246 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1248 if (y >= last->second.position() + int(pm_last.descent())) {
1249 // We are looking for a position that is after the last paragraph in
1250 // the cache (which is in priciple off-screen), that is before the
1252 pit = last->first + 1;
1253 if (pit == int(text_->paragraphs().size()))
1254 // We are already at the last paragraph in the inset.
1256 // OK, this is the paragraph we are looking for.
1257 newParMetricsDown();
1261 for (; it != et; ++it) {
1262 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1263 << " y: " << it->second.position());
1265 ParagraphMetrics const & pm = par_metrics_[it->first];
1267 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1269 yy = it->second.position();
1273 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1279 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1280 bool assert_in_view, bool up)
1282 ParagraphMetrics const & pm = par_metrics_[pit];
1284 int yy = pm.position() - pm.ascent();
1285 LBUFERR(!pm.rows().empty());
1286 RowList::const_iterator rit = pm.rows().begin();
1287 RowList::const_iterator rlast = pm.rows().end();
1289 for (; rit != rlast; yy += rit->height(), ++rit)
1290 if (yy + rit->height() > y)
1293 if (assert_in_view) {
1294 if (!up && yy + rit->height() > y) {
1295 if (rit != pm.rows().begin()) {
1298 } else if (pit != 0) {
1301 ParagraphMetrics const & pm2 = par_metrics_[pit];
1302 rit = pm2.rows().end();
1306 } else if (up && yy != y) {
1308 y = yy + rit->height();
1310 } else if (pit < int(text_->paragraphs().size()) - 1) {
1312 newParMetricsDown();
1313 ParagraphMetrics const & pm2 = par_metrics_[pit];
1314 rit = pm2.rows().begin();
1323 // x,y are absolute screen coordinates
1324 // sets cursor recursively descending into nested editable insets
1325 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1326 bool assert_in_view, bool up)
1328 if (lyxerr.debugging(Debug::WORKAREA)) {
1329 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1330 cur.bv().coordCache().dump();
1332 pit_type pit = getPitNearY(y);
1333 LASSERT(pit != -1, return 0);
1334 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1337 // Do we cover an inset?
1338 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1341 // No inset, set position in the text
1342 bool bound = false; // is modified by getPosNearX
1343 cur.pos() = getPosNearX(row, x, bound);
1344 cur.boundary(bound);
1345 cur.setCurrentFont();
1350 Inset * inset = it->inset;
1351 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1353 // Set position in front of inset
1354 cur.pos() = it->pos;
1355 cur.boundary(false);
1358 // Try to descend recursively inside the inset.
1359 Inset * edited = inset->editXY(cur, x, y);
1360 if (edited == inset && cur.pos() == it->pos) {
1361 // non-editable inset, set cursor after the inset if x is
1362 // nearer to that position (bug 9628)
1363 bool bound = false; // is modified by getPosNearX
1364 cur.pos() = getPosNearX(row, x, bound);
1365 cur.boundary(bound);
1366 cur.setCurrentFont();
1370 if (cur.top().text() == text_)
1371 cur.setCurrentFont();
1376 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1378 LASSERT(text_ == cur.text(), return);
1379 pit_type const pit = getPitNearY(y);
1380 LASSERT(pit != -1, return);
1382 ParagraphMetrics const & pm = par_metrics_[pit];
1384 int yy = pm.position() - pm.ascent();
1385 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1386 " pit: " << pit << " yy: " << yy);
1389 LBUFERR(pm.rows().size());
1390 for (; r < int(pm.rows().size()) - 1; ++r) {
1391 Row const & row = pm.rows()[r];
1392 if (int(yy + row.height()) > y)
1397 Row const & row = pm.rows()[r];
1399 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1403 pos_type const pos = getPosNearX(row, xx, bound);
1405 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1407 text_->setCursor(cur, pit, pos, true, bound);
1408 // remember new position.
1413 //takes screen x,y coordinates
1414 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1416 Paragraph const & par = text_->paragraphs()[pit];
1417 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1419 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1421 for (auto const & it : par.insetList()) {
1422 LYXERR(Debug::DEBUG, "examining inset " << it.inset);
1424 if (insetCache.covers(it.inset, x, y)) {
1425 LYXERR(Debug::DEBUG, "Hit inset: " << it.inset);
1426 return const_cast<InsetList::InsetTable *>(&it);
1430 LYXERR(Debug::DEBUG, "No inset hit. ");
1435 //takes screen x,y coordinates
1436 Inset * TextMetrics::checkInsetHit(int x, int y)
1438 pit_type const pit = getPitNearY(y);
1439 LASSERT(pit != -1, return 0);
1440 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1449 int TextMetrics::cursorX(CursorSlice const & sl,
1450 bool boundary) const
1452 LASSERT(sl.text() == text_, return 0);
1454 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1455 if (pm.rows().empty())
1457 Row const & row = pm.getRow(sl.pos(), boundary);
1458 pos_type const pos = sl.pos();
1461 row.findElement(pos, boundary, x);
1467 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1469 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1470 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1471 if (pm.rows().empty())
1475 h -= par_metrics_[0].rows()[0].ascent();
1476 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1477 h += par_metrics_[pit].height();
1480 if (pos && boundary)
1482 size_t const rend = pm.pos2row(pos);
1483 for (size_t rit = 0; rit != rend; ++rit)
1484 h += pm.rows()[rit].height();
1485 h += pm.rows()[rend].ascent();
1490 // the cursor set functions have a special mechanism. When they
1491 // realize you left an empty paragraph, they will delete it.
1493 bool TextMetrics::cursorHome(Cursor & cur)
1495 LASSERT(text_ == cur.text(), return false);
1496 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1497 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1498 return text_->setCursor(cur, cur.pit(), row.pos());
1502 bool TextMetrics::cursorEnd(Cursor & cur)
1504 LASSERT(text_ == cur.text(), return false);
1505 // if not on the last row of the par, put the cursor before
1506 // the final space exept if I have a spanning inset or one string
1507 // is so long that we force a break.
1508 pos_type end = cur.textRow().endpos();
1510 // empty text, end-1 is no valid position
1512 bool boundary = false;
1513 if (end != cur.lastpos()) {
1514 if (!cur.paragraph().isLineSeparator(end-1)
1515 && !cur.paragraph().isNewline(end-1)
1516 && !cur.paragraph().isEnvSeparator(end-1))
1520 } else if (cur.paragraph().isEnvSeparator(end-1))
1522 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1526 void TextMetrics::deleteLineForward(Cursor & cur)
1528 LASSERT(text_ == cur.text(), return);
1529 if (cur.lastpos() == 0) {
1530 // Paragraph is empty, so we just go forward
1531 text_->cursorForward(cur);
1534 cur.selection(true); // to avoid deletion
1537 // What is this test for ??? (JMarc)
1538 if (!cur.selection())
1539 text_->deleteWordForward(cur);
1541 cap::cutSelection(cur, true, false);
1542 cur.checkBufferStructure();
1547 bool TextMetrics::isLastRow(Row const & row) const
1549 ParagraphList const & pars = text_->paragraphs();
1550 return row.endpos() >= pars[row.pit()].size()
1551 && row.pit() + 1 == pit_type(pars.size());
1555 bool TextMetrics::isFirstRow(Row const & row) const
1557 return row.pos() == 0 && row.pit() == 0;
1561 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1563 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1567 int TextMetrics::leftMargin(int max_width,
1568 pit_type const pit, pos_type const pos) const
1570 ParagraphList const & pars = text_->paragraphs();
1572 LASSERT(pit >= 0, return 0);
1573 LASSERT(pit < int(pars.size()), return 0);
1574 Paragraph const & par = pars[pit];
1575 LASSERT(pos >= 0, return 0);
1576 LASSERT(pos <= par.size(), return 0);
1577 Buffer const & buffer = bv_->buffer();
1578 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1579 DocumentClass const & tclass = buffer.params().documentClass();
1580 Layout const & layout = par.layout();
1581 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1583 docstring parindent = layout.parindent;
1587 if (text_->isMainText())
1588 l_margin += bv_->leftMargin();
1590 l_margin += bfm.signedWidth(tclass.leftmargin());
1592 int depth = par.getDepth();
1594 // find the next level paragraph
1595 pit_type newpar = text_->outerHook(pit);
1596 if (newpar != pit_type(pars.size())) {
1597 if (pars[newpar].layout().isEnvironment()) {
1598 int nestmargin = depth * nestMargin();
1599 if (text_->isMainText())
1600 nestmargin += changebarMargin();
1601 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1602 // Remove the parindent that has been added
1603 // if the paragraph was empty.
1604 if (pars[newpar].empty() &&
1605 buffer.params().paragraph_separation ==
1606 BufferParams::ParagraphIndentSeparation) {
1607 docstring pi = pars[newpar].layout().parindent;
1608 l_margin -= bfm.signedWidth(pi);
1611 if (tclass.isDefaultLayout(par.layout())
1612 || tclass.isPlainLayout(par.layout())) {
1613 if (pars[newpar].params().noindent())
1616 parindent = pars[newpar].layout().parindent;
1621 // This happens after sections or environments in standard classes.
1622 // We have to check the previous layout at same depth.
1623 if (buffer.params().paragraph_separation ==
1624 BufferParams::ParagraphSkipSeparation)
1626 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1627 pit_type prev = text_->depthHook(pit, par.getDepth());
1628 if (par.layout() == pars[prev].layout()) {
1630 && pars[pit - 1].layout().nextnoindent)
1632 } else if (pars[prev].layout().nextnoindent)
1636 FontInfo const labelfont = text_->labelFont(par);
1637 FontMetrics const & lfm = theFontMetrics(labelfont);
1639 switch (layout.margintype) {
1640 case MARGIN_DYNAMIC:
1641 if (!layout.leftmargin.empty()) {
1642 l_margin += bfm.signedWidth(layout.leftmargin);
1644 if (!par.labelString().empty()) {
1645 l_margin += lfm.signedWidth(layout.labelindent);
1646 l_margin += lfm.width(par.labelString());
1647 l_margin += lfm.width(layout.labelsep);
1651 case MARGIN_MANUAL: {
1652 l_margin += lfm.signedWidth(layout.labelindent);
1653 // The width of an empty par, even with manual label, should be 0
1654 if (!par.empty() && pos >= par.beginOfBody()) {
1655 if (!par.getLabelWidthString().empty()) {
1656 docstring labstr = par.getLabelWidthString();
1657 l_margin += lfm.width(labstr);
1658 l_margin += lfm.width(layout.labelsep);
1664 case MARGIN_STATIC: {
1665 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1666 / (par.getDepth() + 4);
1670 case MARGIN_FIRST_DYNAMIC:
1671 if (layout.labeltype == LABEL_MANUAL) {
1672 // if we are at position 0, we are never in the body
1673 if (pos > 0 && pos >= par.beginOfBody())
1674 l_margin += lfm.signedWidth(layout.leftmargin);
1676 l_margin += lfm.signedWidth(layout.labelindent);
1678 // Special case to fix problems with
1680 || (layout.labeltype == LABEL_STATIC
1681 && layout.latextype == LATEX_ENVIRONMENT
1682 && !text_->isFirstInSequence(pit))) {
1683 l_margin += lfm.signedWidth(layout.leftmargin);
1684 } else if (!layout.labelIsAbove()) {
1685 l_margin += lfm.signedWidth(layout.labelindent);
1686 l_margin += lfm.width(layout.labelsep);
1687 l_margin += lfm.width(par.labelString());
1691 case MARGIN_RIGHT_ADDRESS_BOX: {
1693 // The left margin depends on the widest row in this paragraph.
1694 // This code is wrong because it depends on the rows, but at the
1695 // same time this function is used in redoParagraph to construct
1697 ParagraphMetrics const & pm = par_metrics_[pit];
1698 RowList::const_iterator rit = pm.rows().begin();
1699 RowList::const_iterator end = pm.rows().end();
1700 int minfill = max_width;
1701 for ( ; rit != end; ++rit)
1702 if (rit->fill() < minfill)
1703 minfill = rit->fill();
1704 l_margin += bfm.signedWidth(layout.leftmargin);
1705 l_margin += minfill;
1707 // also wrong, but much shorter.
1708 l_margin += max_width / 2;
1713 if (!par.params().leftIndent().zero())
1714 l_margin += par.params().leftIndent().inPixels(max_width, lfm.em());
1716 LyXAlignment align = par.getAlign();
1718 // set the correct parindent
1720 && (layout.labeltype == LABEL_NO_LABEL
1721 || layout.labeltype == LABEL_ABOVE
1722 || layout.labeltype == LABEL_CENTERED
1723 || (layout.labeltype == LABEL_STATIC
1724 && layout.latextype == LATEX_ENVIRONMENT
1725 && !text_->isFirstInSequence(pit)))
1726 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1727 && !par.params().noindent()
1728 // in some insets, paragraphs are never indented
1729 && !text_->inset().neverIndent()
1730 // display style insets are always centered, omit indentation
1733 && par.getInset(pos)->display())
1734 && (!(tclass.isDefaultLayout(par.layout())
1735 || tclass.isPlainLayout(par.layout()))
1736 || buffer.params().paragraph_separation
1737 == BufferParams::ParagraphIndentSeparation)) {
1738 /* use the parindent of the layout when the default
1739 * indentation is used otherwise use the indentation set in
1740 * the document settings
1742 if (buffer.params().getParIndent().empty())
1743 l_margin += bfm.signedWidth(parindent);
1745 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
1752 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1754 if (par_metrics_.empty())
1760 ParMetricsCache::iterator it = par_metrics_.begin();
1761 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1762 y -= it->second.ascent();
1763 for (; it != pm_end; ++it) {
1764 ParagraphMetrics const & pmi = it->second;
1766 pit_type const pit = it->first;
1767 // Save the paragraph position in the cache.
1768 it->second.setPosition(y);
1769 drawParagraph(pi, pit, x, y);
1775 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1777 ParagraphMetrics const & pm = par_metrics_[pit];
1778 if (pm.rows().empty())
1780 size_t const nrows = pm.rows().size();
1782 // Use fast lane when drawing is disabled.
1783 if (!pi.pain.isDrawingEnabled()) {
1784 for (size_t i = 0; i != nrows; ++i) {
1786 Row const & row = pm.rows()[i];
1787 // Adapt to cursor row scroll offset if applicable.
1788 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1792 RowPainter rp(pi, *text_, row, row_x, y);
1794 rp.paintOnlyInsets();
1800 int const ww = bv_->workHeight();
1801 Cursor const & cur = bv_->cursor();
1802 DocIterator sel_beg = cur.selectionBegin();
1803 DocIterator sel_end = cur.selectionEnd();
1804 bool selection = cur.selection()
1805 // This is our text.
1806 && cur.text() == text_
1807 // if the anchor is outside, this is not our selection
1808 && cur.normalAnchor().text() == text_
1809 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1811 // We store the begin and end pos of the selection relative to this par
1812 DocIterator sel_beg_par = cur.selectionBegin();
1813 DocIterator sel_end_par = cur.selectionEnd();
1815 // We care only about visible selection.
1817 if (pit != sel_beg.pit()) {
1818 sel_beg_par.pit() = pit;
1819 sel_beg_par.pos() = 0;
1821 if (pit != sel_end.pit()) {
1822 sel_end_par.pit() = pit;
1823 sel_end_par.pos() = sel_end_par.lastpos();
1827 for (size_t i = 0; i != nrows; ++i) {
1829 Row const & row = pm.rows()[i];
1830 // Adapt to cursor row scroll offset if applicable.
1831 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1835 RowPainter rp(pi, *text_, row, row_x, y);
1837 // It is not needed to draw on screen if we are not inside.
1838 bool const inside = (y + row.descent() >= 0
1839 && y - row.ascent() < ww);
1840 pi.pain.setDrawingEnabled(inside);
1842 // Paint only the insets to set inset cache correctly
1843 // FIXME: remove paintOnlyInsets when we know that positions
1844 // have already been set.
1845 rp.paintOnlyInsets();
1851 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1853 row.setSelection(-1, -1);
1855 // The row knows nothing about the paragraph, so we have to check
1856 // whether this row is the first or last and update the margins.
1857 if (row.selection()) {
1858 if (row.sel_beg == 0)
1859 row.begin_margin_sel = sel_beg.pit() < pit;
1860 if (row.sel_end == sel_end_par.lastpos())
1861 row.end_margin_sel = sel_end.pit() > pit;
1864 // Row signature; has row changed since last paint?
1865 row.setCrc(pm.computeRowSignature(row, *bv_));
1866 bool row_has_changed = row.changed()
1867 || bv_->hadHorizScrollOffset(text_, pit, row.pos());
1869 // Take this opportunity to spellcheck the row contents.
1870 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1871 text_->getPar(pit).spellCheck();
1874 // Don't paint the row if a full repaint has not been requested
1875 // and if it has not changed.
1876 if (!pi.full_repaint && !row_has_changed) {
1877 // Paint only the insets if the text itself is
1879 rp.paintOnlyInsets();
1884 // Clear background of this row if paragraph background was not
1885 // already cleared because of a full repaint.
1886 if (!pi.full_repaint && row_has_changed) {
1887 LYXERR(Debug::PAINTING, "Clear rect@("
1888 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1889 << width() << " x " << row.height());
1890 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1891 width(), row.height(), pi.background_color);
1894 // Instrumentation for testing row cache (see also
1896 if (lyxerr.debugging(Debug::PAINTING)
1897 && (row.selection() || pi.full_repaint || row_has_changed)) {
1898 string const foreword = text_->isMainText() ?
1899 "main text redraw " : "inset text redraw: ";
1900 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1901 << " row_selection=" << row.selection()
1902 << " full_repaint=" << pi.full_repaint
1903 << " row_has_changed=" << row_has_changed
1904 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1907 // Backup full_repaint status and force full repaint
1908 // for inner insets as the Row has been cleared out.
1909 bool tmp = pi.full_repaint;
1910 pi.full_repaint = true;
1912 rp.paintSelection();
1915 rp.paintChangeBar();
1916 if (i == 0 && !row.isRTL())
1918 if (i == nrows - 1 && row.isRTL())
1921 if (i == nrows - 1 && !row.isRTL())
1923 if (i == 0 && row.isRTL())
1925 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1926 row_x + row.right_x() > bv_->workWidth());
1929 // Restore full_repaint status.
1930 pi.full_repaint = tmp;
1932 // Re-enable screen drawing for future use of the painter.
1933 pi.pain.setDrawingEnabled(true);
1935 //LYXERR(Debug::PAINTING, ".");
1939 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1940 Dimension & dim) const
1942 Cursor const & bvcur = cur.bv().cursor();
1944 // get word in front of cursor
1945 docstring word = text_->previousWord(bvcur.top());
1946 DocIterator wordStart = bvcur;
1947 wordStart.pos() -= word.length();
1949 // calculate dimensions of the word
1951 row.pit(bvcur.pit());
1952 row.pos(wordStart.pos());
1953 row.endpos(bvcur.pos());
1955 dim = row.dimension();
1957 // get position on screen of the word start and end
1958 //FIXME: Is it necessary to explicitly set this to false?
1959 wordStart.boundary(false);
1960 Point lxy = cur.bv().getPos(wordStart);
1961 Point rxy = cur.bv().getPos(bvcur);
1962 dim.wid = abs(rxy.x_ - lxy.x_);
1964 // calculate position of word
1966 x = min(rxy.x_, lxy.x_);
1968 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1969 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1972 int defaultRowHeight()
1974 return int(theFontMetrics(sane_font).maxHeight() * 1.2);