2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
30 #include "FuncRequest.h"
32 #include "InsetList.h"
36 #include "MetricsInfo.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "rowpainter.h"
41 #include "TextClass.h"
43 #include "WordLangTuple.h"
45 #include "insets/InsetText.h"
47 #include "mathed/MacroTable.h"
48 #include "mathed/MathMacroTemplate.h"
50 #include "frontends/FontMetrics.h"
51 #include "frontends/Painter.h"
53 #include "support/debug.h"
54 #include "support/docstring_list.h"
55 #include "support/lassert.h"
64 using frontend::FontMetrics;
66 static int numberOfSeparators(Paragraph const & par, Row const & row)
68 pos_type const first = max(row.pos(), par.beginOfBody());
69 pos_type const last = row.endpos() - 1;
71 for (pos_type p = first; p < last; ++p) {
72 if (par.isSeparator(p))
79 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
81 pos_type last = row.endpos() - 1;
82 pos_type first = row.pos();
84 // hfill *DO* count at the beginning of paragraphs!
86 while (first < last && par.isHfill(first))
90 last = min(last, par.beginOfBody());
92 for (pos_type p = first; p < last; ++p) {
100 static int numberOfHfills(Paragraph const & par, Row const & row)
102 pos_type const last = row.endpos();
103 pos_type first = row.pos();
105 // hfill *DO* count at the beginning of paragraphs!
107 while (first < last && par.isHfill(first))
111 first = max(first, par.beginOfBody());
114 for (pos_type p = first; p < last; ++p) {
122 /////////////////////////////////////////////////////////////////////
126 /////////////////////////////////////////////////////////////////////
129 TextMetrics::TextMetrics(BufferView * bv, Text * text)
130 : bv_(bv), text_(text)
133 max_width_ = bv_->workWidth();
134 dim_.wid = max_width_;
138 //text_->updateBuffer(bv->buffer());
142 bool TextMetrics::contains(pit_type pit) const
144 return par_metrics_.find(pit) != par_metrics_.end();
148 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
150 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
155 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
157 ParMetricsCache::const_iterator it = par_metrics_.begin();
158 return make_pair(it->first, &it->second);
162 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
164 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
165 return make_pair(it->first, &it->second);
169 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
171 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
172 if (pmc_it == par_metrics_.end()) {
173 pmc_it = par_metrics_.insert(
174 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
176 if (pmc_it->second.rows().empty() && redo)
178 return pmc_it->second;
182 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
184 LASSERT(mi.base.textwidth > 0, /**/);
185 max_width_ = mi.base.textwidth;
186 // backup old dimension.
187 Dimension const old_dim = dim_;
190 dim_.wid = min_width;
191 pit_type const npar = text_->paragraphs().size();
193 // If there is more than one row, expand the text to
194 // the full allowable width.
195 dim_.wid = max_width_;
197 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
198 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
200 bool changed = false;
202 for (pit_type pit = 0; pit != npar; ++pit) {
203 changed |= redoParagraph(pit);
204 ParagraphMetrics const & pm = par_metrics_[pit];
206 if (dim_.wid < pm.width())
207 dim_.wid = pm.width();
210 dim_.asc = par_metrics_[0].ascent();
211 dim_.des = h - dim_.asc;
212 //lyxerr << "dim_.wid " << dim_.wid << endl;
213 //lyxerr << "dim_.asc " << dim_.asc << endl;
214 //lyxerr << "dim_.des " << dim_.des << endl;
216 changed |= dim_ != old_dim;
222 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
224 return main_text_? pm.rightMargin(*bv_) : 0;
228 int TextMetrics::rightMargin(pit_type const pit) const
230 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
234 void TextMetrics::applyOuterFont(Font & font) const
236 FontInfo lf(font_.fontInfo());
237 lf.reduce(bv_->buffer().params().getFont().fontInfo());
238 font.fontInfo().realize(lf);
242 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
244 LASSERT(pos >= 0, /**/);
246 ParagraphList const & pars = text_->paragraphs();
247 Paragraph const & par = pars[pit];
248 Layout const & layout = par.layout();
249 Buffer const & buffer = bv_->buffer();
251 BufferParams const & params = buffer.params();
252 pos_type const body_pos = par.beginOfBody();
254 // We specialize the 95% common case:
255 if (!par.getDepth()) {
256 Font f = par.getFontSettings(params, pos);
257 if (!text_->isMainText())
259 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
261 FontInfo const & lf = lab ? layout.labelfont : layout.font;
262 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
264 // In case the default family has been customized
265 if (lf.family() == INHERIT_FAMILY)
266 rlf.setFamily(params.getFont().fontInfo().family());
267 f.fontInfo().realize(rlf);
271 // The uncommon case need not be optimized as much
272 FontInfo const & layoutfont = pos < body_pos ?
273 layout.labelfont : layout.font;
275 Font font = par.getFontSettings(params, pos);
276 font.fontInfo().realize(layoutfont);
278 if (!text_->isMainText())
279 applyOuterFont(font);
281 // Realize against environment font information
282 // NOTE: the cast to pit_type should be removed when pit_type
283 // changes to a unsigned integer.
284 if (pit < pit_type(pars.size()))
285 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
287 // Realize with the fonts of lesser depth.
288 font.fontInfo().realize(params.getFont().fontInfo());
294 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
296 if (!lyxrc.rtl_support || !sl.text())
300 if (boundary && sl.pos() > 0)
303 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
307 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
309 if (!lyxrc.rtl_support)
312 // no RTL boundary at paragraph start
316 Font const & left_font = displayFont(pit, pos - 1);
318 return isRTLBoundary(pit, pos, left_font);
322 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
323 Font const & font) const
325 if (!lyxrc.rtl_support
326 // no RTL boundary at paragraph start
328 // if the metrics have not been calculated, then we are not
329 // on screen and can safely ignore issues about boundaries.
333 ParagraphMetrics & pm = par_metrics_[pit];
334 // no RTL boundary in empty paragraph
335 if (pm.rows().empty())
338 pos_type endpos = pm.getRow(pos - 1, false).endpos();
339 pos_type startpos = pm.getRow(pos, false).pos();
340 // no RTL boundary at line start:
341 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
343 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
346 Paragraph const & par = text_->getPar(pit);
347 // no RTL boundary at line break:
348 // abc|\n -> move right -> abc\n (and not: abc\n|
350 if (startpos == pos && endpos == pos && endpos != par.size()
351 && (par.isNewline(pos - 1)
352 || par.isLineSeparator(pos - 1)
353 || par.isSeparator(pos - 1)))
356 bool left = font.isVisibleRightToLeft();
358 if (pos == par.size())
359 right = par.isRTL(bv_->buffer().params());
361 right = displayFont(pit, pos).isVisibleRightToLeft();
363 return left != right;
367 bool TextMetrics::redoParagraph(pit_type const pit)
369 Paragraph & par = text_->getPar(pit);
370 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
371 // redoParagraph() recursively inside parMetrics.
372 Dimension old_dim = parMetrics(pit, false).dim();
373 ParagraphMetrics & pm = par_metrics_[pit];
376 Buffer & buffer = bv_->buffer();
377 main_text_ = (text_ == &buffer.text());
378 bool changed = false;
380 // FIXME: This check ought to be done somewhere else. It is the reason
381 // why text_ is not const. But then, where else to do it?
382 // Well, how can you end up with either (a) a biblio environment that
383 // has no InsetBibitem or (b) a biblio environment with more than one
384 // InsetBibitem? I think the answer is: when paragraphs are merged;
385 // when layout is set; when material is pasted.
386 int const moveCursor = par.checkBiblio(buffer);
388 const_cast<Cursor &>(bv_->cursor()).posForward();
389 else if (moveCursor < 0) {
390 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
391 if (cursor.pos() >= -moveCursor)
392 cursor.posBackward();
395 // Optimisation: this is used in the next two loops
396 // so better to calculate that once here.
397 int const right_margin = rightMargin(pm);
399 // iterator pointing to paragraph to resolve macros
400 DocIterator parPos = text_->macrocontextPosition();
404 LYXERR(Debug::INFO, "MacroContext not initialised!"
405 << " Going through the buffer again and hope"
406 << " the context is better then.");
407 bv_->buffer().updateBuffer();
408 parPos = text_->macrocontextPosition();
409 LASSERT(!parPos.empty(), /**/);
414 // FIXME: We should always use getFont(), see documentation of
415 // noFontChange() in Inset.h.
416 Font const bufferfont = buffer.params().getFont();
417 InsetList::const_iterator ii = par.insetList().begin();
418 InsetList::const_iterator iend = par.insetList().end();
419 for (; ii != iend; ++ii) {
420 // position already initialized?
421 if (!parPos.empty()) {
422 parPos.pos() = ii->pos;
424 // A macro template would normally not be visible
425 // by itself. But the tex macro semantics allow
426 // recursion, so we artifically take the context
427 // after the macro template to simulate this.
428 if (ii->inset->lyxCode() == MATHMACRO_CODE)
432 // do the metric calculation
434 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
436 Font const & font = ii->inset->noFontChange() ?
437 bufferfont : displayFont(pit, ii->pos);
438 MacroContext mc(&buffer, parPos);
439 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
440 ii->inset->metrics(mi, dim);
441 Dimension const old_dim = pm.insetDimension(ii->inset);
442 if (old_dim != dim) {
443 pm.setInsetDimension(ii->inset, dim);
448 par.setBeginOfBody();
450 size_t row_index = 0;
451 // maximum pixel width of a row
452 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
455 pos_type end = rowBreakPoint(width, pit, first);
456 if (row_index || end < par.size())
457 // If there is more than one row, expand the text to
458 // the full allowable width. This setting here is needed
459 // for the computeRowMetrics() below.
460 dim_.wid = max_width_;
462 dim = rowHeight(pit, first, end);
463 dim.wid = rowWidth(right_margin, pit, first, end);
464 if (row_index == pm.rows().size())
465 pm.rows().push_back(Row());
466 Row & row = pm.rows()[row_index];
467 row.setChanged(false);
470 row.setDimension(dim);
471 int const max_row_width = max(dim_.wid, dim.wid);
472 computeRowMetrics(pit, row, max_row_width);
476 pm.dim().wid = max(pm.dim().wid, dim.wid);
477 pm.dim().des += dim.height();
478 } while (first < par.size());
480 if (row_index < pm.rows().size())
481 pm.rows().resize(row_index);
483 // Make sure that if a par ends in newline, there is one more row
485 if (first > 0 && par.isNewline(first - 1)) {
486 Dimension dim = rowHeight(pit, first, first);
487 dim.wid = rowWidth(right_margin, pit, first, first);
488 if (row_index == pm.rows().size())
489 pm.rows().push_back(Row());
490 Row & row = pm.rows()[row_index];
491 row.setChanged(false);
494 row.setDimension(dim);
495 int const max_row_width = max(dim_.wid, dim.wid);
496 computeRowMetrics(pit, row, max_row_width);
497 pm.dim().des += dim.height();
500 pm.dim().asc += pm.rows()[0].ascent();
501 pm.dim().des -= pm.rows()[0].ascent();
503 changed |= old_dim.height() != pm.dim().height();
509 void TextMetrics::computeRowMetrics(pit_type const pit,
510 Row & row, int width) const
515 Paragraph const & par = text_->getPar(pit);
517 double w = width - row.width();
518 // FIXME: put back this assertion when the crash on new doc is solved.
519 //LASSERT(w >= 0, /**/);
521 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
522 //lyxerr << "row.width() " << row.width() << endl;
523 //lyxerr << "w " << w << endl;
525 bool const is_rtl = text_->isRTL(par);
527 row.x = rightMargin(pit);
529 row.x = leftMargin(max_width_, pit, row.pos());
531 // is there a manual margin with a manual label
532 Layout const & layout = par.layout();
534 if (layout.margintype == MARGIN_MANUAL
535 && layout.labeltype == LABEL_MANUAL) {
536 /// We might have real hfills in the label part
537 int nlh = numberOfLabelHfills(par, row);
539 // A manual label par (e.g. List) has an auto-hfill
540 // between the label text and the body of the
542 // But we don't want to do this auto hfill if the par
547 if (nlh && !par.getLabelWidthString().empty())
548 row.label_hfill = labelFill(pit, row) / double(nlh);
552 // are there any hfills in the row?
553 if (int const nh = numberOfHfills(par, row)) {
555 hfill = w / double(nh);
556 // we don't have to look at the alignment if it is ALIGN_LEFT and
557 // if the row is already larger then the permitted width as then
558 // we force the LEFT_ALIGN'edness!
559 } else if (int(row.width()) < max_width_) {
560 // is it block, flushleft or flushright?
561 // set x how you need it
563 if (par.params().align() == LYX_ALIGN_LAYOUT)
564 align = layout.align;
566 align = par.params().align();
568 // handle alignment inside tabular cells
569 Inset const & owner = text_->inset();
570 switch (owner.contentAlignment()) {
571 case LYX_ALIGN_CENTER:
573 case LYX_ALIGN_RIGHT:
574 if (align == LYX_ALIGN_NONE
575 || align == LYX_ALIGN_BLOCK)
576 align = owner.contentAlignment();
579 // unchanged (use align)
583 // Display-style insets should always be on a centered row
584 if (Inset const * inset = par.getInset(row.pos())) {
585 switch (inset->display()) {
586 case Inset::AlignLeft:
587 align = LYX_ALIGN_BLOCK;
589 case Inset::AlignCenter:
590 align = LYX_ALIGN_CENTER;
593 // unchanged (use align)
595 case Inset::AlignRight:
596 align = LYX_ALIGN_RIGHT;
602 case LYX_ALIGN_BLOCK: {
603 int const ns = numberOfSeparators(par, row);
604 bool disp_inset = false;
605 if (row.endpos() < par.size()) {
606 Inset const * in = par.getInset(row.endpos());
608 disp_inset = in->display();
610 // If we have separators, this is not the last row of a
611 // par, does not end in newline, and is not row above a
612 // display inset... then stretch it
614 && row.endpos() < par.size()
615 && !par.isNewline(row.endpos() - 1)
618 row.separator = w / ns;
619 //lyxerr << "row.separator " << row.separator << endl;
620 //lyxerr << "ns " << ns << endl;
626 case LYX_ALIGN_RIGHT:
629 case LYX_ALIGN_CENTER:
636 pos_type body_pos = par.beginOfBody();
637 pos_type end = row.endpos();
640 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
642 row.x += theFontMetrics(text_->labelFont(par)).
643 width(layout.labelsep);
645 row.x += row.label_hfill;
649 pos_type const endpos = row.endpos();
650 pos_type body_pos = par.beginOfBody();
652 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
655 ParagraphMetrics & pm = par_metrics_[pit];
656 InsetList::const_iterator ii = par.insetList().begin();
657 InsetList::const_iterator iend = par.insetList().end();
658 for ( ; ii != iend; ++ii) {
659 if (ii->pos >= endpos || ii->pos < row.pos()
660 || (ii->inset->lyxCode() != SPACE_CODE ||
661 !ii->inset->isStretchableSpace()))
663 Dimension dim = row.dimension();
664 if (pm.hfillExpansion(row, ii->pos))
665 dim.wid = int(ii->pos >= body_pos ?
666 max(hfill, 5.0) : row.label_hfill);
669 // Cache the inset dimension.
670 bv_->coordCache().insets().add(ii->inset, dim);
671 pm.setInsetDimension(ii->inset, dim);
676 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
678 Paragraph const & par = text_->getPar(pit);
680 pos_type last = par.beginOfBody();
681 LASSERT(last > 0, /**/);
683 // -1 because a label ends with a space that is in the label
686 // a separator at this end does not count
687 if (par.isLineSeparator(last))
691 for (pos_type i = row.pos(); i <= last; ++i)
692 w += singleWidth(pit, i);
694 docstring const & label = par.params().labelWidthString();
698 FontMetrics const & fm
699 = theFontMetrics(text_->labelFont(par));
701 return max(0, fm.width(label) - w);
705 // this needs special handling - only newlines count as a break point
706 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
708 pos_type const end = par.size();
711 if (par.isNewline(i))
718 int TextMetrics::labelEnd(pit_type const pit) const
720 // labelEnd is only needed if the layout fills a flushleft label.
721 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
723 // return the beginning of the body
724 return leftMargin(max_width_, pit);
730 * Calling Text::getFont is slow. While rebreaking we scan a
731 * paragraph from left to right calling getFont for every char. This
732 * simple class address this problem by hidding an optimization trick
733 * (not mine btw -AB): the font is reused in the whole font span. The
734 * class handles transparently the "hidden" (not part of the fontlist)
735 * label font (as getFont does).
741 FontIterator(TextMetrics const & tm,
742 Paragraph const & par, pit_type pit, pos_type pos)
743 : tm_(tm), par_(par), pit_(pit), pos_(pos),
744 font_(tm.displayFont(pit, pos)),
745 endspan_(par.fontSpan(pos).last),
746 bodypos_(par.beginOfBody())
750 Font const & operator*() const { return font_; }
753 FontIterator & operator++()
756 if (pos_ > endspan_ || pos_ == bodypos_) {
757 font_ = tm_.displayFont(pit_, pos_);
758 endspan_ = par_.fontSpan(pos_).last;
764 Font * operator->() { return &font_; }
768 TextMetrics const & tm_;
770 Paragraph const & par_;
785 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
788 ParagraphMetrics const & pm = par_metrics_[pit];
789 Paragraph const & par = text_->getPar(pit);
790 pos_type const end = par.size();
791 if (pos == end || width < 0)
794 Layout const & layout = par.layout();
796 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
797 return addressBreakPoint(pos, par);
799 pos_type const body_pos = par.beginOfBody();
801 // check for possible inline completion
802 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
803 pos_type inlineCompletionLPos = -1;
804 if (inlineCompletionPos.inTexted()
805 && inlineCompletionPos.text() == text_
806 && inlineCompletionPos.pit() == pit) {
807 // draw logically behind the previous character
808 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
811 // Now we iterate through until we reach the right margin
812 // or the end of the par, then choose the possible break
815 int label_end = labelEnd(pit);
816 int const left = leftMargin(max_width_, pit, pos);
819 // pixel width since last breakpoint
822 docstring const s(1, char_type(0x00B6));
824 int par_marker_width = theFontMetrics(f).width(s);
826 FontIterator fi = FontIterator(*this, par, pit, pos);
827 pos_type point = end;
830 ParagraphList const & pars_ = text_->paragraphs();
831 bool const draw_par_end_marker = lyxrc.paragraph_markers
832 && size_type(pit + 1) < pars_.size();
834 for ( ; i < end; ++i, ++fi) {
835 int thiswidth = pm.singleWidth(i, *fi);
837 if (draw_par_end_marker && i == end - 1)
838 // enlarge the last character to hold the end-of-par marker
839 thiswidth += par_marker_width;
841 // add inline completion width
842 if (inlineCompletionLPos == i) {
843 docstring const & completion = bv_->inlineCompletion();
844 if (completion.length() > 0)
845 thiswidth += theFontMetrics(*fi).width(completion);
848 // add the auto-hfill from label end to the body
849 if (body_pos && i == body_pos) {
850 FontMetrics const & fm = theFontMetrics(
851 text_->labelFont(par));
852 int add = fm.width(layout.labelsep);
853 if (par.isLineSeparator(i - 1))
854 add -= singleWidth(pit, i - 1);
856 add = max(add, label_end - x);
861 chunkwidth += thiswidth;
863 // break before a character that will fall off
864 // the right of the row
866 // if no break before, break here
867 if (point == end || chunkwidth >= width - left) {
873 // exit on last registered breakpoint:
877 if (par.isNewline(i)) {
881 Inset const * inset = 0;
884 if ((inset = par.getInset(i + 1)) && inset->display()) {
889 if ((inset = par.getInset(i)) && inset->display()) {
895 inset = par.getInset(i);
896 if (!inset || inset->isChar()) {
897 // some insets are line separators too
898 if (par.isLineSeparator(i)) {
899 // register breakpoint:
906 // maybe found one, but the par is short enough.
907 if (i == end && x < width)
910 // manual labels cannot be broken in LaTeX. But we
911 // want to make our on-screen rendering of footnotes
913 if (body_pos && point < body_pos)
920 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
921 pos_type const first, pos_type const end) const
923 // get the pure distance
924 ParagraphMetrics const & pm = par_metrics_[pit];
925 Paragraph const & par = text_->getPar(pit);
926 int w = leftMargin(max_width_, pit, first);
927 int label_end = labelEnd(pit);
929 // check for possible inline completion
930 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
931 pos_type inlineCompletionLPos = -1;
932 if (inlineCompletionPos.inTexted()
933 && inlineCompletionPos.text() == text_
934 && inlineCompletionPos.pit() == pit) {
935 // draw logically behind the previous character
936 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
939 pos_type const body_pos = par.beginOfBody();
943 FontIterator fi = FontIterator(*this, par, pit, i);
944 for ( ; i < end; ++i, ++fi) {
945 if (body_pos > 0 && i == body_pos) {
946 FontMetrics const & fm = theFontMetrics(
947 text_->labelFont(par));
948 w += fm.width(par.layout().labelsep);
949 if (par.isLineSeparator(i - 1))
950 w -= singleWidth(pit, i - 1);
951 w = max(w, label_end);
954 // a line separator at the end of a line (but not at the end of a
955 // paragraph) will not be drawn and should therefore not count for
957 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
958 w += pm.singleWidth(i, *fi);
960 // add inline completion width
961 if (inlineCompletionLPos == i) {
962 docstring const & completion = bv_->inlineCompletion();
963 if (completion.length() > 0)
964 w += theFontMetrics(*fi).width(completion);
969 // count the paragraph end marker.
970 if (end == par.size() && lyxrc.paragraph_markers) {
971 ParagraphList const & pars_ = text_->paragraphs();
972 if (size_type(pit + 1) < pars_.size()) {
973 // enlarge the last character to hold the
975 docstring const s(1, char_type(0x00B6));
977 w += theFontMetrics(f).width(s);
981 if (body_pos > 0 && body_pos >= end) {
982 FontMetrics const & fm = theFontMetrics(
983 text_->labelFont(par));
984 w += fm.width(par.layout().labelsep);
985 if (end > 0 && par.isLineSeparator(end - 1))
986 w -= singleWidth(pit, end - 1);
987 w = max(w, label_end);
990 return w + right_margin;
994 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
995 pos_type const end, bool topBottomSpace) const
997 Paragraph const & par = text_->getPar(pit);
998 // get the maximum ascent and the maximum descent
999 double layoutasc = 0;
1000 double layoutdesc = 0;
1001 double const dh = defaultRowHeight();
1003 // ok, let us initialize the maxasc and maxdesc value.
1004 // Only the fontsize count. The other properties
1005 // are taken from the layoutfont. Nicer on the screen :)
1006 Layout const & layout = par.layout();
1008 // as max get the first character of this row then it can
1009 // increase but not decrease the height. Just some point to
1010 // start with so we don't have to do the assignment below too
1012 Buffer const & buffer = bv_->buffer();
1013 Font font = displayFont(pit, first);
1014 FontSize const tmpsize = font.fontInfo().size();
1015 font.fontInfo() = text_->layoutFont(pit);
1016 FontSize const size = font.fontInfo().size();
1017 font.fontInfo().setSize(tmpsize);
1019 FontInfo labelfont = text_->labelFont(par);
1021 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1022 FontMetrics const & fontmetrics = theFontMetrics(font);
1024 // these are minimum values
1025 double const spacing_val = layout.spacing.getValue()
1026 * text_->spacing(par);
1027 //lyxerr << "spacing_val = " << spacing_val << endl;
1028 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1029 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1031 // insets may be taller
1032 ParagraphMetrics const & pm = par_metrics_[pit];
1033 InsetList::const_iterator ii = par.insetList().begin();
1034 InsetList::const_iterator iend = par.insetList().end();
1035 for ( ; ii != iend; ++ii) {
1036 if (ii->pos >= first && ii->pos < end) {
1037 Dimension const & dim = pm.insetDimension(ii->inset);
1038 maxasc = max(maxasc, dim.ascent());
1039 maxdesc = max(maxdesc, dim.descent());
1043 // Check if any custom fonts are larger (Asger)
1044 // This is not completely correct, but we can live with the small,
1045 // cosmetic error for now.
1049 par.highestFontInRange(first, end, size);
1050 if (maxsize > font.fontInfo().size()) {
1051 // use standard paragraph font with the maximal size
1052 FontInfo maxfont = font.fontInfo();
1053 maxfont.setSize(maxsize);
1054 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1055 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1056 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1059 // This is nicer with box insets:
1063 ParagraphList const & pars = text_->paragraphs();
1064 Inset const & inset = text_->inset();
1066 // is it a top line?
1067 if (first == 0 && topBottomSpace) {
1068 BufferParams const & bufparams = buffer.params();
1069 // some parskips VERY EASY IMPLEMENTATION
1070 if (bufparams.paragraph_separation
1071 == BufferParams::ParagraphSkipSeparation
1072 && inset.lyxCode() != ERT_CODE
1073 && inset.lyxCode() != LISTINGS_CODE
1075 && ((layout.isParagraph() && par.getDepth() == 0)
1076 || (pars[pit - 1].layout().isParagraph()
1077 && pars[pit - 1].getDepth() == 0)))
1079 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1082 if (par.params().startOfAppendix())
1083 maxasc += int(3 * dh);
1085 // This is special code for the chapter, since the label of this
1086 // layout is printed in an extra row
1087 if (layout.counter == "chapter"
1088 && !par.params().labelString().empty()) {
1089 labeladdon = int(labelfont_metrics.maxHeight()
1090 * layout.spacing.getValue()
1091 * text_->spacing(par));
1094 // special code for the top label
1095 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1096 || layout.labeltype == LABEL_BIBLIO
1097 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1098 && text_->isFirstInSequence(pit)
1099 && !par.labelString().empty())
1102 labelfont_metrics.maxHeight()
1103 * layout.spacing.getValue()
1104 * text_->spacing(par)
1105 + (layout.topsep + layout.labelbottomsep) * dh);
1108 // Add the layout spaces, for example before and after
1109 // a section, or between the items of a itemize or enumerate
1112 pit_type prev = text_->depthHook(pit, par.getDepth());
1113 Paragraph const & prevpar = pars[prev];
1115 && prevpar.layout() == layout
1116 && prevpar.getDepth() == par.getDepth()
1117 && prevpar.getLabelWidthString()
1118 == par.getLabelWidthString()) {
1119 layoutasc = layout.itemsep * dh;
1120 } else if (pit != 0 || first != 0) {
1121 if (layout.topsep > 0)
1122 layoutasc = layout.topsep * dh;
1125 prev = text_->outerHook(pit);
1126 if (prev != pit_type(pars.size())) {
1127 maxasc += int(pars[prev].layout().parsep * dh);
1128 } else if (pit != 0) {
1129 Paragraph const & prevpar = pars[pit - 1];
1130 if (prevpar.getDepth() != 0 ||
1131 prevpar.layout() == layout) {
1132 maxasc += int(layout.parsep * dh);
1137 // is it a bottom line?
1138 if (end >= par.size() && topBottomSpace) {
1139 // add the layout spaces, for example before and after
1140 // a section, or between the items of a itemize or enumerate
1142 pit_type nextpit = pit + 1;
1143 if (nextpit != pit_type(pars.size())) {
1144 pit_type cpit = pit;
1148 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1149 usual = pars[cpit].layout().bottomsep * dh;
1150 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1151 if (pars[cpit].layout() != pars[nextpit].layout()
1152 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1154 unusual = pars[cpit].layout().bottomsep * dh;
1156 layoutdesc = max(unusual, usual);
1157 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1158 if (pars[cpit].layout() != pars[nextpit].layout()
1159 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1160 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1165 // incalculate the layout spaces
1166 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1167 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1169 // FIXME: the correct way is to do the following is to move the
1170 // following code in another method specially tailored for the
1171 // main Text. The following test is thus bogus.
1172 // Top and bottom margin of the document (only at top-level)
1173 if (main_text_ && topBottomSpace) {
1174 if (pit == 0 && first == 0)
1176 if (pit + 1 == pit_type(pars.size()) &&
1177 end == par.size() &&
1178 !(end > 0 && par.isNewline(end - 1)))
1182 return Dimension(0, maxasc + labeladdon, maxdesc);
1186 // x is an absolute screen coord
1187 // returns the column near the specified x-coordinate of the row
1188 // x is set to the real beginning of this column
1189 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1190 Row const & row, int & x, bool & boundary) const
1192 Buffer const & buffer = bv_->buffer();
1194 /// For the main Text, it is possible that this pit is not
1195 /// yet in the CoordCache when moving cursor up.
1196 /// x Paragraph coordinate is always 0 for main text anyway.
1197 int const xo = origin_.x_;
1199 Paragraph const & par = text_->getPar(pit);
1201 bidi.computeTables(par, buffer, row);
1203 pos_type vc = row.pos();
1204 pos_type end = row.endpos();
1206 Layout const & layout = par.layout();
1208 bool left_side = false;
1210 pos_type body_pos = par.beginOfBody();
1212 double tmpx = row.x;
1213 double last_tmpx = tmpx;
1216 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1219 // check for empty row
1225 // if the first character is a separator, we are in RTL
1226 // text. This character will not be painted on screen
1227 // and thus we should not count it and skip to the next.
1228 if (par.isSeparator(bidi.vis2log(vc)))
1231 while (vc < end && tmpx <= x) {
1232 c = bidi.vis2log(vc);
1234 if (body_pos > 0 && c == body_pos - 1) {
1235 FontMetrics const & fm = theFontMetrics(
1236 text_->labelFont(par));
1237 tmpx += row.label_hfill + fm.width(layout.labelsep);
1238 if (par.isLineSeparator(body_pos - 1))
1239 tmpx -= singleWidth(pit, body_pos - 1);
1242 tmpx += singleWidth(pit, c);
1243 if (par.isSeparator(c) && c >= body_pos)
1244 tmpx += row.separator;
1248 if ((tmpx + last_tmpx) / 2 > x) {
1253 LASSERT(vc <= end, /**/); // This shouldn't happen.
1256 // This (rtl_support test) is not needed, but gives
1257 // some speedup if rtl_support == false
1258 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1260 // If lastrow is false, we don't need to compute
1261 // the value of rtl.
1262 bool const rtl = lastrow ? text_->isRTL(par) : false;
1264 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1265 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1266 if (!par.isNewline(end - 1))
1268 } else if (vc == row.pos()) {
1269 c = bidi.vis2log(vc);
1270 if (bidi.level(c) % 2 == 1)
1273 c = bidi.vis2log(vc - 1);
1274 bool const rtl = (bidi.level(c) % 2 == 1);
1275 if (left_side == rtl) {
1277 boundary = isRTLBoundary(pit, c);
1281 // I believe this code is not needed anymore (Jug 20050717)
1283 // The following code is necessary because the cursor position past
1284 // the last char in a row is logically equivalent to that before
1285 // the first char in the next row. That's why insets causing row
1286 // divisions -- Newline and display-style insets -- must be treated
1287 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1288 // Newline inset, air gap below:
1289 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1290 if (bidi.level(end -1) % 2 == 0)
1291 tmpx -= singleWidth(pit, end - 1);
1293 tmpx += singleWidth(pit, end - 1);
1297 // Air gap above display inset:
1298 if (row.pos() < end && c >= end && end < par.size()
1299 && par.isInset(end) && par.getInset(end)->display()) {
1302 // Air gap below display inset:
1303 if (row.pos() < end && c >= end && par.isInset(end - 1)
1304 && par.getInset(end - 1)->display()) {
1310 pos_type const col = c - row.pos();
1312 if (!c || end == par.size())
1315 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1320 return min(col, end - 1 - row.pos());
1324 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1326 // We play safe and use parMetrics(pit) to make sure the
1327 // ParagraphMetrics will be redone and OK to use if needed.
1328 // Otherwise we would use an empty ParagraphMetrics in
1329 // upDownInText() while in selection mode.
1330 ParagraphMetrics const & pm = parMetrics(pit);
1332 LASSERT(row < int(pm.rows().size()), /**/);
1334 Row const & r = pm.rows()[row];
1335 return r.pos() + getColumnNearX(pit, r, x, bound);
1339 void TextMetrics::newParMetricsDown()
1341 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1342 pit_type const pit = last.first + 1;
1343 if (pit == int(text_->paragraphs().size()))
1346 // do it and update its position.
1348 par_metrics_[pit].setPosition(last.second.position()
1349 + last.second.descent() + par_metrics_[pit].ascent());
1353 void TextMetrics::newParMetricsUp()
1355 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1356 if (first.first == 0)
1359 pit_type const pit = first.first - 1;
1360 // do it and update its position.
1362 par_metrics_[pit].setPosition(first.second.position()
1363 - first.second.ascent() - par_metrics_[pit].descent());
1366 // y is screen coordinate
1367 pit_type TextMetrics::getPitNearY(int y)
1369 LASSERT(!text_->paragraphs().empty(), return -1);
1370 LASSERT(!par_metrics_.empty(), return -1);
1371 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1373 // look for highest numbered paragraph with y coordinate less than given y
1376 ParMetricsCache::const_iterator it = par_metrics_.begin();
1377 ParMetricsCache::const_iterator et = par_metrics_.end();
1378 ParMetricsCache::const_iterator last = et; last--;
1380 ParagraphMetrics const & pm = it->second;
1382 if (y < it->second.position() - int(pm.ascent())) {
1383 // We are looking for a position that is before the first paragraph in
1384 // the cache (which is in priciple off-screen, that is before the
1387 // We are already at the first paragraph in the inset.
1389 // OK, this is the paragraph we are looking for.
1390 pit = it->first - 1;
1395 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1397 if (y >= last->second.position() + int(pm_last.descent())) {
1398 // We are looking for a position that is after the last paragraph in
1399 // the cache (which is in priciple off-screen), that is before the
1401 pit = last->first + 1;
1402 if (pit == int(text_->paragraphs().size()))
1403 // We are already at the last paragraph in the inset.
1405 // OK, this is the paragraph we are looking for.
1406 newParMetricsDown();
1410 for (; it != et; ++it) {
1411 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1412 << " y: " << it->second.position());
1414 ParagraphMetrics const & pm = par_metrics_[it->first];
1416 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1418 yy = it->second.position();
1422 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1428 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1429 bool assert_in_view, bool up)
1431 ParagraphMetrics const & pm = par_metrics_[pit];
1433 int yy = pm.position() - pm.ascent();
1434 LASSERT(!pm.rows().empty(), /**/);
1435 RowList::const_iterator rit = pm.rows().begin();
1436 RowList::const_iterator rlast = pm.rows().end();
1438 for (; rit != rlast; yy += rit->height(), ++rit)
1439 if (yy + rit->height() > y)
1442 if (assert_in_view) {
1443 if (!up && yy + rit->height() > y) {
1444 if (rit != pm.rows().begin()) {
1447 } else if (pit != 0) {
1450 ParagraphMetrics const & pm2 = par_metrics_[pit];
1451 rit = pm2.rows().end();
1455 } else if (up && yy != y) {
1457 y = yy + rit->height();
1459 } else if (pit < int(text_->paragraphs().size()) - 1) {
1461 newParMetricsDown();
1462 ParagraphMetrics const & pm2 = par_metrics_[pit];
1463 rit = pm2.rows().begin();
1472 // x,y are absolute screen coordinates
1473 // sets cursor recursively descending into nested editable insets
1474 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1475 bool assert_in_view, bool up)
1477 if (lyxerr.debugging(Debug::WORKAREA)) {
1478 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1479 cur.bv().coordCache().dump();
1481 pit_type pit = getPitNearY(y);
1482 LASSERT(pit != -1, return 0);
1484 int yy = y; // is modified by getPitAndRowNearY
1485 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1487 bool bound = false; // is modified by getColumnNearX
1488 int xx = x; // is modified by getColumnNearX
1489 pos_type const pos = row.pos()
1490 + getColumnNearX(pit, row, xx, bound);
1493 cur.boundary(bound);
1496 // try to descend into nested insets
1497 Inset * inset = checkInsetHit(x, yy);
1498 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1500 // Either we deconst editXY or better we move current_font
1501 // and real_current_font to Cursor
1502 // FIXME: what is needed now that current_font and real_current_font
1504 cur.setCurrentFont();
1508 ParagraphList const & pars = text_->paragraphs();
1509 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1511 // This should be just before or just behind the
1512 // cursor position set above.
1513 LASSERT(inset == inset_before
1514 || inset == pars[pit].getInset(pos), /**/);
1516 // Make sure the cursor points to the position before
1518 if (inset == inset_before) {
1520 cur.boundary(false);
1523 // Try to descend recursively inside the inset.
1524 inset = inset->editXY(cur, x, yy);
1526 if (cur.top().text() == text_)
1527 cur.setCurrentFont();
1532 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1534 LASSERT(text_ == cur.text(), /**/);
1535 pit_type pit = getPitNearY(y);
1536 LASSERT(pit != -1, return);
1538 ParagraphMetrics const & pm = par_metrics_[pit];
1540 int yy = pm.position() - pm.ascent();
1541 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1542 " pit: " << pit << " yy: " << yy);
1545 LASSERT(pm.rows().size(), /**/);
1546 for (; r < int(pm.rows().size()) - 1; ++r) {
1547 Row const & row = pm.rows()[r];
1548 if (int(yy + row.height()) > y)
1553 Row const & row = pm.rows()[r];
1555 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1559 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1561 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1563 text_->setCursor(cur, pit, pos, true, bound);
1564 // remember new position.
1569 //takes screen x,y coordinates
1570 Inset * TextMetrics::checkInsetHit(int x, int y)
1572 pit_type pit = getPitNearY(y);
1573 LASSERT(pit != -1, return 0);
1575 Paragraph const & par = text_->paragraphs()[pit];
1576 ParagraphMetrics const & pm = par_metrics_[pit];
1578 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1580 InsetList::const_iterator iit = par.insetList().begin();
1581 InsetList::const_iterator iend = par.insetList().end();
1582 for (; iit != iend; ++iit) {
1583 Inset * inset = iit->inset;
1585 LYXERR(Debug::DEBUG, "examining inset " << inset);
1587 if (!bv_->coordCache().getInsets().has(inset)) {
1588 LYXERR(Debug::DEBUG, "inset has no cached position");
1592 Dimension const & dim = pm.insetDimension(inset);
1593 Point p = bv_->coordCache().getInsets().xy(inset);
1595 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1596 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1599 && x <= p.x_ + dim.wid
1600 && y >= p.y_ - dim.asc
1601 && y <= p.y_ + dim.des) {
1602 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1607 LYXERR(Debug::DEBUG, "No inset hit. ");
1612 int TextMetrics::cursorX(CursorSlice const & sl,
1613 bool boundary) const
1615 LASSERT(sl.text() == text_, /**/);
1616 pit_type const pit = sl.pit();
1617 Paragraph const & par = text_->paragraphs()[pit];
1618 ParagraphMetrics const & pm = par_metrics_[pit];
1619 if (pm.rows().empty())
1622 pos_type ppos = sl.pos();
1623 // Correct position in front of big insets
1624 bool const boundary_correction = ppos != 0 && boundary;
1625 if (boundary_correction)
1628 Row const & row = pm.getRow(sl.pos(), boundary);
1630 pos_type cursor_vpos = 0;
1632 Buffer const & buffer = bv_->buffer();
1635 bidi.computeTables(par, buffer, row);
1637 pos_type const row_pos = row.pos();
1638 pos_type const end = row.endpos();
1639 // Spaces at logical line breaks in bidi text must be skipped during
1640 // cursor positioning. However, they may appear visually in the middle
1641 // of a row; they must be skipped, wherever they are...
1642 // * logically "abc_[HEBREW_\nHEBREW]"
1643 // * visually "abc_[_WERBEH\nWERBEH]"
1644 pos_type skipped_sep_vpos = -1;
1647 cursor_vpos = row_pos;
1648 else if (ppos >= end)
1649 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1650 else if (ppos > row_pos && ppos >= end)
1651 //FIXME: this code is never reached!
1652 // (see http://www.lyx.org/trac/changeset/8251)
1653 // Place cursor after char at (logical) position pos - 1
1654 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1655 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1657 // Place cursor before char at (logical) position ppos
1658 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1659 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1661 pos_type body_pos = par.beginOfBody();
1663 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1666 // check for possible inline completion in this row
1667 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1668 pos_type inlineCompletionVPos = -1;
1669 if (inlineCompletionPos.inTexted()
1670 && inlineCompletionPos.text() == text_
1671 && inlineCompletionPos.pit() == pit
1672 && inlineCompletionPos.pos() - 1 >= row_pos
1673 && inlineCompletionPos.pos() - 1 < end) {
1674 // draw logically behind the previous character
1675 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1678 // Use font span to speed things up, see below
1682 // If the last logical character is a separator, skip it, unless
1683 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1684 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1685 skipped_sep_vpos = bidi.log2vis(end - 1);
1687 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1688 ParagraphList const & pars_ = text_->paragraphs();
1689 if (size_type(pit + 1) < pars_.size()) {
1691 docstring const s = docstring(1, char_type(0x00B6));
1692 x += theFontMetrics(f).width(s);
1696 // Inline completion RTL special case row_pos == cursor_pos:
1697 // "__|b" => cursor_pos is right of __
1698 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1699 font = displayFont(pit, row_pos + 1);
1700 docstring const & completion = bv_->inlineCompletion();
1701 if (font.isRightToLeft() && completion.length() > 0)
1702 x += theFontMetrics(font.fontInfo()).width(completion);
1705 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1706 // Skip the separator which is at the logical end of the row
1707 if (vpos == skipped_sep_vpos)
1709 pos_type pos = bidi.vis2log(vpos);
1710 if (body_pos > 0 && pos == body_pos - 1) {
1711 FontMetrics const & labelfm = theFontMetrics(
1712 text_->labelFont(par));
1713 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1714 if (par.isLineSeparator(body_pos - 1))
1715 x -= singleWidth(pit, body_pos - 1);
1718 // Use font span to speed things up, see above
1719 if (pos < font_span.first || pos > font_span.last) {
1720 font_span = par.fontSpan(pos);
1721 font = displayFont(pit, pos);
1724 x += pm.singleWidth(pos, font);
1726 // Inline completion RTL case:
1727 // "a__|b", __ of b => non-boundary a-pos is right of __
1728 if (vpos + 1 == inlineCompletionVPos
1729 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1730 font = displayFont(pit, vpos + 1);
1731 docstring const & completion = bv_->inlineCompletion();
1732 if (font.isRightToLeft() && completion.length() > 0)
1733 x += theFontMetrics(font.fontInfo()).width(completion);
1736 // Inline completion LTR case:
1737 // "b|__a", __ of b => non-boundary a-pos is in front of __
1738 if (vpos == inlineCompletionVPos
1739 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1740 font = displayFont(pit, vpos);
1741 docstring const & completion = bv_->inlineCompletion();
1742 if (!font.isRightToLeft() && completion.length() > 0)
1743 x += theFontMetrics(font.fontInfo()).width(completion);
1746 if (par.isSeparator(pos) && pos >= body_pos)
1750 // see correction above
1751 if (boundary_correction) {
1752 if (isRTL(sl, boundary))
1753 x -= singleWidth(pit, ppos);
1755 x += singleWidth(pit, ppos);
1762 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1764 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1765 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1766 if (pm.rows().empty())
1770 h -= par_metrics_[0].rows()[0].ascent();
1771 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1772 h += par_metrics_[pit].height();
1775 if (pos && boundary)
1777 size_t const rend = pm.pos2row(pos);
1778 for (size_t rit = 0; rit != rend; ++rit)
1779 h += pm.rows()[rit].height();
1780 h += pm.rows()[rend].ascent();
1785 // the cursor set functions have a special mechanism. When they
1786 // realize you left an empty paragraph, they will delete it.
1788 bool TextMetrics::cursorHome(Cursor & cur)
1790 LASSERT(text_ == cur.text(), /**/);
1791 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1792 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1793 return text_->setCursor(cur, cur.pit(), row.pos());
1797 bool TextMetrics::cursorEnd(Cursor & cur)
1799 LASSERT(text_ == cur.text(), /**/);
1800 // if not on the last row of the par, put the cursor before
1801 // the final space exept if I have a spanning inset or one string
1802 // is so long that we force a break.
1803 pos_type end = cur.textRow().endpos();
1805 // empty text, end-1 is no valid position
1807 bool boundary = false;
1808 if (end != cur.lastpos()) {
1809 if (!cur.paragraph().isLineSeparator(end-1)
1810 && !cur.paragraph().isNewline(end-1))
1815 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1819 void TextMetrics::deleteLineForward(Cursor & cur)
1821 LASSERT(text_ == cur.text(), /**/);
1822 if (cur.lastpos() == 0) {
1823 // Paragraph is empty, so we just go forward
1824 text_->cursorForward(cur);
1827 cur.setSelection(true); // to avoid deletion
1830 // What is this test for ??? (JMarc)
1831 if (!cur.selection())
1832 text_->deleteWordForward(cur);
1834 cap::cutSelection(cur, true, false);
1835 cur.checkBufferStructure();
1840 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1842 ParagraphList const & pars = text_->paragraphs();
1843 return row.endpos() >= pars[pit].size()
1844 && pit + 1 == pit_type(pars.size());
1848 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1850 return row.pos() == 0 && pit == 0;
1854 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1856 LASSERT(pit >= 0, /**/);
1857 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1858 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1862 int TextMetrics::leftMargin(int max_width,
1863 pit_type const pit, pos_type const pos) const
1865 ParagraphList const & pars = text_->paragraphs();
1867 LASSERT(pit >= 0, /**/);
1868 LASSERT(pit < int(pars.size()), /**/);
1869 Paragraph const & par = pars[pit];
1870 LASSERT(pos >= 0, /**/);
1871 LASSERT(pos <= par.size(), /**/);
1872 Buffer const & buffer = bv_->buffer();
1873 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1874 DocumentClass const & tclass = buffer.params().documentClass();
1875 Layout const & layout = par.layout();
1877 docstring parindent = layout.parindent;
1881 if (text_->isMainText())
1882 l_margin += bv_->leftMargin();
1884 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1885 tclass.leftmargin());
1887 if (par.getDepth() != 0) {
1888 // find the next level paragraph
1889 pit_type newpar = text_->outerHook(pit);
1890 if (newpar != pit_type(pars.size())) {
1891 if (pars[newpar].layout().isEnvironment()) {
1892 l_margin = leftMargin(max_width, newpar);
1894 if (tclass.isDefaultLayout(par.layout())
1895 || tclass.isPlainLayout(par.layout())) {
1896 if (pars[newpar].params().noindent())
1899 parindent = pars[newpar].layout().parindent;
1904 // This happens after sections in standard classes. The 1.3.x
1905 // code compared depths too, but it does not seem necessary
1907 if (tclass.isDefaultLayout(par.layout())
1908 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1911 FontInfo const labelfont = text_->labelFont(par);
1912 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1914 switch (layout.margintype) {
1915 case MARGIN_DYNAMIC:
1916 if (!layout.leftmargin.empty()) {
1917 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1920 if (!par.labelString().empty()) {
1921 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1922 l_margin += labelfont_metrics.width(par.labelString());
1923 l_margin += labelfont_metrics.width(layout.labelsep);
1927 case MARGIN_MANUAL: {
1928 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1929 // The width of an empty par, even with manual label, should be 0
1930 if (!par.empty() && pos >= par.beginOfBody()) {
1931 if (!par.getLabelWidthString().empty()) {
1932 docstring labstr = par.getLabelWidthString();
1933 l_margin += labelfont_metrics.width(labstr);
1934 l_margin += labelfont_metrics.width(layout.labelsep);
1940 case MARGIN_STATIC: {
1941 l_margin += theFontMetrics(buffer.params().getFont()).
1942 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1946 case MARGIN_FIRST_DYNAMIC:
1947 if (layout.labeltype == LABEL_MANUAL) {
1948 // if we are at position 0, we are never in the body
1949 if (pos > 0 && pos >= par.beginOfBody())
1950 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1952 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1954 // Special case to fix problems with
1956 || (layout.labeltype == LABEL_STATIC
1957 && layout.latextype == LATEX_ENVIRONMENT
1958 && !text_->isFirstInSequence(pit))) {
1959 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1960 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1961 && layout.labeltype != LABEL_BIBLIO
1962 && layout.labeltype !=
1963 LABEL_CENTERED_TOP_ENVIRONMENT) {
1964 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1965 l_margin += labelfont_metrics.width(layout.labelsep);
1966 l_margin += labelfont_metrics.width(par.labelString());
1970 case MARGIN_RIGHT_ADDRESS_BOX: {
1972 // ok, a terrible hack. The left margin depends on the widest
1973 // row in this paragraph.
1974 RowList::iterator rit = par.rows().begin();
1975 RowList::iterator end = par.rows().end();
1976 // FIXME: This is wrong.
1977 int minfill = max_width;
1978 for ( ; rit != end; ++rit)
1979 if (rit->fill() < minfill)
1980 minfill = rit->fill();
1981 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1982 l_margin += minfill;
1984 // also wrong, but much shorter.
1985 l_margin += max_width / 2;
1990 if (!par.params().leftIndent().zero())
1991 l_margin += par.params().leftIndent().inPixels(max_width);
1995 if (par.params().align() == LYX_ALIGN_LAYOUT)
1996 align = layout.align;
1998 align = par.params().align();
2000 // set the correct parindent
2002 && (layout.labeltype == LABEL_NO_LABEL
2003 || layout.labeltype == LABEL_TOP_ENVIRONMENT
2004 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
2005 || (layout.labeltype == LABEL_STATIC
2006 && layout.latextype == LATEX_ENVIRONMENT
2007 && !text_->isFirstInSequence(pit)))
2008 && align == LYX_ALIGN_BLOCK
2009 && !par.params().noindent()
2010 // in some insets, paragraphs are never indented
2011 && !text_->inset().neverIndent()
2012 // display style insets are always centered, omit indentation
2015 && par.getInset(pos)->display())
2016 && (!(tclass.isDefaultLayout(par.layout())
2017 || tclass.isPlainLayout(par.layout()))
2018 || buffer.params().paragraph_separation == BufferParams::ParagraphIndentSeparation)
2021 // use the parindent of the layout when the default indentation is used
2022 // otherwise use the indentation set in the document settings
2023 if (buffer.params().getIndentation().asLyXCommand() == "default")
2024 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
2027 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2034 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2036 ParagraphMetrics const & pm = par_metrics_[pit];
2038 return pm.singleWidth(pos, displayFont(pit, pos));
2042 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2044 if (par_metrics_.empty())
2050 ParMetricsCache::iterator it = par_metrics_.begin();
2051 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2052 y -= it->second.ascent();
2053 for (; it != pm_end; ++it) {
2054 ParagraphMetrics const & pmi = it->second;
2056 pit_type const pit = it->first;
2057 // Save the paragraph position in the cache.
2058 it->second.setPosition(y);
2059 drawParagraph(pi, pit, x, y);
2065 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2067 BufferParams const & bparams = bv_->buffer().params();
2068 ParagraphMetrics const & pm = par_metrics_[pit];
2069 if (pm.rows().empty())
2073 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2074 int const ww = bv_->workHeight();
2075 size_t const nrows = pm.rows().size();
2077 Cursor const & cur = bv_->cursor();
2078 DocIterator sel_beg = cur.selectionBegin();
2079 DocIterator sel_end = cur.selectionEnd();
2080 bool selection = cur.selection()
2081 // This is our text.
2082 && cur.text() == text_
2083 // if the anchor is outside, this is not our selection
2084 && cur.anchor().text() == text_
2085 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2087 // We store the begin and end pos of the selection relative to this par
2088 DocIterator sel_beg_par = cur.selectionBegin();
2089 DocIterator sel_end_par = cur.selectionEnd();
2091 // We care only about visible selection.
2093 if (pit != sel_beg.pit()) {
2094 sel_beg_par.pit() = pit;
2095 sel_beg_par.pos() = 0;
2097 if (pit != sel_end.pit()) {
2098 sel_end_par.pit() = pit;
2099 sel_end_par.pos() = sel_end_par.lastpos();
2103 for (size_t i = 0; i != nrows; ++i) {
2105 Row const & row = pm.rows()[i];
2109 bool const inside = (y + row.descent() >= 0
2110 && y - row.ascent() < ww);
2111 // It is not needed to draw on screen if we are not inside.
2112 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2113 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2116 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2118 row.setSelection(-1, -1);
2120 // The row knows nothing about the paragraph, so we have to check
2121 // whether this row is the first or last and update the margins.
2122 if (row.selection()) {
2123 if (row.sel_beg == 0)
2124 row.begin_margin_sel = sel_beg.pit() < pit;
2125 if (row.sel_end == sel_end_par.lastpos())
2126 row.end_margin_sel = sel_end.pit() > pit;
2129 // Row signature; has row changed since last paint?
2130 row.setCrc(pm.computeRowSignature(row, bparams));
2131 bool row_has_changed = row.changed();
2133 // Take this opportunity to spellcheck the row contents.
2134 if (row_has_changed && lyxrc.spellcheck_continuously) {
2136 // dummy variable, not used.
2137 static docstring_list suggestions;
2138 pos_type from = row.pos();
2139 pos_type to = row.endpos();
2140 while (from < row.endpos()) {
2141 text_->getPar(pit).spellCheck(from, to, wl, suggestions, false);
2146 // Don't paint the row if a full repaint has not been requested
2147 // and if it has not changed.
2148 if (!pi.full_repaint && !row_has_changed) {
2149 // Paint only the insets if the text itself is
2151 rp.paintOnlyInsets();
2156 // Clear background of this row if paragraph background was not
2157 // already cleared because of a full repaint.
2158 if (!pi.full_repaint && row_has_changed) {
2159 pi.pain.fillRectangle(x, y - row.ascent(),
2160 width(), row.height(), pi.background_color);
2163 if (row.selection())
2164 drawRowSelection(pi, x, row, cur, pit);
2166 // Instrumentation for testing row cache (see also
2168 if (lyxerr.debugging(Debug::PAINTING) && inside
2169 && (row.selection() || pi.full_repaint || row_has_changed)) {
2170 string const foreword = text_->isMainText() ?
2171 "main text redraw " : "inset text redraw: ";
2172 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2173 << " row_selection=" << row.selection()
2174 << " full_repaint=" << pi.full_repaint
2175 << " row_has_changed=" << row_has_changed);
2178 // Backup full_repaint status and force full repaint
2179 // for inner insets as the Row has been cleared out.
2180 bool tmp = pi.full_repaint;
2181 pi.full_repaint = true;
2184 rp.paintChangeBar();
2185 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2186 if (i == 0 && !is_rtl)
2188 if (i == nrows - 1 && is_rtl)
2191 if (i == nrows - 1 && !is_rtl)
2193 if (i == 0 && is_rtl)
2196 // Restore full_repaint status.
2197 pi.full_repaint = tmp;
2199 // Re-enable screen drawing for future use of the painter.
2200 pi.pain.setDrawingEnabled(original_drawing_state);
2202 //LYXERR(Debug::PAINTING, ".");
2206 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
2207 Cursor const & curs, pit_type pit) const
2209 DocIterator beg = curs.selectionBegin();
2211 beg.pos() = row.sel_beg;
2213 DocIterator end = curs.selectionEnd();
2215 end.pos() = row.sel_end;
2217 bool const begin_boundary = beg.pos() >= row.endpos();
2218 bool const end_boundary = row.sel_end == row.endpos();
2220 DocIterator cur = beg;
2221 cur.boundary(begin_boundary);
2222 int x1 = cursorX(beg.top(), begin_boundary);
2223 int x2 = cursorX(end.top(), end_boundary);
2224 int const y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
2225 int const y2 = y1 + row.height();
2227 int const rm = text_->isMainText() ? bv_->rightMargin() : 0;
2228 int const lm = text_->isMainText() ? bv_->leftMargin() : 0;
2231 if (row.begin_margin_sel) {
2232 if (text_->isRTL(beg.paragraph())) {
2233 pi.pain.fillRectangle(x + x1, y1, width() - rm - x1, y2 - y1,
2236 pi.pain.fillRectangle(x + lm, y1, x1 - lm, y2 - y1,
2241 if (row.end_margin_sel) {
2242 if (text_->isRTL(beg.paragraph())) {
2243 pi.pain.fillRectangle(x + lm, y1, x2 - lm, y2 - y1,
2246 pi.pain.fillRectangle(x + x2, y1, width() - rm - x2, y2 - y1,
2251 // if we are on a boundary from the beginning, it's probably
2252 // a RTL boundary and we jump to the other side directly as this
2253 // segement is 0-size and confuses the logic below
2255 cur.boundary(false);
2257 // go through row and draw from RTL boundary to RTL boundary
2259 bool draw_now = false;
2261 // simplified cursorForward code below which does not
2262 // descend into insets and which does not go into the
2263 // next line. Compare the logic with the original cursorForward
2265 // if left of boundary -> just jump to right side, but
2266 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2267 if (cur.boundary()) {
2268 cur.boundary(false);
2269 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2270 // in front of RTL boundary -> Stay on this side of the boundary
2271 // because: ab|cDDEEFFghi -> abc|DDEEFFghi
2280 if (cur.pos() == row.endpos())
2285 // the previous segment was just drawn, now the next starts
2286 x1 = cursorX(cur.top(), cur.boundary());
2289 if (!(cur < end) || draw_now) {
2290 x2 = cursorX(cur.top(), cur.boundary());
2291 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2294 // reset x1, so it is set again next round (which will be on the
2295 // right side of a boundary or at the selection end)
2302 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2303 Dimension & dim) const
2305 Cursor const & bvcur = cur.bv().cursor();
2307 // get word in front of cursor
2308 docstring word = text_->previousWord(bvcur.top());
2309 DocIterator wordStart = bvcur;
2310 wordStart.pos() -= word.length();
2312 // get position on screen of the word start and end
2313 Point lxy = cur.bv().getPos(wordStart, false);
2314 Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
2316 // calculate dimensions of the word
2317 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2318 dim.wid = abs(rxy.x_ - lxy.x_);
2320 // calculate position of word
2322 x = min(rxy.x_, lxy.x_);
2324 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2325 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2328 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2330 // ParagraphMetrics const & pm = par_metrics_[pit];
2331 // Row const & r = pm.rows()[row];
2337 int defaultRowHeight()
2339 return int(theFontMetrics(sane_font).maxHeight() * 1.2);