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"
17 #include "coordcache.h"
20 #include "bufferparams.h"
21 #include "BufferView.h"
28 #include "lyxrow_funcs.h"
29 #include "metricsinfo.h"
30 #include "paragraph.h"
31 #include "paragraph_funcs.h"
32 #include "ParagraphParameters.h"
35 #include "frontends/font_metrics.h"
36 #include "frontends/nullpainter.h"
37 #include "frontends/Painter.h"
39 #include "insets/insettext.h"
41 #include "support/textutils.h"
55 * A class used for painting an individual row of text.
59 /// initialise and run painter
60 RowPainter(PainterInfo & pi, LyXText const & text,
61 pit_type pit, Row const & row, int x, int y);
63 // paint various parts
66 void paintChangeBar();
72 void paintForeignMark(double orig_x, LyXFont const & font);
73 void paintHebrewComposeChar(lyx::pos_type & vpos, LyXFont const & font);
74 void paintArabicComposeChar(lyx::pos_type & vpos, LyXFont const & font);
75 void paintChars(lyx::pos_type & vpos, LyXFont font,
76 bool hebrew, bool arabic);
77 int paintAppendixStart(int y);
78 void paintFromPos(lyx::pos_type & vpos);
79 void paintInset(lyx::pos_type const pos, LyXFont const & font);
81 /// return left margin
82 int leftMargin() const;
84 /// return the label font for this row
85 LyXFont const getLabelFont() const;
87 /// bufferview to paint on
88 BufferView const & bv_;
93 /// LyXText for the row
94 LyXText const & text_;
95 ParagraphList const & pars_;
102 Paragraph const & par_;
104 /// is row erased? (change tracking)
109 int const yo_; // current baseline
118 RowPainter::RowPainter(PainterInfo & pi,
119 LyXText const & text, pit_type pit, Row const & row, int x, int y)
120 : bv_(*pi.base.bv), pain_(pi.pain), text_(text), pars_(text.paragraphs()),
121 row_(row), pit_(pit), par_(text.paragraphs()[pit]),
123 xo_(x), yo_(y), width_(text_.width())
125 RowMetrics m = text_.computeRowMetrics(pit, row_);
128 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
131 separator_ = m.separator;
133 label_hfill_ = m.label_hfill;
135 BOOST_ASSERT(pit >= 0);
136 BOOST_ASSERT(pit < int(text.paragraphs().size()));
140 LyXFont const RowPainter::getLabelFont() const
142 return text_.getLabelFont(par_);
146 int RowPainter::leftMargin() const
148 return text_.leftMargin(pit_, row_.pos());
152 void RowPainter::paintInset(pos_type const pos, LyXFont const & font)
154 InsetBase const * inset = par_.getInset(pos);
156 PainterInfo pi(const_cast<BufferView *>(&bv_), pain_);
157 // FIXME: We should always use font, see documentation of
158 // noFontChange() in insetbase.h.
159 pi.base.font = inset->noFontChange() ?
160 bv_.buffer()->params().getLyXTextClass().defaultfont() :
162 pi.ltr_pos = (text_.bidi.level(pos) % 2 == 0);
163 pi.erased_ = erased_ || isDeletedText(par_, pos);
164 theCoords.insets().add(inset, int(x_), yo_);
165 inset->drawSelection(pi, int(x_), yo_);
166 inset->draw(pi, int(x_), yo_);
167 x_ += inset->width();
171 void RowPainter::paintHebrewComposeChar(pos_type & vpos, LyXFont const & font)
173 pos_type pos = text_.bidi.vis2log(vpos);
178 char c = par_.getChar(pos);
182 int const width = font_metrics::width(c, font);
185 for (pos_type i = pos - 1; i >= 0; --i) {
187 if (!Encodings::IsComposeChar_hebrew(c)) {
188 if (IsPrintableNonspace(c)) {
190 text_.singleWidth(par_, i, c, text_.getFont(par_, i));
192 dx = (c == 'ø' || c == 'ã')
194 : (width2 - width) / 2;
201 pain_.text(int(x_) + dx, yo_, str, font);
205 void RowPainter::paintArabicComposeChar(pos_type & vpos, LyXFont const & font)
207 pos_type pos = text_.bidi.vis2log(vpos);
211 char c = par_.getChar(pos);
212 c = par_.transformChar(c, pos);
216 int const width = font_metrics::width(c, font);
219 for (pos_type i = pos - 1; i >= 0; --i) {
221 if (!Encodings::IsComposeChar_arabic(c)) {
222 if (IsPrintableNonspace(c)) {
224 text_.singleWidth(par_, i, c, text_.getFont(par_, i));
225 dx = (width2 - width) / 2;
231 pain_.text(int(x_) + dx, yo_, str, font);
235 void RowPainter::paintChars(pos_type & vpos, LyXFont font,
236 bool hebrew, bool arabic)
238 pos_type pos = text_.bidi.vis2log(vpos);
239 pos_type const end = row_.endpos();
240 FontSpan const font_span = par_.fontSpan(pos);
241 Change::Type const prev_change = par_.lookupChange(pos);
245 str += par_.getChar(pos);
247 unsigned char c = str[0];
248 str[0] = par_.transformChar(c, pos);
251 // collect as much similar chars as we can
252 for (++vpos ; vpos < end ; ++vpos) {
253 pos = text_.bidi.vis2log(vpos);
254 if (pos < font_span.first || pos > font_span.last)
257 if (prev_change != par_.lookupChange(pos))
260 char c = par_.getChar(pos);
262 if (!IsPrintableNonspace(c))
265 if (arabic && Encodings::IsComposeChar_arabic(c))
268 if (hebrew && Encodings::IsComposeChar_hebrew(c))
272 c = par_.transformChar(c, pos);
277 if (prev_change == Change::DELETED)
278 font.setColor(LColor::strikeout);
279 else if (prev_change == Change::INSERTED)
280 font.setColor(LColor::newtext);
282 // Draw text and set the new x position
283 //lyxerr << "paint row: yo_ " << yo_ << "\n";
284 pain_.text(int(x_), yo_, str, font);
285 x_ += font_metrics::width(str, font);
289 void RowPainter::paintForeignMark(double orig_x, LyXFont const & font)
291 if (!lyxrc.mark_foreign_language)
293 if (font.language() == latex_language)
295 if (font.language() == bv_.buffer()->params().language)
298 int const y = yo_ + 1;
299 pain_.line(int(orig_x), y, int(x_), y, LColor::language);
303 void RowPainter::paintFromPos(pos_type & vpos)
305 pos_type const pos = text_.bidi.vis2log(vpos);
306 LyXFont orig_font = text_.getFont(par_, pos);
307 text_.applyOuterFont(orig_font);
309 double const orig_x = x_;
311 if (par_.isInset(pos)) {
312 paintInset(pos, orig_font);
314 paintForeignMark(orig_x, orig_font);
318 // usual characters, no insets
319 char const c = par_.getChar(pos);
321 // special case languages
322 std::string const & lang = orig_font.language()->lang();
323 bool const hebrew = lang == "hebrew";
324 bool const arabic = lang == "arabic" &&
325 (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
326 lyxrc.font_norm_type == LyXRC::ISO_10646_1);
328 // draw as many chars as we can
329 if ((!hebrew && !arabic)
330 || (hebrew && !Encodings::IsComposeChar_hebrew(c))
331 || (arabic && !Encodings::IsComposeChar_arabic(c))) {
332 paintChars(vpos, orig_font, hebrew, arabic);
334 paintHebrewComposeChar(vpos, orig_font);
336 paintArabicComposeChar(vpos, orig_font);
339 paintForeignMark(orig_x, orig_font);
343 void RowPainter::paintChangeBar()
345 pos_type const start = row_.pos();
346 pos_type const end = row_.endpos();
348 if (start == end || !par_.isChanged(start, end - 1))
351 int const height = text_.isLastRow(pit_, row_)
355 pain_.fillRectangle(4, yo_ - row_.ascent(), 5, height, LColor::changebar);
359 void RowPainter::paintAppendix()
361 if (!par_.params().appendix())
364 int y = yo_ - row_.ascent();
366 if (par_.params().startOfAppendix())
367 y += 2 * defaultRowHeight();
369 pain_.line(1, y, 1, yo_ + row_.height(), LColor::appendix);
370 pain_.line(width_ - 2, y, width_ - 2, yo_ + row_.height(), LColor::appendix);
374 void RowPainter::paintDepthBar()
376 Paragraph::depth_type const depth = par_.getDepth();
381 Paragraph::depth_type prev_depth = 0;
382 if (!text_.isFirstRow(pit_, row_)) {
383 pit_type pit2 = pit_;
386 prev_depth = pars_[pit2].getDepth();
389 Paragraph::depth_type next_depth = 0;
390 if (!text_.isLastRow(pit_, row_)) {
391 pit_type pit2 = pit_;
392 if (row_.endpos() >= pars_[pit2].size())
394 next_depth = pars_[pit2].getDepth();
397 for (Paragraph::depth_type i = 1; i <= depth; ++i) {
398 int const w = nestMargin() / 5;
399 int x = int(xo_) + w * i;
400 // only consider the changebar space if we're drawing outermost text
401 if (text_.isMainText())
402 x += changebarMargin();
404 int const starty = yo_ - row_.ascent();
405 int const h = row_.height() - 1 - (i - next_depth - 1) * 3;
407 pain_.line(x, starty, x, starty + h, LColor::depthbar);
410 pain_.fillRectangle(x, starty, w, 2, LColor::depthbar);
412 pain_.fillRectangle(x, starty + h, w, 2, LColor::depthbar);
417 int RowPainter::paintAppendixStart(int y)
420 pb_font.setColor(LColor::appendix);
423 string const label = _("Appendix");
427 font_metrics::rectText(label, pb_font, w, a, d);
429 int const text_start = int(xo_ + (width_ - w) / 2);
430 int const text_end = text_start + w;
432 pain_.rectText(text_start, y + d, label, pb_font, LColor::none, LColor::none);
434 pain_.line(int(xo_ + 1), y, text_start, y, LColor::appendix);
435 pain_.line(text_end, y, int(xo_ + width_ - 2), y, LColor::appendix);
437 return 3 * defaultRowHeight();
441 void RowPainter::paintFirst()
443 ParagraphParameters const & parparams = par_.params();
447 // start of appendix?
448 if (parparams.startOfAppendix())
449 y_top += paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
451 Buffer const & buffer = *bv_.buffer();
453 LyXLayout_ptr const & layout = par_.layout();
455 if (buffer.params().paragraph_separation == BufferParams::PARSEP_SKIP) {
457 if (layout->latextype == LATEX_PARAGRAPH
458 && !par_.getDepth()) {
459 y_top += buffer.params().getDefSkip().inPixels(bv_);
461 LyXLayout_ptr const & playout = pars_[pit_ - 1].layout();
462 if (playout->latextype == LATEX_PARAGRAPH
463 && !pars_[pit_ - 1].getDepth()) {
464 // is it right to use defskip here, too? (AS)
465 y_top += buffer.params().getDefSkip().inPixels(bv_);
471 bool const is_rtl = text_.isRTL(par_);
472 bool const is_seq = isFirstInSequence(pit_, text_.paragraphs());
473 //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << std::endl;
475 // should we print a label?
476 if (layout->labeltype >= LABEL_STATIC
477 && (layout->labeltype != LABEL_STATIC
478 || layout->latextype != LATEX_ENVIRONMENT
481 LyXFont const font = getLabelFont();
482 string const str = par_.getLabelstring();
486 // this is special code for the chapter layout. This is
487 // printed in an extra row and has a pagebreak at
489 if (layout->counter == "chapter") {
490 double spacing_val = 1.0;
491 if (!parparams.spacing().isDefault()) {
492 spacing_val = parparams.spacing().getValue();
494 spacing_val = buffer.params().spacing().getValue();
497 int const labeladdon = int(font_metrics::maxHeight(font) * layout->spacing.getValue() * spacing_val);
499 int const maxdesc = int(font_metrics::maxDescent(font) * layout->spacing.getValue() * spacing_val)
500 + int(layout->parsep) * defaultRowHeight();
503 x = width_ - leftMargin() -
504 font_metrics::width(str, font);
507 pain_.text(int(x), yo_ - maxdesc - labeladdon, str, font);
510 x = width_ - leftMargin()
511 + font_metrics::width(layout->labelsep, font);
513 x = x_ - font_metrics::width(layout->labelsep, font)
514 - font_metrics::width(str, font);
517 pain_.text(int(x), yo_, str, font);
521 // the labels at the top of an environment.
522 // More or less for bibliography
524 (layout->labeltype == LABEL_TOP_ENVIRONMENT ||
525 layout->labeltype == LABEL_BIBLIO ||
526 layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)) {
527 LyXFont font = getLabelFont();
528 if (!par_.getLabelstring().empty()) {
529 string const str = par_.getLabelstring();
530 double spacing_val = 1.0;
531 if (!parparams.spacing().isDefault())
532 spacing_val = parparams.spacing().getValue();
534 spacing_val = buffer.params().spacing().getValue();
536 int const labeladdon = int(font_metrics::maxHeight(font) * layout->spacing.getValue() * spacing_val);
539 int(font_metrics::maxDescent(font) * layout->spacing.getValue() * spacing_val
540 + (layout->labelbottomsep * defaultRowHeight()));
543 if (layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT) {
546 x += (width_ - text_.rightMargin(par_) - leftMargin()) / 2;
547 x -= font_metrics::width(str, font) / 2;
549 x = width_ - leftMargin() -
550 font_metrics::width(str, font);
552 pain_.text(int(x), yo_ - maxdesc - labeladdon, str, font);
558 void RowPainter::paintLast()
560 bool const is_rtl = text_.isRTL(par_);
561 int const endlabel = getEndLabel(pit_, text_.paragraphs());
566 case END_LABEL_FILLED_BOX: {
567 LyXFont const font = getLabelFont();
568 int const size = int(0.75 * font_metrics::maxAscent(font));
569 int const y = yo_ - size;
570 int x = is_rtl ? nestMargin() + changebarMargin() : width_ - size;
572 if (width_ - int(row_.width()) <= size)
573 x += (size - width_ + row_.width() + 1) * (is_rtl ? -1 : 1);
575 if (endlabel == END_LABEL_BOX)
576 pain_.rectangle(x, y, size, size, LColor::eolmarker);
578 pain_.fillRectangle(x, y, size, size, LColor::eolmarker);
582 case END_LABEL_STATIC: {
583 LyXFont font = getLabelFont();
584 string const & str = par_.layout()->endlabelstring();
585 double const x = is_rtl ?
586 x_ - font_metrics::width(str, font)
587 : - text_.rightMargin(par_) - row_.width();
588 pain_.text(int(x), yo_, str, font);
592 case END_LABEL_NO_LABEL:
598 void RowPainter::paintText()
600 pos_type const end = row_.endpos();
601 pos_type body_pos = par_.beginOfBody();
603 (body_pos > end || !par_.isLineSeparator(body_pos - 1))) {
607 LyXLayout_ptr const & layout = par_.layout();
609 bool running_strikeout = false;
610 bool is_struckout = false;
611 int last_strikeout_x = 0;
613 // Use font span to speed things up, see below
617 for (pos_type vpos = row_.pos(); vpos < end; ) {
618 if (x_ > bv_.workWidth())
621 pos_type const pos = text_.bidi.vis2log(vpos);
623 if (pos >= par_.size()) {
628 // Use font span to speed things up, see above
629 if (vpos < font_span.first || vpos > font_span.last) {
630 font_span = par_.fontSpan(vpos);
631 font = text_.getFont(par_, vpos);
634 const int width_pos =
635 text_.singleWidth(par_, pos, par_.getChar(pos), font);
637 if (x_ + width_pos < 0) {
643 is_struckout = isDeletedText(par_, pos);
645 if (is_struckout && !running_strikeout) {
646 running_strikeout = true;
647 last_strikeout_x = int(x_);
650 bool const highly_editable_inset = par_.isInset(pos)
651 && isHighlyEditableInset(par_.getInset(pos));
653 // If we reach the end of a struck out range, paint it.
654 // We also don't paint across things like tables
655 if (running_strikeout && (highly_editable_inset || !is_struckout)) {
656 // Calculate 1/3 height of the buffer's default font
658 yo_ - font_metrics::maxAscent(text_.defaultfont_) / 3;
659 pain_.line(last_strikeout_x, middle, int(x_), middle,
660 LColor::strikeout, Painter::line_solid, Painter::line_thin);
661 running_strikeout = false;
664 if (body_pos > 0 && pos == body_pos - 1) {
665 int const lwidth = font_metrics::width(layout->labelsep,
668 x_ += label_hfill_ + lwidth - width_pos;
671 if (par_.isHfill(pos)) {
675 int const y1 = y0 - defaultRowHeight() / 2;
677 pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
679 if (hfillExpansion(par_, row_, pos)) {
680 int const y2 = (y0 + y1) / 2;
682 if (pos >= body_pos) {
683 pain_.line(int(x_), y2, int(x_ + hfill_), y2,
685 Painter::line_onoffdash);
688 pain_.line(int(x_), y2, int(x_ + label_hfill_), y2,
690 Painter::line_onoffdash);
693 pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
697 } else if (par_.isSeparator(pos)) {
707 // if we reach the end of a struck out range, paint it
708 if (running_strikeout) {
709 // calculate 1/3 height of the buffer's default font
711 yo_ - font_metrics::maxAscent(text_.defaultfont_) / 3;
712 pain_.line(last_strikeout_x, middle, int(x_), middle,
713 LColor::strikeout, Painter::line_solid, Painter::line_thin);
714 running_strikeout = false;
720 (PainterInfo & pi, LyXText const & text, pit_type pit, int x, int y)
722 // lyxerr << " paintPar: pit: " << pit << " at y: " << y << endl;
723 static NullPainter nop;
724 static PainterInfo nullpi(pi.base.bv, nop);
725 int const ww = pi.base.bv->workHeight();
727 Paragraph const & par = text.paragraphs()[pit];
729 RowList::const_iterator const rb = par.rows().begin();
730 RowList::const_iterator const re = par.rows().end();
731 theCoords.parPos()[&text][pit] = Point(x, y);
734 for (RowList::const_iterator rit = rb; rit != re; ++rit) {
736 bool const inside = (y + rit->descent() >= 0
737 && y - rit->ascent() < ww);
738 RowPainter rp(inside ? pi : nullpi, text, pit, *rit, x, y);
755 void paintText(BufferView const & bv, ViewMetricsInfo const & vi)
757 Painter & pain = bv.painter();
758 LyXText * const text = bv.text();
761 pain.fillRectangle(0, vi.y1, bv.workWidth(), vi.y2 - vi.y1,
765 PainterInfo pi(const_cast<BufferView *>(&bv), pain);
767 text->drawSelection(pi, 0, 0);
771 for (pit_type pit = vi.p1; pit <= vi.p2; ++pit) {
772 yy += text->getPar(pit).ascent();
773 paintPar(pi, *bv.text(), pit, 0, yy);
774 yy += text->getPar(pit).descent();
777 // Cache one paragraph above and one below
778 // Note MV: this cannot be suppressed even for singlepar.
779 // Try viewing the User Guide Mobius figure
782 text->redoParagraph(vi.p1 - 1);
783 theCoords.parPos()[bv.text()][vi.p1 - 1] =
784 Point(0, vi.y1 - text->getPar(vi.p1 - 1).descent());
787 if (vi.p2 < lyx::pit_type(text->paragraphs().size()) - 1) {
788 text->redoParagraph(vi.p2 + 1);
789 theCoords.parPos()[bv.text()][vi.p2 + 1] =
790 Point(0, vi.y2 + text->getPar(vi.p2 + 1).ascent());
793 // and grey out above (should not happen later)
794 // lyxerr << "par ascent: " << text->getPar(vi.p1).ascent() << endl;
795 if (vi.y1 > 0 && !vi.singlepar)
796 pain.fillRectangle(0, 0, bv.workWidth(), vi.y1, LColor::bottomarea);
798 // and possibly grey out below
799 // lyxerr << "par descent: " << text->getPar(vi.p1).ascent() << endl;
800 if (vi.y2 < bv.workHeight() && !vi.singlepar)
801 pain.fillRectangle(0, vi.y2, bv.workWidth(), bv.workHeight() - vi.y2, LColor::bottomarea);
805 void paintTextInset(LyXText const & text, PainterInfo & pi, int x, int y)
807 // lyxerr << " paintTextInset: y: " << y << endl;
809 y -= text.getPar(0).ascent();
810 for (int pit = 0; pit < int(text.paragraphs().size()); ++pit) {
811 y += text.getPar(pit).ascent();
812 paintPar(pi, text, pit, x, y);
813 y += text.getPar(pit).descent();