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"
34 #include "MetricsInfo.h"
35 #include "ParagraphParameters.h"
36 #include "RowPainter.h"
38 #include "TextClass.h"
41 #include "insets/InsetText.h"
43 #include "mathed/MathMacroTemplate.h"
45 #include "frontends/FontMetrics.h"
46 #include "frontends/Painter.h"
48 #include "support/debug.h"
49 #include "support/lassert.h"
58 using frontend::FontMetrics;
63 int numberOfLabelHfills(Paragraph const & par, Row const & row)
65 pos_type last = row.endpos() - 1;
66 pos_type first = row.pos();
68 // hfill *DO* count at the beginning of paragraphs!
70 while (first < last && par.isHfill(first))
74 last = min(last, par.beginOfBody());
76 for (pos_type p = first; p < last; ++p) {
84 int numberOfHfills(Row const & row, pos_type const body_pos)
87 Row::const_iterator cit = row.begin();
88 Row::const_iterator const end = row.end();
89 for ( ; cit != end ; ++cit)
90 if (cit->pos >= body_pos
91 && cit->inset && cit->inset->isHfill())
99 /////////////////////////////////////////////////////////////////////
103 /////////////////////////////////////////////////////////////////////
106 TextMetrics::TextMetrics(BufferView * bv, Text * text)
107 : bv_(bv), text_(text)
110 max_width_ = bv_->workWidth();
111 dim_.wid = max_width_;
117 bool TextMetrics::contains(pit_type pit) const
119 return par_metrics_.find(pit) != par_metrics_.end();
123 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
125 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
130 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
132 ParMetricsCache::const_iterator it = par_metrics_.begin();
133 return make_pair(it->first, &it->second);
137 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
139 LBUFERR(!par_metrics_.empty());
140 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
141 return make_pair(it->first, &it->second);
145 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
147 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
148 if (pmc_it == par_metrics_.end()) {
149 pmc_it = par_metrics_.insert(
150 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
152 if (pmc_it->second.rows().empty() && redo)
154 return pmc_it->second;
158 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
160 LBUFERR(mi.base.textwidth > 0);
161 max_width_ = mi.base.textwidth;
162 // backup old dimension.
163 Dimension const old_dim = dim_;
166 dim_.wid = min_width;
167 pit_type const npar = text_->paragraphs().size();
169 // If there is more than one row, expand the text to
170 // the full allowable width.
171 dim_.wid = max_width_;
173 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
174 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
176 bool changed = false;
178 for (pit_type pit = 0; pit != npar; ++pit) {
179 changed |= redoParagraph(pit);
180 ParagraphMetrics const & pm = par_metrics_[pit];
182 if (dim_.wid < pm.width())
183 dim_.wid = pm.width();
186 dim_.asc = par_metrics_[0].ascent();
187 dim_.des = h - dim_.asc;
188 //lyxerr << "dim_.wid " << dim_.wid << endl;
189 //lyxerr << "dim_.asc " << dim_.asc << endl;
190 //lyxerr << "dim_.des " << dim_.des << endl;
192 changed |= dim_ != old_dim;
198 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
200 return main_text_? pm.rightMargin(*bv_) : 0;
204 int TextMetrics::rightMargin(pit_type const pit) const
206 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
210 void TextMetrics::applyOuterFont(Font & font) const
212 FontInfo lf(font_.fontInfo());
213 lf.reduce(bv_->buffer().params().getFont().fontInfo());
214 font.fontInfo().realize(lf);
218 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
220 LASSERT(pos >= 0, { static Font f; return f; });
222 ParagraphList const & pars = text_->paragraphs();
223 Paragraph const & par = pars[pit];
224 Layout const & layout = par.layout();
225 Buffer const & buffer = bv_->buffer();
227 BufferParams const & params = buffer.params();
228 pos_type const body_pos = par.beginOfBody();
230 // We specialize the 95% common case:
231 if (!par.getDepth()) {
232 Font f = par.getFontSettings(params, pos);
233 if (!text_->isMainText())
235 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
237 FontInfo const & lf = lab ? layout.labelfont : layout.font;
238 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
240 // In case the default family has been customized
241 if (lf.family() == INHERIT_FAMILY)
242 rlf.setFamily(params.getFont().fontInfo().family());
243 f.fontInfo().realize(rlf);
247 // The uncommon case need not be optimized as much
248 FontInfo const & layoutfont = pos < body_pos ?
249 layout.labelfont : layout.font;
251 Font font = par.getFontSettings(params, pos);
252 font.fontInfo().realize(layoutfont);
254 if (!text_->isMainText())
255 applyOuterFont(font);
257 // Realize against environment font information
258 // NOTE: the cast to pit_type should be removed when pit_type
259 // changes to a unsigned integer.
260 if (pit < pit_type(pars.size()))
261 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
263 // Realize with the fonts of lesser depth.
264 font.fontInfo().realize(params.getFont().fontInfo());
270 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
276 if (boundary && sl.pos() > 0)
279 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
283 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
285 // no RTL boundary at paragraph start
289 Font const & left_font = displayFont(pit, pos - 1);
291 return isRTLBoundary(pit, pos, left_font);
295 // isRTLBoundary returns false on a real end-of-line boundary,
296 // because otherwise the two boundary types get mixed up.
297 // This is the whole purpose of this being in TextMetrics.
298 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
299 Font const & font) const
301 if (// no RTL boundary at paragraph start
303 // if the metrics have not been calculated, then we are not
304 // on screen and can safely ignore issues about boundaries.
308 ParagraphMetrics & pm = par_metrics_[pit];
309 // no RTL boundary in empty paragraph
310 if (pm.rows().empty())
313 pos_type endpos = pm.getRow(pos - 1, false).endpos();
314 pos_type startpos = pm.getRow(pos, false).pos();
315 // no RTL boundary at line start:
316 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
318 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
321 Paragraph const & par = text_->getPar(pit);
322 // no RTL boundary at line break:
323 // abc|\n -> move right -> abc\n (and not: abc\n|
325 if (startpos == pos && endpos == pos && endpos != par.size()
326 && (par.isNewline(pos - 1)
327 || par.isEnvSeparator(pos - 1)
328 || par.isLineSeparator(pos - 1)
329 || par.isSeparator(pos - 1)))
332 bool left = font.isVisibleRightToLeft();
334 if (pos == par.size())
335 right = par.isRTL(bv_->buffer().params());
337 right = displayFont(pit, pos).isVisibleRightToLeft();
339 return left != right;
343 bool TextMetrics::redoParagraph(pit_type const pit)
345 Paragraph & par = text_->getPar(pit);
346 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
347 // redoParagraph() recursively inside parMetrics.
348 Dimension old_dim = parMetrics(pit, false).dim();
349 ParagraphMetrics & pm = par_metrics_[pit];
352 Buffer & buffer = bv_->buffer();
353 main_text_ = (text_ == &buffer.text());
354 bool changed = false;
356 // Check whether there are InsetBibItems that need fixing
357 // FIXME: This check ought to be done somewhere else. It is the reason
358 // why text_ is not const. But then, where else to do it?
359 // Well, how can you end up with either (a) a biblio environment that
360 // has no InsetBibitem or (b) a biblio environment with more than one
361 // InsetBibitem? I think the answer is: when paragraphs are merged;
362 // when layout is set; when material is pasted.
363 if (par.brokenBiblio()) {
364 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
365 // In some cases, we do not know how to record undo
366 if (&cur.inset() == &text_->inset())
367 cur.recordUndo(pit, pit);
369 int const moveCursor = par.fixBiblio(buffer);
371 // Is it necessary to update the cursor?
372 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
375 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
380 // Optimisation: this is used in the next two loops
381 // so better to calculate that once here.
382 int const right_margin = rightMargin(pm);
384 // iterator pointing to paragraph to resolve macros
385 DocIterator parPos = text_->macrocontextPosition();
389 LYXERR(Debug::INFO, "MacroContext not initialised!"
390 << " Going through the buffer again and hope"
391 << " the context is better then.");
392 // FIXME audit updateBuffer calls
393 // This should not be here, but it is not clear yet where else it
395 bv_->buffer().updateBuffer();
396 parPos = text_->macrocontextPosition();
397 LBUFERR(!parPos.empty());
402 Font const bufferfont = buffer.params().getFont();
403 InsetList::const_iterator ii = par.insetList().begin();
404 InsetList::const_iterator iend = par.insetList().end();
405 for (; ii != iend; ++ii) {
406 // FIXME Doesn't this HAVE to be non-empty?
407 // position already initialized?
408 if (!parPos.empty()) {
409 parPos.pos() = ii->pos;
411 // A macro template would normally not be visible
412 // by itself. But the tex macro semantics allow
413 // recursion, so we artifically take the context
414 // after the macro template to simulate this.
415 if (ii->inset->lyxCode() == MATHMACRO_CODE)
419 // do the metric calculation
421 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
423 Font const & font = ii->inset->inheritFont() ?
424 displayFont(pit, ii->pos) : bufferfont;
425 MacroContext mc(&buffer, parPos);
426 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
427 ii->inset->metrics(mi, dim);
428 Dimension const & old_dim = pm.insetDimension(ii->inset);
429 if (old_dim != dim) {
430 pm.setInsetDimension(ii->inset, dim);
435 par.setBeginOfBody();
437 size_t row_index = 0;
438 // maximum pixel width of a row
440 if (row_index == pm.rows().size())
441 pm.rows().push_back(Row());
442 Row & row = pm.rows()[row_index];
444 breakRow(row, right_margin, pit);
445 setRowHeight(row, pit);
446 row.setChanged(false);
447 if (row_index || row.right_boundary() || row.endpos() < par.size())
448 // If there is more than one row or the row has been
449 // broken by a display inset or a newline, expand the text
450 // to the full allowable width. This setting here is
451 // needed for the computeRowMetrics() below.
452 dim_.wid = max_width_;
453 int const max_row_width = max(dim_.wid, row.width());
454 computeRowMetrics(pit, row, max_row_width);
455 first = row.endpos();
458 pm.dim().wid = max(pm.dim().wid, row.width());
459 pm.dim().des += row.height();
460 } while (first < par.size());
462 if (row_index < pm.rows().size())
463 pm.rows().resize(row_index);
465 // Make sure that if a par ends in newline, there is one more row
467 if (first > 0 && par.isNewline(first - 1)) {
468 if (row_index == pm.rows().size())
469 pm.rows().push_back(Row());
470 Row & row = pm.rows()[row_index];
473 setRowHeight(row, pit);
474 row.setChanged(false);
475 int const max_row_width = max(dim_.wid, row.width());
476 computeRowMetrics(pit, row, max_row_width);
477 pm.dim().des += row.height();
480 pm.dim().asc += pm.rows()[0].ascent();
481 pm.dim().des -= pm.rows()[0].ascent();
483 changed |= old_dim.height() != pm.dim().height();
489 LyXAlignment TextMetrics::getAlign(Paragraph const & par, pos_type const pos) const
491 Layout const & layout = par.layout();
494 if (par.params().align() == LYX_ALIGN_LAYOUT)
495 align = layout.align;
497 align = par.params().align();
499 // handle alignment inside tabular cells
500 Inset const & owner = text_->inset();
501 switch (owner.contentAlignment()) {
502 case LYX_ALIGN_CENTER:
504 case LYX_ALIGN_RIGHT:
505 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
506 align = owner.contentAlignment();
509 // unchanged (use align)
513 // Display-style insets should always be on a centered row
514 if (Inset const * inset = par.getInset(pos)) {
515 switch (inset->display()) {
516 case Inset::AlignLeft:
517 align = LYX_ALIGN_BLOCK;
519 case Inset::AlignCenter:
520 align = LYX_ALIGN_CENTER;
523 // unchanged (use align)
525 case Inset::AlignRight:
526 align = LYX_ALIGN_RIGHT;
531 // Has the user requested we not justify stuff?
532 if (!bv_->buffer().params().justification
533 && align == LYX_ALIGN_BLOCK)
534 align = LYX_ALIGN_LEFT;
540 void TextMetrics::computeRowMetrics(pit_type const pit,
541 Row & row, int width) const
546 Paragraph const & par = text_->getPar(pit);
548 int const w = width - row.right_margin - row.width();
549 // FIXME: put back this assertion when the crash on new doc is solved.
550 //LASSERT(w >= 0, /**/);
552 // is there a manual margin with a manual label
553 Layout const & layout = par.layout();
556 if (layout.margintype == MARGIN_MANUAL
557 && layout.labeltype == LABEL_MANUAL) {
558 /// We might have real hfills in the label part
559 nlh = numberOfLabelHfills(par, row);
561 // A manual label par (e.g. List) has an auto-hfill
562 // between the label text and the body of the
564 // But we don't want to do this auto hfill if the par
569 if (nlh && !par.getLabelWidthString().empty())
570 row.label_hfill = labelFill(pit, row) / double(nlh);
574 // are there any hfills in the row?
575 if (int const nh = numberOfHfills(row, par.beginOfBody())) {
577 hfill = double(w) / nh;
578 // we don't have to look at the alignment if it is ALIGN_LEFT and
579 // if the row is already larger then the permitted width as then
580 // we force the LEFT_ALIGN'edness!
581 } else if (int(row.width()) < max_width_) {
582 // is it block, flushleft or flushright?
583 // set x how you need it
584 switch (getAlign(par, row.pos())) {
585 case LYX_ALIGN_BLOCK: {
586 int const ns = row.countSeparators();
587 /** If we have separators, and this row has
588 * not be broken abruptly by a display inset
589 * or newline, then stretch it */
590 if (ns && !row.right_boundary()
591 && row.endpos() != par.size()) {
592 row.setSeparatorExtraWidth(double(w) / ns);
593 row.dimension().wid = width;
594 } else if (text_->isRTL(par)) {
595 row.dimension().wid = width;
596 row.left_margin += w;
600 case LYX_ALIGN_RIGHT:
601 row.left_margin += w;
602 row.dimension().wid += w;
604 case LYX_ALIGN_CENTER:
605 row.dimension().wid = width - w / 2;
606 row.left_margin += w / 2;
610 case LYX_ALIGN_LAYOUT:
611 case LYX_ALIGN_SPECIAL:
612 case LYX_ALIGN_DECIMAL:
617 // Finally, handle hfill insets
618 pos_type const endpos = row.endpos();
619 pos_type body_pos = par.beginOfBody();
621 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
623 ParagraphMetrics & pm = par_metrics_[pit];
624 Row::iterator cit = row.begin();
625 Row::iterator const cend = row.end();
626 for ( ; cit != cend; ++cit) {
627 if (row.label_hfill && cit->endpos == body_pos
628 && cit->type == Row::SPACE)
629 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
630 if (!cit->inset || !cit->inset->isHfill())
632 if (pm.hfillExpansion(row, cit->pos))
633 cit->dim.wid = int(cit->pos >= body_pos ?
634 max(hfill, 5.0) : row.label_hfill);
637 // Cache the inset dimension.
638 bv_->coordCache().insets().add(cit->inset, cit->dim);
639 pm.setInsetDimension(cit->inset, cit->dim);
644 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
646 Paragraph const & par = text_->getPar(pit);
647 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
650 Row::const_iterator cit = row.begin();
651 Row::const_iterator const end = row.end();
652 // iterate over elements before main body (except the last one,
653 // which is extra space).
654 while (cit!= end && cit->endpos < par.beginOfBody()) {
659 docstring const & label = par.params().labelWidthString();
663 FontMetrics const & fm
664 = theFontMetrics(text_->labelFont(par));
666 return max(0, fm.width(label) - w);
671 // Not used, see TextMetrics::breakRow
672 // this needs special handling - only newlines count as a break point
673 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
675 pos_type const end = par.size();
678 if (par.isNewline(i))
686 int TextMetrics::labelEnd(pit_type const pit) const
688 // labelEnd is only needed if the layout fills a flushleft label.
689 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
691 // return the beginning of the body
692 return leftMargin(max_width_, pit);
698 * Calling Text::getFont is slow. While rebreaking we scan a
699 * paragraph from left to right calling getFont for every char. This
700 * simple class address this problem by hidding an optimization trick
701 * (not mine btw -AB): the font is reused in the whole font span. The
702 * class handles transparently the "hidden" (not part of the fontlist)
703 * label font (as getFont does).
709 FontIterator(TextMetrics const & tm,
710 Paragraph const & par, pit_type pit, pos_type pos)
711 : tm_(tm), par_(par), pit_(pit), pos_(pos),
712 font_(tm.displayFont(pit, pos)),
713 endspan_(par.fontSpan(pos).last),
714 bodypos_(par.beginOfBody())
718 Font const & operator*() const { return font_; }
721 FontIterator & operator++()
724 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
725 font_ = tm_.displayFont(pit_, pos_);
726 endspan_ = par_.fontSpan(pos_).last;
732 Font * operator->() { return &font_; }
736 TextMetrics const & tm_;
738 Paragraph const & par_;
753 /** This is the function where the hard work is done. The code here is
754 * very sensitive to small changes :) Note that part of the
755 * intelligence is also in Row::shortenIfNeeded.
757 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
759 Paragraph const & par = text_->getPar(pit);
760 pos_type const end = par.size();
761 pos_type const pos = row.pos();
762 pos_type const body_pos = par.beginOfBody();
763 bool const is_rtl = text_->isRTL(par);
766 row.left_margin = leftMargin(max_width_, pit, pos);
767 row.right_margin = right_margin;
769 swap(row.left_margin, row.right_margin);
770 // Remember that the row width takes into account the left_margin
771 // but not the right_margin.
772 row.dimension().wid = row.left_margin;
773 // the width available for the row.
774 int const width = max_width_ - row.right_margin;
776 if (pos >= end || row.width() > width) {
781 ParagraphMetrics const & pm = par_metrics_[pit];
782 ParagraphList const & pars = text_->paragraphs();
785 //FIXME: As long as leftMargin() is not correctly implemented for
786 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
787 // Otherwise, long rows will be painted off the screen.
788 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
789 return addressBreakPoint(pos, par);
792 // check for possible inline completion
793 DocIterator const & ic_it = bv_->inlineCompletionPos();
794 pos_type ic_pos = -1;
795 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
796 ic_pos = ic_it.pos();
798 // Now we iterate through until we reach the right margin
799 // or the end of the par, then build a representation of the row.
801 FontIterator fi = FontIterator(*this, par, pit, pos);
802 while (i < end && row.width() <= width) {
803 char_type c = par.getChar(i);
804 // The most special cases are handled first.
805 if (par.isInset(i)) {
806 Inset const * ins = par.getInset(i);
807 Dimension dim = pm.insetDimension(ins);
808 row.add(i, ins, dim, *fi, par.lookupChange(i));
809 } else if (c == ' ' && i + 1 == body_pos) {
810 // There is a space at i, but it should not be
811 // added as a separator, because it is just
812 // before body_pos. Instead, insert some spacing to
814 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
815 // this is needed to make sure that the row width is correct
817 int const add = max(fm.width(par.layout().labelsep),
818 labelEnd(pit) - row.width());
819 row.addSpace(i, add, *fi, par.lookupChange(i));
820 } else if (c == '\t')
821 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
822 *fi, par.lookupChange(i));
824 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
825 // see also Paragraph::getUChar.
826 if (fi->language()->lang() == "hebrew") {
832 row.add(i, c, *fi, par.lookupChange(i));
835 // add inline completion width
836 // draw logically behind the previous character
837 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
838 docstring const comp = bv_->inlineCompletion();
839 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
843 f.fontInfo().setColor(Color_inlinecompletion);
844 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
846 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
847 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
850 // Handle some situations that abruptly terminate the row
852 // - Before a display inset
853 // - After a display inset
854 Inset const * inset = 0;
855 if (par.isNewline(i) || par.isEnvSeparator(i)
856 || (i + 1 < end && (inset = par.getInset(i + 1))
858 || (!row.empty() && row.back().inset
859 && row.back().inset->display())) {
860 row.right_boundary(true);
871 // End of paragraph marker
872 if (lyxrc.paragraph_markers
873 && i == end && size_type(pit + 1) < pars.size()) {
874 // add a virtual element for the end-of-paragraph
875 // marker; it is shown on screen, but does not exist
877 Font f(text_->layoutFont(pit));
878 f.fontInfo().setColor(Color_paragraphmarker);
879 BufferParams const & bparams
880 = text_->inset().buffer().params();
881 f.setLanguage(par.getParLanguage(bparams));
882 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
885 // if the row is too large, try to cut at last separator.
886 row.shortenIfNeeded(body_pos, width);
888 // make sure that the RTL elements are in reverse ordering
889 row.reverseRTL(is_rtl);
890 //LYXERR0("breakrow: row is " << row);
894 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
895 bool topBottomSpace) const
897 Paragraph const & par = text_->getPar(pit);
898 // get the maximum ascent and the maximum descent
899 double layoutasc = 0;
900 double layoutdesc = 0;
901 double const dh = defaultRowHeight();
903 // ok, let us initialize the maxasc and maxdesc value.
904 // Only the fontsize count. The other properties
905 // are taken from the layoutfont. Nicer on the screen :)
906 Layout const & layout = par.layout();
908 // as max get the first character of this row then it can
909 // increase but not decrease the height. Just some point to
910 // start with so we don't have to do the assignment below too
912 Buffer const & buffer = bv_->buffer();
913 Font font = displayFont(pit, row.pos());
914 FontSize const tmpsize = font.fontInfo().size();
915 font.fontInfo() = text_->layoutFont(pit);
916 FontSize const size = font.fontInfo().size();
917 font.fontInfo().setSize(tmpsize);
919 FontInfo labelfont = text_->labelFont(par);
921 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
922 FontMetrics const & fontmetrics = theFontMetrics(font);
924 // these are minimum values
925 double const spacing_val = layout.spacing.getValue()
926 * text_->spacing(par);
927 //lyxerr << "spacing_val = " << spacing_val << endl;
928 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
929 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
931 // insets may be taller
932 ParagraphMetrics const & pm = par_metrics_[pit];
933 Row::const_iterator cit = row.begin();
934 Row::const_iterator cend = row.end();
935 for ( ; cit != cend; ++cit) {
937 Dimension const & dim = pm.insetDimension(cit->inset);
938 maxasc = max(maxasc, dim.ascent());
939 maxdesc = max(maxdesc, dim.descent());
943 // Check if any custom fonts are larger (Asger)
944 // This is not completely correct, but we can live with the small,
945 // cosmetic error for now.
949 par.highestFontInRange(row.pos(), row.endpos(), size);
950 if (maxsize > font.fontInfo().size()) {
951 // use standard paragraph font with the maximal size
952 FontInfo maxfont = font.fontInfo();
953 maxfont.setSize(maxsize);
954 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
955 maxasc = max(maxasc, maxfontmetrics.maxAscent());
956 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
959 // This is nicer with box insets:
963 ParagraphList const & pars = text_->paragraphs();
964 Inset const & inset = text_->inset();
967 if (row.pos() == 0 && topBottomSpace) {
968 BufferParams const & bufparams = buffer.params();
969 // some parskips VERY EASY IMPLEMENTATION
970 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
971 && !inset.getLayout().parbreakIsNewline()
972 && !par.layout().parbreak_is_newline
974 && ((layout.isParagraph() && par.getDepth() == 0)
975 || (pars[pit - 1].layout().isParagraph()
976 && pars[pit - 1].getDepth() == 0))) {
977 maxasc += bufparams.getDefSkip().inPixels(*bv_);
980 if (par.params().startOfAppendix())
981 maxasc += int(3 * dh);
983 // special code for the top label
984 if (layout.labelIsAbove()
985 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
986 && !par.labelString().empty()) {
988 labelfont_metrics.maxHeight()
989 * layout.spacing.getValue()
990 * text_->spacing(par)
991 + (layout.topsep + layout.labelbottomsep) * dh);
994 // Add the layout spaces, for example before and after
995 // a section, or between the items of a itemize or enumerate
998 pit_type prev = text_->depthHook(pit, par.getDepth());
999 Paragraph const & prevpar = pars[prev];
1001 && prevpar.layout() == layout
1002 && prevpar.getDepth() == par.getDepth()
1003 && prevpar.getLabelWidthString()
1004 == par.getLabelWidthString()) {
1005 layoutasc = layout.itemsep * dh;
1006 } else if (pit != 0 || row.pos() != 0) {
1007 if (layout.topsep > 0)
1008 layoutasc = layout.topsep * dh;
1011 prev = text_->outerHook(pit);
1012 if (prev != pit_type(pars.size())) {
1013 maxasc += int(pars[prev].layout().parsep * dh);
1014 } else if (pit != 0) {
1015 Paragraph const & prevpar = pars[pit - 1];
1016 if (prevpar.getDepth() != 0 ||
1017 prevpar.layout() == layout) {
1018 maxasc += int(layout.parsep * dh);
1023 // is it a bottom line?
1024 if (row.endpos() >= par.size() && topBottomSpace) {
1025 // add the layout spaces, for example before and after
1026 // a section, or between the items of a itemize or enumerate
1028 pit_type nextpit = pit + 1;
1029 if (nextpit != pit_type(pars.size())) {
1030 pit_type cpit = pit;
1032 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1033 double usual = pars[cpit].layout().bottomsep * dh;
1035 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1036 if (pars[cpit].layout() != pars[nextpit].layout()
1037 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1038 unusual = pars[cpit].layout().bottomsep * dh;
1039 layoutdesc = max(unusual, usual);
1040 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1041 if (pars[cpit].layout() != pars[nextpit].layout()
1042 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1043 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1048 // incalculate the layout spaces
1049 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1050 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1052 // FIXME: the correct way is to do the following is to move the
1053 // following code in another method specially tailored for the
1054 // main Text. The following test is thus bogus.
1055 // Top and bottom margin of the document (only at top-level)
1056 if (main_text_ && topBottomSpace) {
1057 if (pit == 0 && row.pos() == 0)
1059 if (pit + 1 == pit_type(pars.size()) &&
1060 row.endpos() == par.size() &&
1061 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1065 row.dimension().asc = maxasc + labeladdon;
1066 row.dimension().des = maxdesc;
1070 // x is an absolute screen coord
1071 // returns the column near the specified x-coordinate of the row
1072 // x is set to the real beginning of this column
1073 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1074 bool & boundary) const
1076 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1077 /// For the main Text, it is possible that this pit is not
1078 /// yet in the CoordCache when moving cursor up.
1079 /// x Paragraph coordinate is always 0 for main text anyway.
1080 int const xo = origin_.x_;
1083 pos_type pos = row.pos();
1086 x = row.left_margin;
1087 else if (x <= row.left_margin) {
1088 pos = row.front().left_pos();
1089 x = row.left_margin;
1090 } else if (x >= row.width()) {
1091 pos = row.back().right_pos();
1094 double w = row.left_margin;
1095 Row::const_iterator cit = row.begin();
1096 Row::const_iterator cend = row.end();
1097 for ( ; cit != cend; ++cit) {
1098 if (w <= x && w + cit->full_width() > x) {
1099 int x_offset = int(x - w);
1100 pos = cit->x2pos(x_offset);
1101 x = int(x_offset + w);
1104 w += cit->full_width();
1106 if (cit == row.end()) {
1107 pos = row.back().right_pos();
1110 /** This tests for the case where the cursor is placed
1111 * just before a font direction change. See comment on
1112 * the boundary_ member in DocIterator.h to understand
1113 * how boundary helps here.
1115 else if (pos == cit->endpos
1116 && cit + 1 != row.end()
1117 && cit->isRTL() != (cit + 1)->isRTL())
1121 /** This tests for the case where the cursor is set at the end
1122 * of a row which has been broken due something else than a
1123 * separator (a display inset or a forced breaking of the
1124 * row). We know that there is a separator when the end of the
1125 * row is larger than the end of its last element.
1127 if (!row.empty() && pos == row.back().endpos
1128 && row.back().endpos == row.endpos())
1132 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1137 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1139 // We play safe and use parMetrics(pit) to make sure the
1140 // ParagraphMetrics will be redone and OK to use if needed.
1141 // Otherwise we would use an empty ParagraphMetrics in
1142 // upDownInText() while in selection mode.
1143 ParagraphMetrics const & pm = parMetrics(pit);
1145 LBUFERR(row < int(pm.rows().size()));
1147 Row const & r = pm.rows()[row];
1148 return getPosNearX(r, x, bound);
1152 void TextMetrics::newParMetricsDown()
1154 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1155 pit_type const pit = last.first + 1;
1156 if (pit == int(text_->paragraphs().size()))
1159 // do it and update its position.
1161 par_metrics_[pit].setPosition(last.second.position()
1162 + last.second.descent() + par_metrics_[pit].ascent());
1166 void TextMetrics::newParMetricsUp()
1168 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1169 if (first.first == 0)
1172 pit_type const pit = first.first - 1;
1173 // do it and update its position.
1175 par_metrics_[pit].setPosition(first.second.position()
1176 - first.second.ascent() - par_metrics_[pit].descent());
1179 // y is screen coordinate
1180 pit_type TextMetrics::getPitNearY(int y)
1182 LASSERT(!text_->paragraphs().empty(), return -1);
1183 LASSERT(!par_metrics_.empty(), return -1);
1184 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1186 // look for highest numbered paragraph with y coordinate less than given y
1189 ParMetricsCache::const_iterator it = par_metrics_.begin();
1190 ParMetricsCache::const_iterator et = par_metrics_.end();
1191 ParMetricsCache::const_iterator last = et;
1194 ParagraphMetrics const & pm = it->second;
1196 if (y < it->second.position() - int(pm.ascent())) {
1197 // We are looking for a position that is before the first paragraph in
1198 // the cache (which is in priciple off-screen, that is before the
1201 // We are already at the first paragraph in the inset.
1203 // OK, this is the paragraph we are looking for.
1204 pit = it->first - 1;
1209 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1211 if (y >= last->second.position() + int(pm_last.descent())) {
1212 // We are looking for a position that is after the last paragraph in
1213 // the cache (which is in priciple off-screen), that is before the
1215 pit = last->first + 1;
1216 if (pit == int(text_->paragraphs().size()))
1217 // We are already at the last paragraph in the inset.
1219 // OK, this is the paragraph we are looking for.
1220 newParMetricsDown();
1224 for (; it != et; ++it) {
1225 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1226 << " y: " << it->second.position());
1228 ParagraphMetrics const & pm = par_metrics_[it->first];
1230 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1232 yy = it->second.position();
1236 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1242 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1243 bool assert_in_view, bool up)
1245 ParagraphMetrics const & pm = par_metrics_[pit];
1247 int yy = pm.position() - pm.ascent();
1248 LBUFERR(!pm.rows().empty());
1249 RowList::const_iterator rit = pm.rows().begin();
1250 RowList::const_iterator rlast = pm.rows().end();
1252 for (; rit != rlast; yy += rit->height(), ++rit)
1253 if (yy + rit->height() > y)
1256 if (assert_in_view) {
1257 if (!up && yy + rit->height() > y) {
1258 if (rit != pm.rows().begin()) {
1261 } else if (pit != 0) {
1264 ParagraphMetrics const & pm2 = par_metrics_[pit];
1265 rit = pm2.rows().end();
1269 } else if (up && yy != y) {
1271 y = yy + rit->height();
1273 } else if (pit < int(text_->paragraphs().size()) - 1) {
1275 newParMetricsDown();
1276 ParagraphMetrics const & pm2 = par_metrics_[pit];
1277 rit = pm2.rows().begin();
1286 // x,y are absolute screen coordinates
1287 // sets cursor recursively descending into nested editable insets
1288 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1289 bool assert_in_view, bool up)
1291 if (lyxerr.debugging(Debug::WORKAREA)) {
1292 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1293 cur.bv().coordCache().dump();
1295 pit_type pit = getPitNearY(y);
1296 LASSERT(pit != -1, return 0);
1298 int yy = y; // is modified by getPitAndRowNearY
1299 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1303 // Do we cover an inset?
1304 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1307 // No inset, set position in the text
1308 bool bound = false; // is modified by getPosNearX
1309 int xx = x; // is modified by getPosNearX
1310 cur.pos() = getPosNearX(row, xx, bound);
1311 cur.boundary(bound);
1312 cur.setCurrentFont();
1317 Inset * inset = it->inset;
1318 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1320 // Set position in front of inset
1321 cur.pos() = it->pos;
1322 cur.boundary(false);
1325 // Try to descend recursively inside the inset.
1326 inset = inset->editXY(cur, x, yy);
1328 if (cur.top().text() == text_)
1329 cur.setCurrentFont();
1334 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1336 LASSERT(text_ == cur.text(), return);
1337 pit_type const pit = getPitNearY(y);
1338 LASSERT(pit != -1, return);
1340 ParagraphMetrics const & pm = par_metrics_[pit];
1342 int yy = pm.position() - pm.ascent();
1343 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1344 " pit: " << pit << " yy: " << yy);
1347 LBUFERR(pm.rows().size());
1348 for (; r < int(pm.rows().size()) - 1; ++r) {
1349 Row const & row = pm.rows()[r];
1350 if (int(yy + row.height()) > y)
1355 Row const & row = pm.rows()[r];
1357 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1361 pos_type const pos = getPosNearX(row, xx, bound);
1363 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1365 text_->setCursor(cur, pit, pos, true, bound);
1366 // remember new position.
1371 //takes screen x,y coordinates
1372 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1374 Paragraph const & par = text_->paragraphs()[pit];
1375 ParagraphMetrics const & pm = par_metrics_[pit];
1377 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1379 InsetList::const_iterator iit = par.insetList().begin();
1380 InsetList::const_iterator iend = par.insetList().end();
1381 for (; iit != iend; ++iit) {
1382 Inset * inset = iit->inset;
1384 LYXERR(Debug::DEBUG, "examining inset " << inset);
1386 if (!bv_->coordCache().getInsets().has(inset)) {
1387 LYXERR(Debug::DEBUG, "inset has no cached position");
1391 Dimension const & dim = pm.insetDimension(inset);
1392 Point p = bv_->coordCache().getInsets().xy(inset);
1394 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1395 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1397 if (x >= p.x_ && x <= p.x_ + dim.wid
1398 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1399 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1400 return const_cast<InsetList::InsetTable *>(&(*iit));
1404 LYXERR(Debug::DEBUG, "No inset hit. ");
1409 //takes screen x,y coordinates
1410 Inset * TextMetrics::checkInsetHit(int x, int y)
1412 pit_type const pit = getPitNearY(y);
1413 LASSERT(pit != -1, return 0);
1414 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1423 Row::const_iterator const
1424 TextMetrics::findRowElement(Row const & row, pos_type const pos,
1425 bool const boundary, double & x) const
1428 * When boundary is true, position i is in the row element (pos, endpos)
1431 * whereas, when boundary is false, the test is
1433 * The correction below allows to handle both cases.
1435 int const boundary_corr = (boundary && pos) ? -1 : 0;
1437 x = row.left_margin;
1439 /** Early return in trivial cases
1440 * 1) the row is empty
1441 * 2) the position is the left-most position of the row; there
1442 * is a quirk here however: if the first element is virtual
1443 * (end-of-par marker for example), then we have to look
1447 || (pos == row.begin()->left_pos() && !boundary
1448 && !row.begin()->isVirtual()))
1451 Row::const_iterator cit = row.begin();
1452 for ( ; cit != row.end() ; ++cit) {
1453 /** Look whether the cursor is inside the element's
1454 * span. Note that it is necessary to take the
1455 * boundary into account, and to accept virtual
1456 * elements, which have pos == endpos.
1458 if (pos + boundary_corr >= cit->pos
1459 && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
1460 x += cit->pos2x(pos);
1463 x += cit->full_width();
1466 if (cit == row.end())
1473 int TextMetrics::cursorX(CursorSlice const & sl,
1474 bool boundary) const
1476 LASSERT(sl.text() == text_, return 0);
1478 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1479 if (pm.rows().empty())
1481 Row const & row = pm.getRow(sl.pos(), boundary);
1482 pos_type const pos = sl.pos();
1485 findRowElement(row, pos, boundary, x);
1491 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1493 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1494 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1495 if (pm.rows().empty())
1499 h -= par_metrics_[0].rows()[0].ascent();
1500 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1501 h += par_metrics_[pit].height();
1504 if (pos && boundary)
1506 size_t const rend = pm.pos2row(pos);
1507 for (size_t rit = 0; rit != rend; ++rit)
1508 h += pm.rows()[rit].height();
1509 h += pm.rows()[rend].ascent();
1514 // the cursor set functions have a special mechanism. When they
1515 // realize you left an empty paragraph, they will delete it.
1517 bool TextMetrics::cursorHome(Cursor & cur)
1519 LASSERT(text_ == cur.text(), return false);
1520 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1521 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1522 return text_->setCursor(cur, cur.pit(), row.pos());
1526 bool TextMetrics::cursorEnd(Cursor & cur)
1528 LASSERT(text_ == cur.text(), return false);
1529 // if not on the last row of the par, put the cursor before
1530 // the final space exept if I have a spanning inset or one string
1531 // is so long that we force a break.
1532 pos_type end = cur.textRow().endpos();
1534 // empty text, end-1 is no valid position
1536 bool boundary = false;
1537 if (end != cur.lastpos()) {
1538 if (!cur.paragraph().isLineSeparator(end-1)
1539 && !cur.paragraph().isNewline(end-1)
1540 && !cur.paragraph().isEnvSeparator(end-1))
1545 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1549 void TextMetrics::deleteLineForward(Cursor & cur)
1551 LASSERT(text_ == cur.text(), return);
1552 if (cur.lastpos() == 0) {
1553 // Paragraph is empty, so we just go forward
1554 text_->cursorForward(cur);
1557 cur.setSelection(true); // to avoid deletion
1560 // What is this test for ??? (JMarc)
1561 if (!cur.selection())
1562 text_->deleteWordForward(cur);
1564 cap::cutSelection(cur, true, false);
1565 cur.checkBufferStructure();
1570 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1572 ParagraphList const & pars = text_->paragraphs();
1573 return row.endpos() >= pars[pit].size()
1574 && pit + 1 == pit_type(pars.size());
1578 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1580 return row.pos() == 0 && pit == 0;
1584 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1586 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1590 int TextMetrics::leftMargin(int max_width,
1591 pit_type const pit, pos_type const pos) const
1593 ParagraphList const & pars = text_->paragraphs();
1595 LASSERT(pit >= 0, return 0);
1596 LASSERT(pit < int(pars.size()), return 0);
1597 Paragraph const & par = pars[pit];
1598 LASSERT(pos >= 0, return 0);
1599 LASSERT(pos <= par.size(), return 0);
1600 Buffer const & buffer = bv_->buffer();
1601 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1602 DocumentClass const & tclass = buffer.params().documentClass();
1603 Layout const & layout = par.layout();
1605 docstring parindent = layout.parindent;
1609 if (text_->isMainText())
1610 l_margin += bv_->leftMargin();
1612 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1613 tclass.leftmargin());
1615 int depth = par.getDepth();
1617 // find the next level paragraph
1618 pit_type newpar = text_->outerHook(pit);
1619 if (newpar != pit_type(pars.size())) {
1620 if (pars[newpar].layout().isEnvironment()) {
1621 int nestmargin = depth * nestMargin();
1622 if (text_->isMainText())
1623 nestmargin += changebarMargin();
1624 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1625 // Remove the parindent that has been added
1626 // if the paragraph was empty.
1627 if (pars[newpar].empty() &&
1628 buffer.params().paragraph_separation ==
1629 BufferParams::ParagraphIndentSeparation) {
1630 docstring pi = pars[newpar].layout().parindent;
1631 l_margin -= theFontMetrics(
1632 buffer.params().getFont()).signedWidth(pi);
1635 if (tclass.isDefaultLayout(par.layout())
1636 || tclass.isPlainLayout(par.layout())) {
1637 if (pars[newpar].params().noindent())
1640 parindent = pars[newpar].layout().parindent;
1645 // This happens after sections or environments in standard classes.
1646 // We have to check the previous layout at same depth.
1647 if (buffer.params().paragraph_separation ==
1648 BufferParams::ParagraphSkipSeparation)
1650 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1651 pit_type prev = text_->depthHook(pit, par.getDepth());
1652 if (par.layout() == pars[prev].layout()) {
1654 && pars[pit - 1].layout().nextnoindent)
1656 } else if (pars[prev].layout().nextnoindent)
1660 FontInfo const labelfont = text_->labelFont(par);
1661 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1663 switch (layout.margintype) {
1664 case MARGIN_DYNAMIC:
1665 if (!layout.leftmargin.empty()) {
1666 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1669 if (!par.labelString().empty()) {
1670 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1671 l_margin += labelfont_metrics.width(par.labelString());
1672 l_margin += labelfont_metrics.width(layout.labelsep);
1676 case MARGIN_MANUAL: {
1677 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1678 // The width of an empty par, even with manual label, should be 0
1679 if (!par.empty() && pos >= par.beginOfBody()) {
1680 if (!par.getLabelWidthString().empty()) {
1681 docstring labstr = par.getLabelWidthString();
1682 l_margin += labelfont_metrics.width(labstr);
1683 l_margin += labelfont_metrics.width(layout.labelsep);
1689 case MARGIN_STATIC: {
1690 l_margin += theFontMetrics(buffer.params().getFont()).
1691 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1695 case MARGIN_FIRST_DYNAMIC:
1696 if (layout.labeltype == LABEL_MANUAL) {
1697 // if we are at position 0, we are never in the body
1698 if (pos > 0 && pos >= par.beginOfBody())
1699 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1701 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1703 // Special case to fix problems with
1705 || (layout.labeltype == LABEL_STATIC
1706 && layout.latextype == LATEX_ENVIRONMENT
1707 && !text_->isFirstInSequence(pit))) {
1708 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1709 } else if (!layout.labelIsAbove()) {
1710 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1711 l_margin += labelfont_metrics.width(layout.labelsep);
1712 l_margin += labelfont_metrics.width(par.labelString());
1716 case MARGIN_RIGHT_ADDRESS_BOX: {
1718 // The left margin depends on the widest row in this paragraph.
1719 // This code is wrong because it depends on the rows, but at the
1720 // same time this function is used in redoParagraph to construct
1722 ParagraphMetrics const & pm = par_metrics_[pit];
1723 RowList::const_iterator rit = pm.rows().begin();
1724 RowList::const_iterator end = pm.rows().end();
1725 int minfill = max_width;
1726 for ( ; rit != end; ++rit)
1727 if (rit->fill() < minfill)
1728 minfill = rit->fill();
1729 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1730 l_margin += minfill;
1732 // also wrong, but much shorter.
1733 l_margin += max_width / 2;
1738 if (!par.params().leftIndent().zero())
1739 l_margin += par.params().leftIndent().inPixels(max_width, labelfont_metrics.em());
1743 if (par.params().align() == LYX_ALIGN_LAYOUT)
1744 align = layout.align;
1746 align = par.params().align();
1748 // set the correct parindent
1750 && (layout.labeltype == LABEL_NO_LABEL
1751 || layout.labeltype == LABEL_ABOVE
1752 || layout.labeltype == LABEL_CENTERED
1753 || (layout.labeltype == LABEL_STATIC
1754 && layout.latextype == LATEX_ENVIRONMENT
1755 && !text_->isFirstInSequence(pit)))
1756 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1757 && !par.params().noindent()
1758 // in some insets, paragraphs are never indented
1759 && !text_->inset().neverIndent()
1760 // display style insets are always centered, omit indentation
1763 && par.getInset(pos)->display())
1764 && (!(tclass.isDefaultLayout(par.layout())
1765 || tclass.isPlainLayout(par.layout()))
1766 || buffer.params().paragraph_separation
1767 == BufferParams::ParagraphIndentSeparation)) {
1768 // use the parindent of the layout when the
1769 // default indentation is used otherwise use
1770 // the indentation set in the document
1772 if (buffer.params().getIndentation().asLyXCommand() == "default")
1773 l_margin += theFontMetrics(
1774 buffer.params().getFont()).signedWidth(parindent);
1776 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1783 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1785 if (par_metrics_.empty())
1791 ParMetricsCache::iterator it = par_metrics_.begin();
1792 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1793 y -= it->second.ascent();
1794 for (; it != pm_end; ++it) {
1795 ParagraphMetrics const & pmi = it->second;
1797 pit_type const pit = it->first;
1798 // Save the paragraph position in the cache.
1799 it->second.setPosition(y);
1800 drawParagraph(pi, pit, x, y);
1806 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1808 BufferParams const & bparams = bv_->buffer().params();
1809 ParagraphMetrics const & pm = par_metrics_[pit];
1810 if (pm.rows().empty())
1813 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1814 int const ww = bv_->workHeight();
1815 size_t const nrows = pm.rows().size();
1817 Cursor const & cur = bv_->cursor();
1818 DocIterator sel_beg = cur.selectionBegin();
1819 DocIterator sel_end = cur.selectionEnd();
1820 bool selection = cur.selection()
1821 // This is our text.
1822 && cur.text() == text_
1823 // if the anchor is outside, this is not our selection
1824 && cur.normalAnchor().text() == text_
1825 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1827 // We store the begin and end pos of the selection relative to this par
1828 DocIterator sel_beg_par = cur.selectionBegin();
1829 DocIterator sel_end_par = cur.selectionEnd();
1831 // We care only about visible selection.
1833 if (pit != sel_beg.pit()) {
1834 sel_beg_par.pit() = pit;
1835 sel_beg_par.pos() = 0;
1837 if (pit != sel_end.pit()) {
1838 sel_end_par.pit() = pit;
1839 sel_end_par.pos() = sel_end_par.lastpos();
1843 for (size_t i = 0; i != nrows; ++i) {
1845 Row const & row = pm.rows()[i];
1850 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1851 rowSlice.pit() = pit;
1852 rowSlice.pos() = row.pos();
1854 bool const inside = (y + row.descent() >= 0
1855 && y - row.ascent() < ww);
1857 // Adapt to cursor row scroll offset if applicable.
1858 if (bv_->currentRowSlice() == rowSlice)
1859 row_x -= bv_->horizScrollOffset();
1861 // It is not needed to draw on screen if we are not inside.
1862 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1864 RowPainter rp(pi, *text_, pit, row, row_x, y);
1867 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1869 row.setSelection(-1, -1);
1871 // The row knows nothing about the paragraph, so we have to check
1872 // whether this row is the first or last and update the margins.
1873 if (row.selection()) {
1874 if (row.sel_beg == 0)
1875 row.begin_margin_sel = sel_beg.pit() < pit;
1876 if (row.sel_end == sel_end_par.lastpos())
1877 row.end_margin_sel = sel_end.pit() > pit;
1880 // Row signature; has row changed since last paint?
1881 if (pi.pain.isDrawingEnabled())
1882 row.setCrc(pm.computeRowSignature(row, bparams));
1883 bool row_has_changed = row.changed()
1884 || rowSlice == bv_->lastRowSlice();
1886 // Take this opportunity to spellcheck the row contents.
1887 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1888 text_->getPar(pit).spellCheck();
1891 // Don't paint the row if a full repaint has not been requested
1892 // and if it has not changed.
1893 if (!pi.full_repaint && !row_has_changed) {
1894 // Paint only the insets if the text itself is
1896 rp.paintOnlyInsets();
1901 // Clear background of this row if paragraph background was not
1902 // already cleared because of a full repaint.
1903 if (!pi.full_repaint && row_has_changed) {
1904 LYXERR(Debug::PAINTING, "Clear rect@("
1905 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1906 << width() << " x " << row.height());
1907 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1908 width(), row.height(), pi.background_color);
1911 // Instrumentation for testing row cache (see also
1913 if (lyxerr.debugging(Debug::PAINTING) && inside
1914 && (row.selection() || pi.full_repaint || row_has_changed)) {
1915 string const foreword = text_->isMainText() ?
1916 "main text redraw " : "inset text redraw: ";
1917 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1918 << " row_selection=" << row.selection()
1919 << " full_repaint=" << pi.full_repaint
1920 << " row_has_changed=" << row_has_changed
1921 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1924 // Backup full_repaint status and force full repaint
1925 // for inner insets as the Row has been cleared out.
1926 bool tmp = pi.full_repaint;
1927 pi.full_repaint = true;
1929 rp.paintSelection();
1932 rp.paintChangeBar();
1933 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1934 if (i == 0 && !is_rtl)
1936 if (i == nrows - 1 && is_rtl)
1939 if (i == nrows - 1 && !is_rtl)
1941 if (i == 0 && is_rtl)
1943 rp.paintTooLargeMarks(row_x < 0,
1944 row_x + row.width() > bv_->workWidth());
1947 // Restore full_repaint status.
1948 pi.full_repaint = tmp;
1950 // Re-enable screen drawing for future use of the painter.
1951 pi.pain.setDrawingEnabled(original_drawing_state);
1953 //LYXERR(Debug::PAINTING, ".");
1957 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1958 Dimension & dim) const
1960 Cursor const & bvcur = cur.bv().cursor();
1962 // get word in front of cursor
1963 docstring word = text_->previousWord(bvcur.top());
1964 DocIterator wordStart = bvcur;
1965 wordStart.pos() -= word.length();
1967 // get position on screen of the word start and end
1968 //FIXME: Is it necessary to explicitly set this to false?
1969 wordStart.boundary(false);
1970 Point lxy = cur.bv().getPos(wordStart);
1971 Point rxy = cur.bv().getPos(bvcur);
1973 // calculate dimensions of the word
1975 row.pos(wordStart.pos());
1976 row.endpos(bvcur.pos());
1977 setRowHeight(row, bvcur.pit(), false);
1978 dim = row.dimension();
1979 dim.wid = abs(rxy.x_ - lxy.x_);
1981 // calculate position of word
1983 x = min(rxy.x_, lxy.x_);
1985 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1986 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1989 int defaultRowHeight()
1991 return int(theFontMetrics(sane_font).maxHeight() * 1.2);