2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
31 #include "InsetList.h"
35 #include "MetricsInfo.h"
36 #include "ParagraphParameters.h"
37 #include "ParIterator.h"
38 #include "rowpainter.h"
40 #include "TextClass.h"
42 #include "WordLangTuple.h"
44 #include "insets/InsetText.h"
46 #include "mathed/MacroTable.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
52 #include "support/debug.h"
53 #include "support/docstring_list.h"
54 #include "support/lassert.h"
63 using frontend::FontMetrics;
65 static int numberOfSeparators(Paragraph const & par, Row const & row)
67 pos_type const first = max(row.pos(), par.beginOfBody());
68 pos_type const last = row.endpos() - 1;
70 for (pos_type p = first; p < last; ++p) {
71 if (par.isSeparator(p))
78 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
80 pos_type last = row.endpos() - 1;
81 pos_type first = row.pos();
83 // hfill *DO* count at the beginning of paragraphs!
85 while (first < last && par.isHfill(first))
89 last = min(last, par.beginOfBody());
91 for (pos_type p = first; p < last; ++p) {
99 static int numberOfHfills(Paragraph const & par, Row const & row)
101 pos_type const last = row.endpos();
102 pos_type first = row.pos();
104 // hfill *DO* count at the beginning of paragraphs!
106 while (first < last && par.isHfill(first))
110 first = max(first, par.beginOfBody());
113 for (pos_type p = first; p < last; ++p) {
121 /////////////////////////////////////////////////////////////////////
125 /////////////////////////////////////////////////////////////////////
128 TextMetrics::TextMetrics(BufferView * bv, Text * text)
129 : bv_(bv), text_(text)
132 max_width_ = bv_->workWidth();
133 dim_.wid = max_width_;
139 bool TextMetrics::contains(pit_type pit) const
141 return par_metrics_.find(pit) != par_metrics_.end();
145 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
147 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
152 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
154 ParMetricsCache::const_iterator it = par_metrics_.begin();
155 return make_pair(it->first, &it->second);
159 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
161 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
162 return make_pair(it->first, &it->second);
166 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
168 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
169 if (pmc_it == par_metrics_.end()) {
170 pmc_it = par_metrics_.insert(
171 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
173 if (pmc_it->second.rows().empty() && redo)
175 return pmc_it->second;
179 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
181 LASSERT(mi.base.textwidth > 0, /**/);
182 max_width_ = mi.base.textwidth;
183 // backup old dimension.
184 Dimension const old_dim = dim_;
187 dim_.wid = min_width;
188 pit_type const npar = text_->paragraphs().size();
190 // If there is more than one row, expand the text to
191 // the full allowable width.
192 dim_.wid = max_width_;
194 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
195 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
197 bool changed = false;
199 for (pit_type pit = 0; pit != npar; ++pit) {
200 changed |= redoParagraph(pit);
201 ParagraphMetrics const & pm = par_metrics_[pit];
203 if (dim_.wid < pm.width())
204 dim_.wid = pm.width();
207 dim_.asc = par_metrics_[0].ascent();
208 dim_.des = h - dim_.asc;
209 //lyxerr << "dim_.wid " << dim_.wid << endl;
210 //lyxerr << "dim_.asc " << dim_.asc << endl;
211 //lyxerr << "dim_.des " << dim_.des << endl;
213 changed |= dim_ != old_dim;
219 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
221 return main_text_? pm.rightMargin(*bv_) : 0;
225 int TextMetrics::rightMargin(pit_type const pit) const
227 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
231 void TextMetrics::applyOuterFont(Font & font) const
233 FontInfo lf(font_.fontInfo());
234 lf.reduce(bv_->buffer().params().getFont().fontInfo());
235 font.fontInfo().realize(lf);
239 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
241 LASSERT(pos >= 0, /**/);
243 ParagraphList const & pars = text_->paragraphs();
244 Paragraph const & par = pars[pit];
245 Layout const & layout = par.layout();
246 Buffer const & buffer = bv_->buffer();
248 BufferParams const & params = buffer.params();
249 pos_type const body_pos = par.beginOfBody();
251 // We specialize the 95% common case:
252 if (!par.getDepth()) {
253 Font f = par.getFontSettings(params, pos);
254 if (!text_->isMainText())
256 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
258 FontInfo const & lf = lab ? layout.labelfont : layout.font;
259 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
261 // In case the default family has been customized
262 if (lf.family() == INHERIT_FAMILY)
263 rlf.setFamily(params.getFont().fontInfo().family());
264 f.fontInfo().realize(rlf);
268 // The uncommon case need not be optimized as much
269 FontInfo const & layoutfont = pos < body_pos ?
270 layout.labelfont : layout.font;
272 Font font = par.getFontSettings(params, pos);
273 font.fontInfo().realize(layoutfont);
275 if (!text_->isMainText())
276 applyOuterFont(font);
278 // Realize against environment font information
279 // NOTE: the cast to pit_type should be removed when pit_type
280 // changes to a unsigned integer.
281 if (pit < pit_type(pars.size()))
282 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
284 // Realize with the fonts of lesser depth.
285 font.fontInfo().realize(params.getFont().fontInfo());
291 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
293 if (!lyxrc.rtl_support || !sl.text())
297 if (boundary && sl.pos() > 0)
300 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
304 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
306 // no RTL boundary at paragraph start
307 if (!lyxrc.rtl_support || pos == 0)
310 Font const & left_font = displayFont(pit, pos - 1);
312 return isRTLBoundary(pit, pos, left_font);
316 // isRTLBoundary returns false on a real end-of-line boundary,
317 // because otherwise the two boundary types get mixed up.
318 // This is the whole purpose of this being in TextMetrics.
319 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
320 Font const & font) const
322 if (!lyxrc.rtl_support
323 // no RTL boundary at paragraph start
325 // if the metrics have not been calculated, then we are not
326 // on screen and can safely ignore issues about boundaries.
330 ParagraphMetrics & pm = par_metrics_[pit];
331 // no RTL boundary in empty paragraph
332 if (pm.rows().empty())
335 pos_type endpos = pm.getRow(pos - 1, false).endpos();
336 pos_type startpos = pm.getRow(pos, false).pos();
337 // no RTL boundary at line start:
338 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
340 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
343 Paragraph const & par = text_->getPar(pit);
344 // no RTL boundary at line break:
345 // abc|\n -> move right -> abc\n (and not: abc\n|
347 if (startpos == pos && endpos == pos && endpos != par.size()
348 && (par.isNewline(pos - 1)
349 || par.isLineSeparator(pos - 1)
350 || par.isSeparator(pos - 1)))
353 bool left = font.isVisibleRightToLeft();
355 if (pos == par.size())
356 right = par.isRTL(bv_->buffer().params());
358 right = displayFont(pit, pos).isVisibleRightToLeft();
360 return left != right;
364 bool TextMetrics::redoParagraph(pit_type const pit)
366 Paragraph & par = text_->getPar(pit);
367 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
368 // redoParagraph() recursively inside parMetrics.
369 Dimension old_dim = parMetrics(pit, false).dim();
370 ParagraphMetrics & pm = par_metrics_[pit];
373 Buffer & buffer = bv_->buffer();
374 main_text_ = (text_ == &buffer.text());
375 bool changed = false;
377 // Optimisation: this is used in the next two loops
378 // so better to calculate that once here.
379 int const right_margin = rightMargin(pm);
381 // iterator pointing to paragraph to resolve macros
382 DocIterator parPos = text_->macrocontextPosition();
386 LYXERR(Debug::INFO, "MacroContext not initialised!"
387 << " Going through the buffer again and hope"
388 << " the context is better then.");
389 // FIXME audit updateBuffer calls
390 // This should not be here, but it is not clear yet where else it
392 bv_->buffer().updateBuffer();
393 parPos = text_->macrocontextPosition();
394 LASSERT(!parPos.empty(), /**/);
399 // FIXME: We should always use getFont(), see documentation of
400 // noFontChange() in Inset.h.
401 Font const bufferfont = buffer.params().getFont();
402 InsetList::const_iterator ii = par.insetList().begin();
403 InsetList::const_iterator iend = par.insetList().end();
404 for (; ii != iend; ++ii) {
405 // position already initialized?
406 if (!parPos.empty()) {
407 parPos.pos() = ii->pos;
409 // A macro template would normally not be visible
410 // by itself. But the tex macro semantics allow
411 // recursion, so we artifically take the context
412 // after the macro template to simulate this.
413 if (ii->inset->lyxCode() == MATHMACRO_CODE)
417 // do the metric calculation
419 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
421 Font const & font = ii->inset->noFontChange() ?
422 bufferfont : displayFont(pit, ii->pos);
423 MacroContext mc(&buffer, parPos);
424 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
425 ii->inset->metrics(mi, dim);
426 Dimension const old_dim = pm.insetDimension(ii->inset);
427 if (old_dim != dim) {
428 pm.setInsetDimension(ii->inset, dim);
433 par.setBeginOfBody();
435 size_t row_index = 0;
436 // maximum pixel width of a row
437 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
440 pos_type end = rowBreakPoint(width, pit, first);
441 if (row_index || end < par.size())
442 // If there is more than one row, expand the text to
443 // the full allowable width. This setting here is needed
444 // for the computeRowMetrics() below.
445 dim_.wid = max_width_;
447 dim = rowHeight(pit, first, end);
448 dim.wid = rowWidth(right_margin, pit, first, end);
449 if (row_index == pm.rows().size())
450 pm.rows().push_back(Row());
451 Row & row = pm.rows()[row_index];
452 row.setChanged(false);
455 row.setDimension(dim);
456 int const max_row_width = max(dim_.wid, dim.wid);
457 computeRowMetrics(pit, row, max_row_width);
461 pm.dim().wid = max(pm.dim().wid, dim.wid);
462 pm.dim().des += dim.height();
463 } while (first < par.size());
465 if (row_index < pm.rows().size())
466 pm.rows().resize(row_index);
468 // Make sure that if a par ends in newline, there is one more row
470 if (first > 0 && par.isNewline(first - 1)) {
471 Dimension dim = rowHeight(pit, first, first);
472 dim.wid = rowWidth(right_margin, pit, first, first);
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);
482 pm.dim().des += dim.height();
485 pm.dim().asc += pm.rows()[0].ascent();
486 pm.dim().des -= pm.rows()[0].ascent();
488 changed |= old_dim.height() != pm.dim().height();
494 void TextMetrics::computeRowMetrics(pit_type const pit,
495 Row & row, int width) const
500 Paragraph const & par = text_->getPar(pit);
502 double w = width - row.width();
503 // FIXME: put back this assertion when the crash on new doc is solved.
504 //LASSERT(w >= 0, /**/);
506 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
507 //lyxerr << "row.width() " << row.width() << endl;
508 //lyxerr << "w " << w << endl;
510 bool const is_rtl = text_->isRTL(par);
512 row.x = rightMargin(pit);
514 row.x = leftMargin(max_width_, pit, row.pos());
516 // is there a manual margin with a manual label
517 Layout const & layout = par.layout();
519 if (layout.margintype == MARGIN_MANUAL
520 && layout.labeltype == LABEL_MANUAL) {
521 /// We might have real hfills in the label part
522 int nlh = numberOfLabelHfills(par, row);
524 // A manual label par (e.g. List) has an auto-hfill
525 // between the label text and the body of the
527 // But we don't want to do this auto hfill if the par
532 if (nlh && !par.getLabelWidthString().empty())
533 row.label_hfill = labelFill(pit, row) / double(nlh);
537 // are there any hfills in the row?
538 if (int const nh = numberOfHfills(par, row)) {
540 hfill = w / double(nh);
541 // we don't have to look at the alignment if it is ALIGN_LEFT and
542 // if the row is already larger then the permitted width as then
543 // we force the LEFT_ALIGN'edness!
544 } else if (int(row.width()) < max_width_) {
545 // is it block, flushleft or flushright?
546 // set x how you need it
548 if (par.params().align() == LYX_ALIGN_LAYOUT)
549 align = layout.align;
551 align = par.params().align();
553 // handle alignment inside tabular cells
554 Inset const & owner = text_->inset();
555 switch (owner.contentAlignment()) {
556 case LYX_ALIGN_CENTER:
558 case LYX_ALIGN_RIGHT:
559 if (align == LYX_ALIGN_NONE
560 || align == LYX_ALIGN_BLOCK)
561 align = owner.contentAlignment();
564 // unchanged (use align)
568 // Display-style insets should always be on a centered row
569 if (Inset const * inset = par.getInset(row.pos())) {
570 switch (inset->display()) {
571 case Inset::AlignLeft:
572 align = LYX_ALIGN_BLOCK;
574 case Inset::AlignCenter:
575 align = LYX_ALIGN_CENTER;
578 // unchanged (use align)
580 case Inset::AlignRight:
581 align = LYX_ALIGN_RIGHT;
587 case LYX_ALIGN_BLOCK: {
588 int const ns = numberOfSeparators(par, row);
589 bool disp_inset = false;
590 if (row.endpos() < par.size()) {
591 Inset const * in = par.getInset(row.endpos());
593 disp_inset = in->display();
595 // If we have separators, this is not the last row of a
596 // par, does not end in newline, and is not row above a
597 // display inset... then stretch it
599 && row.endpos() < par.size()
600 && !par.isNewline(row.endpos() - 1)
603 row.separator = w / ns;
604 //lyxerr << "row.separator " << row.separator << endl;
605 //lyxerr << "ns " << ns << endl;
611 case LYX_ALIGN_RIGHT:
614 case LYX_ALIGN_CENTER:
621 pos_type body_pos = par.beginOfBody();
622 pos_type end = row.endpos();
625 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
627 row.x += theFontMetrics(text_->labelFont(par)).
628 width(layout.labelsep);
630 row.x += row.label_hfill;
634 pos_type const endpos = row.endpos();
635 pos_type body_pos = par.beginOfBody();
637 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
640 ParagraphMetrics & pm = par_metrics_[pit];
641 InsetList::const_iterator ii = par.insetList().begin();
642 InsetList::const_iterator iend = par.insetList().end();
643 for ( ; ii != iend; ++ii) {
644 if (ii->pos >= endpos || ii->pos < row.pos()
645 || (ii->inset->lyxCode() != SPACE_CODE ||
646 !ii->inset->isStretchableSpace()))
648 Dimension dim = row.dimension();
649 if (pm.hfillExpansion(row, ii->pos))
650 dim.wid = int(ii->pos >= body_pos ?
651 max(hfill, 5.0) : row.label_hfill);
654 // Cache the inset dimension.
655 bv_->coordCache().insets().add(ii->inset, dim);
656 pm.setInsetDimension(ii->inset, dim);
661 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
663 Paragraph const & par = text_->getPar(pit);
665 pos_type last = par.beginOfBody();
666 LASSERT(last > 0, /**/);
668 // -1 because a label ends with a space that is in the label
671 // a separator at this end does not count
672 if (par.isLineSeparator(last))
676 for (pos_type i = row.pos(); i <= last; ++i)
677 w += singleWidth(pit, i);
679 docstring const & label = par.params().labelWidthString();
683 FontMetrics const & fm
684 = theFontMetrics(text_->labelFont(par));
686 return max(0, fm.width(label) - w);
690 // this needs special handling - only newlines count as a break point
691 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
693 pos_type const end = par.size();
696 if (par.isNewline(i))
703 int TextMetrics::labelEnd(pit_type const pit) const
705 // labelEnd is only needed if the layout fills a flushleft label.
706 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
708 // return the beginning of the body
709 return leftMargin(max_width_, pit);
715 * Calling Text::getFont is slow. While rebreaking we scan a
716 * paragraph from left to right calling getFont for every char. This
717 * simple class address this problem by hidding an optimization trick
718 * (not mine btw -AB): the font is reused in the whole font span. The
719 * class handles transparently the "hidden" (not part of the fontlist)
720 * label font (as getFont does).
726 FontIterator(TextMetrics const & tm,
727 Paragraph const & par, pit_type pit, pos_type pos)
728 : tm_(tm), par_(par), pit_(pit), pos_(pos),
729 font_(tm.displayFont(pit, pos)),
730 endspan_(par.fontSpan(pos).last),
731 bodypos_(par.beginOfBody())
735 Font const & operator*() const { return font_; }
738 FontIterator & operator++()
741 if (pos_ > endspan_ || pos_ == bodypos_) {
742 font_ = tm_.displayFont(pit_, pos_);
743 endspan_ = par_.fontSpan(pos_).last;
749 Font * operator->() { return &font_; }
753 TextMetrics const & tm_;
755 Paragraph const & par_;
770 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
773 ParagraphMetrics const & pm = par_metrics_[pit];
774 Paragraph const & par = text_->getPar(pit);
775 pos_type const end = par.size();
776 if (pos == end || width < 0)
779 Layout const & layout = par.layout();
781 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
782 return addressBreakPoint(pos, par);
784 pos_type const body_pos = par.beginOfBody();
786 // check for possible inline completion
787 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
788 pos_type inlineCompletionLPos = -1;
789 if (inlineCompletionPos.inTexted()
790 && inlineCompletionPos.text() == text_
791 && inlineCompletionPos.pit() == pit) {
792 // draw logically behind the previous character
793 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
796 // Now we iterate through until we reach the right margin
797 // or the end of the par, then choose the possible break
800 int label_end = labelEnd(pit);
801 int const left = leftMargin(max_width_, pit, pos);
804 // pixel width since last breakpoint
807 docstring const s(1, char_type(0x00B6));
809 int par_marker_width = theFontMetrics(f).width(s);
811 FontIterator fi = FontIterator(*this, par, pit, pos);
812 pos_type point = end;
815 ParagraphList const & pars_ = text_->paragraphs();
816 bool const draw_par_end_marker = lyxrc.paragraph_markers
817 && size_type(pit + 1) < pars_.size();
819 for ( ; i < end; ++i, ++fi) {
820 int thiswidth = pm.singleWidth(i, *fi);
822 if (draw_par_end_marker && i == end - 1)
823 // enlarge the last character to hold the end-of-par marker
824 thiswidth += par_marker_width;
826 // add inline completion width
827 if (inlineCompletionLPos == i) {
828 docstring const & completion = bv_->inlineCompletion();
829 if (completion.length() > 0)
830 thiswidth += theFontMetrics(*fi).width(completion);
833 // add the auto-hfill from label end to the body
834 if (body_pos && i == body_pos) {
835 FontMetrics const & fm = theFontMetrics(
836 text_->labelFont(par));
837 int add = fm.width(layout.labelsep);
838 if (par.isLineSeparator(i - 1))
839 add -= singleWidth(pit, i - 1);
841 add = max(add, label_end - x);
846 chunkwidth += thiswidth;
848 // break before a character that will fall off
849 // the right of the row
851 // if no break before, break here
852 if (point == end || chunkwidth >= width - left) {
858 // exit on last registered breakpoint:
862 if (par.isNewline(i)) {
866 Inset const * inset = 0;
869 if ((inset = par.getInset(i + 1)) && inset->display()) {
874 if ((inset = par.getInset(i)) && inset->display()) {
880 inset = par.getInset(i);
881 if (!inset || inset->isChar()) {
882 // some insets are line separators too
883 if (par.isLineSeparator(i)) {
884 // register breakpoint:
891 // maybe found one, but the par is short enough.
892 if (i == end && x < width)
895 // manual labels cannot be broken in LaTeX. But we
896 // want to make our on-screen rendering of footnotes
898 if (body_pos && point < body_pos)
905 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
906 pos_type const first, pos_type const end) const
908 // get the pure distance
909 ParagraphMetrics const & pm = par_metrics_[pit];
910 Paragraph const & par = text_->getPar(pit);
911 int w = leftMargin(max_width_, pit, first);
912 int label_end = labelEnd(pit);
914 // check for possible inline completion
915 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
916 pos_type inlineCompletionLPos = -1;
917 if (inlineCompletionPos.inTexted()
918 && inlineCompletionPos.text() == text_
919 && inlineCompletionPos.pit() == pit) {
920 // draw logically behind the previous character
921 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
924 pos_type const body_pos = par.beginOfBody();
928 FontIterator fi = FontIterator(*this, par, pit, i);
929 for ( ; i < end; ++i, ++fi) {
930 if (body_pos > 0 && i == body_pos) {
931 FontMetrics const & fm = theFontMetrics(
932 text_->labelFont(par));
933 w += fm.width(par.layout().labelsep);
934 if (par.isLineSeparator(i - 1))
935 w -= singleWidth(pit, i - 1);
936 w = max(w, label_end);
939 // a line separator at the end of a line (but not at the end of a
940 // paragraph) will not be drawn and should therefore not count for
942 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
943 w += pm.singleWidth(i, *fi);
945 // add inline completion width
946 if (inlineCompletionLPos == i) {
947 docstring const & completion = bv_->inlineCompletion();
948 if (completion.length() > 0)
949 w += theFontMetrics(*fi).width(completion);
954 // count the paragraph end marker.
955 if (end == par.size() && lyxrc.paragraph_markers) {
956 ParagraphList const & pars_ = text_->paragraphs();
957 if (size_type(pit + 1) < pars_.size()) {
958 // enlarge the last character to hold the
960 docstring const s(1, char_type(0x00B6));
962 w += theFontMetrics(f).width(s);
966 if (body_pos > 0 && body_pos >= end) {
967 FontMetrics const & fm = theFontMetrics(
968 text_->labelFont(par));
969 w += fm.width(par.layout().labelsep);
970 if (end > 0 && par.isLineSeparator(end - 1))
971 w -= singleWidth(pit, end - 1);
972 w = max(w, label_end);
975 return w + right_margin;
979 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
980 pos_type const end, bool topBottomSpace) const
982 Paragraph const & par = text_->getPar(pit);
983 // get the maximum ascent and the maximum descent
984 double layoutasc = 0;
985 double layoutdesc = 0;
986 double const dh = defaultRowHeight();
988 // ok, let us initialize the maxasc and maxdesc value.
989 // Only the fontsize count. The other properties
990 // are taken from the layoutfont. Nicer on the screen :)
991 Layout const & layout = par.layout();
993 // as max get the first character of this row then it can
994 // increase but not decrease the height. Just some point to
995 // start with so we don't have to do the assignment below too
997 Buffer const & buffer = bv_->buffer();
998 Font font = displayFont(pit, first);
999 FontSize const tmpsize = font.fontInfo().size();
1000 font.fontInfo() = text_->layoutFont(pit);
1001 FontSize const size = font.fontInfo().size();
1002 font.fontInfo().setSize(tmpsize);
1004 FontInfo labelfont = text_->labelFont(par);
1006 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1007 FontMetrics const & fontmetrics = theFontMetrics(font);
1009 // these are minimum values
1010 double const spacing_val = layout.spacing.getValue()
1011 * text_->spacing(par);
1012 //lyxerr << "spacing_val = " << spacing_val << endl;
1013 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1014 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1016 // insets may be taller
1017 ParagraphMetrics const & pm = par_metrics_[pit];
1018 InsetList::const_iterator ii = par.insetList().begin();
1019 InsetList::const_iterator iend = par.insetList().end();
1020 for ( ; ii != iend; ++ii) {
1021 if (ii->pos >= first && ii->pos < end) {
1022 Dimension const & dim = pm.insetDimension(ii->inset);
1023 maxasc = max(maxasc, dim.ascent());
1024 maxdesc = max(maxdesc, dim.descent());
1028 // Check if any custom fonts are larger (Asger)
1029 // This is not completely correct, but we can live with the small,
1030 // cosmetic error for now.
1034 par.highestFontInRange(first, end, size);
1035 if (maxsize > font.fontInfo().size()) {
1036 // use standard paragraph font with the maximal size
1037 FontInfo maxfont = font.fontInfo();
1038 maxfont.setSize(maxsize);
1039 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1040 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1041 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1044 // This is nicer with box insets:
1048 ParagraphList const & pars = text_->paragraphs();
1049 Inset const & inset = text_->inset();
1051 // is it a top line?
1052 if (first == 0 && topBottomSpace) {
1053 BufferParams const & bufparams = buffer.params();
1054 // some parskips VERY EASY IMPLEMENTATION
1055 if (bufparams.paragraph_separation
1056 == BufferParams::ParagraphSkipSeparation
1057 && inset.lyxCode() != ERT_CODE
1058 && inset.lyxCode() != LISTINGS_CODE
1060 && ((layout.isParagraph() && par.getDepth() == 0)
1061 || (pars[pit - 1].layout().isParagraph()
1062 && pars[pit - 1].getDepth() == 0)))
1064 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1067 if (par.params().startOfAppendix())
1068 maxasc += int(3 * dh);
1070 // This is special code for the chapter, since the label of this
1071 // layout is printed in an extra row
1072 if (layout.counter == "chapter"
1073 && !par.params().labelString().empty()) {
1074 labeladdon = int(labelfont_metrics.maxHeight()
1075 * layout.spacing.getValue()
1076 * text_->spacing(par));
1079 // special code for the top label
1080 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1081 || layout.labeltype == LABEL_BIBLIO
1082 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1083 && text_->isFirstInSequence(pit)
1084 && !par.labelString().empty())
1087 labelfont_metrics.maxHeight()
1088 * layout.spacing.getValue()
1089 * text_->spacing(par)
1090 + (layout.topsep + layout.labelbottomsep) * dh);
1093 // Add the layout spaces, for example before and after
1094 // a section, or between the items of a itemize or enumerate
1097 pit_type prev = text_->depthHook(pit, par.getDepth());
1098 Paragraph const & prevpar = pars[prev];
1100 && prevpar.layout() == layout
1101 && prevpar.getDepth() == par.getDepth()
1102 && prevpar.getLabelWidthString()
1103 == par.getLabelWidthString()) {
1104 layoutasc = layout.itemsep * dh;
1105 } else if (pit != 0 || first != 0) {
1106 if (layout.topsep > 0)
1107 layoutasc = layout.topsep * dh;
1110 prev = text_->outerHook(pit);
1111 if (prev != pit_type(pars.size())) {
1112 maxasc += int(pars[prev].layout().parsep * dh);
1113 } else if (pit != 0) {
1114 Paragraph const & prevpar = pars[pit - 1];
1115 if (prevpar.getDepth() != 0 ||
1116 prevpar.layout() == layout) {
1117 maxasc += int(layout.parsep * dh);
1122 // is it a bottom line?
1123 if (end >= par.size() && topBottomSpace) {
1124 // add the layout spaces, for example before and after
1125 // a section, or between the items of a itemize or enumerate
1127 pit_type nextpit = pit + 1;
1128 if (nextpit != pit_type(pars.size())) {
1129 pit_type cpit = pit;
1133 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1134 usual = pars[cpit].layout().bottomsep * dh;
1135 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1136 if (pars[cpit].layout() != pars[nextpit].layout()
1137 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1139 unusual = pars[cpit].layout().bottomsep * dh;
1141 layoutdesc = max(unusual, usual);
1142 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1143 if (pars[cpit].layout() != pars[nextpit].layout()
1144 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1145 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1150 // incalculate the layout spaces
1151 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1152 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1154 // FIXME: the correct way is to do the following is to move the
1155 // following code in another method specially tailored for the
1156 // main Text. The following test is thus bogus.
1157 // Top and bottom margin of the document (only at top-level)
1158 if (main_text_ && topBottomSpace) {
1159 if (pit == 0 && first == 0)
1161 if (pit + 1 == pit_type(pars.size()) &&
1162 end == par.size() &&
1163 !(end > 0 && par.isNewline(end - 1)))
1167 return Dimension(0, maxasc + labeladdon, maxdesc);
1171 // x is an absolute screen coord
1172 // returns the column near the specified x-coordinate of the row
1173 // x is set to the real beginning of this column
1174 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1175 Row const & row, int & x, bool & boundary) const
1177 Buffer const & buffer = bv_->buffer();
1179 /// For the main Text, it is possible that this pit is not
1180 /// yet in the CoordCache when moving cursor up.
1181 /// x Paragraph coordinate is always 0 for main text anyway.
1182 int const xo = origin_.x_;
1184 Paragraph const & par = text_->getPar(pit);
1186 bidi.computeTables(par, buffer, row);
1188 pos_type vc = row.pos();
1189 pos_type end = row.endpos();
1191 Layout const & layout = par.layout();
1193 bool left_side = false;
1195 pos_type body_pos = par.beginOfBody();
1197 double tmpx = row.x;
1198 double last_tmpx = tmpx;
1201 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1204 // check for empty row
1210 // This (rtl_support test) is not needed, but gives
1211 // some speedup if rtl_support == false
1212 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1214 // If lastrow is false, we don't need to compute
1215 // the value of rtl.
1216 bool const rtl = lastrow ? text_->isRTL(par) : false;
1218 // if the first character is a separator, and we are in RTL
1219 // text, this character will not be painted on screen
1220 // and thus we should not count it and skip to the next.
1221 if (rtl && par.isSeparator(bidi.vis2log(vc)))
1224 while (vc < end && tmpx <= x) {
1225 c = bidi.vis2log(vc);
1227 if (body_pos > 0 && c == body_pos - 1) {
1228 FontMetrics const & fm = theFontMetrics(
1229 text_->labelFont(par));
1230 tmpx += row.label_hfill + fm.width(layout.labelsep);
1231 if (par.isLineSeparator(body_pos - 1))
1232 tmpx -= singleWidth(pit, body_pos - 1);
1235 tmpx += singleWidth(pit, c);
1236 if (par.isSeparator(c) && c >= body_pos)
1237 tmpx += row.separator;
1241 if ((tmpx + last_tmpx) / 2 > x) {
1246 LASSERT(vc <= end, /**/); // This shouldn't happen.
1251 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1252 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1253 if (!par.isNewline(end - 1))
1255 } else if (vc == row.pos()) {
1256 c = bidi.vis2log(vc);
1257 if (bidi.level(c) % 2 == 1)
1260 c = bidi.vis2log(vc - 1);
1261 bool const rtl = (bidi.level(c) % 2 == 1);
1262 if (left_side == rtl) {
1264 boundary = isRTLBoundary(pit, c);
1268 // I believe this code is not needed anymore (Jug 20050717)
1270 // The following code is necessary because the cursor position past
1271 // the last char in a row is logically equivalent to that before
1272 // the first char in the next row. That's why insets causing row
1273 // divisions -- Newline and display-style insets -- must be treated
1274 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1275 // Newline inset, air gap below:
1276 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1277 if (bidi.level(end -1) % 2 == 0)
1278 tmpx -= singleWidth(pit, end - 1);
1280 tmpx += singleWidth(pit, end - 1);
1284 // Air gap above display inset:
1285 if (row.pos() < end && c >= end && end < par.size()
1286 && par.isInset(end) && par.getInset(end)->display()) {
1289 // Air gap below display inset:
1290 if (row.pos() < end && c >= end && par.isInset(end - 1)
1291 && par.getInset(end - 1)->display()) {
1297 pos_type const col = c - row.pos();
1299 if (!c || end == par.size())
1302 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1307 return min(col, end - 1 - row.pos());
1311 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1313 // We play safe and use parMetrics(pit) to make sure the
1314 // ParagraphMetrics will be redone and OK to use if needed.
1315 // Otherwise we would use an empty ParagraphMetrics in
1316 // upDownInText() while in selection mode.
1317 ParagraphMetrics const & pm = parMetrics(pit);
1319 LASSERT(row < int(pm.rows().size()), /**/);
1321 Row const & r = pm.rows()[row];
1322 return r.pos() + getColumnNearX(pit, r, x, bound);
1326 void TextMetrics::newParMetricsDown()
1328 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1329 pit_type const pit = last.first + 1;
1330 if (pit == int(text_->paragraphs().size()))
1333 // do it and update its position.
1335 par_metrics_[pit].setPosition(last.second.position()
1336 + last.second.descent() + par_metrics_[pit].ascent());
1340 void TextMetrics::newParMetricsUp()
1342 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1343 if (first.first == 0)
1346 pit_type const pit = first.first - 1;
1347 // do it and update its position.
1349 par_metrics_[pit].setPosition(first.second.position()
1350 - first.second.ascent() - par_metrics_[pit].descent());
1353 // y is screen coordinate
1354 pit_type TextMetrics::getPitNearY(int y)
1356 LASSERT(!text_->paragraphs().empty(), return -1);
1357 LASSERT(!par_metrics_.empty(), return -1);
1358 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1360 // look for highest numbered paragraph with y coordinate less than given y
1363 ParMetricsCache::const_iterator it = par_metrics_.begin();
1364 ParMetricsCache::const_iterator et = par_metrics_.end();
1365 ParMetricsCache::const_iterator last = et; last--;
1367 ParagraphMetrics const & pm = it->second;
1369 if (y < it->second.position() - int(pm.ascent())) {
1370 // We are looking for a position that is before the first paragraph in
1371 // the cache (which is in priciple off-screen, that is before the
1374 // We are already at the first paragraph in the inset.
1376 // OK, this is the paragraph we are looking for.
1377 pit = it->first - 1;
1382 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1384 if (y >= last->second.position() + int(pm_last.descent())) {
1385 // We are looking for a position that is after the last paragraph in
1386 // the cache (which is in priciple off-screen), that is before the
1388 pit = last->first + 1;
1389 if (pit == int(text_->paragraphs().size()))
1390 // We are already at the last paragraph in the inset.
1392 // OK, this is the paragraph we are looking for.
1393 newParMetricsDown();
1397 for (; it != et; ++it) {
1398 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1399 << " y: " << it->second.position());
1401 ParagraphMetrics const & pm = par_metrics_[it->first];
1403 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1405 yy = it->second.position();
1409 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1415 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1416 bool assert_in_view, bool up)
1418 ParagraphMetrics const & pm = par_metrics_[pit];
1420 int yy = pm.position() - pm.ascent();
1421 LASSERT(!pm.rows().empty(), /**/);
1422 RowList::const_iterator rit = pm.rows().begin();
1423 RowList::const_iterator rlast = pm.rows().end();
1425 for (; rit != rlast; yy += rit->height(), ++rit)
1426 if (yy + rit->height() > y)
1429 if (assert_in_view) {
1430 if (!up && yy + rit->height() > y) {
1431 if (rit != pm.rows().begin()) {
1434 } else if (pit != 0) {
1437 ParagraphMetrics const & pm2 = par_metrics_[pit];
1438 rit = pm2.rows().end();
1442 } else if (up && yy != y) {
1444 y = yy + rit->height();
1446 } else if (pit < int(text_->paragraphs().size()) - 1) {
1448 newParMetricsDown();
1449 ParagraphMetrics const & pm2 = par_metrics_[pit];
1450 rit = pm2.rows().begin();
1459 // x,y are absolute screen coordinates
1460 // sets cursor recursively descending into nested editable insets
1461 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1462 bool assert_in_view, bool up)
1464 if (lyxerr.debugging(Debug::WORKAREA)) {
1465 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1466 cur.bv().coordCache().dump();
1468 pit_type pit = getPitNearY(y);
1469 LASSERT(pit != -1, return 0);
1471 int yy = y; // is modified by getPitAndRowNearY
1472 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1474 bool bound = false; // is modified by getColumnNearX
1475 int xx = x; // is modified by getColumnNearX
1476 pos_type const pos = row.pos()
1477 + getColumnNearX(pit, row, xx, bound);
1480 cur.boundary(bound);
1483 // try to descend into nested insets
1484 Inset * inset = checkInsetHit(x, yy);
1485 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1487 // Either we deconst editXY or better we move current_font
1488 // and real_current_font to Cursor
1489 // FIXME: what is needed now that current_font and real_current_font
1491 cur.setCurrentFont();
1495 ParagraphList const & pars = text_->paragraphs();
1496 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1498 // This should be just before or just behind the
1499 // cursor position set above.
1500 LASSERT(inset == inset_before
1501 || inset == pars[pit].getInset(pos), /**/);
1503 // Make sure the cursor points to the position before
1505 if (inset == inset_before) {
1507 cur.boundary(false);
1510 // Try to descend recursively inside the inset.
1511 inset = inset->editXY(cur, x, yy);
1513 if (cur.top().text() == text_)
1514 cur.setCurrentFont();
1519 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1521 LASSERT(text_ == cur.text(), /**/);
1522 pit_type pit = getPitNearY(y);
1523 LASSERT(pit != -1, return);
1525 ParagraphMetrics const & pm = par_metrics_[pit];
1527 int yy = pm.position() - pm.ascent();
1528 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1529 " pit: " << pit << " yy: " << yy);
1532 LASSERT(pm.rows().size(), /**/);
1533 for (; r < int(pm.rows().size()) - 1; ++r) {
1534 Row const & row = pm.rows()[r];
1535 if (int(yy + row.height()) > y)
1540 Row const & row = pm.rows()[r];
1542 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1546 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1548 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1550 text_->setCursor(cur, pit, pos, true, bound);
1551 // remember new position.
1556 //takes screen x,y coordinates
1557 Inset * TextMetrics::checkInsetHit(int x, int y)
1559 pit_type pit = getPitNearY(y);
1560 LASSERT(pit != -1, return 0);
1562 Paragraph const & par = text_->paragraphs()[pit];
1563 ParagraphMetrics const & pm = par_metrics_[pit];
1565 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1567 InsetList::const_iterator iit = par.insetList().begin();
1568 InsetList::const_iterator iend = par.insetList().end();
1569 for (; iit != iend; ++iit) {
1570 Inset * inset = iit->inset;
1572 LYXERR(Debug::DEBUG, "examining inset " << inset);
1574 if (!bv_->coordCache().getInsets().has(inset)) {
1575 LYXERR(Debug::DEBUG, "inset has no cached position");
1579 Dimension const & dim = pm.insetDimension(inset);
1580 Point p = bv_->coordCache().getInsets().xy(inset);
1582 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1583 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1586 && x <= p.x_ + dim.wid
1587 && y >= p.y_ - dim.asc
1588 && y <= p.y_ + dim.des) {
1589 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1594 LYXERR(Debug::DEBUG, "No inset hit. ");
1599 int TextMetrics::cursorX(CursorSlice const & sl,
1600 bool boundary) const
1602 LASSERT(sl.text() == text_, /**/);
1603 pit_type const pit = sl.pit();
1604 Paragraph const & par = text_->paragraphs()[pit];
1605 ParagraphMetrics const & pm = par_metrics_[pit];
1606 if (pm.rows().empty())
1609 pos_type ppos = sl.pos();
1610 // Correct position in front of big insets
1611 bool const boundary_correction = ppos != 0 && boundary;
1612 if (boundary_correction)
1615 Row const & row = pm.getRow(sl.pos(), boundary);
1617 pos_type cursor_vpos = 0;
1619 Buffer const & buffer = bv_->buffer();
1622 bidi.computeTables(par, buffer, row);
1624 pos_type const row_pos = row.pos();
1625 pos_type const end = row.endpos();
1626 // Spaces at logical line breaks in bidi text must be skipped during
1627 // cursor positioning. However, they may appear visually in the middle
1628 // of a row; they must be skipped, wherever they are...
1629 // * logically "abc_[HEBREW_\nHEBREW]"
1630 // * visually "abc_[_WERBEH\nWERBEH]"
1631 pos_type skipped_sep_vpos = -1;
1634 cursor_vpos = row_pos;
1635 else if (ppos >= end)
1636 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1637 else if (ppos > row_pos && ppos >= end)
1638 //FIXME: this code is never reached!
1639 // (see http://www.lyx.org/trac/changeset/8251)
1640 // Place cursor after char at (logical) position pos - 1
1641 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1642 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1644 // Place cursor before char at (logical) position ppos
1645 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1646 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1648 pos_type body_pos = par.beginOfBody();
1650 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1653 // check for possible inline completion in this row
1654 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1655 pos_type inlineCompletionVPos = -1;
1656 if (inlineCompletionPos.inTexted()
1657 && inlineCompletionPos.text() == text_
1658 && inlineCompletionPos.pit() == pit
1659 && inlineCompletionPos.pos() - 1 >= row_pos
1660 && inlineCompletionPos.pos() - 1 < end) {
1661 // draw logically behind the previous character
1662 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1665 // Use font span to speed things up, see below
1669 // If the last logical character is a separator, skip it, unless
1670 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1671 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1672 skipped_sep_vpos = bidi.log2vis(end - 1);
1674 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1675 ParagraphList const & pars_ = text_->paragraphs();
1676 if (size_type(pit + 1) < pars_.size()) {
1678 docstring const s = docstring(1, char_type(0x00B6));
1679 x += theFontMetrics(f).width(s);
1683 // Inline completion RTL special case row_pos == cursor_pos:
1684 // "__|b" => cursor_pos is right of __
1685 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1686 font = displayFont(pit, row_pos + 1);
1687 docstring const & completion = bv_->inlineCompletion();
1688 if (font.isRightToLeft() && completion.length() > 0)
1689 x += theFontMetrics(font.fontInfo()).width(completion);
1692 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1693 // Skip the separator which is at the logical end of the row
1694 if (vpos == skipped_sep_vpos)
1696 pos_type pos = bidi.vis2log(vpos);
1697 if (body_pos > 0 && pos == body_pos - 1) {
1698 FontMetrics const & labelfm = theFontMetrics(
1699 text_->labelFont(par));
1700 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1701 if (par.isLineSeparator(body_pos - 1))
1702 x -= singleWidth(pit, body_pos - 1);
1705 // Use font span to speed things up, see above
1706 if (pos < font_span.first || pos > font_span.last) {
1707 font_span = par.fontSpan(pos);
1708 font = displayFont(pit, pos);
1711 x += pm.singleWidth(pos, font);
1713 // Inline completion RTL case:
1714 // "a__|b", __ of b => non-boundary a-pos is right of __
1715 if (vpos + 1 == inlineCompletionVPos
1716 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1717 font = displayFont(pit, vpos + 1);
1718 docstring const & completion = bv_->inlineCompletion();
1719 if (font.isRightToLeft() && completion.length() > 0)
1720 x += theFontMetrics(font.fontInfo()).width(completion);
1723 // Inline completion LTR case:
1724 // "b|__a", __ of b => non-boundary a-pos is in front of __
1725 if (vpos == inlineCompletionVPos
1726 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1727 font = displayFont(pit, vpos);
1728 docstring const & completion = bv_->inlineCompletion();
1729 if (!font.isRightToLeft() && completion.length() > 0)
1730 x += theFontMetrics(font.fontInfo()).width(completion);
1733 if (par.isSeparator(pos) && pos >= body_pos)
1737 // see correction above
1738 if (boundary_correction) {
1739 if (isRTL(sl, boundary))
1740 x -= singleWidth(pit, ppos);
1742 x += singleWidth(pit, ppos);
1749 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1751 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1752 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1753 if (pm.rows().empty())
1757 h -= par_metrics_[0].rows()[0].ascent();
1758 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1759 h += par_metrics_[pit].height();
1762 if (pos && boundary)
1764 size_t const rend = pm.pos2row(pos);
1765 for (size_t rit = 0; rit != rend; ++rit)
1766 h += pm.rows()[rit].height();
1767 h += pm.rows()[rend].ascent();
1772 // the cursor set functions have a special mechanism. When they
1773 // realize you left an empty paragraph, they will delete it.
1775 bool TextMetrics::cursorHome(Cursor & cur)
1777 LASSERT(text_ == cur.text(), /**/);
1778 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1779 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1780 return text_->setCursor(cur, cur.pit(), row.pos());
1784 bool TextMetrics::cursorEnd(Cursor & cur)
1786 LASSERT(text_ == cur.text(), /**/);
1787 // if not on the last row of the par, put the cursor before
1788 // the final space exept if I have a spanning inset or one string
1789 // is so long that we force a break.
1790 pos_type end = cur.textRow().endpos();
1792 // empty text, end-1 is no valid position
1794 bool boundary = false;
1795 if (end != cur.lastpos()) {
1796 if (!cur.paragraph().isLineSeparator(end-1)
1797 && !cur.paragraph().isNewline(end-1))
1802 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1806 void TextMetrics::deleteLineForward(Cursor & cur)
1808 LASSERT(text_ == cur.text(), /**/);
1809 if (cur.lastpos() == 0) {
1810 // Paragraph is empty, so we just go forward
1811 text_->cursorForward(cur);
1814 cur.setSelection(true); // to avoid deletion
1817 // What is this test for ??? (JMarc)
1818 if (!cur.selection())
1819 text_->deleteWordForward(cur);
1821 cap::cutSelection(cur, true, false);
1822 cur.checkBufferStructure();
1827 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1829 ParagraphList const & pars = text_->paragraphs();
1830 return row.endpos() >= pars[pit].size()
1831 && pit + 1 == pit_type(pars.size());
1835 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1837 return row.pos() == 0 && pit == 0;
1841 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1843 LASSERT(pit >= 0, /**/);
1844 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1845 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1849 int TextMetrics::leftMargin(int max_width,
1850 pit_type const pit, pos_type const pos) const
1852 ParagraphList const & pars = text_->paragraphs();
1854 LASSERT(pit >= 0, /**/);
1855 LASSERT(pit < int(pars.size()), /**/);
1856 Paragraph const & par = pars[pit];
1857 LASSERT(pos >= 0, /**/);
1858 LASSERT(pos <= par.size(), /**/);
1859 Buffer const & buffer = bv_->buffer();
1860 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1861 DocumentClass const & tclass = buffer.params().documentClass();
1862 Layout const & layout = par.layout();
1864 docstring parindent = layout.parindent;
1868 if (text_->isMainText())
1869 l_margin += bv_->leftMargin();
1871 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1872 tclass.leftmargin());
1874 if (par.getDepth() != 0) {
1875 // find the next level paragraph
1876 pit_type newpar = text_->outerHook(pit);
1877 if (newpar != pit_type(pars.size())) {
1878 if (pars[newpar].layout().isEnvironment()) {
1879 l_margin = leftMargin(max_width, newpar);
1881 if (tclass.isDefaultLayout(par.layout())
1882 || tclass.isPlainLayout(par.layout())) {
1883 if (pars[newpar].params().noindent())
1886 parindent = pars[newpar].layout().parindent;
1891 // This happens after sections in standard classes. The 1.3.x
1892 // code compared depths too, but it does not seem necessary
1894 if (tclass.isDefaultLayout(par.layout())
1895 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1898 FontInfo const labelfont = text_->labelFont(par);
1899 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1901 switch (layout.margintype) {
1902 case MARGIN_DYNAMIC:
1903 if (!layout.leftmargin.empty()) {
1904 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1907 if (!par.labelString().empty()) {
1908 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1909 l_margin += labelfont_metrics.width(par.labelString());
1910 l_margin += labelfont_metrics.width(layout.labelsep);
1914 case MARGIN_MANUAL: {
1915 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1916 // The width of an empty par, even with manual label, should be 0
1917 if (!par.empty() && pos >= par.beginOfBody()) {
1918 if (!par.getLabelWidthString().empty()) {
1919 docstring labstr = par.getLabelWidthString();
1920 l_margin += labelfont_metrics.width(labstr);
1921 l_margin += labelfont_metrics.width(layout.labelsep);
1927 case MARGIN_STATIC: {
1928 l_margin += theFontMetrics(buffer.params().getFont()).
1929 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1933 case MARGIN_FIRST_DYNAMIC:
1934 if (layout.labeltype == LABEL_MANUAL) {
1935 // if we are at position 0, we are never in the body
1936 if (pos > 0 && pos >= par.beginOfBody())
1937 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1939 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1941 // Special case to fix problems with
1943 || (layout.labeltype == LABEL_STATIC
1944 && layout.latextype == LATEX_ENVIRONMENT
1945 && !text_->isFirstInSequence(pit))) {
1946 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1947 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1948 && layout.labeltype != LABEL_BIBLIO
1949 && layout.labeltype !=
1950 LABEL_CENTERED_TOP_ENVIRONMENT) {
1951 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1952 l_margin += labelfont_metrics.width(layout.labelsep);
1953 l_margin += labelfont_metrics.width(par.labelString());
1957 case MARGIN_RIGHT_ADDRESS_BOX: {
1959 // ok, a terrible hack. The left margin depends on the widest
1960 // row in this paragraph.
1961 RowList::iterator rit = par.rows().begin();
1962 RowList::iterator end = par.rows().end();
1963 // FIXME: This is wrong.
1964 int minfill = max_width;
1965 for ( ; rit != end; ++rit)
1966 if (rit->fill() < minfill)
1967 minfill = rit->fill();
1968 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1969 l_margin += minfill;
1971 // also wrong, but much shorter.
1972 l_margin += max_width / 2;
1977 if (!par.params().leftIndent().zero())
1978 l_margin += par.params().leftIndent().inPixels(max_width);
1982 if (par.params().align() == LYX_ALIGN_LAYOUT)
1983 align = layout.align;
1985 align = par.params().align();
1987 // set the correct parindent
1989 && (layout.labeltype == LABEL_NO_LABEL
1990 || layout.labeltype == LABEL_TOP_ENVIRONMENT
1991 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1992 || (layout.labeltype == LABEL_STATIC
1993 && layout.latextype == LATEX_ENVIRONMENT
1994 && !text_->isFirstInSequence(pit)))
1995 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1996 && !par.params().noindent()
1997 // in some insets, paragraphs are never indented
1998 && !text_->inset().neverIndent()
1999 // display style insets are always centered, omit indentation
2002 && par.getInset(pos)->display())
2003 && (!(tclass.isDefaultLayout(par.layout())
2004 || tclass.isPlainLayout(par.layout()))
2005 || buffer.params().paragraph_separation
2006 == BufferParams::ParagraphIndentSeparation)
2009 // use the parindent of the layout when the default indentation is
2010 // used otherwise use the indentation set in the document settings
2011 if (buffer.params().getIndentation().asLyXCommand() == "default")
2012 l_margin += theFontMetrics(
2013 buffer.params().getFont()).signedWidth(parindent);
2015 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2022 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2024 ParagraphMetrics const & pm = par_metrics_[pit];
2026 return pm.singleWidth(pos, displayFont(pit, pos));
2030 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2032 if (par_metrics_.empty())
2038 ParMetricsCache::iterator it = par_metrics_.begin();
2039 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2040 y -= it->second.ascent();
2041 for (; it != pm_end; ++it) {
2042 ParagraphMetrics const & pmi = it->second;
2044 pit_type const pit = it->first;
2045 // Save the paragraph position in the cache.
2046 it->second.setPosition(y);
2047 drawParagraph(pi, pit, x, y);
2053 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2055 BufferParams const & bparams = bv_->buffer().params();
2056 ParagraphMetrics const & pm = par_metrics_[pit];
2057 if (pm.rows().empty())
2061 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2062 int const ww = bv_->workHeight();
2063 size_t const nrows = pm.rows().size();
2065 Cursor const & cur = bv_->cursor();
2066 DocIterator sel_beg = cur.selectionBegin();
2067 DocIterator sel_end = cur.selectionEnd();
2068 bool selection = cur.selection()
2069 // This is our text.
2070 && cur.text() == text_
2071 // if the anchor is outside, this is not our selection
2072 && cur.normalAnchor().text() == text_
2073 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2075 // We store the begin and end pos of the selection relative to this par
2076 DocIterator sel_beg_par = cur.selectionBegin();
2077 DocIterator sel_end_par = cur.selectionEnd();
2079 // We care only about visible selection.
2081 if (pit != sel_beg.pit()) {
2082 sel_beg_par.pit() = pit;
2083 sel_beg_par.pos() = 0;
2085 if (pit != sel_end.pit()) {
2086 sel_end_par.pit() = pit;
2087 sel_end_par.pos() = sel_end_par.lastpos();
2091 for (size_t i = 0; i != nrows; ++i) {
2093 Row const & row = pm.rows()[i];
2097 bool const inside = (y + row.descent() >= 0
2098 && y - row.ascent() < ww);
2099 // It is not needed to draw on screen if we are not inside.
2100 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2101 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2104 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2106 row.setSelection(-1, -1);
2108 // The row knows nothing about the paragraph, so we have to check
2109 // whether this row is the first or last and update the margins.
2110 if (row.selection()) {
2111 if (row.sel_beg == 0)
2112 row.begin_margin_sel = sel_beg.pit() < pit;
2113 if (row.sel_end == sel_end_par.lastpos())
2114 row.end_margin_sel = sel_end.pit() > pit;
2117 // Row signature; has row changed since last paint?
2118 row.setCrc(pm.computeRowSignature(row, bparams));
2119 bool row_has_changed = row.changed();
2121 // Take this opportunity to spellcheck the row contents.
2122 if (row_has_changed && lyxrc.spellcheck_continuously) {
2123 text_->getPar(pit).spellCheck();
2126 // Don't paint the row if a full repaint has not been requested
2127 // and if it has not changed.
2128 if (!pi.full_repaint && !row_has_changed) {
2129 // Paint only the insets if the text itself is
2131 rp.paintOnlyInsets();
2136 // Clear background of this row if paragraph background was not
2137 // already cleared because of a full repaint.
2138 if (!pi.full_repaint && row_has_changed) {
2139 pi.pain.fillRectangle(x, y - row.ascent(),
2140 width(), row.height(), pi.background_color);
2143 // Instrumentation for testing row cache (see also
2145 if (lyxerr.debugging(Debug::PAINTING) && inside
2146 && (row.selection() || pi.full_repaint || row_has_changed)) {
2147 string const foreword = text_->isMainText() ?
2148 "main text redraw " : "inset text redraw: ";
2149 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2150 << " row_selection=" << row.selection()
2151 << " full_repaint=" << pi.full_repaint
2152 << " row_has_changed=" << row_has_changed);
2155 // Backup full_repaint status and force full repaint
2156 // for inner insets as the Row has been cleared out.
2157 bool tmp = pi.full_repaint;
2158 pi.full_repaint = true;
2160 rp.paintSelection();
2163 rp.paintChangeBar();
2164 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2165 if (i == 0 && !is_rtl)
2167 if (i == nrows - 1 && is_rtl)
2170 if (i == nrows - 1 && !is_rtl)
2172 if (i == 0 && is_rtl)
2176 // Restore full_repaint status.
2177 pi.full_repaint = tmp;
2179 // Re-enable screen drawing for future use of the painter.
2180 pi.pain.setDrawingEnabled(original_drawing_state);
2182 //LYXERR(Debug::PAINTING, ".");
2186 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2187 Dimension & dim) const
2189 Cursor const & bvcur = cur.bv().cursor();
2191 // get word in front of cursor
2192 docstring word = text_->previousWord(bvcur.top());
2193 DocIterator wordStart = bvcur;
2194 wordStart.pos() -= word.length();
2196 // get position on screen of the word start and end
2197 //FIXME: Is it necessary to explicitly set this to false?
2198 wordStart.boundary(false);
2199 Point lxy = cur.bv().getPos(wordStart);
2200 Point rxy = cur.bv().getPos(bvcur);
2202 // calculate dimensions of the word
2203 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2204 dim.wid = abs(rxy.x_ - lxy.x_);
2206 // calculate position of word
2208 x = min(rxy.x_, lxy.x_);
2210 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2211 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2214 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2216 // ParagraphMetrics const & pm = par_metrics_[pit];
2217 // Row const & r = pm.rows()[row];
2223 int defaultRowHeight()
2225 return int(theFontMetrics(sane_font).maxHeight() * 1.2);