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"
23 #include "buffer_funcs.h"
24 #include "BufferParams.h"
25 #include "BufferView.h"
26 #include "CoordCache.h"
28 #include "CutAndPaste.h"
30 #include "InsetList.h"
33 #include "MetricsInfo.h"
34 #include "ParagraphParameters.h"
35 #include "RowPainter.h"
37 #include "TextClass.h"
40 #include "insets/InsetText.h"
42 #include "mathed/MathMacroTemplate.h"
44 #include "frontends/FontMetrics.h"
45 #include "frontends/Painter.h"
47 #include "support/debug.h"
48 #include "support/lassert.h"
57 using frontend::FontMetrics;
61 int numberOfSeparators(Row const & row)
64 Row::const_iterator cit = row.begin();
65 Row::const_iterator const end = row.end();
66 for ( ; cit != end ; ++cit)
67 if (cit->type == Row::SEPARATOR)
73 void setSeparatorWidth(Row & row, double w)
76 Row::iterator it = row.begin();
77 Row::iterator const end = row.end();
78 for ( ; it != end ; ++it)
79 if (it->type == Row::SEPARATOR)
84 int numberOfLabelHfills(Paragraph const & par, Row const & row)
86 pos_type last = row.endpos() - 1;
87 pos_type first = row.pos();
89 // hfill *DO* count at the beginning of paragraphs!
91 while (first < last && par.isHfill(first))
95 last = min(last, par.beginOfBody());
97 for (pos_type p = first; p < last; ++p) {
105 int numberOfHfills(Row const & row, pos_type const body_pos)
108 Row::const_iterator cit = row.begin();
109 Row::const_iterator const end = row.end();
110 for ( ; cit != end ; ++cit)
111 if (cit->pos >= body_pos
112 && cit->inset && cit->inset->isHfill())
120 /////////////////////////////////////////////////////////////////////
124 /////////////////////////////////////////////////////////////////////
127 TextMetrics::TextMetrics(BufferView * bv, Text * text)
128 : bv_(bv), text_(text)
131 max_width_ = bv_->workWidth();
132 dim_.wid = max_width_;
138 bool TextMetrics::contains(pit_type pit) const
140 return par_metrics_.find(pit) != par_metrics_.end();
144 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
146 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
151 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
153 ParMetricsCache::const_iterator it = par_metrics_.begin();
154 return make_pair(it->first, &it->second);
158 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
160 LBUFERR(!par_metrics_.empty());
161 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
162 return make_pair(it->first, &it->second);
166 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
168 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
169 if (pmc_it == par_metrics_.end()) {
170 pmc_it = par_metrics_.insert(
171 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
173 if (pmc_it->second.rows().empty() && redo)
175 return pmc_it->second;
179 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
181 LBUFERR(mi.base.textwidth > 0);
182 max_width_ = mi.base.textwidth;
183 // backup old dimension.
184 Dimension const old_dim = dim_;
187 dim_.wid = min_width;
188 pit_type const npar = text_->paragraphs().size();
190 // If there is more than one row, expand the text to
191 // the full allowable width.
192 dim_.wid = max_width_;
194 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
195 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
197 bool changed = false;
199 for (pit_type pit = 0; pit != npar; ++pit) {
200 changed |= redoParagraph(pit);
201 ParagraphMetrics const & pm = par_metrics_[pit];
203 if (dim_.wid < pm.width())
204 dim_.wid = pm.width();
207 dim_.asc = par_metrics_[0].ascent();
208 dim_.des = h - dim_.asc;
209 //lyxerr << "dim_.wid " << dim_.wid << endl;
210 //lyxerr << "dim_.asc " << dim_.asc << endl;
211 //lyxerr << "dim_.des " << dim_.des << endl;
213 changed |= dim_ != old_dim;
219 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
221 return main_text_? pm.rightMargin(*bv_) : 0;
225 int TextMetrics::rightMargin(pit_type const pit) const
227 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
231 void TextMetrics::applyOuterFont(Font & font) const
233 FontInfo lf(font_.fontInfo());
234 lf.reduce(bv_->buffer().params().getFont().fontInfo());
235 font.fontInfo().realize(lf);
239 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
241 LASSERT(pos >= 0, { static Font f; return f; });
243 ParagraphList const & pars = text_->paragraphs();
244 Paragraph const & par = pars[pit];
245 Layout const & layout = par.layout();
246 Buffer const & buffer = bv_->buffer();
248 BufferParams const & params = buffer.params();
249 pos_type const body_pos = par.beginOfBody();
251 // We specialize the 95% common case:
252 if (!par.getDepth()) {
253 Font f = par.getFontSettings(params, pos);
254 if (!text_->isMainText())
256 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
258 FontInfo const & lf = lab ? layout.labelfont : layout.font;
259 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
261 // In case the default family has been customized
262 if (lf.family() == INHERIT_FAMILY)
263 rlf.setFamily(params.getFont().fontInfo().family());
264 f.fontInfo().realize(rlf);
268 // The uncommon case need not be optimized as much
269 FontInfo const & layoutfont = pos < body_pos ?
270 layout.labelfont : layout.font;
272 Font font = par.getFontSettings(params, pos);
273 font.fontInfo().realize(layoutfont);
275 if (!text_->isMainText())
276 applyOuterFont(font);
278 // Realize against environment font information
279 // NOTE: the cast to pit_type should be removed when pit_type
280 // changes to a unsigned integer.
281 if (pit < pit_type(pars.size()))
282 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
284 // Realize with the fonts of lesser depth.
285 font.fontInfo().realize(params.getFont().fontInfo());
291 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
297 if (boundary && sl.pos() > 0)
300 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
304 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
306 // no RTL boundary at paragraph start
310 Font const & left_font = displayFont(pit, pos - 1);
312 return isRTLBoundary(pit, pos, left_font);
316 // isRTLBoundary returns false on a real end-of-line boundary,
317 // because otherwise the two boundary types get mixed up.
318 // This is the whole purpose of this being in TextMetrics.
319 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
320 Font const & font) const
322 if (// no RTL boundary at paragraph start
324 // if the metrics have not been calculated, then we are not
325 // on screen and can safely ignore issues about boundaries.
329 ParagraphMetrics & pm = par_metrics_[pit];
330 // no RTL boundary in empty paragraph
331 if (pm.rows().empty())
334 pos_type endpos = pm.getRow(pos - 1, false).endpos();
335 pos_type startpos = pm.getRow(pos, false).pos();
336 // no RTL boundary at line start:
337 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
339 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
342 Paragraph const & par = text_->getPar(pit);
343 // no RTL boundary at line break:
344 // abc|\n -> move right -> abc\n (and not: abc\n|
346 if (startpos == pos && endpos == pos && endpos != par.size()
347 && (par.isNewline(pos - 1)
348 || par.isEnvSeparator(pos - 1)
349 || par.isLineSeparator(pos - 1)
350 || par.isSeparator(pos - 1)))
353 bool left = font.isVisibleRightToLeft();
355 if (pos == par.size())
356 right = par.isRTL(bv_->buffer().params());
358 right = displayFont(pit, pos).isVisibleRightToLeft();
360 return left != right;
364 bool TextMetrics::redoParagraph(pit_type const pit)
366 Paragraph & par = text_->getPar(pit);
367 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
368 // redoParagraph() recursively inside parMetrics.
369 Dimension old_dim = parMetrics(pit, false).dim();
370 ParagraphMetrics & pm = par_metrics_[pit];
373 Buffer & buffer = bv_->buffer();
374 main_text_ = (text_ == &buffer.text());
375 bool changed = false;
377 // Check whether there are InsetBibItems that need fixing
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 if (par.brokenBiblio()) {
385 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
386 // In some cases, we do not know how to record undo
387 if (&cur.inset() == &text_->inset())
388 cur.recordUndo(ATOMIC_UNDO, pit, pit);
390 int const moveCursor = par.fixBiblio(buffer);
392 // Is it necessary to update the cursor?
393 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
396 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
401 // Optimisation: this is used in the next two loops
402 // so better to calculate that once here.
403 int const right_margin = rightMargin(pm);
405 // iterator pointing to paragraph to resolve macros
406 DocIterator parPos = text_->macrocontextPosition();
410 LYXERR(Debug::INFO, "MacroContext not initialised!"
411 << " Going through the buffer again and hope"
412 << " the context is better then.");
413 // FIXME audit updateBuffer calls
414 // This should not be here, but it is not clear yet where else it
416 bv_->buffer().updateBuffer();
417 parPos = text_->macrocontextPosition();
418 LBUFERR(!parPos.empty());
423 Font const bufferfont = buffer.params().getFont();
424 InsetList::const_iterator ii = par.insetList().begin();
425 InsetList::const_iterator iend = par.insetList().end();
426 for (; ii != iend; ++ii) {
427 // FIXME Doesn't this HAVE to be non-empty?
428 // position already initialized?
429 if (!parPos.empty()) {
430 parPos.pos() = ii->pos;
432 // A macro template would normally not be visible
433 // by itself. But the tex macro semantics allow
434 // recursion, so we artifically take the context
435 // after the macro template to simulate this.
436 if (ii->inset->lyxCode() == MATHMACRO_CODE)
440 // do the metric calculation
442 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
444 Font const & font = ii->inset->inheritFont() ?
445 displayFont(pit, ii->pos) : bufferfont;
446 MacroContext mc(&buffer, parPos);
447 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
448 ii->inset->metrics(mi, dim);
449 Dimension const old_dim = pm.insetDimension(ii->inset);
450 if (old_dim != dim) {
451 pm.setInsetDimension(ii->inset, dim);
456 par.setBeginOfBody();
458 size_t row_index = 0;
459 // maximum pixel width of a row
461 if (row_index == pm.rows().size())
462 pm.rows().push_back(Row());
463 Row & row = pm.rows()[row_index];
465 breakRow(row, right_margin, pit);
466 setRowHeight(row, pit);
467 row.setChanged(false);
468 if (row_index || row.endpos() < par.size())
469 // If there is more than one row, expand the text to
470 // the full allowable width. This setting here is needed
471 // for the computeRowMetrics() below.
472 dim_.wid = max_width_;
473 int const max_row_width = max(dim_.wid, row.width());
474 computeRowMetrics(pit, row, max_row_width);
475 first = row.endpos();
478 pm.dim().wid = max(pm.dim().wid, row.width());
479 pm.dim().des += row.height();
480 } while (first < par.size());
482 if (row_index < pm.rows().size())
483 pm.rows().resize(row_index);
485 // Make sure that if a par ends in newline, there is one more row
487 if (first > 0 && par.isNewline(first - 1)) {
488 if (row_index == pm.rows().size())
489 pm.rows().push_back(Row());
490 Row & row = pm.rows()[row_index];
493 setRowHeight(row, pit);
494 row.setChanged(false);
495 int const max_row_width = max(dim_.wid, row.width());
496 computeRowMetrics(pit, row, max_row_width);
497 pm.dim().des += row.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 int TextMetrics::getAlign(Paragraph const & par, pos_type const pos) const
511 Layout const & layout = par.layout();
514 if (par.params().align() == LYX_ALIGN_LAYOUT)
515 align = layout.align;
517 align = par.params().align();
519 // handle alignment inside tabular cells
520 Inset const & owner = text_->inset();
521 switch (owner.contentAlignment()) {
522 case LYX_ALIGN_CENTER:
524 case LYX_ALIGN_RIGHT:
525 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
526 align = owner.contentAlignment();
529 // unchanged (use align)
533 // Display-style insets should always be on a centered row
534 if (Inset const * inset = par.getInset(pos)) {
535 switch (inset->display()) {
536 case Inset::AlignLeft:
537 align = LYX_ALIGN_BLOCK;
539 case Inset::AlignCenter:
540 align = LYX_ALIGN_CENTER;
543 // unchanged (use align)
545 case Inset::AlignRight:
546 align = LYX_ALIGN_RIGHT;
551 // Has the user requested we not justify stuff?
552 if (!bv_->buffer().params().justification
553 && align == LYX_ALIGN_BLOCK)
554 align = LYX_ALIGN_LEFT;
560 void TextMetrics::computeRowMetrics(pit_type const pit,
561 Row & row, int width) const
566 Paragraph const & par = text_->getPar(pit);
568 double const w = width - row.right_margin - row.width();
569 // FIXME: put back this assertion when the crash on new doc is solved.
570 //LASSERT(w >= 0, /**/);
572 bool const is_rtl = text_->isRTL(par);
574 row.x = rightMargin(pit);
576 row.x = leftMargin(max_width_, pit, row.pos());
578 // is there a manual margin with a manual label
579 Layout const & layout = par.layout();
582 if (layout.margintype == MARGIN_MANUAL
583 && layout.labeltype == LABEL_MANUAL) {
584 /// We might have real hfills in the label part
585 nlh = numberOfLabelHfills(par, row);
587 // A manual label par (e.g. List) has an auto-hfill
588 // between the label text and the body of the
590 // But we don't want to do this auto hfill if the par
595 if (nlh && !par.getLabelWidthString().empty())
596 row.label_hfill = labelFill(pit, row) / double(nlh);
600 // are there any hfills in the row?
601 if (int const nh = numberOfHfills(row, par.beginOfBody())) {
603 hfill = w / double(nh);
604 // we don't have to look at the alignment if it is ALIGN_LEFT and
605 // if the row is already larger then the permitted width as then
606 // we force the LEFT_ALIGN'edness!
607 } else if (int(row.width()) < max_width_) {
608 // is it block, flushleft or flushright?
609 // set x how you need it
610 switch (getAlign(par, row.pos())) {
611 case LYX_ALIGN_BLOCK: {
612 int const ns = numberOfSeparators(row);
613 /** If we have separators, and this row has
614 * not be broken abruptly by a display inset
615 * or newline, then stretch it */
616 if (ns && !row.right_boundary()
617 && row.endpos() != par.size()) {
618 setSeparatorWidth(row, w / ns);
619 row.dimension().wid = width;
621 row.dimension().wid = width;
626 case LYX_ALIGN_RIGHT:
629 case LYX_ALIGN_CENTER:
630 row.dimension().wid = width - w / 2;
638 pos_type body_pos = par.beginOfBody();
639 pos_type end = row.endpos();
642 && (body_pos > end || !par.isLineSeparator(body_pos - 1))) {
643 row.x += theFontMetrics(text_->labelFont(par)).
644 width(layout.labelsep);
646 row.x += row.label_hfill;
651 // Finally, handle hfill insets
652 pos_type const endpos = row.endpos();
653 pos_type body_pos = par.beginOfBody();
655 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
657 ParagraphMetrics & pm = par_metrics_[pit];
658 Row::iterator cit = row.begin();
659 Row::iterator const cend = row.end();
660 for ( ; cit != cend; ++cit) {
661 if (row.label_hfill && cit->endpos == body_pos
662 && cit->type == Row::SPACE)
663 cit->dim.wid -= row.label_hfill * (nlh - 1);
664 if (!cit->inset || !cit->inset->isHfill())
666 if (pm.hfillExpansion(row, cit->pos))
667 cit->dim.wid = int(cit->pos >= body_pos ?
668 max(hfill, 5.0) : row.label_hfill);
671 // Cache the inset dimension.
672 bv_->coordCache().insets().add(cit->inset, cit->dim);
673 pm.setInsetDimension(cit->inset, cit->dim);
678 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
680 Paragraph const & par = text_->getPar(pit);
681 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
684 Row::const_iterator cit = row.begin();
685 Row::const_iterator const end = row.end();
686 // iterate over elements before main body (except the last one,
687 // which is extra space).
688 while (cit!= end && cit->endpos < par.beginOfBody()) {
693 docstring const & label = par.params().labelWidthString();
697 FontMetrics const & fm
698 = theFontMetrics(text_->labelFont(par));
700 return max(0, fm.width(label) - w);
705 // Not used, see TextMetrics::breakRow
706 // this needs special handling - only newlines count as a break point
707 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
709 pos_type const end = par.size();
712 if (par.isNewline(i))
720 int TextMetrics::labelEnd(pit_type const pit) const
722 // labelEnd is only needed if the layout fills a flushleft label.
723 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
725 // return the beginning of the body
726 return leftMargin(max_width_, pit);
732 * Calling Text::getFont is slow. While rebreaking we scan a
733 * paragraph from left to right calling getFont for every char. This
734 * simple class address this problem by hidding an optimization trick
735 * (not mine btw -AB): the font is reused in the whole font span. The
736 * class handles transparently the "hidden" (not part of the fontlist)
737 * label font (as getFont does).
743 FontIterator(TextMetrics const & tm,
744 Paragraph const & par, pit_type pit, pos_type pos)
745 : tm_(tm), par_(par), pit_(pit), pos_(pos),
746 font_(tm.displayFont(pit, pos)),
747 endspan_(par.fontSpan(pos).last),
748 bodypos_(par.beginOfBody())
752 Font const & operator*() const { return font_; }
755 FontIterator & operator++()
758 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
759 font_ = tm_.displayFont(pit_, pos_);
760 endspan_ = par_.fontSpan(pos_).last;
766 Font * operator->() { return &font_; }
770 TextMetrics const & tm_;
772 Paragraph const & par_;
787 /** This is the function where the hard work is done. The code here is
788 * very sensitive to small changes :) Note that part of the
789 * intelligence is also in Row::shorten_if_needed
791 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
793 Paragraph const & par = text_->getPar(pit);
794 pos_type const end = par.size();
795 pos_type const pos = row.pos();
796 int const width = max_width_ - right_margin;
797 pos_type const body_pos = par.beginOfBody();
799 row.dimension().wid = leftMargin(max_width_, pit, pos);
800 row.right_margin = right_margin;
802 if (pos >= end || row.width() > width) {
803 row.dimension().wid += right_margin;
808 ParagraphMetrics const & pm = par_metrics_[pit];
809 ParagraphList const & pars = text_->paragraphs();
812 //FIXME: As long as leftMargin() is not correctly implemented for
813 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
814 // Otherwise, long rows will be painted off the screen.
815 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
816 return addressBreakPoint(pos, par);
819 // check for possible inline completion
820 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
821 pos_type inlineCompletionLPos = -1;
822 if (inlineCompletionPos.inTexted()
823 && inlineCompletionPos.text() == text_
824 && inlineCompletionPos.pit() == pit) {
825 // draw logically behind the previous character
826 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
829 // Now we iterate through until we reach the right margin
830 // or the end of the par, then build a representation of the row.
832 FontIterator fi = FontIterator(*this, par, pit, pos);
833 while (i < end && row.width() < width) {
834 char_type c = par.getChar(i);
835 // The most special cases are handled first.
836 if (par.isInset(i)) {
837 Inset const * ins = par.getInset(i);
838 Dimension dim = pm.insetDimension(ins);
839 row.add(i, ins, dim, *fi, par.lookupChange(i));
840 } else if (c == ' ' && i + 1 == body_pos) {
841 // There is a space at i, but it should not be
842 // added as a separator, because it is just
843 // before body_pos. Instead, insert some spacing to
845 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
846 int const add = max(fm.width(par.layout().labelsep),
847 labelEnd(pit) - row.width());
848 row.addSpace(i, add, *fi, par.lookupChange(i));
849 } else if (par.isLineSeparator(i)) {
850 // In theory, no inset has this property. If
851 // this is done, a new addSeparator which
852 // takes an inset as parameter should be
854 LATTEST(!par.isInset(i));
855 row.addSeparator(i, c, *fi, par.lookupChange(i));
856 } else if (c == '\t')
857 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
858 *fi, par.lookupChange(i));
860 row.add(i, c, *fi, par.lookupChange(i));
862 // add inline completion width
863 if (inlineCompletionLPos == i &&
864 !bv_->inlineCompletion().empty()) {
866 f.fontInfo().setColor(Color_inlinecompletion);
867 row.addVirtual(i + 1, bv_->inlineCompletion(),
871 // Handle some situations that abruptly terminate the row
873 // - Before a display inset
874 // - After a display inset
875 Inset const * inset = 0;
876 if (par.isNewline(i) || par.isEnvSeparator(i)
877 || (i + 1 < end && (inset = par.getInset(i + 1))
879 || (!row.empty() && row.back().inset
880 && row.back().inset->display())) {
881 row.right_boundary(true);
892 // End of paragraph marker
893 if (lyxrc.paragraph_markers
894 && i == end && size_type(pit + 1) < pars.size()) {
895 // add a virtual element for the end-of-paragraph
896 // marker; it is shown on screen, but does not exist
898 Font f(text_->layoutFont(pit));
899 f.fontInfo().setColor(Color_paragraphmarker);
900 BufferParams const & bparams
901 = text_->inset().buffer().params();
902 f.setLanguage(par.getParLanguage(bparams));
903 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
906 // if the row is too large, try to cut at last separator.
907 row.shortenIfNeeded(body_pos, width);
909 // if the row ends with a separator that is not at end of
910 // paragraph, remove it
911 if (!row.empty() && row.back().type == Row::SEPARATOR
912 && row.endpos() < par.size())
915 // make sure that the RTL elements are in reverse ordering
916 row.reverseRTL(text_->isRTL(par));
920 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
921 bool topBottomSpace) const
923 Paragraph const & par = text_->getPar(pit);
924 // get the maximum ascent and the maximum descent
925 double layoutasc = 0;
926 double layoutdesc = 0;
927 double const dh = defaultRowHeight();
929 // ok, let us initialize the maxasc and maxdesc value.
930 // Only the fontsize count. The other properties
931 // are taken from the layoutfont. Nicer on the screen :)
932 Layout const & layout = par.layout();
934 // as max get the first character of this row then it can
935 // increase but not decrease the height. Just some point to
936 // start with so we don't have to do the assignment below too
938 Buffer const & buffer = bv_->buffer();
939 Font font = displayFont(pit, row.pos());
940 FontSize const tmpsize = font.fontInfo().size();
941 font.fontInfo() = text_->layoutFont(pit);
942 FontSize const size = font.fontInfo().size();
943 font.fontInfo().setSize(tmpsize);
945 FontInfo labelfont = text_->labelFont(par);
947 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
948 FontMetrics const & fontmetrics = theFontMetrics(font);
950 // these are minimum values
951 double const spacing_val = layout.spacing.getValue()
952 * text_->spacing(par);
953 //lyxerr << "spacing_val = " << spacing_val << endl;
954 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
955 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
957 // insets may be taller
958 ParagraphMetrics const & pm = par_metrics_[pit];
959 Row::const_iterator cit = row.begin();
960 Row::const_iterator cend = row.end();
961 for ( ; cit != cend; ++cit) {
963 Dimension const & dim = pm.insetDimension(cit->inset);
964 maxasc = max(maxasc, dim.ascent());
965 maxdesc = max(maxdesc, dim.descent());
969 // Check if any custom fonts are larger (Asger)
970 // This is not completely correct, but we can live with the small,
971 // cosmetic error for now.
975 par.highestFontInRange(row.pos(), row.endpos(), size);
976 if (maxsize > font.fontInfo().size()) {
977 // use standard paragraph font with the maximal size
978 FontInfo maxfont = font.fontInfo();
979 maxfont.setSize(maxsize);
980 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
981 maxasc = max(maxasc, maxfontmetrics.maxAscent());
982 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
985 // This is nicer with box insets:
989 ParagraphList const & pars = text_->paragraphs();
990 Inset const & inset = text_->inset();
993 if (row.pos() == 0 && topBottomSpace) {
994 BufferParams const & bufparams = buffer.params();
995 // some parskips VERY EASY IMPLEMENTATION
996 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
997 && !inset.getLayout().parbreakIsNewline()
998 && !par.layout().parbreak_is_newline
1000 && ((layout.isParagraph() && par.getDepth() == 0)
1001 || (pars[pit - 1].layout().isParagraph()
1002 && pars[pit - 1].getDepth() == 0))) {
1003 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1006 if (par.params().startOfAppendix())
1007 maxasc += int(3 * dh);
1009 // special code for the top label
1010 if (layout.labelIsAbove()
1011 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1012 && !par.labelString().empty()) {
1014 labelfont_metrics.maxHeight()
1015 * layout.spacing.getValue()
1016 * text_->spacing(par)
1017 + (layout.topsep + layout.labelbottomsep) * dh);
1020 // Add the layout spaces, for example before and after
1021 // a section, or between the items of a itemize or enumerate
1024 pit_type prev = text_->depthHook(pit, par.getDepth());
1025 Paragraph const & prevpar = pars[prev];
1027 && prevpar.layout() == layout
1028 && prevpar.getDepth() == par.getDepth()
1029 && prevpar.getLabelWidthString()
1030 == par.getLabelWidthString()) {
1031 layoutasc = layout.itemsep * dh;
1032 } else if (pit != 0 || row.pos() != 0) {
1033 if (layout.topsep > 0)
1034 layoutasc = layout.topsep * dh;
1037 prev = text_->outerHook(pit);
1038 if (prev != pit_type(pars.size())) {
1039 maxasc += int(pars[prev].layout().parsep * dh);
1040 } else if (pit != 0) {
1041 Paragraph const & prevpar = pars[pit - 1];
1042 if (prevpar.getDepth() != 0 ||
1043 prevpar.layout() == layout) {
1044 maxasc += int(layout.parsep * dh);
1049 // is it a bottom line?
1050 if (row.endpos() >= par.size() && topBottomSpace) {
1051 // add the layout spaces, for example before and after
1052 // a section, or between the items of a itemize or enumerate
1054 pit_type nextpit = pit + 1;
1055 if (nextpit != pit_type(pars.size())) {
1056 pit_type cpit = pit;
1058 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1059 double usual = pars[cpit].layout().bottomsep * dh;
1061 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1062 if (pars[cpit].layout() != pars[nextpit].layout()
1063 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1064 unusual = pars[cpit].layout().bottomsep * dh;
1065 layoutdesc = max(unusual, usual);
1066 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1067 if (pars[cpit].layout() != pars[nextpit].layout()
1068 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1069 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1074 // incalculate the layout spaces
1075 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1076 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1078 // FIXME: the correct way is to do the following is to move the
1079 // following code in another method specially tailored for the
1080 // main Text. The following test is thus bogus.
1081 // Top and bottom margin of the document (only at top-level)
1082 if (main_text_ && topBottomSpace) {
1083 if (pit == 0 && row.pos() == 0)
1085 if (pit + 1 == pit_type(pars.size()) &&
1086 row.endpos() == par.size() &&
1087 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1091 row.dimension().asc = maxasc + labeladdon;
1092 row.dimension().des = maxdesc;
1096 // x is an absolute screen coord
1097 // returns the column near the specified x-coordinate of the row
1098 // x is set to the real beginning of this column
1099 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1100 bool & boundary) const
1102 /// For the main Text, it is possible that this pit is not
1103 /// yet in the CoordCache when moving cursor up.
1104 /// x Paragraph coordinate is always 0 for main text anyway.
1105 int const xo = origin_.x_;
1108 pos_type pos = row.pos();
1112 else if (x <= row.x) {
1113 pos = row.front().left_pos();
1115 } else if (x >= row.width() - row.right_margin) {
1116 pos = row.back().right_pos();
1117 x = row.width() - row.right_margin;
1120 Row::const_iterator cit = row.begin();
1121 Row::const_iterator cend = row.end();
1122 for ( ; cit != cend; ++cit) {
1123 if (w <= x && w + cit->width() > x) {
1124 double x_offset = x - w;
1125 pos = cit->x2pos(x_offset);
1131 if (cit == row.end()) {
1132 pos = row.back().right_pos();
1133 x = row.width() - row.right_margin;
1135 /** This tests for the case where the cursor is placed
1136 * just before a font direction change. See comment on
1137 * the boundary_ member in DocIterator.h to understand
1138 * how boundary helps here.
1140 else if (pos == cit->endpos
1141 && cit + 1 != row.end()
1142 && cit->font.isVisibleRightToLeft() != (cit + 1)->font.isVisibleRightToLeft())
1146 /** This tests for the case where the cursor is set at the end
1147 * of a row which has been broken due to a display inset on
1148 * next row. This is indicated by Row::right_boundary.
1150 if (!row.empty() && pos == row.back().endpos
1151 && row.back().endpos == row.endpos())
1152 boundary = row.right_boundary();
1159 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1161 // We play safe and use parMetrics(pit) to make sure the
1162 // ParagraphMetrics will be redone and OK to use if needed.
1163 // Otherwise we would use an empty ParagraphMetrics in
1164 // upDownInText() while in selection mode.
1165 ParagraphMetrics const & pm = parMetrics(pit);
1167 LBUFERR(row < int(pm.rows().size()));
1169 Row const & r = pm.rows()[row];
1170 return getPosNearX(r, x, bound);
1174 void TextMetrics::newParMetricsDown()
1176 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1177 pit_type const pit = last.first + 1;
1178 if (pit == int(text_->paragraphs().size()))
1181 // do it and update its position.
1183 par_metrics_[pit].setPosition(last.second.position()
1184 + last.second.descent() + par_metrics_[pit].ascent());
1188 void TextMetrics::newParMetricsUp()
1190 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1191 if (first.first == 0)
1194 pit_type const pit = first.first - 1;
1195 // do it and update its position.
1197 par_metrics_[pit].setPosition(first.second.position()
1198 - first.second.ascent() - par_metrics_[pit].descent());
1201 // y is screen coordinate
1202 pit_type TextMetrics::getPitNearY(int y)
1204 LASSERT(!text_->paragraphs().empty(), return -1);
1205 LASSERT(!par_metrics_.empty(), return -1);
1206 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1208 // look for highest numbered paragraph with y coordinate less than given y
1211 ParMetricsCache::const_iterator it = par_metrics_.begin();
1212 ParMetricsCache::const_iterator et = par_metrics_.end();
1213 ParMetricsCache::const_iterator last = et;
1216 ParagraphMetrics const & pm = it->second;
1218 if (y < it->second.position() - int(pm.ascent())) {
1219 // We are looking for a position that is before the first paragraph in
1220 // the cache (which is in priciple off-screen, that is before the
1223 // We are already at the first paragraph in the inset.
1225 // OK, this is the paragraph we are looking for.
1226 pit = it->first - 1;
1231 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1233 if (y >= last->second.position() + int(pm_last.descent())) {
1234 // We are looking for a position that is after the last paragraph in
1235 // the cache (which is in priciple off-screen), that is before the
1237 pit = last->first + 1;
1238 if (pit == int(text_->paragraphs().size()))
1239 // We are already at the last paragraph in the inset.
1241 // OK, this is the paragraph we are looking for.
1242 newParMetricsDown();
1246 for (; it != et; ++it) {
1247 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1248 << " y: " << it->second.position());
1250 ParagraphMetrics const & pm = par_metrics_[it->first];
1252 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1254 yy = it->second.position();
1258 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1264 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1265 bool assert_in_view, bool up)
1267 ParagraphMetrics const & pm = par_metrics_[pit];
1269 int yy = pm.position() - pm.ascent();
1270 LBUFERR(!pm.rows().empty());
1271 RowList::const_iterator rit = pm.rows().begin();
1272 RowList::const_iterator rlast = pm.rows().end();
1274 for (; rit != rlast; yy += rit->height(), ++rit)
1275 if (yy + rit->height() > y)
1278 if (assert_in_view) {
1279 if (!up && yy + rit->height() > y) {
1280 if (rit != pm.rows().begin()) {
1283 } else if (pit != 0) {
1286 ParagraphMetrics const & pm2 = par_metrics_[pit];
1287 rit = pm2.rows().end();
1291 } else if (up && yy != y) {
1293 y = yy + rit->height();
1295 } else if (pit < int(text_->paragraphs().size()) - 1) {
1297 newParMetricsDown();
1298 ParagraphMetrics const & pm2 = par_metrics_[pit];
1299 rit = pm2.rows().begin();
1308 // x,y are absolute screen coordinates
1309 // sets cursor recursively descending into nested editable insets
1310 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1311 bool assert_in_view, bool up)
1313 if (lyxerr.debugging(Debug::WORKAREA)) {
1314 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1315 cur.bv().coordCache().dump();
1317 pit_type pit = getPitNearY(y);
1318 LASSERT(pit != -1, return 0);
1320 int yy = y; // is modified by getPitAndRowNearY
1321 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1325 // Do we cover an inset?
1326 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1329 // No inset, set position in the text
1330 bool bound = false; // is modified by getPosNearX
1331 int xx = x; // is modified by getPosNearX
1332 cur.pos() = getPosNearX(row, xx, bound);
1333 cur.boundary(bound);
1334 cur.setCurrentFont();
1339 Inset * inset = it->inset;
1340 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1342 // Set position in front of inset
1343 cur.pos() = it->pos;
1344 cur.boundary(false);
1347 // Try to descend recursively inside the inset.
1348 inset = inset->editXY(cur, x, yy);
1350 if (cur.top().text() == text_)
1351 cur.setCurrentFont();
1356 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1358 LASSERT(text_ == cur.text(), return);
1359 pit_type const pit = getPitNearY(y);
1360 LASSERT(pit != -1, return);
1362 ParagraphMetrics const & pm = par_metrics_[pit];
1364 int yy = pm.position() - pm.ascent();
1365 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1366 " pit: " << pit << " yy: " << yy);
1369 LBUFERR(pm.rows().size());
1370 for (; r < int(pm.rows().size()) - 1; ++r) {
1371 Row const & row = pm.rows()[r];
1372 if (int(yy + row.height()) > y)
1377 Row const & row = pm.rows()[r];
1379 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1383 pos_type const pos = getPosNearX(row, xx, bound);
1385 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1387 text_->setCursor(cur, pit, pos, true, bound);
1388 // remember new position.
1393 //takes screen x,y coordinates
1394 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1396 Paragraph const & par = text_->paragraphs()[pit];
1397 ParagraphMetrics const & pm = par_metrics_[pit];
1399 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1401 InsetList::const_iterator iit = par.insetList().begin();
1402 InsetList::const_iterator iend = par.insetList().end();
1403 for (; iit != iend; ++iit) {
1404 Inset * inset = iit->inset;
1406 LYXERR(Debug::DEBUG, "examining inset " << inset);
1408 if (!bv_->coordCache().getInsets().has(inset)) {
1409 LYXERR(Debug::DEBUG, "inset has no cached position");
1413 Dimension const & dim = pm.insetDimension(inset);
1414 Point p = bv_->coordCache().getInsets().xy(inset);
1416 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1417 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1419 if (x >= p.x_ && x <= p.x_ + dim.wid
1420 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1421 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1422 return const_cast<InsetList::InsetTable *>(&(*iit));
1426 LYXERR(Debug::DEBUG, "No inset hit. ");
1431 //takes screen x,y coordinates
1432 Inset * TextMetrics::checkInsetHit(int x, int y)
1434 pit_type const pit = getPitNearY(y);
1435 LASSERT(pit != -1, return 0);
1436 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1445 int TextMetrics::cursorX(CursorSlice const & sl,
1446 bool boundary) const
1448 LASSERT(sl.text() == text_, return 0);
1450 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1451 if (pm.rows().empty())
1453 Row const & row = pm.getRow(sl.pos(), boundary);
1454 pos_type const pos = sl.pos();
1457 * When boundary is true, position i is in the row element (pos, endpos)
1460 * whereas, when boundary is false, the test is
1462 * The correction below allows to handle both cases.
1464 int const boundary_corr = (boundary && pos) ? -1 : 0;
1466 /** Early return in trivial cases
1467 * 1) the row is empty
1468 * 2) the position is the left-most position of the row; there
1469 * is a quirck herehowever: if the first element is virtual
1470 * (end-of-par marker for example), then we have to look
1474 || (pos == row.begin()->left_pos()
1475 && pos != row.begin()->right_pos()))
1478 Row::const_iterator cit = row.begin();
1480 for ( ; cit != row.end() ; ++cit) {
1481 /** Look whether the cursor is inside the element's
1482 * span. Note that it is necessary to take the
1483 * boundary in account, and to accept virtual
1484 * elements, which have pos == endpos.
1486 if (pos + boundary_corr >= cit->pos
1487 && (pos + boundary_corr < cit->endpos
1488 || cit->pos == cit->endpos)) {
1489 x += cit->pos2x(pos);
1499 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1501 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1502 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1503 if (pm.rows().empty())
1507 h -= par_metrics_[0].rows()[0].ascent();
1508 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1509 h += par_metrics_[pit].height();
1512 if (pos && boundary)
1514 size_t const rend = pm.pos2row(pos);
1515 for (size_t rit = 0; rit != rend; ++rit)
1516 h += pm.rows()[rit].height();
1517 h += pm.rows()[rend].ascent();
1522 // the cursor set functions have a special mechanism. When they
1523 // realize you left an empty paragraph, they will delete it.
1525 bool TextMetrics::cursorHome(Cursor & cur)
1527 LASSERT(text_ == cur.text(), return false);
1528 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1529 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1530 return text_->setCursor(cur, cur.pit(), row.pos());
1534 bool TextMetrics::cursorEnd(Cursor & cur)
1536 LASSERT(text_ == cur.text(), return false);
1537 // if not on the last row of the par, put the cursor before
1538 // the final space exept if I have a spanning inset or one string
1539 // is so long that we force a break.
1540 pos_type end = cur.textRow().endpos();
1542 // empty text, end-1 is no valid position
1544 bool boundary = false;
1545 if (end != cur.lastpos()) {
1546 if (!cur.paragraph().isLineSeparator(end-1)
1547 && !cur.paragraph().isNewline(end-1)
1548 && !cur.paragraph().isEnvSeparator(end-1))
1553 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1557 void TextMetrics::deleteLineForward(Cursor & cur)
1559 LASSERT(text_ == cur.text(), return);
1560 if (cur.lastpos() == 0) {
1561 // Paragraph is empty, so we just go forward
1562 text_->cursorForward(cur);
1565 cur.setSelection(true); // to avoid deletion
1568 // What is this test for ??? (JMarc)
1569 if (!cur.selection())
1570 text_->deleteWordForward(cur);
1572 cap::cutSelection(cur, true, false);
1573 cur.checkBufferStructure();
1578 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1580 ParagraphList const & pars = text_->paragraphs();
1581 return row.endpos() >= pars[pit].size()
1582 && pit + 1 == pit_type(pars.size());
1586 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1588 return row.pos() == 0 && pit == 0;
1592 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1594 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1598 int TextMetrics::leftMargin(int max_width,
1599 pit_type const pit, pos_type const pos) const
1601 ParagraphList const & pars = text_->paragraphs();
1603 LASSERT(pit >= 0, return 0);
1604 LASSERT(pit < int(pars.size()), return 0);
1605 Paragraph const & par = pars[pit];
1606 LASSERT(pos >= 0, return 0);
1607 LASSERT(pos <= par.size(), return 0);
1608 Buffer const & buffer = bv_->buffer();
1609 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1610 DocumentClass const & tclass = buffer.params().documentClass();
1611 Layout const & layout = par.layout();
1613 docstring parindent = layout.parindent;
1617 if (text_->isMainText())
1618 l_margin += bv_->leftMargin();
1620 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1621 tclass.leftmargin());
1623 if (par.getDepth() != 0) {
1624 // find the next level paragraph
1625 pit_type newpar = text_->outerHook(pit);
1626 if (newpar != pit_type(pars.size())) {
1627 if (pars[newpar].layout().isEnvironment()) {
1628 l_margin = leftMargin(max_width, newpar);
1629 // Remove the parindent that has been added
1630 // if the paragraph was empty.
1631 if (pars[newpar].empty() &&
1632 buffer.params().paragraph_separation ==
1633 BufferParams::ParagraphIndentSeparation) {
1634 docstring pi = pars[newpar].layout().parindent;
1635 l_margin -= theFontMetrics(
1636 buffer.params().getFont()).signedWidth(pi);
1639 if (tclass.isDefaultLayout(par.layout())
1640 || tclass.isPlainLayout(par.layout())) {
1641 if (pars[newpar].params().noindent())
1644 parindent = pars[newpar].layout().parindent;
1649 // This happens after sections or environments in standard classes.
1650 // We have to check the previous layout at same depth.
1651 if (buffer.params().paragraph_separation ==
1652 BufferParams::ParagraphSkipSeparation)
1654 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1655 pit_type prev = text_->depthHook(pit, par.getDepth());
1656 if (par.layout() == pars[prev].layout()) {
1658 && pars[pit - 1].layout().nextnoindent)
1660 } else if (pars[prev].layout().nextnoindent)
1664 FontInfo const labelfont = text_->labelFont(par);
1665 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1667 switch (layout.margintype) {
1668 case MARGIN_DYNAMIC:
1669 if (!layout.leftmargin.empty()) {
1670 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1673 if (!par.labelString().empty()) {
1674 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1675 l_margin += labelfont_metrics.width(par.labelString());
1676 l_margin += labelfont_metrics.width(layout.labelsep);
1680 case MARGIN_MANUAL: {
1681 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1682 // The width of an empty par, even with manual label, should be 0
1683 if (!par.empty() && pos >= par.beginOfBody()) {
1684 if (!par.getLabelWidthString().empty()) {
1685 docstring labstr = par.getLabelWidthString();
1686 l_margin += labelfont_metrics.width(labstr);
1687 l_margin += labelfont_metrics.width(layout.labelsep);
1693 case MARGIN_STATIC: {
1694 l_margin += theFontMetrics(buffer.params().getFont()).
1695 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1699 case MARGIN_FIRST_DYNAMIC:
1700 if (layout.labeltype == LABEL_MANUAL) {
1701 // if we are at position 0, we are never in the body
1702 if (pos > 0 && pos >= par.beginOfBody())
1703 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1705 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1707 // Special case to fix problems with
1709 || (layout.labeltype == LABEL_STATIC
1710 && layout.latextype == LATEX_ENVIRONMENT
1711 && !text_->isFirstInSequence(pit))) {
1712 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1713 } else if (!layout.labelIsAbove()) {
1714 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1715 l_margin += labelfont_metrics.width(layout.labelsep);
1716 l_margin += labelfont_metrics.width(par.labelString());
1720 case MARGIN_RIGHT_ADDRESS_BOX: {
1722 // The left margin depends on the widest row in this paragraph.
1723 // This code is wrong because it depends on the rows, but at the
1724 // same time this function is used in redoParagraph to construct
1726 ParagraphMetrics const & pm = par_metrics_[pit];
1727 RowList::const_iterator rit = pm.rows().begin();
1728 RowList::const_iterator end = pm.rows().end();
1729 int minfill = max_width;
1730 for ( ; rit != end; ++rit)
1731 if (rit->fill() < minfill)
1732 minfill = rit->fill();
1733 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1734 l_margin += minfill;
1736 // also wrong, but much shorter.
1737 l_margin += max_width / 2;
1742 if (!par.params().leftIndent().zero())
1743 l_margin += par.params().leftIndent().inPixels(max_width);
1747 if (par.params().align() == LYX_ALIGN_LAYOUT)
1748 align = layout.align;
1750 align = par.params().align();
1752 // set the correct parindent
1754 && (layout.labeltype == LABEL_NO_LABEL
1755 || layout.labeltype == LABEL_ABOVE
1756 || layout.labeltype == LABEL_CENTERED
1757 || (layout.labeltype == LABEL_STATIC
1758 && layout.latextype == LATEX_ENVIRONMENT
1759 && !text_->isFirstInSequence(pit)))
1760 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1761 && !par.params().noindent()
1762 // in some insets, paragraphs are never indented
1763 && !text_->inset().neverIndent()
1764 // display style insets are always centered, omit indentation
1767 && par.getInset(pos)->display())
1768 && (!(tclass.isDefaultLayout(par.layout())
1769 || tclass.isPlainLayout(par.layout()))
1770 || buffer.params().paragraph_separation
1771 == BufferParams::ParagraphIndentSeparation)) {
1772 // use the parindent of the layout when the
1773 // default indentation is used otherwise use
1774 // the indentation set in the document
1776 if (buffer.params().getIndentation().asLyXCommand() == "default")
1777 l_margin += theFontMetrics(
1778 buffer.params().getFont()).signedWidth(parindent);
1780 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1787 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1789 if (par_metrics_.empty())
1795 ParMetricsCache::iterator it = par_metrics_.begin();
1796 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1797 y -= it->second.ascent();
1798 for (; it != pm_end; ++it) {
1799 ParagraphMetrics const & pmi = it->second;
1801 pit_type const pit = it->first;
1802 // Save the paragraph position in the cache.
1803 it->second.setPosition(y);
1804 drawParagraph(pi, pit, x, y);
1810 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1812 BufferParams const & bparams = bv_->buffer().params();
1813 ParagraphMetrics const & pm = par_metrics_[pit];
1814 if (pm.rows().empty())
1817 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1818 int const ww = bv_->workHeight();
1819 size_t const nrows = pm.rows().size();
1821 Cursor const & cur = bv_->cursor();
1822 DocIterator sel_beg = cur.selectionBegin();
1823 DocIterator sel_end = cur.selectionEnd();
1824 bool selection = cur.selection()
1825 // This is our text.
1826 && cur.text() == text_
1827 // if the anchor is outside, this is not our selection
1828 && cur.normalAnchor().text() == text_
1829 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1831 // We store the begin and end pos of the selection relative to this par
1832 DocIterator sel_beg_par = cur.selectionBegin();
1833 DocIterator sel_end_par = cur.selectionEnd();
1835 // We care only about visible selection.
1837 if (pit != sel_beg.pit()) {
1838 sel_beg_par.pit() = pit;
1839 sel_beg_par.pos() = 0;
1841 if (pit != sel_end.pit()) {
1842 sel_end_par.pit() = pit;
1843 sel_end_par.pos() = sel_end_par.lastpos();
1847 for (size_t i = 0; i != nrows; ++i) {
1849 Row const & row = pm.rows()[i];
1853 bool const inside = (y + row.descent() >= 0
1854 && y - row.ascent() < ww);
1855 // It is not needed to draw on screen if we are not inside.
1856 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1857 RowPainter rp(pi, *text_, pit, row, x, y);
1860 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1862 row.setSelection(-1, -1);
1864 // The row knows nothing about the paragraph, so we have to check
1865 // whether this row is the first or last and update the margins.
1866 if (row.selection()) {
1867 if (row.sel_beg == 0)
1868 row.begin_margin_sel = sel_beg.pit() < pit;
1869 if (row.sel_end == sel_end_par.lastpos())
1870 row.end_margin_sel = sel_end.pit() > pit;
1873 // Row signature; has row changed since last paint?
1874 row.setCrc(pm.computeRowSignature(row, bparams));
1875 bool row_has_changed = row.changed();
1877 // Take this opportunity to spellcheck the row contents.
1878 if (row_has_changed && lyxrc.spellcheck_continuously) {
1879 text_->getPar(pit).spellCheck();
1882 // Don't paint the row if a full repaint has not been requested
1883 // and if it has not changed.
1884 if (!pi.full_repaint && !row_has_changed) {
1885 // Paint only the insets if the text itself is
1887 rp.paintOnlyInsets();
1892 // Clear background of this row if paragraph background was not
1893 // already cleared because of a full repaint.
1894 if (!pi.full_repaint && row_has_changed) {
1895 pi.pain.fillRectangle(x, y - row.ascent(),
1896 width(), row.height(), pi.background_color);
1899 // Instrumentation for testing row cache (see also
1901 if (lyxerr.debugging(Debug::PAINTING) && inside
1902 && (row.selection() || pi.full_repaint || row_has_changed)) {
1903 string const foreword = text_->isMainText() ?
1904 "main text redraw " : "inset text redraw: ";
1905 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1906 << " row_selection=" << row.selection()
1907 << " full_repaint=" << pi.full_repaint
1908 << " row_has_changed=" << row_has_changed);
1911 // Backup full_repaint status and force full repaint
1912 // for inner insets as the Row has been cleared out.
1913 bool tmp = pi.full_repaint;
1914 pi.full_repaint = true;
1916 rp.paintSelection();
1919 rp.paintChangeBar();
1920 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1921 if (i == 0 && !is_rtl)
1923 if (i == nrows - 1 && is_rtl)
1926 if (i == nrows - 1 && !is_rtl)
1928 if (i == 0 && is_rtl)
1932 // Restore full_repaint status.
1933 pi.full_repaint = tmp;
1935 // Re-enable screen drawing for future use of the painter.
1936 pi.pain.setDrawingEnabled(original_drawing_state);
1938 //LYXERR(Debug::PAINTING, ".");
1942 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1943 Dimension & dim) const
1945 Cursor const & bvcur = cur.bv().cursor();
1947 // get word in front of cursor
1948 docstring word = text_->previousWord(bvcur.top());
1949 DocIterator wordStart = bvcur;
1950 wordStart.pos() -= word.length();
1952 // get position on screen of the word start and end
1953 //FIXME: Is it necessary to explicitly set this to false?
1954 wordStart.boundary(false);
1955 Point lxy = cur.bv().getPos(wordStart);
1956 Point rxy = cur.bv().getPos(bvcur);
1958 // calculate dimensions of the word
1960 row.pos(wordStart.pos());
1961 row.endpos(bvcur.pos());
1962 setRowHeight(row, bvcur.pit(), false);
1963 dim = row.dimension();
1964 dim.wid = abs(rxy.x_ - lxy.x_);
1966 // calculate position of word
1968 x = min(rxy.x_, lxy.x_);
1970 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1971 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1974 int defaultRowHeight()
1976 return int(theFontMetrics(sane_font).maxHeight() * 1.2);