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/gettext.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_;
140 bool TextMetrics::contains(pit_type pit) const
142 return par_metrics_.find(pit) != par_metrics_.end();
146 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
148 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
153 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
155 ParMetricsCache::const_iterator it = par_metrics_.begin();
156 return make_pair(it->first, &it->second);
160 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
162 LBUFERR(!par_metrics_.empty());
163 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
164 return make_pair(it->first, &it->second);
168 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
170 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
171 if (pmc_it == par_metrics_.end()) {
172 pmc_it = par_metrics_.insert(
173 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
175 if (pmc_it->second.rows().empty() && redo)
177 return pmc_it->second;
181 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
183 LBUFERR(mi.base.textwidth > 0);
184 max_width_ = mi.base.textwidth;
185 // backup old dimension.
186 Dimension const old_dim = dim_;
189 dim_.wid = min_width;
190 pit_type const npar = text_->paragraphs().size();
192 // If there is more than one row, expand the text to
193 // the full allowable width.
194 dim_.wid = max_width_;
196 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
197 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
199 bool changed = false;
201 for (pit_type pit = 0; pit != npar; ++pit) {
202 changed |= redoParagraph(pit);
203 ParagraphMetrics const & pm = par_metrics_[pit];
205 if (dim_.wid < pm.width())
206 dim_.wid = pm.width();
209 dim_.asc = par_metrics_[0].ascent();
210 dim_.des = h - dim_.asc;
211 //lyxerr << "dim_.wid " << dim_.wid << endl;
212 //lyxerr << "dim_.asc " << dim_.asc << endl;
213 //lyxerr << "dim_.des " << dim_.des << endl;
215 changed |= dim_ != old_dim;
221 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
223 return main_text_? pm.rightMargin(*bv_) : 0;
227 int TextMetrics::rightMargin(pit_type const pit) const
229 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
233 void TextMetrics::applyOuterFont(Font & font) const
235 FontInfo lf(font_.fontInfo());
236 lf.reduce(bv_->buffer().params().getFont().fontInfo());
237 font.fontInfo().realize(lf);
241 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
243 LASSERT(pos >= 0, { static Font f; return f; });
245 ParagraphList const & pars = text_->paragraphs();
246 Paragraph const & par = pars[pit];
247 Layout const & layout = par.layout();
248 Buffer const & buffer = bv_->buffer();
250 BufferParams const & params = buffer.params();
251 pos_type const body_pos = par.beginOfBody();
253 // We specialize the 95% common case:
254 if (!par.getDepth()) {
255 Font f = par.getFontSettings(params, pos);
256 if (!text_->isMainText())
258 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
260 FontInfo const & lf = lab ? layout.labelfont : layout.font;
261 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
263 // In case the default family has been customized
264 if (lf.family() == INHERIT_FAMILY)
265 rlf.setFamily(params.getFont().fontInfo().family());
266 f.fontInfo().realize(rlf);
270 // The uncommon case need not be optimized as much
271 FontInfo const & layoutfont = pos < body_pos ?
272 layout.labelfont : layout.font;
274 Font font = par.getFontSettings(params, pos);
275 font.fontInfo().realize(layoutfont);
277 if (!text_->isMainText())
278 applyOuterFont(font);
280 // Realize against environment font information
281 // NOTE: the cast to pit_type should be removed when pit_type
282 // changes to a unsigned integer.
283 if (pit < pit_type(pars.size()))
284 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
286 // Realize with the fonts of lesser depth.
287 font.fontInfo().realize(params.getFont().fontInfo());
293 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
295 if (!lyxrc.rtl_support || !sl.text())
299 if (boundary && sl.pos() > 0)
302 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
306 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
308 // no RTL boundary at paragraph start
309 if (!lyxrc.rtl_support || pos == 0)
312 Font const & left_font = displayFont(pit, pos - 1);
314 return isRTLBoundary(pit, pos, left_font);
318 // isRTLBoundary returns false on a real end-of-line boundary,
319 // because otherwise the two boundary types get mixed up.
320 // This is the whole purpose of this being in TextMetrics.
321 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
322 Font const & font) const
324 if (!lyxrc.rtl_support
325 // no RTL boundary at paragraph start
327 // if the metrics have not been calculated, then we are not
328 // on screen and can safely ignore issues about boundaries.
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 // no RTL boundary at line break:
347 // abc|\n -> move right -> abc\n (and not: abc\n|
349 if (startpos == pos && endpos == pos && endpos != par.size()
350 && (par.isNewline(pos - 1)
351 || par.isEnvSeparator(pos - 1)
352 || par.isLineSeparator(pos - 1)
353 || par.isSeparator(pos - 1)))
356 bool left = font.isVisibleRightToLeft();
358 if (pos == par.size())
359 right = par.isRTL(bv_->buffer().params());
361 right = displayFont(pit, pos).isVisibleRightToLeft();
363 return left != right;
367 bool TextMetrics::redoParagraph(pit_type const pit)
369 Paragraph & par = text_->getPar(pit);
370 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
371 // redoParagraph() recursively inside parMetrics.
372 Dimension old_dim = parMetrics(pit, false).dim();
373 ParagraphMetrics & pm = par_metrics_[pit];
376 Buffer & buffer = bv_->buffer();
377 main_text_ = (text_ == &buffer.text());
378 bool changed = false;
380 // Check whether there are InsetBibItems that need fixing
381 // FIXME: This check ought to be done somewhere else. It is the reason
382 // why text_ is not const. But then, where else to do it?
383 // Well, how can you end up with either (a) a biblio environment that
384 // has no InsetBibitem or (b) a biblio environment with more than one
385 // InsetBibitem? I think the answer is: when paragraphs are merged;
386 // when layout is set; when material is pasted.
387 if (par.brokenBiblio()) {
388 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
389 // In some cases, we do not know how to record undo
390 if (&cur.inset() == &text_->inset())
391 cur.recordUndo(ATOMIC_UNDO, pit, pit);
393 int const moveCursor = par.fixBiblio(buffer);
395 // Is it necessary to update the cursor?
396 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
399 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
404 // Optimisation: this is used in the next two loops
405 // so better to calculate that once here.
406 int const right_margin = rightMargin(pm);
408 // iterator pointing to paragraph to resolve macros
409 DocIterator parPos = text_->macrocontextPosition();
413 LYXERR(Debug::INFO, "MacroContext not initialised!"
414 << " Going through the buffer again and hope"
415 << " the context is better then.");
416 // FIXME audit updateBuffer calls
417 // This should not be here, but it is not clear yet where else it
419 bv_->buffer().updateBuffer();
420 parPos = text_->macrocontextPosition();
421 LBUFERR(!parPos.empty());
426 Font const bufferfont = buffer.params().getFont();
427 InsetList::const_iterator ii = par.insetList().begin();
428 InsetList::const_iterator iend = par.insetList().end();
429 for (; ii != iend; ++ii) {
430 // FIXME Doesn't this HAVE to be non-empty?
431 // position already initialized?
432 if (!parPos.empty()) {
433 parPos.pos() = ii->pos;
435 // A macro template would normally not be visible
436 // by itself. But the tex macro semantics allow
437 // recursion, so we artifically take the context
438 // after the macro template to simulate this.
439 if (ii->inset->lyxCode() == MATHMACRO_CODE)
443 // do the metric calculation
445 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
447 Font const & font = ii->inset->inheritFont() ?
448 displayFont(pit, ii->pos) : bufferfont;
449 MacroContext mc(&buffer, parPos);
450 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
451 ii->inset->metrics(mi, dim);
452 Dimension const old_dim = pm.insetDimension(ii->inset);
453 if (old_dim != dim) {
454 pm.setInsetDimension(ii->inset, dim);
459 par.setBeginOfBody();
461 size_t row_index = 0;
462 // maximum pixel width of a row
463 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
466 pos_type end = rowBreakPoint(width, pit, first);
467 if (row_index || end < par.size())
468 // If there is more than one row, expand the text to
469 // the full allowable width. This setting here is needed
470 // for the computeRowMetrics() below.
471 dim_.wid = max_width_;
473 dim = rowHeight(pit, first, end);
474 dim.wid = rowWidth(right_margin, pit, first, end);
475 if (row_index == pm.rows().size())
476 pm.rows().push_back(Row());
477 Row & row = pm.rows()[row_index];
478 row.setChanged(false);
481 row.setDimension(dim);
482 int const max_row_width = max(dim_.wid, dim.wid);
483 computeRowMetrics(pit, row, max_row_width);
487 pm.dim().wid = max(pm.dim().wid, dim.wid);
488 pm.dim().des += dim.height();
489 } while (first < par.size());
491 if (row_index < pm.rows().size())
492 pm.rows().resize(row_index);
494 // Make sure that if a par ends in newline, there is one more row
496 if (first > 0 && par.isNewline(first - 1)) {
497 Dimension dim = rowHeight(pit, first, first);
498 dim.wid = rowWidth(right_margin, pit, first, first);
499 if (row_index == pm.rows().size())
500 pm.rows().push_back(Row());
501 Row & row = pm.rows()[row_index];
502 row.setChanged(false);
505 row.setDimension(dim);
506 int const max_row_width = max(dim_.wid, dim.wid);
507 computeRowMetrics(pit, row, max_row_width);
508 pm.dim().des += dim.height();
511 pm.dim().asc += pm.rows()[0].ascent();
512 pm.dim().des -= pm.rows()[0].ascent();
514 changed |= old_dim.height() != pm.dim().height();
520 void TextMetrics::computeRowMetrics(pit_type const pit,
521 Row & row, int width) const
526 Paragraph const & par = text_->getPar(pit);
528 double w = width - row.width();
529 // FIXME: put back this assertion when the crash on new doc is solved.
530 //LASSERT(w >= 0, /**/);
532 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
533 //lyxerr << "row.width() " << row.width() << endl;
534 //lyxerr << "w " << w << endl;
536 bool const is_rtl = text_->isRTL(par);
538 row.x = rightMargin(pit);
540 row.x = leftMargin(max_width_, pit, row.pos());
542 // is there a manual margin with a manual label
543 Layout const & layout = par.layout();
545 if (layout.margintype == MARGIN_MANUAL
546 && layout.labeltype == LABEL_MANUAL) {
547 /// We might have real hfills in the label part
548 int nlh = numberOfLabelHfills(par, row);
550 // A manual label par (e.g. List) has an auto-hfill
551 // between the label text and the body of the
553 // But we don't want to do this auto hfill if the par
558 if (nlh && !par.getLabelWidthString().empty())
559 row.label_hfill = labelFill(pit, row) / double(nlh);
563 // are there any hfills in the row?
564 if (int const nh = numberOfHfills(par, row)) {
566 hfill = w / double(nh);
567 // we don't have to look at the alignment if it is ALIGN_LEFT and
568 // if the row is already larger then the permitted width as then
569 // we force the LEFT_ALIGN'edness!
570 } else if (int(row.width()) < max_width_) {
571 // is it block, flushleft or flushright?
572 // set x how you need it
574 if (par.params().align() == LYX_ALIGN_LAYOUT)
575 align = layout.align;
577 align = par.params().align();
579 // handle alignment inside tabular cells
580 Inset const & owner = text_->inset();
581 switch (owner.contentAlignment()) {
582 case LYX_ALIGN_CENTER:
584 case LYX_ALIGN_RIGHT:
585 if (align == LYX_ALIGN_NONE
586 || align == LYX_ALIGN_BLOCK)
587 align = owner.contentAlignment();
590 // unchanged (use align)
594 // Display-style insets should always be on a centered row
595 if (Inset const * inset = par.getInset(row.pos())) {
596 switch (inset->display()) {
597 case Inset::AlignLeft:
598 align = LYX_ALIGN_BLOCK;
600 case Inset::AlignCenter:
601 align = LYX_ALIGN_CENTER;
604 // unchanged (use align)
606 case Inset::AlignRight:
607 align = LYX_ALIGN_RIGHT;
612 // Has the user requested we not justify stuff?
613 if (!bv_->buffer().params().justification
614 && align == LYX_ALIGN_BLOCK)
615 align = LYX_ALIGN_LEFT;
618 case LYX_ALIGN_BLOCK: {
619 int const ns = numberOfSeparators(par, row);
620 bool disp_inset = false;
621 if (row.endpos() < par.size()) {
622 Inset const * in = par.getInset(row.endpos());
624 disp_inset = in->display();
626 // If we have separators, this is not the last row of a
627 // par, does not end in newline, and is not row above a
628 // display inset... then stretch it
630 && row.endpos() < par.size()
631 && !par.isNewline(row.endpos() - 1)
632 && !par.isEnvSeparator(row.endpos() - 1)
635 row.separator = w / ns;
636 //lyxerr << "row.separator " << row.separator << endl;
637 //lyxerr << "ns " << ns << endl;
643 case LYX_ALIGN_RIGHT:
646 case LYX_ALIGN_CENTER:
653 pos_type body_pos = par.beginOfBody();
654 pos_type end = row.endpos();
657 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
659 row.x += theFontMetrics(text_->labelFont(par)).
660 width(layout.labelsep);
662 row.x += row.label_hfill;
666 pos_type const endpos = row.endpos();
667 pos_type body_pos = par.beginOfBody();
669 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
672 ParagraphMetrics & pm = par_metrics_[pit];
673 InsetList::const_iterator ii = par.insetList().begin();
674 InsetList::const_iterator iend = par.insetList().end();
675 for ( ; ii != iend; ++ii) {
676 if (ii->pos >= endpos || ii->pos < row.pos()
677 || (ii->inset->lyxCode() != SPACE_CODE ||
678 !ii->inset->isStretchableSpace()))
680 Dimension dim = row.dimension();
681 if (pm.hfillExpansion(row, ii->pos))
682 dim.wid = int(ii->pos >= body_pos ?
683 max(hfill, 5.0) : row.label_hfill);
686 // Cache the inset dimension.
687 bv_->coordCache().insets().add(ii->inset, dim);
688 pm.setInsetDimension(ii->inset, dim);
693 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
695 Paragraph const & par = text_->getPar(pit);
697 pos_type last = par.beginOfBody();
698 LBUFERR(last > 0 || par.isEnvSeparator(0));
700 // -1 because a label ends with a space that is in the label
703 // a separator at this end does not count
704 if (last >= 0 && par.isLineSeparator(last))
708 for (pos_type i = row.pos(); i <= last; ++i)
709 w += singleWidth(pit, i);
711 docstring const & label = par.params().labelWidthString();
715 FontMetrics const & fm
716 = theFontMetrics(text_->labelFont(par));
718 return max(0, fm.width(label) - w);
723 // Not used, see TextMetrics::rowBreakPoint.
724 // this needs special handling - only newlines count as a break point
725 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
727 pos_type const end = par.size();
730 if (par.isNewline(i))
738 int TextMetrics::labelEnd(pit_type const pit) const
740 // labelEnd is only needed if the layout fills a flushleft label.
741 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
743 // return the beginning of the body
744 return leftMargin(max_width_, pit);
750 * Calling Text::getFont is slow. While rebreaking we scan a
751 * paragraph from left to right calling getFont for every char. This
752 * simple class address this problem by hidding an optimization trick
753 * (not mine btw -AB): the font is reused in the whole font span. The
754 * class handles transparently the "hidden" (not part of the fontlist)
755 * label font (as getFont does).
761 FontIterator(TextMetrics const & tm,
762 Paragraph const & par, pit_type pit, pos_type pos)
763 : tm_(tm), par_(par), pit_(pit), pos_(pos),
764 font_(tm.displayFont(pit, pos)),
765 endspan_(par.fontSpan(pos).last),
766 bodypos_(par.beginOfBody())
770 Font const & operator*() const { return font_; }
773 FontIterator & operator++()
776 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
777 font_ = tm_.displayFont(pit_, pos_);
778 endspan_ = par_.fontSpan(pos_).last;
784 Font * operator->() { return &font_; }
788 TextMetrics const & tm_;
790 Paragraph const & par_;
805 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
808 ParagraphMetrics const & pm = par_metrics_[pit];
809 Paragraph const & par = text_->getPar(pit);
810 pos_type const end = par.size();
811 if (pos == end || width < 0)
814 Layout const & layout = par.layout();
817 //FIXME: As long as leftMargin() is not correctly implemented for
818 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
819 // Otherwise, long rows will be painted off the screen.
820 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
821 return addressBreakPoint(pos, par);
824 pos_type const body_pos = par.beginOfBody();
826 // check for possible inline completion
827 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
828 pos_type inlineCompletionLPos = -1;
829 if (inlineCompletionPos.inTexted()
830 && inlineCompletionPos.text() == text_
831 && inlineCompletionPos.pit() == pit) {
832 // draw logically behind the previous character
833 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
836 // Now we iterate through until we reach the right margin
837 // or the end of the par, then choose the possible break
840 int label_end = labelEnd(pit);
841 int const left = leftMargin(max_width_, pit, pos);
844 // pixel width since last breakpoint
847 docstring const s(1, char_type(0x00B6));
849 int par_marker_width = theFontMetrics(f).width(s);
851 FontIterator fi = FontIterator(*this, par, pit, pos);
852 pos_type point = end;
855 ParagraphList const & pars_ = text_->paragraphs();
856 bool const draw_par_end_marker = lyxrc.paragraph_markers
857 && size_type(pit + 1) < pars_.size();
859 for ( ; i < end; ++i, ++fi) {
860 int thiswidth = pm.singleWidth(i, *fi);
862 if (draw_par_end_marker && i == end - 1)
863 // enlarge the last character to hold the end-of-par marker
864 thiswidth += par_marker_width;
866 // add inline completion width
867 if (inlineCompletionLPos == i) {
868 docstring const & completion = bv_->inlineCompletion();
869 if (completion.length() > 0)
870 thiswidth += theFontMetrics(*fi).width(completion);
873 // add the auto-hfill from label end to the body
874 if (body_pos && i == body_pos) {
875 FontMetrics const & fm = theFontMetrics(
876 text_->labelFont(par));
877 int add = fm.width(layout.labelsep);
878 if (par.isLineSeparator(i - 1))
879 add -= singleWidth(pit, i - 1);
881 add = max(add, label_end - x);
886 chunkwidth += thiswidth;
888 // break before a character that will fall off
889 // the right of the row
891 // if no break before, break here
892 if (point == end || chunkwidth >= width - left) {
898 // exit on last registered breakpoint:
902 if (par.isNewline(i) || par.isEnvSeparator(i)) {
906 Inset const * inset = 0;
909 if ((inset = par.getInset(i + 1)) && inset->display()) {
914 if ((inset = par.getInset(i)) && inset->display()) {
920 inset = par.getInset(i);
921 if (!inset || inset->isChar()) {
922 // some insets are line separators too
923 if (par.isLineSeparator(i)) {
924 // register breakpoint:
931 // maybe found one, but the par is short enough.
932 if (i == end && x < width)
935 // manual labels cannot be broken in LaTeX. But we
936 // want to make our on-screen rendering of footnotes
938 if (body_pos && point < body_pos)
945 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
946 pos_type const first, pos_type const end) const
948 // get the pure distance
949 ParagraphMetrics const & pm = par_metrics_[pit];
950 Paragraph const & par = text_->getPar(pit);
951 int w = leftMargin(max_width_, pit, first);
952 int label_end = labelEnd(pit);
954 // check for possible inline completion
955 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
956 pos_type inlineCompletionLPos = -1;
957 if (inlineCompletionPos.inTexted()
958 && inlineCompletionPos.text() == text_
959 && inlineCompletionPos.pit() == pit) {
960 // draw logically behind the previous character
961 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
964 pos_type const body_pos = par.beginOfBody();
968 FontIterator fi = FontIterator(*this, par, pit, i);
969 for ( ; i < end; ++i, ++fi) {
970 if (body_pos > 0 && i == body_pos) {
971 FontMetrics const & fm = theFontMetrics(
972 text_->labelFont(par));
973 w += fm.width(par.layout().labelsep);
974 if (par.isLineSeparator(i - 1))
975 w -= singleWidth(pit, i - 1);
976 w = max(w, label_end);
979 // a line separator at the end of a line (but not at the end of a
980 // paragraph) will not be drawn and should therefore not count for
982 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
983 w += pm.singleWidth(i, *fi);
985 // add inline completion width
986 if (inlineCompletionLPos == i) {
987 docstring const & completion = bv_->inlineCompletion();
988 if (completion.length() > 0)
989 w += theFontMetrics(*fi).width(completion);
994 // count the paragraph end marker.
995 if (end == par.size() && lyxrc.paragraph_markers) {
996 ParagraphList const & pars_ = text_->paragraphs();
997 if (size_type(pit + 1) < pars_.size()) {
998 // enlarge the last character to hold the
1000 docstring const s(1, char_type(0x00B6));
1002 w += theFontMetrics(f).width(s);
1006 if (body_pos > 0 && body_pos >= end) {
1007 FontMetrics const & fm = theFontMetrics(
1008 text_->labelFont(par));
1009 w += fm.width(par.layout().labelsep);
1010 if (end > 0 && par.isLineSeparator(end - 1))
1011 w -= singleWidth(pit, end - 1);
1012 w = max(w, label_end);
1015 return w + right_margin;
1019 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
1020 pos_type const end, bool topBottomSpace) const
1022 Paragraph const & par = text_->getPar(pit);
1023 // get the maximum ascent and the maximum descent
1024 double layoutasc = 0;
1025 double layoutdesc = 0;
1026 double const dh = defaultRowHeight();
1028 // ok, let us initialize the maxasc and maxdesc value.
1029 // Only the fontsize count. The other properties
1030 // are taken from the layoutfont. Nicer on the screen :)
1031 Layout const & layout = par.layout();
1033 // as max get the first character of this row then it can
1034 // increase but not decrease the height. Just some point to
1035 // start with so we don't have to do the assignment below too
1037 Buffer const & buffer = bv_->buffer();
1038 Font font = displayFont(pit, first);
1039 FontSize const tmpsize = font.fontInfo().size();
1040 font.fontInfo() = text_->layoutFont(pit);
1041 FontSize const size = font.fontInfo().size();
1042 font.fontInfo().setSize(tmpsize);
1044 FontInfo labelfont = text_->labelFont(par);
1046 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1047 FontMetrics const & fontmetrics = theFontMetrics(font);
1049 // these are minimum values
1050 double const spacing_val = layout.spacing.getValue()
1051 * text_->spacing(par);
1052 //lyxerr << "spacing_val = " << spacing_val << endl;
1053 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1054 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1056 // insets may be taller
1057 ParagraphMetrics const & pm = par_metrics_[pit];
1058 InsetList::const_iterator ii = par.insetList().begin();
1059 InsetList::const_iterator iend = par.insetList().end();
1060 for ( ; ii != iend; ++ii) {
1061 if (ii->pos >= first && ii->pos < end) {
1062 Dimension const & dim = pm.insetDimension(ii->inset);
1063 maxasc = max(maxasc, dim.ascent());
1064 maxdesc = max(maxdesc, dim.descent());
1068 // Check if any custom fonts are larger (Asger)
1069 // This is not completely correct, but we can live with the small,
1070 // cosmetic error for now.
1074 par.highestFontInRange(first, end, size);
1075 if (maxsize > font.fontInfo().size()) {
1076 // use standard paragraph font with the maximal size
1077 FontInfo maxfont = font.fontInfo();
1078 maxfont.setSize(maxsize);
1079 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1080 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1081 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1084 // This is nicer with box insets:
1088 ParagraphList const & pars = text_->paragraphs();
1089 Inset const & inset = text_->inset();
1091 // is it a top line?
1092 if (first == 0 && topBottomSpace) {
1093 BufferParams const & bufparams = buffer.params();
1094 // some parskips VERY EASY IMPLEMENTATION
1095 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1096 && !inset.getLayout().parbreakIsNewline()
1097 && !par.layout().parbreak_is_newline
1099 && ((layout.isParagraph() && par.getDepth() == 0)
1100 || (pars[pit - 1].layout().isParagraph()
1101 && pars[pit - 1].getDepth() == 0))) {
1102 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1105 if (par.params().startOfAppendix())
1106 maxasc += int(3 * dh);
1108 // special code for the top label
1109 if (layout.labelIsAbove()
1110 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1111 && !par.labelString().empty())
1114 labelfont_metrics.maxHeight()
1115 * layout.spacing.getValue()
1116 * text_->spacing(par)
1117 + (layout.topsep + layout.labelbottomsep) * dh);
1120 // Add the layout spaces, for example before and after
1121 // a section, or between the items of a itemize or enumerate
1124 pit_type prev = text_->depthHook(pit, par.getDepth());
1125 Paragraph const & prevpar = pars[prev];
1127 && prevpar.layout() == layout
1128 && prevpar.getDepth() == par.getDepth()
1129 && prevpar.getLabelWidthString()
1130 == par.getLabelWidthString()) {
1131 layoutasc = layout.itemsep * dh;
1132 } else if (pit != 0 || first != 0) {
1133 if (layout.topsep > 0)
1134 layoutasc = layout.topsep * dh;
1137 prev = text_->outerHook(pit);
1138 if (prev != pit_type(pars.size())) {
1139 maxasc += int(pars[prev].layout().parsep * dh);
1140 } else if (pit != 0) {
1141 Paragraph const & prevpar = pars[pit - 1];
1142 if (prevpar.getDepth() != 0 ||
1143 prevpar.layout() == layout) {
1144 maxasc += int(layout.parsep * dh);
1149 // is it a bottom line?
1150 if (end >= par.size() && topBottomSpace) {
1151 // add the layout spaces, for example before and after
1152 // a section, or between the items of a itemize or enumerate
1154 pit_type nextpit = pit + 1;
1155 if (nextpit != pit_type(pars.size())) {
1156 pit_type cpit = pit;
1158 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1159 double usual = pars[cpit].layout().bottomsep * dh;
1161 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1162 if (pars[cpit].layout() != pars[nextpit].layout()
1163 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1165 unusual = pars[cpit].layout().bottomsep * dh;
1167 layoutdesc = max(unusual, usual);
1168 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1169 if (pars[cpit].layout() != pars[nextpit].layout()
1170 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1171 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1176 // incalculate the layout spaces
1177 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1178 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1180 // FIXME: the correct way is to do the following is to move the
1181 // following code in another method specially tailored for the
1182 // main Text. The following test is thus bogus.
1183 // Top and bottom margin of the document (only at top-level)
1184 if (main_text_ && topBottomSpace) {
1185 if (pit == 0 && first == 0)
1187 if (pit + 1 == pit_type(pars.size()) &&
1188 end == par.size() &&
1189 !(end > 0 && par.isNewline(end - 1)))
1193 return Dimension(0, maxasc + labeladdon, maxdesc);
1197 // x is an absolute screen coord
1198 // returns the column near the specified x-coordinate of the row
1199 // x is set to the real beginning of this column
1200 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1201 Row const & row, int & x, bool & boundary) const
1203 Buffer const & buffer = bv_->buffer();
1205 /// For the main Text, it is possible that this pit is not
1206 /// yet in the CoordCache when moving cursor up.
1207 /// x Paragraph coordinate is always 0 for main text anyway.
1208 int const xo = origin_.x_;
1210 Paragraph const & par = text_->getPar(pit);
1212 bidi.computeTables(par, buffer, row);
1214 pos_type vc = row.pos();
1215 pos_type end = row.endpos();
1217 Layout const & layout = par.layout();
1219 bool left_side = false;
1221 pos_type body_pos = par.beginOfBody();
1223 double tmpx = row.x;
1224 double last_tmpx = tmpx;
1227 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1230 // check for empty row
1236 // This (rtl_support test) is not needed, but gives
1237 // some speedup if rtl_support == false
1238 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1240 // If lastrow is false, we don't need to compute
1241 // the value of rtl.
1242 bool const rtl_on_lastrow = lastrow ? text_->isRTL(par) : false;
1244 while (vc < end && tmpx <= x) {
1245 c = bidi.vis2log(vc);
1247 if (body_pos > 0 && c == body_pos - 1) {
1248 FontMetrics const & fm = theFontMetrics(
1249 text_->labelFont(par));
1250 tmpx += row.label_hfill + fm.width(layout.labelsep);
1251 if (par.isLineSeparator(body_pos - 1))
1252 tmpx -= singleWidth(pit, body_pos - 1);
1255 tmpx += singleWidth(pit, c);
1256 if (par.isSeparator(c) && c >= body_pos)
1257 tmpx += row.separator;
1261 if ((tmpx + last_tmpx) / 2 > x) {
1266 // This shouldn't happen. But we can reset and try to continue.
1267 LASSERT(vc <= end, vc = end);
1272 ((rtl_on_lastrow && left_side && vc == row.pos() && x < tmpx - 5) ||
1273 (!rtl_on_lastrow && !left_side && vc == end && x > tmpx + 5))) {
1274 if (!(par.isNewline(end - 1) || par.isEnvSeparator(end - 1)))
1276 } else if (vc == row.pos()) {
1277 c = bidi.vis2log(vc);
1278 if (bidi.level(c) % 2 == 1)
1281 c = bidi.vis2log(vc - 1);
1282 bool const rtl = (bidi.level(c) % 2 == 1);
1283 if (left_side == rtl) {
1285 boundary = isRTLBoundary(pit, c);
1289 // I believe this code is not needed anymore (Jug 20050717)
1291 // The following code is necessary because the cursor position past
1292 // the last char in a row is logically equivalent to that before
1293 // the first char in the next row. That's why insets causing row
1294 // divisions -- Newline and display-style insets -- must be treated
1295 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1296 // Newline inset, air gap below:
1297 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1298 if (bidi.level(end -1) % 2 == 0)
1299 tmpx -= singleWidth(pit, end - 1);
1301 tmpx += singleWidth(pit, end - 1);
1305 // Air gap above display inset:
1306 if (row.pos() < end && c >= end && end < par.size()
1307 && par.isInset(end) && par.getInset(end)->display()) {
1310 // Air gap below display inset:
1311 if (row.pos() < end && c >= end && par.isInset(end - 1)
1312 && par.getInset(end - 1)->display()) {
1318 pos_type const col = c - row.pos();
1320 if (!c || end == par.size())
1323 if (c==end && !par.isLineSeparator(c-1)
1324 && !par.isNewline(c-1)
1325 && !par.isEnvSeparator(c-1)) {
1330 return min(col, end - 1 - row.pos());
1334 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1336 // We play safe and use parMetrics(pit) to make sure the
1337 // ParagraphMetrics will be redone and OK to use if needed.
1338 // Otherwise we would use an empty ParagraphMetrics in
1339 // upDownInText() while in selection mode.
1340 ParagraphMetrics const & pm = parMetrics(pit);
1342 LBUFERR(row < int(pm.rows().size()));
1344 Row const & r = pm.rows()[row];
1345 return r.pos() + getColumnNearX(pit, r, x, bound);
1349 void TextMetrics::newParMetricsDown()
1351 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1352 pit_type const pit = last.first + 1;
1353 if (pit == int(text_->paragraphs().size()))
1356 // do it and update its position.
1358 par_metrics_[pit].setPosition(last.second.position()
1359 + last.second.descent() + par_metrics_[pit].ascent());
1363 void TextMetrics::newParMetricsUp()
1365 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1366 if (first.first == 0)
1369 pit_type const pit = first.first - 1;
1370 // do it and update its position.
1372 par_metrics_[pit].setPosition(first.second.position()
1373 - first.second.ascent() - par_metrics_[pit].descent());
1376 // y is screen coordinate
1377 pit_type TextMetrics::getPitNearY(int y)
1379 LASSERT(!text_->paragraphs().empty(), return -1);
1380 LASSERT(!par_metrics_.empty(), return -1);
1381 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1383 // look for highest numbered paragraph with y coordinate less than given y
1386 ParMetricsCache::const_iterator it = par_metrics_.begin();
1387 ParMetricsCache::const_iterator et = par_metrics_.end();
1388 ParMetricsCache::const_iterator last = et;
1391 ParagraphMetrics const & pm = it->second;
1393 if (y < it->second.position() - int(pm.ascent())) {
1394 // We are looking for a position that is before the first paragraph in
1395 // the cache (which is in priciple off-screen, that is before the
1398 // We are already at the first paragraph in the inset.
1400 // OK, this is the paragraph we are looking for.
1401 pit = it->first - 1;
1406 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1408 if (y >= last->second.position() + int(pm_last.descent())) {
1409 // We are looking for a position that is after the last paragraph in
1410 // the cache (which is in priciple off-screen), that is before the
1412 pit = last->first + 1;
1413 if (pit == int(text_->paragraphs().size()))
1414 // We are already at the last paragraph in the inset.
1416 // OK, this is the paragraph we are looking for.
1417 newParMetricsDown();
1421 for (; it != et; ++it) {
1422 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1423 << " y: " << it->second.position());
1425 ParagraphMetrics const & pm = par_metrics_[it->first];
1427 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1429 yy = it->second.position();
1433 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1439 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1440 bool assert_in_view, bool up)
1442 ParagraphMetrics const & pm = par_metrics_[pit];
1444 int yy = pm.position() - pm.ascent();
1445 LBUFERR(!pm.rows().empty());
1446 RowList::const_iterator rit = pm.rows().begin();
1447 RowList::const_iterator rlast = pm.rows().end();
1449 for (; rit != rlast; yy += rit->height(), ++rit)
1450 if (yy + rit->height() > y)
1453 if (assert_in_view) {
1454 if (!up && yy + rit->height() > y) {
1455 if (rit != pm.rows().begin()) {
1458 } else if (pit != 0) {
1461 ParagraphMetrics const & pm2 = par_metrics_[pit];
1462 rit = pm2.rows().end();
1466 } else if (up && yy != y) {
1468 y = yy + rit->height();
1470 } else if (pit < int(text_->paragraphs().size()) - 1) {
1472 newParMetricsDown();
1473 ParagraphMetrics const & pm2 = par_metrics_[pit];
1474 rit = pm2.rows().begin();
1483 // x,y are absolute screen coordinates
1484 // sets cursor recursively descending into nested editable insets
1485 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1486 bool assert_in_view, bool up)
1488 if (lyxerr.debugging(Debug::WORKAREA)) {
1489 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1490 cur.bv().coordCache().dump();
1492 pit_type pit = getPitNearY(y);
1493 LASSERT(pit != -1, return 0);
1495 int yy = y; // is modified by getPitAndRowNearY
1496 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1500 // Do we cover an inset?
1501 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1504 // No inset, set position in the text
1505 bool bound = false; // is modified by getColumnNearX
1506 int xx = x; // is modified by getColumnNearX
1507 cur.pos() = row.pos()
1508 + getColumnNearX(pit, row, xx, bound);
1509 cur.boundary(bound);
1510 cur.setCurrentFont();
1515 Inset * inset = it->inset;
1516 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1518 // Set position in front of inset
1519 cur.pos() = it->pos;
1520 cur.boundary(false);
1523 // Try to descend recursively inside the inset.
1524 inset = inset->editXY(cur, x, yy);
1526 if (cur.top().text() == text_)
1527 cur.setCurrentFont();
1532 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1534 LASSERT(text_ == cur.text(), return);
1535 pit_type const pit = getPitNearY(y);
1536 LASSERT(pit != -1, return);
1538 ParagraphMetrics const & pm = par_metrics_[pit];
1540 int yy = pm.position() - pm.ascent();
1541 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1542 " pit: " << pit << " yy: " << yy);
1545 LBUFERR(pm.rows().size());
1546 for (; r < int(pm.rows().size()) - 1; ++r) {
1547 Row const & row = pm.rows()[r];
1548 if (int(yy + row.height()) > y)
1553 Row const & row = pm.rows()[r];
1555 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1559 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1561 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1563 text_->setCursor(cur, pit, pos, true, bound);
1564 // remember new position.
1569 //takes screen x,y coordinates
1570 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1572 Paragraph const & par = text_->paragraphs()[pit];
1573 ParagraphMetrics const & pm = par_metrics_[pit];
1575 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1577 InsetList::const_iterator iit = par.insetList().begin();
1578 InsetList::const_iterator iend = par.insetList().end();
1579 for (; iit != iend; ++iit) {
1580 Inset * inset = iit->inset;
1582 LYXERR(Debug::DEBUG, "examining inset " << inset);
1584 if (!bv_->coordCache().getInsets().has(inset)) {
1585 LYXERR(Debug::DEBUG, "inset has no cached position");
1589 Dimension const & dim = pm.insetDimension(inset);
1590 Point p = bv_->coordCache().getInsets().xy(inset);
1592 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1593 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1596 && x <= p.x_ + dim.wid
1597 && y >= p.y_ - dim.asc
1598 && y <= p.y_ + dim.des) {
1599 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1600 return const_cast<InsetList::InsetTable *>(&(*iit));
1604 LYXERR(Debug::DEBUG, "No inset hit. ");
1609 //takes screen x,y coordinates
1610 Inset * TextMetrics::checkInsetHit(int x, int y)
1612 pit_type const pit = getPitNearY(y);
1613 LASSERT(pit != -1, return 0);
1614 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1623 int TextMetrics::cursorX(CursorSlice const & sl,
1624 bool boundary) const
1626 LASSERT(sl.text() == text_, return 0);
1627 pit_type const pit = sl.pit();
1628 Paragraph const & par = text_->paragraphs()[pit];
1629 ParagraphMetrics const & pm = par_metrics_[pit];
1630 if (pm.rows().empty())
1633 pos_type ppos = sl.pos();
1634 // Correct position in front of big insets
1635 bool const boundary_correction = ppos != 0 && boundary;
1636 if (boundary_correction)
1639 Row const & row = pm.getRow(sl.pos(), boundary);
1641 pos_type cursor_vpos = 0;
1643 Buffer const & buffer = bv_->buffer();
1646 bidi.computeTables(par, buffer, row);
1648 pos_type const row_pos = row.pos();
1649 pos_type const end = row.endpos();
1650 // Spaces at logical line breaks in bidi text must be skipped during
1651 // cursor positioning. However, they may appear visually in the middle
1652 // of a row; they must be skipped, wherever they are...
1653 // * logically "abc_[HEBREW_\nHEBREW]"
1654 // * visually "abc_[_WERBEH\nWERBEH]"
1655 pos_type skipped_sep_vpos = -1;
1658 cursor_vpos = row_pos;
1659 else if (ppos >= end)
1660 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1661 else if (ppos > row_pos && ppos >= end)
1662 //FIXME: this code is never reached!
1663 // (see http://www.lyx.org/trac/changeset/8251)
1664 // Place cursor after char at (logical) position pos - 1
1665 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1666 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1668 // Place cursor before char at (logical) position ppos
1669 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1670 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1672 pos_type body_pos = par.beginOfBody();
1674 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1677 // check for possible inline completion in this row
1678 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1679 pos_type inlineCompletionVPos = -1;
1680 if (inlineCompletionPos.inTexted()
1681 && inlineCompletionPos.text() == text_
1682 && inlineCompletionPos.pit() == pit
1683 && inlineCompletionPos.pos() - 1 >= row_pos
1684 && inlineCompletionPos.pos() - 1 < end) {
1685 // draw logically behind the previous character
1686 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1689 // Use font span to speed things up, see below
1693 // If the last logical character is a separator, skip it, unless
1694 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1695 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1696 skipped_sep_vpos = bidi.log2vis(end - 1);
1698 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1699 ParagraphList const & pars_ = text_->paragraphs();
1700 if (size_type(pit + 1) < pars_.size()) {
1702 docstring const s = docstring(1, char_type(0x00B6));
1703 x += theFontMetrics(f).width(s);
1707 // Inline completion RTL special case row_pos == cursor_pos:
1708 // "__|b" => cursor_pos is right of __
1709 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1710 font = displayFont(pit, row_pos + 1);
1711 docstring const & completion = bv_->inlineCompletion();
1712 if (font.isRightToLeft() && completion.length() > 0)
1713 x += theFontMetrics(font.fontInfo()).width(completion);
1716 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1717 // Skip the separator which is at the logical end of the row
1718 if (vpos == skipped_sep_vpos)
1720 pos_type pos = bidi.vis2log(vpos);
1721 if (body_pos > 0 && pos == body_pos - 1) {
1722 FontMetrics const & labelfm = theFontMetrics(
1723 text_->labelFont(par));
1724 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1725 if (par.isLineSeparator(body_pos - 1))
1726 x -= singleWidth(pit, body_pos - 1);
1729 // Use font span to speed things up, see above
1730 if (pos < font_span.first || pos > font_span.last) {
1731 font_span = par.fontSpan(pos);
1732 font = displayFont(pit, pos);
1735 x += pm.singleWidth(pos, font);
1737 // Inline completion RTL case:
1738 // "a__|b", __ of b => non-boundary a-pos is right of __
1739 if (vpos + 1 == inlineCompletionVPos
1740 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1741 font = displayFont(pit, vpos + 1);
1742 docstring const & completion = bv_->inlineCompletion();
1743 if (font.isRightToLeft() && completion.length() > 0)
1744 x += theFontMetrics(font.fontInfo()).width(completion);
1747 // Inline completion LTR case:
1748 // "b|__a", __ of b => non-boundary a-pos is in front of __
1749 if (vpos == inlineCompletionVPos
1750 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1751 font = displayFont(pit, vpos);
1752 docstring const & completion = bv_->inlineCompletion();
1753 if (!font.isRightToLeft() && completion.length() > 0)
1754 x += theFontMetrics(font.fontInfo()).width(completion);
1757 if (par.isSeparator(pos) && pos >= body_pos)
1761 // see correction above
1762 if (boundary_correction) {
1763 if (isRTL(sl, boundary))
1764 x -= singleWidth(pit, ppos);
1766 x += singleWidth(pit, ppos);
1773 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1775 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1776 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1777 if (pm.rows().empty())
1781 h -= par_metrics_[0].rows()[0].ascent();
1782 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1783 h += par_metrics_[pit].height();
1786 if (pos && boundary)
1788 size_t const rend = pm.pos2row(pos);
1789 for (size_t rit = 0; rit != rend; ++rit)
1790 h += pm.rows()[rit].height();
1791 h += pm.rows()[rend].ascent();
1796 // the cursor set functions have a special mechanism. When they
1797 // realize you left an empty paragraph, they will delete it.
1799 bool TextMetrics::cursorHome(Cursor & cur)
1801 LASSERT(text_ == cur.text(), return false);
1802 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1803 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1804 return text_->setCursor(cur, cur.pit(), row.pos());
1808 bool TextMetrics::cursorEnd(Cursor & cur)
1810 LASSERT(text_ == cur.text(), return false);
1811 // if not on the last row of the par, put the cursor before
1812 // the final space exept if I have a spanning inset or one string
1813 // is so long that we force a break.
1814 pos_type end = cur.textRow().endpos();
1816 // empty text, end-1 is no valid position
1818 bool boundary = false;
1819 if (end != cur.lastpos()) {
1820 if (!cur.paragraph().isLineSeparator(end-1)
1821 && !cur.paragraph().isNewline(end-1)
1822 && !cur.paragraph().isEnvSeparator(end-1))
1827 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1831 void TextMetrics::deleteLineForward(Cursor & cur)
1833 LASSERT(text_ == cur.text(), return);
1834 if (cur.lastpos() == 0) {
1835 // Paragraph is empty, so we just go forward
1836 text_->cursorForward(cur);
1839 cur.setSelection(true); // to avoid deletion
1842 // What is this test for ??? (JMarc)
1843 if (!cur.selection())
1844 text_->deleteWordForward(cur);
1846 cap::cutSelection(cur, true, false);
1847 cur.checkBufferStructure();
1852 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1854 ParagraphList const & pars = text_->paragraphs();
1855 return row.endpos() >= pars[pit].size()
1856 && pit + 1 == pit_type(pars.size());
1860 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1862 return row.pos() == 0 && pit == 0;
1866 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1868 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1872 int TextMetrics::leftMargin(int max_width,
1873 pit_type const pit, pos_type const pos) const
1875 ParagraphList const & pars = text_->paragraphs();
1877 LASSERT(pit >= 0, return 0);
1878 LASSERT(pit < int(pars.size()), return 0);
1879 Paragraph const & par = pars[pit];
1880 LASSERT(pos >= 0, return 0);
1881 LASSERT(pos <= par.size(), return 0);
1882 Buffer const & buffer = bv_->buffer();
1883 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1884 DocumentClass const & tclass = buffer.params().documentClass();
1885 Layout const & layout = par.layout();
1887 docstring parindent = layout.parindent;
1891 if (text_->isMainText())
1892 l_margin += bv_->leftMargin();
1894 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1895 tclass.leftmargin());
1897 if (par.getDepth() != 0) {
1898 // find the next level paragraph
1899 pit_type newpar = text_->outerHook(pit);
1900 if (newpar != pit_type(pars.size())) {
1901 if (pars[newpar].layout().isEnvironment()) {
1902 l_margin = leftMargin(max_width, newpar);
1903 // Remove the parindent that has been added
1904 // if the paragraph was empty.
1905 if (pars[newpar].empty() &&
1906 buffer.params().paragraph_separation ==
1907 BufferParams::ParagraphIndentSeparation) {
1908 docstring pi = pars[newpar].layout().parindent;
1909 l_margin -= theFontMetrics(
1910 buffer.params().getFont()).signedWidth(pi);
1913 if (tclass.isDefaultLayout(par.layout())
1914 || tclass.isPlainLayout(par.layout())) {
1915 if (pars[newpar].params().noindent())
1918 parindent = pars[newpar].layout().parindent;
1923 // This happens after sections or environments in standard classes.
1924 // We have to check the previous layout at same depth.
1925 if (buffer.params().paragraph_separation ==
1926 BufferParams::ParagraphSkipSeparation)
1928 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1929 pit_type prev = text_->depthHook(pit, par.getDepth());
1930 if (par.layout() == pars[prev].layout()) {
1932 && pars[pit - 1].layout().nextnoindent)
1934 } else if (pars[prev].layout().nextnoindent)
1938 FontInfo const labelfont = text_->labelFont(par);
1939 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1941 switch (layout.margintype) {
1942 case MARGIN_DYNAMIC:
1943 if (!layout.leftmargin.empty()) {
1944 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1947 if (!par.labelString().empty()) {
1948 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1949 l_margin += labelfont_metrics.width(par.labelString());
1950 l_margin += labelfont_metrics.width(layout.labelsep);
1954 case MARGIN_MANUAL: {
1955 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1956 // The width of an empty par, even with manual label, should be 0
1957 if (!par.empty() && pos >= par.beginOfBody()) {
1958 if (!par.getLabelWidthString().empty()) {
1959 docstring labstr = par.getLabelWidthString();
1960 l_margin += labelfont_metrics.width(labstr);
1961 l_margin += labelfont_metrics.width(layout.labelsep);
1967 case MARGIN_STATIC: {
1968 l_margin += theFontMetrics(buffer.params().getFont()).
1969 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1973 case MARGIN_FIRST_DYNAMIC:
1974 if (layout.labeltype == LABEL_MANUAL) {
1975 // if we are at position 0, we are never in the body
1976 if (pos > 0 && pos >= par.beginOfBody())
1977 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1979 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1981 // Special case to fix problems with
1983 || (layout.labeltype == LABEL_STATIC
1984 && layout.latextype == LATEX_ENVIRONMENT
1985 && !text_->isFirstInSequence(pit))) {
1986 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1987 } else if (!layout.labelIsAbove()) {
1988 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1989 l_margin += labelfont_metrics.width(layout.labelsep);
1990 l_margin += labelfont_metrics.width(par.labelString());
1994 case MARGIN_RIGHT_ADDRESS_BOX: {
1996 // The left margin depends on the widest row in this paragraph.
1997 // This code is wrong because it depends on the rows, but at the
1998 // same time this function is used in redoParagraph to construct
2000 ParagraphMetrics const & pm = par_metrics_[pit];
2001 RowList::const_iterator rit = pm.rows().begin();
2002 RowList::const_iterator end = pm.rows().end();
2003 int minfill = max_width;
2004 for ( ; rit != end; ++rit)
2005 if (rit->fill() < minfill)
2006 minfill = rit->fill();
2007 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
2008 l_margin += minfill;
2010 // also wrong, but much shorter.
2011 l_margin += max_width / 2;
2016 if (!par.params().leftIndent().zero())
2017 l_margin += par.params().leftIndent().inPixels(max_width);
2021 if (par.params().align() == LYX_ALIGN_LAYOUT)
2022 align = layout.align;
2024 align = par.params().align();
2026 // set the correct parindent
2028 && (layout.labeltype == LABEL_NO_LABEL
2029 || layout.labeltype == LABEL_ABOVE
2030 || layout.labeltype == LABEL_CENTERED
2031 || (layout.labeltype == LABEL_STATIC
2032 && layout.latextype == LATEX_ENVIRONMENT
2033 && !text_->isFirstInSequence(pit)))
2034 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2035 && !par.params().noindent()
2036 // in some insets, paragraphs are never indented
2037 && !text_->inset().neverIndent()
2038 // display style insets are always centered, omit indentation
2041 && par.getInset(pos)->display())
2042 && (!(tclass.isDefaultLayout(par.layout())
2043 || tclass.isPlainLayout(par.layout()))
2044 || buffer.params().paragraph_separation
2045 == BufferParams::ParagraphIndentSeparation)
2048 // use the parindent of the layout when the default indentation is
2049 // used otherwise use the indentation set in the document settings
2050 if (buffer.params().getIndentation().asLyXCommand() == "default")
2051 l_margin += theFontMetrics(
2052 buffer.params().getFont()).signedWidth(parindent);
2054 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2061 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2063 ParagraphMetrics const & pm = par_metrics_[pit];
2065 return pm.singleWidth(pos, displayFont(pit, pos));
2069 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2071 if (par_metrics_.empty())
2077 ParMetricsCache::iterator it = par_metrics_.begin();
2078 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2079 y -= it->second.ascent();
2080 for (; it != pm_end; ++it) {
2081 ParagraphMetrics const & pmi = it->second;
2083 pit_type const pit = it->first;
2084 // Save the paragraph position in the cache.
2085 it->second.setPosition(y);
2086 drawParagraph(pi, pit, x, y);
2092 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2094 BufferParams const & bparams = bv_->buffer().params();
2095 ParagraphMetrics const & pm = par_metrics_[pit];
2096 if (pm.rows().empty())
2100 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2101 int const ww = bv_->workHeight();
2102 size_t const nrows = pm.rows().size();
2104 Cursor const & cur = bv_->cursor();
2105 DocIterator sel_beg = cur.selectionBegin();
2106 DocIterator sel_end = cur.selectionEnd();
2107 bool selection = cur.selection()
2108 // This is our text.
2109 && cur.text() == text_
2110 // if the anchor is outside, this is not our selection
2111 && cur.normalAnchor().text() == text_
2112 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2114 // We store the begin and end pos of the selection relative to this par
2115 DocIterator sel_beg_par = cur.selectionBegin();
2116 DocIterator sel_end_par = cur.selectionEnd();
2118 // We care only about visible selection.
2120 if (pit != sel_beg.pit()) {
2121 sel_beg_par.pit() = pit;
2122 sel_beg_par.pos() = 0;
2124 if (pit != sel_end.pit()) {
2125 sel_end_par.pit() = pit;
2126 sel_end_par.pos() = sel_end_par.lastpos();
2130 for (size_t i = 0; i != nrows; ++i) {
2132 Row const & row = pm.rows()[i];
2136 bool const inside = (y + row.descent() >= 0
2137 && y - row.ascent() < ww);
2138 // It is not needed to draw on screen if we are not inside.
2139 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2140 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2143 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2145 row.setSelection(-1, -1);
2147 // The row knows nothing about the paragraph, so we have to check
2148 // whether this row is the first or last and update the margins.
2149 if (row.selection()) {
2150 if (row.sel_beg == 0)
2151 row.begin_margin_sel = sel_beg.pit() < pit;
2152 if (row.sel_end == sel_end_par.lastpos())
2153 row.end_margin_sel = sel_end.pit() > pit;
2156 // Row signature; has row changed since last paint?
2157 row.setCrc(pm.computeRowSignature(row, bparams));
2158 bool row_has_changed = row.changed();
2160 // Take this opportunity to spellcheck the row contents.
2161 if (row_has_changed && lyxrc.spellcheck_continuously) {
2162 text_->getPar(pit).spellCheck();
2165 // Don't paint the row if a full repaint has not been requested
2166 // and if it has not changed.
2167 if (!pi.full_repaint && !row_has_changed) {
2168 // Paint only the insets if the text itself is
2170 rp.paintOnlyInsets();
2175 // Clear background of this row if paragraph background was not
2176 // already cleared because of a full repaint.
2177 if (!pi.full_repaint && row_has_changed) {
2178 pi.pain.fillRectangle(x, y - row.ascent(),
2179 width(), row.height(), pi.background_color);
2182 // Instrumentation for testing row cache (see also
2184 if (lyxerr.debugging(Debug::PAINTING) && inside
2185 && (row.selection() || pi.full_repaint || row_has_changed)) {
2186 string const foreword = text_->isMainText() ?
2187 "main text redraw " : "inset text redraw: ";
2188 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2189 << " row_selection=" << row.selection()
2190 << " full_repaint=" << pi.full_repaint
2191 << " row_has_changed=" << row_has_changed);
2194 // Backup full_repaint status and force full repaint
2195 // for inner insets as the Row has been cleared out.
2196 bool tmp = pi.full_repaint;
2197 pi.full_repaint = true;
2199 rp.paintSelection();
2202 rp.paintChangeBar();
2203 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2204 if (i == 0 && !is_rtl)
2206 if (i == nrows - 1 && is_rtl)
2209 if (i == nrows - 1 && !is_rtl)
2211 if (i == 0 && is_rtl)
2215 // Restore full_repaint status.
2216 pi.full_repaint = tmp;
2218 // Re-enable screen drawing for future use of the painter.
2219 pi.pain.setDrawingEnabled(original_drawing_state);
2221 //LYXERR(Debug::PAINTING, ".");
2225 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2226 Dimension & dim) const
2228 Cursor const & bvcur = cur.bv().cursor();
2230 // get word in front of cursor
2231 docstring word = text_->previousWord(bvcur.top());
2232 DocIterator wordStart = bvcur;
2233 wordStart.pos() -= word.length();
2235 // get position on screen of the word start and end
2236 //FIXME: Is it necessary to explicitly set this to false?
2237 wordStart.boundary(false);
2238 Point lxy = cur.bv().getPos(wordStart);
2239 Point rxy = cur.bv().getPos(bvcur);
2241 // calculate dimensions of the word
2242 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2243 dim.wid = abs(rxy.x_ - lxy.x_);
2245 // calculate position of word
2247 x = min(rxy.x_, lxy.x_);
2249 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2250 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2253 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2255 // ParagraphMetrics const & pm = par_metrics_[pit];
2256 // Row const & r = pm.rows()[row];
2262 int defaultRowHeight()
2264 return int(theFontMetrics(sane_font).maxHeight() * 1.2);