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.
18 //#define KEEP_OLD_METRICS_CODE 1
22 #include "TextMetrics.h"
26 #include "buffer_funcs.h"
27 #include "BufferParams.h"
28 #include "BufferView.h"
29 #include "CoordCache.h"
31 #include "CutAndPaste.h"
33 #include "InsetList.h"
36 #include "MetricsInfo.h"
37 #include "ParagraphParameters.h"
38 #include "rowpainter.h"
40 #include "TextClass.h"
43 #include "insets/InsetText.h"
45 #include "mathed/MathMacroTemplate.h"
47 #include "frontends/FontMetrics.h"
48 #include "frontends/Painter.h"
50 #include "support/debug.h"
51 #include "support/lassert.h"
60 using frontend::FontMetrics;
64 int numberOfSeparators(Row const & row)
67 Row::const_iterator cit = row.begin();
68 Row::const_iterator const end = row.end();
69 for ( ; cit != end ; ++cit)
70 if (cit->type == Row::SEPARATOR)
76 void setSeparatorWidth(Row & row, double w)
79 Row::iterator it = row.begin();
80 Row::iterator const end = row.end();
81 for ( ; it != end ; ++it)
82 if (it->type == Row::SEPARATOR)
87 int numberOfLabelHfills(Paragraph const & par, Row const & row)
89 pos_type last = row.endpos() - 1;
90 pos_type first = row.pos();
92 // hfill *DO* count at the beginning of paragraphs!
94 while (first < last && par.isHfill(first))
98 last = min(last, par.beginOfBody());
100 for (pos_type p = first; p < last; ++p) {
108 int numberOfHfills(Row const & row, pos_type const body_pos)
111 Row::const_iterator cit = row.begin();
112 Row::const_iterator const end = row.end();
113 for ( ; cit != end ; ++cit)
114 if (cit->pos >= body_pos
115 && cit->inset && cit->inset->isHfill())
123 /////////////////////////////////////////////////////////////////////
127 /////////////////////////////////////////////////////////////////////
130 TextMetrics::TextMetrics(BufferView * bv, Text * text)
131 : bv_(bv), text_(text)
134 max_width_ = bv_->workWidth();
135 dim_.wid = max_width_;
141 bool TextMetrics::contains(pit_type pit) const
143 return par_metrics_.find(pit) != par_metrics_.end();
147 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
149 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
154 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
156 ParMetricsCache::const_iterator it = par_metrics_.begin();
157 return make_pair(it->first, &it->second);
161 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
163 LBUFERR(!par_metrics_.empty());
164 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
165 return make_pair(it->first, &it->second);
169 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
171 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
172 if (pmc_it == par_metrics_.end()) {
173 pmc_it = par_metrics_.insert(
174 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
176 if (pmc_it->second.rows().empty() && redo)
178 return pmc_it->second;
182 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
184 LBUFERR(mi.base.textwidth > 0);
185 max_width_ = mi.base.textwidth;
186 // backup old dimension.
187 Dimension const old_dim = dim_;
190 dim_.wid = min_width;
191 pit_type const npar = text_->paragraphs().size();
193 // If there is more than one row, expand the text to
194 // the full allowable width.
195 dim_.wid = max_width_;
197 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
198 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
200 bool changed = false;
202 for (pit_type pit = 0; pit != npar; ++pit) {
203 changed |= redoParagraph(pit);
204 ParagraphMetrics const & pm = par_metrics_[pit];
206 if (dim_.wid < pm.width())
207 dim_.wid = pm.width();
210 dim_.asc = par_metrics_[0].ascent();
211 dim_.des = h - dim_.asc;
212 //lyxerr << "dim_.wid " << dim_.wid << endl;
213 //lyxerr << "dim_.asc " << dim_.asc << endl;
214 //lyxerr << "dim_.des " << dim_.des << endl;
216 changed |= dim_ != old_dim;
222 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
224 return main_text_? pm.rightMargin(*bv_) : 0;
228 int TextMetrics::rightMargin(pit_type const pit) const
230 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
234 void TextMetrics::applyOuterFont(Font & font) const
236 FontInfo lf(font_.fontInfo());
237 lf.reduce(bv_->buffer().params().getFont().fontInfo());
238 font.fontInfo().realize(lf);
242 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
244 LASSERT(pos >= 0, { static Font f; return f; });
246 ParagraphList const & pars = text_->paragraphs();
247 Paragraph const & par = pars[pit];
248 Layout const & layout = par.layout();
249 Buffer const & buffer = bv_->buffer();
251 BufferParams const & params = buffer.params();
252 pos_type const body_pos = par.beginOfBody();
254 // We specialize the 95% common case:
255 if (!par.getDepth()) {
256 Font f = par.getFontSettings(params, pos);
257 if (!text_->isMainText())
259 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
261 FontInfo const & lf = lab ? layout.labelfont : layout.font;
262 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
264 // In case the default family has been customized
265 if (lf.family() == INHERIT_FAMILY)
266 rlf.setFamily(params.getFont().fontInfo().family());
267 f.fontInfo().realize(rlf);
271 // The uncommon case need not be optimized as much
272 FontInfo const & layoutfont = pos < body_pos ?
273 layout.labelfont : layout.font;
275 Font font = par.getFontSettings(params, pos);
276 font.fontInfo().realize(layoutfont);
278 if (!text_->isMainText())
279 applyOuterFont(font);
281 // Realize against environment font information
282 // NOTE: the cast to pit_type should be removed when pit_type
283 // changes to a unsigned integer.
284 if (pit < pit_type(pars.size()))
285 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
287 // Realize with the fonts of lesser depth.
288 font.fontInfo().realize(params.getFont().fontInfo());
294 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
296 if (!lyxrc.rtl_support || !sl.text())
300 if (boundary && sl.pos() > 0)
303 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
307 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
309 // no RTL boundary at paragraph start
310 if (!lyxrc.rtl_support || pos == 0)
313 Font const & left_font = displayFont(pit, pos - 1);
315 return isRTLBoundary(pit, pos, left_font);
319 // isRTLBoundary returns false on a real end-of-line boundary,
320 // because otherwise the two boundary types get mixed up.
321 // This is the whole purpose of this being in TextMetrics.
322 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
323 Font const & font) const
325 if (!lyxrc.rtl_support
326 // no RTL boundary at paragraph start
328 // if the metrics have not been calculated, then we are not
329 // on screen and can safely ignore issues about boundaries.
333 ParagraphMetrics & pm = par_metrics_[pit];
334 // no RTL boundary in empty paragraph
335 if (pm.rows().empty())
338 pos_type endpos = pm.getRow(pos - 1, false).endpos();
339 pos_type startpos = pm.getRow(pos, false).pos();
340 // no RTL boundary at line start:
341 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
343 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
346 Paragraph const & par = text_->getPar(pit);
347 // no RTL boundary at line break:
348 // abc|\n -> move right -> abc\n (and not: abc\n|
350 if (startpos == pos && endpos == pos && endpos != par.size()
351 && (par.isNewline(pos - 1)
352 || par.isLineSeparator(pos - 1)
353 || par.isSeparator(pos - 1)))
356 bool left = font.isVisibleRightToLeft();
358 if (pos == par.size())
359 right = par.isRTL(bv_->buffer().params());
361 right = displayFont(pit, pos).isVisibleRightToLeft();
363 return left != right;
367 bool TextMetrics::redoParagraph(pit_type const pit)
369 Paragraph & par = text_->getPar(pit);
370 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
371 // redoParagraph() recursively inside parMetrics.
372 Dimension old_dim = parMetrics(pit, false).dim();
373 ParagraphMetrics & pm = par_metrics_[pit];
376 Buffer & buffer = bv_->buffer();
377 main_text_ = (text_ == &buffer.text());
378 bool changed = false;
380 // Check whether there are InsetBibItems that need fixing
381 // FIXME: This check ought to be done somewhere else. It is the reason
382 // why text_ is not const. But then, where else to do it?
383 // Well, how can you end up with either (a) a biblio environment that
384 // has no InsetBibitem or (b) a biblio environment with more than one
385 // InsetBibitem? I think the answer is: when paragraphs are merged;
386 // when layout is set; when material is pasted.
387 if (par.brokenBiblio()) {
388 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
389 // In some cases, we do not know how to record undo
390 if (&cur.inset() == &text_->inset())
391 cur.recordUndo(ATOMIC_UNDO, pit, pit);
393 int const moveCursor = par.fixBiblio(buffer);
395 // Is it necessary to update the cursor?
396 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
399 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
404 // Optimisation: this is used in the next two loops
405 // so better to calculate that once here.
406 int const right_margin = rightMargin(pm);
408 // iterator pointing to paragraph to resolve macros
409 DocIterator parPos = text_->macrocontextPosition();
413 LYXERR(Debug::INFO, "MacroContext not initialised!"
414 << " Going through the buffer again and hope"
415 << " the context is better then.");
416 // FIXME audit updateBuffer calls
417 // This should not be here, but it is not clear yet where else it
419 bv_->buffer().updateBuffer();
420 parPos = text_->macrocontextPosition();
421 LBUFERR(!parPos.empty());
426 Font const bufferfont = buffer.params().getFont();
427 InsetList::const_iterator ii = par.insetList().begin();
428 InsetList::const_iterator iend = par.insetList().end();
429 for (; ii != iend; ++ii) {
430 // FIXME Doesn't this HAVE to be non-empty?
431 // position already initialized?
432 if (!parPos.empty()) {
433 parPos.pos() = ii->pos;
435 // A macro template would normally not be visible
436 // by itself. But the tex macro semantics allow
437 // recursion, so we artifically take the context
438 // after the macro template to simulate this.
439 if (ii->inset->lyxCode() == MATHMACRO_CODE)
443 // do the metric calculation
445 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
447 Font const & font = ii->inset->inheritFont() ?
448 displayFont(pit, ii->pos) : bufferfont;
449 MacroContext mc(&buffer, parPos);
450 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
451 ii->inset->metrics(mi, dim);
452 Dimension const old_dim = pm.insetDimension(ii->inset);
453 if (old_dim != dim) {
454 pm.setInsetDimension(ii->inset, dim);
459 par.setBeginOfBody();
461 size_t row_index = 0;
462 // maximum pixel width of a row
464 if (row_index == pm.rows().size())
465 pm.rows().push_back(Row());
466 Row & row = pm.rows()[row_index];
468 breakRow(row, right_margin, pit);
469 setRowHeight(row, pit);
470 row.setChanged(false);
471 if (row_index || row.endpos() < par.size())
472 // If there is more than one row, expand the text to
473 // the full allowable width. This setting here is needed
474 // for the computeRowMetrics() below.
475 dim_.wid = max_width_;
476 int const max_row_width = max(dim_.wid, row.width());
477 computeRowMetrics(pit, row, max_row_width);
478 first = row.endpos();
481 pm.dim().wid = max(pm.dim().wid, row.width());
482 pm.dim().des += row.height();
483 } while (first < par.size());
485 if (row_index < pm.rows().size())
486 pm.rows().resize(row_index);
488 // Make sure that if a par ends in newline, there is one more row
490 if (first > 0 && par.isNewline(first - 1)) {
491 if (row_index == pm.rows().size())
492 pm.rows().push_back(Row());
493 Row & row = pm.rows()[row_index];
496 setRowHeight(row, pit);
497 row.setChanged(false);
498 int const max_row_width = max(dim_.wid, row.width());
499 computeRowMetrics(pit, row, max_row_width);
500 pm.dim().des += row.height();
503 pm.dim().asc += pm.rows()[0].ascent();
504 pm.dim().des -= pm.rows()[0].ascent();
506 changed |= old_dim.height() != pm.dim().height();
512 int TextMetrics::getAlign(Paragraph const & par, pos_type const pos) const
514 Layout const & layout = par.layout();
517 if (par.params().align() == LYX_ALIGN_LAYOUT)
518 align = layout.align;
520 align = par.params().align();
522 // handle alignment inside tabular cells
523 Inset const & owner = text_->inset();
524 switch (owner.contentAlignment()) {
525 case LYX_ALIGN_CENTER:
527 case LYX_ALIGN_RIGHT:
528 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
529 align = owner.contentAlignment();
532 // unchanged (use align)
536 // Display-style insets should always be on a centered row
537 if (Inset const * inset = par.getInset(pos)) {
538 switch (inset->display()) {
539 case Inset::AlignLeft:
540 align = LYX_ALIGN_BLOCK;
542 case Inset::AlignCenter:
543 align = LYX_ALIGN_CENTER;
546 // unchanged (use align)
548 case Inset::AlignRight:
549 align = LYX_ALIGN_RIGHT;
554 // Has the user requested we not justify stuff?
555 if (!bv_->buffer().params().justification
556 && align == LYX_ALIGN_BLOCK)
557 align = LYX_ALIGN_LEFT;
563 void TextMetrics::computeRowMetrics(pit_type const pit,
564 Row & row, int width) const
569 Paragraph const & par = text_->getPar(pit);
571 double w = width - row.width();
572 // FIXME: put back this assertion when the crash on new doc is solved.
573 //LASSERT(w >= 0, /**/);
575 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
576 //lyxerr << "row.width() " << row.width() << endl;
577 //lyxerr << "w " << w << endl;
579 bool const is_rtl = text_->isRTL(par);
581 row.x = rightMargin(pit);
583 row.x = leftMargin(max_width_, pit, row.pos());
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(pit, row) / double(nlh);
607 // are there any hfills in the row?
608 if (int const nh = numberOfHfills(row, par.beginOfBody())) {
610 hfill = w / double(nh);
611 // we don't have to look at the alignment if it is ALIGN_LEFT and
612 // if the row is already larger then the permitted width as then
613 // we force the LEFT_ALIGN'edness!
614 } else if (int(row.width()) < max_width_) {
615 // is it block, flushleft or flushright?
616 // set x how you need it
617 int const align = getAlign(par, row.pos());
620 case LYX_ALIGN_BLOCK: {
621 int const ns = numberOfSeparators(row);
622 bool disp_inset = false;
623 if (row.endpos() < par.size()) {
624 Inset const * in = par.getInset(row.endpos());
626 disp_inset = in->display();
628 // If we have separators, this is not the last row of a
629 // par, does not end in newline, and is not row above a
630 // display inset... then stretch it
631 if (ns && row.endpos() < par.size()
632 && !par.isNewline(row.endpos() - 1)
634 setSeparatorWidth(row, w / ns);
635 row.dimension().wid = width;
636 //lyxerr << "row.separator " << row.separator << endl;
637 //lyxerr << "ns " << ns << endl;
639 row.dimension().wid = width;
644 case LYX_ALIGN_RIGHT:
645 row.dimension().wid = width;
648 case LYX_ALIGN_CENTER:
649 row.dimension().wid += w / 2;
657 pos_type body_pos = par.beginOfBody();
658 pos_type end = row.endpos();
661 && (body_pos > end || !par.isLineSeparator(body_pos - 1))) {
662 row.x += theFontMetrics(text_->labelFont(par)).
663 width(layout.labelsep);
665 row.x += row.label_hfill;
670 pos_type const endpos = row.endpos();
671 pos_type body_pos = par.beginOfBody();
673 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
676 ParagraphMetrics & pm = par_metrics_[pit];
677 Row::iterator cit = row.begin();
678 Row::iterator const cend = row.end();
679 for ( ; cit != cend; ++cit) {
680 if (row.label_hfill && cit->endpos == body_pos
681 && cit->type == Row::SPACE)
682 cit->dim.wid -= row.label_hfill * (nlh - 1);
683 if (!cit->inset || !cit->inset->isHfill())
685 if (pm.hfillExpansion(row, cit->pos))
686 cit->dim.wid = int(cit->pos >= body_pos ?
687 max(hfill, 5.0) : row.label_hfill);
690 // Cache the inset dimension.
691 bv_->coordCache().insets().add(cit->inset, cit->dim);
692 pm.setInsetDimension(cit->inset, cit->dim);
697 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
699 Paragraph const & par = text_->getPar(pit);
700 LBUFERR(par.beginOfBody() > 0);
703 Row::const_iterator cit = row.begin();
704 Row::const_iterator const end = row.end();
705 // iterate over elements before main body (except the last one,
706 // which is extra space).
707 while (cit!= end && cit->endpos < par.beginOfBody()) {
712 docstring const & label = par.params().labelWidthString();
716 FontMetrics const & fm
717 = theFontMetrics(text_->labelFont(par));
719 return max(0, fm.width(label) - w);
724 // Not used, see TextMetrics::breakRow
725 // this needs special handling - only newlines count as a break point
726 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
728 pos_type const end = par.size();
731 if (par.isNewline(i))
739 int TextMetrics::labelEnd(pit_type const pit) const
741 // labelEnd is only needed if the layout fills a flushleft label.
742 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
744 // return the beginning of the body
745 return leftMargin(max_width_, pit);
751 * Calling Text::getFont is slow. While rebreaking we scan a
752 * paragraph from left to right calling getFont for every char. This
753 * simple class address this problem by hidding an optimization trick
754 * (not mine btw -AB): the font is reused in the whole font span. The
755 * class handles transparently the "hidden" (not part of the fontlist)
756 * label font (as getFont does).
762 FontIterator(TextMetrics const & tm,
763 Paragraph const & par, pit_type pit, pos_type pos)
764 : tm_(tm), par_(par), pit_(pit), pos_(pos),
765 font_(tm.displayFont(pit, pos)),
766 endspan_(par.fontSpan(pos).last),
767 bodypos_(par.beginOfBody())
771 Font const & operator*() const { return font_; }
774 FontIterator & operator++()
777 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
778 font_ = tm_.displayFont(pit_, pos_);
779 endspan_ = par_.fontSpan(pos_).last;
785 Font * operator->() { return &font_; }
789 TextMetrics const & tm_;
791 Paragraph const & par_;
806 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
808 Paragraph const & par = text_->getPar(pit);
809 pos_type const end = par.size();
810 pos_type const pos = row.pos();
811 int const width = max_width_ - right_margin;
812 pos_type const body_pos = par.beginOfBody();
814 row.dimension().wid = leftMargin(max_width_, pit, pos);
815 row.right_margin = right_margin;
817 if (pos >= end || row.width() > width) {
818 row.dimension().wid += right_margin;
823 ParagraphMetrics const & pm = par_metrics_[pit];
824 ParagraphList const & pars = text_->paragraphs();
827 //FIXME: As long as leftMargin() is not correctly implemented for
828 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
829 // Otherwise, long rows will be painted off the screen.
830 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
831 return addressBreakPoint(pos, par);
834 // check for possible inline completion
835 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
836 pos_type inlineCompletionLPos = -1;
837 if (inlineCompletionPos.inTexted()
838 && inlineCompletionPos.text() == text_
839 && inlineCompletionPos.pit() == pit) {
840 // draw logically behind the previous character
841 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
844 // Now we iterate through until we reach the right margin
845 // or the end of the par, then build a representation of the row.
847 FontIterator fi = FontIterator(*this, par, pit, pos);
848 while (i < end && row.width() < width) {
849 char_type c = par.getChar(i);
850 // The most special cases are handled first.
851 if (par.isInset(i)) {
852 Inset const * ins = par.getInset(i);
853 Dimension dim = pm.insetDimension(ins);
854 row.add(i, ins, dim, *fi, par.lookupChange(i));
855 } else if (par.isLineSeparator(i)) {
856 // In theory, no inset has this property. If
857 // this is done, a new addSeparator which
858 // takes an inset as parameter should be
860 LATTEST(!par.isInset(i));
861 row.addSeparator(i, c, *fi, par.lookupChange(i));
862 } else if (c == '\t')
863 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
864 *fi, par.lookupChange(i));
866 row.add(i, c, *fi, par.lookupChange(i));
868 // end of paragraph marker
869 if (lyxrc.paragraph_markers
870 && i == end - 1 && size_type(pit + 1) < pars.size()) {
871 // enlarge the last character to hold the end-of-par marker
872 Font f(text_->layoutFont(pit));
873 f.fontInfo().setColor(Color_paragraphmarker);
874 row.addVirtual(i + 1, docstring(1, char_type(0x00B6)), f, Change());
877 // add inline completion width
878 if (inlineCompletionLPos == i &&
879 !bv_->inlineCompletion().empty()) {
881 f.fontInfo().setColor(Color_inlinecompletion);
882 row.addVirtual(i + 1, bv_->inlineCompletion(),
886 // Handle some situations that abruptly terminate the row
888 // - Before a display inset
889 // - After a display inset
890 Inset const * inset = 0;
892 || (i + 1 < end && (inset = par.getInset(i + 1))
894 || (!row.empty() && row.back().inset
895 && row.back().inset->display())) {
903 // add the auto-hfill from label end to the body
904 if (body_pos && i == body_pos) {
905 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
908 && row.back().type == Row::SEPARATOR) {
912 int const add = max(fm.width(par.layout().labelsep),
913 labelEnd(pit) - row.width());
914 row.addSpace(j, add, *fi, par.lookupChange(i));
921 // if the row is too large, try to cut at last separator.
922 row.shorten_if_needed(body_pos, width);
924 // if the row ends with a separator that is not at end of
925 // paragraph, remove it
926 if (!row.empty() && row.back().type == Row::SEPARATOR
927 && row.endpos() < par.size())
930 // make sure that the RTL elements are in reverse ordering
933 row.dimension().wid += right_margin;
937 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
938 bool topBottomSpace) const
940 Paragraph const & par = text_->getPar(pit);
941 // get the maximum ascent and the maximum descent
942 double layoutasc = 0;
943 double layoutdesc = 0;
944 double const dh = defaultRowHeight();
946 // ok, let us initialize the maxasc and maxdesc value.
947 // Only the fontsize count. The other properties
948 // are taken from the layoutfont. Nicer on the screen :)
949 Layout const & layout = par.layout();
951 // as max get the first character of this row then it can
952 // increase but not decrease the height. Just some point to
953 // start with so we don't have to do the assignment below too
955 Buffer const & buffer = bv_->buffer();
956 Font font = displayFont(pit, row.pos());
957 FontSize const tmpsize = font.fontInfo().size();
958 font.fontInfo() = text_->layoutFont(pit);
959 FontSize const size = font.fontInfo().size();
960 font.fontInfo().setSize(tmpsize);
962 FontInfo labelfont = text_->labelFont(par);
964 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
965 FontMetrics const & fontmetrics = theFontMetrics(font);
967 // these are minimum values
968 double const spacing_val = layout.spacing.getValue()
969 * text_->spacing(par);
970 //lyxerr << "spacing_val = " << spacing_val << endl;
971 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
972 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
974 // insets may be taller
975 ParagraphMetrics const & pm = par_metrics_[pit];
976 Row::const_iterator cit = row.begin();
977 Row::const_iterator cend = row.end();
978 for ( ; cit != cend; ++cit) {
980 Dimension const & dim = pm.insetDimension(cit->inset);
981 maxasc = max(maxasc, dim.ascent());
982 maxdesc = max(maxdesc, dim.descent());
986 // Check if any custom fonts are larger (Asger)
987 // This is not completely correct, but we can live with the small,
988 // cosmetic error for now.
992 par.highestFontInRange(row.pos(), row.endpos(), size);
993 if (maxsize > font.fontInfo().size()) {
994 // use standard paragraph font with the maximal size
995 FontInfo maxfont = font.fontInfo();
996 maxfont.setSize(maxsize);
997 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
998 maxasc = max(maxasc, maxfontmetrics.maxAscent());
999 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1002 // This is nicer with box insets:
1006 ParagraphList const & pars = text_->paragraphs();
1007 Inset const & inset = text_->inset();
1009 // is it a top line?
1010 if (row.pos() == 0 && topBottomSpace) {
1011 BufferParams const & bufparams = buffer.params();
1012 // some parskips VERY EASY IMPLEMENTATION
1013 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1014 && !inset.getLayout().parbreakIsNewline()
1015 && !par.layout().parbreak_is_newline
1017 && ((layout.isParagraph() && par.getDepth() == 0)
1018 || (pars[pit - 1].layout().isParagraph()
1019 && pars[pit - 1].getDepth() == 0))) {
1020 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1023 if (par.params().startOfAppendix())
1024 maxasc += int(3 * dh);
1026 // special code for the top label
1027 if (layout.labelIsAbove()
1028 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1029 && !par.labelString().empty()) {
1031 labelfont_metrics.maxHeight()
1032 * layout.spacing.getValue()
1033 * text_->spacing(par)
1034 + (layout.topsep + layout.labelbottomsep) * dh);
1037 // Add the layout spaces, for example before and after
1038 // a section, or between the items of a itemize or enumerate
1041 pit_type prev = text_->depthHook(pit, par.getDepth());
1042 Paragraph const & prevpar = pars[prev];
1044 && prevpar.layout() == layout
1045 && prevpar.getDepth() == par.getDepth()
1046 && prevpar.getLabelWidthString()
1047 == par.getLabelWidthString()) {
1048 layoutasc = layout.itemsep * dh;
1049 } else if (pit != 0 || row.pos() != 0) {
1050 if (layout.topsep > 0)
1051 layoutasc = layout.topsep * dh;
1054 prev = text_->outerHook(pit);
1055 if (prev != pit_type(pars.size())) {
1056 maxasc += int(pars[prev].layout().parsep * dh);
1057 } else if (pit != 0) {
1058 Paragraph const & prevpar = pars[pit - 1];
1059 if (prevpar.getDepth() != 0 ||
1060 prevpar.layout() == layout) {
1061 maxasc += int(layout.parsep * dh);
1066 // is it a bottom line?
1067 if (row.endpos() >= par.size() && topBottomSpace) {
1068 // add the layout spaces, for example before and after
1069 // a section, or between the items of a itemize or enumerate
1071 pit_type nextpit = pit + 1;
1072 if (nextpit != pit_type(pars.size())) {
1073 pit_type cpit = pit;
1075 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1076 double usual = pars[cpit].layout().bottomsep * dh;
1078 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1079 if (pars[cpit].layout() != pars[nextpit].layout()
1080 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1081 unusual = pars[cpit].layout().bottomsep * dh;
1082 layoutdesc = max(unusual, usual);
1083 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1084 if (pars[cpit].layout() != pars[nextpit].layout()
1085 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1086 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1091 // incalculate the layout spaces
1092 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1093 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1095 // FIXME: the correct way is to do the following is to move the
1096 // following code in another method specially tailored for the
1097 // main Text. The following test is thus bogus.
1098 // Top and bottom margin of the document (only at top-level)
1099 if (main_text_ && topBottomSpace) {
1100 if (pit == 0 && row.pos() == 0)
1102 if (pit + 1 == pit_type(pars.size()) &&
1103 row.endpos() == par.size() &&
1104 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1108 row.dimension().asc = maxasc + labeladdon;
1109 row.dimension().des = maxdesc;
1113 // x is an absolute screen coord
1114 // returns the column near the specified x-coordinate of the row
1115 // x is set to the real beginning of this column
1116 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1117 Row const & row, int & x, bool & boundary) const
1121 pos_type pos = row.pos();
1122 if (row.x >= x || row.empty())
1124 else if (x >= row.width() - row.right_margin) {
1125 x = row.width() - row.right_margin;
1126 pos = row.back().endpos;
1129 Row::const_iterator cit = row.begin();
1130 Row::const_iterator cend = row.end();
1131 for ( ; cit != cend; ++cit) {
1132 if (w <= x && w + cit->width() > x) {
1133 double x_offset = x - w;
1134 pos = cit->x2pos(x_offset);
1140 if (cit == row.end())
1141 lyxerr << "NOT FOUND!! x=" << x
1142 << ", wid=" << row.width() << endl;
1143 /** This tests for the case where the cursor is placed
1144 * just before a font direction change. See comment on
1145 * the boundary_ member in DocIterator.h to understand
1146 * how bounddary helps here.
1148 else if (pos == cit->endpos
1149 && cit + 1 != row.end()
1150 && cit->font.isVisibleRightToLeft() != (cit + 1)->font.isVisibleRightToLeft())
1154 /** This tests for the case where the cursor is set at the end
1155 * of a row which has been broken due to a display inset on
1156 * next row. This can be recognized because the end of the
1157 * last element is the same as the end of the row (there is no
1158 * separator at the end of the row)
1160 if (!row.empty() && pos == row.back().endpos
1161 && row.back().endpos == row.endpos())
1164 #if !defined(KEEP_OLD_METRICS_CODE)
1165 return pos - row.pos();
1167 Buffer const & buffer = bv_->buffer();
1169 /// For the main Text, it is possible that this pit is not
1170 /// yet in the CoordCache when moving cursor up.
1171 /// x Paragraph coordinate is always 0 for main text anyway.
1172 int const xo = origin_.x_;
1174 Paragraph const & par = text_->getPar(pit);
1176 bidi.computeTables(par, buffer, row);
1178 pos_type vc = row.pos();
1179 pos_type const end = row.endpos();
1181 Layout const & layout = par.layout();
1183 bool left_side = false;
1185 pos_type body_pos = par.beginOfBody();
1187 double tmpx = row.x;
1188 double last_tmpx = tmpx;
1191 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1194 // check for empty row
1196 x2 = int(tmpx) + xo;
1200 // This (rtl_support test) is not needed, but gives
1201 // some speedup if rtl_support == false
1202 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1204 // If lastrow is false, we don't need to compute
1205 // the value of rtl.
1206 bool const rtl_on_lastrow = lastrow ? text_->isRTL(par) : false;
1208 while (vc < end && tmpx <= x2) {
1209 c = bidi.vis2log(vc);
1211 if (body_pos > 0 && c == body_pos - 1) {
1212 FontMetrics const & fm = theFontMetrics(
1213 text_->labelFont(par));
1214 tmpx += row.label_hfill + fm.width(layout.labelsep);
1215 if (par.isLineSeparator(body_pos - 1))
1216 tmpx -= singleWidth(pit, body_pos - 1);
1219 tmpx += singleWidth(pit, c);
1220 if (par.isSeparator(c) && c >= body_pos)
1221 tmpx += row.separator;
1225 if ((tmpx + last_tmpx) / 2 > x2) {
1230 // This shouldn't happen. But we can reset and try to continue.
1231 LASSERT(vc <= end, vc = end);
1233 bool boundary2 = false;
1236 ((rtl_on_lastrow && left_side && vc == row.pos() && x2 < tmpx - 5) ||
1237 (!rtl_on_lastrow && !left_side && vc == end && x2 > tmpx + 5))) {
1238 if (!par.isNewline(end - 1))
1240 } else if (vc == row.pos()) {
1241 c = bidi.vis2log(vc);
1242 if (bidi.level(c) % 2 == 1)
1245 c = bidi.vis2log(vc - 1);
1246 bool const rtl = (bidi.level(c) % 2 == 1);
1247 if (left_side == rtl) {
1249 boundary2 = isRTLBoundary(pit, c);
1253 // I believe this code is not needed anymore (Jug 20050717)
1255 // The following code is necessary because the cursor position past
1256 // the last char in a row is logically equivalent to that before
1257 // the first char in the next row. That's why insets causing row
1258 // divisions -- Newline and display-style insets -- must be treated
1259 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1260 // Newline inset, air gap below:
1261 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1262 if (bidi.level(end -1) % 2 == 0)
1263 tmpx -= singleWidth(pit, end - 1);
1265 tmpx += singleWidth(pit, end - 1);
1269 // Air gap above display inset:
1270 if (row.pos() < end && c >= end && end < par.size()
1271 && par.isInset(end) && par.getInset(end)->display()) {
1274 // Air gap below display inset:
1275 if (row.pos() < end && c >= end && par.isInset(end - 1)
1276 && par.getInset(end - 1)->display()) {
1281 x2 = int(tmpx) + xo;
1282 pos_type const col = c - row.pos();
1284 if (abs(x2 - x) > 0.1 || boundary != boundary
1286 lyxerr << "new=(x=" << x << ", b=" << boundary << ", p=" << pos << "), "
1287 << "old=(x=" << x2 << ", b=" << boundary2 << ", p=" << c << "), " << row;
1290 if (!c || end == par.size())
1293 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1298 return min(col, end - 1 - row.pos());
1303 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1305 // We play safe and use parMetrics(pit) to make sure the
1306 // ParagraphMetrics will be redone and OK to use if needed.
1307 // Otherwise we would use an empty ParagraphMetrics in
1308 // upDownInText() while in selection mode.
1309 ParagraphMetrics const & pm = parMetrics(pit);
1311 LBUFERR(row < int(pm.rows().size()));
1313 Row const & r = pm.rows()[row];
1314 return r.pos() + getColumnNearX(pit, r, x, bound);
1318 void TextMetrics::newParMetricsDown()
1320 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1321 pit_type const pit = last.first + 1;
1322 if (pit == int(text_->paragraphs().size()))
1325 // do it and update its position.
1327 par_metrics_[pit].setPosition(last.second.position()
1328 + last.second.descent() + par_metrics_[pit].ascent());
1332 void TextMetrics::newParMetricsUp()
1334 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1335 if (first.first == 0)
1338 pit_type const pit = first.first - 1;
1339 // do it and update its position.
1341 par_metrics_[pit].setPosition(first.second.position()
1342 - first.second.ascent() - par_metrics_[pit].descent());
1345 // y is screen coordinate
1346 pit_type TextMetrics::getPitNearY(int y)
1348 LASSERT(!text_->paragraphs().empty(), return -1);
1349 LASSERT(!par_metrics_.empty(), return -1);
1350 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1352 // look for highest numbered paragraph with y coordinate less than given y
1355 ParMetricsCache::const_iterator it = par_metrics_.begin();
1356 ParMetricsCache::const_iterator et = par_metrics_.end();
1357 ParMetricsCache::const_iterator last = et;
1360 ParagraphMetrics const & pm = it->second;
1362 if (y < it->second.position() - int(pm.ascent())) {
1363 // We are looking for a position that is before the first paragraph in
1364 // the cache (which is in priciple off-screen, that is before the
1367 // We are already at the first paragraph in the inset.
1369 // OK, this is the paragraph we are looking for.
1370 pit = it->first - 1;
1375 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1377 if (y >= last->second.position() + int(pm_last.descent())) {
1378 // We are looking for a position that is after the last paragraph in
1379 // the cache (which is in priciple off-screen), that is before the
1381 pit = last->first + 1;
1382 if (pit == int(text_->paragraphs().size()))
1383 // We are already at the last paragraph in the inset.
1385 // OK, this is the paragraph we are looking for.
1386 newParMetricsDown();
1390 for (; it != et; ++it) {
1391 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1392 << " y: " << it->second.position());
1394 ParagraphMetrics const & pm = par_metrics_[it->first];
1396 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1398 yy = it->second.position();
1402 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1408 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1409 bool assert_in_view, bool up)
1411 ParagraphMetrics const & pm = par_metrics_[pit];
1413 int yy = pm.position() - pm.ascent();
1414 LBUFERR(!pm.rows().empty());
1415 RowList::const_iterator rit = pm.rows().begin();
1416 RowList::const_iterator rlast = pm.rows().end();
1418 for (; rit != rlast; yy += rit->height(), ++rit)
1419 if (yy + rit->height() > y)
1422 if (assert_in_view) {
1423 if (!up && yy + rit->height() > y) {
1424 if (rit != pm.rows().begin()) {
1427 } else if (pit != 0) {
1430 ParagraphMetrics const & pm2 = par_metrics_[pit];
1431 rit = pm2.rows().end();
1435 } else if (up && yy != y) {
1437 y = yy + rit->height();
1439 } else if (pit < int(text_->paragraphs().size()) - 1) {
1441 newParMetricsDown();
1442 ParagraphMetrics const & pm2 = par_metrics_[pit];
1443 rit = pm2.rows().begin();
1452 // x,y are absolute screen coordinates
1453 // sets cursor recursively descending into nested editable insets
1454 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1455 bool assert_in_view, bool up)
1457 if (lyxerr.debugging(Debug::WORKAREA)) {
1458 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1459 cur.bv().coordCache().dump();
1461 pit_type pit = getPitNearY(y);
1462 LASSERT(pit != -1, return 0);
1464 int yy = y; // is modified by getPitAndRowNearY
1465 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1469 // Do we cover an inset?
1470 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1473 // No inset, set position in the text
1474 bool bound = false; // is modified by getColumnNearX
1475 int xx = x; // is modified by getColumnNearX
1476 cur.pos() = row.pos()
1477 + getColumnNearX(pit, row, xx, bound);
1478 cur.boundary(bound);
1479 cur.setCurrentFont();
1484 Inset * inset = it->inset;
1485 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1487 // Set position in front of inset
1488 cur.pos() = it->pos;
1489 cur.boundary(false);
1492 // Try to descend recursively inside the inset.
1493 inset = inset->editXY(cur, x, yy);
1495 if (cur.top().text() == text_)
1496 cur.setCurrentFont();
1501 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1503 LASSERT(text_ == cur.text(), return);
1504 pit_type const pit = getPitNearY(y);
1505 LASSERT(pit != -1, return);
1507 ParagraphMetrics const & pm = par_metrics_[pit];
1509 int yy = pm.position() - pm.ascent();
1510 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1511 " pit: " << pit << " yy: " << yy);
1514 LBUFERR(pm.rows().size());
1515 for (; r < int(pm.rows().size()) - 1; ++r) {
1516 Row const & row = pm.rows()[r];
1517 if (int(yy + row.height()) > y)
1522 Row const & row = pm.rows()[r];
1524 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1528 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1530 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1532 text_->setCursor(cur, pit, pos, true, bound);
1533 // remember new position.
1538 //takes screen x,y coordinates
1539 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1541 Paragraph const & par = text_->paragraphs()[pit];
1542 ParagraphMetrics const & pm = par_metrics_[pit];
1544 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1546 InsetList::const_iterator iit = par.insetList().begin();
1547 InsetList::const_iterator iend = par.insetList().end();
1548 for (; iit != iend; ++iit) {
1549 Inset * inset = iit->inset;
1551 LYXERR(Debug::DEBUG, "examining inset " << inset);
1553 if (!bv_->coordCache().getInsets().has(inset)) {
1554 LYXERR(Debug::DEBUG, "inset has no cached position");
1558 Dimension const & dim = pm.insetDimension(inset);
1559 Point p = bv_->coordCache().getInsets().xy(inset);
1561 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1562 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1564 if (x >= p.x_ && x <= p.x_ + dim.wid
1565 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1566 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1567 return const_cast<InsetList::InsetTable *>(&(*iit));
1571 LYXERR(Debug::DEBUG, "No inset hit. ");
1576 //takes screen x,y coordinates
1577 Inset * TextMetrics::checkInsetHit(int x, int y)
1579 pit_type const pit = getPitNearY(y);
1580 LASSERT(pit != -1, return 0);
1581 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1590 int TextMetrics::cursorX(CursorSlice const & sl,
1591 bool boundary) const
1593 LASSERT(sl.text() == text_, return 0);
1594 pit_type const pit = sl.pit();
1595 pos_type pos = sl.pos();
1597 ParagraphMetrics const & pm = par_metrics_[pit];
1598 if (pm.rows().empty())
1600 Row const & row = pm.getRow(sl.pos(), boundary);
1605 * When boundary is true, position is on the row element (pos, endpos)
1607 * pos < pos <= endpos
1608 * whereas, when boundary is false, the test is
1609 * pos <= pos < endpos
1610 * The correction below allows to handle both cases.
1612 int const boundary_corr = (boundary && pos) ? -1 : 0;
1615 || (row.begin()->font.isRightToLeft()
1616 && pos == row.begin()->endpos))
1619 Row::const_iterator cit = row.begin();
1620 for ( ; cit != row.end() ; ++cit) {
1621 if (pos + boundary_corr >= cit->pos
1622 && pos + boundary_corr < cit->endpos) {
1623 x += cit->pos2x(pos);
1629 if (cit == row.end()
1630 && (row.back().font.isRightToLeft() || pos != row.back().endpos))
1631 lyxerr << "NOT FOUND!"
1632 << "pos=" << pos << "(" << boundary_corr << ")" << "\n"
1635 #ifdef KEEP_OLD_METRICS_CODE
1636 Paragraph const & par = text_->paragraphs()[pit];
1638 // Correct position in front of big insets
1639 bool const boundary_correction = pos != 0 && boundary;
1640 if (boundary_correction)
1643 pos_type cursor_vpos = 0;
1645 Buffer const & buffer = bv_->buffer();
1648 bidi.computeTables(par, buffer, row);
1650 pos_type const row_pos = row.pos();
1651 pos_type const end = row.endpos();
1652 // Spaces at logical line breaks in bidi text must be skipped during
1653 // cursor positioning. However, they may appear visually in the middle
1654 // of a row; they must be skipped, wherever they are...
1655 // * logically "abc_[HEBREW_\nHEBREW]"
1656 // * visually "abc_[_WERBEH\nWERBEH]"
1657 pos_type skipped_sep_vpos = -1;
1660 cursor_vpos = row_pos;
1661 else if (pos >= end)
1662 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1663 else if (pos > row_pos && pos >= end)
1664 //FIXME: this code is never reached!
1665 // (see http://www.lyx.org/trac/changeset/8251)
1666 // Place cursor after char at (logical) position pos - 1
1667 cursor_vpos = (bidi.level(pos - 1) % 2 == 0)
1668 ? bidi.log2vis(pos - 1) + 1 : bidi.log2vis(pos - 1);
1670 // Place cursor before char at (logical) position pos
1671 cursor_vpos = (bidi.level(pos) % 2 == 0)
1672 ? bidi.log2vis(pos) : bidi.log2vis(pos) + 1;
1674 pos_type body_pos = par.beginOfBody();
1676 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1679 // check for possible inline completion in this row
1680 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1681 pos_type inlineCompletionVPos = -1;
1682 if (inlineCompletionPos.inTexted()
1683 && inlineCompletionPos.text() == text_
1684 && inlineCompletionPos.pit() == pit
1685 && inlineCompletionPos.pos() - 1 >= row_pos
1686 && inlineCompletionPos.pos() - 1 < end) {
1687 // draw logically behind the previous character
1688 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1691 // Use font span to speed things up, see below
1695 // If the last logical character is a separator, skip it, unless
1696 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1697 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1698 skipped_sep_vpos = bidi.log2vis(end - 1);
1700 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1701 ParagraphList const & pars_ = text_->paragraphs();
1702 if (size_type(pit + 1) < pars_.size()) {
1703 FontInfo f(text_->layoutFont(pit));
1704 docstring const s = docstring(1, char_type(0x00B6));
1705 x2 += theFontMetrics(f).width(s);
1709 // Inline completion RTL special case row_pos == cursor_pos:
1710 // "__|b" => cursor_pos is right of __
1711 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1712 font = displayFont(pit, row_pos + 1);
1713 docstring const & completion = bv_->inlineCompletion();
1714 if (font.isRightToLeft() && completion.length() > 0)
1715 x2 += theFontMetrics(font.fontInfo()).width(completion);
1718 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1719 // Skip the separator which is at the logical end of the row
1720 if (vpos == skipped_sep_vpos)
1722 pos_type pos = bidi.vis2log(vpos);
1723 if (body_pos > 0 && pos == body_pos - 1) {
1724 FontMetrics const & labelfm = theFontMetrics(
1725 text_->labelFont(par));
1726 x2 += row.label_hfill + labelfm.width(par.layout().labelsep);
1727 if (par.isLineSeparator(body_pos - 1))
1728 x2 -= singleWidth(pit, body_pos - 1);
1731 // Use font span to speed things up, see above
1732 if (pos < font_span.first || pos > font_span.last) {
1733 font_span = par.fontSpan(pos);
1734 font = displayFont(pit, pos);
1737 x2 += pm.singleWidth(pos, font);
1739 // Inline completion RTL case:
1740 // "a__|b", __ of b => non-boundary a-pos is right of __
1741 if (vpos + 1 == inlineCompletionVPos
1742 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1743 font = displayFont(pit, vpos + 1);
1744 docstring const & completion = bv_->inlineCompletion();
1745 if (font.isRightToLeft() && completion.length() > 0)
1746 x2 += theFontMetrics(font.fontInfo()).width(completion);
1749 // Inline completion LTR case:
1750 // "b|__a", __ of b => non-boundary a-pos is in front of __
1751 if (vpos == inlineCompletionVPos
1752 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1753 font = displayFont(pit, vpos);
1754 docstring const & completion = bv_->inlineCompletion();
1755 if (!font.isRightToLeft() && completion.length() > 0)
1756 x2 += theFontMetrics(font.fontInfo()).width(completion);
1759 if (par.isSeparator(pos) && pos >= body_pos)
1760 x2 += row.separator;
1763 // see correction above
1764 if (boundary_correction) {
1765 if (isRTL(sl, boundary))
1766 x2 -= singleWidth(pit, pos);
1768 x2 += singleWidth(pit, pos);
1771 if (abs(x2 - x) > 0.01) {
1772 lyxerr << "cursorX: x2=" << x2 << ", x=" << x;
1773 if (cit == row.end())
1774 lyxerr << "Element not found for "
1775 << pos - boundary_corr << "(" << boundary_corr << ")";
1777 lyxerr << " in [" << cit->pos << "/"
1778 << pos - boundary_corr << "(" << boundary_corr << ")"
1779 << "/" << cit->endpos << "] of " << *cit << "\n";
1780 lyxerr << row <<endl;
1788 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1790 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1791 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1792 if (pm.rows().empty())
1796 h -= par_metrics_[0].rows()[0].ascent();
1797 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1798 h += par_metrics_[pit].height();
1801 if (pos && boundary)
1803 size_t const rend = pm.pos2row(pos);
1804 for (size_t rit = 0; rit != rend; ++rit)
1805 h += pm.rows()[rit].height();
1806 h += pm.rows()[rend].ascent();
1811 // the cursor set functions have a special mechanism. When they
1812 // realize you left an empty paragraph, they will delete it.
1814 bool TextMetrics::cursorHome(Cursor & cur)
1816 LASSERT(text_ == cur.text(), return false);
1817 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1818 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1819 return text_->setCursor(cur, cur.pit(), row.pos());
1823 bool TextMetrics::cursorEnd(Cursor & cur)
1825 LASSERT(text_ == cur.text(), return false);
1826 // if not on the last row of the par, put the cursor before
1827 // the final space exept if I have a spanning inset or one string
1828 // is so long that we force a break.
1829 pos_type end = cur.textRow().endpos();
1831 // empty text, end-1 is no valid position
1833 bool boundary = false;
1834 if (end != cur.lastpos()) {
1835 if (!cur.paragraph().isLineSeparator(end-1)
1836 && !cur.paragraph().isNewline(end-1))
1841 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1845 void TextMetrics::deleteLineForward(Cursor & cur)
1847 LASSERT(text_ == cur.text(), return);
1848 if (cur.lastpos() == 0) {
1849 // Paragraph is empty, so we just go forward
1850 text_->cursorForward(cur);
1853 cur.setSelection(true); // to avoid deletion
1856 // What is this test for ??? (JMarc)
1857 if (!cur.selection())
1858 text_->deleteWordForward(cur);
1860 cap::cutSelection(cur, true, false);
1861 cur.checkBufferStructure();
1866 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1868 ParagraphList const & pars = text_->paragraphs();
1869 return row.endpos() >= pars[pit].size()
1870 && pit + 1 == pit_type(pars.size());
1874 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1876 return row.pos() == 0 && pit == 0;
1880 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1882 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1886 int TextMetrics::leftMargin(int max_width,
1887 pit_type const pit, pos_type const pos) const
1889 ParagraphList const & pars = text_->paragraphs();
1891 LASSERT(pit >= 0, return 0);
1892 LASSERT(pit < int(pars.size()), return 0);
1893 Paragraph const & par = pars[pit];
1894 LASSERT(pos >= 0, return 0);
1895 LASSERT(pos <= par.size(), return 0);
1896 Buffer const & buffer = bv_->buffer();
1897 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1898 DocumentClass const & tclass = buffer.params().documentClass();
1899 Layout const & layout = par.layout();
1901 docstring parindent = layout.parindent;
1905 if (text_->isMainText())
1906 l_margin += bv_->leftMargin();
1908 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1909 tclass.leftmargin());
1911 if (par.getDepth() != 0) {
1912 // find the next level paragraph
1913 pit_type newpar = text_->outerHook(pit);
1914 if (newpar != pit_type(pars.size())) {
1915 if (pars[newpar].layout().isEnvironment()) {
1916 l_margin = leftMargin(max_width, newpar);
1917 // Remove the parindent that has been added
1918 // if the paragraph was empty.
1919 if (pars[newpar].empty()) {
1920 docstring pi = pars[newpar].layout().parindent;
1921 l_margin -= theFontMetrics(
1922 buffer.params().getFont()).signedWidth(pi);
1925 if (tclass.isDefaultLayout(par.layout())
1926 || tclass.isPlainLayout(par.layout())) {
1927 if (pars[newpar].params().noindent())
1930 parindent = pars[newpar].layout().parindent;
1935 // This happens after sections or environments in standard classes.
1936 // We have to check the previous layout at same depth.
1937 if (tclass.isDefaultLayout(par.layout()) && pit > 0
1938 && pars[pit - 1].getDepth() >= par.getDepth()) {
1939 pit_type prev = text_->depthHook(pit, par.getDepth());
1940 if (pars[prev < pit ? prev : pit - 1].layout().nextnoindent)
1944 FontInfo const labelfont = text_->labelFont(par);
1945 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1947 switch (layout.margintype) {
1948 case MARGIN_DYNAMIC:
1949 if (!layout.leftmargin.empty()) {
1950 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1953 if (!par.labelString().empty()) {
1954 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1955 l_margin += labelfont_metrics.width(par.labelString());
1956 l_margin += labelfont_metrics.width(layout.labelsep);
1960 case MARGIN_MANUAL: {
1961 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1962 // The width of an empty par, even with manual label, should be 0
1963 if (!par.empty() && pos >= par.beginOfBody()) {
1964 if (!par.getLabelWidthString().empty()) {
1965 docstring labstr = par.getLabelWidthString();
1966 l_margin += labelfont_metrics.width(labstr);
1967 l_margin += labelfont_metrics.width(layout.labelsep);
1973 case MARGIN_STATIC: {
1974 l_margin += theFontMetrics(buffer.params().getFont()).
1975 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1979 case MARGIN_FIRST_DYNAMIC:
1980 if (layout.labeltype == LABEL_MANUAL) {
1981 // if we are at position 0, we are never in the body
1982 if (pos > 0 && pos >= par.beginOfBody())
1983 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1985 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1987 // Special case to fix problems with
1989 || (layout.labeltype == LABEL_STATIC
1990 && layout.latextype == LATEX_ENVIRONMENT
1991 && !text_->isFirstInSequence(pit))) {
1992 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1993 } else if (!layout.labelIsAbove()) {
1994 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1995 l_margin += labelfont_metrics.width(layout.labelsep);
1996 l_margin += labelfont_metrics.width(par.labelString());
2000 case MARGIN_RIGHT_ADDRESS_BOX: {
2002 // The left margin depends on the widest row in this paragraph.
2003 // This code is wrong because it depends on the rows, but at the
2004 // same time this function is used in redoParagraph to construct
2006 ParagraphMetrics const & pm = par_metrics_[pit];
2007 RowList::const_iterator rit = pm.rows().begin();
2008 RowList::const_iterator end = pm.rows().end();
2009 int minfill = max_width;
2010 for ( ; rit != end; ++rit)
2011 if (rit->fill() < minfill)
2012 minfill = rit->fill();
2013 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
2014 l_margin += minfill;
2016 // also wrong, but much shorter.
2017 l_margin += max_width / 2;
2022 if (!par.params().leftIndent().zero())
2023 l_margin += par.params().leftIndent().inPixels(max_width);
2027 if (par.params().align() == LYX_ALIGN_LAYOUT)
2028 align = layout.align;
2030 align = par.params().align();
2032 // set the correct parindent
2034 && (layout.labeltype == LABEL_NO_LABEL
2035 || layout.labeltype == LABEL_ABOVE
2036 || layout.labeltype == LABEL_CENTERED
2037 || (layout.labeltype == LABEL_STATIC
2038 && layout.latextype == LATEX_ENVIRONMENT
2039 && !text_->isFirstInSequence(pit)))
2040 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2041 && !par.params().noindent()
2042 // in some insets, paragraphs are never indented
2043 && !text_->inset().neverIndent()
2044 // display style insets are always centered, omit indentation
2047 && par.getInset(pos)->display())
2048 && (!(tclass.isDefaultLayout(par.layout())
2049 || tclass.isPlainLayout(par.layout()))
2050 || buffer.params().paragraph_separation
2051 == BufferParams::ParagraphIndentSeparation)) {
2052 // use the parindent of the layout when the
2053 // default indentation is used otherwise use
2054 // the indentation set in the document
2056 if (buffer.params().getIndentation().asLyXCommand() == "default")
2057 l_margin += theFontMetrics(
2058 buffer.params().getFont()).signedWidth(parindent);
2060 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2067 #ifdef KEEP_OLD_METRICS_CODE
2068 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2070 ParagraphMetrics const & pm = par_metrics_[pit];
2072 return pm.singleWidth(pos, displayFont(pit, pos));
2076 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2078 if (par_metrics_.empty())
2084 ParMetricsCache::iterator it = par_metrics_.begin();
2085 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2086 y -= it->second.ascent();
2087 for (; it != pm_end; ++it) {
2088 ParagraphMetrics const & pmi = it->second;
2090 pit_type const pit = it->first;
2091 // Save the paragraph position in the cache.
2092 it->second.setPosition(y);
2093 drawParagraph(pi, pit, x, y);
2099 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2101 BufferParams const & bparams = bv_->buffer().params();
2102 ParagraphMetrics const & pm = par_metrics_[pit];
2103 if (pm.rows().empty())
2107 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2108 int const ww = bv_->workHeight();
2109 size_t const nrows = pm.rows().size();
2111 Cursor const & cur = bv_->cursor();
2112 DocIterator sel_beg = cur.selectionBegin();
2113 DocIterator sel_end = cur.selectionEnd();
2114 bool selection = cur.selection()
2115 // This is our text.
2116 && cur.text() == text_
2117 // if the anchor is outside, this is not our selection
2118 && cur.normalAnchor().text() == text_
2119 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2121 // We store the begin and end pos of the selection relative to this par
2122 DocIterator sel_beg_par = cur.selectionBegin();
2123 DocIterator sel_end_par = cur.selectionEnd();
2125 // We care only about visible selection.
2127 if (pit != sel_beg.pit()) {
2128 sel_beg_par.pit() = pit;
2129 sel_beg_par.pos() = 0;
2131 if (pit != sel_end.pit()) {
2132 sel_end_par.pit() = pit;
2133 sel_end_par.pos() = sel_end_par.lastpos();
2137 for (size_t i = 0; i != nrows; ++i) {
2139 Row const & row = pm.rows()[i];
2143 bool const inside = (y + row.descent() >= 0
2144 && y - row.ascent() < ww);
2145 // It is not needed to draw on screen if we are not inside.
2146 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2147 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2150 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2152 row.setSelection(-1, -1);
2154 // The row knows nothing about the paragraph, so we have to check
2155 // whether this row is the first or last and update the margins.
2156 if (row.selection()) {
2157 if (row.sel_beg == 0)
2158 row.begin_margin_sel = sel_beg.pit() < pit;
2159 if (row.sel_end == sel_end_par.lastpos())
2160 row.end_margin_sel = sel_end.pit() > pit;
2163 // Row signature; has row changed since last paint?
2164 row.setCrc(pm.computeRowSignature(row, bparams));
2165 bool row_has_changed = row.changed();
2167 // Take this opportunity to spellcheck the row contents.
2168 if (row_has_changed && lyxrc.spellcheck_continuously) {
2169 text_->getPar(pit).spellCheck();
2172 // Don't paint the row if a full repaint has not been requested
2173 // and if it has not changed.
2174 if (!pi.full_repaint && !row_has_changed) {
2175 // Paint only the insets if the text itself is
2177 rp.paintOnlyInsets();
2182 // Clear background of this row if paragraph background was not
2183 // already cleared because of a full repaint.
2184 if (!pi.full_repaint && row_has_changed) {
2185 pi.pain.fillRectangle(x, y - row.ascent(),
2186 width(), row.height(), pi.background_color);
2189 // Instrumentation for testing row cache (see also
2191 if (lyxerr.debugging(Debug::PAINTING) && inside
2192 && (row.selection() || pi.full_repaint || row_has_changed)) {
2193 string const foreword = text_->isMainText() ?
2194 "main text redraw " : "inset text redraw: ";
2195 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2196 << " row_selection=" << row.selection()
2197 << " full_repaint=" << pi.full_repaint
2198 << " row_has_changed=" << row_has_changed);
2201 // Backup full_repaint status and force full repaint
2202 // for inner insets as the Row has been cleared out.
2203 bool tmp = pi.full_repaint;
2204 pi.full_repaint = true;
2206 rp.paintSelection();
2209 rp.paintChangeBar();
2210 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2211 if (i == 0 && !is_rtl)
2213 if (i == nrows - 1 && is_rtl)
2216 if (i == nrows - 1 && !is_rtl)
2218 if (i == 0 && is_rtl)
2222 // Restore full_repaint status.
2223 pi.full_repaint = tmp;
2225 // Re-enable screen drawing for future use of the painter.
2226 pi.pain.setDrawingEnabled(original_drawing_state);
2228 //LYXERR(Debug::PAINTING, ".");
2232 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2233 Dimension & dim) const
2235 Cursor const & bvcur = cur.bv().cursor();
2237 // get word in front of cursor
2238 docstring word = text_->previousWord(bvcur.top());
2239 DocIterator wordStart = bvcur;
2240 wordStart.pos() -= word.length();
2242 // get position on screen of the word start and end
2243 //FIXME: Is it necessary to explicitly set this to false?
2244 wordStart.boundary(false);
2245 Point lxy = cur.bv().getPos(wordStart);
2246 Point rxy = cur.bv().getPos(bvcur);
2248 // calculate dimensions of the word
2250 row.pos(wordStart.pos());
2251 row.endpos(bvcur.pos());
2252 setRowHeight(row, bvcur.pit(), false);
2253 dim = row.dimension();
2254 dim.wid = abs(rxy.x_ - lxy.x_);
2256 // calculate position of word
2258 x = min(rxy.x_, lxy.x_);
2260 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2261 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2264 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2266 // ParagraphMetrics const & pm = par_metrics_[pit];
2267 // Row const & r = pm.rows()[row];
2273 int defaultRowHeight()
2275 return int(theFontMetrics(sane_font).maxHeight() * 1.2);