3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "RowPainter.h"
18 #include "CoordCache.h"
20 #include "BufferParams.h"
21 #include "BufferView.h"
27 #include "MetricsInfo.h"
28 #include "Paragraph.h"
29 #include "ParagraphParameters.h"
30 #include "TextMetrics.h"
33 #include "frontends/FontMetrics.h"
34 #include "frontends/Painter.h"
36 #include "insets/InsetText.h"
38 #include "mathed/InsetMath.h"
40 #include "support/debug.h"
41 #include "support/gettext.h"
42 #include "support/textutils.h"
44 #include "support/lassert.h"
45 #include <boost/crc.hpp>
53 using frontend::Painter;
54 using frontend::FontMetrics;
57 RowPainter::RowPainter(PainterInfo & pi,
58 Text const & text, Row const & row, int x, int y)
59 : pi_(pi), text_(text),
60 tm_(pi_.base.bv->textMetrics(&text)),
61 pars_(text.paragraphs()),
62 row_(row), par_(text.paragraphs()[row.pit()]),
66 x_ = row_.left_margin + xo_;
68 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
71 LBUFERR(row.pit() >= 0);
72 LBUFERR(row.pit() < int(text.paragraphs().size()));
76 FontInfo RowPainter::labelFont() const
78 FontInfo f = text_.labelFont(par_);
80 if (row_.begin_margin_sel || pi_.selected)
81 f.setPaintColor(Color_selectiontext);
86 // If you want to debug inset metrics uncomment the following line:
87 //#define DEBUG_METRICS
88 // This draws green lines around each inset.
91 void RowPainter::paintInset(Row::Element const & e) const
94 bool const pi_selected = pi_.selected;
95 Cursor const & cur = pi_.base.bv->cursor();
96 if (cur.selection() && cur.text() == &text_
97 && cur.normalAnchor().text() == &text_)
98 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
100 LASSERT(e.inset, return);
101 // Backup full_repaint status because some insets (InsetTabular)
102 // requires a full repaint
103 bool const pi_full_repaint = pi_.full_repaint;
104 bool const pi_do_spellcheck = pi_.do_spellcheck;
105 Change const pi_change = pi_.change_;
107 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
108 pi_.base.bv->buffer().params().getFont().fontInfo();
109 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
110 pi_.change_ = change_.changed() ? change_ : e.change;
111 pi_.do_spellcheck &= e.inset->allowSpellCheck();
113 int const x1 = int(x_);
114 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
115 // insets are painted completely. Recursive
116 // FIXME: it is wrong to completely paint the background
117 // if we want to do single row painting.
118 e.inset->drawBackground(pi_, x1, yo_);
119 e.inset->drawSelection(pi_, x1, yo_);
120 e.inset->draw(pi_, x1, yo_);
122 // Restore full_repaint status.
123 pi_.full_repaint = pi_full_repaint;
124 pi_.change_ = pi_change;
125 pi_.do_spellcheck = pi_do_spellcheck;
126 pi_.selected = pi_selected;
129 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
130 int const x2 = x1 + dim.wid;
131 int const y1 = yo_ + dim.des;
132 int const y2 = yo_ - dim.asc;
133 pi_.pain.line(x1, y1, x1, y2, Color_green);
134 pi_.pain.line(x1, y1, x2, y1, Color_green);
135 pi_.pain.line(x2, y1, x2, y2, Color_green);
136 pi_.pain.line(x1, y2, x2, y2, Color_green);
141 void RowPainter::paintForeignMark(Row::Element const & e) const
143 Language const * lang = e.font.language();
144 if (!lyxrc.mark_foreign_language)
146 if (lang == latex_language)
148 if (lang == pi_.base.bv->buffer().params().language)
151 int const desc = e.inset ? e.dim.descent() : 0;
152 int const y = yo_ + pi_.base.solidLineOffset()
153 + desc + pi_.base.solidLineThickness() / 2;
154 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
155 Painter::line_solid, pi_.base.solidLineThickness());
159 void RowPainter::paintMisspelledMark(Row::Element const & e) const
161 // if changed the misspelled marker gets placed slightly lower than normal
162 // to avoid drawing at the same vertical offset
163 FontMetrics const & fm = theFontMetrics(e.font);
164 int const thickness = max(fm.lineWidth(), 2);
165 int const y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
166 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
169 //FIXME: this could be computed only once, it is probably not costly.
170 // check for cursor position
171 // don't draw misspelled marker for words at cursor position
172 // we don't want to disturb the process of text editing
173 DocIterator const nw = pi_.base.bv->cursor().newWord();
175 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
177 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
179 else if (cpos > 0 && par_.isWordSeparator(cpos))
183 pos_type pos = e.pos;
184 while (pos < e.pos + pos_type(e.str.length())) {
185 if (!par_.isMisspelled(pos)) {
190 FontSpan const & range = par_.getSpellRange(pos);
192 // Skip element which are being edited
193 if (range.contains(cpos)) {
194 // the range includes the last element
195 pos = range.last + 1;
199 int x1 = fm.pos2x(e.str, range.first - e.pos,
201 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
202 pos_type(e.str.length())),
207 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
209 Painter::line_onoffdash, thickness);
210 pos = range.last + 1;
215 void RowPainter::paintStringAndSel(Row::Element const & e) const
217 // at least part of text selected?
218 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
220 // all the text selected?
221 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
224 if (all_sel || e.change.changed()) {
226 Color const col = e.change.changed() ? e.change.color()
227 : Color_selectiontext;
228 copy.fontInfo().setPaintColor(col);
229 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
230 } else if (!some_sel) {
231 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
233 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
234 max(row_.sel_beg, e.pos) - e.pos,
235 min(row_.sel_end, e.endpos) - e.pos,
236 e.extra, e.full_width());
241 void RowPainter::paintChange(Row::Element const & e) const
243 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
247 void RowPainter::paintChangeBar() const
249 int const height = tm_.isLastRow(row_)
253 pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, height, Color_changebar);
257 void RowPainter::paintAppendix() const
259 // only draw the appendix frame once (for the main text)
260 if (!par_.params().appendix() || !text_.isMainText())
263 int y = yo_ - row_.ascent();
265 if (par_.params().startOfAppendix())
266 y += 2 * defaultRowHeight();
268 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
269 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
273 void RowPainter::paintDepthBar() const
275 depth_type depth = par_.getDepth();
277 // We also mark follow-up paragraphs in a paragraph group
278 if (par_.layout().isParagraphGroup()
279 && par_.layout().labeltype != LABEL_NO_LABEL
280 && !text_.isFirstInSequence(row_.pit()))
286 depth_type prev_depth = 0;
287 if (!tm_.isFirstRow(row_)) {
288 pit_type pit2 = row_.pit();
291 prev_depth = pars_[pit2].getDepth();
292 // We also mark follow-up paragraphs in a paragraph group
293 if (pars_[pit2].layout().isParagraphGroup()
294 && pars_[pit2].layout().labeltype != LABEL_NO_LABEL
295 && !text_.isFirstInSequence(pit2))
299 depth_type next_depth = 0;
300 if (!tm_.isLastRow(row_)) {
301 pit_type pit2 = row_.pit();
302 if (row_.endpos() >= pars_[pit2].size())
304 next_depth = pars_[pit2].getDepth();
305 // We also mark follow-up paragraphs in a paragraph group
306 if (pars_[pit2].layout().isParagraphGroup()
307 && pars_[pit2].layout().labeltype != LABEL_NO_LABEL
308 && !text_.isFirstInSequence(pit2))
312 for (depth_type i = 1; i <= depth; ++i) {
313 int const w = nestMargin() / 5;
314 int x = int(xo_) + w * i;
315 // only consider the changebar space if we're drawing outermost text
316 if (text_.isMainText())
317 x += changebarMargin();
319 int const starty = yo_ - row_.ascent();
320 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
322 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
325 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
327 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
332 void RowPainter::paintAppendixStart(int y) const
334 FontInfo pb_font = sane_font;
335 pb_font.setColor(Color_appendix);
342 docstring const label = _("Appendix");
343 theFontMetrics(pb_font).rectText(label, w, a, d);
345 int const text_start = int(xo_ + (tm_.width() - w) / 2);
346 int const text_end = text_start + w;
348 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
350 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
351 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
355 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
358 pi_.pain.line(pi_.base.dottedLineThickness(), yo_ - row_.ascent(),
359 pi_.base.dottedLineThickness(), yo_ + row_.descent(),
360 Color_scroll, Painter::line_onoffdash,
361 pi_.base.dottedLineThickness());
364 pi_.base.bv->workWidth() - pi_.base.dottedLineThickness();
365 pi_.pain.line(wwidth, yo_ - row_.ascent(),
366 wwidth, yo_ + row_.descent(),
367 Color_scroll, Painter::line_onoffdash,
368 pi_.base.dottedLineThickness());
373 void RowPainter::paintFirst() const
375 Layout const & layout = par_.layout();
377 // start of appendix?
378 if (par_.params().startOfAppendix())
379 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
381 bool const is_first =
382 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
383 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
385 if (layout.labelIsInline()
386 && (layout.labeltype != LABEL_STATIC || is_first))
388 else if (is_first && layout.labelIsAbove())
389 paintTopLevelLabel();
393 void RowPainter::paintLabel() const
395 docstring const & str = par_.labelString();
399 Layout const & layout = par_.layout();
400 FontInfo const font = labelFont();
401 FontMetrics const & fm = theFontMetrics(font);
405 x = tm_.width() - row_.right_margin + fm.width(layout.labelsep);
407 x = x_ - fm.width(layout.labelsep) - fm.width(str);
409 pi_.pain.text(int(x), yo_, str, font);
413 void RowPainter::paintTopLevelLabel() const
415 BufferParams const & bparams = pi_.base.bv->buffer().params();
416 ParagraphParameters const & pparams = par_.params();
417 Layout const & layout = par_.layout();
418 FontInfo const font = labelFont();
419 docstring const str = par_.labelString();
423 double spacing_val = 1.0;
424 if (!pparams.spacing().isDefault())
425 spacing_val = pparams.spacing().getValue();
427 spacing_val = bparams.spacing().getValue();
429 FontMetrics const & fm = theFontMetrics(font);
431 int const labeladdon = int(fm.maxHeight()
432 * layout.spacing.getValue() * spacing_val);
435 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
436 + (layout.labelbottomsep * defaultRowHeight()));
439 if (layout.labeltype == LABEL_CENTERED) {
440 x = row_.left_margin + (tm_.width() - row_.left_margin - row_.right_margin) / 2;
441 x -= fm.width(str) / 2;
442 } else if (row_.isRTL()) {
443 x = tm_.width() - row_.right_margin - fm.width(str);
445 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
449 /** Check if the current paragraph is the last paragraph in a
451 static int getEndLabel(pit_type p, Text const & text)
453 ParagraphList const & pars = text.paragraphs();
455 depth_type par_depth = pars[p].getDepth();
456 while (pit != pit_type(pars.size())) {
457 Layout const & layout = pars[pit].layout();
458 int const endlabeltype = layout.endlabeltype;
460 if (endlabeltype != END_LABEL_NO_LABEL) {
461 if (p + 1 == pit_type(pars.size()))
464 depth_type const next_depth =
465 pars[p + 1].getDepth();
466 if (par_depth > next_depth ||
467 (par_depth == next_depth && layout != pars[p + 1].layout()))
473 pit = text.outerHook(pit);
474 if (pit != pit_type(pars.size()))
475 par_depth = pars[pit].getDepth();
477 return END_LABEL_NO_LABEL;
481 void RowPainter::paintLast() const
483 int const endlabel = getEndLabel(row_.pit(), text_);
485 // paint imaginary end-of-paragraph character
487 Change const & change = par_.lookupChange(par_.size());
488 if (change.changed()) {
489 FontMetrics const & fm =
490 theFontMetrics(pi_.base.bv->buffer().params().getFont());
491 int const length = fm.maxAscent() / 2;
492 Color col = change.color();
494 pi_.pain.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
495 Painter::line_solid, 3);
497 if (change.deleted()) {
498 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1 + length,
499 yo_ + 2, col, Painter::line_solid, 3);
501 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1,
502 yo_ + 2, col, Painter::line_solid, 3);
510 case END_LABEL_FILLED_BOX: {
511 FontInfo const font = labelFont();
512 FontMetrics const & fm = theFontMetrics(font);
513 int const size = int(0.75 * fm.maxAscent());
514 int const y = yo_ - size;
516 // If needed, move the box a bit to avoid overlapping with text.
519 int const normal_x = nestMargin() + changebarMargin();
520 x = min(normal_x, row_.left_margin - size - Inset::TEXT_TO_INSET_OFFSET);
522 int const normal_x = tm_.width() - row_.right_margin
523 - size - Inset::TEXT_TO_INSET_OFFSET;
524 x = max(normal_x, row_.width());
527 if (endlabel == END_LABEL_BOX)
528 pi_.pain.rectangle(x, y, size, size, Color_eolmarker);
530 pi_.pain.fillRectangle(x, y, size, size, Color_eolmarker);
534 case END_LABEL_STATIC: {
535 FontInfo const font = labelFont();
536 FontMetrics const & fm = theFontMetrics(font);
537 docstring const & str = par_.layout().endlabelstring();
538 double const x = row_.isRTL() ? x_ - fm.width(str) : x_;
539 pi_.pain.text(int(x), yo_, str, font);
543 case END_LABEL_NO_LABEL:
549 void RowPainter::paintOnlyInsets()
551 Row::const_iterator cit = row_.begin();
552 Row::const_iterator const & end = row_.end();
553 for ( ; cit != end ; ++cit) {
554 Row::Element const & e = *cit;
555 if (e.type == Row::INSET) {
557 // The line that indicates word in a different language
559 // change tracking (not for insets that handle it themselves)
560 if (!e.inset->canPaintChange(*pi_.base.bv))
564 x_ += e.full_width();
569 void RowPainter::paintText()
571 Row::const_iterator cit = row_.begin();
572 Row::const_iterator const & end = row_.end();
573 for ( ; cit != end ; ++cit) {
574 Row::Element const & e = *cit;
579 paintStringAndSel(e);
581 // Paint the spelling marks if enabled.
582 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
583 paintMisspelledMark(e);
591 pi_.pain.textDecoration(e.font.fontInfo(), int(x_), yo_, int(e.full_width()));
594 // The line that indicates word in a different language
597 // change tracking (not for insets that handle it themselves)
598 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
601 x_ += e.full_width();
606 void RowPainter::paintSelection() const
608 if (!row_.selection())
611 int const y1 = yo_ - row_.ascent();
612 int const y2 = y1 + row_.height();
615 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
616 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
619 // go through row and draw from RTL boundary to RTL boundary
620 double x = xo_ + row_.left_margin;
621 for (auto const & e : row_) {
622 // These are the same tests as in paintStringAndSel, except
623 // that all_sel has an additional clause that triggers for end
624 // of paragraph markers. The clause was not used in
625 // paintStringAndSel to avoid changing the drawing color.
626 // at least part of text selected?
627 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
629 // all the text selected?
630 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
631 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
635 // the 3rd argument is written like that to avoid rounding issues
636 pi_.pain.fillRectangle(int(x), y1,
637 int(x + e.full_width()) - int(x), y2 - y1,
639 } else if (some_sel) {
640 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
641 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
642 double x1 = e.pos2x(from);
643 double x2 = e.pos2x(to);
646 // the 3rd argument is written like that to avoid rounding issues
647 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
648 y2 - y1, Color_selection);
653 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
654 pi_.pain.fillRectangle(int(x), y1,
655 int(xo_ + tm_.width()) - int(x), y2 - y1,