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"
27 #include "MetricsInfo.h"
28 #include "Paragraph.h"
29 #include "ParagraphList.h"
30 #include "ParagraphParameters.h"
32 #include "TextMetrics.h"
34 #include "frontends/FontMetrics.h"
35 #include "frontends/Painter.h"
37 #include "support/debug.h"
38 #include "support/gettext.h"
39 #include "support/lassert.h"
47 using frontend::Painter;
48 using frontend::FontMetrics;
51 RowPainter::RowPainter(PainterInfo & pi,
52 Text const & text, Row const & row, int x, int y)
53 : pi_(pi), text_(text),
54 tm_(pi_.base.bv->textMetrics(&text)),
55 row_(row), par_(text.paragraphs()[row.pit()]),
58 x_ = row_.left_margin + xo_;
60 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
63 LBUFERR(row.pit() >= 0);
64 LBUFERR(row.pit() < int(text.paragraphs().size()));
68 FontInfo RowPainter::labelFont(bool end) const
70 FontInfo f = tm_.labelDisplayFont(row_.pit()).fontInfo();
72 if ((end ? row_.end_margin_sel : row_.begin_margin_sel)
74 f.setPaintColor(Color_selectiontext);
79 // If you want to debug inset metrics uncomment the following line:
80 //#define DEBUG_METRICS
81 // This draws green lines around each inset.
84 void RowPainter::paintInset(Row::Element const & e) const
86 // Handle selection (first left/right, then middle).
87 pi_.selected_left = pi_.selected
88 || (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel);
89 pi_.selected_right = pi_.selected
90 || (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel);
91 bool const pi_selected = pi_.selected;
92 Cursor const & cur = pi_.base.bv->cursor();
93 if (cur.selection() && cur.text() == &text_
94 && cur.normalAnchor().text() == &text_)
95 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
97 LASSERT(e.inset, return);
98 // Backup full_repaint status because some insets (InsetTabular)
99 // requires a full repaint
100 bool const pi_full_repaint = pi_.full_repaint;
101 bool const pi_do_spellcheck = pi_.do_spellcheck;
102 Change const pi_change = pi_.change;
103 int const pi_textwidth = pi_.base.textwidth;
105 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
106 pi_.base.bv->buffer().params().getFont().fontInfo();
107 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
108 pi_.change = pi_.change.changed() ? pi_.change : e.change;
109 pi_.do_spellcheck &= e.inset->allowSpellCheck();
110 pi_.base.textwidth += e.extra;
112 int const x1 = int(x_);
113 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
114 // insets are painted completely. Recursive
115 // FIXME: it is wrong to completely paint the background
116 // if we want to do single row painting.
117 e.inset->drawBackground(pi_, x1, yo_);
118 e.inset->drawSelection(pi_, x1, yo_);
119 e.inset->draw(pi_, x1, yo_);
120 paintTextDecoration(e);
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;
127 pi_.base.textwidth = pi_textwidth;
130 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
131 int const x2 = x1 + dim.wid;
132 int const y1 = yo_ + dim.des;
133 int const y2 = yo_ - dim.asc;
134 pi_.pain.line(x1, y1, x1, y2, Color_green);
135 pi_.pain.line(x1, y1, x2, y1, Color_green);
136 pi_.pain.line(x2, y1, x2, y2, Color_green);
137 pi_.pain.line(x1, y2, x2, y2, Color_green);
142 void RowPainter::paintLanguageMarkings(Row::Element const & e) const
145 paintNoSpellingMark(e);
149 void RowPainter::paintForeignMark(Row::Element const & e) const
151 Language const * lang = e.font.language();
152 if (!lyxrc.mark_foreign_language)
154 if (lang == latex_language)
156 if (lang == pi_.base.bv->buffer().params().language)
159 int const desc = e.inset ? e.dim.descent() : 0;
160 int const y = yo_ + min(3 * pi_.base.solidLineOffset() / 2 + desc,
162 pi_.pain.line(int(x_), y, int(x_ + e.full_width() - 1), y, Color_language,
163 Painter::line_solid, pi_.base.solidLineThickness());
167 void RowPainter::paintNoSpellingMark(Row::Element const & e) const
169 //if (!lyxrc.mark_no_spelling)
171 if (e.font.language() == latex_language)
173 if (e.font.fontInfo().nospellcheck() != FONT_ON)
176 // We at the same voffset than the misspelled mark, since
177 // these two are mutually exclusive
178 int const desc = e.inset ? e.dim.descent() : 0;
179 int y = yo_ + pi_.base.solidLineOffset() + desc
180 + pi_.base.solidLineThickness()
181 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
183 // Make sure that the mark does not go below the row rectangle
184 y = min(y, yo_ + row_.descent() - 1);
186 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
187 Painter::line_onoffdash, pi_.base.solidLineThickness());
191 void RowPainter::paintMisspelledMark(Row::Element const & e) const
193 if (e.font.fontInfo().nospellcheck() == FONT_ON)
195 // if changed the misspelled marker gets placed slightly lower than normal
196 // to avoid drawing at the same vertical offset
197 FontMetrics const & fm = theFontMetrics(e.font);
198 int const thickness = max(fm.lineWidth(), 2);
199 int y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
200 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
202 // Make sure that the mark does not go below the row rectangle
203 y = min(y, yo_ + row_.descent() - 1);
205 //FIXME: this could be computed only once, it is probably not costly.
206 // check for cursor position
207 // don't draw misspelled marker for words at cursor position
208 // we don't want to disturb the process of text editing
209 DocIterator const nw = pi_.base.bv->cursor().newWord();
211 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
213 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
215 else if (cpos > 0 && par_.isWordSeparator(cpos))
219 pos_type pos = e.pos;
220 while (pos < e.pos + pos_type(e.str.length())) {
221 if (!par_.isMisspelled(pos)) {
226 FontSpan const & range = par_.getSpellRange(pos);
228 // Skip element which are being edited
229 if (range.contains(cpos)) {
230 // the range includes the last element
231 pos = range.last + 1;
235 int x1 = fm.pos2x(e.str, range.first - e.pos,
237 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
238 pos_type(e.str.length())),
243 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
245 Painter::line_onoffdash, thickness);
246 pos = range.last + 1;
251 void RowPainter::paintStringAndSel(Row::Element const & e) const
253 // at least part of text selected?
254 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
256 // all the text selected?
257 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
260 if (all_sel || e.change.changed()) {
262 Color const col = e.change.changed() ? e.change.color()
263 : Color_selectiontext;
264 copy.fontInfo().setPaintColor(col);
265 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
266 } else if (!some_sel) {
267 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
269 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
270 max(row_.sel_beg, e.pos) - e.pos,
271 min(row_.sel_end, e.endpos) - e.pos,
272 e.extra, e.full_width());
277 void RowPainter::paintTextDecoration(Row::Element const & e) const
280 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
282 FontInfo copy = e.font.fontInfo();
283 if (sel || e.change.changed()) {
284 Color const col = e.change.changed() ? e.change.color()
285 : Color_selectiontext;
286 copy.setPaintColor(col);
288 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
292 void RowPainter::paintChange(Row::Element const & e) const
294 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
298 void RowPainter::paintChangeBar() const
300 int const x = pi_.base.bv->leftMargin() - pi_.base.bv->zoomedPixels(7);
301 Dimension const & cdim = row_.contents_dim();
302 pi_.pain.fillRectangle(x, yo_ - cdim.ascent(),
303 3, cdim.height(), Color_changebar);
307 void RowPainter::paintAppendix() const
309 // only draw the appendix frame once (for the main text)
310 if (!par_.params().appendix() || !text_.isMainText())
313 int y = yo_ - row_.ascent();
315 if (par_.params().startOfAppendix())
316 y += 2 * defaultRowHeight();
318 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
319 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
323 void RowPainter::paintDepthBar() const
325 depth_type const depth = par_.getDepth();
326 ParagraphList const & pars = text_.paragraphs();
331 depth_type prev_depth = 0;
332 if (!tm_.isFirstRow(row_)) {
333 pit_type pit2 = row_.pit();
336 prev_depth = pars[pit2].getDepth();
339 depth_type next_depth = 0;
340 if (!tm_.isLastRow(row_)) {
341 pit_type pit2 = row_.pit();
342 if (row_.endpos() >= pars[pit2].size())
344 next_depth = pars[pit2].getDepth();
347 for (depth_type i = 1; i <= depth; ++i) {
348 int const w = nestMargin() / 5;
349 int x = int(xo_) + w * i;
350 // only consider the changebar space if we're drawing outermost text
351 if (text_.isMainText())
352 x += pi_.base.bv->leftMargin() - changebarMargin();
354 int const starty = yo_ - row_.ascent();
355 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
357 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
360 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
362 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
367 void RowPainter::paintAppendixStart(int y) const
369 FontInfo pb_font = sane_font;
370 pb_font.setColor(Color_appendix);
377 docstring const label = _("Appendix");
378 theFontMetrics(pb_font).rectText(label, w, a, d);
380 int const text_start = int(xo_ + (tm_.width() - w) / 2);
381 int const text_end = text_start + w;
383 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
385 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
386 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
390 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
392 int const lwid = pi_.base.dottedLineThickness();
393 Dimension const & cdim = row_.contents_dim();
395 int const x = pi_.base.bv->leftMargin() - lwid;
396 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
397 Color_scroll, Painter::line_onoffdash, lwid);
400 int const x = pi_.base.bv->workWidth() - pi_.base.bv->rightMargin();
401 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
402 Color_scroll, Painter::line_onoffdash, lwid);
407 void RowPainter::paintFirst() const
409 Layout const & layout = par_.layout();
411 // start of appendix?
412 if (par_.params().startOfAppendix())
413 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
415 bool const is_first =
416 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
417 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
419 if (layout.labelIsInline()
420 && (layout.labeltype != LABEL_STATIC || is_first))
422 else if (is_first && layout.labelIsAbove())
423 paintTopLevelLabel();
427 void RowPainter::paintLabel() const
429 docstring const & str = par_.labelString();
433 // different font for label separation and string
434 Layout const & layout = par_.layout();
435 FontInfo const font = labelFont(false);
436 FontMetrics const & fm = theFontMetrics(font);
437 FontInfo lfont = font;
440 if (layout.labeltype == LABEL_ITEMIZE && par_.itemdepth < 4) {
441 // get label font size from document properties
442 lfont.setSize(pi_.base.bv->buffer().params().user_defined_bullet(par_.itemdepth).getFontSize());
443 // realize to avoid assertion
444 lfont.realize(sane_font);
447 FontMetrics const & lfm = theFontMetrics(lfont);
449 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
450 : row_.left_margin - fm.width(layout.labelsep) - lfm.width(str);
452 pi_.pain.text(int(xo_) + x, yo_, str, lfont);
456 void RowPainter::paintTopLevelLabel() const
458 BufferParams const & bparams = pi_.base.bv->buffer().params();
459 ParagraphParameters const & pparams = par_.params();
460 Layout const & layout = par_.layout();
461 FontInfo const font = labelFont(false);
462 docstring const str = par_.labelString();
466 double spacing_val = 1.0;
467 if (!pparams.spacing().isDefault())
468 spacing_val = pparams.spacing().getValue();
470 spacing_val = bparams.spacing().getValue();
472 FontMetrics const & fm = theFontMetrics(font);
474 int const labeladdon = int(fm.maxHeight()
475 * layout.spacing.getValue() * spacing_val);
478 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
479 + (layout.labelbottomsep * defaultRowHeight()));
482 if (layout.labeltype == LABEL_CENTERED) {
483 // The 'size + 1' is weird, but it makes sure that we get the
484 // left margin of non-first row.
485 int leftm = tm_.leftMargin(row_.pit(), par_.size() + 1);
486 int rightm = tm_.rightMargin(row_.pit());
489 /* Currently, x points at row_.left_margin (which contains the
490 * indent). First remove that, and then center the title with
491 * respect to the left and right margins.
493 x += leftm - row_.left_margin + (tm_.width() - leftm -rightm) / 2
495 } else if (row_.isRTL()) {
496 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
498 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
502 void RowPainter::paintLast() const
504 int const endlabel = text_.getEndLabel(row_.pit());
507 case END_LABEL_FILLED_BOX: {
508 FontInfo font = labelFont(true);
509 if (font.realColor() != Color_selectiontext)
510 font.setPaintColor(Color_eolmarker);
511 FontMetrics const & fm = theFontMetrics(font);
512 int const size = int(0.75 * fm.maxAscent());
513 int const y = yo_ - size;
515 // If needed, move the box a bit to avoid overlapping with text.
518 int const normal_x = nestMargin() + changebarMargin();
519 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
521 int const normal_x = tm_.width() - row_.right_margin
522 - size - Inset::textOffset(pi_.base.bv);
523 x = max(normal_x, row_.width());
526 if (endlabel == END_LABEL_BOX)
527 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
529 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
533 case END_LABEL_STATIC: {
534 FontInfo const font = labelFont(true);
535 FontMetrics const & fm = theFontMetrics(font);
536 docstring const & str = par_.layout().endlabelstring();
537 double const x = row_.isRTL() ? row_.left_margin - fm.width(str) : row_.width();
538 pi_.pain.text(xo_ + x, yo_, str, font);
542 case END_LABEL_NO_LABEL:
548 void RowPainter::paintOnlyInsets()
550 for (Row::Element const & e : row_) {
551 if (e.type == Row::INSET) {
553 // The markings of foreign languages
554 // and of text ignored for spellchecking
555 paintLanguageMarkings(e);
556 // change tracking (not for insets that handle it themselves)
557 if (!e.inset->canPaintChange(*pi_.base.bv))
561 // extra is the extrawidth band-aid described in redoParagraphs
562 x_ += e.full_width() + ((e.type == Row::INSET) ? e.extra : 0);
567 void RowPainter::paintText()
569 for (Row::Element const & e : row_) {
573 paintStringAndSel(e);
575 // Paint the spelling marks if enabled.
576 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
577 paintMisspelledMark(e);
585 case Row::MARGINSPACE:
586 paintTextDecoration(e);
589 // The markings of foreign languages
590 // and of text ignored for spellchecking
591 paintLanguageMarkings(e);
593 // change tracking (not for insets that handle it themselves)
594 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
597 // extra is the extrawidth band-aid described in redoParagraphs
598 x_ += e.full_width() + ((e.type == Row::INSET) ? e.extra : 0);
603 void RowPainter::paintSelection() const
605 if (!row_.selection())
608 int const y1 = yo_ - row_.contents_dim().asc;
609 int const y2 = yo_ + row_.contents_dim().des;
612 if (row_.begin_margin_sel)
613 pi_.pain.fillRectangle(int(xo_), yo_ - row_.ascent(),
614 tm_.width(), row_.ascent() - row_.contents_dim().asc,
617 // The left margin selection
618 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
619 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
622 // go through row and draw from RTL boundary to RTL boundary
623 double x = xo_ + row_.left_margin;
624 for (auto const & e : row_) {
625 // These are the same tests as in paintStringAndSel, except
626 // that all_sel has an additional clause that triggers for end
627 // of paragraph markers. The clause was not used in
628 // paintStringAndSel to avoid changing the drawing color.
629 // at least part of text selected?
630 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
632 // all the text selected?
633 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
634 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
638 // the 3rd argument is written like that to avoid rounding issues
639 pi_.pain.fillRectangle(int(x), y1,
640 int(x + e.full_width()) - int(x), y2 - y1,
642 } else if (some_sel) {
643 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
644 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
645 double x1 = e.pos2x(from);
646 double x2 = e.pos2x(to);
649 // the 3rd argument is written like that to avoid rounding issues
650 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
651 y2 - y1, Color_selection);
656 // the right margin selection
657 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
658 pi_.pain.fillRectangle(int(x), y1,
659 int(xo_ + tm_.width()) - int(x), y2 - y1,
661 // The bottom selection
662 if (row_.end_margin_sel)
663 pi_.pain.fillRectangle(int(xo_), yo_ + row_.contents_dim().des,
664 tm_.width(), row_.descent() - row_.contents_dim().des,
669 void RowPainter::paintBookmark(int num) const
671 BufferView const * bv = pi_.base.bv;
672 FontInfo fi = bv->buffer().params().getFont().fontInfo();
673 FontMetrics const & fm = theFontMetrics(fi);
674 fi.setColor(Color_bookmark);
675 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
676 char_type const ch = 0x2775 + num;
677 int const x = row_.isRTL()
678 ? bv->workWidth() - bv->rightMargin() + (bv->defaultMargin() - fm.width(ch)) / 2
679 : bv->leftMargin() - (bv->defaultMargin() + fm.width(ch)) / 2;
680 pi_.pain.text(x, yo_, ch, fi);