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