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 "support/debug.h"
31 #include "FontIterator.h"
32 #include "FuncRequest.h"
33 #include "InsetList.h"
37 #include "MetricsInfo.h"
38 #include "paragraph_funcs.h"
39 #include "ParagraphParameters.h"
40 #include "ParIterator.h"
41 #include "rowpainter.h"
43 #include "TextClass.h"
46 #include "mathed/MacroTable.h"
47 #include "mathed/MathMacroTemplate.h"
49 #include "frontends/FontMetrics.h"
50 #include "frontends/Painter.h"
59 using frontend::FontMetrics;
63 int numberOfSeparators(Paragraph const & par, Row const & row)
65 pos_type const first = max(row.pos(), par.beginOfBody());
66 pos_type const last = row.endpos() - 1;
68 for (pos_type p = first; p < last; ++p) {
69 if (par.isSeparator(p))
76 int numberOfLabelHfills(Paragraph const & par, Row const & row)
78 pos_type last = row.endpos() - 1;
79 pos_type first = row.pos();
81 // hfill *DO* count at the beginning of paragraphs!
83 while (first < last && par.isHfill(first))
87 last = min(last, par.beginOfBody());
89 for (pos_type p = first; p < last; ++p) {
97 int numberOfHfills(Paragraph const & par, Row const & row)
99 pos_type const last = row.endpos();
100 pos_type first = row.pos();
102 // hfill *DO* count at the beginning of paragraphs!
104 while (first < last && par.isHfill(first))
108 first = max(first, par.beginOfBody());
111 for (pos_type p = first; p < last; ++p) {
120 TextMetrics::TextMetrics(BufferView * bv, Text * text)
121 : bv_(bv), text_(text)
124 max_width_ = bv_->workWidth();
125 dim_.wid = max_width_;
129 //text_->updateLabels(bv->buffer());
133 bool TextMetrics::has(pit_type pit) const
135 return par_metrics_.find(pit) != par_metrics_.end();
139 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
141 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
146 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
148 ParMetricsCache::const_iterator it = par_metrics_.begin();
149 return make_pair(it->first, &it->second);
153 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
155 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
156 return make_pair(it->first, &it->second);
160 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
162 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
163 if (pmc_it == par_metrics_.end()) {
164 pmc_it = par_metrics_.insert(
165 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
167 if (pmc_it->second.rows().empty() && redo)
169 return pmc_it->second;
173 int TextMetrics::parPosition(pit_type pit) const
175 if (pit < par_metrics_.begin()->first)
177 if (pit > par_metrics_.rbegin()->first)
180 return par_metrics_[pit].position();
184 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
186 BOOST_ASSERT(mi.base.textwidth);
187 max_width_ = mi.base.textwidth;
188 // backup old dimension.
189 Dimension const old_dim = dim_;
192 dim_.wid = min_width;
193 pit_type const npar = text_->paragraphs().size();
195 // If there is more than one row, expand the text to
196 // the full allowable width.
197 dim_.wid = max_width_;
199 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
200 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
202 bool changed = false;
204 for (pit_type pit = 0; pit != npar; ++pit) {
205 changed |= redoParagraph(pit);
206 ParagraphMetrics const & pm = par_metrics_[pit];
208 if (dim_.wid < pm.width())
209 dim_.wid = pm.width();
212 dim_.asc = par_metrics_[0].ascent();
213 dim_.des = h - dim_.asc;
214 //lyxerr << "dim_.wid " << dim_.wid << endl;
215 //lyxerr << "dim_.asc " << dim_.asc << endl;
216 //lyxerr << "dim_.des " << dim_.des << endl;
218 changed |= dim_ != old_dim;
224 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
226 return main_text_? pm.rightMargin(bv_->buffer()) : 0;
230 int TextMetrics::rightMargin(pit_type const pit) const
232 return main_text_? par_metrics_[pit].rightMargin(bv_->buffer()) : 0;
236 void TextMetrics::applyOuterFont(Font & font) const
239 lf.fontInfo().reduce(bv_->buffer().params().getFont().fontInfo());
240 lf.fontInfo().realize(font.fontInfo());
241 lf.setLanguage(font.language());
246 Font TextMetrics::getDisplayFont(pit_type pit, pos_type pos) const
248 BOOST_ASSERT(pos >= 0);
250 ParagraphList const & pars = text_->paragraphs();
251 Paragraph const & par = pars[pit];
252 LayoutPtr const & layout = par.layout();
253 Buffer const & buffer = bv_->buffer();
255 BufferParams const & params = buffer.params();
256 pos_type const body_pos = par.beginOfBody();
258 // We specialize the 95% common case:
259 if (!par.getDepth()) {
260 Font f = par.getFontSettings(params, pos);
261 if (!text_->isMainText(buffer))
263 bool lab = layout->labeltype == LABEL_MANUAL && pos < body_pos;
265 FontInfo const & lf = lab ? layout->labelfont : layout->font;
266 FontInfo rlf = lab ? layout->reslabelfont : layout->resfont;
268 // In case the default family has been customized
269 if (lf.family() == INHERIT_FAMILY)
270 rlf.setFamily(params.getFont().fontInfo().family());
271 f.fontInfo().realize(rlf);
275 // The uncommon case need not be optimized as much
276 FontInfo const & layoutfont = pos < body_pos ?
277 layout->labelfont : layout->font;
279 Font font = par.getFontSettings(params, pos);
280 font.fontInfo().realize(layoutfont);
282 if (!text_->isMainText(buffer))
283 applyOuterFont(font);
285 // Realize against environment font information
286 // NOTE: the cast to pit_type should be removed when pit_type
287 // changes to a unsigned integer.
288 if (pit < pit_type(pars.size()))
289 font.fontInfo().realize(outerFont(pit, pars).fontInfo());
291 // Realize with the fonts of lesser depth.
292 font.fontInfo().realize(params.getFont().fontInfo());
298 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
300 if (!lyxrc.rtl_support || !sl.text())
304 if (boundary && sl.pos() > 0)
307 return getDisplayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
311 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
313 if (!lyxrc.rtl_support)
316 // no RTL boundary at line start
320 Paragraph const & par = text_->getPar(pit);
322 bool left = getDisplayFont(pit, pos - 1).isVisibleRightToLeft();
324 if (pos == par.size())
325 right = par.isRTL(bv_->buffer().params());
327 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
328 return left != right;
332 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
333 Font const & font) const
335 if (!lyxrc.rtl_support)
338 Paragraph const & par = text_->getPar(pit);
339 bool left = font.isVisibleRightToLeft();
341 if (pos == par.size())
342 right = par.isRTL(bv_->buffer().params());
344 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
345 return left != right;
349 bool TextMetrics::redoParagraph(pit_type const pit)
351 Paragraph & par = text_->getPar(pit);
352 // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
353 // redoParagraph() recursively inside parMetrics.
354 Dimension old_dim = parMetrics(pit, false).dim();
355 ParagraphMetrics & pm = par_metrics_[pit];
358 Buffer & buffer = bv_->buffer();
359 main_text_ = (text_ == &buffer.text());
360 bool changed = false;
362 // FIXME This check ought to be done somewhere else. It is the reason
363 // why text_ is not const. But then, where else to do it?
364 // Well, how can you end up with either (a) a biblio environment that
365 // has no InsetBibitem or (b) a biblio environment with more than one
366 // InsetBibitem? I think the answer is: when paragraphs are merged;
367 // when layout is set; when material is pasted.
368 int const moveCursor = par.checkBiblio(buffer.params().trackChanges);
370 const_cast<Cursor &>(bv_->cursor()).posForward();
371 else if (moveCursor < 0) {
372 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
373 if (cursor.pos() >= -moveCursor)
374 cursor.posBackward();
377 // Optimisation: this is used in the next two loops
378 // so better to calculate that once here.
379 int const right_margin = rightMargin(pm);
382 // FIXME: We should always use getFont(), see documentation of
383 // noFontChange() in Inset.h.
384 Font const bufferfont = buffer.params().getFont();
385 MacroContext mc(buffer, par);
386 InsetList::const_iterator ii = par.insetList().begin();
387 InsetList::const_iterator iend = par.insetList().end();
388 for (; ii != iend; ++ii) {
389 // the macro must come here, _before_ the metric call, because
390 // the macro should see itself to detect recursions. To find out
391 // whether the macro definition is a redefinition it will look
392 // at the MacroData::redefinition_. So it doesn't get confused
393 // by the already existing macro definition of itself in the
395 if (ii->inset->lyxCode() == MATHMACRO_CODE) {
397 MathMacroTemplate const & macroTemplate
398 = static_cast<MathMacroTemplate const &>(*ii->inset);
401 if (macroTemplate.validMacro()) {
402 MacroData macro = macroTemplate.asMacroData();
405 macro.setRedefinition(mc.has(macroTemplate.name()));
407 // register macro (possibly overwrite the previous one of this paragraph)
408 mc.insert(macroTemplate.name(), macro);
412 // do the metric calculation
414 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
416 Font const & font = ii->inset->noFontChange() ?
417 bufferfont : getDisplayFont(pit, ii->pos);
418 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
419 ii->inset->metrics(mi, dim);
420 Dimension const old_dim = pm.insetDimension(ii->inset);
421 pm.setInsetDimension(ii->inset, dim);
422 changed |= (old_dim != dim);
425 Cursor const & cur = bv_->cursor();
426 DocIterator sel_beg = cur.selectionBegin();
427 DocIterator sel_end = cur.selectionEnd();
428 bool selection = cur.selection()
430 && cur.text() == text_
431 // if the anchor is outside, this is not our selection
432 && cur.anchor().text() == text_
433 && pit >= sel_beg.pit() && pit <= sel_end.pit();
435 // We care only about visible selection.
437 if (pit != sel_beg.pit()) {
441 if (pit != sel_end.pit()) {
443 sel_end.pos() = sel_end.lastpos();
447 par.setBeginOfBody();
449 size_t row_index = 0;
450 // maximum pixel width of a row
451 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
454 pos_type end = rowBreakPoint(width, pit, first);
455 if (row_index || end < par.size())
456 // If there is more than one row, expand the text to
457 // the full allowable width. This setting here is needed
458 // for the computeRowMetrics() below.
459 dim_.wid = max_width_;
461 dim = rowHeight(pit, first, end);
462 dim.wid = rowWidth(right_margin, pit, first, end);
463 if (row_index == pm.rows().size())
464 pm.rows().push_back(Row());
465 Row & row = pm.rows()[row_index];
466 row.setChanged(false);
470 row.setSelection(sel_beg.pos(), sel_end.pos());
472 row.setSelection(-1, -1);
473 row.setDimension(dim);
474 int const max_row_width = max(dim_.wid, dim.wid);
475 computeRowMetrics(pit, row, max_row_width);
479 pm.dim().wid = std::max(pm.dim().wid, dim.wid);
480 pm.dim().des += dim.height();
481 } while (first < par.size());
483 if (row_index < pm.rows().size())
484 pm.rows().resize(row_index);
486 // Make sure that if a par ends in newline, there is one more row
488 if (first > 0 && par.isNewline(first - 1)) {
489 Dimension dim = rowHeight(pit, first, first);
490 dim.wid = rowWidth(right_margin, pit, first, first);
491 if (row_index == pm.rows().size())
492 pm.rows().push_back(Row());
493 Row & row = pm.rows()[row_index];
494 row.setChanged(false);
497 row.setDimension(dim);
498 int const max_row_width = max(dim_.wid, dim.wid);
499 computeRowMetrics(pit, row, max_row_width);
500 pm.dim().des += dim.height();
503 pm.dim().asc += pm.rows()[0].ascent();
504 pm.dim().des -= pm.rows()[0].ascent();
506 changed |= old_dim.height() != pm.dim().height();
512 void TextMetrics::computeRowMetrics(pit_type const pit,
513 Row & row, int width) const
519 Buffer & buffer = bv_->buffer();
520 Paragraph const & par = text_->getPar(pit);
522 double w = width - row.width();
523 // FIXME: put back this assertion when the crash on new doc is solved.
524 //BOOST_ASSERT(w >= 0);
526 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
527 //lyxerr << "row.width() " << row.width() << endl;
528 //lyxerr << "w " << w << endl;
530 bool const is_rtl = text_->isRTL(buffer, par);
532 row.x = rightMargin(pit);
534 row.x = leftMargin(max_width_, pit, row.pos());
536 // is there a manual margin with a manual label
537 LayoutPtr const & layout = par.layout();
539 if (layout->margintype == MARGIN_MANUAL
540 && layout->labeltype == LABEL_MANUAL) {
541 /// We might have real hfills in the label part
542 int nlh = numberOfLabelHfills(par, row);
544 // A manual label par (e.g. List) has an auto-hfill
545 // between the label text and the body of the
547 // But we don't want to do this auto hfill if the par
552 if (nlh && !par.getLabelWidthString().empty())
553 row.label_hfill = labelFill(pit, row) / double(nlh);
556 // are there any hfills in the row?
557 int const nh = numberOfHfills(par, row);
562 // we don't have to look at the alignment if it is ALIGN_LEFT and
563 // if the row is already larger then the permitted width as then
564 // we force the LEFT_ALIGN'edness!
565 } else if (int(row.width()) < max_width_) {
566 // is it block, flushleft or flushright?
567 // set x how you need it
569 if (par.params().align() == LYX_ALIGN_LAYOUT)
570 align = layout->align;
572 align = par.params().align();
574 // Display-style insets should always be on a centred row
575 // The test on par.size() is to catch zero-size pars, which
576 // would trigger the assert in Paragraph::getInset().
577 //inset = par.size() ? par.getInset(row.pos()) : 0;
578 if (row.pos() < par.size() && par.isInset(row.pos())) {
579 switch(par.getInset(row.pos())->display()) {
580 case Inset::AlignLeft:
581 align = LYX_ALIGN_BLOCK;
583 case Inset::AlignCenter:
584 align = LYX_ALIGN_CENTER;
587 case Inset::AlignRight:
588 // unchanged (use align)
594 case LYX_ALIGN_BLOCK: {
595 int const ns = numberOfSeparators(par, row);
596 bool disp_inset = false;
597 if (row.endpos() < par.size()) {
598 Inset const * in = par.getInset(row.endpos());
600 disp_inset = in->display();
602 // If we have separators, this is not the last row of a
603 // par, does not end in newline, and is not row above a
604 // display inset... then stretch it
606 && row.endpos() < par.size()
607 && !par.isNewline(row.endpos() - 1)
610 row.separator = w / ns;
611 //lyxerr << "row.separator " << row.separator << endl;
612 //lyxerr << "ns " << ns << endl;
618 case LYX_ALIGN_RIGHT:
621 case LYX_ALIGN_CENTER:
628 pos_type body_pos = par.beginOfBody();
629 pos_type end = row.endpos();
632 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
634 row.x += theFontMetrics(text_->getLabelFont(buffer, par)).
635 width(layout->labelsep);
637 row.x += row.label_hfill;
641 pos_type const endpos = row.endpos();
642 pos_type body_pos = par.beginOfBody();
644 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
647 ParagraphMetrics & pm = par_metrics_[pit];
648 InsetList::const_iterator ii = par.insetList().begin();
649 InsetList::const_iterator iend = par.insetList().end();
650 for ( ; ii != iend; ++ii) {
651 if (ii->pos >= endpos || ii->pos < row.pos()
652 || ii->inset->lyxCode() != HFILL_CODE
653 || !pm.hfillExpansion(row, ii->pos))
656 Dimension dim = row.dimension();
657 dim.wid = int(ii->pos >= body_pos ? row.hfill : row.label_hfill);
658 // Cache the inset dimension.
659 bv_->coordCache().insets().add(ii->inset, dim);
660 pm.setInsetDimension(ii->inset, dim);
665 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
667 Buffer & buffer = bv_->buffer();
668 Paragraph const & par = text_->getPar(pit);
670 pos_type last = par.beginOfBody();
671 BOOST_ASSERT(last > 0);
673 // -1 because a label ends with a space that is in the label
676 // a separator at this end does not count
677 if (par.isLineSeparator(last))
681 for (pos_type i = row.pos(); i <= last; ++i)
682 w += singleWidth(pit, i);
684 docstring const & label = par.params().labelWidthString();
688 FontMetrics const & fm
689 = theFontMetrics(text_->getLabelFont(buffer, par));
691 return max(0, fm.width(label) - w);
695 // this needs special handling - only newlines count as a break point
696 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
698 pos_type const end = par.size();
701 if (par.isNewline(i))
708 int TextMetrics::labelEnd(pit_type const pit) const
710 // labelEnd is only needed if the layout fills a flushleft label.
711 if (text_->getPar(pit).layout()->margintype != MARGIN_MANUAL)
713 // return the beginning of the body
714 return leftMargin(max_width_, pit);
718 pit_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
721 Buffer & buffer = bv_->buffer();
722 ParagraphMetrics const & pm = par_metrics_[pit];
723 Paragraph const & par = text_->getPar(pit);
724 pos_type const end = par.size();
725 if (pos == end || width < 0)
728 LayoutPtr const & layout = par.layout();
730 if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX)
731 return addressBreakPoint(pos, par);
733 pos_type const body_pos = par.beginOfBody();
736 // Now we iterate through until we reach the right margin
737 // or the end of the par, then choose the possible break
740 int label_end = labelEnd(pit);
741 int const left = leftMargin(max_width_, pit, pos);
744 // pixel width since last breakpoint
747 FontIterator fi = FontIterator(*this, par, pit, pos);
748 pos_type point = end;
750 for ( ; i < end; ++i, ++fi) {
751 int thiswidth = pm.singleWidth(i, *fi);
753 // add the auto-hfill from label end to the body
754 if (body_pos && i == body_pos) {
755 FontMetrics const & fm = theFontMetrics(
756 text_->getLabelFont(buffer, par));
757 int add = fm.width(layout->labelsep);
758 if (par.isLineSeparator(i - 1))
759 add -= singleWidth(pit, i - 1);
761 add = std::max(add, label_end - x);
766 chunkwidth += thiswidth;
768 // break before a character that will fall off
769 // the right of the row
771 // if no break before, break here
772 if (point == end || chunkwidth >= width - left) {
778 // exit on last registered breakpoint:
782 if (par.isNewline(i)) {
788 if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
793 if (par.isInset(i) && par.getInset(i)->display()) {
799 if (!par.isInset(i) || par.getInset(i)->isChar()) {
800 // some insets are line separators too
801 if (par.isLineSeparator(i)) {
802 // register breakpoint:
809 // maybe found one, but the par is short enough.
810 if (i == end && x < width)
813 // manual labels cannot be broken in LaTeX. But we
814 // want to make our on-screen rendering of footnotes
816 if (body_pos && point < body_pos)
823 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
824 pos_type const first, pos_type const end) const
826 Buffer & buffer = bv_->buffer();
827 // get the pure distance
828 ParagraphMetrics const & pm = par_metrics_[pit];
829 Paragraph const & par = text_->getPar(pit);
830 int w = leftMargin(max_width_, pit, first);
831 int label_end = labelEnd(pit);
833 pos_type const body_pos = par.beginOfBody();
837 FontIterator fi = FontIterator(*this, par, pit, i);
838 for ( ; i < end; ++i, ++fi) {
839 if (body_pos > 0 && i == body_pos) {
840 FontMetrics const & fm = theFontMetrics(
841 text_->getLabelFont(buffer, par));
842 w += fm.width(par.layout()->labelsep);
843 if (par.isLineSeparator(i - 1))
844 w -= singleWidth(pit, i - 1);
845 w = max(w, label_end);
847 w += pm.singleWidth(i, *fi);
851 if (body_pos > 0 && body_pos >= end) {
852 FontMetrics const & fm = theFontMetrics(
853 text_->getLabelFont(buffer, par));
854 w += fm.width(par.layout()->labelsep);
855 if (end > 0 && par.isLineSeparator(end - 1))
856 w -= singleWidth(pit, end - 1);
857 w = max(w, label_end);
860 return w + right_margin;
864 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
865 pos_type const end) const
867 Paragraph const & par = text_->getPar(pit);
868 // get the maximum ascent and the maximum descent
869 double layoutasc = 0;
870 double layoutdesc = 0;
871 double const dh = defaultRowHeight();
873 // ok, let us initialize the maxasc and maxdesc value.
874 // Only the fontsize count. The other properties
875 // are taken from the layoutfont. Nicer on the screen :)
876 LayoutPtr const & layout = par.layout();
878 // as max get the first character of this row then it can
879 // increase but not decrease the height. Just some point to
880 // start with so we don't have to do the assignment below too
882 Buffer const & buffer = bv_->buffer();
883 Font font = getDisplayFont(pit, first);
884 FontSize const tmpsize = font.fontInfo().size();
885 font.fontInfo() = text_->getLayoutFont(buffer, pit);
886 FontSize const size = font.fontInfo().size();
887 font.fontInfo().setSize(tmpsize);
889 FontInfo labelfont = text_->getLabelFont(buffer, par);
891 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
892 FontMetrics const & fontmetrics = theFontMetrics(font);
894 // these are minimum values
895 double const spacing_val = layout->spacing.getValue()
896 * text_->spacing(buffer, par);
897 //lyxerr << "spacing_val = " << spacing_val << endl;
898 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
899 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
901 // insets may be taller
902 ParagraphMetrics const & pm = par_metrics_[pit];
903 InsetList::const_iterator ii = par.insetList().begin();
904 InsetList::const_iterator iend = par.insetList().end();
905 for ( ; ii != iend; ++ii) {
906 Dimension const & dim = pm.insetDimension(ii->inset);
907 if (ii->pos >= first && ii->pos < end) {
908 maxasc = max(maxasc, dim.ascent());
909 maxdesc = max(maxdesc, dim.descent());
913 // Check if any custom fonts are larger (Asger)
914 // This is not completely correct, but we can live with the small,
915 // cosmetic error for now.
919 par.highestFontInRange(first, end, size);
920 if (maxsize > font.fontInfo().size()) {
921 // use standard paragraph font with the maximal size
922 FontInfo maxfont = font.fontInfo();
923 maxfont.setSize(maxsize);
924 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
925 maxasc = max(maxasc, maxfontmetrics.maxAscent());
926 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
929 // This is nicer with box insets:
933 ParagraphList const & pars = text_->paragraphs();
937 BufferParams const & bufparams = buffer.params();
938 // some parskips VERY EASY IMPLEMENTATION
939 if (bufparams.paragraph_separation
940 == BufferParams::PARSEP_SKIP
941 && par.ownerCode() != ERT_CODE
942 && par.ownerCode() != LISTINGS_CODE
944 && ((layout->isParagraph() && par.getDepth() == 0)
945 || (pars[pit - 1].layout()->isParagraph()
946 && pars[pit - 1].getDepth() == 0)))
948 maxasc += bufparams.getDefSkip().inPixels(*bv_);
951 if (par.params().startOfAppendix())
952 maxasc += int(3 * dh);
954 // This is special code for the chapter, since the label of this
955 // layout is printed in an extra row
956 if (layout->counter == "chapter"
957 && !par.params().labelString().empty()) {
958 labeladdon = int(labelfont_metrics.maxHeight()
959 * layout->spacing.getValue()
960 * text_->spacing(buffer, par));
963 // special code for the top label
964 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
965 || layout->labeltype == LABEL_BIBLIO
966 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
967 && isFirstInSequence(pit, pars)
968 && !par.getLabelstring().empty())
971 labelfont_metrics.maxHeight()
972 * layout->spacing.getValue()
973 * text_->spacing(buffer, par)
974 + (layout->topsep + layout->labelbottomsep) * dh);
977 // Add the layout spaces, for example before and after
978 // a section, or between the items of a itemize or enumerate
981 pit_type prev = depthHook(pit, pars, par.getDepth());
982 Paragraph const & prevpar = pars[prev];
984 && prevpar.layout() == layout
985 && prevpar.getDepth() == par.getDepth()
986 && prevpar.getLabelWidthString()
987 == par.getLabelWidthString()) {
988 layoutasc = layout->itemsep * dh;
989 } else if (pit != 0 || first != 0) {
990 if (layout->topsep > 0)
991 layoutasc = layout->topsep * dh;
994 prev = outerHook(pit, pars);
995 if (prev != pit_type(pars.size())) {
996 maxasc += int(pars[prev].layout()->parsep * dh);
997 } else if (pit != 0) {
998 Paragraph const & prevpar = pars[pit - 1];
999 if (prevpar.getDepth() != 0 ||
1000 prevpar.layout() == layout) {
1001 maxasc += int(layout->parsep * dh);
1006 // is it a bottom line?
1007 if (end >= par.size()) {
1008 // add the layout spaces, for example before and after
1009 // a section, or between the items of a itemize or enumerate
1011 pit_type nextpit = pit + 1;
1012 if (nextpit != pit_type(pars.size())) {
1013 pit_type cpit = pit;
1017 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1018 usual = pars[cpit].layout()->bottomsep * dh;
1019 cpit = depthHook(cpit, pars, pars[nextpit].getDepth());
1020 if (pars[cpit].layout() != pars[nextpit].layout()
1021 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1023 unusual = pars[cpit].layout()->bottomsep * dh;
1025 layoutdesc = max(unusual, usual);
1026 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1027 if (pars[cpit].layout() != pars[nextpit].layout()
1028 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1029 layoutdesc = int(pars[cpit].layout()->bottomsep * dh);
1034 // incalculate the layout spaces
1035 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1036 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1038 // FIXME: the correct way is to do the following is to move the
1039 // following code in another method specially tailored for the
1040 // main Text. The following test is thus bogus.
1041 // Top and bottom margin of the document (only at top-level)
1043 if (pit == 0 && first == 0)
1045 if (pit + 1 == pit_type(pars.size()) &&
1046 end == par.size() &&
1047 !(end > 0 && par.isNewline(end - 1)))
1051 return Dimension(0, maxasc + labeladdon, maxdesc);
1055 // x is an absolute screen coord
1056 // returns the column near the specified x-coordinate of the row
1057 // x is set to the real beginning of this column
1058 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1059 Row const & row, int & x, bool & boundary) const
1061 Buffer const & buffer = bv_->buffer();
1063 /// For the main Text, it is possible that this pit is not
1064 /// yet in the CoordCache when moving cursor up.
1065 /// x Paragraph coordinate is always 0 for main text anyway.
1066 int const xo = origin_.x_;
1068 Paragraph const & par = text_->getPar(pit);
1070 bidi.computeTables(par, buffer, row);
1072 pos_type vc = row.pos();
1073 pos_type end = row.endpos();
1075 LayoutPtr const & layout = par.layout();
1077 bool left_side = false;
1079 pos_type body_pos = par.beginOfBody();
1081 double tmpx = row.x;
1082 double last_tmpx = tmpx;
1085 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1088 // check for empty row
1094 while (vc < end && tmpx <= x) {
1095 c = bidi.vis2log(vc);
1097 if (body_pos > 0 && c == body_pos - 1) {
1098 FontMetrics const & fm = theFontMetrics(
1099 text_->getLabelFont(buffer, par));
1100 tmpx += row.label_hfill + fm.width(layout->labelsep);
1101 if (par.isLineSeparator(body_pos - 1))
1102 tmpx -= singleWidth(pit, body_pos - 1);
1105 tmpx += singleWidth(pit, c);
1106 if (par.isSeparator(c) && c >= body_pos)
1107 tmpx += row.separator;
1111 if ((tmpx + last_tmpx) / 2 > x) {
1116 BOOST_ASSERT(vc <= end); // This shouldn't happen.
1119 // This (rtl_support test) is not needed, but gives
1120 // some speedup if rtl_support == false
1121 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1123 // If lastrow is false, we don't need to compute
1124 // the value of rtl.
1125 bool const rtl = lastrow ? text_->isRTL(buffer, par) : false;
1127 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1128 (!rtl && !left_side && vc == end && x > tmpx + 5)))
1130 else if (vc == row.pos()) {
1131 c = bidi.vis2log(vc);
1132 if (bidi.level(c) % 2 == 1)
1135 c = bidi.vis2log(vc - 1);
1136 bool const rtl = (bidi.level(c) % 2 == 1);
1137 if (left_side == rtl) {
1139 boundary = isRTLBoundary(pit, c);
1143 // I believe this code is not needed anymore (Jug 20050717)
1145 // The following code is necessary because the cursor position past
1146 // the last char in a row is logically equivalent to that before
1147 // the first char in the next row. That's why insets causing row
1148 // divisions -- Newline and display-style insets -- must be treated
1149 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1150 // Newline inset, air gap below:
1151 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1152 if (bidi.level(end -1) % 2 == 0)
1153 tmpx -= singleWidth(pit, end - 1);
1155 tmpx += singleWidth(pit, end - 1);
1159 // Air gap above display inset:
1160 if (row.pos() < end && c >= end && end < par.size()
1161 && par.isInset(end) && par.getInset(end)->display()) {
1164 // Air gap below display inset:
1165 if (row.pos() < end && c >= end && par.isInset(end - 1)
1166 && par.getInset(end - 1)->display()) {
1172 pos_type const col = c - row.pos();
1174 if (!c || end == par.size())
1177 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1182 return min(col, end - 1 - row.pos());
1186 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1188 // We play safe and use parMetrics(pit) to make sure the
1189 // ParagraphMetrics will be redone and OK to use if needed.
1190 // Otherwise we would use an empty ParagraphMetrics in
1191 // upDownInText() while in selection mode.
1192 ParagraphMetrics const & pm = parMetrics(pit);
1194 BOOST_ASSERT(row < int(pm.rows().size()));
1196 Row const & r = pm.rows()[row];
1197 return r.pos() + getColumnNearX(pit, r, x, bound);
1201 void TextMetrics::newParMetricsDown()
1203 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1204 pit_type const pit = last.first + 1;
1205 if (pit == int(text_->paragraphs().size()))
1208 // do it and update its position.
1210 par_metrics_[pit].setPosition(last.second.position()
1211 + last.second.descent());
1215 void TextMetrics::newParMetricsUp()
1217 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1218 if (first.first == 0)
1221 pit_type const pit = first.first - 1;
1222 // do it and update its position.
1224 par_metrics_[pit].setPosition(first.second.position()
1225 - first.second.ascent());
1228 // y is screen coordinate
1229 pit_type TextMetrics::getPitNearY(int y)
1231 BOOST_ASSERT(!text_->paragraphs().empty());
1232 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1234 // look for highest numbered paragraph with y coordinate less than given y
1237 ParMetricsCache::const_iterator it = par_metrics_.begin();
1238 ParMetricsCache::const_iterator et = par_metrics_.end();
1239 ParMetricsCache::const_iterator last = et; last--;
1241 ParagraphMetrics const & pm = it->second;
1243 if (y < it->second.position() - int(pm.ascent())) {
1244 // We are looking for a position that is before the first paragraph in
1245 // the cache (which is in priciple off-screen, that is before the
1248 // We are already at the first paragraph in the inset.
1250 // OK, this is the paragraph we are looking for.
1251 pit = it->first - 1;
1256 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1258 if (y >= last->second.position() + int(pm_last.descent())) {
1259 // We are looking for a position that is after the last paragraph in
1260 // the cache (which is in priciple off-screen, that is before the
1262 pit = last->first + 1;
1263 if (pit == int(text_->paragraphs().size()))
1264 // We are already at the last paragraph in the inset.
1266 // OK, this is the paragraph we are looking for.
1267 newParMetricsDown();
1271 for (; it != et; ++it) {
1272 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1273 << " y: " << it->second.position());
1275 ParagraphMetrics const & pm = par_metrics_[it->first];
1277 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1279 yy = it->second.position();
1283 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1289 Row const & TextMetrics::getRowNearY(int y, pit_type pit) const
1291 ParagraphMetrics const & pm = par_metrics_[pit];
1293 int yy = pm.position() - pm.ascent();
1294 BOOST_ASSERT(!pm.rows().empty());
1295 RowList::const_iterator rit = pm.rows().begin();
1296 RowList::const_iterator rlast = pm.rows().end();
1298 for (; rit != rlast; yy += rit->height(), ++rit)
1299 if (yy + rit->height() > y)
1305 // x,y are absolute screen coordinates
1306 // sets cursor recursively descending into nested editable insets
1307 Inset * TextMetrics::editXY(Cursor & cur, int x, int y)
1309 if (lyxerr.debugging(Debug::WORKAREA)) {
1310 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1311 cur.bv().coordCache().dump();
1313 pit_type pit = getPitNearY(y);
1314 BOOST_ASSERT(pit != -1);
1316 Row const & row = getRowNearY(y, pit);
1319 int xx = x; // is modified by getColumnNearX
1320 pos_type const pos = row.pos()
1321 + getColumnNearX(pit, row, xx, bound);
1324 cur.boundary(bound);
1327 // try to descend into nested insets
1328 Inset * inset = checkInsetHit(x, y);
1329 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1331 // Either we deconst editXY or better we move current_font
1332 // and real_current_font to Cursor
1333 // FIXME: what is needed now that current_font and real_current_font
1335 cur.setCurrentFont();
1339 ParagraphList const & pars = text_->paragraphs();
1340 Inset const * insetBefore = pos? pars[pit].getInset(pos - 1): 0;
1341 //Inset * insetBehind = pars[pit].getInset(pos);
1343 // This should be just before or just behind the
1344 // cursor position set above.
1345 BOOST_ASSERT((pos != 0 && inset == insetBefore)
1346 || inset == pars[pit].getInset(pos));
1348 // Make sure the cursor points to the position before
1350 if (inset == insetBefore) {
1352 cur.boundary(false);
1355 // Try to descend recursively inside the inset.
1356 inset = inset->editXY(cur, x, y);
1358 if (cur.top().text() == text_)
1359 cur.setCurrentFont();
1364 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1366 BOOST_ASSERT(text_ == cur.text());
1367 pit_type pit = getPitNearY(y);
1369 ParagraphMetrics const & pm = par_metrics_[pit];
1371 int yy = pm.position() - pm.ascent();
1372 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1373 " pit: " << pit << " yy: " << yy);
1376 BOOST_ASSERT(pm.rows().size());
1377 for (; r < int(pm.rows().size()) - 1; ++r) {
1378 Row const & row = pm.rows()[r];
1379 if (int(yy + row.height()) > y)
1384 Row const & row = pm.rows()[r];
1386 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1390 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1392 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1394 text_->setCursor(cur, pit, pos, true, bound);
1395 // remember new position.
1400 //takes screen x,y coordinates
1401 Inset * TextMetrics::checkInsetHit(int x, int y)
1403 pit_type pit = getPitNearY(y);
1404 BOOST_ASSERT(pit != -1);
1406 Paragraph const & par = text_->paragraphs()[pit];
1407 ParagraphMetrics const & pm = par_metrics_[pit];
1409 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1411 InsetList::const_iterator iit = par.insetList().begin();
1412 InsetList::const_iterator iend = par.insetList().end();
1413 for (; iit != iend; ++iit) {
1414 Inset * inset = iit->inset;
1416 LYXERR(Debug::DEBUG, "examining inset " << inset);
1418 if (!bv_->coordCache().getInsets().has(inset)) {
1419 LYXERR(Debug::DEBUG, "inset has no cached position");
1423 Dimension const & dim = pm.insetDimension(inset);
1424 Point p = bv_->coordCache().getInsets().xy(inset);
1426 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1427 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1430 && x <= p.x_ + dim.wid
1431 && y >= p.y_ - dim.asc
1432 && y <= p.y_ + dim.des) {
1433 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1438 LYXERR(Debug::DEBUG, "No inset hit. ");
1443 int TextMetrics::cursorX(CursorSlice const & sl,
1444 bool boundary) const
1446 BOOST_ASSERT(sl.text() == text_);
1447 pit_type const pit = sl.pit();
1448 Paragraph const & par = text_->paragraphs()[pit];
1449 ParagraphMetrics const & pm = par_metrics_[pit];
1450 if (pm.rows().empty())
1453 pos_type ppos = sl.pos();
1454 // Correct position in front of big insets
1455 bool const boundary_correction = ppos != 0 && boundary;
1456 if (boundary_correction)
1459 Row const & row = pm.getRow(sl.pos(), boundary);
1461 pos_type cursor_vpos = 0;
1463 Buffer const & buffer = bv_->buffer();
1466 bidi.computeTables(par, buffer, row);
1468 pos_type const row_pos = row.pos();
1469 pos_type const end = row.endpos();
1470 // Spaces at logical line breaks in bidi text must be skipped during
1471 // cursor positioning. However, they may appear visually in the middle
1472 // of a row; they must be skipped, wherever they are...
1473 // * logically "abc_[HEBREW_\nHEBREW]"
1474 // * visually "abc_[_WERBEH\nWERBEH]"
1475 pos_type skipped_sep_vpos = -1;
1478 cursor_vpos = row_pos;
1479 else if (ppos >= end)
1480 cursor_vpos = text_->isRTL(buffer, par) ? row_pos : end;
1481 else if (ppos > row_pos && ppos >= end)
1482 // Place cursor after char at (logical) position pos - 1
1483 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1484 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1486 // Place cursor before char at (logical) position ppos
1487 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1488 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1490 pos_type body_pos = par.beginOfBody();
1492 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1495 // Use font span to speed things up, see below
1499 // If the last logical character is a separator, skip it, unless
1500 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1501 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1502 skipped_sep_vpos = bidi.log2vis(end - 1);
1504 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1505 // Skip the separator which is at the logical end of the row
1506 if (vpos == skipped_sep_vpos)
1508 pos_type pos = bidi.vis2log(vpos);
1509 if (body_pos > 0 && pos == body_pos - 1) {
1510 FontMetrics const & labelfm = theFontMetrics(
1511 text_->getLabelFont(buffer, par));
1512 x += row.label_hfill + labelfm.width(par.layout()->labelsep);
1513 if (par.isLineSeparator(body_pos - 1))
1514 x -= singleWidth(pit, body_pos - 1);
1517 // Use font span to speed things up, see above
1518 if (pos < font_span.first || pos > font_span.last) {
1519 font_span = par.fontSpan(pos);
1520 font = getDisplayFont(pit, pos);
1523 x += pm.singleWidth(pos, font);
1525 if (par.isSeparator(pos) && pos >= body_pos)
1529 // see correction above
1530 if (boundary_correction) {
1531 if (isRTL(sl, boundary))
1532 x -= singleWidth(pit, ppos);
1534 x += singleWidth(pit, ppos);
1541 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1543 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << std::endl;
1544 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1545 if (pm.rows().empty())
1549 h -= par_metrics_[0].rows()[0].ascent();
1550 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1551 h += par_metrics_[pit].height();
1554 if (pos && boundary)
1556 size_t const rend = pm.pos2row(pos);
1557 for (size_t rit = 0; rit != rend; ++rit)
1558 h += pm.rows()[rit].height();
1559 h += pm.rows()[rend].ascent();
1564 void TextMetrics::cursorPrevious(Cursor & cur)
1566 pos_type cpos = cur.pos();
1567 pit_type cpar = cur.pit();
1569 int x = cur.x_target();
1570 setCursorFromCoordinates(cur, x, 0);
1571 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1573 if (cpar == cur.pit() && cpos == cur.pos())
1574 // we have a row which is taller than the workarea. The
1575 // simplest solution is to move to the previous row instead.
1576 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1579 cur.updateFlags(Update::Force | Update::FitCursor);
1583 void TextMetrics::cursorNext(Cursor & cur)
1585 pos_type cpos = cur.pos();
1586 pit_type cpar = cur.pit();
1588 int x = cur.x_target();
1589 setCursorFromCoordinates(cur, x, cur.bv().workHeight() - 1);
1590 cur.dispatch(FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1592 if (cpar == cur.pit() && cpos == cur.pos())
1593 // we have a row which is taller than the workarea. The
1594 // simplest solution is to move to the next row instead.
1596 FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1599 cur.updateFlags(Update::Force | Update::FitCursor);
1603 // the cursor set functions have a special mechanism. When they
1604 // realize you left an empty paragraph, they will delete it.
1606 bool TextMetrics::cursorHome(Cursor & cur)
1608 BOOST_ASSERT(text_ == cur.text());
1609 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1610 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1611 return text_->setCursor(cur, cur.pit(), row.pos());
1615 bool TextMetrics::cursorEnd(Cursor & cur)
1617 BOOST_ASSERT(text_ == cur.text());
1618 // if not on the last row of the par, put the cursor before
1619 // the final space exept if I have a spanning inset or one string
1620 // is so long that we force a break.
1621 pos_type end = cur.textRow().endpos();
1623 // empty text, end-1 is no valid position
1625 bool boundary = false;
1626 if (end != cur.lastpos()) {
1627 if (!cur.paragraph().isLineSeparator(end-1)
1628 && !cur.paragraph().isNewline(end-1))
1633 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1637 void TextMetrics::deleteLineForward(Cursor & cur)
1639 BOOST_ASSERT(text_ == cur.text());
1640 if (cur.lastpos() == 0) {
1641 // Paragraph is empty, so we just go forward
1642 text_->cursorForward(cur);
1645 cur.selection() = true; // to avoid deletion
1648 // What is this test for ??? (JMarc)
1649 if (!cur.selection())
1650 text_->deleteWordForward(cur);
1652 cap::cutSelection(cur, true, false);
1653 checkBufferStructure(cur.buffer(), cur);
1658 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1660 ParagraphList const & pars = text_->paragraphs();
1661 return row.endpos() >= pars[pit].size()
1662 && pit + 1 == pit_type(pars.size());
1666 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1668 return row.pos() == 0 && pit == 0;
1672 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1674 BOOST_ASSERT(pit >= 0);
1675 BOOST_ASSERT(pit < int(text_->paragraphs().size()));
1676 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1680 int TextMetrics::leftMargin(int max_width,
1681 pit_type const pit, pos_type const pos) const
1683 ParagraphList const & pars = text_->paragraphs();
1685 BOOST_ASSERT(pit >= 0);
1686 BOOST_ASSERT(pit < int(pars.size()));
1687 Paragraph const & par = pars[pit];
1688 BOOST_ASSERT(pos >= 0);
1689 BOOST_ASSERT(pos <= par.size());
1690 Buffer const & buffer = bv_->buffer();
1691 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1692 TextClass const & tclass = buffer.params().getTextClass();
1693 LayoutPtr const & layout = par.layout();
1695 docstring parindent = layout->parindent;
1699 if (text_->isMainText(buffer))
1700 l_margin += changebarMargin();
1702 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1703 tclass.leftmargin());
1705 if (par.getDepth() != 0) {
1706 // find the next level paragraph
1707 pit_type newpar = outerHook(pit, pars);
1708 if (newpar != pit_type(pars.size())) {
1709 if (pars[newpar].layout()->isEnvironment()) {
1710 l_margin = leftMargin(max_width, newpar);
1712 if (par.layout() == tclass.defaultLayout()) {
1713 if (pars[newpar].params().noindent())
1716 parindent = pars[newpar].layout()->parindent;
1721 // This happens after sections in standard classes. The 1.3.x
1722 // code compared depths too, but it does not seem necessary
1724 if (par.layout() == tclass.defaultLayout()
1725 && pit > 0 && pars[pit - 1].layout()->nextnoindent)
1728 FontInfo const labelfont = text_->getLabelFont(buffer, par);
1729 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1731 switch (layout->margintype) {
1732 case MARGIN_DYNAMIC:
1733 if (!layout->leftmargin.empty()) {
1734 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1735 layout->leftmargin);
1737 if (!par.getLabelstring().empty()) {
1738 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1739 l_margin += labelfont_metrics.width(par.getLabelstring());
1740 l_margin += labelfont_metrics.width(layout->labelsep);
1744 case MARGIN_MANUAL: {
1745 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1746 // The width of an empty par, even with manual label, should be 0
1747 if (!par.empty() && pos >= par.beginOfBody()) {
1748 if (!par.getLabelWidthString().empty()) {
1749 docstring labstr = par.getLabelWidthString();
1750 l_margin += labelfont_metrics.width(labstr);
1751 l_margin += labelfont_metrics.width(layout->labelsep);
1757 case MARGIN_STATIC: {
1758 l_margin += theFontMetrics(buffer.params().getFont()).
1759 signedWidth(layout->leftmargin) * 4 / (par.getDepth() + 4);
1763 case MARGIN_FIRST_DYNAMIC:
1764 if (layout->labeltype == LABEL_MANUAL) {
1765 if (pos >= par.beginOfBody()) {
1766 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1768 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1771 // Special case to fix problems with
1773 || (layout->labeltype == LABEL_STATIC
1774 && layout->latextype == LATEX_ENVIRONMENT
1775 && !isFirstInSequence(pit, pars))) {
1776 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1777 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
1778 && layout->labeltype != LABEL_BIBLIO
1779 && layout->labeltype !=
1780 LABEL_CENTERED_TOP_ENVIRONMENT) {
1781 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1782 l_margin += labelfont_metrics.width(layout->labelsep);
1783 l_margin += labelfont_metrics.width(par.getLabelstring());
1787 case MARGIN_RIGHT_ADDRESS_BOX: {
1789 // ok, a terrible hack. The left margin depends on the widest
1790 // row in this paragraph.
1791 RowList::iterator rit = par.rows().begin();
1792 RowList::iterator end = par.rows().end();
1793 // FIXME: This is wrong.
1794 int minfill = max_width;
1795 for ( ; rit != end; ++rit)
1796 if (rit->fill() < minfill)
1797 minfill = rit->fill();
1798 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
1799 l_margin += minfill;
1801 // also wrong, but much shorter.
1802 l_margin += max_width / 2;
1807 if (!par.params().leftIndent().zero())
1808 l_margin += par.params().leftIndent().inPixels(max_width);
1812 if (par.params().align() == LYX_ALIGN_LAYOUT)
1813 align = layout->align;
1815 align = par.params().align();
1817 // set the correct parindent
1819 && (layout->labeltype == LABEL_NO_LABEL
1820 || layout->labeltype == LABEL_TOP_ENVIRONMENT
1821 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1822 || (layout->labeltype == LABEL_STATIC
1823 && layout->latextype == LATEX_ENVIRONMENT
1824 && !isFirstInSequence(pit, pars)))
1825 && align == LYX_ALIGN_BLOCK
1826 && !par.params().noindent()
1827 // in some insets, paragraphs are never indented
1828 && !(par.inInset() && par.inInset()->neverIndent(buffer))
1829 // display style insets are always centered, omit indentation
1832 && par.getInset(pos)->display())
1833 && (par.layout() != tclass.defaultLayout()
1834 || buffer.params().paragraph_separation ==
1835 BufferParams::PARSEP_INDENT))
1837 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1845 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
1847 ParagraphMetrics const & pm = par_metrics_[pit];
1849 return pm.singleWidth(pos, getDisplayFont(pit, pos));
1853 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1855 if (par_metrics_.empty())
1861 ParMetricsCache::iterator it = par_metrics_.begin();
1862 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1863 y -= it->second.ascent();
1864 for (; it != pm_end; ++it) {
1865 ParagraphMetrics const & pmi = it->second;
1867 pit_type const pit = it->first;
1868 // Save the paragraph position in the cache.
1869 it->second.setPosition(y);
1870 drawParagraph(pi, pit, x, y);
1876 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1878 BufferParams const & bparams = bv_->buffer().params();
1879 ParagraphMetrics const & pm = par_metrics_[pit];
1880 if (pm.rows().empty())
1884 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1885 int const ww = bv_->workHeight();
1886 size_t const nrows = pm.rows().size();
1888 for (size_t i = 0; i != nrows; ++i) {
1890 Row const & row = pm.rows()[i];
1894 bool const inside = (y + row.descent() >= 0
1895 && y - row.ascent() < ww);
1896 // It is not needed to draw on screen if we are not inside.
1897 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1898 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
1900 // Row signature; has row changed since last paint?
1901 row.setCrc(pm.computeRowSignature(row, bparams));
1902 bool row_has_changed = row.changed();
1904 // Don't paint the row if a full repaint has not been requested
1905 // and if it has not changed.
1906 if (!pi.full_repaint && !row_has_changed) {
1907 // Paint only the insets if the text itself is
1909 rp.paintOnlyInsets();
1914 // Clear background of this row if paragraph background was not
1915 // already cleared because of a full repaint.
1916 if (!pi.full_repaint && row_has_changed) {
1917 pi.pain.fillRectangle(x, y - row.ascent(),
1918 width(), row.height(), pi.background_color);
1921 bool row_selection = row.sel_beg != -1 && row.sel_end != -1;
1922 if (row_selection) {
1923 DocIterator beg = bv_->cursor().selectionBegin();
1924 DocIterator end = bv_->cursor().selectionEnd();
1925 bool const beg_margin = beg.pit() < pit && i == 0;
1926 bool const end_margin = end.pit() > pit && i == nrows - 1;
1928 beg.pos() = row.sel_beg;
1930 end.pos() = row.sel_end;
1931 drawRowSelection(pi, x, row, beg, end, beg_margin, end_margin);
1934 // Instrumentation for testing row cache (see also
1936 if (lyxerr.debugging(Debug::PAINTING) && inside
1937 && (row_selection || pi.full_repaint || row_has_changed)) {
1938 std::string const foreword = text_->isMainText(bv_->buffer()) ?
1939 "main text redraw " : "inset text redraw: ";
1940 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1941 << " row_selection=" << row_selection
1942 << " full_repaint=" << pi.full_repaint
1943 << " row_has_changed=" << row_has_changed);
1946 // Backup full_repaint status and force full repaint
1947 // for inner insets as the Row has been cleared out.
1948 bool tmp = pi.full_repaint;
1949 pi.full_repaint = true;
1952 rp.paintChangeBar();
1959 // Restore full_repaint status.
1960 pi.full_repaint = tmp;
1962 // Re-enable screen drawing for future use of the painter.
1963 pi.pain.setDrawingEnabled(original_drawing_state);
1965 //LYXERR(Debug::PAINTING, ".");
1969 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
1970 DocIterator const & beg, DocIterator const & end,
1971 bool drawOnBegMargin, bool drawOnEndMargin) const
1973 Buffer & buffer = bv_->buffer();
1974 DocIterator cur = beg;
1975 int x1 = cursorX(beg.top(), beg.boundary());
1976 int x2 = cursorX(end.top(), end.boundary());
1977 int y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
1978 int y2 = y1 + row.height();
1981 if (drawOnBegMargin) {
1982 if (text_->isRTL(buffer, beg.paragraph()))
1983 pi.pain.fillRectangle(x + x1, y1, width() - x1, y2 - y1, Color_selection);
1985 pi.pain.fillRectangle(x, y1, x1, y2 - y1, Color_selection);
1988 if (drawOnEndMargin) {
1989 if (text_->isRTL(buffer, beg.paragraph()))
1990 pi.pain.fillRectangle(x, y1, x2, y2 - y1, Color_selection);
1992 pi.pain.fillRectangle(x + x2, y1, width() - x2, y2 - y1, Color_selection);
1995 // if we are on a boundary from the beginning, it's probably
1996 // a RTL boundary and we jump to the other side directly as this
1997 // segement is 0-size and confuses the logic below
1999 cur.boundary(false);
2001 // go through row and draw from RTL boundary to RTL boundary
2003 bool drawNow = false;
2005 // simplified cursorForward code below which does not
2006 // descend into insets and which does not go into the
2007 // next line. Compare the logic with the original cursorForward
2009 // if left of boundary -> just jump to right side
2010 // but for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2011 if (cur.boundary()) {
2012 cur.boundary(false);
2013 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2014 // in front of RTL boundary -> Stay on this side of the boundary because:
2015 // ab|cDDEEFFghi -> abc|DDEEFFghi
2024 if (cur.pos() == row.endpos())
2029 // the previous segment was just drawn, now the next starts
2030 x1 = cursorX(cur.top(), cur.boundary());
2033 if (!(cur < end) || drawNow) {
2034 x2 = cursorX(cur.top(), cur.boundary());
2035 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2038 // reset x1, so it is set again next round (which will be on the
2039 // right side of a boundary or at the selection end)
2045 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2047 // ParagraphMetrics const & pm = par_metrics_[pit];
2048 // Row const & r = pm.rows()[row];
2054 int defaultRowHeight()
2056 return int(theFontMetrics(sane_font).maxHeight() * 1.2);