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