2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
31 #include "InsetList.h"
35 #include "MetricsInfo.h"
36 #include "ParagraphParameters.h"
37 #include "ParIterator.h"
38 #include "rowpainter.h"
40 #include "TextClass.h"
42 #include "WordLangTuple.h"
44 #include "insets/InsetText.h"
46 #include "mathed/MacroTable.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
52 #include "support/debug.h"
53 #include "support/docstring_list.h"
54 #include "support/lassert.h"
63 using frontend::FontMetrics;
65 static int numberOfSeparators(Paragraph const & par, Row const & row)
67 pos_type const first = max(row.pos(), par.beginOfBody());
68 pos_type const last = row.endpos() - 1;
70 for (pos_type p = first; p < last; ++p) {
71 if (par.isSeparator(p))
78 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
80 pos_type last = row.endpos() - 1;
81 pos_type first = row.pos();
83 // hfill *DO* count at the beginning of paragraphs!
85 while (first < last && par.isHfill(first))
89 last = min(last, par.beginOfBody());
91 for (pos_type p = first; p < last; ++p) {
99 static int numberOfHfills(Paragraph const & par, Row const & row)
101 pos_type const last = row.endpos();
102 pos_type first = row.pos();
104 // hfill *DO* count at the beginning of paragraphs!
106 while (first < last && par.isHfill(first))
110 first = max(first, par.beginOfBody());
113 for (pos_type p = first; p < last; ++p) {
121 /////////////////////////////////////////////////////////////////////
125 /////////////////////////////////////////////////////////////////////
128 TextMetrics::TextMetrics(BufferView * bv, Text * text)
129 : bv_(bv), text_(text)
132 max_width_ = bv_->workWidth();
133 dim_.wid = max_width_;
139 bool TextMetrics::contains(pit_type pit) const
141 return par_metrics_.find(pit) != par_metrics_.end();
145 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
147 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
152 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
154 ParMetricsCache::const_iterator it = par_metrics_.begin();
155 return make_pair(it->first, &it->second);
159 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
161 LASSERT(!par_metrics_.empty(), /**/);
162 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
163 return make_pair(it->first, &it->second);
167 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
169 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
170 if (pmc_it == par_metrics_.end()) {
171 pmc_it = par_metrics_.insert(
172 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
174 if (pmc_it->second.rows().empty() && redo)
176 return pmc_it->second;
180 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
182 LASSERT(mi.base.textwidth > 0, /**/);
183 max_width_ = mi.base.textwidth;
184 // backup old dimension.
185 Dimension const old_dim = dim_;
188 dim_.wid = min_width;
189 pit_type const npar = text_->paragraphs().size();
191 // If there is more than one row, expand the text to
192 // the full allowable width.
193 dim_.wid = max_width_;
195 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
196 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
198 bool changed = false;
200 for (pit_type pit = 0; pit != npar; ++pit) {
201 changed |= redoParagraph(pit);
202 ParagraphMetrics const & pm = par_metrics_[pit];
204 if (dim_.wid < pm.width())
205 dim_.wid = pm.width();
208 dim_.asc = par_metrics_[0].ascent();
209 dim_.des = h - dim_.asc;
210 //lyxerr << "dim_.wid " << dim_.wid << endl;
211 //lyxerr << "dim_.asc " << dim_.asc << endl;
212 //lyxerr << "dim_.des " << dim_.des << endl;
214 changed |= dim_ != old_dim;
220 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
222 return main_text_? pm.rightMargin(*bv_) : 0;
226 int TextMetrics::rightMargin(pit_type const pit) const
228 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
232 void TextMetrics::applyOuterFont(Font & font) const
234 FontInfo lf(font_.fontInfo());
235 lf.reduce(bv_->buffer().params().getFont().fontInfo());
236 font.fontInfo().realize(lf);
240 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
242 LASSERT(pos >= 0, /**/);
244 ParagraphList const & pars = text_->paragraphs();
245 Paragraph const & par = pars[pit];
246 Layout const & layout = par.layout();
247 Buffer const & buffer = bv_->buffer();
249 BufferParams const & params = buffer.params();
250 pos_type const body_pos = par.beginOfBody();
252 // We specialize the 95% common case:
253 if (!par.getDepth()) {
254 Font f = par.getFontSettings(params, pos);
255 if (!text_->isMainText())
257 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
259 FontInfo const & lf = lab ? layout.labelfont : layout.font;
260 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
262 // In case the default family has been customized
263 if (lf.family() == INHERIT_FAMILY)
264 rlf.setFamily(params.getFont().fontInfo().family());
265 f.fontInfo().realize(rlf);
269 // The uncommon case need not be optimized as much
270 FontInfo const & layoutfont = pos < body_pos ?
271 layout.labelfont : layout.font;
273 Font font = par.getFontSettings(params, pos);
274 font.fontInfo().realize(layoutfont);
276 if (!text_->isMainText())
277 applyOuterFont(font);
279 // Realize against environment font information
280 // NOTE: the cast to pit_type should be removed when pit_type
281 // changes to a unsigned integer.
282 if (pit < pit_type(pars.size()))
283 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
285 // Realize with the fonts of lesser depth.
286 font.fontInfo().realize(params.getFont().fontInfo());
292 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
294 if (!lyxrc.rtl_support || !sl.text())
298 if (boundary && sl.pos() > 0)
301 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
305 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
307 // no RTL boundary at paragraph start
308 if (!lyxrc.rtl_support || pos == 0)
311 Font const & left_font = displayFont(pit, pos - 1);
313 return isRTLBoundary(pit, pos, left_font);
317 // isRTLBoundary returns false on a real end-of-line boundary,
318 // because otherwise the two boundary types get mixed up.
319 // This is the whole purpose of this being in TextMetrics.
320 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
321 Font const & font) const
323 if (!lyxrc.rtl_support
324 // no RTL boundary at paragraph start
326 // if the metrics have not been calculated, then we are not
327 // on screen and can safely ignore issues about boundaries.
331 ParagraphMetrics & pm = par_metrics_[pit];
332 // no RTL boundary in empty paragraph
333 if (pm.rows().empty())
336 pos_type endpos = pm.getRow(pos - 1, false).endpos();
337 pos_type startpos = pm.getRow(pos, false).pos();
338 // no RTL boundary at line start:
339 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
341 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
344 Paragraph const & par = text_->getPar(pit);
345 // no RTL boundary at line break:
346 // abc|\n -> move right -> abc\n (and not: abc\n|
348 if (startpos == pos && endpos == pos && endpos != par.size()
349 && (par.isNewline(pos - 1)
350 || par.isLineSeparator(pos - 1)
351 || par.isSeparator(pos - 1)))
354 bool left = font.isVisibleRightToLeft();
356 if (pos == par.size())
357 right = par.isRTL(bv_->buffer().params());
359 right = displayFont(pit, pos).isVisibleRightToLeft();
361 return left != right;
365 bool TextMetrics::redoParagraph(pit_type const pit)
367 Paragraph & par = text_->getPar(pit);
368 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
369 // redoParagraph() recursively inside parMetrics.
370 Dimension old_dim = parMetrics(pit, false).dim();
371 ParagraphMetrics & pm = par_metrics_[pit];
374 Buffer & buffer = bv_->buffer();
375 main_text_ = (text_ == &buffer.text());
376 bool changed = false;
378 // FIXME: This check ought to be done somewhere else. It is the reason
379 // why text_ is not const. But then, where else to do it?
380 // Well, how can you end up with either (a) a biblio environment that
381 // has no InsetBibitem or (b) a biblio environment with more than one
382 // InsetBibitem? I think the answer is: when paragraphs are merged;
383 // when layout is set; when material is pasted.
384 int const moveCursor = par.checkBiblio(buffer);
386 const_cast<Cursor &>(bv_->cursor()).posForward();
387 else if (moveCursor < 0) {
388 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
389 if (cursor.pos() >= -moveCursor)
390 cursor.posBackward();
393 // Optimisation: this is used in the next two loops
394 // so better to calculate that once here.
395 int const right_margin = rightMargin(pm);
397 // iterator pointing to paragraph to resolve macros
398 DocIterator parPos = text_->macrocontextPosition();
402 LYXERR(Debug::INFO, "MacroContext not initialised!"
403 << " Going through the buffer again and hope"
404 << " the context is better then.");
405 // FIXME audit updateBuffer calls
406 // This should not be here, but it is not clear yet where else it
408 bv_->buffer().updateBuffer();
409 parPos = text_->macrocontextPosition();
410 LASSERT(!parPos.empty(), /**/);
415 Font const bufferfont = buffer.params().getFont();
416 InsetList::const_iterator ii = par.insetList().begin();
417 InsetList::const_iterator iend = par.insetList().end();
418 for (; ii != iend; ++ii) {
419 // FIXME Doesn't this HAVE to be non-empty?
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->inheritFont() ?
437 displayFont(pit, ii->pos) : bufferfont;
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;
601 // Has the user requested we not justify stuff?
602 if (!bv_->buffer().params().justification
603 && align == LYX_ALIGN_BLOCK)
604 align = LYX_ALIGN_LEFT;
607 case LYX_ALIGN_BLOCK: {
608 int const ns = numberOfSeparators(par, row);
609 bool disp_inset = false;
610 if (row.endpos() < par.size()) {
611 Inset const * in = par.getInset(row.endpos());
613 disp_inset = in->display();
615 // If we have separators, this is not the last row of a
616 // par, does not end in newline, and is not row above a
617 // display inset... then stretch it
619 && row.endpos() < par.size()
620 && !par.isNewline(row.endpos() - 1)
623 row.separator = w / ns;
624 //lyxerr << "row.separator " << row.separator << endl;
625 //lyxerr << "ns " << ns << endl;
631 case LYX_ALIGN_RIGHT:
634 case LYX_ALIGN_CENTER:
641 pos_type body_pos = par.beginOfBody();
642 pos_type end = row.endpos();
645 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
647 row.x += theFontMetrics(text_->labelFont(par)).
648 width(layout.labelsep);
650 row.x += row.label_hfill;
654 pos_type const endpos = row.endpos();
655 pos_type body_pos = par.beginOfBody();
657 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
660 ParagraphMetrics & pm = par_metrics_[pit];
661 InsetList::const_iterator ii = par.insetList().begin();
662 InsetList::const_iterator iend = par.insetList().end();
663 for ( ; ii != iend; ++ii) {
664 if (ii->pos >= endpos || ii->pos < row.pos()
665 || (ii->inset->lyxCode() != SPACE_CODE ||
666 !ii->inset->isStretchableSpace()))
668 Dimension dim = row.dimension();
669 if (pm.hfillExpansion(row, ii->pos))
670 dim.wid = int(ii->pos >= body_pos ?
671 max(hfill, 5.0) : row.label_hfill);
674 // Cache the inset dimension.
675 bv_->coordCache().insets().add(ii->inset, dim);
676 pm.setInsetDimension(ii->inset, dim);
681 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
683 Paragraph const & par = text_->getPar(pit);
685 pos_type last = par.beginOfBody();
686 LASSERT(last > 0, /**/);
688 // -1 because a label ends with a space that is in the label
691 // a separator at this end does not count
692 if (par.isLineSeparator(last))
696 for (pos_type i = row.pos(); i <= last; ++i)
697 w += singleWidth(pit, i);
699 docstring const & label = par.params().labelWidthString();
703 FontMetrics const & fm
704 = theFontMetrics(text_->labelFont(par));
706 return max(0, fm.width(label) - w);
710 // this needs special handling - only newlines count as a break point
711 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
713 pos_type const end = par.size();
716 if (par.isNewline(i))
723 int TextMetrics::labelEnd(pit_type const pit) const
725 // labelEnd is only needed if the layout fills a flushleft label.
726 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
728 // return the beginning of the body
729 return leftMargin(max_width_, pit);
735 * Calling Text::getFont is slow. While rebreaking we scan a
736 * paragraph from left to right calling getFont for every char. This
737 * simple class address this problem by hidding an optimization trick
738 * (not mine btw -AB): the font is reused in the whole font span. The
739 * class handles transparently the "hidden" (not part of the fontlist)
740 * label font (as getFont does).
746 FontIterator(TextMetrics const & tm,
747 Paragraph const & par, pit_type pit, pos_type pos)
748 : tm_(tm), par_(par), pit_(pit), pos_(pos),
749 font_(tm.displayFont(pit, pos)),
750 endspan_(par.fontSpan(pos).last),
751 bodypos_(par.beginOfBody())
755 Font const & operator*() const { return font_; }
758 FontIterator & operator++()
761 if (pos_ > endspan_ || pos_ == bodypos_) {
762 font_ = tm_.displayFont(pit_, pos_);
763 endspan_ = par_.fontSpan(pos_).last;
769 Font * operator->() { return &font_; }
773 TextMetrics const & tm_;
775 Paragraph const & par_;
790 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
793 ParagraphMetrics const & pm = par_metrics_[pit];
794 Paragraph const & par = text_->getPar(pit);
795 pos_type const end = par.size();
796 if (pos == end || width < 0)
799 Layout const & layout = par.layout();
801 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
802 return addressBreakPoint(pos, par);
804 pos_type const body_pos = par.beginOfBody();
806 // check for possible inline completion
807 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
808 pos_type inlineCompletionLPos = -1;
809 if (inlineCompletionPos.inTexted()
810 && inlineCompletionPos.text() == text_
811 && inlineCompletionPos.pit() == pit) {
812 // draw logically behind the previous character
813 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
816 // Now we iterate through until we reach the right margin
817 // or the end of the par, then choose the possible break
820 int label_end = labelEnd(pit);
821 int const left = leftMargin(max_width_, pit, pos);
824 // pixel width since last breakpoint
827 docstring const s(1, char_type(0x00B6));
829 int par_marker_width = theFontMetrics(f).width(s);
831 FontIterator fi = FontIterator(*this, par, pit, pos);
832 pos_type point = end;
835 ParagraphList const & pars_ = text_->paragraphs();
836 bool const draw_par_end_marker = lyxrc.paragraph_markers
837 && size_type(pit + 1) < pars_.size();
839 for ( ; i < end; ++i, ++fi) {
840 int thiswidth = pm.singleWidth(i, *fi);
842 if (draw_par_end_marker && i == end - 1)
843 // enlarge the last character to hold the end-of-par marker
844 thiswidth += par_marker_width;
846 // add inline completion width
847 if (inlineCompletionLPos == i) {
848 docstring const & completion = bv_->inlineCompletion();
849 if (completion.length() > 0)
850 thiswidth += theFontMetrics(*fi).width(completion);
853 // add the auto-hfill from label end to the body
854 if (body_pos && i == body_pos) {
855 FontMetrics const & fm = theFontMetrics(
856 text_->labelFont(par));
857 int add = fm.width(layout.labelsep);
858 if (par.isLineSeparator(i - 1))
859 add -= singleWidth(pit, i - 1);
861 add = max(add, label_end - x);
866 chunkwidth += thiswidth;
868 // break before a character that will fall off
869 // the right of the row
871 // if no break before, break here
872 if (point == end || chunkwidth >= width - left) {
878 // exit on last registered breakpoint:
882 if (par.isNewline(i)) {
886 Inset const * inset = 0;
889 if ((inset = par.getInset(i + 1)) && inset->display()) {
894 if ((inset = par.getInset(i)) && inset->display()) {
900 inset = par.getInset(i);
901 if (!inset || inset->isChar()) {
902 // some insets are line separators too
903 if (par.isLineSeparator(i)) {
904 // register breakpoint:
911 // maybe found one, but the par is short enough.
912 if (i == end && x < width)
915 // manual labels cannot be broken in LaTeX. But we
916 // want to make our on-screen rendering of footnotes
918 if (body_pos && point < body_pos)
925 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
926 pos_type const first, pos_type const end) const
928 // get the pure distance
929 ParagraphMetrics const & pm = par_metrics_[pit];
930 Paragraph const & par = text_->getPar(pit);
931 int w = leftMargin(max_width_, pit, first);
932 int label_end = labelEnd(pit);
934 // check for possible inline completion
935 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
936 pos_type inlineCompletionLPos = -1;
937 if (inlineCompletionPos.inTexted()
938 && inlineCompletionPos.text() == text_
939 && inlineCompletionPos.pit() == pit) {
940 // draw logically behind the previous character
941 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
944 pos_type const body_pos = par.beginOfBody();
948 FontIterator fi = FontIterator(*this, par, pit, i);
949 for ( ; i < end; ++i, ++fi) {
950 if (body_pos > 0 && i == body_pos) {
951 FontMetrics const & fm = theFontMetrics(
952 text_->labelFont(par));
953 w += fm.width(par.layout().labelsep);
954 if (par.isLineSeparator(i - 1))
955 w -= singleWidth(pit, i - 1);
956 w = max(w, label_end);
959 // a line separator at the end of a line (but not at the end of a
960 // paragraph) will not be drawn and should therefore not count for
962 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
963 w += pm.singleWidth(i, *fi);
965 // add inline completion width
966 if (inlineCompletionLPos == i) {
967 docstring const & completion = bv_->inlineCompletion();
968 if (completion.length() > 0)
969 w += theFontMetrics(*fi).width(completion);
974 // count the paragraph end marker.
975 if (end == par.size() && lyxrc.paragraph_markers) {
976 ParagraphList const & pars_ = text_->paragraphs();
977 if (size_type(pit + 1) < pars_.size()) {
978 // enlarge the last character to hold the
980 docstring const s(1, char_type(0x00B6));
982 w += theFontMetrics(f).width(s);
986 if (body_pos > 0 && body_pos >= end) {
987 FontMetrics const & fm = theFontMetrics(
988 text_->labelFont(par));
989 w += fm.width(par.layout().labelsep);
990 if (end > 0 && par.isLineSeparator(end - 1))
991 w -= singleWidth(pit, end - 1);
992 w = max(w, label_end);
995 return w + right_margin;
999 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
1000 pos_type const end, bool topBottomSpace) const
1002 Paragraph const & par = text_->getPar(pit);
1003 // get the maximum ascent and the maximum descent
1004 double layoutasc = 0;
1005 double layoutdesc = 0;
1006 double const dh = defaultRowHeight();
1008 // ok, let us initialize the maxasc and maxdesc value.
1009 // Only the fontsize count. The other properties
1010 // are taken from the layoutfont. Nicer on the screen :)
1011 Layout const & layout = par.layout();
1013 // as max get the first character of this row then it can
1014 // increase but not decrease the height. Just some point to
1015 // start with so we don't have to do the assignment below too
1017 Buffer const & buffer = bv_->buffer();
1018 Font font = displayFont(pit, first);
1019 FontSize const tmpsize = font.fontInfo().size();
1020 font.fontInfo() = text_->layoutFont(pit);
1021 FontSize const size = font.fontInfo().size();
1022 font.fontInfo().setSize(tmpsize);
1024 FontInfo labelfont = text_->labelFont(par);
1026 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1027 FontMetrics const & fontmetrics = theFontMetrics(font);
1029 // these are minimum values
1030 double const spacing_val = layout.spacing.getValue()
1031 * text_->spacing(par);
1032 //lyxerr << "spacing_val = " << spacing_val << endl;
1033 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1034 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1036 // insets may be taller
1037 ParagraphMetrics const & pm = par_metrics_[pit];
1038 InsetList::const_iterator ii = par.insetList().begin();
1039 InsetList::const_iterator iend = par.insetList().end();
1040 for ( ; ii != iend; ++ii) {
1041 if (ii->pos >= first && ii->pos < end) {
1042 Dimension const & dim = pm.insetDimension(ii->inset);
1043 maxasc = max(maxasc, dim.ascent());
1044 maxdesc = max(maxdesc, dim.descent());
1048 // Check if any custom fonts are larger (Asger)
1049 // This is not completely correct, but we can live with the small,
1050 // cosmetic error for now.
1054 par.highestFontInRange(first, end, size);
1055 if (maxsize > font.fontInfo().size()) {
1056 // use standard paragraph font with the maximal size
1057 FontInfo maxfont = font.fontInfo();
1058 maxfont.setSize(maxsize);
1059 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1060 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1061 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1064 // This is nicer with box insets:
1068 ParagraphList const & pars = text_->paragraphs();
1069 Inset const & inset = text_->inset();
1071 // is it a top line?
1072 if (first == 0 && topBottomSpace) {
1073 BufferParams const & bufparams = buffer.params();
1074 // some parskips VERY EASY IMPLEMENTATION
1075 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1076 && !inset.getLayout().parbreakIsNewline()
1077 && !par.layout().parbreak_is_newline
1079 && ((layout.isParagraph() && par.getDepth() == 0)
1080 || (pars[pit - 1].layout().isParagraph()
1081 && pars[pit - 1].getDepth() == 0))) {
1082 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1085 if (par.params().startOfAppendix())
1086 maxasc += int(3 * dh);
1088 // This is special code for the chapter, since the label of this
1089 // layout is printed in an extra row
1090 if (layout.counter == "chapter"
1091 && !par.params().labelString().empty()) {
1092 labeladdon = int(labelfont_metrics.maxHeight()
1093 * layout.spacing.getValue()
1094 * text_->spacing(par));
1097 // special code for the top label
1098 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1099 || layout.labeltype == LABEL_BIBLIO
1100 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1101 && text_->isFirstInSequence(pit)
1102 && !par.labelString().empty())
1105 labelfont_metrics.maxHeight()
1106 * layout.spacing.getValue()
1107 * text_->spacing(par)
1108 + (layout.topsep + layout.labelbottomsep) * dh);
1111 // Add the layout spaces, for example before and after
1112 // a section, or between the items of a itemize or enumerate
1115 pit_type prev = text_->depthHook(pit, par.getDepth());
1116 Paragraph const & prevpar = pars[prev];
1118 && prevpar.layout() == layout
1119 && prevpar.getDepth() == par.getDepth()
1120 && prevpar.getLabelWidthString()
1121 == par.getLabelWidthString()) {
1122 layoutasc = layout.itemsep * dh;
1123 } else if (pit != 0 || first != 0) {
1124 if (layout.topsep > 0)
1125 layoutasc = layout.topsep * dh;
1128 prev = text_->outerHook(pit);
1129 if (prev != pit_type(pars.size())) {
1130 maxasc += int(pars[prev].layout().parsep * dh);
1131 } else if (pit != 0) {
1132 Paragraph const & prevpar = pars[pit - 1];
1133 if (prevpar.getDepth() != 0 ||
1134 prevpar.layout() == layout) {
1135 maxasc += int(layout.parsep * dh);
1140 // is it a bottom line?
1141 if (end >= par.size() && topBottomSpace) {
1142 // add the layout spaces, for example before and after
1143 // a section, or between the items of a itemize or enumerate
1145 pit_type nextpit = pit + 1;
1146 if (nextpit != pit_type(pars.size())) {
1147 pit_type cpit = pit;
1151 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1152 usual = pars[cpit].layout().bottomsep * dh;
1153 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1154 if (pars[cpit].layout() != pars[nextpit].layout()
1155 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1157 unusual = pars[cpit].layout().bottomsep * dh;
1159 layoutdesc = max(unusual, usual);
1160 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1161 if (pars[cpit].layout() != pars[nextpit].layout()
1162 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1163 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1168 // incalculate the layout spaces
1169 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1170 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1172 // FIXME: the correct way is to do the following is to move the
1173 // following code in another method specially tailored for the
1174 // main Text. The following test is thus bogus.
1175 // Top and bottom margin of the document (only at top-level)
1176 if (main_text_ && topBottomSpace) {
1177 if (pit == 0 && first == 0)
1179 if (pit + 1 == pit_type(pars.size()) &&
1180 end == par.size() &&
1181 !(end > 0 && par.isNewline(end - 1)))
1185 return Dimension(0, maxasc + labeladdon, maxdesc);
1189 // x is an absolute screen coord
1190 // returns the column near the specified x-coordinate of the row
1191 // x is set to the real beginning of this column
1192 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1193 Row const & row, int & x, bool & boundary) const
1195 Buffer const & buffer = bv_->buffer();
1197 /// For the main Text, it is possible that this pit is not
1198 /// yet in the CoordCache when moving cursor up.
1199 /// x Paragraph coordinate is always 0 for main text anyway.
1200 int const xo = origin_.x_;
1202 Paragraph const & par = text_->getPar(pit);
1204 bidi.computeTables(par, buffer, row);
1206 pos_type vc = row.pos();
1207 pos_type end = row.endpos();
1209 Layout const & layout = par.layout();
1211 bool left_side = false;
1213 pos_type body_pos = par.beginOfBody();
1215 double tmpx = row.x;
1216 double last_tmpx = tmpx;
1219 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1222 // check for empty row
1228 // This (rtl_support test) is not needed, but gives
1229 // some speedup if rtl_support == false
1230 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1232 // If lastrow is false, we don't need to compute
1233 // the value of rtl.
1234 bool const rtl = lastrow ? text_->isRTL(par) : false;
1236 // if the first character is a separator, and we are in RTL
1237 // text, this character will not be painted on screen
1238 // and thus we should not count it and skip to the next.
1239 if (rtl && par.isSeparator(bidi.vis2log(vc)))
1242 while (vc < end && tmpx <= x) {
1243 c = bidi.vis2log(vc);
1245 if (body_pos > 0 && c == body_pos - 1) {
1246 FontMetrics const & fm = theFontMetrics(
1247 text_->labelFont(par));
1248 tmpx += row.label_hfill + fm.width(layout.labelsep);
1249 if (par.isLineSeparator(body_pos - 1))
1250 tmpx -= singleWidth(pit, body_pos - 1);
1253 tmpx += singleWidth(pit, c);
1254 if (par.isSeparator(c) && c >= body_pos)
1255 tmpx += row.separator;
1259 if ((tmpx + last_tmpx) / 2 > x) {
1264 LASSERT(vc <= end, /**/); // This shouldn't happen.
1269 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1270 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1271 if (!par.isNewline(end - 1))
1273 } else if (vc == row.pos()) {
1274 c = bidi.vis2log(vc);
1275 if (bidi.level(c) % 2 == 1)
1278 c = bidi.vis2log(vc - 1);
1279 bool const rtl = (bidi.level(c) % 2 == 1);
1280 if (left_side == rtl) {
1282 boundary = isRTLBoundary(pit, c);
1286 // I believe this code is not needed anymore (Jug 20050717)
1288 // The following code is necessary because the cursor position past
1289 // the last char in a row is logically equivalent to that before
1290 // the first char in the next row. That's why insets causing row
1291 // divisions -- Newline and display-style insets -- must be treated
1292 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1293 // Newline inset, air gap below:
1294 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1295 if (bidi.level(end -1) % 2 == 0)
1296 tmpx -= singleWidth(pit, end - 1);
1298 tmpx += singleWidth(pit, end - 1);
1302 // Air gap above display inset:
1303 if (row.pos() < end && c >= end && end < par.size()
1304 && par.isInset(end) && par.getInset(end)->display()) {
1307 // Air gap below display inset:
1308 if (row.pos() < end && c >= end && par.isInset(end - 1)
1309 && par.getInset(end - 1)->display()) {
1315 pos_type const col = c - row.pos();
1317 if (!c || end == par.size())
1320 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1325 return min(col, end - 1 - row.pos());
1329 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1331 // We play safe and use parMetrics(pit) to make sure the
1332 // ParagraphMetrics will be redone and OK to use if needed.
1333 // Otherwise we would use an empty ParagraphMetrics in
1334 // upDownInText() while in selection mode.
1335 ParagraphMetrics const & pm = parMetrics(pit);
1337 LASSERT(row < int(pm.rows().size()), /**/);
1339 Row const & r = pm.rows()[row];
1340 return r.pos() + getColumnNearX(pit, r, x, bound);
1344 void TextMetrics::newParMetricsDown()
1346 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1347 pit_type const pit = last.first + 1;
1348 if (pit == int(text_->paragraphs().size()))
1351 // do it and update its position.
1353 par_metrics_[pit].setPosition(last.second.position()
1354 + last.second.descent() + par_metrics_[pit].ascent());
1358 void TextMetrics::newParMetricsUp()
1360 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1361 if (first.first == 0)
1364 pit_type const pit = first.first - 1;
1365 // do it and update its position.
1367 par_metrics_[pit].setPosition(first.second.position()
1368 - first.second.ascent() - par_metrics_[pit].descent());
1371 // y is screen coordinate
1372 pit_type TextMetrics::getPitNearY(int y)
1374 LASSERT(!text_->paragraphs().empty(), return -1);
1375 LASSERT(!par_metrics_.empty(), return -1);
1376 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1378 // look for highest numbered paragraph with y coordinate less than given y
1381 ParMetricsCache::const_iterator it = par_metrics_.begin();
1382 ParMetricsCache::const_iterator et = par_metrics_.end();
1383 ParMetricsCache::const_iterator last = et; last--;
1385 ParagraphMetrics const & pm = it->second;
1387 if (y < it->second.position() - int(pm.ascent())) {
1388 // We are looking for a position that is before the first paragraph in
1389 // the cache (which is in priciple off-screen, that is before the
1392 // We are already at the first paragraph in the inset.
1394 // OK, this is the paragraph we are looking for.
1395 pit = it->first - 1;
1400 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1402 if (y >= last->second.position() + int(pm_last.descent())) {
1403 // We are looking for a position that is after the last paragraph in
1404 // the cache (which is in priciple off-screen), that is before the
1406 pit = last->first + 1;
1407 if (pit == int(text_->paragraphs().size()))
1408 // We are already at the last paragraph in the inset.
1410 // OK, this is the paragraph we are looking for.
1411 newParMetricsDown();
1415 for (; it != et; ++it) {
1416 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1417 << " y: " << it->second.position());
1419 ParagraphMetrics const & pm = par_metrics_[it->first];
1421 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1423 yy = it->second.position();
1427 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1433 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1434 bool assert_in_view, bool up)
1436 ParagraphMetrics const & pm = par_metrics_[pit];
1438 int yy = pm.position() - pm.ascent();
1439 LASSERT(!pm.rows().empty(), /**/);
1440 RowList::const_iterator rit = pm.rows().begin();
1441 RowList::const_iterator rlast = pm.rows().end();
1443 for (; rit != rlast; yy += rit->height(), ++rit)
1444 if (yy + rit->height() > y)
1447 if (assert_in_view) {
1448 if (!up && yy + rit->height() > y) {
1449 if (rit != pm.rows().begin()) {
1452 } else if (pit != 0) {
1455 ParagraphMetrics const & pm2 = par_metrics_[pit];
1456 rit = pm2.rows().end();
1460 } else if (up && yy != y) {
1462 y = yy + rit->height();
1464 } else if (pit < int(text_->paragraphs().size()) - 1) {
1466 newParMetricsDown();
1467 ParagraphMetrics const & pm2 = par_metrics_[pit];
1468 rit = pm2.rows().begin();
1477 // x,y are absolute screen coordinates
1478 // sets cursor recursively descending into nested editable insets
1479 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1480 bool assert_in_view, bool up)
1482 if (lyxerr.debugging(Debug::WORKAREA)) {
1483 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1484 cur.bv().coordCache().dump();
1486 pit_type pit = getPitNearY(y);
1487 LASSERT(pit != -1, return 0);
1489 int yy = y; // is modified by getPitAndRowNearY
1490 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1492 bool bound = false; // is modified by getColumnNearX
1493 int xx = x; // is modified by getColumnNearX
1494 pos_type const pos = row.pos()
1495 + getColumnNearX(pit, row, xx, bound);
1498 cur.boundary(bound);
1501 // try to descend into nested insets
1502 Inset * inset = checkInsetHit(x, yy);
1503 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1505 // Either we deconst editXY or better we move current_font
1506 // and real_current_font to Cursor
1507 // FIXME: what is needed now that current_font and real_current_font
1509 cur.setCurrentFont();
1513 ParagraphList const & pars = text_->paragraphs();
1514 Inset const * inset_before = pos ? pars[pit].getInset(pos - 1) : 0;
1516 // This should be just before or just behind the
1517 // cursor position set above.
1518 LASSERT(inset == inset_before
1519 || inset == pars[pit].getInset(pos), return 0);
1521 // Make sure the cursor points to the position before
1523 if (inset == inset_before) {
1525 cur.boundary(false);
1528 // Try to descend recursively inside the inset.
1529 inset = inset->editXY(cur, x, yy);
1531 if (cur.top().text() == text_)
1532 cur.setCurrentFont();
1537 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1539 LASSERT(text_ == cur.text(), /**/);
1540 pit_type pit = getPitNearY(y);
1541 LASSERT(pit != -1, return);
1543 ParagraphMetrics const & pm = par_metrics_[pit];
1545 int yy = pm.position() - pm.ascent();
1546 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1547 " pit: " << pit << " yy: " << yy);
1550 LASSERT(pm.rows().size(), /**/);
1551 for (; r < int(pm.rows().size()) - 1; ++r) {
1552 Row const & row = pm.rows()[r];
1553 if (int(yy + row.height()) > y)
1558 Row const & row = pm.rows()[r];
1560 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1564 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1566 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1568 text_->setCursor(cur, pit, pos, true, bound);
1569 // remember new position.
1574 //takes screen x,y coordinates
1575 Inset * TextMetrics::checkInsetHit(int x, int y)
1577 pit_type pit = getPitNearY(y);
1578 LASSERT(pit != -1, return 0);
1580 Paragraph const & par = text_->paragraphs()[pit];
1581 ParagraphMetrics const & pm = par_metrics_[pit];
1583 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1585 InsetList::const_iterator iit = par.insetList().begin();
1586 InsetList::const_iterator iend = par.insetList().end();
1587 for (; iit != iend; ++iit) {
1588 Inset * inset = iit->inset;
1590 LYXERR(Debug::DEBUG, "examining inset " << inset);
1592 if (!bv_->coordCache().getInsets().has(inset)) {
1593 LYXERR(Debug::DEBUG, "inset has no cached position");
1597 Dimension const & dim = pm.insetDimension(inset);
1598 Point p = bv_->coordCache().getInsets().xy(inset);
1600 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1601 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1604 && x <= p.x_ + dim.wid
1605 && y >= p.y_ - dim.asc
1606 && y <= p.y_ + dim.des) {
1607 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1612 LYXERR(Debug::DEBUG, "No inset hit. ");
1617 int TextMetrics::cursorX(CursorSlice const & sl,
1618 bool boundary) const
1620 LASSERT(sl.text() == text_, /**/);
1621 pit_type const pit = sl.pit();
1622 Paragraph const & par = text_->paragraphs()[pit];
1623 ParagraphMetrics const & pm = par_metrics_[pit];
1624 if (pm.rows().empty())
1627 pos_type ppos = sl.pos();
1628 // Correct position in front of big insets
1629 bool const boundary_correction = ppos != 0 && boundary;
1630 if (boundary_correction)
1633 Row const & row = pm.getRow(sl.pos(), boundary);
1635 pos_type cursor_vpos = 0;
1637 Buffer const & buffer = bv_->buffer();
1640 bidi.computeTables(par, buffer, row);
1642 pos_type const row_pos = row.pos();
1643 pos_type const end = row.endpos();
1644 // Spaces at logical line breaks in bidi text must be skipped during
1645 // cursor positioning. However, they may appear visually in the middle
1646 // of a row; they must be skipped, wherever they are...
1647 // * logically "abc_[HEBREW_\nHEBREW]"
1648 // * visually "abc_[_WERBEH\nWERBEH]"
1649 pos_type skipped_sep_vpos = -1;
1652 cursor_vpos = row_pos;
1653 else if (ppos >= end)
1654 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1655 else if (ppos > row_pos && ppos >= end)
1656 //FIXME: this code is never reached!
1657 // (see http://www.lyx.org/trac/changeset/8251)
1658 // Place cursor after char at (logical) position pos - 1
1659 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1660 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1662 // Place cursor before char at (logical) position ppos
1663 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1664 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1666 pos_type body_pos = par.beginOfBody();
1668 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1671 // check for possible inline completion in this row
1672 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1673 pos_type inlineCompletionVPos = -1;
1674 if (inlineCompletionPos.inTexted()
1675 && inlineCompletionPos.text() == text_
1676 && inlineCompletionPos.pit() == pit
1677 && inlineCompletionPos.pos() - 1 >= row_pos
1678 && inlineCompletionPos.pos() - 1 < end) {
1679 // draw logically behind the previous character
1680 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1683 // Use font span to speed things up, see below
1687 // If the last logical character is a separator, skip it, unless
1688 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1689 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1690 skipped_sep_vpos = bidi.log2vis(end - 1);
1692 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1693 ParagraphList const & pars_ = text_->paragraphs();
1694 if (size_type(pit + 1) < pars_.size()) {
1696 docstring const s = docstring(1, char_type(0x00B6));
1697 x += theFontMetrics(f).width(s);
1701 // Inline completion RTL special case row_pos == cursor_pos:
1702 // "__|b" => cursor_pos is right of __
1703 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1704 font = displayFont(pit, row_pos + 1);
1705 docstring const & completion = bv_->inlineCompletion();
1706 if (font.isRightToLeft() && completion.length() > 0)
1707 x += theFontMetrics(font.fontInfo()).width(completion);
1710 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1711 // Skip the separator which is at the logical end of the row
1712 if (vpos == skipped_sep_vpos)
1714 pos_type pos = bidi.vis2log(vpos);
1715 if (body_pos > 0 && pos == body_pos - 1) {
1716 FontMetrics const & labelfm = theFontMetrics(
1717 text_->labelFont(par));
1718 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1719 if (par.isLineSeparator(body_pos - 1))
1720 x -= singleWidth(pit, body_pos - 1);
1723 // Use font span to speed things up, see above
1724 if (pos < font_span.first || pos > font_span.last) {
1725 font_span = par.fontSpan(pos);
1726 font = displayFont(pit, pos);
1729 x += pm.singleWidth(pos, font);
1731 // Inline completion RTL case:
1732 // "a__|b", __ of b => non-boundary a-pos is right of __
1733 if (vpos + 1 == inlineCompletionVPos
1734 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1735 font = displayFont(pit, vpos + 1);
1736 docstring const & completion = bv_->inlineCompletion();
1737 if (font.isRightToLeft() && completion.length() > 0)
1738 x += theFontMetrics(font.fontInfo()).width(completion);
1741 // Inline completion LTR case:
1742 // "b|__a", __ of b => non-boundary a-pos is in front of __
1743 if (vpos == inlineCompletionVPos
1744 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1745 font = displayFont(pit, vpos);
1746 docstring const & completion = bv_->inlineCompletion();
1747 if (!font.isRightToLeft() && completion.length() > 0)
1748 x += theFontMetrics(font.fontInfo()).width(completion);
1751 if (par.isSeparator(pos) && pos >= body_pos)
1755 // see correction above
1756 if (boundary_correction) {
1757 if (isRTL(sl, boundary))
1758 x -= singleWidth(pit, ppos);
1760 x += singleWidth(pit, ppos);
1767 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1769 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1770 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1771 if (pm.rows().empty())
1775 h -= par_metrics_[0].rows()[0].ascent();
1776 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1777 h += par_metrics_[pit].height();
1780 if (pos && boundary)
1782 size_t const rend = pm.pos2row(pos);
1783 for (size_t rit = 0; rit != rend; ++rit)
1784 h += pm.rows()[rit].height();
1785 h += pm.rows()[rend].ascent();
1790 // the cursor set functions have a special mechanism. When they
1791 // realize you left an empty paragraph, they will delete it.
1793 bool TextMetrics::cursorHome(Cursor & cur)
1795 LASSERT(text_ == cur.text(), /**/);
1796 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1797 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1798 return text_->setCursor(cur, cur.pit(), row.pos());
1802 bool TextMetrics::cursorEnd(Cursor & cur)
1804 LASSERT(text_ == cur.text(), /**/);
1805 // if not on the last row of the par, put the cursor before
1806 // the final space exept if I have a spanning inset or one string
1807 // is so long that we force a break.
1808 pos_type end = cur.textRow().endpos();
1810 // empty text, end-1 is no valid position
1812 bool boundary = false;
1813 if (end != cur.lastpos()) {
1814 if (!cur.paragraph().isLineSeparator(end-1)
1815 && !cur.paragraph().isNewline(end-1))
1820 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1824 void TextMetrics::deleteLineForward(Cursor & cur)
1826 LASSERT(text_ == cur.text(), /**/);
1827 if (cur.lastpos() == 0) {
1828 // Paragraph is empty, so we just go forward
1829 text_->cursorForward(cur);
1832 cur.setSelection(true); // to avoid deletion
1835 // What is this test for ??? (JMarc)
1836 if (!cur.selection())
1837 text_->deleteWordForward(cur);
1839 cap::cutSelection(cur, true, false);
1840 cur.checkBufferStructure();
1845 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1847 ParagraphList const & pars = text_->paragraphs();
1848 return row.endpos() >= pars[pit].size()
1849 && pit + 1 == pit_type(pars.size());
1853 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1855 return row.pos() == 0 && pit == 0;
1859 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1861 LASSERT(pit >= 0, /**/);
1862 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1863 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1867 int TextMetrics::leftMargin(int max_width,
1868 pit_type const pit, pos_type const pos) const
1870 ParagraphList const & pars = text_->paragraphs();
1872 LASSERT(pit >= 0, /**/);
1873 LASSERT(pit < int(pars.size()), /**/);
1874 Paragraph const & par = pars[pit];
1875 LASSERT(pos >= 0, /**/);
1876 LASSERT(pos <= par.size(), /**/);
1877 Buffer const & buffer = bv_->buffer();
1878 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1879 DocumentClass const & tclass = buffer.params().documentClass();
1880 Layout const & layout = par.layout();
1882 docstring parindent = layout.parindent;
1886 if (text_->isMainText())
1887 l_margin += bv_->leftMargin();
1889 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1890 tclass.leftmargin());
1892 if (par.getDepth() != 0) {
1893 // find the next level paragraph
1894 pit_type newpar = text_->outerHook(pit);
1895 if (newpar != pit_type(pars.size())) {
1896 if (pars[newpar].layout().isEnvironment()) {
1897 l_margin = leftMargin(max_width, newpar);
1899 if (tclass.isDefaultLayout(par.layout())
1900 || tclass.isPlainLayout(par.layout())) {
1901 if (pars[newpar].params().noindent())
1904 parindent = pars[newpar].layout().parindent;
1909 // This happens after sections in standard classes. The 1.3.x
1910 // code compared depths too, but it does not seem necessary
1912 if (tclass.isDefaultLayout(par.layout())
1913 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1916 FontInfo const labelfont = text_->labelFont(par);
1917 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1919 switch (layout.margintype) {
1920 case MARGIN_DYNAMIC:
1921 if (!layout.leftmargin.empty()) {
1922 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1925 if (!par.labelString().empty()) {
1926 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1927 l_margin += labelfont_metrics.width(par.labelString());
1928 l_margin += labelfont_metrics.width(layout.labelsep);
1932 case MARGIN_MANUAL: {
1933 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1934 // The width of an empty par, even with manual label, should be 0
1935 if (!par.empty() && pos >= par.beginOfBody()) {
1936 if (!par.getLabelWidthString().empty()) {
1937 docstring labstr = par.getLabelWidthString();
1938 l_margin += labelfont_metrics.width(labstr);
1939 l_margin += labelfont_metrics.width(layout.labelsep);
1945 case MARGIN_STATIC: {
1946 l_margin += theFontMetrics(buffer.params().getFont()).
1947 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1951 case MARGIN_FIRST_DYNAMIC:
1952 if (layout.labeltype == LABEL_MANUAL) {
1953 // if we are at position 0, we are never in the body
1954 if (pos > 0 && pos >= par.beginOfBody())
1955 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1957 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1959 // Special case to fix problems with
1961 || (layout.labeltype == LABEL_STATIC
1962 && layout.latextype == LATEX_ENVIRONMENT
1963 && !text_->isFirstInSequence(pit))) {
1964 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1965 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1966 && layout.labeltype != LABEL_BIBLIO
1967 && layout.labeltype !=
1968 LABEL_CENTERED_TOP_ENVIRONMENT) {
1969 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1970 l_margin += labelfont_metrics.width(layout.labelsep);
1971 l_margin += labelfont_metrics.width(par.labelString());
1975 case MARGIN_RIGHT_ADDRESS_BOX: {
1977 // ok, a terrible hack. The left margin depends on the widest
1978 // row in this paragraph.
1979 RowList::iterator rit = par.rows().begin();
1980 RowList::iterator end = par.rows().end();
1981 // FIXME: This is wrong.
1982 int minfill = max_width;
1983 for ( ; rit != end; ++rit)
1984 if (rit->fill() < minfill)
1985 minfill = rit->fill();
1986 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1987 l_margin += minfill;
1989 // also wrong, but much shorter.
1990 l_margin += max_width / 2;
1995 if (!par.params().leftIndent().zero())
1996 l_margin += par.params().leftIndent().inPixels(max_width);
2000 if (par.params().align() == LYX_ALIGN_LAYOUT)
2001 align = layout.align;
2003 align = par.params().align();
2005 // set the correct parindent
2007 && (layout.labeltype == LABEL_NO_LABEL
2008 || layout.labeltype == LABEL_TOP_ENVIRONMENT
2009 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
2010 || (layout.labeltype == LABEL_STATIC
2011 && layout.latextype == LATEX_ENVIRONMENT
2012 && !text_->isFirstInSequence(pit)))
2013 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2014 && !par.params().noindent()
2015 // in some insets, paragraphs are never indented
2016 && !text_->inset().neverIndent()
2017 // display style insets are always centered, omit indentation
2020 && par.getInset(pos)->display())
2021 && (!(tclass.isDefaultLayout(par.layout())
2022 || tclass.isPlainLayout(par.layout()))
2023 || buffer.params().paragraph_separation
2024 == BufferParams::ParagraphIndentSeparation)
2027 // use the parindent of the layout when the default indentation is
2028 // used otherwise use the indentation set in the document settings
2029 if (buffer.params().getIndentation().asLyXCommand() == "default")
2030 l_margin += theFontMetrics(
2031 buffer.params().getFont()).signedWidth(parindent);
2033 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2040 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2042 ParagraphMetrics const & pm = par_metrics_[pit];
2044 return pm.singleWidth(pos, displayFont(pit, pos));
2048 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2050 if (par_metrics_.empty())
2056 ParMetricsCache::iterator it = par_metrics_.begin();
2057 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2058 y -= it->second.ascent();
2059 for (; it != pm_end; ++it) {
2060 ParagraphMetrics const & pmi = it->second;
2062 pit_type const pit = it->first;
2063 // Save the paragraph position in the cache.
2064 it->second.setPosition(y);
2065 drawParagraph(pi, pit, x, y);
2071 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2073 BufferParams const & bparams = bv_->buffer().params();
2074 ParagraphMetrics const & pm = par_metrics_[pit];
2075 if (pm.rows().empty())
2079 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2080 int const ww = bv_->workHeight();
2081 size_t const nrows = pm.rows().size();
2083 Cursor const & cur = bv_->cursor();
2084 DocIterator sel_beg = cur.selectionBegin();
2085 DocIterator sel_end = cur.selectionEnd();
2086 bool selection = cur.selection()
2087 // This is our text.
2088 && cur.text() == text_
2089 // if the anchor is outside, this is not our selection
2090 && cur.normalAnchor().text() == text_
2091 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2093 // We store the begin and end pos of the selection relative to this par
2094 DocIterator sel_beg_par = cur.selectionBegin();
2095 DocIterator sel_end_par = cur.selectionEnd();
2097 // We care only about visible selection.
2099 if (pit != sel_beg.pit()) {
2100 sel_beg_par.pit() = pit;
2101 sel_beg_par.pos() = 0;
2103 if (pit != sel_end.pit()) {
2104 sel_end_par.pit() = pit;
2105 sel_end_par.pos() = sel_end_par.lastpos();
2109 for (size_t i = 0; i != nrows; ++i) {
2111 Row const & row = pm.rows()[i];
2115 bool const inside = (y + row.descent() >= 0
2116 && y - row.ascent() < ww);
2117 // It is not needed to draw on screen if we are not inside.
2118 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2119 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2122 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2124 row.setSelection(-1, -1);
2126 // The row knows nothing about the paragraph, so we have to check
2127 // whether this row is the first or last and update the margins.
2128 if (row.selection()) {
2129 if (row.sel_beg == 0)
2130 row.begin_margin_sel = sel_beg.pit() < pit;
2131 if (row.sel_end == sel_end_par.lastpos())
2132 row.end_margin_sel = sel_end.pit() > pit;
2135 // Row signature; has row changed since last paint?
2136 row.setCrc(pm.computeRowSignature(row, bparams));
2137 bool row_has_changed = row.changed();
2139 // Take this opportunity to spellcheck the row contents.
2140 if (row_has_changed && lyxrc.spellcheck_continuously) {
2141 text_->getPar(pit).spellCheck();
2144 // Don't paint the row if a full repaint has not been requested
2145 // and if it has not changed.
2146 if (!pi.full_repaint && !row_has_changed) {
2147 // Paint only the insets if the text itself is
2149 rp.paintOnlyInsets();
2154 // Clear background of this row if paragraph background was not
2155 // already cleared because of a full repaint.
2156 if (!pi.full_repaint && row_has_changed) {
2157 pi.pain.fillRectangle(x, y - row.ascent(),
2158 width(), row.height(), pi.background_color);
2161 // Instrumentation for testing row cache (see also
2163 if (lyxerr.debugging(Debug::PAINTING) && inside
2164 && (row.selection() || pi.full_repaint || row_has_changed)) {
2165 string const foreword = text_->isMainText() ?
2166 "main text redraw " : "inset text redraw: ";
2167 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2168 << " row_selection=" << row.selection()
2169 << " full_repaint=" << pi.full_repaint
2170 << " row_has_changed=" << row_has_changed);
2173 // Backup full_repaint status and force full repaint
2174 // for inner insets as the Row has been cleared out.
2175 bool tmp = pi.full_repaint;
2176 pi.full_repaint = true;
2178 rp.paintSelection();
2181 rp.paintChangeBar();
2182 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2183 if (i == 0 && !is_rtl)
2185 if (i == nrows - 1 && is_rtl)
2188 if (i == nrows - 1 && !is_rtl)
2190 if (i == 0 && is_rtl)
2194 // Restore full_repaint status.
2195 pi.full_repaint = tmp;
2197 // Re-enable screen drawing for future use of the painter.
2198 pi.pain.setDrawingEnabled(original_drawing_state);
2200 //LYXERR(Debug::PAINTING, ".");
2204 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2205 Dimension & dim) const
2207 Cursor const & bvcur = cur.bv().cursor();
2209 // get word in front of cursor
2210 docstring word = text_->previousWord(bvcur.top());
2211 DocIterator wordStart = bvcur;
2212 wordStart.pos() -= word.length();
2214 // get position on screen of the word start and end
2215 //FIXME: Is it necessary to explicitly set this to false?
2216 wordStart.boundary(false);
2217 Point lxy = cur.bv().getPos(wordStart);
2218 Point rxy = cur.bv().getPos(bvcur);
2220 // calculate dimensions of the word
2221 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2222 dim.wid = abs(rxy.x_ - lxy.x_);
2224 // calculate position of word
2226 x = min(rxy.x_, lxy.x_);
2228 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2229 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2232 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2234 // ParagraphMetrics const & pm = par_metrics_[pit];
2235 // Row const & r = pm.rows()[row];
2241 int defaultRowHeight()
2243 return int(theFontMetrics(sane_font).maxHeight() * 1.2);