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.
15 #include "RowPainter.h"
18 #include "CoordCache.h"
20 #include "BufferParams.h"
21 #include "BufferView.h"
27 #include "MetricsInfo.h"
28 #include "Paragraph.h"
29 #include "ParagraphParameters.h"
30 #include "TextMetrics.h"
33 #include "frontends/FontMetrics.h"
34 #include "frontends/Painter.h"
36 #include "insets/InsetText.h"
38 #include "mathed/InsetMath.h"
40 #include "support/debug.h"
41 #include "support/gettext.h"
42 #include "support/textutils.h"
44 #include "support/lassert.h"
45 #include <boost/crc.hpp>
53 using frontend::Painter;
54 using frontend::FontMetrics;
57 RowPainter::RowPainter(PainterInfo & pi,
58 Text const & text, Row const & row, int x, int y)
59 : pi_(pi), text_(text),
60 tm_(pi_.base.bv->textMetrics(&text)),
61 pars_(text.paragraphs()),
62 row_(row), par_(text.paragraphs()[row.pit()]),
66 x_ = row_.left_margin + xo_;
68 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
71 LBUFERR(row.pit() >= 0);
72 LBUFERR(row.pit() < int(text.paragraphs().size()));
76 FontInfo RowPainter::labelFont() const
78 FontInfo f = text_.labelFont(par_);
80 if ((row_.selection() && row_.begin_margin_sel) || pi_.selected)
81 f.setPaintColor(Color_selectiontext);
86 // If you want to debug inset metrics uncomment the following line:
87 //#define DEBUG_METRICS
88 // This draws green lines around each inset.
91 void RowPainter::paintInset(Row::Element const & e) const
94 bool const pi_selected = pi_.selected;
95 Cursor const & cur = pi_.base.bv->cursor();
96 if (cur.selection() && cur.text() == &text_
97 && cur.normalAnchor().text() == &text_)
98 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
100 LASSERT(e.inset, return);
101 // Backup full_repaint status because some insets (InsetTabular)
102 // requires a full repaint
103 bool const pi_full_repaint = pi_.full_repaint;
104 bool const pi_do_spellcheck = pi_.do_spellcheck;
105 Change const pi_change = pi_.change_;
107 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
108 pi_.base.bv->buffer().params().getFont().fontInfo();
109 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
110 pi_.change_ = change_.changed() ? change_ : e.change;
111 pi_.do_spellcheck &= e.inset->allowSpellCheck();
113 int const x1 = int(x_);
114 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
115 // insets are painted completely. Recursive
116 // FIXME: it is wrong to completely paint the background
117 // if we want to do single row painting.
118 e.inset->drawBackground(pi_, x1, yo_);
119 e.inset->drawSelection(pi_, x1, yo_);
120 e.inset->draw(pi_, x1, yo_);
121 paintTextDecoration(e);
123 // Restore full_repaint status.
124 pi_.full_repaint = pi_full_repaint;
125 pi_.change_ = pi_change;
126 pi_.do_spellcheck = pi_do_spellcheck;
127 pi_.selected = pi_selected;
130 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
131 int const x2 = x1 + dim.wid;
132 int const y1 = yo_ + dim.des;
133 int const y2 = yo_ - dim.asc;
134 pi_.pain.line(x1, y1, x1, y2, Color_green);
135 pi_.pain.line(x1, y1, x2, y1, Color_green);
136 pi_.pain.line(x2, y1, x2, y2, Color_green);
137 pi_.pain.line(x1, y2, x2, y2, Color_green);
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()), y, Color_language,
156 Painter::line_solid, pi_.base.solidLineThickness());
160 void RowPainter::paintMisspelledMark(Row::Element const & e) const
162 // if changed the misspelled marker gets placed slightly lower than normal
163 // to avoid drawing at the same vertical offset
164 FontMetrics const & fm = theFontMetrics(e.font);
165 int const thickness = max(fm.lineWidth(), 2);
166 int const y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
167 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
170 //FIXME: this could be computed only once, it is probably not costly.
171 // check for cursor position
172 // don't draw misspelled marker for words at cursor position
173 // we don't want to disturb the process of text editing
174 DocIterator const nw = pi_.base.bv->cursor().newWord();
176 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
178 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
180 else if (cpos > 0 && par_.isWordSeparator(cpos))
184 pos_type pos = e.pos;
185 while (pos < e.pos + pos_type(e.str.length())) {
186 if (!par_.isMisspelled(pos)) {
191 FontSpan const & range = par_.getSpellRange(pos);
193 // Skip element which are being edited
194 if (range.contains(cpos)) {
195 // the range includes the last element
196 pos = range.last + 1;
200 FontMetrics const & fm = theFontMetrics(e.font);
201 int x1 = fm.pos2x(e.str, range.first - e.pos,
203 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
204 pos_type(e.str.length())),
209 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y,
211 Painter::line_onoffdash, thickness);
212 pos = range.last + 1;
217 void RowPainter::paintStringAndSel(Row::Element const & e) const
219 // at least part of text selected?
220 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
222 // all the text selected?
223 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
226 if (all_sel || e.change.changed()) {
228 Color const col = e.change.changed() ? e.change.color()
229 : Color_selectiontext;
230 copy.fontInfo().setPaintColor(col);
231 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
232 } else if (!some_sel) {
233 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
235 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
236 max(row_.sel_beg, e.pos) - e.pos,
237 min(row_.sel_end, e.endpos) - e.pos,
238 e.extra, e.full_width());
243 void RowPainter::paintTextDecoration(Row::Element const & e) const
246 bool const sel = (e.pos >= row_.sel_beg && e.endpos <= row_.sel_end)
248 FontInfo copy = e.font.fontInfo();
249 if (sel || e.change.changed()) {
250 Color const col = e.change.changed() ? e.change.color()
251 : Color_selectiontext;
252 copy.setPaintColor(col);
254 pi_.pain.textDecoration(copy, int(x_), yo_, int(e.full_width()));
258 void RowPainter::paintChange(Row::Element const & e) const
260 e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
264 void RowPainter::paintChangeBar() const
266 int const height = tm_.isLastRow(row_)
270 pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, height, Color_changebar);
274 void RowPainter::paintAppendix() const
276 // only draw the appendix frame once (for the main text)
277 if (!par_.params().appendix() || !text_.isMainText())
280 int y = yo_ - row_.ascent();
282 if (par_.params().startOfAppendix())
283 y += 2 * defaultRowHeight();
285 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
286 pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
290 void RowPainter::paintDepthBar() const
292 depth_type const depth = par_.getDepth();
297 depth_type prev_depth = 0;
298 if (!tm_.isFirstRow(row_)) {
299 pit_type pit2 = row_.pit();
302 prev_depth = pars_[pit2].getDepth();
305 depth_type next_depth = 0;
306 if (!tm_.isLastRow(row_)) {
307 pit_type pit2 = row_.pit();
308 if (row_.endpos() >= pars_[pit2].size())
310 next_depth = pars_[pit2].getDepth();
313 for (depth_type i = 1; i <= depth; ++i) {
314 int const w = nestMargin() / 5;
315 int x = int(xo_) + w * i;
316 // consider the bufferview left margin if we're drawing outermost text
317 if (text_.isMainText())
318 x += pi_.base.bv->leftMargin();
320 int const starty = yo_ - row_.ascent();
321 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
323 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
326 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
328 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
333 void RowPainter::paintAppendixStart(int y) const
335 FontInfo pb_font = sane_font;
336 pb_font.setColor(Color_appendix);
343 docstring const label = _("Appendix");
344 theFontMetrics(pb_font).rectText(label, w, a, d);
346 int const text_start = int(xo_ + (tm_.width() - w) / 2);
347 int const text_end = text_start + w;
349 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
351 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
352 pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
356 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
359 pi_.pain.line(pi_.base.dottedLineThickness(), yo_ - row_.ascent(),
360 pi_.base.dottedLineThickness(), yo_ + row_.descent(),
361 Color_scroll, Painter::line_onoffdash,
362 pi_.base.dottedLineThickness());
365 pi_.base.bv->workWidth() - pi_.base.dottedLineThickness();
366 pi_.pain.line(wwidth, yo_ - row_.ascent(),
367 wwidth, yo_ + row_.descent(),
368 Color_scroll, Painter::line_onoffdash,
369 pi_.base.dottedLineThickness());
374 void RowPainter::paintFirst() const
376 Layout const & layout = par_.layout();
378 // start of appendix?
379 if (par_.params().startOfAppendix())
380 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
382 bool const is_first =
383 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
384 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
386 if (layout.labelIsInline()
387 && (layout.labeltype != LABEL_STATIC || is_first))
389 else if (is_first && layout.labelIsAbove())
390 paintTopLevelLabel();
394 void RowPainter::paintLabel() const
396 docstring const & str = par_.labelString();
400 Layout const & layout = par_.layout();
401 FontInfo const font = labelFont();
402 FontMetrics const & fm = theFontMetrics(font);
406 x = xo_ + row_.width() + fm.width(layout.labelsep);
408 x = x_ - fm.width(layout.labelsep) - fm.width(str);
410 pi_.pain.text(int(x), yo_, str, font);
414 void RowPainter::paintTopLevelLabel() const
416 BufferParams const & bparams = pi_.base.bv->buffer().params();
417 ParagraphParameters const & pparams = par_.params();
418 Layout const & layout = par_.layout();
419 FontInfo const font = labelFont();
420 docstring const str = par_.labelString();
424 double spacing_val = 1.0;
425 if (!pparams.spacing().isDefault())
426 spacing_val = pparams.spacing().getValue();
428 spacing_val = bparams.spacing().getValue();
430 FontMetrics const & fm = theFontMetrics(font);
432 int const labeladdon = int(fm.maxHeight()
433 * layout.spacing.getValue() * spacing_val);
436 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
437 + (layout.labelbottomsep * defaultRowHeight()));
440 if (layout.labeltype == LABEL_CENTERED) {
441 x += (tm_.width() - row_.left_margin - row_.right_margin) / 2;
442 x -= fm.width(str) / 2;
443 } else if (row_.isRTL()) {
444 x = xo_ + tm_.width() - row_.right_margin - fm.width(str);
446 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
450 /** Check if the current paragraph is the last paragraph in a
452 static int getEndLabel(pit_type p, Text const & text)
454 ParagraphList const & pars = text.paragraphs();
456 depth_type par_depth = pars[p].getDepth();
457 while (pit != pit_type(pars.size())) {
458 Layout const & layout = pars[pit].layout();
459 int const endlabeltype = layout.endlabeltype;
461 if (endlabeltype != END_LABEL_NO_LABEL) {
462 if (p + 1 == pit_type(pars.size()))
465 depth_type const next_depth =
466 pars[p + 1].getDepth();
467 if (par_depth > next_depth ||
468 (par_depth == next_depth && layout != pars[p + 1].layout()))
474 pit = text.outerHook(pit);
475 if (pit != pit_type(pars.size()))
476 par_depth = pars[pit].getDepth();
478 return END_LABEL_NO_LABEL;
482 void RowPainter::paintLast() const
484 int const endlabel = getEndLabel(row_.pit(), text_);
486 // paint imaginary end-of-paragraph character
488 Change const & change = par_.lookupChange(par_.size());
489 if (change.changed()) {
490 FontMetrics const & fm =
491 theFontMetrics(pi_.base.bv->buffer().params().getFont());
492 int const length = fm.maxAscent() / 2;
493 Color col = change.color();
495 pi_.pain.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
496 Painter::line_solid, 3);
498 if (change.deleted()) {
499 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1 + length,
500 yo_ + 2, col, Painter::line_solid, 3);
502 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1,
503 yo_ + 2, col, Painter::line_solid, 3);
511 case END_LABEL_FILLED_BOX: {
512 FontInfo const font = labelFont();
513 FontMetrics const & fm = theFontMetrics(font);
514 int const size = int(0.75 * fm.maxAscent());
515 int const y = yo_ - size;
517 // If needed, move the box a bit to avoid overlapping with text.
520 int const normal_x = nestMargin() + changebarMargin();
521 x = min(normal_x, row_.left_margin - size - Inset::TEXT_TO_INSET_OFFSET);
523 int const normal_x = tm_.width() - row_.right_margin
524 - size - Inset::TEXT_TO_INSET_OFFSET;
525 x = max(normal_x, row_.width());
528 if (endlabel == END_LABEL_BOX)
529 pi_.pain.rectangle(int(xo_) + x, y, size, size, Color_eolmarker);
531 pi_.pain.fillRectangle(int(xo_) + x, y, size, size, Color_eolmarker);
535 case END_LABEL_STATIC: {
536 FontInfo const font = labelFont();
537 FontMetrics const & fm = theFontMetrics(font);
538 docstring const & str = par_.layout().endlabelstring();
539 double const x = row_.isRTL() ? x_ - fm.width(str) : x_;
540 pi_.pain.text(int(x), yo_, str, font);
544 case END_LABEL_NO_LABEL:
550 void RowPainter::paintOnlyInsets()
552 Row::const_iterator cit = row_.begin();
553 Row::const_iterator const & end = row_.end();
554 for ( ; cit != end ; ++cit) {
555 Row::Element const & e = *cit;
556 if (e.type == Row::INSET) {
558 // The line that indicates word in a different language
560 // change tracking (not for insets that handle it themselves)
561 if (!e.inset->canPaintChange(*pi_.base.bv))
565 x_ += e.full_width();
570 void RowPainter::paintText()
572 Row::const_iterator cit = row_.begin();
573 Row::const_iterator const & end = row_.end();
574 for ( ; cit != end ; ++cit) {
575 Row::Element const & e = *cit;
580 paintStringAndSel(e);
582 // Paint the spelling marks if enabled.
583 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && !pi_.pain.isNull())
584 paintMisspelledMark(e);
592 paintTextDecoration(e);
595 // The line that indicates word in a different language
598 // change tracking (not for insets that handle it themselves)
599 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
602 x_ += e.full_width();
607 void RowPainter::paintSelection() const
609 if (!row_.selection())
612 int const y1 = yo_ - row_.ascent();
613 int const y2 = y1 + row_.height();
616 if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
617 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
620 // go through row and draw from RTL boundary to RTL boundary
621 double x = xo_ + row_.left_margin;
622 for (auto const & e : row_) {
623 // These are the same tests as in paintStringAndSel, except
624 // that all_sel has an additional clause that triggers for end
625 // of paragraph markers. The clause was not used in
626 // paintStringAndSel to avoid changing the drawing color.
627 // at least part of text selected?
628 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
630 // all the text selected?
631 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
632 || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
636 // the 3rd argument is written like that to avoid rounding issues
637 pi_.pain.fillRectangle(int(x), y1,
638 int(x + e.full_width()) - int(x), y2 - y1,
640 } else if (some_sel) {
641 pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
642 pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
643 double x1 = e.pos2x(from);
644 double x2 = e.pos2x(to);
647 // the 3rd argument is written like that to avoid rounding issues
648 pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
649 y2 - y1, Color_selection);
654 if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
655 pi_.pain.fillRectangle(int(x), y1,
656 int(xo_ + tm_.width()) - int(x), y2 - y1,