]> git.lyx.org Git - lyx.git/blob - src/rowpainter.C
Change (and fix) the bullets in itemize to be more unicode friendly.
[lyx.git] / src / rowpainter.C
1 /**
2  * \file rowpainter.C
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
14 #include "rowpainter.h"
15
16 #include "buffer.h"
17 #include "coordcache.h"
18 #include "cursor.h"
19 #include "debug.h"
20 #include "bufferparams.h"
21 #include "BufferView.h"
22 #include "encoding.h"
23 #include "gettext.h"
24 #include "language.h"
25 #include "LColor.h"
26 #include "lyxrc.h"
27 #include "lyxrow.h"
28 #include "lyxrow_funcs.h"
29 #include "metricsinfo.h"
30 #include "paragraph.h"
31 #include "paragraph_funcs.h"
32 #include "ParagraphParameters.h"
33 #include "vspace.h"
34
35 #include "frontends/FontMetrics.h"
36 #include "frontends/nullpainter.h"
37 #include "frontends/Painter.h"
38
39 #include "insets/insettext.h"
40
41 #include "support/textutils.h"
42
43 #include <boost/crc.hpp>
44
45 using lyx::docstring;
46 using lyx::frontend::Painter;
47 using lyx::frontend::NullPainter;
48 using lyx::frontend::FontMetrics;
49
50 using lyx::char_type;
51 using lyx::pit_type;
52 using lyx::pos_type;
53 using lyx::Point;
54
55 using std::endl;
56 using std::max;
57 using std::min;
58 using std::string;
59
60
61 namespace {
62
63 /// Flag: do a full redraw of inside text of inset
64 /// Working variable indicating a full screen refresh
65 bool refreshInside;
66
67 /**
68  * A class used for painting an individual row of text.
69  */
70 class RowPainter {
71 public:
72         /// initialise and run painter
73         RowPainter(PainterInfo & pi, LyXText const & text,
74                 pit_type pit, Row const & row, int x, int y);
75
76         // paint various parts
77         void paintAppendix();
78         void paintDepthBar();
79         void paintChangeBar();
80         void paintFirst();
81         void paintLast();
82         void paintText();
83
84 private:
85         void paintForeignMark(double orig_x, LyXFont const & font, int desc = 0);
86         void paintHebrewComposeChar(lyx::pos_type & vpos, LyXFont const & font);
87         void paintArabicComposeChar(lyx::pos_type & vpos, LyXFont const & font);
88         void paintChars(lyx::pos_type & vpos, LyXFont font,
89                         bool hebrew, bool arabic);
90         int paintAppendixStart(int y);
91         void paintFromPos(lyx::pos_type & vpos);
92         void paintInset(lyx::pos_type const pos, LyXFont const & font);
93
94         /// return left margin
95         int leftMargin() const;
96
97         /// return the label font for this row
98         LyXFont const getLabelFont() const;
99
100         /// bufferview to paint on
101         BufferView & bv_;
102
103         /// Painter to use
104         Painter & pain_;
105
106         /// LyXText for the row
107         LyXText const & text_;
108         ParagraphList const & pars_;
109
110         /// The row to paint
111         Row const & row_;
112
113         /// Row's paragraph
114         pit_type const pit_;
115         Paragraph const & par_;
116
117         /// is row erased? (change tracking)
118         bool erased_;
119
120         // Looks ugly - is
121         double const xo_;
122         int const yo_;    // current baseline
123         double x_;
124         int width_;
125         double separator_;
126         double hfill_;
127         double label_hfill_;
128 };
129
130
131 RowPainter::RowPainter(PainterInfo & pi,
132         LyXText const & text, pit_type pit, Row const & row, int x, int y)
133         : bv_(*pi.base.bv), pain_(pi.pain), text_(text), pars_(text.paragraphs()),
134           row_(row), pit_(pit), par_(text.paragraphs()[pit]),
135           erased_(pi.erased_),
136           xo_(x), yo_(y), width_(text_.width())
137 {
138         RowMetrics m = text_.computeRowMetrics(pit, row_);
139         x_ = m.x + xo_;
140
141         //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
142         //row_.dump();
143
144         separator_ = m.separator;
145         hfill_ = m.hfill;
146         label_hfill_ = m.label_hfill;
147
148         BOOST_ASSERT(pit >= 0);
149         BOOST_ASSERT(pit < int(text.paragraphs().size()));
150 }
151
152
153 LyXFont const RowPainter::getLabelFont() const
154 {
155         return text_.getLabelFont(par_);
156 }
157
158
159 int RowPainter::leftMargin() const
160 {
161         return text_.leftMargin(pit_, row_.pos());
162 }
163
164
165 void RowPainter::paintInset(pos_type const pos, LyXFont const & font)
166 {
167         InsetBase const * inset = par_.getInset(pos);
168         BOOST_ASSERT(inset);
169         PainterInfo pi(const_cast<BufferView *>(&bv_), pain_);
170         // FIXME: We should always use font, see documentation of
171         // noFontChange() in insetbase.h.
172         pi.base.font = inset->noFontChange() ?
173                 bv_.buffer()->params().getFont() :
174                 font;
175         pi.ltr_pos = (text_.bidi.level(pos) % 2 == 0);
176         pi.erased_ = erased_ || par_.isDeleted(pos);
177         bv_.coordCache().insets().add(inset, int(x_), yo_);
178         InsetText const * const in = inset->asTextInset();
179         // non-wide insets are painted completely. Recursive
180         bool tmp = refreshInside;
181         if (!in || !in->Wide()) {
182                 refreshInside = true;
183                 lyxerr[Debug::PAINTING] << endl << "Paint inset fully" << endl;
184         }
185         if (refreshInside)
186                 inset->drawSelection(pi, int(x_), yo_);
187         inset->draw(pi, int(x_), yo_);
188         refreshInside = tmp;
189         x_ += inset->width();
190 }
191
192
193 void RowPainter::paintHebrewComposeChar(pos_type & vpos, LyXFont const & font)
194 {
195         pos_type pos = text_.bidi.vis2log(vpos);
196
197         docstring str;
198
199         // first char
200         char_type c = par_.getChar(pos);
201         str += c;
202         ++vpos;
203
204         int const width = theFontMetrics(font).width(c);
205         int dx = 0;
206
207         for (pos_type i = pos - 1; i >= 0; --i) {
208                 c = par_.getChar(i);
209                 if (!Encodings::isComposeChar_hebrew(c)) {
210                         if (isPrintableNonspace(c)) {
211                                 int const width2 =
212                                         text_.singleWidth(par_, i, c, text_.getFont(par_, i));
213                                 // FIXME UNICODE
214                                 // This does not work anymore, and non-ascii
215                                 // characters in source files are forbidden
216                                 // anyway.
217                                 // dalet / resh
218                                 dx = (c == 'ø' || c == 'ã')
219                                         ? width2 - width
220                                         : (width2 - width) / 2;
221                         }
222                         break;
223                 }
224         }
225
226         // Draw nikud
227         // FIXME UNICODE
228         pain_.text(int(x_) + dx, yo_, str, font);
229 }
230
231
232 void RowPainter::paintArabicComposeChar(pos_type & vpos, LyXFont const & font)
233 {
234         pos_type pos = text_.bidi.vis2log(vpos);
235         docstring str;
236
237         // first char
238         char_type c = par_.getChar(pos);
239         c = par_.transformChar(c, pos);
240         str += c;
241         ++vpos;
242
243         int const width = theFontMetrics(font).width(c);
244         int dx = 0;
245
246         for (pos_type i = pos - 1; i >= 0; --i) {
247                 c = par_.getChar(i);
248                 if (!Encodings::isComposeChar_arabic(c)) {
249                         if (isPrintableNonspace(c)) {
250                                 int const width2 =
251                                         text_.singleWidth(par_, i, c, text_.getFont(par_, i));
252                                 dx = (width2 - width) / 2;
253                         }
254                         break;
255                 }
256         }
257         // Draw nikud
258         pain_.text(int(x_) + dx, yo_, str, font);
259 }
260
261
262 void RowPainter::paintChars(pos_type & vpos, LyXFont font,
263                             bool hebrew, bool arabic)
264 {
265         pos_type pos = text_.bidi.vis2log(vpos);
266         pos_type const end = row_.endpos();
267         FontSpan const font_span = par_.fontSpan(pos);
268         Change::Type const prev_change = par_.lookupChange(pos).type;
269
270         // first character
271 #if 0
272         string str;
273         str += par_.getChar(pos);
274 #else
275         std::vector<char_type> str;
276         str.push_back(par_.getChar(pos));
277 #endif
278         if (arabic) {
279                 char_type c = str[0];
280                 str[0] = par_.transformChar(c, pos);
281         }
282
283         // collect as much similar chars as we can
284         for (++vpos ; vpos < end ; ++vpos) {
285                 pos = text_.bidi.vis2log(vpos);
286                 if (pos < font_span.first || pos > font_span.last)
287                         break;
288
289                 if (prev_change != par_.lookupChange(pos).type)
290                         break;
291
292                 char_type c = par_.getChar(pos);
293
294                 if (!isPrintableNonspace(c))
295                         break;
296
297                 if (arabic && Encodings::isComposeChar_arabic(c))
298                         break;
299
300                 if (hebrew && Encodings::isComposeChar_hebrew(c))
301                         break;
302
303                 if (arabic)
304                         c = par_.transformChar(c, pos);
305
306 #if 0
307                 str += c;
308 #else
309                 str.push_back(c);
310 #endif
311         }
312
313         if (prev_change == Change::DELETED)
314                 font.setColor(LColor::strikeout);
315         else if (prev_change == Change::INSERTED)
316                 font.setColor(LColor::newtext);
317
318         // Draw text and set the new x position
319         //lyxerr << "paint row: yo_ " << yo_ << "\n";
320 #if 0
321         int width = pain_.text(int(x_), yo_, str, font);
322 #else
323         int width = pain_.text(int(x_), yo_, &str[0], str.size(), font);
324 #endif
325         x_ += width;
326 }
327
328
329 void RowPainter::paintForeignMark(double orig_x, LyXFont const & font, int desc)
330 {
331         if (!lyxrc.mark_foreign_language)
332                 return;
333         if (font.language() == latex_language)
334                 return;
335         if (font.language() == bv_.buffer()->params().language)
336                 return;
337
338         int const y = yo_ + 1 + desc;
339         pain_.line(int(orig_x), y, int(x_), y, LColor::language);
340 }
341
342
343 void RowPainter::paintFromPos(pos_type & vpos)
344 {
345         pos_type const pos = text_.bidi.vis2log(vpos);
346         LyXFont orig_font = text_.getFont(par_, pos);
347
348         double const orig_x = x_;
349
350         if (par_.isInset(pos)) {
351                 paintInset(pos, orig_font);
352                 ++vpos;
353                 paintForeignMark(orig_x, orig_font,
354                         par_.getInset(pos)->descent());
355                 return;
356         }
357
358         // usual characters, no insets
359         char_type const c = par_.getChar(pos);
360
361         // special case languages
362         std::string const & lang = orig_font.language()->lang();
363         bool const hebrew = lang == "hebrew";
364         bool const arabic = lang == "arabic" &&
365                 (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
366                 lyxrc.font_norm_type == LyXRC::ISO_10646_1);
367
368         // draw as many chars as we can
369         if ((!hebrew && !arabic)
370                 || (hebrew && !Encodings::isComposeChar_hebrew(c))
371                 || (arabic && !Encodings::isComposeChar_arabic(c))) {
372                 paintChars(vpos, orig_font, hebrew, arabic);
373         } else if (hebrew) {
374                 paintHebrewComposeChar(vpos, orig_font);
375         } else if (arabic) {
376                 paintArabicComposeChar(vpos, orig_font);
377         }
378
379         paintForeignMark(orig_x, orig_font);
380 }
381
382
383 void RowPainter::paintChangeBar()
384 {
385         pos_type const start = row_.pos();
386         pos_type const end = row_.endpos();
387
388         if (start == end || !par_.isChanged(start, end))
389                 return;
390
391         int const height = text_.isLastRow(pit_, row_)
392                 ? row_.ascent()
393                 : row_.height();
394
395         pain_.fillRectangle(5, yo_ - row_.ascent(), 3, height, LColor::changebar);
396 }
397
398
399 void RowPainter::paintAppendix()
400 {
401         if (!par_.params().appendix())
402                 return;
403
404         int y = yo_ - row_.ascent();
405
406         if (par_.params().startOfAppendix())
407                 y += 2 * defaultRowHeight();
408
409         pain_.line(1, y, 1, yo_ + row_.height(), LColor::appendix);
410         pain_.line(width_ - 2, y, width_ - 2, yo_ + row_.height(), LColor::appendix);
411 }
412
413
414 void RowPainter::paintDepthBar()
415 {
416         Paragraph::depth_type const depth = par_.getDepth();
417
418         if (depth <= 0)
419                 return;
420
421         Paragraph::depth_type prev_depth = 0;
422         if (!text_.isFirstRow(pit_, row_)) {
423                 pit_type pit2 = pit_;
424                 if (row_.pos() == 0)
425                         --pit2;
426                 prev_depth = pars_[pit2].getDepth();
427         }
428
429         Paragraph::depth_type next_depth = 0;
430         if (!text_.isLastRow(pit_, row_)) {
431                 pit_type pit2 = pit_;
432                 if (row_.endpos() >= pars_[pit2].size())
433                         ++pit2;
434                 next_depth = pars_[pit2].getDepth();
435         }
436
437         for (Paragraph::depth_type i = 1; i <= depth; ++i) {
438                 int const w = nestMargin() / 5;
439                 int x = int(xo_) + w * i;
440                 // only consider the changebar space if we're drawing outermost text
441                 if (text_.isMainText())
442                         x += changebarMargin();
443
444                 int const starty = yo_ - row_.ascent();
445                 int const h =  row_.height() - 1 - (i - next_depth - 1) * 3;
446
447                 pain_.line(x, starty, x, starty + h, LColor::depthbar);
448
449                 if (i > prev_depth)
450                         pain_.fillRectangle(x, starty, w, 2, LColor::depthbar);
451                 if (i > next_depth)
452                         pain_.fillRectangle(x, starty + h, w, 2, LColor::depthbar);
453         }
454 }
455
456
457 int RowPainter::paintAppendixStart(int y)
458 {
459         LyXFont pb_font;
460         pb_font.setColor(LColor::appendix);
461         pb_font.decSize();
462
463         int w = 0;
464         int a = 0;
465         int d = 0;
466
467         docstring const label = _("Appendix");
468         theFontMetrics(pb_font).rectText(label, w, a, d);
469
470         int const text_start = int(xo_ + (width_ - w) / 2);
471         int const text_end = text_start + w;
472
473         pain_.rectText(text_start, y + d, label, pb_font, LColor::none, LColor::none);
474
475         pain_.line(int(xo_ + 1), y, text_start, y, LColor::appendix);
476         pain_.line(text_end, y, int(xo_ + width_ - 2), y, LColor::appendix);
477
478         return 3 * defaultRowHeight();
479 }
480
481
482 void RowPainter::paintFirst()
483 {
484         ParagraphParameters const & parparams = par_.params();
485
486         int y_top = 0;
487
488         // start of appendix?
489         if (parparams.startOfAppendix())
490                 y_top += paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
491
492         Buffer const & buffer = *bv_.buffer();
493
494         LyXLayout_ptr const & layout = par_.layout();
495
496         if (buffer.params().paragraph_separation == BufferParams::PARSEP_SKIP) {
497                 if (pit_ != 0) {
498                         if (layout->latextype == LATEX_PARAGRAPH
499                                 && !par_.getDepth()) {
500                                 y_top += buffer.params().getDefSkip().inPixels(bv_);
501                         } else {
502                                 LyXLayout_ptr const & playout = pars_[pit_ - 1].layout();
503                                 if (playout->latextype == LATEX_PARAGRAPH
504                                         && !pars_[pit_ - 1].getDepth()) {
505                                         // is it right to use defskip here, too? (AS)
506                                         y_top += buffer.params().getDefSkip().inPixels(bv_);
507                                 }
508                         }
509                 }
510         }
511
512         bool const is_rtl = text_.isRTL(par_);
513         bool const is_seq = isFirstInSequence(pit_, text_.paragraphs());
514         //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << std::endl;
515
516         // should we print a label?
517         if (layout->labeltype >= LABEL_STATIC
518             && (layout->labeltype != LABEL_STATIC
519                       || layout->latextype != LATEX_ENVIRONMENT
520                       || is_seq)) {
521
522                 LyXFont const font = getLabelFont();
523                 FontMetrics const & fm = theFontMetrics(font);
524
525                 docstring const str = par_.getLabelstring();
526                 if (!str.empty()) {
527                         double x = x_;
528
529                         // this is special code for the chapter layout. This is
530                         // printed in an extra row and has a pagebreak at
531                         // the top.
532                         if (layout->counter == "chapter") {
533                                 double spacing_val = 1.0;
534                                 if (!parparams.spacing().isDefault()) {
535                                         spacing_val = parparams.spacing().getValue();
536                                 } else {
537                                         spacing_val = buffer.params().spacing().getValue();
538                                 }
539
540                                 int const labeladdon = int(fm.maxHeight() * layout->spacing.getValue() * spacing_val);
541
542                                 int const maxdesc = int(fm.maxDescent() * layout->spacing.getValue() * spacing_val)
543                                         + int(layout->parsep) * defaultRowHeight();
544
545                                 if (is_rtl) {
546                                         x = width_ - leftMargin() -
547                                                 fm.width(str);
548                                 }
549
550                                 pain_.text(int(x), yo_ - maxdesc - labeladdon, str, font);
551                         } else {
552                                 // FIXME UNICODE
553                                 docstring lab = lyx::from_utf8(layout->labelsep);
554                                 if (is_rtl) {
555                                         x = width_ - leftMargin()
556                                                 + fm.width(lab);
557                                 } else {
558                                         x = x_ - fm.width(lab)
559                                                 - fm.width(str);
560                                 }
561
562                                 pain_.text(int(x), yo_, str, font);
563                         }
564                 }
565
566         // the labels at the top of an environment.
567         // More or less for bibliography
568         } else if (is_seq &&
569                 (layout->labeltype == LABEL_TOP_ENVIRONMENT ||
570                 layout->labeltype == LABEL_BIBLIO ||
571                 layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)) {
572                 LyXFont font = getLabelFont();
573                 if (!par_.getLabelstring().empty()) {
574                         docstring const str = par_.getLabelstring();
575                         double spacing_val = 1.0;
576                         if (!parparams.spacing().isDefault())
577                                 spacing_val = parparams.spacing().getValue();
578                         else
579                                 spacing_val = buffer.params().spacing().getValue();
580
581                         FontMetrics const & fm = theFontMetrics(font);
582
583                         int const labeladdon = int(fm.maxHeight()
584                                 * layout->spacing.getValue() * spacing_val);
585
586                         int maxdesc =
587                                 int(fm.maxDescent() * layout->spacing.getValue() * spacing_val
588                                 + (layout->labelbottomsep * defaultRowHeight()));
589
590                         double x = x_;
591                         if (layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT) {
592                                 if (is_rtl)
593                                         x = leftMargin();
594                                 x += (width_ - text_.rightMargin(par_) - leftMargin()) / 2;
595                                 x -= fm.width(str) / 2;
596                         } else if (is_rtl) {
597                                 x = width_ - leftMargin() -     fm.width(str);
598                         }
599                         pain_.text(int(x), yo_ - maxdesc - labeladdon, str, font);
600                 }
601         }
602 }
603
604
605 void RowPainter::paintLast()
606 {
607         bool const is_rtl = text_.isRTL(par_);
608         int const endlabel = getEndLabel(pit_, text_.paragraphs());
609
610         // draw an endlabel
611         switch (endlabel) {
612         case END_LABEL_BOX:
613         case END_LABEL_FILLED_BOX: {
614                 LyXFont const font = getLabelFont();
615                 FontMetrics const & fm = theFontMetrics(font);
616                 int const size = int(0.75 * fm.maxAscent());
617                 int const y = yo_ - size;
618                 int x = is_rtl ? nestMargin() + changebarMargin() : width_ - size;
619
620                 if (width_ - int(row_.width()) <= size)
621                         x += (size - width_ + row_.width() + 1) * (is_rtl ? -1 : 1);
622
623                 if (endlabel == END_LABEL_BOX)
624                         pain_.rectangle(x, y, size, size, LColor::eolmarker);
625                 else
626                         pain_.fillRectangle(x, y, size, size, LColor::eolmarker);
627                 break;
628         }
629
630         case END_LABEL_STATIC: {
631                 LyXFont font = getLabelFont();
632                 FontMetrics const & fm = theFontMetrics(font);
633                 // FIXME UNICODE
634                 docstring const & str = lyx::from_utf8(par_.layout()->endlabelstring());
635                 double const x = is_rtl ?
636                         x_ - fm.width(str)
637                         : - text_.rightMargin(par_) - row_.width();
638                 pain_.text(int(x), yo_, str, font);
639                 break;
640         }
641
642         case END_LABEL_NO_LABEL:
643                 break;
644         }
645 }
646
647
648 void RowPainter::paintText()
649 {
650         pos_type const end = row_.endpos();
651         pos_type body_pos = par_.beginOfBody();
652         if (body_pos > 0 &&
653                 (body_pos > end || !par_.isLineSeparator(body_pos - 1))) {
654                 body_pos = 0;
655         }
656
657         LyXLayout_ptr const & layout = par_.layout();
658
659         bool running_strikeout = false;
660         bool is_struckout = false;
661         int last_strikeout_x = 0;
662
663         // Use font span to speed things up, see below
664         FontSpan font_span;
665         LyXFont font;
666
667         for (pos_type vpos = row_.pos(); vpos < end; ) {
668                 if (x_ > bv_.workWidth())
669                         break;
670
671                 pos_type const pos = text_.bidi.vis2log(vpos);
672
673                 if (pos >= par_.size()) {
674                         ++vpos;
675                         continue;
676                 }
677
678                 // Use font span to speed things up, see above
679                 if (vpos < font_span.first || vpos > font_span.last) {
680                         font_span = par_.fontSpan(vpos);
681                         font = text_.getFont(par_, vpos);
682                 }
683
684                 const int width_pos =
685                         text_.singleWidth(par_, pos, par_.getChar(pos), font);
686
687                 if (x_ + width_pos < 0) {
688                         x_ += width_pos;
689                         ++vpos;
690                         continue;
691                 }
692
693                 is_struckout = par_.isDeleted(pos);
694
695                 if (is_struckout && !running_strikeout) {
696                         running_strikeout = true;
697                         last_strikeout_x = int(x_);
698                 }
699
700                 bool const highly_editable_inset = par_.isInset(pos)
701                         && isHighlyEditableInset(par_.getInset(pos));
702
703                 // If we reach the end of a struck out range, paint it.
704                 // We also don't paint across things like tables
705                 if (running_strikeout && (highly_editable_inset || !is_struckout)) {
706                         // Calculate 1/3 height of the buffer's default font
707                         FontMetrics const & fm 
708                                 = theFontMetrics(bv_.buffer()->params().getFont());
709                         int const middle = yo_ - fm.maxAscent() / 3;
710                         pain_.line(last_strikeout_x, middle, int(x_), middle,
711                                 LColor::strikeout, Painter::line_solid, Painter::line_thin);
712                         running_strikeout = false;
713                 }
714
715                 if (body_pos > 0 && pos == body_pos - 1) {
716                         // FIXME UNICODE
717                         int const lwidth = theFontMetrics(getLabelFont())
718                                 .width(lyx::from_utf8(layout->labelsep));
719
720                         x_ += label_hfill_ + lwidth - width_pos;
721                 }
722
723                 if (par_.isHfill(pos)) {
724                         x_ += 1;
725
726                         int const y0 = yo_;
727                         int const y1 = y0 - defaultRowHeight() / 2;
728
729                         pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
730
731                         if (hfillExpansion(par_, row_, pos)) {
732                                 int const y2 = (y0 + y1) / 2;
733
734                                 if (pos >= body_pos) {
735                                         pain_.line(int(x_), y2, int(x_ + hfill_), y2,
736                                                   LColor::added_space,
737                                                   Painter::line_onoffdash);
738                                         x_ += hfill_;
739                                 } else {
740                                         pain_.line(int(x_), y2, int(x_ + label_hfill_), y2,
741                                                   LColor::added_space,
742                                                   Painter::line_onoffdash);
743                                         x_ += label_hfill_;
744                                 }
745                                 pain_.line(int(x_), y1, int(x_), y0, LColor::added_space);
746                         }
747                         x_ += 2;
748                         ++vpos;
749                 } else if (par_.isSeparator(pos)) {
750                         x_ += width_pos;
751                         if (pos >= body_pos)
752                                 x_ += separator_;
753                         ++vpos;
754                 } else {
755                         paintFromPos(vpos);
756                 }
757         }
758
759         // if we reach the end of a struck out range, paint it
760         if (running_strikeout) {
761                 // calculate 1/3 height of the buffer's default font
762                 FontMetrics const & fm 
763                         = theFontMetrics(bv_.buffer()->params().getFont());
764                 int const middle = yo_ - fm.maxAscent() / 3;
765                 pain_.line(last_strikeout_x, middle, int(x_), middle,
766                         LColor::strikeout, Painter::line_solid, Painter::line_thin);
767                 running_strikeout = false;
768         }
769 }
770
771
772 lyx::size_type calculateRowSignature(Row const & row, Paragraph const & par,
773         int x, int y)
774 {
775         boost::crc_32_type crc;
776         for (lyx::pos_type i = row.pos(); i < row.endpos(); ++i) {
777                 const unsigned char b[] = { par.getChar(i) };
778                 crc.process_bytes(b, 1);
779         }
780         const unsigned char b[] = { x, y, row.width() };
781         crc.process_bytes(b, 3);
782         return crc.checksum();
783 }
784
785
786 bool CursorOnRow(PainterInfo & pi, pit_type const pit,
787         RowList::const_iterator rit, LyXText const & text)
788 {
789         // Is there a cursor on this row (or inside inset on row)
790         LCursor & cur = pi.base.bv->cursor();
791         for (lyx::size_type d = 0; d < cur.depth(); d++) {
792                 CursorSlice const & sl = cur[d];
793                 if (sl.text() == &text
794                     && sl.pit() == pit
795                     && sl.pos() >= rit->pos()
796                     && sl.pos() <= rit->endpos())
797                         return true;
798         }
799         return false;
800 }
801
802
803 bool innerCursorOnRow(PainterInfo & pi, pit_type pit,
804         RowList::const_iterator rit, LyXText const & text)
805 {
806         // Is there a cursor inside an inset on this row, and is this inset
807         // the only "character" on this row
808         LCursor & cur = pi.base.bv->cursor();
809         if (rit->pos() + 1 != rit->endpos())
810                 return false;
811         for (lyx::size_type d = 0; d < cur.depth(); d++) {
812                 CursorSlice const & sl = cur[d];
813                 if (sl.text() == &text
814                     && sl.pit() == pit
815                     && sl.pos() == rit->pos())
816                         return d < cur.depth() - 1;
817         }
818         return false;
819 }
820
821
822 void paintPar
823         (PainterInfo & pi, LyXText const & text, pit_type pit, int x, int y,
824          bool repaintAll)
825 {
826 //      lyxerr << "  paintPar: pit: " << pit << " at y: " << y << endl;
827         static NullPainter nop;
828         static PainterInfo nullpi(pi.base.bv, nop);
829         int const ww = pi.base.bv->workHeight();
830
831         pi.base.bv->coordCache().parPos()[&text][pit] = Point(x, y);
832
833         Paragraph const & par = text.paragraphs()[pit];
834         if (par.rows().empty())
835                 return;
836
837         RowList::const_iterator const rb = par.rows().begin();
838         RowList::const_iterator const re = par.rows().end();
839
840         y -= rb->ascent();
841         lyx::size_type rowno(0);
842         for (RowList::const_iterator rit = rb; rit != re; ++rit, ++rowno) {
843                 y += rit->ascent();
844                 // Allow setting of refreshInside for nested insets in
845                 // this row only
846                 bool tmp = refreshInside;
847
848                 // Row signature; has row changed since last paint?
849                 lyx::size_type const row_sig = calculateRowSignature(*rit, par, x, y);
850                 bool row_has_changed = par.rowSignature()[rowno] != row_sig;
851
852                 bool cursor_on_row = CursorOnRow(pi, pit, rit, text);
853                 bool in_inset_alone_on_row = innerCursorOnRow(pi, pit, rit,
854                         text);
855
856                 // If this is the only object on the row, we can make it wide
857                 for (pos_type i = rit->pos() ; i != rit->endpos(); ++i) {
858                         InsetBase const * const in = par.getInset(i);
859                         if (in) {
860                                 InsetText const * const t = in->asTextInset();
861                                 if (t)
862                                         t->Wide() = in_inset_alone_on_row;
863                         }
864                 }
865
866                 // If selection is on, the current row signature differs
867                 // from cache, or cursor is inside an inset _on this row_,
868                 // then paint the row
869                 if (repaintAll || row_has_changed || cursor_on_row) {
870                         // Add to row signature cache
871                         par.rowSignature()[rowno] = row_sig;
872
873                         bool const inside = (y + rit->descent() >= 0
874                                        && y - rit->ascent() < ww);
875                         RowPainter rp(inside ? pi : nullpi, text, pit, *rit, x, y);
876                         // Clear background of this row
877                         // (if paragraph background was not cleared)
878                         if (!repaintAll &&
879                             (!in_inset_alone_on_row || row_has_changed)) {
880                                 pi.pain.fillRectangle(x, y - rit->ascent(),
881                                     text.maxwidth_, rit->height(),
882                                     text.backgroundColor());
883                                 // If outer row has changed, force nested
884                                 // insets to repaint completely
885                                 if (row_has_changed)
886                                         refreshInside = true;
887                         }
888
889                         // Instrumentation for testing row cache (see also
890                         // 12 lines lower):
891                         if (text.isMainText())
892                                 lyxerr[Debug::PAINTING] << "#";
893                         else
894                                 lyxerr[Debug::PAINTING] << "[" <<
895                                     repaintAll << row_has_changed <<
896                                     cursor_on_row << "]";
897                         rp.paintAppendix();
898                         rp.paintDepthBar();
899                         rp.paintChangeBar();
900                         if (rit == rb)
901                                 rp.paintFirst();
902                         if (rit + 1 == re)
903                                 rp.paintLast();
904                         rp.paintText();
905                 }
906                 y += rit->descent();
907                 // Restore, see above
908                 refreshInside = tmp;
909         }
910         lyxerr[Debug::PAINTING] << "." << endl;
911 }
912
913 } // namespace anon
914
915
916 void paintText(BufferView & bv, ViewMetricsInfo const & vi,
917                Painter & pain)
918 {
919         LyXText & text = bv.buffer()->text();
920         bool const select = bv.cursor().selection();
921
922         PainterInfo pi(const_cast<BufferView *>(&bv), pain);
923         // Should the whole screen, including insets, be refreshed?
924         bool repaintAll = select || !vi.singlepar;
925
926         if (repaintAll) {
927                 // Clear background (if not delegated to rows)
928                 pain.fillRectangle(0, vi.y1, bv.workWidth(), vi.y2 - vi.y1,
929                         text.backgroundColor());
930         }
931         if (select) {
932                 text.drawSelection(pi, 0, 0);
933         }
934
935         int yy = vi.y1;
936         // draw contents
937         for (pit_type pit = vi.p1; pit <= vi.p2; ++pit) {
938                 refreshInside = repaintAll;
939                 Paragraph const & par = text.getPar(pit);
940                 yy += par.ascent();
941                 paintPar(pi, text, pit, 0, yy, repaintAll);
942                 yy += par.descent();
943         }
944
945         // Cache one paragraph above and one below
946         // Note MV: this cannot be suppressed even for singlepar.
947         // Try viewing the User Guide Mobius figure
948
949         if (vi.p1 > 0) {
950                 text.redoParagraph(vi.p1 - 1);
951                 bv.coordCache().parPos()[&text][vi.p1 - 1] =
952                         Point(0, vi.y1 - text.getPar(vi.p1 - 1).descent());
953         }
954
955         if (vi.p2 < lyx::pit_type(text.paragraphs().size()) - 1) {
956                 text.redoParagraph(vi.p2 + 1);
957                 bv.coordCache().parPos()[&text][vi.p2 + 1] =
958                         Point(0, vi.y2 + text.getPar(vi.p2 + 1).ascent());
959         }
960
961         // and grey out above (should not happen later)
962 //      lyxerr << "par ascent: " << text.getPar(vi.p1).ascent() << endl;
963         if (vi.y1 > 0 && !vi.singlepar)
964                 pain.fillRectangle(0, 0, bv.workWidth(), vi.y1, LColor::bottomarea);
965
966         // and possibly grey out below
967 //      lyxerr << "par descent: " << text.getPar(vi.p1).ascent() << endl;
968         if (vi.y2 < bv.workHeight() && !vi.singlepar)
969                 pain.fillRectangle(0, vi.y2, bv.workWidth(), bv.workHeight() - vi.y2, LColor::bottomarea);
970 }
971
972
973 void paintTextInset(LyXText const & text, PainterInfo & pi, int x, int y)
974 {
975 //      lyxerr << "  paintTextInset: y: " << y << endl;
976
977         y -= text.getPar(0).ascent();
978         // This flag can not be set from within same inset:
979         bool repaintAll = refreshInside;
980         for (int pit = 0; pit < int(text.paragraphs().size()); ++pit) {
981                 y += text.getPar(pit).ascent();
982                 paintPar(pi, text, pit, x, y, repaintAll);
983                 y += text.getPar(pit).descent();
984         }
985 }