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"
30 #include "FuncRequest.h"
32 #include "InsetList.h"
36 #include "MetricsInfo.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "rowpainter.h"
41 #include "TextClass.h"
43 #include "WordLangTuple.h"
45 #include "insets/InsetText.h"
47 #include "mathed/MacroTable.h"
48 #include "mathed/MathMacroTemplate.h"
50 #include "frontends/FontMetrics.h"
51 #include "frontends/Painter.h"
53 #include "support/debug.h"
54 #include "support/docstring_list.h"
55 #include "support/lassert.h"
64 using frontend::FontMetrics;
66 static int numberOfSeparators(Paragraph const & par, Row const & row)
68 pos_type const first = max(row.pos(), par.beginOfBody());
69 pos_type const last = row.endpos() - 1;
71 for (pos_type p = first; p < last; ++p) {
72 if (par.isSeparator(p))
79 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
81 pos_type last = row.endpos() - 1;
82 pos_type first = row.pos();
84 // hfill *DO* count at the beginning of paragraphs!
86 while (first < last && par.isHfill(first))
90 last = min(last, par.beginOfBody());
92 for (pos_type p = first; p < last; ++p) {
100 static int numberOfHfills(Paragraph const & par, Row const & row)
102 pos_type const last = row.endpos();
103 pos_type first = row.pos();
105 // hfill *DO* count at the beginning of paragraphs!
107 while (first < last && par.isHfill(first))
111 first = max(first, par.beginOfBody());
114 for (pos_type p = first; p < last; ++p) {
122 /////////////////////////////////////////////////////////////////////
126 /////////////////////////////////////////////////////////////////////
129 TextMetrics::TextMetrics(BufferView * bv, Text * text)
130 : bv_(bv), text_(text)
133 max_width_ = bv_->workWidth();
134 dim_.wid = max_width_;
138 //text_->updateBuffer(bv->buffer());
142 bool TextMetrics::contains(pit_type pit) const
144 return par_metrics_.find(pit) != par_metrics_.end();
148 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
150 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
155 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
157 ParMetricsCache::const_iterator it = par_metrics_.begin();
158 return make_pair(it->first, &it->second);
162 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
164 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
165 return make_pair(it->first, &it->second);
169 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
171 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
172 if (pmc_it == par_metrics_.end()) {
173 pmc_it = par_metrics_.insert(
174 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
176 if (pmc_it->second.rows().empty() && redo)
178 return pmc_it->second;
182 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
184 LASSERT(mi.base.textwidth > 0, /**/);
185 max_width_ = mi.base.textwidth;
186 // backup old dimension.
187 Dimension const old_dim = dim_;
190 dim_.wid = min_width;
191 pit_type const npar = text_->paragraphs().size();
193 // If there is more than one row, expand the text to
194 // the full allowable width.
195 dim_.wid = max_width_;
197 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
198 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
200 bool changed = false;
202 for (pit_type pit = 0; pit != npar; ++pit) {
203 changed |= redoParagraph(pit);
204 ParagraphMetrics const & pm = par_metrics_[pit];
206 if (dim_.wid < pm.width())
207 dim_.wid = pm.width();
210 dim_.asc = par_metrics_[0].ascent();
211 dim_.des = h - dim_.asc;
212 //lyxerr << "dim_.wid " << dim_.wid << endl;
213 //lyxerr << "dim_.asc " << dim_.asc << endl;
214 //lyxerr << "dim_.des " << dim_.des << endl;
216 changed |= dim_ != old_dim;
222 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
224 return main_text_? pm.rightMargin(*bv_) : 0;
228 int TextMetrics::rightMargin(pit_type const pit) const
230 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
234 void TextMetrics::applyOuterFont(Font & font) const
236 FontInfo lf(font_.fontInfo());
237 lf.reduce(bv_->buffer().params().getFont().fontInfo());
238 font.fontInfo().realize(lf);
242 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
244 LASSERT(pos >= 0, /**/);
246 ParagraphList const & pars = text_->paragraphs();
247 Paragraph const & par = pars[pit];
248 Layout const & layout = par.layout();
249 Buffer const & buffer = bv_->buffer();
251 BufferParams const & params = buffer.params();
252 pos_type const body_pos = par.beginOfBody();
254 // We specialize the 95% common case:
255 if (!par.getDepth()) {
256 Font f = par.getFontSettings(params, pos);
257 if (!text_->isMainText())
259 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
261 FontInfo const & lf = lab ? layout.labelfont : layout.font;
262 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
264 // In case the default family has been customized
265 if (lf.family() == INHERIT_FAMILY)
266 rlf.setFamily(params.getFont().fontInfo().family());
267 f.fontInfo().realize(rlf);
271 // The uncommon case need not be optimized as much
272 FontInfo const & layoutfont = pos < body_pos ?
273 layout.labelfont : layout.font;
275 Font font = par.getFontSettings(params, pos);
276 font.fontInfo().realize(layoutfont);
278 if (!text_->isMainText())
279 applyOuterFont(font);
281 // Realize against environment font information
282 // NOTE: the cast to pit_type should be removed when pit_type
283 // changes to a unsigned integer.
284 if (pit < pit_type(pars.size()))
285 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
287 // Realize with the fonts of lesser depth.
288 font.fontInfo().realize(params.getFont().fontInfo());
294 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
296 if (!lyxrc.rtl_support || !sl.text())
300 if (boundary && sl.pos() > 0)
303 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
307 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
309 if (!lyxrc.rtl_support)
312 // no RTL boundary at paragraph start
316 Font const & left_font = displayFont(pit, pos - 1);
318 return isRTLBoundary(pit, pos, left_font);
322 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
323 Font const & font) const
325 if (!lyxrc.rtl_support)
328 // no RTL boundary at paragraph start
332 ParagraphMetrics & pm = par_metrics_[pit];
333 // no RTL boundary in empty paragraph
334 if (pm.rows().empty())
337 pos_type endpos = pm.getRow(pos - 1, false).endpos();
338 pos_type startpos = pm.getRow(pos, false).pos();
339 // no RTL boundary at line start:
340 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
342 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
345 Paragraph const & par = text_->getPar(pit);
346 bool left = font.isVisibleRightToLeft();
348 if (pos == par.size())
349 right = par.isRTL(bv_->buffer().params());
351 right = displayFont(pit, pos).isVisibleRightToLeft();
353 // no RTL boundary at line break:
354 // abc|\n -> move right -> abc\n (and not: abc\n|
356 if (startpos == pos && endpos == pos && endpos != par.size()
357 && (par.isNewline(pos - 1)
358 || par.isLineSeparator(pos - 1)
359 || par.isSeparator(pos - 1)))
362 return left != right;
366 bool TextMetrics::redoParagraph(pit_type const pit)
368 Paragraph & par = text_->getPar(pit);
369 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
370 // redoParagraph() recursively inside parMetrics.
371 Dimension old_dim = parMetrics(pit, false).dim();
372 ParagraphMetrics & pm = par_metrics_[pit];
375 Buffer & buffer = bv_->buffer();
376 main_text_ = (text_ == &buffer.text());
377 bool changed = false;
379 // FIXME: This check ought to be done somewhere else. It is the reason
380 // why text_ is not const. But then, where else to do it?
381 // Well, how can you end up with either (a) a biblio environment that
382 // has no InsetBibitem or (b) a biblio environment with more than one
383 // InsetBibitem? I think the answer is: when paragraphs are merged;
384 // when layout is set; when material is pasted.
385 int const moveCursor = par.checkBiblio(buffer);
387 const_cast<Cursor &>(bv_->cursor()).posForward();
388 else if (moveCursor < 0) {
389 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
390 if (cursor.pos() >= -moveCursor)
391 cursor.posBackward();
394 // Optimisation: this is used in the next two loops
395 // so better to calculate that once here.
396 int const right_margin = rightMargin(pm);
398 // iterator pointing to paragraph to resolve macros
399 DocIterator parPos = text_->macrocontextPosition();
403 LYXERR(Debug::INFO, "MacroContext not initialised!"
404 << " Going through the buffer again and hope"
405 << " the context is better then.");
406 bv_->buffer().updateBuffer();
407 parPos = text_->macrocontextPosition();
408 LASSERT(!parPos.empty(), /**/);
413 // FIXME: We should always use getFont(), see documentation of
414 // noFontChange() in Inset.h.
415 Font const bufferfont = buffer.params().getFont();
416 InsetList::const_iterator ii = par.insetList().begin();
417 InsetList::const_iterator iend = par.insetList().end();
418 for (; ii != iend; ++ii) {
419 // position already initialized?
420 if (!parPos.empty()) {
421 parPos.pos() = ii->pos;
423 // A macro template would normally not be visible
424 // by itself. But the tex macro semantics allow
425 // recursion, so we artifically take the context
426 // after the macro template to simulate this.
427 if (ii->inset->lyxCode() == MATHMACRO_CODE)
431 // do the metric calculation
433 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
435 Font const & font = ii->inset->noFontChange() ?
436 bufferfont : displayFont(pit, ii->pos);
437 MacroContext mc(&buffer, parPos);
438 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
439 ii->inset->metrics(mi, dim);
440 Dimension const old_dim = pm.insetDimension(ii->inset);
441 if (old_dim != dim) {
442 pm.setInsetDimension(ii->inset, dim);
447 par.setBeginOfBody();
449 size_t row_index = 0;
450 // maximum pixel width of a row
451 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
454 pos_type end = rowBreakPoint(width, pit, first);
455 if (row_index || end < par.size())
456 // If there is more than one row, expand the text to
457 // the full allowable width. This setting here is needed
458 // for the computeRowMetrics() below.
459 dim_.wid = max_width_;
461 dim = rowHeight(pit, first, end);
462 dim.wid = rowWidth(right_margin, pit, first, end);
463 if (row_index == pm.rows().size())
464 pm.rows().push_back(Row());
465 Row & row = pm.rows()[row_index];
466 row.setChanged(false);
469 row.setDimension(dim);
470 int const max_row_width = max(dim_.wid, dim.wid);
471 computeRowMetrics(pit, row, max_row_width);
475 pm.dim().wid = max(pm.dim().wid, dim.wid);
476 pm.dim().des += dim.height();
477 } while (first < par.size());
479 if (row_index < pm.rows().size())
480 pm.rows().resize(row_index);
482 // Make sure that if a par ends in newline, there is one more row
484 if (first > 0 && par.isNewline(first - 1)) {
485 Dimension dim = rowHeight(pit, first, first);
486 dim.wid = rowWidth(right_margin, pit, first, first);
487 if (row_index == pm.rows().size())
488 pm.rows().push_back(Row());
489 Row & row = pm.rows()[row_index];
490 row.setChanged(false);
493 row.setDimension(dim);
494 int const max_row_width = max(dim_.wid, dim.wid);
495 computeRowMetrics(pit, row, max_row_width);
496 pm.dim().des += dim.height();
499 pm.dim().asc += pm.rows()[0].ascent();
500 pm.dim().des -= pm.rows()[0].ascent();
502 changed |= old_dim.height() != pm.dim().height();
508 void TextMetrics::computeRowMetrics(pit_type const pit,
509 Row & row, int width) const
514 Paragraph const & par = text_->getPar(pit);
516 double w = width - row.width();
517 // FIXME: put back this assertion when the crash on new doc is solved.
518 //LASSERT(w >= 0, /**/);
520 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
521 //lyxerr << "row.width() " << row.width() << endl;
522 //lyxerr << "w " << w << endl;
524 bool const is_rtl = text_->isRTL(par);
526 row.x = rightMargin(pit);
528 row.x = leftMargin(max_width_, pit, row.pos());
530 // is there a manual margin with a manual label
531 Layout const & layout = par.layout();
533 if (layout.margintype == MARGIN_MANUAL
534 && layout.labeltype == LABEL_MANUAL) {
535 /// We might have real hfills in the label part
536 int nlh = numberOfLabelHfills(par, row);
538 // A manual label par (e.g. List) has an auto-hfill
539 // between the label text and the body of the
541 // But we don't want to do this auto hfill if the par
546 if (nlh && !par.getLabelWidthString().empty())
547 row.label_hfill = labelFill(pit, row) / double(nlh);
551 // are there any hfills in the row?
552 if (int const nh = numberOfHfills(par, row)) {
554 hfill = w / double(nh);
555 // we don't have to look at the alignment if it is ALIGN_LEFT and
556 // if the row is already larger then the permitted width as then
557 // we force the LEFT_ALIGN'edness!
558 } else if (int(row.width()) < max_width_) {
559 // is it block, flushleft or flushright?
560 // set x how you need it
562 if (par.params().align() == LYX_ALIGN_LAYOUT)
563 align = layout.align;
565 align = par.params().align();
567 // handle alignment inside tabular cells
568 Inset const & owner = text_->inset();
569 switch (owner.contentAlignment()) {
570 case LYX_ALIGN_CENTER:
572 case LYX_ALIGN_RIGHT:
573 if (align == LYX_ALIGN_NONE
574 || align == LYX_ALIGN_BLOCK)
575 align = owner.contentAlignment();
578 // unchanged (use align)
582 // Display-style insets should always be on a centered row
583 if (Inset const * inset = par.getInset(row.pos())) {
584 switch (inset->display()) {
585 case Inset::AlignLeft:
586 align = LYX_ALIGN_BLOCK;
588 case Inset::AlignCenter:
589 align = LYX_ALIGN_CENTER;
592 // unchanged (use align)
594 case Inset::AlignRight:
595 align = LYX_ALIGN_RIGHT;
601 case LYX_ALIGN_BLOCK: {
602 int const ns = numberOfSeparators(par, row);
603 bool disp_inset = false;
604 if (row.endpos() < par.size()) {
605 Inset const * in = par.getInset(row.endpos());
607 disp_inset = in->display();
609 // If we have separators, this is not the last row of a
610 // par, does not end in newline, and is not row above a
611 // display inset... then stretch it
613 && row.endpos() < par.size()
614 && !par.isNewline(row.endpos() - 1)
617 row.separator = w / ns;
618 //lyxerr << "row.separator " << row.separator << endl;
619 //lyxerr << "ns " << ns << endl;
625 case LYX_ALIGN_RIGHT:
628 case LYX_ALIGN_CENTER:
635 pos_type body_pos = par.beginOfBody();
636 pos_type end = row.endpos();
639 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
641 row.x += theFontMetrics(text_->labelFont(par)).
642 width(layout.labelsep);
644 row.x += row.label_hfill;
648 pos_type const endpos = row.endpos();
649 pos_type body_pos = par.beginOfBody();
651 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
654 ParagraphMetrics & pm = par_metrics_[pit];
655 InsetList::const_iterator ii = par.insetList().begin();
656 InsetList::const_iterator iend = par.insetList().end();
657 for ( ; ii != iend; ++ii) {
658 if (ii->pos >= endpos || ii->pos < row.pos()
659 || (ii->inset->lyxCode() != SPACE_CODE ||
660 !ii->inset->isStretchableSpace()))
662 Dimension dim = row.dimension();
663 if (pm.hfillExpansion(row, ii->pos))
664 dim.wid = int(ii->pos >= body_pos ?
665 max(hfill, 5.0) : row.label_hfill);
668 // Cache the inset dimension.
669 bv_->coordCache().insets().add(ii->inset, dim);
670 pm.setInsetDimension(ii->inset, dim);
675 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
677 Paragraph const & par = text_->getPar(pit);
679 pos_type last = par.beginOfBody();
680 LASSERT(last > 0, /**/);
682 // -1 because a label ends with a space that is in the label
685 // a separator at this end does not count
686 if (par.isLineSeparator(last))
690 for (pos_type i = row.pos(); i <= last; ++i)
691 w += singleWidth(pit, i);
693 docstring const & label = par.params().labelWidthString();
697 FontMetrics const & fm
698 = theFontMetrics(text_->labelFont(par));
700 return max(0, fm.width(label) - w);
704 // this needs special handling - only newlines count as a break point
705 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
707 pos_type const end = par.size();
710 if (par.isNewline(i))
717 int TextMetrics::labelEnd(pit_type const pit) const
719 // labelEnd is only needed if the layout fills a flushleft label.
720 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
722 // return the beginning of the body
723 return leftMargin(max_width_, pit);
729 * Calling Text::getFont is slow. While rebreaking we scan a
730 * paragraph from left to right calling getFont for every char. This
731 * simple class address this problem by hidding an optimization trick
732 * (not mine btw -AB): the font is reused in the whole font span. The
733 * class handles transparently the "hidden" (not part of the fontlist)
734 * label font (as getFont does).
740 FontIterator(TextMetrics const & tm,
741 Paragraph const & par, pit_type pit, pos_type pos)
742 : tm_(tm), par_(par), pit_(pit), pos_(pos),
743 font_(tm.displayFont(pit, pos)),
744 endspan_(par.fontSpan(pos).last),
745 bodypos_(par.beginOfBody())
749 Font const & operator*() const { return font_; }
752 FontIterator & operator++()
755 if (pos_ > endspan_ || pos_ == bodypos_) {
756 font_ = tm_.displayFont(pit_, pos_);
757 endspan_ = par_.fontSpan(pos_).last;
763 Font * operator->() { return &font_; }
767 TextMetrics const & tm_;
769 Paragraph const & par_;
784 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
787 ParagraphMetrics const & pm = par_metrics_[pit];
788 Paragraph const & par = text_->getPar(pit);
789 pos_type const end = par.size();
790 if (pos == end || width < 0)
793 Layout const & layout = par.layout();
795 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
796 return addressBreakPoint(pos, par);
798 pos_type const body_pos = par.beginOfBody();
800 // check for possible inline completion
801 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
802 pos_type inlineCompletionLPos = -1;
803 if (inlineCompletionPos.inTexted()
804 && inlineCompletionPos.text() == text_
805 && inlineCompletionPos.pit() == pit) {
806 // draw logically behind the previous character
807 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
810 // Now we iterate through until we reach the right margin
811 // or the end of the par, then choose the possible break
814 int label_end = labelEnd(pit);
815 int const left = leftMargin(max_width_, pit, pos);
818 // pixel width since last breakpoint
821 docstring const s(1, char_type(0x00B6));
823 int par_marker_width = theFontMetrics(f).width(s);
825 FontIterator fi = FontIterator(*this, par, pit, pos);
826 pos_type point = end;
829 ParagraphList const & pars_ = text_->paragraphs();
830 bool const draw_par_end_marker = lyxrc.paragraph_markers
831 && size_type(pit + 1) < pars_.size();
833 for ( ; i < end; ++i, ++fi) {
834 int thiswidth = pm.singleWidth(i, *fi);
836 if (draw_par_end_marker && i == end - 1)
837 // enlarge the last character to hold the end-of-par marker
838 thiswidth += par_marker_width;
840 // add inline completion width
841 if (inlineCompletionLPos == i) {
842 docstring const & completion = bv_->inlineCompletion();
843 if (completion.length() > 0)
844 thiswidth += theFontMetrics(*fi).width(completion);
847 // add the auto-hfill from label end to the body
848 if (body_pos && i == body_pos) {
849 FontMetrics const & fm = theFontMetrics(
850 text_->labelFont(par));
851 int add = fm.width(layout.labelsep);
852 if (par.isLineSeparator(i - 1))
853 add -= singleWidth(pit, i - 1);
855 add = max(add, label_end - x);
860 chunkwidth += thiswidth;
862 // break before a character that will fall off
863 // the right of the row
865 // if no break before, break here
866 if (point == end || chunkwidth >= width - left) {
872 // exit on last registered breakpoint:
876 if (par.isNewline(i)) {
880 Inset const * inset = 0;
883 if ((inset = par.getInset(i + 1)) && inset->display()) {
888 if ((inset = par.getInset(i)) && inset->display()) {
894 inset = par.getInset(i);
895 if (!inset || inset->isChar()) {
896 // some insets are line separators too
897 if (par.isLineSeparator(i)) {
898 // register breakpoint:
905 // maybe found one, but the par is short enough.
906 if (i == end && x < width)
909 // manual labels cannot be broken in LaTeX. But we
910 // want to make our on-screen rendering of footnotes
912 if (body_pos && point < body_pos)
919 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
920 pos_type const first, pos_type const end) const
922 // get the pure distance
923 ParagraphMetrics const & pm = par_metrics_[pit];
924 Paragraph const & par = text_->getPar(pit);
925 int w = leftMargin(max_width_, pit, first);
926 int label_end = labelEnd(pit);
928 // check for possible inline completion
929 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
930 pos_type inlineCompletionLPos = -1;
931 if (inlineCompletionPos.inTexted()
932 && inlineCompletionPos.text() == text_
933 && inlineCompletionPos.pit() == pit) {
934 // draw logically behind the previous character
935 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
938 pos_type const body_pos = par.beginOfBody();
942 FontIterator fi = FontIterator(*this, par, pit, i);
943 for ( ; i < end; ++i, ++fi) {
944 if (body_pos > 0 && i == body_pos) {
945 FontMetrics const & fm = theFontMetrics(
946 text_->labelFont(par));
947 w += fm.width(par.layout().labelsep);
948 if (par.isLineSeparator(i - 1))
949 w -= singleWidth(pit, i - 1);
950 w = max(w, label_end);
953 // a line separator at the end of a line (but not at the end of a
954 // paragraph) will not be drawn and should therefore not count for
956 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
957 w += pm.singleWidth(i, *fi);
959 // add inline completion width
960 if (inlineCompletionLPos == i) {
961 docstring const & completion = bv_->inlineCompletion();
962 if (completion.length() > 0)
963 w += theFontMetrics(*fi).width(completion);
968 // count the paragraph end marker.
969 if (end == par.size() && lyxrc.paragraph_markers) {
970 ParagraphList const & pars_ = text_->paragraphs();
971 if (size_type(pit + 1) < pars_.size()) {
972 // enlarge the last character to hold the
974 docstring const s(1, char_type(0x00B6));
976 w += theFontMetrics(f).width(s);
980 if (body_pos > 0 && body_pos >= end) {
981 FontMetrics const & fm = theFontMetrics(
982 text_->labelFont(par));
983 w += fm.width(par.layout().labelsep);
984 if (end > 0 && par.isLineSeparator(end - 1))
985 w -= singleWidth(pit, end - 1);
986 w = max(w, label_end);
989 return w + right_margin;
993 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
994 pos_type const end, bool topBottomSpace) const
996 Paragraph const & par = text_->getPar(pit);
997 // get the maximum ascent and the maximum descent
998 double layoutasc = 0;
999 double layoutdesc = 0;
1000 double const dh = defaultRowHeight();
1002 // ok, let us initialize the maxasc and maxdesc value.
1003 // Only the fontsize count. The other properties
1004 // are taken from the layoutfont. Nicer on the screen :)
1005 Layout const & layout = par.layout();
1007 // as max get the first character of this row then it can
1008 // increase but not decrease the height. Just some point to
1009 // start with so we don't have to do the assignment below too
1011 Buffer const & buffer = bv_->buffer();
1012 Font font = displayFont(pit, first);
1013 FontSize const tmpsize = font.fontInfo().size();
1014 font.fontInfo() = text_->layoutFont(pit);
1015 FontSize const size = font.fontInfo().size();
1016 font.fontInfo().setSize(tmpsize);
1018 FontInfo labelfont = text_->labelFont(par);
1020 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1021 FontMetrics const & fontmetrics = theFontMetrics(font);
1023 // these are minimum values
1024 double const spacing_val = layout.spacing.getValue()
1025 * text_->spacing(par);
1026 //lyxerr << "spacing_val = " << spacing_val << endl;
1027 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1028 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1030 // insets may be taller
1031 ParagraphMetrics const & pm = par_metrics_[pit];
1032 InsetList::const_iterator ii = par.insetList().begin();
1033 InsetList::const_iterator iend = par.insetList().end();
1034 for ( ; ii != iend; ++ii) {
1035 if (ii->pos >= first && ii->pos < end) {
1036 Dimension const & dim = pm.insetDimension(ii->inset);
1037 maxasc = max(maxasc, dim.ascent());
1038 maxdesc = max(maxdesc, dim.descent());
1042 // Check if any custom fonts are larger (Asger)
1043 // This is not completely correct, but we can live with the small,
1044 // cosmetic error for now.
1048 par.highestFontInRange(first, end, size);
1049 if (maxsize > font.fontInfo().size()) {
1050 // use standard paragraph font with the maximal size
1051 FontInfo maxfont = font.fontInfo();
1052 maxfont.setSize(maxsize);
1053 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1054 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1055 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1058 // This is nicer with box insets:
1062 ParagraphList const & pars = text_->paragraphs();
1063 Inset const & inset = text_->inset();
1065 // is it a top line?
1066 if (first == 0 && topBottomSpace) {
1067 BufferParams const & bufparams = buffer.params();
1068 // some parskips VERY EASY IMPLEMENTATION
1069 if (bufparams.paragraph_separation
1070 == BufferParams::ParagraphSkipSeparation
1071 && inset.lyxCode() != ERT_CODE
1072 && inset.lyxCode() != LISTINGS_CODE
1074 && ((layout.isParagraph() && par.getDepth() == 0)
1075 || (pars[pit - 1].layout().isParagraph()
1076 && pars[pit - 1].getDepth() == 0)))
1078 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1081 if (par.params().startOfAppendix())
1082 maxasc += int(3 * dh);
1084 // This is special code for the chapter, since the label of this
1085 // layout is printed in an extra row
1086 if (layout.counter == "chapter"
1087 && !par.params().labelString().empty()) {
1088 labeladdon = int(labelfont_metrics.maxHeight()
1089 * layout.spacing.getValue()
1090 * text_->spacing(par));
1093 // special code for the top label
1094 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1095 || layout.labeltype == LABEL_BIBLIO
1096 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1097 && text_->isFirstInSequence(pit)
1098 && !par.labelString().empty())
1101 labelfont_metrics.maxHeight()
1102 * layout.spacing.getValue()
1103 * text_->spacing(par)
1104 + (layout.topsep + layout.labelbottomsep) * dh);
1107 // Add the layout spaces, for example before and after
1108 // a section, or between the items of a itemize or enumerate
1111 pit_type prev = text_->depthHook(pit, par.getDepth());
1112 Paragraph const & prevpar = pars[prev];
1114 && prevpar.layout() == layout
1115 && prevpar.getDepth() == par.getDepth()
1116 && prevpar.getLabelWidthString()
1117 == par.getLabelWidthString()) {
1118 layoutasc = layout.itemsep * dh;
1119 } else if (pit != 0 || first != 0) {
1120 if (layout.topsep > 0)
1121 layoutasc = layout.topsep * dh;
1124 prev = text_->outerHook(pit);
1125 if (prev != pit_type(pars.size())) {
1126 maxasc += int(pars[prev].layout().parsep * dh);
1127 } else if (pit != 0) {
1128 Paragraph const & prevpar = pars[pit - 1];
1129 if (prevpar.getDepth() != 0 ||
1130 prevpar.layout() == layout) {
1131 maxasc += int(layout.parsep * dh);
1136 // is it a bottom line?
1137 if (end >= par.size() && topBottomSpace) {
1138 // add the layout spaces, for example before and after
1139 // a section, or between the items of a itemize or enumerate
1141 pit_type nextpit = pit + 1;
1142 if (nextpit != pit_type(pars.size())) {
1143 pit_type cpit = pit;
1147 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1148 usual = pars[cpit].layout().bottomsep * dh;
1149 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1150 if (pars[cpit].layout() != pars[nextpit].layout()
1151 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1153 unusual = pars[cpit].layout().bottomsep * dh;
1155 layoutdesc = max(unusual, usual);
1156 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1157 if (pars[cpit].layout() != pars[nextpit].layout()
1158 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1159 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1164 // incalculate the layout spaces
1165 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1166 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1168 // FIXME: the correct way is to do the following is to move the
1169 // following code in another method specially tailored for the
1170 // main Text. The following test is thus bogus.
1171 // Top and bottom margin of the document (only at top-level)
1172 if (main_text_ && topBottomSpace) {
1173 if (pit == 0 && first == 0)
1175 if (pit + 1 == pit_type(pars.size()) &&
1176 end == par.size() &&
1177 !(end > 0 && par.isNewline(end - 1)))
1181 return Dimension(0, maxasc + labeladdon, maxdesc);
1185 // x is an absolute screen coord
1186 // returns the column near the specified x-coordinate of the row
1187 // x is set to the real beginning of this column
1188 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1189 Row const & row, int & x, bool & boundary) const
1191 Buffer const & buffer = bv_->buffer();
1193 /// For the main Text, it is possible that this pit is not
1194 /// yet in the CoordCache when moving cursor up.
1195 /// x Paragraph coordinate is always 0 for main text anyway.
1196 int const xo = origin_.x_;
1198 Paragraph const & par = text_->getPar(pit);
1200 bidi.computeTables(par, buffer, row);
1202 pos_type vc = row.pos();
1203 pos_type end = row.endpos();
1205 Layout const & layout = par.layout();
1207 bool left_side = false;
1209 pos_type body_pos = par.beginOfBody();
1211 double tmpx = row.x;
1212 double last_tmpx = tmpx;
1215 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1218 // check for empty row
1224 // if the first character is a separator, we are in RTL
1225 // text. This character will not be painted on screen
1226 // and thus we should not count it and skip to the next.
1227 if (par.isSeparator(bidi.vis2log(vc)))
1230 while (vc < end && tmpx <= x) {
1231 c = bidi.vis2log(vc);
1233 if (body_pos > 0 && c == body_pos - 1) {
1234 FontMetrics const & fm = theFontMetrics(
1235 text_->labelFont(par));
1236 tmpx += row.label_hfill + fm.width(layout.labelsep);
1237 if (par.isLineSeparator(body_pos - 1))
1238 tmpx -= singleWidth(pit, body_pos - 1);
1241 tmpx += singleWidth(pit, c);
1242 if (par.isSeparator(c) && c >= body_pos)
1243 tmpx += row.separator;
1247 if ((tmpx + last_tmpx) / 2 > x) {
1252 LASSERT(vc <= end, /**/); // This shouldn't happen.
1255 // This (rtl_support test) is not needed, but gives
1256 // some speedup if rtl_support == false
1257 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1259 // If lastrow is false, we don't need to compute
1260 // the value of rtl.
1261 bool const rtl = lastrow ? text_->isRTL(par) : false;
1263 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1264 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1265 if (!par.isNewline(end - 1))
1267 } else if (vc == row.pos()) {
1268 c = bidi.vis2log(vc);
1269 if (bidi.level(c) % 2 == 1)
1272 c = bidi.vis2log(vc - 1);
1273 bool const rtl = (bidi.level(c) % 2 == 1);
1274 if (left_side == rtl) {
1276 boundary = isRTLBoundary(pit, c);
1280 // I believe this code is not needed anymore (Jug 20050717)
1282 // The following code is necessary because the cursor position past
1283 // the last char in a row is logically equivalent to that before
1284 // the first char in the next row. That's why insets causing row
1285 // divisions -- Newline and display-style insets -- must be treated
1286 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1287 // Newline inset, air gap below:
1288 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1289 if (bidi.level(end -1) % 2 == 0)
1290 tmpx -= singleWidth(pit, end - 1);
1292 tmpx += singleWidth(pit, end - 1);
1296 // Air gap above display inset:
1297 if (row.pos() < end && c >= end && end < par.size()
1298 && par.isInset(end) && par.getInset(end)->display()) {
1301 // Air gap below display inset:
1302 if (row.pos() < end && c >= end && par.isInset(end - 1)
1303 && par.getInset(end - 1)->display()) {
1309 pos_type const col = c - row.pos();
1311 if (!c || end == par.size())
1314 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1319 return min(col, end - 1 - row.pos());
1323 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1325 // We play safe and use parMetrics(pit) to make sure the
1326 // ParagraphMetrics will be redone and OK to use if needed.
1327 // Otherwise we would use an empty ParagraphMetrics in
1328 // upDownInText() while in selection mode.
1329 ParagraphMetrics const & pm = parMetrics(pit);
1331 LASSERT(row < int(pm.rows().size()), /**/);
1333 Row const & r = pm.rows()[row];
1334 return r.pos() + getColumnNearX(pit, r, x, bound);
1338 void TextMetrics::newParMetricsDown()
1340 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1341 pit_type const pit = last.first + 1;
1342 if (pit == int(text_->paragraphs().size()))
1345 // do it and update its position.
1347 par_metrics_[pit].setPosition(last.second.position()
1348 + last.second.descent() + par_metrics_[pit].ascent());
1352 void TextMetrics::newParMetricsUp()
1354 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1355 if (first.first == 0)
1358 pit_type const pit = first.first - 1;
1359 // do it and update its position.
1361 par_metrics_[pit].setPosition(first.second.position()
1362 - first.second.ascent() - par_metrics_[pit].descent());
1365 // y is screen coordinate
1366 pit_type TextMetrics::getPitNearY(int y)
1368 LASSERT(!text_->paragraphs().empty(), return -1);
1369 LASSERT(!par_metrics_.empty(), return -1);
1370 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1372 // look for highest numbered paragraph with y coordinate less than given y
1375 ParMetricsCache::const_iterator it = par_metrics_.begin();
1376 ParMetricsCache::const_iterator et = par_metrics_.end();
1377 ParMetricsCache::const_iterator last = et; last--;
1379 ParagraphMetrics const & pm = it->second;
1381 if (y < it->second.position() - int(pm.ascent())) {
1382 // We are looking for a position that is before the first paragraph in
1383 // the cache (which is in priciple off-screen, that is before the
1386 // We are already at the first paragraph in the inset.
1388 // OK, this is the paragraph we are looking for.
1389 pit = it->first - 1;
1394 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1396 if (y >= last->second.position() + int(pm_last.descent())) {
1397 // We are looking for a position that is after the last paragraph in
1398 // the cache (which is in priciple off-screen), that is before the
1400 pit = last->first + 1;
1401 if (pit == int(text_->paragraphs().size()))
1402 // We are already at the last paragraph in the inset.
1404 // OK, this is the paragraph we are looking for.
1405 newParMetricsDown();
1409 for (; it != et; ++it) {
1410 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1411 << " y: " << it->second.position());
1413 ParagraphMetrics const & pm = par_metrics_[it->first];
1415 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1417 yy = it->second.position();
1421 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1427 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1428 bool assert_in_view, bool up)
1430 ParagraphMetrics const & pm = par_metrics_[pit];
1432 int yy = pm.position() - pm.ascent();
1433 LASSERT(!pm.rows().empty(), /**/);
1434 RowList::const_iterator rit = pm.rows().begin();
1435 RowList::const_iterator rlast = pm.rows().end();
1437 for (; rit != rlast; yy += rit->height(), ++rit)
1438 if (yy + rit->height() > y)
1441 if (assert_in_view) {
1442 if (!up && yy + rit->height() > y) {
1443 if (rit != pm.rows().begin()) {
1446 } else if (pit != 0) {
1449 ParagraphMetrics const & pm2 = par_metrics_[pit];
1450 rit = pm2.rows().end();
1454 } else if (up && yy != y) {
1456 y = yy + rit->height();
1458 } else if (pit < int(text_->paragraphs().size()) - 1) {
1460 newParMetricsDown();
1461 ParagraphMetrics const & pm2 = par_metrics_[pit];
1462 rit = pm2.rows().begin();
1471 // x,y are absolute screen coordinates
1472 // sets cursor recursively descending into nested editable insets
1473 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1474 bool assert_in_view, bool up)
1476 if (lyxerr.debugging(Debug::WORKAREA)) {
1477 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1478 cur.bv().coordCache().dump();
1480 pit_type pit = getPitNearY(y);
1481 LASSERT(pit != -1, return 0);
1483 int yy = y; // is modified by getPitAndRowNearY
1484 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1486 bool bound = false; // is modified by getColumnNearX
1487 int xx = x; // is modified by getColumnNearX
1488 pos_type const pos = row.pos()
1489 + getColumnNearX(pit, row, xx, bound);
1492 cur.boundary(bound);
1495 // try to descend into nested insets
1496 Inset * inset = checkInsetHit(x, yy);
1497 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1499 // Either we deconst editXY or better we move current_font
1500 // and real_current_font to Cursor
1501 // FIXME: what is needed now that current_font and real_current_font
1503 cur.setCurrentFont();
1507 ParagraphList const & pars = text_->paragraphs();
1508 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1510 // This should be just before or just behind the
1511 // cursor position set above.
1512 LASSERT(inset == inset_before
1513 || inset == pars[pit].getInset(pos), /**/);
1515 // Make sure the cursor points to the position before
1517 if (inset == inset_before) {
1519 cur.boundary(false);
1522 // Try to descend recursively inside the inset.
1523 inset = inset->editXY(cur, x, yy);
1525 if (cur.top().text() == text_)
1526 cur.setCurrentFont();
1531 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1533 LASSERT(text_ == cur.text(), /**/);
1534 pit_type pit = getPitNearY(y);
1535 LASSERT(pit != -1, return);
1537 ParagraphMetrics const & pm = par_metrics_[pit];
1539 int yy = pm.position() - pm.ascent();
1540 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1541 " pit: " << pit << " yy: " << yy);
1544 LASSERT(pm.rows().size(), /**/);
1545 for (; r < int(pm.rows().size()) - 1; ++r) {
1546 Row const & row = pm.rows()[r];
1547 if (int(yy + row.height()) > y)
1552 Row const & row = pm.rows()[r];
1554 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1558 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1560 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1562 text_->setCursor(cur, pit, pos, true, bound);
1563 // remember new position.
1568 //takes screen x,y coordinates
1569 Inset * TextMetrics::checkInsetHit(int x, int y)
1571 pit_type pit = getPitNearY(y);
1572 LASSERT(pit != -1, return 0);
1574 Paragraph const & par = text_->paragraphs()[pit];
1575 ParagraphMetrics const & pm = par_metrics_[pit];
1577 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1579 InsetList::const_iterator iit = par.insetList().begin();
1580 InsetList::const_iterator iend = par.insetList().end();
1581 for (; iit != iend; ++iit) {
1582 Inset * inset = iit->inset;
1584 LYXERR(Debug::DEBUG, "examining inset " << inset);
1586 if (!bv_->coordCache().getInsets().has(inset)) {
1587 LYXERR(Debug::DEBUG, "inset has no cached position");
1591 Dimension const & dim = pm.insetDimension(inset);
1592 Point p = bv_->coordCache().getInsets().xy(inset);
1594 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1595 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1598 && x <= p.x_ + dim.wid
1599 && y >= p.y_ - dim.asc
1600 && y <= p.y_ + dim.des) {
1601 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1606 LYXERR(Debug::DEBUG, "No inset hit. ");
1611 int TextMetrics::cursorX(CursorSlice const & sl,
1612 bool boundary) const
1614 LASSERT(sl.text() == text_, /**/);
1615 pit_type const pit = sl.pit();
1616 Paragraph const & par = text_->paragraphs()[pit];
1617 ParagraphMetrics const & pm = par_metrics_[pit];
1618 if (pm.rows().empty())
1621 pos_type ppos = sl.pos();
1622 // Correct position in front of big insets
1623 bool const boundary_correction = ppos != 0 && boundary;
1624 if (boundary_correction)
1627 Row const & row = pm.getRow(sl.pos(), boundary);
1629 pos_type cursor_vpos = 0;
1631 Buffer const & buffer = bv_->buffer();
1634 bidi.computeTables(par, buffer, row);
1636 pos_type const row_pos = row.pos();
1637 pos_type const end = row.endpos();
1638 // Spaces at logical line breaks in bidi text must be skipped during
1639 // cursor positioning. However, they may appear visually in the middle
1640 // of a row; they must be skipped, wherever they are...
1641 // * logically "abc_[HEBREW_\nHEBREW]"
1642 // * visually "abc_[_WERBEH\nWERBEH]"
1643 pos_type skipped_sep_vpos = -1;
1646 cursor_vpos = row_pos;
1647 else if (ppos >= end)
1648 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1649 else if (ppos > row_pos && ppos >= end)
1650 //FIXME: this code is never reached!
1651 // (see http://www.lyx.org/trac/changeset/8251)
1652 // Place cursor after char at (logical) position pos - 1
1653 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1654 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1656 // Place cursor before char at (logical) position ppos
1657 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1658 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1660 pos_type body_pos = par.beginOfBody();
1662 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1665 // check for possible inline completion in this row
1666 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1667 pos_type inlineCompletionVPos = -1;
1668 if (inlineCompletionPos.inTexted()
1669 && inlineCompletionPos.text() == text_
1670 && inlineCompletionPos.pit() == pit
1671 && inlineCompletionPos.pos() - 1 >= row_pos
1672 && inlineCompletionPos.pos() - 1 < end) {
1673 // draw logically behind the previous character
1674 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1677 // Use font span to speed things up, see below
1681 // If the last logical character is a separator, skip it, unless
1682 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1683 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1684 skipped_sep_vpos = bidi.log2vis(end - 1);
1686 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1687 ParagraphList const & pars_ = text_->paragraphs();
1688 if (size_type(pit + 1) < pars_.size()) {
1690 docstring const s = docstring(1, char_type(0x00B6));
1691 x += theFontMetrics(f).width(s);
1695 // Inline completion RTL special case row_pos == cursor_pos:
1696 // "__|b" => cursor_pos is right of __
1697 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1698 font = displayFont(pit, row_pos + 1);
1699 docstring const & completion = bv_->inlineCompletion();
1700 if (font.isRightToLeft() && completion.length() > 0)
1701 x += theFontMetrics(font.fontInfo()).width(completion);
1704 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1705 // Skip the separator which is at the logical end of the row
1706 if (vpos == skipped_sep_vpos)
1708 pos_type pos = bidi.vis2log(vpos);
1709 if (body_pos > 0 && pos == body_pos - 1) {
1710 FontMetrics const & labelfm = theFontMetrics(
1711 text_->labelFont(par));
1712 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1713 if (par.isLineSeparator(body_pos - 1))
1714 x -= singleWidth(pit, body_pos - 1);
1717 // Use font span to speed things up, see above
1718 if (pos < font_span.first || pos > font_span.last) {
1719 font_span = par.fontSpan(pos);
1720 font = displayFont(pit, pos);
1723 x += pm.singleWidth(pos, font);
1725 // Inline completion RTL case:
1726 // "a__|b", __ of b => non-boundary a-pos is right of __
1727 if (vpos + 1 == inlineCompletionVPos
1728 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1729 font = displayFont(pit, vpos + 1);
1730 docstring const & completion = bv_->inlineCompletion();
1731 if (font.isRightToLeft() && completion.length() > 0)
1732 x += theFontMetrics(font.fontInfo()).width(completion);
1735 // Inline completion LTR case:
1736 // "b|__a", __ of b => non-boundary a-pos is in front of __
1737 if (vpos == inlineCompletionVPos
1738 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1739 font = displayFont(pit, vpos);
1740 docstring const & completion = bv_->inlineCompletion();
1741 if (!font.isRightToLeft() && completion.length() > 0)
1742 x += theFontMetrics(font.fontInfo()).width(completion);
1745 if (par.isSeparator(pos) && pos >= body_pos)
1749 // see correction above
1750 if (boundary_correction) {
1751 if (isRTL(sl, boundary))
1752 x -= singleWidth(pit, ppos);
1754 x += singleWidth(pit, ppos);
1761 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1763 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1764 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1765 if (pm.rows().empty())
1769 h -= par_metrics_[0].rows()[0].ascent();
1770 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1771 h += par_metrics_[pit].height();
1774 if (pos && boundary)
1776 size_t const rend = pm.pos2row(pos);
1777 for (size_t rit = 0; rit != rend; ++rit)
1778 h += pm.rows()[rit].height();
1779 h += pm.rows()[rend].ascent();
1784 // the cursor set functions have a special mechanism. When they
1785 // realize you left an empty paragraph, they will delete it.
1787 bool TextMetrics::cursorHome(Cursor & cur)
1789 LASSERT(text_ == cur.text(), /**/);
1790 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1791 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1792 return text_->setCursor(cur, cur.pit(), row.pos());
1796 bool TextMetrics::cursorEnd(Cursor & cur)
1798 LASSERT(text_ == cur.text(), /**/);
1799 // if not on the last row of the par, put the cursor before
1800 // the final space exept if I have a spanning inset or one string
1801 // is so long that we force a break.
1802 pos_type end = cur.textRow().endpos();
1804 // empty text, end-1 is no valid position
1806 bool boundary = false;
1807 if (end != cur.lastpos()) {
1808 if (!cur.paragraph().isLineSeparator(end-1)
1809 && !cur.paragraph().isNewline(end-1))
1814 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1818 void TextMetrics::deleteLineForward(Cursor & cur)
1820 LASSERT(text_ == cur.text(), /**/);
1821 if (cur.lastpos() == 0) {
1822 // Paragraph is empty, so we just go forward
1823 text_->cursorForward(cur);
1826 cur.setSelection(true); // to avoid deletion
1829 // What is this test for ??? (JMarc)
1830 if (!cur.selection())
1831 text_->deleteWordForward(cur);
1833 cap::cutSelection(cur, true, false);
1834 cur.checkBufferStructure();
1839 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1841 ParagraphList const & pars = text_->paragraphs();
1842 return row.endpos() >= pars[pit].size()
1843 && pit + 1 == pit_type(pars.size());
1847 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1849 return row.pos() == 0 && pit == 0;
1853 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1855 LASSERT(pit >= 0, /**/);
1856 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1857 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1861 int TextMetrics::leftMargin(int max_width,
1862 pit_type const pit, pos_type const pos) const
1864 ParagraphList const & pars = text_->paragraphs();
1866 LASSERT(pit >= 0, /**/);
1867 LASSERT(pit < int(pars.size()), /**/);
1868 Paragraph const & par = pars[pit];
1869 LASSERT(pos >= 0, /**/);
1870 LASSERT(pos <= par.size(), /**/);
1871 Buffer const & buffer = bv_->buffer();
1872 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1873 DocumentClass const & tclass = buffer.params().documentClass();
1874 Layout const & layout = par.layout();
1876 docstring parindent = layout.parindent;
1880 if (text_->isMainText())
1881 l_margin += bv_->leftMargin();
1883 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1884 tclass.leftmargin());
1886 if (par.getDepth() != 0) {
1887 // find the next level paragraph
1888 pit_type newpar = text_->outerHook(pit);
1889 if (newpar != pit_type(pars.size())) {
1890 if (pars[newpar].layout().isEnvironment()) {
1891 l_margin = leftMargin(max_width, newpar);
1893 if (tclass.isDefaultLayout(par.layout())
1894 || tclass.isPlainLayout(par.layout())) {
1895 if (pars[newpar].params().noindent())
1898 parindent = pars[newpar].layout().parindent;
1903 // This happens after sections in standard classes. The 1.3.x
1904 // code compared depths too, but it does not seem necessary
1906 if (tclass.isDefaultLayout(par.layout())
1907 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1910 FontInfo const labelfont = text_->labelFont(par);
1911 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1913 switch (layout.margintype) {
1914 case MARGIN_DYNAMIC:
1915 if (!layout.leftmargin.empty()) {
1916 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1919 if (!par.labelString().empty()) {
1920 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1921 l_margin += labelfont_metrics.width(par.labelString());
1922 l_margin += labelfont_metrics.width(layout.labelsep);
1926 case MARGIN_MANUAL: {
1927 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1928 // The width of an empty par, even with manual label, should be 0
1929 if (!par.empty() && pos >= par.beginOfBody()) {
1930 if (!par.getLabelWidthString().empty()) {
1931 docstring labstr = par.getLabelWidthString();
1932 l_margin += labelfont_metrics.width(labstr);
1933 l_margin += labelfont_metrics.width(layout.labelsep);
1939 case MARGIN_STATIC: {
1940 l_margin += theFontMetrics(buffer.params().getFont()).
1941 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1945 case MARGIN_FIRST_DYNAMIC:
1946 if (layout.labeltype == LABEL_MANUAL) {
1947 // if we are at position 0, we are never in the body
1948 if (pos > 0 && pos >= par.beginOfBody())
1949 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1951 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1953 // Special case to fix problems with
1955 || (layout.labeltype == LABEL_STATIC
1956 && layout.latextype == LATEX_ENVIRONMENT
1957 && !text_->isFirstInSequence(pit))) {
1958 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1959 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1960 && layout.labeltype != LABEL_BIBLIO
1961 && layout.labeltype !=
1962 LABEL_CENTERED_TOP_ENVIRONMENT) {
1963 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1964 l_margin += labelfont_metrics.width(layout.labelsep);
1965 l_margin += labelfont_metrics.width(par.labelString());
1969 case MARGIN_RIGHT_ADDRESS_BOX: {
1971 // ok, a terrible hack. The left margin depends on the widest
1972 // row in this paragraph.
1973 RowList::iterator rit = par.rows().begin();
1974 RowList::iterator end = par.rows().end();
1975 // FIXME: This is wrong.
1976 int minfill = max_width;
1977 for ( ; rit != end; ++rit)
1978 if (rit->fill() < minfill)
1979 minfill = rit->fill();
1980 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1981 l_margin += minfill;
1983 // also wrong, but much shorter.
1984 l_margin += max_width / 2;
1989 if (!par.params().leftIndent().zero())
1990 l_margin += par.params().leftIndent().inPixels(max_width);
1994 if (par.params().align() == LYX_ALIGN_LAYOUT)
1995 align = layout.align;
1997 align = par.params().align();
1999 // set the correct parindent
2001 && (layout.labeltype == LABEL_NO_LABEL
2002 || layout.labeltype == LABEL_TOP_ENVIRONMENT
2003 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
2004 || (layout.labeltype == LABEL_STATIC
2005 && layout.latextype == LATEX_ENVIRONMENT
2006 && !text_->isFirstInSequence(pit)))
2007 && align == LYX_ALIGN_BLOCK
2008 && !par.params().noindent()
2009 // in some insets, paragraphs are never indented
2010 && !text_->inset().neverIndent()
2011 // display style insets are always centered, omit indentation
2014 && par.getInset(pos)->display())
2015 && (!(tclass.isDefaultLayout(par.layout())
2016 || tclass.isPlainLayout(par.layout()))
2017 || buffer.params().paragraph_separation == BufferParams::ParagraphIndentSeparation)
2020 // use the parindent of the layout when the default indentation is used
2021 // otherwise use the indentation set in the document settings
2022 if (buffer.params().getIndentation().asLyXCommand() == "default")
2023 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
2026 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2033 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2035 ParagraphMetrics const & pm = par_metrics_[pit];
2037 return pm.singleWidth(pos, displayFont(pit, pos));
2041 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2043 if (par_metrics_.empty())
2049 ParMetricsCache::iterator it = par_metrics_.begin();
2050 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2051 y -= it->second.ascent();
2052 for (; it != pm_end; ++it) {
2053 ParagraphMetrics const & pmi = it->second;
2055 pit_type const pit = it->first;
2056 // Save the paragraph position in the cache.
2057 it->second.setPosition(y);
2058 drawParagraph(pi, pit, x, y);
2064 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2066 BufferParams const & bparams = bv_->buffer().params();
2067 ParagraphMetrics const & pm = par_metrics_[pit];
2068 if (pm.rows().empty())
2072 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2073 int const ww = bv_->workHeight();
2074 size_t const nrows = pm.rows().size();
2076 Cursor const & cur = bv_->cursor();
2077 DocIterator sel_beg = cur.selectionBegin();
2078 DocIterator sel_end = cur.selectionEnd();
2079 bool selection = cur.selection()
2080 // This is our text.
2081 && cur.text() == text_
2082 // if the anchor is outside, this is not our selection
2083 && cur.anchor().text() == text_
2084 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2086 // We store the begin and end pos of the selection relative to this par
2087 DocIterator sel_beg_par = cur.selectionBegin();
2088 DocIterator sel_end_par = cur.selectionEnd();
2090 // We care only about visible selection.
2092 if (pit != sel_beg.pit()) {
2093 sel_beg_par.pit() = pit;
2094 sel_beg_par.pos() = 0;
2096 if (pit != sel_end.pit()) {
2097 sel_end_par.pit() = pit;
2098 sel_end_par.pos() = sel_end_par.lastpos();
2102 for (size_t i = 0; i != nrows; ++i) {
2104 Row const & row = pm.rows()[i];
2108 bool const inside = (y + row.descent() >= 0
2109 && y - row.ascent() < ww);
2110 // It is not needed to draw on screen if we are not inside.
2111 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2112 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2115 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2117 row.setSelection(-1, -1);
2119 // The row knows nothing about the paragraph, so we have to check
2120 // whether this row is the first or last and update the margins.
2121 if (row.selection()) {
2122 if (row.sel_beg == 0)
2123 row.begin_margin_sel = sel_beg.pit() < pit;
2124 if (row.sel_end == sel_end_par.lastpos())
2125 row.end_margin_sel = sel_end.pit() > pit;
2128 // Row signature; has row changed since last paint?
2129 row.setCrc(pm.computeRowSignature(row, bparams));
2130 bool row_has_changed = row.changed();
2132 // Take this opportunity to spellcheck the row contents.
2133 if (row_has_changed && lyxrc.spellcheck_continuously) {
2135 // dummy variable, not used.
2136 static docstring_list suggestions;
2137 pos_type from = row.pos();
2138 pos_type to = row.endpos();
2139 while (from < row.endpos()) {
2140 text_->getPar(pit).spellCheck(from, to, wl, suggestions, false);
2145 // Don't paint the row if a full repaint has not been requested
2146 // and if it has not changed.
2147 if (!pi.full_repaint && !row_has_changed) {
2148 // Paint only the insets if the text itself is
2150 rp.paintOnlyInsets();
2155 // Clear background of this row if paragraph background was not
2156 // already cleared because of a full repaint.
2157 if (!pi.full_repaint && row_has_changed) {
2158 pi.pain.fillRectangle(x, y - row.ascent(),
2159 width(), row.height(), pi.background_color);
2162 if (row.selection())
2163 drawRowSelection(pi, x, row, cur, pit);
2165 // Instrumentation for testing row cache (see also
2167 if (lyxerr.debugging(Debug::PAINTING) && inside
2168 && (row.selection() || pi.full_repaint || row_has_changed)) {
2169 string const foreword = text_->isMainText() ?
2170 "main text redraw " : "inset text redraw: ";
2171 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2172 << " row_selection=" << row.selection()
2173 << " full_repaint=" << pi.full_repaint
2174 << " row_has_changed=" << row_has_changed);
2177 // Backup full_repaint status and force full repaint
2178 // for inner insets as the Row has been cleared out.
2179 bool tmp = pi.full_repaint;
2180 pi.full_repaint = true;
2183 rp.paintChangeBar();
2184 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2185 if (i == 0 && !is_rtl)
2187 if (i == nrows - 1 && is_rtl)
2190 if (i == nrows - 1 && !is_rtl)
2192 if (i == 0 && is_rtl)
2195 // Restore full_repaint status.
2196 pi.full_repaint = tmp;
2198 // Re-enable screen drawing for future use of the painter.
2199 pi.pain.setDrawingEnabled(original_drawing_state);
2201 //LYXERR(Debug::PAINTING, ".");
2205 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
2206 Cursor const & curs, pit_type pit) const
2208 DocIterator beg = curs.selectionBegin();
2210 beg.pos() = row.sel_beg;
2212 DocIterator end = curs.selectionEnd();
2214 end.pos() = row.sel_end;
2216 bool const begin_boundary = beg.pos() >= row.endpos();
2217 bool const end_boundary = row.sel_end == row.endpos();
2219 DocIterator cur = beg;
2220 cur.boundary(begin_boundary);
2221 int x1 = cursorX(beg.top(), begin_boundary);
2222 int x2 = cursorX(end.top(), end_boundary);
2223 int const y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
2224 int const y2 = y1 + row.height();
2226 int const rm = text_->isMainText() ? bv_->rightMargin() : 0;
2227 int const lm = text_->isMainText() ? bv_->leftMargin() : 0;
2230 if (row.begin_margin_sel) {
2231 if (text_->isRTL(beg.paragraph())) {
2232 pi.pain.fillRectangle(x + x1, y1, width() - rm - x1, y2 - y1,
2235 pi.pain.fillRectangle(x + lm, y1, x1 - lm, y2 - y1,
2240 if (row.end_margin_sel) {
2241 if (text_->isRTL(beg.paragraph())) {
2242 pi.pain.fillRectangle(x + lm, y1, x2 - lm, y2 - y1,
2245 pi.pain.fillRectangle(x + x2, y1, width() - rm - x2, y2 - y1,
2250 // if we are on a boundary from the beginning, it's probably
2251 // a RTL boundary and we jump to the other side directly as this
2252 // segement is 0-size and confuses the logic below
2254 cur.boundary(false);
2256 // go through row and draw from RTL boundary to RTL boundary
2258 bool draw_now = false;
2260 // simplified cursorForward code below which does not
2261 // descend into insets and which does not go into the
2262 // next line. Compare the logic with the original cursorForward
2264 // if left of boundary -> just jump to right side, but
2265 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2266 if (cur.boundary()) {
2267 cur.boundary(false);
2268 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2269 // in front of RTL boundary -> Stay on this side of the boundary
2270 // because: ab|cDDEEFFghi -> abc|DDEEFFghi
2279 if (cur.pos() == row.endpos())
2284 // the previous segment was just drawn, now the next starts
2285 x1 = cursorX(cur.top(), cur.boundary());
2288 if (!(cur < end) || draw_now) {
2289 x2 = cursorX(cur.top(), cur.boundary());
2290 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2293 // reset x1, so it is set again next round (which will be on the
2294 // right side of a boundary or at the selection end)
2301 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2302 Dimension & dim) const
2304 Cursor const & bvcur = cur.bv().cursor();
2306 // get word in front of cursor
2307 docstring word = text_->previousWord(bvcur.top());
2308 DocIterator wordStart = bvcur;
2309 wordStart.pos() -= word.length();
2311 // get position on screen of the word start and end
2312 Point lxy = cur.bv().getPos(wordStart, false);
2313 Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
2315 // calculate dimensions of the word
2316 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2317 dim.wid = abs(rxy.x_ - lxy.x_);
2319 // calculate position of word
2321 x = min(rxy.x_, lxy.x_);
2323 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2324 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2327 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2329 // ParagraphMetrics const & pm = par_metrics_[pit];
2330 // Row const & r = pm.rows()[row];
2336 int defaultRowHeight()
2338 return int(theFontMetrics(sane_font).maxHeight() * 1.2);