2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
31 #include "InsetList.h"
35 #include "MetricsInfo.h"
36 #include "ParagraphParameters.h"
37 #include "ParIterator.h"
38 #include "rowpainter.h"
40 #include "TextClass.h"
42 #include "WordLangTuple.h"
44 #include "insets/InsetText.h"
46 #include "mathed/MacroTable.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
52 #include "support/debug.h"
53 #include "support/docstring_list.h"
54 #include "support/lassert.h"
63 using frontend::FontMetrics;
65 static int numberOfSeparators(Paragraph const & par, Row const & row)
67 pos_type const first = max(row.pos(), par.beginOfBody());
68 pos_type const last = row.endpos() - 1;
70 for (pos_type p = first; p < last; ++p) {
71 if (par.isSeparator(p))
78 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
80 pos_type last = row.endpos() - 1;
81 pos_type first = row.pos();
83 // hfill *DO* count at the beginning of paragraphs!
85 while (first < last && par.isHfill(first))
89 last = min(last, par.beginOfBody());
91 for (pos_type p = first; p < last; ++p) {
99 static int numberOfHfills(Paragraph const & par, Row const & row)
101 pos_type const last = row.endpos();
102 pos_type first = row.pos();
104 // hfill *DO* count at the beginning of paragraphs!
106 while (first < last && par.isHfill(first))
110 first = max(first, par.beginOfBody());
113 for (pos_type p = first; p < last; ++p) {
121 /////////////////////////////////////////////////////////////////////
125 /////////////////////////////////////////////////////////////////////
128 TextMetrics::TextMetrics(BufferView * bv, Text * text)
129 : bv_(bv), text_(text)
132 max_width_ = bv_->workWidth();
133 dim_.wid = max_width_;
139 bool TextMetrics::contains(pit_type pit) const
141 return par_metrics_.find(pit) != par_metrics_.end();
145 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
147 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
152 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
154 ParMetricsCache::const_iterator it = par_metrics_.begin();
155 return make_pair(it->first, &it->second);
159 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
161 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
162 return make_pair(it->first, &it->second);
166 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
168 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
169 if (pmc_it == par_metrics_.end()) {
170 pmc_it = par_metrics_.insert(
171 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
173 if (pmc_it->second.rows().empty() && redo)
175 return pmc_it->second;
179 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
181 LASSERT(mi.base.textwidth > 0, /**/);
182 max_width_ = mi.base.textwidth;
183 // backup old dimension.
184 Dimension const old_dim = dim_;
187 dim_.wid = min_width;
188 pit_type const npar = text_->paragraphs().size();
190 // If there is more than one row, expand the text to
191 // the full allowable width.
192 dim_.wid = max_width_;
194 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
195 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
197 bool changed = false;
199 for (pit_type pit = 0; pit != npar; ++pit) {
200 changed |= redoParagraph(pit);
201 ParagraphMetrics const & pm = par_metrics_[pit];
203 if (dim_.wid < pm.width())
204 dim_.wid = pm.width();
207 dim_.asc = par_metrics_[0].ascent();
208 dim_.des = h - dim_.asc;
209 //lyxerr << "dim_.wid " << dim_.wid << endl;
210 //lyxerr << "dim_.asc " << dim_.asc << endl;
211 //lyxerr << "dim_.des " << dim_.des << endl;
213 changed |= dim_ != old_dim;
219 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
221 return main_text_? pm.rightMargin(*bv_) : 0;
225 int TextMetrics::rightMargin(pit_type const pit) const
227 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
231 void TextMetrics::applyOuterFont(Font & font) const
233 FontInfo lf(font_.fontInfo());
234 lf.reduce(bv_->buffer().params().getFont().fontInfo());
235 font.fontInfo().realize(lf);
239 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
241 LASSERT(pos >= 0, /**/);
243 ParagraphList const & pars = text_->paragraphs();
244 Paragraph const & par = pars[pit];
245 Layout const & layout = par.layout();
246 Buffer const & buffer = bv_->buffer();
248 BufferParams const & params = buffer.params();
249 pos_type const body_pos = par.beginOfBody();
251 // We specialize the 95% common case:
252 if (!par.getDepth()) {
253 Font f = par.getFontSettings(params, pos);
254 if (!text_->isMainText())
256 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
258 FontInfo const & lf = lab ? layout.labelfont : layout.font;
259 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
261 // In case the default family has been customized
262 if (lf.family() == INHERIT_FAMILY)
263 rlf.setFamily(params.getFont().fontInfo().family());
264 f.fontInfo().realize(rlf);
268 // The uncommon case need not be optimized as much
269 FontInfo const & layoutfont = pos < body_pos ?
270 layout.labelfont : layout.font;
272 Font font = par.getFontSettings(params, pos);
273 font.fontInfo().realize(layoutfont);
275 if (!text_->isMainText())
276 applyOuterFont(font);
278 // Realize against environment font information
279 // NOTE: the cast to pit_type should be removed when pit_type
280 // changes to a unsigned integer.
281 if (pit < pit_type(pars.size()))
282 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
284 // Realize with the fonts of lesser depth.
285 font.fontInfo().realize(params.getFont().fontInfo());
291 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
293 if (!lyxrc.rtl_support || !sl.text())
297 if (boundary && sl.pos() > 0)
300 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
304 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
306 // no RTL boundary at paragraph start
307 if (!lyxrc.rtl_support || pos == 0)
310 Font const & left_font = displayFont(pit, pos - 1);
312 return isRTLBoundary(pit, pos, left_font);
316 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
317 Font const & font) const
319 if (!lyxrc.rtl_support
320 // no RTL boundary at paragraph start
322 // if the metrics have not been calculated, then we are not
323 // on screen and can safely ignore issues about boundaries.
327 ParagraphMetrics & pm = par_metrics_[pit];
328 // no RTL boundary in empty paragraph
329 if (pm.rows().empty())
332 pos_type endpos = pm.getRow(pos - 1, false).endpos();
333 pos_type startpos = pm.getRow(pos, false).pos();
334 // no RTL boundary at line start:
335 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
337 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
340 Paragraph const & par = text_->getPar(pit);
341 // no RTL boundary at line break:
342 // abc|\n -> move right -> abc\n (and not: abc\n|
344 if (startpos == pos && endpos == pos && endpos != par.size()
345 && (par.isNewline(pos - 1)
346 || par.isLineSeparator(pos - 1)
347 || par.isSeparator(pos - 1)))
350 bool left = font.isVisibleRightToLeft();
352 if (pos == par.size())
353 right = par.isRTL(bv_->buffer().params());
355 right = displayFont(pit, pos).isVisibleRightToLeft();
357 return left != right;
361 bool TextMetrics::redoParagraph(pit_type const pit)
363 Paragraph & par = text_->getPar(pit);
364 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
365 // redoParagraph() recursively inside parMetrics.
366 Dimension old_dim = parMetrics(pit, false).dim();
367 ParagraphMetrics & pm = par_metrics_[pit];
370 Buffer & buffer = bv_->buffer();
371 main_text_ = (text_ == &buffer.text());
372 bool changed = false;
374 // Optimisation: this is used in the next two loops
375 // so better to calculate that once here.
376 int const right_margin = rightMargin(pm);
378 // iterator pointing to paragraph to resolve macros
379 DocIterator parPos = text_->macrocontextPosition();
383 LYXERR(Debug::INFO, "MacroContext not initialised!"
384 << " Going through the buffer again and hope"
385 << " the context is better then.");
386 // FIXME audit updateBuffer calls
387 // This should not be here, but it is not clear yet where else it
389 bv_->buffer().updateBuffer();
390 parPos = text_->macrocontextPosition();
391 LASSERT(!parPos.empty(), /**/);
396 // FIXME: We should always use getFont(), see documentation of
397 // noFontChange() in Inset.h.
398 Font const bufferfont = buffer.params().getFont();
399 InsetList::const_iterator ii = par.insetList().begin();
400 InsetList::const_iterator iend = par.insetList().end();
401 for (; ii != iend; ++ii) {
402 // position already initialized?
403 if (!parPos.empty()) {
404 parPos.pos() = ii->pos;
406 // A macro template would normally not be visible
407 // by itself. But the tex macro semantics allow
408 // recursion, so we artifically take the context
409 // after the macro template to simulate this.
410 if (ii->inset->lyxCode() == MATHMACRO_CODE)
414 // do the metric calculation
416 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
418 Font const & font = ii->inset->noFontChange() ?
419 bufferfont : displayFont(pit, ii->pos);
420 MacroContext mc(&buffer, parPos);
421 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
422 ii->inset->metrics(mi, dim);
423 Dimension const old_dim = pm.insetDimension(ii->inset);
424 if (old_dim != dim) {
425 pm.setInsetDimension(ii->inset, dim);
430 par.setBeginOfBody();
432 size_t row_index = 0;
433 // maximum pixel width of a row
434 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
437 pos_type end = rowBreakPoint(width, pit, first);
438 if (row_index || end < par.size())
439 // If there is more than one row, expand the text to
440 // the full allowable width. This setting here is needed
441 // for the computeRowMetrics() below.
442 dim_.wid = max_width_;
444 dim = rowHeight(pit, first, end);
445 dim.wid = rowWidth(right_margin, pit, first, end);
446 if (row_index == pm.rows().size())
447 pm.rows().push_back(Row());
448 Row & row = pm.rows()[row_index];
449 row.setChanged(false);
452 row.setDimension(dim);
453 int const max_row_width = max(dim_.wid, dim.wid);
454 computeRowMetrics(pit, row, max_row_width);
458 pm.dim().wid = max(pm.dim().wid, dim.wid);
459 pm.dim().des += dim.height();
460 } while (first < par.size());
462 if (row_index < pm.rows().size())
463 pm.rows().resize(row_index);
465 // Make sure that if a par ends in newline, there is one more row
467 if (first > 0 && par.isNewline(first - 1)) {
468 Dimension dim = rowHeight(pit, first, first);
469 dim.wid = rowWidth(right_margin, pit, first, first);
470 if (row_index == pm.rows().size())
471 pm.rows().push_back(Row());
472 Row & row = pm.rows()[row_index];
473 row.setChanged(false);
476 row.setDimension(dim);
477 int const max_row_width = max(dim_.wid, dim.wid);
478 computeRowMetrics(pit, row, max_row_width);
479 pm.dim().des += dim.height();
482 pm.dim().asc += pm.rows()[0].ascent();
483 pm.dim().des -= pm.rows()[0].ascent();
485 changed |= old_dim.height() != pm.dim().height();
491 void TextMetrics::computeRowMetrics(pit_type const pit,
492 Row & row, int width) const
497 Paragraph const & par = text_->getPar(pit);
499 double w = width - row.width();
500 // FIXME: put back this assertion when the crash on new doc is solved.
501 //LASSERT(w >= 0, /**/);
503 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
504 //lyxerr << "row.width() " << row.width() << endl;
505 //lyxerr << "w " << w << endl;
507 bool const is_rtl = text_->isRTL(par);
509 row.x = rightMargin(pit);
511 row.x = leftMargin(max_width_, pit, row.pos());
513 // is there a manual margin with a manual label
514 Layout const & layout = par.layout();
516 if (layout.margintype == MARGIN_MANUAL
517 && layout.labeltype == LABEL_MANUAL) {
518 /// We might have real hfills in the label part
519 int nlh = numberOfLabelHfills(par, row);
521 // A manual label par (e.g. List) has an auto-hfill
522 // between the label text and the body of the
524 // But we don't want to do this auto hfill if the par
529 if (nlh && !par.getLabelWidthString().empty())
530 row.label_hfill = labelFill(pit, row) / double(nlh);
534 // are there any hfills in the row?
535 if (int const nh = numberOfHfills(par, row)) {
537 hfill = w / double(nh);
538 // we don't have to look at the alignment if it is ALIGN_LEFT and
539 // if the row is already larger then the permitted width as then
540 // we force the LEFT_ALIGN'edness!
541 } else if (int(row.width()) < max_width_) {
542 // is it block, flushleft or flushright?
543 // set x how you need it
545 if (par.params().align() == LYX_ALIGN_LAYOUT)
546 align = layout.align;
548 align = par.params().align();
550 // handle alignment inside tabular cells
551 Inset const & owner = text_->inset();
552 switch (owner.contentAlignment()) {
553 case LYX_ALIGN_CENTER:
555 case LYX_ALIGN_RIGHT:
556 if (align == LYX_ALIGN_NONE
557 || align == LYX_ALIGN_BLOCK)
558 align = owner.contentAlignment();
561 // unchanged (use align)
565 // Display-style insets should always be on a centered row
566 if (Inset const * inset = par.getInset(row.pos())) {
567 switch (inset->display()) {
568 case Inset::AlignLeft:
569 align = LYX_ALIGN_BLOCK;
571 case Inset::AlignCenter:
572 align = LYX_ALIGN_CENTER;
575 // unchanged (use align)
577 case Inset::AlignRight:
578 align = LYX_ALIGN_RIGHT;
584 case LYX_ALIGN_BLOCK: {
585 int const ns = numberOfSeparators(par, row);
586 bool disp_inset = false;
587 if (row.endpos() < par.size()) {
588 Inset const * in = par.getInset(row.endpos());
590 disp_inset = in->display();
592 // If we have separators, this is not the last row of a
593 // par, does not end in newline, and is not row above a
594 // display inset... then stretch it
596 && row.endpos() < par.size()
597 && !par.isNewline(row.endpos() - 1)
600 row.separator = w / ns;
601 //lyxerr << "row.separator " << row.separator << endl;
602 //lyxerr << "ns " << ns << endl;
608 case LYX_ALIGN_RIGHT:
611 case LYX_ALIGN_CENTER:
618 pos_type body_pos = par.beginOfBody();
619 pos_type end = row.endpos();
622 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
624 row.x += theFontMetrics(text_->labelFont(par)).
625 width(layout.labelsep);
627 row.x += row.label_hfill;
631 pos_type const endpos = row.endpos();
632 pos_type body_pos = par.beginOfBody();
634 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
637 ParagraphMetrics & pm = par_metrics_[pit];
638 InsetList::const_iterator ii = par.insetList().begin();
639 InsetList::const_iterator iend = par.insetList().end();
640 for ( ; ii != iend; ++ii) {
641 if (ii->pos >= endpos || ii->pos < row.pos()
642 || (ii->inset->lyxCode() != SPACE_CODE ||
643 !ii->inset->isStretchableSpace()))
645 Dimension dim = row.dimension();
646 if (pm.hfillExpansion(row, ii->pos))
647 dim.wid = int(ii->pos >= body_pos ?
648 max(hfill, 5.0) : row.label_hfill);
651 // Cache the inset dimension.
652 bv_->coordCache().insets().add(ii->inset, dim);
653 pm.setInsetDimension(ii->inset, dim);
658 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
660 Paragraph const & par = text_->getPar(pit);
662 pos_type last = par.beginOfBody();
663 LASSERT(last > 0, /**/);
665 // -1 because a label ends with a space that is in the label
668 // a separator at this end does not count
669 if (par.isLineSeparator(last))
673 for (pos_type i = row.pos(); i <= last; ++i)
674 w += singleWidth(pit, i);
676 docstring const & label = par.params().labelWidthString();
680 FontMetrics const & fm
681 = theFontMetrics(text_->labelFont(par));
683 return max(0, fm.width(label) - w);
687 // this needs special handling - only newlines count as a break point
688 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
690 pos_type const end = par.size();
693 if (par.isNewline(i))
700 int TextMetrics::labelEnd(pit_type const pit) const
702 // labelEnd is only needed if the layout fills a flushleft label.
703 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
705 // return the beginning of the body
706 return leftMargin(max_width_, pit);
712 * Calling Text::getFont is slow. While rebreaking we scan a
713 * paragraph from left to right calling getFont for every char. This
714 * simple class address this problem by hidding an optimization trick
715 * (not mine btw -AB): the font is reused in the whole font span. The
716 * class handles transparently the "hidden" (not part of the fontlist)
717 * label font (as getFont does).
723 FontIterator(TextMetrics const & tm,
724 Paragraph const & par, pit_type pit, pos_type pos)
725 : tm_(tm), par_(par), pit_(pit), pos_(pos),
726 font_(tm.displayFont(pit, pos)),
727 endspan_(par.fontSpan(pos).last),
728 bodypos_(par.beginOfBody())
732 Font const & operator*() const { return font_; }
735 FontIterator & operator++()
738 if (pos_ > endspan_ || pos_ == bodypos_) {
739 font_ = tm_.displayFont(pit_, pos_);
740 endspan_ = par_.fontSpan(pos_).last;
746 Font * operator->() { return &font_; }
750 TextMetrics const & tm_;
752 Paragraph const & par_;
767 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
770 ParagraphMetrics const & pm = par_metrics_[pit];
771 Paragraph const & par = text_->getPar(pit);
772 pos_type const end = par.size();
773 if (pos == end || width < 0)
776 Layout const & layout = par.layout();
778 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
779 return addressBreakPoint(pos, par);
781 pos_type const body_pos = par.beginOfBody();
783 // check for possible inline completion
784 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
785 pos_type inlineCompletionLPos = -1;
786 if (inlineCompletionPos.inTexted()
787 && inlineCompletionPos.text() == text_
788 && inlineCompletionPos.pit() == pit) {
789 // draw logically behind the previous character
790 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
793 // Now we iterate through until we reach the right margin
794 // or the end of the par, then choose the possible break
797 int label_end = labelEnd(pit);
798 int const left = leftMargin(max_width_, pit, pos);
801 // pixel width since last breakpoint
804 docstring const s(1, char_type(0x00B6));
806 int par_marker_width = theFontMetrics(f).width(s);
808 FontIterator fi = FontIterator(*this, par, pit, pos);
809 pos_type point = end;
812 ParagraphList const & pars_ = text_->paragraphs();
813 bool const draw_par_end_marker = lyxrc.paragraph_markers
814 && size_type(pit + 1) < pars_.size();
816 for ( ; i < end; ++i, ++fi) {
817 int thiswidth = pm.singleWidth(i, *fi);
819 if (draw_par_end_marker && i == end - 1)
820 // enlarge the last character to hold the end-of-par marker
821 thiswidth += par_marker_width;
823 // add inline completion width
824 if (inlineCompletionLPos == i) {
825 docstring const & completion = bv_->inlineCompletion();
826 if (completion.length() > 0)
827 thiswidth += theFontMetrics(*fi).width(completion);
830 // add the auto-hfill from label end to the body
831 if (body_pos && i == body_pos) {
832 FontMetrics const & fm = theFontMetrics(
833 text_->labelFont(par));
834 int add = fm.width(layout.labelsep);
835 if (par.isLineSeparator(i - 1))
836 add -= singleWidth(pit, i - 1);
838 add = max(add, label_end - x);
843 chunkwidth += thiswidth;
845 // break before a character that will fall off
846 // the right of the row
848 // if no break before, break here
849 if (point == end || chunkwidth >= width - left) {
855 // exit on last registered breakpoint:
859 if (par.isNewline(i)) {
863 Inset const * inset = 0;
866 if ((inset = par.getInset(i + 1)) && inset->display()) {
871 if ((inset = par.getInset(i)) && inset->display()) {
877 inset = par.getInset(i);
878 if (!inset || inset->isChar()) {
879 // some insets are line separators too
880 if (par.isLineSeparator(i)) {
881 // register breakpoint:
888 // maybe found one, but the par is short enough.
889 if (i == end && x < width)
892 // manual labels cannot be broken in LaTeX. But we
893 // want to make our on-screen rendering of footnotes
895 if (body_pos && point < body_pos)
902 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
903 pos_type const first, pos_type const end) const
905 // get the pure distance
906 ParagraphMetrics const & pm = par_metrics_[pit];
907 Paragraph const & par = text_->getPar(pit);
908 int w = leftMargin(max_width_, pit, first);
909 int label_end = labelEnd(pit);
911 // check for possible inline completion
912 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
913 pos_type inlineCompletionLPos = -1;
914 if (inlineCompletionPos.inTexted()
915 && inlineCompletionPos.text() == text_
916 && inlineCompletionPos.pit() == pit) {
917 // draw logically behind the previous character
918 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
921 pos_type const body_pos = par.beginOfBody();
925 FontIterator fi = FontIterator(*this, par, pit, i);
926 for ( ; i < end; ++i, ++fi) {
927 if (body_pos > 0 && i == body_pos) {
928 FontMetrics const & fm = theFontMetrics(
929 text_->labelFont(par));
930 w += fm.width(par.layout().labelsep);
931 if (par.isLineSeparator(i - 1))
932 w -= singleWidth(pit, i - 1);
933 w = max(w, label_end);
936 // a line separator at the end of a line (but not at the end of a
937 // paragraph) will not be drawn and should therefore not count for
939 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
940 w += pm.singleWidth(i, *fi);
942 // add inline completion width
943 if (inlineCompletionLPos == i) {
944 docstring const & completion = bv_->inlineCompletion();
945 if (completion.length() > 0)
946 w += theFontMetrics(*fi).width(completion);
951 // count the paragraph end marker.
952 if (end == par.size() && lyxrc.paragraph_markers) {
953 ParagraphList const & pars_ = text_->paragraphs();
954 if (size_type(pit + 1) < pars_.size()) {
955 // enlarge the last character to hold the
957 docstring const s(1, char_type(0x00B6));
959 w += theFontMetrics(f).width(s);
963 if (body_pos > 0 && body_pos >= end) {
964 FontMetrics const & fm = theFontMetrics(
965 text_->labelFont(par));
966 w += fm.width(par.layout().labelsep);
967 if (end > 0 && par.isLineSeparator(end - 1))
968 w -= singleWidth(pit, end - 1);
969 w = max(w, label_end);
972 return w + right_margin;
976 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
977 pos_type const end, bool topBottomSpace) const
979 Paragraph const & par = text_->getPar(pit);
980 // get the maximum ascent and the maximum descent
981 double layoutasc = 0;
982 double layoutdesc = 0;
983 double const dh = defaultRowHeight();
985 // ok, let us initialize the maxasc and maxdesc value.
986 // Only the fontsize count. The other properties
987 // are taken from the layoutfont. Nicer on the screen :)
988 Layout const & layout = par.layout();
990 // as max get the first character of this row then it can
991 // increase but not decrease the height. Just some point to
992 // start with so we don't have to do the assignment below too
994 Buffer const & buffer = bv_->buffer();
995 Font font = displayFont(pit, first);
996 FontSize const tmpsize = font.fontInfo().size();
997 font.fontInfo() = text_->layoutFont(pit);
998 FontSize const size = font.fontInfo().size();
999 font.fontInfo().setSize(tmpsize);
1001 FontInfo labelfont = text_->labelFont(par);
1003 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1004 FontMetrics const & fontmetrics = theFontMetrics(font);
1006 // these are minimum values
1007 double const spacing_val = layout.spacing.getValue()
1008 * text_->spacing(par);
1009 //lyxerr << "spacing_val = " << spacing_val << endl;
1010 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1011 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1013 // insets may be taller
1014 ParagraphMetrics const & pm = par_metrics_[pit];
1015 InsetList::const_iterator ii = par.insetList().begin();
1016 InsetList::const_iterator iend = par.insetList().end();
1017 for ( ; ii != iend; ++ii) {
1018 if (ii->pos >= first && ii->pos < end) {
1019 Dimension const & dim = pm.insetDimension(ii->inset);
1020 maxasc = max(maxasc, dim.ascent());
1021 maxdesc = max(maxdesc, dim.descent());
1025 // Check if any custom fonts are larger (Asger)
1026 // This is not completely correct, but we can live with the small,
1027 // cosmetic error for now.
1031 par.highestFontInRange(first, end, size);
1032 if (maxsize > font.fontInfo().size()) {
1033 // use standard paragraph font with the maximal size
1034 FontInfo maxfont = font.fontInfo();
1035 maxfont.setSize(maxsize);
1036 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1037 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1038 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1041 // This is nicer with box insets:
1045 ParagraphList const & pars = text_->paragraphs();
1046 Inset const & inset = text_->inset();
1048 // is it a top line?
1049 if (first == 0 && topBottomSpace) {
1050 BufferParams const & bufparams = buffer.params();
1051 // some parskips VERY EASY IMPLEMENTATION
1052 if (bufparams.paragraph_separation
1053 == BufferParams::ParagraphSkipSeparation
1054 && inset.lyxCode() != ERT_CODE
1055 && inset.lyxCode() != LISTINGS_CODE
1057 && ((layout.isParagraph() && par.getDepth() == 0)
1058 || (pars[pit - 1].layout().isParagraph()
1059 && pars[pit - 1].getDepth() == 0)))
1061 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1064 if (par.params().startOfAppendix())
1065 maxasc += int(3 * dh);
1067 // This is special code for the chapter, since the label of this
1068 // layout is printed in an extra row
1069 if (layout.counter == "chapter"
1070 && !par.params().labelString().empty()) {
1071 labeladdon = int(labelfont_metrics.maxHeight()
1072 * layout.spacing.getValue()
1073 * text_->spacing(par));
1076 // special code for the top label
1077 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1078 || layout.labeltype == LABEL_BIBLIO
1079 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1080 && text_->isFirstInSequence(pit)
1081 && !par.labelString().empty())
1084 labelfont_metrics.maxHeight()
1085 * layout.spacing.getValue()
1086 * text_->spacing(par)
1087 + (layout.topsep + layout.labelbottomsep) * dh);
1090 // Add the layout spaces, for example before and after
1091 // a section, or between the items of a itemize or enumerate
1094 pit_type prev = text_->depthHook(pit, par.getDepth());
1095 Paragraph const & prevpar = pars[prev];
1097 && prevpar.layout() == layout
1098 && prevpar.getDepth() == par.getDepth()
1099 && prevpar.getLabelWidthString()
1100 == par.getLabelWidthString()) {
1101 layoutasc = layout.itemsep * dh;
1102 } else if (pit != 0 || first != 0) {
1103 if (layout.topsep > 0)
1104 layoutasc = layout.topsep * dh;
1107 prev = text_->outerHook(pit);
1108 if (prev != pit_type(pars.size())) {
1109 maxasc += int(pars[prev].layout().parsep * dh);
1110 } else if (pit != 0) {
1111 Paragraph const & prevpar = pars[pit - 1];
1112 if (prevpar.getDepth() != 0 ||
1113 prevpar.layout() == layout) {
1114 maxasc += int(layout.parsep * dh);
1119 // is it a bottom line?
1120 if (end >= par.size() && topBottomSpace) {
1121 // add the layout spaces, for example before and after
1122 // a section, or between the items of a itemize or enumerate
1124 pit_type nextpit = pit + 1;
1125 if (nextpit != pit_type(pars.size())) {
1126 pit_type cpit = pit;
1130 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1131 usual = pars[cpit].layout().bottomsep * dh;
1132 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1133 if (pars[cpit].layout() != pars[nextpit].layout()
1134 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1136 unusual = pars[cpit].layout().bottomsep * dh;
1138 layoutdesc = max(unusual, usual);
1139 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1140 if (pars[cpit].layout() != pars[nextpit].layout()
1141 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1142 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1147 // incalculate the layout spaces
1148 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1149 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1151 // FIXME: the correct way is to do the following is to move the
1152 // following code in another method specially tailored for the
1153 // main Text. The following test is thus bogus.
1154 // Top and bottom margin of the document (only at top-level)
1155 if (main_text_ && topBottomSpace) {
1156 if (pit == 0 && first == 0)
1158 if (pit + 1 == pit_type(pars.size()) &&
1159 end == par.size() &&
1160 !(end > 0 && par.isNewline(end - 1)))
1164 return Dimension(0, maxasc + labeladdon, maxdesc);
1168 // x is an absolute screen coord
1169 // returns the column near the specified x-coordinate of the row
1170 // x is set to the real beginning of this column
1171 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1172 Row const & row, int & x, bool & boundary) const
1174 Buffer const & buffer = bv_->buffer();
1176 /// For the main Text, it is possible that this pit is not
1177 /// yet in the CoordCache when moving cursor up.
1178 /// x Paragraph coordinate is always 0 for main text anyway.
1179 int const xo = origin_.x_;
1181 Paragraph const & par = text_->getPar(pit);
1183 bidi.computeTables(par, buffer, row);
1185 pos_type vc = row.pos();
1186 pos_type end = row.endpos();
1188 Layout const & layout = par.layout();
1190 bool left_side = false;
1192 pos_type body_pos = par.beginOfBody();
1194 double tmpx = row.x;
1195 double last_tmpx = tmpx;
1198 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1201 // check for empty row
1207 // This (rtl_support test) is not needed, but gives
1208 // some speedup if rtl_support == false
1209 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1211 // If lastrow is false, we don't need to compute
1212 // the value of rtl.
1213 bool const rtl = lastrow ? text_->isRTL(par) : false;
1215 // if the first character is a separator, and we are in RTL
1216 // text, this character will not be painted on screen
1217 // and thus we should not count it and skip to the next.
1218 if (rtl && par.isSeparator(bidi.vis2log(vc)))
1221 while (vc < end && tmpx <= x) {
1222 c = bidi.vis2log(vc);
1224 if (body_pos > 0 && c == body_pos - 1) {
1225 FontMetrics const & fm = theFontMetrics(
1226 text_->labelFont(par));
1227 tmpx += row.label_hfill + fm.width(layout.labelsep);
1228 if (par.isLineSeparator(body_pos - 1))
1229 tmpx -= singleWidth(pit, body_pos - 1);
1232 tmpx += singleWidth(pit, c);
1233 if (par.isSeparator(c) && c >= body_pos)
1234 tmpx += row.separator;
1238 if ((tmpx + last_tmpx) / 2 > x) {
1243 LASSERT(vc <= end, /**/); // This shouldn't happen.
1248 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1249 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1250 if (!par.isNewline(end - 1))
1252 } else if (vc == row.pos()) {
1253 c = bidi.vis2log(vc);
1254 if (bidi.level(c) % 2 == 1)
1257 c = bidi.vis2log(vc - 1);
1258 bool const rtl = (bidi.level(c) % 2 == 1);
1259 if (left_side == rtl) {
1261 boundary = isRTLBoundary(pit, c);
1265 // I believe this code is not needed anymore (Jug 20050717)
1267 // The following code is necessary because the cursor position past
1268 // the last char in a row is logically equivalent to that before
1269 // the first char in the next row. That's why insets causing row
1270 // divisions -- Newline and display-style insets -- must be treated
1271 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1272 // Newline inset, air gap below:
1273 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1274 if (bidi.level(end -1) % 2 == 0)
1275 tmpx -= singleWidth(pit, end - 1);
1277 tmpx += singleWidth(pit, end - 1);
1281 // Air gap above display inset:
1282 if (row.pos() < end && c >= end && end < par.size()
1283 && par.isInset(end) && par.getInset(end)->display()) {
1286 // Air gap below display inset:
1287 if (row.pos() < end && c >= end && par.isInset(end - 1)
1288 && par.getInset(end - 1)->display()) {
1294 pos_type const col = c - row.pos();
1296 if (!c || end == par.size())
1299 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1304 return min(col, end - 1 - row.pos());
1308 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1310 // We play safe and use parMetrics(pit) to make sure the
1311 // ParagraphMetrics will be redone and OK to use if needed.
1312 // Otherwise we would use an empty ParagraphMetrics in
1313 // upDownInText() while in selection mode.
1314 ParagraphMetrics const & pm = parMetrics(pit);
1316 LASSERT(row < int(pm.rows().size()), /**/);
1318 Row const & r = pm.rows()[row];
1319 return r.pos() + getColumnNearX(pit, r, x, bound);
1323 void TextMetrics::newParMetricsDown()
1325 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1326 pit_type const pit = last.first + 1;
1327 if (pit == int(text_->paragraphs().size()))
1330 // do it and update its position.
1332 par_metrics_[pit].setPosition(last.second.position()
1333 + last.second.descent() + par_metrics_[pit].ascent());
1337 void TextMetrics::newParMetricsUp()
1339 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1340 if (first.first == 0)
1343 pit_type const pit = first.first - 1;
1344 // do it and update its position.
1346 par_metrics_[pit].setPosition(first.second.position()
1347 - first.second.ascent() - par_metrics_[pit].descent());
1350 // y is screen coordinate
1351 pit_type TextMetrics::getPitNearY(int y)
1353 LASSERT(!text_->paragraphs().empty(), return -1);
1354 LASSERT(!par_metrics_.empty(), return -1);
1355 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1357 // look for highest numbered paragraph with y coordinate less than given y
1360 ParMetricsCache::const_iterator it = par_metrics_.begin();
1361 ParMetricsCache::const_iterator et = par_metrics_.end();
1362 ParMetricsCache::const_iterator last = et; last--;
1364 ParagraphMetrics const & pm = it->second;
1366 if (y < it->second.position() - int(pm.ascent())) {
1367 // We are looking for a position that is before the first paragraph in
1368 // the cache (which is in priciple off-screen, that is before the
1371 // We are already at the first paragraph in the inset.
1373 // OK, this is the paragraph we are looking for.
1374 pit = it->first - 1;
1379 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1381 if (y >= last->second.position() + int(pm_last.descent())) {
1382 // We are looking for a position that is after the last paragraph in
1383 // the cache (which is in priciple off-screen), that is before the
1385 pit = last->first + 1;
1386 if (pit == int(text_->paragraphs().size()))
1387 // We are already at the last paragraph in the inset.
1389 // OK, this is the paragraph we are looking for.
1390 newParMetricsDown();
1394 for (; it != et; ++it) {
1395 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1396 << " y: " << it->second.position());
1398 ParagraphMetrics const & pm = par_metrics_[it->first];
1400 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1402 yy = it->second.position();
1406 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1412 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1413 bool assert_in_view, bool up)
1415 ParagraphMetrics const & pm = par_metrics_[pit];
1417 int yy = pm.position() - pm.ascent();
1418 LASSERT(!pm.rows().empty(), /**/);
1419 RowList::const_iterator rit = pm.rows().begin();
1420 RowList::const_iterator rlast = pm.rows().end();
1422 for (; rit != rlast; yy += rit->height(), ++rit)
1423 if (yy + rit->height() > y)
1426 if (assert_in_view) {
1427 if (!up && yy + rit->height() > y) {
1428 if (rit != pm.rows().begin()) {
1431 } else if (pit != 0) {
1434 ParagraphMetrics const & pm2 = par_metrics_[pit];
1435 rit = pm2.rows().end();
1439 } else if (up && yy != y) {
1441 y = yy + rit->height();
1443 } else if (pit < int(text_->paragraphs().size()) - 1) {
1445 newParMetricsDown();
1446 ParagraphMetrics const & pm2 = par_metrics_[pit];
1447 rit = pm2.rows().begin();
1456 // x,y are absolute screen coordinates
1457 // sets cursor recursively descending into nested editable insets
1458 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1459 bool assert_in_view, bool up)
1461 if (lyxerr.debugging(Debug::WORKAREA)) {
1462 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1463 cur.bv().coordCache().dump();
1465 pit_type pit = getPitNearY(y);
1466 LASSERT(pit != -1, return 0);
1468 int yy = y; // is modified by getPitAndRowNearY
1469 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1471 bool bound = false; // is modified by getColumnNearX
1472 int xx = x; // is modified by getColumnNearX
1473 pos_type const pos = row.pos()
1474 + getColumnNearX(pit, row, xx, bound);
1477 cur.boundary(bound);
1480 // try to descend into nested insets
1481 Inset * inset = checkInsetHit(x, yy);
1482 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1484 // Either we deconst editXY or better we move current_font
1485 // and real_current_font to Cursor
1486 // FIXME: what is needed now that current_font and real_current_font
1488 cur.setCurrentFont();
1492 ParagraphList const & pars = text_->paragraphs();
1493 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1495 // This should be just before or just behind the
1496 // cursor position set above.
1497 LASSERT(inset == inset_before
1498 || inset == pars[pit].getInset(pos), /**/);
1500 // Make sure the cursor points to the position before
1502 if (inset == inset_before) {
1504 cur.boundary(false);
1507 // Try to descend recursively inside the inset.
1508 inset = inset->editXY(cur, x, yy);
1510 if (cur.top().text() == text_)
1511 cur.setCurrentFont();
1516 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1518 LASSERT(text_ == cur.text(), /**/);
1519 pit_type pit = getPitNearY(y);
1520 LASSERT(pit != -1, return);
1522 ParagraphMetrics const & pm = par_metrics_[pit];
1524 int yy = pm.position() - pm.ascent();
1525 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1526 " pit: " << pit << " yy: " << yy);
1529 LASSERT(pm.rows().size(), /**/);
1530 for (; r < int(pm.rows().size()) - 1; ++r) {
1531 Row const & row = pm.rows()[r];
1532 if (int(yy + row.height()) > y)
1537 Row const & row = pm.rows()[r];
1539 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1543 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1545 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1547 text_->setCursor(cur, pit, pos, true, bound);
1548 // remember new position.
1553 //takes screen x,y coordinates
1554 Inset * TextMetrics::checkInsetHit(int x, int y)
1556 pit_type pit = getPitNearY(y);
1557 LASSERT(pit != -1, return 0);
1559 Paragraph const & par = text_->paragraphs()[pit];
1560 ParagraphMetrics const & pm = par_metrics_[pit];
1562 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1564 InsetList::const_iterator iit = par.insetList().begin();
1565 InsetList::const_iterator iend = par.insetList().end();
1566 for (; iit != iend; ++iit) {
1567 Inset * inset = iit->inset;
1569 LYXERR(Debug::DEBUG, "examining inset " << inset);
1571 if (!bv_->coordCache().getInsets().has(inset)) {
1572 LYXERR(Debug::DEBUG, "inset has no cached position");
1576 Dimension const & dim = pm.insetDimension(inset);
1577 Point p = bv_->coordCache().getInsets().xy(inset);
1579 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1580 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1583 && x <= p.x_ + dim.wid
1584 && y >= p.y_ - dim.asc
1585 && y <= p.y_ + dim.des) {
1586 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1591 LYXERR(Debug::DEBUG, "No inset hit. ");
1596 int TextMetrics::cursorX(CursorSlice const & sl,
1597 bool boundary) const
1599 LASSERT(sl.text() == text_, /**/);
1600 pit_type const pit = sl.pit();
1601 Paragraph const & par = text_->paragraphs()[pit];
1602 ParagraphMetrics const & pm = par_metrics_[pit];
1603 if (pm.rows().empty())
1606 pos_type ppos = sl.pos();
1607 // Correct position in front of big insets
1608 bool const boundary_correction = ppos != 0 && boundary;
1609 if (boundary_correction)
1612 Row const & row = pm.getRow(sl.pos(), boundary);
1614 pos_type cursor_vpos = 0;
1616 Buffer const & buffer = bv_->buffer();
1619 bidi.computeTables(par, buffer, row);
1621 pos_type const row_pos = row.pos();
1622 pos_type const end = row.endpos();
1623 // Spaces at logical line breaks in bidi text must be skipped during
1624 // cursor positioning. However, they may appear visually in the middle
1625 // of a row; they must be skipped, wherever they are...
1626 // * logically "abc_[HEBREW_\nHEBREW]"
1627 // * visually "abc_[_WERBEH\nWERBEH]"
1628 pos_type skipped_sep_vpos = -1;
1631 cursor_vpos = row_pos;
1632 else if (ppos >= end)
1633 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1634 else if (ppos > row_pos && ppos >= end)
1635 //FIXME: this code is never reached!
1636 // (see http://www.lyx.org/trac/changeset/8251)
1637 // Place cursor after char at (logical) position pos - 1
1638 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1639 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1641 // Place cursor before char at (logical) position ppos
1642 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1643 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1645 pos_type body_pos = par.beginOfBody();
1647 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1650 // check for possible inline completion in this row
1651 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1652 pos_type inlineCompletionVPos = -1;
1653 if (inlineCompletionPos.inTexted()
1654 && inlineCompletionPos.text() == text_
1655 && inlineCompletionPos.pit() == pit
1656 && inlineCompletionPos.pos() - 1 >= row_pos
1657 && inlineCompletionPos.pos() - 1 < end) {
1658 // draw logically behind the previous character
1659 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1662 // Use font span to speed things up, see below
1666 // If the last logical character is a separator, skip it, unless
1667 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1668 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1669 skipped_sep_vpos = bidi.log2vis(end - 1);
1671 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1672 ParagraphList const & pars_ = text_->paragraphs();
1673 if (size_type(pit + 1) < pars_.size()) {
1675 docstring const s = docstring(1, char_type(0x00B6));
1676 x += theFontMetrics(f).width(s);
1680 // Inline completion RTL special case row_pos == cursor_pos:
1681 // "__|b" => cursor_pos is right of __
1682 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1683 font = displayFont(pit, row_pos + 1);
1684 docstring const & completion = bv_->inlineCompletion();
1685 if (font.isRightToLeft() && completion.length() > 0)
1686 x += theFontMetrics(font.fontInfo()).width(completion);
1689 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1690 // Skip the separator which is at the logical end of the row
1691 if (vpos == skipped_sep_vpos)
1693 pos_type pos = bidi.vis2log(vpos);
1694 if (body_pos > 0 && pos == body_pos - 1) {
1695 FontMetrics const & labelfm = theFontMetrics(
1696 text_->labelFont(par));
1697 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1698 if (par.isLineSeparator(body_pos - 1))
1699 x -= singleWidth(pit, body_pos - 1);
1702 // Use font span to speed things up, see above
1703 if (pos < font_span.first || pos > font_span.last) {
1704 font_span = par.fontSpan(pos);
1705 font = displayFont(pit, pos);
1708 x += pm.singleWidth(pos, font);
1710 // Inline completion RTL case:
1711 // "a__|b", __ of b => non-boundary a-pos is right of __
1712 if (vpos + 1 == inlineCompletionVPos
1713 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1714 font = displayFont(pit, vpos + 1);
1715 docstring const & completion = bv_->inlineCompletion();
1716 if (font.isRightToLeft() && completion.length() > 0)
1717 x += theFontMetrics(font.fontInfo()).width(completion);
1720 // Inline completion LTR case:
1721 // "b|__a", __ of b => non-boundary a-pos is in front of __
1722 if (vpos == inlineCompletionVPos
1723 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1724 font = displayFont(pit, vpos);
1725 docstring const & completion = bv_->inlineCompletion();
1726 if (!font.isRightToLeft() && completion.length() > 0)
1727 x += theFontMetrics(font.fontInfo()).width(completion);
1730 if (par.isSeparator(pos) && pos >= body_pos)
1734 // see correction above
1735 if (boundary_correction) {
1736 if (isRTL(sl, boundary))
1737 x -= singleWidth(pit, ppos);
1739 x += singleWidth(pit, ppos);
1746 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1748 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1749 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1750 if (pm.rows().empty())
1754 h -= par_metrics_[0].rows()[0].ascent();
1755 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1756 h += par_metrics_[pit].height();
1759 if (pos && boundary)
1761 size_t const rend = pm.pos2row(pos);
1762 for (size_t rit = 0; rit != rend; ++rit)
1763 h += pm.rows()[rit].height();
1764 h += pm.rows()[rend].ascent();
1769 // the cursor set functions have a special mechanism. When they
1770 // realize you left an empty paragraph, they will delete it.
1772 bool TextMetrics::cursorHome(Cursor & cur)
1774 LASSERT(text_ == cur.text(), /**/);
1775 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1776 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1777 return text_->setCursor(cur, cur.pit(), row.pos());
1781 bool TextMetrics::cursorEnd(Cursor & cur)
1783 LASSERT(text_ == cur.text(), /**/);
1784 // if not on the last row of the par, put the cursor before
1785 // the final space exept if I have a spanning inset or one string
1786 // is so long that we force a break.
1787 pos_type end = cur.textRow().endpos();
1789 // empty text, end-1 is no valid position
1791 bool boundary = false;
1792 if (end != cur.lastpos()) {
1793 if (!cur.paragraph().isLineSeparator(end-1)
1794 && !cur.paragraph().isNewline(end-1))
1799 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1803 void TextMetrics::deleteLineForward(Cursor & cur)
1805 LASSERT(text_ == cur.text(), /**/);
1806 if (cur.lastpos() == 0) {
1807 // Paragraph is empty, so we just go forward
1808 text_->cursorForward(cur);
1811 cur.setSelection(true); // to avoid deletion
1814 // What is this test for ??? (JMarc)
1815 if (!cur.selection())
1816 text_->deleteWordForward(cur);
1818 cap::cutSelection(cur, true, false);
1819 cur.checkBufferStructure();
1824 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1826 ParagraphList const & pars = text_->paragraphs();
1827 return row.endpos() >= pars[pit].size()
1828 && pit + 1 == pit_type(pars.size());
1832 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1834 return row.pos() == 0 && pit == 0;
1838 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1840 LASSERT(pit >= 0, /**/);
1841 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1842 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1846 int TextMetrics::leftMargin(int max_width,
1847 pit_type const pit, pos_type const pos) const
1849 ParagraphList const & pars = text_->paragraphs();
1851 LASSERT(pit >= 0, /**/);
1852 LASSERT(pit < int(pars.size()), /**/);
1853 Paragraph const & par = pars[pit];
1854 LASSERT(pos >= 0, /**/);
1855 LASSERT(pos <= par.size(), /**/);
1856 Buffer const & buffer = bv_->buffer();
1857 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1858 DocumentClass const & tclass = buffer.params().documentClass();
1859 Layout const & layout = par.layout();
1861 docstring parindent = layout.parindent;
1865 if (text_->isMainText())
1866 l_margin += bv_->leftMargin();
1868 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1869 tclass.leftmargin());
1871 if (par.getDepth() != 0) {
1872 // find the next level paragraph
1873 pit_type newpar = text_->outerHook(pit);
1874 if (newpar != pit_type(pars.size())) {
1875 if (pars[newpar].layout().isEnvironment()) {
1876 l_margin = leftMargin(max_width, newpar);
1878 if (tclass.isDefaultLayout(par.layout())
1879 || tclass.isPlainLayout(par.layout())) {
1880 if (pars[newpar].params().noindent())
1883 parindent = pars[newpar].layout().parindent;
1888 // This happens after sections in standard classes. The 1.3.x
1889 // code compared depths too, but it does not seem necessary
1891 if (tclass.isDefaultLayout(par.layout())
1892 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1895 FontInfo const labelfont = text_->labelFont(par);
1896 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1898 switch (layout.margintype) {
1899 case MARGIN_DYNAMIC:
1900 if (!layout.leftmargin.empty()) {
1901 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1904 if (!par.labelString().empty()) {
1905 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1906 l_margin += labelfont_metrics.width(par.labelString());
1907 l_margin += labelfont_metrics.width(layout.labelsep);
1911 case MARGIN_MANUAL: {
1912 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1913 // The width of an empty par, even with manual label, should be 0
1914 if (!par.empty() && pos >= par.beginOfBody()) {
1915 if (!par.getLabelWidthString().empty()) {
1916 docstring labstr = par.getLabelWidthString();
1917 l_margin += labelfont_metrics.width(labstr);
1918 l_margin += labelfont_metrics.width(layout.labelsep);
1924 case MARGIN_STATIC: {
1925 l_margin += theFontMetrics(buffer.params().getFont()).
1926 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1930 case MARGIN_FIRST_DYNAMIC:
1931 if (layout.labeltype == LABEL_MANUAL) {
1932 // if we are at position 0, we are never in the body
1933 if (pos > 0 && pos >= par.beginOfBody())
1934 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1936 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1938 // Special case to fix problems with
1940 || (layout.labeltype == LABEL_STATIC
1941 && layout.latextype == LATEX_ENVIRONMENT
1942 && !text_->isFirstInSequence(pit))) {
1943 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1944 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1945 && layout.labeltype != LABEL_BIBLIO
1946 && layout.labeltype !=
1947 LABEL_CENTERED_TOP_ENVIRONMENT) {
1948 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1949 l_margin += labelfont_metrics.width(layout.labelsep);
1950 l_margin += labelfont_metrics.width(par.labelString());
1954 case MARGIN_RIGHT_ADDRESS_BOX: {
1956 // ok, a terrible hack. The left margin depends on the widest
1957 // row in this paragraph.
1958 RowList::iterator rit = par.rows().begin();
1959 RowList::iterator end = par.rows().end();
1960 // FIXME: This is wrong.
1961 int minfill = max_width;
1962 for ( ; rit != end; ++rit)
1963 if (rit->fill() < minfill)
1964 minfill = rit->fill();
1965 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1966 l_margin += minfill;
1968 // also wrong, but much shorter.
1969 l_margin += max_width / 2;
1974 if (!par.params().leftIndent().zero())
1975 l_margin += par.params().leftIndent().inPixels(max_width);
1979 if (par.params().align() == LYX_ALIGN_LAYOUT)
1980 align = layout.align;
1982 align = par.params().align();
1984 // set the correct parindent
1986 && (layout.labeltype == LABEL_NO_LABEL
1987 || layout.labeltype == LABEL_TOP_ENVIRONMENT
1988 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1989 || (layout.labeltype == LABEL_STATIC
1990 && layout.latextype == LATEX_ENVIRONMENT
1991 && !text_->isFirstInSequence(pit)))
1992 && align == LYX_ALIGN_BLOCK
1993 && !par.params().noindent()
1994 // in some insets, paragraphs are never indented
1995 && !text_->inset().neverIndent()
1996 // display style insets are always centered, omit indentation
1999 && par.getInset(pos)->display())
2000 && (!(tclass.isDefaultLayout(par.layout())
2001 || tclass.isPlainLayout(par.layout()))
2002 || buffer.params().paragraph_separation
2003 == BufferParams::ParagraphIndentSeparation)
2006 // use the parindent of the layout when the default indentation is
2007 // used otherwise use the indentation set in the document settings
2008 if (buffer.params().getIndentation().asLyXCommand() == "default")
2009 l_margin += theFontMetrics(
2010 buffer.params().getFont()).signedWidth(parindent);
2012 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2019 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2021 ParagraphMetrics const & pm = par_metrics_[pit];
2023 return pm.singleWidth(pos, displayFont(pit, pos));
2027 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2029 if (par_metrics_.empty())
2035 ParMetricsCache::iterator it = par_metrics_.begin();
2036 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2037 y -= it->second.ascent();
2038 for (; it != pm_end; ++it) {
2039 ParagraphMetrics const & pmi = it->second;
2041 pit_type const pit = it->first;
2042 // Save the paragraph position in the cache.
2043 it->second.setPosition(y);
2044 drawParagraph(pi, pit, x, y);
2050 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2052 BufferParams const & bparams = bv_->buffer().params();
2053 ParagraphMetrics const & pm = par_metrics_[pit];
2054 if (pm.rows().empty())
2058 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2059 int const ww = bv_->workHeight();
2060 size_t const nrows = pm.rows().size();
2062 Cursor const & cur = bv_->cursor();
2063 DocIterator sel_beg = cur.selectionBegin();
2064 DocIterator sel_end = cur.selectionEnd();
2065 bool selection = cur.selection()
2066 // This is our text.
2067 && cur.text() == text_
2068 // if the anchor is outside, this is not our selection
2069 && cur.normalAnchor().text() == text_
2070 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2072 // We store the begin and end pos of the selection relative to this par
2073 DocIterator sel_beg_par = cur.selectionBegin();
2074 DocIterator sel_end_par = cur.selectionEnd();
2076 // We care only about visible selection.
2078 if (pit != sel_beg.pit()) {
2079 sel_beg_par.pit() = pit;
2080 sel_beg_par.pos() = 0;
2082 if (pit != sel_end.pit()) {
2083 sel_end_par.pit() = pit;
2084 sel_end_par.pos() = sel_end_par.lastpos();
2088 for (size_t i = 0; i != nrows; ++i) {
2090 Row const & row = pm.rows()[i];
2094 bool const inside = (y + row.descent() >= 0
2095 && y - row.ascent() < ww);
2096 // It is not needed to draw on screen if we are not inside.
2097 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2098 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2101 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2103 row.setSelection(-1, -1);
2105 // The row knows nothing about the paragraph, so we have to check
2106 // whether this row is the first or last and update the margins.
2107 if (row.selection()) {
2108 if (row.sel_beg == 0)
2109 row.begin_margin_sel = sel_beg.pit() < pit;
2110 if (row.sel_end == sel_end_par.lastpos())
2111 row.end_margin_sel = sel_end.pit() > pit;
2114 // Row signature; has row changed since last paint?
2115 row.setCrc(pm.computeRowSignature(row, bparams));
2116 bool row_has_changed = row.changed();
2118 // Take this opportunity to spellcheck the row contents.
2119 if (row_has_changed && lyxrc.spellcheck_continuously) {
2120 text_->getPar(pit).spellCheck();
2123 // Don't paint the row if a full repaint has not been requested
2124 // and if it has not changed.
2125 if (!pi.full_repaint && !row_has_changed) {
2126 // Paint only the insets if the text itself is
2128 rp.paintOnlyInsets();
2133 // Clear background of this row if paragraph background was not
2134 // already cleared because of a full repaint.
2135 if (!pi.full_repaint && row_has_changed) {
2136 pi.pain.fillRectangle(x, y - row.ascent(),
2137 width(), row.height(), pi.background_color);
2140 // Instrumentation for testing row cache (see also
2142 if (lyxerr.debugging(Debug::PAINTING) && inside
2143 && (row.selection() || pi.full_repaint || row_has_changed)) {
2144 string const foreword = text_->isMainText() ?
2145 "main text redraw " : "inset text redraw: ";
2146 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2147 << " row_selection=" << row.selection()
2148 << " full_repaint=" << pi.full_repaint
2149 << " row_has_changed=" << row_has_changed);
2152 // Backup full_repaint status and force full repaint
2153 // for inner insets as the Row has been cleared out.
2154 bool tmp = pi.full_repaint;
2155 pi.full_repaint = true;
2157 rp.paintSelection();
2160 rp.paintChangeBar();
2161 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2162 if (i == 0 && !is_rtl)
2164 if (i == nrows - 1 && is_rtl)
2167 if (i == nrows - 1 && !is_rtl)
2169 if (i == 0 && is_rtl)
2173 // Restore full_repaint status.
2174 pi.full_repaint = tmp;
2176 // Re-enable screen drawing for future use of the painter.
2177 pi.pain.setDrawingEnabled(original_drawing_state);
2179 //LYXERR(Debug::PAINTING, ".");
2183 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2184 Dimension & dim) const
2186 Cursor const & bvcur = cur.bv().cursor();
2188 // get word in front of cursor
2189 docstring word = text_->previousWord(bvcur.top());
2190 DocIterator wordStart = bvcur;
2191 wordStart.pos() -= word.length();
2193 // get position on screen of the word start and end
2194 //FIXME: Is it necessary to explicitly set this to false?
2195 wordStart.boundary(false);
2196 Point lxy = cur.bv().getPos(wordStart);
2197 Point rxy = cur.bv().getPos(bvcur);
2199 // calculate dimensions of the word
2200 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2201 dim.wid = abs(rxy.x_ - lxy.x_);
2203 // calculate position of word
2205 x = min(rxy.x_, lxy.x_);
2207 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2208 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2211 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2213 // ParagraphMetrics const & pm = par_metrics_[pit];
2214 // Row const & r = pm.rows()[row];
2220 int defaultRowHeight()
2222 return int(theFontMetrics(sane_font).maxHeight() * 1.2);