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"
30 #include "InsetList.h"
34 #include "MetricsInfo.h"
35 #include "ParagraphParameters.h"
36 #include "RowPainter.h"
38 #include "TextClass.h"
41 #include "insets/InsetText.h"
43 #include "mathed/MathMacroTemplate.h"
45 #include "frontends/FontMetrics.h"
46 #include "frontends/Painter.h"
48 #include "support/debug.h"
49 #include "support/lassert.h"
59 using frontend::FontMetrics;
64 int numberOfLabelHfills(Paragraph const & par, Row const & row)
66 pos_type last = row.endpos() - 1;
67 pos_type first = row.pos();
69 // hfill *DO* count at the beginning of paragraphs!
71 while (first < last && par.isHfill(first))
75 last = min(last, par.beginOfBody());
77 for (pos_type p = first; p < last; ++p) {
84 // FIXME: this needs to be rewritten, probably by merging it into some
85 // code that, besides counting, sets the active status of the space
86 // inset in the row element.
87 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
88 pos_type const body_pos)
91 Row::const_iterator cit = row.begin();
92 Row::const_iterator const end = row.end();
93 for ( ; cit != end ; ++cit)
94 if (cit->pos >= body_pos
95 && cit->inset && pm.hfillExpansion(row, cit->pos))
103 /////////////////////////////////////////////////////////////////////
107 /////////////////////////////////////////////////////////////////////
110 TextMetrics::TextMetrics(BufferView * bv, Text * text)
111 : bv_(bv), text_(text)
114 max_width_ = bv_->workWidth();
115 dim_.wid = max_width_;
121 bool TextMetrics::contains(pit_type pit) const
123 return par_metrics_.find(pit) != par_metrics_.end();
127 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
129 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
134 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
136 ParMetricsCache::const_iterator it = par_metrics_.begin();
137 return make_pair(it->first, &it->second);
141 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
143 LBUFERR(!par_metrics_.empty());
144 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
145 return make_pair(it->first, &it->second);
149 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
151 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
152 if (pmc_it == par_metrics_.end()) {
153 pmc_it = par_metrics_.insert(
154 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
156 if (pmc_it->second.rows().empty() && redo)
158 return pmc_it->second;
162 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
164 LBUFERR(mi.base.textwidth > 0);
165 max_width_ = mi.base.textwidth;
166 // backup old dimension.
167 Dimension const old_dim = dim_;
170 dim_.wid = min_width;
171 pit_type const npar = text_->paragraphs().size();
173 // If there is more than one row, expand the text to
174 // the full allowable width.
175 dim_.wid = max_width_;
177 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
178 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
180 bool changed = false;
182 for (pit_type pit = 0; pit != npar; ++pit) {
183 changed |= redoParagraph(pit);
184 ParagraphMetrics const & pm = par_metrics_[pit];
186 if (dim_.wid < pm.width())
187 dim_.wid = pm.width();
190 dim_.asc = par_metrics_[0].ascent();
191 dim_.des = h - dim_.asc;
192 //lyxerr << "dim_.wid " << dim_.wid << endl;
193 //lyxerr << "dim_.asc " << dim_.asc << endl;
194 //lyxerr << "dim_.des " << dim_.des << endl;
196 changed |= dim_ != old_dim;
202 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
204 return text_->isMainText() ? pm.rightMargin(*bv_) : 0;
208 int TextMetrics::rightMargin(pit_type const pit) const
210 return text_->isMainText() ? par_metrics_[pit].rightMargin(*bv_) : 0;
214 void TextMetrics::applyOuterFont(Font & font) const
216 FontInfo lf(font_.fontInfo());
217 lf.reduce(bv_->buffer().params().getFont().fontInfo());
218 font.fontInfo().realize(lf);
222 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
224 LASSERT(pos >= 0, { static Font f; return f; });
226 ParagraphList const & pars = text_->paragraphs();
227 Paragraph const & par = pars[pit];
228 Layout const & layout = par.layout();
229 Buffer const & buffer = bv_->buffer();
231 BufferParams const & params = buffer.params();
232 pos_type const body_pos = par.beginOfBody();
234 // We specialize the 95% common case:
235 if (!par.getDepth()) {
236 Font f = par.getFontSettings(params, pos);
237 if (!text_->isMainText())
239 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
241 FontInfo const & lf = lab ? layout.labelfont : layout.font;
242 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
244 // In case the default family has been customized
245 if (lf.family() == INHERIT_FAMILY)
246 rlf.setFamily(params.getFont().fontInfo().family());
247 f.fontInfo().realize(rlf);
251 // The uncommon case need not be optimized as much
252 FontInfo const & layoutfont = pos < body_pos ?
253 layout.labelfont : layout.font;
255 Font font = par.getFontSettings(params, pos);
256 font.fontInfo().realize(layoutfont);
258 if (!text_->isMainText())
259 applyOuterFont(font);
261 // Realize against environment font information
262 // NOTE: the cast to pit_type should be removed when pit_type
263 // changes to a unsigned integer.
264 if (pit < pit_type(pars.size()))
265 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
267 // Realize with the fonts of lesser depth.
268 font.fontInfo().realize(params.getFont().fontInfo());
274 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
280 if (boundary && sl.pos() > 0)
283 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
287 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
289 // no RTL boundary at paragraph start
293 Font const & left_font = displayFont(pit, pos - 1);
295 return isRTLBoundary(pit, pos, left_font);
299 // isRTLBoundary returns false on a real end-of-line boundary,
300 // because otherwise the two boundary types get mixed up.
301 // This is the whole purpose of this being in TextMetrics.
302 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
303 Font const & font) const
305 if (// no RTL boundary at paragraph start
307 // if the metrics have not been calculated, then we are not
308 // on screen and can safely ignore issues about boundaries.
312 ParagraphMetrics & pm = par_metrics_[pit];
313 // no RTL boundary in empty paragraph
314 if (pm.rows().empty())
317 pos_type endpos = pm.getRow(pos - 1, false).endpos();
318 pos_type startpos = pm.getRow(pos, false).pos();
319 // no RTL boundary at line start:
320 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
322 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
325 Paragraph const & par = text_->getPar(pit);
326 // no RTL boundary at line break:
327 // abc|\n -> move right -> abc\n (and not: abc\n|
329 if (startpos == pos && endpos == pos && endpos != par.size()
330 && (par.isNewline(pos - 1)
331 || par.isEnvSeparator(pos - 1)
332 || par.isLineSeparator(pos - 1)
333 || par.isSeparator(pos - 1)))
336 bool left = font.isVisibleRightToLeft();
338 if (pos == par.size())
339 right = par.isRTL(bv_->buffer().params());
341 right = displayFont(pit, pos).isVisibleRightToLeft();
343 return left != right;
347 bool TextMetrics::redoParagraph(pit_type const pit)
349 Paragraph & par = text_->getPar(pit);
350 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
351 // redoParagraph() recursively inside parMetrics.
352 Dimension old_dim = parMetrics(pit, false).dim();
353 ParagraphMetrics & pm = par_metrics_[pit];
356 Buffer & buffer = bv_->buffer();
357 bool changed = false;
359 // Check whether there are InsetBibItems that need fixing
360 // FIXME: This check ought to be done somewhere else. It is the reason
361 // why text_ is not const. But then, where else to do it?
362 // Well, how can you end up with either (a) a biblio environment that
363 // has no InsetBibitem or (b) a biblio environment with more than one
364 // InsetBibitem? I think the answer is: when paragraphs are merged;
365 // when layout is set; when material is pasted.
366 if (par.brokenBiblio()) {
367 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
368 // In some cases, we do not know how to record undo
369 if (&cur.inset() == &text_->inset())
370 cur.recordUndo(pit, pit);
372 int const moveCursor = par.fixBiblio(buffer);
374 // Is it necessary to update the cursor?
375 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
378 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
383 // Optimisation: this is used in the next two loops
384 // so better to calculate that once here.
385 int const right_margin = rightMargin(pm);
387 // iterator pointing to paragraph to resolve macros
388 DocIterator parPos = text_->macrocontextPosition();
392 LYXERR(Debug::INFO, "MacroContext not initialised!"
393 << " Going through the buffer again and hope"
394 << " the context is better then.");
395 // FIXME audit updateBuffer calls
396 // This should not be here, but it is not clear yet where else it
398 bv_->buffer().updateBuffer();
399 parPos = text_->macrocontextPosition();
400 LBUFERR(!parPos.empty());
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);
438 par.setBeginOfBody();
440 size_t row_index = 0;
441 bool need_new_row = false;
442 // maximum pixel width of a row
444 if (row_index == pm.rows().size())
445 pm.rows().push_back(Row());
446 Row & row = pm.rows()[row_index];
450 need_new_row = breakRow(row, right_margin);
452 row.setChanged(false);
453 if (row_index || row.endpos() < par.size()
454 || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
455 /* If there is more than one row or the row has been
456 * broken by a display inset or a newline, expand the text
457 * to the full allowable width. This setting here is
458 * needed for the computeRowMetrics() below. In the case
459 * of a display inset, we do nothing when inside a table
460 * cell, because the tabular code is not prepared for
461 * that, and it triggers when using a caption in a
462 * longtable (see bugs #9945 and #9757).
464 if (dim_.wid < max_width_)
465 dim_.wid = max_width_;
467 int const max_row_width = max(dim_.wid, row.width());
468 computeRowMetrics(row, max_row_width);
469 first = row.endpos();
472 pm.dim().wid = max(pm.dim().wid, row.width());
473 pm.dim().des += row.height();
474 } while (first < par.size() || need_new_row);
476 if (row_index < pm.rows().size())
477 pm.rows().resize(row_index);
479 // FIXME: It might be better to move this in another method
480 // specially tailored for the main text.
481 // Top and bottom margin of the document (only at top-level)
482 if (text_->isMainText()) {
484 pm.rows().front().dimension().asc += 20;
485 /* coverity[copy_paste_error]: coverity thinks that we
486 * should update pm.dim().asc below, but all the rows
487 * heights are actually counted as part of the paragraph metric
488 * descent see loop above).
492 ParagraphList const & pars = text_->paragraphs();
493 if (pit + 1 == pit_type(pars.size())) {
494 pm.rows().back().dimension().des += 20;
499 // The space above and below the paragraph.
500 int const top = parTopSpacing(pit);
501 pm.rows().front().dimension().asc += top;
502 int const bottom = parBottomSpacing(pit);
503 pm.rows().back().dimension().des += bottom;
504 pm.dim().des += top + bottom;
506 pm.dim().asc += pm.rows()[0].ascent();
507 pm.dim().des -= pm.rows()[0].ascent();
509 changed |= old_dim.height() != pm.dim().height();
515 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
517 Layout const & layout = par.layout();
520 if (par.params().align() == LYX_ALIGN_LAYOUT)
521 align = layout.align;
523 align = par.params().align();
525 // handle alignment inside tabular cells
526 Inset const & owner = text_->inset();
527 bool forced_block = false;
528 switch (owner.contentAlignment()) {
529 case LYX_ALIGN_BLOCK:
530 // In general block align is the default state, but here it is
531 // an explicit choice. Therefore it should not be overridden
535 case LYX_ALIGN_CENTER:
537 case LYX_ALIGN_RIGHT:
538 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
539 align = owner.contentAlignment();
542 // unchanged (use align)
546 // Display-style insets should always be on a centered row
547 if (Inset const * inset = par.getInset(row.pos())) {
548 switch (inset->display()) {
549 case Inset::AlignLeft:
550 align = LYX_ALIGN_BLOCK;
552 case Inset::AlignCenter:
553 align = LYX_ALIGN_CENTER;
556 // unchanged (use align)
558 case Inset::AlignRight:
559 align = LYX_ALIGN_RIGHT;
564 if (align == LYX_ALIGN_BLOCK) {
565 // If this row has been broken abruptly by a display inset, or
566 // it is the end of the paragraph, or the user requested we
567 // not justify stuff, then don't stretch.
568 // A forced block alignment can only be overridden the 'no
569 // justification on screen' setting.
570 if (((row.right_boundary() || row.endpos() == par.size())
572 || !bv_->buffer().params().justification)
573 align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
580 void TextMetrics::computeRowMetrics(Row & row, int width) const
585 Paragraph const & par = text_->getPar(row.pit());
587 int const w = width - row.right_margin - row.width();
588 // FIXME: put back this assertion when the crash on new doc is solved.
589 //LASSERT(w >= 0, /**/);
591 // is there a manual margin with a manual label
592 Layout const & layout = par.layout();
595 if (layout.margintype == MARGIN_MANUAL
596 && layout.labeltype == LABEL_MANUAL) {
597 /// We might have real hfills in the label part
598 nlh = numberOfLabelHfills(par, row);
600 // A manual label par (e.g. List) has an auto-hfill
601 // between the label text and the body of the
603 // But we don't want to do this auto hfill if the par
608 if (nlh && !par.getLabelWidthString().empty())
609 row.label_hfill = labelFill(row) / double(nlh);
612 // are there any hfills in the row?
613 ParagraphMetrics & pm = par_metrics_[row.pit()];
614 int nh = numberOfHfills(row, pm, par.beginOfBody());
618 // We don't have to look at the alignment if the row is already
619 // larger then the permitted width as then we force the
620 // LEFT_ALIGN'edness!
621 if (int(row.width()) >= max_width_)
625 // Common case : there is no hfill, and the alignment will be
627 switch (getAlign(par, row)) {
628 case LYX_ALIGN_BLOCK: {
629 int const ns = row.countSeparators();
630 // If we have separators, then stretch the row
632 row.setSeparatorExtraWidth(double(w) / ns);
633 row.dimension().wid += w;
634 } else if (text_->isRTL(par)) {
635 row.left_margin += w;
636 row.dimension().wid += w;
640 case LYX_ALIGN_RIGHT:
641 row.left_margin += w;
642 row.dimension().wid += w;
644 case LYX_ALIGN_CENTER:
645 row.dimension().wid += w / 2;
646 row.left_margin += w / 2;
650 case LYX_ALIGN_LAYOUT:
651 case LYX_ALIGN_SPECIAL:
652 case LYX_ALIGN_DECIMAL:
660 row.dimension().wid += w;
661 // Set size of hfill insets
662 pos_type const endpos = row.endpos();
663 pos_type body_pos = par.beginOfBody();
665 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
668 CoordCache::Insets & insetCache = bv_->coordCache().insets();
669 Row::iterator cit = row.begin();
670 Row::iterator const cend = row.end();
671 for ( ; cit != cend; ++cit) {
672 if (row.label_hfill && cit->endpos == body_pos
673 && cit->type == Row::SPACE)
674 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
675 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
676 if (cit->pos >= body_pos) {
677 cit->dim.wid += hfill;
680 cit->dim.wid += hfill_rem;
682 cit->dim.wid += int(row.label_hfill);
683 // Cache the inset dimension.
684 insetCache.add(cit->inset, cit->dim);
690 int TextMetrics::labelFill(Row const & row) const
692 Paragraph const & par = text_->getPar(row.pit());
693 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
696 Row::const_iterator cit = row.begin();
697 Row::const_iterator const end = row.end();
698 // iterate over elements before main body (except the last one,
699 // which is extra space).
700 while (cit!= end && cit->endpos < par.beginOfBody()) {
705 docstring const & label = par.params().labelWidthString();
709 FontMetrics const & fm
710 = theFontMetrics(text_->labelFont(par));
712 return max(0, fm.width(label) - w);
717 // Not used, see TextMetrics::breakRow
718 // this needs special handling - only newlines count as a break point
719 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
721 pos_type const end = par.size();
724 if (par.isNewline(i))
732 int TextMetrics::labelEnd(pit_type const pit) const
734 // labelEnd is only needed if the layout fills a flushleft label.
735 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
737 // return the beginning of the body
738 return leftMargin(max_width_, pit);
744 * Calling Text::getFont is slow. While rebreaking we scan a
745 * paragraph from left to right calling getFont for every char. This
746 * simple class address this problem by hidding an optimization trick
747 * (not mine btw -AB): the font is reused in the whole font span. The
748 * class handles transparently the "hidden" (not part of the fontlist)
749 * label font (as getFont does).
755 FontIterator(TextMetrics const & tm,
756 Paragraph const & par, pit_type pit, pos_type pos)
757 : tm_(tm), par_(par), pit_(pit), pos_(pos),
758 font_(tm.displayFont(pit, pos)),
759 endspan_(par.fontSpan(pos).last),
760 bodypos_(par.beginOfBody())
764 Font const & operator*() const { return font_; }
767 FontIterator & operator++()
770 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
771 font_ = tm_.displayFont(pit_, pos_);
772 endspan_ = par_.fontSpan(pos_).last;
778 Font * operator->() { return &font_; }
782 TextMetrics const & tm_;
784 Paragraph const & par_;
799 /** This is the function where the hard work is done. The code here is
800 * very sensitive to small changes :) Note that part of the
801 * intelligence is also in Row::shortenIfNeeded.
803 bool TextMetrics::breakRow(Row & row, int const right_margin) const
805 Paragraph const & par = text_->getPar(row.pit());
806 pos_type const end = par.size();
807 pos_type const pos = row.pos();
808 pos_type const body_pos = par.beginOfBody();
809 bool const is_rtl = text_->isRTL(par);
810 bool need_new_row = false;
813 row.left_margin = leftMargin(max_width_, row.pit(), pos);
814 row.right_margin = right_margin;
816 swap(row.left_margin, row.right_margin);
817 // Remember that the row width takes into account the left_margin
818 // but not the right_margin.
819 row.dimension().wid = row.left_margin;
820 // the width available for the row.
821 int const width = max_width_ - row.right_margin;
823 if (pos >= end || row.width() > width) {
829 //FIXME: As long as leftMargin() is not correctly implemented for
830 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
831 // Otherwise, long rows will be painted off the screen.
832 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
833 return addressBreakPoint(pos, par);
836 // check for possible inline completion
837 DocIterator const & ic_it = bv_->inlineCompletionPos();
838 pos_type ic_pos = -1;
839 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == row.pit())
840 ic_pos = ic_it.pos();
842 // Now we iterate through until we reach the right margin
843 // or the end of the par, then build a representation of the row.
845 FontIterator fi = FontIterator(*this, par, row.pit(), pos);
847 // this can happen for an empty row after a newline
850 char_type c = par.getChar(i);
851 // The most special cases are handled first.
852 if (par.isInset(i)) {
853 Inset const * ins = par.getInset(i);
854 Dimension dim = bv_->coordCache().insets().dim(ins);
855 row.add(i, ins, dim, *fi, par.lookupChange(i));
856 } else if (c == ' ' && i + 1 == body_pos) {
857 // There is a space at i, but it should not be
858 // added as a separator, because it is just
859 // before body_pos. Instead, insert some spacing to
861 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
862 // this is needed to make sure that the row width is correct
864 int const add = max(fm.width(par.layout().labelsep),
865 labelEnd(row.pit()) - row.width());
866 row.addSpace(i, add, *fi, par.lookupChange(i));
867 } else if (c == '\t')
868 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
869 *fi, par.lookupChange(i));
871 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
872 // see also Paragraph::getUChar.
873 if (fi->language()->lang() == "hebrew") {
879 row.add(i, c, *fi, par.lookupChange(i));
882 // add inline completion width
883 // draw logically behind the previous character
884 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
885 docstring const comp = bv_->inlineCompletion();
886 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
890 f.fontInfo().setColor(Color_inlinecompletion);
891 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
893 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
894 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
897 // Handle some situations that abruptly terminate the row
899 // - Before a display inset
900 // - After a display inset
901 Inset const * inset = 0;
902 if (par.isNewline(i) || par.isEnvSeparator(i)
903 || (i + 1 < end && (inset = par.getInset(i + 1))
905 || (!row.empty() && row.back().inset
906 && row.back().inset->display())) {
907 row.right_boundary(true);
908 need_new_row = par.isNewline(i);
915 } while (i < end && row.width() <= width);
919 // End of paragraph marker
920 ParagraphList const & pars = text_->paragraphs();
921 if (lyxrc.paragraph_markers && !need_new_row
922 && i == end && size_type(row.pit() + 1) < pars.size()) {
923 // add a virtual element for the end-of-paragraph
924 // marker; it is shown on screen, but does not exist
926 Font f(text_->layoutFont(row.pit()));
927 f.fontInfo().setColor(Color_paragraphmarker);
928 BufferParams const & bparams
929 = text_->inset().buffer().params();
930 f.setLanguage(par.getParLanguage(bparams));
931 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
934 // if the row is too large, try to cut at last separator. In case
935 // of success, reset indication that the row was broken abruptly.
936 if (row.shortenIfNeeded(body_pos, width))
937 row.right_boundary(!row.empty() && row.back().endpos == row.endpos());
939 // make sure that the RTL elements are in reverse ordering
940 row.reverseRTL(is_rtl);
941 //LYXERR0("breakrow: row is " << row);
946 int TextMetrics::parTopSpacing(pit_type const pit) const
948 Paragraph const & par = text_->getPar(pit);
949 Layout const & layout = par.layout();
952 ParagraphList const & pars = text_->paragraphs();
953 double const dh = defaultRowHeight();
955 BufferParams const & bparams = bv_->buffer().params();
956 Inset const & inset = text_->inset();
957 // some parskips VERY EASY IMPLEMENTATION
958 if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
959 && !inset.getLayout().parbreakIsNewline()
960 && !par.layout().parbreak_is_newline
962 && ((layout.isParagraph() && par.getDepth() == 0)
963 || (pars[pit - 1].layout().isParagraph()
964 && pars[pit - 1].getDepth() == 0))) {
965 asc += bparams.getDefSkip().inPixels(*bv_);
968 if (par.params().startOfAppendix())
971 // special code for the top label
972 if (layout.labelIsAbove()
973 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
974 && !par.labelString().empty()) {
975 FontInfo labelfont = text_->labelFont(par);
976 FontMetrics const & lfm = theFontMetrics(labelfont);
977 asc += int(lfm.maxHeight() * layout.spacing.getValue()
978 * text_->spacing(par)
979 + (layout.topsep + layout.labelbottomsep) * dh);
982 // Add the layout spaces, for example before and after
983 // a section, or between the items of a itemize or enumerate
986 pit_type prev = text_->depthHook(pit, par.getDepth());
987 Paragraph const & prevpar = pars[prev];
988 double layoutasc = 0;
990 && prevpar.layout() == layout
991 && prevpar.getDepth() == par.getDepth()
992 && prevpar.getLabelWidthString() == par.getLabelWidthString()) {
993 layoutasc = layout.itemsep * dh;
994 } else if (pit != 0 && layout.topsep > 0)
995 layoutasc = layout.topsep * dh;
997 asc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
999 prev = text_->outerHook(pit);
1000 if (prev != pit_type(pars.size())) {
1001 asc += int(pars[prev].layout().parsep * dh);
1002 } else if (pit != 0) {
1003 Paragraph const & prevpar = pars[pit - 1];
1004 if (prevpar.getDepth() != 0 || prevpar.layout() == layout)
1005 asc += int(layout.parsep * dh);
1012 int TextMetrics::parBottomSpacing(pit_type const pit) const
1014 double layoutdesc = 0;
1015 ParagraphList const & pars = text_->paragraphs();
1016 double const dh = defaultRowHeight();
1018 // add the layout spaces, for example before and after
1019 // a section, or between the items of a itemize or enumerate
1021 pit_type nextpit = pit + 1;
1022 if (nextpit != pit_type(pars.size())) {
1023 pit_type cpit = pit;
1025 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1026 double usual = pars[cpit].layout().bottomsep * dh;
1028 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1029 if (pars[cpit].layout() != pars[nextpit].layout()
1030 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1031 unusual = pars[cpit].layout().bottomsep * dh;
1032 layoutdesc = max(unusual, usual);
1033 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1034 if (pars[cpit].layout() != pars[nextpit].layout()
1035 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1036 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1040 return int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1044 void TextMetrics::setRowHeight(Row & row) const
1046 Paragraph const & par = text_->getPar(row.pit());
1047 Layout const & layout = par.layout();
1048 double const spacing_val = layout.spacing.getValue() * text_->spacing(par);
1050 // Initial value for ascent (useful if row is empty).
1051 Font const font = displayFont(row.pit(), row.pos());
1052 FontMetrics const & fm = theFontMetrics(font);
1053 int maxasc = int(fm.maxAscent() * spacing_val);
1054 int maxdes = int(fm.maxDescent() * spacing_val);
1056 // Find the ascent/descent of the row contents
1057 Row::const_iterator cit = row.begin();
1058 Row::const_iterator cend = row.end();
1059 for ( ; cit != cend; ++cit) {
1061 maxasc = max(maxasc, cit->dim.ascent());
1062 maxdes = max(maxdes, cit->dim.descent());
1064 FontMetrics const & fm = theFontMetrics(cit->font);
1065 maxasc = max(maxasc, int(fm.maxAscent() * spacing_val));
1066 maxdes = max(maxdes, int(fm.maxDescent() * spacing_val));
1070 // This is nicer with box insets
1074 row.dimension().asc = maxasc;
1075 row.dimension().des = maxdes;
1079 // x is an absolute screen coord
1080 // returns the column near the specified x-coordinate of the row
1081 // x is set to the real beginning of this column
1082 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1083 bool & boundary) const
1085 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1086 /// For the main Text, it is possible that this pit is not
1087 /// yet in the CoordCache when moving cursor up.
1088 /// x Paragraph coordinate is always 0 for main text anyway.
1089 int const xo = origin_.x_;
1092 // Adapt to cursor row scroll offset if applicable.
1093 int const offset = bv_->horizScrollOffset(text_, row.pit(), row.pos());
1096 pos_type pos = row.pos();
1099 x = row.left_margin;
1100 else if (x <= row.left_margin) {
1101 pos = row.front().left_pos();
1102 x = row.left_margin;
1103 } else if (x >= row.width()) {
1104 pos = row.back().right_pos();
1107 double w = row.left_margin;
1108 Row::const_iterator cit = row.begin();
1109 Row::const_iterator cend = row.end();
1110 for ( ; cit != cend; ++cit) {
1111 if (w <= x && w + cit->full_width() > x) {
1112 int x_offset = int(x - w);
1113 pos = cit->x2pos(x_offset);
1114 x = int(x_offset + w);
1117 w += cit->full_width();
1119 if (cit == row.end()) {
1120 pos = row.back().right_pos();
1123 /** This tests for the case where the cursor is placed
1124 * just before a font direction change. See comment on
1125 * the boundary_ member in DocIterator.h to understand
1126 * how boundary helps here.
1128 else if (pos == cit->endpos
1129 && cit + 1 != row.end()
1130 && cit->isRTL() != (cit + 1)->isRTL())
1134 /** This tests for the case where the cursor is set at the end
1135 * of a row which has been broken due something else than a
1136 * separator (a display inset or a forced breaking of the
1137 * row). We know that there is a separator when the end of the
1138 * row is larger than the end of its last element.
1140 if (!row.empty() && pos == row.back().endpos
1141 && row.back().endpos == row.endpos()) {
1142 Inset const * inset = row.back().inset;
1143 if (inset && (inset->lyxCode() == NEWLINE_CODE
1144 || inset->lyxCode() == SEPARATOR_CODE))
1145 pos = row.back().pos;
1147 boundary = row.right_boundary();
1151 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1157 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1159 // We play safe and use parMetrics(pit) to make sure the
1160 // ParagraphMetrics will be redone and OK to use if needed.
1161 // Otherwise we would use an empty ParagraphMetrics in
1162 // upDownInText() while in selection mode.
1163 ParagraphMetrics const & pm = parMetrics(pit);
1165 LBUFERR(row < int(pm.rows().size()));
1167 Row const & r = pm.rows()[row];
1168 return getPosNearX(r, x, bound);
1172 void TextMetrics::newParMetricsDown()
1174 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1175 pit_type const pit = last.first + 1;
1176 if (pit == int(text_->paragraphs().size()))
1179 // do it and update its position.
1181 par_metrics_[pit].setPosition(last.second.position()
1182 + last.second.descent() + par_metrics_[pit].ascent());
1186 void TextMetrics::newParMetricsUp()
1188 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1189 if (first.first == 0)
1192 pit_type const pit = first.first - 1;
1193 // do it and update its position.
1195 par_metrics_[pit].setPosition(first.second.position()
1196 - first.second.ascent() - par_metrics_[pit].descent());
1199 // y is screen coordinate
1200 pit_type TextMetrics::getPitNearY(int y)
1202 LASSERT(!text_->paragraphs().empty(), return -1);
1203 LASSERT(!par_metrics_.empty(), return -1);
1204 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1206 // look for highest numbered paragraph with y coordinate less than given y
1209 ParMetricsCache::const_iterator it = par_metrics_.begin();
1210 ParMetricsCache::const_iterator et = par_metrics_.end();
1211 ParMetricsCache::const_iterator last = et;
1214 ParagraphMetrics const & pm = it->second;
1216 if (y < it->second.position() - int(pm.ascent())) {
1217 // We are looking for a position that is before the first paragraph in
1218 // the cache (which is in priciple off-screen, that is before the
1221 // We are already at the first paragraph in the inset.
1223 // OK, this is the paragraph we are looking for.
1224 pit = it->first - 1;
1229 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1231 if (y >= last->second.position() + int(pm_last.descent())) {
1232 // We are looking for a position that is after the last paragraph in
1233 // the cache (which is in priciple off-screen), that is before the
1235 pit = last->first + 1;
1236 if (pit == int(text_->paragraphs().size()))
1237 // We are already at the last paragraph in the inset.
1239 // OK, this is the paragraph we are looking for.
1240 newParMetricsDown();
1244 for (; it != et; ++it) {
1245 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1246 << " y: " << it->second.position());
1248 ParagraphMetrics const & pm = par_metrics_[it->first];
1250 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1252 yy = it->second.position();
1256 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1262 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1263 bool assert_in_view, bool up)
1265 ParagraphMetrics const & pm = par_metrics_[pit];
1267 int yy = pm.position() - pm.ascent();
1268 LBUFERR(!pm.rows().empty());
1269 RowList::const_iterator rit = pm.rows().begin();
1270 RowList::const_iterator rlast = pm.rows().end();
1272 for (; rit != rlast; yy += rit->height(), ++rit)
1273 if (yy + rit->height() > y)
1276 if (assert_in_view) {
1277 if (!up && yy + rit->height() > y) {
1278 if (rit != pm.rows().begin()) {
1281 } else if (pit != 0) {
1284 ParagraphMetrics const & pm2 = par_metrics_[pit];
1285 rit = pm2.rows().end();
1289 } else if (up && yy != y) {
1291 y = yy + rit->height();
1293 } else if (pit < int(text_->paragraphs().size()) - 1) {
1295 newParMetricsDown();
1296 ParagraphMetrics const & pm2 = par_metrics_[pit];
1297 rit = pm2.rows().begin();
1306 // x,y are absolute screen coordinates
1307 // sets cursor recursively descending into nested editable insets
1308 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1309 bool assert_in_view, bool up)
1311 if (lyxerr.debugging(Debug::WORKAREA)) {
1312 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1313 cur.bv().coordCache().dump();
1315 pit_type pit = getPitNearY(y);
1316 LASSERT(pit != -1, return 0);
1318 int yy = y; // is modified by getPitAndRowNearY
1319 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1323 // Do we cover an inset?
1324 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1327 // No inset, set position in the text
1328 bool bound = false; // is modified by getPosNearX
1329 int xx = x; // is modified by getPosNearX
1330 cur.pos() = getPosNearX(row, xx, bound);
1331 cur.boundary(bound);
1332 cur.setCurrentFont();
1337 Inset * inset = it->inset;
1338 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1340 // Set position in front of inset
1341 cur.pos() = it->pos;
1342 cur.boundary(false);
1345 // Try to descend recursively inside the inset.
1346 Inset * edited = inset->editXY(cur, x, yy);
1347 if (edited == inset && cur.pos() == it->pos) {
1348 // non-editable inset, set cursor after the inset if x is
1349 // nearer to that position (bug 9628)
1350 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1351 Dimension const & dim = insetCache.dim(inset);
1352 Point p = insetCache.xy(inset);
1353 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1355 // "in front of" == "right of"
1356 if (abs(p.x_ - x) < abs(p.x_ + dim.wid - x))
1359 // "in front of" == "left of"
1360 if (abs(p.x_ + dim.wid - x) < abs(p.x_ - x))
1365 if (cur.top().text() == text_)
1366 cur.setCurrentFont();
1371 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1373 LASSERT(text_ == cur.text(), return);
1374 pit_type const pit = getPitNearY(y);
1375 LASSERT(pit != -1, return);
1377 ParagraphMetrics const & pm = par_metrics_[pit];
1379 int yy = pm.position() - pm.ascent();
1380 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1381 " pit: " << pit << " yy: " << yy);
1384 LBUFERR(pm.rows().size());
1385 for (; r < int(pm.rows().size()) - 1; ++r) {
1386 Row const & row = pm.rows()[r];
1387 if (int(yy + row.height()) > y)
1392 Row const & row = pm.rows()[r];
1394 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1398 pos_type const pos = getPosNearX(row, xx, bound);
1400 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1402 text_->setCursor(cur, pit, pos, true, bound);
1403 // remember new position.
1408 //takes screen x,y coordinates
1409 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1411 Paragraph const & par = text_->paragraphs()[pit];
1412 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1414 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1416 InsetList::const_iterator iit = par.insetList().begin();
1417 InsetList::const_iterator iend = par.insetList().end();
1418 for (; iit != iend; ++iit) {
1419 Inset * inset = iit->inset;
1421 LYXERR(Debug::DEBUG, "examining inset " << inset);
1423 if (!insetCache.has(inset)) {
1424 LYXERR(Debug::DEBUG, "inset has no cached position");
1428 Dimension const & dim = insetCache.dim(inset);
1429 Point p = insetCache.xy(inset);
1431 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1432 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1434 if (x >= p.x_ && x <= p.x_ + dim.wid
1435 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1436 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1437 return const_cast<InsetList::InsetTable *>(&(*iit));
1441 LYXERR(Debug::DEBUG, "No inset hit. ");
1446 //takes screen x,y coordinates
1447 Inset * TextMetrics::checkInsetHit(int x, int y)
1449 pit_type const pit = getPitNearY(y);
1450 LASSERT(pit != -1, return 0);
1451 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1460 Row::const_iterator const
1461 TextMetrics::findRowElement(Row const & row, pos_type const pos,
1462 bool const boundary, double & x) const
1465 * When boundary is true, position i is in the row element (pos, endpos)
1468 * whereas, when boundary is false, the test is
1470 * The correction below allows to handle both cases.
1472 int const boundary_corr = (boundary && pos) ? -1 : 0;
1474 x = row.left_margin;
1476 /** Early return in trivial cases
1477 * 1) the row is empty
1478 * 2) the position is the left-most position of the row; there
1479 * is a quirk here however: if the first element is virtual
1480 * (end-of-par marker for example), then we have to look
1484 || (pos == row.begin()->left_pos() && !boundary
1485 && !row.begin()->isVirtual()))
1488 Row::const_iterator cit = row.begin();
1489 for ( ; cit != row.end() ; ++cit) {
1490 /** Look whether the cursor is inside the element's
1491 * span. Note that it is necessary to take the
1492 * boundary into account, and to accept virtual
1493 * elements, which have pos == endpos.
1495 if (pos + boundary_corr >= cit->pos
1496 && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
1497 x += cit->pos2x(pos);
1500 x += cit->full_width();
1503 if (cit == row.end())
1510 int TextMetrics::cursorX(CursorSlice const & sl,
1511 bool boundary) const
1513 LASSERT(sl.text() == text_, return 0);
1515 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1516 if (pm.rows().empty())
1518 Row const & row = pm.getRow(sl.pos(), boundary);
1519 pos_type const pos = sl.pos();
1522 findRowElement(row, pos, boundary, x);
1528 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1530 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1531 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1532 if (pm.rows().empty())
1536 h -= par_metrics_[0].rows()[0].ascent();
1537 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1538 h += par_metrics_[pit].height();
1541 if (pos && boundary)
1543 size_t const rend = pm.pos2row(pos);
1544 for (size_t rit = 0; rit != rend; ++rit)
1545 h += pm.rows()[rit].height();
1546 h += pm.rows()[rend].ascent();
1551 // the cursor set functions have a special mechanism. When they
1552 // realize you left an empty paragraph, they will delete it.
1554 bool TextMetrics::cursorHome(Cursor & cur)
1556 LASSERT(text_ == cur.text(), return false);
1557 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1558 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1559 return text_->setCursor(cur, cur.pit(), row.pos());
1563 bool TextMetrics::cursorEnd(Cursor & cur)
1565 LASSERT(text_ == cur.text(), return false);
1566 // if not on the last row of the par, put the cursor before
1567 // the final space exept if I have a spanning inset or one string
1568 // is so long that we force a break.
1569 pos_type end = cur.textRow().endpos();
1571 // empty text, end-1 is no valid position
1573 bool boundary = false;
1574 if (end != cur.lastpos()) {
1575 if (!cur.paragraph().isLineSeparator(end-1)
1576 && !cur.paragraph().isNewline(end-1)
1577 && !cur.paragraph().isEnvSeparator(end-1))
1581 } else if (cur.paragraph().isEnvSeparator(end-1))
1583 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1587 void TextMetrics::deleteLineForward(Cursor & cur)
1589 LASSERT(text_ == cur.text(), return);
1590 if (cur.lastpos() == 0) {
1591 // Paragraph is empty, so we just go forward
1592 text_->cursorForward(cur);
1595 cur.selection(true); // to avoid deletion
1598 // What is this test for ??? (JMarc)
1599 if (!cur.selection())
1600 text_->deleteWordForward(cur);
1602 cap::cutSelection(cur, true, false);
1603 cur.checkBufferStructure();
1608 bool TextMetrics::isLastRow(Row const & row) const
1610 ParagraphList const & pars = text_->paragraphs();
1611 return row.endpos() >= pars[row.pit()].size()
1612 && row.pit() + 1 == pit_type(pars.size());
1616 bool TextMetrics::isFirstRow(Row const & row) const
1618 return row.pos() == 0 && row.pit() == 0;
1622 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1624 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1628 int TextMetrics::leftMargin(int max_width,
1629 pit_type const pit, pos_type const pos) const
1631 ParagraphList const & pars = text_->paragraphs();
1633 LASSERT(pit >= 0, return 0);
1634 LASSERT(pit < int(pars.size()), return 0);
1635 Paragraph const & par = pars[pit];
1636 LASSERT(pos >= 0, return 0);
1637 LASSERT(pos <= par.size(), return 0);
1638 Buffer const & buffer = bv_->buffer();
1639 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1640 DocumentClass const & tclass = buffer.params().documentClass();
1641 Layout const & layout = par.layout();
1642 FontMetrics const & bfm = theFontMetrics(buffer.params().getFont());
1644 docstring parindent = layout.parindent;
1648 if (text_->isMainText())
1649 l_margin += bv_->leftMargin();
1651 l_margin += bfm.signedWidth(tclass.leftmargin());
1653 int depth = par.getDepth();
1655 // find the next level paragraph
1656 pit_type newpar = text_->outerHook(pit);
1657 if (newpar != pit_type(pars.size())) {
1658 if (pars[newpar].layout().isEnvironment()) {
1659 int nestmargin = depth * nestMargin();
1660 if (text_->isMainText())
1661 nestmargin += changebarMargin();
1662 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1663 // Remove the parindent that has been added
1664 // if the paragraph was empty.
1665 if (pars[newpar].empty() &&
1666 buffer.params().paragraph_separation ==
1667 BufferParams::ParagraphIndentSeparation) {
1668 docstring pi = pars[newpar].layout().parindent;
1669 l_margin -= bfm.signedWidth(pi);
1672 if (tclass.isDefaultLayout(par.layout())
1673 || tclass.isPlainLayout(par.layout())) {
1674 if (pars[newpar].params().noindent())
1677 parindent = pars[newpar].layout().parindent;
1682 // This happens after sections or environments in standard classes.
1683 // We have to check the previous layout at same depth.
1684 if (buffer.params().paragraph_separation ==
1685 BufferParams::ParagraphSkipSeparation)
1687 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1688 pit_type prev = text_->depthHook(pit, par.getDepth());
1689 if (par.layout() == pars[prev].layout()) {
1691 && pars[pit - 1].layout().nextnoindent)
1693 } else if (pars[prev].layout().nextnoindent)
1697 FontInfo const labelfont = text_->labelFont(par);
1698 FontMetrics const & lfm = theFontMetrics(labelfont);
1700 switch (layout.margintype) {
1701 case MARGIN_DYNAMIC:
1702 if (!layout.leftmargin.empty()) {
1703 l_margin += bfm.signedWidth(layout.leftmargin);
1705 if (!par.labelString().empty()) {
1706 l_margin += lfm.signedWidth(layout.labelindent);
1707 l_margin += lfm.width(par.labelString());
1708 l_margin += lfm.width(layout.labelsep);
1712 case MARGIN_MANUAL: {
1713 l_margin += lfm.signedWidth(layout.labelindent);
1714 // The width of an empty par, even with manual label, should be 0
1715 if (!par.empty() && pos >= par.beginOfBody()) {
1716 if (!par.getLabelWidthString().empty()) {
1717 docstring labstr = par.getLabelWidthString();
1718 l_margin += lfm.width(labstr);
1719 l_margin += lfm.width(layout.labelsep);
1725 case MARGIN_STATIC: {
1726 l_margin += bfm.signedWidth(layout.leftmargin) * 4
1727 / (par.getDepth() + 4);
1731 case MARGIN_FIRST_DYNAMIC:
1732 if (layout.labeltype == LABEL_MANUAL) {
1733 // if we are at position 0, we are never in the body
1734 if (pos > 0 && pos >= par.beginOfBody())
1735 l_margin += lfm.signedWidth(layout.leftmargin);
1737 l_margin += lfm.signedWidth(layout.labelindent);
1739 // Special case to fix problems with
1741 || (layout.labeltype == LABEL_STATIC
1742 && layout.latextype == LATEX_ENVIRONMENT
1743 && !text_->isFirstInSequence(pit))) {
1744 l_margin += lfm.signedWidth(layout.leftmargin);
1745 } else if (!layout.labelIsAbove()) {
1746 l_margin += lfm.signedWidth(layout.labelindent);
1747 l_margin += lfm.width(layout.labelsep);
1748 l_margin += lfm.width(par.labelString());
1752 case MARGIN_RIGHT_ADDRESS_BOX: {
1754 // The left margin depends on the widest row in this paragraph.
1755 // This code is wrong because it depends on the rows, but at the
1756 // same time this function is used in redoParagraph to construct
1758 ParagraphMetrics const & pm = par_metrics_[pit];
1759 RowList::const_iterator rit = pm.rows().begin();
1760 RowList::const_iterator end = pm.rows().end();
1761 int minfill = max_width;
1762 for ( ; rit != end; ++rit)
1763 if (rit->fill() < minfill)
1764 minfill = rit->fill();
1765 l_margin += bfm.signedWidth(layout.leftmargin);
1766 l_margin += minfill;
1768 // also wrong, but much shorter.
1769 l_margin += max_width / 2;
1774 if (!par.params().leftIndent().zero())
1775 l_margin += par.params().leftIndent().inPixels(max_width, lfm.em());
1779 if (par.params().align() == LYX_ALIGN_LAYOUT)
1780 align = layout.align;
1782 align = par.params().align();
1784 // set the correct parindent
1786 && (layout.labeltype == LABEL_NO_LABEL
1787 || layout.labeltype == LABEL_ABOVE
1788 || layout.labeltype == LABEL_CENTERED
1789 || (layout.labeltype == LABEL_STATIC
1790 && layout.latextype == LATEX_ENVIRONMENT
1791 && !text_->isFirstInSequence(pit)))
1792 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1793 && !par.params().noindent()
1794 // in some insets, paragraphs are never indented
1795 && !text_->inset().neverIndent()
1796 // display style insets are always centered, omit indentation
1799 && par.getInset(pos)->display())
1800 && (!(tclass.isDefaultLayout(par.layout())
1801 || tclass.isPlainLayout(par.layout()))
1802 || buffer.params().paragraph_separation
1803 == BufferParams::ParagraphIndentSeparation)) {
1804 // use the parindent of the layout when the
1805 // default indentation is used otherwise use
1806 // the indentation set in the document
1808 if (buffer.params().getIndentation().asLyXCommand() == "default")
1809 l_margin += bfm.signedWidth(parindent);
1811 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1818 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1820 if (par_metrics_.empty())
1826 ParMetricsCache::iterator it = par_metrics_.begin();
1827 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1828 y -= it->second.ascent();
1829 for (; it != pm_end; ++it) {
1830 ParagraphMetrics const & pmi = it->second;
1832 pit_type const pit = it->first;
1833 // Save the paragraph position in the cache.
1834 it->second.setPosition(y);
1835 drawParagraph(pi, pit, x, y);
1841 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1843 ParagraphMetrics const & pm = par_metrics_[pit];
1844 if (pm.rows().empty())
1846 size_t const nrows = pm.rows().size();
1848 // Use fast lane when drawing is disabled.
1849 if (!pi.pain.isDrawingEnabled()) {
1850 for (size_t i = 0; i != nrows; ++i) {
1852 Row const & row = pm.rows()[i];
1853 // Adapt to cursor row scroll offset if applicable.
1854 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1858 RowPainter rp(pi, *text_, row, row_x, y);
1860 rp.paintOnlyInsets();
1866 int const ww = bv_->workHeight();
1867 Cursor const & cur = bv_->cursor();
1868 DocIterator sel_beg = cur.selectionBegin();
1869 DocIterator sel_end = cur.selectionEnd();
1870 bool selection = cur.selection()
1871 // This is our text.
1872 && cur.text() == text_
1873 // if the anchor is outside, this is not our selection
1874 && cur.normalAnchor().text() == text_
1875 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1877 // We store the begin and end pos of the selection relative to this par
1878 DocIterator sel_beg_par = cur.selectionBegin();
1879 DocIterator sel_end_par = cur.selectionEnd();
1881 // We care only about visible selection.
1883 if (pit != sel_beg.pit()) {
1884 sel_beg_par.pit() = pit;
1885 sel_beg_par.pos() = 0;
1887 if (pit != sel_end.pit()) {
1888 sel_end_par.pit() = pit;
1889 sel_end_par.pos() = sel_end_par.lastpos();
1893 for (size_t i = 0; i != nrows; ++i) {
1895 Row const & row = pm.rows()[i];
1896 // Adapt to cursor row scroll offset if applicable.
1897 int row_x = x - bv_->horizScrollOffset(text_, pit, row.pos());
1901 RowPainter rp(pi, *text_, row, row_x, y);
1903 // It is not needed to draw on screen if we are not inside.
1904 bool const inside = (y + row.descent() >= 0
1905 && y - row.ascent() < ww);
1906 pi.pain.setDrawingEnabled(inside);
1908 // Paint only the insets to set inset cache correctly
1909 // FIXME: remove paintOnlyInsets when we know that positions
1910 // have already been set.
1911 rp.paintOnlyInsets();
1917 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1919 row.setSelection(-1, -1);
1921 // The row knows nothing about the paragraph, so we have to check
1922 // whether this row is the first or last and update the margins.
1923 if (row.selection()) {
1924 if (row.sel_beg == 0)
1925 row.begin_margin_sel = sel_beg.pit() < pit;
1926 if (row.sel_end == sel_end_par.lastpos())
1927 row.end_margin_sel = sel_end.pit() > pit;
1930 // Row signature; has row changed since last paint?
1931 row.setCrc(pm.computeRowSignature(row, *bv_));
1932 bool row_has_changed = row.changed()
1933 || bv_->hadHorizScrollOffset(text_, pit, row.pos());
1935 // Take this opportunity to spellcheck the row contents.
1936 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1937 text_->getPar(pit).spellCheck();
1940 // Don't paint the row if a full repaint has not been requested
1941 // and if it has not changed.
1942 if (!pi.full_repaint && !row_has_changed) {
1943 // Paint only the insets if the text itself is
1945 rp.paintOnlyInsets();
1950 // Clear background of this row if paragraph background was not
1951 // already cleared because of a full repaint.
1952 if (!pi.full_repaint && row_has_changed) {
1953 LYXERR(Debug::PAINTING, "Clear rect@("
1954 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1955 << width() << " x " << row.height());
1956 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1957 width(), row.height(), pi.background_color);
1960 // Instrumentation for testing row cache (see also
1962 if (lyxerr.debugging(Debug::PAINTING)
1963 && (row.selection() || pi.full_repaint || row_has_changed)) {
1964 string const foreword = text_->isMainText() ?
1965 "main text redraw " : "inset text redraw: ";
1966 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1967 << " row_selection=" << row.selection()
1968 << " full_repaint=" << pi.full_repaint
1969 << " row_has_changed=" << row_has_changed
1970 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1973 // Backup full_repaint status and force full repaint
1974 // for inner insets as the Row has been cleared out.
1975 bool tmp = pi.full_repaint;
1976 pi.full_repaint = true;
1978 rp.paintSelection();
1981 rp.paintChangeBar();
1982 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1983 if (i == 0 && !is_rtl)
1985 if (i == nrows - 1 && is_rtl)
1988 if (i == nrows - 1 && !is_rtl)
1990 if (i == 0 && is_rtl)
1992 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
1993 row_x + row.right_x() > bv_->workWidth());
1996 // Restore full_repaint status.
1997 pi.full_repaint = tmp;
1999 // Re-enable screen drawing for future use of the painter.
2000 pi.pain.setDrawingEnabled(true);
2002 //LYXERR(Debug::PAINTING, ".");
2006 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2007 Dimension & dim) const
2009 Cursor const & bvcur = cur.bv().cursor();
2011 // get word in front of cursor
2012 docstring word = text_->previousWord(bvcur.top());
2013 DocIterator wordStart = bvcur;
2014 wordStart.pos() -= word.length();
2016 // calculate dimensions of the word
2018 row.pit(bvcur.pit());
2019 row.pos(wordStart.pos());
2020 row.endpos(bvcur.pos());
2022 dim = row.dimension();
2024 // get position on screen of the word start and end
2025 //FIXME: Is it necessary to explicitly set this to false?
2026 wordStart.boundary(false);
2027 Point lxy = cur.bv().getPos(wordStart);
2028 Point rxy = cur.bv().getPos(bvcur);
2029 dim.wid = abs(rxy.x_ - lxy.x_);
2031 // calculate position of word
2033 x = min(rxy.x_, lxy.x_);
2035 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2036 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2039 int defaultRowHeight()
2041 return int(theFontMetrics(sane_font).maxHeight() * 1.2);