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 "CoordCache.h"
28 #include "CutAndPaste.h"
30 #include "InsetList.h"
34 #include "MetricsInfo.h"
35 #include "ParagraphParameters.h"
36 #include "RowPainter.h"
38 #include "TextClass.h"
41 #include "insets/InsetText.h"
43 #include "mathed/MathMacroTemplate.h"
45 #include "frontends/FontMetrics.h"
46 #include "frontends/Painter.h"
48 #include "support/debug.h"
49 #include "support/lassert.h"
58 using frontend::FontMetrics;
63 int numberOfLabelHfills(Paragraph const & par, Row const & row)
65 pos_type last = row.endpos() - 1;
66 pos_type first = row.pos();
68 // hfill *DO* count at the beginning of paragraphs!
70 while (first < last && par.isHfill(first))
74 last = min(last, par.beginOfBody());
76 for (pos_type p = first; p < last; ++p) {
83 // FIXME: this needs to be rewritten, probably by merging it into some
84 // code that, besides counting, sets the active status of the space
85 // inset in the row element.
86 int numberOfHfills(Row const & row, ParagraphMetrics const & pm,
87 pos_type const body_pos)
90 Row::const_iterator cit = row.begin();
91 Row::const_iterator const end = row.end();
92 for ( ; cit != end ; ++cit)
93 if (cit->pos >= body_pos
94 && cit->inset && pm.hfillExpansion(row, cit->pos))
102 /////////////////////////////////////////////////////////////////////
106 /////////////////////////////////////////////////////////////////////
109 TextMetrics::TextMetrics(BufferView * bv, Text * text)
110 : bv_(bv), text_(text)
113 max_width_ = bv_->workWidth();
114 dim_.wid = max_width_;
120 bool TextMetrics::contains(pit_type pit) const
122 return par_metrics_.find(pit) != par_metrics_.end();
126 ParagraphMetrics const & TextMetrics::parMetrics(pit_type pit) const
128 return const_cast<TextMetrics *>(this)->parMetrics(pit, true);
133 pair<pit_type, ParagraphMetrics const *> TextMetrics::first() const
135 ParMetricsCache::const_iterator it = par_metrics_.begin();
136 return make_pair(it->first, &it->second);
140 pair<pit_type, ParagraphMetrics const *> TextMetrics::last() const
142 LBUFERR(!par_metrics_.empty());
143 ParMetricsCache::const_reverse_iterator it = par_metrics_.rbegin();
144 return make_pair(it->first, &it->second);
148 ParagraphMetrics & TextMetrics::parMetrics(pit_type pit, bool redo)
150 ParMetricsCache::iterator pmc_it = par_metrics_.find(pit);
151 if (pmc_it == par_metrics_.end()) {
152 pmc_it = par_metrics_.insert(
153 make_pair(pit, ParagraphMetrics(text_->getPar(pit)))).first;
155 if (pmc_it->second.rows().empty() && redo)
157 return pmc_it->second;
161 bool TextMetrics::metrics(MetricsInfo & mi, Dimension & dim, int min_width)
163 LBUFERR(mi.base.textwidth > 0);
164 max_width_ = mi.base.textwidth;
165 // backup old dimension.
166 Dimension const old_dim = dim_;
169 dim_.wid = min_width;
170 pit_type const npar = text_->paragraphs().size();
172 // If there is more than one row, expand the text to
173 // the full allowable width.
174 dim_.wid = max_width_;
176 //lyxerr << "TextMetrics::metrics: width: " << mi.base.textwidth
177 // << " maxWidth: " << max_width_ << "\nfont: " << mi.base.font << endl;
179 bool changed = false;
181 for (pit_type pit = 0; pit != npar; ++pit) {
182 changed |= redoParagraph(pit);
183 ParagraphMetrics const & pm = par_metrics_[pit];
185 if (dim_.wid < pm.width())
186 dim_.wid = pm.width();
189 dim_.asc = par_metrics_[0].ascent();
190 dim_.des = h - dim_.asc;
191 //lyxerr << "dim_.wid " << dim_.wid << endl;
192 //lyxerr << "dim_.asc " << dim_.asc << endl;
193 //lyxerr << "dim_.des " << dim_.des << endl;
195 changed |= dim_ != old_dim;
201 int TextMetrics::rightMargin(ParagraphMetrics const & pm) const
203 return main_text_? pm.rightMargin(*bv_) : 0;
207 int TextMetrics::rightMargin(pit_type const pit) const
209 return main_text_? par_metrics_[pit].rightMargin(*bv_) : 0;
213 void TextMetrics::applyOuterFont(Font & font) const
215 FontInfo lf(font_.fontInfo());
216 lf.reduce(bv_->buffer().params().getFont().fontInfo());
217 font.fontInfo().realize(lf);
221 Font TextMetrics::displayFont(pit_type pit, pos_type pos) const
223 LASSERT(pos >= 0, { static Font f; return f; });
225 ParagraphList const & pars = text_->paragraphs();
226 Paragraph const & par = pars[pit];
227 Layout const & layout = par.layout();
228 Buffer const & buffer = bv_->buffer();
230 BufferParams const & params = buffer.params();
231 pos_type const body_pos = par.beginOfBody();
233 // We specialize the 95% common case:
234 if (!par.getDepth()) {
235 Font f = par.getFontSettings(params, pos);
236 if (!text_->isMainText())
238 bool lab = layout.labeltype == LABEL_MANUAL && pos < body_pos;
240 FontInfo const & lf = lab ? layout.labelfont : layout.font;
241 FontInfo rlf = lab ? layout.reslabelfont : layout.resfont;
243 // In case the default family has been customized
244 if (lf.family() == INHERIT_FAMILY)
245 rlf.setFamily(params.getFont().fontInfo().family());
246 f.fontInfo().realize(rlf);
250 // The uncommon case need not be optimized as much
251 FontInfo const & layoutfont = pos < body_pos ?
252 layout.labelfont : layout.font;
254 Font font = par.getFontSettings(params, pos);
255 font.fontInfo().realize(layoutfont);
257 if (!text_->isMainText())
258 applyOuterFont(font);
260 // Realize against environment font information
261 // NOTE: the cast to pit_type should be removed when pit_type
262 // changes to a unsigned integer.
263 if (pit < pit_type(pars.size()))
264 font.fontInfo().realize(text_->outerFont(pit).fontInfo());
266 // Realize with the fonts of lesser depth.
267 font.fontInfo().realize(params.getFont().fontInfo());
273 bool TextMetrics::isRTL(CursorSlice const & sl, bool boundary) const
279 if (boundary && sl.pos() > 0)
282 return displayFont(sl.pit(), sl.pos() + correction).isVisibleRightToLeft();
286 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos) const
288 // no RTL boundary at paragraph start
292 Font const & left_font = displayFont(pit, pos - 1);
294 return isRTLBoundary(pit, pos, left_font);
298 // isRTLBoundary returns false on a real end-of-line boundary,
299 // because otherwise the two boundary types get mixed up.
300 // This is the whole purpose of this being in TextMetrics.
301 bool TextMetrics::isRTLBoundary(pit_type pit, pos_type pos,
302 Font const & font) const
304 if (// no RTL boundary at paragraph start
306 // if the metrics have not been calculated, then we are not
307 // on screen and can safely ignore issues about boundaries.
311 ParagraphMetrics & pm = par_metrics_[pit];
312 // no RTL boundary in empty paragraph
313 if (pm.rows().empty())
316 pos_type endpos = pm.getRow(pos - 1, false).endpos();
317 pos_type startpos = pm.getRow(pos, false).pos();
318 // no RTL boundary at line start:
319 // abc\n -> toggle to RTL -> abc\n (and not: abc\n|
321 if (pos == startpos && pos == endpos) // start of cur row, end of prev row
324 Paragraph const & par = text_->getPar(pit);
325 // no RTL boundary at line break:
326 // abc|\n -> move right -> abc\n (and not: abc\n|
328 if (startpos == pos && endpos == pos && endpos != par.size()
329 && (par.isNewline(pos - 1)
330 || par.isEnvSeparator(pos - 1)
331 || par.isLineSeparator(pos - 1)
332 || par.isSeparator(pos - 1)))
335 bool left = font.isVisibleRightToLeft();
337 if (pos == par.size())
338 right = par.isRTL(bv_->buffer().params());
340 right = displayFont(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' explicitly 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 // Check whether there are InsetBibItems that need fixing
360 // FIXME: This check ought to be done somewhere else. It is the reason
361 // why text_ is not const. But then, where else to do it?
362 // Well, how can you end up with either (a) a biblio environment that
363 // has no InsetBibitem or (b) a biblio environment with more than one
364 // InsetBibitem? I think the answer is: when paragraphs are merged;
365 // when layout is set; when material is pasted.
366 if (par.brokenBiblio()) {
367 Cursor & cur = const_cast<Cursor &>(bv_->cursor());
368 // In some cases, we do not know how to record undo
369 if (&cur.inset() == &text_->inset())
370 cur.recordUndo(pit, pit);
372 int const moveCursor = par.fixBiblio(buffer);
374 // Is it necessary to update the cursor?
375 if (&cur.inset() == &text_->inset() && cur.pit() == pit) {
378 else if (moveCursor < 0 && cur.pos() >= -moveCursor)
383 // Optimisation: this is used in the next two loops
384 // so better to calculate that once here.
385 int const right_margin = rightMargin(pm);
387 // iterator pointing to paragraph to resolve macros
388 DocIterator parPos = text_->macrocontextPosition();
392 LYXERR(Debug::INFO, "MacroContext not initialised!"
393 << " Going through the buffer again and hope"
394 << " the context is better then.");
395 // FIXME audit updateBuffer calls
396 // This should not be here, but it is not clear yet where else it
398 bv_->buffer().updateBuffer();
399 parPos = text_->macrocontextPosition();
400 LBUFERR(!parPos.empty());
405 par.setBeginOfBody();
406 Font const bufferfont = buffer.params().getFont();
407 CoordCache::Insets & insetCache = bv_->coordCache().insets();
408 InsetList::const_iterator ii = par.insetList().begin();
409 InsetList::const_iterator iend = par.insetList().end();
410 for (; ii != iend; ++ii) {
411 // FIXME Doesn't this HAVE to be non-empty?
412 // position already initialized?
413 if (!parPos.empty()) {
414 parPos.pos() = ii->pos;
416 // A macro template would normally not be visible
417 // by itself. But the tex macro semantics allow
418 // recursion, so we artifically take the context
419 // after the macro template to simulate this.
420 if (ii->inset->lyxCode() == MATHMACRO_CODE)
424 // do the metric calculation
426 int const w = max_width_ - leftMargin(max_width_, pit, ii->pos)
428 Font const & font = ii->inset->inheritFont() ?
429 displayFont(pit, ii->pos) : bufferfont;
430 MacroContext mc(&buffer, parPos);
431 MetricsInfo mi(bv_, font.fontInfo(), w, mc);
432 ii->inset->metrics(mi, dim);
433 if (!insetCache.has(ii->inset) || insetCache.dim(ii->inset) != dim) {
434 insetCache.add(ii->inset, dim);
440 size_t row_index = 0;
441 // maximum pixel width of a row
443 if (row_index == pm.rows().size())
444 pm.rows().push_back(Row());
445 Row & row = pm.rows()[row_index];
448 breakRow(row, right_margin, pit);
449 setRowHeight(row, pit);
450 row.setChanged(false);
451 if (row_index || row.endpos() < par.size()
452 || (row.right_boundary() && par.inInset().lyxCode() != CELL_CODE)) {
453 /* If there is more than one row or the row has been
454 * broken by a display inset or a newline, expand the text
455 * to the full allowable width. This setting here is
456 * needed for the computeRowMetrics() below. In the case
457 * of a display inset, we do nothing when inside a table
458 * cell, because the tabular code is not prepared for
459 * that, and it triggers when using a caption in a
460 * longtable (see bugs #9945 and #9757).
462 if (dim_.wid < max_width_)
463 dim_.wid = max_width_;
465 int const max_row_width = max(dim_.wid, row.width());
466 computeRowMetrics(pit, row, max_row_width);
467 first = row.endpos();
470 pm.dim().wid = max(pm.dim().wid, row.width());
471 pm.dim().des += row.height();
472 } while (first < par.size());
474 if (row_index < pm.rows().size())
475 pm.rows().resize(row_index);
477 // Make sure that if a par ends in newline, there is one more row
479 if (first > 0 && par.isNewline(first - 1)) {
480 if (row_index == pm.rows().size())
481 pm.rows().push_back(Row());
482 Row & row = pm.rows()[row_index];
484 breakRow(row, right_margin, pit);
485 setRowHeight(row, pit);
486 row.setChanged(false);
487 int const max_row_width = max(dim_.wid, row.width());
488 computeRowMetrics(pit, row, max_row_width);
489 pm.dim().des += row.height();
492 pm.dim().asc += pm.rows()[0].ascent();
493 pm.dim().des -= pm.rows()[0].ascent();
495 changed |= old_dim.height() != pm.dim().height();
501 LyXAlignment TextMetrics::getAlign(Paragraph const & par, Row const & row) const
503 Layout const & layout = par.layout();
506 if (par.params().align() == LYX_ALIGN_LAYOUT)
507 align = layout.align;
509 align = par.params().align();
511 // handle alignment inside tabular cells
512 Inset const & owner = text_->inset();
513 bool forced_block = false;
514 switch (owner.contentAlignment()) {
515 case LYX_ALIGN_BLOCK:
516 // In general block align is the default state, but here it is
517 // an explicit choice. Therefore it should not be overridden
521 case LYX_ALIGN_CENTER:
523 case LYX_ALIGN_RIGHT:
524 if (align == LYX_ALIGN_NONE || align == LYX_ALIGN_BLOCK)
525 align = owner.contentAlignment();
528 // unchanged (use align)
532 // Display-style insets should always be on a centered row
533 if (Inset const * inset = par.getInset(row.pos())) {
534 switch (inset->display()) {
535 case Inset::AlignLeft:
536 align = LYX_ALIGN_BLOCK;
538 case Inset::AlignCenter:
539 align = LYX_ALIGN_CENTER;
542 // unchanged (use align)
544 case Inset::AlignRight:
545 align = LYX_ALIGN_RIGHT;
550 if (align == LYX_ALIGN_BLOCK) {
551 // If this row has been broken abruptly by a display inset, or
552 // it is the end of the paragraph, or the user requested we
553 // not justify stuff, then don't stretch.
554 // A forced block alignment can only be overridden the 'no
555 // justification on screen' setting.
556 if (((row.right_boundary() || row.endpos() == par.size())
558 || !bv_->buffer().params().justification)
559 align = text_->isRTL(par) ? LYX_ALIGN_RIGHT : LYX_ALIGN_LEFT;
566 void TextMetrics::computeRowMetrics(pit_type const pit,
567 Row & row, int width) const
572 Paragraph const & par = text_->getPar(pit);
574 int const w = width - row.right_margin - row.width();
575 // FIXME: put back this assertion when the crash on new doc is solved.
576 //LASSERT(w >= 0, /**/);
578 // is there a manual margin with a manual label
579 Layout const & layout = par.layout();
582 if (layout.margintype == MARGIN_MANUAL
583 && layout.labeltype == LABEL_MANUAL) {
584 /// We might have real hfills in the label part
585 nlh = numberOfLabelHfills(par, row);
587 // A manual label par (e.g. List) has an auto-hfill
588 // between the label text and the body of the
590 // But we don't want to do this auto hfill if the par
595 if (nlh && !par.getLabelWidthString().empty())
596 row.label_hfill = labelFill(pit, row) / double(nlh);
599 // are there any hfills in the row?
600 ParagraphMetrics & pm = par_metrics_[pit];
601 int nh = numberOfHfills(row, pm, par.beginOfBody());
605 // We don't have to look at the alignment if the row is already
606 // larger then the permitted width as then we force the
607 // LEFT_ALIGN'edness!
608 if (int(row.width()) >= max_width_)
612 // Common case : there is no hfill, and the alignment will be
614 switch (getAlign(par, row)) {
615 case LYX_ALIGN_BLOCK: {
616 int const ns = row.countSeparators();
617 // If we have separators, then stretch the row
619 row.setSeparatorExtraWidth(double(w) / ns);
620 row.dimension().wid += w;
621 } else if (text_->isRTL(par)) {
622 row.left_margin += w;
623 row.dimension().wid += w;
627 case LYX_ALIGN_RIGHT:
628 row.left_margin += w;
629 row.dimension().wid += w;
631 case LYX_ALIGN_CENTER:
632 row.dimension().wid += w / 2;
633 row.left_margin += w / 2;
637 case LYX_ALIGN_LAYOUT:
638 case LYX_ALIGN_SPECIAL:
639 case LYX_ALIGN_DECIMAL:
647 row.dimension().wid += w;
648 // Set size of hfill insets
649 pos_type const endpos = row.endpos();
650 pos_type body_pos = par.beginOfBody();
652 && (body_pos > endpos || !par.isLineSeparator(body_pos - 1)))
655 CoordCache::Insets & insetCache = bv_->coordCache().insets();
656 Row::iterator cit = row.begin();
657 Row::iterator const cend = row.end();
658 for ( ; cit != cend; ++cit) {
659 if (row.label_hfill && cit->endpos == body_pos
660 && cit->type == Row::SPACE)
661 cit->dim.wid -= int(row.label_hfill * (nlh - 1));
662 if (cit->inset && pm.hfillExpansion(row, cit->pos)) {
663 if (cit->pos >= body_pos) {
664 cit->dim.wid += hfill;
667 cit->dim.wid += hfill_rem;
669 cit->dim.wid += int(row.label_hfill);
670 // Cache the inset dimension.
671 insetCache.add(cit->inset, cit->dim);
677 int TextMetrics::labelFill(pit_type const pit, Row const & row) const
679 Paragraph const & par = text_->getPar(pit);
680 LBUFERR(par.beginOfBody() > 0 || par.isEnvSeparator(0));
683 Row::const_iterator cit = row.begin();
684 Row::const_iterator const end = row.end();
685 // iterate over elements before main body (except the last one,
686 // which is extra space).
687 while (cit!= end && cit->endpos < par.beginOfBody()) {
692 docstring const & label = par.params().labelWidthString();
696 FontMetrics const & fm
697 = theFontMetrics(text_->labelFont(par));
699 return max(0, fm.width(label) - w);
704 // Not used, see TextMetrics::breakRow
705 // this needs special handling - only newlines count as a break point
706 static pos_type addressBreakPoint(pos_type i, Paragraph const & par)
708 pos_type const end = par.size();
711 if (par.isNewline(i))
719 int TextMetrics::labelEnd(pit_type const pit) const
721 // labelEnd is only needed if the layout fills a flushleft label.
722 if (text_->getPar(pit).layout().margintype != MARGIN_MANUAL)
724 // return the beginning of the body
725 return leftMargin(max_width_, pit);
731 * Calling Text::getFont is slow. While rebreaking we scan a
732 * paragraph from left to right calling getFont for every char. This
733 * simple class address this problem by hidding an optimization trick
734 * (not mine btw -AB): the font is reused in the whole font span. The
735 * class handles transparently the "hidden" (not part of the fontlist)
736 * label font (as getFont does).
742 FontIterator(TextMetrics const & tm,
743 Paragraph const & par, pit_type pit, pos_type pos)
744 : tm_(tm), par_(par), pit_(pit), pos_(pos),
745 font_(tm.displayFont(pit, pos)),
746 endspan_(par.fontSpan(pos).last),
747 bodypos_(par.beginOfBody())
751 Font const & operator*() const { return font_; }
754 FontIterator & operator++()
757 if (pos_ < par_.size() && (pos_ > endspan_ || pos_ == bodypos_)) {
758 font_ = tm_.displayFont(pit_, pos_);
759 endspan_ = par_.fontSpan(pos_).last;
765 Font * operator->() { return &font_; }
769 TextMetrics const & tm_;
771 Paragraph const & par_;
786 /** This is the function where the hard work is done. The code here is
787 * very sensitive to small changes :) Note that part of the
788 * intelligence is also in Row::shortenIfNeeded.
790 void TextMetrics::breakRow(Row & row, int const right_margin, pit_type const pit) const
792 Paragraph const & par = text_->getPar(pit);
793 pos_type const end = par.size();
794 pos_type const pos = row.pos();
795 pos_type const body_pos = par.beginOfBody();
796 bool const is_rtl = text_->isRTL(par);
797 bool need_new_row = false;
800 row.left_margin = leftMargin(max_width_, pit, pos);
801 row.right_margin = right_margin;
803 swap(row.left_margin, row.right_margin);
804 // Remember that the row width takes into account the left_margin
805 // but not the right_margin.
806 row.dimension().wid = row.left_margin;
807 // the width available for the row.
808 int const width = max_width_ - row.right_margin;
810 ParagraphList const & pars = text_->paragraphs();
813 //FIXME: As long as leftMargin() is not correctly implemented for
814 // MARGIN_RIGHT_ADDRESS_BOX, we should also not do this here.
815 // Otherwise, long rows will be painted off the screen.
816 if (par.layout().margintype == MARGIN_RIGHT_ADDRESS_BOX)
817 return addressBreakPoint(pos, par);
820 // check for possible inline completion
821 DocIterator const & ic_it = bv_->inlineCompletionPos();
822 pos_type ic_pos = -1;
823 if (ic_it.inTexted() && ic_it.text() == text_ && ic_it.pit() == pit)
824 ic_pos = ic_it.pos();
826 // Now we iterate through until we reach the right margin
827 // or the end of the par, then build a representation of the row.
829 FontIterator fi = FontIterator(*this, par, pit, pos);
831 // this can happen for an empty row after a newline
834 char_type c = par.getChar(i);
835 // The most special cases are handled first.
836 if (par.isInset(i)) {
837 Inset const * ins = par.getInset(i);
838 Dimension dim = bv_->coordCache().insets().dim(ins);
839 row.add(i, ins, dim, *fi, par.lookupChange(i));
840 } else if (c == ' ' && i + 1 == body_pos) {
841 // There is a space at i, but it should not be
842 // added as a separator, because it is just
843 // before body_pos. Instead, insert some spacing to
845 FontMetrics const & fm = theFontMetrics(text_->labelFont(par));
846 // this is needed to make sure that the row width is correct
848 int const add = max(fm.width(par.layout().labelsep),
849 labelEnd(pit) - row.width());
850 row.addSpace(i, add, *fi, par.lookupChange(i));
851 } else if (c == '\t')
852 row.addSpace(i, theFontMetrics(*fi).width(from_ascii(" ")),
853 *fi, par.lookupChange(i));
855 // FIXME: please someone fix the Hebrew/Arabic parenthesis mess!
856 // see also Paragraph::getUChar.
857 if (fi->language()->lang() == "hebrew") {
863 row.add(i, c, *fi, par.lookupChange(i));
866 // add inline completion width
867 // draw logically behind the previous character
868 if (ic_pos == i + 1 && !bv_->inlineCompletion().empty()) {
869 docstring const comp = bv_->inlineCompletion();
870 size_t const uniqueTo =bv_->inlineCompletionUniqueChars();
874 f.fontInfo().setColor(Color_inlinecompletion);
875 row.addVirtual(i + 1, comp.substr(0, uniqueTo), f, Change());
877 f.fontInfo().setColor(Color_nonunique_inlinecompletion);
878 row.addVirtual(i + 1, comp.substr(uniqueTo), f, Change());
881 // Handle some situations that abruptly terminate the row
883 // - Before a display inset
884 // - After a display inset
885 Inset const * inset = 0;
886 if (par.isNewline(i) || par.isEnvSeparator(i)
887 || (i + 1 < end && (inset = par.getInset(i + 1))
889 || (!row.empty() && row.back().inset
890 && row.back().inset->display())) {
891 row.right_boundary(true);
892 need_new_row = par.isNewline(i);
899 } while (i < end && row.width() <= width);
903 // End of paragraph marker
904 if (lyxrc.paragraph_markers && !need_new_row
905 && i == end && size_type(pit + 1) < pars.size()) {
906 // add a virtual element for the end-of-paragraph
907 // marker; it is shown on screen, but does not exist
909 Font f(text_->layoutFont(pit));
910 f.fontInfo().setColor(Color_paragraphmarker);
911 BufferParams const & bparams
912 = text_->inset().buffer().params();
913 f.setLanguage(par.getParLanguage(bparams));
914 row.addVirtual(end, docstring(1, char_type(0x00B6)), f, Change());
917 // if the row is too large, try to cut at last separator. In case
918 // of success, reset indication that the row was broken abruptly.
919 if (row.shortenIfNeeded(body_pos, width))
920 row.right_boundary(!row.empty() && row.back().endpos == row.endpos());
922 // make sure that the RTL elements are in reverse ordering
923 row.reverseRTL(is_rtl);
924 //LYXERR0("breakrow: row is " << row);
928 void TextMetrics::setRowHeight(Row & row, pit_type const pit,
929 bool topBottomSpace) const
931 Paragraph const & par = text_->getPar(pit);
932 // get the maximum ascent and the maximum descent
933 double layoutasc = 0;
934 double layoutdesc = 0;
935 double const dh = defaultRowHeight();
937 // ok, let us initialize the maxasc and maxdesc value.
938 // Only the fontsize count. The other properties
939 // are taken from the layoutfont. Nicer on the screen :)
940 Layout const & layout = par.layout();
942 // as max get the first character of this row then it can
943 // increase but not decrease the height. Just some point to
944 // start with so we don't have to do the assignment below too
946 Buffer const & buffer = bv_->buffer();
947 Font font = displayFont(pit, row.pos());
948 FontSize const tmpsize = font.fontInfo().size();
949 font.fontInfo() = text_->layoutFont(pit);
950 FontSize const size = font.fontInfo().size();
951 font.fontInfo().setSize(tmpsize);
953 FontInfo labelfont = text_->labelFont(par);
955 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
956 FontMetrics const & fontmetrics = theFontMetrics(font);
958 // these are minimum values
959 double const spacing_val = layout.spacing.getValue()
960 * text_->spacing(par);
961 //lyxerr << "spacing_val = " << spacing_val << endl;
962 int maxasc = int(fontmetrics.maxAscent() * spacing_val);
963 int maxdesc = int(fontmetrics.maxDescent() * spacing_val);
965 // insets may be taller
966 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
967 Row::const_iterator cit = row.begin();
968 Row::const_iterator cend = row.end();
969 for ( ; cit != cend; ++cit) {
971 Dimension const & dim = insetCache.dim(cit->inset);
972 maxasc = max(maxasc, dim.ascent());
973 maxdesc = max(maxdesc, dim.descent());
977 // Check if any custom fonts are larger (Asger)
978 // This is not completely correct, but we can live with the small,
979 // cosmetic error for now.
983 par.highestFontInRange(row.pos(), row.endpos(), size);
984 if (maxsize > font.fontInfo().size()) {
985 // use standard paragraph font with the maximal size
986 FontInfo maxfont = font.fontInfo();
987 maxfont.setSize(maxsize);
988 FontMetrics const & maxfontmetrics = theFontMetrics(maxfont);
989 maxasc = max(maxasc, maxfontmetrics.maxAscent());
990 maxdesc = max(maxdesc, maxfontmetrics.maxDescent());
993 // This is nicer with box insets:
997 ParagraphList const & pars = text_->paragraphs();
998 Inset const & inset = text_->inset();
1000 // is it a top line?
1001 if (row.pos() == 0 && topBottomSpace) {
1002 BufferParams const & bufparams = buffer.params();
1003 // some parskips VERY EASY IMPLEMENTATION
1004 if (bufparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
1005 && !inset.getLayout().parbreakIsNewline()
1006 && !par.layout().parbreak_is_newline
1008 && ((layout.isParagraph() && par.getDepth() == 0)
1009 || (pars[pit - 1].layout().isParagraph()
1010 && pars[pit - 1].getDepth() == 0))) {
1011 maxasc += bufparams.getDefSkip().inPixels(*bv_);
1014 if (par.params().startOfAppendix())
1015 maxasc += int(3 * dh);
1017 // special code for the top label
1018 if (layout.labelIsAbove()
1019 && (!layout.isParagraphGroup() || text_->isFirstInSequence(pit))
1020 && !par.labelString().empty()) {
1022 labelfont_metrics.maxHeight()
1023 * layout.spacing.getValue()
1024 * text_->spacing(par)
1025 + (layout.topsep + layout.labelbottomsep) * dh);
1028 // Add the layout spaces, for example before and after
1029 // a section, or between the items of a itemize or enumerate
1032 pit_type prev = text_->depthHook(pit, par.getDepth());
1033 Paragraph const & prevpar = pars[prev];
1035 && prevpar.layout() == layout
1036 && prevpar.getDepth() == par.getDepth()
1037 && prevpar.getLabelWidthString()
1038 == par.getLabelWidthString()) {
1039 layoutasc = layout.itemsep * dh;
1040 } else if (pit != 0 || row.pos() != 0) {
1041 if (layout.topsep > 0)
1042 layoutasc = layout.topsep * dh;
1045 prev = text_->outerHook(pit);
1046 if (prev != pit_type(pars.size())) {
1047 maxasc += int(pars[prev].layout().parsep * dh);
1048 } else if (pit != 0) {
1049 Paragraph const & prevpar = pars[pit - 1];
1050 if (prevpar.getDepth() != 0 ||
1051 prevpar.layout() == layout) {
1052 maxasc += int(layout.parsep * dh);
1057 // is it a bottom line?
1058 if (row.endpos() >= par.size() && topBottomSpace) {
1059 // add the layout spaces, for example before and after
1060 // a section, or between the items of a itemize or enumerate
1062 pit_type nextpit = pit + 1;
1063 if (nextpit != pit_type(pars.size())) {
1064 pit_type cpit = pit;
1066 if (pars[cpit].getDepth() > pars[nextpit].getDepth()) {
1067 double usual = pars[cpit].layout().bottomsep * dh;
1069 cpit = text_->depthHook(cpit, pars[nextpit].getDepth());
1070 if (pars[cpit].layout() != pars[nextpit].layout()
1071 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1072 unusual = pars[cpit].layout().bottomsep * dh;
1073 layoutdesc = max(unusual, usual);
1074 } else if (pars[cpit].getDepth() == pars[nextpit].getDepth()) {
1075 if (pars[cpit].layout() != pars[nextpit].layout()
1076 || pars[nextpit].getLabelWidthString() != pars[cpit].getLabelWidthString())
1077 layoutdesc = int(pars[cpit].layout().bottomsep * dh);
1082 // incalculate the layout spaces
1083 maxasc += int(layoutasc * 2 / (2 + pars[pit].getDepth()));
1084 maxdesc += int(layoutdesc * 2 / (2 + pars[pit].getDepth()));
1086 // FIXME: the correct way is to do the following is to move the
1087 // following code in another method specially tailored for the
1088 // main Text. The following test is thus bogus.
1089 // Top and bottom margin of the document (only at top-level)
1090 if (main_text_ && topBottomSpace) {
1091 if (pit == 0 && row.pos() == 0)
1093 if (pit + 1 == pit_type(pars.size()) &&
1094 row.endpos() == par.size() &&
1095 !(row.endpos() > 0 && par.isNewline(row.endpos() - 1)))
1099 row.dimension().asc = maxasc + labeladdon;
1100 row.dimension().des = maxdesc;
1104 // x is an absolute screen coord
1105 // returns the column near the specified x-coordinate of the row
1106 // x is set to the real beginning of this column
1107 pos_type TextMetrics::getPosNearX(Row const & row, int & x,
1108 bool & boundary) const
1110 //LYXERR0("getPosNearX(" << x << ") row=" << row);
1111 /// For the main Text, it is possible that this pit is not
1112 /// yet in the CoordCache when moving cursor up.
1113 /// x Paragraph coordinate is always 0 for main text anyway.
1114 int const xo = origin_.x_;
1118 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1119 rowSlice.pit() = row.pit();
1120 rowSlice.pos() = row.pos();
1122 // Adapt to cursor row scroll offset if applicable.
1123 if (bv_->currentRowSlice() == rowSlice)
1124 offset = bv_->horizScrollOffset();
1127 pos_type pos = row.pos();
1130 x = row.left_margin;
1131 else if (x <= row.left_margin) {
1132 pos = row.front().left_pos();
1133 x = row.left_margin;
1134 } else if (x >= row.width()) {
1135 pos = row.back().right_pos();
1138 double w = row.left_margin;
1139 Row::const_iterator cit = row.begin();
1140 Row::const_iterator cend = row.end();
1141 for ( ; cit != cend; ++cit) {
1142 if (w <= x && w + cit->full_width() > x) {
1143 int x_offset = int(x - w);
1144 pos = cit->x2pos(x_offset);
1145 x = int(x_offset + w);
1148 w += cit->full_width();
1150 if (cit == row.end()) {
1151 pos = row.back().right_pos();
1154 /** This tests for the case where the cursor is placed
1155 * just before a font direction change. See comment on
1156 * the boundary_ member in DocIterator.h to understand
1157 * how boundary helps here.
1159 else if (pos == cit->endpos
1160 && cit + 1 != row.end()
1161 && cit->isRTL() != (cit + 1)->isRTL())
1165 /** This tests for the case where the cursor is set at the end
1166 * of a row which has been broken due something else than a
1167 * separator (a display inset or a forced breaking of the
1168 * row). We know that there is a separator when the end of the
1169 * row is larger than the end of its last element.
1171 if (!row.empty() && pos == row.back().endpos
1172 && row.back().endpos == row.endpos()) {
1173 Inset const * inset = row.back().inset;
1174 if (inset && (inset->lyxCode() == NEWLINE_CODE
1175 || inset->lyxCode() == SEPARATOR_CODE))
1176 pos = row.back().pos;
1178 boundary = row.right_boundary();
1182 //LYXERR0("getPosNearX ==> pos=" << pos << ", boundary=" << boundary);
1188 pos_type TextMetrics::x2pos(pit_type pit, int row, int x) const
1190 // We play safe and use parMetrics(pit) to make sure the
1191 // ParagraphMetrics will be redone and OK to use if needed.
1192 // Otherwise we would use an empty ParagraphMetrics in
1193 // upDownInText() while in selection mode.
1194 ParagraphMetrics const & pm = parMetrics(pit);
1196 LBUFERR(row < int(pm.rows().size()));
1198 Row const & r = pm.rows()[row];
1199 return getPosNearX(r, x, bound);
1203 void TextMetrics::newParMetricsDown()
1205 pair<pit_type, ParagraphMetrics> const & last = *par_metrics_.rbegin();
1206 pit_type const pit = last.first + 1;
1207 if (pit == int(text_->paragraphs().size()))
1210 // do it and update its position.
1212 par_metrics_[pit].setPosition(last.second.position()
1213 + last.second.descent() + par_metrics_[pit].ascent());
1217 void TextMetrics::newParMetricsUp()
1219 pair<pit_type, ParagraphMetrics> const & first = *par_metrics_.begin();
1220 if (first.first == 0)
1223 pit_type const pit = first.first - 1;
1224 // do it and update its position.
1226 par_metrics_[pit].setPosition(first.second.position()
1227 - first.second.ascent() - par_metrics_[pit].descent());
1230 // y is screen coordinate
1231 pit_type TextMetrics::getPitNearY(int y)
1233 LASSERT(!text_->paragraphs().empty(), return -1);
1234 LASSERT(!par_metrics_.empty(), return -1);
1235 LYXERR(Debug::DEBUG, "y: " << y << " cache size: " << par_metrics_.size());
1237 // look for highest numbered paragraph with y coordinate less than given y
1240 ParMetricsCache::const_iterator it = par_metrics_.begin();
1241 ParMetricsCache::const_iterator et = par_metrics_.end();
1242 ParMetricsCache::const_iterator last = et;
1245 ParagraphMetrics const & pm = it->second;
1247 if (y < it->second.position() - int(pm.ascent())) {
1248 // We are looking for a position that is before the first paragraph in
1249 // the cache (which is in priciple off-screen, that is before the
1252 // We are already at the first paragraph in the inset.
1254 // OK, this is the paragraph we are looking for.
1255 pit = it->first - 1;
1260 ParagraphMetrics const & pm_last = par_metrics_[last->first];
1262 if (y >= last->second.position() + int(pm_last.descent())) {
1263 // We are looking for a position that is after the last paragraph in
1264 // the cache (which is in priciple off-screen), that is before the
1266 pit = last->first + 1;
1267 if (pit == int(text_->paragraphs().size()))
1268 // We are already at the last paragraph in the inset.
1270 // OK, this is the paragraph we are looking for.
1271 newParMetricsDown();
1275 for (; it != et; ++it) {
1276 LYXERR(Debug::DEBUG, "examining: pit: " << it->first
1277 << " y: " << it->second.position());
1279 ParagraphMetrics const & pm = par_metrics_[it->first];
1281 if (it->first >= pit && int(it->second.position()) - int(pm.ascent()) <= y) {
1283 yy = it->second.position();
1287 LYXERR(Debug::DEBUG, "found best y: " << yy << " for pit: " << pit);
1293 Row const & TextMetrics::getPitAndRowNearY(int & y, pit_type & pit,
1294 bool assert_in_view, bool up)
1296 ParagraphMetrics const & pm = par_metrics_[pit];
1298 int yy = pm.position() - pm.ascent();
1299 LBUFERR(!pm.rows().empty());
1300 RowList::const_iterator rit = pm.rows().begin();
1301 RowList::const_iterator rlast = pm.rows().end();
1303 for (; rit != rlast; yy += rit->height(), ++rit)
1304 if (yy + rit->height() > y)
1307 if (assert_in_view) {
1308 if (!up && yy + rit->height() > y) {
1309 if (rit != pm.rows().begin()) {
1312 } else if (pit != 0) {
1315 ParagraphMetrics const & pm2 = par_metrics_[pit];
1316 rit = pm2.rows().end();
1320 } else if (up && yy != y) {
1322 y = yy + rit->height();
1324 } else if (pit < int(text_->paragraphs().size()) - 1) {
1326 newParMetricsDown();
1327 ParagraphMetrics const & pm2 = par_metrics_[pit];
1328 rit = pm2.rows().begin();
1337 // x,y are absolute screen coordinates
1338 // sets cursor recursively descending into nested editable insets
1339 Inset * TextMetrics::editXY(Cursor & cur, int x, int y,
1340 bool assert_in_view, bool up)
1342 if (lyxerr.debugging(Debug::WORKAREA)) {
1343 LYXERR0("TextMetrics::editXY(cur, " << x << ", " << y << ")");
1344 cur.bv().coordCache().dump();
1346 pit_type pit = getPitNearY(y);
1347 LASSERT(pit != -1, return 0);
1349 int yy = y; // is modified by getPitAndRowNearY
1350 Row const & row = getPitAndRowNearY(yy, pit, assert_in_view, up);
1354 // Do we cover an inset?
1355 InsetList::InsetTable * it = checkInsetHit(pit, x, yy);
1358 // No inset, set position in the text
1359 bool bound = false; // is modified by getPosNearX
1360 int xx = x; // is modified by getPosNearX
1361 cur.pos() = getPosNearX(row, xx, bound);
1362 cur.boundary(bound);
1363 cur.setCurrentFont();
1368 Inset * inset = it->inset;
1369 //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
1371 // Set position in front of inset
1372 cur.pos() = it->pos;
1373 cur.boundary(false);
1376 // Try to descend recursively inside the inset.
1377 Inset * edited = inset->editXY(cur, x, yy);
1378 if (edited == inset && cur.pos() == it->pos) {
1379 // non-editable inset, set cursor after the inset if x is
1380 // nearer to that position (bug 9628)
1381 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1382 Dimension const & dim = insetCache.dim(inset);
1383 Point p = insetCache.xy(inset);
1384 bool const is_rtl = text_->isRTL(text_->getPar(pit));
1386 // "in front of" == "right of"
1387 if (abs(p.x_ - x) < abs(p.x_ + dim.wid - x))
1390 // "in front of" == "left of"
1391 if (abs(p.x_ + dim.wid - x) < abs(p.x_ - x))
1396 if (cur.top().text() == text_)
1397 cur.setCurrentFont();
1402 void TextMetrics::setCursorFromCoordinates(Cursor & cur, int const x, int const y)
1404 LASSERT(text_ == cur.text(), return);
1405 pit_type const pit = getPitNearY(y);
1406 LASSERT(pit != -1, return);
1408 ParagraphMetrics const & pm = par_metrics_[pit];
1410 int yy = pm.position() - pm.ascent();
1411 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y <<
1412 " pit: " << pit << " yy: " << yy);
1415 LBUFERR(pm.rows().size());
1416 for (; r < int(pm.rows().size()) - 1; ++r) {
1417 Row const & row = pm.rows()[r];
1418 if (int(yy + row.height()) > y)
1423 Row const & row = pm.rows()[r];
1425 LYXERR(Debug::DEBUG, "row " << r << " from pos: " << row.pos());
1429 pos_type const pos = getPosNearX(row, xx, bound);
1431 LYXERR(Debug::DEBUG, "setting cursor pit: " << pit << " pos: " << pos);
1433 text_->setCursor(cur, pit, pos, true, bound);
1434 // remember new position.
1439 //takes screen x,y coordinates
1440 InsetList::InsetTable * TextMetrics::checkInsetHit(pit_type pit, int x, int y)
1442 Paragraph const & par = text_->paragraphs()[pit];
1443 CoordCache::Insets const & insetCache = bv_->coordCache().getInsets();
1445 LYXERR(Debug::DEBUG, "x: " << x << " y: " << y << " pit: " << pit);
1447 InsetList::const_iterator iit = par.insetList().begin();
1448 InsetList::const_iterator iend = par.insetList().end();
1449 for (; iit != iend; ++iit) {
1450 Inset * inset = iit->inset;
1452 LYXERR(Debug::DEBUG, "examining inset " << inset);
1454 if (!insetCache.has(inset)) {
1455 LYXERR(Debug::DEBUG, "inset has no cached position");
1459 Dimension const & dim = insetCache.dim(inset);
1460 Point p = insetCache.xy(inset);
1462 LYXERR(Debug::DEBUG, "xo: " << p.x_ << "..." << p.x_ + dim.wid
1463 << " yo: " << p.y_ - dim.asc << "..." << p.y_ + dim.des);
1465 if (x >= p.x_ && x <= p.x_ + dim.wid
1466 && y >= p.y_ - dim.asc && y <= p.y_ + dim.des) {
1467 LYXERR(Debug::DEBUG, "Hit inset: " << inset);
1468 return const_cast<InsetList::InsetTable *>(&(*iit));
1472 LYXERR(Debug::DEBUG, "No inset hit. ");
1477 //takes screen x,y coordinates
1478 Inset * TextMetrics::checkInsetHit(int x, int y)
1480 pit_type const pit = getPitNearY(y);
1481 LASSERT(pit != -1, return 0);
1482 InsetList::InsetTable * it = checkInsetHit(pit, x, y);
1491 Row::const_iterator const
1492 TextMetrics::findRowElement(Row const & row, pos_type const pos,
1493 bool const boundary, double & x) const
1496 * When boundary is true, position i is in the row element (pos, endpos)
1499 * whereas, when boundary is false, the test is
1501 * The correction below allows to handle both cases.
1503 int const boundary_corr = (boundary && pos) ? -1 : 0;
1505 x = row.left_margin;
1507 /** Early return in trivial cases
1508 * 1) the row is empty
1509 * 2) the position is the left-most position of the row; there
1510 * is a quirk here however: if the first element is virtual
1511 * (end-of-par marker for example), then we have to look
1515 || (pos == row.begin()->left_pos() && !boundary
1516 && !row.begin()->isVirtual()))
1519 Row::const_iterator cit = row.begin();
1520 for ( ; cit != row.end() ; ++cit) {
1521 /** Look whether the cursor is inside the element's
1522 * span. Note that it is necessary to take the
1523 * boundary into account, and to accept virtual
1524 * elements, which have pos == endpos.
1526 if (pos + boundary_corr >= cit->pos
1527 && (pos + boundary_corr < cit->endpos || cit->isVirtual())) {
1528 x += cit->pos2x(pos);
1531 x += cit->full_width();
1534 if (cit == row.end())
1541 int TextMetrics::cursorX(CursorSlice const & sl,
1542 bool boundary) const
1544 LASSERT(sl.text() == text_, return 0);
1546 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1547 if (pm.rows().empty())
1549 Row const & row = pm.getRow(sl.pos(), boundary);
1550 pos_type const pos = sl.pos();
1553 findRowElement(row, pos, boundary, x);
1559 int TextMetrics::cursorY(CursorSlice const & sl, bool boundary) const
1561 //lyxerr << "TextMetrics::cursorY: boundary: " << boundary << endl;
1562 ParagraphMetrics const & pm = par_metrics_[sl.pit()];
1563 if (pm.rows().empty())
1567 h -= par_metrics_[0].rows()[0].ascent();
1568 for (pit_type pit = 0; pit < sl.pit(); ++pit) {
1569 h += par_metrics_[pit].height();
1572 if (pos && boundary)
1574 size_t const rend = pm.pos2row(pos);
1575 for (size_t rit = 0; rit != rend; ++rit)
1576 h += pm.rows()[rit].height();
1577 h += pm.rows()[rend].ascent();
1582 // the cursor set functions have a special mechanism. When they
1583 // realize you left an empty paragraph, they will delete it.
1585 bool TextMetrics::cursorHome(Cursor & cur)
1587 LASSERT(text_ == cur.text(), return false);
1588 ParagraphMetrics const & pm = par_metrics_[cur.pit()];
1589 Row const & row = pm.getRow(cur.pos(),cur.boundary());
1590 return text_->setCursor(cur, cur.pit(), row.pos());
1594 bool TextMetrics::cursorEnd(Cursor & cur)
1596 LASSERT(text_ == cur.text(), return false);
1597 // if not on the last row of the par, put the cursor before
1598 // the final space exept if I have a spanning inset or one string
1599 // is so long that we force a break.
1600 pos_type end = cur.textRow().endpos();
1602 // empty text, end-1 is no valid position
1604 bool boundary = false;
1605 if (end != cur.lastpos()) {
1606 if (!cur.paragraph().isLineSeparator(end-1)
1607 && !cur.paragraph().isNewline(end-1)
1608 && !cur.paragraph().isEnvSeparator(end-1))
1612 } else if (cur.paragraph().isEnvSeparator(end-1))
1614 return text_->setCursor(cur, cur.pit(), end, true, boundary);
1618 void TextMetrics::deleteLineForward(Cursor & cur)
1620 LASSERT(text_ == cur.text(), return);
1621 if (cur.lastpos() == 0) {
1622 // Paragraph is empty, so we just go forward
1623 text_->cursorForward(cur);
1626 cur.setSelection(true); // to avoid deletion
1629 // What is this test for ??? (JMarc)
1630 if (!cur.selection())
1631 text_->deleteWordForward(cur);
1633 cap::cutSelection(cur, true, false);
1634 cur.checkBufferStructure();
1639 bool TextMetrics::isLastRow(pit_type pit, Row const & row) const
1641 ParagraphList const & pars = text_->paragraphs();
1642 return row.endpos() >= pars[pit].size()
1643 && pit + 1 == pit_type(pars.size());
1647 bool TextMetrics::isFirstRow(pit_type pit, Row const & row) const
1649 return row.pos() == 0 && pit == 0;
1653 int TextMetrics::leftMargin(int max_width, pit_type pit) const
1655 return leftMargin(max_width, pit, text_->paragraphs()[pit].size());
1659 int TextMetrics::leftMargin(int max_width,
1660 pit_type const pit, pos_type const pos) const
1662 ParagraphList const & pars = text_->paragraphs();
1664 LASSERT(pit >= 0, return 0);
1665 LASSERT(pit < int(pars.size()), return 0);
1666 Paragraph const & par = pars[pit];
1667 LASSERT(pos >= 0, return 0);
1668 LASSERT(pos <= par.size(), return 0);
1669 Buffer const & buffer = bv_->buffer();
1670 //lyxerr << "TextMetrics::leftMargin: pit: " << pit << " pos: " << pos << endl;
1671 DocumentClass const & tclass = buffer.params().documentClass();
1672 Layout const & layout = par.layout();
1674 docstring parindent = layout.parindent;
1678 if (text_->isMainText())
1679 l_margin += bv_->leftMargin();
1681 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1682 tclass.leftmargin());
1684 int depth = par.getDepth();
1686 // find the next level paragraph
1687 pit_type newpar = text_->outerHook(pit);
1688 if (newpar != pit_type(pars.size())) {
1689 if (pars[newpar].layout().isEnvironment()) {
1690 int nestmargin = depth * nestMargin();
1691 if (text_->isMainText())
1692 nestmargin += changebarMargin();
1693 l_margin = max(leftMargin(max_width, newpar), nestmargin);
1694 // Remove the parindent that has been added
1695 // if the paragraph was empty.
1696 if (pars[newpar].empty() &&
1697 buffer.params().paragraph_separation ==
1698 BufferParams::ParagraphIndentSeparation) {
1699 docstring pi = pars[newpar].layout().parindent;
1700 l_margin -= theFontMetrics(
1701 buffer.params().getFont()).signedWidth(pi);
1704 if (tclass.isDefaultLayout(par.layout())
1705 || tclass.isPlainLayout(par.layout())) {
1706 if (pars[newpar].params().noindent())
1709 parindent = pars[newpar].layout().parindent;
1714 // This happens after sections or environments in standard classes.
1715 // We have to check the previous layout at same depth.
1716 if (buffer.params().paragraph_separation ==
1717 BufferParams::ParagraphSkipSeparation)
1719 else if (pit > 0 && pars[pit - 1].getDepth() >= par.getDepth()) {
1720 pit_type prev = text_->depthHook(pit, par.getDepth());
1721 if (par.layout() == pars[prev].layout()) {
1723 && pars[pit - 1].layout().nextnoindent)
1725 } else if (pars[prev].layout().nextnoindent)
1729 FontInfo const labelfont = text_->labelFont(par);
1730 FontMetrics const & labelfont_metrics = theFontMetrics(labelfont);
1732 switch (layout.margintype) {
1733 case MARGIN_DYNAMIC:
1734 if (!layout.leftmargin.empty()) {
1735 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(
1738 if (!par.labelString().empty()) {
1739 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1740 l_margin += labelfont_metrics.width(par.labelString());
1741 l_margin += labelfont_metrics.width(layout.labelsep);
1745 case MARGIN_MANUAL: {
1746 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1747 // The width of an empty par, even with manual label, should be 0
1748 if (!par.empty() && pos >= par.beginOfBody()) {
1749 if (!par.getLabelWidthString().empty()) {
1750 docstring labstr = par.getLabelWidthString();
1751 l_margin += labelfont_metrics.width(labstr);
1752 l_margin += labelfont_metrics.width(layout.labelsep);
1758 case MARGIN_STATIC: {
1759 l_margin += theFontMetrics(buffer.params().getFont()).
1760 signedWidth(layout.leftmargin) * 4 / (par.getDepth() + 4);
1764 case MARGIN_FIRST_DYNAMIC:
1765 if (layout.labeltype == LABEL_MANUAL) {
1766 // if we are at position 0, we are never in the body
1767 if (pos > 0 && pos >= par.beginOfBody())
1768 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1770 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1772 // Special case to fix problems with
1774 || (layout.labeltype == LABEL_STATIC
1775 && layout.latextype == LATEX_ENVIRONMENT
1776 && !text_->isFirstInSequence(pit))) {
1777 l_margin += labelfont_metrics.signedWidth(layout.leftmargin);
1778 } else if (!layout.labelIsAbove()) {
1779 l_margin += labelfont_metrics.signedWidth(layout.labelindent);
1780 l_margin += labelfont_metrics.width(layout.labelsep);
1781 l_margin += labelfont_metrics.width(par.labelString());
1785 case MARGIN_RIGHT_ADDRESS_BOX: {
1787 // The left margin depends on the widest row in this paragraph.
1788 // This code is wrong because it depends on the rows, but at the
1789 // same time this function is used in redoParagraph to construct
1791 ParagraphMetrics const & pm = par_metrics_[pit];
1792 RowList::const_iterator rit = pm.rows().begin();
1793 RowList::const_iterator end = pm.rows().end();
1794 int minfill = max_width;
1795 for ( ; rit != end; ++rit)
1796 if (rit->fill() < minfill)
1797 minfill = rit->fill();
1798 l_margin += theFontMetrics(buffer.params().getFont()).signedWidth(layout.leftmargin);
1799 l_margin += minfill;
1801 // also wrong, but much shorter.
1802 l_margin += max_width / 2;
1807 if (!par.params().leftIndent().zero())
1808 l_margin += par.params().leftIndent().inPixels(max_width, labelfont_metrics.em());
1812 if (par.params().align() == LYX_ALIGN_LAYOUT)
1813 align = layout.align;
1815 align = par.params().align();
1817 // set the correct parindent
1819 && (layout.labeltype == LABEL_NO_LABEL
1820 || layout.labeltype == LABEL_ABOVE
1821 || layout.labeltype == LABEL_CENTERED
1822 || (layout.labeltype == LABEL_STATIC
1823 && layout.latextype == LATEX_ENVIRONMENT
1824 && !text_->isFirstInSequence(pit)))
1825 && (align == LYX_ALIGN_BLOCK || align == LYX_ALIGN_LEFT)
1826 && !par.params().noindent()
1827 // in some insets, paragraphs are never indented
1828 && !text_->inset().neverIndent()
1829 // display style insets are always centered, omit indentation
1832 && par.getInset(pos)->display())
1833 && (!(tclass.isDefaultLayout(par.layout())
1834 || tclass.isPlainLayout(par.layout()))
1835 || buffer.params().paragraph_separation
1836 == BufferParams::ParagraphIndentSeparation)) {
1837 // use the parindent of the layout when the
1838 // default indentation is used otherwise use
1839 // the indentation set in the document
1841 if (buffer.params().getIndentation().asLyXCommand() == "default")
1842 l_margin += theFontMetrics(
1843 buffer.params().getFont()).signedWidth(parindent);
1845 l_margin += buffer.params().getIndentation().inPixels(*bv_);
1852 void TextMetrics::draw(PainterInfo & pi, int x, int y) const
1854 if (par_metrics_.empty())
1860 ParMetricsCache::iterator it = par_metrics_.begin();
1861 ParMetricsCache::iterator const pm_end = par_metrics_.end();
1862 y -= it->second.ascent();
1863 for (; it != pm_end; ++it) {
1864 ParagraphMetrics const & pmi = it->second;
1866 pit_type const pit = it->first;
1867 // Save the paragraph position in the cache.
1868 it->second.setPosition(y);
1869 drawParagraph(pi, pit, x, y);
1875 void TextMetrics::drawParagraph(PainterInfo & pi, pit_type const pit, int const x, int y) const
1877 ParagraphMetrics const & pm = par_metrics_[pit];
1878 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 Cursor const & cur = bv_->cursor();
1886 DocIterator sel_beg = cur.selectionBegin();
1887 DocIterator sel_end = cur.selectionEnd();
1888 bool selection = cur.selection()
1889 // This is our text.
1890 && cur.text() == text_
1891 // if the anchor is outside, this is not our selection
1892 && cur.normalAnchor().text() == text_
1893 && pit >= sel_beg.pit() && pit <= sel_end.pit();
1895 // We store the begin and end pos of the selection relative to this par
1896 DocIterator sel_beg_par = cur.selectionBegin();
1897 DocIterator sel_end_par = cur.selectionEnd();
1899 // We care only about visible selection.
1901 if (pit != sel_beg.pit()) {
1902 sel_beg_par.pit() = pit;
1903 sel_beg_par.pos() = 0;
1905 if (pit != sel_end.pit()) {
1906 sel_end_par.pit() = pit;
1907 sel_end_par.pos() = sel_end_par.lastpos();
1911 for (size_t i = 0; i != nrows; ++i) {
1913 Row const & row = pm.rows()[i];
1918 CursorSlice rowSlice(const_cast<InsetText &>(text_->inset()));
1919 rowSlice.pit() = pit;
1920 rowSlice.pos() = row.pos();
1922 bool const inside = (y + row.descent() >= 0
1923 && y - row.ascent() < ww);
1925 // Adapt to cursor row scroll offset if applicable.
1926 if (bv_->currentRowSlice() == rowSlice)
1927 row_x -= bv_->horizScrollOffset();
1929 // It is not needed to draw on screen if we are not inside.
1930 pi.pain.setDrawingEnabled(inside && original_drawing_state);
1932 RowPainter rp(pi, *text_, pit, row, row_x, y);
1935 row.setSelectionAndMargins(sel_beg_par, sel_end_par);
1937 row.setSelection(-1, -1);
1939 // The row knows nothing about the paragraph, so we have to check
1940 // whether this row is the first or last and update the margins.
1941 if (row.selection()) {
1942 if (row.sel_beg == 0)
1943 row.begin_margin_sel = sel_beg.pit() < pit;
1944 if (row.sel_end == sel_end_par.lastpos())
1945 row.end_margin_sel = sel_end.pit() > pit;
1948 // Row signature; has row changed since last paint?
1949 if (pi.pain.isDrawingEnabled())
1950 row.setCrc(pm.computeRowSignature(row, *bv_));
1951 bool row_has_changed = row.changed()
1952 || rowSlice == bv_->lastRowSlice();
1954 // Take this opportunity to spellcheck the row contents.
1955 if (row_has_changed && pi.do_spellcheck && lyxrc.spellcheck_continuously) {
1956 text_->getPar(pit).spellCheck();
1959 // Don't paint the row if a full repaint has not been requested
1960 // and if it has not changed.
1961 if (!pi.full_repaint && !row_has_changed) {
1962 // Paint only the insets if the text itself is
1964 rp.paintOnlyInsets();
1969 // Clear background of this row if paragraph background was not
1970 // already cleared because of a full repaint.
1971 if (!pi.full_repaint && row_has_changed) {
1972 LYXERR(Debug::PAINTING, "Clear rect@("
1973 << max(row_x, 0) << ", " << y - row.ascent() << ")="
1974 << width() << " x " << row.height());
1975 pi.pain.fillRectangle(max(row_x, 0), y - row.ascent(),
1976 width(), row.height(), pi.background_color);
1979 // Instrumentation for testing row cache (see also
1981 if (lyxerr.debugging(Debug::PAINTING) && inside
1982 && (row.selection() || pi.full_repaint || row_has_changed)) {
1983 string const foreword = text_->isMainText() ?
1984 "main text redraw " : "inset text redraw: ";
1985 LYXERR(Debug::PAINTING, foreword << "pit=" << pit << " row=" << i
1986 << " row_selection=" << row.selection()
1987 << " full_repaint=" << pi.full_repaint
1988 << " row_has_changed=" << row_has_changed
1989 << " drawingEnabled=" << pi.pain.isDrawingEnabled());
1992 // Backup full_repaint status and force full repaint
1993 // for inner insets as the Row has been cleared out.
1994 bool tmp = pi.full_repaint;
1995 pi.full_repaint = true;
1997 rp.paintSelection();
2000 rp.paintChangeBar();
2001 bool const is_rtl = text_->isRTL(text_->getPar(pit));
2002 if (i == 0 && !is_rtl)
2004 if (i == nrows - 1 && is_rtl)
2007 if (i == nrows - 1 && !is_rtl)
2009 if (i == 0 && is_rtl)
2011 rp.paintTooLargeMarks(row_x + row.left_x() < 0,
2012 row_x + row.right_x() > bv_->workWidth());
2015 // Restore full_repaint status.
2016 pi.full_repaint = tmp;
2018 // Re-enable screen drawing for future use of the painter.
2019 pi.pain.setDrawingEnabled(original_drawing_state);
2021 //LYXERR(Debug::PAINTING, ".");
2025 void TextMetrics::completionPosAndDim(Cursor const & cur, int & x, int & y,
2026 Dimension & dim) const
2028 Cursor const & bvcur = cur.bv().cursor();
2030 // get word in front of cursor
2031 docstring word = text_->previousWord(bvcur.top());
2032 DocIterator wordStart = bvcur;
2033 wordStart.pos() -= word.length();
2035 // get position on screen of the word start and end
2036 //FIXME: Is it necessary to explicitly set this to false?
2037 wordStart.boundary(false);
2038 Point lxy = cur.bv().getPos(wordStart);
2039 Point rxy = cur.bv().getPos(bvcur);
2041 // calculate dimensions of the word
2043 row.pos(wordStart.pos());
2044 row.endpos(bvcur.pos());
2045 setRowHeight(row, bvcur.pit(), false);
2046 dim = row.dimension();
2047 dim.wid = abs(rxy.x_ - lxy.x_);
2049 // calculate position of word
2051 x = min(rxy.x_, lxy.x_);
2053 //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
2054 //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
2057 int defaultRowHeight()
2059 return int(theFontMetrics(sane_font).maxHeight() * 1.2);