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.
16 #include "RowPainter.h"
19 #include "CoordCache.h"
21 #include "BufferParams.h"
22 #include "BufferView.h"
28 #include "MetricsInfo.h"
29 #include "Paragraph.h"
30 #include "ParagraphList.h"
31 #include "ParagraphParameters.h"
33 #include "TextMetrics.h"
35 #include "frontends/FontMetrics.h"
36 #include "frontends/Painter.h"
38 #include "support/debug.h"
39 #include "support/gettext.h"
40 #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
87 bool const pi_selected = pi_.selected;
88 Cursor const & cur = pi_.base.bv->cursor();
89 if (cur.selection() && cur.text() == &text_
90 && cur.normalAnchor().text() == &text_)
91 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
93 LASSERT(e.inset, return);
94 // Backup full_repaint status because some insets (InsetTabular)
95 // requires a full repaint
96 bool const pi_full_repaint = pi_.full_repaint;
97 bool const pi_do_spellcheck = pi_.do_spellcheck;
98 Change const pi_change = pi_.change;
100 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
101 pi_.base.bv->buffer().params().getFont().fontInfo();
102 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
103 pi_.change = pi_.change.changed() ? pi_.change : e.change;
104 pi_.do_spellcheck &= e.inset->allowSpellCheck();
106 int const x1 = int(x_);
107 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
108 // insets are painted completely. Recursive
109 // FIXME: it is wrong to completely paint the background
110 // if we want to do single row painting.
111 e.inset->drawBackground(pi_, x1, yo_);
112 e.inset->drawSelection(pi_, x1, yo_);
113 e.inset->draw(pi_, x1, yo_);
114 paintTextDecoration(e);
116 // Restore full_repaint status.
117 pi_.full_repaint = pi_full_repaint;
118 pi_.change = pi_change;
119 pi_.do_spellcheck = pi_do_spellcheck;
120 pi_.selected = pi_selected;
123 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
124 int const x2 = x1 + dim.wid;
125 int const y1 = yo_ + dim.des;
126 int const y2 = yo_ - dim.asc;
127 pi_.pain.line(x1, y1, x1, y2, Color_green);
128 pi_.pain.line(x1, y1, x2, y1, Color_green);
129 pi_.pain.line(x2, y1, x2, y2, Color_green);
130 pi_.pain.line(x1, y2, x2, y2, Color_green);
135 void RowPainter::paintLanguageMarkings(Row::Element const & e) const
138 paintNoSpellingMark(e);
142 void RowPainter::paintForeignMark(Row::Element const & e) const
144 Language const * lang = e.font.language();
145 if (!lyxrc.mark_foreign_language)
147 if (lang == latex_language)
149 if (lang == pi_.base.bv->buffer().params().language)
152 int const desc = e.inset ? e.dim.descent() : 0;
153 int const y = yo_ + min(3 * pi_.base.solidLineOffset() / 2 + desc,
155 pi_.pain.line(int(x_), y, int(x_ + e.full_width() - 1), y, Color_language,
156 Painter::line_solid, pi_.base.solidLineThickness());
160 void RowPainter::paintNoSpellingMark(Row::Element const & e) const
162 //if (!lyxrc.mark_no_spelling)
164 if (e.font.language() == latex_language)
166 if (e.font.fontInfo().nospellcheck() != FONT_ON)
169 // We at the same voffset than the misspelled mark, since
170 // these two are mutually exclusive
171 int const desc = e.inset ? e.dim.descent() : 0;
172 int y = yo_ + pi_.base.solidLineOffset() + desc
173 + pi_.base.solidLineThickness()
174 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
176 // Make sure that the mark does not go below the row rectangle
177 y = min(y, yo_ + row_.descent() - 1);
179 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
180 Painter::line_onoffdash, pi_.base.solidLineThickness());
184 void RowPainter::paintMisspelledMark(Row::Element const & e) const
186 if (e.font.fontInfo().nospellcheck() == FONT_ON)
188 // if changed the misspelled marker gets placed slightly lower than normal
189 // to avoid drawing at the same vertical offset
190 FontMetrics const & fm = theFontMetrics(e.font);
191 int const thickness = max(fm.lineWidth(), 2);
192 int y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
193 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
195 // Make sure that the mark does not go below the row rectangle
196 y = min(y, yo_ + row_.descent() - 1);
198 //FIXME: this could be computed only once, it is probably not costly.
199 // check for cursor position
200 // don't draw misspelled marker for words at cursor position
201 // we don't want to disturb the process of text editing
202 DocIterator const nw = pi_.base.bv->cursor().newWord();
204 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
206 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
208 else if (cpos > 0 && par_.isWordSeparator(cpos))
212 pos_type pos = e.pos;
213 while (pos < e.pos + pos_type(e.str.length())) {
214 if (!par_.isMisspelled(pos)) {
219 FontSpan const & range = par_.getSpellRange(pos);
221 // Skip element which are being edited
222 if (range.contains(cpos)) {
223 // the range includes the last element
224 pos = range.last + 1;
228 int x1 = fm.pos2x(e.str, range.first - e.pos,
230 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
231 pos_type(e.str.length())),
236 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
238 Painter::line_onoffdash, thickness);
239 pos = range.last + 1;
244 void RowPainter::paintStringAndSel(Row::Element const & e) const
246 // at least part of text selected?
247 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
249 // all the text selected?
250 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
253 if (all_sel || e.change.changed()) {
255 Color const col = e.change.changed() ? e.change.color()
256 : Color_selectiontext;
257 copy.fontInfo().setPaintColor(col);
258 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
259 } else if (!some_sel) {
260 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
262 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
263 max(row_.sel_beg, e.pos) - e.pos,
264 min(row_.sel_end, e.endpos) - e.pos,
265 e.extra, e.full_width());
270 void RowPainter::paintTextDecoration(Row::Element const & e) const
273 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
275 FontInfo copy = e.font.fontInfo();
276 if (sel || e.change.changed()) {
277 Color const col = e.change.changed() ? e.change.color()
278 : Color_selectiontext;
279 copy.setPaintColor(col);
281 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
285 void RowPainter::paintChange(Row::Element const & e) const
287 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
291 void RowPainter::paintChangeBar() const
293 pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, row_.height(), Color_changebar);
297 void RowPainter::paintAppendix() const
299 // only draw the appendix frame once (for the main text)
300 if (!par_.params().appendix() || !text_.isMainText())
303 int y = yo_ - row_.ascent();
305 if (par_.params().startOfAppendix())
306 y += 2 * defaultRowHeight();
308 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
309 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
313 void RowPainter::paintDepthBar() const
315 depth_type const depth = par_.getDepth();
316 ParagraphList const & pars = text_.paragraphs();
321 depth_type prev_depth = 0;
322 if (!tm_.isFirstRow(row_)) {
323 pit_type pit2 = row_.pit();
326 prev_depth = pars[pit2].getDepth();
329 depth_type next_depth = 0;
330 if (!tm_.isLastRow(row_)) {
331 pit_type pit2 = row_.pit();
332 if (row_.endpos() >= pars[pit2].size())
334 next_depth = pars[pit2].getDepth();
337 for (depth_type i = 1; i <= depth; ++i) {
338 int const w = nestMargin() / 5;
339 int x = int(xo_) + w * i;
340 // consider the bufferview left margin if we're drawing outermost text
341 if (text_.isMainText())
342 x += pi_.base.bv->leftMargin();
344 int const starty = yo_ - row_.ascent();
345 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
347 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
350 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
352 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
357 void RowPainter::paintAppendixStart(int y) const
359 FontInfo pb_font = sane_font;
360 pb_font.setColor(Color_appendix);
367 docstring const label = _("Appendix");
368 theFontMetrics(pb_font).rectText(label, w, a, d);
370 int const text_start = int(xo_ + (tm_.width() - w) / 2);
371 int const text_end = text_start + w;
373 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
375 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
376 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
380 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
383 pi_.pain.line(pi_.base.dottedLineThickness(), yo_ - row_.ascent(),
384 pi_.base.dottedLineThickness(), yo_ + row_.descent(),
385 Color_scroll, Painter::line_onoffdash,
386 pi_.base.dottedLineThickness());
389 pi_.base.bv->workWidth() - pi_.base.dottedLineThickness();
390 pi_.pain.line(wwidth, yo_ - row_.ascent(),
391 wwidth, yo_ + row_.descent(),
392 Color_scroll, Painter::line_onoffdash,
393 pi_.base.dottedLineThickness());
398 void RowPainter::paintFirst() const
400 Layout const & layout = par_.layout();
402 // start of appendix?
403 if (par_.params().startOfAppendix())
404 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
406 bool const is_first =
407 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
408 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
410 if (layout.labelIsInline()
411 && (layout.labeltype != LABEL_STATIC || is_first))
413 else if (is_first && layout.labelIsAbove())
414 paintTopLevelLabel();
418 void RowPainter::paintLabel() const
420 docstring const & str = par_.labelString();
424 Layout const & layout = par_.layout();
425 FontInfo const font = labelFont(false);
426 FontMetrics const & fm = theFontMetrics(font);
427 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
428 : row_.left_margin - fm.width(layout.labelsep) - fm.width(str);
430 pi_.pain.text(int(xo_) + x, yo_, str, font);
434 void RowPainter::paintTopLevelLabel() const
436 BufferParams const & bparams = pi_.base.bv->buffer().params();
437 ParagraphParameters const & pparams = par_.params();
438 Layout const & layout = par_.layout();
439 FontInfo const font = labelFont(false);
440 docstring const str = par_.labelString();
444 double spacing_val = 1.0;
445 if (!pparams.spacing().isDefault())
446 spacing_val = pparams.spacing().getValue();
448 spacing_val = bparams.spacing().getValue();
450 FontMetrics const & fm = theFontMetrics(font);
452 int const labeladdon = int(fm.maxHeight()
453 * layout.spacing.getValue() * spacing_val);
456 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
457 + (layout.labelbottomsep * defaultRowHeight()));
460 if (layout.labeltype == LABEL_CENTERED) {
461 x += (tm_.width() - row_.left_margin - row_.right_margin) / 2;
462 x -= fm.width(str) / 2;
463 } else if (row_.isRTL()) {
464 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
466 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
470 void RowPainter::paintLast() const
472 int const endlabel = text_.getEndLabel(row_.pit());
475 case END_LABEL_FILLED_BOX: {
476 FontInfo font = labelFont(true);
477 if (font.realColor() != Color_selectiontext)
478 font.setPaintColor(Color_eolmarker);
479 FontMetrics const & fm = theFontMetrics(font);
480 int const size = int(0.75 * fm.maxAscent());
481 int const y = yo_ - size;
483 // If needed, move the box a bit to avoid overlapping with text.
486 int const normal_x = nestMargin() + changebarMargin();
487 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
489 int const normal_x = tm_.width() - row_.right_margin
490 - size - Inset::textOffset(pi_.base.bv);
491 x = max(normal_x, row_.width());
494 if (endlabel == END_LABEL_BOX)
495 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
497 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
501 case END_LABEL_STATIC: {
502 FontInfo const font = labelFont(true);
503 FontMetrics const & fm = theFontMetrics(font);
504 docstring const & str = par_.layout().endlabelstring();
505 double const x = row_.isRTL() ? x_ - fm.width(str) : x_;
506 pi_.pain.text(int(x), yo_, str, font);
510 case END_LABEL_NO_LABEL:
516 void RowPainter::paintOnlyInsets()
518 for (Row::Element const & e : row_) {
519 if (e.type == Row::INSET) {
521 // The markings of foreign languages
522 // and of text ignored for spellchecking
523 paintLanguageMarkings(e);
524 // change tracking (not for insets that handle it themselves)
525 if (!e.inset->canPaintChange(*pi_.base.bv))
529 x_ += e.full_width();
534 void RowPainter::paintText()
536 for (Row::Element const & e : row_) {
540 paintStringAndSel(e);
542 // Paint the spelling marks if enabled.
543 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
544 paintMisspelledMark(e);
552 paintTextDecoration(e);
555 // The markings of foreign languages
556 // and of text ignored for spellchecking
557 paintLanguageMarkings(e);
559 // change tracking (not for insets that handle it themselves)
560 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
563 x_ += e.full_width();
568 void RowPainter::paintSelection() const
570 if (!row_.selection())
573 int const y1 = yo_ - row_.ascent();
574 int const y2 = y1 + row_.height();
577 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
578 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
581 // go through row and draw from RTL boundary to RTL boundary
582 double x = xo_ + row_.left_margin;
583 for (auto const & e : row_) {
584 // These are the same tests as in paintStringAndSel, except
585 // that all_sel has an additional clause that triggers for end
586 // of paragraph markers. The clause was not used in
587 // paintStringAndSel to avoid changing the drawing color.
588 // at least part of text selected?
589 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
591 // all the text selected?
592 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
593 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
597 // the 3rd argument is written like that to avoid rounding issues
598 pi_.pain.fillRectangle(int(x), y1,
599 int(x + e.full_width()) - int(x), y2 - y1,
601 } else if (some_sel) {
602 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
603 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
604 double x1 = e.pos2x(from);
605 double x2 = e.pos2x(to);
608 // the 3rd argument is written like that to avoid rounding issues
609 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
610 y2 - y1, Color_selection);
615 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
616 pi_.pain.fillRectangle(int(x), y1,
617 int(xo_ + tm_.width()) - int(x), y2 - y1,