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.
14 #include "RowPainter.h"
17 #include "CoordCache.h"
19 #include "BufferParams.h"
20 #include "BufferView.h"
26 #include "MetricsInfo.h"
27 #include "Paragraph.h"
28 #include "ParagraphList.h"
29 #include "ParagraphParameters.h"
31 #include "TextMetrics.h"
33 #include "frontends/FontMetrics.h"
34 #include "frontends/Painter.h"
36 #include "support/debug.h"
37 #include "support/gettext.h"
38 #include "support/lassert.h"
46 using frontend::Painter;
47 using frontend::FontMetrics;
50 RowPainter::RowPainter(PainterInfo & pi,
51 Text const & text, Row const & row, int x, int y)
52 : pi_(pi), text_(text),
53 tm_(pi_.base.bv->textMetrics(&text)),
54 row_(row), par_(text.paragraphs()[row.pit()]),
57 x_ = row_.left_margin + xo_;
59 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
62 LBUFERR(row.pit() >= 0);
63 LBUFERR(row.pit() < int(text.paragraphs().size()));
67 FontInfo RowPainter::labelFont(bool end) const
69 FontInfo f = text_.labelFont(par_);
71 if ((end ? row_.end_margin_sel : row_.begin_margin_sel)
73 f.setPaintColor(Color_selectiontext);
78 // If you want to debug inset metrics uncomment the following line:
79 //#define DEBUG_METRICS
80 // This draws green lines around each inset.
83 void RowPainter::paintInset(Row::Element const & e) const
85 // Handle selection (first left/right, then middle).
86 pi_.selected_left = pi_.selected
87 || (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel);
88 pi_.selected_right = pi_.selected
89 || (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel);
90 bool const pi_selected = pi_.selected;
91 Cursor const & cur = pi_.base.bv->cursor();
92 if (cur.selection() && cur.text() == &text_
93 && cur.normalAnchor().text() == &text_)
94 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
96 LASSERT(e.inset, return);
97 // Backup full_repaint status because some insets (InsetTabular)
98 // requires a full repaint
99 bool const pi_full_repaint = pi_.full_repaint;
100 bool const pi_do_spellcheck = pi_.do_spellcheck;
101 Change const pi_change = pi_.change;
103 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
104 pi_.base.bv->buffer().params().getFont().fontInfo();
105 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
106 pi_.change = pi_.change.changed() ? pi_.change : e.change;
107 pi_.do_spellcheck &= e.inset->allowSpellCheck();
109 int const x1 = int(x_);
110 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
111 // insets are painted completely. Recursive
112 // FIXME: it is wrong to completely paint the background
113 // if we want to do single row painting.
114 e.inset->drawBackground(pi_, x1, yo_);
115 e.inset->drawSelection(pi_, x1, yo_);
116 e.inset->draw(pi_, x1, yo_);
117 paintTextDecoration(e);
119 // Restore full_repaint status.
120 pi_.full_repaint = pi_full_repaint;
121 pi_.change = pi_change;
122 pi_.do_spellcheck = pi_do_spellcheck;
123 pi_.selected = pi_selected;
126 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
127 int const x2 = x1 + dim.wid;
128 int const y1 = yo_ + dim.des;
129 int const y2 = yo_ - dim.asc;
130 pi_.pain.line(x1, y1, x1, y2, Color_green);
131 pi_.pain.line(x1, y1, x2, y1, Color_green);
132 pi_.pain.line(x2, y1, x2, y2, Color_green);
133 pi_.pain.line(x1, y2, x2, y2, Color_green);
138 void RowPainter::paintLanguageMarkings(Row::Element const & e) const
141 paintNoSpellingMark(e);
145 void RowPainter::paintForeignMark(Row::Element const & e) const
147 Language const * lang = e.font.language();
148 if (!lyxrc.mark_foreign_language)
150 if (lang == latex_language)
152 if (lang == pi_.base.bv->buffer().params().language)
155 int const desc = e.inset ? e.dim.descent() : 0;
156 int const y = yo_ + min(3 * pi_.base.solidLineOffset() / 2 + desc,
158 pi_.pain.line(int(x_), y, int(x_ + e.full_width() - 1), y, Color_language,
159 Painter::line_solid, pi_.base.solidLineThickness());
163 void RowPainter::paintNoSpellingMark(Row::Element const & e) const
165 //if (!lyxrc.mark_no_spelling)
167 if (e.font.language() == latex_language)
169 if (e.font.fontInfo().nospellcheck() != FONT_ON)
172 // We at the same voffset than the misspelled mark, since
173 // these two are mutually exclusive
174 int const desc = e.inset ? e.dim.descent() : 0;
175 int y = yo_ + pi_.base.solidLineOffset() + desc
176 + pi_.base.solidLineThickness()
177 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
179 // Make sure that the mark does not go below the row rectangle
180 y = min(y, yo_ + row_.descent() - 1);
182 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
183 Painter::line_onoffdash, pi_.base.solidLineThickness());
187 void RowPainter::paintMisspelledMark(Row::Element const & e) const
189 if (e.font.fontInfo().nospellcheck() == FONT_ON)
191 // if changed the misspelled marker gets placed slightly lower than normal
192 // to avoid drawing at the same vertical offset
193 FontMetrics const & fm = theFontMetrics(e.font);
194 int const thickness = max(fm.lineWidth(), 2);
195 int y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
196 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
198 // Make sure that the mark does not go below the row rectangle
199 y = min(y, yo_ + row_.descent() - 1);
201 //FIXME: this could be computed only once, it is probably not costly.
202 // check for cursor position
203 // don't draw misspelled marker for words at cursor position
204 // we don't want to disturb the process of text editing
205 DocIterator const nw = pi_.base.bv->cursor().newWord();
207 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
209 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
211 else if (cpos > 0 && par_.isWordSeparator(cpos))
215 pos_type pos = e.pos;
216 while (pos < e.pos + pos_type(e.str.length())) {
217 if (!par_.isMisspelled(pos)) {
222 FontSpan const & range = par_.getSpellRange(pos);
224 // Skip element which are being edited
225 if (range.contains(cpos)) {
226 // the range includes the last element
227 pos = range.last + 1;
231 int x1 = fm.pos2x(e.str, range.first - e.pos,
233 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
234 pos_type(e.str.length())),
239 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
241 Painter::line_onoffdash, thickness);
242 pos = range.last + 1;
247 void RowPainter::paintStringAndSel(Row::Element const & e) const
249 // at least part of text selected?
250 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
252 // all the text selected?
253 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
256 if (all_sel || e.change.changed()) {
258 Color const col = e.change.changed() ? e.change.color()
259 : Color_selectiontext;
260 copy.fontInfo().setPaintColor(col);
261 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
262 } else if (!some_sel) {
263 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
265 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
266 max(row_.sel_beg, e.pos) - e.pos,
267 min(row_.sel_end, e.endpos) - e.pos,
268 e.extra, e.full_width());
273 void RowPainter::paintTextDecoration(Row::Element const & e) const
276 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
278 FontInfo copy = e.font.fontInfo();
279 if (sel || e.change.changed()) {
280 Color const col = e.change.changed() ? e.change.color()
281 : Color_selectiontext;
282 copy.setPaintColor(col);
284 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
288 void RowPainter::paintChange(Row::Element const & e) const
290 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
294 void RowPainter::paintChangeBar() const
296 int const x = pi_.base.bv->leftMargin() - pi_.base.bv->zoomedPixels(7);
297 Dimension const & cdim = row_.contents_dim();
298 pi_.pain.fillRectangle(x, yo_ - cdim.ascent(),
299 3, cdim.height(), Color_changebar);
303 void RowPainter::paintAppendix() const
305 // only draw the appendix frame once (for the main text)
306 if (!par_.params().appendix() || !text_.isMainText())
309 int y = yo_ - row_.ascent();
311 if (par_.params().startOfAppendix())
312 y += 2 * defaultRowHeight();
314 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
315 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
319 void RowPainter::paintDepthBar() const
321 depth_type const depth = par_.getDepth();
322 ParagraphList const & pars = text_.paragraphs();
327 depth_type prev_depth = 0;
328 if (!tm_.isFirstRow(row_)) {
329 pit_type pit2 = row_.pit();
332 prev_depth = pars[pit2].getDepth();
335 depth_type next_depth = 0;
336 if (!tm_.isLastRow(row_)) {
337 pit_type pit2 = row_.pit();
338 if (row_.endpos() >= pars[pit2].size())
340 next_depth = pars[pit2].getDepth();
343 for (depth_type i = 1; i <= depth; ++i) {
344 int const w = nestMargin() / 5;
345 int x = int(xo_) + w * i;
346 // consider the bufferview left margin if we're drawing outermost text
347 if (text_.isMainText())
348 x += pi_.base.bv->leftMargin();
350 int const starty = yo_ - row_.ascent();
351 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
353 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
356 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
358 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
363 void RowPainter::paintAppendixStart(int y) const
365 FontInfo pb_font = sane_font;
366 pb_font.setColor(Color_appendix);
373 docstring const label = _("Appendix");
374 theFontMetrics(pb_font).rectText(label, w, a, d);
376 int const text_start = int(xo_ + (tm_.width() - w) / 2);
377 int const text_end = text_start + w;
379 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
381 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
382 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
386 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
388 int const lwid = pi_.base.dottedLineThickness();
389 Dimension const & cdim = row_.contents_dim();
391 int const x = pi_.base.bv->leftMargin() - lwid;
392 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
393 Color_scroll, Painter::line_onoffdash, lwid);
396 int const x = pi_.base.bv->workWidth() - pi_.base.bv->rightMargin();
397 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
398 Color_scroll, Painter::line_onoffdash, lwid);
403 void RowPainter::paintFirst() const
405 Layout const & layout = par_.layout();
407 // start of appendix?
408 if (par_.params().startOfAppendix())
409 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
411 bool const is_first =
412 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
413 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
415 if (layout.labelIsInline()
416 && (layout.labeltype != LABEL_STATIC || is_first))
418 else if (is_first && layout.labelIsAbove())
419 paintTopLevelLabel();
423 void RowPainter::paintLabel() const
425 docstring const & str = par_.labelString();
429 Layout const & layout = par_.layout();
430 FontInfo const font = labelFont(false);
431 FontMetrics const & fm = theFontMetrics(font);
432 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
433 : row_.left_margin - fm.width(layout.labelsep) - fm.width(str);
435 pi_.pain.text(int(xo_) + x, yo_, str, font);
439 void RowPainter::paintTopLevelLabel() const
441 BufferParams const & bparams = pi_.base.bv->buffer().params();
442 ParagraphParameters const & pparams = par_.params();
443 Layout const & layout = par_.layout();
444 FontInfo const font = labelFont(false);
445 docstring const str = par_.labelString();
449 double spacing_val = 1.0;
450 if (!pparams.spacing().isDefault())
451 spacing_val = pparams.spacing().getValue();
453 spacing_val = bparams.spacing().getValue();
455 FontMetrics const & fm = theFontMetrics(font);
457 int const labeladdon = int(fm.maxHeight()
458 * layout.spacing.getValue() * spacing_val);
461 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
462 + (layout.labelbottomsep * defaultRowHeight()));
465 if (layout.labeltype == LABEL_CENTERED) {
466 // The 'size + 1' is weird, but it makes sure that we get the
467 // left margin of non-first row.
468 int leftm = tm_.leftMargin(row_.pit(), par_.size() + 1);
469 int rightm = tm_.rightMargin(row_.pit());
472 /* Currently, x points at row_.left_margin (which contains the
473 * indent). First remove that, and then center the title with
474 * respect to the left and right margins.
476 x += leftm - row_.left_margin + (tm_.width() - leftm -rightm) / 2
478 } else if (row_.isRTL()) {
479 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
481 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
485 void RowPainter::paintLast() const
487 int const endlabel = text_.getEndLabel(row_.pit());
490 case END_LABEL_FILLED_BOX: {
491 FontInfo font = labelFont(true);
492 if (font.realColor() != Color_selectiontext)
493 font.setPaintColor(Color_eolmarker);
494 FontMetrics const & fm = theFontMetrics(font);
495 int const size = int(0.75 * fm.maxAscent());
496 int const y = yo_ - size;
498 // If needed, move the box a bit to avoid overlapping with text.
501 int const normal_x = nestMargin() + changebarMargin();
502 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
504 int const normal_x = tm_.width() - row_.right_margin
505 - size - Inset::textOffset(pi_.base.bv);
506 x = max(normal_x, row_.width());
509 if (endlabel == END_LABEL_BOX)
510 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
512 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
516 case END_LABEL_STATIC: {
517 FontInfo const font = labelFont(true);
518 FontMetrics const & fm = theFontMetrics(font);
519 docstring const & str = par_.layout().endlabelstring();
520 double const x = row_.isRTL() ? row_.left_margin - fm.width(str) : row_.width();
521 pi_.pain.text(xo_ + x, yo_, str, font);
525 case END_LABEL_NO_LABEL:
531 void RowPainter::paintOnlyInsets()
533 for (Row::Element const & e : row_) {
534 if (e.type == Row::INSET) {
536 // The markings of foreign languages
537 // and of text ignored for spellchecking
538 paintLanguageMarkings(e);
539 // change tracking (not for insets that handle it themselves)
540 if (!e.inset->canPaintChange(*pi_.base.bv))
544 x_ += e.full_width();
549 void RowPainter::paintText()
551 for (Row::Element const & e : row_) {
555 paintStringAndSel(e);
557 // Paint the spelling marks if enabled.
558 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
559 paintMisspelledMark(e);
567 paintTextDecoration(e);
570 // The markings of foreign languages
571 // and of text ignored for spellchecking
572 paintLanguageMarkings(e);
574 // change tracking (not for insets that handle it themselves)
575 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
578 x_ += e.full_width();
583 void RowPainter::paintSelection() const
585 if (!row_.selection())
588 int const y1 = yo_ - row_.contents_dim().asc;
589 int const y2 = yo_ + row_.contents_dim().des;
592 if (row_.begin_margin_sel)
593 pi_.pain.fillRectangle(int(xo_), yo_ - row_.ascent(),
594 tm_.width(), row_.ascent() - row_.contents_dim().asc,
597 // The left margin selection
598 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
599 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
602 // go through row and draw from RTL boundary to RTL boundary
603 double x = xo_ + row_.left_margin;
604 for (auto const & e : row_) {
605 // These are the same tests as in paintStringAndSel, except
606 // that all_sel has an additional clause that triggers for end
607 // of paragraph markers. The clause was not used in
608 // paintStringAndSel to avoid changing the drawing color.
609 // at least part of text selected?
610 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
612 // all the text selected?
613 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
614 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
618 // the 3rd argument is written like that to avoid rounding issues
619 pi_.pain.fillRectangle(int(x), y1,
620 int(x + e.full_width()) - int(x), y2 - y1,
622 } else if (some_sel) {
623 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
624 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
625 double x1 = e.pos2x(from);
626 double x2 = e.pos2x(to);
629 // the 3rd argument is written like that to avoid rounding issues
630 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
631 y2 - y1, Color_selection);
636 // the right margin selection
637 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
638 pi_.pain.fillRectangle(int(x), y1,
639 int(xo_ + tm_.width()) - int(x), y2 - y1,
641 // The bottom selection
642 if (row_.end_margin_sel)
643 pi_.pain.fillRectangle(int(xo_), yo_ + row_.contents_dim().des,
644 tm_.width(), row_.descent() - row_.contents_dim().des,
649 void RowPainter::paintBookmark(int num) const
651 BufferView const * bv = pi_.base.bv;
652 FontInfo fi = bv->buffer().params().getFont().fontInfo();
653 FontMetrics const & fm = theFontMetrics(fi);
654 fi.setColor(Color_bookmark);
655 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
656 char_type const ch = 0x2775 + num;
657 int const x = row_.isRTL()
658 ? bv->workWidth() - bv->rightMargin() + (bv->defaultMargin() - fm.width(ch)) / 2
659 : bv->leftMargin() - (bv->defaultMargin() + fm.width(ch)) / 2;
660 pi_.pain.text(x, yo_, ch, fi);