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