2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #include "BufferView.h"
27 #include "CoordCache.h"
29 #include "CutAndPaste.h"
30 #include "FuncRequest.h"
31 #include "InsetList.h"
35 #include "MetricsInfo.h"
36 #include "paragraph_funcs.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "rowpainter.h"
41 #include "TextClass.h"
44 #include "mathed/MacroTable.h"
45 #include "mathed/MathMacroTemplate.h"
47 #include "frontends/FontMetrics.h"
48 #include "frontends/Painter.h"
50 #include "support/debug.h"
52 #include "support/lassert.h"
59 using frontend::FontMetrics;
61 static int numberOfSeparators(Paragraph const & par, Row const & row)
63 pos_type const first = max(row.pos(), par.beginOfBody());
64 pos_type const last = row.endpos() - 1;
66 for (pos_type p = first; p < last; ++p) {
67 if (par.isSeparator(p))
74 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
76 pos_type last = row.endpos() - 1;
77 pos_type first = row.pos();
79 // hfill *DO* count at the beginning of paragraphs!
81 while (first < last && par.isHfill(first))
85 last = min(last, par.beginOfBody());
87 for (pos_type p = first; p < last; ++p) {
95 static int numberOfHfills(Paragraph const & par, Row const & row)
97 pos_type const last = row.endpos();
98 pos_type first = row.pos();
100 // hfill *DO* count at the beginning of paragraphs!
102 while (first < last && par.isHfill(first))
106 first = max(first, par.beginOfBody());
109 for (pos_type p = first; p < last; ++p) {
117 /////////////////////////////////////////////////////////////////////
121 /////////////////////////////////////////////////////////////////////
124 TextMetrics::TextMetrics(BufferView * bv, Text * text)
125 : bv_(bv), text_(text)
128 max_width_ = bv_->workWidth();
129 dim_.wid = max_width_;
133 //text_->updateLabels(bv->buffer());
137 bool TextMetrics::contains(pit_type pit) const
139 return par_metrics_.find(pit) != par_metrics_.end();
143 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
145 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
150 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
152 ParMetricsCache::const_iterator it = par_metrics_.begin();
153 return make_pair(it->first, &it->second);
157 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
159 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
160 return make_pair(it->first, &it->second);
164 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
166 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
167 if (pmc_it == par_metrics_.end()) {
168 pmc_it = par_metrics_.insert(
169 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
171 if (pmc_it->second.rows().empty() && redo)
173 return pmc_it->second;
177 int TextMetrics::parPosition(pit_type pit) const
179 if (pit < par_metrics_.begin()->first)
181 if (pit > par_metrics_.rbegin()->first)
184 return par_metrics_[pit].position();
188 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
190 LASSERT(mi.base.textwidth > 0, /**/);
191 max_width_ = mi.base.textwidth;
192 // backup old dimension.
193 Dimension const old_dim = dim_;
196 dim_.wid = min_width;
197 pit_type const npar = text_->paragraphs().size();
199 // If there is more than one row, expand the text to
200 // the full allowable width.
201 dim_.wid = max_width_;
203 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
204 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
206 bool changed = false;
208 for (pit_type pit = 0; pit != npar; ++pit) {
209 changed |= redoParagraph(pit);
210 ParagraphMetrics const & pm = par_metrics_[pit];
212 if (dim_.wid < pm.width())
213 dim_.wid = pm.width();
216 dim_.asc = par_metrics_[0].ascent();
217 dim_.des = h - dim_.asc;
218 //lyxerr << "dim_.wid " << dim_.wid << endl;
219 //lyxerr << "dim_.asc " << dim_.asc << endl;
220 //lyxerr << "dim_.des " << dim_.des << endl;
222 changed |= dim_ != old_dim;
228 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
230 return main_text_? pm.rightMargin(*bv_) : 0;
234 int TextMetrics::rightMargin(pit_type const pit) const
236 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
240 void TextMetrics::applyOuterFont(Font & font) const
243 lf.fontInfo().reduce(bv_->buffer().params().getFont().fontInfo());
244 lf.fontInfo().realize(font.fontInfo());
245 lf.setLanguage(font.language());
250 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
252 LASSERT(pos >= 0, /**/);
254 ParagraphList const & pars = text_->paragraphs();
255 Paragraph const & par = pars[pit];
256 Layout const & layout = par.layout();
257 Buffer const & buffer = bv_->buffer();
259 BufferParams const & params = buffer.params();
260 pos_type const body_pos = par.beginOfBody();
262 // We specialize the 95% common case:
263 if (!par.getDepth()) {
264 Font f = par.getFontSettings(params, pos);
265 if (!text_->isMainText(buffer))
267 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
269 FontInfo const & lf = lab ? layout.labelfont : layout.font;
270 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
272 // In case the default family has been customized
273 if (lf.family() == INHERIT_FAMILY)
274 rlf.setFamily(params.getFont().fontInfo().family());
275 f.fontInfo().realize(rlf);
279 // The uncommon case need not be optimized as much
280 FontInfo const & layoutfont = pos < body_pos ?
281 layout.labelfont : layout.font;
283 Font font = par.getFontSettings(params, pos);
284 font.fontInfo().realize(layoutfont);
286 if (!text_->isMainText(buffer))
287 applyOuterFont(font);
289 // Realize against environment font information
290 // NOTE: the cast to pit_type should be removed when pit_type
291 // changes to a unsigned integer.
292 if (pit < pit_type(pars.size()))
293 font.fontInfo().realize(outerFont(pit, pars).fontInfo());
295 // Realize with the fonts of lesser depth.
296 font.fontInfo().realize(params.getFont().fontInfo());
302 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
304 if (!lyxrc.rtl_support || !sl.text())
308 if (boundary && sl.pos() > 0)
311 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
315 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
317 if (!lyxrc.rtl_support)
320 // no RTL boundary at line start
324 Font const & left_font = displayFont(pit, pos - 1);
326 return isRTLBoundary(pit, pos, left_font);
330 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
331 Font const & font) const
333 if (!lyxrc.rtl_support)
336 Paragraph const & par = text_->getPar(pit);
337 bool left = font.isVisibleRightToLeft();
339 if (pos == par.size())
340 right = par.isRTL(bv_->buffer().params());
342 right = displayFont(pit, pos).isVisibleRightToLeft();
343 return left != right;
347 bool TextMetrics::redoParagraph(pit_type const pit)
349 Paragraph & par = text_->getPar(pit);
350 // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
351 // redoParagraph() recursively inside parMetrics.
352 Dimension old_dim = parMetrics(pit, false).dim();
353 ParagraphMetrics & pm = par_metrics_[pit];
356 Buffer & buffer = bv_->buffer();
357 main_text_ = (text_ == &buffer.text());
358 bool changed = false;
360 // FIXME: This check ought to be done somewhere else. It is the reason
361 // why text_ is not const. But then, where else to do it?
362 // Well, how can you end up with either (a) a biblio environment that
363 // has no InsetBibitem or (b) a biblio environment with more than one
364 // InsetBibitem? I think the answer is: when paragraphs are merged;
365 // when layout is set; when material is pasted.
366 int const moveCursor = par.checkBiblio(buffer);
368 const_cast<Cursor &>(bv_->cursor()).posForward();
369 else if (moveCursor < 0) {
370 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
371 if (cursor.pos() >= -moveCursor)
372 cursor.posBackward();
375 // Optimisation: this is used in the next two loops
376 // so better to calculate that once here.
377 int const right_margin = rightMargin(pm);
379 // iterator pointing to paragraph to resolve macros
380 DocIterator parPos = text_->macrocontextPosition();
384 LYXERR(Debug::INFO, "MacroContext not initialised!"
385 << " Going through the buffer again and hope"
386 << " the context is better then.");
387 bv_->buffer().updateLabels();
388 parPos = text_->macrocontextPosition();
389 LASSERT(!parPos.empty(), /**/);
394 // FIXME: We should always use getFont(), see documentation of
395 // noFontChange() in Inset.h.
396 Font const bufferfont = buffer.params().getFont();
397 InsetList::const_iterator ii = par.insetList().begin();
398 InsetList::const_iterator iend = par.insetList().end();
399 for (; ii != iend; ++ii) {
400 // position already initialized?
401 if (!parPos.empty()) {
402 parPos.pos() = ii->pos;
404 // A macro template would normally not be visible
405 // by itself. But the tex macro semantics allow
406 // recursion, so we artifically take the context
407 // after the macro template to simulate this.
408 if (ii->inset->lyxCode() == MATHMACRO_CODE)
412 // do the metric calculation
414 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
416 Font const & font = ii->inset->noFontChange() ?
417 bufferfont : displayFont(pit, ii->pos);
418 MacroContext mc(buffer, parPos);
419 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
420 ii->inset->metrics(mi, dim);
421 Dimension const old_dim = pm.insetDimension(ii->inset);
422 if (old_dim != dim) {
423 pm.setInsetDimension(ii->inset, dim);
428 par.setBeginOfBody();
430 size_t row_index = 0;
431 // maximum pixel width of a row
432 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
435 pos_type end = rowBreakPoint(width, pit, first);
436 if (row_index || end < par.size())
437 // If there is more than one row, expand the text to
438 // the full allowable width. This setting here is needed
439 // for the computeRowMetrics() below.
440 dim_.wid = max_width_;
442 dim = rowHeight(pit, first, end);
443 dim.wid = rowWidth(right_margin, pit, first, end);
444 if (row_index == pm.rows().size())
445 pm.rows().push_back(Row());
446 Row & row = pm.rows()[row_index];
447 row.setChanged(false);
450 row.setDimension(dim);
451 int const max_row_width = max(dim_.wid, dim.wid);
452 computeRowMetrics(pit, row, max_row_width);
456 pm.dim().wid = max(pm.dim().wid, dim.wid);
457 pm.dim().des += dim.height();
458 } while (first < par.size());
460 if (row_index < pm.rows().size())
461 pm.rows().resize(row_index);
463 // Make sure that if a par ends in newline, there is one more row
465 if (first > 0 && par.isNewline(first - 1)) {
466 Dimension dim = rowHeight(pit, first, first);
467 dim.wid = rowWidth(right_margin, pit, first, first);
468 if (row_index == pm.rows().size())
469 pm.rows().push_back(Row());
470 Row & row = pm.rows()[row_index];
471 row.setChanged(false);
474 row.setDimension(dim);
475 int const max_row_width = max(dim_.wid, dim.wid);
476 computeRowMetrics(pit, row, max_row_width);
477 pm.dim().des += dim.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 void TextMetrics::computeRowMetrics(pit_type const pit,
490 Row & row, int width) const
495 Buffer & buffer = bv_->buffer();
496 Paragraph const & par = text_->getPar(pit);
498 double w = width - row.width();
499 // FIXME: put back this assertion when the crash on new doc is solved.
500 //LASSERT(w >= 0, /**/);
502 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
503 //lyxerr << "row.width() " << row.width() << endl;
504 //lyxerr << "w " << w << endl;
506 bool const is_rtl = text_->isRTL(buffer, par);
508 row.x = rightMargin(pit);
510 row.x = leftMargin(max_width_, pit, row.pos());
512 // is there a manual margin with a manual label
513 Layout const & layout = par.layout();
515 if (layout.margintype == MARGIN_MANUAL
516 && layout.labeltype == LABEL_MANUAL) {
517 /// We might have real hfills in the label part
518 int nlh = numberOfLabelHfills(par, row);
520 // A manual label par (e.g. List) has an auto-hfill
521 // between the label text and the body of the
523 // But we don't want to do this auto hfill if the par
528 if (nlh && !par.getLabelWidthString().empty())
529 row.label_hfill = labelFill(pit, row) / double(nlh);
533 // are there any hfills in the row?
534 if (int const nh = numberOfHfills(par, row)) {
536 hfill = w / double(nh);
537 // we don't have to look at the alignment if it is ALIGN_LEFT and
538 // if the row is already larger then the permitted width as then
539 // we force the LEFT_ALIGN'edness!
540 } else if (int(row.width()) < max_width_) {
541 // is it block, flushleft or flushright?
542 // set x how you need it
544 if (par.params().align() == LYX_ALIGN_LAYOUT)
545 align = layout.align;
547 align = par.params().align();
549 // handle alignment inside tabular cells
550 Inset const & owner = par.inInset();
551 switch (owner.contentAlignment()) {
552 case LYX_ALIGN_CENTER:
554 case LYX_ALIGN_RIGHT:
555 if (align == LYX_ALIGN_NONE
556 || align == LYX_ALIGN_BLOCK)
557 align = owner.contentAlignment();
560 // unchanged (use align)
564 // Display-style insets should always be on a centered row
565 if (Inset const * inset = par.getInset(row.pos())) {
566 switch (inset->display()) {
567 case Inset::AlignLeft:
568 align = LYX_ALIGN_BLOCK;
570 case Inset::AlignCenter:
571 align = LYX_ALIGN_CENTER;
574 // unchanged (use align)
576 case Inset::AlignRight:
577 align = LYX_ALIGN_RIGHT;
583 case LYX_ALIGN_BLOCK: {
584 int const ns = numberOfSeparators(par, row);
585 bool disp_inset = false;
586 if (row.endpos() < par.size()) {
587 Inset const * in = par.getInset(row.endpos());
589 disp_inset = in->display();
591 // If we have separators, this is not the last row of a
592 // par, does not end in newline, and is not row above a
593 // display inset... then stretch it
595 && row.endpos() < par.size()
596 && !par.isNewline(row.endpos() - 1)
599 row.separator = w / ns;
600 //lyxerr << "row.separator " << row.separator << endl;
601 //lyxerr << "ns " << ns << endl;
607 case LYX_ALIGN_RIGHT:
610 case LYX_ALIGN_CENTER:
617 pos_type body_pos = par.beginOfBody();
618 pos_type end = row.endpos();
621 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
623 row.x += theFontMetrics(text_->labelFont(buffer, par)).
624 width(layout.labelsep);
626 row.x += row.label_hfill;
630 pos_type const endpos = row.endpos();
631 pos_type body_pos = par.beginOfBody();
633 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
636 ParagraphMetrics & pm = par_metrics_[pit];
637 InsetList::const_iterator ii = par.insetList().begin();
638 InsetList::const_iterator iend = par.insetList().end();
639 for ( ; ii != iend; ++ii) {
640 if (ii->pos >= endpos || ii->pos < row.pos()
641 || (ii->inset->lyxCode() != SPACE_CODE ||
642 !ii->inset->isStretchableSpace()))
644 Dimension dim = row.dimension();
645 if (pm.hfillExpansion(row, ii->pos))
646 dim.wid = int(ii->pos >= body_pos ?
647 max(hfill, 5.0) : row.label_hfill);
650 // Cache the inset dimension.
651 bv_->coordCache().insets().add(ii->inset, dim);
652 pm.setInsetDimension(ii->inset, dim);
657 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
659 Buffer & buffer = bv_->buffer();
660 Paragraph const & par = text_->getPar(pit);
662 pos_type last = par.beginOfBody();
663 LASSERT(last > 0, /**/);
665 // -1 because a label ends with a space that is in the label
668 // a separator at this end does not count
669 if (par.isLineSeparator(last))
673 for (pos_type i = row.pos(); i <= last; ++i)
674 w += singleWidth(pit, i);
676 docstring const & label = par.params().labelWidthString();
680 FontMetrics const & fm
681 = theFontMetrics(text_->labelFont(buffer, par));
683 return max(0, fm.width(label) - w);
687 // this needs special handling - only newlines count as a break point
688 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
690 pos_type const end = par.size();
693 if (par.isNewline(i))
700 int TextMetrics::labelEnd(pit_type const pit) const
702 // labelEnd is only needed if the layout fills a flushleft label.
703 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
705 // return the beginning of the body
706 return leftMargin(max_width_, pit);
712 * Calling Text::getFont is slow. While rebreaking we scan a
713 * paragraph from left to right calling getFont for every char. This
714 * simple class address this problem by hidding an optimization trick
715 * (not mine btw -AB): the font is reused in the whole font span. The
716 * class handles transparently the "hidden" (not part of the fontlist)
717 * label font (as getFont does).
723 FontIterator(TextMetrics const & tm,
724 Paragraph const & par, pit_type pit, pos_type pos)
725 : tm_(tm), par_(par), pit_(pit), pos_(pos),
726 font_(tm.displayFont(pit, pos)),
727 endspan_(par.fontSpan(pos).last),
728 bodypos_(par.beginOfBody())
732 Font const & operator*() const { return font_; }
735 FontIterator & operator++()
738 if (pos_ > endspan_ || pos_ == bodypos_) {
739 font_ = tm_.displayFont(pit_, pos_);
740 endspan_ = par_.fontSpan(pos_).last;
746 Font * operator->() { return &font_; }
750 TextMetrics const & tm_;
752 Paragraph const & par_;
767 pit_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
770 Buffer & buffer = bv_->buffer();
771 ParagraphMetrics const & pm = par_metrics_[pit];
772 Paragraph const & par = text_->getPar(pit);
773 pos_type const end = par.size();
774 if (pos == end || width < 0)
777 Layout const & layout = par.layout();
779 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
780 return addressBreakPoint(pos, par);
782 pos_type const body_pos = par.beginOfBody();
784 // check for possible inline completion
785 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
786 pos_type inlineCompletionLPos = -1;
787 if (inlineCompletionPos.inTexted()
788 && inlineCompletionPos.text() == text_
789 && inlineCompletionPos.pit() == pit) {
790 // draw logically behind the previous character
791 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
794 // Now we iterate through until we reach the right margin
795 // or the end of the par, then choose the possible break
798 int label_end = labelEnd(pit);
799 int const left = leftMargin(max_width_, pit, pos);
802 // pixel width since last breakpoint
805 FontIterator fi = FontIterator(*this, par, pit, pos);
806 pos_type point = end;
808 for ( ; i < end; ++i, ++fi) {
809 int thiswidth = pm.singleWidth(i, *fi);
811 // add inline completion width
812 if (inlineCompletionLPos == i) {
813 docstring const & completion = bv_->inlineCompletion();
814 if (completion.length() > 0)
815 thiswidth += theFontMetrics(*fi).width(completion);
818 // add the auto-hfill from label end to the body
819 if (body_pos && i == body_pos) {
820 FontMetrics const & fm = theFontMetrics(
821 text_->labelFont(buffer, par));
822 int add = fm.width(layout.labelsep);
823 if (par.isLineSeparator(i - 1))
824 add -= singleWidth(pit, i - 1);
826 add = max(add, label_end - x);
831 chunkwidth += thiswidth;
833 // break before a character that will fall off
834 // the right of the row
836 // if no break before, break here
837 if (point == end || chunkwidth >= width - left) {
843 // exit on last registered breakpoint:
847 if (par.isNewline(i)) {
851 Inset const * inset = 0;
854 if ((inset = par.getInset(i + 1)) && inset->display()) {
859 if ((inset = par.getInset(i)) && inset->display()) {
865 inset = par.getInset(i);
866 if (!inset || inset->isChar()) {
867 // some insets are line separators too
868 if (par.isLineSeparator(i)) {
869 // register breakpoint:
876 // maybe found one, but the par is short enough.
877 if (i == end && x < width)
880 // manual labels cannot be broken in LaTeX. But we
881 // want to make our on-screen rendering of footnotes
883 if (body_pos && point < body_pos)
890 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
891 pos_type const first, pos_type const end) const
893 Buffer & buffer = bv_->buffer();
894 // get the pure distance
895 ParagraphMetrics const & pm = par_metrics_[pit];
896 Paragraph const & par = text_->getPar(pit);
897 int w = leftMargin(max_width_, pit, first);
898 int label_end = labelEnd(pit);
900 // check for possible inline completion
901 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
902 pos_type inlineCompletionLPos = -1;
903 if (inlineCompletionPos.inTexted()
904 && inlineCompletionPos.text() == text_
905 && inlineCompletionPos.pit() == pit) {
906 // draw logically behind the previous character
907 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
910 pos_type const body_pos = par.beginOfBody();
914 FontIterator fi = FontIterator(*this, par, pit, i);
915 for ( ; i < end; ++i, ++fi) {
916 if (body_pos > 0 && i == body_pos) {
917 FontMetrics const & fm = theFontMetrics(
918 text_->labelFont(buffer, par));
919 w += fm.width(par.layout().labelsep);
920 if (par.isLineSeparator(i - 1))
921 w -= singleWidth(pit, i - 1);
922 w = max(w, label_end);
924 w += pm.singleWidth(i, *fi);
926 // add inline completion width
927 if (inlineCompletionLPos == i) {
928 docstring const & completion = bv_->inlineCompletion();
929 if (completion.length() > 0)
930 w += theFontMetrics(*fi).width(completion);
935 if (body_pos > 0 && body_pos >= end) {
936 FontMetrics const & fm = theFontMetrics(
937 text_->labelFont(buffer, par));
938 w += fm.width(par.layout().labelsep);
939 if (end > 0 && par.isLineSeparator(end - 1))
940 w -= singleWidth(pit, end - 1);
941 w = max(w, label_end);
944 return w + right_margin;
948 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
949 pos_type const end, bool topBottomSpace) const
951 Paragraph const & par = text_->getPar(pit);
952 // get the maximum ascent and the maximum descent
953 double layoutasc = 0;
954 double layoutdesc = 0;
955 double const dh = defaultRowHeight();
957 // ok, let us initialize the maxasc and maxdesc value.
958 // Only the fontsize count. The other properties
959 // are taken from the layoutfont. Nicer on the screen :)
960 Layout const & layout = par.layout();
962 // as max get the first character of this row then it can
963 // increase but not decrease the height. Just some point to
964 // start with so we don't have to do the assignment below too
966 Buffer const & buffer = bv_->buffer();
967 Font font = displayFont(pit, first);
968 FontSize const tmpsize = font.fontInfo().size();
969 font.fontInfo() = text_->layoutFont(buffer, pit);
970 FontSize const size = font.fontInfo().size();
971 font.fontInfo().setSize(tmpsize);
973 FontInfo labelfont = text_->labelFont(buffer, par);
975 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
976 FontMetrics const & fontmetrics = theFontMetrics(font);
978 // these are minimum values
979 double const spacing_val = layout.spacing.getValue()
980 * text_->spacing(buffer, par);
981 //lyxerr << "spacing_val = " << spacing_val << endl;
982 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
983 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
985 // insets may be taller
986 ParagraphMetrics const & pm = par_metrics_[pit];
987 InsetList::const_iterator ii = par.insetList().begin();
988 InsetList::const_iterator iend = par.insetList().end();
989 for ( ; ii != iend; ++ii) {
990 if (ii->pos >= first && ii->pos < end) {
991 Dimension const & dim = pm.insetDimension(ii->inset);
992 maxasc = max(maxasc, dim.ascent());
993 maxdesc = max(maxdesc, dim.descent());
997 // Check if any custom fonts are larger (Asger)
998 // This is not completely correct, but we can live with the small,
999 // cosmetic error for now.
1003 par.highestFontInRange(first, end, size);
1004 if (maxsize > font.fontInfo().size()) {
1005 // use standard paragraph font with the maximal size
1006 FontInfo maxfont = font.fontInfo();
1007 maxfont.setSize(maxsize);
1008 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1009 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1010 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1013 // This is nicer with box insets:
1017 ParagraphList const & pars = text_->paragraphs();
1019 // is it a top line?
1020 if (first == 0 && topBottomSpace) {
1021 BufferParams const & bufparams = buffer.params();
1022 // some parskips VERY EASY IMPLEMENTATION
1023 if (bufparams.paragraph_separation
1024 == BufferParams::ParagraphSkipSeparation
1025 && par.ownerCode() != ERT_CODE
1026 && par.ownerCode() != LISTINGS_CODE
1028 && ((layout.isParagraph() && par.getDepth() == 0)
1029 || (pars[pit - 1].layout().isParagraph()
1030 && pars[pit - 1].getDepth() == 0)))
1032 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1035 if (par.params().startOfAppendix())
1036 maxasc += int(3 * dh);
1038 // This is special code for the chapter, since the label of this
1039 // layout is printed in an extra row
1040 if (layout.counter == "chapter"
1041 && !par.params().labelString().empty()) {
1042 labeladdon = int(labelfont_metrics.maxHeight()
1043 * layout.spacing.getValue()
1044 * text_->spacing(buffer, par));
1047 // special code for the top label
1048 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1049 || layout.labeltype == LABEL_BIBLIO
1050 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1051 && isFirstInSequence(pit, pars)
1052 && !par.labelString().empty())
1055 labelfont_metrics.maxHeight()
1056 * layout.spacing.getValue()
1057 * text_->spacing(buffer, par)
1058 + (layout.topsep + layout.labelbottomsep) * dh);
1061 // Add the layout spaces, for example before and after
1062 // a section, or between the items of a itemize or enumerate
1065 pit_type prev = depthHook(pit, pars, par.getDepth());
1066 Paragraph const & prevpar = pars[prev];
1068 && prevpar.layout() == layout
1069 && prevpar.getDepth() == par.getDepth()
1070 && prevpar.getLabelWidthString()
1071 == par.getLabelWidthString()) {
1072 layoutasc = layout.itemsep * dh;
1073 } else if (pit != 0 || first != 0) {
1074 if (layout.topsep > 0)
1075 layoutasc = layout.topsep * dh;
1078 prev = outerHook(pit, pars);
1079 if (prev != pit_type(pars.size())) {
1080 maxasc += int(pars[prev].layout().parsep * dh);
1081 } else if (pit != 0) {
1082 Paragraph const & prevpar = pars[pit - 1];
1083 if (prevpar.getDepth() != 0 ||
1084 prevpar.layout() == layout) {
1085 maxasc += int(layout.parsep * dh);
1090 // is it a bottom line?
1091 if (end >= par.size() && topBottomSpace) {
1092 // add the layout spaces, for example before and after
1093 // a section, or between the items of a itemize or enumerate
1095 pit_type nextpit = pit + 1;
1096 if (nextpit != pit_type(pars.size())) {
1097 pit_type cpit = pit;
1101 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1102 usual = pars[cpit].layout().bottomsep * dh;
1103 cpit = depthHook(cpit, pars, pars[nextpit].getDepth());
1104 if (pars[cpit].layout() != pars[nextpit].layout()
1105 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1107 unusual = pars[cpit].layout().bottomsep * dh;
1109 layoutdesc = max(unusual, usual);
1110 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1111 if (pars[cpit].layout() != pars[nextpit].layout()
1112 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1113 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1118 // incalculate the layout spaces
1119 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1120 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1122 // FIXME: the correct way is to do the following is to move the
1123 // following code in another method specially tailored for the
1124 // main Text. The following test is thus bogus.
1125 // Top and bottom margin of the document (only at top-level)
1126 if (main_text_ && topBottomSpace) {
1127 if (pit == 0 && first == 0)
1129 if (pit + 1 == pit_type(pars.size()) &&
1130 end == par.size() &&
1131 !(end > 0 && par.isNewline(end - 1)))
1135 return Dimension(0, maxasc + labeladdon, maxdesc);
1139 // x is an absolute screen coord
1140 // returns the column near the specified x-coordinate of the row
1141 // x is set to the real beginning of this column
1142 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1143 Row const & row, int & x, bool & boundary) const
1145 Buffer const & buffer = bv_->buffer();
1147 /// For the main Text, it is possible that this pit is not
1148 /// yet in the CoordCache when moving cursor up.
1149 /// x Paragraph coordinate is always 0 for main text anyway.
1150 int const xo = origin_.x_;
1152 Paragraph const & par = text_->getPar(pit);
1154 bidi.computeTables(par, buffer, row);
1156 pos_type vc = row.pos();
1157 pos_type end = row.endpos();
1159 Layout const & layout = par.layout();
1161 bool left_side = false;
1163 pos_type body_pos = par.beginOfBody();
1165 double tmpx = row.x;
1166 double last_tmpx = tmpx;
1169 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1172 // check for empty row
1178 while (vc < end && tmpx <= x) {
1179 c = bidi.vis2log(vc);
1181 if (body_pos > 0 && c == body_pos - 1) {
1182 FontMetrics const & fm = theFontMetrics(
1183 text_->labelFont(buffer, par));
1184 tmpx += row.label_hfill + fm.width(layout.labelsep);
1185 if (par.isLineSeparator(body_pos - 1))
1186 tmpx -= singleWidth(pit, body_pos - 1);
1189 tmpx += singleWidth(pit, c);
1190 if (par.isSeparator(c) && c >= body_pos)
1191 tmpx += row.separator;
1195 if ((tmpx + last_tmpx) / 2 > x) {
1200 LASSERT(vc <= end, /**/); // This shouldn't happen.
1203 // This (rtl_support test) is not needed, but gives
1204 // some speedup if rtl_support == false
1205 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1207 // If lastrow is false, we don't need to compute
1208 // the value of rtl.
1209 bool const rtl = lastrow ? text_->isRTL(buffer, par) : false;
1211 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1212 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1213 if (!par.isNewline(end - 1))
1215 } else if (vc == row.pos()) {
1216 c = bidi.vis2log(vc);
1217 if (bidi.level(c) % 2 == 1)
1220 c = bidi.vis2log(vc - 1);
1221 bool const rtl = (bidi.level(c) % 2 == 1);
1222 if (left_side == rtl) {
1224 boundary = isRTLBoundary(pit, c);
1228 // I believe this code is not needed anymore (Jug 20050717)
1230 // The following code is necessary because the cursor position past
1231 // the last char in a row is logically equivalent to that before
1232 // the first char in the next row. That's why insets causing row
1233 // divisions -- Newline and display-style insets -- must be treated
1234 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1235 // Newline inset, air gap below:
1236 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1237 if (bidi.level(end -1) % 2 == 0)
1238 tmpx -= singleWidth(pit, end - 1);
1240 tmpx += singleWidth(pit, end - 1);
1244 // Air gap above display inset:
1245 if (row.pos() < end && c >= end && end < par.size()
1246 && par.isInset(end) && par.getInset(end)->display()) {
1249 // Air gap below display inset:
1250 if (row.pos() < end && c >= end && par.isInset(end - 1)
1251 && par.getInset(end - 1)->display()) {
1257 pos_type const col = c - row.pos();
1259 if (!c || end == par.size())
1262 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1267 return min(col, end - 1 - row.pos());
1271 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1273 // We play safe and use parMetrics(pit) to make sure the
1274 // ParagraphMetrics will be redone and OK to use if needed.
1275 // Otherwise we would use an empty ParagraphMetrics in
1276 // upDownInText() while in selection mode.
1277 ParagraphMetrics const & pm = parMetrics(pit);
1279 LASSERT(row < int(pm.rows().size()), /**/);
1281 Row const & r = pm.rows()[row];
1282 return r.pos() + getColumnNearX(pit, r, x, bound);
1286 void TextMetrics::newParMetricsDown()
1288 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1289 pit_type const pit = last.first + 1;
1290 if (pit == int(text_->paragraphs().size()))
1293 // do it and update its position.
1295 par_metrics_[pit].setPosition(last.second.position()
1296 + last.second.descent() + par_metrics_[pit].ascent());
1300 void TextMetrics::newParMetricsUp()
1302 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1303 if (first.first == 0)
1306 pit_type const pit = first.first - 1;
1307 // do it and update its position.
1309 par_metrics_[pit].setPosition(first.second.position()
1310 - first.second.ascent() - par_metrics_[pit].descent());
1313 // y is screen coordinate
1314 pit_type TextMetrics::getPitNearY(int y)
1316 LASSERT(!text_->paragraphs().empty(), return -1);
1317 LASSERT(!par_metrics_.empty(), return -1);
1318 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1320 // look for highest numbered paragraph with y coordinate less than given y
1323 ParMetricsCache::const_iterator it = par_metrics_.begin();
1324 ParMetricsCache::const_iterator et = par_metrics_.end();
1325 ParMetricsCache::const_iterator last = et; last--;
1327 ParagraphMetrics const & pm = it->second;
1329 if (y < it->second.position() - int(pm.ascent())) {
1330 // We are looking for a position that is before the first paragraph in
1331 // the cache (which is in priciple off-screen, that is before the
1334 // We are already at the first paragraph in the inset.
1336 // OK, this is the paragraph we are looking for.
1337 pit = it->first - 1;
1342 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1344 if (y >= last->second.position() + int(pm_last.descent())) {
1345 // We are looking for a position that is after the last paragraph in
1346 // the cache (which is in priciple off-screen), that is before the
1348 pit = last->first + 1;
1349 if (pit == int(text_->paragraphs().size()))
1350 // We are already at the last paragraph in the inset.
1352 // OK, this is the paragraph we are looking for.
1353 newParMetricsDown();
1357 for (; it != et; ++it) {
1358 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1359 << " y: " << it->second.position());
1361 ParagraphMetrics const & pm = par_metrics_[it->first];
1363 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1365 yy = it->second.position();
1369 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1375 Row const & TextMetrics::getPitAndRowNearY(int y, pit_type & pit,
1376 bool assert_in_view, bool up)
1378 ParagraphMetrics const & pm = par_metrics_[pit];
1380 int yy = pm.position() - pm.ascent();
1381 LASSERT(!pm.rows().empty(), /**/);
1382 RowList::const_iterator rit = pm.rows().begin();
1383 RowList::const_iterator rlast = pm.rows().end();
1385 for (; rit != rlast; yy += rit->height(), ++rit)
1386 if (yy + rit->height() > y)
1389 if (assert_in_view && yy + rit->height() != y) {
1391 if (rit != pm.rows().begin())
1393 else if (pit != 0) {
1396 ParagraphMetrics const & pm2 = par_metrics_[pit];
1397 rit = pm2.rows().end();
1403 else if (pit != int(par_metrics_.size())) {
1405 newParMetricsDown();
1406 ParagraphMetrics const & pm2 = par_metrics_[pit];
1407 rit = pm2.rows().begin();
1415 // x,y are absolute screen coordinates
1416 // sets cursor recursively descending into nested editable insets
1417 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1418 bool assert_in_view, bool up)
1420 if (lyxerr.debugging(Debug::WORKAREA)) {
1421 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1422 cur.bv().coordCache().dump();
1424 pit_type pit = getPitNearY(y);
1425 LASSERT(pit != -1, return 0);
1427 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1430 int xx = x; // is modified by getColumnNearX
1431 pos_type const pos = row.pos()
1432 + getColumnNearX(pit, row, xx, bound);
1435 cur.boundary(bound);
1438 // try to descend into nested insets
1439 Inset * inset = checkInsetHit(x, y);
1440 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1442 // Either we deconst editXY or better we move current_font
1443 // and real_current_font to Cursor
1444 // FIXME: what is needed now that current_font and real_current_font
1446 cur.setCurrentFont();
1450 ParagraphList const & pars = text_->paragraphs();
1451 Inset const * insetBefore = pos ? pars[pit].getInset(pos - 1) : 0;
1452 //Inset * insetBehind = pars[pit].getInset(pos);
1454 // This should be just before or just behind the
1455 // cursor position set above.
1456 LASSERT((pos != 0 && inset == insetBefore)
1457 || inset == pars[pit].getInset(pos), /**/);
1459 // Make sure the cursor points to the position before
1461 if (inset == insetBefore) {
1463 cur.boundary(false);
1466 // Try to descend recursively inside the inset.
1467 inset = inset->editXY(cur, x, y);
1469 if (cur.top().text() == text_)
1470 cur.setCurrentFont();
1475 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1477 LASSERT(text_ == cur.text(), /**/);
1478 pit_type pit = getPitNearY(y);
1479 LASSERT(pit != -1, return);
1481 ParagraphMetrics const & pm = par_metrics_[pit];
1483 int yy = pm.position() - pm.ascent();
1484 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1485 " pit: " << pit << " yy: " << yy);
1488 LASSERT(pm.rows().size(), /**/);
1489 for (; r < int(pm.rows().size()) - 1; ++r) {
1490 Row const & row = pm.rows()[r];
1491 if (int(yy + row.height()) > y)
1496 Row const & row = pm.rows()[r];
1498 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1502 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1504 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1506 text_->setCursor(cur, pit, pos, true, bound);
1507 // remember new position.
1512 //takes screen x,y coordinates
1513 Inset * TextMetrics::checkInsetHit(int x, int y)
1515 pit_type pit = getPitNearY(y);
1516 LASSERT(pit != -1, return 0);
1518 Paragraph const & par = text_->paragraphs()[pit];
1519 ParagraphMetrics const & pm = par_metrics_[pit];
1521 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1523 InsetList::const_iterator iit = par.insetList().begin();
1524 InsetList::const_iterator iend = par.insetList().end();
1525 for (; iit != iend; ++iit) {
1526 Inset * inset = iit->inset;
1528 LYXERR(Debug::DEBUG, "examining inset " << inset);
1530 if (!bv_->coordCache().getInsets().has(inset)) {
1531 LYXERR(Debug::DEBUG, "inset has no cached position");
1535 Dimension const & dim = pm.insetDimension(inset);
1536 Point p = bv_->coordCache().getInsets().xy(inset);
1538 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1539 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1542 && x <= p.x_ + dim.wid
1543 && y >= p.y_ - dim.asc
1544 && y <= p.y_ + dim.des) {
1545 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1550 LYXERR(Debug::DEBUG, "No inset hit. ");
1555 int TextMetrics::cursorX(CursorSlice const & sl,
1556 bool boundary) const
1558 LASSERT(sl.text() == text_, /**/);
1559 pit_type const pit = sl.pit();
1560 Paragraph const & par = text_->paragraphs()[pit];
1561 ParagraphMetrics const & pm = par_metrics_[pit];
1562 if (pm.rows().empty())
1565 pos_type ppos = sl.pos();
1566 // Correct position in front of big insets
1567 bool const boundary_correction = ppos != 0 && boundary;
1568 if (boundary_correction)
1571 Row const & row = pm.getRow(sl.pos(), boundary);
1573 pos_type cursor_vpos = 0;
1575 Buffer const & buffer = bv_->buffer();
1578 bidi.computeTables(par, buffer, row);
1580 pos_type const row_pos = row.pos();
1581 pos_type const end = row.endpos();
1582 // Spaces at logical line breaks in bidi text must be skipped during
1583 // cursor positioning. However, they may appear visually in the middle
1584 // of a row; they must be skipped, wherever they are...
1585 // * logically "abc_[HEBREW_\nHEBREW]"
1586 // * visually "abc_[_WERBEH\nWERBEH]"
1587 pos_type skipped_sep_vpos = -1;
1590 cursor_vpos = row_pos;
1591 else if (ppos >= end)
1592 cursor_vpos = text_->isRTL(buffer, par) ? row_pos : end;
1593 else if (ppos > row_pos && ppos >= end)
1594 // Place cursor after char at (logical) position pos - 1
1595 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1596 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1598 // Place cursor before char at (logical) position ppos
1599 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1600 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1602 pos_type body_pos = par.beginOfBody();
1604 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1607 // check for possible inline completion in this row
1608 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1609 pos_type inlineCompletionVPos = -1;
1610 if (inlineCompletionPos.inTexted()
1611 && inlineCompletionPos.text() == text_
1612 && inlineCompletionPos.pit() == pit
1613 && inlineCompletionPos.pos() - 1 >= row_pos
1614 && inlineCompletionPos.pos() - 1 < end) {
1615 // draw logically behind the previous character
1616 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1619 // Use font span to speed things up, see below
1623 // If the last logical character is a separator, skip it, unless
1624 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1625 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1626 skipped_sep_vpos = bidi.log2vis(end - 1);
1628 // Inline completion RTL special case row_pos == cursor_pos:
1629 // "__|b" => cursor_pos is right of __
1630 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1631 font = displayFont(pit, row_pos + 1);
1632 docstring const & completion = bv_->inlineCompletion();
1633 if (font.isRightToLeft() && completion.length() > 0)
1634 x += theFontMetrics(font.fontInfo()).width(completion);
1637 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1638 // Skip the separator which is at the logical end of the row
1639 if (vpos == skipped_sep_vpos)
1641 pos_type pos = bidi.vis2log(vpos);
1642 if (body_pos > 0 && pos == body_pos - 1) {
1643 FontMetrics const & labelfm = theFontMetrics(
1644 text_->labelFont(buffer, par));
1645 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1646 if (par.isLineSeparator(body_pos - 1))
1647 x -= singleWidth(pit, body_pos - 1);
1650 // Use font span to speed things up, see above
1651 if (pos < font_span.first || pos > font_span.last) {
1652 font_span = par.fontSpan(pos);
1653 font = displayFont(pit, pos);
1656 x += pm.singleWidth(pos, font);
1658 // Inline completion RTL case:
1659 // "a__|b", __ of b => non-boundary a-pos is right of __
1660 if (vpos + 1 == inlineCompletionVPos
1661 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1662 font = displayFont(pit, vpos + 1);
1663 docstring const & completion = bv_->inlineCompletion();
1664 if (font.isRightToLeft() && completion.length() > 0)
1665 x += theFontMetrics(font.fontInfo()).width(completion);
1668 // Inline completion LTR case:
1669 // "b|__a", __ of b => non-boundary a-pos is in front of __
1670 if (vpos == inlineCompletionVPos
1671 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1672 font = displayFont(pit, vpos);
1673 docstring const & completion = bv_->inlineCompletion();
1674 if (!font.isRightToLeft() && completion.length() > 0)
1675 x += theFontMetrics(font.fontInfo()).width(completion);
1678 if (par.isSeparator(pos) && pos >= body_pos)
1682 // see correction above
1683 if (boundary_correction) {
1684 if (isRTL(sl, boundary))
1685 x -= singleWidth(pit, ppos);
1687 x += singleWidth(pit, ppos);
1694 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1696 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1697 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1698 if (pm.rows().empty())
1702 h -= par_metrics_[0].rows()[0].ascent();
1703 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1704 h += par_metrics_[pit].height();
1707 if (pos && boundary)
1709 size_t const rend = pm.pos2row(pos);
1710 for (size_t rit = 0; rit != rend; ++rit)
1711 h += pm.rows()[rit].height();
1712 h += pm.rows()[rend].ascent();
1717 // the cursor set functions have a special mechanism. When they
1718 // realize you left an empty paragraph, they will delete it.
1720 bool TextMetrics::cursorHome(Cursor & cur)
1722 LASSERT(text_ == cur.text(), /**/);
1723 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1724 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1725 return text_->setCursor(cur, cur.pit(), row.pos());
1729 bool TextMetrics::cursorEnd(Cursor & cur)
1731 LASSERT(text_ == cur.text(), /**/);
1732 // if not on the last row of the par, put the cursor before
1733 // the final space exept if I have a spanning inset or one string
1734 // is so long that we force a break.
1735 pos_type end = cur.textRow().endpos();
1737 // empty text, end-1 is no valid position
1739 bool boundary = false;
1740 if (end != cur.lastpos()) {
1741 if (!cur.paragraph().isLineSeparator(end-1)
1742 && !cur.paragraph().isNewline(end-1))
1747 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1751 void TextMetrics::deleteLineForward(Cursor & cur)
1753 LASSERT(text_ == cur.text(), /**/);
1754 if (cur.lastpos() == 0) {
1755 // Paragraph is empty, so we just go forward
1756 text_->cursorForward(cur);
1759 cur.setSelection(true); // to avoid deletion
1762 // What is this test for ??? (JMarc)
1763 if (!cur.selection())
1764 text_->deleteWordForward(cur);
1766 cap::cutSelection(cur, true, false);
1767 cur.checkBufferStructure();
1772 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1774 ParagraphList const & pars = text_->paragraphs();
1775 return row.endpos() >= pars[pit].size()
1776 && pit + 1 == pit_type(pars.size());
1780 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1782 return row.pos() == 0 && pit == 0;
1786 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1788 LASSERT(pit >= 0, /**/);
1789 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1790 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1794 int TextMetrics::leftMargin(int max_width,
1795 pit_type const pit, pos_type const pos) const
1797 ParagraphList const & pars = text_->paragraphs();
1799 LASSERT(pit >= 0, /**/);
1800 LASSERT(pit < int(pars.size()), /**/);
1801 Paragraph const & par = pars[pit];
1802 LASSERT(pos >= 0, /**/);
1803 LASSERT(pos <= par.size(), /**/);
1804 Buffer const & buffer = bv_->buffer();
1805 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1806 DocumentClass const & tclass = buffer.params().documentClass();
1807 Layout const & layout = par.layout();
1809 docstring parindent = layout.parindent;
1813 if (text_->isMainText(buffer))
1814 l_margin += bv_->leftMargin();
1816 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1817 tclass.leftmargin());
1819 if (par.getDepth() != 0) {
1820 // find the next level paragraph
1821 pit_type newpar = outerHook(pit, pars);
1822 if (newpar != pit_type(pars.size())) {
1823 if (pars[newpar].layout().isEnvironment()) {
1824 l_margin = leftMargin(max_width, newpar);
1826 if (tclass.isDefaultLayout(par.layout())
1827 || tclass.isPlainLayout(par.layout())) {
1828 if (pars[newpar].params().noindent())
1831 parindent = pars[newpar].layout().parindent;
1836 // This happens after sections in standard classes. The 1.3.x
1837 // code compared depths too, but it does not seem necessary
1839 if (tclass.isDefaultLayout(par.layout())
1840 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1843 FontInfo const labelfont = text_->labelFont(buffer, par);
1844 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1846 switch (layout.margintype) {
1847 case MARGIN_DYNAMIC:
1848 if (!layout.leftmargin.empty()) {
1849 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1852 if (!par.labelString().empty()) {
1853 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1854 l_margin += labelfont_metrics.width(par.labelString());
1855 l_margin += labelfont_metrics.width(layout.labelsep);
1859 case MARGIN_MANUAL: {
1860 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1861 // The width of an empty par, even with manual label, should be 0
1862 if (!par.empty() && pos >= par.beginOfBody()) {
1863 if (!par.getLabelWidthString().empty()) {
1864 docstring labstr = par.getLabelWidthString();
1865 l_margin += labelfont_metrics.width(labstr);
1866 l_margin += labelfont_metrics.width(layout.labelsep);
1872 case MARGIN_STATIC: {
1873 l_margin += theFontMetrics(buffer.params().getFont()).
1874 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1878 case MARGIN_FIRST_DYNAMIC:
1879 if (layout.labeltype == LABEL_MANUAL) {
1880 // if we are at position 0, we are never in the body
1881 if (pos > 0 && pos >= par.beginOfBody())
1882 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1884 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1886 // Special case to fix problems with
1888 || (layout.labeltype == LABEL_STATIC
1889 && layout.latextype == LATEX_ENVIRONMENT
1890 && !isFirstInSequence(pit, pars))) {
1891 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1892 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1893 && layout.labeltype != LABEL_BIBLIO
1894 && layout.labeltype !=
1895 LABEL_CENTERED_TOP_ENVIRONMENT) {
1896 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1897 l_margin += labelfont_metrics.width(layout.labelsep);
1898 l_margin += labelfont_metrics.width(par.labelString());
1902 case MARGIN_RIGHT_ADDRESS_BOX: {
1904 // ok, a terrible hack. The left margin depends on the widest
1905 // row in this paragraph.
1906 RowList::iterator rit = par.rows().begin();
1907 RowList::iterator end = par.rows().end();
1908 // FIXME: This is wrong.
1909 int minfill = max_width;
1910 for ( ; rit != end; ++rit)
1911 if (rit->fill() < minfill)
1912 minfill = rit->fill();
1913 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1914 l_margin += minfill;
1916 // also wrong, but much shorter.
1917 l_margin += max_width / 2;
1922 if (!par.params().leftIndent().zero())
1923 l_margin += par.params().leftIndent().inPixels(max_width);
1927 if (par.params().align() == LYX_ALIGN_LAYOUT)
1928 align = layout.align;
1930 align = par.params().align();
1932 // set the correct parindent
1934 && (layout.labeltype == LABEL_NO_LABEL
1935 || layout.labeltype == LABEL_TOP_ENVIRONMENT
1936 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1937 || (layout.labeltype == LABEL_STATIC
1938 && layout.latextype == LATEX_ENVIRONMENT
1939 && !isFirstInSequence(pit, pars)))
1940 && align == LYX_ALIGN_BLOCK
1941 && !par.params().noindent()
1942 // in some insets, paragraphs are never indented
1943 && !par.inInset().neverIndent()
1944 // display style insets are always centered, omit indentation
1947 && par.getInset(pos)->display())
1948 && (!(tclass.isDefaultLayout(par.layout())
1949 || tclass.isPlainLayout(par.layout()))
1950 || buffer.params().paragraph_separation == BufferParams::ParagraphIndentSeparation)
1953 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1961 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
1963 ParagraphMetrics const & pm = par_metrics_[pit];
1965 return pm.singleWidth(pos, displayFont(pit, pos));
1969 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1971 if (par_metrics_.empty())
1977 ParMetricsCache::iterator it = par_metrics_.begin();
1978 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1979 y -= it->second.ascent();
1980 for (; it != pm_end; ++it) {
1981 ParagraphMetrics const & pmi = it->second;
1983 pit_type const pit = it->first;
1984 // Save the paragraph position in the cache.
1985 it->second.setPosition(y);
1986 drawParagraph(pi, pit, x, y);
1992 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1994 BufferParams const & bparams = bv_->buffer().params();
1995 ParagraphMetrics const & pm = par_metrics_[pit];
1996 if (pm.rows().empty())
2000 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2001 int const ww = bv_->workHeight();
2002 size_t const nrows = pm.rows().size();
2004 Cursor const & cur = bv_->cursor();
2005 DocIterator sel_beg = cur.selectionBegin();
2006 DocIterator sel_end = cur.selectionEnd();
2007 bool selection = cur.selection()
2008 // This is our text.
2009 && cur.text() == text_
2010 // if the anchor is outside, this is not our selection
2011 && cur.anchor().text() == text_
2012 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2014 // We store the begin and end pos of the selection relative to this par
2015 DocIterator sel_beg_par = cur.selectionBegin();
2016 DocIterator sel_end_par = cur.selectionEnd();
2018 // We care only about visible selection.
2020 if (pit != sel_beg.pit()) {
2021 sel_beg_par.pit() = pit;
2022 sel_beg_par.pos() = 0;
2024 if (pit != sel_end.pit()) {
2025 sel_end_par.pit() = pit;
2026 sel_end_par.pos() = sel_end_par.lastpos();
2030 for (size_t i = 0; i != nrows; ++i) {
2032 Row const & row = pm.rows()[i];
2036 bool const inside = (y + row.descent() >= 0
2037 && y - row.ascent() < ww);
2038 // It is not needed to draw on screen if we are not inside.
2039 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2040 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2043 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2045 row.setSelection(-1, -1);
2047 // The row knows nothing about the paragraph, so we have to check
2048 // whether this row is the first or last and update the margins.
2049 if (row.selection()) {
2050 if (row.sel_beg == 0)
2051 row.begin_margin_sel = sel_beg.pit() < pit;
2052 if (row.sel_end == sel_end_par.lastpos())
2053 row.end_margin_sel = sel_end.pit() > pit;
2056 // Row signature; has row changed since last paint?
2057 row.setCrc(pm.computeRowSignature(row, bparams));
2058 bool row_has_changed = row.changed();
2060 // Don't paint the row if a full repaint has not been requested
2061 // and if it has not changed.
2062 if (!pi.full_repaint && !row_has_changed) {
2063 // Paint only the insets if the text itself is
2065 rp.paintOnlyInsets();
2070 // Clear background of this row if paragraph background was not
2071 // already cleared because of a full repaint.
2072 if (!pi.full_repaint && row_has_changed) {
2073 pi.pain.fillRectangle(x, y - row.ascent(),
2074 width(), row.height(), pi.background_color);
2077 if (row.selection())
2078 drawRowSelection(pi, x, row, cur, pit);
2080 // Instrumentation for testing row cache (see also
2082 if (lyxerr.debugging(Debug::PAINTING) && inside
2083 && (row.selection() || pi.full_repaint || row_has_changed)) {
2084 string const foreword = text_->isMainText(bv_->buffer()) ?
2085 "main text redraw " : "inset text redraw: ";
2086 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2087 << " row_selection=" << row.selection()
2088 << " full_repaint=" << pi.full_repaint
2089 << " row_has_changed=" << row_has_changed);
2092 // Backup full_repaint status and force full repaint
2093 // for inner insets as the Row has been cleared out.
2094 bool tmp = pi.full_repaint;
2095 pi.full_repaint = true;
2098 rp.paintChangeBar();
2105 // Restore full_repaint status.
2106 pi.full_repaint = tmp;
2108 // Re-enable screen drawing for future use of the painter.
2109 pi.pain.setDrawingEnabled(original_drawing_state);
2111 //LYXERR(Debug::PAINTING, ".");
2115 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
2116 Cursor const & curs, pit_type pit) const
2118 DocIterator beg = curs.selectionBegin();
2120 beg.pos() = row.sel_beg;
2122 DocIterator end = curs.selectionEnd();
2124 end.pos() = row.sel_end;
2126 bool const begin_boundary = beg.pos() >= row.endpos();
2127 bool const end_boundary = row.sel_end == row.endpos();
2129 Buffer & buffer = bv_->buffer();
2130 DocIterator cur = beg;
2131 cur.boundary(begin_boundary);
2132 int x1 = cursorX(beg.top(), begin_boundary);
2133 int x2 = cursorX(end.top(), end_boundary);
2134 int const y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
2135 int const y2 = y1 + row.height();
2137 int const rm = text_->isMainText(buffer) ? bv_->rightMargin() : 0;
2138 int const lm = text_->isMainText(buffer) ? bv_->leftMargin() : 0;
2141 if (row.begin_margin_sel) {
2142 if (text_->isRTL(buffer, beg.paragraph())) {
2143 pi.pain.fillRectangle(x + x1, y1, width() - rm - x1, y2 - y1,
2146 pi.pain.fillRectangle(x + lm, y1, x1 - lm, y2 - y1,
2151 if (row.end_margin_sel) {
2152 if (text_->isRTL(buffer, beg.paragraph())) {
2153 pi.pain.fillRectangle(x + lm, y1, x2 - lm, y2 - y1,
2156 pi.pain.fillRectangle(x + x2, y1, width() - rm - x2, y2 - y1,
2161 // if we are on a boundary from the beginning, it's probably
2162 // a RTL boundary and we jump to the other side directly as this
2163 // segement is 0-size and confuses the logic below
2165 cur.boundary(false);
2167 // go through row and draw from RTL boundary to RTL boundary
2169 bool drawNow = false;
2171 // simplified cursorForward code below which does not
2172 // descend into insets and which does not go into the
2173 // next line. Compare the logic with the original cursorForward
2175 // if left of boundary -> just jump to right side, but
2176 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2177 if (cur.boundary()) {
2178 cur.boundary(false);
2179 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2180 // in front of RTL boundary -> Stay on this side of the boundary
2181 // because: ab|cDDEEFFghi -> abc|DDEEFFghi
2190 if (cur.pos() == row.endpos())
2195 // the previous segment was just drawn, now the next starts
2196 x1 = cursorX(cur.top(), cur.boundary());
2199 if (!(cur < end) || drawNow) {
2200 x2 = cursorX(cur.top(), cur.boundary());
2201 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2204 // reset x1, so it is set again next round (which will be on the
2205 // right side of a boundary or at the selection end)
2212 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2213 Dimension & dim) const
2215 Cursor const & bvcur = cur.bv().cursor();
2217 // get word in front of cursor
2218 docstring word = text_->previousWord(bvcur.top());
2219 DocIterator wordStart = bvcur;
2220 wordStart.pos() -= word.length();
2222 // get position on screen of the word start and end
2223 Point lxy = cur.bv().getPos(wordStart, false);
2224 Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
2226 // calculate dimensions of the word
2227 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2228 dim.wid = abs(rxy.x_ - lxy.x_);
2230 // calculate position of word
2232 x = min(rxy.x_, lxy.x_);
2234 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2235 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2238 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2240 // ParagraphMetrics const & pm = par_metrics_[pit];
2241 // Row const & r = pm.rows()[row];
2247 int defaultRowHeight()
2249 return int(theFontMetrics(sane_font).maxHeight() * 1.2);