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.isLineSeparator(pos - 1)
352 || par.isSeparator(pos - 1)))
355 bool left = font.isVisibleRightToLeft();
357 if (pos == par.size())
358 right = par.isRTL(bv_->buffer().params());
360 right = displayFont(pit, pos).isVisibleRightToLeft();
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 // Check whether there are InsetBibItems that need fixing
380 // FIXME: This check ought to be done somewhere else. It is the reason
381 // why text_ is not const. But then, where else to do it?
382 // Well, how can you end up with either (a) a biblio environment that
383 // has no InsetBibitem or (b) a biblio environment with more than one
384 // InsetBibitem? I think the answer is: when paragraphs are merged;
385 // when layout is set; when material is pasted.
386 if (par.brokenBiblio()) {
387 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
388 // In some cases, we do not know how to record undo
389 if (&cur.inset() == &text_->inset())
390 cur.recordUndo(ATOMIC_UNDO, pit, pit);
392 int const moveCursor = par.fixBiblio(buffer);
394 // Is it necessary to update the cursor?
395 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
398 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
403 // Optimisation: this is used in the next two loops
404 // so better to calculate that once here.
405 int const right_margin = rightMargin(pm);
407 // iterator pointing to paragraph to resolve macros
408 DocIterator parPos = text_->macrocontextPosition();
412 LYXERR(Debug::INFO, "MacroContext not initialised!"
413 << " Going through the buffer again and hope"
414 << " the context is better then.");
415 // FIXME audit updateBuffer calls
416 // This should not be here, but it is not clear yet where else it
418 bv_->buffer().updateBuffer();
419 parPos = text_->macrocontextPosition();
420 LBUFERR(!parPos.empty());
425 Font const bufferfont = buffer.params().getFont();
426 InsetList::const_iterator ii = par.insetList().begin();
427 InsetList::const_iterator iend = par.insetList().end();
428 for (; ii != iend; ++ii) {
429 // FIXME Doesn't this HAVE to be non-empty?
430 // position already initialized?
431 if (!parPos.empty()) {
432 parPos.pos() = ii->pos;
434 // A macro template would normally not be visible
435 // by itself. But the tex macro semantics allow
436 // recursion, so we artifically take the context
437 // after the macro template to simulate this.
438 if (ii->inset->lyxCode() == MATHMACRO_CODE)
442 // do the metric calculation
444 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
446 Font const & font = ii->inset->inheritFont() ?
447 displayFont(pit, ii->pos) : bufferfont;
448 MacroContext mc(&buffer, parPos);
449 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
450 ii->inset->metrics(mi, dim);
451 Dimension const old_dim = pm.insetDimension(ii->inset);
452 if (old_dim != dim) {
453 pm.setInsetDimension(ii->inset, dim);
458 par.setBeginOfBody();
460 size_t row_index = 0;
461 // maximum pixel width of a row
462 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
465 pos_type end = rowBreakPoint(width, pit, first);
466 if (row_index || end < par.size())
467 // If there is more than one row, expand the text to
468 // the full allowable width. This setting here is needed
469 // for the computeRowMetrics() below.
470 dim_.wid = max_width_;
472 dim = rowHeight(pit, first, end);
473 dim.wid = rowWidth(right_margin, pit, first, end);
474 if (row_index == pm.rows().size())
475 pm.rows().push_back(Row());
476 Row & row = pm.rows()[row_index];
477 row.setChanged(false);
480 row.setDimension(dim);
481 int const max_row_width = max(dim_.wid, dim.wid);
482 computeRowMetrics(pit, row, max_row_width);
486 pm.dim().wid = max(pm.dim().wid, dim.wid);
487 pm.dim().des += dim.height();
488 } while (first < par.size());
490 if (row_index < pm.rows().size())
491 pm.rows().resize(row_index);
493 // Make sure that if a par ends in newline, there is one more row
495 if (first > 0 && par.isNewline(first - 1)) {
496 Dimension dim = rowHeight(pit, first, first);
497 dim.wid = rowWidth(right_margin, pit, first, first);
498 if (row_index == pm.rows().size())
499 pm.rows().push_back(Row());
500 Row & row = pm.rows()[row_index];
501 row.setChanged(false);
504 row.setDimension(dim);
505 int const max_row_width = max(dim_.wid, dim.wid);
506 computeRowMetrics(pit, row, max_row_width);
507 pm.dim().des += dim.height();
510 pm.dim().asc += pm.rows()[0].ascent();
511 pm.dim().des -= pm.rows()[0].ascent();
513 changed |= old_dim.height() != pm.dim().height();
519 void TextMetrics::computeRowMetrics(pit_type const pit,
520 Row & row, int width) const
525 Paragraph const & par = text_->getPar(pit);
527 double w = width - row.width();
528 // FIXME: put back this assertion when the crash on new doc is solved.
529 //LASSERT(w >= 0, /**/);
531 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
532 //lyxerr << "row.width() " << row.width() << endl;
533 //lyxerr << "w " << w << endl;
535 bool const is_rtl = text_->isRTL(par);
537 row.x = rightMargin(pit);
539 row.x = leftMargin(max_width_, pit, row.pos());
541 // is there a manual margin with a manual label
542 Layout const & layout = par.layout();
544 if (layout.margintype == MARGIN_MANUAL
545 && layout.labeltype == LABEL_MANUAL) {
546 /// We might have real hfills in the label part
547 int nlh = numberOfLabelHfills(par, row);
549 // A manual label par (e.g. List) has an auto-hfill
550 // between the label text and the body of the
552 // But we don't want to do this auto hfill if the par
557 if (nlh && !par.getLabelWidthString().empty())
558 row.label_hfill = labelFill(pit, row) / double(nlh);
562 // are there any hfills in the row?
563 if (int const nh = numberOfHfills(par, row)) {
565 hfill = w / double(nh);
566 // we don't have to look at the alignment if it is ALIGN_LEFT and
567 // if the row is already larger then the permitted width as then
568 // we force the LEFT_ALIGN'edness!
569 } else if (int(row.width()) < max_width_) {
570 // is it block, flushleft or flushright?
571 // set x how you need it
573 if (par.params().align() == LYX_ALIGN_LAYOUT)
574 align = layout.align;
576 align = par.params().align();
578 // handle alignment inside tabular cells
579 Inset const & owner = text_->inset();
580 switch (owner.contentAlignment()) {
581 case LYX_ALIGN_CENTER:
583 case LYX_ALIGN_RIGHT:
584 if (align == LYX_ALIGN_NONE
585 || align == LYX_ALIGN_BLOCK)
586 align = owner.contentAlignment();
589 // unchanged (use align)
593 // Display-style insets should always be on a centered row
594 if (Inset const * inset = par.getInset(row.pos())) {
595 switch (inset->display()) {
596 case Inset::AlignLeft:
597 align = LYX_ALIGN_BLOCK;
599 case Inset::AlignCenter:
600 align = LYX_ALIGN_CENTER;
603 // unchanged (use align)
605 case Inset::AlignRight:
606 align = LYX_ALIGN_RIGHT;
611 // Has the user requested we not justify stuff?
612 if (!bv_->buffer().params().justification
613 && align == LYX_ALIGN_BLOCK)
614 align = LYX_ALIGN_LEFT;
617 case LYX_ALIGN_BLOCK: {
618 int const ns = numberOfSeparators(par, row);
619 bool disp_inset = false;
620 if (row.endpos() < par.size()) {
621 Inset const * in = par.getInset(row.endpos());
623 disp_inset = in->display();
625 // If we have separators, this is not the last row of a
626 // par, does not end in newline, and is not row above a
627 // display inset... then stretch it
629 && row.endpos() < par.size()
630 && !par.isNewline(row.endpos() - 1)
633 row.separator = w / ns;
634 //lyxerr << "row.separator " << row.separator << endl;
635 //lyxerr << "ns " << ns << endl;
641 case LYX_ALIGN_RIGHT:
644 case LYX_ALIGN_CENTER:
651 pos_type body_pos = par.beginOfBody();
652 pos_type end = row.endpos();
655 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
657 row.x += theFontMetrics(text_->labelFont(par)).
658 width(layout.labelsep);
660 row.x += row.label_hfill;
664 pos_type const endpos = row.endpos();
665 pos_type body_pos = par.beginOfBody();
667 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
670 ParagraphMetrics & pm = par_metrics_[pit];
671 InsetList::const_iterator ii = par.insetList().begin();
672 InsetList::const_iterator iend = par.insetList().end();
673 for ( ; ii != iend; ++ii) {
674 if (ii->pos >= endpos || ii->pos < row.pos()
675 || (ii->inset->lyxCode() != SPACE_CODE ||
676 !ii->inset->isStretchableSpace()))
678 Dimension dim = row.dimension();
679 if (pm.hfillExpansion(row, ii->pos))
680 dim.wid = int(ii->pos >= body_pos ?
681 max(hfill, 5.0) : row.label_hfill);
684 // Cache the inset dimension.
685 bv_->coordCache().insets().add(ii->inset, dim);
686 pm.setInsetDimension(ii->inset, dim);
691 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
693 Paragraph const & par = text_->getPar(pit);
695 pos_type last = par.beginOfBody();
698 // -1 because a label ends with a space that is in the label
701 // a separator at this end does not count
702 if (par.isLineSeparator(last))
706 for (pos_type i = row.pos(); i <= last; ++i)
707 w += singleWidth(pit, i);
709 docstring const & label = par.params().labelWidthString();
713 FontMetrics const & fm
714 = theFontMetrics(text_->labelFont(par));
716 return max(0, fm.width(label) - w);
721 // Not used, see TextMetrics::rowBreakPoint.
722 // this needs special handling - only newlines count as a break point
723 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
725 pos_type const end = par.size();
728 if (par.isNewline(i))
736 int TextMetrics::labelEnd(pit_type const pit) const
738 // labelEnd is only needed if the layout fills a flushleft label.
739 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
741 // return the beginning of the body
742 return leftMargin(max_width_, pit);
748 * Calling Text::getFont is slow. While rebreaking we scan a
749 * paragraph from left to right calling getFont for every char. This
750 * simple class address this problem by hidding an optimization trick
751 * (not mine btw -AB): the font is reused in the whole font span. The
752 * class handles transparently the "hidden" (not part of the fontlist)
753 * label font (as getFont does).
759 FontIterator(TextMetrics const & tm,
760 Paragraph const & par, pit_type pit, pos_type pos)
761 : tm_(tm), par_(par), pit_(pit), pos_(pos),
762 font_(tm.displayFont(pit, pos)),
763 endspan_(par.fontSpan(pos).last),
764 bodypos_(par.beginOfBody())
768 Font const & operator*() const { return font_; }
771 FontIterator & operator++()
774 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
775 font_ = tm_.displayFont(pit_, pos_);
776 endspan_ = par_.fontSpan(pos_).last;
782 Font * operator->() { return &font_; }
786 TextMetrics const & tm_;
788 Paragraph const & par_;
803 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
806 ParagraphMetrics const & pm = par_metrics_[pit];
807 Paragraph const & par = text_->getPar(pit);
808 pos_type const end = par.size();
809 if (pos == end || width < 0)
812 Layout const & layout = par.layout();
815 //FIXME: As long as leftMargin() is not correctly implemented for
816 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
817 // Otherwise, long rows will be painted off the screen.
818 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
819 return addressBreakPoint(pos, par);
822 pos_type const body_pos = par.beginOfBody();
824 // check for possible inline completion
825 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
826 pos_type inlineCompletionLPos = -1;
827 if (inlineCompletionPos.inTexted()
828 && inlineCompletionPos.text() == text_
829 && inlineCompletionPos.pit() == pit) {
830 // draw logically behind the previous character
831 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
834 // Now we iterate through until we reach the right margin
835 // or the end of the par, then choose the possible break
838 int label_end = labelEnd(pit);
839 int const left = leftMargin(max_width_, pit, pos);
842 // pixel width since last breakpoint
845 docstring const s(1, char_type(0x00B6));
847 int par_marker_width = theFontMetrics(f).width(s);
849 FontIterator fi = FontIterator(*this, par, pit, pos);
850 pos_type point = end;
853 ParagraphList const & pars_ = text_->paragraphs();
854 bool const draw_par_end_marker = lyxrc.paragraph_markers
855 && size_type(pit + 1) < pars_.size();
857 for ( ; i < end; ++i, ++fi) {
858 int thiswidth = pm.singleWidth(i, *fi);
860 if (draw_par_end_marker && i == end - 1)
861 // enlarge the last character to hold the end-of-par marker
862 thiswidth += par_marker_width;
864 // add inline completion width
865 if (inlineCompletionLPos == i) {
866 docstring const & completion = bv_->inlineCompletion();
867 if (completion.length() > 0)
868 thiswidth += theFontMetrics(*fi).width(completion);
871 // add the auto-hfill from label end to the body
872 if (body_pos && i == body_pos) {
873 FontMetrics const & fm = theFontMetrics(
874 text_->labelFont(par));
875 int add = fm.width(layout.labelsep);
876 if (par.isLineSeparator(i - 1))
877 add -= singleWidth(pit, i - 1);
879 add = max(add, label_end - x);
884 chunkwidth += thiswidth;
886 // break before a character that will fall off
887 // the right of the row
889 // if no break before, break here
890 if (point == end || chunkwidth >= width - left) {
896 // exit on last registered breakpoint:
900 if (par.isNewline(i)) {
904 Inset const * inset = 0;
907 if ((inset = par.getInset(i + 1)) && inset->display()) {
912 if ((inset = par.getInset(i)) && inset->display()) {
918 inset = par.getInset(i);
919 if (!inset || inset->isChar()) {
920 // some insets are line separators too
921 if (par.isLineSeparator(i)) {
922 // register breakpoint:
929 // maybe found one, but the par is short enough.
930 if (i == end && x < width)
933 // manual labels cannot be broken in LaTeX. But we
934 // want to make our on-screen rendering of footnotes
936 if (body_pos && point < body_pos)
943 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
944 pos_type const first, pos_type const end) const
946 // get the pure distance
947 ParagraphMetrics const & pm = par_metrics_[pit];
948 Paragraph const & par = text_->getPar(pit);
949 int w = leftMargin(max_width_, pit, first);
950 int label_end = labelEnd(pit);
952 // check for possible inline completion
953 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
954 pos_type inlineCompletionLPos = -1;
955 if (inlineCompletionPos.inTexted()
956 && inlineCompletionPos.text() == text_
957 && inlineCompletionPos.pit() == pit) {
958 // draw logically behind the previous character
959 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
962 pos_type const body_pos = par.beginOfBody();
966 FontIterator fi = FontIterator(*this, par, pit, i);
967 for ( ; i < end; ++i, ++fi) {
968 if (body_pos > 0 && i == body_pos) {
969 FontMetrics const & fm = theFontMetrics(
970 text_->labelFont(par));
971 w += fm.width(par.layout().labelsep);
972 if (par.isLineSeparator(i - 1))
973 w -= singleWidth(pit, i - 1);
974 w = max(w, label_end);
977 // a line separator at the end of a line (but not at the end of a
978 // paragraph) will not be drawn and should therefore not count for
980 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
981 w += pm.singleWidth(i, *fi);
983 // add inline completion width
984 if (inlineCompletionLPos == i) {
985 docstring const & completion = bv_->inlineCompletion();
986 if (completion.length() > 0)
987 w += theFontMetrics(*fi).width(completion);
992 // count the paragraph end marker.
993 if (end == par.size() && lyxrc.paragraph_markers) {
994 ParagraphList const & pars_ = text_->paragraphs();
995 if (size_type(pit + 1) < pars_.size()) {
996 // enlarge the last character to hold the
998 docstring const s(1, char_type(0x00B6));
1000 w += theFontMetrics(f).width(s);
1004 if (body_pos > 0 && body_pos >= end) {
1005 FontMetrics const & fm = theFontMetrics(
1006 text_->labelFont(par));
1007 w += fm.width(par.layout().labelsep);
1008 if (end > 0 && par.isLineSeparator(end - 1))
1009 w -= singleWidth(pit, end - 1);
1010 w = max(w, label_end);
1013 return w + right_margin;
1017 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
1018 pos_type const end, bool topBottomSpace) const
1020 Paragraph const & par = text_->getPar(pit);
1021 // get the maximum ascent and the maximum descent
1022 double layoutasc = 0;
1023 double layoutdesc = 0;
1024 double const dh = defaultRowHeight();
1026 // ok, let us initialize the maxasc and maxdesc value.
1027 // Only the fontsize count. The other properties
1028 // are taken from the layoutfont. Nicer on the screen :)
1029 Layout const & layout = par.layout();
1031 // as max get the first character of this row then it can
1032 // increase but not decrease the height. Just some point to
1033 // start with so we don't have to do the assignment below too
1035 Buffer const & buffer = bv_->buffer();
1036 Font font = displayFont(pit, first);
1037 FontSize const tmpsize = font.fontInfo().size();
1038 font.fontInfo() = text_->layoutFont(pit);
1039 FontSize const size = font.fontInfo().size();
1040 font.fontInfo().setSize(tmpsize);
1042 FontInfo labelfont = text_->labelFont(par);
1044 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1045 FontMetrics const & fontmetrics = theFontMetrics(font);
1047 // these are minimum values
1048 double const spacing_val = layout.spacing.getValue()
1049 * text_->spacing(par);
1050 //lyxerr << "spacing_val = " << spacing_val << endl;
1051 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1052 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1054 // insets may be taller
1055 ParagraphMetrics const & pm = par_metrics_[pit];
1056 InsetList::const_iterator ii = par.insetList().begin();
1057 InsetList::const_iterator iend = par.insetList().end();
1058 for ( ; ii != iend; ++ii) {
1059 if (ii->pos >= first && ii->pos < end) {
1060 Dimension const & dim = pm.insetDimension(ii->inset);
1061 maxasc = max(maxasc, dim.ascent());
1062 maxdesc = max(maxdesc, dim.descent());
1066 // Check if any custom fonts are larger (Asger)
1067 // This is not completely correct, but we can live with the small,
1068 // cosmetic error for now.
1072 par.highestFontInRange(first, end, size);
1073 if (maxsize > font.fontInfo().size()) {
1074 // use standard paragraph font with the maximal size
1075 FontInfo maxfont = font.fontInfo();
1076 maxfont.setSize(maxsize);
1077 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1078 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1079 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1082 // This is nicer with box insets:
1086 ParagraphList const & pars = text_->paragraphs();
1087 Inset const & inset = text_->inset();
1089 // is it a top line?
1090 if (first == 0 && topBottomSpace) {
1091 BufferParams const & bufparams = buffer.params();
1092 // some parskips VERY EASY IMPLEMENTATION
1093 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1094 && !inset.getLayout().parbreakIsNewline()
1095 && !par.layout().parbreak_is_newline
1097 && ((layout.isParagraph() && par.getDepth() == 0)
1098 || (pars[pit - 1].layout().isParagraph()
1099 && pars[pit - 1].getDepth() == 0))) {
1100 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1103 if (par.params().startOfAppendix())
1104 maxasc += int(3 * dh);
1106 // special code for the top label
1107 if (layout.labelIsAbove()
1108 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1109 && !par.labelString().empty())
1112 labelfont_metrics.maxHeight()
1113 * layout.spacing.getValue()
1114 * text_->spacing(par)
1115 + (layout.topsep + layout.labelbottomsep) * dh);
1118 // Add the layout spaces, for example before and after
1119 // a section, or between the items of a itemize or enumerate
1122 pit_type prev = text_->depthHook(pit, par.getDepth());
1123 Paragraph const & prevpar = pars[prev];
1125 && prevpar.layout() == layout
1126 && prevpar.getDepth() == par.getDepth()
1127 && prevpar.getLabelWidthString()
1128 == par.getLabelWidthString()) {
1129 layoutasc = layout.itemsep * dh;
1130 } else if (pit != 0 || first != 0) {
1131 if (layout.topsep > 0)
1132 layoutasc = layout.topsep * dh;
1135 prev = text_->outerHook(pit);
1136 if (prev != pit_type(pars.size())) {
1137 maxasc += int(pars[prev].layout().parsep * dh);
1138 } else if (pit != 0) {
1139 Paragraph const & prevpar = pars[pit - 1];
1140 if (prevpar.getDepth() != 0 ||
1141 prevpar.layout() == layout) {
1142 maxasc += int(layout.parsep * dh);
1147 // is it a bottom line?
1148 if (end >= par.size() && topBottomSpace) {
1149 // add the layout spaces, for example before and after
1150 // a section, or between the items of a itemize or enumerate
1152 pit_type nextpit = pit + 1;
1153 if (nextpit != pit_type(pars.size())) {
1154 pit_type cpit = pit;
1158 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1159 usual = pars[cpit].layout().bottomsep * dh;
1160 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1161 if (pars[cpit].layout() != pars[nextpit].layout()
1162 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1164 unusual = pars[cpit].layout().bottomsep * dh;
1166 layoutdesc = max(unusual, usual);
1167 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1168 if (pars[cpit].layout() != pars[nextpit].layout()
1169 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1170 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1175 // incalculate the layout spaces
1176 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1177 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1179 // FIXME: the correct way is to do the following is to move the
1180 // following code in another method specially tailored for the
1181 // main Text. The following test is thus bogus.
1182 // Top and bottom margin of the document (only at top-level)
1183 if (main_text_ && topBottomSpace) {
1184 if (pit == 0 && first == 0)
1186 if (pit + 1 == pit_type(pars.size()) &&
1187 end == par.size() &&
1188 !(end > 0 && par.isNewline(end - 1)))
1192 return Dimension(0, maxasc + labeladdon, maxdesc);
1196 // x is an absolute screen coord
1197 // returns the column near the specified x-coordinate of the row
1198 // x is set to the real beginning of this column
1199 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1200 Row const & row, int & x, bool & boundary) const
1202 Buffer const & buffer = bv_->buffer();
1204 /// For the main Text, it is possible that this pit is not
1205 /// yet in the CoordCache when moving cursor up.
1206 /// x Paragraph coordinate is always 0 for main text anyway.
1207 int const xo = origin_.x_;
1209 Paragraph const & par = text_->getPar(pit);
1211 bidi.computeTables(par, buffer, row);
1213 pos_type vc = row.pos();
1214 pos_type end = row.endpos();
1216 Layout const & layout = par.layout();
1218 bool left_side = false;
1220 pos_type body_pos = par.beginOfBody();
1222 double tmpx = row.x;
1223 double last_tmpx = tmpx;
1226 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1229 // check for empty row
1235 // This (rtl_support test) is not needed, but gives
1236 // some speedup if rtl_support == false
1237 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1239 // If lastrow is false, we don't need to compute
1240 // the value of rtl.
1241 bool const rtl_on_lastrow = lastrow ? text_->isRTL(par) : false;
1243 // if the first character is a separator, and we are in RTL
1244 // text, this character will not be painted on screen
1245 // and thus we should not count it and skip to the next. Only
1246 // in freespacing paragraphs, this first character is painted.
1247 if (!par.isFreeSpacing() && par.isSeparator(bidi.vis2log(vc)))
1250 while (vc < end && tmpx <= x) {
1251 c = bidi.vis2log(vc);
1253 if (body_pos > 0 && c == body_pos - 1) {
1254 FontMetrics const & fm = theFontMetrics(
1255 text_->labelFont(par));
1256 tmpx += row.label_hfill + fm.width(layout.labelsep);
1257 if (par.isLineSeparator(body_pos - 1))
1258 tmpx -= singleWidth(pit, body_pos - 1);
1261 tmpx += singleWidth(pit, c);
1262 if (par.isSeparator(c) && c >= body_pos)
1263 tmpx += row.separator;
1267 if ((tmpx + last_tmpx) / 2 > x) {
1272 // This shouldn't happen. But we can reset and try to continue.
1273 LASSERT(vc <= end, vc = end);
1278 ((rtl_on_lastrow && left_side && vc == row.pos() && x < tmpx - 5) ||
1279 (!rtl_on_lastrow && !left_side && vc == end && x > tmpx + 5))) {
1280 if (!par.isNewline(end - 1))
1282 } else if (vc == row.pos()) {
1283 c = bidi.vis2log(vc);
1284 if (bidi.level(c) % 2 == 1)
1287 c = bidi.vis2log(vc - 1);
1288 bool const rtl = (bidi.level(c) % 2 == 1);
1289 if (left_side == rtl) {
1291 boundary = isRTLBoundary(pit, c);
1295 // I believe this code is not needed anymore (Jug 20050717)
1297 // The following code is necessary because the cursor position past
1298 // the last char in a row is logically equivalent to that before
1299 // the first char in the next row. That's why insets causing row
1300 // divisions -- Newline and display-style insets -- must be treated
1301 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1302 // Newline inset, air gap below:
1303 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1304 if (bidi.level(end -1) % 2 == 0)
1305 tmpx -= singleWidth(pit, end - 1);
1307 tmpx += singleWidth(pit, end - 1);
1311 // Air gap above display inset:
1312 if (row.pos() < end && c >= end && end < par.size()
1313 && par.isInset(end) && par.getInset(end)->display()) {
1316 // Air gap below display inset:
1317 if (row.pos() < end && c >= end && par.isInset(end - 1)
1318 && par.getInset(end - 1)->display()) {
1324 pos_type const col = c - row.pos();
1326 if (!c || end == par.size())
1329 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1334 return min(col, end - 1 - row.pos());
1338 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1340 // We play safe and use parMetrics(pit) to make sure the
1341 // ParagraphMetrics will be redone and OK to use if needed.
1342 // Otherwise we would use an empty ParagraphMetrics in
1343 // upDownInText() while in selection mode.
1344 ParagraphMetrics const & pm = parMetrics(pit);
1346 LBUFERR(row < int(pm.rows().size()));
1348 Row const & r = pm.rows()[row];
1349 return r.pos() + getColumnNearX(pit, r, x, bound);
1353 void TextMetrics::newParMetricsDown()
1355 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1356 pit_type const pit = last.first + 1;
1357 if (pit == int(text_->paragraphs().size()))
1360 // do it and update its position.
1362 par_metrics_[pit].setPosition(last.second.position()
1363 + last.second.descent() + par_metrics_[pit].ascent());
1367 void TextMetrics::newParMetricsUp()
1369 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1370 if (first.first == 0)
1373 pit_type const pit = first.first - 1;
1374 // do it and update its position.
1376 par_metrics_[pit].setPosition(first.second.position()
1377 - first.second.ascent() - par_metrics_[pit].descent());
1380 // y is screen coordinate
1381 pit_type TextMetrics::getPitNearY(int y)
1383 LASSERT(!text_->paragraphs().empty(), return -1);
1384 LASSERT(!par_metrics_.empty(), return -1);
1385 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1387 // look for highest numbered paragraph with y coordinate less than given y
1390 ParMetricsCache::const_iterator it = par_metrics_.begin();
1391 ParMetricsCache::const_iterator et = par_metrics_.end();
1392 ParMetricsCache::const_iterator last = et;
1395 ParagraphMetrics const & pm = it->second;
1397 if (y < it->second.position() - int(pm.ascent())) {
1398 // We are looking for a position that is before the first paragraph in
1399 // the cache (which is in priciple off-screen, that is before the
1402 // We are already at the first paragraph in the inset.
1404 // OK, this is the paragraph we are looking for.
1405 pit = it->first - 1;
1410 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1412 if (y >= last->second.position() + int(pm_last.descent())) {
1413 // We are looking for a position that is after the last paragraph in
1414 // the cache (which is in priciple off-screen), that is before the
1416 pit = last->first + 1;
1417 if (pit == int(text_->paragraphs().size()))
1418 // We are already at the last paragraph in the inset.
1420 // OK, this is the paragraph we are looking for.
1421 newParMetricsDown();
1425 for (; it != et; ++it) {
1426 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1427 << " y: " << it->second.position());
1429 ParagraphMetrics const & pm = par_metrics_[it->first];
1431 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1433 yy = it->second.position();
1437 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1443 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1444 bool assert_in_view, bool up)
1446 ParagraphMetrics const & pm = par_metrics_[pit];
1448 int yy = pm.position() - pm.ascent();
1449 LBUFERR(!pm.rows().empty());
1450 RowList::const_iterator rit = pm.rows().begin();
1451 RowList::const_iterator rlast = pm.rows().end();
1453 for (; rit != rlast; yy += rit->height(), ++rit)
1454 if (yy + rit->height() > y)
1457 if (assert_in_view) {
1458 if (!up && yy + rit->height() > y) {
1459 if (rit != pm.rows().begin()) {
1462 } else if (pit != 0) {
1465 ParagraphMetrics const & pm2 = par_metrics_[pit];
1466 rit = pm2.rows().end();
1470 } else if (up && yy != y) {
1472 y = yy + rit->height();
1474 } else if (pit < int(text_->paragraphs().size()) - 1) {
1476 newParMetricsDown();
1477 ParagraphMetrics const & pm2 = par_metrics_[pit];
1478 rit = pm2.rows().begin();
1487 // x,y are absolute screen coordinates
1488 // sets cursor recursively descending into nested editable insets
1489 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1490 bool assert_in_view, bool up)
1492 if (lyxerr.debugging(Debug::WORKAREA)) {
1493 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1494 cur.bv().coordCache().dump();
1496 pit_type pit = getPitNearY(y);
1497 LASSERT(pit != -1, return 0);
1499 int yy = y; // is modified by getPitAndRowNearY
1500 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1502 bool bound = false; // is modified by getColumnNearX
1503 int xx = x; // is modified by getColumnNearX
1504 pos_type const pos = row.pos()
1505 + getColumnNearX(pit, row, xx, bound);
1508 cur.boundary(bound);
1511 // try to descend into nested insets
1512 Inset * inset = checkInsetHit(x, yy);
1513 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1515 // Either we deconst editXY or better we move current_font
1516 // and real_current_font to Cursor
1517 // FIXME: what is needed now that current_font and real_current_font
1519 cur.setCurrentFont();
1523 ParagraphList const & pars = text_->paragraphs();
1524 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1526 // This should be just before or just behind the
1527 // cursor position set above.
1528 LASSERT(inset == inset_before
1529 || inset == pars[pit].getInset(pos), return 0);
1531 // Make sure the cursor points to the position before
1533 if (inset == inset_before) {
1535 cur.boundary(false);
1538 // Try to descend recursively inside the inset.
1539 inset = inset->editXY(cur, x, yy);
1541 if (cur.top().text() == text_)
1542 cur.setCurrentFont();
1547 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1549 LASSERT(text_ == cur.text(), return);
1550 pit_type const pit = getPitNearY(y);
1551 LASSERT(pit != -1, return);
1553 ParagraphMetrics const & pm = par_metrics_[pit];
1555 int yy = pm.position() - pm.ascent();
1556 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1557 " pit: " << pit << " yy: " << yy);
1560 LBUFERR(pm.rows().size());
1561 for (; r < int(pm.rows().size()) - 1; ++r) {
1562 Row const & row = pm.rows()[r];
1563 if (int(yy + row.height()) > y)
1568 Row const & row = pm.rows()[r];
1570 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1574 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1576 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1578 text_->setCursor(cur, pit, pos, true, bound);
1579 // remember new position.
1584 //takes screen x,y coordinates
1585 Inset * TextMetrics::checkInsetHit(int x, int y)
1587 pit_type pit = getPitNearY(y);
1588 LASSERT(pit != -1, return 0);
1590 Paragraph const & par = text_->paragraphs()[pit];
1591 ParagraphMetrics const & pm = par_metrics_[pit];
1593 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1595 InsetList::const_iterator iit = par.insetList().begin();
1596 InsetList::const_iterator iend = par.insetList().end();
1597 for (; iit != iend; ++iit) {
1598 Inset * inset = iit->inset;
1600 LYXERR(Debug::DEBUG, "examining inset " << inset);
1602 if (!bv_->coordCache().getInsets().has(inset)) {
1603 LYXERR(Debug::DEBUG, "inset has no cached position");
1607 Dimension const & dim = pm.insetDimension(inset);
1608 Point p = bv_->coordCache().getInsets().xy(inset);
1610 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1611 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1614 && x <= p.x_ + dim.wid
1615 && y >= p.y_ - dim.asc
1616 && y <= p.y_ + dim.des) {
1617 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1622 LYXERR(Debug::DEBUG, "No inset hit. ");
1627 int TextMetrics::cursorX(CursorSlice const & sl,
1628 bool boundary) const
1630 LASSERT(sl.text() == text_, return 0);
1631 pit_type const pit = sl.pit();
1632 Paragraph const & par = text_->paragraphs()[pit];
1633 ParagraphMetrics const & pm = par_metrics_[pit];
1634 if (pm.rows().empty())
1637 pos_type ppos = sl.pos();
1638 // Correct position in front of big insets
1639 bool const boundary_correction = ppos != 0 && boundary;
1640 if (boundary_correction)
1643 Row const & row = pm.getRow(sl.pos(), boundary);
1645 pos_type cursor_vpos = 0;
1647 Buffer const & buffer = bv_->buffer();
1650 bidi.computeTables(par, buffer, row);
1652 pos_type const row_pos = row.pos();
1653 pos_type const end = row.endpos();
1654 // Spaces at logical line breaks in bidi text must be skipped during
1655 // cursor positioning. However, they may appear visually in the middle
1656 // of a row; they must be skipped, wherever they are...
1657 // * logically "abc_[HEBREW_\nHEBREW]"
1658 // * visually "abc_[_WERBEH\nWERBEH]"
1659 pos_type skipped_sep_vpos = -1;
1662 cursor_vpos = row_pos;
1663 else if (ppos >= end)
1664 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1665 else if (ppos > row_pos && ppos >= end)
1666 //FIXME: this code is never reached!
1667 // (see http://www.lyx.org/trac/changeset/8251)
1668 // Place cursor after char at (logical) position pos - 1
1669 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1670 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1672 // Place cursor before char at (logical) position ppos
1673 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1674 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1676 pos_type body_pos = par.beginOfBody();
1678 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1681 // check for possible inline completion in this row
1682 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1683 pos_type inlineCompletionVPos = -1;
1684 if (inlineCompletionPos.inTexted()
1685 && inlineCompletionPos.text() == text_
1686 && inlineCompletionPos.pit() == pit
1687 && inlineCompletionPos.pos() - 1 >= row_pos
1688 && inlineCompletionPos.pos() - 1 < end) {
1689 // draw logically behind the previous character
1690 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1693 // Use font span to speed things up, see below
1697 // If the last logical character is a separator, skip it, unless
1698 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1699 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1700 skipped_sep_vpos = bidi.log2vis(end - 1);
1702 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1703 ParagraphList const & pars_ = text_->paragraphs();
1704 if (size_type(pit + 1) < pars_.size()) {
1706 docstring const s = docstring(1, char_type(0x00B6));
1707 x += theFontMetrics(f).width(s);
1711 // Inline completion RTL special case row_pos == cursor_pos:
1712 // "__|b" => cursor_pos is right of __
1713 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1714 font = displayFont(pit, row_pos + 1);
1715 docstring const & completion = bv_->inlineCompletion();
1716 if (font.isRightToLeft() && completion.length() > 0)
1717 x += theFontMetrics(font.fontInfo()).width(completion);
1720 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1721 // Skip the separator which is at the logical end of the row
1722 if (vpos == skipped_sep_vpos)
1724 pos_type pos = bidi.vis2log(vpos);
1725 if (body_pos > 0 && pos == body_pos - 1) {
1726 FontMetrics const & labelfm = theFontMetrics(
1727 text_->labelFont(par));
1728 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1729 if (par.isLineSeparator(body_pos - 1))
1730 x -= singleWidth(pit, body_pos - 1);
1733 // Use font span to speed things up, see above
1734 if (pos < font_span.first || pos > font_span.last) {
1735 font_span = par.fontSpan(pos);
1736 font = displayFont(pit, pos);
1739 x += pm.singleWidth(pos, font);
1741 // Inline completion RTL case:
1742 // "a__|b", __ of b => non-boundary a-pos is right of __
1743 if (vpos + 1 == inlineCompletionVPos
1744 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1745 font = displayFont(pit, vpos + 1);
1746 docstring const & completion = bv_->inlineCompletion();
1747 if (font.isRightToLeft() && completion.length() > 0)
1748 x += theFontMetrics(font.fontInfo()).width(completion);
1751 // Inline completion LTR case:
1752 // "b|__a", __ of b => non-boundary a-pos is in front of __
1753 if (vpos == inlineCompletionVPos
1754 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1755 font = displayFont(pit, vpos);
1756 docstring const & completion = bv_->inlineCompletion();
1757 if (!font.isRightToLeft() && completion.length() > 0)
1758 x += theFontMetrics(font.fontInfo()).width(completion);
1761 if (par.isSeparator(pos) && pos >= body_pos)
1765 // see correction above
1766 if (boundary_correction) {
1767 if (isRTL(sl, boundary))
1768 x -= singleWidth(pit, ppos);
1770 x += singleWidth(pit, ppos);
1777 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1779 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1780 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1781 if (pm.rows().empty())
1785 h -= par_metrics_[0].rows()[0].ascent();
1786 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1787 h += par_metrics_[pit].height();
1790 if (pos && boundary)
1792 size_t const rend = pm.pos2row(pos);
1793 for (size_t rit = 0; rit != rend; ++rit)
1794 h += pm.rows()[rit].height();
1795 h += pm.rows()[rend].ascent();
1800 // the cursor set functions have a special mechanism. When they
1801 // realize you left an empty paragraph, they will delete it.
1803 bool TextMetrics::cursorHome(Cursor & cur)
1805 LASSERT(text_ == cur.text(), return false);
1806 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1807 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1808 return text_->setCursor(cur, cur.pit(), row.pos());
1812 bool TextMetrics::cursorEnd(Cursor & cur)
1814 LASSERT(text_ == cur.text(), return false);
1815 // if not on the last row of the par, put the cursor before
1816 // the final space exept if I have a spanning inset or one string
1817 // is so long that we force a break.
1818 pos_type end = cur.textRow().endpos();
1820 // empty text, end-1 is no valid position
1822 bool boundary = false;
1823 if (end != cur.lastpos()) {
1824 if (!cur.paragraph().isLineSeparator(end-1)
1825 && !cur.paragraph().isNewline(end-1))
1830 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1834 void TextMetrics::deleteLineForward(Cursor & cur)
1836 LASSERT(text_ == cur.text(), return);
1837 if (cur.lastpos() == 0) {
1838 // Paragraph is empty, so we just go forward
1839 text_->cursorForward(cur);
1842 cur.setSelection(true); // to avoid deletion
1845 // What is this test for ??? (JMarc)
1846 if (!cur.selection())
1847 text_->deleteWordForward(cur);
1849 cap::cutSelection(cur, true, false);
1850 cur.checkBufferStructure();
1855 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1857 ParagraphList const & pars = text_->paragraphs();
1858 return row.endpos() >= pars[pit].size()
1859 && pit + 1 == pit_type(pars.size());
1863 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1865 return row.pos() == 0 && pit == 0;
1869 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1871 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1875 int TextMetrics::leftMargin(int max_width,
1876 pit_type const pit, pos_type const pos) const
1878 ParagraphList const & pars = text_->paragraphs();
1880 LASSERT(pit >= 0, return 0);
1881 LASSERT(pit < int(pars.size()), return 0);
1882 Paragraph const & par = pars[pit];
1883 LASSERT(pos >= 0, return 0);
1884 LASSERT(pos <= par.size(), return 0);
1885 Buffer const & buffer = bv_->buffer();
1886 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1887 DocumentClass const & tclass = buffer.params().documentClass();
1888 Layout const & layout = par.layout();
1890 docstring parindent = layout.parindent;
1894 if (text_->isMainText())
1895 l_margin += bv_->leftMargin();
1897 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1898 tclass.leftmargin());
1900 if (par.getDepth() != 0) {
1901 // find the next level paragraph
1902 pit_type newpar = text_->outerHook(pit);
1903 if (newpar != pit_type(pars.size())) {
1904 if (pars[newpar].layout().isEnvironment()) {
1905 l_margin = leftMargin(max_width, newpar);
1907 if (tclass.isDefaultLayout(par.layout())
1908 || tclass.isPlainLayout(par.layout())) {
1909 if (pars[newpar].params().noindent())
1912 parindent = pars[newpar].layout().parindent;
1917 // This happens after sections in standard classes. The 1.3.x
1918 // code compared depths too, but it does not seem necessary
1920 if (tclass.isDefaultLayout(par.layout())
1921 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1924 FontInfo const labelfont = text_->labelFont(par);
1925 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1927 switch (layout.margintype) {
1928 case MARGIN_DYNAMIC:
1929 if (!layout.leftmargin.empty()) {
1930 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1933 if (!par.labelString().empty()) {
1934 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1935 l_margin += labelfont_metrics.width(par.labelString());
1936 l_margin += labelfont_metrics.width(layout.labelsep);
1940 case MARGIN_MANUAL: {
1941 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1942 // The width of an empty par, even with manual label, should be 0
1943 if (!par.empty() && pos >= par.beginOfBody()) {
1944 if (!par.getLabelWidthString().empty()) {
1945 docstring labstr = par.getLabelWidthString();
1946 l_margin += labelfont_metrics.width(labstr);
1947 l_margin += labelfont_metrics.width(layout.labelsep);
1953 case MARGIN_STATIC: {
1954 l_margin += theFontMetrics(buffer.params().getFont()).
1955 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1959 case MARGIN_FIRST_DYNAMIC:
1960 if (layout.labeltype == LABEL_MANUAL) {
1961 // if we are at position 0, we are never in the body
1962 if (pos > 0 && pos >= par.beginOfBody())
1963 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1965 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1967 // Special case to fix problems with
1969 || (layout.labeltype == LABEL_STATIC
1970 && layout.latextype == LATEX_ENVIRONMENT
1971 && !text_->isFirstInSequence(pit))) {
1972 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1973 } else if (!layout.labelIsAbove()) {
1974 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1975 l_margin += labelfont_metrics.width(layout.labelsep);
1976 l_margin += labelfont_metrics.width(par.labelString());
1980 case MARGIN_RIGHT_ADDRESS_BOX: {
1982 // The left margin depends on the widest row in this paragraph.
1983 // This code is wrong because it depends on the rows, but at the
1984 // same time this function is used in redoParagraph to construct
1986 ParagraphMetrics const & pm = par_metrics_[pit];
1987 RowList::const_iterator rit = pm.rows().begin();
1988 RowList::const_iterator end = pm.rows().end();
1989 int minfill = max_width;
1990 for ( ; rit != end; ++rit)
1991 if (rit->fill() < minfill)
1992 minfill = rit->fill();
1993 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1994 l_margin += minfill;
1996 // also wrong, but much shorter.
1997 l_margin += max_width / 2;
2002 if (!par.params().leftIndent().zero())
2003 l_margin += par.params().leftIndent().inPixels(max_width);
2007 if (par.params().align() == LYX_ALIGN_LAYOUT)
2008 align = layout.align;
2010 align = par.params().align();
2012 // set the correct parindent
2014 && (layout.labeltype == LABEL_NO_LABEL
2015 || layout.labeltype == LABEL_ABOVE
2016 || layout.labeltype == LABEL_CENTERED
2017 || (layout.labeltype == LABEL_STATIC
2018 && layout.latextype == LATEX_ENVIRONMENT
2019 && !text_->isFirstInSequence(pit)))
2020 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2021 && !par.params().noindent()
2022 // in some insets, paragraphs are never indented
2023 && !text_->inset().neverIndent()
2024 // display style insets are always centered, omit indentation
2027 && par.getInset(pos)->display())
2028 && (!(tclass.isDefaultLayout(par.layout())
2029 || tclass.isPlainLayout(par.layout()))
2030 || buffer.params().paragraph_separation
2031 == BufferParams::ParagraphIndentSeparation)
2034 // use the parindent of the layout when the default indentation is
2035 // used otherwise use the indentation set in the document settings
2036 if (buffer.params().getIndentation().asLyXCommand() == "default")
2037 l_margin += theFontMetrics(
2038 buffer.params().getFont()).signedWidth(parindent);
2040 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2047 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2049 ParagraphMetrics const & pm = par_metrics_[pit];
2051 return pm.singleWidth(pos, displayFont(pit, pos));
2055 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2057 if (par_metrics_.empty())
2063 ParMetricsCache::iterator it = par_metrics_.begin();
2064 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2065 y -= it->second.ascent();
2066 for (; it != pm_end; ++it) {
2067 ParagraphMetrics const & pmi = it->second;
2069 pit_type const pit = it->first;
2070 // Save the paragraph position in the cache.
2071 it->second.setPosition(y);
2072 drawParagraph(pi, pit, x, y);
2078 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2080 BufferParams const & bparams = bv_->buffer().params();
2081 ParagraphMetrics const & pm = par_metrics_[pit];
2082 if (pm.rows().empty())
2086 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2087 int const ww = bv_->workHeight();
2088 size_t const nrows = pm.rows().size();
2090 Cursor const & cur = bv_->cursor();
2091 DocIterator sel_beg = cur.selectionBegin();
2092 DocIterator sel_end = cur.selectionEnd();
2093 bool selection = cur.selection()
2094 // This is our text.
2095 && cur.text() == text_
2096 // if the anchor is outside, this is not our selection
2097 && cur.normalAnchor().text() == text_
2098 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2100 // We store the begin and end pos of the selection relative to this par
2101 DocIterator sel_beg_par = cur.selectionBegin();
2102 DocIterator sel_end_par = cur.selectionEnd();
2104 // We care only about visible selection.
2106 if (pit != sel_beg.pit()) {
2107 sel_beg_par.pit() = pit;
2108 sel_beg_par.pos() = 0;
2110 if (pit != sel_end.pit()) {
2111 sel_end_par.pit() = pit;
2112 sel_end_par.pos() = sel_end_par.lastpos();
2116 for (size_t i = 0; i != nrows; ++i) {
2118 Row const & row = pm.rows()[i];
2122 bool const inside = (y + row.descent() >= 0
2123 && y - row.ascent() < ww);
2124 // It is not needed to draw on screen if we are not inside.
2125 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2126 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2129 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2131 row.setSelection(-1, -1);
2133 // The row knows nothing about the paragraph, so we have to check
2134 // whether this row is the first or last and update the margins.
2135 if (row.selection()) {
2136 if (row.sel_beg == 0)
2137 row.begin_margin_sel = sel_beg.pit() < pit;
2138 if (row.sel_end == sel_end_par.lastpos())
2139 row.end_margin_sel = sel_end.pit() > pit;
2142 // Row signature; has row changed since last paint?
2143 row.setCrc(pm.computeRowSignature(row, bparams));
2144 bool row_has_changed = row.changed();
2146 // Take this opportunity to spellcheck the row contents.
2147 if (row_has_changed && lyxrc.spellcheck_continuously) {
2148 text_->getPar(pit).spellCheck();
2151 // Don't paint the row if a full repaint has not been requested
2152 // and if it has not changed.
2153 if (!pi.full_repaint && !row_has_changed) {
2154 // Paint only the insets if the text itself is
2156 rp.paintOnlyInsets();
2161 // Clear background of this row if paragraph background was not
2162 // already cleared because of a full repaint.
2163 if (!pi.full_repaint && row_has_changed) {
2164 pi.pain.fillRectangle(x, y - row.ascent(),
2165 width(), row.height(), pi.background_color);
2168 // Instrumentation for testing row cache (see also
2170 if (lyxerr.debugging(Debug::PAINTING) && inside
2171 && (row.selection() || pi.full_repaint || row_has_changed)) {
2172 string const foreword = text_->isMainText() ?
2173 "main text redraw " : "inset text redraw: ";
2174 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2175 << " row_selection=" << row.selection()
2176 << " full_repaint=" << pi.full_repaint
2177 << " row_has_changed=" << row_has_changed);
2180 // Backup full_repaint status and force full repaint
2181 // for inner insets as the Row has been cleared out.
2182 bool tmp = pi.full_repaint;
2183 pi.full_repaint = true;
2185 rp.paintSelection();
2188 rp.paintChangeBar();
2189 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2190 if (i == 0 && !is_rtl)
2192 if (i == nrows - 1 && is_rtl)
2195 if (i == nrows - 1 && !is_rtl)
2197 if (i == 0 && is_rtl)
2201 // Restore full_repaint status.
2202 pi.full_repaint = tmp;
2204 // Re-enable screen drawing for future use of the painter.
2205 pi.pain.setDrawingEnabled(original_drawing_state);
2207 //LYXERR(Debug::PAINTING, ".");
2211 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2212 Dimension & dim) const
2214 Cursor const & bvcur = cur.bv().cursor();
2216 // get word in front of cursor
2217 docstring word = text_->previousWord(bvcur.top());
2218 DocIterator wordStart = bvcur;
2219 wordStart.pos() -= word.length();
2221 // get position on screen of the word start and end
2222 //FIXME: Is it necessary to explicitly set this to false?
2223 wordStart.boundary(false);
2224 Point lxy = cur.bv().getPos(wordStart);
2225 Point rxy = cur.bv().getPos(bvcur);
2227 // calculate dimensions of the word
2228 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2229 dim.wid = abs(rxy.x_ - lxy.x_);
2231 // calculate position of word
2233 x = min(rxy.x_, lxy.x_);
2235 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2236 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2239 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2241 // ParagraphMetrics const & pm = par_metrics_[pit];
2242 // Row const & r = pm.rows()[row];
2248 int defaultRowHeight()
2250 return int(theFontMetrics(sane_font).maxHeight() * 1.2);