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 "frontends/Painter.h"
  15 #include "frontends/screen.h"
  16 #include "frontends/font_metrics.h"
  17 #include "support/LAssert.h"
  18 #include "paragraph.h"
  19 #include "paragraph_funcs.h"
  20 #include "support/textutils.h"
  21
  22 #include "insets/insettext.h"
  23 #include "ParagraphParameters.h"
  24 #include "BufferView.h"
  25 #include "buffer.h"
  26 #include "gettext.h"
  27 #include "language.h"
  28 #include "encoding.h"
  29 #include "lyxtext.h"
  30 #include "lyxrow.h"
  31 #include "rowpainter.h"
  32 #include "lyxrc.h"
  33 #include "lyxrow_funcs.h"
  34 #include "metricsinfo.h"
  35
  36 #include <algorithm>
  37
  38 using namespace lyx::support;
  39
  40 using std::max;
  41 using lyx::pos_type;
  42
  43 extern int PAPER_MARGIN;
  44 extern int CHANGEBAR_MARGIN;
  45 extern int LEFT_MARGIN;
  46
  47 namespace {
  48
  49 // "temporary". We'll never get to use more
  50 // references until we start adding hacks like
  51 // these until other places catch up.
  52 BufferView * perv(BufferView const & bv)
  53 {
  54         return const_cast<BufferView *>(&bv);
  55 }
  56
  57 /**
  58  * A class used for painting an individual row of text.
  59  */
  60 class RowPainter {
  61 public:
  62         /// initialise painter
  63         RowPainter(BufferView const & bv, LyXText const & text,
  64                 RowList::iterator rit, int y_offset, int x_offset, int y);
  65
  66         /// do the painting
  67         void paint();
  68 private:
  69         // paint various parts
  70         void paintBackground();
  71         void paintSelection();
  72         void paintAppendix();
  73         void paintDepthBar();
  74         void paintChangeBar();
  75         void paintFirst();
  76         void paintLast();
  77         void paintForeignMark(float const orig_x, LyXFont const & orig_font);
  78         void paintHebrewComposeChar(lyx::pos_type & vpos);
  79         void paintArabicComposeChar(lyx::pos_type & vpos);
  80         void paintChars(lyx::pos_type & vpos, bool hebrew, bool arabic);
  81         int paintPageBreak(string const & label, int y);
  82         int paintAppendixStart(int y);
  83         int paintLengthMarker(string const & prefix, VSpace const & vsp, int start);
  84         void paintText();
  85         void paintFromPos(lyx::pos_type & vpos);
  86         void paintInset(lyx::pos_type const pos);
  87
  88         /// return left margin
  89         int leftMargin() const;
  90
  91         /// return the font at the given pos
  92         LyXFont const getFont(lyx::pos_type pos) const;
  93
  94         /// return the label font for this row
  95         LyXFont const getLabelFont() const;
  96
  97         char const transformChar(char c, lyx::pos_type pos) const;
  98
  99         /// return pixel width for the given pos
 100         int singleWidth(lyx::pos_type pos) const;
 101         int singleWidth(lyx::pos_type pos, char c) const;
 102
 103         /// bufferview to paint on
 104         BufferView const & bv_;
 105
 106         /// Painter to use
 107         Painter & pain_;
 108
 109         /// LyXText for the row
 110         LyXText const & text_;
 111
 112         /// The row to paint
 113         RowList::iterator row_;
 114
 115         /// Row's paragraph
 116         mutable ParagraphList::iterator  pit_;
 117
 118         // Looks ugly - is
 119         int xo_;
 120         int yo_;
 121         float x_;
 122         int y_;
 123         int width_;
 124         float separator_;
 125         float hfill_;
 126         float label_hfill_;
 127 };
 128
 129 RowPainter::RowPainter(BufferView const & bv, LyXText const & text,
 130      RowList::iterator rit,
 131      int y_offset, int x_offset, int y)
 132         : bv_(bv), pain_(bv_.painter()), text_(text), row_(rit),
 133           pit_(rit->par()),
 134                 xo_(x_offset), yo_(y_offset), y_(y)
 135 {}
 136
 137
 138 /// "temporary"
 139 LyXFont const RowPainter::getFont(pos_type pos) const
 140 {
 141         return text_.getFont(bv_.buffer(), pit_, pos);
 142 }
 143
 144
 145 int RowPainter::singleWidth(lyx::pos_type pos) const
 146 {
 147         return text_.singleWidth(pit_, pos);
 148 }
 149
 150
 151 int RowPainter::singleWidth(lyx::pos_type pos, char c) const
 152 {
 153         return text_.singleWidth(pit_, pos, c);
 154 }
 155
 156
 157 LyXFont const RowPainter::getLabelFont() const
 158 {
 159         return text_.getLabelFont(bv_.buffer(), pit_);
 160 }
 161
 162
 163 char const RowPainter::transformChar(char c, lyx::pos_type pos) const
 164 {
 165         return text_.transformChar(c, *pit_, pos);
 166 }
 167
 168
 169 int RowPainter::leftMargin() const
 170 {
 171         return text_.leftMargin(*row_);
 172 }
 173
 174
 175 void RowPainter::paintInset(pos_type const pos)
 176 {
 177         Inset * inset = const_cast<Inset*>(pit_->getInset(pos));
 178
 179         Assert(inset);
 180
 181 #warning inset->update FIXME
 182         inset->update(perv(bv_), false);
 183
 184         PainterInfo pi(perv(bv_));
 185         pi.base.font = getFont(pos);
 186         int const w = inset->width(perv(bv_), pi.base.font);
 187         inset->draw(pi, int(x_), yo_ + row_->baseline());
 188         x_ += w;
 189 }
 190
 191
 192 void RowPainter::paintHebrewComposeChar(pos_type & vpos)
 193 {
 194         pos_type pos = text_.vis2log(vpos);
 195
 196         string str;
 197
 198         // first char
 199         char c = pit_->getChar(pos);
 200         str += c;
 201         ++vpos;
 202
 203         LyXFont const & font = getFont(pos);
 204         int const width = font_metrics::width(c, font);
 205         int dx = 0;
 206
 207         for (pos_type i = pos - 1; i >= 0; --i) {
 208                 c = pit_->getChar(i);
 209                 if (!Encodings::IsComposeChar_hebrew(c)) {
 210                         if (IsPrintableNonspace(c)) {
 211                                 int const width2 =
 212                                         singleWidth(i, c);
 213                                 // dalet / resh
 214                                 dx = (c == 'ø' || c == 'ã')
 215                                         ? width2 - width
 216                                         : (width2 - width) / 2;
 217                         }
 218                         break;
 219                 }
 220         }
 221
 222         // Draw nikud
 223         pain_.text(int(x_) + dx, yo_ + row_->baseline(), str, font);
 224 }
 225
 226
 227 void RowPainter::paintArabicComposeChar(pos_type & vpos)
 228 {
 229         pos_type pos = text_.vis2log(vpos);
 230         string str;
 231
 232         // first char
 233         char c = pit_->getChar(pos);
 234         c = transformChar(c, pos);
 235         str +=c;
 236         ++vpos;
 237
 238         LyXFont const & font = getFont(pos);
 239         int const width = font_metrics::width(c, font);
 240         int dx = 0;
 241
 242         for (pos_type i = pos - 1; i >= 0; --i) {
 243                 c = pit_->getChar(i);
 244                 if (!Encodings::IsComposeChar_arabic(c)) {
 245                         if (IsPrintableNonspace(c)) {
 246                                 int const width2 =
 247                                         singleWidth(i, c);
 248                                 dx = (width2 - width) / 2;
 249                         }
 250                         break;
 251                 }
 252         }
 253         // Draw nikud
 254         pain_.text(int(x_) + dx, yo_ + row_->baseline(), str, font);
 255 }
 256
 257
 258 void RowPainter::paintChars(pos_type & vpos, bool hebrew, bool arabic)
 259 {
 260         pos_type pos = text_.vis2log(vpos);
 261         pos_type const last = lastPrintablePos(text_, row_);
 262         LyXFont orig_font(getFont(pos));
 263
 264         // first character
 265         string str;
 266         str += pit_->getChar(pos);
 267         if (arabic) {
 268                 unsigned char c = str[0];
 269                 str[0] = transformChar(c, pos);
 270         }
 271
 272         bool prev_struckout(isDeletedText(*pit_, pos));
 273         bool prev_newtext(isInsertedText(*pit_, pos));
 274
 275         ++vpos;
 276
 277         // collect as much similar chars as we can
 278         while (vpos <= last && (pos = text_.vis2log(vpos)) >= 0) {
 279                 char c = pit_->getChar(pos);
 280
 281                 if (!IsPrintableNonspace(c))
 282                         break;
 283
 284                 if (prev_struckout != isDeletedText(*pit_, pos))
 285                         break;
 286
 287                 if (prev_newtext != isInsertedText(*pit_, pos))
 288                         break;
 289
 290                 if (arabic && Encodings::IsComposeChar_arabic(c))
 291                         break;
 292                 if (hebrew && Encodings::IsComposeChar_hebrew(c))
 293                         break;
 294
 295                 if (orig_font != getFont(pos))
 296                         break;
 297
 298                 if (arabic)
 299                         c = transformChar(c, pos);
 300                 str += c;
 301                 ++vpos;
 302         }
 303
 304         if (prev_struckout) {
 305                 orig_font.setColor(LColor::strikeout);
 306         } else if (prev_newtext) {
 307                 orig_font.setColor(LColor::newtext);
 308         }
 309
 310         // Draw text and set the new x position
 311         pain_.text(int(x_), yo_ + row_->baseline(), str, orig_font);
 312         x_ += font_metrics::width(str, orig_font);
 313 }
 314
 315
 316 void RowPainter::paintForeignMark(float const orig_x, LyXFont const & orig_font)
 317 {
 318         if (!lyxrc.mark_foreign_language)
 319                 return;
 320         if (orig_font.language() == latex_language)
 321                 return;
 322         if (orig_font.language() == bv_.buffer()->params.language)
 323                 return;
 324
 325         int const y = yo_ + row_->baseline() + 1;
 326         pain_.line(int(orig_x), y, int(x_), y, LColor::language);
 327 }
 328
 329
 330 void RowPainter::paintFromPos(pos_type & vpos)
 331 {
 332         pos_type const pos = text_.vis2log(vpos);
 333
 334         LyXFont const & orig_font = getFont(pos);
 335
 336         float const orig_x = x_;
 337
 338         char const c = pit_->getChar(pos);
 339
 340         if (IsInsetChar(c)) {
 341                 paintInset(pos);
 342                 ++vpos;
 343                 paintForeignMark(orig_x, orig_font);
 344                 return;
 345         }
 346
 347         // usual characters, no insets
 348
 349         // special case languages
 350         bool const hebrew = (orig_font.language()->lang() == "hebrew");
 351         bool const arabic =
 352                 orig_font.language()->lang() == "arabic" &&
 353                 (lyxrc.font_norm_type == LyXRC::ISO_8859_6_8 ||
 354                 lyxrc.font_norm_type == LyXRC::ISO_10646_1);
 355
 356         // draw as many chars as we can
 357         if ((!hebrew && !arabic)
 358                 || (hebrew && !Encodings::IsComposeChar_hebrew(c))
 359                 || (arabic && !Encodings::IsComposeChar_arabic(c))) {
 360                 paintChars(vpos, hebrew, arabic);
 361         } else if (hebrew) {
 362                 paintHebrewComposeChar(vpos);
 363         } else if (arabic) {
 364                 paintArabicComposeChar(vpos);
 365         }
 366
 367         paintForeignMark(orig_x, orig_font);
 368
 369         return;
 370 }
 371
 372
 373 void RowPainter::paintBackground()
 374 {
 375         int const x = xo_;
 376         int const y = yo_ < 0 ? 0 : yo_;
 377         int const h = yo_ < 0 ? row_->height() + yo_ : row_->height();
 378         pain_.fillRectangle(x, y, width_, h, text_.backgroundColor());
 379 }
 380
 381
 382 void RowPainter::paintSelection()
 383 {
 384         bool const is_rtl = pit_->isRightToLeftPar(bv_.buffer()->params);
 385
 386         // the current selection
 387         int const startx = text_.selection.start.x();
 388         int const endx = text_.selection.end.x();
 389         int const starty = text_.selection.start.y();
 390         int const endy = text_.selection.end.y();
 391         RowList::iterator startrow = text_.getRow(text_.selection.start);
 392         RowList::iterator endrow = text_.getRow(text_.selection.end);
 393
 394         if (text_.bidi_same_direction) {
 395                 int x;
 396                 int y = yo_;
 397                 int w;
 398                 int h = row_->height();
 399
 400                 if (startrow == row_ && endrow == row_) {
 401                         if (startx < endx) {
 402                                 x = xo_ + startx;
 403                                 w = endx - startx;
 404                                 pain_.fillRectangle(x, y, w, h, LColor::selection);
 405                         } else {
 406                                 x = xo_ + endx;
 407                                 w = startx - endx;
 408                                 pain_.fillRectangle(x, y, w, h, LColor::selection);
 409                         }
 410                 } else if (startrow == row_) {
 411                         int const x = (is_rtl) ? xo_ : (xo_ + startx);
 412                         int const w = (is_rtl) ? startx : (width_ - startx);
 413                         pain_.fillRectangle(x, y, w, h, LColor::selection);
 414                 } else if (endrow == row_) {
 415                         int const x = (is_rtl) ? (xo_ + endx) : xo_;
 416                         int const w = (is_rtl) ? (width_ - endx) : endx;
 417                         pain_.fillRectangle(x, y, w, h, LColor::selection);
 418                 } else if (y_ > starty && y_ < endy) {
 419                         pain_.fillRectangle(xo_, y, width_, h, LColor::selection);
 420                 }
 421                 return;
 422         } else if (startrow != row_ && endrow != row_) {
 423                 if (y_ > starty && y_ < endy) {
 424                         int w = width_;
 425                         int h = row_->height();
 426                         pain_.fillRectangle(xo_, yo_, w, h, LColor::selection);
 427                 }
 428                 return;
 429         }
 430
 431         if ((startrow != row_ && !is_rtl) || (endrow != row_ && is_rtl))
 432                 pain_.fillRectangle(xo_, yo_, int(x_), row_->height(), LColor::selection);
 433
 434         pos_type const body_pos = pit_->beginningOfBody();
 435         pos_type const last = lastPrintablePos(text_, row_);
 436         float tmpx = x_;
 437
 438         for (pos_type vpos = row_->pos(); vpos <= last; ++vpos)  {
 439                 pos_type pos = text_.vis2log(vpos);
 440                 float const old_tmpx = tmpx;
 441                 if (body_pos > 0 && pos == body_pos - 1) {
 442                         LyXLayout_ptr const & layout = pit_->layout();
 443                         LyXFont const lfont = getLabelFont();
 444
 445                         tmpx += label_hfill_ + font_metrics::width(layout->labelsep, lfont);
 446
 447                         if (pit_->isLineSeparator(body_pos - 1))
 448                                 tmpx -= singleWidth(body_pos - 1);
 449                 }
 450
 451                 if (hfillExpansion(text_, row_, pos)) {
 452                         tmpx += singleWidth(pos);
 453                         if (pos >= body_pos)
 454                                 tmpx += hfill_;
 455                         else
 456                                 tmpx += label_hfill_;
 457                 }
 458
 459                 else if (pit_->isSeparator(pos)) {
 460                         tmpx += singleWidth(pos);
 461                         if (pos >= body_pos)
 462                                 tmpx += separator_;
 463                 } else {
 464                         tmpx += singleWidth(pos);
 465                 }
 466
 467                 if ((startrow != row_ || text_.selection.start.pos() <= pos) &&
 468                         (endrow != row_ || pos < text_.selection.end.pos())) {
 469                         // Here we do not use x_ as xo_ was added to x_.
 470                         pain_.fillRectangle(int(old_tmpx), yo_,
 471                                 int(tmpx - old_tmpx + 1),
 472                                 row_->height(), LColor::selection);
 473                 }
 474         }
 475
 476         if ((startrow != row_ && is_rtl) || (endrow != row_ && !is_rtl)) {
 477                 pain_.fillRectangle(xo_ + int(tmpx),
 478                                       yo_, int(bv_.workWidth() - tmpx),
 479                                       row_->height(), LColor::selection);
 480         }
 481 }
 482
 483
 484 void RowPainter::paintChangeBar()
 485 {
 486         pos_type const start = row_->pos();
 487         pos_type const end = lastPrintablePos(text_, row_);
 488
 489         if (!pit_->isChanged(start, end))
 490                 return;
 491
 492         int const height = (boost::next(row_) != text_.rows().end()
 493                 ? row_->height() + boost::next(row_)->top_of_text()
 494                 : row_->baseline());
 495
 496         pain_.fillRectangle(4, yo_, 5, height, LColor::changebar);
 497 }
 498
 499
 500 void RowPainter::paintAppendix()
 501 {
 502         if (!pit_->params().appendix())
 503                 return;
 504
 505         // FIXME: can be just width_ ?
 506         int const ww = bv_.workWidth();
 507
 508         int y = yo_;
 509
 510         if (pit_->params().startOfAppendix())
 511                 y += 2 * defaultRowHeight();
 512
 513         pain_.line(1, y, 1, yo_ + row_->height(), LColor::appendix);
 514         pain_.line(ww - 2, y, ww - 2, yo_ + row_->height(), LColor::appendix);
 515 }
 516
 517
 518 void RowPainter::paintDepthBar()
 519 {
 520         Paragraph::depth_type const depth = pit_->getDepth();
 521
 522         if (depth <= 0)
 523                 return;
 524
 525         Paragraph::depth_type prev_depth = 0;
 526         if (row_ != text_.rows().begin())
 527                 prev_depth = boost::prior(row_)->par()->getDepth();
 528         Paragraph::depth_type next_depth = 0;
 529
 530         RowList::iterator next_row = boost::next(row_);
 531         if (next_row != text_.rows().end())
 532                 next_depth = next_row->par()->getDepth();
 533
 534         for (Paragraph::depth_type i = 1; i <= depth; ++i) {
 535                 int x = (PAPER_MARGIN / 5) * i + xo_;
 536                 // only consider the changebar space if we're drawing outer left
 537                 if (!xo_)
 538                         x += CHANGEBAR_MARGIN;
 539                 int const h = yo_ + row_->height() - 1 - (i - next_depth - 1) * 3;
 540
 541                 pain_.line(x, yo_, x, h, LColor::depthbar);
 542
 543                 int const w = PAPER_MARGIN / 5;
 544
 545                 if (i > prev_depth) {
 546                         pain_.fillRectangle(x, yo_, w, 2, LColor::depthbar);
 547                 }
 548                 if (i > next_depth) {
 549                         pain_.fillRectangle(x, h, w, 2, LColor::depthbar);
 550                 }
 551         }
 552 }
 553
 554
 555 int RowPainter::paintLengthMarker(string const & prefix, VSpace const & vsp, int start)
 556 {
 557         if (vsp.kind() == VSpace::NONE)
 558                 return 0;
 559
 560         int const arrow_size = 4;
 561         int const size = getLengthMarkerHeight(bv_, vsp);
 562         int const end = start + size;
 563
 564         // the label to display (if any)
 565         string str;
 566         // y-values for top arrow
 567         int ty1, ty2;
 568         // y-values for bottom arrow
 569         int by1, by2;
 570
 571         str = prefix + " (" + vsp.asLyXCommand() + ")";
 572
 573         if (vsp.kind() == VSpace::VFILL) {
 574                 ty1 = ty2 = start;
 575                 by1 = by2 = end;
 576         } else {
 577                 // adding or removing space
 578                 bool const added = vsp.kind() != VSpace::LENGTH ||
 579                                    vsp.length().len().value() > 0.0;
 580                 ty1 = added ? (start + arrow_size) : start;
 581                 ty2 = added ? start : (start + arrow_size);
 582                 by1 = added ? (end - arrow_size) : end;
 583                 by2 = added ? end : (end - arrow_size);
 584         }
 585
 586         int const leftx = xo_ + leftMargin();
 587         int const midx = leftx + arrow_size;
 588         int const rightx = midx + arrow_size;
 589
 590         // first the string
 591         int w = 0;
 592         int a = 0;
 593         int d = 0;
 594
 595         LyXFont font;
 596         font.setColor(LColor::added_space).decSize().decSize();
 597         font_metrics::rectText(str, font, w, a, d);
 598
 599         pain_.rectText(leftx + 2 * arrow_size + 5,
 600                          start + ((end - start) / 2) + d,
 601                          str, font);
 602
 603         // top arrow
 604         pain_.line(leftx, ty1, midx, ty2, LColor::added_space);
 605         pain_.line(midx, ty2, rightx, ty1, LColor::added_space);
 606
 607         // bottom arrow
 608         pain_.line(leftx, by1, midx, by2, LColor::added_space);
 609         pain_.line(midx, by2, rightx, by1, LColor::added_space);
 610
 611         // joining line
 612         pain_.line(midx, ty2, midx, by2, LColor::added_space);
 613
 614         return size;
 615 }
 616
 617
 618 int RowPainter::paintPageBreak(string const & label, int y)
 619 {
 620         LyXFont pb_font;
 621         pb_font.setColor(LColor::pagebreak).decSize();
 622
 623         int w = 0;
 624         int a = 0;
 625         int d = 0;
 626         font_metrics::rectText(label, pb_font, w, a, d);
 627
 628         int const text_start = xo_ + ((width_ - w) / 2);
 629         int const text_end = text_start + w;
 630
 631         pain_.rectText(text_start, y + d, label, pb_font);
 632
 633         pain_.line(xo_, y, text_start, y,
 634                 LColor::pagebreak, Painter::line_onoffdash);
 635         pain_.line(text_end, y, xo_ + width_, y,
 636                 LColor::pagebreak, Painter::line_onoffdash);
 637
 638         return 3 * defaultRowHeight();
 639 }
 640
 641
 642 int RowPainter::paintAppendixStart(int y)
 643 {
 644         LyXFont pb_font;
 645         pb_font.setColor(LColor::appendix).decSize();
 646
 647         string const label = _("Appendix");
 648         int w = 0;
 649         int a = 0;
 650         int d = 0;
 651         font_metrics::rectText(label, pb_font, w, a, d);
 652
 653         int const text_start = xo_ + ((width_ - w) / 2);
 654         int const text_end = text_start + w;
 655
 656         pain_.rectText(text_start, y + d, label, pb_font);
 657
 658         pain_.line(xo_ + 1, y, text_start, y, LColor::appendix);
 659         pain_.line(text_end, y, xo_ + width_ - 2, y, LColor::appendix);
 660
 661         return 3 * defaultRowHeight();
 662 }
 663
 664
 665 void RowPainter::paintFirst()
 666 {
 667         ParagraphParameters const & parparams = pit_->params();
 668
 669         int y_top = 0;
 670
 671         // start of appendix?
 672         if (parparams.startOfAppendix()) {
 673                 y_top += paintAppendixStart(yo_ + y_top + 2 * defaultRowHeight());
 674         }
 675
 676         // the top margin
 677         if (row_ == text_.rows().begin() && !text_.isInInset())
 678                 y_top += PAPER_MARGIN;
 679
 680         // draw a top pagebreak
 681         if (parparams.pagebreakTop()) {
 682                 y_top += paintPageBreak(_("Page Break (top)"),
 683                         yo_ + y_top + 2 * defaultRowHeight());
 684         }
 685
 686         // draw the additional space if needed:
 687         y_top += paintLengthMarker(_("Space above"), parparams.spaceTop(),
 688                         yo_ + y_top);
 689
 690         Buffer const * buffer = bv_.buffer();
 691
 692         LyXLayout_ptr const & layout = pit_->layout();
 693
 694         if (buffer->params.paragraph_separation == BufferParams::PARSEP_SKIP) {
 695                 if (pit_ != text_.ownerParagraphs().begin()) {
 696                         if (layout->latextype == LATEX_PARAGRAPH
 697                                 && !pit_->getDepth()) {
 698                                 y_top += buffer->params.getDefSkip().inPixels(bv_);
 699                         } else {
 700                                 LyXLayout_ptr const & playout =
 701                                         boost::prior(pit_)->layout();
 702                                 if (playout->latextype == LATEX_PARAGRAPH
 703                                         && !boost::prior(pit_)->getDepth()) {
 704                                         // is it right to use defskip here, too? (AS)
 705                                         y_top += buffer->params.getDefSkip().inPixels(bv_);
 706                                 }
 707                         }
 708                 }
 709         }
 710
 711         int const ww = bv_.workWidth();
 712
 713         // draw a top line
 714         if (parparams.lineTop()) {
 715                 LyXFont font(LyXFont::ALL_SANE);
 716                 int const asc = font_metrics::ascent('x', getFont(0));
 717
 718                 y_top += asc;
 719
 720                 int const w = (text_.isInInset() ? text_.inset_owner->width(perv(bv_), font) : ww);
 721                 int const xp = static_cast<int>(text_.isInInset() ? xo_ : 0);
 722                 pain_.line(xp, yo_ + y_top, xp + w, yo_ + y_top,
 723                         LColor::topline, Painter::line_solid,
 724                         Painter::line_thick);
 725
 726                 y_top += asc;
 727         }
 728
 729         bool const is_rtl = pit_->isRightToLeftPar(bv_.buffer()->params);
 730
 731         // should we print a label?
 732         if (layout->labeltype >= LABEL_STATIC
 733             && (layout->labeltype != LABEL_STATIC
 734                 || layout->latextype != LATEX_ENVIRONMENT
 735                 || isFirstInSequence(pit_, text_.ownerParagraphs()))) {
 736
 737                 LyXFont font = getLabelFont();
 738                 if (!pit_->getLabelstring().empty()) {
 739                         float x = x_;
 740                         string const str = pit_->getLabelstring();
 741
 742                         // this is special code for the chapter layout. This is
 743                         // printed in an extra row and has a pagebreak at
 744                         // the top.
 745                         if (layout->labeltype == LABEL_COUNTER_CHAPTER) {
 746                                 if (buffer->params.secnumdepth >= 0) {
 747                                         float spacing_val = 1.0;
 748                                         if (!parparams.spacing().isDefault()) {
 749                                                 spacing_val = parparams.spacing().getValue();
 750                                         } else {
 751                                                 spacing_val = buffer->params.spacing.getValue();
 752                                         }
 753
 754                                         int const maxdesc =
 755                                                 int(font_metrics::maxDescent(font) * layout->spacing.getValue() * spacing_val)
 756                                                 + int(layout->parsep) * defaultRowHeight();
 757
 758                                         if (is_rtl) {
 759                                                 x = ww - leftMargin() -
 760                                                         font_metrics::width(str, font);
 761                                         }
 762
 763                                         pain_.text(int(x),
 764                                                 yo_ + row_->baseline() -
 765                                                 row_->ascent_of_text() - maxdesc,
 766                                                 str, font);
 767                                 }
 768                         } else {
 769                                 if (is_rtl) {
 770                                         x = ww - leftMargin()
 771                                                 + font_metrics::width(layout->labelsep, font);
 772                                 } else {
 773                                         x = x_ - font_metrics::width(layout->labelsep, font)
 774                                                 - font_metrics::width(str, font);
 775                                 }
 776
 777                                 pain_.text(int(x), yo_ + row_->baseline(), str, font);
 778                         }
 779                 }
 780
 781         // the labels at the top of an environment.
 782         // More or less for bibliography
 783         } else if (isFirstInSequence(pit_, text_.ownerParagraphs()) &&
 784                 (layout->labeltype == LABEL_TOP_ENVIRONMENT ||
 785                 layout->labeltype == LABEL_BIBLIO ||
 786                 layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)) {
 787                 LyXFont font = getLabelFont();
 788                 if (!pit_->getLabelstring().empty()) {
 789                         string const str = pit_->getLabelstring();
 790                         float spacing_val = 1.0;
 791                         if (!parparams.spacing().isDefault()) {
 792                                 spacing_val = parparams.spacing().getValue();
 793                         } else {
 794                                 spacing_val = buffer->params.spacing.getValue();
 795                         }
 796
 797                         int maxdesc =
 798                                 int(font_metrics::maxDescent(font) * layout->spacing.getValue() * spacing_val
 799                                 + (layout->labelbottomsep * defaultRowHeight()));
 800
 801                         float x = x_;
 802                         if (layout->labeltype == LABEL_CENTERED_TOP_ENVIRONMENT) {
 803                                 x = ((is_rtl ? leftMargin() : x_)
 804                                          + ww - text_.rightMargin(*bv_.buffer(), *row_)) / 2;
 805                                 x -= font_metrics::width(str, font) / 2;
 806                         } else if (is_rtl) {
 807                                 x = ww - leftMargin() -
 808                                         font_metrics::width(str, font);
 809                         }
 810                         pain_.text(int(x), yo_ + row_->baseline()
 811                                   - row_->ascent_of_text() - maxdesc,
 812                                   str, font);
 813                 }
 814         }
 815 }
 816
 817
 818 void RowPainter::paintLast()
 819 {
 820         ParagraphParameters const & parparams = pit_->params();
 821         int y_bottom = row_->height() - 1;
 822
 823         // the bottom margin
 824         if (boost::next(row_) == text_.rows().end() && !text_.isInInset())
 825                 y_bottom -= PAPER_MARGIN;
 826
 827         int const ww = bv_.workWidth();
 828
 829         // draw a bottom pagebreak
 830         if (parparams.pagebreakBottom()) {
 831                 y_bottom -= paintPageBreak(_("Page Break (bottom)"),
 832                         yo_ + y_bottom - 2 * defaultRowHeight());
 833         }
 834
 835         // draw the additional space if needed:
 836         int const height = getLengthMarkerHeight(bv_, parparams.spaceBottom());
 837         y_bottom -= paintLengthMarker(_("Space below"), parparams.spaceBottom(),
 838                              yo_ + y_bottom - height);
 839
 840         // draw a bottom line
 841         if (parparams.lineBottom()) {
 842                 LyXFont font(LyXFont::ALL_SANE);
 843                 int const asc = font_metrics::ascent('x',
 844                         getFont(max(pos_type(0), pit_->size() - 1)));
 845
 846                 y_bottom -= asc;
 847
 848                 int const w = (text_.isInInset() ? text_.inset_owner->width(perv(bv_), font) : ww);
 849                 int const xp = static_cast<int>(text_.isInInset() ? xo_ : 0);
 850                 int const y = yo_ + y_bottom;
 851                 pain_.line(xp, y, xp + w, y, LColor::topline, Painter::line_solid,
 852                           Painter::line_thick);
 853
 854                 y_bottom -= asc;
 855         }
 856
 857         bool const is_rtl = pit_->isRightToLeftPar(bv_.buffer()->params);
 858         int const endlabel = getEndLabel(pit_, text_.ownerParagraphs());
 859
 860         // draw an endlabel
 861         switch (endlabel) {
 862         case END_LABEL_BOX:
 863         case END_LABEL_FILLED_BOX:
 864         {
 865                 LyXFont const font = getLabelFont();
 866                 int const size = int(0.75 * font_metrics::maxAscent(font));
 867                 int const y = (yo_ + row_->baseline()) - size;
 868                 int x = is_rtl ? LEFT_MARGIN : ww - PAPER_MARGIN - size;
 869
 870                 if (row_->fill() <= size)
 871                         x += (size - row_->fill() + 1) * (is_rtl ? -1 : 1);
 872
 873                 if (endlabel == END_LABEL_BOX) {
 874                         pain_.rectangle(x, y, size, size, LColor::eolmarker);
 875                 } else {
 876                         pain_.fillRectangle(x, y, size, size, LColor::eolmarker);
 877                 }
 878                 break;
 879         }
 880         case END_LABEL_STATIC:
 881         {
 882                 LyXFont font = getLabelFont();
 883                 string const & str = pit_->layout()->endlabelstring();
 884                 int const x = is_rtl ?
 885                         int(x_) - font_metrics::width(str, font)
 886                         : ww - text_.rightMargin(*bv_.buffer(), *row_) - row_->fill();
 887                 pain_.text(x, yo_ + row_->baseline(), str, font);
 888                 break;
 889         }
 890         case END_LABEL_NO_LABEL:
 891                 break;
 892         }
 893 }
 894
 895
 896 void RowPainter::paintText()
 897 {
 898         pos_type const last = lastPrintablePos(text_, row_);
 899         pos_type body_pos = pit_->beginningOfBody();
 900         if (body_pos > 0 &&
 901                 (body_pos - 1 > last ||
 902                 !pit_->isLineSeparator(body_pos - 1))) {
 903                 body_pos = 0;
 904         }
 905
 906         LyXLayout_ptr const & layout = pit_->layout();
 907
 908         bool running_strikeout = false;
 909         bool is_struckout = false;
 910         float last_strikeout_x = 0.0;
 911
 912         pos_type vpos = row_->pos();
 913         while (vpos <= last) {
 914                 if (x_ > bv_.workWidth())
 915                         break;
 916                 pos_type pos = text_.vis2log(vpos);
 917
 918                 if (pos >= pit_->size()) {
 919                         ++vpos;
 920                         continue;
 921                 }
 922
 923                 if (x_ + singleWidth(pos) < 0) {
 924                         x_ += singleWidth(pos);
 925                         ++vpos;
 926                         continue;
 927                 }
 928
 929                 is_struckout = isDeletedText(*pit_, pos);
 930
 931                 if (is_struckout && !running_strikeout) {
 932                         running_strikeout = true;
 933                         last_strikeout_x = x_;
 934                 }
 935
 936                 bool const highly_editable_inset = pit_->isInset(pos)
 937                         && isHighlyEditableInset(pit_->getInset(pos));
 938
 939                 // if we reach the end of a struck out range, paint it
 940                 // we also don't paint across things like tables
 941                 if (running_strikeout && (highly_editable_inset || !is_struckout)) {
 942                         int const middle = yo_ + row_->top_of_text()
 943                                 + ((row_->baseline() - row_->top_of_text()) / 2);
 944                         pain_.line(int(last_strikeout_x), middle, int(x_), middle,
 945                                 LColor::strikeout, Painter::line_solid, Painter::line_thin);
 946                         running_strikeout = false;
 947                 }
 948
 949                 if (body_pos > 0 && pos == body_pos - 1) {
 950                         int const lwidth = font_metrics::width(layout->labelsep,
 951                                 getLabelFont());
 952
 953                         x_ += label_hfill_ + lwidth
 954                                 - singleWidth(body_pos - 1);
 955                 }
 956
 957                 if (pit_->isHfill(pos)) {
 958                         x_ += 1;
 959
 960                         int const y0 = yo_ + row_->baseline();
 961                         int const y1 = y0 - defaultRowHeight() / 2;
 962
 963                         pain_.line(int(x_), y1, int(x_), y0,
 964                                      LColor::added_space);
 965
 966                         if (hfillExpansion(text_, row_, pos)) {
 967                                 int const y2 = (y0 + y1) / 2;
 968
 969                                 if (pos >= body_pos) {
 970                                         pain_.line(int(x_), y2,
 971                                                   int(x_ + hfill_), y2,
 972                                                   LColor::added_space,
 973                                                   Painter::line_onoffdash);
 974                                         x_ += hfill_;
 975                                 } else {
 976                                         pain_.line(int(x_), y2,
 977                                                   int(x_ + label_hfill_), y2,
 978                                                   LColor::added_space,
 979                                                   Painter::line_onoffdash);
 980                                         x_ += label_hfill_;
 981                                 }
 982                                 pain_.line(int(x_), y1,
 983                                              int(x_), y0,
 984                                              LColor::added_space);
 985                         }
 986                         x_ += 2;
 987                         ++vpos;
 988                 } else if (pit_->isSeparator(pos)) {
 989                         x_ += singleWidth(pos);
 990                         if (pos >= body_pos)
 991                                 x_ += separator_;
 992                         ++vpos;
 993                 } else {
 994                         paintFromPos(vpos);
 995                 }
 996         }
 997
 998         // if we reach the end of a struck out range, paint it
 999         if (running_strikeout) {
1000                 int const middle = yo_ + row_->top_of_text()
1001                         + ((row_->baseline() - row_->top_of_text()) / 2);
1002                 pain_.line(int(last_strikeout_x), middle, int(x_), middle,
1003                         LColor::strikeout, Painter::line_solid, Painter::line_thin);
1004                 running_strikeout = false;
1005         }
1006         return;
1007 }
1008
1009
1010 void RowPainter::paint()
1011 {
1012         width_ = text_.isInInset()
1013                 ? text_.inset_owner->textWidth(perv(bv_), true) : bv_.workWidth();
1014
1015         // FIXME: must be a cleaner way here. Aren't these calculations
1016         // belonging to row metrics ?
1017         text_.prepareToPrint(row_, x_, separator_, hfill_, label_hfill_);
1018
1019         // FIXME: what is this fixing ?
1020         if (text_.isInInset() && (x_ < 0))
1021                 x_ = 0;
1022         x_ += xo_;
1023
1024         // If we're *not* at the top-level of rows, then the
1025         // background has already been cleared.
1026         if (&text_ == bv_.text)
1027                 paintBackground();
1028
1029         // paint the selection background
1030         if (text_.selection.set()) {
1031                 paintSelection();
1032         }
1033
1034         // vertical lines for appendix
1035         paintAppendix();
1036
1037         // environment depth brackets
1038         paintDepthBar();
1039
1040         // changebar
1041         paintChangeBar();
1042
1043         if (row_->isParStart()) {
1044                 paintFirst();
1045         }
1046
1047         if (isParEnd(text_, row_)) {
1048                 paintLast();
1049         }
1050
1051         // paint text
1052         paintText();
1053 }
1054
1055
1056 } // namespace anon
1057
1058
1059 int getLengthMarkerHeight(BufferView const & bv, VSpace const & vsp)
1060 {
1061         if (vsp.kind() == VSpace::NONE)
1062                 return 0;
1063
1064         int const arrow_size = 4;
1065         int const space_size = int(vsp.inPixels(bv));
1066
1067         LyXFont font;
1068         font.decSize();
1069         int const min_size = max(3 * arrow_size,
1070                 font_metrics::maxAscent(font)
1071                 + font_metrics::maxDescent(font));
1072
1073         if (vsp.length().len().value() < 0.0)
1074                 return min_size;
1075         else
1076                 return max(min_size, space_size);
1077 }
1078
1079
1080 void paintRows(BufferView const & bv, LyXText const & text,
1081         RowList::iterator rit, int y_offset, int x_offset, int y)
1082 {
1083         RowPainter painter(bv, text, rit, y_offset, x_offset, y);
1084         painter.paint();
1085 }