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"
32 #include "InsetList.h"
36 #include "MetricsInfo.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "rowpainter.h"
41 #include "TextClass.h"
43 #include "WordLangTuple.h"
45 #include "insets/InsetText.h"
47 #include "mathed/MacroTable.h"
48 #include "mathed/MathMacroTemplate.h"
50 #include "frontends/FontMetrics.h"
51 #include "frontends/Painter.h"
53 #include "support/debug.h"
54 #include "support/docstring_list.h"
55 #include "support/lassert.h"
64 using frontend::FontMetrics;
66 static int numberOfSeparators(Paragraph const & par, Row const & row)
68 pos_type const first = max(row.pos(), par.beginOfBody());
69 pos_type const last = row.endpos() - 1;
71 for (pos_type p = first; p < last; ++p) {
72 if (par.isSeparator(p))
79 static int numberOfLabelHfills(Paragraph const & par, Row const & row)
81 pos_type last = row.endpos() - 1;
82 pos_type first = row.pos();
84 // hfill *DO* count at the beginning of paragraphs!
86 while (first < last && par.isHfill(first))
90 last = min(last, par.beginOfBody());
92 for (pos_type p = first; p < last; ++p) {
100 static int numberOfHfills(Paragraph const & par, Row const & row)
102 pos_type const last = row.endpos();
103 pos_type first = row.pos();
105 // hfill *DO* count at the beginning of paragraphs!
107 while (first < last && par.isHfill(first))
111 first = max(first, par.beginOfBody());
114 for (pos_type p = first; p < last; ++p) {
122 /////////////////////////////////////////////////////////////////////
126 /////////////////////////////////////////////////////////////////////
129 TextMetrics::TextMetrics(BufferView * bv, Text * text)
130 : bv_(bv), text_(text)
133 max_width_ = bv_->workWidth();
134 dim_.wid = max_width_;
138 //text_->updateLabels(bv->buffer());
142 bool TextMetrics::contains(pit_type pit) const
144 return par_metrics_.find(pit) != par_metrics_.end();
148 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
150 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
155 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
157 ParMetricsCache::const_iterator it = par_metrics_.begin();
158 return make_pair(it->first, &it->second);
162 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
164 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
165 return make_pair(it->first, &it->second);
169 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
171 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
172 if (pmc_it == par_metrics_.end()) {
173 pmc_it = par_metrics_.insert(
174 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
176 if (pmc_it->second.rows().empty() && redo)
178 return pmc_it->second;
182 int TextMetrics::parPosition(pit_type pit) const
184 if (pit < par_metrics_.begin()->first)
186 if (pit > par_metrics_.rbegin()->first)
189 return par_metrics_[pit].position();
193 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
195 LASSERT(mi.base.textwidth > 0, /**/);
196 max_width_ = mi.base.textwidth;
197 // backup old dimension.
198 Dimension const old_dim = dim_;
201 dim_.wid = min_width;
202 pit_type const npar = text_->paragraphs().size();
204 // If there is more than one row, expand the text to
205 // the full allowable width.
206 dim_.wid = max_width_;
208 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
209 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
211 bool changed = false;
213 for (pit_type pit = 0; pit != npar; ++pit) {
214 changed |= redoParagraph(pit);
215 ParagraphMetrics const & pm = par_metrics_[pit];
217 if (dim_.wid < pm.width())
218 dim_.wid = pm.width();
221 dim_.asc = par_metrics_[0].ascent();
222 dim_.des = h - dim_.asc;
223 //lyxerr << "dim_.wid " << dim_.wid << endl;
224 //lyxerr << "dim_.asc " << dim_.asc << endl;
225 //lyxerr << "dim_.des " << dim_.des << endl;
227 changed |= dim_ != old_dim;
233 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
235 return main_text_? pm.rightMargin(*bv_) : 0;
239 int TextMetrics::rightMargin(pit_type const pit) const
241 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
245 void TextMetrics::applyOuterFont(Font & font) const
248 lf.fontInfo().reduce(bv_->buffer().params().getFont().fontInfo());
249 lf.fontInfo().realize(font.fontInfo());
250 lf.setLanguage(font.language());
255 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
257 LASSERT(pos >= 0, /**/);
259 ParagraphList const & pars = text_->paragraphs();
260 Paragraph const & par = pars[pit];
261 Layout const & layout = par.layout();
262 Buffer const & buffer = bv_->buffer();
264 BufferParams const & params = buffer.params();
265 pos_type const body_pos = par.beginOfBody();
267 // We specialize the 95% common case:
268 if (!par.getDepth()) {
269 Font f = par.getFontSettings(params, pos);
270 if (!text_->isMainText())
272 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
274 FontInfo const & lf = lab ? layout.labelfont : layout.font;
275 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
277 // In case the default family has been customized
278 if (lf.family() == INHERIT_FAMILY)
279 rlf.setFamily(params.getFont().fontInfo().family());
280 f.fontInfo().realize(rlf);
284 // The uncommon case need not be optimized as much
285 FontInfo const & layoutfont = pos < body_pos ?
286 layout.labelfont : layout.font;
288 Font font = par.getFontSettings(params, pos);
289 font.fontInfo().realize(layoutfont);
291 if (!text_->isMainText())
292 applyOuterFont(font);
294 // Realize against environment font information
295 // NOTE: the cast to pit_type should be removed when pit_type
296 // changes to a unsigned integer.
297 if (pit < pit_type(pars.size()))
298 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
300 // Realize with the fonts of lesser depth.
301 font.fontInfo().realize(params.getFont().fontInfo());
307 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
309 if (!lyxrc.rtl_support || !sl.text())
313 if (boundary && sl.pos() > 0)
316 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
320 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
322 if (!lyxrc.rtl_support)
325 // no RTL boundary at paragraph start
329 Font const & left_font = displayFont(pit, pos - 1);
331 return isRTLBoundary(pit, pos, left_font);
335 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
336 Font const & font) const
338 if (!lyxrc.rtl_support)
341 // no RTL boundary at paragraph start
345 ParagraphMetrics & pm = par_metrics_[pit];
346 // no RTL boundary in empty paragraph
347 if (pm.rows().empty())
350 pos_type endpos = pm.getRow(pos - 1, false).endpos();
351 pos_type startpos = pm.getRow(pos, false).pos();
352 // no RTL boundary at line start:
353 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
355 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
358 Paragraph const & par = text_->getPar(pit);
359 bool left = font.isVisibleRightToLeft();
361 if (pos == par.size())
362 right = par.isRTL(bv_->buffer().params());
364 right = displayFont(pit, pos).isVisibleRightToLeft();
366 // no RTL boundary at line break:
367 // abc|\n -> move right -> abc\n (and not: abc\n|
369 if (startpos == pos && endpos == pos && endpos != par.size()
370 && (par.isNewline(pos - 1)
371 || par.isLineSeparator(pos - 1)
372 || par.isSeparator(pos - 1)))
375 return left != right;
379 bool TextMetrics::redoParagraph(pit_type const pit)
381 Paragraph & par = text_->getPar(pit);
382 // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
383 // redoParagraph() recursively inside parMetrics.
384 Dimension old_dim = parMetrics(pit, false).dim();
385 ParagraphMetrics & pm = par_metrics_[pit];
388 Buffer & buffer = bv_->buffer();
389 main_text_ = (text_ == &buffer.text());
390 bool changed = false;
392 // FIXME: This check ought to be done somewhere else. It is the reason
393 // why text_ is not const. But then, where else to do it?
394 // Well, how can you end up with either (a) a biblio environment that
395 // has no InsetBibitem or (b) a biblio environment with more than one
396 // InsetBibitem? I think the answer is: when paragraphs are merged;
397 // when layout is set; when material is pasted.
398 int const moveCursor = par.checkBiblio(buffer);
400 const_cast<Cursor &>(bv_->cursor()).posForward();
401 else if (moveCursor < 0) {
402 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
403 if (cursor.pos() >= -moveCursor)
404 cursor.posBackward();
407 // Optimisation: this is used in the next two loops
408 // so better to calculate that once here.
409 int const right_margin = rightMargin(pm);
411 // iterator pointing to paragraph to resolve macros
412 DocIterator parPos = text_->macrocontextPosition();
416 LYXERR(Debug::INFO, "MacroContext not initialised!"
417 << " Going through the buffer again and hope"
418 << " the context is better then.");
419 bv_->buffer().updateLabels();
420 parPos = text_->macrocontextPosition();
421 LASSERT(!parPos.empty(), /**/);
426 // FIXME: We should always use getFont(), see documentation of
427 // noFontChange() in Inset.h.
428 Font const bufferfont = buffer.params().getFont();
429 InsetList::const_iterator ii = par.insetList().begin();
430 InsetList::const_iterator iend = par.insetList().end();
431 for (; ii != iend; ++ii) {
432 // position already initialized?
433 if (!parPos.empty()) {
434 parPos.pos() = ii->pos;
436 // A macro template would normally not be visible
437 // by itself. But the tex macro semantics allow
438 // recursion, so we artifically take the context
439 // after the macro template to simulate this.
440 if (ii->inset->lyxCode() == MATHMACRO_CODE)
444 // do the metric calculation
446 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
448 Font const & font = ii->inset->noFontChange() ?
449 bufferfont : displayFont(pit, ii->pos);
450 MacroContext mc(buffer, parPos);
451 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
452 ii->inset->metrics(mi, dim);
453 Dimension const old_dim = pm.insetDimension(ii->inset);
454 if (old_dim != dim) {
455 pm.setInsetDimension(ii->inset, dim);
460 par.setBeginOfBody();
462 size_t row_index = 0;
463 // maximum pixel width of a row
464 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
467 pos_type end = rowBreakPoint(width, pit, first);
468 if (row_index || end < 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_;
474 dim = rowHeight(pit, first, end);
475 dim.wid = rowWidth(right_margin, pit, first, end);
476 if (row_index == pm.rows().size())
477 pm.rows().push_back(Row());
478 Row & row = pm.rows()[row_index];
479 row.setChanged(false);
482 row.setDimension(dim);
483 int const max_row_width = max(dim_.wid, dim.wid);
484 computeRowMetrics(pit, row, max_row_width);
488 pm.dim().wid = max(pm.dim().wid, dim.wid);
489 pm.dim().des += dim.height();
490 } while (first < par.size());
492 if (row_index < pm.rows().size())
493 pm.rows().resize(row_index);
495 // Make sure that if a par ends in newline, there is one more row
497 if (first > 0 && par.isNewline(first - 1)) {
498 Dimension dim = rowHeight(pit, first, first);
499 dim.wid = rowWidth(right_margin, pit, first, first);
500 if (row_index == pm.rows().size())
501 pm.rows().push_back(Row());
502 Row & row = pm.rows()[row_index];
503 row.setChanged(false);
506 row.setDimension(dim);
507 int const max_row_width = max(dim_.wid, dim.wid);
508 computeRowMetrics(pit, row, max_row_width);
509 pm.dim().des += dim.height();
512 pm.dim().asc += pm.rows()[0].ascent();
513 pm.dim().des -= pm.rows()[0].ascent();
515 changed |= old_dim.height() != pm.dim().height();
521 void TextMetrics::computeRowMetrics(pit_type const pit,
522 Row & row, int width) const
527 Paragraph const & par = text_->getPar(pit);
529 double w = width - row.width();
530 // FIXME: put back this assertion when the crash on new doc is solved.
531 //LASSERT(w >= 0, /**/);
533 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
534 //lyxerr << "row.width() " << row.width() << endl;
535 //lyxerr << "w " << w << endl;
537 bool const is_rtl = text_->isRTL(par);
539 row.x = rightMargin(pit);
541 row.x = leftMargin(max_width_, pit, row.pos());
543 // is there a manual margin with a manual label
544 Layout const & layout = par.layout();
546 if (layout.margintype == MARGIN_MANUAL
547 && layout.labeltype == LABEL_MANUAL) {
548 /// We might have real hfills in the label part
549 int nlh = numberOfLabelHfills(par, row);
551 // A manual label par (e.g. List) has an auto-hfill
552 // between the label text and the body of the
554 // But we don't want to do this auto hfill if the par
559 if (nlh && !par.getLabelWidthString().empty())
560 row.label_hfill = labelFill(pit, row) / double(nlh);
564 // are there any hfills in the row?
565 if (int const nh = numberOfHfills(par, row)) {
567 hfill = w / double(nh);
568 // we don't have to look at the alignment if it is ALIGN_LEFT and
569 // if the row is already larger then the permitted width as then
570 // we force the LEFT_ALIGN'edness!
571 } else if (int(row.width()) < max_width_) {
572 // is it block, flushleft or flushright?
573 // set x how you need it
575 if (par.params().align() == LYX_ALIGN_LAYOUT)
576 align = layout.align;
578 align = par.params().align();
580 // handle alignment inside tabular cells
581 Inset const & owner = text_->inset();
582 switch (owner.contentAlignment()) {
583 case LYX_ALIGN_CENTER:
585 case LYX_ALIGN_RIGHT:
586 if (align == LYX_ALIGN_NONE
587 || align == LYX_ALIGN_BLOCK)
588 align = owner.contentAlignment();
591 // unchanged (use align)
595 // Display-style insets should always be on a centered row
596 if (Inset const * inset = par.getInset(row.pos())) {
597 switch (inset->display()) {
598 case Inset::AlignLeft:
599 align = LYX_ALIGN_BLOCK;
601 case Inset::AlignCenter:
602 align = LYX_ALIGN_CENTER;
605 // unchanged (use align)
607 case Inset::AlignRight:
608 align = LYX_ALIGN_RIGHT;
614 case LYX_ALIGN_BLOCK: {
615 int const ns = numberOfSeparators(par, row);
616 bool disp_inset = false;
617 if (row.endpos() < par.size()) {
618 Inset const * in = par.getInset(row.endpos());
620 disp_inset = in->display();
622 // If we have separators, this is not the last row of a
623 // par, does not end in newline, and is not row above a
624 // display inset... then stretch it
626 && row.endpos() < par.size()
627 && !par.isNewline(row.endpos() - 1)
630 row.separator = w / ns;
631 //lyxerr << "row.separator " << row.separator << endl;
632 //lyxerr << "ns " << ns << endl;
638 case LYX_ALIGN_RIGHT:
641 case LYX_ALIGN_CENTER:
648 pos_type body_pos = par.beginOfBody();
649 pos_type end = row.endpos();
652 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
654 row.x += theFontMetrics(text_->labelFont(par)).
655 width(layout.labelsep);
657 row.x += row.label_hfill;
661 pos_type const endpos = row.endpos();
662 pos_type body_pos = par.beginOfBody();
664 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
667 ParagraphMetrics & pm = par_metrics_[pit];
668 InsetList::const_iterator ii = par.insetList().begin();
669 InsetList::const_iterator iend = par.insetList().end();
670 for ( ; ii != iend; ++ii) {
671 if (ii->pos >= endpos || ii->pos < row.pos()
672 || (ii->inset->lyxCode() != SPACE_CODE ||
673 !ii->inset->isStretchableSpace()))
675 Dimension dim = row.dimension();
676 if (pm.hfillExpansion(row, ii->pos))
677 dim.wid = int(ii->pos >= body_pos ?
678 max(hfill, 5.0) : row.label_hfill);
681 // Cache the inset dimension.
682 bv_->coordCache().insets().add(ii->inset, dim);
683 pm.setInsetDimension(ii->inset, dim);
688 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
690 Paragraph const & par = text_->getPar(pit);
692 pos_type last = par.beginOfBody();
693 LASSERT(last > 0, /**/);
695 // -1 because a label ends with a space that is in the label
698 // a separator at this end does not count
699 if (par.isLineSeparator(last))
703 for (pos_type i = row.pos(); i <= last; ++i)
704 w += singleWidth(pit, i);
706 docstring const & label = par.params().labelWidthString();
710 FontMetrics const & fm
711 = theFontMetrics(text_->labelFont(par));
713 return max(0, fm.width(label) - w);
717 // this needs special handling - only newlines count as a break point
718 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
720 pos_type const end = par.size();
723 if (par.isNewline(i))
730 int TextMetrics::labelEnd(pit_type const pit) const
732 // labelEnd is only needed if the layout fills a flushleft label.
733 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
735 // return the beginning of the body
736 return leftMargin(max_width_, pit);
742 * Calling Text::getFont is slow. While rebreaking we scan a
743 * paragraph from left to right calling getFont for every char. This
744 * simple class address this problem by hidding an optimization trick
745 * (not mine btw -AB): the font is reused in the whole font span. The
746 * class handles transparently the "hidden" (not part of the fontlist)
747 * label font (as getFont does).
753 FontIterator(TextMetrics const & tm,
754 Paragraph const & par, pit_type pit, pos_type pos)
755 : tm_(tm), par_(par), pit_(pit), pos_(pos),
756 font_(tm.displayFont(pit, pos)),
757 endspan_(par.fontSpan(pos).last),
758 bodypos_(par.beginOfBody())
762 Font const & operator*() const { return font_; }
765 FontIterator & operator++()
768 if (pos_ > endspan_ || pos_ == bodypos_) {
769 font_ = tm_.displayFont(pit_, pos_);
770 endspan_ = par_.fontSpan(pos_).last;
776 Font * operator->() { return &font_; }
780 TextMetrics const & tm_;
782 Paragraph const & par_;
797 pos_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
800 ParagraphMetrics const & pm = par_metrics_[pit];
801 Paragraph const & par = text_->getPar(pit);
802 pos_type const end = par.size();
803 if (pos == end || width < 0)
806 Layout const & layout = par.layout();
808 if (layout.margintype == MARGIN_RIGHT_ADDRESS_BOX)
809 return addressBreakPoint(pos, par);
811 pos_type const body_pos = par.beginOfBody();
813 // check for possible inline completion
814 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
815 pos_type inlineCompletionLPos = -1;
816 if (inlineCompletionPos.inTexted()
817 && inlineCompletionPos.text() == text_
818 && inlineCompletionPos.pit() == pit) {
819 // draw logically behind the previous character
820 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
823 // Now we iterate through until we reach the right margin
824 // or the end of the par, then choose the possible break
827 int label_end = labelEnd(pit);
828 int const left = leftMargin(max_width_, pit, pos);
831 // pixel width since last breakpoint
834 docstring const s(1, char_type(0x00B6));
836 int par_marker_width = theFontMetrics(f).width(s);
838 FontIterator fi = FontIterator(*this, par, pit, pos);
839 pos_type point = end;
841 for ( ; i < end; ++i, ++fi) {
842 int thiswidth = pm.singleWidth(i, *fi);
844 if (i == end - 1 && lyxrc.paragraph_markers)
845 // enlarge the last character to hold the
847 thiswidth += par_marker_width;
849 // add inline completion width
850 if (inlineCompletionLPos == i) {
851 docstring const & completion = bv_->inlineCompletion();
852 if (completion.length() > 0)
853 thiswidth += theFontMetrics(*fi).width(completion);
856 // add the auto-hfill from label end to the body
857 if (body_pos && i == body_pos) {
858 FontMetrics const & fm = theFontMetrics(
859 text_->labelFont(par));
860 int add = fm.width(layout.labelsep);
861 if (par.isLineSeparator(i - 1))
862 add -= singleWidth(pit, i - 1);
864 add = max(add, label_end - x);
869 chunkwidth += thiswidth;
871 // break before a character that will fall off
872 // the right of the row
874 // if no break before, break here
875 if (point == end || chunkwidth >= width - left) {
881 // exit on last registered breakpoint:
885 if (par.isNewline(i)) {
889 Inset const * inset = 0;
892 if ((inset = par.getInset(i + 1)) && inset->display()) {
897 if ((inset = par.getInset(i)) && inset->display()) {
903 inset = par.getInset(i);
904 if (!inset || inset->isChar()) {
905 // some insets are line separators too
906 if (par.isLineSeparator(i)) {
907 // register breakpoint:
914 // maybe found one, but the par is short enough.
915 if (i == end && x < width)
918 // manual labels cannot be broken in LaTeX. But we
919 // want to make our on-screen rendering of footnotes
921 if (body_pos && point < body_pos)
928 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
929 pos_type const first, pos_type const end) const
931 // get the pure distance
932 ParagraphMetrics const & pm = par_metrics_[pit];
933 Paragraph const & par = text_->getPar(pit);
934 int w = leftMargin(max_width_, pit, first);
935 int label_end = labelEnd(pit);
937 // check for possible inline completion
938 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
939 pos_type inlineCompletionLPos = -1;
940 if (inlineCompletionPos.inTexted()
941 && inlineCompletionPos.text() == text_
942 && inlineCompletionPos.pit() == pit) {
943 // draw logically behind the previous character
944 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
947 pos_type const body_pos = par.beginOfBody();
951 FontIterator fi = FontIterator(*this, par, pit, i);
952 for ( ; i < end; ++i, ++fi) {
953 if (body_pos > 0 && i == body_pos) {
954 FontMetrics const & fm = theFontMetrics(
955 text_->labelFont(par));
956 w += fm.width(par.layout().labelsep);
957 if (par.isLineSeparator(i - 1))
958 w -= singleWidth(pit, i - 1);
959 w = max(w, label_end);
962 // a line separator at the end of a line (but not at the end of a
963 // paragraph) will not be drawn and should therefore not count for
965 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
966 w += pm.singleWidth(i, *fi);
968 // add inline completion width
969 if (inlineCompletionLPos == i) {
970 docstring const & completion = bv_->inlineCompletion();
971 if (completion.length() > 0)
972 w += theFontMetrics(*fi).width(completion);
977 // count the paragraph end marker.
978 if (end == par.size() && lyxrc.paragraph_markers) {
979 docstring const s(1, char_type(0x00B6));
981 w += theFontMetrics(f).width(s);
984 if (body_pos > 0 && body_pos >= end) {
985 FontMetrics const & fm = theFontMetrics(
986 text_->labelFont(par));
987 w += fm.width(par.layout().labelsep);
988 if (end > 0 && par.isLineSeparator(end - 1))
989 w -= singleWidth(pit, end - 1);
990 w = max(w, label_end);
993 return w + right_margin;
997 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
998 pos_type const end, bool topBottomSpace) const
1000 Paragraph const & par = text_->getPar(pit);
1001 // get the maximum ascent and the maximum descent
1002 double layoutasc = 0;
1003 double layoutdesc = 0;
1004 double const dh = defaultRowHeight();
1006 // ok, let us initialize the maxasc and maxdesc value.
1007 // Only the fontsize count. The other properties
1008 // are taken from the layoutfont. Nicer on the screen :)
1009 Layout const & layout = par.layout();
1011 // as max get the first character of this row then it can
1012 // increase but not decrease the height. Just some point to
1013 // start with so we don't have to do the assignment below too
1015 Buffer const & buffer = bv_->buffer();
1016 Font font = displayFont(pit, first);
1017 FontSize const tmpsize = font.fontInfo().size();
1018 font.fontInfo() = text_->layoutFont(pit);
1019 FontSize const size = font.fontInfo().size();
1020 font.fontInfo().setSize(tmpsize);
1022 FontInfo labelfont = text_->labelFont(par);
1024 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1025 FontMetrics const & fontmetrics = theFontMetrics(font);
1027 // these are minimum values
1028 double const spacing_val = layout.spacing.getValue()
1029 * text_->spacing(par);
1030 //lyxerr << "spacing_val = " << spacing_val << endl;
1031 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1032 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1034 // insets may be taller
1035 ParagraphMetrics const & pm = par_metrics_[pit];
1036 InsetList::const_iterator ii = par.insetList().begin();
1037 InsetList::const_iterator iend = par.insetList().end();
1038 for ( ; ii != iend; ++ii) {
1039 if (ii->pos >= first && ii->pos < end) {
1040 Dimension const & dim = pm.insetDimension(ii->inset);
1041 maxasc = max(maxasc, dim.ascent());
1042 maxdesc = max(maxdesc, dim.descent());
1046 // Check if any custom fonts are larger (Asger)
1047 // This is not completely correct, but we can live with the small,
1048 // cosmetic error for now.
1052 par.highestFontInRange(first, end, size);
1053 if (maxsize > font.fontInfo().size()) {
1054 // use standard paragraph font with the maximal size
1055 FontInfo maxfont = font.fontInfo();
1056 maxfont.setSize(maxsize);
1057 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1058 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1059 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1062 // This is nicer with box insets:
1066 ParagraphList const & pars = text_->paragraphs();
1067 Inset const & inset = text_->inset();
1069 // is it a top line?
1070 if (first == 0 && topBottomSpace) {
1071 BufferParams const & bufparams = buffer.params();
1072 // some parskips VERY EASY IMPLEMENTATION
1073 if (bufparams.paragraph_separation
1074 == BufferParams::ParagraphSkipSeparation
1075 && inset.lyxCode() != ERT_CODE
1076 && inset.lyxCode() != LISTINGS_CODE
1078 && ((layout.isParagraph() && par.getDepth() == 0)
1079 || (pars[pit - 1].layout().isParagraph()
1080 && pars[pit - 1].getDepth() == 0)))
1082 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1085 if (par.params().startOfAppendix())
1086 maxasc += int(3 * dh);
1088 // This is special code for the chapter, since the label of this
1089 // layout is printed in an extra row
1090 if (layout.counter == "chapter"
1091 && !par.params().labelString().empty()) {
1092 labeladdon = int(labelfont_metrics.maxHeight()
1093 * layout.spacing.getValue()
1094 * text_->spacing(par));
1097 // special code for the top label
1098 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1099 || layout.labeltype == LABEL_BIBLIO
1100 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1101 && text_->isFirstInSequence(pit)
1102 && !par.labelString().empty())
1105 labelfont_metrics.maxHeight()
1106 * layout.spacing.getValue()
1107 * text_->spacing(par)
1108 + (layout.topsep + layout.labelbottomsep) * dh);
1111 // Add the layout spaces, for example before and after
1112 // a section, or between the items of a itemize or enumerate
1115 pit_type prev = text_->depthHook(pit, par.getDepth());
1116 Paragraph const & prevpar = pars[prev];
1118 && prevpar.layout() == layout
1119 && prevpar.getDepth() == par.getDepth()
1120 && prevpar.getLabelWidthString()
1121 == par.getLabelWidthString()) {
1122 layoutasc = layout.itemsep * dh;
1123 } else if (pit != 0 || first != 0) {
1124 if (layout.topsep > 0)
1125 layoutasc = layout.topsep * dh;
1128 prev = text_->outerHook(pit);
1129 if (prev != pit_type(pars.size())) {
1130 maxasc += int(pars[prev].layout().parsep * dh);
1131 } else if (pit != 0) {
1132 Paragraph const & prevpar = pars[pit - 1];
1133 if (prevpar.getDepth() != 0 ||
1134 prevpar.layout() == layout) {
1135 maxasc += int(layout.parsep * dh);
1140 // is it a bottom line?
1141 if (end >= par.size() && topBottomSpace) {
1142 // add the layout spaces, for example before and after
1143 // a section, or between the items of a itemize or enumerate
1145 pit_type nextpit = pit + 1;
1146 if (nextpit != pit_type(pars.size())) {
1147 pit_type cpit = pit;
1151 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1152 usual = pars[cpit].layout().bottomsep * dh;
1153 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1154 if (pars[cpit].layout() != pars[nextpit].layout()
1155 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1157 unusual = pars[cpit].layout().bottomsep * dh;
1159 layoutdesc = max(unusual, usual);
1160 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1161 if (pars[cpit].layout() != pars[nextpit].layout()
1162 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1163 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1168 // incalculate the layout spaces
1169 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1170 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1172 // FIXME: the correct way is to do the following is to move the
1173 // following code in another method specially tailored for the
1174 // main Text. The following test is thus bogus.
1175 // Top and bottom margin of the document (only at top-level)
1176 if (main_text_ && topBottomSpace) {
1177 if (pit == 0 && first == 0)
1179 if (pit + 1 == pit_type(pars.size()) &&
1180 end == par.size() &&
1181 !(end > 0 && par.isNewline(end - 1)))
1185 return Dimension(0, maxasc + labeladdon, maxdesc);
1189 // x is an absolute screen coord
1190 // returns the column near the specified x-coordinate of the row
1191 // x is set to the real beginning of this column
1192 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1193 Row const & row, int & x, bool & boundary) const
1195 Buffer const & buffer = bv_->buffer();
1197 /// For the main Text, it is possible that this pit is not
1198 /// yet in the CoordCache when moving cursor up.
1199 /// x Paragraph coordinate is always 0 for main text anyway.
1200 int const xo = origin_.x_;
1202 Paragraph const & par = text_->getPar(pit);
1204 bidi.computeTables(par, buffer, row);
1206 pos_type vc = row.pos();
1207 pos_type end = row.endpos();
1209 Layout const & layout = par.layout();
1211 bool left_side = false;
1213 pos_type body_pos = par.beginOfBody();
1215 double tmpx = row.x;
1216 double last_tmpx = tmpx;
1219 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1222 // check for empty row
1228 while (vc < end && tmpx <= x) {
1229 c = bidi.vis2log(vc);
1231 if (body_pos > 0 && c == body_pos - 1) {
1232 FontMetrics const & fm = theFontMetrics(
1233 text_->labelFont(par));
1234 tmpx += row.label_hfill + fm.width(layout.labelsep);
1235 if (par.isLineSeparator(body_pos - 1))
1236 tmpx -= singleWidth(pit, body_pos - 1);
1239 tmpx += singleWidth(pit, c);
1240 if (par.isSeparator(c) && c >= body_pos)
1241 tmpx += row.separator;
1245 if ((tmpx + last_tmpx) / 2 > x) {
1250 LASSERT(vc <= end, /**/); // This shouldn't happen.
1253 // This (rtl_support test) is not needed, but gives
1254 // some speedup if rtl_support == false
1255 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1257 // If lastrow is false, we don't need to compute
1258 // the value of rtl.
1259 bool const rtl = lastrow ? text_->isRTL(par) : false;
1261 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1262 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1263 if (!par.isNewline(end - 1))
1265 } else if (vc == row.pos()) {
1266 c = bidi.vis2log(vc);
1267 if (bidi.level(c) % 2 == 1)
1270 c = bidi.vis2log(vc - 1);
1271 bool const rtl = (bidi.level(c) % 2 == 1);
1272 if (left_side == rtl) {
1274 boundary = isRTLBoundary(pit, c);
1278 // I believe this code is not needed anymore (Jug 20050717)
1280 // The following code is necessary because the cursor position past
1281 // the last char in a row is logically equivalent to that before
1282 // the first char in the next row. That's why insets causing row
1283 // divisions -- Newline and display-style insets -- must be treated
1284 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1285 // Newline inset, air gap below:
1286 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1287 if (bidi.level(end -1) % 2 == 0)
1288 tmpx -= singleWidth(pit, end - 1);
1290 tmpx += singleWidth(pit, end - 1);
1294 // Air gap above display inset:
1295 if (row.pos() < end && c >= end && end < par.size()
1296 && par.isInset(end) && par.getInset(end)->display()) {
1299 // Air gap below display inset:
1300 if (row.pos() < end && c >= end && par.isInset(end - 1)
1301 && par.getInset(end - 1)->display()) {
1307 pos_type const col = c - row.pos();
1309 if (!c || end == par.size())
1312 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1317 return min(col, end - 1 - row.pos());
1321 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1323 // We play safe and use parMetrics(pit) to make sure the
1324 // ParagraphMetrics will be redone and OK to use if needed.
1325 // Otherwise we would use an empty ParagraphMetrics in
1326 // upDownInText() while in selection mode.
1327 ParagraphMetrics const & pm = parMetrics(pit);
1329 LASSERT(row < int(pm.rows().size()), /**/);
1331 Row const & r = pm.rows()[row];
1332 return r.pos() + getColumnNearX(pit, r, x, bound);
1336 void TextMetrics::newParMetricsDown()
1338 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1339 pit_type const pit = last.first + 1;
1340 if (pit == int(text_->paragraphs().size()))
1343 // do it and update its position.
1345 par_metrics_[pit].setPosition(last.second.position()
1346 + last.second.descent() + par_metrics_[pit].ascent());
1350 void TextMetrics::newParMetricsUp()
1352 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1353 if (first.first == 0)
1356 pit_type const pit = first.first - 1;
1357 // do it and update its position.
1359 par_metrics_[pit].setPosition(first.second.position()
1360 - first.second.ascent() - par_metrics_[pit].descent());
1363 // y is screen coordinate
1364 pit_type TextMetrics::getPitNearY(int y)
1366 LASSERT(!text_->paragraphs().empty(), return -1);
1367 LASSERT(!par_metrics_.empty(), return -1);
1368 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1370 // look for highest numbered paragraph with y coordinate less than given y
1373 ParMetricsCache::const_iterator it = par_metrics_.begin();
1374 ParMetricsCache::const_iterator et = par_metrics_.end();
1375 ParMetricsCache::const_iterator last = et; last--;
1377 ParagraphMetrics const & pm = it->second;
1379 if (y < it->second.position() - int(pm.ascent())) {
1380 // We are looking for a position that is before the first paragraph in
1381 // the cache (which is in priciple off-screen, that is before the
1384 // We are already at the first paragraph in the inset.
1386 // OK, this is the paragraph we are looking for.
1387 pit = it->first - 1;
1392 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1394 if (y >= last->second.position() + int(pm_last.descent())) {
1395 // We are looking for a position that is after the last paragraph in
1396 // the cache (which is in priciple off-screen), that is before the
1398 pit = last->first + 1;
1399 if (pit == int(text_->paragraphs().size()))
1400 // We are already at the last paragraph in the inset.
1402 // OK, this is the paragraph we are looking for.
1403 newParMetricsDown();
1407 for (; it != et; ++it) {
1408 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1409 << " y: " << it->second.position());
1411 ParagraphMetrics const & pm = par_metrics_[it->first];
1413 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1415 yy = it->second.position();
1419 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1425 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1426 bool assert_in_view, bool up)
1428 ParagraphMetrics const & pm = par_metrics_[pit];
1430 int yy = pm.position() - pm.ascent();
1431 LASSERT(!pm.rows().empty(), /**/);
1432 RowList::const_iterator rit = pm.rows().begin();
1433 RowList::const_iterator rlast = pm.rows().end();
1435 for (; rit != rlast; yy += rit->height(), ++rit)
1436 if (yy + rit->height() > y)
1439 if (assert_in_view && yy + rit->height() != y) {
1441 if (rit != pm.rows().begin()) {
1444 } else if (pit != 0) {
1447 ParagraphMetrics const & pm2 = par_metrics_[pit];
1448 rit = pm2.rows().end();
1454 y = yy + rit->height();
1456 } else if (pit != int(par_metrics_.size())) {
1458 newParMetricsDown();
1459 ParagraphMetrics const & pm2 = par_metrics_[pit];
1460 rit = pm2.rows().begin();
1469 // x,y are absolute screen coordinates
1470 // sets cursor recursively descending into nested editable insets
1471 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1472 bool assert_in_view, bool up)
1474 if (lyxerr.debugging(Debug::WORKAREA)) {
1475 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1476 cur.bv().coordCache().dump();
1478 pit_type pit = getPitNearY(y);
1479 LASSERT(pit != -1, return 0);
1481 int yy = y; // is modified by getPitAndRowNearY
1482 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1485 int xx = x; // is modified by getColumnNearX
1486 pos_type const pos = row.pos()
1487 + getColumnNearX(pit, row, xx, bound);
1490 cur.boundary(bound);
1493 // try to descend into nested insets
1494 Inset * inset = checkInsetHit(x, yy);
1495 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1497 // Either we deconst editXY or better we move current_font
1498 // and real_current_font to Cursor
1499 // FIXME: what is needed now that current_font and real_current_font
1501 cur.setCurrentFont();
1505 ParagraphList const & pars = text_->paragraphs();
1506 Inset const * insetBefore = pos ? pars[pit].getInset(pos - 1) : 0;
1507 //Inset * insetBehind = pars[pit].getInset(pos);
1509 // This should be just before or just behind the
1510 // cursor position set above.
1511 LASSERT((pos != 0 && inset == insetBefore)
1512 || inset == pars[pit].getInset(pos), /**/);
1514 // Make sure the cursor points to the position before
1516 if (inset == insetBefore) {
1518 cur.boundary(false);
1521 // Try to descend recursively inside the inset.
1522 inset = inset->editXY(cur, x, yy);
1524 if (cur.top().text() == text_)
1525 cur.setCurrentFont();
1530 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1532 LASSERT(text_ == cur.text(), /**/);
1533 pit_type pit = getPitNearY(y);
1534 LASSERT(pit != -1, return);
1536 ParagraphMetrics const & pm = par_metrics_[pit];
1538 int yy = pm.position() - pm.ascent();
1539 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1540 " pit: " << pit << " yy: " << yy);
1543 LASSERT(pm.rows().size(), /**/);
1544 for (; r < int(pm.rows().size()) - 1; ++r) {
1545 Row const & row = pm.rows()[r];
1546 if (int(yy + row.height()) > y)
1551 Row const & row = pm.rows()[r];
1553 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1557 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1559 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1561 text_->setCursor(cur, pit, pos, true, bound);
1562 // remember new position.
1567 //takes screen x,y coordinates
1568 Inset * TextMetrics::checkInsetHit(int x, int y)
1570 pit_type pit = getPitNearY(y);
1571 LASSERT(pit != -1, return 0);
1573 Paragraph const & par = text_->paragraphs()[pit];
1574 ParagraphMetrics const & pm = par_metrics_[pit];
1576 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1578 InsetList::const_iterator iit = par.insetList().begin();
1579 InsetList::const_iterator iend = par.insetList().end();
1580 for (; iit != iend; ++iit) {
1581 Inset * inset = iit->inset;
1583 LYXERR(Debug::DEBUG, "examining inset " << inset);
1585 if (!bv_->coordCache().getInsets().has(inset)) {
1586 LYXERR(Debug::DEBUG, "inset has no cached position");
1590 Dimension const & dim = pm.insetDimension(inset);
1591 Point p = bv_->coordCache().getInsets().xy(inset);
1593 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1594 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1597 && x <= p.x_ + dim.wid
1598 && y >= p.y_ - dim.asc
1599 && y <= p.y_ + dim.des) {
1600 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1605 LYXERR(Debug::DEBUG, "No inset hit. ");
1610 int TextMetrics::cursorX(CursorSlice const & sl,
1611 bool boundary) const
1613 LASSERT(sl.text() == text_, /**/);
1614 pit_type const pit = sl.pit();
1615 Paragraph const & par = text_->paragraphs()[pit];
1616 ParagraphMetrics const & pm = par_metrics_[pit];
1617 if (pm.rows().empty())
1620 pos_type ppos = sl.pos();
1621 // Correct position in front of big insets
1622 bool const boundary_correction = ppos != 0 && boundary;
1623 if (boundary_correction)
1626 Row const & row = pm.getRow(sl.pos(), boundary);
1628 pos_type cursor_vpos = 0;
1630 Buffer const & buffer = bv_->buffer();
1633 bidi.computeTables(par, buffer, row);
1635 pos_type const row_pos = row.pos();
1636 pos_type const end = row.endpos();
1637 // Spaces at logical line breaks in bidi text must be skipped during
1638 // cursor positioning. However, they may appear visually in the middle
1639 // of a row; they must be skipped, wherever they are...
1640 // * logically "abc_[HEBREW_\nHEBREW]"
1641 // * visually "abc_[_WERBEH\nWERBEH]"
1642 pos_type skipped_sep_vpos = -1;
1645 cursor_vpos = row_pos;
1646 else if (ppos >= end)
1647 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1648 else if (ppos > row_pos && ppos >= end)
1649 // Place cursor after char at (logical) position pos - 1
1650 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1651 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1653 // Place cursor before char at (logical) position ppos
1654 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1655 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1657 pos_type body_pos = par.beginOfBody();
1659 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1662 // check for possible inline completion in this row
1663 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1664 pos_type inlineCompletionVPos = -1;
1665 if (inlineCompletionPos.inTexted()
1666 && inlineCompletionPos.text() == text_
1667 && inlineCompletionPos.pit() == pit
1668 && inlineCompletionPos.pos() - 1 >= row_pos
1669 && inlineCompletionPos.pos() - 1 < end) {
1670 // draw logically behind the previous character
1671 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1674 // Use font span to speed things up, see below
1678 // If the last logical character is a separator, skip it, unless
1679 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1680 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1681 skipped_sep_vpos = bidi.log2vis(end - 1);
1683 if (lyxrc.paragraph_markers && text_->isRTL(par)) {
1685 docstring const s = docstring(1, char_type(0x00B6));
1686 x += theFontMetrics(f).width(s);
1689 // Inline completion RTL special case row_pos == cursor_pos:
1690 // "__|b" => cursor_pos is right of __
1691 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1692 font = displayFont(pit, row_pos + 1);
1693 docstring const & completion = bv_->inlineCompletion();
1694 if (font.isRightToLeft() && completion.length() > 0)
1695 x += theFontMetrics(font.fontInfo()).width(completion);
1698 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1699 // Skip the separator which is at the logical end of the row
1700 if (vpos == skipped_sep_vpos)
1702 pos_type pos = bidi.vis2log(vpos);
1703 if (body_pos > 0 && pos == body_pos - 1) {
1704 FontMetrics const & labelfm = theFontMetrics(
1705 text_->labelFont(par));
1706 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1707 if (par.isLineSeparator(body_pos - 1))
1708 x -= singleWidth(pit, body_pos - 1);
1711 // Use font span to speed things up, see above
1712 if (pos < font_span.first || pos > font_span.last) {
1713 font_span = par.fontSpan(pos);
1714 font = displayFont(pit, pos);
1717 x += pm.singleWidth(pos, font);
1719 // Inline completion RTL case:
1720 // "a__|b", __ of b => non-boundary a-pos is right of __
1721 if (vpos + 1 == inlineCompletionVPos
1722 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1723 font = displayFont(pit, vpos + 1);
1724 docstring const & completion = bv_->inlineCompletion();
1725 if (font.isRightToLeft() && completion.length() > 0)
1726 x += theFontMetrics(font.fontInfo()).width(completion);
1729 // Inline completion LTR case:
1730 // "b|__a", __ of b => non-boundary a-pos is in front of __
1731 if (vpos == inlineCompletionVPos
1732 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1733 font = displayFont(pit, vpos);
1734 docstring const & completion = bv_->inlineCompletion();
1735 if (!font.isRightToLeft() && completion.length() > 0)
1736 x += theFontMetrics(font.fontInfo()).width(completion);
1739 if (par.isSeparator(pos) && pos >= body_pos)
1743 // see correction above
1744 if (boundary_correction) {
1745 if (isRTL(sl, boundary))
1746 x -= singleWidth(pit, ppos);
1748 x += singleWidth(pit, ppos);
1755 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1757 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1758 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1759 if (pm.rows().empty())
1763 h -= par_metrics_[0].rows()[0].ascent();
1764 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1765 h += par_metrics_[pit].height();
1768 if (pos && boundary)
1770 size_t const rend = pm.pos2row(pos);
1771 for (size_t rit = 0; rit != rend; ++rit)
1772 h += pm.rows()[rit].height();
1773 h += pm.rows()[rend].ascent();
1778 // the cursor set functions have a special mechanism. When they
1779 // realize you left an empty paragraph, they will delete it.
1781 bool TextMetrics::cursorHome(Cursor & cur)
1783 LASSERT(text_ == cur.text(), /**/);
1784 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1785 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1786 return text_->setCursor(cur, cur.pit(), row.pos());
1790 bool TextMetrics::cursorEnd(Cursor & cur)
1792 LASSERT(text_ == cur.text(), /**/);
1793 // if not on the last row of the par, put the cursor before
1794 // the final space exept if I have a spanning inset or one string
1795 // is so long that we force a break.
1796 pos_type end = cur.textRow().endpos();
1798 // empty text, end-1 is no valid position
1800 bool boundary = false;
1801 if (end != cur.lastpos()) {
1802 if (!cur.paragraph().isLineSeparator(end-1)
1803 && !cur.paragraph().isNewline(end-1))
1808 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1812 void TextMetrics::deleteLineForward(Cursor & cur)
1814 LASSERT(text_ == cur.text(), /**/);
1815 if (cur.lastpos() == 0) {
1816 // Paragraph is empty, so we just go forward
1817 text_->cursorForward(cur);
1820 cur.setSelection(true); // to avoid deletion
1823 // What is this test for ??? (JMarc)
1824 if (!cur.selection())
1825 text_->deleteWordForward(cur);
1827 cap::cutSelection(cur, true, false);
1828 cur.checkBufferStructure();
1833 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1835 ParagraphList const & pars = text_->paragraphs();
1836 return row.endpos() >= pars[pit].size()
1837 && pit + 1 == pit_type(pars.size());
1841 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1843 return row.pos() == 0 && pit == 0;
1847 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1849 LASSERT(pit >= 0, /**/);
1850 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1851 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1855 int TextMetrics::leftMargin(int max_width,
1856 pit_type const pit, pos_type const pos) const
1858 ParagraphList const & pars = text_->paragraphs();
1860 LASSERT(pit >= 0, /**/);
1861 LASSERT(pit < int(pars.size()), /**/);
1862 Paragraph const & par = pars[pit];
1863 LASSERT(pos >= 0, /**/);
1864 LASSERT(pos <= par.size(), /**/);
1865 Buffer const & buffer = bv_->buffer();
1866 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1867 DocumentClass const & tclass = buffer.params().documentClass();
1868 Layout const & layout = par.layout();
1870 docstring parindent = layout.parindent;
1874 if (text_->isMainText())
1875 l_margin += bv_->leftMargin();
1877 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1878 tclass.leftmargin());
1880 if (par.getDepth() != 0) {
1881 // find the next level paragraph
1882 pit_type newpar = text_->outerHook(pit);
1883 if (newpar != pit_type(pars.size())) {
1884 if (pars[newpar].layout().isEnvironment()) {
1885 l_margin = leftMargin(max_width, newpar);
1887 if (tclass.isDefaultLayout(par.layout())
1888 || tclass.isPlainLayout(par.layout())) {
1889 if (pars[newpar].params().noindent())
1892 parindent = pars[newpar].layout().parindent;
1897 // This happens after sections in standard classes. The 1.3.x
1898 // code compared depths too, but it does not seem necessary
1900 if (tclass.isDefaultLayout(par.layout())
1901 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1904 FontInfo const labelfont = text_->labelFont(par);
1905 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1907 switch (layout.margintype) {
1908 case MARGIN_DYNAMIC:
1909 if (!layout.leftmargin.empty()) {
1910 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1913 if (!par.labelString().empty()) {
1914 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1915 l_margin += labelfont_metrics.width(par.labelString());
1916 l_margin += labelfont_metrics.width(layout.labelsep);
1920 case MARGIN_MANUAL: {
1921 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1922 // The width of an empty par, even with manual label, should be 0
1923 if (!par.empty() && pos >= par.beginOfBody()) {
1924 if (!par.getLabelWidthString().empty()) {
1925 docstring labstr = par.getLabelWidthString();
1926 l_margin += labelfont_metrics.width(labstr);
1927 l_margin += labelfont_metrics.width(layout.labelsep);
1933 case MARGIN_STATIC: {
1934 l_margin += theFontMetrics(buffer.params().getFont()).
1935 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1939 case MARGIN_FIRST_DYNAMIC:
1940 if (layout.labeltype == LABEL_MANUAL) {
1941 // if we are at position 0, we are never in the body
1942 if (pos > 0 && pos >= par.beginOfBody())
1943 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1945 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1947 // Special case to fix problems with
1949 || (layout.labeltype == LABEL_STATIC
1950 && layout.latextype == LATEX_ENVIRONMENT
1951 && !text_->isFirstInSequence(pit))) {
1952 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1953 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1954 && layout.labeltype != LABEL_BIBLIO
1955 && layout.labeltype !=
1956 LABEL_CENTERED_TOP_ENVIRONMENT) {
1957 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1958 l_margin += labelfont_metrics.width(layout.labelsep);
1959 l_margin += labelfont_metrics.width(par.labelString());
1963 case MARGIN_RIGHT_ADDRESS_BOX: {
1965 // ok, a terrible hack. The left margin depends on the widest
1966 // row in this paragraph.
1967 RowList::iterator rit = par.rows().begin();
1968 RowList::iterator end = par.rows().end();
1969 // FIXME: This is wrong.
1970 int minfill = max_width;
1971 for ( ; rit != end; ++rit)
1972 if (rit->fill() < minfill)
1973 minfill = rit->fill();
1974 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1975 l_margin += minfill;
1977 // also wrong, but much shorter.
1978 l_margin += max_width / 2;
1983 if (!par.params().leftIndent().zero())
1984 l_margin += par.params().leftIndent().inPixels(max_width);
1988 if (par.params().align() == LYX_ALIGN_LAYOUT)
1989 align = layout.align;
1991 align = par.params().align();
1993 // set the correct parindent
1995 && (layout.labeltype == LABEL_NO_LABEL
1996 || layout.labeltype == LABEL_TOP_ENVIRONMENT
1997 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1998 || (layout.labeltype == LABEL_STATIC
1999 && layout.latextype == LATEX_ENVIRONMENT
2000 && !text_->isFirstInSequence(pit)))
2001 && align == LYX_ALIGN_BLOCK
2002 && !par.params().noindent()
2003 // in some insets, paragraphs are never indented
2004 && !text_->inset().neverIndent()
2005 // display style insets are always centered, omit indentation
2008 && par.getInset(pos)->display())
2009 && (!(tclass.isDefaultLayout(par.layout())
2010 || tclass.isPlainLayout(par.layout()))
2011 || buffer.params().paragraph_separation == BufferParams::ParagraphIndentSeparation)
2014 // use the parindent of the layout when the default indentation is used
2015 // otherwise use the indentation set in the document settings
2016 if (buffer.params().getIndentation().asLyXCommand() == "default")
2017 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
2020 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2027 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2029 ParagraphMetrics const & pm = par_metrics_[pit];
2031 return pm.singleWidth(pos, displayFont(pit, pos));
2035 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2037 if (par_metrics_.empty())
2043 ParMetricsCache::iterator it = par_metrics_.begin();
2044 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2045 y -= it->second.ascent();
2046 for (; it != pm_end; ++it) {
2047 ParagraphMetrics const & pmi = it->second;
2049 pit_type const pit = it->first;
2050 // Save the paragraph position in the cache.
2051 it->second.setPosition(y);
2052 drawParagraph(pi, pit, x, y);
2058 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2060 BufferParams const & bparams = bv_->buffer().params();
2061 ParagraphMetrics const & pm = par_metrics_[pit];
2062 if (pm.rows().empty())
2066 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2067 int const ww = bv_->workHeight();
2068 size_t const nrows = pm.rows().size();
2070 Cursor const & cur = bv_->cursor();
2071 DocIterator sel_beg = cur.selectionBegin();
2072 DocIterator sel_end = cur.selectionEnd();
2073 bool selection = cur.selection()
2074 // This is our text.
2075 && cur.text() == text_
2076 // if the anchor is outside, this is not our selection
2077 && cur.anchor().text() == text_
2078 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2080 // We store the begin and end pos of the selection relative to this par
2081 DocIterator sel_beg_par = cur.selectionBegin();
2082 DocIterator sel_end_par = cur.selectionEnd();
2084 // We care only about visible selection.
2086 if (pit != sel_beg.pit()) {
2087 sel_beg_par.pit() = pit;
2088 sel_beg_par.pos() = 0;
2090 if (pit != sel_end.pit()) {
2091 sel_end_par.pit() = pit;
2092 sel_end_par.pos() = sel_end_par.lastpos();
2096 for (size_t i = 0; i != nrows; ++i) {
2098 Row const & row = pm.rows()[i];
2102 bool const inside = (y + row.descent() >= 0
2103 && y - row.ascent() < ww);
2104 // It is not needed to draw on screen if we are not inside.
2105 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2106 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2109 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2111 row.setSelection(-1, -1);
2113 // The row knows nothing about the paragraph, so we have to check
2114 // whether this row is the first or last and update the margins.
2115 if (row.selection()) {
2116 if (row.sel_beg == 0)
2117 row.begin_margin_sel = sel_beg.pit() < pit;
2118 if (row.sel_end == sel_end_par.lastpos())
2119 row.end_margin_sel = sel_end.pit() > pit;
2122 // Row signature; has row changed since last paint?
2123 row.setCrc(pm.computeRowSignature(row, bparams));
2124 bool row_has_changed = row.changed();
2126 // Take this opportunity to spellcheck the row contents.
2127 if (row_has_changed && lyxrc.spellcheck_continuously) {
2129 // dummy variable, not used.
2130 static docstring_list suggestions;
2131 pos_type from = row.pos();
2132 pos_type to = row.endpos();
2133 while (from < row.endpos()) {
2134 text_->getPar(pit).spellCheck(from, to, wl, suggestions, false);
2139 // Don't paint the row if a full repaint has not been requested
2140 // and if it has not changed.
2141 if (!pi.full_repaint && !row_has_changed) {
2142 // Paint only the insets if the text itself is
2144 rp.paintOnlyInsets();
2149 // Clear background of this row if paragraph background was not
2150 // already cleared because of a full repaint.
2151 if (!pi.full_repaint && row_has_changed) {
2152 pi.pain.fillRectangle(x, y - row.ascent(),
2153 width(), row.height(), pi.background_color);
2156 if (row.selection())
2157 drawRowSelection(pi, x, row, cur, pit);
2159 // Instrumentation for testing row cache (see also
2161 if (lyxerr.debugging(Debug::PAINTING) && inside
2162 && (row.selection() || pi.full_repaint || row_has_changed)) {
2163 string const foreword = text_->isMainText() ?
2164 "main text redraw " : "inset text redraw: ";
2165 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2166 << " row_selection=" << row.selection()
2167 << " full_repaint=" << pi.full_repaint
2168 << " row_has_changed=" << row_has_changed);
2171 // Backup full_repaint status and force full repaint
2172 // for inner insets as the Row has been cleared out.
2173 bool tmp = pi.full_repaint;
2174 pi.full_repaint = true;
2177 rp.paintChangeBar();
2178 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2179 if (i == 0 && !is_rtl)
2181 if (i == nrows - 1 && is_rtl)
2184 if (i == nrows - 1 && !is_rtl)
2186 if (i == 0 && is_rtl)
2189 // Restore full_repaint status.
2190 pi.full_repaint = tmp;
2192 // Re-enable screen drawing for future use of the painter.
2193 pi.pain.setDrawingEnabled(original_drawing_state);
2195 //LYXERR(Debug::PAINTING, ".");
2199 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
2200 Cursor const & curs, pit_type pit) const
2202 DocIterator beg = curs.selectionBegin();
2204 beg.pos() = row.sel_beg;
2206 DocIterator end = curs.selectionEnd();
2208 end.pos() = row.sel_end;
2210 bool const begin_boundary = beg.pos() >= row.endpos();
2211 bool const end_boundary = row.sel_end == row.endpos();
2213 DocIterator cur = beg;
2214 cur.boundary(begin_boundary);
2215 int x1 = cursorX(beg.top(), begin_boundary);
2216 int x2 = cursorX(end.top(), end_boundary);
2217 int const y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
2218 int const y2 = y1 + row.height();
2220 int const rm = text_->isMainText() ? bv_->rightMargin() : 0;
2221 int const lm = text_->isMainText() ? bv_->leftMargin() : 0;
2224 if (row.begin_margin_sel) {
2225 if (text_->isRTL(beg.paragraph())) {
2226 pi.pain.fillRectangle(x + x1, y1, width() - rm - x1, y2 - y1,
2229 pi.pain.fillRectangle(x + lm, y1, x1 - lm, y2 - y1,
2234 if (row.end_margin_sel) {
2235 if (text_->isRTL(beg.paragraph())) {
2236 pi.pain.fillRectangle(x + lm, y1, x2 - lm, y2 - y1,
2239 pi.pain.fillRectangle(x + x2, y1, width() - rm - x2, y2 - y1,
2244 // if we are on a boundary from the beginning, it's probably
2245 // a RTL boundary and we jump to the other side directly as this
2246 // segement is 0-size and confuses the logic below
2248 cur.boundary(false);
2250 // go through row and draw from RTL boundary to RTL boundary
2252 bool drawNow = false;
2254 // simplified cursorForward code below which does not
2255 // descend into insets and which does not go into the
2256 // next line. Compare the logic with the original cursorForward
2258 // if left of boundary -> just jump to right side, but
2259 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2260 if (cur.boundary()) {
2261 cur.boundary(false);
2262 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2263 // in front of RTL boundary -> Stay on this side of the boundary
2264 // because: ab|cDDEEFFghi -> abc|DDEEFFghi
2273 if (cur.pos() == row.endpos())
2278 // the previous segment was just drawn, now the next starts
2279 x1 = cursorX(cur.top(), cur.boundary());
2282 if (!(cur < end) || drawNow) {
2283 x2 = cursorX(cur.top(), cur.boundary());
2284 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2287 // reset x1, so it is set again next round (which will be on the
2288 // right side of a boundary or at the selection end)
2295 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2296 Dimension & dim) const
2298 Cursor const & bvcur = cur.bv().cursor();
2300 // get word in front of cursor
2301 docstring word = text_->previousWord(bvcur.top());
2302 DocIterator wordStart = bvcur;
2303 wordStart.pos() -= word.length();
2305 // get position on screen of the word start and end
2306 Point lxy = cur.bv().getPos(wordStart, false);
2307 Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
2309 // calculate dimensions of the word
2310 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2311 dim.wid = abs(rxy.x_ - lxy.x_);
2313 // calculate position of word
2315 x = min(rxy.x_, lxy.x_);
2317 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2318 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2321 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2323 // ParagraphMetrics const & pm = par_metrics_[pit];
2324 // Row const & r = pm.rows()[row];
2330 int defaultRowHeight()
2332 return int(theFontMetrics(sane_font).maxHeight() * 1.2);