2 * \file src/TextMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Jürgen Vigna
13 * \author Abdelrazak Younes
15 * Full author contact details are available in file CREDITS.
20 #include "TextMetrics.h"
23 #include "buffer_funcs.h"
24 #include "BufferParams.h"
25 #include "BufferView.h"
26 #include "bufferview_funcs.h"
28 #include "CoordCache.h"
29 #include "CutAndPaste.h"
31 #include "FontIterator.h"
32 #include "FuncRequest.h"
35 #include "MetricsInfo.h"
36 #include "paragraph_funcs.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "rowpainter.h"
44 #include "frontends/FontMetrics.h"
45 #include "frontends/Painter.h"
47 #include <boost/current_function.hpp>
55 using frontend::FontMetrics;
59 int numberOfSeparators(Paragraph const & par, Row const & row)
61 pos_type const first = max(row.pos(), par.beginOfBody());
62 pos_type const last = row.endpos() - 1;
64 for (pos_type p = first; p < last; ++p) {
65 if (par.isSeparator(p))
72 int numberOfLabelHfills(Paragraph const & par, Row const & row)
74 pos_type last = row.endpos() - 1;
75 pos_type first = row.pos();
77 // hfill *DO* count at the beginning of paragraphs!
79 while (first < last && par.isHfill(first))
83 last = min(last, par.beginOfBody());
85 for (pos_type p = first; p < last; ++p) {
93 int numberOfHfills(Paragraph const & par, Row const & row)
95 pos_type const last = row.endpos();
96 pos_type first = row.pos();
98 // hfill *DO* count at the beginning of paragraphs!
100 while (first < last && par.isHfill(first))
104 first = max(first, par.beginOfBody());
107 for (pos_type p = first; p < last; ++p) {
116 TextMetrics::TextMetrics(BufferView * bv, Text * text)
117 : bv_(bv), text_(text)
120 max_width_ = bv_->workWidth();
121 dim_.wid = max_width_;
125 //text_->updateLabels(bv->buffer());
129 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
131 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
135 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit,
138 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
139 if (pmc_it == par_metrics_.end()) {
140 pmc_it = par_metrics_.insert(
141 std::make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
143 if (pmc_it->second.rows().empty() && redo) {
146 return pmc_it->second;
150 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim)
152 BOOST_ASSERT(mi.base.textwidth);
153 max_width_ = mi.base.textwidth;
154 // backup old dimension.
155 Dimension const old_dim = dim_;
158 pit_type const npar = text_->paragraphs().size();
160 // If there is more than one row, expand the text to
161 // the full allowable width.
162 dim_.wid = max_width_;
164 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
165 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
167 bool changed = false;
169 for (pit_type pit = 0; pit != npar; ++pit) {
170 changed |= redoParagraph(pit);
171 ParagraphMetrics const & pm = par_metrics_[pit];
173 if (dim_.wid < pm.width())
174 dim_.wid = pm.width();
177 dim_.asc = par_metrics_[0].ascent();
178 dim_.des = h - dim_.asc;
179 //lyxerr << "dim_.wid " << dim_.wid << endl;
180 //lyxerr << "dim_.asc " << dim_.asc << endl;
181 //lyxerr << "dim_.des " << dim_.des << endl;
183 changed |= dim_ != old_dim;
189 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
191 return main_text_? pm.rightMargin(bv_->buffer()) : 0;
195 int TextMetrics::rightMargin(pit_type const pit) const
197 return main_text_? par_metrics_[pit].rightMargin(bv_->buffer()) : 0;
201 void TextMetrics::applyOuterFont(Font & font) const
204 lf.reduce(bv_->buffer().params().getFont());
206 lf.setLanguage(font.language());
211 Font TextMetrics::getDisplayFont(pit_type pit, pos_type pos) const
213 BOOST_ASSERT(pos >= 0);
215 ParagraphList const & pars = text_->paragraphs();
216 Paragraph const & par = pars[pit];
217 LayoutPtr const & layout = par.layout();
218 Buffer const & buffer = bv_->buffer();
220 BufferParams const & params = buffer.params();
221 pos_type const body_pos = par.beginOfBody();
223 // We specialize the 95% common case:
224 if (!par.getDepth()) {
225 Font f = par.getFontSettings(params, pos);
226 if (!text_->isMainText(buffer))
228 bool lab = layout->labeltype == LABEL_MANUAL && pos < body_pos;
230 Font const & lf = lab ? layout->labelfont : layout->font;
231 Font rlf = lab ? layout->reslabelfont : layout->resfont;
233 // In case the default family has been customized
234 if (lf.family() == Font::INHERIT_FAMILY)
235 rlf.setFamily(params.getFont().family());
236 return f.realize(rlf);
239 // The uncommon case need not be optimized as much
240 Font const & layoutfont = pos < body_pos ?
241 layout->labelfont : layout->font;
243 Font font = par.getFontSettings(params, pos);
244 font.realize(layoutfont);
246 if (!text_->isMainText(buffer))
247 applyOuterFont(font);
249 // Realize against environment font information
250 // NOTE: the cast to pit_type should be removed when pit_type
251 // changes to a unsigned integer.
252 if (pit < pit_type(pars.size()))
253 font.realize(outerFont(pit, pars));
255 // Realize with the fonts of lesser depth.
256 font.realize(params.getFont());
262 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
264 if (!lyxrc.rtl_support || !sl.text())
268 if (boundary && sl.pos() > 0)
271 return getDisplayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
275 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
277 if (!lyxrc.rtl_support)
280 // no RTL boundary at line start
284 Paragraph const & par = text_->getPar(pit);
286 bool left = getDisplayFont(pit, pos - 1).isVisibleRightToLeft();
288 if (pos == par.size())
289 right = par.isRTL(bv_->buffer().params());
291 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
292 return left != right;
296 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
297 Font const & font) const
299 if (!lyxrc.rtl_support)
302 Paragraph const & par = text_->getPar(pit);
303 bool left = font.isVisibleRightToLeft();
305 if (pos == par.size())
306 right = par.isRTL(bv_->buffer().params());
308 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
309 return left != right;
313 bool TextMetrics::redoParagraph(pit_type const pit)
315 Paragraph & par = text_->getPar(pit);
316 // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
317 // redoParagraph() recursively inside parMetrics.
318 Dimension old_dim = parMetrics(pit, false).dim();
319 ParagraphMetrics & pm = par_metrics_[pit];
322 Buffer & buffer = bv_->buffer();
323 BufferParams const & bparams = buffer.params();
324 main_text_ = (text_ == &buffer.text());
325 bool changed = false;
327 // FIXME This check ought to be done somewhere else. It is the reason
328 // why text_ is not const. But then, where else to do it?
329 // Well, how can you end up with either (a) a biblio environment that
330 // has no InsetBibitem or (b) a biblio environment with more than one
331 // InsetBibitem? I think the answer is: when paragraphs are merged;
332 // when layout is set; when material is pasted.
333 int const moveCursor = par.checkBiblio(buffer.params().trackChanges);
335 const_cast<Cursor &>(bv_->cursor()).posRight();
336 else if (moveCursor < 0) {
337 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
338 if (cursor.pos() >= -moveCursor)
342 // Optimisation: this is used in the next two loops
343 // so better to calculate that once here.
344 int const right_margin = rightMargin(pm);
347 // FIXME: We should always use getFont(), see documentation of
348 // noFontChange() in Inset.h.
349 Font const bufferfont = buffer.params().getFont();
350 InsetList::const_iterator ii = par.insetlist.begin();
351 InsetList::const_iterator iend = par.insetlist.end();
352 for (; ii != iend; ++ii) {
353 Dimension old_dim = ii->inset->dimension();
355 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
357 Font const & font = ii->inset->noFontChange() ?
358 bufferfont : getDisplayFont(pit, ii->pos);
359 MetricsInfo mi(bv_, font, w);
360 changed |= ii->inset->metrics(mi, dim);
361 changed |= (old_dim != dim);
364 Cursor const & cur = bv_->cursor();
365 DocIterator sel_beg = cur.selectionBegin();
366 DocIterator sel_end = cur.selectionEnd();
367 bool selection = cur.selection()
369 && cur.text() == text_
370 // if the anchor is outside, this is not our selection
371 && cur.anchor().text() == text_
372 && pit >= sel_beg.pit() && pit <= sel_end.pit();
374 // We care only about visible selection.
376 if (pit != sel_beg.pit()) {
380 if (pit != sel_end.pit()) {
382 sel_end.pos() = sel_end.lastpos();
386 par.setBeginOfBody();
388 size_t row_index = 0;
389 // maximum pixel width of a row
390 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
393 pos_type end = rowBreakPoint(width, pit, first);
394 if (row_index || end < par.size())
395 // If there is more than one row, expand the text to
396 // the full allowable width. This setting here is needed
397 // for the computeRowMetrics below().
398 dim_.wid = max_width_;
400 dim.wid = rowWidth(right_margin, pit, first, end);
401 boost::tie(dim.asc, dim.des) = rowHeight(pit, first, end);
402 if (row_index == pm.rows().size())
403 pm.rows().push_back(Row());
404 Row & row = pm.rows()[row_index];
405 row.setChanged(false);
409 row.setSelection(sel_beg.pos(), sel_end.pos());
411 row.setSelection(-1, -1);
412 row.setDimension(dim);
413 computeRowMetrics(pit, row);
414 pm.computeRowSignature(row, bparams);
418 pm.dim().wid = std::max(pm.dim().wid, dim.wid);
419 pm.dim().des += dim.height();
420 } while (first < par.size());
422 if (row_index < pm.rows().size())
423 pm.rows().resize(row_index);
425 // Make sure that if a par ends in newline, there is one more row
427 if (first > 0 && par.isNewline(first - 1)) {
429 dim.wid = rowWidth(right_margin, pit, first, first);
430 boost::tie(dim.asc, dim.des) = rowHeight(pit, first, first);
431 if (row_index == pm.rows().size())
432 pm.rows().push_back(Row());
433 Row & row = pm.rows()[row_index];
434 row.setChanged(false);
437 row.setDimension(dim);
438 computeRowMetrics(pit, row);
439 pm.computeRowSignature(row, bparams);
440 pm.dim().des += dim.height();
443 pm.dim().asc += pm.rows()[0].ascent();
444 pm.dim().des -= pm.rows()[0].ascent();
446 changed |= old_dim.height() != pm.dim().height();
452 void TextMetrics::computeRowMetrics(pit_type const pit,
460 Buffer & buffer = bv_->buffer();
461 Paragraph const & par = text_->getPar(pit);
463 double w = dim_.wid - row.width();
464 // FIXME: put back this assertion when the crash on new doc is solved.
465 //BOOST_ASSERT(w >= 0);
467 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
468 //lyxerr << "row.width() " << row.width() << endl;
469 //lyxerr << "w " << w << endl;
471 bool const is_rtl = text_->isRTL(buffer, par);
473 row.x = rightMargin(pit);
475 row.x = leftMargin(max_width_, pit, row.pos());
477 // is there a manual margin with a manual label
478 LayoutPtr const & layout = par.layout();
480 if (layout->margintype == MARGIN_MANUAL
481 && layout->labeltype == LABEL_MANUAL) {
482 /// We might have real hfills in the label part
483 int nlh = numberOfLabelHfills(par, row);
485 // A manual label par (e.g. List) has an auto-hfill
486 // between the label text and the body of the
488 // But we don't want to do this auto hfill if the par
493 if (nlh && !par.getLabelWidthString().empty())
494 row.label_hfill = labelFill(pit, row) / double(nlh);
497 // are there any hfills in the row?
498 int const nh = numberOfHfills(par, row);
503 // we don't have to look at the alignment if it is ALIGN_LEFT and
504 // if the row is already larger then the permitted width as then
505 // we force the LEFT_ALIGN'edness!
506 } else if (int(row.width()) < max_width_) {
507 // is it block, flushleft or flushright?
508 // set x how you need it
510 if (par.params().align() == LYX_ALIGN_LAYOUT)
511 align = layout->align;
513 align = par.params().align();
515 // Display-style insets should always be on a centred row
516 // The test on par.size() is to catch zero-size pars, which
517 // would trigger the assert in Paragraph::getInset().
518 //inset = par.size() ? par.getInset(row.pos()) : 0;
519 if (row.pos() < par.size()
520 && par.isInset(row.pos()))
522 switch(par.getInset(row.pos())->display()) {
523 case Inset::AlignLeft:
524 align = LYX_ALIGN_BLOCK;
526 case Inset::AlignCenter:
527 align = LYX_ALIGN_CENTER;
530 case Inset::AlignRight:
531 // unchanged (use align)
537 case LYX_ALIGN_BLOCK: {
538 int const ns = numberOfSeparators(par, row);
539 bool disp_inset = false;
540 if (row.endpos() < par.size()) {
541 Inset const * in = par.getInset(row.endpos());
543 disp_inset = in->display();
545 // If we have separators, this is not the last row of a
546 // par, does not end in newline, and is not row above a
547 // display inset... then stretch it
549 && row.endpos() < par.size()
550 && !par.isNewline(row.endpos() - 1)
553 row.separator = w / ns;
554 //lyxerr << "row.separator " << row.separator << endl;
555 //lyxerr << "ns " << ns << endl;
561 case LYX_ALIGN_RIGHT:
564 case LYX_ALIGN_CENTER:
571 pos_type body_pos = par.beginOfBody();
572 pos_type end = row.endpos();
575 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
577 row.x += theFontMetrics(text_->getLabelFont(buffer, par)).
578 width(layout->labelsep);
580 row.x += row.label_hfill;
586 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
588 Buffer & buffer = bv_->buffer();
589 Paragraph const & par = text_->getPar(pit);
591 pos_type last = par.beginOfBody();
592 BOOST_ASSERT(last > 0);
594 // -1 because a label ends with a space that is in the label
597 // a separator at this end does not count
598 if (par.isLineSeparator(last))
602 for (pos_type i = row.pos(); i <= last; ++i)
603 w += singleWidth(pit, i);
605 docstring const & label = par.params().labelWidthString();
609 FontMetrics const & fm
610 = theFontMetrics(text_->getLabelFont(buffer, par));
612 return max(0, fm.width(label) - w);
618 // this needs special handling - only newlines count as a break point
619 pos_type addressBreakPoint(pos_type i, Paragraph const & par)
621 pos_type const end = par.size();
624 if (par.isNewline(i))
633 int TextMetrics::labelEnd(pit_type const pit) const
635 // labelEnd is only needed if the layout fills a flushleft label.
636 if (text_->getPar(pit).layout()->margintype != MARGIN_MANUAL)
638 // return the beginning of the body
639 return leftMargin(max_width_, pit);
643 pit_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
646 Buffer & buffer = bv_->buffer();
647 ParagraphMetrics const & pm = par_metrics_[pit];
648 Paragraph const & par = text_->getPar(pit);
649 pos_type const end = par.size();
650 if (pos == end || width < 0)
653 LayoutPtr const & layout = par.layout();
655 if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX)
656 return addressBreakPoint(pos, par);
658 pos_type const body_pos = par.beginOfBody();
661 // Now we iterate through until we reach the right margin
662 // or the end of the par, then choose the possible break
665 int label_end = labelEnd(pit);
666 int const left = leftMargin(max_width_, pit, pos);
669 // pixel width since last breakpoint
672 FontIterator fi = FontIterator(*this, par, pit, pos);
673 pos_type point = end;
675 for ( ; i < end; ++i, ++fi) {
676 int thiswidth = pm.singleWidth(i, *fi);
678 // add the auto-hfill from label end to the body
679 if (body_pos && i == body_pos) {
680 FontMetrics const & fm = theFontMetrics(
681 text_->getLabelFont(buffer, par));
682 int add = fm.width(layout->labelsep);
683 if (par.isLineSeparator(i - 1))
684 add -= singleWidth(pit, i - 1);
686 add = std::max(add, label_end - x);
691 chunkwidth += thiswidth;
693 // break before a character that will fall off
694 // the right of the row
696 // if no break before, break here
697 if (point == end || chunkwidth >= width - left) {
704 // exit on last registered breakpoint:
708 if (par.isNewline(i)) {
714 if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
719 if (par.isInset(i) && par.getInset(i)->display()) {
725 if (!par.isInset(i) || par.getInset(i)->isChar()) {
726 // some insets are line separators too
727 if (par.isLineSeparator(i)) {
728 // register breakpoint:
735 // maybe found one, but the par is short enough.
736 if (i == end && x < width)
739 // manual labels cannot be broken in LaTeX. But we
740 // want to make our on-screen rendering of footnotes
742 if (body_pos && point < body_pos)
749 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
750 pos_type const first, pos_type const end) const
752 Buffer & buffer = bv_->buffer();
753 // get the pure distance
754 ParagraphMetrics const & pm = par_metrics_[pit];
755 Paragraph const & par = text_->getPar(pit);
756 int w = leftMargin(max_width_, pit, first);
757 int label_end = labelEnd(pit);
759 pos_type const body_pos = par.beginOfBody();
763 FontIterator fi = FontIterator(*this, par, pit, i);
764 for ( ; i < end; ++i, ++fi) {
765 if (body_pos > 0 && i == body_pos) {
766 FontMetrics const & fm = theFontMetrics(
767 text_->getLabelFont(buffer, par));
768 w += fm.width(par.layout()->labelsep);
769 if (par.isLineSeparator(i - 1))
770 w -= singleWidth(pit, i - 1);
771 w = max(w, label_end);
773 w += pm.singleWidth(i, *fi);
777 if (body_pos > 0 && body_pos >= end) {
778 FontMetrics const & fm = theFontMetrics(
779 text_->getLabelFont(buffer, par));
780 w += fm.width(par.layout()->labelsep);
781 if (end > 0 && par.isLineSeparator(end - 1))
782 w -= singleWidth(pit, end - 1);
783 w = max(w, label_end);
786 return w + right_margin;
790 boost::tuple<int, int> TextMetrics::rowHeight(pit_type const pit, pos_type const first,
791 pos_type const end) const
793 Paragraph const & par = text_->getPar(pit);
794 // get the maximum ascent and the maximum descent
795 double layoutasc = 0;
796 double layoutdesc = 0;
797 double const dh = defaultRowHeight();
799 // ok, let us initialize the maxasc and maxdesc value.
800 // Only the fontsize count. The other properties
801 // are taken from the layoutfont. Nicer on the screen :)
802 LayoutPtr const & layout = par.layout();
804 // as max get the first character of this row then it can
805 // increase but not decrease the height. Just some point to
806 // start with so we don't have to do the assignment below too
808 Buffer const & buffer = bv_->buffer();
809 Font font = getDisplayFont(pit, first);
810 Font::FONT_SIZE const tmpsize = font.size();
811 font = text_->getLayoutFont(buffer, pit);
812 Font::FONT_SIZE const size = font.size();
813 font.setSize(tmpsize);
815 Font labelfont = text_->getLabelFont(buffer, par);
817 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
818 FontMetrics const & fontmetrics = theFontMetrics(font);
820 // these are minimum values
821 double const spacing_val = layout->spacing.getValue()
822 * text_->spacing(buffer, par);
823 //lyxerr << "spacing_val = " << spacing_val << endl;
824 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
825 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
827 // insets may be taller
828 InsetList::const_iterator ii = par.insetlist.begin();
829 InsetList::const_iterator iend = par.insetlist.end();
830 for ( ; ii != iend; ++ii) {
831 if (ii->pos >= first && ii->pos < end) {
832 maxasc = max(maxasc, ii->inset->ascent());
833 maxdesc = max(maxdesc, ii->inset->descent());
837 // Check if any custom fonts are larger (Asger)
838 // This is not completely correct, but we can live with the small,
839 // cosmetic error for now.
842 Font::FONT_SIZE maxsize =
843 par.highestFontInRange(first, end, size);
844 if (maxsize > font.size()) {
845 // use standard paragraph font with the maximal size
847 maxfont.setSize(maxsize);
848 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
849 maxasc = max(maxasc, maxfontmetrics.maxAscent());
850 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
853 // This is nicer with box insets:
857 ParagraphList const & pars = text_->paragraphs();
861 BufferParams const & bufparams = buffer.params();
862 // some parskips VERY EASY IMPLEMENTATION
863 if (bufparams.paragraph_separation
864 == BufferParams::PARSEP_SKIP
865 && par.ownerCode() != Inset::ERT_CODE
866 && par.ownerCode() != Inset::LISTINGS_CODE
868 && ((layout->isParagraph() && par.getDepth() == 0)
869 || (pars[pit - 1].layout()->isParagraph()
870 && pars[pit - 1].getDepth() == 0)))
872 maxasc += bufparams.getDefSkip().inPixels(*bv_);
875 if (par.params().startOfAppendix())
876 maxasc += int(3 * dh);
878 // This is special code for the chapter, since the label of this
879 // layout is printed in an extra row
880 if (layout->counter == "chapter"
881 && !par.params().labelString().empty()) {
882 labeladdon = int(labelfont_metrics.maxHeight()
883 * layout->spacing.getValue()
884 * text_->spacing(buffer, par));
887 // special code for the top label
888 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
889 || layout->labeltype == LABEL_BIBLIO
890 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
891 && isFirstInSequence(pit, pars)
892 && !par.getLabelstring().empty())
895 labelfont_metrics.maxHeight()
896 * layout->spacing.getValue()
897 * text_->spacing(buffer, par)
898 + (layout->topsep + layout->labelbottomsep) * dh);
901 // Add the layout spaces, for example before and after
902 // a section, or between the items of a itemize or enumerate
905 pit_type prev = depthHook(pit, pars, par.getDepth());
906 Paragraph const & prevpar = pars[prev];
908 && prevpar.layout() == layout
909 && prevpar.getDepth() == par.getDepth()
910 && prevpar.getLabelWidthString()
911 == par.getLabelWidthString()) {
912 layoutasc = layout->itemsep * dh;
913 } else if (pit != 0 || first != 0) {
914 if (layout->topsep > 0)
915 layoutasc = layout->topsep * dh;
918 prev = outerHook(pit, pars);
919 if (prev != pit_type(pars.size())) {
920 maxasc += int(pars[prev].layout()->parsep * dh);
921 } else if (pit != 0) {
922 Paragraph const & prevpar = pars[pit - 1];
923 if (prevpar.getDepth() != 0 ||
924 prevpar.layout() == layout) {
925 maxasc += int(layout->parsep * dh);
930 // is it a bottom line?
931 if (end >= par.size()) {
932 // add the layout spaces, for example before and after
933 // a section, or between the items of a itemize or enumerate
935 pit_type nextpit = pit + 1;
936 if (nextpit != pit_type(pars.size())) {
941 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
942 usual = pars[cpit].layout()->bottomsep * dh;
943 cpit = depthHook(cpit, pars, pars[nextpit].getDepth());
944 if (pars[cpit].layout() != pars[nextpit].layout()
945 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
947 unusual = pars[cpit].layout()->bottomsep * dh;
949 layoutdesc = max(unusual, usual);
950 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
951 if (pars[cpit].layout() != pars[nextpit].layout()
952 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
953 layoutdesc = int(pars[cpit].layout()->bottomsep * dh);
958 // incalculate the layout spaces
959 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
960 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
962 // FIXME: the correct way is to do the following is to move the
963 // following code in another method specially tailored for the
964 // main Text. The following test is thus bogus.
965 // Top and bottom margin of the document (only at top-level)
967 if (pit == 0 && first == 0)
969 if (pit + 1 == pit_type(pars.size()) &&
971 !(end > 0 && par.isNewline(end - 1)))
975 return boost::make_tuple(maxasc + labeladdon, maxdesc);
979 // x is an absolute screen coord
980 // returns the column near the specified x-coordinate of the row
981 // x is set to the real beginning of this column
982 pos_type TextMetrics::getColumnNearX(pit_type const pit,
983 Row const & row, int & x, bool & boundary) const
985 Buffer const & buffer = bv_->buffer();
987 /// For the main Text, it is possible that this pit is not
988 /// yet in the CoordCache when moving cursor up.
989 /// x Paragraph coordinate is always 0 for main text anyway.
990 int const xo = main_text_? 0 : bv_->coordCache().get(text_, pit).x_;
992 Paragraph const & par = text_->getPar(pit);
993 ParagraphMetrics const & pm = par_metrics_[pit];
995 bidi.computeTables(par, buffer, row);
997 pos_type vc = row.pos();
998 pos_type end = row.endpos();
1000 LayoutPtr const & layout = par.layout();
1002 bool left_side = false;
1004 pos_type body_pos = par.beginOfBody();
1006 double tmpx = row.x;
1007 double last_tmpx = tmpx;
1010 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1013 // check for empty row
1019 while (vc < end && tmpx <= x) {
1020 c = bidi.vis2log(vc);
1022 if (body_pos > 0 && c == body_pos - 1) {
1023 FontMetrics const & fm = theFontMetrics(
1024 text_->getLabelFont(buffer, par));
1025 tmpx += row.label_hfill + fm.width(layout->labelsep);
1026 if (par.isLineSeparator(body_pos - 1))
1027 tmpx -= singleWidth(pit, body_pos - 1);
1030 if (pm.hfillExpansion(row, c)) {
1031 tmpx += singleWidth(pit, c);
1035 tmpx += row.label_hfill;
1036 } else if (par.isSeparator(c)) {
1037 tmpx += singleWidth(pit, c);
1039 tmpx += row.separator;
1041 tmpx += singleWidth(pit, c);
1046 if ((tmpx + last_tmpx) / 2 > x) {
1051 BOOST_ASSERT(vc <= end); // This shouldn't happen.
1054 // This (rtl_support test) is not needed, but gives
1055 // some speedup if rtl_support == false
1056 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1058 // If lastrow is false, we don't need to compute
1059 // the value of rtl.
1060 bool const rtl = lastrow ? text_->isRTL(buffer, par) : false;
1062 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1063 (!rtl && !left_side && vc == end && x > tmpx + 5)))
1065 else if (vc == row.pos()) {
1066 c = bidi.vis2log(vc);
1067 if (bidi.level(c) % 2 == 1)
1070 c = bidi.vis2log(vc - 1);
1071 bool const rtl = (bidi.level(c) % 2 == 1);
1072 if (left_side == rtl) {
1074 boundary = isRTLBoundary(pit, c);
1078 // I believe this code is not needed anymore (Jug 20050717)
1080 // The following code is necessary because the cursor position past
1081 // the last char in a row is logically equivalent to that before
1082 // the first char in the next row. That's why insets causing row
1083 // divisions -- Newline and display-style insets -- must be treated
1084 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1085 // Newline inset, air gap below:
1086 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1087 if (bidi.level(end -1) % 2 == 0)
1088 tmpx -= singleWidth(pit, end - 1);
1090 tmpx += singleWidth(pit, end - 1);
1094 // Air gap above display inset:
1095 if (row.pos() < end && c >= end && end < par.size()
1096 && par.isInset(end) && par.getInset(end)->display()) {
1099 // Air gap below display inset:
1100 if (row.pos() < end && c >= end && par.isInset(end - 1)
1101 && par.getInset(end - 1)->display()) {
1107 pos_type const col = c - row.pos();
1109 if (!c || end == par.size())
1112 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1117 return min(col, end - 1 - row.pos());
1121 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1123 // We play safe and use parMetrics(pit) to make sure the
1124 // ParagraphMetrics will be redone and OK to use if needed.
1125 // Otherwise we would use an empty ParagraphMetrics in
1126 // upDownInText() while in selection mode.
1127 ParagraphMetrics const & pm = parMetrics(pit);
1129 BOOST_ASSERT(row < int(pm.rows().size()));
1131 Row const & r = pm.rows()[row];
1132 return r.pos() + getColumnNearX(pit, r, x, bound);
1136 // y is screen coordinate
1137 pit_type TextMetrics::getPitNearY(int y)
1139 BOOST_ASSERT(!text_->paragraphs().empty());
1140 BOOST_ASSERT(bv_->coordCache().getParPos().find(text_) != bv_->coordCache().getParPos().end());
1141 CoordCache::InnerParPosCache const & cc = bv_->coordCache().getParPos().find(text_)->second;
1142 LYXERR(Debug::DEBUG)
1143 << BOOST_CURRENT_FUNCTION
1144 << ": y: " << y << " cache size: " << cc.size()
1147 // look for highest numbered paragraph with y coordinate less than given y
1150 CoordCache::InnerParPosCache::const_iterator it = cc.begin();
1151 CoordCache::InnerParPosCache::const_iterator et = cc.end();
1152 CoordCache::InnerParPosCache::const_iterator last = et; last--;
1154 ParagraphMetrics const & pm = par_metrics_[it->first];
1156 // If we are off-screen (before the visible part)
1158 // and even before the first paragraph in the cache.
1159 && y < it->second.y_ - int(pm.ascent())) {
1160 // and we are not at the first paragraph in the inset.
1163 // then this is the paragraph we are looking for.
1164 pit = it->first - 1;
1165 // rebreak it and update the CoordCache.
1167 bv_->coordCache().parPos()[text_][pit] =
1168 Point(0, it->second.y_ - pm.descent());
1172 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1174 // If we are off-screen (after the visible part)
1175 if (y > bv_->workHeight()
1176 // and even after the first paragraph in the cache.
1177 && y >= last->second.y_ + int(pm_last.descent())) {
1178 pit = last->first + 1;
1179 // and we are not at the last paragraph in the inset.
1180 if (pit == int(text_->paragraphs().size()))
1182 // then this is the paragraph we are looking for.
1183 // rebreak it and update the CoordCache.
1185 bv_->coordCache().parPos()[text_][pit] =
1186 Point(0, last->second.y_ + pm_last.ascent());
1190 for (; it != et; ++it) {
1191 LYXERR(Debug::DEBUG)
1192 << BOOST_CURRENT_FUNCTION
1193 << " examining: pit: " << it->first
1194 << " y: " << it->second.y_
1197 ParagraphMetrics const & pm = par_metrics_[it->first];
1199 if (it->first >= pit && int(it->second.y_) - int(pm.ascent()) <= y) {
1205 LYXERR(Debug::DEBUG)
1206 << BOOST_CURRENT_FUNCTION
1207 << ": found best y: " << yy << " for pit: " << pit
1214 Row const & TextMetrics::getRowNearY(int y, pit_type pit) const
1216 ParagraphMetrics const & pm = par_metrics_[pit];
1218 int yy = bv_->coordCache().get(text_, pit).y_ - pm.ascent();
1219 BOOST_ASSERT(!pm.rows().empty());
1220 RowList::const_iterator rit = pm.rows().begin();
1221 RowList::const_iterator const rlast = boost::prior(pm.rows().end());
1222 for (; rit != rlast; yy += rit->height(), ++rit)
1223 if (yy + rit->height() > y)
1229 // x,y are absolute screen coordinates
1230 // sets cursor recursively descending into nested editable insets
1231 Inset * TextMetrics::editXY(Cursor & cur, int x, int y)
1233 if (lyxerr.debugging(Debug::WORKAREA)) {
1234 lyxerr << "TextMetrics::editXY(cur, " << x << ", " << y << ")" << std::endl;
1235 cur.bv().coordCache().dump();
1237 pit_type pit = getPitNearY(y);
1238 BOOST_ASSERT(pit != -1);
1240 Row const & row = getRowNearY(y, pit);
1243 int xx = x; // is modified by getColumnNearX
1244 pos_type const pos = row.pos()
1245 + getColumnNearX(pit, row, xx, bound);
1248 cur.boundary(bound);
1251 // try to descend into nested insets
1252 Inset * inset = checkInsetHit(x, y);
1253 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1255 // Either we deconst editXY or better we move current_font
1256 // and real_current_font to Cursor
1257 // FIXME: what is needed now that current_font and real_current_font
1259 cur.setCurrentFont();
1263 ParagraphList const & pars = text_->paragraphs();
1264 Inset const * insetBefore = pos? pars[pit].getInset(pos - 1): 0;
1265 //Inset * insetBehind = pars[pit].getInset(pos);
1267 // This should be just before or just behind the
1268 // cursor position set above.
1269 BOOST_ASSERT((pos != 0 && inset == insetBefore)
1270 || inset == pars[pit].getInset(pos));
1272 // Make sure the cursor points to the position before
1274 if (inset == insetBefore) {
1276 cur.boundary(false);
1279 // Try to descend recursively inside the inset.
1280 inset = inset->editXY(cur, x, y);
1282 if (cur.top().text() == text_)
1283 cur.setCurrentFont();
1288 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1290 BOOST_ASSERT(text_ == cur.text());
1291 pit_type pit = getPitNearY(y);
1293 ParagraphMetrics const & pm = par_metrics_[pit];
1295 int yy = bv_->coordCache().get(text_, pit).y_ - pm.ascent();
1296 LYXERR(Debug::DEBUG)
1297 << BOOST_CURRENT_FUNCTION
1301 << " yy: " << yy << endl;
1304 BOOST_ASSERT(pm.rows().size());
1305 for (; r < int(pm.rows().size()) - 1; ++r) {
1306 Row const & row = pm.rows()[r];
1307 if (int(yy + row.height()) > y)
1312 Row const & row = pm.rows()[r];
1314 LYXERR(Debug::DEBUG)
1315 << BOOST_CURRENT_FUNCTION
1317 << " from pos: " << row.pos()
1322 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1324 LYXERR(Debug::DEBUG)
1325 << BOOST_CURRENT_FUNCTION
1326 << ": setting cursor pit: " << pit
1330 text_->setCursor(cur, pit, pos, true, bound);
1331 // remember new position.
1336 //takes screen x,y coordinates
1337 Inset * TextMetrics::checkInsetHit(int x, int y)
1339 pit_type pit = getPitNearY(y);
1340 BOOST_ASSERT(pit != -1);
1342 Paragraph const & par = text_->paragraphs()[pit];
1344 LYXERR(Debug::DEBUG)
1345 << BOOST_CURRENT_FUNCTION
1350 InsetList::const_iterator iit = par.insetlist.begin();
1351 InsetList::const_iterator iend = par.insetlist.end();
1352 for (; iit != iend; ++iit) {
1353 Inset * inset = iit->inset;
1355 LYXERR(Debug::DEBUG)
1356 << BOOST_CURRENT_FUNCTION
1357 << ": examining inset " << inset << endl;
1359 if (bv_->coordCache().getInsets().has(inset))
1360 LYXERR(Debug::DEBUG)
1361 << BOOST_CURRENT_FUNCTION
1362 << ": xo: " << inset->xo(*bv_) << "..."
1363 << inset->xo(*bv_) + inset->width()
1364 << " yo: " << inset->yo(*bv_) - inset->ascent()
1366 << inset->yo(*bv_) + inset->descent()
1369 LYXERR(Debug::DEBUG)
1370 << BOOST_CURRENT_FUNCTION
1371 << ": inset has no cached position" << endl;
1373 if (inset->covers(*bv_, x, y)) {
1374 LYXERR(Debug::DEBUG)
1375 << BOOST_CURRENT_FUNCTION
1376 << ": Hit inset: " << inset << endl;
1380 LYXERR(Debug::DEBUG)
1381 << BOOST_CURRENT_FUNCTION
1382 << ": No inset hit. " << endl;
1387 int TextMetrics::cursorX(CursorSlice const & sl,
1388 bool boundary) const
1390 BOOST_ASSERT(sl.text() == text_);
1391 pit_type const pit = sl.pit();
1392 Paragraph const & par = text_->paragraphs()[pit];
1393 ParagraphMetrics const & pm = par_metrics_[pit];
1394 if (pm.rows().empty())
1397 pos_type ppos = sl.pos();
1398 // Correct position in front of big insets
1399 bool const boundary_correction = ppos != 0 && boundary;
1400 if (boundary_correction)
1403 Row const & row = pm.getRow(sl.pos(), boundary);
1405 pos_type cursor_vpos = 0;
1407 Buffer const & buffer = bv_->buffer();
1410 bidi.computeTables(par, buffer, row);
1412 pos_type const row_pos = row.pos();
1413 pos_type const end = row.endpos();
1414 // Spaces at logical line breaks in bidi text must be skipped during
1415 // cursor positioning. However, they may appear visually in the middle
1416 // of a row; they must be skipped, wherever they are...
1417 // * logically "abc_[HEBREW_\nHEBREW]"
1418 // * visually "abc_[_WERBEH\nWERBEH]"
1419 pos_type skipped_sep_vpos = -1;
1422 cursor_vpos = row_pos;
1423 else if (ppos >= end)
1424 cursor_vpos = text_->isRTL(buffer, par) ? row_pos : end;
1425 else if (ppos > row_pos && ppos >= end)
1426 // Place cursor after char at (logical) position pos - 1
1427 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1428 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1430 // Place cursor before char at (logical) position ppos
1431 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1432 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1434 pos_type body_pos = par.beginOfBody();
1436 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1439 // Use font span to speed things up, see below
1443 // If the last logical character is a separator, skip it, unless
1444 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1445 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1446 skipped_sep_vpos = bidi.log2vis(end - 1);
1448 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1449 // Skip the separator which is at the logical end of the row
1450 if (vpos == skipped_sep_vpos)
1452 pos_type pos = bidi.vis2log(vpos);
1453 if (body_pos > 0 && pos == body_pos - 1) {
1454 FontMetrics const & labelfm = theFontMetrics(
1455 text_->getLabelFont(buffer, par));
1456 x += row.label_hfill + labelfm.width(par.layout()->labelsep);
1457 if (par.isLineSeparator(body_pos - 1))
1458 x -= singleWidth(pit, body_pos - 1);
1461 // Use font span to speed things up, see above
1462 if (pos < font_span.first || pos > font_span.last) {
1463 font_span = par.fontSpan(pos);
1464 font = getDisplayFont(pit, pos);
1467 x += pm.singleWidth(pos, font);
1469 if (pm.hfillExpansion(row, pos))
1470 x += (pos >= body_pos) ? row.hfill : row.label_hfill;
1471 else if (par.isSeparator(pos) && pos >= body_pos)
1475 // see correction above
1476 if (boundary_correction) {
1477 if (isRTL(sl, boundary))
1478 x -= singleWidth(pit, ppos);
1480 x += singleWidth(pit, ppos);
1487 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1489 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << std::endl;
1490 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1491 if (pm.rows().empty())
1495 h -= par_metrics_[0].rows()[0].ascent();
1496 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1497 h += par_metrics_[pit].height();
1500 if (pos && boundary)
1502 size_t const rend = pm.pos2row(pos);
1503 for (size_t rit = 0; rit != rend; ++rit)
1504 h += pm.rows()[rit].height();
1505 h += pm.rows()[rend].ascent();
1510 void TextMetrics::cursorPrevious(Cursor & cur)
1512 pos_type cpos = cur.pos();
1513 pit_type cpar = cur.pit();
1515 int x = cur.x_target();
1516 setCursorFromCoordinates(cur, x, 0);
1517 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1519 if (cpar == cur.pit() && cpos == cur.pos())
1520 // we have a row which is taller than the workarea. The
1521 // simplest solution is to move to the previous row instead.
1522 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1525 cur.updateFlags(Update::Force | Update::FitCursor);
1529 void TextMetrics::cursorNext(Cursor & cur)
1531 pos_type cpos = cur.pos();
1532 pit_type cpar = cur.pit();
1534 int x = cur.x_target();
1535 setCursorFromCoordinates(cur, x, cur.bv().workHeight() - 1);
1536 cur.dispatch(FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1538 if (cpar == cur.pit() && cpos == cur.pos())
1539 // we have a row which is taller than the workarea. The
1540 // simplest solution is to move to the next row instead.
1542 FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1545 cur.updateFlags(Update::Force | Update::FitCursor);
1549 // the cursor set functions have a special mechanism. When they
1550 // realize you left an empty paragraph, they will delete it.
1552 bool TextMetrics::cursorHome(Cursor & cur)
1554 BOOST_ASSERT(text_ == cur.text());
1555 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1556 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1557 return text_->setCursor(cur, cur.pit(), row.pos());
1561 bool TextMetrics::cursorEnd(Cursor & cur)
1563 BOOST_ASSERT(text_ == cur.text());
1564 // if not on the last row of the par, put the cursor before
1565 // the final space exept if I have a spanning inset or one string
1566 // is so long that we force a break.
1567 pos_type end = cur.textRow().endpos();
1569 // empty text, end-1 is no valid position
1571 bool boundary = false;
1572 if (end != cur.lastpos()) {
1573 if (!cur.paragraph().isLineSeparator(end-1)
1574 && !cur.paragraph().isNewline(end-1))
1579 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1583 void TextMetrics::deleteLineForward(Cursor & cur)
1585 BOOST_ASSERT(text_ == cur.text());
1586 if (cur.lastpos() == 0) {
1587 // Paragraph is empty, so we just go to the right
1588 text_->cursorRight(cur);
1591 cur.selection() = true; // to avoid deletion
1594 // What is this test for ??? (JMarc)
1595 if (!cur.selection())
1596 text_->deleteWordForward(cur);
1598 cap::cutSelection(cur, true, false);
1599 checkBufferStructure(cur.buffer(), cur);
1604 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1606 ParagraphList const & pars = text_->paragraphs();
1607 return row.endpos() >= pars[pit].size()
1608 && pit + 1 == pit_type(pars.size());
1612 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1614 return row.pos() == 0 && pit == 0;
1618 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1620 BOOST_ASSERT(pit >= 0);
1621 BOOST_ASSERT(pit < int(text_->paragraphs().size()));
1622 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1626 int TextMetrics::leftMargin(int max_width,
1627 pit_type const pit, pos_type const pos) const
1629 ParagraphList const & pars = text_->paragraphs();
1631 BOOST_ASSERT(pit >= 0);
1632 BOOST_ASSERT(pit < int(pars.size()));
1633 Paragraph const & par = pars[pit];
1634 BOOST_ASSERT(pos >= 0);
1635 BOOST_ASSERT(pos <= par.size());
1636 Buffer const & buffer = bv_->buffer();
1637 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1638 TextClass const & tclass = buffer.params().getTextClass();
1639 LayoutPtr const & layout = par.layout();
1641 docstring parindent = layout->parindent;
1645 if (text_->isMainText(buffer))
1646 l_margin += changebarMargin();
1648 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1649 tclass.leftmargin());
1651 if (par.getDepth() != 0) {
1652 // find the next level paragraph
1653 pit_type newpar = outerHook(pit, pars);
1654 if (newpar != pit_type(pars.size())) {
1655 if (pars[newpar].layout()->isEnvironment()) {
1656 l_margin = leftMargin(max_width, newpar);
1658 if (par.layout() == tclass.defaultLayout()) {
1659 if (pars[newpar].params().noindent())
1662 parindent = pars[newpar].layout()->parindent;
1667 // This happens after sections in standard classes. The 1.3.x
1668 // code compared depths too, but it does not seem necessary
1670 if (par.layout() == tclass.defaultLayout()
1671 && pit > 0 && pars[pit - 1].layout()->nextnoindent)
1674 Font const labelfont = text_->getLabelFont(buffer, par);
1675 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1677 switch (layout->margintype) {
1678 case MARGIN_DYNAMIC:
1679 if (!layout->leftmargin.empty()) {
1680 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1681 layout->leftmargin);
1683 if (!par.getLabelstring().empty()) {
1684 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1685 l_margin += labelfont_metrics.width(par.getLabelstring());
1686 l_margin += labelfont_metrics.width(layout->labelsep);
1690 case MARGIN_MANUAL: {
1691 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1692 // The width of an empty par, even with manual label, should be 0
1693 if (!par.empty() && pos >= par.beginOfBody()) {
1694 if (!par.getLabelWidthString().empty()) {
1695 docstring labstr = par.getLabelWidthString();
1696 l_margin += labelfont_metrics.width(labstr);
1697 l_margin += labelfont_metrics.width(layout->labelsep);
1703 case MARGIN_STATIC: {
1704 l_margin += theFontMetrics(buffer.params().getFont()).
1705 signedWidth(layout->leftmargin) * 4 / (par.getDepth() + 4);
1709 case MARGIN_FIRST_DYNAMIC:
1710 if (layout->labeltype == LABEL_MANUAL) {
1711 if (pos >= par.beginOfBody()) {
1712 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1714 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1717 // Special case to fix problems with
1719 || (layout->labeltype == LABEL_STATIC
1720 && layout->latextype == LATEX_ENVIRONMENT
1721 && !isFirstInSequence(pit, pars))) {
1722 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1723 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
1724 && layout->labeltype != LABEL_BIBLIO
1725 && layout->labeltype !=
1726 LABEL_CENTERED_TOP_ENVIRONMENT) {
1727 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1728 l_margin += labelfont_metrics.width(layout->labelsep);
1729 l_margin += labelfont_metrics.width(par.getLabelstring());
1733 case MARGIN_RIGHT_ADDRESS_BOX: {
1735 // ok, a terrible hack. The left margin depends on the widest
1736 // row in this paragraph.
1737 RowList::iterator rit = par.rows().begin();
1738 RowList::iterator end = par.rows().end();
1739 // FIXME: This is wrong.
1740 int minfill = max_width;
1741 for ( ; rit != end; ++rit)
1742 if (rit->fill() < minfill)
1743 minfill = rit->fill();
1744 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
1745 l_margin += minfill;
1747 // also wrong, but much shorter.
1748 l_margin += max_width / 2;
1753 if (!par.params().leftIndent().zero())
1754 l_margin += par.params().leftIndent().inPixels(max_width);
1758 if (par.params().align() == LYX_ALIGN_LAYOUT)
1759 align = layout->align;
1761 align = par.params().align();
1763 // set the correct parindent
1765 && (layout->labeltype == LABEL_NO_LABEL
1766 || layout->labeltype == LABEL_TOP_ENVIRONMENT
1767 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1768 || (layout->labeltype == LABEL_STATIC
1769 && layout->latextype == LATEX_ENVIRONMENT
1770 && !isFirstInSequence(pit, pars)))
1771 && align == LYX_ALIGN_BLOCK
1772 && !par.params().noindent()
1773 // in some insets, paragraphs are never indented
1774 && !(par.inInset() && par.inInset()->neverIndent(buffer))
1775 // display style insets are always centered, omit indentation
1778 && par.getInset(pos)->display())
1779 && (par.layout() != tclass.defaultLayout()
1780 || buffer.params().paragraph_separation ==
1781 BufferParams::PARSEP_INDENT))
1783 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1791 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
1793 ParagraphMetrics const & pm = par_metrics_[pit];
1795 return pm.singleWidth(pos, getDisplayFont(pit, pos));
1799 // only used for inset right now. should also be used for main text
1800 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1802 if (par_metrics_.empty())
1805 CoordCache::InnerParPosCache & ppcache = bv_->coordCache().parPos()[text_];
1807 ParMetricsCache::const_iterator it = par_metrics_.begin();
1808 ParMetricsCache::const_iterator const pm_end = par_metrics_.end();
1809 y -= it->second.ascent();
1810 for (; it != pm_end; ++it) {
1811 ParagraphMetrics const & pmi = it->second;
1813 pit_type const pit = it->first;
1814 // Save the paragraph position in the cache.
1815 ppcache[pit] = Point(x, y);
1816 drawParagraph(pi, pit, x, y);
1822 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1824 // lyxerr << " paintPar: pit: " << pit << " at y: " << y << endl;
1825 int const ww = bv_->workHeight();
1827 ParagraphMetrics const & pm = par_metrics_[pit];
1828 if (pm.rows().empty())
1831 RowList::const_iterator const rb = pm.rows().begin();
1832 RowList::const_iterator const re = pm.rows().end();
1837 for (RowList::const_iterator rit = rb; rit != re; ++rit) {
1840 bool const inside = (y + rit->descent() >= 0
1841 && y - rit->ascent() < ww);
1842 // it is not needed to draw on screen if we are not inside.
1843 pi.pain.setDrawingEnabled(inside);
1844 RowPainter rp(pi, *text_, pit, *rit, bidi, x, y);
1846 // Row signature; has row changed since last paint?
1847 bool row_has_changed = rit->changed();
1849 bool row_selection = rit->sel_beg != -1 && rit->sel_end != -1;
1851 if (!row_selection && !pi.full_repaint && !row_has_changed) {
1852 // Paint the only the insets if the text itself is
1854 rp.paintOnlyInsets();
1855 y += rit->descent();
1859 // Paint the row if a full repaint has been requested or it has
1861 // Clear background of this row
1862 // (if paragraph background was not cleared)
1863 if (row_selection || (!pi.full_repaint && row_has_changed)) {
1864 pi.pain.fillRectangle(x, y - rit->ascent(),
1865 width(), rit->height(),
1866 Color_color(Color::color(pi.background_color)));
1868 if (row_selection) {
1869 lyxerr << "row selected" << endl;
1870 DocIterator beg = bv_->cursor().selectionBegin();
1871 DocIterator end = bv_->cursor().selectionEnd();
1873 beg.pos() = rit->sel_beg;
1874 if (pit == end.pit()) {
1875 end.pos() = rit->sel_end;
1877 end.pit() = pit + 1;
1880 drawSelection(pi, beg, end, x);
1883 // Instrumentation for testing row cache (see also
1885 if (lyxerr.debugging(Debug::PAINTING)) {
1886 if (text_->isMainText(bv_->buffer()))
1887 LYXERR(Debug::PAINTING) << "\n{" <<
1888 pi.full_repaint << row_has_changed << "}";
1890 LYXERR(Debug::PAINTING) << "[" <<
1891 pi.full_repaint << row_has_changed << "]";
1894 // Backup full_repaint status and force full repaint
1895 // for inner insets as the Row has been cleared out.
1896 bool tmp = pi.full_repaint;
1897 pi.full_repaint = true;
1900 rp.paintChangeBar();
1906 y += rit->descent();
1907 // Restore full_repaint status.
1908 pi.full_repaint = tmp;
1910 // Re-enable screen drawing for future use of the painter.
1911 pi.pain.setDrawingEnabled(true);
1913 //LYXERR(Debug::PAINTING) << "." << endl;
1917 // only used for inset right now. should also be used for main text
1918 void TextMetrics::drawSelection(PainterInfo & pi,
1919 DocIterator const & beg, DocIterator const & end, int x) const
1921 ParagraphMetrics const & pm1 = par_metrics_[beg.pit()];
1922 ParagraphMetrics const & pm2 = par_metrics_[end.pit()];
1923 Row const & row1 = pm1.getRow(beg.pos(), beg.boundary());
1924 Row const & row2 = pm2.getRow(end.pos(), end.boundary());
1928 bool const clipAbove =
1929 (bv_funcs::status(bv_, beg) == bv_funcs::CUR_ABOVE);
1933 middleTop = bv_funcs::getPos(*bv_, beg, beg.boundary()).y_ + row1.descent();
1937 bool const clipBelow =
1938 (bv_funcs::status(bv_, end) == bv_funcs::CUR_BELOW);
1940 middleBottom = bv_->workHeight();
1942 middleBottom = bv_funcs::getPos(*bv_, end, end.boundary()).y_ - row2.ascent();
1944 // start and end in the same line?
1945 if (!(clipAbove || clipBelow) && &row1 == &row2)
1946 // then only draw this row's selection
1947 drawRowSelection(pi, x, row1, beg, end, false, false);
1951 DocIterator begRowEnd = beg;
1952 begRowEnd.pos() = row1.endpos();
1953 begRowEnd.boundary(true);
1955 // draw upper rectangle
1956 drawRowSelection(pi, x, row1, beg, begRowEnd, false, true);
1959 if (middleTop < middleBottom) {
1960 // draw middle rectangle
1961 pi.pain.fillRectangle(x, middleTop, width(), middleBottom - middleTop,
1967 DocIterator endRowBeg = end;
1968 endRowBeg.pos() = row2.pos();
1969 endRowBeg.boundary(false);
1971 // draw low rectangle
1972 drawRowSelection(pi, x, row2, endRowBeg, end, true, false);
1978 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
1979 DocIterator const & beg, DocIterator const & end,
1980 bool drawOnBegMargin, bool drawOnEndMargin) const
1982 Buffer & buffer = bv_->buffer();
1983 DocIterator cur = beg;
1984 int x1 = cursorX(beg.top(), beg.boundary());
1985 int x2 = cursorX(end.top(), end.boundary());
1986 int y1 = bv_funcs::getPos(*bv_, cur, cur.boundary()).y_ - row.ascent();
1987 int y2 = y1 + row.height();
1990 if (drawOnBegMargin) {
1991 if (text_->isRTL(buffer, beg.paragraph()))
1992 pi.pain.fillRectangle(x + x1, y1, width() - x1, y2 - y1, Color::selection);
1994 pi.pain.fillRectangle(x, y1, x1, y2 - y1, Color::selection);
1997 if (drawOnEndMargin) {
1998 if (text_->isRTL(buffer, beg.paragraph()))
1999 pi.pain.fillRectangle(x, y1, x2, y2 - y1, Color::selection);
2001 pi.pain.fillRectangle(x + x2, y1, width() - x2, y2 - y1, Color::selection);
2004 // if we are on a boundary from the beginning, it's probably
2005 // a RTL boundary and we jump to the other side directly as this
2006 // segement is 0-size and confuses the logic below
2008 cur.boundary(false);
2010 // go through row and draw from RTL boundary to RTL boundary
2012 bool drawNow = false;
2014 // simplified cursorRight code below which does not
2015 // descend into insets and which does not go into the
2016 // next line. Compare the logic with the original cursorRight
2018 // if left of boundary -> just jump to right side
2019 // but for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2020 if (cur.boundary()) {
2021 cur.boundary(false);
2022 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2023 // in front of RTL boundary -> Stay on this side of the boundary because:
2024 // ab|cDDEEFFghi -> abc|DDEEFFghi
2033 if (cur.pos() == row.endpos())
2038 // the previous segment was just drawn, now the next starts
2039 x1 = cursorX(cur.top(), cur.boundary());
2042 if (!(cur < end) || drawNow) {
2043 x2 = cursorX(cur.top(), cur.boundary());
2044 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2047 // reset x1, so it is set again next round (which will be on the
2048 // right side of a boundary or at the selection end)
2054 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2056 // ParagraphMetrics const & pm = par_metrics_[pit];
2057 // Row const & r = pm.rows()[row];
2063 int defaultRowHeight()
2065 return int(theFontMetrics(Font(Font::ALL_SANE)).maxHeight() * 1.2);