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"
18 #include "CoordCache.h"
21 #include "BufferParams.h"
22 #include "BufferView.h"
29 #include "MetricsInfo.h"
30 #include "Paragraph.h"
31 #include "ParagraphMetrics.h"
32 #include "paragraph_funcs.h"
33 #include "ParagraphParameters.h"
34 #include "TextMetrics.h"
37 #include "frontends/FontMetrics.h"
38 #include "frontends/Painter.h"
40 #include "insets/InsetText.h"
42 #include "support/textutils.h"
44 #include <boost/crc.hpp>
53 using frontend::Painter;
54 using frontend::FontMetrics;
56 RowPainter::RowPainter(PainterInfo & pi,
57 Text const & text, pit_type pit, Row const & row, Bidi & bidi, 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)),
63 bidi_(bidi), erased_(pi_.erased_),
64 xo_(x), yo_(y), width_(text_metrics_.width())
66 bidi_.computeTables(par_, pi_.base.bv->buffer(), row_);
69 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
72 BOOST_ASSERT(pit >= 0);
73 BOOST_ASSERT(pit < int(text.paragraphs().size()));
77 Font const RowPainter::getLabelFont() const
79 return text_.getLabelFont(pi_.base.bv->buffer(), par_);
83 int RowPainter::leftMargin() const
85 return text_metrics_.leftMargin(text_metrics_.width(), pit_,
90 void RowPainter::paintHfill(pos_type const pos, pos_type const body_pos)
95 int const y1 = y0 - defaultRowHeight() / 2;
97 pi_.pain.line(int(x_), y1, int(x_), y0, Color::added_space);
99 if (pm_.hfillExpansion(row_, pos)) {
100 int const y2 = (y0 + y1) / 2;
102 if (pos >= body_pos) {
103 pi_.pain.line(int(x_), y2, int(x_ + row_.hfill), y2,
105 Painter::line_onoffdash);
108 pi_.pain.line(int(x_), y2, int(x_ + row_.label_hfill), y2,
110 Painter::line_onoffdash);
111 x_ += row_.label_hfill;
113 pi_.pain.line(int(x_), y1, int(x_), y0, Color::added_space);
119 // If you want to debug inset metrics uncomment the following line:
120 //#define DEBUG_METRICS
121 // This draws green lines around each inset.
124 void RowPainter::paintInset(Inset const * inset, pos_type const pos)
126 Font font = text_metrics_.getDisplayFont(pit_, pos);
129 // FIXME: We should always use font, see documentation of
130 // noFontChange() in Inset.h.
131 pi_.base.font = inset->noFontChange() ?
132 pi_.base.bv->buffer().params().getFont() :
134 pi_.ltr_pos = (bidi_.level(pos) % 2 == 0);
135 pi_.erased_ = erased_ || par_.isDeleted(pos);
136 pi_.base.bv->coordCache().insets().add(inset, int(x_), yo_);
137 // insets are painted completely. Recursive
138 inset->drawSelection(pi_, int(x_), yo_);
139 inset->draw(pi_, int(x_), yo_);
141 paintForeignMark(x_, font, inset->descent());
143 x_ += inset->width();
146 int const x1 = int(x_ - inset->width());
148 BOOST_ASSERT(max_witdh_ > 0);
149 int right_margin = text_metrics_.rightMargin(pm_);
150 int const w = max_witdh_ - leftMargin() - right_margin;
151 MetricsInfo mi(pi_.base.bv, font, w);
152 inset->metrics(mi, dim);
153 if (inset->width() > dim.wid)
154 lyxerr << "Error: inset " << to_ascii(inset->getInsetName())
155 << " draw width " << inset->width()
156 << "> metrics width " << dim.wid << "." << std::endl;
157 if (inset->ascent() > dim.asc)
158 lyxerr << "Error: inset " << to_ascii(inset->getInsetName())
159 << " draw ascent " << inset->ascent()
160 << "> metrics ascent " << dim.asc << "." << std::endl;
161 if (inset->descent() > dim.des)
162 lyxerr << "Error: inset " << to_ascii(inset->getInsetName())
163 << " draw ascent " << inset->descent()
164 << "> metrics descent " << dim.des << "." << std::endl;
165 BOOST_ASSERT(inset->width() <= dim.wid);
166 BOOST_ASSERT(inset->ascent() <= dim.asc);
167 BOOST_ASSERT(inset->descent() <= dim.des);
168 int const x2 = x1 + dim.wid;
169 int const y1 = yo_ + dim.des;
170 int const y2 = yo_ - dim.asc;
171 pi_.pain.line(x1, y1, x1, y2, Color::green);
172 pi_.pain.line(x1, y1, x2, y1, Color::green);
173 pi_.pain.line(x2, y1, x2, y2, Color::green);
174 pi_.pain.line(x1, y2, x2, y2, Color::green);
179 void RowPainter::paintHebrewComposeChar(pos_type & vpos, Font const & font)
181 pos_type pos = bidi_.vis2log(vpos);
186 char_type c = par_.getChar(pos);
190 int const width = theFontMetrics(font).width(c);
193 for (pos_type i = pos - 1; i >= 0; --i) {
195 if (!Encodings::isComposeChar_hebrew(c)) {
196 if (isPrintableNonspace(c)) {
197 int const width2 = pm_.singleWidth(i,
198 text_metrics_.getDisplayFont(pit_, i));
199 dx = (c == 0x05e8 || // resh
200 c == 0x05d3) // dalet
202 : (width2 - width) / 2;
209 pi_.pain.text(int(x_) + dx, yo_, str, font);
213 void RowPainter::paintArabicComposeChar(pos_type & vpos, Font const & font)
215 pos_type pos = bidi_.vis2log(vpos);
219 char_type c = par_.getChar(pos);
220 c = par_.transformChar(c, pos);
224 int const width = theFontMetrics(font).width(c);
227 for (pos_type i = pos - 1; i >= 0; --i) {
229 if (!Encodings::isComposeChar_arabic(c)) {
230 if (isPrintableNonspace(c)) {
231 int const width2 = pm_.singleWidth(i,
232 text_metrics_.getDisplayFont(pit_, i));
233 dx = (width2 - width) / 2;
239 pi_.pain.text(int(x_) + dx, yo_, str, font);
243 void RowPainter::paintChars(pos_type & vpos, Font const & font,
244 bool hebrew, bool arabic)
246 // This method takes up 70% of time when typing
247 pos_type pos = bidi_.vis2log(vpos);
248 pos_type const end = row_.endpos();
249 FontSpan const font_span = par_.fontSpan(pos);
250 Change::Type const prev_change = par_.lookupChange(pos).type;
253 std::vector<char_type> str;
255 str.push_back(par_.getChar(pos));
258 char_type c = str[0];
263 str[0] = par_.transformChar(c, pos);
266 // collect as much similar chars as we can
267 for (++vpos ; vpos < end ; ++vpos) {
268 pos = bidi_.vis2log(vpos);
269 if (pos < font_span.first || pos > font_span.last)
272 if (prev_change != par_.lookupChange(pos).type)
275 char_type c = par_.getChar(pos);
277 if (!isPrintableNonspace(c))
280 /* Because we do our own bidi, at this point the strings are
281 * already in visual order. However, Qt also applies its own
282 * bidi algorithm to strings that it paints to the screen.
283 * Therefore, if we were to paint Hebrew/Arabic words as a
284 * single string, the letters in the words would get reversed
285 * again. In order to avoid that, we don't collect Hebrew/
286 * Arabic characters, but rather paint them one at a time.
287 * See also http://thread.gmane.org/gmane.editors.lyx.devel/79740
292 /* FIXME: these checks are irrelevant, since 'arabic' and
293 * 'hebrew' alone are already going to trigger a break.
294 * However, this should not be removed completely, because
295 * if an alternative solution is found which allows grouping
296 * of arabic and hebrew characters, then these breaks may have
299 if (arabic && Encodings::isComposeChar_arabic(c))
302 if (hebrew && Encodings::isComposeChar_hebrew(c))
311 c = par_.transformChar(c, pos);
312 /* see comment in hebrew, explaining why we break */
319 docstring s(&str[0], str.size());
321 if (prev_change != Change::UNCHANGED) {
323 if (prev_change == Change::DELETED) {
324 copy.setColor(Color::deletedtext);
325 } else if (prev_change == Change::INSERTED) {
326 copy.setColor(Color::addedtext);
328 x_ += pi_.pain.text(int(x_), yo_, s, copy);
330 x_ += pi_.pain.text(int(x_), yo_, s, font);
335 void RowPainter::paintForeignMark(double orig_x, Font const & font, int desc)
337 if (!lyxrc.mark_foreign_language)
339 if (font.language() == latex_language)
341 if (font.language() == pi_.base.bv->buffer().params().language)
344 int const y = yo_ + 1 + desc;
345 pi_.pain.line(int(orig_x), y, int(x_), y, Color::language);
349 void RowPainter::paintFromPos(pos_type & vpos)
351 pos_type const pos = bidi_.vis2log(vpos);
352 Font orig_font = text_metrics_.getDisplayFont(pit_, pos);
353 double const orig_x = x_;
355 // usual characters, no insets
356 char_type const c = par_.getChar(pos);
358 // special case languages
359 std::string const & lang = orig_font.language()->lang();
360 bool const hebrew = lang == "hebrew";
361 bool const arabic = lang == "arabic_arabtex" || lang == "arabic_arabi" ||
364 // draw as many chars as we can
365 if ((!hebrew && !arabic)
366 || (hebrew && !Encodings::isComposeChar_hebrew(c))
367 || (arabic && !Encodings::isComposeChar_arabic(c))) {
368 paintChars(vpos, orig_font, hebrew, arabic);
370 paintHebrewComposeChar(vpos, orig_font);
372 paintArabicComposeChar(vpos, orig_font);
375 paintForeignMark(orig_x, orig_font);
379 void RowPainter::paintChangeBar()
381 pos_type const start = row_.pos();
382 pos_type end = row_.endpos();
384 if (par_.size() == end) {
385 // this is the last row of the paragraph;
386 // thus, we must also consider the imaginary end-of-par character
390 if (start == end || !par_.isChanged(start, end))
393 int const height = text_metrics_.isLastRow(pit_, row_)
397 pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, height, Color::changebar);
401 void RowPainter::paintAppendix()
403 // only draw the appendix frame once (for the main text)
404 if (!par_.params().appendix() || !text_.isMainText(pi_.base.bv->buffer()))
407 int y = yo_ - row_.ascent();
409 if (par_.params().startOfAppendix())
410 y += 2 * defaultRowHeight();
412 pi_.pain.line(1, y, 1, yo_ + row_.height(), Color::appendix);
413 pi_.pain.line(width_ - 2, y, width_ - 2, yo_ + row_.height(), Color::appendix);
417 void RowPainter::paintDepthBar()
419 depth_type const depth = par_.getDepth();
424 depth_type prev_depth = 0;
425 if (!text_metrics_.isFirstRow(pit_, row_)) {
426 pit_type pit2 = pit_;
429 prev_depth = pars_[pit2].getDepth();
432 depth_type next_depth = 0;
433 if (!text_metrics_.isLastRow(pit_, row_)) {
434 pit_type pit2 = pit_;
435 if (row_.endpos() >= pars_[pit2].size())
437 next_depth = pars_[pit2].getDepth();
440 for (depth_type i = 1; i <= depth; ++i) {
441 int const w = nestMargin() / 5;
442 int x = int(xo_) + w * i;
443 // only consider the changebar space if we're drawing outermost text
444 if (text_.isMainText(pi_.base.bv->buffer()))
445 x += changebarMargin();
447 int const starty = yo_ - row_.ascent();
448 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
450 pi_.pain.line(x, starty, x, starty + h, Color::depthbar);
453 pi_.pain.fillRectangle(x, starty, w, 2, Color::depthbar);
455 pi_.pain.fillRectangle(x, starty + h, w, 2, Color::depthbar);
460 int RowPainter::paintAppendixStart(int y)
463 pb_font.setColor(Color::appendix);
470 docstring const label = _("Appendix");
471 theFontMetrics(pb_font).rectText(label, w, a, d);
473 int const text_start = int(xo_ + (width_ - w) / 2);
474 int const text_end = text_start + w;
476 pi_.pain.rectText(text_start, y + d, label, pb_font, Color::none, Color::none);
478 pi_.pain.line(int(xo_ + 1), y, text_start, y, Color::appendix);
479 pi_.pain.line(text_end, y, int(xo_ + width_ - 2), y, Color::appendix);
481 return 3 * defaultRowHeight();
485 void RowPainter::paintFirst()
487 ParagraphParameters const & parparams = par_.params();
491 // start of appendix?
492 if (parparams.startOfAppendix())
493 y_top += paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
495 Buffer const & buffer = pi_.base.bv->buffer();
497 LayoutPtr const & layout = par_.layout();
499 if (buffer.params().paragraph_separation == BufferParams::PARSEP_SKIP) {
501 if (layout->latextype == LATEX_PARAGRAPH
502 && !par_.getDepth()) {
503 y_top += buffer.params().getDefSkip().inPixels(*pi_.base.bv);
505 LayoutPtr const & playout = pars_[pit_ - 1].layout();
506 if (playout->latextype == LATEX_PARAGRAPH
507 && !pars_[pit_ - 1].getDepth()) {
508 // is it right to use defskip here, too? (AS)
509 y_top += buffer.params().getDefSkip().inPixels(*pi_.base.bv);
515 bool const is_rtl = text_.isRTL(buffer, par_);
516 bool const is_seq = isFirstInSequence(pit_, text_.paragraphs());
517 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << std::endl;
519 // should we print a label?
520 if (layout->labeltype >= LABEL_STATIC
521 && (layout->labeltype != LABEL_STATIC
522 || layout->latextype != LATEX_ENVIRONMENT
525 Font const font = getLabelFont();
526 FontMetrics const & fm = theFontMetrics(font);
528 docstring const str = par_.getLabelstring();
532 // this is special code for the chapter layout. This is
533 // printed in an extra row and has a pagebreak at
535 if (layout->counter == "chapter") {
536 double spacing_val = 1.0;
537 if (!parparams.spacing().isDefault()) {
538 spacing_val = parparams.spacing().getValue();
540 spacing_val = buffer.params().spacing().getValue();
543 int const labeladdon = int(fm.maxHeight() * layout->spacing.getValue() * spacing_val);
545 int const maxdesc = int(fm.maxDescent() * layout->spacing.getValue() * spacing_val)
546 + int(layout->parsep) * defaultRowHeight();
549 x = width_ - leftMargin() -
553 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
556 x = width_ - leftMargin()
557 + fm.width(layout->labelsep);
559 x = x_ - fm.width(layout->labelsep)
563 pi_.pain.text(int(x), yo_, str, font);
567 // the labels at the top of an environment.
568 // More or less for bibliography
570 (layout->labeltype == LABEL_TOP_ENVIRONMENT ||
571 layout->labeltype == LABEL_BIBLIO ||
572 layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)) {
573 Font font = getLabelFont();
574 if (!par_.getLabelstring().empty()) {
575 docstring const str = par_.getLabelstring();
576 double spacing_val = 1.0;
577 if (!parparams.spacing().isDefault())
578 spacing_val = parparams.spacing().getValue();
580 spacing_val = buffer.params().spacing().getValue();
582 FontMetrics const & fm = theFontMetrics(font);
584 int const labeladdon = int(fm.maxHeight()
585 * layout->spacing.getValue() * spacing_val);
588 int(fm.maxDescent() * layout->spacing.getValue() * spacing_val
589 + (layout->labelbottomsep * defaultRowHeight()));
592 if (layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT) {
595 x += (width_ - text_metrics_.rightMargin(pm_) - leftMargin()) / 2;
596 x -= fm.width(str) / 2;
598 x = width_ - leftMargin() - fm.width(str);
600 pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
606 void RowPainter::paintLast()
608 bool const is_rtl = text_.isRTL(pi_.base.bv->buffer(), par_);
609 int const endlabel = getEndLabel(pit_, text_.paragraphs());
611 // paint imaginary end-of-paragraph character
613 if (par_.isInserted(par_.size()) || par_.isDeleted(par_.size())) {
614 FontMetrics const & fm = theFontMetrics(pi_.base.bv->buffer().params().getFont());
615 int const length = fm.maxAscent() / 2;
616 Color::color col = par_.isInserted(par_.size()) ? Color::addedtext : Color::deletedtext;
618 pi_.pain.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
619 Painter::line_solid, Painter::line_thick);
620 pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1, yo_ + 2, col,
621 Painter::line_solid, Painter::line_thick);
628 case END_LABEL_FILLED_BOX: {
629 Font const font = getLabelFont();
630 FontMetrics const & fm = theFontMetrics(font);
631 int const size = int(0.75 * fm.maxAscent());
632 int const y = yo_ - size;
633 int x = is_rtl ? nestMargin() + changebarMargin() : width_ - size;
635 if (width_ - int(row_.width()) <= size)
636 x += (size - width_ + row_.width() + 1) * (is_rtl ? -1 : 1);
638 if (endlabel == END_LABEL_BOX)
639 pi_.pain.rectangle(x, y, size, size, Color::eolmarker);
641 pi_.pain.fillRectangle(x, y, size, size, Color::eolmarker);
645 case END_LABEL_STATIC: {
646 Font font = getLabelFont();
647 FontMetrics const & fm = theFontMetrics(font);
648 docstring const & str = par_.layout()->endlabelstring();
649 double const x = is_rtl ?
651 : - text_metrics_.rightMargin(pm_) - row_.width();
652 pi_.pain.text(int(x), yo_, str, font);
656 case END_LABEL_NO_LABEL:
662 void RowPainter::paintOnlyInsets()
664 pos_type const end = row_.endpos();
665 for (pos_type pos = row_.pos(); pos != end; ++pos) {
666 if (!par_.isInset(pos))
669 // If outer row has changed, nested insets are repaint completely.
670 Inset const * inset = par_.getInset(pos);
672 if (x_ > pi_.base.bv->workWidth())
675 x_ = pi_.base.bv->coordCache().getInsets().x(inset);
676 paintInset(inset, pos);
681 void RowPainter::paintText()
683 pos_type const end = row_.endpos();
684 // Spaces at logical line breaks in bidi text must be skipped during
685 // painting. However, they may appear visually in the middle
686 // of a row; they must be skipped, wherever they are...
687 // * logically "abc_[HEBREW_\nHEBREW]"
688 // * visually "abc_[_WERBEH\nWERBEH]"
689 pos_type skipped_sep_vpos = -1;
690 pos_type body_pos = par_.beginOfBody();
692 (body_pos > end || !par_.isLineSeparator(body_pos - 1))) {
696 LayoutPtr const & layout = par_.layout();
698 bool running_strikeout = false;
699 bool is_struckout = false;
700 int last_strikeout_x = 0;
702 // Use font span to speed things up, see below
706 // If the last logical character is a separator, don't paint it, unless
707 // it's in the last row of a paragraph; see skipped_sep_vpos declaration
708 if (end > 0 && end < par_.size() && par_.isSeparator(end - 1))
709 skipped_sep_vpos = bidi_.log2vis(end - 1);
711 for (pos_type vpos = row_.pos(); vpos < end; ) {
712 if (x_ > pi_.base.bv->workWidth())
715 // Skip the separator at the logical end of the row
716 if (vpos == skipped_sep_vpos) {
721 pos_type const pos = bidi_.vis2log(vpos);
723 if (pos >= par_.size()) {
728 // Use font span to speed things up, see above
729 if (vpos < font_span.first || vpos > font_span.last) {
730 font_span = par_.fontSpan(vpos);
731 font = text_metrics_.getDisplayFont(pit_, vpos);
734 const int width_pos = pm_.singleWidth(pos, font);
736 if (x_ + width_pos < 0) {
742 is_struckout = par_.isDeleted(pos);
744 if (is_struckout && !running_strikeout) {
745 running_strikeout = true;
746 last_strikeout_x = int(x_);
749 bool const highly_editable_inset = par_.isInset(pos)
750 && isHighlyEditableInset(par_.getInset(pos));
752 // If we reach the end of a struck out range, paint it.
753 // We also don't paint across things like tables
754 if (running_strikeout && (highly_editable_inset || !is_struckout)) {
755 // Calculate 1/3 height of the buffer's default font
756 FontMetrics const & fm
757 = theFontMetrics(pi_.base.bv->buffer().params().getFont());
758 int const middle = yo_ - fm.maxAscent() / 3;
759 pi_.pain.line(last_strikeout_x, middle, int(x_), middle,
760 Color::deletedtext, Painter::line_solid, Painter::line_thin);
761 running_strikeout = false;
764 if (body_pos > 0 && pos == body_pos - 1) {
765 int const lwidth = theFontMetrics(getLabelFont())
766 .width(layout->labelsep);
768 x_ += row_.label_hfill + lwidth - width_pos;
771 if (par_.isHfill(pos)) {
772 paintHfill(pos, body_pos);
775 } else if (par_.isSeparator(pos)) {
776 Font orig_font = text_metrics_.getDisplayFont(pit_, pos);
777 double const orig_x = x_;
780 x_ += row_.separator;
781 paintForeignMark(orig_x, orig_font);
784 } else if (par_.isInset(pos)) {
785 // If outer row has changed, nested insets are repaint completely.
786 Inset const * inset = par_.getInset(pos);
787 pi_.base.bv->coordCache().insets().add(inset, int(x_), yo_);
788 paintInset(inset, pos);
792 // paint as many characters as possible.
797 // if we reach the end of a struck out range, paint it
798 if (running_strikeout) {
799 // calculate 1/3 height of the buffer's default font
800 FontMetrics const & fm
801 = theFontMetrics(pi_.base.bv->buffer().params().getFont());
802 int const middle = yo_ - fm.maxAscent() / 3;
803 pi_.pain.line(last_strikeout_x, middle, int(x_), middle,
804 Color::deletedtext, Painter::line_solid, Painter::line_thin);
805 running_strikeout = false;