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 const y = yo_ + pi_.base.solidLineOffset() + desc
173 + pi_.base.solidLineThickness()
174 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
176 pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
177 Painter::line_onoffdash, pi_.base.solidLineThickness());
181 void RowPainter::paintMisspelledMark(Row::Element const & e) const
183 if (e.font.fontInfo().nospellcheck() == FONT_ON)
185 // if changed the misspelled marker gets placed slightly lower than normal
186 // to avoid drawing at the same vertical offset
187 FontMetrics const & fm = theFontMetrics(e.font);
188 int const thickness = max(fm.lineWidth(), 2);
189 int const y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
190 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
193 //FIXME: this could be computed only once, it is probably not costly.
194 // check for cursor position
195 // don't draw misspelled marker for words at cursor position
196 // we don't want to disturb the process of text editing
197 DocIterator const nw = pi_.base.bv->cursor().newWord();
199 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
201 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
203 else if (cpos > 0 && par_.isWordSeparator(cpos))
207 pos_type pos = e.pos;
208 while (pos < e.pos + pos_type(e.str.length())) {
209 if (!par_.isMisspelled(pos)) {
214 FontSpan const & range = par_.getSpellRange(pos);
216 // Skip element which are being edited
217 if (range.contains(cpos)) {
218 // the range includes the last element
219 pos = range.last + 1;
223 int x1 = fm.pos2x(e.str, range.first - e.pos,
225 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
226 pos_type(e.str.length())),
231 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
233 Painter::line_onoffdash, thickness);
234 pos = range.last + 1;
239 void RowPainter::paintStringAndSel(Row::Element const & e) const
241 // at least part of text selected?
242 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
244 // all the text selected?
245 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
248 if (all_sel || e.change.changed()) {
250 Color const col = e.change.changed() ? e.change.color()
251 : Color_selectiontext;
252 copy.fontInfo().setPaintColor(col);
253 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
254 } else if (!some_sel) {
255 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
257 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
258 max(row_.sel_beg, e.pos) - e.pos,
259 min(row_.sel_end, e.endpos) - e.pos,
260 e.extra, e.full_width());
265 void RowPainter::paintTextDecoration(Row::Element const & e) const
268 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
270 FontInfo copy = e.font.fontInfo();
271 if (sel || e.change.changed()) {
272 Color const col = e.change.changed() ? e.change.color()
273 : Color_selectiontext;
274 copy.setPaintColor(col);
276 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
280 void RowPainter::paintChange(Row::Element const & e) const
282 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
286 void RowPainter::paintChangeBar() const
288 pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, row_.height(), Color_changebar);
292 void RowPainter::paintAppendix() const
294 // only draw the appendix frame once (for the main text)
295 if (!par_.params().appendix() || !text_.isMainText())
298 int y = yo_ - row_.ascent();
300 if (par_.params().startOfAppendix())
301 y += 2 * defaultRowHeight();
303 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
304 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
308 void RowPainter::paintDepthBar() const
310 depth_type const depth = par_.getDepth();
311 ParagraphList const & pars = text_.paragraphs();
316 depth_type prev_depth = 0;
317 if (!tm_.isFirstRow(row_)) {
318 pit_type pit2 = row_.pit();
321 prev_depth = pars[pit2].getDepth();
324 depth_type next_depth = 0;
325 if (!tm_.isLastRow(row_)) {
326 pit_type pit2 = row_.pit();
327 if (row_.endpos() >= pars[pit2].size())
329 next_depth = pars[pit2].getDepth();
332 for (depth_type i = 1; i <= depth; ++i) {
333 int const w = nestMargin() / 5;
334 int x = int(xo_) + w * i;
335 // consider the bufferview left margin if we're drawing outermost text
336 if (text_.isMainText())
337 x += pi_.base.bv->leftMargin();
339 int const starty = yo_ - row_.ascent();
340 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
342 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
345 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
347 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
352 void RowPainter::paintAppendixStart(int y) const
354 FontInfo pb_font = sane_font;
355 pb_font.setColor(Color_appendix);
362 docstring const label = _("Appendix");
363 theFontMetrics(pb_font).rectText(label, w, a, d);
365 int const text_start = int(xo_ + (tm_.width() - w) / 2);
366 int const text_end = text_start + w;
368 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
370 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
371 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
375 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
378 pi_.pain.line(pi_.base.dottedLineThickness(), yo_ - row_.ascent(),
379 pi_.base.dottedLineThickness(), yo_ + row_.descent(),
380 Color_scroll, Painter::line_onoffdash,
381 pi_.base.dottedLineThickness());
384 pi_.base.bv->workWidth() - pi_.base.dottedLineThickness();
385 pi_.pain.line(wwidth, yo_ - row_.ascent(),
386 wwidth, yo_ + row_.descent(),
387 Color_scroll, Painter::line_onoffdash,
388 pi_.base.dottedLineThickness());
393 void RowPainter::paintFirst() const
395 Layout const & layout = par_.layout();
397 // start of appendix?
398 if (par_.params().startOfAppendix())
399 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
401 bool const is_first =
402 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
403 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
405 if (layout.labelIsInline()
406 && (layout.labeltype != LABEL_STATIC || is_first))
408 else if (is_first && layout.labelIsAbove())
409 paintTopLevelLabel();
413 void RowPainter::paintLabel() const
415 docstring const & str = par_.labelString();
419 Layout const & layout = par_.layout();
420 FontInfo const font = labelFont(false);
421 FontMetrics const & fm = theFontMetrics(font);
422 int const x = row_.isRTL() ? row_.width() + fm.width(layout.labelsep)
423 : row_.left_margin - fm.width(layout.labelsep) - fm.width(str);
425 pi_.pain.text(int(xo_) + x, yo_, str, font);
429 void RowPainter::paintTopLevelLabel() const
431 BufferParams const & bparams = pi_.base.bv->buffer().params();
432 ParagraphParameters const & pparams = par_.params();
433 Layout const & layout = par_.layout();
434 FontInfo const font = labelFont(false);
435 docstring const str = par_.labelString();
439 double spacing_val = 1.0;
440 if (!pparams.spacing().isDefault())
441 spacing_val = pparams.spacing().getValue();
443 spacing_val = bparams.spacing().getValue();
445 FontMetrics const & fm = theFontMetrics(font);
447 int const labeladdon = int(fm.maxHeight()
448 * layout.spacing.getValue() * spacing_val);
451 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
452 + (layout.labelbottomsep * defaultRowHeight()));
455 if (layout.labeltype == LABEL_CENTERED) {
456 x += (tm_.width() - row_.left_margin - row_.right_margin) / 2;
457 x -= fm.width(str) / 2;
458 } else if (row_.isRTL()) {
459 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
461 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
465 void RowPainter::paintLast() const
467 int const endlabel = text_.getEndLabel(row_.pit());
470 case END_LABEL_FILLED_BOX: {
471 FontInfo font = labelFont(true);
472 if (font.realColor() != Color_selectiontext)
473 font.setPaintColor(Color_eolmarker);
474 FontMetrics const & fm = theFontMetrics(font);
475 int const size = int(0.75 * fm.maxAscent());
476 int const y = yo_ - size;
478 // If needed, move the box a bit to avoid overlapping with text.
481 int const normal_x = nestMargin() + changebarMargin();
482 x = min(normal_x, row_.left_margin - size - Inset::textOffset(pi_.base.bv));
484 int const normal_x = tm_.width() - row_.right_margin
485 - size - Inset::textOffset(pi_.base.bv);
486 x = max(normal_x, row_.width());
489 if (endlabel == END_LABEL_BOX)
490 pi_.pain.rectangle(int(xo_) + x, y, size, size, font.realColor());
492 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, font.realColor());
496 case END_LABEL_STATIC: {
497 FontInfo const font = labelFont(true);
498 FontMetrics const & fm = theFontMetrics(font);
499 docstring const & str = par_.layout().endlabelstring();
500 double const x = row_.isRTL() ? x_ - fm.width(str) : x_;
501 pi_.pain.text(int(x), yo_, str, font);
505 case END_LABEL_NO_LABEL:
511 void RowPainter::paintOnlyInsets()
513 for (Row::Element const & e : row_) {
514 if (e.type == Row::INSET) {
516 // The markings of foreign languages
517 // and of text ignored for spellchecking
518 paintLanguageMarkings(e);
519 // change tracking (not for insets that handle it themselves)
520 if (!e.inset->canPaintChange(*pi_.base.bv))
524 x_ += e.full_width();
529 void RowPainter::paintText()
531 for (Row::Element const & e : row_) {
535 paintStringAndSel(e);
537 // Paint the spelling marks if enabled.
538 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
539 paintMisspelledMark(e);
547 paintTextDecoration(e);
550 // The markings of foreign languages
551 // and of text ignored for spellchecking
552 paintLanguageMarkings(e);
554 // change tracking (not for insets that handle it themselves)
555 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
558 x_ += e.full_width();
563 void RowPainter::paintSelection() const
565 if (!row_.selection())
568 int const y1 = yo_ - row_.ascent();
569 int const y2 = y1 + row_.height();
572 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
573 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
576 // go through row and draw from RTL boundary to RTL boundary
577 double x = xo_ + row_.left_margin;
578 for (auto const & e : row_) {
579 // These are the same tests as in paintStringAndSel, except
580 // that all_sel has an additional clause that triggers for end
581 // of paragraph markers. The clause was not used in
582 // paintStringAndSel to avoid changing the drawing color.
583 // at least part of text selected?
584 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
586 // all the text selected?
587 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
588 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
592 // the 3rd argument is written like that to avoid rounding issues
593 pi_.pain.fillRectangle(int(x), y1,
594 int(x + e.full_width()) - int(x), y2 - y1,
596 } else if (some_sel) {
597 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
598 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
599 double x1 = e.pos2x(from);
600 double x2 = e.pos2x(to);
603 // the 3rd argument is written like that to avoid rounding issues
604 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
605 y2 - y1, Color_selection);
610 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
611 pi_.pain.fillRectangle(int(x), y1,
612 int(xo_ + tm_.width()) - int(x), y2 - y1,