]> git.lyx.org Git - lyx.git/blob - src/RowPainter.cpp
Account for old versions of Pygments
[lyx.git] / src / RowPainter.cpp
1 /**
2  * \file RowPainter.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author various
7  * \author John Levon
8  *
9  * Full author contact details are available in file CREDITS.
10  */
11
12 #include <config.h>
13 #include <algorithm>
14
15 #include "RowPainter.h"
16
17 #include "Buffer.h"
18 #include "CoordCache.h"
19 #include "Cursor.h"
20 #include "BufferParams.h"
21 #include "BufferView.h"
22 #include "Changes.h"
23 #include "Language.h"
24 #include "Layout.h"
25 #include "LyXRC.h"
26 #include "Row.h"
27 #include "MetricsInfo.h"
28 #include "Paragraph.h"
29 #include "ParagraphParameters.h"
30 #include "TextMetrics.h"
31 #include "VSpace.h"
32
33 #include "frontends/FontMetrics.h"
34 #include "frontends/Painter.h"
35
36 #include "insets/InsetText.h"
37
38 #include "mathed/InsetMath.h"
39
40 #include "support/debug.h"
41 #include "support/gettext.h"
42 #include "support/textutils.h"
43
44 #include "support/lassert.h"
45 #include <boost/crc.hpp>
46
47 #include <stdlib.h>
48
49 using namespace std;
50
51 namespace lyx {
52
53 using frontend::Painter;
54 using frontend::FontMetrics;
55
56
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()]),
63           change_(pi_.change_),
64           xo_(x), yo_(y)
65 {
66         x_ = row_.left_margin + xo_;
67
68         //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
69         //row_.dump();
70
71         LBUFERR(row.pit() >= 0);
72         LBUFERR(row.pit() < int(text.paragraphs().size()));
73 }
74
75
76 FontInfo RowPainter::labelFont() const
77 {
78         FontInfo f = text_.labelFont(par_);
79         // selected text?
80         if (row_.begin_margin_sel || pi_.selected)
81                 f.setPaintColor(Color_selectiontext);
82         return f;
83 }
84
85
86 // If you want to debug inset metrics uncomment the following line:
87 //#define DEBUG_METRICS
88 // This draws green lines around each inset.
89
90
91 void RowPainter::paintInset(Row::Element const & e) const
92 {
93         // Handle selection
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;
99
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_;
106
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();
112
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
122         // Restore full_repaint status.
123         pi_.full_repaint = pi_full_repaint;
124         pi_.change_ = pi_change;
125         pi_.do_spellcheck = pi_do_spellcheck;
126         pi_.selected = pi_selected;
127
128 #ifdef DEBUG_METRICS
129         Dimension const & dim = pi_.base.bv->coordCache().insets().dim(e.inset);
130         int const x2 = x1 + dim.wid;
131         int const y1 = yo_ + dim.des;
132         int const y2 = yo_ - dim.asc;
133         pi_.pain.line(x1, y1, x1, y2, Color_green);
134         pi_.pain.line(x1, y1, x2, y1, Color_green);
135         pi_.pain.line(x2, y1, x2, y2, Color_green);
136         pi_.pain.line(x1, y2, x2, y2, Color_green);
137 #endif
138 }
139
140
141 void RowPainter::paintForeignMark(Row::Element const & e) const
142 {
143         Language const * lang = e.font.language();
144         if (!lyxrc.mark_foreign_language)
145                 return;
146         if (lang == latex_language)
147                 return;
148         if (lang == pi_.base.bv->buffer().params().language)
149                 return;
150
151         int const desc = e.inset ? e.dim.descent() : 0;
152         int const y = yo_ + pi_.base.solidLineOffset()
153                 + desc + pi_.base.solidLineThickness() / 2;
154         pi_.pain.line(int(x_), y, int(x_ + e.full_width()), y, Color_language,
155                       Painter::line_solid, pi_.base.solidLineThickness());
156 }
157
158
159 void RowPainter::paintMisspelledMark(Row::Element const & e) const
160 {
161         // if changed the misspelled marker gets placed slightly lower than normal
162         // to avoid drawing at the same vertical offset
163         FontMetrics const & fm = theFontMetrics(e.font);
164         int const thickness = max(fm.lineWidth(), 2);
165         int const y = yo_ + pi_.base.solidLineOffset() + pi_.base.solidLineThickness()
166                 + (e.change.changed() ? pi_.base.solidLineThickness() + 1 : 0)
167                 + 1 + thickness / 2;
168
169         //FIXME: this could be computed only once, it is probably not costly.
170         // check for cursor position
171         // don't draw misspelled marker for words at cursor position
172         // we don't want to disturb the process of text editing
173         DocIterator const nw = pi_.base.bv->cursor().newWord();
174         pos_type cpos = -1;
175         if (!nw.empty() && par_.id() == nw.paragraph().id()) {
176                 cpos = nw.pos();
177                 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
178                         --cpos;
179                 else if (cpos > 0 && par_.isWordSeparator(cpos))
180                         --cpos;
181         }
182
183         pos_type pos = e.pos;
184         while (pos < e.pos + pos_type(e.str.length())) {
185                 if (!par_.isMisspelled(pos)) {
186                         ++pos;
187                         continue;
188                 }
189
190                 FontSpan const & range = par_.getSpellRange(pos);
191
192                 // Skip element which are being edited
193                 if (range.contains(cpos)) {
194                         // the range includes the last element
195                         pos = range.last + 1;
196                         continue;
197                 }
198
199                 FontMetrics const & fm = theFontMetrics(e.font);
200                 int x1 = fm.pos2x(e.str, range.first - e.pos,
201                                   e.isRTL(), e.extra);
202                 int x2 = fm.pos2x(e.str, min(range.last - e.pos + 1,
203                                                                          pos_type(e.str.length())),
204                                                                          e.isRTL(), e.extra);
205                 if (x1 > x2)
206                         swap(x1, x2);
207
208                 pi_.pain.line(int(x_ + x1), y, int(x_ + x2), y, 
209                               Color_error,
210                               Painter::line_onoffdash, thickness);
211                 pos = range.last + 1;
212         }
213 }
214
215
216 void RowPainter::paintStringAndSel(Row::Element const & e) const
217 {
218         // at least part of text selected?
219         bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
220                 || pi_.selected;
221         // all the text selected?
222         bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
223                 || pi_.selected;
224
225         if (all_sel || e.change.changed()) {
226                 Font copy = e.font;
227                 Color const col = e.change.changed() ? e.change.color()
228                                                      : Color_selectiontext;
229                 copy.fontInfo().setPaintColor(col);
230                 pi_.pain.text(int(x_), yo_, e.str, copy, e.extra, e.full_width());
231         } else if (!some_sel) {
232                 pi_.pain.text(int(x_), yo_, e.str, e.font, e.extra, e.full_width());
233         } else {
234                 pi_.pain.text(int(x_), yo_, e.str, e.font, Color_selectiontext,
235                               max(row_.sel_beg, e.pos) - e.pos,
236                               min(row_.sel_end, e.endpos) - e.pos,
237                               e.extra, e.full_width());
238         }
239 }
240
241
242 void RowPainter::paintChange(Row::Element const & e) const
243 {
244         e.change.paintCue(pi_, x_, yo_, x_ + e.full_width(), e.font.fontInfo());
245 }
246
247
248 void RowPainter::paintChangeBar() const
249 {
250         pos_type const start = row_.pos();
251         pos_type end = row_.endpos();
252
253         if (par_.size() == end) {
254                 // this is the last row of the paragraph;
255                 // thus, we must also consider the imaginary end-of-par character
256                 end++;
257         }
258
259         if (start == end || !par_.isChanged(start, end))
260                 return;
261
262         int const height = tm_.isLastRow(row_)
263                 ? row_.ascent()
264                 : row_.height();
265
266         pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, height, Color_changebar);
267 }
268
269
270 void RowPainter::paintAppendix() const
271 {
272         // only draw the appendix frame once (for the main text)
273         if (!par_.params().appendix() || !text_.isMainText())
274                 return;
275
276         int y = yo_ - row_.ascent();
277
278         if (par_.params().startOfAppendix())
279                 y += 2 * defaultRowHeight();
280
281         pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
282         pi_.pain.line(tm_.width() - 2, y, tm_.width() - 2, yo_ + row_.height(), Color_appendix);
283 }
284
285
286 void RowPainter::paintDepthBar() const
287 {
288         depth_type const depth = par_.getDepth();
289
290         if (depth <= 0)
291                 return;
292
293         depth_type prev_depth = 0;
294         if (!tm_.isFirstRow(row_)) {
295                 pit_type pit2 = row_.pit();
296                 if (row_.pos() == 0)
297                         --pit2;
298                 prev_depth = pars_[pit2].getDepth();
299         }
300
301         depth_type next_depth = 0;
302         if (!tm_.isLastRow(row_)) {
303                 pit_type pit2 = row_.pit();
304                 if (row_.endpos() >= pars_[pit2].size())
305                         ++pit2;
306                 next_depth = pars_[pit2].getDepth();
307         }
308
309         for (depth_type i = 1; i <= depth; ++i) {
310                 int const w = nestMargin() / 5;
311                 int x = int(xo_) + w * i;
312                 // only consider the changebar space if we're drawing outermost text
313                 if (text_.isMainText())
314                         x += changebarMargin();
315
316                 int const starty = yo_ - row_.ascent();
317                 int const h =  row_.height() - 1 - (i - next_depth - 1) * 3;
318
319                 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
320
321                 if (i > prev_depth)
322                         pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
323                 if (i > next_depth)
324                         pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
325         }
326 }
327
328
329 void RowPainter::paintAppendixStart(int y) const
330 {
331         FontInfo pb_font = sane_font;
332         pb_font.setColor(Color_appendix);
333         pb_font.decSize();
334
335         int w = 0;
336         int a = 0;
337         int d = 0;
338
339         docstring const label = _("Appendix");
340         theFontMetrics(pb_font).rectText(label, w, a, d);
341
342         int const text_start = int(xo_ + (tm_.width() - w) / 2);
343         int const text_end = text_start + w;
344
345         pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
346
347         pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
348         pi_.pain.line(text_end, y, int(xo_ + tm_.width() - 2), y, Color_appendix);
349 }
350
351
352 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
353 {
354         if (left)
355                 pi_.pain.line(pi_.base.dottedLineThickness(), yo_ - row_.ascent(),
356                                           pi_.base.dottedLineThickness(), yo_ + row_.descent(),
357                                           Color_scroll, Painter::line_onoffdash,
358                               pi_.base.dottedLineThickness());
359         if (right) {
360                 int const wwidth =
361                         pi_.base.bv->workWidth() - pi_.base.dottedLineThickness();
362                 pi_.pain.line(wwidth, yo_ - row_.ascent(),
363                                           wwidth, yo_ + row_.descent(),
364                                           Color_scroll, Painter::line_onoffdash,
365                               pi_.base.dottedLineThickness());
366         }
367 }
368
369
370 void RowPainter::paintFirst() const
371 {
372         Layout const & layout = par_.layout();
373
374         // start of appendix?
375         if (par_.params().startOfAppendix())
376             paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
377
378         bool const is_first =
379                 text_.isFirstInSequence(row_.pit()) || !layout.isParagraphGroup();
380         //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
381
382         if (layout.labelIsInline()
383             && (layout.labeltype != LABEL_STATIC || is_first))
384                 paintLabel();
385         else if (is_first && layout.labelIsAbove())
386                 paintTopLevelLabel();
387 }
388
389
390 void RowPainter::paintLabel() const
391 {
392         docstring const & str = par_.labelString();
393         if (str.empty())
394                 return;
395
396         Layout const & layout = par_.layout();
397         FontInfo const font = labelFont();
398         FontMetrics const & fm = theFontMetrics(font);
399         double x = x_;
400
401         if (row_.isRTL())
402                 x = tm_.width() - row_.right_margin + fm.width(layout.labelsep);
403         else
404                 x = x_ - fm.width(layout.labelsep) - fm.width(str);
405
406         pi_.pain.text(int(x), yo_, str, font);
407 }
408
409
410 void RowPainter::paintTopLevelLabel() const
411 {
412         BufferParams const & bparams = pi_.base.bv->buffer().params();
413         ParagraphParameters const & pparams = par_.params();
414         Layout const & layout = par_.layout();
415         FontInfo const font = labelFont();
416         docstring const str = par_.labelString();
417         if (str.empty())
418                 return;
419
420         double spacing_val = 1.0;
421         if (!pparams.spacing().isDefault())
422                 spacing_val = pparams.spacing().getValue();
423         else
424                 spacing_val = bparams.spacing().getValue();
425
426         FontMetrics const & fm = theFontMetrics(font);
427
428         int const labeladdon = int(fm.maxHeight()
429                 * layout.spacing.getValue() * spacing_val);
430
431         int maxdesc =
432                 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
433                 + (layout.labelbottomsep * defaultRowHeight()));
434
435         double x = x_;
436         if (layout.labeltype == LABEL_CENTERED) {
437                 x = row_.left_margin + (tm_.width() - row_.left_margin - row_.right_margin) / 2;
438                 x -= fm.width(str) / 2;
439         } else if (row_.isRTL()) {
440                 x = tm_.width() - row_.right_margin - fm.width(str);
441         }
442         pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
443 }
444
445
446 /** Check if the current paragraph is the last paragraph in a
447     proof environment */
448 static int getEndLabel(pit_type p, Text const & text)
449 {
450         ParagraphList const & pars = text.paragraphs();
451         pit_type pit = p;
452         depth_type par_depth = pars[p].getDepth();
453         while (pit != pit_type(pars.size())) {
454                 Layout const & layout = pars[pit].layout();
455                 int const endlabeltype = layout.endlabeltype;
456
457                 if (endlabeltype != END_LABEL_NO_LABEL) {
458                         if (p + 1 == pit_type(pars.size()))
459                                 return endlabeltype;
460
461                         depth_type const next_depth =
462                                 pars[p + 1].getDepth();
463                         if (par_depth > next_depth ||
464                             (par_depth == next_depth && layout != pars[p + 1].layout()))
465                                 return endlabeltype;
466                         break;
467                 }
468                 if (par_depth == 0)
469                         break;
470                 pit = text.outerHook(pit);
471                 if (pit != pit_type(pars.size()))
472                         par_depth = pars[pit].getDepth();
473         }
474         return END_LABEL_NO_LABEL;
475 }
476
477
478 void RowPainter::paintLast() const
479 {
480         int const endlabel = getEndLabel(row_.pit(), text_);
481
482         // paint imaginary end-of-paragraph character
483
484         Change const & change = par_.lookupChange(par_.size());
485         if (change.changed()) {
486                 FontMetrics const & fm =
487                         theFontMetrics(pi_.base.bv->buffer().params().getFont());
488                 int const length = fm.maxAscent() / 2;
489                 Color col = change.color();
490
491                 pi_.pain.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
492                            Painter::line_solid, 3);
493
494                 if (change.deleted()) {
495                         pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1 + length,
496                                 yo_ + 2, col, Painter::line_solid, 3);
497                 } else {
498                         pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1,
499                                 yo_ + 2, col, Painter::line_solid, 3);
500                 }
501         }
502
503         // draw an endlabel
504
505         switch (endlabel) {
506         case END_LABEL_BOX:
507         case END_LABEL_FILLED_BOX: {
508                 FontInfo const font = labelFont();
509                 FontMetrics const & fm = theFontMetrics(font);
510                 int const size = int(0.75 * fm.maxAscent());
511                 int const y = yo_ - size;
512
513                 // If needed, move the box a bit to avoid overlapping with text.
514                 int x = 0;
515                 if (row_.isRTL()) {
516                         int const normal_x = nestMargin() + changebarMargin();
517                         x = min(normal_x, row_.left_margin - size - Inset::TEXT_TO_INSET_OFFSET);
518                 } else {
519                         int const normal_x = tm_.width() - row_.right_margin
520                                 - size - Inset::TEXT_TO_INSET_OFFSET;
521                         x = max(normal_x, row_.width());
522                 }
523
524                 if (endlabel == END_LABEL_BOX)
525                         pi_.pain.rectangle(x, y, size, size, Color_eolmarker);
526                 else
527                         pi_.pain.fillRectangle(x, y, size, size, Color_eolmarker);
528                 break;
529         }
530
531         case END_LABEL_STATIC: {
532                 FontInfo const font = labelFont();
533                 FontMetrics const & fm = theFontMetrics(font);
534                 docstring const & str = par_.layout().endlabelstring();
535                 double const x = row_.isRTL() ? x_ - fm.width(str) : x_;
536                 pi_.pain.text(int(x), yo_, str, font);
537                 break;
538         }
539
540         case END_LABEL_NO_LABEL:
541                 break;
542         }
543 }
544
545
546 void RowPainter::paintOnlyInsets()
547 {
548         Row::const_iterator cit = row_.begin();
549         Row::const_iterator const & end = row_.end();
550         for ( ; cit != end ; ++cit) {
551                 Row::Element const & e = *cit;
552                 if (e.type == Row::INSET) {
553                         paintInset(e);
554                         // The line that indicates word in a different language
555                         paintForeignMark(e);
556                         // change tracking (not for insets that handle it themselves)
557                         if (!e.inset->canPaintChange(*pi_.base.bv))
558                                 paintChange(e);
559                 }
560
561                 x_ += e.full_width();
562         }
563 }
564
565
566 void RowPainter::paintText()
567 {
568         Row::const_iterator cit = row_.begin();
569         Row::const_iterator const & end = row_.end();
570         for ( ; cit != end ; ++cit) {
571                 Row::Element const & e = *cit;
572
573                 switch (e.type) {
574                 case Row::STRING:
575                 case Row::VIRTUAL:
576                         paintStringAndSel(e);
577
578                         // Paint the spelling marks if enabled.
579                         if (lyxrc.spellcheck_continuously && pi_.do_spellcheck && pi_.pain.isDrawingEnabled())
580                                 paintMisspelledMark(e);
581                         break;
582
583                 case Row::INSET:
584                         paintInset(e);
585                         break;
586
587                 case Row::SPACE:
588                         pi_.pain.textDecoration(e.font.fontInfo(), int(x_), yo_, int(e.full_width()));
589                 }
590
591                 // The line that indicates word in a different language
592                 paintForeignMark(e);
593
594                 // change tracking (not for insets that handle it themselves)
595                 if (e.type != Row::INSET || ! e.inset->canPaintChange(*pi_.base.bv))
596                         paintChange(e);
597
598                 x_ += e.full_width();
599         }
600 }
601
602
603 void RowPainter::paintSelection() const
604 {
605         if (!row_.selection())
606                 return;
607
608         int const y1 = yo_ - row_.ascent();
609         int const y2 = y1 + row_.height();
610
611         // draw the margins
612         if (row_.isRTL() ? row_.end_margin_sel : row_.begin_margin_sel)
613                 pi_.pain.fillRectangle(int(xo_), y1, row_.left_margin, y2 - y1,
614                                        Color_selection);
615
616         // go through row and draw from RTL boundary to RTL boundary
617         double x = xo_ + row_.left_margin;
618         for (auto const & e : row_) {
619                 // These are the same tests as in paintStringAndSel, except
620                 // that all_sel has an additional clause that triggers for end
621                 // of paragraph markers. The clause was not used in
622                 // paintStringAndSel to avoid changing the drawing color.
623                 // at least part of text selected?
624                 bool const some_sel = (e.endpos >= row_.sel_beg && e.pos < row_.sel_end)
625                         || pi_.selected;
626                 // all the text selected?
627                 bool const all_sel = (e.pos >= row_.sel_beg && e.endpos < row_.sel_end)
628                     || (e.isVirtual() && e.pos == row_.endpos() && row_.end_margin_sel)
629                     || pi_.selected;
630
631                 if (all_sel) {
632                         // the 3rd argument is written like that to avoid rounding issues
633                         pi_.pain.fillRectangle(int(x), y1,
634                                                int(x + e.full_width()) - int(x), y2 - y1,
635                                                Color_selection);
636                 } else if (some_sel) {
637                         pos_type const from = min(max(row_.sel_beg, e.pos), e.endpos);
638                         pos_type const to = max(min(row_.sel_end, e.endpos), e.pos);
639                         double x1 = e.pos2x(from);
640                         double x2 = e.pos2x(to);
641                         if (x1 > x2)
642                                 swap(x1, x2);
643                         // the 3rd argument is written like that to avoid rounding issues
644                         pi_.pain.fillRectangle(int(x + x1), y1, int(x2 + x) - int(x1 + x),
645                                                y2 - y1, Color_selection);
646                 }
647                 x += e.full_width();
648         }
649
650         if (row_.isRTL() ? row_.begin_margin_sel : row_.end_margin_sel)
651                 pi_.pain.fillRectangle(int(x), y1,
652                                        int(xo_ + tm_.width()) - int(x), y2 - y1,
653                                        Color_selection);
654
655 }
656
657
658 } // namespace lyx