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"
54 * A class used for painting an individual row of text.
58 /// initialise and run painter
59 RowPainter(BufferView const & bv, Painter & pain, LyXText const & text,
60 par_type pit, RowList::iterator rit, int y);
62 // paint various parts
63 void paintBackground();
64 void paintSelection();
67 void paintChangeBar();
70 void paintForeignMark(double orig_x, LyXFont const & orig_font);
71 void paintHebrewComposeChar(lyx::pos_type & vpos);
72 void paintArabicComposeChar(lyx::pos_type & vpos);
73 void paintChars(lyx::pos_type & vpos, bool hebrew, bool arabic);
74 int paintAppendixStart(int y);
76 void paintFromPos(lyx::pos_type & vpos);
77 void paintInset(lyx::pos_type const pos);
79 /// return left margin
80 int leftMargin() const;
82 /// return the font at the given pos
83 LyXFont const getFont(lyx::pos_type pos) const;
85 /// return the label font for this row
86 LyXFont const getLabelFont() const;
88 /// return pixel width for the given pos
89 int singleWidth(lyx::pos_type pos) const;
90 int singleWidth(lyx::pos_type pos, char c) const;
92 /// bufferview to paint on
93 BufferView const & bv_;
98 /// LyXText for the row
99 LyXText const & text_;
100 ParagraphList & pars_;
103 RowList::iterator const rit_;
107 mutable par_type pit_;
120 RowPainter::RowPainter(BufferView const & bv, Painter & pain,
121 LyXText const & text, par_type pit, RowList::iterator rit, int y)
122 : bv_(bv), pain_(pain), text_(text), pars_(text.paragraphs()),
123 rit_(rit), row_(*rit), pit_(pit),
124 xo_(text_.xo_), yo_(y), width_(text_.width())
126 //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo << " yo: " << yo
127 // << " pit->y: " << pit_->y
128 // << " row: " << (pars_[pit_].size() ? pars_[pit_].getChar(row_.pos()) : 'X') << endl;
130 RowMetrics m = text_.computeRowMetrics(pit, row_);
133 separator_ = m.separator;
135 label_hfill_ = m.label_hfill;
137 // background has already been cleared.
138 if (&text_ == bv_.text())
141 // paint the selection background
142 if (bv_.cursor().selection() && &text_ == bv_.cursor().text())
145 // vertical lines for appendix
148 // environment depth brackets
157 if (row_.endpos() >= pars_[pit_].size())
166 LyXFont const RowPainter::getFont(pos_type pos) const
168 return text_.getFont(pit_, pos);
172 int RowPainter::singleWidth(lyx::pos_type pos) const
174 return text_.singleWidth(pit_, pos);
178 int RowPainter::singleWidth(lyx::pos_type pos, char c) const
180 LyXFont const & font = text_.getFont(pit_, pos);
181 return text_.singleWidth(pit_, pos, c, font);
185 LyXFont const RowPainter::getLabelFont() const
187 return text_.getLabelFont(pit_);
191 int RowPainter::leftMargin() const
193 return text_.leftMargin(pit_, row_.pos());
197 void RowPainter::paintInset(pos_type const pos)
199 InsetBase const * inset = pars_[pit_].getInset(pos);
201 PainterInfo pi(const_cast<BufferView *>(&bv_), pain_);
202 pi.base.font = getFont(pos);
203 theCoords.insets_.add(inset, int(x_), yo_ + row_.baseline());
204 inset->drawSelection(pi, int(x_), yo_ + row_.baseline());
205 inset->draw(pi, int(x_), yo_ + row_.baseline());
206 x_ += inset->width();
210 void RowPainter::paintHebrewComposeChar(pos_type & vpos)
212 pos_type pos = text_.bidi.vis2log(vpos);
217 char c = pars_[pit_].getChar(pos);
221 LyXFont const & font = getFont(pos);
222 int const width = font_metrics::width(c, font);
225 for (pos_type i = pos - 1; i >= 0; --i) {
226 c = pars_[pit_].getChar(i);
227 if (!Encodings::IsComposeChar_hebrew(c)) {
228 if (IsPrintableNonspace(c)) {
229 int const width2 = singleWidth(i, c);
231 dx = (c == 'ø' || c == 'ã')
233 : (width2 - width) / 2;
240 pain_.text(int(x_) + dx, yo_ + row_.baseline(), str, font);
244 void RowPainter::paintArabicComposeChar(pos_type & vpos)
246 pos_type pos = text_.bidi.vis2log(vpos);
250 char c = pars_[pit_].getChar(pos);
251 c = pars_[pit_].transformChar(c, pos);
255 LyXFont const & font = getFont(pos);
256 int const width = font_metrics::width(c, font);
259 for (pos_type i = pos - 1; i >= 0; --i) {
260 c = pars_[pit_].getChar(i);
261 if (!Encodings::IsComposeChar_arabic(c)) {
262 if (IsPrintableNonspace(c)) {
263 int const width2 = singleWidth(i, c);
264 dx = (width2 - width) / 2;
270 pain_.text(int(x_) + dx, yo_ + row_.baseline(), str, font);
274 void RowPainter::paintChars(pos_type & vpos, bool hebrew, bool arabic)
276 pos_type pos = text_.bidi.vis2log(vpos);
277 pos_type const end = row_.endpos();
278 LyXFont orig_font = getFont(pos);
282 str += pars_[pit_].getChar(pos);
284 unsigned char c = str[0];
285 str[0] = pars_[pit_].transformChar(c, pos);
288 bool prev_struckout = isDeletedText(pars_[pit_], pos);
289 bool prev_newtext = isInsertedText(pars_[pit_], pos);
291 // collect as much similar chars as we can
292 for (++vpos; vpos < end && (pos = text_.bidi.vis2log(vpos)) >= 0; ++vpos) {
293 char c = pars_[pit_].getChar(pos);
295 if (!IsPrintableNonspace(c))
298 if (prev_struckout != isDeletedText(pars_[pit_], pos))
301 if (prev_newtext != isInsertedText(pars_[pit_], pos))
304 if (arabic && Encodings::IsComposeChar_arabic(c))
307 if (hebrew && Encodings::IsComposeChar_hebrew(c))
310 if (orig_font != getFont(pos))
314 c = pars_[pit_].transformChar(c, pos);
320 orig_font.setColor(LColor::strikeout);
321 else if (prev_newtext)
322 orig_font.setColor(LColor::newtext);
324 // Draw text and set the new x position
325 //lyxerr << "paint row: yo_ " << yo_ << " baseline: " << row_.baseline()
327 pain_.text(int(x_), yo_ + row_.baseline(), str, orig_font);
328 x_ += font_metrics::width(str, orig_font);
332 void RowPainter::paintForeignMark(double orig_x, LyXFont const & orig_font)
334 if (!lyxrc.mark_foreign_language)
336 if (orig_font.language() == latex_language)
338 if (orig_font.language() == bv_.buffer()->params().language)
341 int const y = yo_ + row_.baseline() + 1;
342 pain_.line(int(orig_x), y, int(x_), y, LColor::language);
346 void RowPainter::paintFromPos(pos_type & vpos)
348 pos_type const pos = text_.bidi.vis2log(vpos);
350 LyXFont const & orig_font = getFont(pos);
352 double const orig_x = x_;
354 char const c = pars_[pit_].getChar(pos);
356 if (c == Paragraph::META_INSET) {
359 paintForeignMark(orig_x, orig_font);
363 // usual characters, no insets
365 // special case languages
366 bool const hebrew = (orig_font.language()->lang() == "hebrew");
368 orig_font.language()->lang() == "arabic" &&
369 (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
370 lyxrc.font_norm_type == LyXRC::ISO_10646_1);
372 // draw as many chars as we can
373 if ((!hebrew && !arabic)
374 || (hebrew && !Encodings::IsComposeChar_hebrew(c))
375 || (arabic && !Encodings::IsComposeChar_arabic(c))) {
376 paintChars(vpos, hebrew, arabic);
378 paintHebrewComposeChar(vpos);
380 paintArabicComposeChar(vpos);
383 paintForeignMark(orig_x, orig_font);
387 void RowPainter::paintBackground()
389 int const x = int(xo_);
390 int const y = yo_ < 0 ? 0 : yo_;
391 int const h = yo_ < 0 ? row_.height() + yo_ : row_.height();
392 pain_.fillRectangle(x, y, width_, h, text_.backgroundColor());
396 void RowPainter::paintSelection()
398 bool const is_rtl = text_.isRTL(pars_[pit_]);
400 // the current selection
401 LCursor const & cur = bv_.cursor();
402 int const starty = text_.cursorY(cur.selBegin());
403 int const endy = text_.cursorY(cur.selEnd());
404 par_type startpit = cur.selBegin().par();
405 par_type endpit = cur.selEnd().par();
406 RowList::iterator startrow = pars_[startpit].getRow(cur.selBegin().pos());
407 RowList::iterator endrow = pars_[endpit].getRow(cur.selEnd().pos());
408 int const h = row_.height();
410 int const row_y = text_.yo_ + pars_[pit_].y + row_.y_offset();
412 bool const sel_starts_here = startpit == pit_ && startrow == rit_;
413 bool const sel_ends_here = endpit == pit_ && endrow == rit_;
414 bool const sel_on_one_row = sel_starts_here && sel_ends_here;
416 if (text_.bidi.same_direction()) {
417 if (sel_on_one_row) {
418 int const startx = text_.cursorX(cur.selBegin());
419 int const endx = text_.cursorX(cur.selEnd());
420 int const x1 = is_rtl ? endx : startx;
421 int const x2 = is_rtl ? startx : endx;
422 pain_.fillRectangle(x1, yo_, x2 - x1, h, LColor::selection);
423 } else if (sel_starts_here) {
424 int const startx = text_.cursorX(cur.selBegin());
425 int const x1 = is_rtl ? int(xo_) : startx;
426 int const x2 = is_rtl ? startx : int(xo_) + width_;
427 pain_.fillRectangle(x1, yo_, x2 - x1, h, LColor::selection);
428 } else if (sel_ends_here) {
429 int const endx = text_.cursorX(cur.selEnd());
430 int const x1 = is_rtl ? endx : int(xo_);
431 int const x2 = is_rtl ? int(xo_) + width_ : endx;
432 pain_.fillRectangle(x1, yo_, x2 - x1, h, LColor::selection);
433 } else if (row_y > starty && row_y < endy) {
434 pain_.fillRectangle(int(xo_), yo_, width_, h, LColor::selection);
439 if ((startpit != pit_ && startrow != rit_ && !is_rtl)
440 || (endpit != pit_ && endrow != rit_ && is_rtl))
441 pain_.fillRectangle(int(xo_), yo_,
442 int(x_), h, LColor::selection);
444 pos_type const body_pos = pars_[pit_].beginOfBody();
445 pos_type const end = row_.endpos();
448 for (pos_type vpos = row_.pos(); vpos < end; ++vpos) {
449 pos_type pos = text_.bidi.vis2log(vpos);
450 double const old_tmpx = tmpx;
451 if (body_pos > 0 && pos == body_pos - 1) {
452 LyXLayout_ptr const & layout = pars_[pit_].layout();
453 LyXFont const lfont = getLabelFont();
455 tmpx += label_hfill_ + font_metrics::width(layout->labelsep, lfont);
457 if (pars_[pit_].isLineSeparator(body_pos - 1))
458 tmpx -= singleWidth(body_pos - 1);
461 tmpx += singleWidth(pos);
463 if (hfillExpansion(pars_[pit_], row_, pos)) {
467 tmpx += label_hfill_;
469 if (pars_[pit_].isSeparator(pos) && pos >= body_pos)
473 if (((startpit != pit_ && startrow != rit_)
474 || cur.selBegin().pos() <= pos) &&
475 ((endpit != pit_ && endrow != rit_)
476 || pos < cur.selEnd().pos())) {
477 // Here we do not use x_ as xo_ was added to x_.
478 pain_.fillRectangle(int(old_tmpx), yo_,
479 int(tmpx - old_tmpx + 1), h, LColor::selection);
483 if ((startpit != pit_ && startrow != rit_ && is_rtl) ||
484 (endpit != pit_ && endrow != rit_ && !is_rtl)) {
485 pain_.fillRectangle(int(xo_ + tmpx),
486 yo_, int(width_ - tmpx), h, LColor::selection);
491 void RowPainter::paintChangeBar()
493 pos_type const start = row_.pos();
494 pos_type const end = row_.endpos();
496 if (start == end || !pars_[pit_].isChanged(start, end - 1))
499 int const height = text_.isLastRow(pit_, row_)
501 : row_.height() + boost::next(rit_)->top_of_text();
503 pain_.fillRectangle(4, yo_, 5, height, LColor::changebar);
507 void RowPainter::paintAppendix()
509 if (!pars_[pit_].params().appendix())
514 if (pars_[pit_].params().startOfAppendix())
515 y += 2 * defaultRowHeight();
517 pain_.line(1, y, 1, yo_ + row_.height(), LColor::appendix);
518 pain_.line(width_ - 2, y, width_ - 2, yo_ + row_.height(), LColor::appendix);
522 void RowPainter::paintDepthBar()
524 Paragraph::depth_type const depth = pars_[pit_].getDepth();
529 Paragraph::depth_type prev_depth = 0;
530 if (!text_.isFirstRow(pit_, row_)) {
531 par_type pit2 = pit_;
534 prev_depth = pars_[pit2].getDepth();
537 Paragraph::depth_type next_depth = 0;
538 if (!text_.isLastRow(pit_, row_)) {
539 par_type pit2 = pit_;
540 if (row_.endpos() >= pars_[pit2].size())
542 next_depth = pars_[pit2].getDepth();
545 for (Paragraph::depth_type i = 1; i <= depth; ++i) {
546 int const w = nestMargin() / 5;
547 int x = int(xo_) + w * i;
548 // only consider the changebar space if we're drawing outermost text
549 if (text_.isMainText())
550 x += changebarMargin();
552 int const h = yo_ + row_.height() - 1 - (i - next_depth - 1) * 3;
554 pain_.line(x, yo_, x, h, LColor::depthbar);
557 pain_.fillRectangle(x, yo_, w, 2, LColor::depthbar);
559 pain_.fillRectangle(x, h, w, 2, LColor::depthbar);
564 int RowPainter::paintAppendixStart(int y)
567 pb_font.setColor(LColor::appendix);
570 string const label = _("Appendix");
574 font_metrics::rectText(label, pb_font, w, a, d);
576 int const text_start = int(xo_ + (width_ - w) / 2);
577 int const text_end = text_start + w;
579 pain_.rectText(text_start, y + d, label, pb_font, LColor::none, LColor::none);
581 pain_.line(int(xo_ + 1), y, text_start, y, LColor::appendix);
582 pain_.line(text_end, y, int(xo_ + width_ - 2), y, LColor::appendix);
584 return 3 * defaultRowHeight();
588 void RowPainter::paintFirst()
590 ParagraphParameters const & parparams = pars_[pit_].params();
594 // start of appendix?
595 if (parparams.startOfAppendix())
596 y_top += paintAppendixStart(yo_ + y_top + 2 * defaultRowHeight());
598 Buffer const & buffer = *bv_.buffer();
600 LyXLayout_ptr const & layout = pars_[pit_].layout();
602 if (buffer.params().paragraph_separation == BufferParams::PARSEP_SKIP) {
604 if (layout->latextype == LATEX_PARAGRAPH
605 && !pars_[pit_].getDepth()) {
606 y_top += buffer.params().getDefSkip().inPixels(bv_);
608 LyXLayout_ptr const & playout = pars_[pit_ - 1].layout();
609 if (playout->latextype == LATEX_PARAGRAPH
610 && !pars_[pit_ - 1].getDepth()) {
611 // is it right to use defskip here, too? (AS)
612 y_top += buffer.params().getDefSkip().inPixels(bv_);
618 bool const is_rtl = text_.isRTL(pars_[pit_]);
619 bool const is_seq = isFirstInSequence(pit_, text_.paragraphs());
620 //lyxerr << "paintFirst: " << pars_[pit_].id() << " is_seq: " << is_seq << std::endl;
622 // should we print a label?
623 if (layout->labeltype >= LABEL_STATIC
624 && (layout->labeltype != LABEL_STATIC
625 || layout->latextype != LATEX_ENVIRONMENT
628 LyXFont font = getLabelFont();
629 if (!pars_[pit_].getLabelstring().empty()) {
631 string const str = pars_[pit_].getLabelstring();
633 // this is special code for the chapter layout. This is
634 // printed in an extra row and has a pagebreak at
636 if (layout->counter == "chapter") {
637 if (buffer.params().secnumdepth >= 0) {
638 float spacing_val = 1.0;
639 if (!parparams.spacing().isDefault()) {
640 spacing_val = parparams.spacing().getValue();
642 spacing_val = buffer.params().spacing().getValue();
646 int(font_metrics::maxDescent(font) * layout->spacing.getValue() * spacing_val)
647 + int(layout->parsep) * defaultRowHeight();
650 x = width_ - leftMargin() -
651 font_metrics::width(str, font);
655 yo_ + row_.baseline() -
656 row_.ascent_of_text() - maxdesc,
661 x = width_ - leftMargin()
662 + font_metrics::width(layout->labelsep, font);
664 x = x_ - font_metrics::width(layout->labelsep, font)
665 - font_metrics::width(str, font);
668 pain_.text(int(x), yo_ + row_.baseline(), str, font);
672 // the labels at the top of an environment.
673 // More or less for bibliography
675 (layout->labeltype == LABEL_TOP_ENVIRONMENT ||
676 layout->labeltype == LABEL_BIBLIO ||
677 layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)) {
678 LyXFont font = getLabelFont();
679 if (!pars_[pit_].getLabelstring().empty()) {
680 string const str = pars_[pit_].getLabelstring();
681 float spacing_val = 1.0;
682 if (!parparams.spacing().isDefault()) {
683 spacing_val = parparams.spacing().getValue();
685 spacing_val = buffer.params().spacing().getValue();
689 int(font_metrics::maxDescent(font) * layout->spacing.getValue() * spacing_val
690 + (layout->labelbottomsep * defaultRowHeight()));
693 if (layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT) {
694 x = ((is_rtl ? leftMargin() : x_)
695 + width_ - text_.rightMargin(pars_[pit_])) / 2;
696 x -= font_metrics::width(str, font) / 2;
698 x = width_ - leftMargin() -
699 font_metrics::width(str, font);
702 yo_ + row_.baseline() - row_.ascent_of_text() - maxdesc,
709 void RowPainter::paintLast()
711 bool const is_rtl = text_.isRTL(pars_[pit_]);
712 int const endlabel = getEndLabel(pit_, text_.paragraphs());
717 case END_LABEL_FILLED_BOX: {
718 LyXFont const font = getLabelFont();
719 int const size = int(0.75 * font_metrics::maxAscent(font));
720 int const y = yo_ + row_.baseline() - size;
721 int x = is_rtl ? nestMargin() + changebarMargin() : width_ - size;
723 if (width_ - int(row_.width()) <= size)
724 x += (size - width_ + row_.width() + 1) * (is_rtl ? -1 : 1);
726 if (endlabel == END_LABEL_BOX)
727 pain_.rectangle(x, y, size, size, LColor::eolmarker);
729 pain_.fillRectangle(x, y, size, size, LColor::eolmarker);
733 case END_LABEL_STATIC: {
734 LyXFont font = getLabelFont();
735 string const & str = pars_[pit_].layout()->endlabelstring();
736 double const x = is_rtl ?
737 x_ - font_metrics::width(str, font)
738 : - text_.rightMargin(pars_[pit_]) - row_.width();
739 pain_.text(int(x), yo_ + row_.baseline(), str, font);
743 case END_LABEL_NO_LABEL:
749 void RowPainter::paintText()
751 pos_type const end = row_.endpos();
752 pos_type body_pos = pars_[pit_].beginOfBody();
754 (body_pos > end || !pars_[pit_].isLineSeparator(body_pos - 1))) {
758 LyXLayout_ptr const & layout = pars_[pit_].layout();
760 bool running_strikeout = false;
761 bool is_struckout = false;
762 int last_strikeout_x = 0;
764 for (pos_type vpos = row_.pos(); vpos < end; ) {
765 if (x_ > bv_.workWidth())
768 pos_type pos = text_.bidi.vis2log(vpos);
770 if (pos >= pars_[pit_].size()) {
775 if (x_ + singleWidth(pos) < 0) {
776 x_ += singleWidth(pos);
781 is_struckout = isDeletedText(pars_[pit_], pos);
783 if (is_struckout && !running_strikeout) {
784 running_strikeout = true;
785 last_strikeout_x = int(x_);
788 bool const highly_editable_inset = pars_[pit_].isInset(pos)
789 && isHighlyEditableInset(pars_[pit_].getInset(pos));
791 // if we reach the end of a struck out range, paint it
792 // we also don't paint across things like tables
793 if (running_strikeout && (highly_editable_inset || !is_struckout)) {
794 int const middle = yo_ + (row_.baseline() + row_.top_of_text()) / 2;
795 pain_.line(last_strikeout_x, middle, int(x_), middle,
796 LColor::strikeout, Painter::line_solid, Painter::line_thin);
797 running_strikeout = false;
800 if (body_pos > 0 && pos == body_pos - 1) {
801 int const lwidth = font_metrics::width(layout->labelsep,
804 x_ += label_hfill_ + lwidth - singleWidth(body_pos - 1);
807 if (pars_[pit_].isHfill(pos)) {
810 int const y0 = yo_ + row_.baseline();
811 int const y1 = y0 - defaultRowHeight() / 2;
813 pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
815 if (hfillExpansion(pars_[pit_], row_, pos)) {
816 int const y2 = (y0 + y1) / 2;
818 if (pos >= body_pos) {
819 pain_.line(int(x_), y2, int(x_ + hfill_), y2,
821 Painter::line_onoffdash);
824 pain_.line(int(x_), y2, int(x_ + label_hfill_), y2,
826 Painter::line_onoffdash);
829 pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
833 } else if (pars_[pit_].isSeparator(pos)) {
834 x_ += singleWidth(pos);
843 // if we reach the end of a struck out range, paint it
844 if (running_strikeout) {
845 int const middle = yo_ + (row_.baseline() + row_.top_of_text()) / 2;
846 pain_.line(last_strikeout_x, middle, int(x_), middle,
847 LColor::strikeout, Painter::line_solid, Painter::line_thin);
848 running_strikeout = false;
853 int paintPars(BufferView const & bv, Painter & pain,
854 LyXText const & text, par_type pit, par_type end)
856 //lyxerr << " paintRows: pit: " << &*pit << endl;
857 ParagraphList & pars = text.paragraphs();
859 int y = pars[pit].y + text.yo_ - bv.top_y();
861 for (; pit != end; ++pit) {
862 RowList::iterator row = pars[pit].rows.begin();
863 RowList::iterator rend = pars[pit].rows.end();
865 // We draw full paragraphs to get the (xo, yo) cache of all
866 // contained insets right. This is needed for properly working
867 // editXY. And maybe not even sufficient.
868 // FIXME: Alfredo, please have a look at the coordinate business
870 for ( ; row != rend; ++row) {
871 RowPainter(bv, pain, text, pit, row, y);
882 void refreshPar(BufferView const & bv, LyXText const & text, par_type pit)
884 static NullPainter nop;
885 paintPars(bv, nop, text, pit, pit + 1);
889 int paintText(BufferView const & bv)
892 getParsInRange(bv.text()->paragraphs(), bv.top_y(),
893 bv.top_y() + bv.workHeight(), pit, end);
894 //lyxerr << "top_y: " << bv.top_y() << " y: " << pit->y << endl;
895 return paintPars(bv, bv.painter(), *bv.text(), pit, end);
899 void paintTextInset(LyXText const & text, PainterInfo & pi)
901 paintPars(*pi.base.bv, pi.pain, text, 0, text.paragraphs().size());