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 FontIterator fi = FontIterator(*this, par, pit, pos);
835 pos_type point = end;
837 for ( ; i < end; ++i, ++fi) {
838 int thiswidth = pm.singleWidth(i, *fi);
840 // add inline completion width
841 if (inlineCompletionLPos == i) {
842 docstring const & completion = bv_->inlineCompletion();
843 if (completion.length() > 0)
844 thiswidth += theFontMetrics(*fi).width(completion);
847 // add the auto-hfill from label end to the body
848 if (body_pos && i == body_pos) {
849 FontMetrics const & fm = theFontMetrics(
850 text_->labelFont(par));
851 int add = fm.width(layout.labelsep);
852 if (par.isLineSeparator(i - 1))
853 add -= singleWidth(pit, i - 1);
855 add = max(add, label_end - x);
860 chunkwidth += thiswidth;
862 // break before a character that will fall off
863 // the right of the row
865 // if no break before, break here
866 if (point == end || chunkwidth >= width - left) {
872 // exit on last registered breakpoint:
876 if (par.isNewline(i)) {
880 Inset const * inset = 0;
883 if ((inset = par.getInset(i + 1)) && inset->display()) {
888 if ((inset = par.getInset(i)) && inset->display()) {
894 inset = par.getInset(i);
895 if (!inset || inset->isChar()) {
896 // some insets are line separators too
897 if (par.isLineSeparator(i)) {
898 // register breakpoint:
905 // maybe found one, but the par is short enough.
906 if (i == end && x < width)
909 // manual labels cannot be broken in LaTeX. But we
910 // want to make our on-screen rendering of footnotes
912 if (body_pos && point < body_pos)
919 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
920 pos_type const first, pos_type const end) const
922 // get the pure distance
923 ParagraphMetrics const & pm = par_metrics_[pit];
924 Paragraph const & par = text_->getPar(pit);
925 int w = leftMargin(max_width_, pit, first);
926 int label_end = labelEnd(pit);
928 // check for possible inline completion
929 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
930 pos_type inlineCompletionLPos = -1;
931 if (inlineCompletionPos.inTexted()
932 && inlineCompletionPos.text() == text_
933 && inlineCompletionPos.pit() == pit) {
934 // draw logically behind the previous character
935 inlineCompletionLPos = inlineCompletionPos.pos() - 1;
938 pos_type const body_pos = par.beginOfBody();
942 FontIterator fi = FontIterator(*this, par, pit, i);
943 for ( ; i < end; ++i, ++fi) {
944 if (body_pos > 0 && i == body_pos) {
945 FontMetrics const & fm = theFontMetrics(
946 text_->labelFont(par));
947 w += fm.width(par.layout().labelsep);
948 if (par.isLineSeparator(i - 1))
949 w -= singleWidth(pit, i - 1);
950 w = max(w, label_end);
953 // a line separator at the end of a line (but not at the end of a
954 // paragraph) will not be drawn and should therefore not count for
956 if (!par.isLineSeparator(i) || i != end - 1 || end == par.size())
957 w += pm.singleWidth(i, *fi);
959 // add inline completion width
960 if (inlineCompletionLPos == i) {
961 docstring const & completion = bv_->inlineCompletion();
962 if (completion.length() > 0)
963 w += theFontMetrics(*fi).width(completion);
968 if (body_pos > 0 && body_pos >= end) {
969 FontMetrics const & fm = theFontMetrics(
970 text_->labelFont(par));
971 w += fm.width(par.layout().labelsep);
972 if (end > 0 && par.isLineSeparator(end - 1))
973 w -= singleWidth(pit, end - 1);
974 w = max(w, label_end);
977 return w + right_margin;
981 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
982 pos_type const end, bool topBottomSpace) const
984 Paragraph const & par = text_->getPar(pit);
985 // get the maximum ascent and the maximum descent
986 double layoutasc = 0;
987 double layoutdesc = 0;
988 double const dh = defaultRowHeight();
990 // ok, let us initialize the maxasc and maxdesc value.
991 // Only the fontsize count. The other properties
992 // are taken from the layoutfont. Nicer on the screen :)
993 Layout const & layout = par.layout();
995 // as max get the first character of this row then it can
996 // increase but not decrease the height. Just some point to
997 // start with so we don't have to do the assignment below too
999 Buffer const & buffer = bv_->buffer();
1000 Font font = displayFont(pit, first);
1001 FontSize const tmpsize = font.fontInfo().size();
1002 font.fontInfo() = text_->layoutFont(pit);
1003 FontSize const size = font.fontInfo().size();
1004 font.fontInfo().setSize(tmpsize);
1006 FontInfo labelfont = text_->labelFont(par);
1008 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1009 FontMetrics const & fontmetrics = theFontMetrics(font);
1011 // these are minimum values
1012 double const spacing_val = layout.spacing.getValue()
1013 * text_->spacing(par);
1014 //lyxerr << "spacing_val = " << spacing_val << endl;
1015 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
1016 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
1018 // insets may be taller
1019 ParagraphMetrics const & pm = par_metrics_[pit];
1020 InsetList::const_iterator ii = par.insetList().begin();
1021 InsetList::const_iterator iend = par.insetList().end();
1022 for ( ; ii != iend; ++ii) {
1023 if (ii->pos >= first && ii->pos < end) {
1024 Dimension const & dim = pm.insetDimension(ii->inset);
1025 maxasc = max(maxasc, dim.ascent());
1026 maxdesc = max(maxdesc, dim.descent());
1030 // Check if any custom fonts are larger (Asger)
1031 // This is not completely correct, but we can live with the small,
1032 // cosmetic error for now.
1036 par.highestFontInRange(first, end, size);
1037 if (maxsize > font.fontInfo().size()) {
1038 // use standard paragraph font with the maximal size
1039 FontInfo maxfont = font.fontInfo();
1040 maxfont.setSize(maxsize);
1041 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
1042 maxasc = max(maxasc, maxfontmetrics.maxAscent());
1043 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
1046 // This is nicer with box insets:
1050 ParagraphList const & pars = text_->paragraphs();
1051 Inset const & inset = text_->inset();
1053 // is it a top line?
1054 if (first == 0 && topBottomSpace) {
1055 BufferParams const & bufparams = buffer.params();
1056 // some parskips VERY EASY IMPLEMENTATION
1057 if (bufparams.paragraph_separation
1058 == BufferParams::ParagraphSkipSeparation
1059 && inset.lyxCode() != ERT_CODE
1060 && inset.lyxCode() != LISTINGS_CODE
1062 && ((layout.isParagraph() && par.getDepth() == 0)
1063 || (pars[pit - 1].layout().isParagraph()
1064 && pars[pit - 1].getDepth() == 0)))
1066 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1069 if (par.params().startOfAppendix())
1070 maxasc += int(3 * dh);
1072 // This is special code for the chapter, since the label of this
1073 // layout is printed in an extra row
1074 if (layout.counter == "chapter"
1075 && !par.params().labelString().empty()) {
1076 labeladdon = int(labelfont_metrics.maxHeight()
1077 * layout.spacing.getValue()
1078 * text_->spacing(par));
1081 // special code for the top label
1082 if ((layout.labeltype == LABEL_TOP_ENVIRONMENT
1083 || layout.labeltype == LABEL_BIBLIO
1084 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
1085 && text_->isFirstInSequence(pit)
1086 && !par.labelString().empty())
1089 labelfont_metrics.maxHeight()
1090 * layout.spacing.getValue()
1091 * text_->spacing(par)
1092 + (layout.topsep + layout.labelbottomsep) * dh);
1095 // Add the layout spaces, for example before and after
1096 // a section, or between the items of a itemize or enumerate
1099 pit_type prev = text_->depthHook(pit, par.getDepth());
1100 Paragraph const & prevpar = pars[prev];
1102 && prevpar.layout() == layout
1103 && prevpar.getDepth() == par.getDepth()
1104 && prevpar.getLabelWidthString()
1105 == par.getLabelWidthString()) {
1106 layoutasc = layout.itemsep * dh;
1107 } else if (pit != 0 || first != 0) {
1108 if (layout.topsep > 0)
1109 layoutasc = layout.topsep * dh;
1112 prev = text_->outerHook(pit);
1113 if (prev != pit_type(pars.size())) {
1114 maxasc += int(pars[prev].layout().parsep * dh);
1115 } else if (pit != 0) {
1116 Paragraph const & prevpar = pars[pit - 1];
1117 if (prevpar.getDepth() != 0 ||
1118 prevpar.layout() == layout) {
1119 maxasc += int(layout.parsep * dh);
1124 // is it a bottom line?
1125 if (end >= par.size() && topBottomSpace) {
1126 // add the layout spaces, for example before and after
1127 // a section, or between the items of a itemize or enumerate
1129 pit_type nextpit = pit + 1;
1130 if (nextpit != pit_type(pars.size())) {
1131 pit_type cpit = pit;
1135 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1136 usual = pars[cpit].layout().bottomsep * dh;
1137 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1138 if (pars[cpit].layout() != pars[nextpit].layout()
1139 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1141 unusual = pars[cpit].layout().bottomsep * dh;
1143 layoutdesc = max(unusual, usual);
1144 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1145 if (pars[cpit].layout() != pars[nextpit].layout()
1146 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1147 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1152 // incalculate the layout spaces
1153 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1154 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1156 // FIXME: the correct way is to do the following is to move the
1157 // following code in another method specially tailored for the
1158 // main Text. The following test is thus bogus.
1159 // Top and bottom margin of the document (only at top-level)
1160 if (main_text_ && topBottomSpace) {
1161 if (pit == 0 && first == 0)
1163 if (pit + 1 == pit_type(pars.size()) &&
1164 end == par.size() &&
1165 !(end > 0 && par.isNewline(end - 1)))
1169 return Dimension(0, maxasc + labeladdon, maxdesc);
1173 // x is an absolute screen coord
1174 // returns the column near the specified x-coordinate of the row
1175 // x is set to the real beginning of this column
1176 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1177 Row const & row, int & x, bool & boundary) const
1179 Buffer const & buffer = bv_->buffer();
1181 /// For the main Text, it is possible that this pit is not
1182 /// yet in the CoordCache when moving cursor up.
1183 /// x Paragraph coordinate is always 0 for main text anyway.
1184 int const xo = origin_.x_;
1186 Paragraph const & par = text_->getPar(pit);
1188 bidi.computeTables(par, buffer, row);
1190 pos_type vc = row.pos();
1191 pos_type end = row.endpos();
1193 Layout const & layout = par.layout();
1195 bool left_side = false;
1197 pos_type body_pos = par.beginOfBody();
1199 double tmpx = row.x;
1200 double last_tmpx = tmpx;
1203 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1206 // check for empty row
1212 while (vc < end && tmpx <= x) {
1213 c = bidi.vis2log(vc);
1215 if (body_pos > 0 && c == body_pos - 1) {
1216 FontMetrics const & fm = theFontMetrics(
1217 text_->labelFont(par));
1218 tmpx += row.label_hfill + fm.width(layout.labelsep);
1219 if (par.isLineSeparator(body_pos - 1))
1220 tmpx -= singleWidth(pit, body_pos - 1);
1223 tmpx += singleWidth(pit, c);
1224 if (par.isSeparator(c) && c >= body_pos)
1225 tmpx += row.separator;
1229 if ((tmpx + last_tmpx) / 2 > x) {
1234 LASSERT(vc <= end, /**/); // This shouldn't happen.
1237 // This (rtl_support test) is not needed, but gives
1238 // some speedup if rtl_support == false
1239 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1241 // If lastrow is false, we don't need to compute
1242 // the value of rtl.
1243 bool const rtl = lastrow ? text_->isRTL(par) : false;
1245 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1246 (!rtl && !left_side && vc == end && x > tmpx + 5))) {
1247 if (!par.isNewline(end - 1))
1249 } else if (vc == row.pos()) {
1250 c = bidi.vis2log(vc);
1251 if (bidi.level(c) % 2 == 1)
1254 c = bidi.vis2log(vc - 1);
1255 bool const rtl = (bidi.level(c) % 2 == 1);
1256 if (left_side == rtl) {
1258 boundary = isRTLBoundary(pit, c);
1262 // I believe this code is not needed anymore (Jug 20050717)
1264 // The following code is necessary because the cursor position past
1265 // the last char in a row is logically equivalent to that before
1266 // the first char in the next row. That's why insets causing row
1267 // divisions -- Newline and display-style insets -- must be treated
1268 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1269 // Newline inset, air gap below:
1270 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1271 if (bidi.level(end -1) % 2 == 0)
1272 tmpx -= singleWidth(pit, end - 1);
1274 tmpx += singleWidth(pit, end - 1);
1278 // Air gap above display inset:
1279 if (row.pos() < end && c >= end && end < par.size()
1280 && par.isInset(end) && par.getInset(end)->display()) {
1283 // Air gap below display inset:
1284 if (row.pos() < end && c >= end && par.isInset(end - 1)
1285 && par.getInset(end - 1)->display()) {
1291 pos_type const col = c - row.pos();
1293 if (!c || end == par.size())
1296 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1301 return min(col, end - 1 - row.pos());
1305 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1307 // We play safe and use parMetrics(pit) to make sure the
1308 // ParagraphMetrics will be redone and OK to use if needed.
1309 // Otherwise we would use an empty ParagraphMetrics in
1310 // upDownInText() while in selection mode.
1311 ParagraphMetrics const & pm = parMetrics(pit);
1313 LASSERT(row < int(pm.rows().size()), /**/);
1315 Row const & r = pm.rows()[row];
1316 return r.pos() + getColumnNearX(pit, r, x, bound);
1320 void TextMetrics::newParMetricsDown()
1322 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1323 pit_type const pit = last.first + 1;
1324 if (pit == int(text_->paragraphs().size()))
1327 // do it and update its position.
1329 par_metrics_[pit].setPosition(last.second.position()
1330 + last.second.descent() + par_metrics_[pit].ascent());
1334 void TextMetrics::newParMetricsUp()
1336 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1337 if (first.first == 0)
1340 pit_type const pit = first.first - 1;
1341 // do it and update its position.
1343 par_metrics_[pit].setPosition(first.second.position()
1344 - first.second.ascent() - par_metrics_[pit].descent());
1347 // y is screen coordinate
1348 pit_type TextMetrics::getPitNearY(int y)
1350 LASSERT(!text_->paragraphs().empty(), return -1);
1351 LASSERT(!par_metrics_.empty(), return -1);
1352 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1354 // look for highest numbered paragraph with y coordinate less than given y
1357 ParMetricsCache::const_iterator it = par_metrics_.begin();
1358 ParMetricsCache::const_iterator et = par_metrics_.end();
1359 ParMetricsCache::const_iterator last = et; last--;
1361 ParagraphMetrics const & pm = it->second;
1363 if (y < it->second.position() - int(pm.ascent())) {
1364 // We are looking for a position that is before the first paragraph in
1365 // the cache (which is in priciple off-screen, that is before the
1368 // We are already at the first paragraph in the inset.
1370 // OK, this is the paragraph we are looking for.
1371 pit = it->first - 1;
1376 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1378 if (y >= last->second.position() + int(pm_last.descent())) {
1379 // We are looking for a position that is after the last paragraph in
1380 // the cache (which is in priciple off-screen), that is before the
1382 pit = last->first + 1;
1383 if (pit == int(text_->paragraphs().size()))
1384 // We are already at the last paragraph in the inset.
1386 // OK, this is the paragraph we are looking for.
1387 newParMetricsDown();
1391 for (; it != et; ++it) {
1392 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1393 << " y: " << it->second.position());
1395 ParagraphMetrics const & pm = par_metrics_[it->first];
1397 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1399 yy = it->second.position();
1403 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1409 Row const & TextMetrics::getPitAndRowNearY(int y, pit_type & pit,
1410 bool assert_in_view, bool up)
1412 ParagraphMetrics const & pm = par_metrics_[pit];
1414 int yy = pm.position() - pm.ascent();
1415 LASSERT(!pm.rows().empty(), /**/);
1416 RowList::const_iterator rit = pm.rows().begin();
1417 RowList::const_iterator rlast = pm.rows().end();
1419 for (; rit != rlast; yy += rit->height(), ++rit)
1420 if (yy + rit->height() > y)
1423 if (assert_in_view && yy + rit->height() != y) {
1425 if (rit != pm.rows().begin())
1427 else if (pit != 0) {
1430 ParagraphMetrics const & pm2 = par_metrics_[pit];
1431 rit = pm2.rows().end();
1437 else if (pit != int(par_metrics_.size())) {
1439 newParMetricsDown();
1440 ParagraphMetrics const & pm2 = par_metrics_[pit];
1441 rit = pm2.rows().begin();
1449 // x,y are absolute screen coordinates
1450 // sets cursor recursively descending into nested editable insets
1451 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1452 bool assert_in_view, bool up)
1454 if (lyxerr.debugging(Debug::WORKAREA)) {
1455 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1456 cur.bv().coordCache().dump();
1458 pit_type pit = getPitNearY(y);
1459 LASSERT(pit != -1, return 0);
1461 Row const & row = getPitAndRowNearY(y, pit, assert_in_view, up);
1464 int xx = x; // is modified by getColumnNearX
1465 pos_type const pos = row.pos()
1466 + getColumnNearX(pit, row, xx, bound);
1469 cur.boundary(bound);
1472 // try to descend into nested insets
1473 Inset * inset = checkInsetHit(x, y);
1474 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1476 // Either we deconst editXY or better we move current_font
1477 // and real_current_font to Cursor
1478 // FIXME: what is needed now that current_font and real_current_font
1480 cur.setCurrentFont();
1484 ParagraphList const & pars = text_->paragraphs();
1485 Inset const * insetBefore = pos ? pars[pit].getInset(pos - 1) : 0;
1486 //Inset * insetBehind = pars[pit].getInset(pos);
1488 // This should be just before or just behind the
1489 // cursor position set above.
1490 LASSERT((pos != 0 && inset == insetBefore)
1491 || inset == pars[pit].getInset(pos), /**/);
1493 // Make sure the cursor points to the position before
1495 if (inset == insetBefore) {
1497 cur.boundary(false);
1500 // Try to descend recursively inside the inset.
1501 inset = inset->editXY(cur, x, y);
1503 if (cur.top().text() == text_)
1504 cur.setCurrentFont();
1509 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1511 LASSERT(text_ == cur.text(), /**/);
1512 pit_type pit = getPitNearY(y);
1513 LASSERT(pit != -1, return);
1515 ParagraphMetrics const & pm = par_metrics_[pit];
1517 int yy = pm.position() - pm.ascent();
1518 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1519 " pit: " << pit << " yy: " << yy);
1522 LASSERT(pm.rows().size(), /**/);
1523 for (; r < int(pm.rows().size()) - 1; ++r) {
1524 Row const & row = pm.rows()[r];
1525 if (int(yy + row.height()) > y)
1530 Row const & row = pm.rows()[r];
1532 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1536 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1538 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1540 text_->setCursor(cur, pit, pos, true, bound);
1541 // remember new position.
1546 //takes screen x,y coordinates
1547 Inset * TextMetrics::checkInsetHit(int x, int y)
1549 pit_type pit = getPitNearY(y);
1550 LASSERT(pit != -1, return 0);
1552 Paragraph const & par = text_->paragraphs()[pit];
1553 ParagraphMetrics const & pm = par_metrics_[pit];
1555 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1557 InsetList::const_iterator iit = par.insetList().begin();
1558 InsetList::const_iterator iend = par.insetList().end();
1559 for (; iit != iend; ++iit) {
1560 Inset * inset = iit->inset;
1562 LYXERR(Debug::DEBUG, "examining inset " << inset);
1564 if (!bv_->coordCache().getInsets().has(inset)) {
1565 LYXERR(Debug::DEBUG, "inset has no cached position");
1569 Dimension const & dim = pm.insetDimension(inset);
1570 Point p = bv_->coordCache().getInsets().xy(inset);
1572 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1573 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1576 && x <= p.x_ + dim.wid
1577 && y >= p.y_ - dim.asc
1578 && y <= p.y_ + dim.des) {
1579 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1584 LYXERR(Debug::DEBUG, "No inset hit. ");
1589 int TextMetrics::cursorX(CursorSlice const & sl,
1590 bool boundary) const
1592 LASSERT(sl.text() == text_, /**/);
1593 pit_type const pit = sl.pit();
1594 Paragraph const & par = text_->paragraphs()[pit];
1595 ParagraphMetrics const & pm = par_metrics_[pit];
1596 if (pm.rows().empty())
1599 pos_type ppos = sl.pos();
1600 // Correct position in front of big insets
1601 bool const boundary_correction = ppos != 0 && boundary;
1602 if (boundary_correction)
1605 Row const & row = pm.getRow(sl.pos(), boundary);
1607 pos_type cursor_vpos = 0;
1609 Buffer const & buffer = bv_->buffer();
1612 bidi.computeTables(par, buffer, row);
1614 pos_type const row_pos = row.pos();
1615 pos_type const end = row.endpos();
1616 // Spaces at logical line breaks in bidi text must be skipped during
1617 // cursor positioning. However, they may appear visually in the middle
1618 // of a row; they must be skipped, wherever they are...
1619 // * logically "abc_[HEBREW_\nHEBREW]"
1620 // * visually "abc_[_WERBEH\nWERBEH]"
1621 pos_type skipped_sep_vpos = -1;
1624 cursor_vpos = row_pos;
1625 else if (ppos >= end)
1626 cursor_vpos = text_->isRTL(par) ? row_pos : end;
1627 else if (ppos > row_pos && ppos >= end)
1628 // Place cursor after char at (logical) position pos - 1
1629 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1630 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1632 // Place cursor before char at (logical) position ppos
1633 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1634 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1636 pos_type body_pos = par.beginOfBody();
1638 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1641 // check for possible inline completion in this row
1642 DocIterator const & inlineCompletionPos = bv_->inlineCompletionPos();
1643 pos_type inlineCompletionVPos = -1;
1644 if (inlineCompletionPos.inTexted()
1645 && inlineCompletionPos.text() == text_
1646 && inlineCompletionPos.pit() == pit
1647 && inlineCompletionPos.pos() - 1 >= row_pos
1648 && inlineCompletionPos.pos() - 1 < end) {
1649 // draw logically behind the previous character
1650 inlineCompletionVPos = bidi.log2vis(inlineCompletionPos.pos() - 1);
1653 // Use font span to speed things up, see below
1657 // If the last logical character is a separator, skip it, unless
1658 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1659 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1660 skipped_sep_vpos = bidi.log2vis(end - 1);
1662 // Inline completion RTL special case row_pos == cursor_pos:
1663 // "__|b" => cursor_pos is right of __
1664 if (row_pos == inlineCompletionVPos && row_pos == cursor_vpos) {
1665 font = displayFont(pit, row_pos + 1);
1666 docstring const & completion = bv_->inlineCompletion();
1667 if (font.isRightToLeft() && completion.length() > 0)
1668 x += theFontMetrics(font.fontInfo()).width(completion);
1671 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1672 // Skip the separator which is at the logical end of the row
1673 if (vpos == skipped_sep_vpos)
1675 pos_type pos = bidi.vis2log(vpos);
1676 if (body_pos > 0 && pos == body_pos - 1) {
1677 FontMetrics const & labelfm = theFontMetrics(
1678 text_->labelFont(par));
1679 x += row.label_hfill + labelfm.width(par.layout().labelsep);
1680 if (par.isLineSeparator(body_pos - 1))
1681 x -= singleWidth(pit, body_pos - 1);
1684 // Use font span to speed things up, see above
1685 if (pos < font_span.first || pos > font_span.last) {
1686 font_span = par.fontSpan(pos);
1687 font = displayFont(pit, pos);
1690 x += pm.singleWidth(pos, font);
1692 // Inline completion RTL case:
1693 // "a__|b", __ of b => non-boundary a-pos is right of __
1694 if (vpos + 1 == inlineCompletionVPos
1695 && (vpos + 1 < cursor_vpos || !boundary_correction)) {
1696 font = displayFont(pit, vpos + 1);
1697 docstring const & completion = bv_->inlineCompletion();
1698 if (font.isRightToLeft() && completion.length() > 0)
1699 x += theFontMetrics(font.fontInfo()).width(completion);
1702 // Inline completion LTR case:
1703 // "b|__a", __ of b => non-boundary a-pos is in front of __
1704 if (vpos == inlineCompletionVPos
1705 && (vpos + 1 < cursor_vpos || boundary_correction)) {
1706 font = displayFont(pit, vpos);
1707 docstring const & completion = bv_->inlineCompletion();
1708 if (!font.isRightToLeft() && completion.length() > 0)
1709 x += theFontMetrics(font.fontInfo()).width(completion);
1712 if (par.isSeparator(pos) && pos >= body_pos)
1716 // see correction above
1717 if (boundary_correction) {
1718 if (isRTL(sl, boundary))
1719 x -= singleWidth(pit, ppos);
1721 x += singleWidth(pit, ppos);
1728 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1730 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1731 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1732 if (pm.rows().empty())
1736 h -= par_metrics_[0].rows()[0].ascent();
1737 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1738 h += par_metrics_[pit].height();
1741 if (pos && boundary)
1743 size_t const rend = pm.pos2row(pos);
1744 for (size_t rit = 0; rit != rend; ++rit)
1745 h += pm.rows()[rit].height();
1746 h += pm.rows()[rend].ascent();
1751 // the cursor set functions have a special mechanism. When they
1752 // realize you left an empty paragraph, they will delete it.
1754 bool TextMetrics::cursorHome(Cursor & cur)
1756 LASSERT(text_ == cur.text(), /**/);
1757 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1758 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1759 return text_->setCursor(cur, cur.pit(), row.pos());
1763 bool TextMetrics::cursorEnd(Cursor & cur)
1765 LASSERT(text_ == cur.text(), /**/);
1766 // if not on the last row of the par, put the cursor before
1767 // the final space exept if I have a spanning inset or one string
1768 // is so long that we force a break.
1769 pos_type end = cur.textRow().endpos();
1771 // empty text, end-1 is no valid position
1773 bool boundary = false;
1774 if (end != cur.lastpos()) {
1775 if (!cur.paragraph().isLineSeparator(end-1)
1776 && !cur.paragraph().isNewline(end-1))
1781 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1785 void TextMetrics::deleteLineForward(Cursor & cur)
1787 LASSERT(text_ == cur.text(), /**/);
1788 if (cur.lastpos() == 0) {
1789 // Paragraph is empty, so we just go forward
1790 text_->cursorForward(cur);
1793 cur.setSelection(true); // to avoid deletion
1796 // What is this test for ??? (JMarc)
1797 if (!cur.selection())
1798 text_->deleteWordForward(cur);
1800 cap::cutSelection(cur, true, false);
1801 cur.checkBufferStructure();
1806 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1808 ParagraphList const & pars = text_->paragraphs();
1809 return row.endpos() >= pars[pit].size()
1810 && pit + 1 == pit_type(pars.size());
1814 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1816 return row.pos() == 0 && pit == 0;
1820 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1822 LASSERT(pit >= 0, /**/);
1823 LASSERT(pit < int(text_->paragraphs().size()), /**/);
1824 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1828 int TextMetrics::leftMargin(int max_width,
1829 pit_type const pit, pos_type const pos) const
1831 ParagraphList const & pars = text_->paragraphs();
1833 LASSERT(pit >= 0, /**/);
1834 LASSERT(pit < int(pars.size()), /**/);
1835 Paragraph const & par = pars[pit];
1836 LASSERT(pos >= 0, /**/);
1837 LASSERT(pos <= par.size(), /**/);
1838 Buffer const & buffer = bv_->buffer();
1839 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1840 DocumentClass const & tclass = buffer.params().documentClass();
1841 Layout const & layout = par.layout();
1843 docstring parindent = layout.parindent;
1847 if (text_->isMainText())
1848 l_margin += bv_->leftMargin();
1850 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1851 tclass.leftmargin());
1853 if (par.getDepth() != 0) {
1854 // find the next level paragraph
1855 pit_type newpar = text_->outerHook(pit);
1856 if (newpar != pit_type(pars.size())) {
1857 if (pars[newpar].layout().isEnvironment()) {
1858 l_margin = leftMargin(max_width, newpar);
1860 if (tclass.isDefaultLayout(par.layout())
1861 || tclass.isPlainLayout(par.layout())) {
1862 if (pars[newpar].params().noindent())
1865 parindent = pars[newpar].layout().parindent;
1870 // This happens after sections in standard classes. The 1.3.x
1871 // code compared depths too, but it does not seem necessary
1873 if (tclass.isDefaultLayout(par.layout())
1874 && pit > 0 && pars[pit - 1].layout().nextnoindent)
1877 FontInfo const labelfont = text_->labelFont(par);
1878 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1880 switch (layout.margintype) {
1881 case MARGIN_DYNAMIC:
1882 if (!layout.leftmargin.empty()) {
1883 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1886 if (!par.labelString().empty()) {
1887 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1888 l_margin += labelfont_metrics.width(par.labelString());
1889 l_margin += labelfont_metrics.width(layout.labelsep);
1893 case MARGIN_MANUAL: {
1894 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1895 // The width of an empty par, even with manual label, should be 0
1896 if (!par.empty() && pos >= par.beginOfBody()) {
1897 if (!par.getLabelWidthString().empty()) {
1898 docstring labstr = par.getLabelWidthString();
1899 l_margin += labelfont_metrics.width(labstr);
1900 l_margin += labelfont_metrics.width(layout.labelsep);
1906 case MARGIN_STATIC: {
1907 l_margin += theFontMetrics(buffer.params().getFont()).
1908 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1912 case MARGIN_FIRST_DYNAMIC:
1913 if (layout.labeltype == LABEL_MANUAL) {
1914 // if we are at position 0, we are never in the body
1915 if (pos > 0 && pos >= par.beginOfBody())
1916 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1918 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1920 // Special case to fix problems with
1922 || (layout.labeltype == LABEL_STATIC
1923 && layout.latextype == LATEX_ENVIRONMENT
1924 && !text_->isFirstInSequence(pit))) {
1925 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1926 } else if (layout.labeltype != LABEL_TOP_ENVIRONMENT
1927 && layout.labeltype != LABEL_BIBLIO
1928 && layout.labeltype !=
1929 LABEL_CENTERED_TOP_ENVIRONMENT) {
1930 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1931 l_margin += labelfont_metrics.width(layout.labelsep);
1932 l_margin += labelfont_metrics.width(par.labelString());
1936 case MARGIN_RIGHT_ADDRESS_BOX: {
1938 // ok, a terrible hack. The left margin depends on the widest
1939 // row in this paragraph.
1940 RowList::iterator rit = par.rows().begin();
1941 RowList::iterator end = par.rows().end();
1942 // FIXME: This is wrong.
1943 int minfill = max_width;
1944 for ( ; rit != end; ++rit)
1945 if (rit->fill() < minfill)
1946 minfill = rit->fill();
1947 l_margin += theFontMetrics(params.getFont()).signedWidth(layout.leftmargin);
1948 l_margin += minfill;
1950 // also wrong, but much shorter.
1951 l_margin += max_width / 2;
1956 if (!par.params().leftIndent().zero())
1957 l_margin += par.params().leftIndent().inPixels(max_width);
1961 if (par.params().align() == LYX_ALIGN_LAYOUT)
1962 align = layout.align;
1964 align = par.params().align();
1966 // set the correct parindent
1968 && (layout.labeltype == LABEL_NO_LABEL
1969 || layout.labeltype == LABEL_TOP_ENVIRONMENT
1970 || layout.labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1971 || (layout.labeltype == LABEL_STATIC
1972 && layout.latextype == LATEX_ENVIRONMENT
1973 && !text_->isFirstInSequence(pit)))
1974 && align == LYX_ALIGN_BLOCK
1975 && !par.params().noindent()
1976 // in some insets, paragraphs are never indented
1977 && !text_->inset().neverIndent()
1978 // display style insets are always centered, omit indentation
1981 && par.getInset(pos)->display())
1982 && (!(tclass.isDefaultLayout(par.layout())
1983 || tclass.isPlainLayout(par.layout()))
1984 || buffer.params().paragraph_separation == BufferParams::ParagraphIndentSeparation)
1987 // use the parindent of the layout when the default indentation is used
1988 // otherwise use the indentation set in the document settings
1989 if (buffer.params().getIndentation().asLyXCommand() == "default")
1990 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1993 l_margin += buffer.params().getIndentation().inPixels(*bv_);
2000 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
2002 ParagraphMetrics const & pm = par_metrics_[pit];
2004 return pm.singleWidth(pos, displayFont(pit, pos));
2008 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
2010 if (par_metrics_.empty())
2016 ParMetricsCache::iterator it = par_metrics_.begin();
2017 ParMetricsCache::iterator const pm_end = par_metrics_.end();
2018 y -= it->second.ascent();
2019 for (; it != pm_end; ++it) {
2020 ParagraphMetrics const & pmi = it->second;
2022 pit_type const pit = it->first;
2023 // Save the paragraph position in the cache.
2024 it->second.setPosition(y);
2025 drawParagraph(pi, pit, x, y);
2031 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
2033 BufferParams const & bparams = bv_->buffer().params();
2034 ParagraphMetrics const & pm = par_metrics_[pit];
2035 if (pm.rows().empty())
2039 bool const original_drawing_state = pi.pain.isDrawingEnabled();
2040 int const ww = bv_->workHeight();
2041 size_t const nrows = pm.rows().size();
2043 Cursor const & cur = bv_->cursor();
2044 DocIterator sel_beg = cur.selectionBegin();
2045 DocIterator sel_end = cur.selectionEnd();
2046 bool selection = cur.selection()
2047 // This is our text.
2048 && cur.text() == text_
2049 // if the anchor is outside, this is not our selection
2050 && cur.anchor().text() == text_
2051 && pit >= sel_beg.pit() && pit <= sel_end.pit();
2053 // We store the begin and end pos of the selection relative to this par
2054 DocIterator sel_beg_par = cur.selectionBegin();
2055 DocIterator sel_end_par = cur.selectionEnd();
2057 // We care only about visible selection.
2059 if (pit != sel_beg.pit()) {
2060 sel_beg_par.pit() = pit;
2061 sel_beg_par.pos() = 0;
2063 if (pit != sel_end.pit()) {
2064 sel_end_par.pit() = pit;
2065 sel_end_par.pos() = sel_end_par.lastpos();
2069 for (size_t i = 0; i != nrows; ++i) {
2071 Row const & row = pm.rows()[i];
2075 bool const inside = (y + row.descent() >= 0
2076 && y - row.ascent() < ww);
2077 // It is not needed to draw on screen if we are not inside.
2078 pi.pain.setDrawingEnabled(inside && original_drawing_state);
2079 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
2082 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
2084 row.setSelection(-1, -1);
2086 // The row knows nothing about the paragraph, so we have to check
2087 // whether this row is the first or last and update the margins.
2088 if (row.selection()) {
2089 if (row.sel_beg == 0)
2090 row.begin_margin_sel = sel_beg.pit() < pit;
2091 if (row.sel_end == sel_end_par.lastpos())
2092 row.end_margin_sel = sel_end.pit() > pit;
2095 // Row signature; has row changed since last paint?
2096 row.setCrc(pm.computeRowSignature(row, bparams));
2097 bool row_has_changed = row.changed();
2099 // Take this opportunity to spellcheck the row contents.
2100 if (row_has_changed && lyxrc.spellcheck_continuously) {
2102 // dummy variable, not used.
2103 static docstring_list suggestions;
2104 pos_type from = row.pos();
2105 pos_type to = row.endpos();
2106 text_->getPar(pit).spellCheck(from, to, wl, suggestions, false);
2109 // Don't paint the row if a full repaint has not been requested
2110 // and if it has not changed.
2111 if (!pi.full_repaint && !row_has_changed) {
2112 // Paint only the insets if the text itself is
2114 rp.paintOnlyInsets();
2119 // Clear background of this row if paragraph background was not
2120 // already cleared because of a full repaint.
2121 if (!pi.full_repaint && row_has_changed) {
2122 pi.pain.fillRectangle(x, y - row.ascent(),
2123 width(), row.height(), pi.background_color);
2126 if (row.selection())
2127 drawRowSelection(pi, x, row, cur, pit);
2129 // Instrumentation for testing row cache (see also
2131 if (lyxerr.debugging(Debug::PAINTING) && inside
2132 && (row.selection() || pi.full_repaint || row_has_changed)) {
2133 string const foreword = text_->isMainText() ?
2134 "main text redraw " : "inset text redraw: ";
2135 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
2136 << " row_selection=" << row.selection()
2137 << " full_repaint=" << pi.full_repaint
2138 << " row_has_changed=" << row_has_changed);
2141 // Backup full_repaint status and force full repaint
2142 // for inner insets as the Row has been cleared out.
2143 bool tmp = pi.full_repaint;
2144 pi.full_repaint = true;
2147 rp.paintChangeBar();
2154 // Restore full_repaint status.
2155 pi.full_repaint = tmp;
2157 // Re-enable screen drawing for future use of the painter.
2158 pi.pain.setDrawingEnabled(original_drawing_state);
2160 //LYXERR(Debug::PAINTING, ".");
2164 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
2165 Cursor const & curs, pit_type pit) const
2167 DocIterator beg = curs.selectionBegin();
2169 beg.pos() = row.sel_beg;
2171 DocIterator end = curs.selectionEnd();
2173 end.pos() = row.sel_end;
2175 bool const begin_boundary = beg.pos() >= row.endpos();
2176 bool const end_boundary = row.sel_end == row.endpos();
2178 DocIterator cur = beg;
2179 cur.boundary(begin_boundary);
2180 int x1 = cursorX(beg.top(), begin_boundary);
2181 int x2 = cursorX(end.top(), end_boundary);
2182 int const y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
2183 int const y2 = y1 + row.height();
2185 int const rm = text_->isMainText() ? bv_->rightMargin() : 0;
2186 int const lm = text_->isMainText() ? bv_->leftMargin() : 0;
2189 if (row.begin_margin_sel) {
2190 if (text_->isRTL(beg.paragraph())) {
2191 pi.pain.fillRectangle(x + x1, y1, width() - rm - x1, y2 - y1,
2194 pi.pain.fillRectangle(x + lm, y1, x1 - lm, y2 - y1,
2199 if (row.end_margin_sel) {
2200 if (text_->isRTL(beg.paragraph())) {
2201 pi.pain.fillRectangle(x + lm, y1, x2 - lm, y2 - y1,
2204 pi.pain.fillRectangle(x + x2, y1, width() - rm - x2, y2 - y1,
2209 // if we are on a boundary from the beginning, it's probably
2210 // a RTL boundary and we jump to the other side directly as this
2211 // segement is 0-size and confuses the logic below
2213 cur.boundary(false);
2215 // go through row and draw from RTL boundary to RTL boundary
2217 bool drawNow = false;
2219 // simplified cursorForward code below which does not
2220 // descend into insets and which does not go into the
2221 // next line. Compare the logic with the original cursorForward
2223 // if left of boundary -> just jump to right side, but
2224 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2225 if (cur.boundary()) {
2226 cur.boundary(false);
2227 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2228 // in front of RTL boundary -> Stay on this side of the boundary
2229 // because: ab|cDDEEFFghi -> abc|DDEEFFghi
2238 if (cur.pos() == row.endpos())
2243 // the previous segment was just drawn, now the next starts
2244 x1 = cursorX(cur.top(), cur.boundary());
2247 if (!(cur < end) || drawNow) {
2248 x2 = cursorX(cur.top(), cur.boundary());
2249 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2252 // reset x1, so it is set again next round (which will be on the
2253 // right side of a boundary or at the selection end)
2260 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2261 Dimension & dim) const
2263 Cursor const & bvcur = cur.bv().cursor();
2265 // get word in front of cursor
2266 docstring word = text_->previousWord(bvcur.top());
2267 DocIterator wordStart = bvcur;
2268 wordStart.pos() -= word.length();
2270 // get position on screen of the word start and end
2271 Point lxy = cur.bv().getPos(wordStart, false);
2272 Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
2274 // calculate dimensions of the word
2275 dim = rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
2276 dim.wid = abs(rxy.x_ - lxy.x_);
2278 // calculate position of word
2280 x = min(rxy.x_, lxy.x_);
2282 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2283 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2286 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2288 // ParagraphMetrics const & pm = par_metrics_[pit];
2289 // Row const & r = pm.rows()[row];
2295 int defaultRowHeight()
2297 return int(theFontMetrics(sane_font).maxHeight() * 1.2);