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;
104 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
105 pi_.base.bv->buffer().params().getFont().fontInfo();
106 pi_.base.outer_font = e.font.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();
111 int const x1 = int(x_);
112 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
113 // insets are painted completely. Recursive
114 // FIXME: it is wrong to completely paint the background
115 // if we want to do single row painting.
116 e.inset->drawBackground(pi_, x1, yo_);
117 e.inset->drawSelection(pi_, x1, yo_);
118 e.inset->draw(pi_, x1, yo_);
119 paintTextDecoration(e);
121 // Restore full_repaint status.
122 pi_.full_repaint = pi_full_repaint;
123 pi_.change = pi_change;
124 pi_.do_spellcheck = pi_do_spellcheck;
125 pi_.selected = pi_selected;
128 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
129 int const x2 = x1 + dim.wid;
130 int const y1 = yo_ + dim.des;
131 int const y2 = yo_ - dim.asc;
132 pi_.pain.line(x1, y1, x1, y2, Color_green);
133 pi_.pain.line(x1, y1, x2, y1, Color_green);
134 pi_.pain.line(x2, y1, x2, y2, Color_green);
135 pi_.pain.line(x1, y2, x2, y2, Color_green);
140 void RowPainter::paintLanguageMarkings(Row::Element const & e) const
143 paintNoSpellingMark(e);
147 void RowPainter::paintForeignMark(Row::Element const & e) const
149 Language const * lang = e.font.language();
150 if (!lyxrc.mark_foreign_language)
152 if (lang == latex_language)
154 if (lang == pi_.base.bv->buffer().params().language)
157 int const desc = e.inset ? e.dim.descent() : 0;
158 int const y = yo_ + min(3 * pi_.base.solidLineOffset() / 2 + desc,
160 pi_.pain.line(int(x_), y, int(x_ + e.full_width() - 1), y, Color_language,
161 Painter::line_solid, pi_.base.solidLineThickness());
165 void RowPainter::paintNoSpellingMark(Row::Element const & e) const
167 //if (!lyxrc.mark_no_spelling)
169 if (e.font.language() == latex_language)
171 if (e.font.fontInfo().nospellcheck() != FONT_ON)
174 // We at the same voffset than the misspelled mark, since
175 // these two are mutually exclusive
176 int const desc = e.inset ? e.dim.descent() : 0;
177 int y = yo_ + pi_.base.solidLineOffset() + desc
178 + pi_.base.solidLineThickness()
179 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
181 // Make sure that the mark does not go below the row rectangle
182 y = min(y, yo_ + row_.descent() - 1);
184 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
185 Painter::line_onoffdash, pi_.base.solidLineThickness());
189 void RowPainter::paintMisspelledMark(Row::Element const & e) const
191 if (e.font.fontInfo().nospellcheck() == FONT_ON)
193 // if changed the misspelled marker gets placed slightly lower than normal
194 // to avoid drawing at the same vertical offset
195 FontMetrics const & fm = theFontMetrics(e.font);
196 int const thickness = max(fm.lineWidth(), 2);
197 int y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
198 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
200 // Make sure that the mark does not go below the row rectangle
201 y = min(y, yo_ + row_.descent() - 1);
203 //FIXME: this could be computed only once, it is probably not costly.
204 // check for cursor position
205 // don't draw misspelled marker for words at cursor position
206 // we don't want to disturb the process of text editing
207 DocIterator const nw = pi_.base.bv->cursor().newWord();
209 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
211 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
213 else if (cpos > 0 && par_.isWordSeparator(cpos))
217 pos_type pos = e.pos;
218 while (pos < e.pos + pos_type(e.str.length())) {
219 if (!par_.isMisspelled(pos)) {
224 FontSpan const & range = par_.getSpellRange(pos);
226 // Skip element which are being edited
227 if (range.contains(cpos)) {
228 // the range includes the last element
229 pos = range.last + 1;
233 int x1 = fm.pos2x(e.str, range.first - e.pos,
235 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
236 pos_type(e.str.length())),
241 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
243 Painter::line_onoffdash, thickness);
244 pos = range.last + 1;
249 void RowPainter::paintStringAndSel(Row::Element const & e) const
251 // at least part of text selected?
252 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
254 // all the text selected?
255 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
258 if (all_sel || e.change.changed()) {
260 Color const col = e.change.changed() ? e.change.color()
261 : Color_selectiontext;
262 copy.fontInfo().setPaintColor(col);
263 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
264 } else if (!some_sel) {
265 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
267 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
268 max(row_.sel_beg, e.pos) - e.pos,
269 min(row_.sel_end, e.endpos) - e.pos,
270 e.extra, e.full_width());
275 void RowPainter::paintTextDecoration(Row::Element const & e) const
278 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
280 FontInfo copy = e.font.fontInfo();
281 if (sel || e.change.changed()) {
282 Color const col = e.change.changed() ? e.change.color()
283 : Color_selectiontext;
284 copy.setPaintColor(col);
286 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
290 void RowPainter::paintChange(Row::Element const & e) const
292 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
296 void RowPainter::paintChangeBar() const
298 int const x = pi_.base.bv->leftMargin() - pi_.base.bv->zoomedPixels(7);
299 Dimension const & cdim = row_.contents_dim();
300 pi_.pain.fillRectangle(x, yo_ - cdim.ascent(),
301 3, cdim.height(), Color_changebar);
305 void RowPainter::paintAppendix() const
307 // only draw the appendix frame once (for the main text)
308 if (!par_.params().appendix() || !text_.isMainText())
311 int y = yo_ - row_.ascent();
313 if (par_.params().startOfAppendix())
314 y += 2 * defaultRowHeight();
316 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
317 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.descent(), Color_appendix);
321 void RowPainter::paintDepthBar() const
323 depth_type const depth = par_.getDepth();
324 ParagraphList const & pars = text_.paragraphs();
329 depth_type prev_depth = 0;
330 if (!tm_.isFirstRow(row_)) {
331 pit_type pit2 = row_.pit();
334 prev_depth = pars[pit2].getDepth();
337 depth_type next_depth = 0;
338 if (!tm_.isLastRow(row_)) {
339 pit_type pit2 = row_.pit();
340 if (row_.endpos() >= pars[pit2].size())
342 next_depth = pars[pit2].getDepth();
345 for (depth_type i = 1; i <= depth; ++i) {
346 int const w = nestMargin() / 5;
347 int x = int(xo_) + w * i;
348 // only consider the changebar space if we're drawing outermost text
349 if (text_.isMainText())
350 x += pi_.base.bv->leftMargin() - changebarMargin();
352 int const starty = yo_ - row_.ascent();
353 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
355 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
358 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
360 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
365 void RowPainter::paintAppendixStart(int y) const
367 FontInfo pb_font = sane_font;
368 pb_font.setColor(Color_appendix);
375 docstring const label = _("Appendix");
376 theFontMetrics(pb_font).rectText(label, w, a, d);
378 int const text_start = int(xo_ + (tm_.width() - w) / 2);
379 int const text_end = text_start + w;
381 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
383 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
384 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
388 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
390 int const lwid = pi_.base.dottedLineThickness();
391 Dimension const & cdim = row_.contents_dim();
393 int const x = pi_.base.bv->leftMargin() - lwid;
394 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
395 Color_scroll, Painter::line_onoffdash, lwid);
398 int const x = pi_.base.bv->workWidth() - pi_.base.bv->rightMargin();
399 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
400 Color_scroll, Painter::line_onoffdash, lwid);
405 void RowPainter::paintFirst() const
407 Layout const & layout = par_.layout();
409 // start of appendix?
410 if (par_.params().startOfAppendix())
411 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
413 bool const is_first =
414 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
415 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
417 if (layout.labelIsInline()
418 && (layout.labeltype != LABEL_STATIC || is_first))
420 else if (is_first && layout.labelIsAbove())
421 paintTopLevelLabel();
425 void RowPainter::paintLabel() const
427 docstring const & str = par_.labelString();
431 // different font for label separation and string
432 Layout const & layout = par_.layout();
433 FontInfo const font = labelFont(false);
434 FontMetrics const & fm = theFontMetrics(font);
435 FontInfo lfont = font;
438 if (layout.labeltype == LABEL_ITEMIZE && par_.itemdepth < 4) {
439 // get label font size from document properties
440 lfont.setSize(pi_.base.bv->buffer().params().user_defined_bullet(par_.itemdepth).getFontSize());
441 // realize to avoid assertion
442 lfont.realize(sane_font);
445 FontMetrics const & lfm = theFontMetrics(lfont);
447 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
448 : row_.left_margin - fm.width(layout.labelsep) - lfm.width(str);
450 pi_.pain.text(int(xo_) + x, yo_, str, lfont);
454 void RowPainter::paintTopLevelLabel() const
456 BufferParams const & bparams = pi_.base.bv->buffer().params();
457 ParagraphParameters const & pparams = par_.params();
458 Layout const & layout = par_.layout();
459 FontInfo const font = labelFont(false);
460 docstring const str = par_.labelString();
464 double spacing_val = 1.0;
465 if (!pparams.spacing().isDefault())
466 spacing_val = pparams.spacing().getValue();
468 spacing_val = bparams.spacing().getValue();
470 FontMetrics const & fm = theFontMetrics(font);
472 int const labeladdon = int(fm.maxHeight()
473 * layout.spacing.getValue() * spacing_val);
476 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
477 + (layout.labelbottomsep * defaultRowHeight()));
480 if (layout.labeltype == LABEL_CENTERED) {
481 // The 'size + 1' is weird, but it makes sure that we get the
482 // left margin of non-first row.
483 int leftm = tm_.leftMargin(row_.pit(), par_.size() + 1);
484 int rightm = tm_.rightMargin(row_.pit());
487 /* Currently, x points at row_.left_margin (which contains the
488 * indent). First remove that, and then center the title with
489 * respect to the left and right margins.
491 x += leftm - row_.left_margin + (tm_.width() - leftm -rightm) / 2
493 } else if (row_.isRTL()) {
494 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
496 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
500 void RowPainter::paintLast() const
502 int const endlabel = text_.getEndLabel(row_.pit());
505 case END_LABEL_FILLED_BOX: {
506 FontInfo font = labelFont(true);
507 if (font.realColor() != Color_selectiontext)
508 font.setPaintColor(Color_eolmarker);
509 FontMetrics const & fm = theFontMetrics(font);
510 int const size = int(0.75 * fm.maxAscent());
511 int const y = yo_ - size;
513 // If needed, move the box a bit to avoid overlapping with text.
516 int const normal_x = nestMargin() + changebarMargin();
517 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
519 int const normal_x = tm_.width() - row_.right_margin
520 - size - Inset::textOffset(pi_.base.bv);
521 x = max(normal_x, row_.width());
524 if (endlabel == END_LABEL_BOX)
525 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
527 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
531 case END_LABEL_STATIC: {
532 FontInfo const font = labelFont(true);
533 FontMetrics const & fm = theFontMetrics(font);
534 docstring const & str = par_.layout().endlabelstring();
535 double const x = row_.isRTL() ? row_.left_margin - fm.width(str) : row_.width();
536 pi_.pain.text(xo_ + x, yo_, str, font);
540 case END_LABEL_NO_LABEL:
546 void RowPainter::paintOnlyInsets()
548 for (Row::Element const & e : row_) {
549 if (e.type == Row::INSET) {
551 // The markings of foreign languages
552 // and of text ignored for spellchecking
553 paintLanguageMarkings(e);
554 // change tracking (not for insets that handle it themselves)
555 if (!e.inset->canPaintChange(*pi_.base.bv))
559 x_ += e.full_width();
564 void RowPainter::paintText()
566 for (Row::Element const & e : row_) {
570 paintStringAndSel(e);
572 // Paint the spelling marks if enabled.
573 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
574 paintMisspelledMark(e);
582 case Row::MARGINSPACE:
583 paintTextDecoration(e);
586 // The markings of foreign languages
587 // and of text ignored for spellchecking
588 paintLanguageMarkings(e);
590 // change tracking (not for insets that handle it themselves)
591 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
594 x_ += e.full_width();
599 void RowPainter::paintSelection() const
601 if (!row_.selection())
604 int const y1 = yo_ - row_.contents_dim().asc;
605 int const y2 = yo_ + row_.contents_dim().des;
608 if (row_.begin_margin_sel)
609 pi_.pain.fillRectangle(int(xo_), yo_ - row_.ascent(),
610 tm_.width(), row_.ascent() - row_.contents_dim().asc,
613 // The left margin selection
614 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
615 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
618 // go through row and draw from RTL boundary to RTL boundary
619 double x = xo_ + row_.left_margin;
620 for (auto const & e : row_) {
621 // These are the same tests as in paintStringAndSel, except
622 // that all_sel has an additional clause that triggers for end
623 // of paragraph markers. The clause was not used in
624 // paintStringAndSel to avoid changing the drawing color.
625 // at least part of text selected?
626 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
628 // all the text selected?
629 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
630 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
634 // the 3rd argument is written like that to avoid rounding issues
635 pi_.pain.fillRectangle(int(x), y1,
636 int(x + e.full_width()) - int(x), y2 - y1,
638 } else if (some_sel) {
639 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
640 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
641 double x1 = e.pos2x(from);
642 double x2 = e.pos2x(to);
645 // the 3rd argument is written like that to avoid rounding issues
646 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
647 y2 - y1, Color_selection);
652 // the right margin 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,
657 // The bottom selection
658 if (row_.end_margin_sel)
659 pi_.pain.fillRectangle(int(xo_), yo_ + row_.contents_dim().des,
660 tm_.width(), row_.descent() - row_.contents_dim().des,
665 void RowPainter::paintBookmark(int num) const
667 BufferView const * bv = pi_.base.bv;
668 FontInfo fi = bv->buffer().params().getFont().fontInfo();
669 FontMetrics const & fm = theFontMetrics(fi);
670 fi.setColor(Color_bookmark);
671 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
672 char_type const ch = 0x2775 + num;
673 int const x = row_.isRTL()
674 ? bv->workWidth() - bv->rightMargin() + (bv->defaultMargin() - fm.width(ch)) / 2
675 : bv->leftMargin() - (bv->defaultMargin() + fm.width(ch)) / 2;
676 pi_.pain.text(x, yo_, ch, fi);