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