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