2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
31 #include "InsetList.h"
35 #include "MetricsInfo.h"
36 #include "ParagraphParameters.h"
37 #include "ParIterator.h"
38 #include "rowpainter.h"
40 #include "TextClass.h"
42 #include "WordLangTuple.h"
44 #include "insets/InsetText.h"
46 #include "mathed/MacroTable.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
52 #include "support/debug.h"
53 #include "support/docstring_list.h"
54 #include "support/lassert.h"
63 using frontend::FontMetrics;
65 static int numberOfSeparators(Paragraph const & par, Row const & row)
67 pos_type const first = max(row.pos(), par.beginOfBody());
68 pos_type const last = row.endpos() - 1;
70 for (pos_type p = first; p < last; ++p) {
71 if (par.isSeparator(p))
78 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
80 pos_type last = row.endpos() - 1;
81 pos_type first = row.pos();
83 // hfill *DO* count at the beginning of paragraphs!
85 while (first < last && par.isHfill(first))
89 last = min(last, par.beginOfBody());
91 for (pos_type p = first; p < last; ++p) {
99 static int numberOfHfills(Paragraph const & par, Row const & row)
101 pos_type const last = row.endpos();
102 pos_type first = row.pos();
104 // hfill *DO* count at the beginning of paragraphs!
106 while (first < last && par.isHfill(first))
110 first = max(first, par.beginOfBody());
113 for (pos_type p = first; p < last; ++p) {
121 /////////////////////////////////////////////////////////////////////
125 /////////////////////////////////////////////////////////////////////
128 TextMetrics::TextMetrics(BufferView * bv, Text * text)
129 : bv_(bv), text_(text)
132 max_width_ = bv_->workWidth();
133 dim_.wid = max_width_;
139 bool TextMetrics::contains(pit_type pit) const
141 return par_metrics_.find(pit) != par_metrics_.end();
145 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
147 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
152 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
154 ParMetricsCache::const_iterator it = par_metrics_.begin();
155 return make_pair(it->first, &it->second);
159 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
161 LASSERT(!par_metrics_.empty(), /**/);
162 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
163 return make_pair(it->first, &it->second);
167 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
169 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
170 if (pmc_it == par_metrics_.end()) {
171 pmc_it = par_metrics_.insert(
172 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
174 if (pmc_it->second.rows().empty() && redo)
176 return pmc_it->second;
180 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
182 LASSERT(mi.base.textwidth > 0, /**/);
183 max_width_ = mi.base.textwidth;
184 // backup old dimension.
185 Dimension const old_dim = dim_;
188 dim_.wid = min_width;
189 pit_type const npar = text_->paragraphs().size();
191 // If there is more than one row, expand the text to
192 // the full allowable width.
193 dim_.wid = max_width_;
195 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
196 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
198 bool changed = false;
200 for (pit_type pit = 0; pit != npar; ++pit) {
201 changed |= redoParagraph(pit);
202 ParagraphMetrics const & pm = par_metrics_[pit];
204 if (dim_.wid < pm.width())
205 dim_.wid = pm.width();
208 dim_.asc = par_metrics_[0].ascent();
209 dim_.des = h - dim_.asc;
210 //lyxerr << "dim_.wid " << dim_.wid << endl;
211 //lyxerr << "dim_.asc " << dim_.asc << endl;
212 //lyxerr << "dim_.des " << dim_.des << endl;
214 changed |= dim_ != old_dim;
220 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
222 return main_text_? pm.rightMargin(*bv_) : 0;
226 int TextMetrics::rightMargin(pit_type const pit) const
228 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
232 void TextMetrics::applyOuterFont(Font & font) const
234 FontInfo lf(font_.fontInfo());
235 lf.reduce(bv_->buffer().params().getFont().fontInfo());
236 font.fontInfo().realize(lf);
240 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
242 LASSERT(pos >= 0, /**/);
244 ParagraphList const & pars = text_->paragraphs();
245 Paragraph const & par = pars[pit];
246 Layout const & layout = par.layout();
247 Buffer const & buffer = bv_->buffer();
249 BufferParams const & params = buffer.params();
250 pos_type const body_pos = par.beginOfBody();
252 // We specialize the 95% common case:
253 if (!par.getDepth()) {
254 Font f = par.getFontSettings(params, pos);
255 if (!text_->isMainText())
257 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
259 FontInfo const & lf = lab ? layout.labelfont : layout.font;
260 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
262 // In case the default family has been customized
263 if (lf.family() == INHERIT_FAMILY)
264 rlf.setFamily(params.getFont().fontInfo().family());
265 f.fontInfo().realize(rlf);
269 // The uncommon case need not be optimized as much
270 FontInfo const & layoutfont = pos < body_pos ?
271 layout.labelfont : layout.font;
273 Font font = par.getFontSettings(params, pos);
274 font.fontInfo().realize(layoutfont);
276 if (!text_->isMainText())
277 applyOuterFont(font);
279 // Realize against environment font information
280 // NOTE: the cast to pit_type should be removed when pit_type
281 // changes to a unsigned integer.
282 if (pit < pit_type(pars.size()))
283 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
285 // Realize with the fonts of lesser depth.
286 font.fontInfo().realize(params.getFont().fontInfo());
292 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
294 if (!lyxrc.rtl_support || !sl.text())
298 if (boundary && sl.pos() > 0)
301 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
305 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
307 // no RTL boundary at paragraph start
308 if (!lyxrc.rtl_support || pos == 0)
311 Font const & left_font = displayFont(pit, pos - 1);
313 return isRTLBoundary(pit, pos, left_font);
317 // isRTLBoundary returns false on a real end-of-line boundary,
318 // because otherwise the two boundary types get mixed up.
319 // This is the whole purpose of this being in TextMetrics.
320 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
321 Font const & font) const
323 if (!lyxrc.rtl_support
324 // no RTL boundary at paragraph start
326 // if the metrics have not been calculated, then we are not
327 // on screen and can safely ignore issues about boundaries.
331 ParagraphMetrics & pm = par_metrics_[pit];
332 // no RTL boundary in empty paragraph
333 if (pm.rows().empty())
336 pos_type endpos = pm.getRow(pos - 1, false).endpos();
337 pos_type startpos = pm.getRow(pos, false).pos();
338 // no RTL boundary at line start:
339 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
341 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
344 Paragraph const & par = text_->getPar(pit);
345 // no RTL boundary at line break:
346 // abc|\n -> move right -> abc\n (and not: abc\n|
348 if (startpos == pos && endpos == pos && endpos != par.size()
349 && (par.isNewline(pos - 1)
350 || par.isLineSeparator(pos - 1)
351 || par.isSeparator(pos - 1)))
354 bool left = font.isVisibleRightToLeft();
356 if (pos == par.size())
357 right = par.isRTL(bv_->buffer().params());
359 right = displayFont(pit, pos).isVisibleRightToLeft();
361 return left != right;
365 bool TextMetrics::redoParagraph(pit_type const pit)
367 Paragraph & par = text_->getPar(pit);
368 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
369 // redoParagraph() recursively inside parMetrics.
370 Dimension old_dim = parMetrics(pit, false).dim();
371 ParagraphMetrics & pm = par_metrics_[pit];
374 Buffer & buffer = bv_->buffer();
375 main_text_ = (text_ == &buffer.text());
376 bool changed = false;
378 // Check whether there are InsetBibItems that need fixing
379 // FIXME: This check ought to be done somewhere else. It is the reason
380 // why text_ is not const. But then, where else to do it?
381 // Well, how can you end up with either (a) a biblio environment that
382 // has no InsetBibitem or (b) a biblio environment with more than one
383 // InsetBibitem? I think the answer is: when paragraphs are merged;
384 // when layout is set; when material is pasted.
385 if (par.brokenBiblio()) {
386 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
387 // In some cases, we do not know how to record undo
388 if (&cur.inset() == &text_->inset())
389 cur.recordUndo(ATOMIC_UNDO, pit, pit);
391 int const moveCursor = par.fixBiblio(buffer);
393 // Is it necessary to update the cursor?
394 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
397 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
402 // Optimisation: this is used in the next two loops
403 // so better to calculate that once here.
404 int const right_margin = rightMargin(pm);
406 // iterator pointing to paragraph to resolve macros
407 DocIterator parPos = text_->macrocontextPosition();
411 LYXERR(Debug::INFO, "MacroContext not initialised!"
412 << " Going through the buffer again and hope"
413 << " the context is better then.");
414 // FIXME audit updateBuffer calls
415 // This should not be here, but it is not clear yet where else it
417 bv_->buffer().updateBuffer();
418 parPos = text_->macrocontextPosition();
419 LASSERT(!parPos.empty(), /**/);
424 Font const bufferfont = buffer.params().getFont();
425 InsetList::const_iterator ii = par.insetList().begin();
426 InsetList::const_iterator iend = par.insetList().end();
427 for (; ii != iend; ++ii) {
428 // FIXME Doesn't this HAVE to be non-empty?
429 // position already initialized?
430 if (!parPos.empty()) {
431 parPos.pos() = ii->pos;
433 // A macro template would normally not be visible
434 // by itself. But the tex macro semantics allow
435 // recursion, so we artifically take the context
436 // after the macro template to simulate this.
437 if (ii->inset->lyxCode() == MATHMACRO_CODE)
441 // do the metric calculation
443 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
445 Font const & font = ii->inset->inheritFont() ?
446 displayFont(pit, ii->pos) : bufferfont;
447 MacroContext mc(&buffer, parPos);
448 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
449 ii->inset->metrics(mi, dim);
450 Dimension const old_dim = pm.insetDimension(ii->inset);
451 if (old_dim != dim) {
452 pm.setInsetDimension(ii->inset, dim);
457 par.setBeginOfBody();
459 size_t row_index = 0;
460 // maximum pixel width of a row
461 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
464 pos_type end = rowBreakPoint(width, pit, first);
465 if (row_index || end < par.size())
466 // If there is more than one row, expand the text to
467 // the full allowable width. This setting here is needed
468 // for the computeRowMetrics() below.
469 dim_.wid = max_width_;
471 dim = rowHeight(pit, first, end);
472 dim.wid = rowWidth(right_margin, pit, first, end);
473 if (row_index == pm.rows().size())
474 pm.rows().push_back(Row());
475 Row & row = pm.rows()[row_index];
476 row.setChanged(false);
479 row.setDimension(dim);
480 int const max_row_width = max(dim_.wid, dim.wid);
481 computeRowMetrics(pit, row, max_row_width);
485 pm.dim().wid = max(pm.dim().wid, dim.wid);
486 pm.dim().des += dim.height();
487 } while (first < par.size());
489 if (row_index < pm.rows().size())
490 pm.rows().resize(row_index);
492 // Make sure that if a par ends in newline, there is one more row
494 if (first > 0 && par.isNewline(first - 1)) {
495 Dimension dim = rowHeight(pit, first, first);
496 dim.wid = rowWidth(right_margin, pit, first, first);
497 if (row_index == pm.rows().size())
498 pm.rows().push_back(Row());
499 Row & row = pm.rows()[row_index];
500 row.setChanged(false);
503 row.setDimension(dim);
504 int const max_row_width = max(dim_.wid, dim.wid);
505 computeRowMetrics(pit, row, max_row_width);
506 pm.dim().des += dim.height();
509 pm.dim().asc += pm.rows()[0].ascent();
510 pm.dim().des -= pm.rows()[0].ascent();
512 changed |= old_dim.height() != pm.dim().height();
518 void TextMetrics::computeRowMetrics(pit_type const pit,
519 Row & row, int width) const
524 Paragraph const & par = text_->getPar(pit);
526 double w = width - row.width();
527 // FIXME: put back this assertion when the crash on new doc is solved.
528 //LASSERT(w >= 0, /**/);
530 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
531 //lyxerr << "row.width() " << row.width() << endl;
532 //lyxerr << "w " << w << endl;
534 bool const is_rtl = text_->isRTL(par);
536 row.x = rightMargin(pit);
538 row.x = leftMargin(max_width_, pit, row.pos());
540 // is there a manual margin with a manual label
541 Layout const & layout = par.layout();
543 if (layout.margintype == MARGIN_MANUAL
544 && layout.labeltype == LABEL_MANUAL) {
545 /// We might have real hfills in the label part
546 int nlh = numberOfLabelHfills(par, row);
548 // A manual label par (e.g. List) has an auto-hfill
549 // between the label text and the body of the
551 // But we don't want to do this auto hfill if the par
556 if (nlh && !par.getLabelWidthString().empty())
557 row.label_hfill = labelFill(pit, row) / double(nlh);
561 // are there any hfills in the row?
562 if (int const nh = numberOfHfills(par, row)) {
564 hfill = w / double(nh);
565 // we don't have to look at the alignment if it is ALIGN_LEFT and
566 // if the row is already larger then the permitted width as then
567 // we force the LEFT_ALIGN'edness!
568 } else if (int(row.width()) < max_width_) {
569 // is it block, flushleft or flushright?
570 // set x how you need it
572 if (par.params().align() == LYX_ALIGN_LAYOUT)
573 align = layout.align;
575 align = par.params().align();
577 // handle alignment inside tabular cells
578 Inset const & owner = text_->inset();
579 switch (owner.contentAlignment()) {
580 case LYX_ALIGN_CENTER:
582 case LYX_ALIGN_RIGHT:
583 if (align == LYX_ALIGN_NONE
584 || align == LYX_ALIGN_BLOCK)
585 align = owner.contentAlignment();
588 // unchanged (use align)
592 // Display-style insets should always be on a centered row
593 if (Inset const * inset = par.getInset(row.pos())) {
594 switch (inset->display()) {
595 case Inset::AlignLeft:
596 align = LYX_ALIGN_BLOCK;
598 case Inset::AlignCenter:
599 align = LYX_ALIGN_CENTER;
602 // unchanged (use align)
604 case Inset::AlignRight:
605 align = LYX_ALIGN_RIGHT;
610 // Has the user requested we not justify stuff?
611 if (!bv_->buffer().params().justification
612 && align == LYX_ALIGN_BLOCK)
613 align = LYX_ALIGN_LEFT;
616 case LYX_ALIGN_BLOCK: {
617 int const ns = numberOfSeparators(par, row);
618 bool disp_inset = false;
619 if (row.endpos() < par.size()) {
620 Inset const * in = par.getInset(row.endpos());
622 disp_inset = in->display();
624 // If we have separators, this is not the last row of a
625 // par, does not end in newline, and is not row above a
626 // display inset... then stretch it
628 && row.endpos() < par.size()
629 && !par.isNewline(row.endpos() - 1)
632 row.separator = w / ns;
633 //lyxerr << "row.separator " << row.separator << endl;
634 //lyxerr << "ns " << ns << endl;
640 case LYX_ALIGN_RIGHT:
643 case LYX_ALIGN_CENTER:
650 pos_type body_pos = par.beginOfBody();
651 pos_type end = row.endpos();
654 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
656 row.x += theFontMetrics(text_->labelFont(par)).
657 width(layout.labelsep);
659 row.x += row.label_hfill;
663 pos_type const endpos = row.endpos();
664 pos_type body_pos = par.beginOfBody();
666 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
669 ParagraphMetrics & pm = par_metrics_[pit];
670 InsetList::const_iterator ii = par.insetList().begin();
671 InsetList::const_iterator iend = par.insetList().end();
672 for ( ; ii != iend; ++ii) {
673 if (ii->pos >= endpos || ii->pos < row.pos()
674 || (ii->inset->lyxCode() != SPACE_CODE ||
675 !ii->inset->isStretchableSpace()))
677 Dimension dim = row.dimension();
678 if (pm.hfillExpansion(row, ii->pos))
679 dim.wid = int(ii->pos >= body_pos ?
680 max(hfill, 5.0) : row.label_hfill);
683 // Cache the inset dimension.
684 bv_->coordCache().insets().add(ii->inset, dim);
685 pm.setInsetDimension(ii->inset, dim);
690 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
692 Paragraph const & par = text_->getPar(pit);
694 pos_type last = par.beginOfBody();
695 LASSERT(last > 0, /**/);
697 // -1 because a label ends with a space that is in the label
700 // a separator at this end does not count
701 if (par.isLineSeparator(last))
705 for (pos_type i = row.pos(); i <= last; ++i)
706 w += singleWidth(pit, i);
708 docstring const & label = par.params().labelWidthString();
712 FontMetrics const & fm
713 = theFontMetrics(text_->labelFont(par));
715 return max(0, fm.width(label) - w);
720 // Not used, see TextMetrics::rowBreakPoint.
721 // this needs special handling - only newlines count as a break point
722 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
724 pos_type const end = par.size();
727 if (par.isNewline(i))
735 int TextMetrics::labelEnd(pit_type const pit) const
737 // labelEnd is only needed if the layout fills a flushleft label.
738 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
740 // return the beginning of the body
741 return leftMargin(max_width_, pit);
747 * Calling Text::getFont is slow. While rebreaking we scan a
748 * paragraph from left to right calling getFont for every char. This
749 * simple class address this problem by hidding an optimization trick
750 * (not mine btw -AB): the font is reused in the whole font span. The
751 * class handles transparently the "hidden" (not part of the fontlist)
752 * label font (as getFont does).
758 FontIterator(TextMetrics const & tm,
759 Paragraph const & par, pit_type pit, pos_type pos)
760 : tm_(tm), par_(par), pit_(pit), pos_(pos),
761 font_(tm.displayFont(pit, pos)),
762 endspan_(par.fontSpan(pos).last),
763 bodypos_(par.beginOfBody())
767 Font const & operator*() const { return font_; }
770 FontIterator & operator++()
773 if (pos_ > endspan_ || pos_ == bodypos_) {
774 font_ = tm_.displayFont(pit_, pos_);
775 endspan_ = par_.fontSpan(pos_).last;
781 Font * operator->() { return &font_; }
785 TextMetrics const & tm_;
787 Paragraph const & par_;
802 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
805 ParagraphMetrics const & pm = par_metrics_[pit];
806 Paragraph const & par = text_->getPar(pit);
807 pos_type const end = par.size();
808 if (pos == end || width < 0)
811 Layout const & layout = par.layout();
814 //FIXME: As long as leftMargin() is not correctly implemented for
815 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
816 // Otherwise, long rows will be painted off the screen.
817 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
818 return addressBreakPoint(pos, par);
821 pos_type const body_pos = par.beginOfBody();
823 // check for possible inline completion
824 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
825 pos_type inlineCompletionLPos = -1;
826 if (inlineCompletionPos.inTexted()
827 && inlineCompletionPos.text() == text_
828 && inlineCompletionPos.pit() == pit) {
829 // draw logically behind the previous character
830 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
833 // Now we iterate through until we reach the right margin
834 // or the end of the par, then choose the possible break
837 int label_end = labelEnd(pit);
838 int const left = leftMargin(max_width_, pit, pos);
841 // pixel width since last breakpoint
844 docstring const s(1, char_type(0x00B6));
846 int par_marker_width = theFontMetrics(f).width(s);
848 FontIterator fi = FontIterator(*this, par, pit, pos);
849 pos_type point = end;
852 ParagraphList const & pars_ = text_->paragraphs();
853 bool const draw_par_end_marker = lyxrc.paragraph_markers
854 && size_type(pit + 1) < pars_.size();
856 for ( ; i < end; ++i, ++fi) {
857 int thiswidth = pm.singleWidth(i, *fi);
859 if (draw_par_end_marker && i == end - 1)
860 // enlarge the last character to hold the end-of-par marker
861 thiswidth += par_marker_width;
863 // add inline completion width
864 if (inlineCompletionLPos == i) {
865 docstring const & completion = bv_->inlineCompletion();
866 if (completion.length() > 0)
867 thiswidth += theFontMetrics(*fi).width(completion);
870 // add the auto-hfill from label end to the body
871 if (body_pos && i == body_pos) {
872 FontMetrics const & fm = theFontMetrics(
873 text_->labelFont(par));
874 int add = fm.width(layout.labelsep);
875 if (par.isLineSeparator(i - 1))
876 add -= singleWidth(pit, i - 1);
878 add = max(add, label_end - x);
883 chunkwidth += thiswidth;
885 // break before a character that will fall off
886 // the right of the row
888 // if no break before, break here
889 if (point == end || chunkwidth >= width - left) {
895 // exit on last registered breakpoint:
899 if (par.isNewline(i)) {
903 Inset const * inset = 0;
906 if ((inset = par.getInset(i + 1)) && inset->display()) {
911 if ((inset = par.getInset(i)) && inset->display()) {
917 inset = par.getInset(i);
918 if (!inset || inset->isChar()) {
919 // some insets are line separators too
920 if (par.isLineSeparator(i)) {
921 // register breakpoint:
928 // maybe found one, but the par is short enough.
929 if (i == end && x < width)
932 // manual labels cannot be broken in LaTeX. But we
933 // want to make our on-screen rendering of footnotes
935 if (body_pos && point < body_pos)
942 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
943 pos_type const first, pos_type const end) const
945 // get the pure distance
946 ParagraphMetrics const & pm = par_metrics_[pit];
947 Paragraph const & par = text_->getPar(pit);
948 int w = leftMargin(max_width_, pit, first);
949 int label_end = labelEnd(pit);
951 // check for possible inline completion
952 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
953 pos_type inlineCompletionLPos = -1;
954 if (inlineCompletionPos.inTexted()
955 && inlineCompletionPos.text() == text_
956 && inlineCompletionPos.pit() == pit) {
957 // draw logically behind the previous character
958 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
961 pos_type const body_pos = par.beginOfBody();
965 FontIterator fi = FontIterator(*this, par, pit, i);
966 for ( ; i < end; ++i, ++fi) {
967 if (body_pos > 0 && i == body_pos) {
968 FontMetrics const & fm = theFontMetrics(
969 text_->labelFont(par));
970 w += fm.width(par.layout().labelsep);
971 if (par.isLineSeparator(i - 1))
972 w -= singleWidth(pit, i - 1);
973 w = max(w, label_end);
976 // a line separator at the end of a line (but not at the end of a
977 // paragraph) will not be drawn and should therefore not count for
979 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
980 w += pm.singleWidth(i, *fi);
982 // add inline completion width
983 if (inlineCompletionLPos == i) {
984 docstring const & completion = bv_->inlineCompletion();
985 if (completion.length() > 0)
986 w += theFontMetrics(*fi).width(completion);
991 // count the paragraph end marker.
992 if (end == par.size() && lyxrc.paragraph_markers) {
993 ParagraphList const & pars_ = text_->paragraphs();
994 if (size_type(pit + 1) < pars_.size()) {
995 // enlarge the last character to hold the
997 docstring const s(1, char_type(0x00B6));
999 w += theFontMetrics(f).width(s);
1003 if (body_pos > 0 && body_pos >= end) {
1004 FontMetrics const & fm = theFontMetrics(
1005 text_->labelFont(par));
1006 w += fm.width(par.layout().labelsep);
1007 if (end > 0 && par.isLineSeparator(end - 1))
1008 w -= singleWidth(pit, end - 1);
1009 w = max(w, label_end);
1012 return w + right_margin;
1016 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
1017 pos_type const end, bool topBottomSpace) const
1019 Paragraph const & par = text_->getPar(pit);
1020 // get the maximum ascent and the maximum descent
1021 double layoutasc = 0;
1022 double layoutdesc = 0;
1023 double const dh = defaultRowHeight();
1025 // ok, let us initialize the maxasc and maxdesc value.
1026 // Only the fontsize count. The other properties
1027 // are taken from the layoutfont. Nicer on the screen :)
1028 Layout const & layout = par.layout();
1030 // as max get the first character of this row then it can
1031 // increase but not decrease the height. Just some point to
1032 // start with so we don't have to do the assignment below too
1034 Buffer const & buffer = bv_->buffer();
1035 Font font = displayFont(pit, first);
1036 FontSize const tmpsize = font.fontInfo().size();
1037 font.fontInfo() = text_->layoutFont(pit);
1038 FontSize const size = font.fontInfo().size();
1039 font.fontInfo().setSize(tmpsize);
1041 FontInfo labelfont = text_->labelFont(par);
1043 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1044 FontMetrics const & fontmetrics = theFontMetrics(font);
1046 // these are minimum values
1047 double const spacing_val = layout.spacing.getValue()
1048 * text_->spacing(par);
1049 //lyxerr << "spacing_val = " << spacing_val << endl;
1050 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1051 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1053 // insets may be taller
1054 ParagraphMetrics const & pm = par_metrics_[pit];
1055 InsetList::const_iterator ii = par.insetList().begin();
1056 InsetList::const_iterator iend = par.insetList().end();
1057 for ( ; ii != iend; ++ii) {
1058 if (ii->pos >= first && ii->pos < end) {
1059 Dimension const & dim = pm.insetDimension(ii->inset);
1060 maxasc = max(maxasc, dim.ascent());
1061 maxdesc = max(maxdesc, dim.descent());
1065 // Check if any custom fonts are larger (Asger)
1066 // This is not completely correct, but we can live with the small,
1067 // cosmetic error for now.
1071 par.highestFontInRange(first, end, size);
1072 if (maxsize > font.fontInfo().size()) {
1073 // use standard paragraph font with the maximal size
1074 FontInfo maxfont = font.fontInfo();
1075 maxfont.setSize(maxsize);
1076 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1077 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1078 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1081 // This is nicer with box insets:
1085 ParagraphList const & pars = text_->paragraphs();
1086 Inset const & inset = text_->inset();
1088 // is it a top line?
1089 if (first == 0 && topBottomSpace) {
1090 BufferParams const & bufparams = buffer.params();
1091 // some parskips VERY EASY IMPLEMENTATION
1092 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1093 && !inset.getLayout().parbreakIsNewline()
1094 && !par.layout().parbreak_is_newline
1096 && ((layout.isParagraph() && par.getDepth() == 0)
1097 || (pars[pit - 1].layout().isParagraph()
1098 && pars[pit - 1].getDepth() == 0))) {
1099 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1102 if (par.params().startOfAppendix())
1103 maxasc += int(3 * dh);
1105 // special code for the top label
1106 if (layout.labelIsAbove()
1107 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1108 && !par.labelString().empty())
1111 labelfont_metrics.maxHeight()
1112 * layout.spacing.getValue()
1113 * text_->spacing(par)
1114 + (layout.topsep + layout.labelbottomsep) * dh);
1117 // Add the layout spaces, for example before and after
1118 // a section, or between the items of a itemize or enumerate
1121 pit_type prev = text_->depthHook(pit, par.getDepth());
1122 Paragraph const & prevpar = pars[prev];
1124 && prevpar.layout() == layout
1125 && prevpar.getDepth() == par.getDepth()
1126 && prevpar.getLabelWidthString()
1127 == par.getLabelWidthString()) {
1128 layoutasc = layout.itemsep * dh;
1129 } else if (pit != 0 || first != 0) {
1130 if (layout.topsep > 0)
1131 layoutasc = layout.topsep * dh;
1134 prev = text_->outerHook(pit);
1135 if (prev != pit_type(pars.size())) {
1136 maxasc += int(pars[prev].layout().parsep * dh);
1137 } else if (pit != 0) {
1138 Paragraph const & prevpar = pars[pit - 1];
1139 if (prevpar.getDepth() != 0 ||
1140 prevpar.layout() == layout) {
1141 maxasc += int(layout.parsep * dh);
1146 // is it a bottom line?
1147 if (end >= par.size() && topBottomSpace) {
1148 // add the layout spaces, for example before and after
1149 // a section, or between the items of a itemize or enumerate
1151 pit_type nextpit = pit + 1;
1152 if (nextpit != pit_type(pars.size())) {
1153 pit_type cpit = pit;
1157 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1158 usual = pars[cpit].layout().bottomsep * dh;
1159 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1160 if (pars[cpit].layout() != pars[nextpit].layout()
1161 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1163 unusual = pars[cpit].layout().bottomsep * dh;
1165 layoutdesc = max(unusual, usual);
1166 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1167 if (pars[cpit].layout() != pars[nextpit].layout()
1168 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1169 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1174 // incalculate the layout spaces
1175 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1176 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1178 // FIXME: the correct way is to do the following is to move the
1179 // following code in another method specially tailored for the
1180 // main Text. The following test is thus bogus.
1181 // Top and bottom margin of the document (only at top-level)
1182 if (main_text_ && topBottomSpace) {
1183 if (pit == 0 && first == 0)
1185 if (pit + 1 == pit_type(pars.size()) &&
1186 end == par.size() &&
1187 !(end > 0 && par.isNewline(end - 1)))
1191 return Dimension(0, maxasc + labeladdon, maxdesc);
1195 // x is an absolute screen coord
1196 // returns the column near the specified x-coordinate of the row
1197 // x is set to the real beginning of this column
1198 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1199 Row const & row, int & x, bool & boundary) const
1201 Buffer const & buffer = bv_->buffer();
1203 /// For the main Text, it is possible that this pit is not
1204 /// yet in the CoordCache when moving cursor up.
1205 /// x Paragraph coordinate is always 0 for main text anyway.
1206 int const xo = origin_.x_;
1208 Paragraph const & par = text_->getPar(pit);
1210 bidi.computeTables(par, buffer, row);
1212 pos_type vc = row.pos();
1213 pos_type end = row.endpos();
1215 Layout const & layout = par.layout();
1217 bool left_side = false;
1219 pos_type body_pos = par.beginOfBody();
1221 double tmpx = row.x;
1222 double last_tmpx = tmpx;
1225 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1228 // check for empty row
1234 // This (rtl_support test) is not needed, but gives
1235 // some speedup if rtl_support == false
1236 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1238 // If lastrow is false, we don't need to compute
1239 // the value of rtl.
1240 bool const rtl_on_lastrow = lastrow ? text_->isRTL(par) : false;
1242 // if the first character is a separator, and we are in RTL
1243 // text, this character will not be painted on screen
1244 // and thus we should not count it and skip to the next. Only
1245 // in freespacing paragraphs, this first character is painted.
1246 if (!par.isFreeSpacing() && par.isSeparator(bidi.vis2log(vc)))
1249 while (vc < end && tmpx <= x) {
1250 c = bidi.vis2log(vc);
1252 if (body_pos > 0 && c == body_pos - 1) {
1253 FontMetrics const & fm = theFontMetrics(
1254 text_->labelFont(par));
1255 tmpx += row.label_hfill + fm.width(layout.labelsep);
1256 if (par.isLineSeparator(body_pos - 1))
1257 tmpx -= singleWidth(pit, body_pos - 1);
1260 tmpx += singleWidth(pit, c);
1261 if (par.isSeparator(c) && c >= body_pos)
1262 tmpx += row.separator;
1266 if ((tmpx + last_tmpx) / 2 > x) {
1271 LASSERT(vc <= end, /**/); // This shouldn't happen.
1276 ((rtl_on_lastrow && left_side && vc == row.pos() && x < tmpx - 5) ||
1277 (!rtl_on_lastrow && !left_side && vc == end && x > tmpx + 5))) {
1278 if (!par.isNewline(end - 1))
1280 } else if (vc == row.pos()) {
1281 c = bidi.vis2log(vc);
1282 if (bidi.level(c) % 2 == 1)
1285 c = bidi.vis2log(vc - 1);
1286 bool const rtl = (bidi.level(c) % 2 == 1);
1287 if (left_side == rtl) {
1289 boundary = isRTLBoundary(pit, c);
1293 // I believe this code is not needed anymore (Jug 20050717)
1295 // The following code is necessary because the cursor position past
1296 // the last char in a row is logically equivalent to that before
1297 // the first char in the next row. That's why insets causing row
1298 // divisions -- Newline and display-style insets -- must be treated
1299 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1300 // Newline inset, air gap below:
1301 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1302 if (bidi.level(end -1) % 2 == 0)
1303 tmpx -= singleWidth(pit, end - 1);
1305 tmpx += singleWidth(pit, end - 1);
1309 // Air gap above display inset:
1310 if (row.pos() < end && c >= end && end < par.size()
1311 && par.isInset(end) && par.getInset(end)->display()) {
1314 // Air gap below display inset:
1315 if (row.pos() < end && c >= end && par.isInset(end - 1)
1316 && par.getInset(end - 1)->display()) {
1322 pos_type const col = c - row.pos();
1324 if (!c || end == par.size())
1327 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1332 return min(col, end - 1 - row.pos());
1336 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1338 // We play safe and use parMetrics(pit) to make sure the
1339 // ParagraphMetrics will be redone and OK to use if needed.
1340 // Otherwise we would use an empty ParagraphMetrics in
1341 // upDownInText() while in selection mode.
1342 ParagraphMetrics const & pm = parMetrics(pit);
1344 LASSERT(row < int(pm.rows().size()), /**/);
1346 Row const & r = pm.rows()[row];
1347 return r.pos() + getColumnNearX(pit, r, x, bound);
1351 void TextMetrics::newParMetricsDown()
1353 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1354 pit_type const pit = last.first + 1;
1355 if (pit == int(text_->paragraphs().size()))
1358 // do it and update its position.
1360 par_metrics_[pit].setPosition(last.second.position()
1361 + last.second.descent() + par_metrics_[pit].ascent());
1365 void TextMetrics::newParMetricsUp()
1367 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1368 if (first.first == 0)
1371 pit_type const pit = first.first - 1;
1372 // do it and update its position.
1374 par_metrics_[pit].setPosition(first.second.position()
1375 - first.second.ascent() - par_metrics_[pit].descent());
1378 // y is screen coordinate
1379 pit_type TextMetrics::getPitNearY(int y)
1381 LASSERT(!text_->paragraphs().empty(), return -1);
1382 LASSERT(!par_metrics_.empty(), return -1);
1383 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1385 // look for highest numbered paragraph with y coordinate less than given y
1388 ParMetricsCache::const_iterator it = par_metrics_.begin();
1389 ParMetricsCache::const_iterator et = par_metrics_.end();
1390 ParMetricsCache::const_iterator last = et;
1393 ParagraphMetrics const & pm = it->second;
1395 if (y < it->second.position() - int(pm.ascent())) {
1396 // We are looking for a position that is before the first paragraph in
1397 // the cache (which is in priciple off-screen, that is before the
1400 // We are already at the first paragraph in the inset.
1402 // OK, this is the paragraph we are looking for.
1403 pit = it->first - 1;
1408 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1410 if (y >= last->second.position() + int(pm_last.descent())) {
1411 // We are looking for a position that is after the last paragraph in
1412 // the cache (which is in priciple off-screen), that is before the
1414 pit = last->first + 1;
1415 if (pit == int(text_->paragraphs().size()))
1416 // We are already at the last paragraph in the inset.
1418 // OK, this is the paragraph we are looking for.
1419 newParMetricsDown();
1423 for (; it != et; ++it) {
1424 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1425 << " y: " << it->second.position());
1427 ParagraphMetrics const & pm = par_metrics_[it->first];
1429 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1431 yy = it->second.position();
1435 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1441 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1442 bool assert_in_view, bool up)
1444 ParagraphMetrics const & pm = par_metrics_[pit];
1446 int yy = pm.position() - pm.ascent();
1447 LASSERT(!pm.rows().empty(), /**/);
1448 RowList::const_iterator rit = pm.rows().begin();
1449 RowList::const_iterator rlast = pm.rows().end();
1451 for (; rit != rlast; yy += rit->height(), ++rit)
1452 if (yy + rit->height() > y)
1455 if (assert_in_view) {
1456 if (!up && yy + rit->height() > y) {
1457 if (rit != pm.rows().begin()) {
1460 } else if (pit != 0) {
1463 ParagraphMetrics const & pm2 = par_metrics_[pit];
1464 rit = pm2.rows().end();
1468 } else if (up && yy != y) {
1470 y = yy + rit->height();
1472 } else if (pit < int(text_->paragraphs().size()) - 1) {
1474 newParMetricsDown();
1475 ParagraphMetrics const & pm2 = par_metrics_[pit];
1476 rit = pm2.rows().begin();
1485 // x,y are absolute screen coordinates
1486 // sets cursor recursively descending into nested editable insets
1487 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1488 bool assert_in_view, bool up)
1490 if (lyxerr.debugging(Debug::WORKAREA)) {
1491 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1492 cur.bv().coordCache().dump();
1494 pit_type pit = getPitNearY(y);
1495 LASSERT(pit != -1, return 0);
1497 int yy = y; // is modified by getPitAndRowNearY
1498 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1500 bool bound = false; // is modified by getColumnNearX
1501 int xx = x; // is modified by getColumnNearX
1502 pos_type const pos = row.pos()
1503 + getColumnNearX(pit, row, xx, bound);
1506 cur.boundary(bound);
1509 // try to descend into nested insets
1510 Inset * inset = checkInsetHit(x, yy);
1511 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1513 // Either we deconst editXY or better we move current_font
1514 // and real_current_font to Cursor
1515 // FIXME: what is needed now that current_font and real_current_font
1517 cur.setCurrentFont();
1521 ParagraphList const & pars = text_->paragraphs();
1522 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1524 // This should be just before or just behind the
1525 // cursor position set above.
1526 LASSERT(inset == inset_before
1527 || inset == pars[pit].getInset(pos), return 0);
1529 // Make sure the cursor points to the position before
1531 if (inset == inset_before) {
1533 cur.boundary(false);
1536 // Try to descend recursively inside the inset.
1537 inset = inset->editXY(cur, x, yy);
1539 if (cur.top().text() == text_)
1540 cur.setCurrentFont();
1545 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1547 LASSERT(text_ == cur.text(), /**/);
1548 pit_type pit = getPitNearY(y);
1549 LASSERT(pit != -1, return);
1551 ParagraphMetrics const & pm = par_metrics_[pit];
1553 int yy = pm.position() - pm.ascent();
1554 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1555 " pit: " << pit << " yy: " << yy);
1558 LASSERT(pm.rows().size(), /**/);
1559 for (; r < int(pm.rows().size()) - 1; ++r) {
1560 Row const & row = pm.rows()[r];
1561 if (int(yy + row.height()) > y)
1566 Row const & row = pm.rows()[r];
1568 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1572 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1574 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1576 text_->setCursor(cur, pit, pos, true, bound);
1577 // remember new position.
1582 //takes screen x,y coordinates
1583 Inset * TextMetrics::checkInsetHit(int x, int y)
1585 pit_type pit = getPitNearY(y);
1586 LASSERT(pit != -1, return 0);
1588 Paragraph const & par = text_->paragraphs()[pit];
1589 ParagraphMetrics const & pm = par_metrics_[pit];
1591 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1593 InsetList::const_iterator iit = par.insetList().begin();
1594 InsetList::const_iterator iend = par.insetList().end();
1595 for (; iit != iend; ++iit) {
1596 Inset * inset = iit->inset;
1598 LYXERR(Debug::DEBUG, "examining inset " << inset);
1600 if (!bv_->coordCache().getInsets().has(inset)) {
1601 LYXERR(Debug::DEBUG, "inset has no cached position");
1605 Dimension const & dim = pm.insetDimension(inset);
1606 Point p = bv_->coordCache().getInsets().xy(inset);
1608 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1609 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1612 && x <= p.x_ + dim.wid
1613 && y >= p.y_ - dim.asc
1614 && y <= p.y_ + dim.des) {
1615 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1620 LYXERR(Debug::DEBUG, "No inset hit. ");
1625 int TextMetrics::cursorX(CursorSlice const & sl,
1626 bool boundary) const
1628 LASSERT(sl.text() == text_, /**/);
1629 pit_type const pit = sl.pit();
1630 Paragraph const & par = text_->paragraphs()[pit];
1631 ParagraphMetrics const & pm = par_metrics_[pit];
1632 if (pm.rows().empty())
1635 pos_type ppos = sl.pos();
1636 // Correct position in front of big insets
1637 bool const boundary_correction = ppos != 0 && boundary;
1638 if (boundary_correction)
1641 Row const & row = pm.getRow(sl.pos(), boundary);
1643 pos_type cursor_vpos = 0;
1645 Buffer const & buffer = bv_->buffer();
1648 bidi.computeTables(par, buffer, row);
1650 pos_type const row_pos = row.pos();
1651 pos_type const end = row.endpos();
1652 // Spaces at logical line breaks in bidi text must be skipped during
1653 // cursor positioning. However, they may appear visually in the middle
1654 // of a row; they must be skipped, wherever they are...
1655 // * logically "abc_[HEBREW_\nHEBREW]"
1656 // * visually "abc_[_WERBEH\nWERBEH]"
1657 pos_type skipped_sep_vpos = -1;
1660 cursor_vpos = row_pos;
1661 else if (ppos >= end)
1662 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1663 else if (ppos > row_pos && ppos >= end)
1664 //FIXME: this code is never reached!
1665 // (see http://www.lyx.org/trac/changeset/8251)
1666 // Place cursor after char at (logical) position pos - 1
1667 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1668 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1670 // Place cursor before char at (logical) position ppos
1671 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1672 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1674 pos_type body_pos = par.beginOfBody();
1676 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1679 // check for possible inline completion in this row
1680 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1681 pos_type inlineCompletionVPos = -1;
1682 if (inlineCompletionPos.inTexted()
1683 && inlineCompletionPos.text() == text_
1684 && inlineCompletionPos.pit() == pit
1685 && inlineCompletionPos.pos() - 1 >= row_pos
1686 && inlineCompletionPos.pos() - 1 < end) {
1687 // draw logically behind the previous character
1688 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1691 // Use font span to speed things up, see below
1695 // If the last logical character is a separator, skip it, unless
1696 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1697 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1698 skipped_sep_vpos = bidi.log2vis(end - 1);
1700 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1701 ParagraphList const & pars_ = text_->paragraphs();
1702 if (size_type(pit + 1) < pars_.size()) {
1704 docstring const s = docstring(1, char_type(0x00B6));
1705 x += theFontMetrics(f).width(s);
1709 // Inline completion RTL special case row_pos == cursor_pos:
1710 // "__|b" => cursor_pos is right of __
1711 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1712 font = displayFont(pit, row_pos + 1);
1713 docstring const & completion = bv_->inlineCompletion();
1714 if (font.isRightToLeft() && completion.length() > 0)
1715 x += theFontMetrics(font.fontInfo()).width(completion);
1718 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1719 // Skip the separator which is at the logical end of the row
1720 if (vpos == skipped_sep_vpos)
1722 pos_type pos = bidi.vis2log(vpos);
1723 if (body_pos > 0 && pos == body_pos - 1) {
1724 FontMetrics const & labelfm = theFontMetrics(
1725 text_->labelFont(par));
1726 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1727 if (par.isLineSeparator(body_pos - 1))
1728 x -= singleWidth(pit, body_pos - 1);
1731 // Use font span to speed things up, see above
1732 if (pos < font_span.first || pos > font_span.last) {
1733 font_span = par.fontSpan(pos);
1734 font = displayFont(pit, pos);
1737 x += pm.singleWidth(pos, font);
1739 // Inline completion RTL case:
1740 // "a__|b", __ of b => non-boundary a-pos is right of __
1741 if (vpos + 1 == inlineCompletionVPos
1742 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1743 font = displayFont(pit, vpos + 1);
1744 docstring const & completion = bv_->inlineCompletion();
1745 if (font.isRightToLeft() && completion.length() > 0)
1746 x += theFontMetrics(font.fontInfo()).width(completion);
1749 // Inline completion LTR case:
1750 // "b|__a", __ of b => non-boundary a-pos is in front of __
1751 if (vpos == inlineCompletionVPos
1752 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1753 font = displayFont(pit, vpos);
1754 docstring const & completion = bv_->inlineCompletion();
1755 if (!font.isRightToLeft() && completion.length() > 0)
1756 x += theFontMetrics(font.fontInfo()).width(completion);
1759 if (par.isSeparator(pos) && pos >= body_pos)
1763 // see correction above
1764 if (boundary_correction) {
1765 if (isRTL(sl, boundary))
1766 x -= singleWidth(pit, ppos);
1768 x += singleWidth(pit, ppos);
1775 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1777 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1778 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1779 if (pm.rows().empty())
1783 h -= par_metrics_[0].rows()[0].ascent();
1784 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1785 h += par_metrics_[pit].height();
1788 if (pos && boundary)
1790 size_t const rend = pm.pos2row(pos);
1791 for (size_t rit = 0; rit != rend; ++rit)
1792 h += pm.rows()[rit].height();
1793 h += pm.rows()[rend].ascent();
1798 // the cursor set functions have a special mechanism. When they
1799 // realize you left an empty paragraph, they will delete it.
1801 bool TextMetrics::cursorHome(Cursor & cur)
1803 LASSERT(text_ == cur.text(), /**/);
1804 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1805 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1806 return text_->setCursor(cur, cur.pit(), row.pos());
1810 bool TextMetrics::cursorEnd(Cursor & cur)
1812 LASSERT(text_ == cur.text(), /**/);
1813 // if not on the last row of the par, put the cursor before
1814 // the final space exept if I have a spanning inset or one string
1815 // is so long that we force a break.
1816 pos_type end = cur.textRow().endpos();
1818 // empty text, end-1 is no valid position
1820 bool boundary = false;
1821 if (end != cur.lastpos()) {
1822 if (!cur.paragraph().isLineSeparator(end-1)
1823 && !cur.paragraph().isNewline(end-1))
1828 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1832 void TextMetrics::deleteLineForward(Cursor & cur)
1834 LASSERT(text_ == cur.text(), /**/);
1835 if (cur.lastpos() == 0) {
1836 // Paragraph is empty, so we just go forward
1837 text_->cursorForward(cur);
1840 cur.setSelection(true); // to avoid deletion
1843 // What is this test for ??? (JMarc)
1844 if (!cur.selection())
1845 text_->deleteWordForward(cur);
1847 cap::cutSelection(cur, true, false);
1848 cur.checkBufferStructure();
1853 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1855 ParagraphList const & pars = text_->paragraphs();
1856 return row.endpos() >= pars[pit].size()
1857 && pit + 1 == pit_type(pars.size());
1861 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1863 return row.pos() == 0 && pit == 0;
1867 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1869 LASSERT(pit >= 0, /**/);
1870 LASSERT(pit < int(text_->paragraphs().size()), /**/);
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, /**/);
1881 LASSERT(pit < int(pars.size()), /**/);
1882 Paragraph const & par = pars[pit];
1883 LASSERT(pos >= 0, /**/);
1884 LASSERT(pos <= par.size(), /**/);
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);