src/rowpainter.C

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