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
86 bool const pi_selected = pi_.selected;
87 Cursor const & cur = pi_.base.bv->cursor();
88 if (cur.selection() && cur.text() == &text_
89 && cur.normalAnchor().text() == &text_)
90 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
92 LASSERT(e.inset, return);
93 // Backup full_repaint status because some insets (InsetTabular)
94 // requires a full repaint
95 bool const pi_full_repaint = pi_.full_repaint;
96 bool const pi_do_spellcheck = pi_.do_spellcheck;
97 Change const pi_change = pi_.change;
99 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
100 pi_.base.bv->buffer().params().getFont().fontInfo();
101 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
102 pi_.change = pi_.change.changed() ? pi_.change : e.change;
103 pi_.do_spellcheck &= e.inset->allowSpellCheck();
105 int const x1 = int(x_);
106 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
107 // insets are painted completely. Recursive
108 // FIXME: it is wrong to completely paint the background
109 // if we want to do single row painting.
110 e.inset->drawBackground(pi_, x1, yo_);
111 e.inset->drawSelection(pi_, x1, yo_);
112 e.inset->draw(pi_, x1, yo_);
113 paintTextDecoration(e);
115 // Restore full_repaint status.
116 pi_.full_repaint = pi_full_repaint;
117 pi_.change = pi_change;
118 pi_.do_spellcheck = pi_do_spellcheck;
119 pi_.selected = pi_selected;
122 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
123 int const x2 = x1 + dim.wid;
124 int const y1 = yo_ + dim.des;
125 int const y2 = yo_ - dim.asc;
126 pi_.pain.line(x1, y1, x1, y2, Color_green);
127 pi_.pain.line(x1, y1, x2, y1, Color_green);
128 pi_.pain.line(x2, y1, x2, y2, Color_green);
129 pi_.pain.line(x1, y2, x2, y2, Color_green);
134 void RowPainter::paintLanguageMarkings(Row::Element const & e) const
137 paintNoSpellingMark(e);
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_ + min(3 * pi_.base.solidLineOffset() / 2 + desc,
154 pi_.pain.line(int(x_), y, int(x_ + e.full_width() - 1), y, Color_language,
155 Painter::line_solid, pi_.base.solidLineThickness());
159 void RowPainter::paintNoSpellingMark(Row::Element const & e) const
161 //if (!lyxrc.mark_no_spelling)
163 if (e.font.language() == latex_language)
165 if (e.font.fontInfo().nospellcheck() != FONT_ON)
168 // We at the same voffset than the misspelled mark, since
169 // these two are mutually exclusive
170 int const desc = e.inset ? e.dim.descent() : 0;
171 int y = yo_ + pi_.base.solidLineOffset() + desc
172 + pi_.base.solidLineThickness()
173 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
175 // Make sure that the mark does not go below the row rectangle
176 y = min(y, yo_ + row_.descent() - 1);
178 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
179 Painter::line_onoffdash, pi_.base.solidLineThickness());
183 void RowPainter::paintMisspelledMark(Row::Element const & e) const
185 if (e.font.fontInfo().nospellcheck() == FONT_ON)
187 // if changed the misspelled marker gets placed slightly lower than normal
188 // to avoid drawing at the same vertical offset
189 FontMetrics const & fm = theFontMetrics(e.font);
190 int const thickness = max(fm.lineWidth(), 2);
191 int y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
192 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
194 // Make sure that the mark does not go below the row rectangle
195 y = min(y, yo_ + row_.descent() - 1);
197 //FIXME: this could be computed only once, it is probably not costly.
198 // check for cursor position
199 // don't draw misspelled marker for words at cursor position
200 // we don't want to disturb the process of text editing
201 DocIterator const nw = pi_.base.bv->cursor().newWord();
203 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
205 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
207 else if (cpos > 0 && par_.isWordSeparator(cpos))
211 pos_type pos = e.pos;
212 while (pos < e.pos + pos_type(e.str.length())) {
213 if (!par_.isMisspelled(pos)) {
218 FontSpan const & range = par_.getSpellRange(pos);
220 // Skip element which are being edited
221 if (range.contains(cpos)) {
222 // the range includes the last element
223 pos = range.last + 1;
227 int x1 = fm.pos2x(e.str, range.first - e.pos,
229 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
230 pos_type(e.str.length())),
235 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
237 Painter::line_onoffdash, thickness);
238 pos = range.last + 1;
243 void RowPainter::paintStringAndSel(Row::Element const & e) const
245 // at least part of text selected?
246 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
248 // all the text selected?
249 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
252 if (all_sel || e.change.changed()) {
254 Color const col = e.change.changed() ? e.change.color()
255 : Color_selectiontext;
256 copy.fontInfo().setPaintColor(col);
257 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
258 } else if (!some_sel) {
259 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
261 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
262 max(row_.sel_beg, e.pos) - e.pos,
263 min(row_.sel_end, e.endpos) - e.pos,
264 e.extra, e.full_width());
269 void RowPainter::paintTextDecoration(Row::Element const & e) const
272 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
274 FontInfo copy = e.font.fontInfo();
275 if (sel || e.change.changed()) {
276 Color const col = e.change.changed() ? e.change.color()
277 : Color_selectiontext;
278 copy.setPaintColor(col);
280 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
284 void RowPainter::paintChange(Row::Element const & e) const
286 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
290 void RowPainter::paintChangeBar() const
292 int const x = pi_.base.bv->leftMargin() - pi_.base.bv->zoomedPixels(7);
293 Dimension const & cdim = row_.contents_dim();
294 pi_.pain.fillRectangle(x, yo_ - cdim.ascent(),
295 3, cdim.height(), Color_changebar);
299 void RowPainter::paintAppendix() const
301 // only draw the appendix frame once (for the main text)
302 if (!par_.params().appendix() || !text_.isMainText())
305 int y = yo_ - row_.ascent();
307 if (par_.params().startOfAppendix())
308 y += 2 * defaultRowHeight();
310 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
311 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
315 void RowPainter::paintDepthBar() const
317 depth_type const depth = par_.getDepth();
318 ParagraphList const & pars = text_.paragraphs();
323 depth_type prev_depth = 0;
324 if (!tm_.isFirstRow(row_)) {
325 pit_type pit2 = row_.pit();
328 prev_depth = pars[pit2].getDepth();
331 depth_type next_depth = 0;
332 if (!tm_.isLastRow(row_)) {
333 pit_type pit2 = row_.pit();
334 if (row_.endpos() >= pars[pit2].size())
336 next_depth = pars[pit2].getDepth();
339 for (depth_type i = 1; i <= depth; ++i) {
340 int const w = nestMargin() / 5;
341 int x = int(xo_) + w * i;
342 // consider the bufferview left margin if we're drawing outermost text
343 if (text_.isMainText())
344 x += pi_.base.bv->leftMargin();
346 int const starty = yo_ - row_.ascent();
347 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
349 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
352 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
354 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
359 void RowPainter::paintAppendixStart(int y) const
361 FontInfo pb_font = sane_font;
362 pb_font.setColor(Color_appendix);
369 docstring const label = _("Appendix");
370 theFontMetrics(pb_font).rectText(label, w, a, d);
372 int const text_start = int(xo_ + (tm_.width() - w) / 2);
373 int const text_end = text_start + w;
375 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
377 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
378 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
382 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
384 int const lwid = pi_.base.dottedLineThickness();
385 Dimension const & cdim = row_.contents_dim();
387 int const x = pi_.base.bv->leftMargin() - lwid;
388 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
389 Color_scroll, Painter::line_onoffdash, lwid);
392 int const x = pi_.base.bv->workWidth() - pi_.base.bv->rightMargin();
393 pi_.pain.line(x, yo_ - cdim.ascent(), x, yo_ + cdim.descent(),
394 Color_scroll, Painter::line_onoffdash, lwid);
399 void RowPainter::paintFirst() const
401 Layout const & layout = par_.layout();
403 // start of appendix?
404 if (par_.params().startOfAppendix())
405 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
407 bool const is_first =
408 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
409 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
411 if (layout.labelIsInline()
412 && (layout.labeltype != LABEL_STATIC || is_first))
414 else if (is_first && layout.labelIsAbove())
415 paintTopLevelLabel();
419 void RowPainter::paintLabel() const
421 docstring const & str = par_.labelString();
425 Layout const & layout = par_.layout();
426 FontInfo const font = labelFont(false);
427 FontMetrics const & fm = theFontMetrics(font);
428 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
429 : row_.left_margin - fm.width(layout.labelsep) - fm.width(str);
431 pi_.pain.text(int(xo_) + x, yo_, str, font);
435 void RowPainter::paintTopLevelLabel() const
437 BufferParams const & bparams = pi_.base.bv->buffer().params();
438 ParagraphParameters const & pparams = par_.params();
439 Layout const & layout = par_.layout();
440 FontInfo const font = labelFont(false);
441 docstring const str = par_.labelString();
445 double spacing_val = 1.0;
446 if (!pparams.spacing().isDefault())
447 spacing_val = pparams.spacing().getValue();
449 spacing_val = bparams.spacing().getValue();
451 FontMetrics const & fm = theFontMetrics(font);
453 int const labeladdon = int(fm.maxHeight()
454 * layout.spacing.getValue() * spacing_val);
457 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
458 + (layout.labelbottomsep * defaultRowHeight()));
461 if (layout.labeltype == LABEL_CENTERED) {
462 // The 'size + 1' is weird, but it makes sure that we get the
463 // left margin of non-first row.
464 int leftm = tm_.leftMargin(row_.pit(), par_.size() + 1);
465 int rightm = tm_.rightMargin(row_.pit());
468 /* Currently, x points at row_.left_margin (which contains the
469 * indent). First remove that, and then center the title with
470 * respect to the left and right margins.
472 x += leftm - row_.left_margin + (tm_.width() - leftm -rightm) / 2
474 } else if (row_.isRTL()) {
475 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
477 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
481 void RowPainter::paintLast() const
483 int const endlabel = text_.getEndLabel(row_.pit());
486 case END_LABEL_FILLED_BOX: {
487 FontInfo font = labelFont(true);
488 if (font.realColor() != Color_selectiontext)
489 font.setPaintColor(Color_eolmarker);
490 FontMetrics const & fm = theFontMetrics(font);
491 int const size = int(0.75 * fm.maxAscent());
492 int const y = yo_ - size;
494 // If needed, move the box a bit to avoid overlapping with text.
497 int const normal_x = nestMargin() + changebarMargin();
498 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
500 int const normal_x = tm_.width() - row_.right_margin
501 - size - Inset::textOffset(pi_.base.bv);
502 x = max(normal_x, row_.width());
505 if (endlabel == END_LABEL_BOX)
506 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
508 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
512 case END_LABEL_STATIC: {
513 FontInfo const font = labelFont(true);
514 FontMetrics const & fm = theFontMetrics(font);
515 docstring const & str = par_.layout().endlabelstring();
516 double const x = row_.isRTL() ? row_.left_margin - fm.width(str) : row_.width();
517 pi_.pain.text(xo_ + x, yo_, str, font);
521 case END_LABEL_NO_LABEL:
527 void RowPainter::paintOnlyInsets()
529 for (Row::Element const & e : row_) {
530 if (e.type == Row::INSET) {
532 // The markings of foreign languages
533 // and of text ignored for spellchecking
534 paintLanguageMarkings(e);
535 // change tracking (not for insets that handle it themselves)
536 if (!e.inset->canPaintChange(*pi_.base.bv))
540 x_ += e.full_width();
545 void RowPainter::paintText()
547 for (Row::Element const & e : row_) {
551 paintStringAndSel(e);
553 // Paint the spelling marks if enabled.
554 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
555 paintMisspelledMark(e);
563 paintTextDecoration(e);
566 // The markings of foreign languages
567 // and of text ignored for spellchecking
568 paintLanguageMarkings(e);
570 // change tracking (not for insets that handle it themselves)
571 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
574 x_ += e.full_width();
579 void RowPainter::paintSelection() const
581 if (!row_.selection())
584 int const y1 = yo_ - (row_.begin_margin_sel ? row_.ascent()
585 : row_.contents_dim().asc);
586 int const y2 = yo_ + (row_.end_margin_sel ? row_.descent()
587 : row_.contents_dim().des);
590 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
591 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
594 // go through row and draw from RTL boundary to RTL boundary
595 double x = xo_ + row_.left_margin;
596 for (auto const & e : row_) {
597 // These are the same tests as in paintStringAndSel, except
598 // that all_sel has an additional clause that triggers for end
599 // of paragraph markers. The clause was not used in
600 // paintStringAndSel to avoid changing the drawing color.
601 // at least part of text selected?
602 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
604 // all the text selected?
605 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
606 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
610 // the 3rd argument is written like that to avoid rounding issues
611 pi_.pain.fillRectangle(int(x), y1,
612 int(x + e.full_width()) - int(x), y2 - y1,
614 } else if (some_sel) {
615 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
616 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
617 double x1 = e.pos2x(from);
618 double x2 = e.pos2x(to);
621 // the 3rd argument is written like that to avoid rounding issues
622 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
623 y2 - y1, Color_selection);
628 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
629 pi_.pain.fillRectangle(int(x), y1,
630 int(xo_ + tm_.width()) - int(x), y2 - y1,
635 void RowPainter::paintBookmark(int num) const
637 int const x = row_.isRTL()
638 ? pi_.base.bv->workWidth() - pi_.base.bv->rightMargin() : 0;
639 FontInfo fi = pi_.base.bv->buffer().params().getFont().fontInfo();
640 fi.setColor(Color_bookmark);
641 // ❶ U+2776 DINGBAT NEGATIVE CIRCLED DIGIT ONE
642 char_type const ch = 0x2775 + num;
643 pi_.pain.text(x, yo_, ch, fi);