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"
56 using frontend::FontMetrics;
60 int numberOfSeparators(Paragraph const & par, Row const & row)
62 pos_type const first = max(row.pos(), par.beginOfBody());
63 pos_type const last = row.endpos() - 1;
65 for (pos_type p = first; p < last; ++p) {
66 if (par.isSeparator(p))
73 int numberOfLabelHfills(Paragraph const & par, Row const & row)
75 pos_type last = row.endpos() - 1;
76 pos_type first = row.pos();
78 // hfill *DO* count at the beginning of paragraphs!
80 while (first < last && par.isHfill(first))
84 last = min(last, par.beginOfBody());
86 for (pos_type p = first; p < last; ++p) {
94 int numberOfHfills(Paragraph const & par, Row const & row)
96 pos_type const last = row.endpos();
97 pos_type first = row.pos();
99 // hfill *DO* count at the beginning of paragraphs!
101 while (first < last && par.isHfill(first))
105 first = max(first, par.beginOfBody());
108 for (pos_type p = first; p < last; ++p) {
117 TextMetrics::TextMetrics(BufferView * bv, Text * text)
118 : bv_(bv), text_(text)
121 max_width_ = bv_->workWidth();
122 dim_.wid = max_width_;
126 //text_->updateLabels(bv->buffer());
130 bool TextMetrics::has(pit_type pit) const
132 return par_metrics_.find(pit) != par_metrics_.end();
136 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
138 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
143 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
145 ParMetricsCache::const_iterator it = par_metrics_.begin();
146 return make_pair(it->first, &it->second);
150 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
152 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
153 return make_pair(it->first, &it->second);
157 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
159 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
160 if (pmc_it == par_metrics_.end()) {
161 pmc_it = par_metrics_.insert(
162 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
164 if (pmc_it->second.rows().empty() && redo)
166 return pmc_it->second;
170 int TextMetrics::parPosition(pit_type pit) const
172 if (pit < par_metrics_.begin()->first)
174 if (pit > par_metrics_.rbegin()->first)
177 return par_metrics_[pit].position();
181 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
183 BOOST_ASSERT(mi.base.textwidth);
184 max_width_ = mi.base.textwidth;
185 // backup old dimension.
186 Dimension const old_dim = dim_;
189 dim_.wid = min_width;
190 pit_type const npar = text_->paragraphs().size();
192 // If there is more than one row, expand the text to
193 // the full allowable width.
194 dim_.wid = max_width_;
196 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
197 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
199 bool changed = false;
201 for (pit_type pit = 0; pit != npar; ++pit) {
202 changed |= redoParagraph(pit);
203 ParagraphMetrics const & pm = par_metrics_[pit];
205 if (dim_.wid < pm.width())
206 dim_.wid = pm.width();
209 dim_.asc = par_metrics_[0].ascent();
210 dim_.des = h - dim_.asc;
211 //lyxerr << "dim_.wid " << dim_.wid << endl;
212 //lyxerr << "dim_.asc " << dim_.asc << endl;
213 //lyxerr << "dim_.des " << dim_.des << endl;
215 changed |= dim_ != old_dim;
221 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
223 return main_text_? pm.rightMargin(bv_->buffer()) : 0;
227 int TextMetrics::rightMargin(pit_type const pit) const
229 return main_text_? par_metrics_[pit].rightMargin(bv_->buffer()) : 0;
233 void TextMetrics::applyOuterFont(Font & font) const
236 lf.fontInfo().reduce(bv_->buffer().params().getFont().fontInfo());
237 lf.fontInfo().realize(font.fontInfo());
238 lf.setLanguage(font.language());
243 Font TextMetrics::getDisplayFont(pit_type pit, pos_type pos) const
245 BOOST_ASSERT(pos >= 0);
247 ParagraphList const & pars = text_->paragraphs();
248 Paragraph const & par = pars[pit];
249 LayoutPtr const & layout = par.layout();
250 Buffer const & buffer = bv_->buffer();
252 BufferParams const & params = buffer.params();
253 pos_type const body_pos = par.beginOfBody();
255 // We specialize the 95% common case:
256 if (!par.getDepth()) {
257 Font f = par.getFontSettings(params, pos);
258 if (!text_->isMainText(buffer))
260 bool lab = layout->labeltype == LABEL_MANUAL && pos < body_pos;
262 FontInfo const & lf = lab ? layout->labelfont : layout->font;
263 FontInfo rlf = lab ? layout->reslabelfont : layout->resfont;
265 // In case the default family has been customized
266 if (lf.family() == INHERIT_FAMILY)
267 rlf.setFamily(params.getFont().fontInfo().family());
268 f.fontInfo().realize(rlf);
272 // The uncommon case need not be optimized as much
273 FontInfo const & layoutfont = pos < body_pos ?
274 layout->labelfont : layout->font;
276 Font font = par.getFontSettings(params, pos);
277 font.fontInfo().realize(layoutfont);
279 if (!text_->isMainText(buffer))
280 applyOuterFont(font);
282 // Realize against environment font information
283 // NOTE: the cast to pit_type should be removed when pit_type
284 // changes to a unsigned integer.
285 if (pit < pit_type(pars.size()))
286 font.fontInfo().realize(outerFont(pit, pars).fontInfo());
288 // Realize with the fonts of lesser depth.
289 font.fontInfo().realize(params.getFont().fontInfo());
295 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
297 if (!lyxrc.rtl_support || !sl.text())
301 if (boundary && sl.pos() > 0)
304 return getDisplayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
308 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
310 if (!lyxrc.rtl_support)
313 // no RTL boundary at line start
317 Paragraph const & par = text_->getPar(pit);
319 bool left = getDisplayFont(pit, pos - 1).isVisibleRightToLeft();
321 if (pos == par.size())
322 right = par.isRTL(bv_->buffer().params());
324 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
325 return left != right;
329 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
330 Font const & font) const
332 if (!lyxrc.rtl_support)
335 Paragraph const & par = text_->getPar(pit);
336 bool left = font.isVisibleRightToLeft();
338 if (pos == par.size())
339 right = par.isRTL(bv_->buffer().params());
341 right = getDisplayFont(pit, pos).isVisibleRightToLeft();
342 return left != right;
346 bool TextMetrics::redoParagraph(pit_type const pit)
348 Paragraph & par = text_->getPar(pit);
349 // IMPORTANT NOTE: We pass 'false' explicitely in order to not call
350 // redoParagraph() recursively inside parMetrics.
351 Dimension old_dim = parMetrics(pit, false).dim();
352 ParagraphMetrics & pm = par_metrics_[pit];
355 Buffer & buffer = bv_->buffer();
356 main_text_ = (text_ == &buffer.text());
357 bool changed = false;
359 // FIXME This check ought to be done somewhere else. It is the reason
360 // why text_ is not const. But then, where else to do it?
361 // Well, how can you end up with either (a) a biblio environment that
362 // has no InsetBibitem or (b) a biblio environment with more than one
363 // InsetBibitem? I think the answer is: when paragraphs are merged;
364 // when layout is set; when material is pasted.
365 int const moveCursor = par.checkBiblio(buffer.params().trackChanges);
367 const_cast<Cursor &>(bv_->cursor()).posForward();
368 else if (moveCursor < 0) {
369 Cursor & cursor = const_cast<Cursor &>(bv_->cursor());
370 if (cursor.pos() >= -moveCursor)
371 cursor.posBackward();
374 // Optimisation: this is used in the next two loops
375 // so better to calculate that once here.
376 int const right_margin = rightMargin(pm);
379 // FIXME: We should always use getFont(), see documentation of
380 // noFontChange() in Inset.h.
381 Font const bufferfont = buffer.params().getFont();
382 MacroContext mc(buffer, par);
383 InsetList::const_iterator ii = par.insetList().begin();
384 InsetList::const_iterator iend = par.insetList().end();
385 for (; ii != iend; ++ii) {
386 // the macro must come here, _before_ the metric call, because
387 // the macro should see itself to detect recursions. To find out
388 // whether the macro definition is a redefinition it will look
389 // at the MacroData::redefinition_. So it doesn't get confused
390 // by the already existing macro definition of itself in the
392 if (ii->inset->lyxCode() == MATHMACRO_CODE) {
394 MathMacroTemplate const & macroTemplate
395 = static_cast<MathMacroTemplate const &>(*ii->inset);
398 if (macroTemplate.validMacro()) {
399 MacroData macro = macroTemplate.asMacroData();
402 macro.setRedefinition(mc.has(macroTemplate.name()));
404 // register macro (possibly overwrite the previous one of this paragraph)
405 mc.insert(macroTemplate.name(), macro);
409 // do the metric calculation
411 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
413 Font const & font = ii->inset->noFontChange() ?
414 bufferfont : getDisplayFont(pit, ii->pos);
415 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
416 ii->inset->metrics(mi, dim);
417 Dimension const old_dim = pm.insetDimension(ii->inset);
418 pm.setInsetDimension(ii->inset, dim);
419 changed |= (old_dim != dim);
422 Cursor const & cur = bv_->cursor();
423 DocIterator sel_beg = cur.selectionBegin();
424 DocIterator sel_end = cur.selectionEnd();
425 bool selection = cur.selection()
427 && cur.text() == text_
428 // if the anchor is outside, this is not our selection
429 && cur.anchor().text() == text_
430 && pit >= sel_beg.pit() && pit <= sel_end.pit();
432 // We care only about visible selection.
434 if (pit != sel_beg.pit()) {
438 if (pit != sel_end.pit()) {
440 sel_end.pos() = sel_end.lastpos();
444 par.setBeginOfBody();
446 size_t row_index = 0;
447 // maximum pixel width of a row
448 int width = max_width_ - right_margin; // - leftMargin(max_width_, pit, row);
451 pos_type end = rowBreakPoint(width, pit, first);
452 if (row_index || end < par.size())
453 // If there is more than one row, expand the text to
454 // the full allowable width. This setting here is needed
455 // for the computeRowMetrics() below.
456 dim_.wid = max_width_;
458 dim = rowHeight(pit, first, end);
459 dim.wid = rowWidth(right_margin, pit, first, end);
460 if (row_index == pm.rows().size())
461 pm.rows().push_back(Row());
462 Row & row = pm.rows()[row_index];
463 row.setChanged(false);
467 row.setSelection(sel_beg.pos(), sel_end.pos());
469 row.setSelection(-1, -1);
470 row.setDimension(dim);
471 int const max_row_width = max(dim_.wid, dim.wid);
472 computeRowMetrics(pit, row, max_row_width);
476 pm.dim().wid = max(pm.dim().wid, dim.wid);
477 pm.dim().des += dim.height();
478 } while (first < par.size());
480 if (row_index < pm.rows().size())
481 pm.rows().resize(row_index);
483 // Make sure that if a par ends in newline, there is one more row
485 if (first > 0 && par.isNewline(first - 1)) {
486 Dimension dim = rowHeight(pit, first, first);
487 dim.wid = rowWidth(right_margin, pit, first, first);
488 if (row_index == pm.rows().size())
489 pm.rows().push_back(Row());
490 Row & row = pm.rows()[row_index];
491 row.setChanged(false);
494 row.setDimension(dim);
495 int const max_row_width = max(dim_.wid, dim.wid);
496 computeRowMetrics(pit, row, max_row_width);
497 pm.dim().des += dim.height();
500 pm.dim().asc += pm.rows()[0].ascent();
501 pm.dim().des -= pm.rows()[0].ascent();
503 changed |= old_dim.height() != pm.dim().height();
509 void TextMetrics::computeRowMetrics(pit_type const pit,
510 Row & row, int width) const
515 Buffer & buffer = bv_->buffer();
516 Paragraph const & par = text_->getPar(pit);
518 double w = width - row.width();
519 // FIXME: put back this assertion when the crash on new doc is solved.
520 //BOOST_ASSERT(w >= 0);
522 //lyxerr << "\ndim_.wid " << dim_.wid << endl;
523 //lyxerr << "row.width() " << row.width() << endl;
524 //lyxerr << "w " << w << endl;
526 bool const is_rtl = text_->isRTL(buffer, par);
528 row.x = rightMargin(pit);
530 row.x = leftMargin(max_width_, pit, row.pos());
532 // is there a manual margin with a manual label
533 LayoutPtr const & layout = par.layout();
535 if (layout->margintype == MARGIN_MANUAL
536 && layout->labeltype == LABEL_MANUAL) {
537 /// We might have real hfills in the label part
538 int nlh = numberOfLabelHfills(par, row);
540 // A manual label par (e.g. List) has an auto-hfill
541 // between the label text and the body of the
543 // But we don't want to do this auto hfill if the par
548 if (nlh && !par.getLabelWidthString().empty())
549 row.label_hfill = labelFill(pit, row) / double(nlh);
553 // are there any hfills in the row?
554 if (int const nh = numberOfHfills(par, row)) {
556 hfill = w / double(nh);
557 // we don't have to look at the alignment if it is ALIGN_LEFT and
558 // if the row is already larger then the permitted width as then
559 // we force the LEFT_ALIGN'edness!
560 } else if (int(row.width()) < max_width_) {
561 // is it block, flushleft or flushright?
562 // set x how you need it
564 if (par.params().align() == LYX_ALIGN_LAYOUT)
565 align = layout->align;
567 align = par.params().align();
569 // Display-style insets should always be on a centred row
570 // The test on par.size() is to catch zero-size pars, which
571 // would trigger the assert in Paragraph::getInset().
572 //inset = par.size() ? par.getInset(row.pos()) : 0;
573 if (row.pos() < par.size() && par.isInset(row.pos())) {
574 switch(par.getInset(row.pos())->display()) {
575 case Inset::AlignLeft:
576 align = LYX_ALIGN_BLOCK;
578 case Inset::AlignCenter:
579 align = LYX_ALIGN_CENTER;
582 case Inset::AlignRight:
583 // unchanged (use align)
589 case LYX_ALIGN_BLOCK: {
590 int const ns = numberOfSeparators(par, row);
591 bool disp_inset = false;
592 if (row.endpos() < par.size()) {
593 Inset const * in = par.getInset(row.endpos());
595 disp_inset = in->display();
597 // If we have separators, this is not the last row of a
598 // par, does not end in newline, and is not row above a
599 // display inset... then stretch it
601 && row.endpos() < par.size()
602 && !par.isNewline(row.endpos() - 1)
605 row.separator = w / ns;
606 //lyxerr << "row.separator " << row.separator << endl;
607 //lyxerr << "ns " << ns << endl;
613 case LYX_ALIGN_RIGHT:
616 case LYX_ALIGN_CENTER:
623 pos_type body_pos = par.beginOfBody();
624 pos_type end = row.endpos();
627 && (body_pos > end || !par.isLineSeparator(body_pos - 1)))
629 row.x += theFontMetrics(text_->getLabelFont(buffer, par)).
630 width(layout->labelsep);
632 row.x += row.label_hfill;
636 pos_type const endpos = row.endpos();
637 pos_type body_pos = par.beginOfBody();
639 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
642 ParagraphMetrics & pm = par_metrics_[pit];
643 InsetList::const_iterator ii = par.insetList().begin();
644 InsetList::const_iterator iend = par.insetList().end();
645 for ( ; ii != iend; ++ii) {
646 if (ii->pos >= endpos || ii->pos < row.pos()
647 || ii->inset->lyxCode() != HFILL_CODE)
649 Dimension dim = row.dimension();
650 if (pm.hfillExpansion(row, ii->pos))
651 dim.wid = int(ii->pos >= body_pos ?
652 max(hfill, 5.0) : row.label_hfill);
655 // Cache the inset dimension.
656 bv_->coordCache().insets().add(ii->inset, dim);
657 pm.setInsetDimension(ii->inset, dim);
662 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
664 Buffer & buffer = bv_->buffer();
665 Paragraph const & par = text_->getPar(pit);
667 pos_type last = par.beginOfBody();
668 BOOST_ASSERT(last > 0);
670 // -1 because a label ends with a space that is in the label
673 // a separator at this end does not count
674 if (par.isLineSeparator(last))
678 for (pos_type i = row.pos(); i <= last; ++i)
679 w += singleWidth(pit, i);
681 docstring const & label = par.params().labelWidthString();
685 FontMetrics const & fm
686 = theFontMetrics(text_->getLabelFont(buffer, par));
688 return max(0, fm.width(label) - w);
692 // this needs special handling - only newlines count as a break point
693 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
695 pos_type const end = par.size();
698 if (par.isNewline(i))
705 int TextMetrics::labelEnd(pit_type const pit) const
707 // labelEnd is only needed if the layout fills a flushleft label.
708 if (text_->getPar(pit).layout()->margintype != MARGIN_MANUAL)
710 // return the beginning of the body
711 return leftMargin(max_width_, pit);
715 pit_type TextMetrics::rowBreakPoint(int width, pit_type const pit,
718 Buffer & buffer = bv_->buffer();
719 ParagraphMetrics const & pm = par_metrics_[pit];
720 Paragraph const & par = text_->getPar(pit);
721 pos_type const end = par.size();
722 if (pos == end || width < 0)
725 LayoutPtr const & layout = par.layout();
727 if (layout->margintype == MARGIN_RIGHT_ADDRESS_BOX)
728 return addressBreakPoint(pos, par);
730 pos_type const body_pos = par.beginOfBody();
733 // Now we iterate through until we reach the right margin
734 // or the end of the par, then choose the possible break
737 int label_end = labelEnd(pit);
738 int const left = leftMargin(max_width_, pit, pos);
741 // pixel width since last breakpoint
744 FontIterator fi = FontIterator(*this, par, pit, pos);
745 pos_type point = end;
747 for ( ; i < end; ++i, ++fi) {
748 int thiswidth = pm.singleWidth(i, *fi);
750 // add the auto-hfill from label end to the body
751 if (body_pos && i == body_pos) {
752 FontMetrics const & fm = theFontMetrics(
753 text_->getLabelFont(buffer, par));
754 int add = fm.width(layout->labelsep);
755 if (par.isLineSeparator(i - 1))
756 add -= singleWidth(pit, i - 1);
758 add = max(add, label_end - x);
763 chunkwidth += thiswidth;
765 // break before a character that will fall off
766 // the right of the row
768 // if no break before, break here
769 if (point == end || chunkwidth >= width - left) {
775 // exit on last registered breakpoint:
779 if (par.isNewline(i)) {
785 if (par.isInset(i + 1) && par.getInset(i + 1)->display()) {
790 if (par.isInset(i) && par.getInset(i)->display()) {
796 if (!par.isInset(i) || par.getInset(i)->isChar()) {
797 // some insets are line separators too
798 if (par.isLineSeparator(i)) {
799 // register breakpoint:
806 // maybe found one, but the par is short enough.
807 if (i == end && x < width)
810 // manual labels cannot be broken in LaTeX. But we
811 // want to make our on-screen rendering of footnotes
813 if (body_pos && point < body_pos)
820 int TextMetrics::rowWidth(int right_margin, pit_type const pit,
821 pos_type const first, pos_type const end) const
823 Buffer & buffer = bv_->buffer();
824 // get the pure distance
825 ParagraphMetrics const & pm = par_metrics_[pit];
826 Paragraph const & par = text_->getPar(pit);
827 int w = leftMargin(max_width_, pit, first);
828 int label_end = labelEnd(pit);
830 pos_type const body_pos = par.beginOfBody();
834 FontIterator fi = FontIterator(*this, par, pit, i);
835 for ( ; i < end; ++i, ++fi) {
836 if (body_pos > 0 && i == body_pos) {
837 FontMetrics const & fm = theFontMetrics(
838 text_->getLabelFont(buffer, par));
839 w += fm.width(par.layout()->labelsep);
840 if (par.isLineSeparator(i - 1))
841 w -= singleWidth(pit, i - 1);
842 w = max(w, label_end);
844 w += pm.singleWidth(i, *fi);
848 if (body_pos > 0 && body_pos >= end) {
849 FontMetrics const & fm = theFontMetrics(
850 text_->getLabelFont(buffer, par));
851 w += fm.width(par.layout()->labelsep);
852 if (end > 0 && par.isLineSeparator(end - 1))
853 w -= singleWidth(pit, end - 1);
854 w = max(w, label_end);
857 return w + right_margin;
861 Dimension TextMetrics::rowHeight(pit_type const pit, pos_type const first,
862 pos_type const end) const
864 Paragraph const & par = text_->getPar(pit);
865 // get the maximum ascent and the maximum descent
866 double layoutasc = 0;
867 double layoutdesc = 0;
868 double const dh = defaultRowHeight();
870 // ok, let us initialize the maxasc and maxdesc value.
871 // Only the fontsize count. The other properties
872 // are taken from the layoutfont. Nicer on the screen :)
873 LayoutPtr const & layout = par.layout();
875 // as max get the first character of this row then it can
876 // increase but not decrease the height. Just some point to
877 // start with so we don't have to do the assignment below too
879 Buffer const & buffer = bv_->buffer();
880 Font font = getDisplayFont(pit, first);
881 FontSize const tmpsize = font.fontInfo().size();
882 font.fontInfo() = text_->getLayoutFont(buffer, pit);
883 FontSize const size = font.fontInfo().size();
884 font.fontInfo().setSize(tmpsize);
886 FontInfo labelfont = text_->getLabelFont(buffer, par);
888 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
889 FontMetrics const & fontmetrics = theFontMetrics(font);
891 // these are minimum values
892 double const spacing_val = layout->spacing.getValue()
893 * text_->spacing(buffer, par);
894 //lyxerr << "spacing_val = " << spacing_val << endl;
895 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
896 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
898 // insets may be taller
899 ParagraphMetrics const & pm = par_metrics_[pit];
900 InsetList::const_iterator ii = par.insetList().begin();
901 InsetList::const_iterator iend = par.insetList().end();
902 for ( ; ii != iend; ++ii) {
903 Dimension const & dim = pm.insetDimension(ii->inset);
904 if (ii->pos >= first && ii->pos < end) {
905 maxasc = max(maxasc, dim.ascent());
906 maxdesc = max(maxdesc, dim.descent());
910 // Check if any custom fonts are larger (Asger)
911 // This is not completely correct, but we can live with the small,
912 // cosmetic error for now.
916 par.highestFontInRange(first, end, size);
917 if (maxsize > font.fontInfo().size()) {
918 // use standard paragraph font with the maximal size
919 FontInfo maxfont = font.fontInfo();
920 maxfont.setSize(maxsize);
921 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
922 maxasc = max(maxasc, maxfontmetrics.maxAscent());
923 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
926 // This is nicer with box insets:
930 ParagraphList const & pars = text_->paragraphs();
934 BufferParams const & bufparams = buffer.params();
935 // some parskips VERY EASY IMPLEMENTATION
936 if (bufparams.paragraph_separation
937 == BufferParams::PARSEP_SKIP
938 && par.ownerCode() != ERT_CODE
939 && par.ownerCode() != LISTINGS_CODE
941 && ((layout->isParagraph() && par.getDepth() == 0)
942 || (pars[pit - 1].layout()->isParagraph()
943 && pars[pit - 1].getDepth() == 0)))
945 maxasc += bufparams.getDefSkip().inPixels(*bv_);
948 if (par.params().startOfAppendix())
949 maxasc += int(3 * dh);
951 // This is special code for the chapter, since the label of this
952 // layout is printed in an extra row
953 if (layout->counter == "chapter"
954 && !par.params().labelString().empty()) {
955 labeladdon = int(labelfont_metrics.maxHeight()
956 * layout->spacing.getValue()
957 * text_->spacing(buffer, par));
960 // special code for the top label
961 if ((layout->labeltype == LABEL_TOP_ENVIRONMENT
962 || layout->labeltype == LABEL_BIBLIO
963 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
964 && isFirstInSequence(pit, pars)
965 && !par.getLabelstring().empty())
968 labelfont_metrics.maxHeight()
969 * layout->spacing.getValue()
970 * text_->spacing(buffer, par)
971 + (layout->topsep + layout->labelbottomsep) * dh);
974 // Add the layout spaces, for example before and after
975 // a section, or between the items of a itemize or enumerate
978 pit_type prev = depthHook(pit, pars, par.getDepth());
979 Paragraph const & prevpar = pars[prev];
981 && prevpar.layout() == layout
982 && prevpar.getDepth() == par.getDepth()
983 && prevpar.getLabelWidthString()
984 == par.getLabelWidthString()) {
985 layoutasc = layout->itemsep * dh;
986 } else if (pit != 0 || first != 0) {
987 if (layout->topsep > 0)
988 layoutasc = layout->topsep * dh;
991 prev = outerHook(pit, pars);
992 if (prev != pit_type(pars.size())) {
993 maxasc += int(pars[prev].layout()->parsep * dh);
994 } else if (pit != 0) {
995 Paragraph const & prevpar = pars[pit - 1];
996 if (prevpar.getDepth() != 0 ||
997 prevpar.layout() == layout) {
998 maxasc += int(layout->parsep * dh);
1003 // is it a bottom line?
1004 if (end >= par.size()) {
1005 // add the layout spaces, for example before and after
1006 // a section, or between the items of a itemize or enumerate
1008 pit_type nextpit = pit + 1;
1009 if (nextpit != pit_type(pars.size())) {
1010 pit_type cpit = pit;
1014 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1015 usual = pars[cpit].layout()->bottomsep * dh;
1016 cpit = depthHook(cpit, pars, pars[nextpit].getDepth());
1017 if (pars[cpit].layout() != pars[nextpit].layout()
1018 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1020 unusual = pars[cpit].layout()->bottomsep * dh;
1022 layoutdesc = max(unusual, usual);
1023 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1024 if (pars[cpit].layout() != pars[nextpit].layout()
1025 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1026 layoutdesc = int(pars[cpit].layout()->bottomsep * dh);
1031 // incalculate the layout spaces
1032 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1033 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1035 // FIXME: the correct way is to do the following is to move the
1036 // following code in another method specially tailored for the
1037 // main Text. The following test is thus bogus.
1038 // Top and bottom margin of the document (only at top-level)
1040 if (pit == 0 && first == 0)
1042 if (pit + 1 == pit_type(pars.size()) &&
1043 end == par.size() &&
1044 !(end > 0 && par.isNewline(end - 1)))
1048 return Dimension(0, maxasc + labeladdon, maxdesc);
1052 // x is an absolute screen coord
1053 // returns the column near the specified x-coordinate of the row
1054 // x is set to the real beginning of this column
1055 pos_type TextMetrics::getColumnNearX(pit_type const pit,
1056 Row const & row, int & x, bool & boundary) const
1058 Buffer const & buffer = bv_->buffer();
1060 /// For the main Text, it is possible that this pit is not
1061 /// yet in the CoordCache when moving cursor up.
1062 /// x Paragraph coordinate is always 0 for main text anyway.
1063 int const xo = origin_.x_;
1065 Paragraph const & par = text_->getPar(pit);
1067 bidi.computeTables(par, buffer, row);
1069 pos_type vc = row.pos();
1070 pos_type end = row.endpos();
1072 LayoutPtr const & layout = par.layout();
1074 bool left_side = false;
1076 pos_type body_pos = par.beginOfBody();
1078 double tmpx = row.x;
1079 double last_tmpx = tmpx;
1082 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1085 // check for empty row
1091 while (vc < end && tmpx <= x) {
1092 c = bidi.vis2log(vc);
1094 if (body_pos > 0 && c == body_pos - 1) {
1095 FontMetrics const & fm = theFontMetrics(
1096 text_->getLabelFont(buffer, par));
1097 tmpx += row.label_hfill + fm.width(layout->labelsep);
1098 if (par.isLineSeparator(body_pos - 1))
1099 tmpx -= singleWidth(pit, body_pos - 1);
1102 tmpx += singleWidth(pit, c);
1103 if (par.isSeparator(c) && c >= body_pos)
1104 tmpx += row.separator;
1108 if ((tmpx + last_tmpx) / 2 > x) {
1113 BOOST_ASSERT(vc <= end); // This shouldn't happen.
1116 // This (rtl_support test) is not needed, but gives
1117 // some speedup if rtl_support == false
1118 bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
1120 // If lastrow is false, we don't need to compute
1121 // the value of rtl.
1122 bool const rtl = lastrow ? text_->isRTL(buffer, par) : false;
1124 ((rtl && left_side && vc == row.pos() && x < tmpx - 5) ||
1125 (!rtl && !left_side && vc == end && x > tmpx + 5)))
1127 else if (vc == row.pos()) {
1128 c = bidi.vis2log(vc);
1129 if (bidi.level(c) % 2 == 1)
1132 c = bidi.vis2log(vc - 1);
1133 bool const rtl = (bidi.level(c) % 2 == 1);
1134 if (left_side == rtl) {
1136 boundary = isRTLBoundary(pit, c);
1140 // I believe this code is not needed anymore (Jug 20050717)
1142 // The following code is necessary because the cursor position past
1143 // the last char in a row is logically equivalent to that before
1144 // the first char in the next row. That's why insets causing row
1145 // divisions -- Newline and display-style insets -- must be treated
1146 // specially, so cursor up/down doesn't get stuck in an air gap -- MV
1147 // Newline inset, air gap below:
1148 if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
1149 if (bidi.level(end -1) % 2 == 0)
1150 tmpx -= singleWidth(pit, end - 1);
1152 tmpx += singleWidth(pit, end - 1);
1156 // Air gap above display inset:
1157 if (row.pos() < end && c >= end && end < par.size()
1158 && par.isInset(end) && par.getInset(end)->display()) {
1161 // Air gap below display inset:
1162 if (row.pos() < end && c >= end && par.isInset(end - 1)
1163 && par.getInset(end - 1)->display()) {
1169 pos_type const col = c - row.pos();
1171 if (!c || end == par.size())
1174 if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
1179 return min(col, end - 1 - row.pos());
1183 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1185 // We play safe and use parMetrics(pit) to make sure the
1186 // ParagraphMetrics will be redone and OK to use if needed.
1187 // Otherwise we would use an empty ParagraphMetrics in
1188 // upDownInText() while in selection mode.
1189 ParagraphMetrics const & pm = parMetrics(pit);
1191 BOOST_ASSERT(row < int(pm.rows().size()));
1193 Row const & r = pm.rows()[row];
1194 return r.pos() + getColumnNearX(pit, r, x, bound);
1198 void TextMetrics::newParMetricsDown()
1200 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1201 pit_type const pit = last.first + 1;
1202 if (pit == int(text_->paragraphs().size()))
1205 // do it and update its position.
1207 par_metrics_[pit].setPosition(last.second.position()
1208 + last.second.descent());
1212 void TextMetrics::newParMetricsUp()
1214 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1215 if (first.first == 0)
1218 pit_type const pit = first.first - 1;
1219 // do it and update its position.
1221 par_metrics_[pit].setPosition(first.second.position()
1222 - first.second.ascent());
1225 // y is screen coordinate
1226 pit_type TextMetrics::getPitNearY(int y)
1228 BOOST_ASSERT(!text_->paragraphs().empty());
1229 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1231 // look for highest numbered paragraph with y coordinate less than given y
1234 ParMetricsCache::const_iterator it = par_metrics_.begin();
1235 ParMetricsCache::const_iterator et = par_metrics_.end();
1236 ParMetricsCache::const_iterator last = et; last--;
1238 ParagraphMetrics const & pm = it->second;
1240 if (y < it->second.position() - int(pm.ascent())) {
1241 // We are looking for a position that is before the first paragraph in
1242 // the cache (which is in priciple off-screen, that is before the
1245 // We are already at the first paragraph in the inset.
1247 // OK, this is the paragraph we are looking for.
1248 pit = it->first - 1;
1253 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1255 if (y >= last->second.position() + int(pm_last.descent())) {
1256 // We are looking for a position that is after the last paragraph in
1257 // the cache (which is in priciple off-screen, that is before the
1259 pit = last->first + 1;
1260 if (pit == int(text_->paragraphs().size()))
1261 // We are already at the last paragraph in the inset.
1263 // OK, this is the paragraph we are looking for.
1264 newParMetricsDown();
1268 for (; it != et; ++it) {
1269 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1270 << " y: " << it->second.position());
1272 ParagraphMetrics const & pm = par_metrics_[it->first];
1274 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1276 yy = it->second.position();
1280 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1286 Row const & TextMetrics::getRowNearY(int y, pit_type pit) const
1288 ParagraphMetrics const & pm = par_metrics_[pit];
1290 int yy = pm.position() - pm.ascent();
1291 BOOST_ASSERT(!pm.rows().empty());
1292 RowList::const_iterator rit = pm.rows().begin();
1293 RowList::const_iterator rlast = pm.rows().end();
1295 for (; rit != rlast; yy += rit->height(), ++rit)
1296 if (yy + rit->height() > y)
1302 // x,y are absolute screen coordinates
1303 // sets cursor recursively descending into nested editable insets
1304 Inset * TextMetrics::editXY(Cursor & cur, int x, int y)
1306 if (lyxerr.debugging(Debug::WORKAREA)) {
1307 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1308 cur.bv().coordCache().dump();
1310 pit_type pit = getPitNearY(y);
1311 BOOST_ASSERT(pit != -1);
1313 Row const & row = getRowNearY(y, pit);
1316 int xx = x; // is modified by getColumnNearX
1317 pos_type const pos = row.pos()
1318 + getColumnNearX(pit, row, xx, bound);
1321 cur.boundary(bound);
1324 // try to descend into nested insets
1325 Inset * inset = checkInsetHit(x, y);
1326 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1328 // Either we deconst editXY or better we move current_font
1329 // and real_current_font to Cursor
1330 // FIXME: what is needed now that current_font and real_current_font
1332 cur.setCurrentFont();
1336 ParagraphList const & pars = text_->paragraphs();
1337 Inset const * insetBefore = pos? pars[pit].getInset(pos - 1): 0;
1338 //Inset * insetBehind = pars[pit].getInset(pos);
1340 // This should be just before or just behind the
1341 // cursor position set above.
1342 BOOST_ASSERT((pos != 0 && inset == insetBefore)
1343 || inset == pars[pit].getInset(pos));
1345 // Make sure the cursor points to the position before
1347 if (inset == insetBefore) {
1349 cur.boundary(false);
1352 // Try to descend recursively inside the inset.
1353 inset = inset->editXY(cur, x, y);
1355 if (cur.top().text() == text_)
1356 cur.setCurrentFont();
1361 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1363 BOOST_ASSERT(text_ == cur.text());
1364 pit_type pit = getPitNearY(y);
1366 ParagraphMetrics const & pm = par_metrics_[pit];
1368 int yy = pm.position() - pm.ascent();
1369 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1370 " pit: " << pit << " yy: " << yy);
1373 BOOST_ASSERT(pm.rows().size());
1374 for (; r < int(pm.rows().size()) - 1; ++r) {
1375 Row const & row = pm.rows()[r];
1376 if (int(yy + row.height()) > y)
1381 Row const & row = pm.rows()[r];
1383 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1387 pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
1389 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1391 text_->setCursor(cur, pit, pos, true, bound);
1392 // remember new position.
1397 //takes screen x,y coordinates
1398 Inset * TextMetrics::checkInsetHit(int x, int y)
1400 pit_type pit = getPitNearY(y);
1401 BOOST_ASSERT(pit != -1);
1403 Paragraph const & par = text_->paragraphs()[pit];
1404 ParagraphMetrics const & pm = par_metrics_[pit];
1406 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1408 InsetList::const_iterator iit = par.insetList().begin();
1409 InsetList::const_iterator iend = par.insetList().end();
1410 for (; iit != iend; ++iit) {
1411 Inset * inset = iit->inset;
1413 LYXERR(Debug::DEBUG, "examining inset " << inset);
1415 if (!bv_->coordCache().getInsets().has(inset)) {
1416 LYXERR(Debug::DEBUG, "inset has no cached position");
1420 Dimension const & dim = pm.insetDimension(inset);
1421 Point p = bv_->coordCache().getInsets().xy(inset);
1423 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1424 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1427 && x <= p.x_ + dim.wid
1428 && y >= p.y_ - dim.asc
1429 && y <= p.y_ + dim.des) {
1430 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1435 LYXERR(Debug::DEBUG, "No inset hit. ");
1440 int TextMetrics::cursorX(CursorSlice const & sl,
1441 bool boundary) const
1443 BOOST_ASSERT(sl.text() == text_);
1444 pit_type const pit = sl.pit();
1445 Paragraph const & par = text_->paragraphs()[pit];
1446 ParagraphMetrics const & pm = par_metrics_[pit];
1447 if (pm.rows().empty())
1450 pos_type ppos = sl.pos();
1451 // Correct position in front of big insets
1452 bool const boundary_correction = ppos != 0 && boundary;
1453 if (boundary_correction)
1456 Row const & row = pm.getRow(sl.pos(), boundary);
1458 pos_type cursor_vpos = 0;
1460 Buffer const & buffer = bv_->buffer();
1463 bidi.computeTables(par, buffer, row);
1465 pos_type const row_pos = row.pos();
1466 pos_type const end = row.endpos();
1467 // Spaces at logical line breaks in bidi text must be skipped during
1468 // cursor positioning. However, they may appear visually in the middle
1469 // of a row; they must be skipped, wherever they are...
1470 // * logically "abc_[HEBREW_\nHEBREW]"
1471 // * visually "abc_[_WERBEH\nWERBEH]"
1472 pos_type skipped_sep_vpos = -1;
1475 cursor_vpos = row_pos;
1476 else if (ppos >= end)
1477 cursor_vpos = text_->isRTL(buffer, par) ? row_pos : end;
1478 else if (ppos > row_pos && ppos >= end)
1479 // Place cursor after char at (logical) position pos - 1
1480 cursor_vpos = (bidi.level(ppos - 1) % 2 == 0)
1481 ? bidi.log2vis(ppos - 1) + 1 : bidi.log2vis(ppos - 1);
1483 // Place cursor before char at (logical) position ppos
1484 cursor_vpos = (bidi.level(ppos) % 2 == 0)
1485 ? bidi.log2vis(ppos) : bidi.log2vis(ppos) + 1;
1487 pos_type body_pos = par.beginOfBody();
1489 (body_pos > end || !par.isLineSeparator(body_pos - 1)))
1492 // Use font span to speed things up, see below
1496 // If the last logical character is a separator, skip it, unless
1497 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
1498 if (end > 0 && end < par.size() && par.isSeparator(end - 1))
1499 skipped_sep_vpos = bidi.log2vis(end - 1);
1501 for (pos_type vpos = row_pos; vpos < cursor_vpos; ++vpos) {
1502 // Skip the separator which is at the logical end of the row
1503 if (vpos == skipped_sep_vpos)
1505 pos_type pos = bidi.vis2log(vpos);
1506 if (body_pos > 0 && pos == body_pos - 1) {
1507 FontMetrics const & labelfm = theFontMetrics(
1508 text_->getLabelFont(buffer, par));
1509 x += row.label_hfill + labelfm.width(par.layout()->labelsep);
1510 if (par.isLineSeparator(body_pos - 1))
1511 x -= singleWidth(pit, body_pos - 1);
1514 // Use font span to speed things up, see above
1515 if (pos < font_span.first || pos > font_span.last) {
1516 font_span = par.fontSpan(pos);
1517 font = getDisplayFont(pit, pos);
1520 x += pm.singleWidth(pos, font);
1522 if (par.isSeparator(pos) && pos >= body_pos)
1526 // see correction above
1527 if (boundary_correction) {
1528 if (isRTL(sl, boundary))
1529 x -= singleWidth(pit, ppos);
1531 x += singleWidth(pit, ppos);
1538 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1540 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1541 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1542 if (pm.rows().empty())
1546 h -= par_metrics_[0].rows()[0].ascent();
1547 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1548 h += par_metrics_[pit].height();
1551 if (pos && boundary)
1553 size_t const rend = pm.pos2row(pos);
1554 for (size_t rit = 0; rit != rend; ++rit)
1555 h += pm.rows()[rit].height();
1556 h += pm.rows()[rend].ascent();
1561 void TextMetrics::cursorPrevious(Cursor & cur)
1563 pos_type cpos = cur.pos();
1564 pit_type cpar = cur.pit();
1566 int x = cur.x_target();
1567 setCursorFromCoordinates(cur, x, 0);
1568 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1570 if (cpar == cur.pit() && cpos == cur.pos())
1571 // we have a row which is taller than the workarea. The
1572 // simplest solution is to move to the previous row instead.
1573 cur.dispatch(FuncRequest(cur.selection()? LFUN_UP_SELECT: LFUN_UP));
1576 cur.updateFlags(Update::Force | Update::FitCursor);
1580 void TextMetrics::cursorNext(Cursor & cur)
1582 pos_type cpos = cur.pos();
1583 pit_type cpar = cur.pit();
1585 int x = cur.x_target();
1586 setCursorFromCoordinates(cur, x, cur.bv().workHeight() - 1);
1587 cur.dispatch(FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1589 if (cpar == cur.pit() && cpos == cur.pos())
1590 // we have a row which is taller than the workarea. The
1591 // simplest solution is to move to the next row instead.
1593 FuncRequest(cur.selection()? LFUN_DOWN_SELECT: LFUN_DOWN));
1596 cur.updateFlags(Update::Force | Update::FitCursor);
1600 // the cursor set functions have a special mechanism. When they
1601 // realize you left an empty paragraph, they will delete it.
1603 bool TextMetrics::cursorHome(Cursor & cur)
1605 BOOST_ASSERT(text_ == cur.text());
1606 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1607 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1608 return text_->setCursor(cur, cur.pit(), row.pos());
1612 bool TextMetrics::cursorEnd(Cursor & cur)
1614 BOOST_ASSERT(text_ == cur.text());
1615 // if not on the last row of the par, put the cursor before
1616 // the final space exept if I have a spanning inset or one string
1617 // is so long that we force a break.
1618 pos_type end = cur.textRow().endpos();
1620 // empty text, end-1 is no valid position
1622 bool boundary = false;
1623 if (end != cur.lastpos()) {
1624 if (!cur.paragraph().isLineSeparator(end-1)
1625 && !cur.paragraph().isNewline(end-1))
1630 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1634 void TextMetrics::deleteLineForward(Cursor & cur)
1636 BOOST_ASSERT(text_ == cur.text());
1637 if (cur.lastpos() == 0) {
1638 // Paragraph is empty, so we just go forward
1639 text_->cursorForward(cur);
1642 cur.selection() = true; // to avoid deletion
1645 // What is this test for ??? (JMarc)
1646 if (!cur.selection())
1647 text_->deleteWordForward(cur);
1649 cap::cutSelection(cur, true, false);
1650 checkBufferStructure(cur.buffer(), cur);
1655 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1657 ParagraphList const & pars = text_->paragraphs();
1658 return row.endpos() >= pars[pit].size()
1659 && pit + 1 == pit_type(pars.size());
1663 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1665 return row.pos() == 0 && pit == 0;
1669 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1671 BOOST_ASSERT(pit >= 0);
1672 BOOST_ASSERT(pit < int(text_->paragraphs().size()));
1673 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1677 int TextMetrics::leftMargin(int max_width,
1678 pit_type const pit, pos_type const pos) const
1680 ParagraphList const & pars = text_->paragraphs();
1682 BOOST_ASSERT(pit >= 0);
1683 BOOST_ASSERT(pit < int(pars.size()));
1684 Paragraph const & par = pars[pit];
1685 BOOST_ASSERT(pos >= 0);
1686 BOOST_ASSERT(pos <= par.size());
1687 Buffer const & buffer = bv_->buffer();
1688 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1689 TextClass const & tclass = buffer.params().getTextClass();
1690 LayoutPtr const & layout = par.layout();
1692 docstring parindent = layout->parindent;
1696 if (text_->isMainText(buffer))
1697 l_margin += changebarMargin();
1699 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1700 tclass.leftmargin());
1702 if (par.getDepth() != 0) {
1703 // find the next level paragraph
1704 pit_type newpar = outerHook(pit, pars);
1705 if (newpar != pit_type(pars.size())) {
1706 if (pars[newpar].layout()->isEnvironment()) {
1707 l_margin = leftMargin(max_width, newpar);
1709 if (par.layout() == tclass.defaultLayout()) {
1710 if (pars[newpar].params().noindent())
1713 parindent = pars[newpar].layout()->parindent;
1718 // This happens after sections in standard classes. The 1.3.x
1719 // code compared depths too, but it does not seem necessary
1721 if (par.layout() == tclass.defaultLayout()
1722 && pit > 0 && pars[pit - 1].layout()->nextnoindent)
1725 FontInfo const labelfont = text_->getLabelFont(buffer, par);
1726 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1728 switch (layout->margintype) {
1729 case MARGIN_DYNAMIC:
1730 if (!layout->leftmargin.empty()) {
1731 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1732 layout->leftmargin);
1734 if (!par.getLabelstring().empty()) {
1735 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1736 l_margin += labelfont_metrics.width(par.getLabelstring());
1737 l_margin += labelfont_metrics.width(layout->labelsep);
1741 case MARGIN_MANUAL: {
1742 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1743 // The width of an empty par, even with manual label, should be 0
1744 if (!par.empty() && pos >= par.beginOfBody()) {
1745 if (!par.getLabelWidthString().empty()) {
1746 docstring labstr = par.getLabelWidthString();
1747 l_margin += labelfont_metrics.width(labstr);
1748 l_margin += labelfont_metrics.width(layout->labelsep);
1754 case MARGIN_STATIC: {
1755 l_margin += theFontMetrics(buffer.params().getFont()).
1756 signedWidth(layout->leftmargin) * 4 / (par.getDepth() + 4);
1760 case MARGIN_FIRST_DYNAMIC:
1761 if (layout->labeltype == LABEL_MANUAL) {
1762 if (pos >= par.beginOfBody()) {
1763 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1765 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1768 // Special case to fix problems with
1770 || (layout->labeltype == LABEL_STATIC
1771 && layout->latextype == LATEX_ENVIRONMENT
1772 && !isFirstInSequence(pit, pars))) {
1773 l_margin += labelfont_metrics.signedWidth(layout->leftmargin);
1774 } else if (layout->labeltype != LABEL_TOP_ENVIRONMENT
1775 && layout->labeltype != LABEL_BIBLIO
1776 && layout->labeltype !=
1777 LABEL_CENTERED_TOP_ENVIRONMENT) {
1778 l_margin += labelfont_metrics.signedWidth(layout->labelindent);
1779 l_margin += labelfont_metrics.width(layout->labelsep);
1780 l_margin += labelfont_metrics.width(par.getLabelstring());
1784 case MARGIN_RIGHT_ADDRESS_BOX: {
1786 // ok, a terrible hack. The left margin depends on the widest
1787 // row in this paragraph.
1788 RowList::iterator rit = par.rows().begin();
1789 RowList::iterator end = par.rows().end();
1790 // FIXME: This is wrong.
1791 int minfill = max_width;
1792 for ( ; rit != end; ++rit)
1793 if (rit->fill() < minfill)
1794 minfill = rit->fill();
1795 l_margin += theFontMetrics(params.getFont()).signedWidth(layout->leftmargin);
1796 l_margin += minfill;
1798 // also wrong, but much shorter.
1799 l_margin += max_width / 2;
1804 if (!par.params().leftIndent().zero())
1805 l_margin += par.params().leftIndent().inPixels(max_width);
1809 if (par.params().align() == LYX_ALIGN_LAYOUT)
1810 align = layout->align;
1812 align = par.params().align();
1814 // set the correct parindent
1816 && (layout->labeltype == LABEL_NO_LABEL
1817 || layout->labeltype == LABEL_TOP_ENVIRONMENT
1818 || layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT
1819 || (layout->labeltype == LABEL_STATIC
1820 && layout->latextype == LATEX_ENVIRONMENT
1821 && !isFirstInSequence(pit, pars)))
1822 && align == LYX_ALIGN_BLOCK
1823 && !par.params().noindent()
1824 // in some insets, paragraphs are never indented
1825 && !(par.inInset() && par.inInset()->neverIndent(buffer))
1826 // display style insets are always centered, omit indentation
1829 && par.getInset(pos)->display())
1830 && (par.layout() != tclass.defaultLayout()
1831 || buffer.params().paragraph_separation ==
1832 BufferParams::PARSEP_INDENT))
1834 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1842 int TextMetrics::singleWidth(pit_type pit, pos_type pos) const
1844 ParagraphMetrics const & pm = par_metrics_[pit];
1846 return pm.singleWidth(pos, getDisplayFont(pit, pos));
1850 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1852 if (par_metrics_.empty())
1858 ParMetricsCache::iterator it = par_metrics_.begin();
1859 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1860 y -= it->second.ascent();
1861 for (; it != pm_end; ++it) {
1862 ParagraphMetrics const & pmi = it->second;
1864 pit_type const pit = it->first;
1865 // Save the paragraph position in the cache.
1866 it->second.setPosition(y);
1867 drawParagraph(pi, pit, x, y);
1873 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const
1875 BufferParams const & bparams = bv_->buffer().params();
1876 ParagraphMetrics const & pm = par_metrics_[pit];
1877 if (pm.rows().empty())
1881 bool const original_drawing_state = pi.pain.isDrawingEnabled();
1882 int const ww = bv_->workHeight();
1883 size_t const nrows = pm.rows().size();
1885 for (size_t i = 0; i != nrows; ++i) {
1887 Row const & row = pm.rows()[i];
1891 bool const inside = (y + row.descent() >= 0
1892 && y - row.ascent() < ww);
1893 // It is not needed to draw on screen if we are not inside.
1894 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1895 RowPainter rp(pi, *text_, pit, row, bidi, x, y);
1897 // Row signature; has row changed since last paint?
1898 row.setCrc(pm.computeRowSignature(row, bparams));
1899 bool row_has_changed = row.changed();
1901 // Don't paint the row if a full repaint has not been requested
1902 // and if it has not changed.
1903 if (!pi.full_repaint && !row_has_changed) {
1904 // Paint only the insets if the text itself is
1906 rp.paintOnlyInsets();
1911 // Clear background of this row if paragraph background was not
1912 // already cleared because of a full repaint.
1913 if (!pi.full_repaint && row_has_changed) {
1914 pi.pain.fillRectangle(x, y - row.ascent(),
1915 width(), row.height(), pi.background_color);
1918 bool row_selection = row.sel_beg != -1 && row.sel_end != -1;
1919 if (row_selection) {
1920 DocIterator beg = bv_->cursor().selectionBegin();
1921 DocIterator end = bv_->cursor().selectionEnd();
1922 bool const beg_margin = beg.pit() < pit && i == 0;
1923 bool const end_margin = end.pit() > pit && i == nrows - 1;
1925 beg.pos() = row.sel_beg;
1927 end.pos() = row.sel_end;
1928 drawRowSelection(pi, x, row, beg, end, beg_margin, end_margin);
1931 // Instrumentation for testing row cache (see also
1933 if (lyxerr.debugging(Debug::PAINTING) && inside
1934 && (row_selection || pi.full_repaint || row_has_changed)) {
1935 string const foreword = text_->isMainText(bv_->buffer()) ?
1936 "main text redraw " : "inset text redraw: ";
1937 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1938 << " row_selection=" << row_selection
1939 << " full_repaint=" << pi.full_repaint
1940 << " row_has_changed=" << row_has_changed);
1943 // Backup full_repaint status and force full repaint
1944 // for inner insets as the Row has been cleared out.
1945 bool tmp = pi.full_repaint;
1946 pi.full_repaint = true;
1949 rp.paintChangeBar();
1956 // Restore full_repaint status.
1957 pi.full_repaint = tmp;
1959 // Re-enable screen drawing for future use of the painter.
1960 pi.pain.setDrawingEnabled(original_drawing_state);
1962 //LYXERR(Debug::PAINTING, ".");
1966 void TextMetrics::drawRowSelection(PainterInfo & pi, int x, Row const & row,
1967 DocIterator const & beg, DocIterator const & end,
1968 bool drawOnBegMargin, bool drawOnEndMargin) const
1970 Buffer & buffer = bv_->buffer();
1971 DocIterator cur = beg;
1972 int x1 = cursorX(beg.top(), beg.boundary());
1973 int x2 = cursorX(end.top(), end.boundary());
1974 int y1 = bv_->getPos(cur, cur.boundary()).y_ - row.ascent();
1975 int y2 = y1 + row.height();
1978 if (drawOnBegMargin) {
1979 if (text_->isRTL(buffer, beg.paragraph()))
1980 pi.pain.fillRectangle(x + x1, y1, width() - x1, y2 - y1, Color_selection);
1982 pi.pain.fillRectangle(x, y1, x1, y2 - y1, Color_selection);
1985 if (drawOnEndMargin) {
1986 if (text_->isRTL(buffer, beg.paragraph()))
1987 pi.pain.fillRectangle(x, y1, x2, y2 - y1, Color_selection);
1989 pi.pain.fillRectangle(x + x2, y1, width() - x2, y2 - y1, Color_selection);
1992 // if we are on a boundary from the beginning, it's probably
1993 // a RTL boundary and we jump to the other side directly as this
1994 // segement is 0-size and confuses the logic below
1996 cur.boundary(false);
1998 // go through row and draw from RTL boundary to RTL boundary
2000 bool drawNow = false;
2002 // simplified cursorForward code below which does not
2003 // descend into insets and which does not go into the
2004 // next line. Compare the logic with the original cursorForward
2006 // if left of boundary -> just jump to right side
2007 // but for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
2008 if (cur.boundary()) {
2009 cur.boundary(false);
2010 } else if (isRTLBoundary(cur.pit(), cur.pos() + 1)) {
2011 // in front of RTL boundary -> Stay on this side of the boundary because:
2012 // ab|cDDEEFFghi -> abc|DDEEFFghi
2021 if (cur.pos() == row.endpos())
2026 // the previous segment was just drawn, now the next starts
2027 x1 = cursorX(cur.top(), cur.boundary());
2030 if (!(cur < end) || drawNow) {
2031 x2 = cursorX(cur.top(), cur.boundary());
2032 pi.pain.fillRectangle(x + min(x1,x2), y1, abs(x2 - x1), y2 - y1,
2035 // reset x1, so it is set again next round (which will be on the
2036 // right side of a boundary or at the selection end)
2042 //int TextMetrics::pos2x(pit_type pit, pos_type pos) const
2044 // ParagraphMetrics const & pm = par_metrics_[pit];
2045 // Row const & r = pm.rows()[row];
2051 int defaultRowHeight()
2053 return int(theFontMetrics(sane_font).maxHeight() * 1.2);