src/RowPainter.cpp

   1 /**
   2  * \file RowPainter.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author various
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13 #include <algorithm>
  14
  15 #include "RowPainter.h"
  16
  17 #include "Buffer.h"
  18 #include "CoordCache.h"
  19 #include "Cursor.h"
  20 #include "BufferParams.h"
  21 #include "BufferView.h"
  22 #include "Changes.h"
  23 #include "Language.h"
  24 #include "Layout.h"
  25 #include "LyXRC.h"
  26 #include "Row.h"
  27 #include "MetricsInfo.h"
  28 #include "Paragraph.h"
  29 #include "ParagraphMetrics.h"
  30 #include "ParagraphParameters.h"
  31 #include "TextMetrics.h"
  32 #include "VSpace.h"
  33
  34 #include "frontends/FontMetrics.h"
  35 #include "frontends/Painter.h"
  36
  37 #include "insets/InsetText.h"
  38
  39 #include "mathed/InsetMath.h"
  40
  41 #include "support/debug.h"
  42 #include "support/gettext.h"
  43 #include "support/textutils.h"
  44
  45 #include "support/lassert.h"
  46 #include <boost/crc.hpp>
  47
  48 using namespace std;
  49
  50 namespace lyx {
  51
  52 using frontend::Painter;
  53 using frontend::FontMetrics;
  54
  55
  56 RowPainter::RowPainter(PainterInfo & pi,
  57         Text const & text, pit_type pit, Row const & row, int x, int y)
  58         : pi_(pi), text_(text),
  59           text_metrics_(pi_.base.bv->textMetrics(&text)),
  60           pars_(text.paragraphs()),
  61           row_(row), pit_(pit), par_(text.paragraphs()[pit]),
  62           pm_(text_metrics_.parMetrics(pit)), change_(pi_.change_),
  63           xo_(x), yo_(y), width_(text_metrics_.width()),
  64           solid_line_thickness_(1), solid_line_offset_(1),
  65           dotted_line_thickness_(1), dotted_line_offset_(2)
  66 {
  67         bidi_.computeTables(par_, pi_.base.bv->buffer(), row_);
  68
  69         if (lyxrc.zoom >= 200) {
  70                 // derive the line thickness from zoom factor
  71                 // the zoom is given in percent
  72                 // (increase thickness at 250%, 450% etc.)
  73                 solid_line_thickness_ = (lyxrc.zoom + 50) / 200;
  74                 // adjust line_offset_ too
  75                 solid_line_offset_ = 1 + solid_line_thickness_ / 2;
  76         }
  77         if (lyxrc.zoom >= 100) {
  78                 // derive the line thickness from zoom factor
  79                 // the zoom is given in percent
  80                 // (increase thickness at 150%, 250% etc.)
  81                 dotted_line_thickness_ = (lyxrc.zoom + 50) / 100;
  82                 // adjust line_offset_ too
  83                 dotted_line_offset_ = 1 + dotted_line_thickness_ / 2;
  84         }
  85
  86         x_ = row_.left_margin + xo_;
  87
  88         //lyxerr << "RowPainter: x: " << x_ << " xo: " << xo_ << " yo: " << yo_ << endl;
  89         //row_.dump();
  90
  91         LBUFERR(pit >= 0);
  92         LBUFERR(pit < int(text.paragraphs().size()));
  93 }
  94
  95
  96 FontInfo RowPainter::labelFont() const
  97 {
  98         FontInfo f = text_.labelFont(par_);
  99         // selected text?
 100         if (row_.begin_margin_sel || pi_.selected)
 101                 f.setPaintColor(Color_selectiontext);
 102         return f;
 103 }
 104
 105
 106 int RowPainter::leftMargin() const
 107 {
 108         return text_metrics_.leftMargin(text_metrics_.width(), pit_,
 109                 row_.pos());
 110 }
 111
 112 // If you want to debug inset metrics uncomment the following line:
 113 //#define DEBUG_METRICS
 114 // This draws green lines around each inset.
 115
 116
 117 void RowPainter::paintInset(Inset const * inset, pos_type const pos)
 118 {
 119         // Handle selection
 120         bool const pi_selected = pi_.selected;
 121         Cursor const & cur = pi_.base.bv->cursor();
 122         if (cur.selection() && cur.text() == &text_
 123                 && cur.normalAnchor().text() == &text_)
 124                 pi_.selected = row_.sel_beg <= pos && row_.sel_end > pos;
 125
 126         Font const font = text_metrics_.displayFont(pit_, pos);
 127
 128         LASSERT(inset, return);
 129         // Backup full_repaint status because some insets (InsetTabular)
 130         // requires a full repaint
 131         bool const pi_full_repaint = pi_.full_repaint;
 132         bool const pi_do_spellcheck = pi_.do_spellcheck;
 133
 134         pi_.base.font = inset->inheritFont() ? font.fontInfo() :
 135                 pi_.base.bv->buffer().params().getFont().fontInfo();
 136         pi_.ltr_pos = (bidi_.level(pos) % 2 == 0);
 137         Change prev_change = change_;
 138         pi_.change_ = change_.changed() ? change_ : par_.lookupChange(pos);
 139         pi_.do_spellcheck &= inset->allowSpellCheck();
 140
 141         int const x1 = int(x_);
 142         pi_.base.bv->coordCache().insets().add(inset, x1, yo_);
 143         // insets are painted completely. Recursive
 144         // FIXME: it is wrong to completely paint the background
 145         // if we want to do single row painting.
 146         inset->drawBackground(pi_, x1, yo_);
 147         inset->drawSelection(pi_, x1, yo_);
 148         inset->draw(pi_, x1, yo_);
 149
 150         Dimension const & dim = pm_.insetDimension(inset);
 151
 152         paintForeignMark(x_, font.language(), dim.descent());
 153
 154         x_ += dim.width();
 155
 156         // Restore full_repaint status.
 157         pi_.full_repaint = pi_full_repaint;
 158         pi_.change_ = prev_change;
 159         pi_.do_spellcheck = pi_do_spellcheck;
 160         pi_.selected = pi_selected;
 161
 162 #ifdef DEBUG_METRICS
 163         int const x2 = x1 + dim.wid;
 164         int const y1 = yo_ + dim.des;
 165         int const y2 = yo_ - dim.asc;
 166         pi_.pain.line(x1, y1, x1, y2, Color_green);
 167         pi_.pain.line(x1, y1, x2, y1, Color_green);
 168         pi_.pain.line(x2, y1, x2, y2, Color_green);
 169         pi_.pain.line(x1, y2, x2, y2, Color_green);
 170 #endif
 171 }
 172
 173
 174 void RowPainter::paintSeparator(double width, Font const & font)
 175 {
 176         pi_.pain.textDecoration(font.fontInfo(), int(x_), yo_, int(width));
 177         x_ += width;
 178 }
 179
 180
 181 void RowPainter::paintForeignMark(double orig_x, Language const * lang, int desc) const
 182 {
 183         if (!lyxrc.mark_foreign_language)
 184                 return;
 185         if (lang == latex_language)
 186                 return;
 187         if (lang == pi_.base.bv->buffer().params().language)
 188                 return;
 189
 190         int const y = yo_ + solid_line_offset_ + desc + solid_line_thickness_ / 2;
 191         pi_.pain.line(int(orig_x), y, int(x_), y, Color_language,
 192                 Painter::line_solid, solid_line_thickness_);
 193 }
 194
 195
 196 void RowPainter::paintMisspelledMark(double const orig_x,
 197                                      docstring const & str, Font const & font,
 198                                      pos_type const start_pos,
 199                                      bool const changed) const
 200 {
 201         // if changed the misspelled marker gets placed slightly lower than normal
 202         // to avoid drawing at the same vertical offset
 203         int const y = yo_ + solid_line_offset_ + solid_line_thickness_
 204                 + (changed ? solid_line_thickness_ + 1 : 0)
 205                 + dotted_line_offset_;
 206
 207         //FIXME: this could be computed only once, it is probably not costly.
 208         // check for cursor position
 209         // don't draw misspelled marker for words at cursor position
 210         // we don't want to disturb the process of text editing
 211         DocIterator const nw = pi_.base.bv->cursor().newWord();
 212         pos_type cpos = -1;
 213         if (!nw.empty() && par_.id() == nw.paragraph().id()) {
 214                 cpos = nw.pos();
 215                 if (cpos > 0 && cpos == par_.size() && !par_.isWordSeparator(cpos-1))
 216                         --cpos;
 217                 else if (cpos > 0 && par_.isWordSeparator(cpos))
 218                         --cpos;
 219         }
 220
 221         pos_type pos = start_pos;
 222         while (pos < start_pos + pos_type(str.length())) {
 223                 if (!par_.isMisspelled(pos)) {
 224                         ++pos;
 225                         continue;
 226                 }
 227
 228                 FontSpan const & range = par_.getSpellRange(pos);
 229
 230                 // Skip element which are being edited
 231                 if (range.contains(cpos)) {
 232                         // the range includes the last element
 233                         pos = range.last + 1;
 234                         continue;
 235                 }
 236
 237                 FontMetrics const & fm = theFontMetrics(font);
 238                 int x1 = fm.pos2x(str, range.first - start_pos,
 239                                   font.isVisibleRightToLeft());
 240                 int x2 = fm.pos2x(str, min(range.last - start_pos + 1,
 241                                            pos_type(str.length())),
 242                                   font.isVisibleRightToLeft());
 243                 if (x1 > x2)
 244                         swap(x1, x2);
 245
 246                 pi_.pain.line(int(orig_x) + x1, y, int(orig_x) + x2, y,
 247                               Color_error,
 248                               Painter::line_onoffdash, dotted_line_thickness_);
 249                 pos = range.last + 1;
 250         }
 251 }
 252
 253
 254 void RowPainter::paintStringAndSel(docstring const & str, Font const & font,
 255                                  Change const & change,
 256                                  pos_type start_pos, pos_type end_pos)
 257 {
 258         // at least part of text selected?
 259         bool const some_sel = (end_pos >= row_.sel_beg && start_pos < row_.sel_end)
 260                 || pi_.selected;
 261         // all the text selected?
 262         bool const all_sel = (start_pos >= row_.sel_beg && end_pos < row_.sel_end)
 263                 || pi_.selected;
 264
 265         if (all_sel) {
 266                 Font copy = font;
 267                 copy.fontInfo().setPaintColor(Color_selectiontext);
 268                 x_ += pi_.pain.text(int(x_), yo_, str, copy);
 269         } else if (change.changed()) {
 270                 Font copy = font;
 271                 copy.fontInfo().setPaintColor(change.color());
 272                 x_ += pi_.pain.text(int(x_), yo_, str, copy);
 273         } else if (!some_sel) {
 274                 x_ += pi_.pain.text(int(x_), yo_, str, font);
 275         } else {
 276                 x_ += pi_.pain.text(int(x_), yo_, str, font, Color_selectiontext,
 277                                     max(row_.sel_beg, start_pos) - start_pos,
 278                                     min(row_.sel_end, end_pos) - start_pos);
 279         }
 280 }
 281
 282
 283 void RowPainter::paintFromPos(pos_type & vpos, bool changed)
 284 {
 285         pos_type pos = bidi_.vis2log(vpos);
 286         pos_type start_pos = pos;
 287         // first character
 288         docstring str;
 289         str.reserve(100);
 290         char_type const c = par_.getChar(pos);
 291         str.push_back(c);
 292
 293         double const orig_x = x_;
 294
 295         Font const font = text_metrics_.displayFont(pit_, pos);
 296         FontSpan const font_span = par_.fontSpan(pos);
 297         // Track-change status.
 298         Change const & change_running = par_.lookupChange(pos);
 299
 300         // collect as much similar chars as we can
 301         pos_type const end = row_.endpos();
 302         for (++vpos ; vpos < end ; ++vpos) {
 303                 pos = bidi_.vis2log(vpos);
 304
 305                 if (!font_span.contains(pos))
 306                         break;
 307
 308                 Change const & change = par_.lookupChange(pos);
 309                 if (!change_running.isSimilarTo(change))
 310                         // Track change type or author has changed.
 311                         break;
 312
 313                 char_type const c = par_.getChar(pos);
 314
 315                 if (c == '\t')
 316                         break;
 317
 318                 if (!isPrintableNonspace(c))
 319                         break;
 320
 321                 str.push_back(c);
 322         }
 323
 324         // Make pos point to the last character in the string.
 325         // Using "pos = bidi_.vis2log(vpos)" does not work for some reason.
 326         if (vpos < end)
 327                 pos = bidi_.vis2log(vpos - 1);
 328
 329         // Now make pos point to the position _after_ the string.
 330         // Using vis2log for that is not a good idea in general, we
 331         // want logical ordering.
 332         if (font.isVisibleRightToLeft())
 333                 --pos;
 334         else
 335                 ++pos;
 336
 337         if (str[0] == '\t')
 338                 str.replace(0,1,from_ascii("    "));
 339
 340         /* Because we do our own bidi, at this point the strings are
 341          * already in visual order. However, Qt also applies its own
 342          * bidi algorithm to strings that it paints to the screen.
 343          * Therefore, if we were to paint Hebrew/Arabic words as a
 344          * single string, the letters in the words would get reversed
 345          * again. In order to avoid that, we reverse our string.
 346          * See also http://thread.gmane.org/gmane.editors.lyx.devel/79740
 347          * for an earlier thread on the subject
 348          */
 349         if (font.isVisibleRightToLeft()) {
 350                 reverse(str.begin(), str.end());
 351                 // If the string is reversed, the positions need to be adjusted
 352                 ++pos;
 353                 ++start_pos;
 354                 swap(start_pos, pos);
 355         }
 356
 357         // Actually paint the text, taking care about the selection
 358         paintStringAndSel(str, font, change_running, start_pos, pos);
 359
 360         // The line that indicates word in a different language
 361         paintForeignMark(orig_x, font.language());
 362
 363         // Paint the spelling mark if needed.
 364         if (lyxrc.spellcheck_continuously && pi_.do_spellcheck
 365                 && par_.isMisspelled(start_pos)) {
 366                 paintMisspelledMark(orig_x, str, font, start_pos, changed);
 367         }
 368 }
 369
 370
 371 void RowPainter::paintChangeBar() const
 372 {
 373         pos_type const start = row_.pos();
 374         pos_type end = row_.endpos();
 375
 376         if (par_.size() == end) {
 377                 // this is the last row of the paragraph;
 378                 // thus, we must also consider the imaginary end-of-par character
 379                 end++;
 380         }
 381
 382         if (start == end || !par_.isChanged(start, end))
 383                 return;
 384
 385         int const height = text_metrics_.isLastRow(pit_, row_)
 386                 ? row_.ascent()
 387                 : row_.height();
 388
 389         pi_.pain.fillRectangle(5, yo_ - row_.ascent(), 3, height, Color_changebar);
 390 }
 391
 392
 393 void RowPainter::paintAppendix() const
 394 {
 395         // only draw the appendix frame once (for the main text)
 396         if (!par_.params().appendix() || !text_.isMainText())
 397                 return;
 398
 399         int y = yo_ - row_.ascent();
 400
 401         if (par_.params().startOfAppendix())
 402                 y += 2 * defaultRowHeight();
 403
 404         pi_.pain.line(1, y, 1, yo_ + row_.height(), Color_appendix);
 405         pi_.pain.line(width_ - 2, y, width_ - 2, yo_ + row_.height(), Color_appendix);
 406 }
 407
 408
 409 void RowPainter::paintDepthBar() const
 410 {
 411         depth_type const depth = par_.getDepth();
 412
 413         if (depth <= 0)
 414                 return;
 415
 416         depth_type prev_depth = 0;
 417         if (!text_metrics_.isFirstRow(pit_, row_)) {
 418                 pit_type pit2 = pit_;
 419                 if (row_.pos() == 0)
 420                         --pit2;
 421                 prev_depth = pars_[pit2].getDepth();
 422         }
 423
 424         depth_type next_depth = 0;
 425         if (!text_metrics_.isLastRow(pit_, row_)) {
 426                 pit_type pit2 = pit_;
 427                 if (row_.endpos() >= pars_[pit2].size())
 428                         ++pit2;
 429                 next_depth = pars_[pit2].getDepth();
 430         }
 431
 432         for (depth_type i = 1; i <= depth; ++i) {
 433                 int const w = nestMargin() / 5;
 434                 int x = int(xo_) + w * i;
 435                 // only consider the changebar space if we're drawing outermost text
 436                 if (text_.isMainText())
 437                         x += changebarMargin();
 438
 439                 int const starty = yo_ - row_.ascent();
 440                 int const h =  row_.height() - 1 - (i - next_depth - 1) * 3;
 441
 442                 pi_.pain.line(x, starty, x, starty + h, Color_depthbar);
 443
 444                 if (i > prev_depth)
 445                         pi_.pain.fillRectangle(x, starty, w, 2, Color_depthbar);
 446                 if (i > next_depth)
 447                         pi_.pain.fillRectangle(x, starty + h, w, 2, Color_depthbar);
 448         }
 449 }
 450
 451
 452 int RowPainter::paintAppendixStart(int y) const
 453 {
 454         FontInfo pb_font = sane_font;
 455         pb_font.setColor(Color_appendix);
 456         pb_font.decSize();
 457
 458         int w = 0;
 459         int a = 0;
 460         int d = 0;
 461
 462         docstring const label = _("Appendix");
 463         theFontMetrics(pb_font).rectText(label, w, a, d);
 464
 465         int const text_start = int(xo_ + (width_ - w) / 2);
 466         int const text_end = text_start + w;
 467
 468         pi_.pain.rectText(text_start, y + d, label, pb_font, Color_none, Color_none);
 469
 470         pi_.pain.line(int(xo_ + 1), y, text_start, y, Color_appendix);
 471         pi_.pain.line(text_end, y, int(xo_ + width_ - 2), y, Color_appendix);
 472
 473         return 3 * defaultRowHeight();
 474 }
 475
 476
 477 void RowPainter::paintTooLargeMarks(bool const left, bool const right) const
 478 {
 479         if (left)
 480                 pi_.pain.line(dotted_line_thickness_, yo_ - row_.ascent(),
 481                                           dotted_line_thickness_, yo_ + row_.descent(),
 482                                           Color_scroll,
 483                                           Painter::line_onoffdash, dotted_line_thickness_);
 484         if (right) {
 485                 int const wwidth = pi_.base.bv->workWidth() - dotted_line_thickness_;
 486                 pi_.pain.line(wwidth, yo_ - row_.ascent(),
 487                                           wwidth, yo_ + row_.descent(),
 488                                           Color_scroll,
 489                                           Painter::line_onoffdash, dotted_line_thickness_);
 490         }
 491 }
 492
 493
 494 void RowPainter::paintFirst() const
 495 {
 496         BufferParams const & bparams = pi_.base.bv->buffer().params();
 497         Layout const & layout = par_.layout();
 498
 499         int y_top = 0;
 500
 501         // start of appendix?
 502         if (par_.params().startOfAppendix())
 503                 y_top += paintAppendixStart(yo_ - row_.ascent() + 2 * defaultRowHeight());
 504
 505         if (bparams.paragraph_separation == BufferParams::ParagraphSkipSeparation
 506                 && pit_ != 0) {
 507                 if (layout.latextype == LATEX_PARAGRAPH
 508                     && !par_.getDepth()) {
 509                         y_top += bparams.getDefSkip().inPixels(*pi_.base.bv);
 510                 } else {
 511                         Layout const & playout = pars_[pit_ - 1].layout();
 512                         if (playout.latextype == LATEX_PARAGRAPH
 513                             && !pars_[pit_ - 1].getDepth()) {
 514                                 // is it right to use defskip here, too? (AS)
 515                                 y_top += bparams.getDefSkip().inPixels(*pi_.base.bv);
 516                         }
 517                 }
 518         }
 519
 520         bool const is_first =
 521                 text_.isFirstInSequence(pit_) || !layout.isParagraphGroup();
 522         //lyxerr << "paintFirst: " << par_.id() << " is_seq: " << is_seq << endl;
 523
 524         if (layout.labelIsInline()
 525                         && (layout.labeltype != LABEL_STATIC || is_first)) {
 526                 paintLabel();
 527         } else if (is_first && layout.labelIsAbove()) {
 528                 paintTopLevelLabel();
 529         }
 530 }
 531
 532
 533 void RowPainter::paintLabel() const
 534 {
 535         docstring const str = par_.labelString();
 536         if (str.empty())
 537                 return;
 538
 539         bool const is_rtl = text_.isRTL(par_);
 540         Layout const & layout = par_.layout();
 541         FontInfo const font = labelFont();
 542         FontMetrics const & fm = theFontMetrics(font);
 543         double x = x_;
 544
 545         if (is_rtl) {
 546                 x = width_ - leftMargin()
 547                         + fm.width(layout.labelsep);
 548         } else {
 549                 x = x_ - fm.width(layout.labelsep)
 550                         - fm.width(str);
 551         }
 552
 553         pi_.pain.text(int(x), yo_, str, font);
 554 }
 555
 556
 557 void RowPainter::paintTopLevelLabel() const
 558 {
 559         BufferParams const & bparams = pi_.base.bv->buffer().params();
 560         bool const is_rtl = text_.isRTL(par_);
 561         ParagraphParameters const & pparams = par_.params();
 562         Layout const & layout = par_.layout();
 563         FontInfo const font = labelFont();
 564         docstring const str = par_.labelString();
 565         if (str.empty())
 566                 return;
 567
 568         double spacing_val = 1.0;
 569         if (!pparams.spacing().isDefault())
 570                 spacing_val = pparams.spacing().getValue();
 571         else
 572                 spacing_val = bparams.spacing().getValue();
 573
 574         FontMetrics const & fm = theFontMetrics(font);
 575
 576         int const labeladdon = int(fm.maxHeight()
 577                 * layout.spacing.getValue() * spacing_val);
 578
 579         int maxdesc =
 580                 int(fm.maxDescent() * layout.spacing.getValue() * spacing_val
 581                 + (layout.labelbottomsep * defaultRowHeight()));
 582
 583         double x = x_;
 584         if (layout.labeltype == LABEL_CENTERED) {
 585                 if (is_rtl)
 586                         x = leftMargin();
 587                 x += (width_ - text_metrics_.rightMargin(pm_) - leftMargin()) / 2;
 588                 x -= fm.width(str) / 2;
 589         } else if (is_rtl) {
 590                 x = width_ - leftMargin() -     fm.width(str);
 591         }
 592         pi_.pain.text(int(x), yo_ - maxdesc - labeladdon, str, font);
 593 }
 594
 595
 596 /** Check if the current paragraph is the last paragraph in a
 597     proof environment */
 598 static int getEndLabel(pit_type p, Text const & text)
 599 {
 600         ParagraphList const & pars = text.paragraphs();
 601         pit_type pit = p;
 602         depth_type par_depth = pars[p].getDepth();
 603         while (pit != pit_type(pars.size())) {
 604                 Layout const & layout = pars[pit].layout();
 605                 int const endlabeltype = layout.endlabeltype;
 606
 607                 if (endlabeltype != END_LABEL_NO_LABEL) {
 608                         if (p + 1 == pit_type(pars.size()))
 609                                 return endlabeltype;
 610
 611                         depth_type const next_depth =
 612                                 pars[p + 1].getDepth();
 613                         if (par_depth > next_depth ||
 614                             (par_depth == next_depth && layout != pars[p + 1].layout()))
 615                                 return endlabeltype;
 616                         break;
 617                 }
 618                 if (par_depth == 0)
 619                         break;
 620                 pit = text.outerHook(pit);
 621                 if (pit != pit_type(pars.size()))
 622                         par_depth = pars[pit].getDepth();
 623         }
 624         return END_LABEL_NO_LABEL;
 625 }
 626
 627
 628 void RowPainter::paintLast()
 629 {
 630         bool const is_rtl = text_.isRTL(par_);
 631         int const endlabel = getEndLabel(pit_, text_);
 632
 633         // paint imaginary end-of-paragraph character
 634
 635         Change const & change = par_.lookupChange(par_.size());
 636         if (change.changed()) {
 637                 FontMetrics const & fm =
 638                         theFontMetrics(pi_.base.bv->buffer().params().getFont());
 639                 int const length = fm.maxAscent() / 2;
 640                 Color col = change.color();
 641
 642                 pi_.pain.line(int(x_) + 1, yo_ + 2, int(x_) + 1, yo_ + 2 - length, col,
 643                            Painter::line_solid, 3);
 644
 645                 if (change.deleted()) {
 646                         pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1 + length,
 647                                 yo_ + 2, col, Painter::line_solid, 3);
 648                 } else {
 649                         pi_.pain.line(int(x_) + 1 - length, yo_ + 2, int(x_) + 1,
 650                                 yo_ + 2, col, Painter::line_solid, 3);
 651                 }
 652         }
 653
 654         // draw an endlabel
 655
 656         switch (endlabel) {
 657         case END_LABEL_BOX:
 658         case END_LABEL_FILLED_BOX: {
 659                 FontInfo const font = labelFont();
 660                 FontMetrics const & fm = theFontMetrics(font);
 661                 int const size = int(0.75 * fm.maxAscent());
 662                 int const y = yo_ - size;
 663                 int const max_row_width = width_ - size - Inset::TEXT_TO_INSET_OFFSET;
 664                 int x = is_rtl ? nestMargin() + changebarMargin()
 665                         : max_row_width - text_metrics_.rightMargin(pm_);
 666
 667                 // If needed, move the box a bit to avoid overlapping with text.
 668                 int const rem = max_row_width - row_.width();
 669                 if (rem <= 0)
 670                         x += is_rtl ? rem : - rem;
 671
 672                 if (endlabel == END_LABEL_BOX)
 673                         pi_.pain.rectangle(x, y, size, size, Color_eolmarker);
 674                 else
 675                         pi_.pain.fillRectangle(x, y, size, size, Color_eolmarker);
 676                 break;
 677         }
 678
 679         case END_LABEL_STATIC: {
 680                 FontInfo const font = labelFont();
 681                 FontMetrics const & fm = theFontMetrics(font);
 682                 docstring const & str = par_.layout().endlabelstring();
 683                 double const x = is_rtl ? x_ - fm.width(str) : x_;
 684                 pi_.pain.text(int(x), yo_, str, font);
 685                 break;
 686         }
 687
 688         case END_LABEL_NO_LABEL:
 689                 if (lyxrc.paragraph_markers && size_type(pit_ + 1) < pars_.size()) {
 690                         docstring const s = docstring(1, char_type(0x00B6));
 691                         FontInfo f = FontInfo(text_.layoutFont(pit_));
 692                         f.setColor(Color_paragraphmarker);
 693                         pi_.pain.text(int(x_), yo_, s, f);
 694                         x_ += theFontMetrics(f).width(s);
 695                 }
 696                 break;
 697         }
 698 }
 699
 700
 701 void RowPainter::paintOnlyInsets()
 702 {
 703         CoordCache const & cache = pi_.base.bv->coordCache();
 704         pos_type const end = row_.endpos();
 705         for (pos_type pos = row_.pos(); pos != end; ++pos) {
 706                 // If outer row has changed, nested insets are repaint completely.
 707                 Inset const * inset = par_.getInset(pos);
 708                 bool const nested_inset = inset &&
 709                                 ((inset->asInsetMath() &&
 710                                   !inset->asInsetMath()->asMacroTemplate())
 711                                  || inset->asInsetText()
 712                                  || inset->asInsetTabular());
 713                 if (!nested_inset)
 714                         continue;
 715                 if (x_ > pi_.base.bv->workWidth()
 716                     || !cache.getInsets().has(inset))
 717                         continue;
 718                 x_ = cache.getInsets().x(inset);
 719
 720                 bool const pi_selected = pi_.selected;
 721                 Cursor const & cur = pi_.base.bv->cursor();
 722                 if (cur.selection() && cur.text() == &text_
 723                           && cur.normalAnchor().text() == &text_)
 724                         pi_.selected = row_.sel_beg <= pos && row_.sel_end > pos;
 725                 paintInset(inset, pos);
 726                 pi_.selected = pi_selected;
 727         }
 728 }
 729
 730
 731 void RowPainter::paintText()
 732 {
 733         //LYXERR0("-------------------------------------------------------");
 734         pos_type const end = row_.endpos();
 735         // Spaces at logical line breaks in bidi text must be skipped during
 736         // painting. However, they may appear visually in the middle
 737         // of a row; they must be skipped, wherever they are...
 738         // * logically "abc_[HEBREW_\nHEBREW]"
 739         // * visually "abc_[_WERBEH\nWERBEH]"
 740         pos_type skipped_sep_vpos = -1;
 741         pos_type body_pos = par_.beginOfBody();
 742         if (body_pos > 0 &&
 743                 (body_pos > end || !par_.isLineSeparator(body_pos - 1))) {
 744                 body_pos = 0;
 745         }
 746
 747         Layout const & layout = par_.layout();
 748
 749         Change change_running;
 750         int change_last_x = 0;
 751
 752         // check for possible inline completion
 753         DocIterator const & inlineCompletionPos = pi_.base.bv->inlineCompletionPos();
 754         pos_type inlineCompletionVPos = -1;
 755         if (inlineCompletionPos.inTexted()
 756             && inlineCompletionPos.text() == &text_
 757             && inlineCompletionPos.pit() == pit_
 758             && inlineCompletionPos.pos() - 1 >= row_.pos()
 759             && inlineCompletionPos.pos() - 1 < row_.endpos()) {
 760                 // draw logically behind the previous character
 761                 inlineCompletionVPos = bidi_.log2vis(inlineCompletionPos.pos() - 1);
 762         }
 763
 764         // Use font span to speed things up, see below
 765         FontSpan font_span;
 766         Font font;
 767
 768         // If the last logical character is a separator, don't paint it, unless
 769         // it's in the last row of a paragraph; see skipped_sep_vpos declaration
 770         if (end > 0 && end < par_.size() && par_.isSeparator(end - 1))
 771                 skipped_sep_vpos = bidi_.log2vis(end - 1);
 772
 773         for (pos_type vpos = row_.pos(); vpos < end; ) {
 774                 if (x_ > pi_.base.bv->workWidth())
 775                         break;
 776
 777                 // Skip the separator at the logical end of the row
 778                 if (vpos == skipped_sep_vpos) {
 779                         ++vpos;
 780                         continue;
 781                 }
 782
 783                 pos_type const pos = bidi_.vis2log(vpos);
 784
 785                 if (pos >= par_.size()) {
 786                         ++vpos;
 787                         continue;
 788                 }
 789
 790                 // Use font span to speed things up, see above
 791                 if (!font_span.contains(pos)) {
 792                         font_span = par_.fontSpan(pos);
 793                         font = text_metrics_.displayFont(pit_, pos);
 794
 795                         // split font span if inline completion is inside
 796                         if (inlineCompletionVPos != -1
 797                             && font_span.contains(inlineCompletionPos.pos()))
 798                                 font_span.last = inlineCompletionPos.pos();
 799                 }
 800
 801                 // Note that this value will only be used in
 802                 // situations where no ligature of composition of
 803                 // characters is needed. (see comments in uses of width_pos).
 804                 const int width_pos = pm_.singleWidth(pos, font);
 805
 806                 Change const & change = par_.lookupChange(pos);
 807                 if (change.changed() && !change_running.changed()) {
 808                         change_running = change;
 809                         change_last_x = int(x_);
 810                 }
 811
 812                 Inset const * inset = par_.getInset(pos);
 813                 bool const highly_editable_inset = inset
 814                         && inset->editable();
 815
 816                 // If we reach the end of a change or if the author changes, paint it.
 817                 // We also don't paint across things like tables
 818                 if (change_running.changed() && (highly_editable_inset
 819                         || !change.changed() || !change_running.isSimilarTo(change))) {
 820                         // Calculate 1/3 height of the buffer's default font
 821                         FontMetrics const & fm
 822                                 = theFontMetrics(pi_.base.bv->buffer().params().getFont());
 823                         int const y_bar = change_running.deleted() ?
 824                                 yo_ - fm.maxAscent() / 3 : yo_ + 2 * solid_line_offset_ + solid_line_thickness_;
 825                         pi_.pain.line(change_last_x, y_bar, int(x_), y_bar,
 826                                 change_running.color(), Painter::line_solid, solid_line_thickness_);
 827
 828                         // Change might continue with a different author or type
 829                         if (change.changed() && !highly_editable_inset) {
 830                                 change_running = change;
 831                                 change_last_x = int(x_);
 832                         } else
 833                                 change_running.setUnchanged();
 834                 }
 835
 836                 if (body_pos > 0 && pos == body_pos - 1) {
 837                         int const lwidth = theFontMetrics(labelFont())
 838                                 .width(layout.labelsep);
 839
 840                         // width_pos is either the width of a space or an inset
 841                         x_ += row_.label_hfill + lwidth - width_pos;
 842                 }
 843
 844                 // Is the inline completion in front of character?
 845                 if (font.isRightToLeft() && vpos == inlineCompletionVPos)
 846                         paintInlineCompletion(font);
 847
 848                 if (par_.isSeparator(pos)) {
 849                         Font const orig_font = text_metrics_.displayFont(pit_, pos);
 850                         double const orig_x = x_;
 851                         // width_pos is the width of a space
 852                         double separator_width = width_pos;
 853                         if (pos >= body_pos)
 854                                 separator_width += row_.separator;
 855                         paintSeparator(separator_width, orig_font);
 856                         paintForeignMark(orig_x, orig_font.language());
 857                         ++vpos;
 858
 859                 } else if (inset) {
 860                         // If outer row has changed, nested insets are repaint completely.
 861                         pi_.base.bv->coordCache().insets().add(inset, int(x_), yo_);
 862                         paintInset(inset, pos);
 863                         ++vpos;
 864
 865                 } else {
 866                         // paint as many characters as possible.
 867                         paintFromPos(vpos, change_running.changed());
 868                 }
 869
 870                 // Is the inline completion after character?
 871                 if (!font.isRightToLeft() && vpos - 1 == inlineCompletionVPos)
 872                         paintInlineCompletion(font);
 873         }
 874
 875         // if we reach the end of a struck out range, paint it
 876         if (change_running.changed()) {
 877                 FontMetrics const & fm
 878                         = theFontMetrics(pi_.base.bv->buffer().params().getFont());
 879                 int const y_bar = change_running.deleted() ?
 880                                 yo_ - fm.maxAscent() / 3 : yo_ + 2 * solid_line_offset_ + solid_line_thickness_;
 881                 pi_.pain.line(change_last_x, y_bar, int(x_), y_bar,
 882                         change_running.color(), Painter::line_solid, solid_line_thickness_);
 883                 change_running.setUnchanged();
 884         }
 885 }
 886
 887
 888 void RowPainter::paintSelection() const
 889 {
 890         if (!row_.selection())
 891                 return;
 892         Cursor const & curs = pi_.base.bv->cursor();
 893         DocIterator beg = curs.selectionBegin();
 894         beg.pit() = pit_;
 895         beg.pos() = row_.sel_beg;
 896
 897         DocIterator end = curs.selectionEnd();
 898         end.pit() = pit_;
 899         end.pos() = row_.sel_end;
 900
 901         bool const begin_boundary = beg.pos() >= row_.endpos();
 902         bool const end_boundary = row_.sel_end == row_.endpos();
 903
 904         DocIterator cur = beg;
 905         cur.boundary(begin_boundary);
 906         int x1 = text_metrics_.cursorX(beg.top(), begin_boundary);
 907         int x2 = text_metrics_.cursorX(end.top(), end_boundary);
 908         int const y1 = yo_ - row_.ascent();
 909         int const y2 = y1 + row_.height();
 910
 911         int const rm = text_.isMainText() ? pi_.base.bv->rightMargin() : 0;
 912         int const lm = text_.isMainText() ? pi_.base.bv->leftMargin() : 0;
 913
 914         // draw the margins
 915         if (row_.begin_margin_sel) {
 916                 if (text_.isRTL(beg.paragraph())) {
 917                         pi_.pain.fillRectangle(int(xo_ + x1), y1,
 918                                 text_metrics_.width() - rm - x1, y2 - y1, Color_selection);
 919                 } else {
 920                         pi_.pain.fillRectangle(int(xo_ + lm), y1, x1 - lm, y2 - y1,
 921                                 Color_selection);
 922                 }
 923         }
 924
 925         if (row_.end_margin_sel) {
 926                 if (text_.isRTL(beg.paragraph())) {
 927                         pi_.pain.fillRectangle(int(xo_ + lm), y1, x2 - lm, y2 - y1,
 928                                 Color_selection);
 929                 } else {
 930                         pi_.pain.fillRectangle(int(xo_ + x2), y1, text_metrics_.width() - rm - x2,
 931                                 y2 - y1, Color_selection);
 932                 }
 933         }
 934
 935         // if we are on a boundary from the beginning, it's probably
 936         // a RTL boundary and we jump to the other side directly as this
 937         // segement is 0-size and confuses the logic below
 938         if (cur.boundary())
 939                 cur.boundary(false);
 940
 941         // go through row and draw from RTL boundary to RTL boundary
 942         while (cur < end) {
 943                 bool draw_now = false;
 944
 945                 // simplified cursorForward code below which does not
 946                 // descend into insets and which does not go into the
 947                 // next line. Compare the logic with the original cursorForward
 948
 949                 // if left of boundary -> just jump to right side, but
 950                 // for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
 951                 if (cur.boundary()) {
 952                         cur.boundary(false);
 953                 }       else if (text_metrics_.isRTLBoundary(cur.pit(), cur.pos() + 1)) {
 954                         // in front of RTL boundary -> Stay on this side of the boundary
 955                         // because:  ab|cDDEEFFghi -> abc|DDEEFFghi
 956                         ++cur.pos();
 957                         cur.boundary(true);
 958                         draw_now = true;
 959                 } else {
 960                         // move right
 961                         ++cur.pos();
 962
 963                         // line end?
 964                         if (cur.pos() == row_.endpos())
 965                                 cur.boundary(true);
 966                 }
 967
 968                 if (x1 == -1) {
 969                         // the previous segment was just drawn, now the next starts
 970                         x1 = text_metrics_.cursorX(cur.top(), cur.boundary());
 971                 }
 972
 973                 if (!(cur < end) || draw_now) {
 974                         x2 = text_metrics_.cursorX(cur.top(), cur.boundary());
 975                         pi_.pain.fillRectangle(int(xo_ + min(x1, x2)), y1, abs(x2 - x1),
 976                                 y2 - y1, Color_selection);
 977
 978                         // reset x1, so it is set again next round (which will be on the
 979                         // right side of a boundary or at the selection end)
 980                         x1 = -1;
 981                 }
 982         }
 983 }
 984
 985
 986 void RowPainter::paintInlineCompletion(Font const & font)
 987 {
 988         docstring completion = pi_.base.bv->inlineCompletion();
 989         FontInfo f = font.fontInfo();
 990         bool rtl = font.isRightToLeft();
 991
 992         // draw the unique and the non-unique completion part
 993         // Note: this is not time-critical as it is
 994         // only done once per screen.
 995         size_t uniqueTo = pi_.base.bv->inlineCompletionUniqueChars();
 996         docstring s1 = completion.substr(0, uniqueTo);
 997         docstring s2 = completion.substr(uniqueTo);
 998         ColorCode c1 = Color_inlinecompletion;
 999         ColorCode c2 = Color_nonunique_inlinecompletion;
1000
1001         // right to left?
1002         if (rtl) {
1003                 swap(s1, s2);
1004                 swap(c1, c2);
1005         }
1006
1007         if (!s1.empty()) {
1008                 f.setColor(c1);
1009                 pi_.pain.text(int(x_), yo_, s1, f);
1010                 x_ += theFontMetrics(font).width(s1);
1011         }
1012
1013         if (!s2.empty()) {
1014                 f.setColor(c2);
1015                 pi_.pain.text(int(x_), yo_, s2, f);
1016                 x_ += theFontMetrics(font).width(s2);
1017         }
1018 }
1019
1020 } // namespace lyx