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"
24 #ifdef KEEP_OLD_METRICS_CODE
28 #include "buffer_funcs.h"
29 #include "BufferParams.h"
30 #include "BufferView.h"
31 #include "CoordCache.h"
33 #include "CutAndPaste.h"
35 #include "InsetList.h"
38 #include "MetricsInfo.h"
39 #include "ParagraphParameters.h"
40 #include "rowpainter.h"
42 #include "TextClass.h"
45 #include "insets/InsetText.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
52 #include "support/debug.h"
53 #include "support/lassert.h"
62 using frontend::FontMetrics;
66 int numberOfSeparators(Row const & row)
69 Row::const_iterator cit = row.begin();
70 Row::const_iterator const end = row.end();
71 for ( ; cit != end ; ++cit)
72 if (cit->type == Row::SEPARATOR)
78 void setSeparatorWidth(Row & row, double w)
81 Row::iterator it = row.begin();
82 Row::iterator const end = row.end();
83 for ( ; it != end ; ++it)
84 if (it->type == Row::SEPARATOR)
89 int numberOfLabelHfills(Paragraph const & par, Row const & row)
91 pos_type last = row.endpos() - 1;
92 pos_type first = row.pos();
94 // hfill *DO* count at the beginning of paragraphs!
96 while (first < last && par.isHfill(first))
100 last = min(last, par.beginOfBody());
102 for (pos_type p = first; p < last; ++p) {
110 int numberOfHfills(Row const & row, pos_type const body_pos)
113 Row::const_iterator cit = row.begin();
114 Row::const_iterator const end = row.end();
115 for ( ; cit != end ; ++cit)
116 if (cit->pos >= body_pos
117 && cit->inset && cit->inset->isHfill())
125 /////////////////////////////////////////////////////////////////////
129 /////////////////////////////////////////////////////////////////////
132 TextMetrics::TextMetrics(BufferView * bv, Text * text)
133 : bv_(bv), text_(text)
136 max_width_ = bv_->workWidth();
137 dim_.wid = max_width_;
143 bool TextMetrics::contains(pit_type pit) const
145 return par_metrics_.find(pit) != par_metrics_.end();
149 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
151 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
156 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
158 ParMetricsCache::const_iterator it = par_metrics_.begin();
159 return make_pair(it->first, &it->second);
163 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
165 LBUFERR(!par_metrics_.empty());
166 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
167 return make_pair(it->first, &it->second);
171 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
173 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
174 if (pmc_it == par_metrics_.end()) {
175 pmc_it = par_metrics_.insert(
176 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
178 if (pmc_it->second.rows().empty() && redo)
180 return pmc_it->second;
184 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
186 LBUFERR(mi.base.textwidth > 0);
187 max_width_ = mi.base.textwidth;
188 // backup old dimension.
189 Dimension const old_dim = dim_;
192 dim_.wid = min_width;
193 pit_type const npar = text_->paragraphs().size();
195 // If there is more than one row, expand the text to
196 // the full allowable width.
197 dim_.wid = max_width_;
199 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
200 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
202 bool changed = false;
204 for (pit_type pit = 0; pit != npar; ++pit) {
205 changed |= redoParagraph(pit);
206 ParagraphMetrics const & pm = par_metrics_[pit];
208 if (dim_.wid < pm.width())
209 dim_.wid = pm.width();
212 dim_.asc = par_metrics_[0].ascent();
213 dim_.des = h - dim_.asc;
214 //lyxerr << "dim_.wid " << dim_.wid << endl;
215 //lyxerr << "dim_.asc " << dim_.asc << endl;
216 //lyxerr << "dim_.des " << dim_.des << endl;
218 changed |= dim_ != old_dim;
224 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
226 return main_text_? pm.rightMargin(*bv_) : 0;
230 int TextMetrics::rightMargin(pit_type const pit) const
232 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
236 void TextMetrics::applyOuterFont(Font & font) const
238 FontInfo lf(font_.fontInfo());
239 lf.reduce(bv_->buffer().params().getFont().fontInfo());
240 font.fontInfo().realize(lf);
244 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
246 LASSERT(pos >= 0, { static Font f; return f; });
248 ParagraphList const & pars = text_->paragraphs();
249 Paragraph const & par = pars[pit];
250 Layout const & layout = par.layout();
251 Buffer const & buffer = bv_->buffer();
253 BufferParams const & params = buffer.params();
254 pos_type const body_pos = par.beginOfBody();
256 // We specialize the 95% common case:
257 if (!par.getDepth()) {
258 Font f = par.getFontSettings(params, pos);
259 if (!text_->isMainText())
261 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
263 FontInfo const & lf = lab ? layout.labelfont : layout.font;
264 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
266 // In case the default family has been customized
267 if (lf.family() == INHERIT_FAMILY)
268 rlf.setFamily(params.getFont().fontInfo().family());
269 f.fontInfo().realize(rlf);
273 // The uncommon case need not be optimized as much
274 FontInfo const & layoutfont = pos < body_pos ?
275 layout.labelfont : layout.font;
277 Font font = par.getFontSettings(params, pos);
278 font.fontInfo().realize(layoutfont);
280 if (!text_->isMainText())
281 applyOuterFont(font);
283 // Realize against environment font information
284 // NOTE: the cast to pit_type should be removed when pit_type
285 // changes to a unsigned integer.
286 if (pit < pit_type(pars.size()))
287 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
289 // Realize with the fonts of lesser depth.
290 font.fontInfo().realize(params.getFont().fontInfo());
296 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
298 if (!lyxrc.rtl_support || !sl.text())
302 if (boundary && sl.pos() > 0)
305 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
309 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
311 // no RTL boundary at paragraph start
312 if (!lyxrc.rtl_support || pos == 0)
315 Font const & left_font = displayFont(pit, pos - 1);
317 return isRTLBoundary(pit, pos, left_font);
321 // isRTLBoundary returns false on a real end-of-line boundary,
322 // because otherwise the two boundary types get mixed up.
323 // This is the whole purpose of this being in TextMetrics.
324 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
325 Font const & font) const
327 if (!lyxrc.rtl_support
328 // no RTL boundary at paragraph start
330 // if the metrics have not been calculated, then we are not
331 // on screen and can safely ignore issues about boundaries.
335 ParagraphMetrics & pm = par_metrics_[pit];
336 // no RTL boundary in empty paragraph
337 if (pm.rows().empty())
340 pos_type endpos = pm.getRow(pos - 1, false).endpos();
341 pos_type startpos = pm.getRow(pos, false).pos();
342 // no RTL boundary at line start:
343 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
345 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
348 Paragraph const & par = text_->getPar(pit);
349 // no RTL boundary at line break:
350 // abc|\n -> move right -> abc\n (and not: abc\n|
352 if (startpos == pos && endpos == pos && endpos != par.size()
353 && (par.isNewline(pos - 1)
354 || par.isLineSeparator(pos - 1)
355 || par.isSeparator(pos - 1)))
358 bool left = font.isVisibleRightToLeft();
360 if (pos == par.size())
361 right = par.isRTL(bv_->buffer().params());
363 right = displayFont(pit, pos).isVisibleRightToLeft();
365 return left != right;
369 bool TextMetrics::redoParagraph(pit_type const pit)
371 Paragraph & par = text_->getPar(pit);
372 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
373 // redoParagraph() recursively inside parMetrics.
374 Dimension old_dim = parMetrics(pit, false).dim();
375 ParagraphMetrics & pm = par_metrics_[pit];
378 Buffer & buffer = bv_->buffer();
379 main_text_ = (text_ == &buffer.text());
380 bool changed = false;
382 // Check whether there are InsetBibItems that need fixing
383 // FIXME: This check ought to be done somewhere else. It is the reason
384 // why text_ is not const. But then, where else to do it?
385 // Well, how can you end up with either (a) a biblio environment that
386 // has no InsetBibitem or (b) a biblio environment with more than one
387 // InsetBibitem? I think the answer is: when paragraphs are merged;
388 // when layout is set; when material is pasted.
389 if (par.brokenBiblio()) {
390 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
391 // In some cases, we do not know how to record undo
392 if (&cur.inset() == &text_->inset())
393 cur.recordUndo(ATOMIC_UNDO, pit, pit);
395 int const moveCursor = par.fixBiblio(buffer);
397 // Is it necessary to update the cursor?
398 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
401 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
406 // Optimisation: this is used in the next two loops
407 // so better to calculate that once here.
408 int const right_margin = rightMargin(pm);
410 // iterator pointing to paragraph to resolve macros
411 DocIterator parPos = text_->macrocontextPosition();
415 LYXERR(Debug::INFO, "MacroContext not initialised!"
416 << " Going through the buffer again and hope"
417 << " the context is better then.");
418 // FIXME audit updateBuffer calls
419 // This should not be here, but it is not clear yet where else it
421 bv_->buffer().updateBuffer();
422 parPos = text_->macrocontextPosition();
423 LBUFERR(!parPos.empty());
428 Font const bufferfont = buffer.params().getFont();
429 InsetList::const_iterator ii = par.insetList().begin();
430 InsetList::const_iterator iend = par.insetList().end();
431 for (; ii != iend; ++ii) {
432 // FIXME Doesn't this HAVE to be non-empty?
433 // position already initialized?
434 if (!parPos.empty()) {
435 parPos.pos() = ii->pos;
437 // A macro template would normally not be visible
438 // by itself. But the tex macro semantics allow
439 // recursion, so we artifically take the context
440 // after the macro template to simulate this.
441 if (ii->inset->lyxCode() == MATHMACRO_CODE)
445 // do the metric calculation
447 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
449 Font const & font = ii->inset->inheritFont() ?
450 displayFont(pit, ii->pos) : bufferfont;
451 MacroContext mc(&buffer, parPos);
452 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
453 ii->inset->metrics(mi, dim);
454 Dimension const old_dim = pm.insetDimension(ii->inset);
455 if (old_dim != dim) {
456 pm.setInsetDimension(ii->inset, dim);
461 par.setBeginOfBody();
463 size_t row_index = 0;
464 // maximum pixel width of a row
466 if (row_index == pm.rows().size())
467 pm.rows().push_back(Row());
468 Row & row = pm.rows()[row_index];
470 breakRow(row, right_margin, pit);
471 setRowHeight(row, pit);
472 row.setChanged(false);
473 if (row_index || row.endpos() < par.size())
474 // If there is more than one row, expand the text to
475 // the full allowable width. This setting here is needed
476 // for the computeRowMetrics() below.
477 dim_.wid = max_width_;
478 int const max_row_width = max(dim_.wid, row.width());
479 computeRowMetrics(pit, row, max_row_width);
480 first = row.endpos();
483 pm.dim().wid = max(pm.dim().wid, row.width());
484 pm.dim().des += row.height();
485 } while (first < par.size());
487 if (row_index < pm.rows().size())
488 pm.rows().resize(row_index);
490 // Make sure that if a par ends in newline, there is one more row
492 if (first > 0 && par.isNewline(first - 1)) {
493 if (row_index == pm.rows().size())
494 pm.rows().push_back(Row());
495 Row & row = pm.rows()[row_index];
498 setRowHeight(row, pit);
499 row.setChanged(false);
500 int const max_row_width = max(dim_.wid, row.width());
501 computeRowMetrics(pit, row, max_row_width);
502 pm.dim().des += row.height();
505 pm.dim().asc += pm.rows()[0].ascent();
506 pm.dim().des -= pm.rows()[0].ascent();
508 changed |= old_dim.height() != pm.dim().height();
514 int TextMetrics::getAlign(Paragraph const & par, pos_type const pos) const
516 Layout const & layout = par.layout();
519 if (par.params().align() == LYX_ALIGN_LAYOUT)
520 align = layout.align;
522 align = par.params().align();
524 // handle alignment inside tabular cells
525 Inset const & owner = text_->inset();
526 switch (owner.contentAlignment()) {
527 case LYX_ALIGN_CENTER:
529 case LYX_ALIGN_RIGHT:
530 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
531 align = owner.contentAlignment();
534 // unchanged (use align)
538 // Display-style insets should always be on a centered row
539 if (Inset const * inset = par.getInset(pos)) {
540 switch (inset->display()) {
541 case Inset::AlignLeft:
542 align = LYX_ALIGN_BLOCK;
544 case Inset::AlignCenter:
545 align = LYX_ALIGN_CENTER;
548 // unchanged (use align)
550 case Inset::AlignRight:
551 align = LYX_ALIGN_RIGHT;
556 // Has the user requested we not justify stuff?
557 if (!bv_->buffer().params().justification
558 && align == LYX_ALIGN_BLOCK)
559 align = LYX_ALIGN_LEFT;
565 void TextMetrics::computeRowMetrics(pit_type const pit,
566 Row & row, int width) const
571 Paragraph const & par = text_->getPar(pit);
573 double w = width - row.width();
574 // FIXME: put back this assertion when the crash on new doc is solved.
575 //LASSERT(w >= 0, /**/);
577 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
578 //lyxerr << "row.width() " << row.width() << endl;
579 //lyxerr << "w " << w << endl;
581 bool const is_rtl = text_->isRTL(par);
583 row.x = rightMargin(pit);
585 row.x = leftMargin(max_width_, pit, row.pos());
587 // is there a manual margin with a manual label
588 Layout const & layout = par.layout();
591 if (layout.margintype == MARGIN_MANUAL
592 && layout.labeltype == LABEL_MANUAL) {
593 /// We might have real hfills in the label part
594 nlh = numberOfLabelHfills(par, row);
596 // A manual label par (e.g. List) has an auto-hfill
597 // between the label text and the body of the
599 // But we don't want to do this auto hfill if the par
604 if (nlh && !par.getLabelWidthString().empty())
605 row.label_hfill = labelFill(pit, row) / double(nlh);
609 // are there any hfills in the row?
610 if (int const nh = numberOfHfills(row, par.beginOfBody())) {
612 hfill = w / double(nh);
613 // we don't have to look at the alignment if it is ALIGN_LEFT and
614 // if the row is already larger then the permitted width as then
615 // we force the LEFT_ALIGN'edness!
616 } else if (int(row.width()) < max_width_) {
617 // is it block, flushleft or flushright?
618 // set x how you need it
619 int const align = getAlign(par, row.pos());
622 case LYX_ALIGN_BLOCK: {
623 int const ns = numberOfSeparators(row);
624 /** If we have separators, and this row has
625 * not be broken abruptly by a display inset
626 * or newline, then stretch it */
627 if (ns && !row.right_boundary()
628 && row.endpos() != par.size()) {
629 setSeparatorWidth(row, w / ns);
630 row.dimension().wid = width;
631 //lyxerr << "row.separator " << row.separator << endl;
632 //lyxerr << "ns " << ns << endl;
634 row.dimension().wid = width;
639 case LYX_ALIGN_RIGHT:
640 row.dimension().wid = width;
643 case LYX_ALIGN_CENTER:
644 row.dimension().wid += w / 2;
652 pos_type body_pos = par.beginOfBody();
653 pos_type end = row.endpos();
656 && (body_pos > end || !par.isLineSeparator(body_pos - 1))) {
657 row.x += theFontMetrics(text_->labelFont(par)).
658 width(layout.labelsep);
660 row.x += row.label_hfill;
665 pos_type const endpos = row.endpos();
666 pos_type body_pos = par.beginOfBody();
668 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
671 ParagraphMetrics & pm = par_metrics_[pit];
672 Row::iterator cit = row.begin();
673 Row::iterator const cend = row.end();
674 for ( ; cit != cend; ++cit) {
675 if (row.label_hfill && cit->endpos == body_pos
676 && cit->type == Row::SPACE)
677 cit->dim.wid -= row.label_hfill * (nlh - 1);
678 if (!cit->inset || !cit->inset->isHfill())
680 if (pm.hfillExpansion(row, cit->pos))
681 cit->dim.wid = int(cit->pos >= body_pos ?
682 max(hfill, 5.0) : row.label_hfill);
685 // Cache the inset dimension.
686 bv_->coordCache().insets().add(cit->inset, cit->dim);
687 pm.setInsetDimension(cit->inset, cit->dim);
692 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
694 Paragraph const & par = text_->getPar(pit);
695 LBUFERR(par.beginOfBody() > 0);
698 Row::const_iterator cit = row.begin();
699 Row::const_iterator const end = row.end();
700 // iterate over elements before main body (except the last one,
701 // which is extra space).
702 while (cit!= end && cit->endpos < par.beginOfBody()) {
707 docstring const & label = par.params().labelWidthString();
711 FontMetrics const & fm
712 = theFontMetrics(text_->labelFont(par));
714 return max(0, fm.width(label) - w);
719 // Not used, see TextMetrics::breakRow
720 // this needs special handling - only newlines count as a break point
721 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
723 pos_type const end = par.size();
726 if (par.isNewline(i))
734 int TextMetrics::labelEnd(pit_type const pit) const
736 // labelEnd is only needed if the layout fills a flushleft label.
737 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
739 // return the beginning of the body
740 return leftMargin(max_width_, pit);
746 * Calling Text::getFont is slow. While rebreaking we scan a
747 * paragraph from left to right calling getFont for every char. This
748 * simple class address this problem by hidding an optimization trick
749 * (not mine btw -AB): the font is reused in the whole font span. The
750 * class handles transparently the "hidden" (not part of the fontlist)
751 * label font (as getFont does).
757 FontIterator(TextMetrics const & tm,
758 Paragraph const & par, pit_type pit, pos_type pos)
759 : tm_(tm), par_(par), pit_(pit), pos_(pos),
760 font_(tm.displayFont(pit, pos)),
761 endspan_(par.fontSpan(pos).last),
762 bodypos_(par.beginOfBody())
766 Font const & operator*() const { return font_; }
769 FontIterator & operator++()
772 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
773 font_ = tm_.displayFont(pit_, pos_);
774 endspan_ = par_.fontSpan(pos_).last;
780 Font * operator->() { return &font_; }
784 TextMetrics const & tm_;
786 Paragraph const & par_;
801 /** This is the function where the hard work is done. The code here is
802 * very sensitive to small changes :) Note that part of the
803 * intelligence is also in Row::shorten_if_needed
805 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
807 Paragraph const & par = text_->getPar(pit);
808 pos_type const end = par.size();
809 pos_type const pos = row.pos();
810 int const width = max_width_ - right_margin;
811 pos_type const body_pos = par.beginOfBody();
813 row.x = leftMargin(max_width_, pit, pos);
814 row.dimension().wid = row.x;
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())) {
896 row.right_boundary(true);
904 // add the auto-hfill from label end to the body
905 if (body_pos && i == body_pos) {
906 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
909 && row.back().type == Row::SEPARATOR) {
913 int const add = max(fm.width(par.layout().labelsep),
914 labelEnd(pit) - row.width());
915 row.addSpace(j, add, *fi, par.lookupChange(i));
922 // if the row is too large, try to cut at last separator.
923 row.shorten_if_needed(body_pos, width);
925 // if the row ends with a separator that is not at end of
926 // paragraph, remove it
927 if (!row.empty() && row.back().type == Row::SEPARATOR
928 && row.endpos() < par.size())
931 // make sure that the RTL elements are in reverse ordering
932 row.reverseRTL(text_->isRTL(par));
934 row.dimension().wid += right_margin;
938 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
939 bool topBottomSpace) const
941 Paragraph const & par = text_->getPar(pit);
942 // get the maximum ascent and the maximum descent
943 double layoutasc = 0;
944 double layoutdesc = 0;
945 double const dh = defaultRowHeight();
947 // ok, let us initialize the maxasc and maxdesc value.
948 // Only the fontsize count. The other properties
949 // are taken from the layoutfont. Nicer on the screen :)
950 Layout const & layout = par.layout();
952 // as max get the first character of this row then it can
953 // increase but not decrease the height. Just some point to
954 // start with so we don't have to do the assignment below too
956 Buffer const & buffer = bv_->buffer();
957 Font font = displayFont(pit, row.pos());
958 FontSize const tmpsize = font.fontInfo().size();
959 font.fontInfo() = text_->layoutFont(pit);
960 FontSize const size = font.fontInfo().size();
961 font.fontInfo().setSize(tmpsize);
963 FontInfo labelfont = text_->labelFont(par);
965 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
966 FontMetrics const & fontmetrics = theFontMetrics(font);
968 // these are minimum values
969 double const spacing_val = layout.spacing.getValue()
970 * text_->spacing(par);
971 //lyxerr << "spacing_val = " << spacing_val << endl;
972 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
973 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
975 // insets may be taller
976 ParagraphMetrics const & pm = par_metrics_[pit];
977 Row::const_iterator cit = row.begin();
978 Row::const_iterator cend = row.end();
979 for ( ; cit != cend; ++cit) {
981 Dimension const & dim = pm.insetDimension(cit->inset);
982 maxasc = max(maxasc, dim.ascent());
983 maxdesc = max(maxdesc, dim.descent());
987 // Check if any custom fonts are larger (Asger)
988 // This is not completely correct, but we can live with the small,
989 // cosmetic error for now.
993 par.highestFontInRange(row.pos(), row.endpos(), size);
994 if (maxsize > font.fontInfo().size()) {
995 // use standard paragraph font with the maximal size
996 FontInfo maxfont = font.fontInfo();
997 maxfont.setSize(maxsize);
998 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
999 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1000 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1003 // This is nicer with box insets:
1007 ParagraphList const & pars = text_->paragraphs();
1008 Inset const & inset = text_->inset();
1010 // is it a top line?
1011 if (row.pos() == 0 && topBottomSpace) {
1012 BufferParams const & bufparams = buffer.params();
1013 // some parskips VERY EASY IMPLEMENTATION
1014 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1015 && !inset.getLayout().parbreakIsNewline()
1016 && !par.layout().parbreak_is_newline
1018 && ((layout.isParagraph() && par.getDepth() == 0)
1019 || (pars[pit - 1].layout().isParagraph()
1020 && pars[pit - 1].getDepth() == 0))) {
1021 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1024 if (par.params().startOfAppendix())
1025 maxasc += int(3 * dh);
1027 // special code for the top label
1028 if (layout.labelIsAbove()
1029 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1030 && !par.labelString().empty()) {
1032 labelfont_metrics.maxHeight()
1033 * layout.spacing.getValue()
1034 * text_->spacing(par)
1035 + (layout.topsep + layout.labelbottomsep) * dh);
1038 // Add the layout spaces, for example before and after
1039 // a section, or between the items of a itemize or enumerate
1042 pit_type prev = text_->depthHook(pit, par.getDepth());
1043 Paragraph const & prevpar = pars[prev];
1045 && prevpar.layout() == layout
1046 && prevpar.getDepth() == par.getDepth()
1047 && prevpar.getLabelWidthString()
1048 == par.getLabelWidthString()) {
1049 layoutasc = layout.itemsep * dh;
1050 } else if (pit != 0 || row.pos() != 0) {
1051 if (layout.topsep > 0)
1052 layoutasc = layout.topsep * dh;
1055 prev = text_->outerHook(pit);
1056 if (prev != pit_type(pars.size())) {
1057 maxasc += int(pars[prev].layout().parsep * dh);
1058 } else if (pit != 0) {
1059 Paragraph const & prevpar = pars[pit - 1];
1060 if (prevpar.getDepth() != 0 ||
1061 prevpar.layout() == layout) {
1062 maxasc += int(layout.parsep * dh);
1067 // is it a bottom line?
1068 if (row.endpos() >= par.size() && topBottomSpace) {
1069 // add the layout spaces, for example before and after
1070 // a section, or between the items of a itemize or enumerate
1072 pit_type nextpit = pit + 1;
1073 if (nextpit != pit_type(pars.size())) {
1074 pit_type cpit = pit;
1076 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1077 double usual = pars[cpit].layout().bottomsep * dh;
1079 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1080 if (pars[cpit].layout() != pars[nextpit].layout()
1081 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1082 unusual = pars[cpit].layout().bottomsep * dh;
1083 layoutdesc = max(unusual, usual);
1084 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1085 if (pars[cpit].layout() != pars[nextpit].layout()
1086 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1087 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1092 // incalculate the layout spaces
1093 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1094 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1096 // FIXME: the correct way is to do the following is to move the
1097 // following code in another method specially tailored for the
1098 // main Text. The following test is thus bogus.
1099 // Top and bottom margin of the document (only at top-level)
1100 if (main_text_ && topBottomSpace) {
1101 if (pit == 0 && row.pos() == 0)
1103 if (pit + 1 == pit_type(pars.size()) &&
1104 row.endpos() == par.size() &&
1105 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1109 row.dimension().asc = maxasc + labeladdon;
1110 row.dimension().des = maxdesc;
1114 // x is an absolute screen coord
1115 // returns the column near the specified x-coordinate of the row
1116 // x is set to the real beginning of this column
1117 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1118 Row const & row, int & x, bool & boundary) const
1121 /// For the main Text, it is possible that this pit is not
1122 /// yet in the CoordCache when moving cursor up.
1123 /// x Paragraph coordinate is always 0 for main text anyway.
1124 int const xo = origin_.x_;
1126 #ifdef KEEP_OLD_METRICS_CODE
1127 int const x_orig = x;
1130 pos_type pos = row.pos();
1134 else if (x < row.x) {
1135 pos = row.front().font.isVisibleRightToLeft() ?
1136 row.front().endpos : row.front().pos;
1138 } else if (x > row.width() - row.right_margin) {
1139 pos = row.back().font.isVisibleRightToLeft() ?
1140 row.back().pos : row.back().endpos;
1141 x = row.width() - row.right_margin;
1144 Row::const_iterator cit = row.begin();
1145 Row::const_iterator cend = row.end();
1146 for ( ; cit != cend; ++cit) {
1147 if (w <= x && w + cit->width() > x) {
1148 double x_offset = x - w;
1149 pos = cit->x2pos(x_offset);
1155 if (cit == row.end())
1156 lyxerr << "NOT FOUND!! x=" << x
1157 << ", wid=" << row.width() << endl;
1158 /** This tests for the case where the cursor is placed
1159 * just before a font direction change. See comment on
1160 * the boundary_ member in DocIterator.h to understand
1161 * how bounddary helps here.
1163 else if (pos == cit->endpos
1164 && cit + 1 != row.end()
1165 && cit->font.isVisibleRightToLeft() != (cit + 1)->font.isVisibleRightToLeft())
1169 /** This tests for the case where the cursor is set at the end
1170 * of a row which has been broken due to a display inset on
1171 * next row. This is indicated by Row::right_boundary.
1173 if (!row.empty() && pos == row.back().endpos
1174 && row.back().endpos == row.endpos())
1175 boundary = row.right_boundary();
1178 #ifdef KEEP_OLD_METRICS_CODE
1179 Buffer const & buffer = bv_->buffer();
1182 Paragraph const & par = text_->getPar(pit);
1184 bidi.computeTables(par, buffer, row);
1186 pos_type vc = row.pos();
1187 pos_type const end = row.endpos();
1189 Layout const & layout = par.layout();
1191 bool left_side = false;
1193 pos_type body_pos = par.beginOfBody();
1195 double tmpx = row.x;
1196 double last_tmpx = tmpx;
1199 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1202 // check for empty row
1204 x2 = int(tmpx) + xo;
1208 // This (rtl_support test) is not needed, but gives
1209 // some speedup if rtl_support == false
1210 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1212 // If lastrow is false, we don't need to compute
1213 // the value of rtl.
1214 bool const rtl_on_lastrow = lastrow ? text_->isRTL(par) : false;
1216 while (vc < end && tmpx <= x2) {
1217 c = bidi.vis2log(vc);
1219 if (body_pos > 0 && c == body_pos - 1) {
1220 FontMetrics const & fm = theFontMetrics(
1221 text_->labelFont(par));
1222 tmpx += row.label_hfill + fm.width(layout.labelsep);
1223 if (par.isLineSeparator(body_pos - 1))
1224 tmpx -= singleWidth(pit, body_pos - 1);
1227 tmpx += singleWidth(pit, c);
1228 if (par.isSeparator(c) && c >= body_pos)
1229 tmpx += row.separator;
1233 if ((tmpx + last_tmpx) / 2 > x2) {
1238 // This shouldn't happen. But we can reset and try to continue.
1239 LASSERT(vc <= end, vc = end);
1241 bool boundary2 = false;
1244 ((rtl_on_lastrow && left_side && vc == row.pos() && x2 < tmpx - 5) ||
1245 (!rtl_on_lastrow && !left_side && vc == end && x2 > tmpx + 5))) {
1246 if (!par.isNewline(end - 1))
1248 } else if (vc == row.pos()) {
1249 c = bidi.vis2log(vc);
1250 if (bidi.level(c) % 2 == 1)
1253 c = bidi.vis2log(vc - 1);
1254 bool const rtl = (bidi.level(c) % 2 == 1);
1255 if (left_side == rtl) {
1257 boundary2 = isRTLBoundary(pit, c);
1261 // I believe this code is not needed anymore (Jug 20050717)
1263 // The following code is necessary because the cursor position past
1264 // the last char in a row is logically equivalent to that before
1265 // the first char in the next row. That's why insets causing row
1266 // divisions -- Newline and display-style insets -- must be treated
1267 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1268 // Newline inset, air gap below:
1269 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1270 if (bidi.level(end -1) % 2 == 0)
1271 tmpx -= singleWidth(pit, end - 1);
1273 tmpx += singleWidth(pit, end - 1);
1277 // Air gap above display inset:
1278 if (row.pos() < end && c >= end && end < par.size()
1279 && par.isInset(end) && par.getInset(end)->display()) {
1282 // Air gap below display inset:
1283 if (row.pos() < end && c >= end && par.isInset(end - 1)
1284 && par.getInset(end - 1)->display()) {
1289 x2 = int(tmpx) + xo;
1290 //pos_type const col = c - row.pos();
1292 if (abs(x2 - x) > 0.1 || boundary != boundary
1294 lyxerr << "getColumnNearX(" << x_orig << "): new=(x=" << x - xo << ", b=" << boundary << ", p=" << pos << "), "
1295 << "old=(x=" << x2 - xo << ", b=" << boundary2 << ", p=" << c << "), " << row;
1299 if (!c || end == par.size())
1302 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1307 return min(col, end - 1 - row.pos());
1309 #endif // KEEP_OLD_METRICS_CODE
1310 return pos - row.pos();
1314 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1316 // We play safe and use parMetrics(pit) to make sure the
1317 // ParagraphMetrics will be redone and OK to use if needed.
1318 // Otherwise we would use an empty ParagraphMetrics in
1319 // upDownInText() while in selection mode.
1320 ParagraphMetrics const & pm = parMetrics(pit);
1322 LBUFERR(row < int(pm.rows().size()));
1324 Row const & r = pm.rows()[row];
1325 return r.pos() + getColumnNearX(pit, r, x, bound);
1329 void TextMetrics::newParMetricsDown()
1331 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1332 pit_type const pit = last.first + 1;
1333 if (pit == int(text_->paragraphs().size()))
1336 // do it and update its position.
1338 par_metrics_[pit].setPosition(last.second.position()
1339 + last.second.descent() + par_metrics_[pit].ascent());
1343 void TextMetrics::newParMetricsUp()
1345 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1346 if (first.first == 0)
1349 pit_type const pit = first.first - 1;
1350 // do it and update its position.
1352 par_metrics_[pit].setPosition(first.second.position()
1353 - first.second.ascent() - par_metrics_[pit].descent());
1356 // y is screen coordinate
1357 pit_type TextMetrics::getPitNearY(int y)
1359 LASSERT(!text_->paragraphs().empty(), return -1);
1360 LASSERT(!par_metrics_.empty(), return -1);
1361 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1363 // look for highest numbered paragraph with y coordinate less than given y
1366 ParMetricsCache::const_iterator it = par_metrics_.begin();
1367 ParMetricsCache::const_iterator et = par_metrics_.end();
1368 ParMetricsCache::const_iterator last = et;
1371 ParagraphMetrics const & pm = it->second;
1373 if (y < it->second.position() - int(pm.ascent())) {
1374 // We are looking for a position that is before the first paragraph in
1375 // the cache (which is in priciple off-screen, that is before the
1378 // We are already at the first paragraph in the inset.
1380 // OK, this is the paragraph we are looking for.
1381 pit = it->first - 1;
1386 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1388 if (y >= last->second.position() + int(pm_last.descent())) {
1389 // We are looking for a position that is after the last paragraph in
1390 // the cache (which is in priciple off-screen), that is before the
1392 pit = last->first + 1;
1393 if (pit == int(text_->paragraphs().size()))
1394 // We are already at the last paragraph in the inset.
1396 // OK, this is the paragraph we are looking for.
1397 newParMetricsDown();
1401 for (; it != et; ++it) {
1402 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1403 << " y: " << it->second.position());
1405 ParagraphMetrics const & pm = par_metrics_[it->first];
1407 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1409 yy = it->second.position();
1413 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1419 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1420 bool assert_in_view, bool up)
1422 ParagraphMetrics const & pm = par_metrics_[pit];
1424 int yy = pm.position() - pm.ascent();
1425 LBUFERR(!pm.rows().empty());
1426 RowList::const_iterator rit = pm.rows().begin();
1427 RowList::const_iterator rlast = pm.rows().end();
1429 for (; rit != rlast; yy += rit->height(), ++rit)
1430 if (yy + rit->height() > y)
1433 if (assert_in_view) {
1434 if (!up && yy + rit->height() > y) {
1435 if (rit != pm.rows().begin()) {
1438 } else if (pit != 0) {
1441 ParagraphMetrics const & pm2 = par_metrics_[pit];
1442 rit = pm2.rows().end();
1446 } else if (up && yy != y) {
1448 y = yy + rit->height();
1450 } else if (pit < int(text_->paragraphs().size()) - 1) {
1452 newParMetricsDown();
1453 ParagraphMetrics const & pm2 = par_metrics_[pit];
1454 rit = pm2.rows().begin();
1463 // x,y are absolute screen coordinates
1464 // sets cursor recursively descending into nested editable insets
1465 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1466 bool assert_in_view, bool up)
1468 if (lyxerr.debugging(Debug::WORKAREA)) {
1469 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1470 cur.bv().coordCache().dump();
1472 pit_type pit = getPitNearY(y);
1473 LASSERT(pit != -1, return 0);
1475 int yy = y; // is modified by getPitAndRowNearY
1476 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1480 // Do we cover an inset?
1481 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1484 // No inset, set position in the text
1485 bool bound = false; // is modified by getColumnNearX
1486 int xx = x; // is modified by getColumnNearX
1487 cur.pos() = row.pos()
1488 + getColumnNearX(pit, row, xx, bound);
1489 cur.boundary(bound);
1490 cur.setCurrentFont();
1495 Inset * inset = it->inset;
1496 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1498 // Set position in front of inset
1499 cur.pos() = it->pos;
1500 cur.boundary(false);
1503 // Try to descend recursively inside the inset.
1504 inset = inset->editXY(cur, x, yy);
1506 if (cur.top().text() == text_)
1507 cur.setCurrentFont();
1512 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1514 LASSERT(text_ == cur.text(), return);
1515 pit_type const pit = getPitNearY(y);
1516 LASSERT(pit != -1, return);
1518 ParagraphMetrics const & pm = par_metrics_[pit];
1520 int yy = pm.position() - pm.ascent();
1521 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1522 " pit: " << pit << " yy: " << yy);
1525 LBUFERR(pm.rows().size());
1526 for (; r < int(pm.rows().size()) - 1; ++r) {
1527 Row const & row = pm.rows()[r];
1528 if (int(yy + row.height()) > y)
1533 Row const & row = pm.rows()[r];
1535 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1539 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1541 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1543 text_->setCursor(cur, pit, pos, true, bound);
1544 // remember new position.
1549 //takes screen x,y coordinates
1550 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1552 Paragraph const & par = text_->paragraphs()[pit];
1553 ParagraphMetrics const & pm = par_metrics_[pit];
1555 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1557 InsetList::const_iterator iit = par.insetList().begin();
1558 InsetList::const_iterator iend = par.insetList().end();
1559 for (; iit != iend; ++iit) {
1560 Inset * inset = iit->inset;
1562 LYXERR(Debug::DEBUG, "examining inset " << inset);
1564 if (!bv_->coordCache().getInsets().has(inset)) {
1565 LYXERR(Debug::DEBUG, "inset has no cached position");
1569 Dimension const & dim = pm.insetDimension(inset);
1570 Point p = bv_->coordCache().getInsets().xy(inset);
1572 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1573 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1575 if (x >= p.x_ && x <= p.x_ + dim.wid
1576 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1577 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1578 return const_cast<InsetList::InsetTable *>(&(*iit));
1582 LYXERR(Debug::DEBUG, "No inset hit. ");
1587 //takes screen x,y coordinates
1588 Inset * TextMetrics::checkInsetHit(int x, int y)
1590 pit_type const pit = getPitNearY(y);
1591 LASSERT(pit != -1, return 0);
1592 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1601 int TextMetrics::cursorX(CursorSlice const & sl,
1602 bool boundary) const
1604 LASSERT(sl.text() == text_, return 0);
1605 pit_type const pit = sl.pit();
1606 pos_type pos = sl.pos();
1608 ParagraphMetrics const & pm = par_metrics_[pit];
1609 if (pm.rows().empty())
1611 Row const & row = pm.getRow(sl.pos(), boundary);
1616 * When boundary is true, position i is in the row element (pos, endpos)
1619 * whereas, when boundary is false, the test is
1621 * The correction below allows to handle both cases.
1623 int const boundary_corr = (boundary && pos) ? -1 : 0;
1627 || (row.begin()->font.isVisibleRightToLeft()
1628 && pos == row.begin()->endpos))
1631 Row::const_iterator cit = row.begin();
1632 for ( ; cit != row.end() ; ++cit) {
1633 if (pos + boundary_corr >= cit->pos
1634 && pos + boundary_corr < cit->endpos) {
1635 x += cit->pos2x(pos);
1641 if (cit == row.end()
1642 && (row.back().font.isVisibleRightToLeft() || pos != row.back().endpos))
1643 LYXERR0("cursorX(" << pos - boundary_corr
1644 << ", " << boundary_corr << "): NOT FOUND! " << row);
1646 #ifdef KEEP_OLD_METRICS_CODE
1647 Paragraph const & par = text_->paragraphs()[pit];
1649 // Correct position in front of big insets
1650 bool const boundary_correction = pos != 0 && boundary;
1651 if (boundary_correction)
1654 pos_type cursor_vpos = 0;
1656 Buffer const & buffer = bv_->buffer();
1659 bidi.computeTables(par, buffer, row);
1661 pos_type const row_pos = row.pos();
1662 pos_type const end = row.endpos();
1663 // Spaces at logical line breaks in bidi text must be skipped during
1664 // cursor positioning. However, they may appear visually in the middle
1665 // of a row; they must be skipped, wherever they are...
1666 // * logically "abc_[HEBREW_\nHEBREW]"
1667 // * visually "abc_[_WERBEH\nWERBEH]"
1668 pos_type skipped_sep_vpos = -1;
1671 cursor_vpos = row_pos;
1672 else if (pos >= end)
1673 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1674 else if (pos > row_pos && pos >= end)
1675 //FIXME: this code is never reached!
1676 // (see http://www.lyx.org/trac/changeset/8251)
1677 // Place cursor after char at (logical) position pos - 1
1678 cursor_vpos = (bidi.level(pos - 1) % 2 == 0)
1679 ? bidi.log2vis(pos - 1) + 1 : bidi.log2vis(pos - 1);
1681 // Place cursor before char at (logical) position pos
1682 cursor_vpos = (bidi.level(pos) % 2 == 0)
1683 ? bidi.log2vis(pos) : bidi.log2vis(pos) + 1;
1685 pos_type body_pos = par.beginOfBody();
1687 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1690 // check for possible inline completion in this row
1691 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1692 pos_type inlineCompletionVPos = -1;
1693 if (inlineCompletionPos.inTexted()
1694 && inlineCompletionPos.text() == text_
1695 && inlineCompletionPos.pit() == pit
1696 && inlineCompletionPos.pos() - 1 >= row_pos
1697 && inlineCompletionPos.pos() - 1 < end) {
1698 // draw logically behind the previous character
1699 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1702 // Use font span to speed things up, see below
1706 // If the last logical character is a separator, skip it, unless
1707 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1708 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1709 skipped_sep_vpos = bidi.log2vis(end - 1);
1711 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1712 ParagraphList const & pars_ = text_->paragraphs();
1713 if (size_type(pit + 1) < pars_.size()) {
1714 FontInfo f(text_->layoutFont(pit));
1715 docstring const s = docstring(1, char_type(0x00B6));
1716 x2 += theFontMetrics(f).width(s);
1720 // Inline completion RTL special case row_pos == cursor_pos:
1721 // "__|b" => cursor_pos is right of __
1722 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1723 font = displayFont(pit, row_pos + 1);
1724 docstring const & completion = bv_->inlineCompletion();
1725 if (font.isRightToLeft() && completion.length() > 0)
1726 x2 += theFontMetrics(font.fontInfo()).width(completion);
1729 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1730 // Skip the separator which is at the logical end of the row
1731 if (vpos == skipped_sep_vpos)
1733 pos_type pos = bidi.vis2log(vpos);
1734 if (body_pos > 0 && pos == body_pos - 1) {
1735 FontMetrics const & labelfm = theFontMetrics(
1736 text_->labelFont(par));
1737 x2 += row.label_hfill + labelfm.width(par.layout().labelsep);
1738 if (par.isLineSeparator(body_pos - 1))
1739 x2 -= singleWidth(pit, body_pos - 1);
1742 // Use font span to speed things up, see above
1743 if (pos < font_span.first || pos > font_span.last) {
1744 font_span = par.fontSpan(pos);
1745 font = displayFont(pit, pos);
1748 x2 += pm.singleWidth(pos, font);
1750 // Inline completion RTL case:
1751 // "a__|b", __ of b => non-boundary a-pos is right of __
1752 if (vpos + 1 == inlineCompletionVPos
1753 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1754 font = displayFont(pit, vpos + 1);
1755 docstring const & completion = bv_->inlineCompletion();
1756 if (font.isRightToLeft() && completion.length() > 0)
1757 x2 += theFontMetrics(font.fontInfo()).width(completion);
1760 // Inline completion LTR case:
1761 // "b|__a", __ of b => non-boundary a-pos is in front of __
1762 if (vpos == inlineCompletionVPos
1763 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1764 font = displayFont(pit, vpos);
1765 docstring const & completion = bv_->inlineCompletion();
1766 if (!font.isRightToLeft() && completion.length() > 0)
1767 x2 += theFontMetrics(font.fontInfo()).width(completion);
1770 if (par.isSeparator(pos) && pos >= body_pos)
1771 x2 += row.separator;
1774 // see correction above
1775 if (boundary_correction) {
1776 if (isRTL(sl, boundary))
1777 x2 -= singleWidth(pit, pos);
1779 x2 += singleWidth(pit, pos);
1782 if (abs(x2 - x) > 0.01) {
1783 lyxerr << "cursorX(" << pos - boundary_corr << ", " << boundary_corr
1784 << "): old=" << x2 << ", new=" << x;
1785 if (cit == row.end())
1786 lyxerr << "Element not found\n";
1788 lyxerr << " found in " << *cit << "\n";
1789 lyxerr << row <<endl;
1792 #endif // KEEP_OLD_METRICS_CODE
1797 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1799 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1800 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1801 if (pm.rows().empty())
1805 h -= par_metrics_[0].rows()[0].ascent();
1806 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1807 h += par_metrics_[pit].height();
1810 if (pos && boundary)
1812 size_t const rend = pm.pos2row(pos);
1813 for (size_t rit = 0; rit != rend; ++rit)
1814 h += pm.rows()[rit].height();
1815 h += pm.rows()[rend].ascent();
1820 // the cursor set functions have a special mechanism. When they
1821 // realize you left an empty paragraph, they will delete it.
1823 bool TextMetrics::cursorHome(Cursor & cur)
1825 LASSERT(text_ == cur.text(), return false);
1826 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1827 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1828 return text_->setCursor(cur, cur.pit(), row.pos());
1832 bool TextMetrics::cursorEnd(Cursor & cur)
1834 LASSERT(text_ == cur.text(), return false);
1835 // if not on the last row of the par, put the cursor before
1836 // the final space exept if I have a spanning inset or one string
1837 // is so long that we force a break.
1838 pos_type end = cur.textRow().endpos();
1840 // empty text, end-1 is no valid position
1842 bool boundary = false;
1843 if (end != cur.lastpos()) {
1844 if (!cur.paragraph().isLineSeparator(end-1)
1845 && !cur.paragraph().isNewline(end-1))
1850 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1854 void TextMetrics::deleteLineForward(Cursor & cur)
1856 LASSERT(text_ == cur.text(), return);
1857 if (cur.lastpos() == 0) {
1858 // Paragraph is empty, so we just go forward
1859 text_->cursorForward(cur);
1862 cur.setSelection(true); // to avoid deletion
1865 // What is this test for ??? (JMarc)
1866 if (!cur.selection())
1867 text_->deleteWordForward(cur);
1869 cap::cutSelection(cur, true, false);
1870 cur.checkBufferStructure();
1875 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1877 ParagraphList const & pars = text_->paragraphs();
1878 return row.endpos() >= pars[pit].size()
1879 && pit + 1 == pit_type(pars.size());
1883 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1885 return row.pos() == 0 && pit == 0;
1889 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1891 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1895 int TextMetrics::leftMargin(int max_width,
1896 pit_type const pit, pos_type const pos) const
1898 ParagraphList const & pars = text_->paragraphs();
1900 LASSERT(pit >= 0, return 0);
1901 LASSERT(pit < int(pars.size()), return 0);
1902 Paragraph const & par = pars[pit];
1903 LASSERT(pos >= 0, return 0);
1904 LASSERT(pos <= par.size(), return 0);
1905 Buffer const & buffer = bv_->buffer();
1906 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1907 DocumentClass const & tclass = buffer.params().documentClass();
1908 Layout const & layout = par.layout();
1910 docstring parindent = layout.parindent;
1914 if (text_->isMainText())
1915 l_margin += bv_->leftMargin();
1917 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1918 tclass.leftmargin());
1920 if (par.getDepth() != 0) {
1921 // find the next level paragraph
1922 pit_type newpar = text_->outerHook(pit);
1923 if (newpar != pit_type(pars.size())) {
1924 if (pars[newpar].layout().isEnvironment()) {
1925 l_margin = leftMargin(max_width, newpar);
1926 // Remove the parindent that has been added
1927 // if the paragraph was empty.
1928 if (pars[newpar].empty()) {
1929 docstring pi = pars[newpar].layout().parindent;
1930 l_margin -= theFontMetrics(
1931 buffer.params().getFont()).signedWidth(pi);
1934 if (tclass.isDefaultLayout(par.layout())
1935 || tclass.isPlainLayout(par.layout())) {
1936 if (pars[newpar].params().noindent())
1939 parindent = pars[newpar].layout().parindent;
1944 // This happens after sections or environments in standard classes.
1945 // We have to check the previous layout at same depth.
1946 if (tclass.isDefaultLayout(par.layout()) && pit > 0
1947 && pars[pit - 1].getDepth() >= par.getDepth()) {
1948 pit_type prev = text_->depthHook(pit, par.getDepth());
1949 if (pars[prev < pit ? prev : pit - 1].layout().nextnoindent)
1953 FontInfo const labelfont = text_->labelFont(par);
1954 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1956 switch (layout.margintype) {
1957 case MARGIN_DYNAMIC:
1958 if (!layout.leftmargin.empty()) {
1959 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1962 if (!par.labelString().empty()) {
1963 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1964 l_margin += labelfont_metrics.width(par.labelString());
1965 l_margin += labelfont_metrics.width(layout.labelsep);
1969 case MARGIN_MANUAL: {
1970 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1971 // The width of an empty par, even with manual label, should be 0
1972 if (!par.empty() && pos >= par.beginOfBody()) {
1973 if (!par.getLabelWidthString().empty()) {
1974 docstring labstr = par.getLabelWidthString();
1975 l_margin += labelfont_metrics.width(labstr);
1976 l_margin += labelfont_metrics.width(layout.labelsep);
1982 case MARGIN_STATIC: {
1983 l_margin += theFontMetrics(buffer.params().getFont()).
1984 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1988 case MARGIN_FIRST_DYNAMIC:
1989 if (layout.labeltype == LABEL_MANUAL) {
1990 // if we are at position 0, we are never in the body
1991 if (pos > 0 && pos >= par.beginOfBody())
1992 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1994 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1996 // Special case to fix problems with
1998 || (layout.labeltype == LABEL_STATIC
1999 && layout.latextype == LATEX_ENVIRONMENT
2000 && !text_->isFirstInSequence(pit))) {
2001 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
2002 } else if (!layout.labelIsAbove()) {
2003 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
2004 l_margin += labelfont_metrics.width(layout.labelsep);
2005 l_margin += labelfont_metrics.width(par.labelString());
2009 case MARGIN_RIGHT_ADDRESS_BOX: {
2011 // The left margin depends on the widest row in this paragraph.
2012 // This code is wrong because it depends on the rows, but at the
2013 // same time this function is used in redoParagraph to construct
2015 ParagraphMetrics const & pm = par_metrics_[pit];
2016 RowList::const_iterator rit = pm.rows().begin();
2017 RowList::const_iterator end = pm.rows().end();
2018 int minfill = max_width;
2019 for ( ; rit != end; ++rit)
2020 if (rit->fill() < minfill)
2021 minfill = rit->fill();
2022 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
2023 l_margin += minfill;
2025 // also wrong, but much shorter.
2026 l_margin += max_width / 2;
2031 if (!par.params().leftIndent().zero())
2032 l_margin += par.params().leftIndent().inPixels(max_width);
2036 if (par.params().align() == LYX_ALIGN_LAYOUT)
2037 align = layout.align;
2039 align = par.params().align();
2041 // set the correct parindent
2043 && (layout.labeltype == LABEL_NO_LABEL
2044 || layout.labeltype == LABEL_ABOVE
2045 || layout.labeltype == LABEL_CENTERED
2046 || (layout.labeltype == LABEL_STATIC
2047 && layout.latextype == LATEX_ENVIRONMENT
2048 && !text_->isFirstInSequence(pit)))
2049 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2050 && !par.params().noindent()
2051 // in some insets, paragraphs are never indented
2052 && !text_->inset().neverIndent()
2053 // display style insets are always centered, omit indentation
2056 && par.getInset(pos)->display())
2057 && (!(tclass.isDefaultLayout(par.layout())
2058 || tclass.isPlainLayout(par.layout()))
2059 || buffer.params().paragraph_separation
2060 == BufferParams::ParagraphIndentSeparation)) {
2061 // use the parindent of the layout when the
2062 // default indentation is used otherwise use
2063 // the indentation set in the document
2065 if (buffer.params().getIndentation().asLyXCommand() == "default")
2066 l_margin += theFontMetrics(
2067 buffer.params().getFont()).signedWidth(parindent);
2069 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2076 #ifdef KEEP_OLD_METRICS_CODE
2077 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2079 ParagraphMetrics const & pm = par_metrics_[pit];
2081 return pm.singleWidth(pos, displayFont(pit, pos));
2085 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2087 if (par_metrics_.empty())
2093 ParMetricsCache::iterator it = par_metrics_.begin();
2094 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2095 y -= it->second.ascent();
2096 for (; it != pm_end; ++it) {
2097 ParagraphMetrics const & pmi = it->second;
2099 pit_type const pit = it->first;
2100 // Save the paragraph position in the cache.
2101 it->second.setPosition(y);
2102 drawParagraph(pi, pit, x, y);
2108 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2110 BufferParams const & bparams = bv_->buffer().params();
2111 ParagraphMetrics const & pm = par_metrics_[pit];
2112 if (pm.rows().empty())
2115 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2116 int const ww = bv_->workHeight();
2117 size_t const nrows = pm.rows().size();
2119 Cursor const & cur = bv_->cursor();
2120 DocIterator sel_beg = cur.selectionBegin();
2121 DocIterator sel_end = cur.selectionEnd();
2122 bool selection = cur.selection()
2123 // This is our text.
2124 && cur.text() == text_
2125 // if the anchor is outside, this is not our selection
2126 && cur.normalAnchor().text() == text_
2127 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2129 // We store the begin and end pos of the selection relative to this par
2130 DocIterator sel_beg_par = cur.selectionBegin();
2131 DocIterator sel_end_par = cur.selectionEnd();
2133 // We care only about visible selection.
2135 if (pit != sel_beg.pit()) {
2136 sel_beg_par.pit() = pit;
2137 sel_beg_par.pos() = 0;
2139 if (pit != sel_end.pit()) {
2140 sel_end_par.pit() = pit;
2141 sel_end_par.pos() = sel_end_par.lastpos();
2145 for (size_t i = 0; i != nrows; ++i) {
2147 Row const & row = pm.rows()[i];
2151 bool const inside = (y + row.descent() >= 0
2152 && y - row.ascent() < ww);
2153 // It is not needed to draw on screen if we are not inside.
2154 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2155 RowPainter rp(pi, *text_, pit, row, x, y);
2158 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2160 row.setSelection(-1, -1);
2162 // The row knows nothing about the paragraph, so we have to check
2163 // whether this row is the first or last and update the margins.
2164 if (row.selection()) {
2165 if (row.sel_beg == 0)
2166 row.begin_margin_sel = sel_beg.pit() < pit;
2167 if (row.sel_end == sel_end_par.lastpos())
2168 row.end_margin_sel = sel_end.pit() > pit;
2171 // Row signature; has row changed since last paint?
2172 row.setCrc(pm.computeRowSignature(row, bparams));
2173 bool row_has_changed = row.changed();
2175 // Take this opportunity to spellcheck the row contents.
2176 if (row_has_changed && lyxrc.spellcheck_continuously) {
2177 text_->getPar(pit).spellCheck();
2180 // Don't paint the row if a full repaint has not been requested
2181 // and if it has not changed.
2182 if (!pi.full_repaint && !row_has_changed) {
2183 // Paint only the insets if the text itself is
2185 rp.paintOnlyInsets();
2190 // Clear background of this row if paragraph background was not
2191 // already cleared because of a full repaint.
2192 if (!pi.full_repaint && row_has_changed) {
2193 pi.pain.fillRectangle(x, y - row.ascent(),
2194 width(), row.height(), pi.background_color);
2197 // Instrumentation for testing row cache (see also
2199 if (lyxerr.debugging(Debug::PAINTING) && inside
2200 && (row.selection() || pi.full_repaint || row_has_changed)) {
2201 string const foreword = text_->isMainText() ?
2202 "main text redraw " : "inset text redraw: ";
2203 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2204 << " row_selection=" << row.selection()
2205 << " full_repaint=" << pi.full_repaint
2206 << " row_has_changed=" << row_has_changed);
2209 // Backup full_repaint status and force full repaint
2210 // for inner insets as the Row has been cleared out.
2211 bool tmp = pi.full_repaint;
2212 pi.full_repaint = true;
2214 rp.paintSelection();
2217 rp.paintChangeBar();
2218 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2219 if (i == 0 && !is_rtl)
2221 if (i == nrows - 1 && is_rtl)
2224 if (i == nrows - 1 && !is_rtl)
2226 if (i == 0 && is_rtl)
2230 // Restore full_repaint status.
2231 pi.full_repaint = tmp;
2233 // Re-enable screen drawing for future use of the painter.
2234 pi.pain.setDrawingEnabled(original_drawing_state);
2236 //LYXERR(Debug::PAINTING, ".");
2240 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2241 Dimension & dim) const
2243 Cursor const & bvcur = cur.bv().cursor();
2245 // get word in front of cursor
2246 docstring word = text_->previousWord(bvcur.top());
2247 DocIterator wordStart = bvcur;
2248 wordStart.pos() -= word.length();
2250 // get position on screen of the word start and end
2251 //FIXME: Is it necessary to explicitly set this to false?
2252 wordStart.boundary(false);
2253 Point lxy = cur.bv().getPos(wordStart);
2254 Point rxy = cur.bv().getPos(bvcur);
2256 // calculate dimensions of the word
2258 row.pos(wordStart.pos());
2259 row.endpos(bvcur.pos());
2260 setRowHeight(row, bvcur.pit(), false);
2261 dim = row.dimension();
2262 dim.wid = abs(rxy.x_ - lxy.x_);
2264 // calculate position of word
2266 x = min(rxy.x_, lxy.x_);
2268 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2269 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2272 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2274 // ParagraphMetrics const & pm = par_metrics_[pit];
2275 // Row const & r = pm.rows()[row];
2281 int defaultRowHeight()
2283 return int(theFontMetrics(sane_font).maxHeight() * 1.2);