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;
631 // a displayed inset that is flushed
632 if (Inset const * inset = par.getInset(row.pos()))
633 row.left_margin += inset->indent(*bv_);
635 case LYX_ALIGN_RIGHT:
636 if (Inset const * inset = par.getInset(row.pos())) {
637 int const new_w = max(w - inset->indent(*bv_), 0);
638 row.left_margin += new_w;
639 row.dimension().wid += new_w;
641 row.left_margin += w;
642 row.dimension().wid += w;
645 case LYX_ALIGN_CENTER:
646 row.dimension().wid += w / 2;
647 row.left_margin += w / 2;
650 case LYX_ALIGN_LAYOUT:
651 case LYX_ALIGN_SPECIAL:
652 case LYX_ALIGN_DECIMAL:
658 // Case nh > 0. There are hfill separators.
661 row.dimension().wid += w;
662 // Set size of hfill insets
663 pos_type const endpos = row.endpos();
664 pos_type body_pos = par.beginOfBody();
666 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
669 CoordCache::Insets & insetCache = bv_->coordCache().insets();
670 Row::iterator cit = row.begin();
671 Row::iterator const cend = row.end();
672 for ( ; cit != cend; ++cit) {
673 if (row.label_hfill && cit->endpos == body_pos
674 && cit->type == Row::SPACE)
675 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
676 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
677 if (cit->pos >= body_pos) {
678 cit->dim.wid += hfill;
681 cit->dim.wid += hfill_rem;
683 cit->dim.wid += int(row.label_hfill);
684 // Cache the inset dimension.
685 insetCache.add(cit->inset, cit->dim);
691 int TextMetrics::labelFill(Row const & row) const
693 Paragraph const & par = text_->getPar(row.pit());
694 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
697 Row::const_iterator cit = row.begin();
698 Row::const_iterator const end = row.end();
699 // iterate over elements before main body (except the last one,
700 // which is extra space).
701 while (cit!= end && cit->endpos < par.beginOfBody()) {
706 docstring const & label = par.params().labelWidthString();
710 FontMetrics const & fm
711 = theFontMetrics(text_->labelFont(par));
713 return max(0, fm.width(label) - w);
718 // Not used, see TextMetrics::breakRow
719 // this needs special handling - only newlines count as a break point
720 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
722 pos_type const end = par.size();
725 if (par.isNewline(i))
733 int TextMetrics::labelEnd(pit_type const pit) const
735 // labelEnd is only needed if the layout fills a flushleft label.
736 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
738 // return the beginning of the body
739 return leftMargin(max_width_, pit);
745 * Calling Text::getFont is slow. While rebreaking we scan a
746 * paragraph from left to right calling getFont for every char. This
747 * simple class address this problem by hidding an optimization trick
748 * (not mine btw -AB): the font is reused in the whole font span. The
749 * class handles transparently the "hidden" (not part of the fontlist)
750 * label font (as getFont does).
756 FontIterator(TextMetrics const & tm,
757 Paragraph const & par, pit_type pit, pos_type pos)
758 : tm_(tm), par_(par), pit_(pit), pos_(pos),
759 font_(tm.displayFont(pit, pos)),
760 endspan_(par.fontSpan(pos).last),
761 bodypos_(par.beginOfBody())
765 Font const & operator*() const { return font_; }
768 FontIterator & operator++()
771 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
772 font_ = tm_.displayFont(pit_, pos_);
773 endspan_ = par_.fontSpan(pos_).last;
779 Font * operator->() { return &font_; }
783 TextMetrics const & tm_;
785 Paragraph const & par_;
800 /** This is the function where the hard work is done. The code here is
801 * very sensitive to small changes :) Note that part of the
802 * intelligence is also in Row::shortenIfNeeded.
804 bool TextMetrics::breakRow(Row & row, int const right_margin) const
806 Paragraph const & par = text_->getPar(row.pit());
807 pos_type const end = par.size();
808 pos_type const pos = row.pos();
809 pos_type const body_pos = par.beginOfBody();
810 bool const is_rtl = text_->isRTL(par);
811 bool need_new_row = false;
814 row.left_margin = leftMargin(max_width_, row.pit(), pos);
815 row.right_margin = right_margin;
817 swap(row.left_margin, row.right_margin);
818 // Remember that the row width takes into account the left_margin
819 // but not the right_margin.
820 row.dimension().wid = row.left_margin;
821 // the width available for the row.
822 int const width = max_width_ - row.right_margin;
824 if (pos >= end || row.width() > width) {
830 //FIXME: As long as leftMargin() is not correctly implemented for
831 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
832 // Otherwise, long rows will be painted off the screen.
833 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
834 return addressBreakPoint(pos, par);
837 // check for possible inline completion
838 DocIterator const & ic_it = bv_->inlineCompletionPos();
839 pos_type ic_pos = -1;
840 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
841 ic_pos = ic_it.pos();
843 // Now we iterate through until we reach the right margin
844 // or the end of the par, then build a representation of the row.
846 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
848 // this can happen for an empty row after a newline
851 char_type c = par.getChar(i);
852 // The most special cases are handled first.
853 if (par.isInset(i)) {
854 Inset const * ins = par.getInset(i);
855 Dimension dim = bv_->coordCache().insets().dim(ins);
856 row.add(i, ins, dim, *fi, par.lookupChange(i));
857 } else if (c == ' ' && i + 1 == body_pos) {
858 // There is a space at i, but it should not be
859 // added as a separator, because it is just
860 // before body_pos. Instead, insert some spacing to
862 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
863 // this is needed to make sure that the row width is correct
865 int const add = max(fm.width(par.layout().labelsep),
866 labelEnd(row.pit()) - row.width());
867 row.addSpace(i, add, *fi, par.lookupChange(i));
868 } else if (c == '\t')
869 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
870 *fi, par.lookupChange(i));
871 else if (c == 0x2028 || c == 0x2029) {
873 * U+2028 LINE SEPARATOR
874 * U+2029 PARAGRAPH SEPARATOR
876 * These are special unicode characters that break
877 * lines/pragraphs. Not handling them lead to trouble wrt
878 * Qt QTextLayout formatting. We add a visible character
879 * on screen so that the user can see that something is
883 // ⤶ U+2936 ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS
884 // ¶ U+00B6 PILCROW SIGN
885 char_type const screen_char = (c == 0x2028) ? 0x2936 : 0x00B6;
886 row.add(i, screen_char, *fi, par.lookupChange(i));
888 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
889 // see also Paragraph::getUChar.
890 if (fi->language()->lang() == "hebrew") {
896 row.add(i, c, *fi, par.lookupChange(i));
899 // add inline completion width
900 // draw logically behind the previous character
901 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
902 docstring const comp = bv_->inlineCompletion();
903 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
907 f.fontInfo().setColor(Color_inlinecompletion);
908 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
910 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
911 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
914 // Handle some situations that abruptly terminate the row
916 // - Before a display inset
917 // - After a display inset
918 Inset const * inset = 0;
919 if (par.isNewline(i) || par.isEnvSeparator(i)
920 || (i + 1 < end && (inset = par.getInset(i + 1))
922 || (!row.empty() && row.back().inset
923 && row.back().inset->display())) {
925 need_new_row = par.isNewline(i);
932 } while (i < end && row.width() <= width);
936 // End of paragraph marker
937 ParagraphList const & pars = text_->paragraphs();
938 if (lyxrc.paragraph_markers && !need_new_row
939 && i == end && size_type(row.pit() + 1) < pars.size()) {
940 // add a virtual element for the end-of-paragraph
941 // marker; it is shown on screen, but does not exist
943 Font f(text_->layoutFont(row.pit()));
944 f.fontInfo().setColor(Color_paragraphmarker);
945 BufferParams const & bparams
946 = text_->inset().buffer().params();
947 f.setLanguage(par.getParLanguage(bparams));
948 // ¶ U+00B6 PILCROW SIGN
949 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
952 // if the row is too large, try to cut at last separator. In case
953 // of success, reset indication that the row was broken abruptly.
954 int const next_width = max_width_ - leftMargin(max_width_, row.pit(), row.endpos())
955 - rightMargin(row.pit());
957 row.shortenIfNeeded(body_pos, width, next_width);
958 row.right_boundary(!row.empty() && row.endpos() < end
959 && row.back().endpos == row.endpos());
960 // Last row in paragraph is flushed
961 if (row.endpos() == end)
964 // make sure that the RTL elements are in reverse ordering
965 row.reverseRTL(is_rtl);
966 //LYXERR0("breakrow: row is " << row);
971 int TextMetrics::parTopSpacing(pit_type const pit) const
973 Paragraph const & par = text_->getPar(pit);
974 Layout const & layout = par.layout();
977 ParagraphList const & pars = text_->paragraphs();
978 double const dh = defaultRowHeight();
980 BufferParams const & bparams = bv_->buffer().params();
981 Inset const & inset = text_->inset();
982 // some parskips VERY EASY IMPLEMENTATION
983 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
984 && !inset.getLayout().parbreakIsNewline()
985 && !par.layout().parbreak_is_newline
987 && ((layout.isParagraph() && par.getDepth() == 0)
988 || (pars[pit - 1].layout().isParagraph()
989 && pars[pit - 1].getDepth() == 0))) {
990 asc += bparams.getDefSkip().inPixels(*bv_);
993 if (par.params().startOfAppendix())
996 // special code for the top label
997 if (layout.labelIsAbove()
998 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
999 && !par.labelString().empty()) {
1000 FontInfo labelfont = text_->labelFont(par);
1001 FontMetrics const & lfm = theFontMetrics(labelfont);
1002 asc += int(lfm.maxHeight() * layout.spacing.getValue()
1003 * text_->spacing(par)
1004 + (layout.topsep + layout.labelbottomsep) * dh);
1007 // Add the layout spaces, for example before and after
1008 // a section, or between the items of a itemize or enumerate
1011 pit_type prev = text_->depthHook(pit, par.getDepth());
1012 Paragraph const & prevpar = pars[prev];
1013 double layoutasc = 0;
1015 && prevpar.layout() == layout
1016 && prevpar.getDepth() == par.getDepth()
1017 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
1018 layoutasc = layout.itemsep * dh;
1019 } else if (pit != 0 && layout.topsep > 0)
1020 layoutasc = layout.topsep * dh;
1022 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1024 prev = text_->outerHook(pit);
1025 if (prev != pit_type(pars.size())) {
1026 asc += int(pars[prev].layout().parsep * dh);
1027 } else if (pit != 0) {
1028 Paragraph const & prevpar = pars[pit - 1];
1029 if (prevpar.getDepth() != 0 || prevpar.layout() == layout)
1030 asc += int(layout.parsep * dh);
1037 int TextMetrics::parBottomSpacing(pit_type const pit) const
1039 double layoutdesc = 0;
1040 ParagraphList const & pars = text_->paragraphs();
1041 double const dh = defaultRowHeight();
1043 // add the layout spaces, for example before and after
1044 // a section, or between the items of a itemize or enumerate
1046 pit_type nextpit = pit + 1;
1047 if (nextpit != pit_type(pars.size())) {
1048 pit_type cpit = pit;
1050 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1051 double usual = pars[cpit].layout().bottomsep * dh;
1053 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1054 if (pars[cpit].layout() != pars[nextpit].layout()
1055 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1056 unusual = pars[cpit].layout().bottomsep * dh;
1057 layoutdesc = max(unusual, usual);
1058 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1059 if (pars[cpit].layout() != pars[nextpit].layout()
1060 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1061 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1065 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1069 void TextMetrics::setRowHeight(Row & row) const
1071 Paragraph const & par = text_->getPar(row.pit());
1072 Layout const & layout = par.layout();
1073 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1075 // Initial value for ascent (useful if row is empty).
1076 Font const font = displayFont(row.pit(), row.pos());
1077 FontMetrics const & fm = theFontMetrics(font);
1078 int maxasc = int(fm.maxAscent() * spacing_val);
1079 int maxdes = int(fm.maxDescent() * spacing_val);
1081 // Find the ascent/descent of the row contents
1082 Row::const_iterator cit = row.begin();
1083 Row::const_iterator cend = row.end();
1084 for ( ; cit != cend; ++cit) {
1086 maxasc = max(maxasc, cit->dim.ascent());
1087 maxdes = max(maxdes, cit->dim.descent());
1089 FontMetrics const & fm = theFontMetrics(cit->font);
1090 maxasc = max(maxasc, int(fm.maxAscent() * spacing_val));
1091 maxdes = max(maxdes, int(fm.maxDescent() * spacing_val));
1095 // This is nicer with box insets
1099 row.dimension().asc = maxasc;
1100 row.dimension().des = maxdes;
1104 // x is an absolute screen coord
1105 // returns the column near the specified x-coordinate of the row
1106 // x is set to the real beginning of this column
1107 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1108 bool & boundary) const
1110 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1111 /// For the main Text, it is possible that this pit is not
1112 /// yet in the CoordCache when moving cursor up.
1113 /// x Paragraph coordinate is always 0 for main text anyway.
1114 int const xo = origin_.x_;
1117 // Adapt to cursor row scroll offset if applicable.
1118 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1121 pos_type pos = row.pos();
1124 x = row.left_margin;
1125 else if (x <= row.left_margin) {
1126 pos = row.front().left_pos();
1127 x = row.left_margin;
1128 } else if (x >= row.width()) {
1129 pos = row.back().right_pos();
1132 double w = row.left_margin;
1133 Row::const_iterator cit = row.begin();
1134 Row::const_iterator cend = row.end();
1135 for ( ; cit != cend; ++cit) {
1136 if (w <= x && w + cit->full_width() > x) {
1137 int x_offset = int(x - w);
1138 pos = cit->x2pos(x_offset);
1139 x = int(x_offset + w);
1142 w += cit->full_width();
1144 if (cit == row.end()) {
1145 pos = row.back().right_pos();
1148 /** This tests for the case where the cursor is placed
1149 * just before a font direction change. See comment on
1150 * the boundary_ member in DocIterator.h to understand
1151 * how boundary helps here.
1153 else if (pos == cit->endpos
1154 && ((!cit->isRTL() && cit + 1 != row.end()
1155 && (cit + 1)->isRTL())
1156 || (cit->isRTL() && cit != row.begin()
1157 && !(cit - 1)->isRTL())))
1161 /** This tests for the case where the cursor is set at the end
1162 * of a row which has been broken due something else than a
1163 * separator (a display inset or a forced breaking of the
1164 * row). We know that there is a separator when the end of the
1165 * row is larger than the end of its last element.
1167 if (!row.empty() && pos == row.back().endpos
1168 && row.back().endpos == row.endpos()) {
1169 Inset const * inset = row.back().inset;
1170 if (inset && (inset->lyxCode() == NEWLINE_CODE
1171 || inset->lyxCode() == SEPARATOR_CODE))
1172 pos = row.back().pos;
1174 boundary = row.right_boundary();
1178 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1184 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1186 // We play safe and use parMetrics(pit) to make sure the
1187 // ParagraphMetrics will be redone and OK to use if needed.
1188 // Otherwise we would use an empty ParagraphMetrics in
1189 // upDownInText() while in selection mode.
1190 ParagraphMetrics const & pm = parMetrics(pit);
1192 LBUFERR(row < int(pm.rows().size()));
1194 Row const & r = pm.rows()[row];
1195 return getPosNearX(r, x, bound);
1199 void TextMetrics::newParMetricsDown()
1201 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1202 pit_type const pit = last.first + 1;
1203 if (pit == int(text_->paragraphs().size()))
1206 // do it and update its position.
1208 par_metrics_[pit].setPosition(last.second.position()
1209 + last.second.descent() + par_metrics_[pit].ascent());
1213 void TextMetrics::newParMetricsUp()
1215 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1216 if (first.first == 0)
1219 pit_type const pit = first.first - 1;
1220 // do it and update its position.
1222 par_metrics_[pit].setPosition(first.second.position()
1223 - first.second.ascent() - par_metrics_[pit].descent());
1226 // y is screen coordinate
1227 pit_type TextMetrics::getPitNearY(int y)
1229 LASSERT(!text_->paragraphs().empty(), return -1);
1230 LASSERT(!par_metrics_.empty(), return -1);
1231 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1233 // look for highest numbered paragraph with y coordinate less than given y
1236 ParMetricsCache::const_iterator it = par_metrics_.begin();
1237 ParMetricsCache::const_iterator et = par_metrics_.end();
1238 ParMetricsCache::const_iterator last = et;
1241 ParagraphMetrics const & pm = it->second;
1243 if (y < it->second.position() - int(pm.ascent())) {
1244 // We are looking for a position that is before the first paragraph in
1245 // the cache (which is in priciple off-screen, that is before the
1248 // We are already at the first paragraph in the inset.
1250 // OK, this is the paragraph we are looking for.
1251 pit = it->first - 1;
1256 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1258 if (y >= last->second.position() + int(pm_last.descent())) {
1259 // We are looking for a position that is after the last paragraph in
1260 // the cache (which is in priciple off-screen), that is before the
1262 pit = last->first + 1;
1263 if (pit == int(text_->paragraphs().size()))
1264 // We are already at the last paragraph in the inset.
1266 // OK, this is the paragraph we are looking for.
1267 newParMetricsDown();
1271 for (; it != et; ++it) {
1272 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1273 << " y: " << it->second.position());
1275 ParagraphMetrics const & pm = par_metrics_[it->first];
1277 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1279 yy = it->second.position();
1283 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1289 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1290 bool assert_in_view, bool up)
1292 ParagraphMetrics const & pm = par_metrics_[pit];
1294 int yy = pm.position() - pm.ascent();
1295 LBUFERR(!pm.rows().empty());
1296 RowList::const_iterator rit = pm.rows().begin();
1297 RowList::const_iterator rlast = pm.rows().end();
1299 for (; rit != rlast; yy += rit->height(), ++rit)
1300 if (yy + rit->height() > y)
1303 if (assert_in_view) {
1304 if (!up && yy + rit->height() > y) {
1305 if (rit != pm.rows().begin()) {
1308 } else if (pit != 0) {
1311 ParagraphMetrics const & pm2 = par_metrics_[pit];
1312 rit = pm2.rows().end();
1316 } else if (up && yy != y) {
1318 y = yy + rit->height();
1320 } else if (pit < int(text_->paragraphs().size()) - 1) {
1322 newParMetricsDown();
1323 ParagraphMetrics const & pm2 = par_metrics_[pit];
1324 rit = pm2.rows().begin();
1333 // x,y are absolute screen coordinates
1334 // sets cursor recursively descending into nested editable insets
1335 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1336 bool assert_in_view, bool up)
1338 if (lyxerr.debugging(Debug::WORKAREA)) {
1339 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1340 cur.bv().coordCache().dump();
1342 pit_type pit = getPitNearY(y);
1343 LASSERT(pit != -1, return 0);
1344 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1347 // Do we cover an inset?
1348 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1351 // No inset, set position in the text
1352 bool bound = false; // is modified by getPosNearX
1353 cur.pos() = getPosNearX(row, x, bound);
1354 cur.boundary(bound);
1355 cur.setCurrentFont();
1360 Inset * inset = it->inset;
1361 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1363 // Set position in front of inset
1364 cur.pos() = it->pos;
1365 cur.boundary(false);
1368 // Try to descend recursively inside the inset.
1369 Inset * edited = inset->editXY(cur, x, y);
1370 if (edited == inset && cur.pos() == it->pos) {
1371 // non-editable inset, set cursor after the inset if x is
1372 // nearer to that position (bug 9628)
1373 bool bound = false; // is modified by getPosNearX
1374 cur.pos() = getPosNearX(row, x, bound);
1375 cur.boundary(bound);
1376 cur.setCurrentFont();
1380 if (cur.top().text() == text_)
1381 cur.setCurrentFont();
1386 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1388 LASSERT(text_ == cur.text(), return);
1389 pit_type const pit = getPitNearY(y);
1390 LASSERT(pit != -1, return);
1392 ParagraphMetrics const & pm = par_metrics_[pit];
1394 int yy = pm.position() - pm.ascent();
1395 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1396 " pit: " << pit << " yy: " << yy);
1399 LBUFERR(pm.rows().size());
1400 for (; r < int(pm.rows().size()) - 1; ++r) {
1401 Row const & row = pm.rows()[r];
1402 if (int(yy + row.height()) > y)
1407 Row const & row = pm.rows()[r];
1409 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1413 pos_type const pos = getPosNearX(row, xx, bound);
1415 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1417 text_->setCursor(cur, pit, pos, true, bound);
1418 // remember new position.
1423 //takes screen x,y coordinates
1424 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1426 Paragraph const & par = text_->paragraphs()[pit];
1427 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1429 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1431 for (auto const & it : par.insetList()) {
1432 LYXERR(Debug::DEBUG, "examining inset " << it.inset);
1434 if (insetCache.covers(it.inset, x, y)) {
1435 LYXERR(Debug::DEBUG, "Hit inset: " << it.inset);
1436 return const_cast<InsetList::InsetTable *>(&it);
1440 LYXERR(Debug::DEBUG, "No inset hit. ");
1445 //takes screen x,y coordinates
1446 Inset * TextMetrics::checkInsetHit(int x, int y)
1448 pit_type const pit = getPitNearY(y);
1449 LASSERT(pit != -1, return 0);
1450 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1459 int TextMetrics::cursorX(CursorSlice const & sl,
1460 bool boundary) const
1462 LASSERT(sl.text() == text_, return 0);
1464 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1465 if (pm.rows().empty())
1467 Row const & row = pm.getRow(sl.pos(), boundary);
1468 pos_type const pos = sl.pos();
1471 row.findElement(pos, boundary, x);
1477 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1479 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1480 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1481 if (pm.rows().empty())
1485 h -= par_metrics_[0].rows()[0].ascent();
1486 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1487 h += par_metrics_[pit].height();
1490 if (pos && boundary)
1492 size_t const rend = pm.pos2row(pos);
1493 for (size_t rit = 0; rit != rend; ++rit)
1494 h += pm.rows()[rit].height();
1495 h += pm.rows()[rend].ascent();
1500 // the cursor set functions have a special mechanism. When they
1501 // realize you left an empty paragraph, they will delete it.
1503 bool TextMetrics::cursorHome(Cursor & cur)
1505 LASSERT(text_ == cur.text(), return false);
1506 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1507 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1508 return text_->setCursor(cur, cur.pit(), row.pos());
1512 bool TextMetrics::cursorEnd(Cursor & cur)
1514 LASSERT(text_ == cur.text(), return false);
1515 // if not on the last row of the par, put the cursor before
1516 // the final space exept if I have a spanning inset or one string
1517 // is so long that we force a break.
1518 pos_type end = cur.textRow().endpos();
1520 // empty text, end-1 is no valid position
1522 bool boundary = false;
1523 if (end != cur.lastpos()) {
1524 if (!cur.paragraph().isLineSeparator(end-1)
1525 && !cur.paragraph().isNewline(end-1)
1526 && !cur.paragraph().isEnvSeparator(end-1))
1530 } else if (cur.paragraph().isEnvSeparator(end-1))
1532 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1536 void TextMetrics::deleteLineForward(Cursor & cur)
1538 LASSERT(text_ == cur.text(), return);
1539 if (cur.lastpos() == 0) {
1540 // Paragraph is empty, so we just go forward
1541 text_->cursorForward(cur);
1544 cur.selection(true); // to avoid deletion
1547 // What is this test for ??? (JMarc)
1548 if (!cur.selection())
1549 text_->deleteWordForward(cur);
1551 cap::cutSelection(cur, true, false);
1552 cur.checkBufferStructure();
1557 bool TextMetrics::isLastRow(Row const & row) const
1559 ParagraphList const & pars = text_->paragraphs();
1560 return row.endpos() >= pars[row.pit()].size()
1561 && row.pit() + 1 == pit_type(pars.size());
1565 bool TextMetrics::isFirstRow(Row const & row) const
1567 return row.pos() == 0 && row.pit() == 0;
1571 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1573 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1577 int TextMetrics::leftMargin(int max_width,
1578 pit_type const pit, pos_type const pos) const
1580 ParagraphList const & pars = text_->paragraphs();
1582 LASSERT(pit >= 0, return 0);
1583 LASSERT(pit < int(pars.size()), return 0);
1584 Paragraph const & par = pars[pit];
1585 LASSERT(pos >= 0, return 0);
1586 LASSERT(pos <= par.size(), return 0);
1587 Buffer const & buffer = bv_->buffer();
1588 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1589 DocumentClass const & tclass = buffer.params().documentClass();
1590 Layout const & layout = par.layout();
1591 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1593 docstring parindent = layout.parindent;
1597 if (text_->isMainText())
1598 l_margin += bv_->leftMargin();
1600 l_margin += bfm.signedWidth(tclass.leftmargin());
1602 int depth = par.getDepth();
1604 // find the next level paragraph
1605 pit_type newpar = text_->outerHook(pit);
1606 if (newpar != pit_type(pars.size())) {
1607 if (pars[newpar].layout().isEnvironment()) {
1608 int nestmargin = depth * nestMargin();
1609 if (text_->isMainText())
1610 nestmargin += changebarMargin();
1611 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1612 // Remove the parindent that has been added
1613 // if the paragraph was empty.
1614 if (pars[newpar].empty() &&
1615 buffer.params().paragraph_separation ==
1616 BufferParams::ParagraphIndentSeparation) {
1617 docstring pi = pars[newpar].layout().parindent;
1618 l_margin -= bfm.signedWidth(pi);
1621 if (tclass.isDefaultLayout(par.layout())
1622 || tclass.isPlainLayout(par.layout())) {
1623 if (pars[newpar].params().noindent())
1626 parindent = pars[newpar].layout().parindent;
1631 // This happens after sections or environments in standard classes.
1632 // We have to check the previous layout at same depth.
1633 if (buffer.params().paragraph_separation ==
1634 BufferParams::ParagraphSkipSeparation)
1636 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1637 pit_type prev = text_->depthHook(pit, par.getDepth());
1638 if (par.layout() == pars[prev].layout()) {
1640 && pars[pit - 1].layout().nextnoindent)
1642 } else if (pars[prev].layout().nextnoindent)
1646 FontInfo const labelfont = text_->labelFont(par);
1647 FontMetrics const & lfm = theFontMetrics(labelfont);
1649 switch (layout.margintype) {
1650 case MARGIN_DYNAMIC:
1651 if (!layout.leftmargin.empty()) {
1652 l_margin += bfm.signedWidth(layout.leftmargin);
1654 if (!par.labelString().empty()) {
1655 l_margin += lfm.signedWidth(layout.labelindent);
1656 l_margin += lfm.width(par.labelString());
1657 l_margin += lfm.width(layout.labelsep);
1661 case MARGIN_MANUAL: {
1662 l_margin += lfm.signedWidth(layout.labelindent);
1663 // The width of an empty par, even with manual label, should be 0
1664 if (!par.empty() && pos >= par.beginOfBody()) {
1665 if (!par.getLabelWidthString().empty()) {
1666 docstring labstr = par.getLabelWidthString();
1667 l_margin += lfm.width(labstr);
1668 l_margin += lfm.width(layout.labelsep);
1674 case MARGIN_STATIC: {
1675 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1676 / (par.getDepth() + 4);
1680 case MARGIN_FIRST_DYNAMIC:
1681 if (layout.labeltype == LABEL_MANUAL) {
1682 // if we are at position 0, we are never in the body
1683 if (pos > 0 && pos >= par.beginOfBody())
1684 l_margin += lfm.signedWidth(layout.leftmargin);
1686 l_margin += lfm.signedWidth(layout.labelindent);
1688 // Special case to fix problems with
1690 || (layout.labeltype == LABEL_STATIC
1691 && layout.latextype == LATEX_ENVIRONMENT
1692 && !text_->isFirstInSequence(pit))) {
1693 l_margin += lfm.signedWidth(layout.leftmargin);
1694 } else if (!layout.labelIsAbove()) {
1695 l_margin += lfm.signedWidth(layout.labelindent);
1696 l_margin += lfm.width(layout.labelsep);
1697 l_margin += lfm.width(par.labelString());
1701 case MARGIN_RIGHT_ADDRESS_BOX: {
1703 // The left margin depends on the widest row in this paragraph.
1704 // This code is wrong because it depends on the rows, but at the
1705 // same time this function is used in redoParagraph to construct
1707 ParagraphMetrics const & pm = par_metrics_[pit];
1708 RowList::const_iterator rit = pm.rows().begin();
1709 RowList::const_iterator end = pm.rows().end();
1710 int minfill = max_width;
1711 for ( ; rit != end; ++rit)
1712 if (rit->fill() < minfill)
1713 minfill = rit->fill();
1714 l_margin += bfm.signedWidth(layout.leftmargin);
1715 l_margin += minfill;
1717 // also wrong, but much shorter.
1718 l_margin += max_width / 2;
1723 if (!par.params().leftIndent().zero())
1724 l_margin += par.params().leftIndent().inPixels(max_width, lfm.em());
1726 LyXAlignment align = par.getAlign();
1728 // set the correct parindent
1730 && (layout.labeltype == LABEL_NO_LABEL
1731 || layout.labeltype == LABEL_ABOVE
1732 || layout.labeltype == LABEL_CENTERED
1733 || (layout.labeltype == LABEL_STATIC
1734 && layout.latextype == LATEX_ENVIRONMENT
1735 && !text_->isFirstInSequence(pit)))
1736 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1737 && !par.params().noindent()
1738 // in some insets, paragraphs are never indented
1739 && !text_->inset().neverIndent()
1740 // display style insets are always centered, omit indentation
1743 && par.getInset(pos)->display())
1744 && (!(tclass.isDefaultLayout(par.layout())
1745 || tclass.isPlainLayout(par.layout()))
1746 || buffer.params().paragraph_separation
1747 == BufferParams::ParagraphIndentSeparation)) {
1748 /* use the parindent of the layout when the default
1749 * indentation is used otherwise use the indentation set in
1750 * the document settings
1752 if (buffer.params().getParIndent().empty())
1753 l_margin += bfm.signedWidth(parindent);
1755 l_margin += buffer.params().getParIndent().inPixels(max_width_, bfm.em());
1762 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1764 if (par_metrics_.empty())
1770 ParMetricsCache::iterator it = par_metrics_.begin();
1771 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1772 y -= it->second.ascent();
1773 for (; it != pm_end; ++it) {
1774 ParagraphMetrics const & pmi = it->second;
1776 pit_type const pit = it->first;
1777 // Save the paragraph position in the cache.
1778 it->second.setPosition(y);
1779 drawParagraph(pi, pit, x, y);
1785 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1787 ParagraphMetrics const & pm = par_metrics_[pit];
1788 if (pm.rows().empty())
1790 size_t const nrows = pm.rows().size();
1792 // Use fast lane when drawing is disabled.
1793 if (!pi.pain.isDrawingEnabled()) {
1794 for (size_t i = 0; i != nrows; ++i) {
1796 Row const & row = pm.rows()[i];
1797 // Adapt to cursor row scroll offset if applicable.
1798 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1802 RowPainter rp(pi, *text_, row, row_x, y);
1804 rp.paintOnlyInsets();
1810 int const ww = bv_->workHeight();
1811 Cursor const & cur = bv_->cursor();
1812 DocIterator sel_beg = cur.selectionBegin();
1813 DocIterator sel_end = cur.selectionEnd();
1814 bool selection = cur.selection()
1815 // This is our text.
1816 && cur.text() == text_
1817 // if the anchor is outside, this is not our selection
1818 && cur.normalAnchor().text() == text_
1819 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1821 // We store the begin and end pos of the selection relative to this par
1822 DocIterator sel_beg_par = cur.selectionBegin();
1823 DocIterator sel_end_par = cur.selectionEnd();
1825 // We care only about visible selection.
1827 if (pit != sel_beg.pit()) {
1828 sel_beg_par.pit() = pit;
1829 sel_beg_par.pos() = 0;
1831 if (pit != sel_end.pit()) {
1832 sel_end_par.pit() = pit;
1833 sel_end_par.pos() = sel_end_par.lastpos();
1837 for (size_t i = 0; i != nrows; ++i) {
1839 Row const & row = pm.rows()[i];
1840 // Adapt to cursor row scroll offset if applicable.
1841 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1845 RowPainter rp(pi, *text_, row, row_x, y);
1847 // It is not needed to draw on screen if we are not inside.
1848 bool const inside = (y + row.descent() >= 0
1849 && y - row.ascent() < ww);
1850 pi.pain.setDrawingEnabled(inside);
1852 // Paint only the insets to set inset cache correctly
1853 // FIXME: remove paintOnlyInsets when we know that positions
1854 // have already been set.
1855 rp.paintOnlyInsets();
1861 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1863 row.setSelection(-1, -1);
1865 // The row knows nothing about the paragraph, so we have to check
1866 // whether this row is the first or last and update the margins.
1867 if (row.selection()) {
1868 if (row.sel_beg == 0)
1869 row.begin_margin_sel = sel_beg.pit() < pit;
1870 if (row.sel_end == sel_end_par.lastpos())
1871 row.end_margin_sel = sel_end.pit() > pit;
1874 // Row signature; has row changed since last paint?
1875 row.setCrc(pm.computeRowSignature(row, *bv_));
1876 bool row_has_changed = row.changed()
1877 || bv_->hadHorizScrollOffset(text_, pit, row.pos());
1879 // Take this opportunity to spellcheck the row contents.
1880 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1881 text_->getPar(pit).spellCheck();
1884 // Don't paint the row if a full repaint has not been requested
1885 // and if it has not changed.
1886 if (!pi.full_repaint && !row_has_changed) {
1887 // Paint only the insets if the text itself is
1889 rp.paintOnlyInsets();
1894 // Clear background of this row if paragraph background was not
1895 // already cleared because of a full repaint.
1896 if (!pi.full_repaint && row_has_changed) {
1897 LYXERR(Debug::PAINTING, "Clear rect@("
1898 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1899 << width() << " x " << row.height());
1900 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1901 width(), row.height(), pi.background_color);
1904 // Instrumentation for testing row cache (see also
1906 if (lyxerr.debugging(Debug::PAINTING)
1907 && (row.selection() || pi.full_repaint || row_has_changed)) {
1908 string const foreword = text_->isMainText() ?
1909 "main text redraw " : "inset text redraw: ";
1910 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1911 << " row_selection=" << row.selection()
1912 << " full_repaint=" << pi.full_repaint
1913 << " row_has_changed=" << row_has_changed
1914 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1917 // Backup full_repaint status and force full repaint
1918 // for inner insets as the Row has been cleared out.
1919 bool tmp = pi.full_repaint;
1920 pi.full_repaint = true;
1922 rp.paintSelection();
1925 rp.paintChangeBar();
1926 if (i == 0 && !row.isRTL())
1928 if (i == nrows - 1 && row.isRTL())
1931 if (i == nrows - 1 && !row.isRTL())
1933 if (i == 0 && row.isRTL())
1935 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1936 row_x + row.right_x() > bv_->workWidth());
1939 // Restore full_repaint status.
1940 pi.full_repaint = tmp;
1942 // Re-enable screen drawing for future use of the painter.
1943 pi.pain.setDrawingEnabled(true);
1945 //LYXERR(Debug::PAINTING, ".");
1949 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1950 Dimension & dim) const
1952 Cursor const & bvcur = cur.bv().cursor();
1954 // get word in front of cursor
1955 docstring word = text_->previousWord(bvcur.top());
1956 DocIterator wordStart = bvcur;
1957 wordStart.pos() -= word.length();
1959 // calculate dimensions of the word
1961 row.pit(bvcur.pit());
1962 row.pos(wordStart.pos());
1963 row.endpos(bvcur.pos());
1965 dim = row.dimension();
1967 // get position on screen of the word start and end
1968 //FIXME: Is it necessary to explicitly set this to false?
1969 wordStart.boundary(false);
1970 Point lxy = cur.bv().getPos(wordStart);
1971 Point rxy = cur.bv().getPos(bvcur);
1972 dim.wid = abs(rxy.x_ - lxy.x_);
1974 // calculate position of word
1976 x = min(rxy.x_, lxy.x_);
1978 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1979 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1982 int defaultRowHeight()
1984 return int(theFontMetrics(sane_font).maxHeight() * 1.2);