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"
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/gettext.h"
56 #include "support/lassert.h"
65 using frontend::FontMetrics;
67 static int numberOfSeparators(Paragraph const & par, Row const & row)
69 pos_type const first = max(row.pos(), par.beginOfBody());
70 pos_type const last = row.endpos() - 1;
72 for (pos_type p = first; p < last; ++p) {
73 if (par.isSeparator(p))
80 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
82 pos_type last = row.endpos() - 1;
83 pos_type first = row.pos();
85 // hfill *DO* count at the beginning of paragraphs!
87 while (first < last && par.isHfill(first))
91 last = min(last, par.beginOfBody());
93 for (pos_type p = first; p < last; ++p) {
101 static int numberOfHfills(Paragraph const & par, Row const & row)
103 pos_type const last = row.endpos();
104 pos_type first = row.pos();
106 // hfill *DO* count at the beginning of paragraphs!
108 while (first < last && par.isHfill(first))
112 first = max(first, par.beginOfBody());
115 for (pos_type p = first; p < last; ++p) {
123 /////////////////////////////////////////////////////////////////////
127 /////////////////////////////////////////////////////////////////////
130 TextMetrics::TextMetrics(BufferView * bv, Text * text)
131 : bv_(bv), text_(text)
134 max_width_ = bv_->workWidth();
135 dim_.wid = max_width_;
141 bool TextMetrics::contains(pit_type pit) const
143 return par_metrics_.find(pit) != par_metrics_.end();
147 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
149 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
154 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
156 ParMetricsCache::const_iterator it = par_metrics_.begin();
157 return make_pair(it->first, &it->second);
161 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
163 LBUFERR(!par_metrics_.empty());
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 LBUFERR(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, { static Font f; return f; });
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 // no RTL boundary at paragraph start
310 if (!lyxrc.rtl_support || pos == 0)
313 Font const & left_font = displayFont(pit, pos - 1);
315 return isRTLBoundary(pit, pos, left_font);
319 // isRTLBoundary returns false on a real end-of-line boundary,
320 // because otherwise the two boundary types get mixed up.
321 // This is the whole purpose of this being in TextMetrics.
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 // Check whether there are InsetBibItems that need fixing
381 // FIXME: This check ought to be done somewhere else. It is the reason
382 // why text_ is not const. But then, where else to do it?
383 // Well, how can you end up with either (a) a biblio environment that
384 // has no InsetBibitem or (b) a biblio environment with more than one
385 // InsetBibitem? I think the answer is: when paragraphs are merged;
386 // when layout is set; when material is pasted.
387 if (par.brokenBiblio()) {
388 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
389 // In some cases, we do not know how to record undo
390 if (&cur.inset() == &text_->inset())
391 cur.recordUndo(ATOMIC_UNDO, pit, pit);
393 int const moveCursor = par.fixBiblio(buffer);
395 // Is it necessary to update the cursor?
396 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
399 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
404 // Optimisation: this is used in the next two loops
405 // so better to calculate that once here.
406 int const right_margin = rightMargin(pm);
408 // iterator pointing to paragraph to resolve macros
409 DocIterator parPos = text_->macrocontextPosition();
413 LYXERR(Debug::INFO, "MacroContext not initialised!"
414 << " Going through the buffer again and hope"
415 << " the context is better then.");
416 // FIXME audit updateBuffer calls
417 // This should not be here, but it is not clear yet where else it
419 bv_->buffer().updateBuffer();
420 parPos = text_->macrocontextPosition();
421 LBUFERR(!parPos.empty());
426 Font const bufferfont = buffer.params().getFont();
427 InsetList::const_iterator ii = par.insetList().begin();
428 InsetList::const_iterator iend = par.insetList().end();
429 for (; ii != iend; ++ii) {
430 // FIXME Doesn't this HAVE to be non-empty?
431 // position already initialized?
432 if (!parPos.empty()) {
433 parPos.pos() = ii->pos;
435 // A macro template would normally not be visible
436 // by itself. But the tex macro semantics allow
437 // recursion, so we artifically take the context
438 // after the macro template to simulate this.
439 if (ii->inset->lyxCode() == MATHMACRO_CODE)
443 // do the metric calculation
445 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
447 Font const & font = ii->inset->inheritFont() ?
448 displayFont(pit, ii->pos) : bufferfont;
449 MacroContext mc(&buffer, parPos);
450 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
451 ii->inset->metrics(mi, dim);
452 Dimension const old_dim = pm.insetDimension(ii->inset);
453 if (old_dim != dim) {
454 pm.setInsetDimension(ii->inset, dim);
459 par.setBeginOfBody();
461 size_t row_index = 0;
462 // maximum pixel width of a row
464 if (row_index == pm.rows().size())
465 pm.rows().push_back(Row());
466 Row & row = pm.rows()[row_index];
468 breakRow(row, right_margin, pit);
469 setRowHeight(row, pit);
471 row.dimension().wid = rowWidth(right_margin, pit, first, row.endpos());
472 if (row.width() != w) {
473 lyxerr << w << " => " << row.width() << ", body=" << par.beginOfBody() << ", size=" << par.size()<< ", inset=" << par.inInset().layoutName()<< endl;
476 row.setChanged(false);
477 if (row_index || row.endpos() < par.size())
478 // If there is more than one row, expand the text to
479 // the full allowable width. This setting here is needed
480 // for the computeRowMetrics() below.
481 dim_.wid = max_width_;
482 int const max_row_width = max(dim_.wid, row.width());
483 computeRowMetrics(pit, row, max_row_width);
484 first = row.endpos();
487 pm.dim().wid = max(pm.dim().wid, row.width());
488 pm.dim().des += row.height();
489 } while (first < par.size());
491 if (row_index < pm.rows().size())
492 pm.rows().resize(row_index);
494 // Make sure that if a par ends in newline, there is one more row
496 if (first > 0 && par.isNewline(first - 1)) {
497 if (row_index == pm.rows().size())
498 pm.rows().push_back(Row());
499 Row & row = pm.rows()[row_index];
502 row.dimension().wid = rowWidth(right_margin, pit, first, first);
503 setRowHeight(row, pit);
504 row.setChanged(false);
505 int const max_row_width = max(dim_.wid, row.width());
506 computeRowMetrics(pit, row, max_row_width);
507 pm.dim().des += row.height();
510 pm.dim().asc += pm.rows()[0].ascent();
511 pm.dim().des -= pm.rows()[0].ascent();
513 changed |= old_dim.height() != pm.dim().height();
519 void TextMetrics::computeRowMetrics(pit_type const pit,
520 Row & row, int width) const
525 Paragraph const & par = text_->getPar(pit);
527 double w = width - row.width();
528 // FIXME: put back this assertion when the crash on new doc is solved.
529 //LASSERT(w >= 0, /**/);
531 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
532 //lyxerr << "row.width() " << row.width() << endl;
533 //lyxerr << "w " << w << endl;
535 bool const is_rtl = text_->isRTL(par);
537 row.x = rightMargin(pit);
539 row.x = leftMargin(max_width_, pit, row.pos());
541 // is there a manual margin with a manual label
542 Layout const & layout = par.layout();
544 if (layout.margintype == MARGIN_MANUAL
545 && layout.labeltype == LABEL_MANUAL) {
546 /// We might have real hfills in the label part
547 int nlh = numberOfLabelHfills(par, row);
549 // A manual label par (e.g. List) has an auto-hfill
550 // between the label text and the body of the
552 // But we don't want to do this auto hfill if the par
557 if (nlh && !par.getLabelWidthString().empty())
558 row.label_hfill = labelFill(pit, row) / double(nlh);
562 // are there any hfills in the row?
563 if (int const nh = numberOfHfills(par, row)) {
565 hfill = w / double(nh);
566 // we don't have to look at the alignment if it is ALIGN_LEFT and
567 // if the row is already larger then the permitted width as then
568 // we force the LEFT_ALIGN'edness!
569 } else if (int(row.width()) < max_width_) {
570 // is it block, flushleft or flushright?
571 // set x how you need it
573 if (par.params().align() == LYX_ALIGN_LAYOUT)
574 align = layout.align;
576 align = par.params().align();
578 // handle alignment inside tabular cells
579 Inset const & owner = text_->inset();
580 switch (owner.contentAlignment()) {
581 case LYX_ALIGN_CENTER:
583 case LYX_ALIGN_RIGHT:
584 if (align == LYX_ALIGN_NONE
585 || align == LYX_ALIGN_BLOCK)
586 align = owner.contentAlignment();
589 // unchanged (use align)
593 // Display-style insets should always be on a centered row
594 if (Inset const * inset = par.getInset(row.pos())) {
595 switch (inset->display()) {
596 case Inset::AlignLeft:
597 align = LYX_ALIGN_BLOCK;
599 case Inset::AlignCenter:
600 align = LYX_ALIGN_CENTER;
603 // unchanged (use align)
605 case Inset::AlignRight:
606 align = LYX_ALIGN_RIGHT;
611 // Has the user requested we not justify stuff?
612 if (!bv_->buffer().params().justification
613 && align == LYX_ALIGN_BLOCK)
614 align = LYX_ALIGN_LEFT;
617 case LYX_ALIGN_BLOCK: {
618 int const ns = numberOfSeparators(par, row);
619 bool disp_inset = false;
620 if (row.endpos() < par.size()) {
621 Inset const * in = par.getInset(row.endpos());
623 disp_inset = in->display();
625 // If we have separators, this is not the last row of a
626 // par, does not end in newline, and is not row above a
627 // display inset... then stretch it
629 && row.endpos() < par.size()
630 && !par.isNewline(row.endpos() - 1)
633 row.separator = w / ns;
634 //lyxerr << "row.separator " << row.separator << endl;
635 //lyxerr << "ns " << ns << endl;
641 case LYX_ALIGN_RIGHT:
644 case LYX_ALIGN_CENTER:
651 pos_type body_pos = par.beginOfBody();
652 pos_type end = row.endpos();
655 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
657 row.x += theFontMetrics(text_->labelFont(par)).
658 width(layout.labelsep);
660 row.x += row.label_hfill;
664 pos_type const endpos = row.endpos();
665 pos_type body_pos = par.beginOfBody();
667 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
670 ParagraphMetrics & pm = par_metrics_[pit];
671 InsetList::const_iterator ii = par.insetList().begin();
672 InsetList::const_iterator iend = par.insetList().end();
673 for ( ; ii != iend; ++ii) {
674 if (ii->pos >= endpos || ii->pos < row.pos()
675 || (ii->inset->lyxCode() != SPACE_CODE ||
676 !ii->inset->isStretchableSpace()))
678 Dimension dim = row.dimension();
679 if (pm.hfillExpansion(row, ii->pos))
680 dim.wid = int(ii->pos >= body_pos ?
681 max(hfill, 5.0) : row.label_hfill);
684 // Cache the inset dimension.
685 bv_->coordCache().insets().add(ii->inset, dim);
686 pm.setInsetDimension(ii->inset, dim);
691 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
693 Paragraph const & par = text_->getPar(pit);
695 pos_type last = par.beginOfBody();
698 // -1 because a label ends with a space that is in the label
701 // a separator at this end does not count
702 if (par.isLineSeparator(last))
706 for (pos_type i = row.pos(); i <= last; ++i)
707 w += singleWidth(pit, i);
709 docstring const & label = par.params().labelWidthString();
713 FontMetrics const & fm
714 = theFontMetrics(text_->labelFont(par));
716 return max(0, fm.width(label) - w);
721 // Not used, see TextMetrics::breakRow
722 // this needs special handling - only newlines count as a break point
723 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
725 pos_type const end = par.size();
728 if (par.isNewline(i))
736 int TextMetrics::labelEnd(pit_type const pit) const
738 // labelEnd is only needed if the layout fills a flushleft label.
739 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
741 // return the beginning of the body
742 return leftMargin(max_width_, pit);
748 * Calling Text::getFont is slow. While rebreaking we scan a
749 * paragraph from left to right calling getFont for every char. This
750 * simple class address this problem by hidding an optimization trick
751 * (not mine btw -AB): the font is reused in the whole font span. The
752 * class handles transparently the "hidden" (not part of the fontlist)
753 * label font (as getFont does).
759 FontIterator(TextMetrics const & tm,
760 Paragraph const & par, pit_type pit, pos_type pos)
761 : tm_(tm), par_(par), pit_(pit), pos_(pos),
762 font_(tm.displayFont(pit, pos)),
763 endspan_(par.fontSpan(pos).last),
764 bodypos_(par.beginOfBody())
768 Font const & operator*() const { return font_; }
771 FontIterator & operator++()
774 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
775 font_ = tm_.displayFont(pit_, pos_);
776 endspan_ = par_.fontSpan(pos_).last;
782 Font * operator->() { return &font_; }
786 TextMetrics const & tm_;
788 Paragraph const & par_;
803 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
805 Paragraph const & par = text_->getPar(pit);
806 pos_type const end = par.size();
807 pos_type const pos = row.pos();
808 int const width = max_width_ - right_margin;
809 pos_type const body_pos = par.beginOfBody();
811 row.dimension().wid = leftMargin(max_width_, pit, pos);
813 if (pos >= end || row.width() > width) {
814 row.dimension().wid += right_margin;
819 ParagraphMetrics const & pm = par_metrics_[pit];
820 ParagraphList const & pars = text_->paragraphs();
823 //FIXME: As long as leftMargin() is not correctly implemented for
824 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
825 // Otherwise, long rows will be painted off the screen.
826 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
827 return addressBreakPoint(pos, par);
830 // check for possible inline completion
831 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
832 pos_type inlineCompletionLPos = -1;
833 if (inlineCompletionPos.inTexted()
834 && inlineCompletionPos.text() == text_
835 && inlineCompletionPos.pit() == pit) {
836 // draw logically behind the previous character
837 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
840 // Now we iterate through until we reach the right margin
841 // or the end of the par, then build a representation of the row.
843 FontIterator fi = FontIterator(*this, par, pit, pos);
844 while (i < end && row.width() < width) {
845 char_type c = par.getChar(i);
846 // The most special cases are handled first.
847 if (par.isInset(i)) {
848 Inset const * ins = par.getInset(i);
849 Dimension dim = pm.insetDimension(ins);
850 row.add(i, ins, dim, *fi, par.lookupChange(i));
851 } else if (par.isLineSeparator(i)) {
852 // In theory, no inset has this property. If
853 // this is done, a new addSeparator which
854 // takes an inset as parameter should be
856 LATTEST(!par.isInset(i));
857 row.addSeparator(i, c, *fi, par.lookupChange(i));
858 } else if (c == '\t')
859 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")), *fi, par.lookupChange(i));
861 row.add(i, c, *fi, par.lookupChange(i));
863 // end of paragraph marker
864 if (lyxrc.paragraph_markers
865 && i == end - 1 && size_type(pit + 1) < pars.size()) {
866 // enlarge the last character to hold the end-of-par marker
867 Font f(text_->layoutFont(pit));
868 f.fontInfo().setColor(Color_paragraphmarker);
869 row.add(i, char_type(0x00B6), f, Change());
872 // add inline completion width
873 if (inlineCompletionLPos == i) {
875 f.fontInfo().setColor(Color_inlinecompletion);
876 row.add(i, bv_->inlineCompletion(), f, Change());
879 // Handle some situations that abruptly terminate the row
881 // - Before a display inset
882 // - After a display inset
883 Inset const * inset = 0;
885 || (i + 1 < end && (inset = par.getInset(i + 1))
887 || (!row.empty() && row.back().inset
888 && row.back().inset->display())) {
896 // add the auto-hfill from label end to the body
897 if (body_pos && i == body_pos) {
898 FontMetrics const & fm = theFontMetrics(
899 text_->labelFont(par));
900 if (!row.empty() && row.back().isLineSeparator())
902 int const add = max(fm.width(par.layout().labelsep),
903 labelEnd(pit) - row.width());
904 row.addSpace(i, add, *fi, par.lookupChange(i));
911 // if the row is too large, try to cut at last separator.
912 if (row.width() >= width)
913 row.separate_back(body_pos);
915 // if the row ends with a separator that is not at end of
916 // paragraph, remove it
917 if (!row.empty() && row.back().isLineSeparator()
918 && row.endpos() < par.size())
921 // make sure that the RtL elements are in reverse ordering
922 lyxerr << ">>>>>>>>>>BEFORE REVERSE" << row;
924 lyxerr << "<<<<<<<<<<AFTER REVERSE" << row;
926 row.dimension().wid += right_margin;
928 // manual labels cannot be broken in LaTeX. But we
929 // want to make our on-screen rendering of footnotes
931 // if (body_pos && point < body_pos)
936 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
937 pos_type const first, pos_type const end) const
939 // get the pure distance
940 ParagraphMetrics const & pm = par_metrics_[pit];
941 Paragraph const & par = text_->getPar(pit);
942 int w = leftMargin(max_width_, pit, first);
943 int label_end = labelEnd(pit);
945 // check for possible inline completion
946 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
947 pos_type inlineCompletionLPos = -1;
948 if (inlineCompletionPos.inTexted()
949 && inlineCompletionPos.text() == text_
950 && inlineCompletionPos.pit() == pit) {
951 // draw logically behind the previous character
952 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
955 pos_type const body_pos = par.beginOfBody();
959 FontIterator fi = FontIterator(*this, par, pit, i);
960 for ( ; i < end; ++i, ++fi) {
961 if (body_pos > 0 && i == body_pos) {
962 FontMetrics const & fm = theFontMetrics(
963 text_->labelFont(par));
964 w += fm.width(par.layout().labelsep);
965 if (par.isLineSeparator(i - 1))
966 w -= singleWidth(pit, i - 1);
967 w = max(w, label_end);
970 // a line separator at the end of a line (but not at the end of a
971 // paragraph) will not be drawn and should therefore not count for
973 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
974 w += pm.singleWidth(i, *fi);
976 // add inline completion width
977 if (inlineCompletionLPos == i) {
978 docstring const & completion = bv_->inlineCompletion();
979 if (completion.length() > 0)
980 w += theFontMetrics(*fi).width(completion);
985 // count the paragraph end marker.
986 if (end == par.size() && lyxrc.paragraph_markers) {
987 ParagraphList const & pars_ = text_->paragraphs();
988 if (size_type(pit + 1) < pars_.size()) {
989 // enlarge the last character to hold the
991 docstring const s(1, char_type(0x00B6));
993 w += theFontMetrics(f).width(s);
997 if (body_pos > 0 && body_pos >= end) {
998 FontMetrics const & fm = theFontMetrics(
999 text_->labelFont(par));
1000 w += fm.width(par.layout().labelsep);
1001 if (end > 0 && par.isLineSeparator(end - 1))
1002 w -= singleWidth(pit, end - 1);
1003 w = max(w, label_end);
1006 return w + right_margin;
1010 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
1011 bool topBottomSpace) const
1013 Paragraph const & par = text_->getPar(pit);
1014 // get the maximum ascent and the maximum descent
1015 double layoutasc = 0;
1016 double layoutdesc = 0;
1017 double const dh = defaultRowHeight();
1019 // ok, let us initialize the maxasc and maxdesc value.
1020 // Only the fontsize count. The other properties
1021 // are taken from the layoutfont. Nicer on the screen :)
1022 Layout const & layout = par.layout();
1024 // as max get the first character of this row then it can
1025 // increase but not decrease the height. Just some point to
1026 // start with so we don't have to do the assignment below too
1028 Buffer const & buffer = bv_->buffer();
1029 Font font = displayFont(pit, row.pos());
1030 FontSize const tmpsize = font.fontInfo().size();
1031 font.fontInfo() = text_->layoutFont(pit);
1032 FontSize const size = font.fontInfo().size();
1033 font.fontInfo().setSize(tmpsize);
1035 FontInfo labelfont = text_->labelFont(par);
1037 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1038 FontMetrics const & fontmetrics = theFontMetrics(font);
1040 // these are minimum values
1041 double const spacing_val = layout.spacing.getValue()
1042 * text_->spacing(par);
1043 //lyxerr << "spacing_val = " << spacing_val << endl;
1044 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1045 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1047 // insets may be taller
1048 ParagraphMetrics const & pm = par_metrics_[pit];
1049 InsetList::const_iterator ii = par.insetList().begin();
1050 InsetList::const_iterator iend = par.insetList().end();
1051 for ( ; ii != iend; ++ii) {
1052 if (ii->pos >= row.pos() && ii->pos < row.endpos()) {
1053 Dimension const & dim = pm.insetDimension(ii->inset);
1054 maxasc = max(maxasc, dim.ascent());
1055 maxdesc = max(maxdesc, dim.descent());
1059 // Check if any custom fonts are larger (Asger)
1060 // This is not completely correct, but we can live with the small,
1061 // cosmetic error for now.
1065 par.highestFontInRange(row.pos(), row.endpos(), size);
1066 if (maxsize > font.fontInfo().size()) {
1067 // use standard paragraph font with the maximal size
1068 FontInfo maxfont = font.fontInfo();
1069 maxfont.setSize(maxsize);
1070 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1071 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1072 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1075 // This is nicer with box insets:
1079 ParagraphList const & pars = text_->paragraphs();
1080 Inset const & inset = text_->inset();
1082 // is it a top line?
1083 if (row.pos() == 0 && topBottomSpace) {
1084 BufferParams const & bufparams = buffer.params();
1085 // some parskips VERY EASY IMPLEMENTATION
1086 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1087 && !inset.getLayout().parbreakIsNewline()
1088 && !par.layout().parbreak_is_newline
1090 && ((layout.isParagraph() && par.getDepth() == 0)
1091 || (pars[pit - 1].layout().isParagraph()
1092 && pars[pit - 1].getDepth() == 0))) {
1093 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1096 if (par.params().startOfAppendix())
1097 maxasc += int(3 * dh);
1099 // special code for the top label
1100 if (layout.labelIsAbove()
1101 && (!layout.isParagraphGroup() || 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 || row.pos() != 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 (row.endpos() >= 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;
1149 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1150 double usual = pars[cpit].layout().bottomsep * dh;
1152 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1153 if (pars[cpit].layout() != pars[nextpit].layout()
1154 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1156 unusual = pars[cpit].layout().bottomsep * dh;
1158 layoutdesc = max(unusual, usual);
1159 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1160 if (pars[cpit].layout() != pars[nextpit].layout()
1161 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1162 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1167 // incalculate the layout spaces
1168 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1169 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1171 // FIXME: the correct way is to do the following is to move the
1172 // following code in another method specially tailored for the
1173 // main Text. The following test is thus bogus.
1174 // Top and bottom margin of the document (only at top-level)
1175 if (main_text_ && topBottomSpace) {
1176 if (pit == 0 && row.pos() == 0)
1178 if (pit + 1 == pit_type(pars.size()) &&
1179 row.endpos() == par.size() &&
1180 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1184 row.dimension().asc = maxasc + labeladdon;
1185 row.dimension().des = 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 const 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_on_lastrow = lastrow ? text_->isRTL(par) : false;
1236 while (vc < end && tmpx <= x) {
1237 c = bidi.vis2log(vc);
1239 if (body_pos > 0 && c == body_pos - 1) {
1240 FontMetrics const & fm = theFontMetrics(
1241 text_->labelFont(par));
1242 tmpx += row.label_hfill + fm.width(layout.labelsep);
1243 if (par.isLineSeparator(body_pos - 1))
1244 tmpx -= singleWidth(pit, body_pos - 1);
1247 tmpx += singleWidth(pit, c);
1248 if (par.isSeparator(c) && c >= body_pos)
1249 tmpx += row.separator;
1253 if ((tmpx + last_tmpx) / 2 > x) {
1258 // This shouldn't happen. But we can reset and try to continue.
1259 LASSERT(vc <= end, vc = end);
1264 ((rtl_on_lastrow && left_side && vc == row.pos() && x < tmpx - 5) ||
1265 (!rtl_on_lastrow && !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 LBUFERR(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;
1381 ParagraphMetrics const & pm = it->second;
1383 if (y < it->second.position() - int(pm.ascent())) {
1384 // We are looking for a position that is before the first paragraph in
1385 // the cache (which is in priciple off-screen, that is before the
1388 // We are already at the first paragraph in the inset.
1390 // OK, this is the paragraph we are looking for.
1391 pit = it->first - 1;
1396 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1398 if (y >= last->second.position() + int(pm_last.descent())) {
1399 // We are looking for a position that is after the last paragraph in
1400 // the cache (which is in priciple off-screen), that is before the
1402 pit = last->first + 1;
1403 if (pit == int(text_->paragraphs().size()))
1404 // We are already at the last paragraph in the inset.
1406 // OK, this is the paragraph we are looking for.
1407 newParMetricsDown();
1411 for (; it != et; ++it) {
1412 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1413 << " y: " << it->second.position());
1415 ParagraphMetrics const & pm = par_metrics_[it->first];
1417 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1419 yy = it->second.position();
1423 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1429 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1430 bool assert_in_view, bool up)
1432 ParagraphMetrics const & pm = par_metrics_[pit];
1434 int yy = pm.position() - pm.ascent();
1435 LBUFERR(!pm.rows().empty());
1436 RowList::const_iterator rit = pm.rows().begin();
1437 RowList::const_iterator rlast = pm.rows().end();
1439 for (; rit != rlast; yy += rit->height(), ++rit)
1440 if (yy + rit->height() > y)
1443 if (assert_in_view) {
1444 if (!up && yy + rit->height() > y) {
1445 if (rit != pm.rows().begin()) {
1448 } else if (pit != 0) {
1451 ParagraphMetrics const & pm2 = par_metrics_[pit];
1452 rit = pm2.rows().end();
1456 } else if (up && yy != y) {
1458 y = yy + rit->height();
1460 } else if (pit < int(text_->paragraphs().size()) - 1) {
1462 newParMetricsDown();
1463 ParagraphMetrics const & pm2 = par_metrics_[pit];
1464 rit = pm2.rows().begin();
1473 // x,y are absolute screen coordinates
1474 // sets cursor recursively descending into nested editable insets
1475 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1476 bool assert_in_view, bool up)
1478 if (lyxerr.debugging(Debug::WORKAREA)) {
1479 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1480 cur.bv().coordCache().dump();
1482 pit_type pit = getPitNearY(y);
1483 LASSERT(pit != -1, return 0);
1485 int yy = y; // is modified by getPitAndRowNearY
1486 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1490 // Do we cover an inset?
1491 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1494 // No inset, set position in the text
1495 bool bound = false; // is modified by getColumnNearX
1496 int xx = x; // is modified by getColumnNearX
1497 cur.pos() = row.pos()
1498 + getColumnNearX(pit, row, xx, bound);
1499 cur.boundary(bound);
1500 cur.setCurrentFont();
1505 Inset * inset = it->inset;
1506 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1508 // Set position in front of inset
1509 cur.pos() = it->pos;
1510 cur.boundary(false);
1513 // Try to descend recursively inside the inset.
1514 inset = inset->editXY(cur, x, yy);
1516 if (cur.top().text() == text_)
1517 cur.setCurrentFont();
1522 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1524 LASSERT(text_ == cur.text(), return);
1525 pit_type const pit = getPitNearY(y);
1526 LASSERT(pit != -1, return);
1528 ParagraphMetrics const & pm = par_metrics_[pit];
1530 int yy = pm.position() - pm.ascent();
1531 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1532 " pit: " << pit << " yy: " << yy);
1535 LBUFERR(pm.rows().size());
1536 for (; r < int(pm.rows().size()) - 1; ++r) {
1537 Row const & row = pm.rows()[r];
1538 if (int(yy + row.height()) > y)
1543 Row const & row = pm.rows()[r];
1545 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1549 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1551 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1553 text_->setCursor(cur, pit, pos, true, bound);
1554 // remember new position.
1559 //takes screen x,y coordinates
1560 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1562 Paragraph const & par = text_->paragraphs()[pit];
1563 ParagraphMetrics const & pm = par_metrics_[pit];
1565 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1567 InsetList::const_iterator iit = par.insetList().begin();
1568 InsetList::const_iterator iend = par.insetList().end();
1569 for (; iit != iend; ++iit) {
1570 Inset * inset = iit->inset;
1572 LYXERR(Debug::DEBUG, "examining inset " << inset);
1574 if (!bv_->coordCache().getInsets().has(inset)) {
1575 LYXERR(Debug::DEBUG, "inset has no cached position");
1579 Dimension const & dim = pm.insetDimension(inset);
1580 Point p = bv_->coordCache().getInsets().xy(inset);
1582 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1583 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1586 && x <= p.x_ + dim.wid
1587 && y >= p.y_ - dim.asc
1588 && y <= p.y_ + dim.des) {
1589 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1590 return const_cast<InsetList::InsetTable *>(&(*iit));
1594 LYXERR(Debug::DEBUG, "No inset hit. ");
1599 //takes screen x,y coordinates
1600 Inset * TextMetrics::checkInsetHit(int x, int y)
1602 pit_type const pit = getPitNearY(y);
1603 LASSERT(pit != -1, return 0);
1604 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1613 int TextMetrics::cursorX(CursorSlice const & sl,
1614 bool boundary) const
1616 LASSERT(sl.text() == text_, return 0);
1617 pit_type const pit = sl.pit();
1618 Paragraph const & par = text_->paragraphs()[pit];
1619 ParagraphMetrics const & pm = par_metrics_[pit];
1620 if (pm.rows().empty())
1623 pos_type ppos = sl.pos();
1624 // Correct position in front of big insets
1625 bool const boundary_correction = ppos != 0 && boundary;
1626 if (boundary_correction)
1629 Row const & row = pm.getRow(sl.pos(), boundary);
1631 pos_type cursor_vpos = 0;
1633 Buffer const & buffer = bv_->buffer();
1636 bidi.computeTables(par, buffer, row);
1638 pos_type const row_pos = row.pos();
1639 pos_type const end = row.endpos();
1640 // Spaces at logical line breaks in bidi text must be skipped during
1641 // cursor positioning. However, they may appear visually in the middle
1642 // of a row; they must be skipped, wherever they are...
1643 // * logically "abc_[HEBREW_\nHEBREW]"
1644 // * visually "abc_[_WERBEH\nWERBEH]"
1645 pos_type skipped_sep_vpos = -1;
1648 cursor_vpos = row_pos;
1649 else if (ppos >= end)
1650 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1651 else if (ppos > row_pos && ppos >= end)
1652 //FIXME: this code is never reached!
1653 // (see http://www.lyx.org/trac/changeset/8251)
1654 // Place cursor after char at (logical) position pos - 1
1655 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1656 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1658 // Place cursor before char at (logical) position ppos
1659 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1660 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1662 pos_type body_pos = par.beginOfBody();
1664 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1667 // check for possible inline completion in this row
1668 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1669 pos_type inlineCompletionVPos = -1;
1670 if (inlineCompletionPos.inTexted()
1671 && inlineCompletionPos.text() == text_
1672 && inlineCompletionPos.pit() == pit
1673 && inlineCompletionPos.pos() - 1 >= row_pos
1674 && inlineCompletionPos.pos() - 1 < end) {
1675 // draw logically behind the previous character
1676 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1679 // Use font span to speed things up, see below
1683 // If the last logical character is a separator, skip it, unless
1684 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1685 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1686 skipped_sep_vpos = bidi.log2vis(end - 1);
1688 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1689 ParagraphList const & pars_ = text_->paragraphs();
1690 if (size_type(pit + 1) < pars_.size()) {
1692 docstring const s = docstring(1, char_type(0x00B6));
1693 x += theFontMetrics(f).width(s);
1697 // Inline completion RTL special case row_pos == cursor_pos:
1698 // "__|b" => cursor_pos is right of __
1699 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1700 font = displayFont(pit, row_pos + 1);
1701 docstring const & completion = bv_->inlineCompletion();
1702 if (font.isRightToLeft() && completion.length() > 0)
1703 x += theFontMetrics(font.fontInfo()).width(completion);
1706 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1707 // Skip the separator which is at the logical end of the row
1708 if (vpos == skipped_sep_vpos)
1710 pos_type pos = bidi.vis2log(vpos);
1711 if (body_pos > 0 && pos == body_pos - 1) {
1712 FontMetrics const & labelfm = theFontMetrics(
1713 text_->labelFont(par));
1714 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1715 if (par.isLineSeparator(body_pos - 1))
1716 x -= singleWidth(pit, body_pos - 1);
1719 // Use font span to speed things up, see above
1720 if (pos < font_span.first || pos > font_span.last) {
1721 font_span = par.fontSpan(pos);
1722 font = displayFont(pit, pos);
1725 x += pm.singleWidth(pos, font);
1727 // Inline completion RTL case:
1728 // "a__|b", __ of b => non-boundary a-pos is right of __
1729 if (vpos + 1 == inlineCompletionVPos
1730 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1731 font = displayFont(pit, vpos + 1);
1732 docstring const & completion = bv_->inlineCompletion();
1733 if (font.isRightToLeft() && completion.length() > 0)
1734 x += theFontMetrics(font.fontInfo()).width(completion);
1737 // Inline completion LTR case:
1738 // "b|__a", __ of b => non-boundary a-pos is in front of __
1739 if (vpos == inlineCompletionVPos
1740 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1741 font = displayFont(pit, vpos);
1742 docstring const & completion = bv_->inlineCompletion();
1743 if (!font.isRightToLeft() && completion.length() > 0)
1744 x += theFontMetrics(font.fontInfo()).width(completion);
1747 if (par.isSeparator(pos) && pos >= body_pos)
1751 // see correction above
1752 if (boundary_correction) {
1753 if (isRTL(sl, boundary))
1754 x -= singleWidth(pit, ppos);
1756 x += singleWidth(pit, ppos);
1763 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1765 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1766 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1767 if (pm.rows().empty())
1771 h -= par_metrics_[0].rows()[0].ascent();
1772 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1773 h += par_metrics_[pit].height();
1776 if (pos && boundary)
1778 size_t const rend = pm.pos2row(pos);
1779 for (size_t rit = 0; rit != rend; ++rit)
1780 h += pm.rows()[rit].height();
1781 h += pm.rows()[rend].ascent();
1786 // the cursor set functions have a special mechanism. When they
1787 // realize you left an empty paragraph, they will delete it.
1789 bool TextMetrics::cursorHome(Cursor & cur)
1791 LASSERT(text_ == cur.text(), return false);
1792 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1793 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1794 return text_->setCursor(cur, cur.pit(), row.pos());
1798 bool TextMetrics::cursorEnd(Cursor & cur)
1800 LASSERT(text_ == cur.text(), return false);
1801 // if not on the last row of the par, put the cursor before
1802 // the final space exept if I have a spanning inset or one string
1803 // is so long that we force a break.
1804 pos_type end = cur.textRow().endpos();
1806 // empty text, end-1 is no valid position
1808 bool boundary = false;
1809 if (end != cur.lastpos()) {
1810 if (!cur.paragraph().isLineSeparator(end-1)
1811 && !cur.paragraph().isNewline(end-1))
1816 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1820 void TextMetrics::deleteLineForward(Cursor & cur)
1822 LASSERT(text_ == cur.text(), return);
1823 if (cur.lastpos() == 0) {
1824 // Paragraph is empty, so we just go forward
1825 text_->cursorForward(cur);
1828 cur.setSelection(true); // to avoid deletion
1831 // What is this test for ??? (JMarc)
1832 if (!cur.selection())
1833 text_->deleteWordForward(cur);
1835 cap::cutSelection(cur, true, false);
1836 cur.checkBufferStructure();
1841 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1843 ParagraphList const & pars = text_->paragraphs();
1844 return row.endpos() >= pars[pit].size()
1845 && pit + 1 == pit_type(pars.size());
1849 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1851 return row.pos() == 0 && pit == 0;
1855 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1857 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1861 int TextMetrics::leftMargin(int max_width,
1862 pit_type const pit, pos_type const pos) const
1864 ParagraphList const & pars = text_->paragraphs();
1866 LASSERT(pit >= 0, return 0);
1867 LASSERT(pit < int(pars.size()), return 0);
1868 Paragraph const & par = pars[pit];
1869 LASSERT(pos >= 0, return 0);
1870 LASSERT(pos <= par.size(), return 0);
1871 Buffer const & buffer = bv_->buffer();
1872 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1873 DocumentClass const & tclass = buffer.params().documentClass();
1874 Layout const & layout = par.layout();
1876 docstring parindent = layout.parindent;
1880 if (text_->isMainText())
1881 l_margin += bv_->leftMargin();
1883 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1884 tclass.leftmargin());
1886 if (par.getDepth() != 0) {
1887 // find the next level paragraph
1888 pit_type newpar = text_->outerHook(pit);
1889 if (newpar != pit_type(pars.size())) {
1890 if (pars[newpar].layout().isEnvironment()) {
1891 l_margin = leftMargin(max_width, newpar);
1892 // Remove the parindent that has been added
1893 // if the paragraph was empty.
1894 if (pars[newpar].empty()) {
1895 docstring pi = pars[newpar].layout().parindent;
1896 l_margin -= theFontMetrics(
1897 buffer.params().getFont()).signedWidth(pi);
1900 if (tclass.isDefaultLayout(par.layout())
1901 || tclass.isPlainLayout(par.layout())) {
1902 if (pars[newpar].params().noindent())
1905 parindent = pars[newpar].layout().parindent;
1910 // This happens after sections or environments in standard classes.
1911 // We have to check the previous layout at same depth.
1912 if (tclass.isDefaultLayout(par.layout()) && pit > 0
1913 && pars[pit - 1].getDepth() >= par.getDepth()) {
1914 pit_type prev = text_->depthHook(pit, par.getDepth());
1915 if (pars[prev < pit ? prev : pit - 1].layout().nextnoindent)
1919 FontInfo const labelfont = text_->labelFont(par);
1920 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1922 switch (layout.margintype) {
1923 case MARGIN_DYNAMIC:
1924 if (!layout.leftmargin.empty()) {
1925 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1928 if (!par.labelString().empty()) {
1929 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1930 l_margin += labelfont_metrics.width(par.labelString());
1931 l_margin += labelfont_metrics.width(layout.labelsep);
1935 case MARGIN_MANUAL: {
1936 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1937 // The width of an empty par, even with manual label, should be 0
1938 if (!par.empty() && pos >= par.beginOfBody()) {
1939 if (!par.getLabelWidthString().empty()) {
1940 docstring labstr = par.getLabelWidthString();
1941 l_margin += labelfont_metrics.width(labstr);
1942 l_margin += labelfont_metrics.width(layout.labelsep);
1948 case MARGIN_STATIC: {
1949 l_margin += theFontMetrics(buffer.params().getFont()).
1950 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1954 case MARGIN_FIRST_DYNAMIC:
1955 if (layout.labeltype == LABEL_MANUAL) {
1956 // if we are at position 0, we are never in the body
1957 if (pos > 0 && pos >= par.beginOfBody())
1958 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1960 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1962 // Special case to fix problems with
1964 || (layout.labeltype == LABEL_STATIC
1965 && layout.latextype == LATEX_ENVIRONMENT
1966 && !text_->isFirstInSequence(pit))) {
1967 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1968 } else if (!layout.labelIsAbove()) {
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 // The left margin depends on the widest row in this paragraph.
1978 // This code is wrong because it depends on the rows, but at the
1979 // same time this function is used in redoParagraph to construct
1981 ParagraphMetrics const & pm = par_metrics_[pit];
1982 RowList::const_iterator rit = pm.rows().begin();
1983 RowList::const_iterator end = pm.rows().end();
1984 int minfill = max_width;
1985 for ( ; rit != end; ++rit)
1986 if (rit->fill() < minfill)
1987 minfill = rit->fill();
1988 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1989 l_margin += minfill;
1991 // also wrong, but much shorter.
1992 l_margin += max_width / 2;
1997 if (!par.params().leftIndent().zero())
1998 l_margin += par.params().leftIndent().inPixels(max_width);
2002 if (par.params().align() == LYX_ALIGN_LAYOUT)
2003 align = layout.align;
2005 align = par.params().align();
2007 // set the correct parindent
2009 && (layout.labeltype == LABEL_NO_LABEL
2010 || layout.labeltype == LABEL_ABOVE
2011 || layout.labeltype == LABEL_CENTERED
2012 || (layout.labeltype == LABEL_STATIC
2013 && layout.latextype == LATEX_ENVIRONMENT
2014 && !text_->isFirstInSequence(pit)))
2015 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
2016 && !par.params().noindent()
2017 // in some insets, paragraphs are never indented
2018 && !text_->inset().neverIndent()
2019 // display style insets are always centered, omit indentation
2022 && par.getInset(pos)->display())
2023 && (!(tclass.isDefaultLayout(par.layout())
2024 || tclass.isPlainLayout(par.layout()))
2025 || buffer.params().paragraph_separation
2026 == BufferParams::ParagraphIndentSeparation)
2029 // use the parindent of the layout when the default indentation is
2030 // used otherwise use the indentation set in the document settings
2031 if (buffer.params().getIndentation().asLyXCommand() == "default")
2032 l_margin += theFontMetrics(
2033 buffer.params().getFont()).signedWidth(parindent);
2035 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2042 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2044 ParagraphMetrics const & pm = par_metrics_[pit];
2046 return pm.singleWidth(pos, displayFont(pit, pos));
2050 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2052 if (par_metrics_.empty())
2058 ParMetricsCache::iterator it = par_metrics_.begin();
2059 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2060 y -= it->second.ascent();
2061 for (; it != pm_end; ++it) {
2062 ParagraphMetrics const & pmi = it->second;
2064 pit_type const pit = it->first;
2065 // Save the paragraph position in the cache.
2066 it->second.setPosition(y);
2067 drawParagraph(pi, pit, x, y);
2073 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2075 BufferParams const & bparams = bv_->buffer().params();
2076 ParagraphMetrics const & pm = par_metrics_[pit];
2077 if (pm.rows().empty())
2081 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2082 int const ww = bv_->workHeight();
2083 size_t const nrows = pm.rows().size();
2085 Cursor const & cur = bv_->cursor();
2086 DocIterator sel_beg = cur.selectionBegin();
2087 DocIterator sel_end = cur.selectionEnd();
2088 bool selection = cur.selection()
2089 // This is our text.
2090 && cur.text() == text_
2091 // if the anchor is outside, this is not our selection
2092 && cur.normalAnchor().text() == text_
2093 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2095 // We store the begin and end pos of the selection relative to this par
2096 DocIterator sel_beg_par = cur.selectionBegin();
2097 DocIterator sel_end_par = cur.selectionEnd();
2099 // We care only about visible selection.
2101 if (pit != sel_beg.pit()) {
2102 sel_beg_par.pit() = pit;
2103 sel_beg_par.pos() = 0;
2105 if (pit != sel_end.pit()) {
2106 sel_end_par.pit() = pit;
2107 sel_end_par.pos() = sel_end_par.lastpos();
2111 for (size_t i = 0; i != nrows; ++i) {
2113 Row const & row = pm.rows()[i];
2117 bool const inside = (y + row.descent() >= 0
2118 && y - row.ascent() < ww);
2119 // It is not needed to draw on screen if we are not inside.
2120 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2121 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2124 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2126 row.setSelection(-1, -1);
2128 // The row knows nothing about the paragraph, so we have to check
2129 // whether this row is the first or last and update the margins.
2130 if (row.selection()) {
2131 if (row.sel_beg == 0)
2132 row.begin_margin_sel = sel_beg.pit() < pit;
2133 if (row.sel_end == sel_end_par.lastpos())
2134 row.end_margin_sel = sel_end.pit() > pit;
2137 // Row signature; has row changed since last paint?
2138 row.setCrc(pm.computeRowSignature(row, bparams));
2139 bool row_has_changed = row.changed();
2141 // Take this opportunity to spellcheck the row contents.
2142 if (row_has_changed && lyxrc.spellcheck_continuously) {
2143 text_->getPar(pit).spellCheck();
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 // Instrumentation for testing row cache (see also
2165 if (lyxerr.debugging(Debug::PAINTING) && inside
2166 && (row.selection() || pi.full_repaint || row_has_changed)) {
2167 string const foreword = text_->isMainText() ?
2168 "main text redraw " : "inset text redraw: ";
2169 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2170 << " row_selection=" << row.selection()
2171 << " full_repaint=" << pi.full_repaint
2172 << " row_has_changed=" << row_has_changed);
2175 // Backup full_repaint status and force full repaint
2176 // for inner insets as the Row has been cleared out.
2177 bool tmp = pi.full_repaint;
2178 pi.full_repaint = true;
2180 rp.paintSelection();
2183 rp.paintChangeBar();
2184 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2185 if (i == 0 && !is_rtl)
2187 if (i == nrows - 1 && is_rtl)
2190 if (i == nrows - 1 && !is_rtl)
2192 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::completionPosAndDim(Cursor const & cur, int & x, int & y,
2207 Dimension & dim) const
2209 Cursor const & bvcur = cur.bv().cursor();
2211 // get word in front of cursor
2212 docstring word = text_->previousWord(bvcur.top());
2213 DocIterator wordStart = bvcur;
2214 wordStart.pos() -= word.length();
2216 // get position on screen of the word start and end
2217 //FIXME: Is it necessary to explicitly set this to false?
2218 wordStart.boundary(false);
2219 Point lxy = cur.bv().getPos(wordStart);
2220 Point rxy = cur.bv().getPos(bvcur);
2222 // calculate dimensions of the word
2224 row.pos(wordStart.pos());
2225 row.endpos(bvcur.pos());
2226 setRowHeight(row, bvcur.pit(), false);
2227 dim = row.dimension();
2228 dim.wid = abs(rxy.x_ - lxy.x_);
2230 // calculate position of word
2232 x = min(rxy.x_, lxy.x_);
2234 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2235 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2238 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2240 // ParagraphMetrics const & pm = par_metrics_[pit];
2241 // Row const & r = pm.rows()[row];
2247 int defaultRowHeight()
2249 return int(theFontMetrics(sane_font).maxHeight() * 1.2);