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;
62 int numberOfLabelHfills(Paragraph const & par, Row const & row)
64 pos_type last = row.endpos() - 1;
65 pos_type first = row.pos();
67 // hfill *DO* count at the beginning of paragraphs!
69 while (first < last && par.isHfill(first))
73 last = min(last, par.beginOfBody());
75 for (pos_type p = first; p < last; ++p) {
83 int numberOfHfills(Row const & row, pos_type const body_pos)
86 Row::const_iterator cit = row.begin();
87 Row::const_iterator const end = row.end();
88 for ( ; cit != end ; ++cit)
89 if (cit->pos >= body_pos
90 && cit->inset && cit->inset->isHfill())
98 /////////////////////////////////////////////////////////////////////
102 /////////////////////////////////////////////////////////////////////
105 TextMetrics::TextMetrics(BufferView * bv, Text * text)
106 : bv_(bv), text_(text)
109 max_width_ = bv_->workWidth();
110 dim_.wid = max_width_;
116 bool TextMetrics::contains(pit_type pit) const
118 return par_metrics_.find(pit) != par_metrics_.end();
122 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
124 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
129 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
131 ParMetricsCache::const_iterator it = par_metrics_.begin();
132 return make_pair(it->first, &it->second);
136 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
138 LBUFERR(!par_metrics_.empty());
139 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
140 return make_pair(it->first, &it->second);
144 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
146 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
147 if (pmc_it == par_metrics_.end()) {
148 pmc_it = par_metrics_.insert(
149 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
151 if (pmc_it->second.rows().empty() && redo)
153 return pmc_it->second;
157 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
159 LBUFERR(mi.base.textwidth > 0);
160 max_width_ = mi.base.textwidth;
161 // backup old dimension.
162 Dimension const old_dim = dim_;
165 dim_.wid = min_width;
166 pit_type const npar = text_->paragraphs().size();
168 // If there is more than one row, expand the text to
169 // the full allowable width.
170 dim_.wid = max_width_;
172 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
173 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
175 bool changed = false;
177 for (pit_type pit = 0; pit != npar; ++pit) {
178 changed |= redoParagraph(pit);
179 ParagraphMetrics const & pm = par_metrics_[pit];
181 if (dim_.wid < pm.width())
182 dim_.wid = pm.width();
185 dim_.asc = par_metrics_[0].ascent();
186 dim_.des = h - dim_.asc;
187 //lyxerr << "dim_.wid " << dim_.wid << endl;
188 //lyxerr << "dim_.asc " << dim_.asc << endl;
189 //lyxerr << "dim_.des " << dim_.des << endl;
191 changed |= dim_ != old_dim;
197 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
199 return main_text_? pm.rightMargin(*bv_) : 0;
203 int TextMetrics::rightMargin(pit_type const pit) const
205 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
209 void TextMetrics::applyOuterFont(Font & font) const
211 FontInfo lf(font_.fontInfo());
212 lf.reduce(bv_->buffer().params().getFont().fontInfo());
213 font.fontInfo().realize(lf);
217 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
219 LASSERT(pos >= 0, { static Font f; return f; });
221 ParagraphList const & pars = text_->paragraphs();
222 Paragraph const & par = pars[pit];
223 Layout const & layout = par.layout();
224 Buffer const & buffer = bv_->buffer();
226 BufferParams const & params = buffer.params();
227 pos_type const body_pos = par.beginOfBody();
229 // We specialize the 95% common case:
230 if (!par.getDepth()) {
231 Font f = par.getFontSettings(params, pos);
232 if (!text_->isMainText())
234 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
236 FontInfo const & lf = lab ? layout.labelfont : layout.font;
237 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
239 // In case the default family has been customized
240 if (lf.family() == INHERIT_FAMILY)
241 rlf.setFamily(params.getFont().fontInfo().family());
242 f.fontInfo().realize(rlf);
246 // The uncommon case need not be optimized as much
247 FontInfo const & layoutfont = pos < body_pos ?
248 layout.labelfont : layout.font;
250 Font font = par.getFontSettings(params, pos);
251 font.fontInfo().realize(layoutfont);
253 if (!text_->isMainText())
254 applyOuterFont(font);
256 // Realize against environment font information
257 // NOTE: the cast to pit_type should be removed when pit_type
258 // changes to a unsigned integer.
259 if (pit < pit_type(pars.size()))
260 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
262 // Realize with the fonts of lesser depth.
263 font.fontInfo().realize(params.getFont().fontInfo());
269 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
275 if (boundary && sl.pos() > 0)
278 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
282 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
284 // no RTL boundary at paragraph start
288 Font const & left_font = displayFont(pit, pos - 1);
290 return isRTLBoundary(pit, pos, left_font);
294 // isRTLBoundary returns false on a real end-of-line boundary,
295 // because otherwise the two boundary types get mixed up.
296 // This is the whole purpose of this being in TextMetrics.
297 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
298 Font const & font) const
300 if (// no RTL boundary at paragraph start
302 // if the metrics have not been calculated, then we are not
303 // on screen and can safely ignore issues about boundaries.
307 ParagraphMetrics & pm = par_metrics_[pit];
308 // no RTL boundary in empty paragraph
309 if (pm.rows().empty())
312 pos_type endpos = pm.getRow(pos - 1, false).endpos();
313 pos_type startpos = pm.getRow(pos, false).pos();
314 // no RTL boundary at line start:
315 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
317 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
320 Paragraph const & par = text_->getPar(pit);
321 // no RTL boundary at line break:
322 // abc|\n -> move right -> abc\n (and not: abc\n|
324 if (startpos == pos && endpos == pos && endpos != par.size()
325 && (par.isNewline(pos - 1)
326 || par.isEnvSeparator(pos - 1)
327 || par.isLineSeparator(pos - 1)
328 || par.isSeparator(pos - 1)))
331 bool left = font.isVisibleRightToLeft();
333 if (pos == par.size())
334 right = par.isRTL(bv_->buffer().params());
336 right = displayFont(pit, pos).isVisibleRightToLeft();
338 return left != right;
342 bool TextMetrics::redoParagraph(pit_type const pit)
344 Paragraph & par = text_->getPar(pit);
345 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
346 // redoParagraph() recursively inside parMetrics.
347 Dimension old_dim = parMetrics(pit, false).dim();
348 ParagraphMetrics & pm = par_metrics_[pit];
351 Buffer & buffer = bv_->buffer();
352 main_text_ = (text_ == &buffer.text());
353 bool changed = false;
355 // Check whether there are InsetBibItems that need fixing
356 // FIXME: This check ought to be done somewhere else. It is the reason
357 // why text_ is not const. But then, where else to do it?
358 // Well, how can you end up with either (a) a biblio environment that
359 // has no InsetBibitem or (b) a biblio environment with more than one
360 // InsetBibitem? I think the answer is: when paragraphs are merged;
361 // when layout is set; when material is pasted.
362 if (par.brokenBiblio()) {
363 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
364 // In some cases, we do not know how to record undo
365 if (&cur.inset() == &text_->inset())
366 cur.recordUndo(pit, pit);
368 int const moveCursor = par.fixBiblio(buffer);
370 // Is it necessary to update the cursor?
371 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
374 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
379 // Optimisation: this is used in the next two loops
380 // so better to calculate that once here.
381 int const right_margin = rightMargin(pm);
383 // iterator pointing to paragraph to resolve macros
384 DocIterator parPos = text_->macrocontextPosition();
388 LYXERR(Debug::INFO, "MacroContext not initialised!"
389 << " Going through the buffer again and hope"
390 << " the context is better then.");
391 // FIXME audit updateBuffer calls
392 // This should not be here, but it is not clear yet where else it
394 bv_->buffer().updateBuffer();
395 parPos = text_->macrocontextPosition();
396 LBUFERR(!parPos.empty());
401 Font const bufferfont = buffer.params().getFont();
402 InsetList::const_iterator ii = par.insetList().begin();
403 InsetList::const_iterator iend = par.insetList().end();
404 for (; ii != iend; ++ii) {
405 // FIXME Doesn't this HAVE to be non-empty?
406 // position already initialized?
407 if (!parPos.empty()) {
408 parPos.pos() = ii->pos;
410 // A macro template would normally not be visible
411 // by itself. But the tex macro semantics allow
412 // recursion, so we artifically take the context
413 // after the macro template to simulate this.
414 if (ii->inset->lyxCode() == MATHMACRO_CODE)
418 // do the metric calculation
420 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
422 Font const & font = ii->inset->inheritFont() ?
423 displayFont(pit, ii->pos) : bufferfont;
424 MacroContext mc(&buffer, parPos);
425 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
426 ii->inset->metrics(mi, dim);
427 Dimension const & old_dim = pm.insetDimension(ii->inset);
428 if (old_dim != dim) {
429 pm.setInsetDimension(ii->inset, dim);
434 par.setBeginOfBody();
436 size_t row_index = 0;
437 // maximum pixel width of a row
439 if (row_index == pm.rows().size())
440 pm.rows().push_back(Row());
441 Row & row = pm.rows()[row_index];
443 breakRow(row, right_margin, pit);
444 setRowHeight(row, pit);
445 row.setChanged(false);
446 if (row_index || row.right_boundary() || row.endpos() < par.size())
447 // If there is more than one row or the row has been
448 // broken by a display inset or a newline, expand the text
449 // to the full allowable width. This setting here is
450 // needed for the computeRowMetrics() below.
451 dim_.wid = max_width_;
452 int const max_row_width = max(dim_.wid, row.width());
453 computeRowMetrics(pit, row, max_row_width);
454 first = row.endpos();
457 pm.dim().wid = max(pm.dim().wid, row.width());
458 pm.dim().des += row.height();
459 } while (first < par.size());
461 if (row_index < pm.rows().size())
462 pm.rows().resize(row_index);
464 // Make sure that if a par ends in newline, there is one more row
466 if (first > 0 && par.isNewline(first - 1)) {
467 if (row_index == pm.rows().size())
468 pm.rows().push_back(Row());
469 Row & row = pm.rows()[row_index];
472 setRowHeight(row, pit);
473 row.setChanged(false);
474 int const max_row_width = max(dim_.wid, row.width());
475 computeRowMetrics(pit, row, max_row_width);
476 pm.dim().des += row.height();
479 pm.dim().asc += pm.rows()[0].ascent();
480 pm.dim().des -= pm.rows()[0].ascent();
482 changed |= old_dim.height() != pm.dim().height();
488 LyXAlignment TextMetrics::getAlign(Paragraph const & par, pos_type const pos) const
490 Layout const & layout = par.layout();
493 if (par.params().align() == LYX_ALIGN_LAYOUT)
494 align = layout.align;
496 align = par.params().align();
498 // handle alignment inside tabular cells
499 Inset const & owner = text_->inset();
500 switch (owner.contentAlignment()) {
501 case LYX_ALIGN_CENTER:
503 case LYX_ALIGN_RIGHT:
504 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
505 align = owner.contentAlignment();
508 // unchanged (use align)
512 // Display-style insets should always be on a centered row
513 if (Inset const * inset = par.getInset(pos)) {
514 switch (inset->display()) {
515 case Inset::AlignLeft:
516 align = LYX_ALIGN_BLOCK;
518 case Inset::AlignCenter:
519 align = LYX_ALIGN_CENTER;
522 // unchanged (use align)
524 case Inset::AlignRight:
525 align = LYX_ALIGN_RIGHT;
530 // Has the user requested we not justify stuff?
531 if (!bv_->buffer().params().justification
532 && align == LYX_ALIGN_BLOCK)
533 align = LYX_ALIGN_LEFT;
539 void TextMetrics::computeRowMetrics(pit_type const pit,
540 Row & row, int width) const
545 Paragraph const & par = text_->getPar(pit);
547 int const w = width - row.right_margin - row.width();
548 // FIXME: put back this assertion when the crash on new doc is solved.
549 //LASSERT(w >= 0, /**/);
551 // is there a manual margin with a manual label
552 Layout const & layout = par.layout();
555 if (layout.margintype == MARGIN_MANUAL
556 && layout.labeltype == LABEL_MANUAL) {
557 /// We might have real hfills in the label part
558 nlh = numberOfLabelHfills(par, row);
560 // A manual label par (e.g. List) has an auto-hfill
561 // between the label text and the body of the
563 // But we don't want to do this auto hfill if the par
568 if (nlh && !par.getLabelWidthString().empty())
569 row.label_hfill = labelFill(pit, row) / double(nlh);
573 // are there any hfills in the row?
574 if (int const nh = numberOfHfills(row, par.beginOfBody())) {
576 hfill = double(w) / nh;
577 // we don't have to look at the alignment if it is ALIGN_LEFT and
578 // if the row is already larger then the permitted width as then
579 // we force the LEFT_ALIGN'edness!
580 } else if (int(row.width()) < max_width_) {
581 // is it block, flushleft or flushright?
582 // set x how you need it
583 switch (getAlign(par, row.pos())) {
584 case LYX_ALIGN_BLOCK: {
585 int const ns = row.countSeparators();
586 /** If we have separators, and this row has
587 * not be broken abruptly by a display inset
588 * or newline, then stretch it */
589 if (ns && !row.right_boundary()
590 && row.endpos() != par.size()) {
591 row.setSeparatorExtraWidth(double(w) / ns);
592 row.dimension().wid = width;
593 } else if (text_->isRTL(par)) {
594 row.dimension().wid = width;
595 row.left_margin += w;
599 case LYX_ALIGN_RIGHT:
600 row.left_margin += w;
601 row.dimension().wid += w;
603 case LYX_ALIGN_CENTER:
604 row.dimension().wid = width - w / 2;
605 row.left_margin += w / 2;
609 case LYX_ALIGN_LAYOUT:
610 case LYX_ALIGN_SPECIAL:
611 case LYX_ALIGN_DECIMAL:
616 // Finally, handle hfill insets
617 pos_type const endpos = row.endpos();
618 pos_type body_pos = par.beginOfBody();
620 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
622 ParagraphMetrics & pm = par_metrics_[pit];
623 Row::iterator cit = row.begin();
624 Row::iterator const cend = row.end();
625 for ( ; cit != cend; ++cit) {
626 if (row.label_hfill && cit->endpos == body_pos
627 && cit->type == Row::SPACE)
628 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
629 if (!cit->inset || !cit->inset->isHfill())
631 if (pm.hfillExpansion(row, cit->pos))
632 cit->dim.wid = int(cit->pos >= body_pos ?
633 max(hfill, 5.0) : row.label_hfill);
636 // Cache the inset dimension.
637 bv_->coordCache().insets().add(cit->inset, cit->dim);
638 pm.setInsetDimension(cit->inset, cit->dim);
643 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
645 Paragraph const & par = text_->getPar(pit);
646 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
649 Row::const_iterator cit = row.begin();
650 Row::const_iterator const end = row.end();
651 // iterate over elements before main body (except the last one,
652 // which is extra space).
653 while (cit!= end && cit->endpos < par.beginOfBody()) {
658 docstring const & label = par.params().labelWidthString();
662 FontMetrics const & fm
663 = theFontMetrics(text_->labelFont(par));
665 return max(0, fm.width(label) - w);
670 // Not used, see TextMetrics::breakRow
671 // this needs special handling - only newlines count as a break point
672 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
674 pos_type const end = par.size();
677 if (par.isNewline(i))
685 int TextMetrics::labelEnd(pit_type const pit) const
687 // labelEnd is only needed if the layout fills a flushleft label.
688 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
690 // return the beginning of the body
691 return leftMargin(max_width_, pit);
697 * Calling Text::getFont is slow. While rebreaking we scan a
698 * paragraph from left to right calling getFont for every char. This
699 * simple class address this problem by hidding an optimization trick
700 * (not mine btw -AB): the font is reused in the whole font span. The
701 * class handles transparently the "hidden" (not part of the fontlist)
702 * label font (as getFont does).
708 FontIterator(TextMetrics const & tm,
709 Paragraph const & par, pit_type pit, pos_type pos)
710 : tm_(tm), par_(par), pit_(pit), pos_(pos),
711 font_(tm.displayFont(pit, pos)),
712 endspan_(par.fontSpan(pos).last),
713 bodypos_(par.beginOfBody())
717 Font const & operator*() const { return font_; }
720 FontIterator & operator++()
723 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
724 font_ = tm_.displayFont(pit_, pos_);
725 endspan_ = par_.fontSpan(pos_).last;
731 Font * operator->() { return &font_; }
735 TextMetrics const & tm_;
737 Paragraph const & par_;
752 /** This is the function where the hard work is done. The code here is
753 * very sensitive to small changes :) Note that part of the
754 * intelligence is also in Row::shortenIfNeeded.
756 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
758 Paragraph const & par = text_->getPar(pit);
759 pos_type const end = par.size();
760 pos_type const pos = row.pos();
761 pos_type const body_pos = par.beginOfBody();
762 bool const is_rtl = text_->isRTL(par);
765 row.left_margin = leftMargin(max_width_, pit, pos);
766 row.right_margin = right_margin;
768 swap(row.left_margin, row.right_margin);
769 // Remember that the row width takes into account the left_margin
770 // but not the right_margin.
771 row.dimension().wid = row.left_margin;
772 // the width available for the row.
773 int const width = max_width_ - row.right_margin;
775 if (pos >= end || row.width() > width) {
780 ParagraphMetrics const & pm = par_metrics_[pit];
781 ParagraphList const & pars = text_->paragraphs();
784 //FIXME: As long as leftMargin() is not correctly implemented for
785 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
786 // Otherwise, long rows will be painted off the screen.
787 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
788 return addressBreakPoint(pos, par);
791 // check for possible inline completion
792 DocIterator const & ic_it = bv_->inlineCompletionPos();
793 pos_type ic_pos = -1;
794 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
795 ic_pos = ic_it.pos();
797 // Now we iterate through until we reach the right margin
798 // or the end of the par, then build a representation of the row.
800 FontIterator fi = FontIterator(*this, par, pit, pos);
801 while (i < end && row.width() <= width) {
802 char_type c = par.getChar(i);
803 // The most special cases are handled first.
804 if (par.isInset(i)) {
805 Inset const * ins = par.getInset(i);
806 Dimension dim = pm.insetDimension(ins);
807 row.add(i, ins, dim, *fi, par.lookupChange(i));
808 } else if (c == ' ' && i + 1 == body_pos) {
809 // There is a space at i, but it should not be
810 // added as a separator, because it is just
811 // before body_pos. Instead, insert some spacing to
813 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
814 // this is needed to make sure that the row width is correct
816 int const add = max(fm.width(par.layout().labelsep),
817 labelEnd(pit) - row.width());
818 row.addSpace(i, add, *fi, par.lookupChange(i));
819 } else if (c == '\t')
820 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
821 *fi, par.lookupChange(i));
823 row.add(i, c, *fi, par.lookupChange(i));
825 // add inline completion width
826 // draw logically behind the previous character
827 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
828 docstring const comp = bv_->inlineCompletion();
829 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
833 f.fontInfo().setColor(Color_inlinecompletion);
834 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
836 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
837 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
840 // Handle some situations that abruptly terminate the row
842 // - Before a display inset
843 // - After a display inset
844 Inset const * inset = 0;
845 if (par.isNewline(i) || par.isEnvSeparator(i)
846 || (i + 1 < end && (inset = par.getInset(i + 1))
848 || (!row.empty() && row.back().inset
849 && row.back().inset->display())) {
850 row.right_boundary(true);
861 // End of paragraph marker
862 if (lyxrc.paragraph_markers
863 && i == end && size_type(pit + 1) < pars.size()) {
864 // add a virtual element for the end-of-paragraph
865 // marker; it is shown on screen, but does not exist
867 Font f(text_->layoutFont(pit));
868 f.fontInfo().setColor(Color_paragraphmarker);
869 BufferParams const & bparams
870 = text_->inset().buffer().params();
871 f.setLanguage(par.getParLanguage(bparams));
872 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
875 // if the row is too large, try to cut at last separator.
876 row.shortenIfNeeded(body_pos, width);
878 // make sure that the RTL elements are in reverse ordering
879 row.reverseRTL(is_rtl);
880 //LYXERR0("breakrow: row is " << row);
884 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
885 bool topBottomSpace) const
887 Paragraph const & par = text_->getPar(pit);
888 // get the maximum ascent and the maximum descent
889 double layoutasc = 0;
890 double layoutdesc = 0;
891 double const dh = defaultRowHeight();
893 // ok, let us initialize the maxasc and maxdesc value.
894 // Only the fontsize count. The other properties
895 // are taken from the layoutfont. Nicer on the screen :)
896 Layout const & layout = par.layout();
898 // as max get the first character of this row then it can
899 // increase but not decrease the height. Just some point to
900 // start with so we don't have to do the assignment below too
902 Buffer const & buffer = bv_->buffer();
903 Font font = displayFont(pit, row.pos());
904 FontSize const tmpsize = font.fontInfo().size();
905 font.fontInfo() = text_->layoutFont(pit);
906 FontSize const size = font.fontInfo().size();
907 font.fontInfo().setSize(tmpsize);
909 FontInfo labelfont = text_->labelFont(par);
911 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
912 FontMetrics const & fontmetrics = theFontMetrics(font);
914 // these are minimum values
915 double const spacing_val = layout.spacing.getValue()
916 * text_->spacing(par);
917 //lyxerr << "spacing_val = " << spacing_val << endl;
918 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
919 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
921 // insets may be taller
922 ParagraphMetrics const & pm = par_metrics_[pit];
923 Row::const_iterator cit = row.begin();
924 Row::const_iterator cend = row.end();
925 for ( ; cit != cend; ++cit) {
927 Dimension const & dim = pm.insetDimension(cit->inset);
928 maxasc = max(maxasc, dim.ascent());
929 maxdesc = max(maxdesc, dim.descent());
933 // Check if any custom fonts are larger (Asger)
934 // This is not completely correct, but we can live with the small,
935 // cosmetic error for now.
939 par.highestFontInRange(row.pos(), row.endpos(), size);
940 if (maxsize > font.fontInfo().size()) {
941 // use standard paragraph font with the maximal size
942 FontInfo maxfont = font.fontInfo();
943 maxfont.setSize(maxsize);
944 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
945 maxasc = max(maxasc, maxfontmetrics.maxAscent());
946 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
949 // This is nicer with box insets:
953 ParagraphList const & pars = text_->paragraphs();
954 Inset const & inset = text_->inset();
957 if (row.pos() == 0 && topBottomSpace) {
958 BufferParams const & bufparams = buffer.params();
959 // some parskips VERY EASY IMPLEMENTATION
960 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
961 && !inset.getLayout().parbreakIsNewline()
962 && !par.layout().parbreak_is_newline
964 && ((layout.isParagraph() && par.getDepth() == 0)
965 || (pars[pit - 1].layout().isParagraph()
966 && pars[pit - 1].getDepth() == 0))) {
967 maxasc += bufparams.getDefSkip().inPixels(*bv_);
970 if (par.params().startOfAppendix())
971 maxasc += int(3 * dh);
973 // special code for the top label
974 if (layout.labelIsAbove()
975 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
976 && !par.labelString().empty()) {
978 labelfont_metrics.maxHeight()
979 * layout.spacing.getValue()
980 * text_->spacing(par)
981 + (layout.topsep + layout.labelbottomsep) * dh);
984 // Add the layout spaces, for example before and after
985 // a section, or between the items of a itemize or enumerate
988 pit_type prev = text_->depthHook(pit, par.getDepth());
989 Paragraph const & prevpar = pars[prev];
991 && prevpar.layout() == layout
992 && prevpar.getDepth() == par.getDepth()
993 && prevpar.getLabelWidthString()
994 == par.getLabelWidthString()) {
995 layoutasc = layout.itemsep * dh;
996 } else if (pit != 0 || row.pos() != 0) {
997 if (layout.topsep > 0)
998 layoutasc = layout.topsep * dh;
1001 prev = text_->outerHook(pit);
1002 if (prev != pit_type(pars.size())) {
1003 maxasc += int(pars[prev].layout().parsep * dh);
1004 } else if (pit != 0) {
1005 Paragraph const & prevpar = pars[pit - 1];
1006 if (prevpar.getDepth() != 0 ||
1007 prevpar.layout() == layout) {
1008 maxasc += int(layout.parsep * dh);
1013 // is it a bottom line?
1014 if (row.endpos() >= par.size() && topBottomSpace) {
1015 // add the layout spaces, for example before and after
1016 // a section, or between the items of a itemize or enumerate
1018 pit_type nextpit = pit + 1;
1019 if (nextpit != pit_type(pars.size())) {
1020 pit_type cpit = pit;
1022 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1023 double usual = pars[cpit].layout().bottomsep * dh;
1025 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1026 if (pars[cpit].layout() != pars[nextpit].layout()
1027 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1028 unusual = pars[cpit].layout().bottomsep * dh;
1029 layoutdesc = max(unusual, usual);
1030 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1031 if (pars[cpit].layout() != pars[nextpit].layout()
1032 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1033 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1038 // incalculate the layout spaces
1039 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1040 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1042 // FIXME: the correct way is to do the following is to move the
1043 // following code in another method specially tailored for the
1044 // main Text. The following test is thus bogus.
1045 // Top and bottom margin of the document (only at top-level)
1046 if (main_text_ && topBottomSpace) {
1047 if (pit == 0 && row.pos() == 0)
1049 if (pit + 1 == pit_type(pars.size()) &&
1050 row.endpos() == par.size() &&
1051 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1055 row.dimension().asc = maxasc + labeladdon;
1056 row.dimension().des = maxdesc;
1060 // x is an absolute screen coord
1061 // returns the column near the specified x-coordinate of the row
1062 // x is set to the real beginning of this column
1063 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1064 bool & boundary) const
1066 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1067 /// For the main Text, it is possible that this pit is not
1068 /// yet in the CoordCache when moving cursor up.
1069 /// x Paragraph coordinate is always 0 for main text anyway.
1070 int const xo = origin_.x_;
1073 pos_type pos = row.pos();
1076 x = row.left_margin;
1077 else if (x <= row.left_margin) {
1078 pos = row.front().left_pos();
1079 x = row.left_margin;
1080 } else if (x >= row.width()) {
1081 pos = row.back().right_pos();
1084 double w = row.left_margin;
1085 Row::const_iterator cit = row.begin();
1086 Row::const_iterator cend = row.end();
1087 for ( ; cit != cend; ++cit) {
1088 if (w <= x && w + cit->full_width() > x) {
1089 int x_offset = int(x - w);
1090 pos = cit->x2pos(x_offset);
1091 x = int(x_offset + w);
1094 w += cit->full_width();
1096 if (cit == row.end()) {
1097 pos = row.back().right_pos();
1100 /** This tests for the case where the cursor is placed
1101 * just before a font direction change. See comment on
1102 * the boundary_ member in DocIterator.h to understand
1103 * how boundary helps here.
1105 else if (pos == cit->endpos
1106 && cit + 1 != row.end()
1107 && cit->isRTL() != (cit + 1)->isRTL())
1111 /** This tests for the case where the cursor is set at the end
1112 * of a row which has been broken due something else than a
1113 * separator (a display inset or a forced breaking of the
1114 * row). We know that there is a separator when the end of the
1115 * row is larger than the end of its last element.
1117 if (!row.empty() && pos == row.back().endpos
1118 && row.back().endpos == row.endpos())
1122 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1127 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1129 // We play safe and use parMetrics(pit) to make sure the
1130 // ParagraphMetrics will be redone and OK to use if needed.
1131 // Otherwise we would use an empty ParagraphMetrics in
1132 // upDownInText() while in selection mode.
1133 ParagraphMetrics const & pm = parMetrics(pit);
1135 LBUFERR(row < int(pm.rows().size()));
1137 Row const & r = pm.rows()[row];
1138 return getPosNearX(r, x, bound);
1142 void TextMetrics::newParMetricsDown()
1144 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1145 pit_type const pit = last.first + 1;
1146 if (pit == int(text_->paragraphs().size()))
1149 // do it and update its position.
1151 par_metrics_[pit].setPosition(last.second.position()
1152 + last.second.descent() + par_metrics_[pit].ascent());
1156 void TextMetrics::newParMetricsUp()
1158 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1159 if (first.first == 0)
1162 pit_type const pit = first.first - 1;
1163 // do it and update its position.
1165 par_metrics_[pit].setPosition(first.second.position()
1166 - first.second.ascent() - par_metrics_[pit].descent());
1169 // y is screen coordinate
1170 pit_type TextMetrics::getPitNearY(int y)
1172 LASSERT(!text_->paragraphs().empty(), return -1);
1173 LASSERT(!par_metrics_.empty(), return -1);
1174 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1176 // look for highest numbered paragraph with y coordinate less than given y
1179 ParMetricsCache::const_iterator it = par_metrics_.begin();
1180 ParMetricsCache::const_iterator et = par_metrics_.end();
1181 ParMetricsCache::const_iterator last = et;
1184 ParagraphMetrics const & pm = it->second;
1186 if (y < it->second.position() - int(pm.ascent())) {
1187 // We are looking for a position that is before the first paragraph in
1188 // the cache (which is in priciple off-screen, that is before the
1191 // We are already at the first paragraph in the inset.
1193 // OK, this is the paragraph we are looking for.
1194 pit = it->first - 1;
1199 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1201 if (y >= last->second.position() + int(pm_last.descent())) {
1202 // We are looking for a position that is after the last paragraph in
1203 // the cache (which is in priciple off-screen), that is before the
1205 pit = last->first + 1;
1206 if (pit == int(text_->paragraphs().size()))
1207 // We are already at the last paragraph in the inset.
1209 // OK, this is the paragraph we are looking for.
1210 newParMetricsDown();
1214 for (; it != et; ++it) {
1215 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1216 << " y: " << it->second.position());
1218 ParagraphMetrics const & pm = par_metrics_[it->first];
1220 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1222 yy = it->second.position();
1226 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1232 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1233 bool assert_in_view, bool up)
1235 ParagraphMetrics const & pm = par_metrics_[pit];
1237 int yy = pm.position() - pm.ascent();
1238 LBUFERR(!pm.rows().empty());
1239 RowList::const_iterator rit = pm.rows().begin();
1240 RowList::const_iterator rlast = pm.rows().end();
1242 for (; rit != rlast; yy += rit->height(), ++rit)
1243 if (yy + rit->height() > y)
1246 if (assert_in_view) {
1247 if (!up && yy + rit->height() > y) {
1248 if (rit != pm.rows().begin()) {
1251 } else if (pit != 0) {
1254 ParagraphMetrics const & pm2 = par_metrics_[pit];
1255 rit = pm2.rows().end();
1259 } else if (up && yy != y) {
1261 y = yy + rit->height();
1263 } else if (pit < int(text_->paragraphs().size()) - 1) {
1265 newParMetricsDown();
1266 ParagraphMetrics const & pm2 = par_metrics_[pit];
1267 rit = pm2.rows().begin();
1276 // x,y are absolute screen coordinates
1277 // sets cursor recursively descending into nested editable insets
1278 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1279 bool assert_in_view, bool up)
1281 if (lyxerr.debugging(Debug::WORKAREA)) {
1282 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1283 cur.bv().coordCache().dump();
1285 pit_type pit = getPitNearY(y);
1286 LASSERT(pit != -1, return 0);
1288 int yy = y; // is modified by getPitAndRowNearY
1289 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1293 // Do we cover an inset?
1294 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1297 // No inset, set position in the text
1298 bool bound = false; // is modified by getPosNearX
1299 int xx = x; // is modified by getPosNearX
1300 cur.pos() = getPosNearX(row, xx, bound);
1301 cur.boundary(bound);
1302 cur.setCurrentFont();
1307 Inset * inset = it->inset;
1308 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1310 // Set position in front of inset
1311 cur.pos() = it->pos;
1312 cur.boundary(false);
1315 // Try to descend recursively inside the inset.
1316 inset = inset->editXY(cur, x, yy);
1318 if (cur.top().text() == text_)
1319 cur.setCurrentFont();
1324 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1326 LASSERT(text_ == cur.text(), return);
1327 pit_type const pit = getPitNearY(y);
1328 LASSERT(pit != -1, return);
1330 ParagraphMetrics const & pm = par_metrics_[pit];
1332 int yy = pm.position() - pm.ascent();
1333 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1334 " pit: " << pit << " yy: " << yy);
1337 LBUFERR(pm.rows().size());
1338 for (; r < int(pm.rows().size()) - 1; ++r) {
1339 Row const & row = pm.rows()[r];
1340 if (int(yy + row.height()) > y)
1345 Row const & row = pm.rows()[r];
1347 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1351 pos_type const pos = getPosNearX(row, xx, bound);
1353 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1355 text_->setCursor(cur, pit, pos, true, bound);
1356 // remember new position.
1361 //takes screen x,y coordinates
1362 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1364 Paragraph const & par = text_->paragraphs()[pit];
1365 ParagraphMetrics const & pm = par_metrics_[pit];
1367 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1369 InsetList::const_iterator iit = par.insetList().begin();
1370 InsetList::const_iterator iend = par.insetList().end();
1371 for (; iit != iend; ++iit) {
1372 Inset * inset = iit->inset;
1374 LYXERR(Debug::DEBUG, "examining inset " << inset);
1376 if (!bv_->coordCache().getInsets().has(inset)) {
1377 LYXERR(Debug::DEBUG, "inset has no cached position");
1381 Dimension const & dim = pm.insetDimension(inset);
1382 Point p = bv_->coordCache().getInsets().xy(inset);
1384 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1385 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1387 if (x >= p.x_ && x <= p.x_ + dim.wid
1388 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1389 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1390 return const_cast<InsetList::InsetTable *>(&(*iit));
1394 LYXERR(Debug::DEBUG, "No inset hit. ");
1399 //takes screen x,y coordinates
1400 Inset * TextMetrics::checkInsetHit(int x, int y)
1402 pit_type const pit = getPitNearY(y);
1403 LASSERT(pit != -1, return 0);
1404 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1413 int TextMetrics::cursorX(CursorSlice const & sl,
1414 bool boundary) const
1416 LASSERT(sl.text() == text_, return 0);
1418 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1419 if (pm.rows().empty())
1421 Row const & row = pm.getRow(sl.pos(), boundary);
1422 pos_type const pos = sl.pos();
1425 * When boundary is true, position i is in the row element (pos, endpos)
1428 * whereas, when boundary is false, the test is
1430 * The correction below allows to handle both cases.
1432 int const boundary_corr = (boundary && pos) ? -1 : 0;
1434 /** Early return in trivial cases
1435 * 1) the row is empty
1436 * 2) the position is the left-most position of the row; there
1437 * is a quirck herehowever: if the first element is virtual
1438 * (end-of-par marker for example), then we have to look
1442 || (pos == row.begin()->left_pos()
1443 && pos != row.begin()->right_pos()))
1444 return row.left_margin;
1446 Row::const_iterator cit = row.begin();
1447 double x = row.left_margin;
1448 for ( ; cit != row.end() ; ++cit) {
1449 /** Look whether the cursor is inside the element's
1450 * span. Note that it is necessary to take the
1451 * boundary in account, and to accept virtual
1452 * elements, which have pos == endpos.
1454 if (pos + boundary_corr >= cit->pos
1455 && (pos + boundary_corr < cit->endpos
1456 || cit->pos == cit->endpos)) {
1457 x += cit->pos2x(pos);
1460 x += cit->full_width();
1467 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1469 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1470 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1471 if (pm.rows().empty())
1475 h -= par_metrics_[0].rows()[0].ascent();
1476 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1477 h += par_metrics_[pit].height();
1480 if (pos && boundary)
1482 size_t const rend = pm.pos2row(pos);
1483 for (size_t rit = 0; rit != rend; ++rit)
1484 h += pm.rows()[rit].height();
1485 h += pm.rows()[rend].ascent();
1490 // the cursor set functions have a special mechanism. When they
1491 // realize you left an empty paragraph, they will delete it.
1493 bool TextMetrics::cursorHome(Cursor & cur)
1495 LASSERT(text_ == cur.text(), return false);
1496 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1497 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1498 return text_->setCursor(cur, cur.pit(), row.pos());
1502 bool TextMetrics::cursorEnd(Cursor & cur)
1504 LASSERT(text_ == cur.text(), return false);
1505 // if not on the last row of the par, put the cursor before
1506 // the final space exept if I have a spanning inset or one string
1507 // is so long that we force a break.
1508 pos_type end = cur.textRow().endpos();
1510 // empty text, end-1 is no valid position
1512 bool boundary = false;
1513 if (end != cur.lastpos()) {
1514 if (!cur.paragraph().isLineSeparator(end-1)
1515 && !cur.paragraph().isNewline(end-1)
1516 && !cur.paragraph().isEnvSeparator(end-1))
1521 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1525 void TextMetrics::deleteLineForward(Cursor & cur)
1527 LASSERT(text_ == cur.text(), return);
1528 if (cur.lastpos() == 0) {
1529 // Paragraph is empty, so we just go forward
1530 text_->cursorForward(cur);
1533 cur.setSelection(true); // to avoid deletion
1536 // What is this test for ??? (JMarc)
1537 if (!cur.selection())
1538 text_->deleteWordForward(cur);
1540 cap::cutSelection(cur, true, false);
1541 cur.checkBufferStructure();
1546 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1548 ParagraphList const & pars = text_->paragraphs();
1549 return row.endpos() >= pars[pit].size()
1550 && pit + 1 == pit_type(pars.size());
1554 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1556 return row.pos() == 0 && pit == 0;
1560 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1562 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1566 int TextMetrics::leftMargin(int max_width,
1567 pit_type const pit, pos_type const pos) const
1569 ParagraphList const & pars = text_->paragraphs();
1571 LASSERT(pit >= 0, return 0);
1572 LASSERT(pit < int(pars.size()), return 0);
1573 Paragraph const & par = pars[pit];
1574 LASSERT(pos >= 0, return 0);
1575 LASSERT(pos <= par.size(), return 0);
1576 Buffer const & buffer = bv_->buffer();
1577 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1578 DocumentClass const & tclass = buffer.params().documentClass();
1579 Layout const & layout = par.layout();
1581 docstring parindent = layout.parindent;
1585 if (text_->isMainText())
1586 l_margin += bv_->leftMargin();
1588 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1589 tclass.leftmargin());
1591 int depth = par.getDepth();
1593 // find the next level paragraph
1594 pit_type newpar = text_->outerHook(pit);
1595 if (newpar != pit_type(pars.size())) {
1596 if (pars[newpar].layout().isEnvironment()) {
1597 int nestmargin = depth * nestMargin();
1598 if (text_->isMainText())
1599 nestmargin += changebarMargin();
1600 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1601 // Remove the parindent that has been added
1602 // if the paragraph was empty.
1603 if (pars[newpar].empty() &&
1604 buffer.params().paragraph_separation ==
1605 BufferParams::ParagraphIndentSeparation) {
1606 docstring pi = pars[newpar].layout().parindent;
1607 l_margin -= theFontMetrics(
1608 buffer.params().getFont()).signedWidth(pi);
1611 if (tclass.isDefaultLayout(par.layout())
1612 || tclass.isPlainLayout(par.layout())) {
1613 if (pars[newpar].params().noindent())
1616 parindent = pars[newpar].layout().parindent;
1621 // This happens after sections or environments in standard classes.
1622 // We have to check the previous layout at same depth.
1623 if (buffer.params().paragraph_separation ==
1624 BufferParams::ParagraphSkipSeparation)
1626 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1627 pit_type prev = text_->depthHook(pit, par.getDepth());
1628 if (par.layout() == pars[prev].layout()) {
1630 && pars[pit - 1].layout().nextnoindent)
1632 } else if (pars[prev].layout().nextnoindent)
1636 FontInfo const labelfont = text_->labelFont(par);
1637 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1639 switch (layout.margintype) {
1640 case MARGIN_DYNAMIC:
1641 if (!layout.leftmargin.empty()) {
1642 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1645 if (!par.labelString().empty()) {
1646 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1647 l_margin += labelfont_metrics.width(par.labelString());
1648 l_margin += labelfont_metrics.width(layout.labelsep);
1652 case MARGIN_MANUAL: {
1653 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1654 // The width of an empty par, even with manual label, should be 0
1655 if (!par.empty() && pos >= par.beginOfBody()) {
1656 if (!par.getLabelWidthString().empty()) {
1657 docstring labstr = par.getLabelWidthString();
1658 l_margin += labelfont_metrics.width(labstr);
1659 l_margin += labelfont_metrics.width(layout.labelsep);
1665 case MARGIN_STATIC: {
1666 l_margin += theFontMetrics(buffer.params().getFont()).
1667 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1671 case MARGIN_FIRST_DYNAMIC:
1672 if (layout.labeltype == LABEL_MANUAL) {
1673 // if we are at position 0, we are never in the body
1674 if (pos > 0 && pos >= par.beginOfBody())
1675 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1677 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1679 // Special case to fix problems with
1681 || (layout.labeltype == LABEL_STATIC
1682 && layout.latextype == LATEX_ENVIRONMENT
1683 && !text_->isFirstInSequence(pit))) {
1684 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1685 } else if (!layout.labelIsAbove()) {
1686 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1687 l_margin += labelfont_metrics.width(layout.labelsep);
1688 l_margin += labelfont_metrics.width(par.labelString());
1692 case MARGIN_RIGHT_ADDRESS_BOX: {
1694 // The left margin depends on the widest row in this paragraph.
1695 // This code is wrong because it depends on the rows, but at the
1696 // same time this function is used in redoParagraph to construct
1698 ParagraphMetrics const & pm = par_metrics_[pit];
1699 RowList::const_iterator rit = pm.rows().begin();
1700 RowList::const_iterator end = pm.rows().end();
1701 int minfill = max_width;
1702 for ( ; rit != end; ++rit)
1703 if (rit->fill() < minfill)
1704 minfill = rit->fill();
1705 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1706 l_margin += minfill;
1708 // also wrong, but much shorter.
1709 l_margin += max_width / 2;
1714 if (!par.params().leftIndent().zero())
1715 l_margin += par.params().leftIndent().inPixels(max_width, labelfont_metrics.em());
1719 if (par.params().align() == LYX_ALIGN_LAYOUT)
1720 align = layout.align;
1722 align = par.params().align();
1724 // set the correct parindent
1726 && (layout.labeltype == LABEL_NO_LABEL
1727 || layout.labeltype == LABEL_ABOVE
1728 || layout.labeltype == LABEL_CENTERED
1729 || (layout.labeltype == LABEL_STATIC
1730 && layout.latextype == LATEX_ENVIRONMENT
1731 && !text_->isFirstInSequence(pit)))
1732 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1733 && !par.params().noindent()
1734 // in some insets, paragraphs are never indented
1735 && !text_->inset().neverIndent()
1736 // display style insets are always centered, omit indentation
1739 && par.getInset(pos)->display())
1740 && (!(tclass.isDefaultLayout(par.layout())
1741 || tclass.isPlainLayout(par.layout()))
1742 || buffer.params().paragraph_separation
1743 == BufferParams::ParagraphIndentSeparation)) {
1744 // use the parindent of the layout when the
1745 // default indentation is used otherwise use
1746 // the indentation set in the document
1748 if (buffer.params().getIndentation().asLyXCommand() == "default")
1749 l_margin += theFontMetrics(
1750 buffer.params().getFont()).signedWidth(parindent);
1752 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1759 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1761 if (par_metrics_.empty())
1767 ParMetricsCache::iterator it = par_metrics_.begin();
1768 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1769 y -= it->second.ascent();
1770 for (; it != pm_end; ++it) {
1771 ParagraphMetrics const & pmi = it->second;
1773 pit_type const pit = it->first;
1774 // Save the paragraph position in the cache.
1775 it->second.setPosition(y);
1776 drawParagraph(pi, pit, x, y);
1782 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1784 BufferParams const & bparams = bv_->buffer().params();
1785 ParagraphMetrics const & pm = par_metrics_[pit];
1786 if (pm.rows().empty())
1789 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1790 int const ww = bv_->workHeight();
1791 size_t const nrows = pm.rows().size();
1793 Cursor const & cur = bv_->cursor();
1794 DocIterator sel_beg = cur.selectionBegin();
1795 DocIterator sel_end = cur.selectionEnd();
1796 bool selection = cur.selection()
1797 // This is our text.
1798 && cur.text() == text_
1799 // if the anchor is outside, this is not our selection
1800 && cur.normalAnchor().text() == text_
1801 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1803 // We store the begin and end pos of the selection relative to this par
1804 DocIterator sel_beg_par = cur.selectionBegin();
1805 DocIterator sel_end_par = cur.selectionEnd();
1807 // We care only about visible selection.
1809 if (pit != sel_beg.pit()) {
1810 sel_beg_par.pit() = pit;
1811 sel_beg_par.pos() = 0;
1813 if (pit != sel_end.pit()) {
1814 sel_end_par.pit() = pit;
1815 sel_end_par.pos() = sel_end_par.lastpos();
1819 for (size_t i = 0; i != nrows; ++i) {
1821 Row const & row = pm.rows()[i];
1826 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1827 rowSlice.pit() = pit;
1828 rowSlice.pos() = row.pos();
1830 bool const inside = (y + row.descent() >= 0
1831 && y - row.ascent() < ww);
1833 // Adapt to cursor row scroll offset if applicable.
1834 if (bv_->currentRowSlice() == rowSlice)
1835 row_x -= bv_->horizScrollOffset();
1837 // It is not needed to draw on screen if we are not inside.
1838 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1840 RowPainter rp(pi, *text_, pit, row, row_x, y);
1843 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1845 row.setSelection(-1, -1);
1847 // The row knows nothing about the paragraph, so we have to check
1848 // whether this row is the first or last and update the margins.
1849 if (row.selection()) {
1850 if (row.sel_beg == 0)
1851 row.begin_margin_sel = sel_beg.pit() < pit;
1852 if (row.sel_end == sel_end_par.lastpos())
1853 row.end_margin_sel = sel_end.pit() > pit;
1856 // Row signature; has row changed since last paint?
1857 if (pi.pain.isDrawingEnabled())
1858 row.setCrc(pm.computeRowSignature(row, bparams));
1859 bool row_has_changed = row.changed()
1860 || rowSlice == bv_->lastRowSlice();
1862 // Take this opportunity to spellcheck the row contents.
1863 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1864 text_->getPar(pit).spellCheck();
1867 // Don't paint the row if a full repaint has not been requested
1868 // and if it has not changed.
1869 if (!pi.full_repaint && !row_has_changed) {
1870 // Paint only the insets if the text itself is
1872 rp.paintOnlyInsets();
1877 // Clear background of this row if paragraph background was not
1878 // already cleared because of a full repaint.
1879 if (!pi.full_repaint && row_has_changed) {
1880 LYXERR(Debug::PAINTING, "Clear rect@("
1881 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1882 << width() << " x " << row.height());
1883 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1884 width(), row.height(), pi.background_color);
1887 // Instrumentation for testing row cache (see also
1889 if (lyxerr.debugging(Debug::PAINTING) && inside
1890 && (row.selection() || pi.full_repaint || row_has_changed)) {
1891 string const foreword = text_->isMainText() ?
1892 "main text redraw " : "inset text redraw: ";
1893 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1894 << " row_selection=" << row.selection()
1895 << " full_repaint=" << pi.full_repaint
1896 << " row_has_changed=" << row_has_changed
1897 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1900 // Backup full_repaint status and force full repaint
1901 // for inner insets as the Row has been cleared out.
1902 bool tmp = pi.full_repaint;
1903 pi.full_repaint = true;
1905 rp.paintSelection();
1908 rp.paintChangeBar();
1909 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1910 if (i == 0 && !is_rtl)
1912 if (i == nrows - 1 && is_rtl)
1915 if (i == nrows - 1 && !is_rtl)
1917 if (i == 0 && is_rtl)
1919 rp.paintTooLargeMarks(row_x < 0,
1920 row_x + row.width() > bv_->workWidth());
1923 // Restore full_repaint status.
1924 pi.full_repaint = tmp;
1926 // Re-enable screen drawing for future use of the painter.
1927 pi.pain.setDrawingEnabled(original_drawing_state);
1929 //LYXERR(Debug::PAINTING, ".");
1933 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1934 Dimension & dim) const
1936 Cursor const & bvcur = cur.bv().cursor();
1938 // get word in front of cursor
1939 docstring word = text_->previousWord(bvcur.top());
1940 DocIterator wordStart = bvcur;
1941 wordStart.pos() -= word.length();
1943 // get position on screen of the word start and end
1944 //FIXME: Is it necessary to explicitly set this to false?
1945 wordStart.boundary(false);
1946 Point lxy = cur.bv().getPos(wordStart);
1947 Point rxy = cur.bv().getPos(bvcur);
1949 // calculate dimensions of the word
1951 row.pos(wordStart.pos());
1952 row.endpos(bvcur.pos());
1953 setRowHeight(row, bvcur.pit(), false);
1954 dim = row.dimension();
1955 dim.wid = abs(rxy.x_ - lxy.x_);
1957 // calculate position of word
1959 x = min(rxy.x_, lxy.x_);
1961 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1962 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1965 int defaultRowHeight()
1967 return int(theFontMetrics(sane_font).maxHeight() * 1.2);