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