2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
23 #include "buffer_funcs.h"
24 #include "BufferParams.h"
25 #include "BufferView.h"
26 #include "CoordCache.h"
28 #include "CutAndPaste.h"
30 #include "InsetList.h"
33 #include "MetricsInfo.h"
34 #include "ParagraphParameters.h"
35 #include "RowPainter.h"
37 #include "TextClass.h"
40 #include "insets/InsetText.h"
42 #include "mathed/MathMacroTemplate.h"
44 #include "frontends/FontMetrics.h"
45 #include "frontends/Painter.h"
47 #include "support/debug.h"
48 #include "support/lassert.h"
57 using frontend::FontMetrics;
61 int numberOfSeparators(Row const & row)
64 Row::const_iterator cit = row.begin();
65 Row::const_iterator const end = row.end();
66 for ( ; cit != end ; ++cit)
67 if (cit->type == Row::SEPARATOR)
73 void setSeparatorWidth(Row & row, double w)
76 Row::iterator it = row.begin();
77 Row::iterator const end = row.end();
78 for ( ; it != end ; ++it)
79 if (it->type == Row::SEPARATOR)
84 int numberOfLabelHfills(Paragraph const & par, Row const & row)
86 pos_type last = row.endpos() - 1;
87 pos_type first = row.pos();
89 // hfill *DO* count at the beginning of paragraphs!
91 while (first < last && par.isHfill(first))
95 last = min(last, par.beginOfBody());
97 for (pos_type p = first; p < last; ++p) {
105 int numberOfHfills(Row const & row, pos_type const body_pos)
108 Row::const_iterator cit = row.begin();
109 Row::const_iterator const end = row.end();
110 for ( ; cit != end ; ++cit)
111 if (cit->pos >= body_pos
112 && cit->inset && cit->inset->isHfill())
120 /////////////////////////////////////////////////////////////////////
124 /////////////////////////////////////////////////////////////////////
127 TextMetrics::TextMetrics(BufferView * bv, Text * text)
128 : bv_(bv), text_(text)
131 max_width_ = bv_->workWidth();
132 dim_.wid = max_width_;
138 bool TextMetrics::contains(pit_type pit) const
140 return par_metrics_.find(pit) != par_metrics_.end();
144 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
146 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
151 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
153 ParMetricsCache::const_iterator it = par_metrics_.begin();
154 return make_pair(it->first, &it->second);
158 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
160 LBUFERR(!par_metrics_.empty());
161 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
162 return make_pair(it->first, &it->second);
166 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
168 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
169 if (pmc_it == par_metrics_.end()) {
170 pmc_it = par_metrics_.insert(
171 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
173 if (pmc_it->second.rows().empty() && redo)
175 return pmc_it->second;
179 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
181 LBUFERR(mi.base.textwidth > 0);
182 max_width_ = mi.base.textwidth;
183 // backup old dimension.
184 Dimension const old_dim = dim_;
187 dim_.wid = min_width;
188 pit_type const npar = text_->paragraphs().size();
190 // If there is more than one row, expand the text to
191 // the full allowable width.
192 dim_.wid = max_width_;
194 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
195 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
197 bool changed = false;
199 for (pit_type pit = 0; pit != npar; ++pit) {
200 changed |= redoParagraph(pit);
201 ParagraphMetrics const & pm = par_metrics_[pit];
203 if (dim_.wid < pm.width())
204 dim_.wid = pm.width();
207 dim_.asc = par_metrics_[0].ascent();
208 dim_.des = h - dim_.asc;
209 //lyxerr << "dim_.wid " << dim_.wid << endl;
210 //lyxerr << "dim_.asc " << dim_.asc << endl;
211 //lyxerr << "dim_.des " << dim_.des << endl;
213 changed |= dim_ != old_dim;
219 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
221 return main_text_? pm.rightMargin(*bv_) : 0;
225 int TextMetrics::rightMargin(pit_type const pit) const
227 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
231 void TextMetrics::applyOuterFont(Font & font) const
233 FontInfo lf(font_.fontInfo());
234 lf.reduce(bv_->buffer().params().getFont().fontInfo());
235 font.fontInfo().realize(lf);
239 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
241 LASSERT(pos >= 0, { static Font f; return f; });
243 ParagraphList const & pars = text_->paragraphs();
244 Paragraph const & par = pars[pit];
245 Layout const & layout = par.layout();
246 Buffer const & buffer = bv_->buffer();
248 BufferParams const & params = buffer.params();
249 pos_type const body_pos = par.beginOfBody();
251 // We specialize the 95% common case:
252 if (!par.getDepth()) {
253 Font f = par.getFontSettings(params, pos);
254 if (!text_->isMainText())
256 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
258 FontInfo const & lf = lab ? layout.labelfont : layout.font;
259 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
261 // In case the default family has been customized
262 if (lf.family() == INHERIT_FAMILY)
263 rlf.setFamily(params.getFont().fontInfo().family());
264 f.fontInfo().realize(rlf);
268 // The uncommon case need not be optimized as much
269 FontInfo const & layoutfont = pos < body_pos ?
270 layout.labelfont : layout.font;
272 Font font = par.getFontSettings(params, pos);
273 font.fontInfo().realize(layoutfont);
275 if (!text_->isMainText())
276 applyOuterFont(font);
278 // Realize against environment font information
279 // NOTE: the cast to pit_type should be removed when pit_type
280 // changes to a unsigned integer.
281 if (pit < pit_type(pars.size()))
282 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
284 // Realize with the fonts of lesser depth.
285 font.fontInfo().realize(params.getFont().fontInfo());
291 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
297 if (boundary && sl.pos() > 0)
300 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
304 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
306 // no RTL boundary at paragraph start
310 Font const & left_font = displayFont(pit, pos - 1);
312 return isRTLBoundary(pit, pos, left_font);
316 // isRTLBoundary returns false on a real end-of-line boundary,
317 // because otherwise the two boundary types get mixed up.
318 // This is the whole purpose of this being in TextMetrics.
319 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
320 Font const & font) const
322 if (// no RTL boundary at paragraph start
324 // if the metrics have not been calculated, then we are not
325 // on screen and can safely ignore issues about boundaries.
329 ParagraphMetrics & pm = par_metrics_[pit];
330 // no RTL boundary in empty paragraph
331 if (pm.rows().empty())
334 pos_type endpos = pm.getRow(pos - 1, false).endpos();
335 pos_type startpos = pm.getRow(pos, false).pos();
336 // no RTL boundary at line start:
337 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
339 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
342 Paragraph const & par = text_->getPar(pit);
343 // no RTL boundary at line break:
344 // abc|\n -> move right -> abc\n (and not: abc\n|
346 if (startpos == pos && endpos == pos && endpos != par.size()
347 && (par.isNewline(pos - 1)
348 || par.isEnvSeparator(pos - 1)
349 || par.isLineSeparator(pos - 1)
350 || par.isSeparator(pos - 1)))
353 bool left = font.isVisibleRightToLeft();
355 if (pos == par.size())
356 right = par.isRTL(bv_->buffer().params());
358 right = displayFont(pit, pos).isVisibleRightToLeft();
360 return left != right;
364 bool TextMetrics::redoParagraph(pit_type const pit)
366 Paragraph & par = text_->getPar(pit);
367 // IMPORTANT NOTE: We pass 'false' explicitly in order to not call
368 // redoParagraph() recursively inside parMetrics.
369 Dimension old_dim = parMetrics(pit, false).dim();
370 ParagraphMetrics & pm = par_metrics_[pit];
373 Buffer & buffer = bv_->buffer();
374 main_text_ = (text_ == &buffer.text());
375 bool changed = false;
377 // Check whether there are InsetBibItems that need fixing
378 // FIXME: This check ought to be done somewhere else. It is the reason
379 // why text_ is not const. But then, where else to do it?
380 // Well, how can you end up with either (a) a biblio environment that
381 // has no InsetBibitem or (b) a biblio environment with more than one
382 // InsetBibitem? I think the answer is: when paragraphs are merged;
383 // when layout is set; when material is pasted.
384 if (par.brokenBiblio()) {
385 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
386 // In some cases, we do not know how to record undo
387 if (&cur.inset() == &text_->inset())
388 cur.recordUndo(pit, pit);
390 int const moveCursor = par.fixBiblio(buffer);
392 // Is it necessary to update the cursor?
393 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
396 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
401 // Optimisation: this is used in the next two loops
402 // so better to calculate that once here.
403 int const right_margin = rightMargin(pm);
405 // iterator pointing to paragraph to resolve macros
406 DocIterator parPos = text_->macrocontextPosition();
410 LYXERR(Debug::INFO, "MacroContext not initialised!"
411 << " Going through the buffer again and hope"
412 << " the context is better then.");
413 // FIXME audit updateBuffer calls
414 // This should not be here, but it is not clear yet where else it
416 bv_->buffer().updateBuffer();
417 parPos = text_->macrocontextPosition();
418 LBUFERR(!parPos.empty());
423 Font const bufferfont = buffer.params().getFont();
424 InsetList::const_iterator ii = par.insetList().begin();
425 InsetList::const_iterator iend = par.insetList().end();
426 for (; ii != iend; ++ii) {
427 // FIXME Doesn't this HAVE to be non-empty?
428 // position already initialized?
429 if (!parPos.empty()) {
430 parPos.pos() = ii->pos;
432 // A macro template would normally not be visible
433 // by itself. But the tex macro semantics allow
434 // recursion, so we artifically take the context
435 // after the macro template to simulate this.
436 if (ii->inset->lyxCode() == MATHMACRO_CODE)
440 // do the metric calculation
442 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
444 Font const & font = ii->inset->inheritFont() ?
445 displayFont(pit, ii->pos) : bufferfont;
446 MacroContext mc(&buffer, parPos);
447 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
448 ii->inset->metrics(mi, dim);
449 Dimension const & old_dim = pm.insetDimension(ii->inset);
450 if (old_dim != dim) {
451 pm.setInsetDimension(ii->inset, dim);
456 par.setBeginOfBody();
458 size_t row_index = 0;
459 // maximum pixel width of a row
461 if (row_index == pm.rows().size())
462 pm.rows().push_back(Row());
463 Row & row = pm.rows()[row_index];
465 breakRow(row, right_margin, pit);
466 setRowHeight(row, pit);
467 row.setChanged(false);
468 if (row_index || row.endpos() < par.size())
469 // If there is more than one row, expand the text to
470 // the full allowable width. This setting here is needed
471 // for the computeRowMetrics() below.
472 dim_.wid = max_width_;
473 int const max_row_width = max(dim_.wid, row.width());
474 computeRowMetrics(pit, row, max_row_width);
475 first = row.endpos();
478 pm.dim().wid = max(pm.dim().wid, row.width());
479 pm.dim().des += row.height();
480 } while (first < par.size());
482 if (row_index < pm.rows().size())
483 pm.rows().resize(row_index);
485 // Make sure that if a par ends in newline, there is one more row
487 if (first > 0 && par.isNewline(first - 1)) {
488 if (row_index == pm.rows().size())
489 pm.rows().push_back(Row());
490 Row & row = pm.rows()[row_index];
493 setRowHeight(row, pit);
494 row.setChanged(false);
495 int const max_row_width = max(dim_.wid, row.width());
496 computeRowMetrics(pit, row, max_row_width);
497 pm.dim().des += row.height();
500 pm.dim().asc += pm.rows()[0].ascent();
501 pm.dim().des -= pm.rows()[0].ascent();
503 changed |= old_dim.height() != pm.dim().height();
509 LyXAlignment TextMetrics::getAlign(Paragraph const & par, pos_type const pos) const
511 Layout const & layout = par.layout();
514 if (par.params().align() == LYX_ALIGN_LAYOUT)
515 align = layout.align;
517 align = par.params().align();
519 // handle alignment inside tabular cells
520 Inset const & owner = text_->inset();
521 switch (owner.contentAlignment()) {
522 case LYX_ALIGN_CENTER:
524 case LYX_ALIGN_RIGHT:
525 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
526 align = owner.contentAlignment();
529 // unchanged (use align)
533 // Display-style insets should always be on a centered row
534 if (Inset const * inset = par.getInset(pos)) {
535 switch (inset->display()) {
536 case Inset::AlignLeft:
537 align = LYX_ALIGN_BLOCK;
539 case Inset::AlignCenter:
540 align = LYX_ALIGN_CENTER;
543 // unchanged (use align)
545 case Inset::AlignRight:
546 align = LYX_ALIGN_RIGHT;
551 // Has the user requested we not justify stuff?
552 if (!bv_->buffer().params().justification
553 && align == LYX_ALIGN_BLOCK)
554 align = LYX_ALIGN_LEFT;
560 void TextMetrics::computeRowMetrics(pit_type const pit,
561 Row & row, int width) const
566 Paragraph const & par = text_->getPar(pit);
568 int const w = width - row.right_margin - row.width();
569 // FIXME: put back this assertion when the crash on new doc is solved.
570 //LASSERT(w >= 0, /**/);
572 bool const is_rtl = text_->isRTL(par);
574 row.left_margin = rightMargin(pit);
576 row.left_margin = leftMargin(max_width_, pit, row.pos());
578 // is there a manual margin with a manual label
579 Layout const & layout = par.layout();
582 if (layout.margintype == MARGIN_MANUAL
583 && layout.labeltype == LABEL_MANUAL) {
584 /// We might have real hfills in the label part
585 nlh = numberOfLabelHfills(par, row);
587 // A manual label par (e.g. List) has an auto-hfill
588 // between the label text and the body of the
590 // But we don't want to do this auto hfill if the par
595 if (nlh && !par.getLabelWidthString().empty())
596 row.label_hfill = labelFill(pit, row) / double(nlh);
600 // are there any hfills in the row?
601 if (int const nh = numberOfHfills(row, par.beginOfBody())) {
603 hfill = double(w) / nh;
604 // we don't have to look at the alignment if it is ALIGN_LEFT and
605 // if the row is already larger then the permitted width as then
606 // we force the LEFT_ALIGN'edness!
607 } else if (int(row.width()) < max_width_) {
608 // is it block, flushleft or flushright?
609 // set x how you need it
610 switch (getAlign(par, row.pos())) {
611 case LYX_ALIGN_BLOCK: {
612 int const ns = numberOfSeparators(row);
613 /** If we have separators, and this row has
614 * not be broken abruptly by a display inset
615 * or newline, then stretch it */
616 if (ns && !row.right_boundary()
617 && row.endpos() != par.size()) {
618 setSeparatorWidth(row, double(w) / ns);
619 row.dimension().wid = width;
621 row.dimension().wid = width;
622 row.left_margin += w;
626 case LYX_ALIGN_RIGHT:
627 row.left_margin += w;
629 case LYX_ALIGN_CENTER:
630 row.dimension().wid = width - w / 2;
631 row.left_margin += w / 2;
635 case LYX_ALIGN_LAYOUT:
636 case LYX_ALIGN_SPECIAL:
637 case LYX_ALIGN_DECIMAL:
642 // Finally, handle hfill insets
643 pos_type const endpos = row.endpos();
644 pos_type body_pos = par.beginOfBody();
646 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
648 ParagraphMetrics & pm = par_metrics_[pit];
649 Row::iterator cit = row.begin();
650 Row::iterator const cend = row.end();
651 for ( ; cit != cend; ++cit) {
652 if (row.label_hfill && cit->endpos == body_pos
653 && cit->type == Row::SPACE)
654 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
655 if (!cit->inset || !cit->inset->isHfill())
657 if (pm.hfillExpansion(row, cit->pos))
658 cit->dim.wid = int(cit->pos >= body_pos ?
659 max(hfill, 5.0) : row.label_hfill);
662 // Cache the inset dimension.
663 bv_->coordCache().insets().add(cit->inset, cit->dim);
664 pm.setInsetDimension(cit->inset, cit->dim);
669 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
671 Paragraph const & par = text_->getPar(pit);
672 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
675 Row::const_iterator cit = row.begin();
676 Row::const_iterator const end = row.end();
677 // iterate over elements before main body (except the last one,
678 // which is extra space).
679 while (cit!= end && cit->endpos < par.beginOfBody()) {
684 docstring const & label = par.params().labelWidthString();
688 FontMetrics const & fm
689 = theFontMetrics(text_->labelFont(par));
691 return max(0, fm.width(label) - w);
696 // Not used, see TextMetrics::breakRow
697 // this needs special handling - only newlines count as a break point
698 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
700 pos_type const end = par.size();
703 if (par.isNewline(i))
711 int TextMetrics::labelEnd(pit_type const pit) const
713 // labelEnd is only needed if the layout fills a flushleft label.
714 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
716 // return the beginning of the body
717 return leftMargin(max_width_, pit);
723 * Calling Text::getFont is slow. While rebreaking we scan a
724 * paragraph from left to right calling getFont for every char. This
725 * simple class address this problem by hidding an optimization trick
726 * (not mine btw -AB): the font is reused in the whole font span. The
727 * class handles transparently the "hidden" (not part of the fontlist)
728 * label font (as getFont does).
734 FontIterator(TextMetrics const & tm,
735 Paragraph const & par, pit_type pit, pos_type pos)
736 : tm_(tm), par_(par), pit_(pit), pos_(pos),
737 font_(tm.displayFont(pit, pos)),
738 endspan_(par.fontSpan(pos).last),
739 bodypos_(par.beginOfBody())
743 Font const & operator*() const { return font_; }
746 FontIterator & operator++()
749 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
750 font_ = tm_.displayFont(pit_, pos_);
751 endspan_ = par_.fontSpan(pos_).last;
757 Font * operator->() { return &font_; }
761 TextMetrics const & tm_;
763 Paragraph const & par_;
778 /** This is the function where the hard work is done. The code here is
779 * very sensitive to small changes :) Note that part of the
780 * intelligence is also in Row::shortenIfNeeded.
782 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
784 Paragraph const & par = text_->getPar(pit);
785 pos_type const end = par.size();
786 pos_type const pos = row.pos();
787 int const width = max_width_ - right_margin;
788 pos_type const body_pos = par.beginOfBody();
790 // This make get changed in computeRowMetrics depending on RTL
791 row.left_margin = leftMargin(max_width_, pit, pos);
792 row.dimension().wid = row.left_margin;
793 row.right_margin = right_margin;
795 if (pos >= end || row.width() > width) {
800 ParagraphMetrics const & pm = par_metrics_[pit];
801 ParagraphList const & pars = text_->paragraphs();
804 //FIXME: As long as leftMargin() is not correctly implemented for
805 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
806 // Otherwise, long rows will be painted off the screen.
807 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
808 return addressBreakPoint(pos, par);
811 // check for possible inline completion
812 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
813 pos_type inlineCompletionLPos = -1;
814 if (inlineCompletionPos.inTexted()
815 && inlineCompletionPos.text() == text_
816 && inlineCompletionPos.pit() == pit) {
817 // draw logically behind the previous character
818 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
821 // Now we iterate through until we reach the right margin
822 // or the end of the par, then build a representation of the row.
824 FontIterator fi = FontIterator(*this, par, pit, pos);
825 while (i < end && row.width() < width) {
826 char_type c = par.getChar(i);
827 // The most special cases are handled first.
828 if (par.isInset(i)) {
829 Inset const * ins = par.getInset(i);
830 Dimension dim = pm.insetDimension(ins);
831 row.add(i, ins, dim, *fi, par.lookupChange(i));
832 } else if (c == ' ' && i + 1 == body_pos) {
833 // There is a space at i, but it should not be
834 // added as a separator, because it is just
835 // before body_pos. Instead, insert some spacing to
837 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
838 // this is needed to make sure that the row width is correct
840 int const add = max(fm.width(par.layout().labelsep),
841 labelEnd(pit) - row.width());
842 row.addSpace(i, add, *fi, par.lookupChange(i));
843 } else if (par.isLineSeparator(i)) {
844 // In theory, no inset has this property. If
845 // this is done, a new addSeparator which
846 // takes an inset as parameter should be
848 LATTEST(!par.isInset(i));
849 row.addSeparator(i, c, *fi, par.lookupChange(i));
850 } else if (c == '\t')
851 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
852 *fi, par.lookupChange(i));
854 row.add(i, c, *fi, par.lookupChange(i));
856 // add inline completion width
857 if (inlineCompletionLPos == i &&
858 !bv_->inlineCompletion().empty()) {
860 f.fontInfo().setColor(Color_inlinecompletion);
861 row.addVirtual(i + 1, bv_->inlineCompletion(),
865 // Handle some situations that abruptly terminate the row
867 // - Before a display inset
868 // - After a display inset
869 Inset const * inset = 0;
870 if (par.isNewline(i) || par.isEnvSeparator(i)
871 || (i + 1 < end && (inset = par.getInset(i + 1))
873 || (!row.empty() && row.back().inset
874 && row.back().inset->display())) {
875 row.right_boundary(true);
886 // End of paragraph marker
887 if (lyxrc.paragraph_markers
888 && i == end && size_type(pit + 1) < pars.size()) {
889 // add a virtual element for the end-of-paragraph
890 // marker; it is shown on screen, but does not exist
892 Font f(text_->layoutFont(pit));
893 f.fontInfo().setColor(Color_paragraphmarker);
894 BufferParams const & bparams
895 = text_->inset().buffer().params();
896 f.setLanguage(par.getParLanguage(bparams));
897 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
900 // if the row is too large, try to cut at last separator.
901 row.shortenIfNeeded(body_pos, width);
903 // make sure that the RTL elements are in reverse ordering
904 row.reverseRTL(text_->isRTL(par));
908 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
909 bool topBottomSpace) const
911 Paragraph const & par = text_->getPar(pit);
912 // get the maximum ascent and the maximum descent
913 double layoutasc = 0;
914 double layoutdesc = 0;
915 double const dh = defaultRowHeight();
917 // ok, let us initialize the maxasc and maxdesc value.
918 // Only the fontsize count. The other properties
919 // are taken from the layoutfont. Nicer on the screen :)
920 Layout const & layout = par.layout();
922 // as max get the first character of this row then it can
923 // increase but not decrease the height. Just some point to
924 // start with so we don't have to do the assignment below too
926 Buffer const & buffer = bv_->buffer();
927 Font font = displayFont(pit, row.pos());
928 FontSize const tmpsize = font.fontInfo().size();
929 font.fontInfo() = text_->layoutFont(pit);
930 FontSize const size = font.fontInfo().size();
931 font.fontInfo().setSize(tmpsize);
933 FontInfo labelfont = text_->labelFont(par);
935 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
936 FontMetrics const & fontmetrics = theFontMetrics(font);
938 // these are minimum values
939 double const spacing_val = layout.spacing.getValue()
940 * text_->spacing(par);
941 //lyxerr << "spacing_val = " << spacing_val << endl;
942 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
943 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
945 // insets may be taller
946 ParagraphMetrics const & pm = par_metrics_[pit];
947 Row::const_iterator cit = row.begin();
948 Row::const_iterator cend = row.end();
949 for ( ; cit != cend; ++cit) {
951 Dimension const & dim = pm.insetDimension(cit->inset);
952 maxasc = max(maxasc, dim.ascent());
953 maxdesc = max(maxdesc, dim.descent());
957 // Check if any custom fonts are larger (Asger)
958 // This is not completely correct, but we can live with the small,
959 // cosmetic error for now.
963 par.highestFontInRange(row.pos(), row.endpos(), size);
964 if (maxsize > font.fontInfo().size()) {
965 // use standard paragraph font with the maximal size
966 FontInfo maxfont = font.fontInfo();
967 maxfont.setSize(maxsize);
968 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
969 maxasc = max(maxasc, maxfontmetrics.maxAscent());
970 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
973 // This is nicer with box insets:
977 ParagraphList const & pars = text_->paragraphs();
978 Inset const & inset = text_->inset();
981 if (row.pos() == 0 && topBottomSpace) {
982 BufferParams const & bufparams = buffer.params();
983 // some parskips VERY EASY IMPLEMENTATION
984 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
985 && !inset.getLayout().parbreakIsNewline()
986 && !par.layout().parbreak_is_newline
988 && ((layout.isParagraph() && par.getDepth() == 0)
989 || (pars[pit - 1].layout().isParagraph()
990 && pars[pit - 1].getDepth() == 0))) {
991 maxasc += bufparams.getDefSkip().inPixels(*bv_);
994 if (par.params().startOfAppendix())
995 maxasc += int(3 * dh);
997 // special code for the top label
998 if (layout.labelIsAbove()
999 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1000 && !par.labelString().empty()) {
1002 labelfont_metrics.maxHeight()
1003 * layout.spacing.getValue()
1004 * text_->spacing(par)
1005 + (layout.topsep + layout.labelbottomsep) * dh);
1008 // Add the layout spaces, for example before and after
1009 // a section, or between the items of a itemize or enumerate
1012 pit_type prev = text_->depthHook(pit, par.getDepth());
1013 Paragraph const & prevpar = pars[prev];
1015 && prevpar.layout() == layout
1016 && prevpar.getDepth() == par.getDepth()
1017 && prevpar.getLabelWidthString()
1018 == par.getLabelWidthString()) {
1019 layoutasc = layout.itemsep * dh;
1020 } else if (pit != 0 || row.pos() != 0) {
1021 if (layout.topsep > 0)
1022 layoutasc = layout.topsep * dh;
1025 prev = text_->outerHook(pit);
1026 if (prev != pit_type(pars.size())) {
1027 maxasc += int(pars[prev].layout().parsep * dh);
1028 } else if (pit != 0) {
1029 Paragraph const & prevpar = pars[pit - 1];
1030 if (prevpar.getDepth() != 0 ||
1031 prevpar.layout() == layout) {
1032 maxasc += int(layout.parsep * dh);
1037 // is it a bottom line?
1038 if (row.endpos() >= par.size() && topBottomSpace) {
1039 // add the layout spaces, for example before and after
1040 // a section, or between the items of a itemize or enumerate
1042 pit_type nextpit = pit + 1;
1043 if (nextpit != pit_type(pars.size())) {
1044 pit_type cpit = pit;
1046 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1047 double usual = pars[cpit].layout().bottomsep * dh;
1049 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1050 if (pars[cpit].layout() != pars[nextpit].layout()
1051 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1052 unusual = pars[cpit].layout().bottomsep * dh;
1053 layoutdesc = max(unusual, usual);
1054 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1055 if (pars[cpit].layout() != pars[nextpit].layout()
1056 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1057 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1062 // incalculate the layout spaces
1063 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1064 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1066 // FIXME: the correct way is to do the following is to move the
1067 // following code in another method specially tailored for the
1068 // main Text. The following test is thus bogus.
1069 // Top and bottom margin of the document (only at top-level)
1070 if (main_text_ && topBottomSpace) {
1071 if (pit == 0 && row.pos() == 0)
1073 if (pit + 1 == pit_type(pars.size()) &&
1074 row.endpos() == par.size() &&
1075 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1079 row.dimension().asc = maxasc + labeladdon;
1080 row.dimension().des = maxdesc;
1084 // x is an absolute screen coord
1085 // returns the column near the specified x-coordinate of the row
1086 // x is set to the real beginning of this column
1087 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1088 bool & boundary) const
1090 /// For the main Text, it is possible that this pit is not
1091 /// yet in the CoordCache when moving cursor up.
1092 /// x Paragraph coordinate is always 0 for main text anyway.
1093 int const xo = origin_.x_;
1096 pos_type pos = row.pos();
1099 x = row.left_margin;
1100 else if (x <= row.left_margin) {
1101 pos = row.front().left_pos();
1102 x = row.left_margin;
1103 } else if (x >= row.width()) {
1104 pos = row.back().right_pos();
1107 double w = row.left_margin;
1108 Row::const_iterator cit = row.begin();
1109 Row::const_iterator cend = row.end();
1110 for ( ; cit != cend; ++cit) {
1111 if (w <= x && w + cit->full_width() > x) {
1112 int x_offset = int(x - w);
1113 pos = cit->x2pos(x_offset);
1114 x = int(x_offset + w);
1117 w += cit->full_width();
1119 if (cit == row.end()) {
1120 pos = row.back().right_pos();
1123 /** This tests for the case where the cursor is placed
1124 * just before a font direction change. See comment on
1125 * the boundary_ member in DocIterator.h to understand
1126 * how boundary helps here.
1128 else if (pos == cit->endpos
1129 && cit + 1 != row.end()
1130 && cit->font.isVisibleRightToLeft() != (cit + 1)->font.isVisibleRightToLeft())
1134 /** This tests for the case where the cursor is set at the end
1135 * of a row which has been broken due something else than a
1136 * separator (a display inset or a forced breaking of the
1137 * row). We know that there is a separator when the end of the
1138 * row is larger than the end of its last element.
1140 if (!row.empty() && pos == row.back().endpos
1141 && row.back().endpos == row.endpos())
1149 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1151 // We play safe and use parMetrics(pit) to make sure the
1152 // ParagraphMetrics will be redone and OK to use if needed.
1153 // Otherwise we would use an empty ParagraphMetrics in
1154 // upDownInText() while in selection mode.
1155 ParagraphMetrics const & pm = parMetrics(pit);
1157 LBUFERR(row < int(pm.rows().size()));
1159 Row const & r = pm.rows()[row];
1160 return getPosNearX(r, x, bound);
1164 void TextMetrics::newParMetricsDown()
1166 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1167 pit_type const pit = last.first + 1;
1168 if (pit == int(text_->paragraphs().size()))
1171 // do it and update its position.
1173 par_metrics_[pit].setPosition(last.second.position()
1174 + last.second.descent() + par_metrics_[pit].ascent());
1178 void TextMetrics::newParMetricsUp()
1180 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1181 if (first.first == 0)
1184 pit_type const pit = first.first - 1;
1185 // do it and update its position.
1187 par_metrics_[pit].setPosition(first.second.position()
1188 - first.second.ascent() - par_metrics_[pit].descent());
1191 // y is screen coordinate
1192 pit_type TextMetrics::getPitNearY(int y)
1194 LASSERT(!text_->paragraphs().empty(), return -1);
1195 LASSERT(!par_metrics_.empty(), return -1);
1196 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1198 // look for highest numbered paragraph with y coordinate less than given y
1201 ParMetricsCache::const_iterator it = par_metrics_.begin();
1202 ParMetricsCache::const_iterator et = par_metrics_.end();
1203 ParMetricsCache::const_iterator last = et;
1206 ParagraphMetrics const & pm = it->second;
1208 if (y < it->second.position() - int(pm.ascent())) {
1209 // We are looking for a position that is before the first paragraph in
1210 // the cache (which is in priciple off-screen, that is before the
1213 // We are already at the first paragraph in the inset.
1215 // OK, this is the paragraph we are looking for.
1216 pit = it->first - 1;
1221 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1223 if (y >= last->second.position() + int(pm_last.descent())) {
1224 // We are looking for a position that is after the last paragraph in
1225 // the cache (which is in priciple off-screen), that is before the
1227 pit = last->first + 1;
1228 if (pit == int(text_->paragraphs().size()))
1229 // We are already at the last paragraph in the inset.
1231 // OK, this is the paragraph we are looking for.
1232 newParMetricsDown();
1236 for (; it != et; ++it) {
1237 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1238 << " y: " << it->second.position());
1240 ParagraphMetrics const & pm = par_metrics_[it->first];
1242 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1244 yy = it->second.position();
1248 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1254 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1255 bool assert_in_view, bool up)
1257 ParagraphMetrics const & pm = par_metrics_[pit];
1259 int yy = pm.position() - pm.ascent();
1260 LBUFERR(!pm.rows().empty());
1261 RowList::const_iterator rit = pm.rows().begin();
1262 RowList::const_iterator rlast = pm.rows().end();
1264 for (; rit != rlast; yy += rit->height(), ++rit)
1265 if (yy + rit->height() > y)
1268 if (assert_in_view) {
1269 if (!up && yy + rit->height() > y) {
1270 if (rit != pm.rows().begin()) {
1273 } else if (pit != 0) {
1276 ParagraphMetrics const & pm2 = par_metrics_[pit];
1277 rit = pm2.rows().end();
1281 } else if (up && yy != y) {
1283 y = yy + rit->height();
1285 } else if (pit < int(text_->paragraphs().size()) - 1) {
1287 newParMetricsDown();
1288 ParagraphMetrics const & pm2 = par_metrics_[pit];
1289 rit = pm2.rows().begin();
1298 // x,y are absolute screen coordinates
1299 // sets cursor recursively descending into nested editable insets
1300 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1301 bool assert_in_view, bool up)
1303 if (lyxerr.debugging(Debug::WORKAREA)) {
1304 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1305 cur.bv().coordCache().dump();
1307 pit_type pit = getPitNearY(y);
1308 LASSERT(pit != -1, return 0);
1310 int yy = y; // is modified by getPitAndRowNearY
1311 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1315 // Do we cover an inset?
1316 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1319 // No inset, set position in the text
1320 bool bound = false; // is modified by getPosNearX
1321 int xx = x; // is modified by getPosNearX
1322 cur.pos() = getPosNearX(row, xx, bound);
1323 cur.boundary(bound);
1324 cur.setCurrentFont();
1329 Inset * inset = it->inset;
1330 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1332 // Set position in front of inset
1333 cur.pos() = it->pos;
1334 cur.boundary(false);
1337 // Try to descend recursively inside the inset.
1338 inset = inset->editXY(cur, x, yy);
1340 if (cur.top().text() == text_)
1341 cur.setCurrentFont();
1346 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1348 LASSERT(text_ == cur.text(), return);
1349 pit_type const pit = getPitNearY(y);
1350 LASSERT(pit != -1, return);
1352 ParagraphMetrics const & pm = par_metrics_[pit];
1354 int yy = pm.position() - pm.ascent();
1355 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1356 " pit: " << pit << " yy: " << yy);
1359 LBUFERR(pm.rows().size());
1360 for (; r < int(pm.rows().size()) - 1; ++r) {
1361 Row const & row = pm.rows()[r];
1362 if (int(yy + row.height()) > y)
1367 Row const & row = pm.rows()[r];
1369 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1373 pos_type const pos = getPosNearX(row, xx, bound);
1375 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1377 text_->setCursor(cur, pit, pos, true, bound);
1378 // remember new position.
1383 //takes screen x,y coordinates
1384 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1386 Paragraph const & par = text_->paragraphs()[pit];
1387 ParagraphMetrics const & pm = par_metrics_[pit];
1389 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1391 InsetList::const_iterator iit = par.insetList().begin();
1392 InsetList::const_iterator iend = par.insetList().end();
1393 for (; iit != iend; ++iit) {
1394 Inset * inset = iit->inset;
1396 LYXERR(Debug::DEBUG, "examining inset " << inset);
1398 if (!bv_->coordCache().getInsets().has(inset)) {
1399 LYXERR(Debug::DEBUG, "inset has no cached position");
1403 Dimension const & dim = pm.insetDimension(inset);
1404 Point p = bv_->coordCache().getInsets().xy(inset);
1406 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1407 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1409 if (x >= p.x_ && x <= p.x_ + dim.wid
1410 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1411 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1412 return const_cast<InsetList::InsetTable *>(&(*iit));
1416 LYXERR(Debug::DEBUG, "No inset hit. ");
1421 //takes screen x,y coordinates
1422 Inset * TextMetrics::checkInsetHit(int x, int y)
1424 pit_type const pit = getPitNearY(y);
1425 LASSERT(pit != -1, return 0);
1426 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1435 int TextMetrics::cursorX(CursorSlice const & sl,
1436 bool boundary) const
1438 LASSERT(sl.text() == text_, return 0);
1440 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1441 if (pm.rows().empty())
1443 Row const & row = pm.getRow(sl.pos(), boundary);
1444 pos_type const pos = sl.pos();
1447 * When boundary is true, position i is in the row element (pos, endpos)
1450 * whereas, when boundary is false, the test is
1452 * The correction below allows to handle both cases.
1454 int const boundary_corr = (boundary && pos) ? -1 : 0;
1456 /** Early return in trivial cases
1457 * 1) the row is empty
1458 * 2) the position is the left-most position of the row; there
1459 * is a quirck herehowever: if the first element is virtual
1460 * (end-of-par marker for example), then we have to look
1464 || (pos == row.begin()->left_pos()
1465 && pos != row.begin()->right_pos()))
1466 return row.left_margin;
1468 Row::const_iterator cit = row.begin();
1469 double x = row.left_margin;
1470 for ( ; cit != row.end() ; ++cit) {
1471 /** Look whether the cursor is inside the element's
1472 * span. Note that it is necessary to take the
1473 * boundary in account, and to accept virtual
1474 * elements, which have pos == endpos.
1476 if (pos + boundary_corr >= cit->pos
1477 && (pos + boundary_corr < cit->endpos
1478 || cit->pos == cit->endpos)) {
1479 x += cit->pos2x(pos);
1482 x += cit->full_width();
1489 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1491 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1492 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1493 if (pm.rows().empty())
1497 h -= par_metrics_[0].rows()[0].ascent();
1498 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1499 h += par_metrics_[pit].height();
1502 if (pos && boundary)
1504 size_t const rend = pm.pos2row(pos);
1505 for (size_t rit = 0; rit != rend; ++rit)
1506 h += pm.rows()[rit].height();
1507 h += pm.rows()[rend].ascent();
1512 // the cursor set functions have a special mechanism. When they
1513 // realize you left an empty paragraph, they will delete it.
1515 bool TextMetrics::cursorHome(Cursor & cur)
1517 LASSERT(text_ == cur.text(), return false);
1518 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1519 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1520 return text_->setCursor(cur, cur.pit(), row.pos());
1524 bool TextMetrics::cursorEnd(Cursor & cur)
1526 LASSERT(text_ == cur.text(), return false);
1527 // if not on the last row of the par, put the cursor before
1528 // the final space exept if I have a spanning inset or one string
1529 // is so long that we force a break.
1530 pos_type end = cur.textRow().endpos();
1532 // empty text, end-1 is no valid position
1534 bool boundary = false;
1535 if (end != cur.lastpos()) {
1536 if (!cur.paragraph().isLineSeparator(end-1)
1537 && !cur.paragraph().isNewline(end-1)
1538 && !cur.paragraph().isEnvSeparator(end-1))
1543 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1547 void TextMetrics::deleteLineForward(Cursor & cur)
1549 LASSERT(text_ == cur.text(), return);
1550 if (cur.lastpos() == 0) {
1551 // Paragraph is empty, so we just go forward
1552 text_->cursorForward(cur);
1555 cur.setSelection(true); // to avoid deletion
1558 // What is this test for ??? (JMarc)
1559 if (!cur.selection())
1560 text_->deleteWordForward(cur);
1562 cap::cutSelection(cur, true, false);
1563 cur.checkBufferStructure();
1568 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1570 ParagraphList const & pars = text_->paragraphs();
1571 return row.endpos() >= pars[pit].size()
1572 && pit + 1 == pit_type(pars.size());
1576 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1578 return row.pos() == 0 && pit == 0;
1582 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1584 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1588 int TextMetrics::leftMargin(int max_width,
1589 pit_type const pit, pos_type const pos) const
1591 ParagraphList const & pars = text_->paragraphs();
1593 LASSERT(pit >= 0, return 0);
1594 LASSERT(pit < int(pars.size()), return 0);
1595 Paragraph const & par = pars[pit];
1596 LASSERT(pos >= 0, return 0);
1597 LASSERT(pos <= par.size(), return 0);
1598 Buffer const & buffer = bv_->buffer();
1599 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1600 DocumentClass const & tclass = buffer.params().documentClass();
1601 Layout const & layout = par.layout();
1603 docstring parindent = layout.parindent;
1607 if (text_->isMainText())
1608 l_margin += bv_->leftMargin();
1610 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1611 tclass.leftmargin());
1613 int depth = par.getDepth();
1615 // find the next level paragraph
1616 pit_type newpar = text_->outerHook(pit);
1617 if (newpar != pit_type(pars.size())) {
1618 if (pars[newpar].layout().isEnvironment()) {
1619 int nestmargin = depth * nestMargin();
1620 if (text_->isMainText())
1621 nestmargin += changebarMargin();
1622 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1623 // Remove the parindent that has been added
1624 // if the paragraph was empty.
1625 if (pars[newpar].empty() &&
1626 buffer.params().paragraph_separation ==
1627 BufferParams::ParagraphIndentSeparation) {
1628 docstring pi = pars[newpar].layout().parindent;
1629 l_margin -= theFontMetrics(
1630 buffer.params().getFont()).signedWidth(pi);
1633 if (tclass.isDefaultLayout(par.layout())
1634 || tclass.isPlainLayout(par.layout())) {
1635 if (pars[newpar].params().noindent())
1638 parindent = pars[newpar].layout().parindent;
1643 // This happens after sections or environments in standard classes.
1644 // We have to check the previous layout at same depth.
1645 if (buffer.params().paragraph_separation ==
1646 BufferParams::ParagraphSkipSeparation)
1648 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1649 pit_type prev = text_->depthHook(pit, par.getDepth());
1650 if (par.layout() == pars[prev].layout()) {
1652 && pars[pit - 1].layout().nextnoindent)
1654 } else if (pars[prev].layout().nextnoindent)
1658 FontInfo const labelfont = text_->labelFont(par);
1659 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1661 switch (layout.margintype) {
1662 case MARGIN_DYNAMIC:
1663 if (!layout.leftmargin.empty()) {
1664 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1667 if (!par.labelString().empty()) {
1668 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1669 l_margin += labelfont_metrics.width(par.labelString());
1670 l_margin += labelfont_metrics.width(layout.labelsep);
1674 case MARGIN_MANUAL: {
1675 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1676 // The width of an empty par, even with manual label, should be 0
1677 if (!par.empty() && pos >= par.beginOfBody()) {
1678 if (!par.getLabelWidthString().empty()) {
1679 docstring labstr = par.getLabelWidthString();
1680 l_margin += labelfont_metrics.width(labstr);
1681 l_margin += labelfont_metrics.width(layout.labelsep);
1687 case MARGIN_STATIC: {
1688 l_margin += theFontMetrics(buffer.params().getFont()).
1689 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1693 case MARGIN_FIRST_DYNAMIC:
1694 if (layout.labeltype == LABEL_MANUAL) {
1695 // if we are at position 0, we are never in the body
1696 if (pos > 0 && pos >= par.beginOfBody())
1697 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1699 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1701 // Special case to fix problems with
1703 || (layout.labeltype == LABEL_STATIC
1704 && layout.latextype == LATEX_ENVIRONMENT
1705 && !text_->isFirstInSequence(pit))) {
1706 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1707 } else if (!layout.labelIsAbove()) {
1708 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1709 l_margin += labelfont_metrics.width(layout.labelsep);
1710 l_margin += labelfont_metrics.width(par.labelString());
1714 case MARGIN_RIGHT_ADDRESS_BOX: {
1716 // The left margin depends on the widest row in this paragraph.
1717 // This code is wrong because it depends on the rows, but at the
1718 // same time this function is used in redoParagraph to construct
1720 ParagraphMetrics const & pm = par_metrics_[pit];
1721 RowList::const_iterator rit = pm.rows().begin();
1722 RowList::const_iterator end = pm.rows().end();
1723 int minfill = max_width;
1724 for ( ; rit != end; ++rit)
1725 if (rit->fill() < minfill)
1726 minfill = rit->fill();
1727 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1728 l_margin += minfill;
1730 // also wrong, but much shorter.
1731 l_margin += max_width / 2;
1736 if (!par.params().leftIndent().zero())
1737 l_margin += par.params().leftIndent().inPixels(max_width, labelfont_metrics.em());
1741 if (par.params().align() == LYX_ALIGN_LAYOUT)
1742 align = layout.align;
1744 align = par.params().align();
1746 // set the correct parindent
1748 && (layout.labeltype == LABEL_NO_LABEL
1749 || layout.labeltype == LABEL_ABOVE
1750 || layout.labeltype == LABEL_CENTERED
1751 || (layout.labeltype == LABEL_STATIC
1752 && layout.latextype == LATEX_ENVIRONMENT
1753 && !text_->isFirstInSequence(pit)))
1754 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1755 && !par.params().noindent()
1756 // in some insets, paragraphs are never indented
1757 && !text_->inset().neverIndent()
1758 // display style insets are always centered, omit indentation
1761 && par.getInset(pos)->display())
1762 && (!(tclass.isDefaultLayout(par.layout())
1763 || tclass.isPlainLayout(par.layout()))
1764 || buffer.params().paragraph_separation
1765 == BufferParams::ParagraphIndentSeparation)) {
1766 // use the parindent of the layout when the
1767 // default indentation is used otherwise use
1768 // the indentation set in the document
1770 if (buffer.params().getIndentation().asLyXCommand() == "default")
1771 l_margin += theFontMetrics(
1772 buffer.params().getFont()).signedWidth(parindent);
1774 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1781 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1783 if (par_metrics_.empty())
1789 ParMetricsCache::iterator it = par_metrics_.begin();
1790 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1791 y -= it->second.ascent();
1792 for (; it != pm_end; ++it) {
1793 ParagraphMetrics const & pmi = it->second;
1795 pit_type const pit = it->first;
1796 // Save the paragraph position in the cache.
1797 it->second.setPosition(y);
1798 drawParagraph(pi, pit, x, y);
1804 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1806 BufferParams const & bparams = bv_->buffer().params();
1807 ParagraphMetrics const & pm = par_metrics_[pit];
1808 if (pm.rows().empty())
1811 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1812 int const ww = bv_->workHeight();
1813 size_t const nrows = pm.rows().size();
1815 Cursor const & cur = bv_->cursor();
1816 DocIterator sel_beg = cur.selectionBegin();
1817 DocIterator sel_end = cur.selectionEnd();
1818 bool selection = cur.selection()
1819 // This is our text.
1820 && cur.text() == text_
1821 // if the anchor is outside, this is not our selection
1822 && cur.normalAnchor().text() == text_
1823 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1825 // We store the begin and end pos of the selection relative to this par
1826 DocIterator sel_beg_par = cur.selectionBegin();
1827 DocIterator sel_end_par = cur.selectionEnd();
1829 // We care only about visible selection.
1831 if (pit != sel_beg.pit()) {
1832 sel_beg_par.pit() = pit;
1833 sel_beg_par.pos() = 0;
1835 if (pit != sel_end.pit()) {
1836 sel_end_par.pit() = pit;
1837 sel_end_par.pos() = sel_end_par.lastpos();
1841 for (size_t i = 0; i != nrows; ++i) {
1843 Row const & row = pm.rows()[i];
1848 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1849 rowSlice.pit() = pit;
1850 rowSlice.pos() = row.pos();
1852 bool const inside = (y + row.descent() >= 0
1853 && y - row.ascent() < ww);
1855 // Adapt to cursor row scroll offset if applicable.
1856 if (bv_->currentRowSlice() == rowSlice)
1857 row_x -= bv_->horizScrollOffset();
1859 // It is not needed to draw on screen if we are not inside.
1860 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1862 RowPainter rp(pi, *text_, pit, row, row_x, y);
1865 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1867 row.setSelection(-1, -1);
1869 // The row knows nothing about the paragraph, so we have to check
1870 // whether this row is the first or last and update the margins.
1871 if (row.selection()) {
1872 if (row.sel_beg == 0)
1873 row.begin_margin_sel = sel_beg.pit() < pit;
1874 if (row.sel_end == sel_end_par.lastpos())
1875 row.end_margin_sel = sel_end.pit() > pit;
1878 // Row signature; has row changed since last paint?
1879 if (pi.pain.isDrawingEnabled())
1880 row.setCrc(pm.computeRowSignature(row, bparams));
1881 bool row_has_changed = row.changed()
1882 || rowSlice == bv_->lastRowSlice();
1884 // Take this opportunity to spellcheck the row contents.
1885 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1886 text_->getPar(pit).spellCheck();
1889 // Don't paint the row if a full repaint has not been requested
1890 // and if it has not changed.
1891 if (!pi.full_repaint && !row_has_changed) {
1892 // Paint only the insets if the text itself is
1894 rp.paintOnlyInsets();
1899 // Clear background of this row if paragraph background was not
1900 // already cleared because of a full repaint.
1901 if (!pi.full_repaint && row_has_changed) {
1902 LYXERR(Debug::PAINTING, "Clear rect@("
1903 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1904 << width() << " x " << row.height());
1905 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1906 width(), row.height(), pi.background_color);
1909 // Instrumentation for testing row cache (see also
1911 if (lyxerr.debugging(Debug::PAINTING) && inside
1912 && (row.selection() || pi.full_repaint || row_has_changed)) {
1913 string const foreword = text_->isMainText() ?
1914 "main text redraw " : "inset text redraw: ";
1915 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1916 << " row_selection=" << row.selection()
1917 << " full_repaint=" << pi.full_repaint
1918 << " row_has_changed=" << row_has_changed
1919 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1922 // Backup full_repaint status and force full repaint
1923 // for inner insets as the Row has been cleared out.
1924 bool tmp = pi.full_repaint;
1925 pi.full_repaint = true;
1927 rp.paintSelection();
1930 rp.paintChangeBar();
1931 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1932 if (i == 0 && !is_rtl)
1934 if (i == nrows - 1 && is_rtl)
1937 if (i == nrows - 1 && !is_rtl)
1939 if (i == 0 && is_rtl)
1941 rp.paintTooLargeMarks(row_x < 0,
1942 row_x + row.width() > bv_->workWidth());
1945 // Restore full_repaint status.
1946 pi.full_repaint = tmp;
1948 // Re-enable screen drawing for future use of the painter.
1949 pi.pain.setDrawingEnabled(original_drawing_state);
1951 //LYXERR(Debug::PAINTING, ".");
1955 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
1956 Dimension & dim) const
1958 Cursor const & bvcur = cur.bv().cursor();
1960 // get word in front of cursor
1961 docstring word = text_->previousWord(bvcur.top());
1962 DocIterator wordStart = bvcur;
1963 wordStart.pos() -= word.length();
1965 // get position on screen of the word start and end
1966 //FIXME: Is it necessary to explicitly set this to false?
1967 wordStart.boundary(false);
1968 Point lxy = cur.bv().getPos(wordStart);
1969 Point rxy = cur.bv().getPos(bvcur);
1971 // calculate dimensions of the word
1973 row.pos(wordStart.pos());
1974 row.endpos(bvcur.pos());
1975 setRowHeight(row, bvcur.pit(), false);
1976 dim = row.dimension();
1977 dim.wid = abs(rxy.x_ - lxy.x_);
1979 // calculate position of word
1981 x = min(rxy.x_, lxy.x_);
1983 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
1984 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
1987 int defaultRowHeight()
1989 return int(theFontMetrics(sane_font).maxHeight() * 1.2);