src/Row.cpp

   1 /**
   2  * \file Row.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author John Levon
   8  * \author André Pönitz
   9  * \author Jürgen Vigna
  10  * \author Jean-Marc Lasgouttes
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  *
  14  * Metrics for an on-screen text row.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "Row.h"
  20
  21 #include "DocIterator.h"
  22
  23 #include "frontends/FontMetrics.h"
  24
  25 #include "support/debug.h"
  26 #include "support/lassert.h"
  27 #include "support/lstrings.h"
  28 #include "support/lyxalgo.h"
  29
  30 #include <ostream>
  31
  32 using namespace std;
  33
  34 namespace lyx {
  35
  36 using support::rtrim;
  37 using frontend::FontMetrics;
  38
  39
  40 // Maximum length that a space can be stretched when justifying text
  41 static double const MAX_SPACE_STRETCH = 1.5; //em
  42
  43
  44 int Row::Element::countSeparators() const
  45 {
  46         if (type != STRING)
  47                 return 0;
  48         return count(str.begin(), str.end(), ' ');
  49 }
  50
  51
  52 int Row::Element::countExpanders() const
  53 {
  54         if (type != STRING)
  55                 return 0;
  56         return theFontMetrics(font).countExpanders(str);
  57 }
  58
  59
  60 int Row::Element::expansionAmount() const
  61 {
  62         if (type != STRING)
  63                 return 0;
  64         return countExpanders() * theFontMetrics(font).em();
  65 }
  66
  67
  68 void Row::Element::setExtra(double extra_per_em)
  69 {
  70         if (type != STRING)
  71                 return;
  72         extra = extra_per_em * theFontMetrics(font).em();
  73 }
  74
  75
  76 double Row::Element::pos2x(pos_type const i) const
  77 {
  78         // This can happen with inline completion when clicking on the
  79         // row after the completion.
  80         if (i < pos || i > endpos)
  81                 return 0;
  82
  83         double w = 0;
  84         //handle first the two bounds of the element
  85         if (i == endpos && type != VIRTUAL)
  86                 w = isRTL() ? 0 : full_width();
  87         else if (i == pos || type != STRING)
  88                 w = isRTL() ? full_width() : 0;
  89         else {
  90                 FontMetrics const & fm = theFontMetrics(font);
  91                 w = fm.pos2x(str, i - pos, isRTL(), extra);
  92         }
  93
  94         return w;
  95 }
  96
  97
  98 pos_type Row::Element::x2pos(int &x) const
  99 {
 100         //lyxerr << "x2pos: x=" << x << " w=" << width() << " " << *this;
 101         size_t i = 0;
 102
 103         switch (type) {
 104         case STRING: {
 105                 FontMetrics const & fm = theFontMetrics(font);
 106                 i = fm.x2pos(str, x, isRTL(), extra);
 107                 break;
 108         }
 109         case VIRTUAL:
 110                 // those elements are actually empty (but they have a width)
 111                 i = 0;
 112                 x = isRTL() ? int(full_width()) : 0;
 113                 break;
 114         case INSET:
 115         case SPACE:
 116                 // those elements contain only one position. Round to
 117                 // the closest side.
 118                 if (x > full_width()) {
 119                         x = int(full_width());
 120                         i = !isRTL();
 121                 } else {
 122                         x = 0;
 123                         i = isRTL();
 124                 }
 125
 126         }
 127         //lyxerr << "=> p=" << pos + i << " x=" << x << endl;
 128         return pos + i;
 129 }
 130
 131
 132 bool Row::Element::breakAt(int w, bool force)
 133 {
 134         if (type != STRING || dim.wid <= w)
 135                 return false;
 136
 137         FontMetrics const & fm = theFontMetrics(font);
 138         int x = w;
 139         if(fm.breakAt(str, x, isRTL(), force)) {
 140                 dim.wid = x;
 141                 endpos = pos + str.length();
 142                 //lyxerr << "breakAt(" << w << ")  Row element Broken at " << x << "(w(str)=" << fm.width(str) << "): e=" << *this << endl;
 143                 return true;
 144         }
 145
 146         return false;
 147 }
 148
 149
 150 pos_type Row::Element::left_pos() const
 151 {
 152         return isRTL() ? endpos : pos;
 153 }
 154
 155
 156 pos_type Row::Element::right_pos() const
 157 {
 158         return isRTL() ? pos : endpos;
 159 }
 160
 161
 162 Row::Row()
 163         : separator(0), label_hfill(0), left_margin(0), right_margin(0),
 164           sel_beg(-1), sel_end(-1),
 165           begin_margin_sel(false), end_margin_sel(false),
 166           changed_(false), crc_(0),
 167           pit_(0), pos_(0), end_(0),
 168           right_boundary_(false), flushed_(false), rtl_(false)
 169 {}
 170
 171
 172 void Row::setCrc(size_type crc) const
 173 {
 174         changed_ = crc != crc_;
 175         crc_ = crc;
 176 }
 177
 178
 179 bool Row::isMarginSelected(bool left_margin, DocIterator const & beg,
 180                 DocIterator const & end) const
 181 {
 182         pos_type const sel_pos = left_margin ? sel_beg : sel_end;
 183         pos_type const margin_pos = left_margin ? pos_ : end_;
 184
 185         // Is the chosen margin selected ?
 186         if (sel_pos == margin_pos) {
 187                 if (beg.pos() == end.pos())
 188                         // This is a special case in which the space between after
 189                         // pos i-1 and before pos i is selected, i.e. the margins
 190                         // (see DocIterator::boundary_).
 191                         return beg.boundary() && !end.boundary();
 192                 else if (end.pos() == margin_pos)
 193                         // If the selection ends around the margin, it is only
 194                         // drawn if the cursor is after the margin.
 195                         return !end.boundary();
 196                 else if (beg.pos() == margin_pos)
 197                         // If the selection begins around the margin, it is
 198                         // only drawn if the cursor is before the margin.
 199                         return beg.boundary();
 200                 else
 201                         return true;
 202         }
 203         return false;
 204 }
 205
 206
 207 void Row::setSelectionAndMargins(DocIterator const & beg,
 208                 DocIterator const & end) const
 209 {
 210         setSelection(beg.pos(), end.pos());
 211
 212         if (selection()) {
 213                 end_margin_sel = isMarginSelected(false, beg, end);
 214                 begin_margin_sel = isMarginSelected(true, beg, end);
 215         }
 216 }
 217
 218
 219 void Row::setSelection(pos_type beg, pos_type end) const
 220 {
 221         if (pos_ >= beg && pos_ <= end)
 222                 sel_beg = pos_;
 223         else if (beg > pos_ && beg <= end_)
 224                 sel_beg = beg;
 225         else
 226                 sel_beg = -1;
 227
 228         if (end_ >= beg && end_ <= end)
 229                 sel_end = end_;
 230         else if (end < end_ && end >= pos_)
 231                 sel_end = end;
 232         else
 233                 sel_end = -1;
 234 }
 235
 236
 237 bool Row::selection() const
 238 {
 239         return sel_beg != -1 && sel_end != -1;
 240 }
 241
 242
 243 ostream & operator<<(ostream & os, Row::Element const & e)
 244 {
 245         if (e.isRTL())
 246                 os << e.endpos << "<<" << e.pos << " ";
 247         else
 248                 os << e.pos << ">>" << e.endpos << " ";
 249
 250         switch (e.type) {
 251         case Row::STRING:
 252                 os << "STRING: `" << to_utf8(e.str) << "' ("
 253                    << e.countExpanders() << " expanders.), ";
 254                 break;
 255         case Row::VIRTUAL:
 256                 os << "VIRTUAL: `" << to_utf8(e.str) << "', ";
 257                 break;
 258         case Row::INSET:
 259                 os << "INSET: " << to_utf8(e.inset->layoutName()) << ", ";
 260                 break;
 261         case Row::SPACE:
 262                 os << "SPACE: ";
 263                 break;
 264         }
 265         os << "width=" << e.full_width();
 266         return os;
 267 }
 268
 269
 270 ostream & operator<<(ostream & os, Row const & row)
 271 {
 272         os << " pos: " << row.pos_ << " end: " << row.end_
 273            << " left_margin: " << row.left_margin
 274            << " width: " << row.dim_.wid
 275            << " right_margin: " << row.right_margin
 276            << " ascent: " << row.dim_.asc
 277            << " descent: " << row.dim_.des
 278            << " separator: " << row.separator
 279            << " label_hfill: " << row.label_hfill
 280            << " row_boundary: " << row.right_boundary() << "\n";
 281         double x = row.left_margin;
 282         Row::Elements::const_iterator it = row.elements_.begin();
 283         for ( ; it != row.elements_.end() ; ++it) {
 284                 os << "x=" << x << " => " << *it << endl;
 285                 x += it->full_width();
 286         }
 287         return os;
 288 }
 289
 290
 291 int Row::left_x() const
 292 {
 293         double x = left_margin;
 294         const_iterator const end = elements_.end();
 295         const_iterator cit = elements_.begin();
 296         while (cit != end && cit->isVirtual()) {
 297                 x += cit->full_width();
 298                 ++cit;
 299         }
 300         return int(x + 0.5);
 301 }
 302
 303
 304 int Row::right_x() const
 305 {
 306         double x = dim_.wid;
 307         const_iterator const begin = elements_.begin();
 308         const_iterator cit = elements_.end();
 309         while (cit != begin) {
 310                 --cit;
 311                 if (cit->isVirtual())
 312                         x -= cit->full_width();
 313                 else
 314                         break;
 315         }
 316         return int(x + 0.5);
 317 }
 318
 319
 320 int Row::countSeparators() const
 321 {
 322         int n = 0;
 323         const_iterator const end = elements_.end();
 324         for (const_iterator cit = elements_.begin() ; cit != end ; ++cit)
 325                 n += cit->countSeparators();
 326         return n;
 327 }
 328
 329
 330 bool Row::setExtraWidth(int w)
 331 {
 332         if (w < 0)
 333                 // this is not expected to happen (but it does)
 334                 return false;
 335         // amount of expansion: number of expanders time the em value for each
 336         // string element
 337         int exp_amount = 0;
 338         for (Row::Element const & e : elements_)
 339                 exp_amount += e.expansionAmount();
 340         if (!exp_amount)
 341                 return false;
 342         // extra length per expander per em
 343         double extra_per_em = double(w) / exp_amount;
 344         if (extra_per_em > MAX_SPACE_STRETCH)
 345                 // do not stretch more than MAX_SPACE_STRETCH em per expander
 346                 return false;
 347         // add extra length to each element proportionally to its em.
 348         for (Row::Element & e : elements_)
 349                 if (e.type == Row::STRING)
 350                         e.setExtra(extra_per_em);
 351         // update row dimension
 352         dim_.wid += w;
 353         return true;
 354 }
 355
 356
 357 bool Row::sameString(Font const & f, Change const & ch) const
 358 {
 359         if (elements_.empty())
 360                 return false;
 361         Element const & elt = elements_.back();
 362         return elt.type == STRING && !elt.final
 363                    && elt.font == f && elt.change == ch;
 364 }
 365
 366
 367 void Row::finalizeLast()
 368 {
 369         if (elements_.empty())
 370                 return;
 371         Element & elt = elements_.back();
 372         if (elt.final)
 373                 return;
 374         elt.final = true;
 375
 376         if (elt.type == STRING) {
 377                 dim_.wid -= elt.dim.wid;
 378                 elt.dim.wid = theFontMetrics(elt.font).width(elt.str);
 379                 dim_.wid += elt.dim.wid;
 380         }
 381 }
 382
 383
 384 void Row::add(pos_type const pos, Inset const * ins, Dimension const & dim,
 385               Font const & f, Change const & ch)
 386 {
 387         finalizeLast();
 388         Element e(INSET, pos, f, ch);
 389         e.inset = ins;
 390         e.dim = dim;
 391         elements_.push_back(e);
 392         dim_.wid += dim.wid;
 393 }
 394
 395
 396 void Row::add(pos_type const pos, char_type const c,
 397               Font const & f, Change const & ch)
 398 {
 399         if (!sameString(f, ch)) {
 400                 finalizeLast();
 401                 Element e(STRING, pos, f, ch);
 402                 elements_.push_back(e);
 403         }
 404         if (back().str.length() % 30 == 0) {
 405                 dim_.wid -= back().dim.wid;
 406                 back().str += c;
 407                 back().endpos = pos + 1;
 408                 back().dim.wid = theFontMetrics(back().font).width(back().str);
 409                 dim_.wid += back().dim.wid;
 410         } else {
 411                 back().str += c;
 412                 back().endpos = pos + 1;
 413         }
 414 }
 415
 416
 417 void Row::addVirtual(pos_type const pos, docstring const & s,
 418                      Font const & f, Change const & ch)
 419 {
 420         finalizeLast();
 421         Element e(VIRTUAL, pos, f, ch);
 422         e.str = s;
 423         e.dim.wid = theFontMetrics(f).width(s);
 424         dim_.wid += e.dim.wid;
 425         e.endpos = pos;
 426         elements_.push_back(e);
 427         finalizeLast();
 428 }
 429
 430
 431 void Row::addSpace(pos_type const pos, int const width,
 432                    Font const & f, Change const & ch)
 433 {
 434         finalizeLast();
 435         Element e(SPACE, pos, f, ch);
 436         e.dim.wid = width;
 437         elements_.push_back(e);
 438         dim_.wid += e.dim.wid;
 439 }
 440
 441
 442 void Row::pop_back()
 443 {
 444         dim_.wid -= elements_.back().dim.wid;
 445         elements_.pop_back();
 446 }
 447
 448
 449 bool Row::shortenIfNeeded(pos_type const keep, int const w, int const next_width)
 450 {
 451         if (empty() || width() <= w)
 452                 return false;
 453
 454         Elements::iterator const beg = elements_.begin();
 455         Elements::iterator const end = elements_.end();
 456         int wid = left_margin;
 457
 458         // Search for the first element that goes beyond right margin
 459         Elements::iterator cit = beg;
 460         for ( ; cit != end ; ++cit) {
 461                 if (wid + cit->dim.wid > w)
 462                         break;
 463                 wid += cit->dim.wid;
 464         }
 465
 466         if (cit == end) {
 467                 // This should not happen since the row is too long.
 468                 LYXERR0("Something is wrong cannot shorten row: " << *this);
 469                 return false;
 470         }
 471
 472         // Iterate backwards over breakable elements and try to break them
 473         Elements::iterator cit_brk = cit;
 474         int wid_brk = wid + cit_brk->dim.wid;
 475         ++cit_brk;
 476         while (cit_brk != beg) {
 477                 --cit_brk;
 478                 // make a copy of the element to work on it.
 479                 Element brk = *cit_brk;
 480                 wid_brk -= brk.dim.wid;
 481                 if (brk.countSeparators() == 0 || brk.pos < keep)
 482                         continue;
 483                 /* We have found a suitable separable element. This is the common case.
 484                  * Try to break it cleanly (at word boundary) at a length that is both
 485                  * - less than the available space on the row
 486                  * - shorter than the natural width of the element, in order to enforce
 487                  *   break-up.
 488                  */
 489                 if (brk.breakAt(min(w - wid_brk, brk.dim.wid - 2), false)) {
 490                         /* if this element originally did not cause a row overflow
 491                          * in itself, and the remainder of the row would still be
 492                          * too large after breaking, then we will have issues in
 493                          * next row. Thus breaking does not help.
 494                          */
 495                         if (wid_brk + cit_brk->dim.wid < w
 496                             && dim_.wid - (wid_brk + brk.dim.wid) >= next_width) {
 497                                 break;
 498                         }
 499                         end_ = brk.endpos;
 500                         /* after breakAt, there may be spaces at the end of the
 501                          * string, but they are not counted in the string length
 502                          * (QTextLayout feature, actually). We remove them, but do
 503                          * not change the end of the row, since spaces at row
 504                          * break are invisible.
 505                          */
 506                         brk.str = rtrim(brk.str);
 507                         brk.endpos = brk.pos + brk.str.length();
 508                         *cit_brk = brk;
 509                         dim_.wid = wid_brk + brk.dim.wid;
 510                         // If there are other elements, they should be removed.
 511                         elements_.erase(cit_brk + 1, end);
 512                         return true;
 513                 }
 514         }
 515
 516         if (cit != beg && cit->type == VIRTUAL) {
 517                 // It is not possible to separate a virtual element from the
 518                 // previous one.
 519                 --cit;
 520                 wid -= cit->dim.wid;
 521         }
 522
 523         if (cit != beg) {
 524                 // There is no usable separator, but several elements have
 525                 // been added. We can cut right here.
 526                 end_ = cit->pos;
 527                 dim_.wid = wid;
 528                 elements_.erase(cit, end);
 529                 return true;
 530         }
 531
 532         /* If we are here, it means that we have not found a separator to
 533          * shorten the row. Let's try to break it again, but not at word
 534          * boundary this time.
 535          */
 536         if (cit->breakAt(w - wid, true)) {
 537                 end_ = cit->endpos;
 538                 // See comment above.
 539                 cit->str = rtrim(cit->str);
 540                 cit->endpos = cit->pos + cit->str.length();
 541                 dim_.wid = wid + cit->dim.wid;
 542                 // If there are other elements, they should be removed.
 543                 elements_.erase(next(cit, 1), end);
 544                 return true;
 545         }
 546         return false;
 547 }
 548
 549
 550 void Row::reverseRTL(bool const rtl_par)
 551 {
 552         pos_type i = 0;
 553         pos_type const end = elements_.size();
 554         while (i < end) {
 555                 // gather a sequence of elements with the same direction
 556                 bool const rtl = elements_[i].isRTL();
 557                 pos_type j = i;
 558                 while (j < end && elements_[j].isRTL() == rtl)
 559                         ++j;
 560                 // if the direction is not the same as the paragraph
 561                 // direction, the sequence has to be reverted.
 562                 if (rtl != rtl_par)
 563                         reverse(elements_.begin() + i, elements_.begin() + j);
 564                 i = j;
 565         }
 566         // If the paragraph itself is RTL, reverse everything
 567         if (rtl_par)
 568                 reverse(elements_.begin(), elements_.end());
 569         rtl_ = rtl_par;
 570 }
 571
 572 } // namespace lyx