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 = text_.labelFont(par_);
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;
104 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
105 pi_.base.bv->buffer().params().getFont().fontInfo();
106 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
107 pi_.change = pi_.change.changed() ? pi_.change : e.change;
108 pi_.do_spellcheck &= e.inset->allowSpellCheck();
110 int const x1 = int(x_);
111 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
112 // insets are painted completely. Recursive
113 // FIXME: it is wrong to completely paint the background
114 // if we want to do single row painting.
115 e.inset->drawBackground(pi_, x1, yo_);
116 e.inset->drawSelection(pi_, x1, yo_);
117 e.inset->draw(pi_, x1, yo_);
118 paintTextDecoration(e);
120 // Restore full_repaint status.
121 pi_.full_repaint = pi_full_repaint;
122 pi_.change = pi_change;
123 pi_.do_spellcheck = pi_do_spellcheck;
124 pi_.selected = pi_selected;
127 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
128 int const x2 = x1 + dim.wid;
129 int const y1 = yo_ + dim.des;
130 int const y2 = yo_ - dim.asc;
131 pi_.pain.line(x1, y1, x1, y2, Color_green);
132 pi_.pain.line(x1, y1, x2, y1, Color_green);
133 pi_.pain.line(x2, y1, x2, y2, Color_green);
134 pi_.pain.line(x1, y2, x2, y2, Color_green);
139 void RowPainter::paintLanguageMarkings(Row::Element const & e) const
142 paintNoSpellingMark(e);
146 void RowPainter::paintForeignMark(Row::Element const & e) const
148 Language const * lang = e.font.language();
149 if (!lyxrc.mark_foreign_language)
151 if (lang == latex_language)
153 if (lang == pi_.base.bv->buffer().params().language)
156 int const desc = e.inset ? e.dim.descent() : 0;
157 int const y = yo_ + min(3 * pi_.base.solidLineOffset() / 2 + desc,
159 pi_.pain.line(int(x_), y, int(x_ + e.full_width() - 1), y, Color_language,
160 Painter::line_solid, pi_.base.solidLineThickness());
164 void RowPainter::paintNoSpellingMark(Row::Element const & e) const
166 //if (!lyxrc.mark_no_spelling)
168 if (e.font.language() == latex_language)
170 if (e.font.fontInfo().nospellcheck() != FONT_ON)
173 // We at the same voffset than the misspelled mark, since
174 // these two are mutually exclusive
175 int const desc = e.inset ? e.dim.descent() : 0;
176 int y = yo_ + pi_.base.solidLineOffset() + desc
177 + pi_.base.solidLineThickness()
178 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
180 // Make sure that the mark does not go below the row rectangle
181 y = min(y, yo_ + row_.descent() - 1);
183 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
184 Painter::line_onoffdash, pi_.base.solidLineThickness());
188 void RowPainter::paintMisspelledMark(Row::Element const & e) const
190 if (e.font.fontInfo().nospellcheck() == FONT_ON)
192 // if changed the misspelled marker gets placed slightly lower than normal
193 // to avoid drawing at the same vertical offset
194 FontMetrics const & fm = theFontMetrics(e.font);
195 int const thickness = max(fm.lineWidth(), 2);
196 int y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
197 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
199 // Make sure that the mark does not go below the row rectangle
200 y = min(y, yo_ + row_.descent() - 1);
202 //FIXME: this could be computed only once, it is probably not costly.
203 // check for cursor position
204 // don't draw misspelled marker for words at cursor position
205 // we don't want to disturb the process of text editing
206 DocIterator const nw = pi_.base.bv->cursor().newWord();
208 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
210 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
212 else if (cpos > 0 && par_.isWordSeparator(cpos))
216 pos_type pos = e.pos;
217 while (pos < e.pos + pos_type(e.str.length())) {
218 if (!par_.isMisspelled(pos)) {
223 FontSpan const & range = par_.getSpellRange(pos);
225 // Skip element which are being edited
226 if (range.contains(cpos)) {
227 // the range includes the last element
228 pos = range.last + 1;
232 int x1 = fm.pos2x(e.str, range.first - e.pos,
234 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
235 pos_type(e.str.length())),
240 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
242 Painter::line_onoffdash, thickness);
243 pos = range.last + 1;
248 void RowPainter::paintStringAndSel(Row::Element const & e) const
250 // at least part of text selected?
251 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
253 // all the text selected?
254 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
257 if (all_sel || e.change.changed()) {
259 Color const col = e.change.changed() ? e.change.color()
260 : Color_selectiontext;
261 copy.fontInfo().setPaintColor(col);
262 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
263 } else if (!some_sel) {
264 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
266 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
267 max(row_.sel_beg, e.pos) - e.pos,
268 min(row_.sel_end, e.endpos) - e.pos,
269 e.extra, e.full_width());
274 void RowPainter::paintTextDecoration(Row::Element const & e) const
277 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
279 FontInfo copy = e.font.fontInfo();
280 if (sel || e.change.changed()) {
281 Color const col = e.change.changed() ? e.change.color()
282 : Color_selectiontext;
283 copy.setPaintColor(col);
285 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
289 void RowPainter::paintChange(Row::Element const & e) const
291 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
295 void RowPainter::paintChangeBar() const
297 int const x = pi_.base.bv->leftMargin() - pi_.base.bv->zoomedPixels(7);
298 Dimension const & cdim = row_.contents_dim();
299 pi_.pain.fillRectangle(x, yo_ - cdim.ascent(),
300 3, cdim.height(), Color_changebar);
304 void RowPainter::paintAppendix() const
306 // only draw the appendix frame once (for the main text)
307 if (!par_.params().appendix() || !text_.isMainText())
310 int y = yo_ - row_.ascent();
312 if (par_.params().startOfAppendix())
313 y += 2 * defaultRowHeight();
315 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
316 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
320 void RowPainter::paintDepthBar() const
322 depth_type const depth = par_.getDepth();
323 ParagraphList const & pars = text_.paragraphs();
328 depth_type prev_depth = 0;
329 if (!tm_.isFirstRow(row_)) {
330 pit_type pit2 = row_.pit();
333 prev_depth = pars[pit2].getDepth();
336 depth_type next_depth = 0;
337 if (!tm_.isLastRow(row_)) {
338 pit_type pit2 = row_.pit();
339 if (row_.endpos() >= pars[pit2].size())
341 next_depth = pars[pit2].getDepth();
344 for (depth_type i = 1; i <= depth; ++i) {
345 int const w = nestMargin() / 5;
346 int x = int(xo_) + w * i;
347 // only consider the changebar space if we're drawing outermost text
348 if (text_.isMainText())
349 x += pi_.base.bv->leftMargin() - changebarMargin();
351 int const starty = yo_ - row_.ascent();
352 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
354 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
357 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
359 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
364 void RowPainter::paintAppendixStart(int y) const
366 FontInfo pb_font = sane_font;
367 pb_font.setColor(Color_appendix);
374 docstring const label = _("Appendix");
375 theFontMetrics(pb_font).rectText(label, w, a, d);
377 int const text_start = int(xo_ + (tm_.width() - w) / 2);
378 int const text_end = text_start + w;
380 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
382 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
383 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
387 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
389 int const lwid = pi_.base.dottedLineThickness();
390 Dimension const & cdim = row_.contents_dim();
392 int const x = pi_.base.bv->leftMargin() - lwid;
393 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
394 Color_scroll, Painter::line_onoffdash, lwid);
397 int const x = pi_.base.bv->workWidth() - pi_.base.bv->rightMargin();
398 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
399 Color_scroll, Painter::line_onoffdash, lwid);
404 void RowPainter::paintFirst() const
406 Layout const & layout = par_.layout();
408 // start of appendix?
409 if (par_.params().startOfAppendix())
410 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
412 bool const is_first =
413 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
414 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
416 if (layout.labelIsInline()
417 && (layout.labeltype != LABEL_STATIC || is_first))
419 else if (is_first && layout.labelIsAbove())
420 paintTopLevelLabel();
424 void RowPainter::paintLabel() const
426 docstring const & str = par_.labelString();
430 // different font for label separation and string
431 Layout const & layout = par_.layout();
432 FontInfo const font = labelFont(false);
433 FontMetrics const & fm = theFontMetrics(font);
434 FontInfo lfont = font;
437 if (layout.labeltype == LABEL_ITEMIZE && par_.itemdepth < 4) {
438 // get label font size from document properties
439 lfont.setSize(pi_.base.bv->buffer().params().user_defined_bullet(par_.itemdepth).getFontSize());
440 // realize to avoid assertion
441 lfont.realize(sane_font);
444 FontMetrics const & lfm = theFontMetrics(lfont);
446 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
447 : row_.left_margin - fm.width(layout.labelsep) - lfm.width(str);
449 pi_.pain.text(int(xo_) + x, yo_, str, lfont);
453 void RowPainter::paintTopLevelLabel() const
455 BufferParams const & bparams = pi_.base.bv->buffer().params();
456 ParagraphParameters const & pparams = par_.params();
457 Layout const & layout = par_.layout();
458 FontInfo const font = labelFont(false);
459 docstring const str = par_.labelString();
463 double spacing_val = 1.0;
464 if (!pparams.spacing().isDefault())
465 spacing_val = pparams.spacing().getValue();
467 spacing_val = bparams.spacing().getValue();
469 FontMetrics const & fm = theFontMetrics(font);
471 int const labeladdon = int(fm.maxHeight()
472 * layout.spacing.getValue() * spacing_val);
475 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
476 + (layout.labelbottomsep * defaultRowHeight()));
479 if (layout.labeltype == LABEL_CENTERED) {
480 // The 'size + 1' is weird, but it makes sure that we get the
481 // left margin of non-first row.
482 int leftm = tm_.leftMargin(row_.pit(), par_.size() + 1);
483 int rightm = tm_.rightMargin(row_.pit());
486 /* Currently, x points at row_.left_margin (which contains the
487 * indent). First remove that, and then center the title with
488 * respect to the left and right margins.
490 x += leftm - row_.left_margin + (tm_.width() - leftm -rightm) / 2
492 } else if (row_.isRTL()) {
493 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
495 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
499 void RowPainter::paintLast() const
501 int const endlabel = text_.getEndLabel(row_.pit());
504 case END_LABEL_FILLED_BOX: {
505 FontInfo font = labelFont(true);
506 if (font.realColor() != Color_selectiontext)
507 font.setPaintColor(Color_eolmarker);
508 FontMetrics const & fm = theFontMetrics(font);
509 int const size = int(0.75 * fm.maxAscent());
510 int const y = yo_ - size;
512 // If needed, move the box a bit to avoid overlapping with text.
515 int const normal_x = nestMargin() + changebarMargin();
516 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
518 int const normal_x = tm_.width() - row_.right_margin
519 - size - Inset::textOffset(pi_.base.bv);
520 x = max(normal_x, row_.width());
523 if (endlabel == END_LABEL_BOX)
524 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
526 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
530 case END_LABEL_STATIC: {
531 FontInfo const font = labelFont(true);
532 FontMetrics const & fm = theFontMetrics(font);
533 docstring const & str = par_.layout().endlabelstring();
534 double const x = row_.isRTL() ? row_.left_margin - fm.width(str) : row_.width();
535 pi_.pain.text(xo_ + x, yo_, str, font);
539 case END_LABEL_NO_LABEL:
545 void RowPainter::paintOnlyInsets()
547 for (Row::Element const & e : row_) {
548 if (e.type == Row::INSET) {
550 // The markings of foreign languages
551 // and of text ignored for spellchecking
552 paintLanguageMarkings(e);
553 // change tracking (not for insets that handle it themselves)
554 if (!e.inset->canPaintChange(*pi_.base.bv))
558 x_ += e.full_width();
563 void RowPainter::paintText()
565 for (Row::Element const & e : row_) {
569 paintStringAndSel(e);
571 // Paint the spelling marks if enabled.
572 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
573 paintMisspelledMark(e);
581 case Row::MARGINSPACE:
582 paintTextDecoration(e);
585 // The markings of foreign languages
586 // and of text ignored for spellchecking
587 paintLanguageMarkings(e);
589 // change tracking (not for insets that handle it themselves)
590 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
593 x_ += e.full_width();
598 void RowPainter::paintSelection() const
600 if (!row_.selection())
603 int const y1 = yo_ - row_.contents_dim().asc;
604 int const y2 = yo_ + row_.contents_dim().des;
607 if (row_.begin_margin_sel)
608 pi_.pain.fillRectangle(int(xo_), yo_ - row_.ascent(),
609 tm_.width(), row_.ascent() - row_.contents_dim().asc,
612 // The left margin selection
613 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
614 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
617 // go through row and draw from RTL boundary to RTL boundary
618 double x = xo_ + row_.left_margin;
619 for (auto const & e : row_) {
620 // These are the same tests as in paintStringAndSel, except
621 // that all_sel has an additional clause that triggers for end
622 // of paragraph markers. The clause was not used in
623 // paintStringAndSel to avoid changing the drawing color.
624 // at least part of text selected?
625 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
627 // all the text selected?
628 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
629 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
633 // the 3rd argument is written like that to avoid rounding issues
634 pi_.pain.fillRectangle(int(x), y1,
635 int(x + e.full_width()) - int(x), y2 - y1,
637 } else if (some_sel) {
638 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
639 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
640 double x1 = e.pos2x(from);
641 double x2 = e.pos2x(to);
644 // the 3rd argument is written like that to avoid rounding issues
645 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
646 y2 - y1, Color_selection);
651 // the right margin selection
652 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
653 pi_.pain.fillRectangle(int(x), y1,
654 int(xo_ + tm_.width()) - int(x), y2 - y1,
656 // The bottom selection
657 if (row_.end_margin_sel)
658 pi_.pain.fillRectangle(int(xo_), yo_ + row_.contents_dim().des,
659 tm_.width(), row_.descent() - row_.contents_dim().des,
664 void RowPainter::paintBookmark(int num) const
666 BufferView const * bv = pi_.base.bv;
667 FontInfo fi = bv->buffer().params().getFont().fontInfo();
668 FontMetrics const & fm = theFontMetrics(fi);
669 fi.setColor(Color_bookmark);
670 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
671 char_type const ch = 0x2775 + num;
672 int const x = row_.isRTL()
673 ? bv->workWidth() - bv->rightMargin() + (bv->defaultMargin() - fm.width(ch)) / 2
674 : bv->leftMargin() - (bv->defaultMargin() + fm.width(ch)) / 2;
675 pi_.pain.text(x, yo_, ch, fi);