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 "ParagraphMetrics.h"
30 #include "ParagraphParameters.h"
31 #include "TextMetrics.h"
34 #include "frontends/FontMetrics.h"
35 #include "frontends/Painter.h"
37 #include "insets/InsetText.h"
39 #include "mathed/InsetMath.h"
41 #include "support/debug.h"
42 #include "support/gettext.h"
43 #include "support/textutils.h"
45 #include "support/lassert.h"
46 #include <boost/crc.hpp>
52 using frontend::Painter;
53 using frontend::FontMetrics;
56 RowPainter::RowPainter(PainterInfo & pi,
57 Text const & text, pit_type pit, Row const & row, int x, int y)
58 : pi_(pi), text_(text),
59 text_metrics_(pi_.base.bv->textMetrics(&text)),
60 pars_(text.paragraphs()),
61 row_(row), pit_(pit), par_(text.paragraphs()[pit]),
62 pm_(text_metrics_.parMetrics(pit)), change_(pi_.change_),
63 xo_(x), yo_(y), width_(text_metrics_.width()),
64 solid_line_thickness_(1), solid_line_offset_(1),
65 dotted_line_thickness_(1)
67 if (lyxrc.zoom >= 200) {
68 // derive the line thickness from zoom factor
69 // the zoom is given in percent
70 // (increase thickness at 250%, 450% etc.)
71 solid_line_thickness_ = (lyxrc.zoom + 50) / 200;
72 // adjust line_offset_ too
73 solid_line_offset_ = 1 + solid_line_thickness_ / 2;
75 if (lyxrc.zoom >= 100) {
76 // derive the line thickness from zoom factor
77 // the zoom is given in percent
78 // (increase thickness at 150%, 250% etc.)
79 dotted_line_thickness_ = (lyxrc.zoom + 50) / 100;
82 x_ = row_.left_margin + xo_;
84 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
88 LBUFERR(pit < int(text.paragraphs().size()));
92 FontInfo RowPainter::labelFont() const
94 FontInfo f = text_.labelFont(par_);
96 if (row_.begin_margin_sel || pi_.selected)
97 f.setPaintColor(Color_selectiontext);
102 // If you want to debug inset metrics uncomment the following line:
103 //#define DEBUG_METRICS
104 // This draws green lines around each inset.
107 void RowPainter::paintInset(Row::Element const & e)
110 bool const pi_selected = pi_.selected;
111 Cursor const & cur = pi_.base.bv->cursor();
112 if (cur.selection() && cur.text() == &text_
113 && cur.normalAnchor().text() == &text_)
114 pi_.selected = row_.sel_beg <= e.pos && row_.sel_end > e.pos;
116 LASSERT(e.inset, return);
117 // Backup full_repaint status because some insets (InsetTabular)
118 // requires a full repaint
119 bool const pi_full_repaint = pi_.full_repaint;
120 bool const pi_do_spellcheck = pi_.do_spellcheck;
121 Change const pi_change = pi_.change_;
123 pi_.base.font = e.inset->inheritFont() ? e.font.fontInfo() :
124 pi_.base.bv->buffer().params().getFont().fontInfo();
125 pi_.ltr_pos = !e.font.isVisibleRightToLeft();
126 pi_.change_ = change_.changed() ? change_ : e.change;
127 pi_.do_spellcheck &= e.inset->allowSpellCheck();
129 int const x1 = int(x_);
130 pi_.base.bv->coordCache().insets().add(e.inset, x1, yo_);
131 // insets are painted completely. Recursive
132 // FIXME: it is wrong to completely paint the background
133 // if we want to do single row painting.
134 e.inset->drawBackground(pi_, x1, yo_);
135 e.inset->drawSelection(pi_, x1, yo_);
136 e.inset->draw(pi_, x1, yo_);
138 Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
140 paintForeignMark(x_, e.font.language(), dim.descent());
144 // Restore full_repaint status.
145 pi_.full_repaint = pi_full_repaint;
146 pi_.change_ = pi_change;
147 pi_.do_spellcheck = pi_do_spellcheck;
148 pi_.selected = pi_selected;
151 int const x2 = x1 + dim.wid;
152 int const y1 = yo_ + dim.des;
153 int const y2 = yo_ - dim.asc;
154 pi_.pain.line(x1, y1, x1, y2, Color_green);
155 pi_.pain.line(x1, y1, x2, y1, Color_green);
156 pi_.pain.line(x2, y1, x2, y2, Color_green);
157 pi_.pain.line(x1, y2, x2, y2, Color_green);
162 void RowPainter::paintForeignMark(double orig_x, Language const * lang, int desc) const
164 if (!lyxrc.mark_foreign_language)
166 if (lang == latex_language)
168 if (lang == pi_.base.bv->buffer().params().language)
171 int const y = yo_ + solid_line_offset_ + desc + solid_line_thickness_ / 2;
172 pi_.pain.line(int(orig_x), y, int(x_), y, Color_language,
173 Painter::line_solid, solid_line_thickness_);
177 void RowPainter::paintMisspelledMark(double const orig_x,
178 Row::Element const & e) const
180 // if changed the misspelled marker gets placed slightly lower than normal
181 // to avoid drawing at the same vertical offset
182 FontMetrics const & fm = theFontMetrics(e.font);
183 int const thickness = max(fm.lineWidth(), 2);
184 int const y = yo_ + solid_line_offset_ + solid_line_thickness_
185 + (e.change.changed() ? solid_line_thickness_ + 1 : 0)
188 //FIXME: this could be computed only once, it is probably not costly.
189 // check for cursor position
190 // don't draw misspelled marker for words at cursor position
191 // we don't want to disturb the process of text editing
192 DocIterator const nw = pi_.base.bv->cursor().newWord();
194 if (!nw.empty() && par_.id() == nw.paragraph().id()) {
196 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
198 else if (cpos > 0 && par_.isWordSeparator(cpos))
202 pos_type pos = e.pos;
203 while (pos < e.pos + pos_type(e.str.length())) {
204 if (!par_.isMisspelled(pos)) {
209 FontSpan const & range = par_.getSpellRange(pos);
211 // Skip element which are being edited
212 if (range.contains(cpos)) {
213 // the range includes the last element
214 pos = range.last + 1;
218 FontMetrics const & fm = theFontMetrics(e.font);
219 int x1 = fm.pos2x(e.str, range.first - e.pos,
221 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
222 pos_type(e.str.length())),
227 pi_.pain.line(int(orig_x) + x1, y, int(orig_x) + x2, y,
229 Painter::line_onoffdash, thickness);
230 pos = range.last + 1;
235 void RowPainter::paintStringAndSel(Row::Element const & e)
237 // at least part of text selected?
238 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
240 // all the text selected?
241 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
244 if (all_sel || e.change.changed()) {
246 Color const col = e.change.changed() ? e.change.color()
247 : Color_selectiontext;
248 copy.fontInfo().setPaintColor(col);
249 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra);
250 } else if (!some_sel) {
251 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra);
253 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
254 max(row_.sel_beg, e.pos) - e.pos,
255 min(row_.sel_end, e.endpos) - e.pos, e.extra);
257 x_ += e.full_width();
261 void RowPainter::paintChange(double orig_x, Font const & font,
262 Change const & change) const
264 if (!change.changed())
266 // Calculate 1/3 height of font
267 FontMetrics const & fm = theFontMetrics(font);
268 int const y_bar = change.deleted() ? yo_ - fm.maxAscent() / 3
269 : yo_ + 2 * solid_line_offset_ + solid_line_thickness_;
270 pi_.pain.line(int(orig_x), y_bar, int(x_), y_bar,
271 change.color(), Painter::line_solid, solid_line_thickness_);
275 void RowPainter::paintChangeBar() const
277 pos_type const start = row_.pos();
278 pos_type end = row_.endpos();
280 if (par_.size() == end) {
281 // this is the last row of the paragraph;
282 // thus, we must also consider the imaginary end-of-par character
286 if (start == end || !par_.isChanged(start, end))
289 int const height = text_metrics_.isLastRow(pit_, row_)
293 pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, 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(width_ - 2, y, width_ - 2, yo_ + row_.height(), Color_appendix);
313 void RowPainter::paintDepthBar() const
315 depth_type const depth = par_.getDepth();
320 depth_type prev_depth = 0;
321 if (!text_metrics_.isFirstRow(pit_, row_)) {
322 pit_type pit2 = pit_;
325 prev_depth = pars_[pit2].getDepth();
328 depth_type next_depth = 0;
329 if (!text_metrics_.isLastRow(pit_, row_)) {
330 pit_type pit2 = pit_;
331 if (row_.endpos() >= pars_[pit2].size())
333 next_depth = pars_[pit2].getDepth();
336 for (depth_type i = 1; i <= depth; ++i) {
337 int const w = nestMargin() / 5;
338 int x = int(xo_) + w * i;
339 // only consider the changebar space if we're drawing outermost text
340 if (text_.isMainText())
341 x += changebarMargin();
343 int const starty = yo_ - row_.ascent();
344 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
346 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
349 pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
351 pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
356 void RowPainter::paintAppendixStart(int y) const
358 FontInfo pb_font = sane_font;
359 pb_font.setColor(Color_appendix);
366 docstring const label = _("Appendix");
367 theFontMetrics(pb_font).rectText(label, w, a, d);
369 int const text_start = int(xo_ + (width_ - w) / 2);
370 int const text_end = text_start + w;
372 pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
374 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
375 pi_.pain.line(text_end, y, int(xo_ + width_ - 2), y, Color_appendix);
379 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
382 pi_.pain.line(dotted_line_thickness_, yo_ - row_.ascent(),
383 dotted_line_thickness_, yo_ + row_.descent(),
385 Painter::line_onoffdash, dotted_line_thickness_);
387 int const wwidth = pi_.base.bv->workWidth() - dotted_line_thickness_;
388 pi_.pain.line(wwidth, yo_ - row_.ascent(),
389 wwidth, yo_ + row_.descent(),
391 Painter::line_onoffdash, dotted_line_thickness_);
396 void RowPainter::paintFirst() const
398 Layout const & layout = par_.layout();
400 // start of appendix?
401 if (par_.params().startOfAppendix())
402 paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
404 bool const is_first =
405 text_.isFirstInSequence(pit_) || !layout.isParagraphGroup();
406 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
408 if (layout.labelIsInline()
409 && (layout.labeltype != LABEL_STATIC || is_first))
411 else if (is_first && layout.labelIsAbove())
412 paintTopLevelLabel();
416 void RowPainter::paintLabel() const
418 docstring const str = par_.labelString();
422 bool const is_rtl = text_.isRTL(par_);
423 Layout const & layout = par_.layout();
424 FontInfo const font = labelFont();
425 FontMetrics const & fm = theFontMetrics(font);
429 x = width_ - row_.right_margin + fm.width(layout.labelsep);
431 x = x_ - fm.width(layout.labelsep) - fm.width(str);
433 pi_.pain.text(int(x), yo_, str, font);
437 void RowPainter::paintTopLevelLabel() const
439 BufferParams const & bparams = pi_.base.bv->buffer().params();
440 bool const is_rtl = text_.isRTL(par_);
441 ParagraphParameters const & pparams = par_.params();
442 Layout const & layout = par_.layout();
443 FontInfo const font = labelFont();
444 docstring const str = par_.labelString();
448 double spacing_val = 1.0;
449 if (!pparams.spacing().isDefault())
450 spacing_val = pparams.spacing().getValue();
452 spacing_val = bparams.spacing().getValue();
454 FontMetrics const & fm = theFontMetrics(font);
456 int const labeladdon = int(fm.maxHeight()
457 * layout.spacing.getValue() * spacing_val);
460 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
461 + (layout.labelbottomsep * defaultRowHeight()));
464 if (layout.labeltype == LABEL_CENTERED) {
465 x = row_.left_margin + (width_ - row_.left_margin - row_.right_margin) / 2;
466 x -= fm.width(str) / 2;
468 x = width_ - row_.right_margin - fm.width(str);
470 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
474 /** Check if the current paragraph is the last paragraph in a
476 static int getEndLabel(pit_type p, Text const & text)
478 ParagraphList const & pars = text.paragraphs();
480 depth_type par_depth = pars[p].getDepth();
481 while (pit != pit_type(pars.size())) {
482 Layout const & layout = pars[pit].layout();
483 int const endlabeltype = layout.endlabeltype;
485 if (endlabeltype != END_LABEL_NO_LABEL) {
486 if (p + 1 == pit_type(pars.size()))
489 depth_type const next_depth =
490 pars[p + 1].getDepth();
491 if (par_depth > next_depth ||
492 (par_depth == next_depth && layout != pars[p + 1].layout()))
498 pit = text.outerHook(pit);
499 if (pit != pit_type(pars.size()))
500 par_depth = pars[pit].getDepth();
502 return END_LABEL_NO_LABEL;
506 void RowPainter::paintLast()
508 bool const is_rtl = text_.isRTL(par_);
509 int const endlabel = getEndLabel(pit_, text_);
511 // paint imaginary end-of-paragraph character
513 Change const & change = par_.lookupChange(par_.size());
514 if (change.changed()) {
515 FontMetrics const & fm =
516 theFontMetrics(pi_.base.bv->buffer().params().getFont());
517 int const length = fm.maxAscent() / 2;
518 Color col = change.color();
520 pi_.pain.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
521 Painter::line_solid, 3);
523 if (change.deleted()) {
524 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1 + length,
525 yo_ + 2, col, Painter::line_solid, 3);
527 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1,
528 yo_ + 2, col, Painter::line_solid, 3);
536 case END_LABEL_FILLED_BOX: {
537 FontInfo const font = labelFont();
538 FontMetrics const & fm = theFontMetrics(font);
539 int const size = int(0.75 * fm.maxAscent());
540 int const y = yo_ - size;
541 int const max_row_width = width_ - size - Inset::TEXT_TO_INSET_OFFSET;
542 int x = is_rtl ? nestMargin() + changebarMargin()
543 : max_row_width - row_.right_margin;
545 // If needed, move the box a bit to avoid overlapping with text.
546 int const rem = max_row_width - row_.width();
548 x += is_rtl ? rem : - rem;
550 if (endlabel == END_LABEL_BOX)
551 pi_.pain.rectangle(x, y, size, size, Color_eolmarker);
553 pi_.pain.fillRectangle(x, y, size, size, Color_eolmarker);
557 case END_LABEL_STATIC: {
558 FontInfo const font = labelFont();
559 FontMetrics const & fm = theFontMetrics(font);
560 docstring const & str = par_.layout().endlabelstring();
561 double const x = is_rtl ? x_ - fm.width(str) : x_;
562 pi_.pain.text(int(x), yo_, str, font);
566 case END_LABEL_NO_LABEL:
572 void RowPainter::paintOnlyInsets()
574 Row::const_iterator cit = row_.begin();
575 Row::const_iterator const & end = row_.end();
576 for ( ; cit != end ; ++cit) {
577 Row::Element const & e = *cit;
578 if (e.type == Row::INSET) {
579 // If outer row has changed, nested insets are repainted completely.
580 pi_.base.bv->coordCache().insets().add(e.inset, int(x_), yo_);
581 bool const nested_inset =
582 (e.inset->asInsetMath() && !e.inset->asInsetMath()->asMacroTemplate())
583 || e.inset->asInsetText() || e.inset->asInsetTabular();
585 x_ += e.full_width();
590 x_ += e.full_width();
595 void RowPainter::paintText()
597 Row::const_iterator cit = row_.begin();
598 Row::const_iterator const & end = row_.end();
599 for ( ; cit != end ; ++cit) {
600 double const orig_x = x_;
601 Row::Element const & e = *cit;
602 int foreign_descent = 0;
607 paintStringAndSel(e);
609 // Paint the spelling marks if enabled.
610 if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && pi_.pain.isDrawingEnabled())
611 paintMisspelledMark(orig_x, e);
614 // If outer row has changed, nested insets are repaint completely.
615 pi_.base.bv->coordCache().insets().add(e.inset, int(x_), yo_);
617 foreign_descent = e.dim.descent();
621 pi_.pain.textDecoration(e.font.fontInfo(), int(x_), yo_, int(e.full_width()));
622 x_ += e.full_width();
625 // The line that indicates word in a different language
626 paintForeignMark(orig_x, e.font.language(), foreign_descent);
628 // change tracking (not for insets that track their own changes)
629 if (e.type != Row::INSET || ! e.inset->canTrackChanges())
630 paintChange(orig_x, e.font, e.change);
635 void RowPainter::paintSelection() const
637 if (!row_.selection())
639 Cursor const & curs = pi_.base.bv->cursor();
640 DocIterator beg = curs.selectionBegin();
642 beg.pos() = row_.sel_beg;
644 DocIterator end = curs.selectionEnd();
646 end.pos() = row_.sel_end;
648 bool const begin_boundary = beg.pos() >= row_.endpos();
649 bool const end_boundary = row_.sel_end == row_.endpos();
651 DocIterator cur = beg;
652 cur.boundary(begin_boundary);
653 int x1 = text_metrics_.cursorX(beg.top(), begin_boundary);
654 int x2 = text_metrics_.cursorX(end.top(), end_boundary);
655 int const y1 = yo_ - row_.ascent();
656 int const y2 = y1 + row_.height();
658 int const rm = text_.isMainText() ? pi_.base.bv->rightMargin() : 0;
659 int const lm = text_.isMainText() ? pi_.base.bv->leftMargin() : 0;
662 if (row_.begin_margin_sel) {
663 if (text_.isRTL(beg.paragraph())) {
664 pi_.pain.fillRectangle(int(xo_ + x1), y1,
665 text_metrics_.width() - rm - x1, y2 - y1, Color_selection);
667 pi_.pain.fillRectangle(int(xo_ + lm), y1, x1 - lm, y2 - y1,
672 if (row_.end_margin_sel) {
673 if (text_.isRTL(beg.paragraph())) {
674 pi_.pain.fillRectangle(int(xo_ + lm), y1, x2 - lm, y2 - y1,
677 pi_.pain.fillRectangle(int(xo_ + x2), y1, text_metrics_.width() - rm - x2,
678 y2 - y1, Color_selection);
682 // if we are on a boundary from the beginning, it's probably
683 // a RTL boundary and we jump to the other side directly as this
684 // segement is 0-size and confuses the logic below
688 // go through row and draw from RTL boundary to RTL boundary
690 bool draw_now = false;
692 // simplified cursorForward code below which does not
693 // descend into insets and which does not go into the
694 // next line. Compare the logic with the original cursorForward
696 // if left of boundary -> just jump to right side, but
697 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
698 if (cur.boundary()) {
700 } else if (text_metrics_.isRTLBoundary(cur.pit(), cur.pos() + 1)) {
701 // in front of RTL boundary -> Stay on this side of the boundary
702 // because: ab|cDDEEFFghi -> abc|DDEEFFghi
711 if (cur.pos() == row_.endpos())
716 // the previous segment was just drawn, now the next starts
717 x1 = text_metrics_.cursorX(cur.top(), cur.boundary());
720 if (!(cur < end) || draw_now) {
721 x2 = text_metrics_.cursorX(cur.top(), cur.boundary());
722 pi_.pain.fillRectangle(int(xo_ + min(x1, x2)), y1, abs(x2 - x1),
723 y2 - y1, Color_selection);
725 // reset x1, so it is set again next round (which will be on the
726 // right side of a boundary or at the selection end)