src/frontends/qt4/GuiFontMetrics.cpp

   1 /**
   2  * \file GuiFontMetrics.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author unknown
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "GuiFontMetrics.h"
  15
  16 #include "qt_helpers.h"
  17
  18 #include "Dimension.h"
  19 #include "Language.h"
  20 #include "LyXRC.h"
  21
  22 #include "insets/Inset.h"
  23
  24 #include "support/convert.h"
  25 #include "support/lassert.h"
  26
  27 #define DISABLE_PMPROF
  28 #include "support/pmprof.h"
  29
  30 #include <QByteArray>
  31
  32 using namespace std;
  33 using namespace lyx::support;
  34
  35 namespace std {
  36
  37 /*
  38  * Argument-dependent lookup implies that this function shall be
  39  * declared in the namespace of its argument. But this is std
  40  * namespace, since lyx::docstring is just std::basic_string<wchar_t>.
  41  */
  42 uint qHash(lyx::docstring const & s)
  43 {
  44         return qHash(QByteArray(reinterpret_cast<char const *>(s.data()),
  45                                 s.size() * sizeof(lyx::docstring::value_type)));
  46 }
  47
  48 }
  49
  50 namespace lyx {
  51 namespace frontend {
  52
  53
  54 /*
  55  * Limit (strwidth|breakat)_cache_ size to 512kB of string data.
  56  * Limit qtextlayout_cache_ size to 500 elements (we do not know the
  57  * size of the QTextLayout objects anyway).
  58  * Note that all these numbers are arbitrary.
  59  * Also, setting size to 0 is tantamount to disabling the cache.
  60  */
  61 int cache_metrics_width_size = 1 << 19;
  62 int cache_metrics_breakat_size = 1 << 19;
  63 // Qt 5.x already has its own caching of QTextLayout objects
  64 #if (QT_VERSION < 0x050000)
  65 int cache_metrics_qtextlayout_size = 500;
  66 #else
  67 int cache_metrics_qtextlayout_size = 0;
  68 #endif
  69
  70
  71 namespace {
  72 /**
  73  * Convert a UCS4 character into a QChar.
  74  * This is a hack (it does only make sense for the common part of the UCS4
  75  * and UTF16 encodings) and should not be used.
  76  * This does only exist because of performance reasons (a real conversion
  77  * using iconv is too slow on windows).
  78  *
  79  * This is no real conversion but a simple cast in reality. This is the reason
  80  * why this works well for symbol fonts used in mathed too, even though
  81  * these are not real ucs4 characters. These are codepoints in the
  82  * computer modern fonts used, nothing unicode related.
  83  * See comment in GuiPainter::text() for more explanation.
  84  **/
  85 inline QChar const ucs4_to_qchar(char_type const ucs4)
  86 {
  87         LATTEST(is_utf16(ucs4));
  88         return QChar(static_cast<unsigned short>(ucs4));
  89 }
  90 } // anon namespace
  91
  92
  93 GuiFontMetrics::GuiFontMetrics(QFont const & font)
  94         : font_(font), metrics_(font, 0),
  95           strwidth_cache_(cache_metrics_width_size),
  96           breakat_cache_(cache_metrics_breakat_size),
  97           qtextlayout_cache_(cache_metrics_qtextlayout_size)
  98 {
  99 }
 100
 101
 102 int GuiFontMetrics::maxAscent() const
 103 {
 104         return metrics_.ascent();
 105 }
 106
 107
 108 int GuiFontMetrics::maxDescent() const
 109 {
 110         // We add 1 as the value returned by QT is different than X
 111         // See http://doc.trolltech.com/2.3/qfontmetrics.html#200b74
 112         return metrics_.descent() + 1;
 113 }
 114
 115
 116 int GuiFontMetrics::em() const
 117 {
 118         return QFontInfo(font_).pixelSize();
 119 }
 120
 121
 122 int GuiFontMetrics::lineWidth() const
 123 {
 124         return metrics_.lineWidth();
 125 }
 126
 127
 128 int GuiFontMetrics::underlinePos() const
 129 {
 130         return metrics_.underlinePos();
 131 }
 132
 133
 134 int GuiFontMetrics::strikeoutPos() const
 135 {
 136         return metrics_.strikeOutPos();
 137 }
 138
 139
 140 int GuiFontMetrics::lbearing(char_type c) const
 141 {
 142         if (!is_utf16(c))
 143                 // FIXME: QFontMetrics::leftBearing does not support the
 144                 //        full unicode range. Once it does, we could use:
 145                 //return metrics_.leftBearing(toqstr(docstring(1, c)));
 146                 return 0;
 147
 148         return metrics_.leftBearing(ucs4_to_qchar(c));
 149 }
 150
 151
 152 namespace {
 153 int const outOfLimitMetric = -10000;
 154 }
 155
 156
 157 int GuiFontMetrics::rbearing(char_type c) const
 158 {
 159         int value = rbearing_cache_.value(c, outOfLimitMetric);
 160         if (value != outOfLimitMetric)
 161                 return value;
 162
 163         // Qt rbearing is from the right edge of the char's width().
 164         if (is_utf16(c)) {
 165                 QChar sc = ucs4_to_qchar(c);
 166                 value = width(c) - metrics_.rightBearing(sc);
 167         } else {
 168                 // FIXME: QFontMetrics::leftBearing does not support the
 169                 //        full unicode range. Once it does, we could use:
 170                 // metrics_.rightBearing(toqstr(docstring(1, c)));
 171                 value = width(c);
 172         }
 173
 174         rbearing_cache_.insert(c, value);
 175
 176         return value;
 177 }
 178
 179
 180 int GuiFontMetrics::width(docstring const & s) const
 181 {
 182         PROFILE_THIS_BLOCK(width);
 183         if (strwidth_cache_.contains(s))
 184                 return strwidth_cache_[s];
 185         PROFILE_CACHE_MISS(width);
 186         /* For some reason QMetrics::width returns a wrong value with Qt5
 187          * with some arabic text. OTOH, QTextLayout is broken for single
 188          * characters with null width (like \not in mathed). Also, as a
 189          * safety measure, always use QMetrics::width with our math fonts.
 190         */
 191         int w = 0;
 192         if (s.length() == 1
 193 #if QT_VERSION >= 0x040800
 194             || font_.styleName() == "LyX"
 195 #endif
 196             )
 197                 w = metrics_.width(toqstr(s));
 198         else {
 199                 QTextLayout tl;
 200                 tl.setText(toqstr(s));
 201                 tl.setFont(font_);
 202                 tl.beginLayout();
 203                 QTextLine line = tl.createLine();
 204                 tl.endLayout();
 205                 w = int(line.naturalTextWidth());
 206         }
 207         strwidth_cache_.insert(s, w, s.size() * sizeof(char_type));
 208         return w;
 209 }
 210
 211
 212 int GuiFontMetrics::width(QString const & ucs2) const
 213 {
 214         return width(qstring_to_ucs4(ucs2));
 215 }
 216
 217
 218 int GuiFontMetrics::signedWidth(docstring const & s) const
 219 {
 220         if (s.empty())
 221                 return 0;
 222
 223         if (s[0] == '-')
 224                 return -width(s.substr(1, s.size() - 1));
 225         else
 226                 return width(s);
 227 }
 228
 229
 230 shared_ptr<QTextLayout const>
 231 GuiFontMetrics::getTextLayout(docstring const & s, bool const rtl,
 232                               double const wordspacing) const
 233 {
 234         PROFILE_THIS_BLOCK(getTextLayout);
 235         docstring const s_cache =
 236                 s + (rtl ? "r" : "l") + convert<docstring>(wordspacing);
 237         if (auto ptl = qtextlayout_cache_[s_cache])
 238                 return ptl;
 239         PROFILE_CACHE_MISS(getTextLayout);
 240         auto const ptl = make_shared<QTextLayout>();
 241         ptl->setCacheEnabled(true);
 242         ptl->setText(toqstr(s));
 243         QFont copy = font_;
 244         copy.setWordSpacing(wordspacing);
 245         ptl->setFont(copy);
 246         // Note that both setFlags and the enums are undocumented
 247         ptl->setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
 248         ptl->beginLayout();
 249         ptl->createLine();
 250         ptl->endLayout();
 251         qtextlayout_cache_.insert(s_cache, ptl);
 252         return ptl;
 253 }
 254
 255
 256 int GuiFontMetrics::pos2x(docstring const & s, int pos, bool const rtl,
 257                           double const wordspacing) const
 258 {
 259         if (pos <= 0)
 260                 pos = 0;
 261         shared_ptr<QTextLayout const> tl = getTextLayout(s, rtl, wordspacing);
 262         /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
 263          * not be the same when there are high-plan unicode characters
 264          * (bug #10443).
 265          */
 266         int const qpos = toqstr(s.substr(0, pos)).length();
 267         return static_cast<int>(tl->lineForTextPosition(qpos).cursorToX(qpos));
 268 }
 269
 270
 271 int GuiFontMetrics::x2pos(docstring const & s, int & x, bool const rtl,
 272                           double const wordspacing) const
 273 {
 274         shared_ptr<QTextLayout const> tl = getTextLayout(s, rtl, wordspacing);
 275         QTextLine const & tline = tl->lineForTextPosition(0);
 276         int qpos = tline.xToCursor(x);
 277         int newx = static_cast<int>(tline.cursorToX(qpos));
 278         // The value of qpos may be wrong in rtl text (see ticket #10569).
 279         // To work around this, let's have a look at adjacent positions to
 280         // see whether we find closer matches.
 281         if (rtl && newx < x) {
 282                 while (qpos > 0) {
 283                         int const xm = static_cast<int>(tline.cursorToX(qpos - 1));
 284                         if (abs(xm - x) < abs(newx - x)) {
 285                                 --qpos;
 286                                 newx = xm;
 287                         } else
 288                                 break;
 289                 }
 290         } else if (rtl && newx > x) {
 291                 while (qpos < tline.textLength()) {
 292                         int const xp = static_cast<int>(tline.cursorToX(qpos + 1));
 293                         if (abs(xp - x) < abs(newx - x)) {
 294                                 ++qpos;
 295                                 newx = xp;
 296                         } else
 297                                 break;
 298                 }
 299         }
 300         // correct x value to the actual cursor position.
 301         x = newx;
 302
 303         /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
 304          * not be the same when there are high-plan unicode characters
 305          * (bug #10443).
 306          */
 307 #if QT_VERSION < 0x040801 || QT_VERSION >= 0x050100
 308         return qstring_to_ucs4(tl->text().left(qpos)).length();
 309 #else
 310         /* Due to QTBUG-25536 in 4.8.1 <= Qt < 5.1.0, the string returned
 311          * by QString::toUcs4 (used by qstring_to_ucs4) may have wrong
 312          * length. We work around the problem by trying all docstring
 313          * positions until the right one is found. This is slow only if
 314          * there are many high-plane Unicode characters. It might be
 315          * worthwhile to implement a dichotomy search if this shows up
 316          * under a profiler.
 317          */
 318         int pos = min(qpos, static_cast<int>(s.length()));
 319         while (pos >= 0 && toqstr(s.substr(0, pos)).length() != qpos)
 320                 --pos;
 321         LASSERT(pos > 0 || qpos == 0, /**/);
 322         return pos;
 323 #endif
 324 }
 325
 326
 327 int GuiFontMetrics::countExpanders(docstring const & str) const
 328 {
 329         // Numbers of characters that are expanded by inter-word spacing.  These
 330         // characters are spaces, except for characters 09-0D which are treated
 331         // specially.  (From a combination of testing with the notepad found in qt's
 332         // examples, and reading the source code.)  In addition, consecutive spaces
 333         // only count as one expander.
 334         bool wasspace = false;
 335         int nexp = 0;
 336         for (char_type c : str)
 337                 if (c > 0x0d && QChar(c).isSpace()) {
 338                         if (!wasspace) {
 339                                 ++nexp;
 340                                 wasspace = true;
 341                         }
 342                 } else
 343                         wasspace = false;
 344         return nexp;
 345 }
 346
 347
 348 pair<int, int>
 349 GuiFontMetrics::breakAt_helper(docstring const & s, int const x,
 350                                bool const rtl, bool const force) const
 351 {
 352         QTextLayout tl;
 353         /* Qt will not break at a leading or trailing space, and we need
 354          * that sometimes, see http://www.lyx.org/trac/ticket/9921.
 355          *
 356          * To work around the problem, we enclose the string between
 357          * zero-width characters so that the QTextLayout algorithm will
 358          * agree to break the text at these extremal spaces.
 359          */
 360         // Unicode character ZERO WIDTH NO-BREAK SPACE
 361         QChar const zerow_nbsp(0xfeff);
 362         QString qs = zerow_nbsp + toqstr(s) + zerow_nbsp;
 363 #if 1
 364         /* Use unicode override characters to enforce drawing direction
 365          * Source: http://www.iamcal.com/understanding-bidirectional-text/
 366          */
 367         if (rtl)
 368                 // Right-to-left override: forces to draw text right-to-left
 369                 qs = QChar(0x202E) + qs;
 370         else
 371                 // Left-to-right override: forces to draw text left-to-right
 372                 qs =  QChar(0x202D) + qs;
 373         int const offset = 2;
 374 #else
 375         // Alternative version that breaks with Qt5 and arabic text (#10436)
 376         // Note that both setFlags and the enums are undocumented
 377         tl.setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
 378         int const offset = 1;
 379 #endif
 380
 381         tl.setText(qs);
 382         tl.setFont(font_);
 383         QTextOption to;
 384         to.setWrapMode(force ? QTextOption::WrapAtWordBoundaryOrAnywhere
 385                              : QTextOption::WordWrap);
 386         tl.setTextOption(to);
 387         tl.beginLayout();
 388         QTextLine line = tl.createLine();
 389         line.setLineWidth(x);
 390         tl.createLine();
 391         tl.endLayout();
 392         if ((force && line.textLength() == offset) || int(line.naturalTextWidth()) > x)
 393                 return {-1, -1};
 394         /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
 395          * not be the same when there are high-plan unicode characters
 396          * (bug #10443).
 397          */
 398         // The variable `offset' is here to account for the extra leading characters.
 399         // The ending character zerow_nbsp has to be ignored if the line is complete.
 400         int const qlen = line.textLength() - offset - (line.textLength() == qs.length());
 401 #if QT_VERSION < 0x040801 || QT_VERSION >= 0x050100
 402         int len = qstring_to_ucs4(qs.mid(offset, qlen)).length();
 403 #else
 404         /* Due to QTBUG-25536 in 4.8.1 <= Qt < 5.1.0, the string returned
 405          * by QString::toUcs4 (used by qstring_to_ucs4) may have wrong
 406          * length. We work around the problem by trying all docstring
 407          * positions until the right one is found. This is slow only if
 408          * there are many high-plane Unicode characters. It might be
 409          * worthwhile to implement a dichotomy search if this shows up
 410          * under a profiler.
 411          */
 412         int len = min(qlen, static_cast<int>(s.length()));
 413         while (len >= 0 && toqstr(s.substr(0, len)).length() != qlen)
 414                 --len;
 415         LASSERT(len > 0 || qlen == 0, /**/);
 416 #endif
 417         // The -1 is here to account for the leading zerow_nbsp.
 418         return {len, int(line.naturalTextWidth())};
 419 }
 420
 421
 422 bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const force) const
 423 {
 424         PROFILE_THIS_BLOCK(breakAt);
 425         if (s.empty())
 426                 return false;
 427
 428         docstring const s_cache =
 429                 s + convert<docstring>(x) + (rtl ? "r" : "l") + (force ? "f" : "w");
 430         pair<int, int> pp;
 431
 432         if (breakat_cache_.contains(s_cache))
 433                 pp = breakat_cache_[s_cache];
 434         else {
 435                 PROFILE_CACHE_MISS(breakAt);
 436                 pp = breakAt_helper(s, x, rtl, force);
 437                 breakat_cache_.insert(s_cache, pp, s_cache.size() * sizeof(char_type));
 438         }
 439         if (pp.first == -1)
 440                 return false;
 441         s = s.substr(0, pp.first);
 442         x = pp.second;
 443         return true;
 444 }
 445
 446
 447 void GuiFontMetrics::rectText(docstring const & str,
 448         int & w, int & ascent, int & descent) const
 449 {
 450         static int const d = Inset::TEXT_TO_INSET_OFFSET / 2;
 451
 452         w = width(str) + Inset::TEXT_TO_INSET_OFFSET;
 453         ascent = metrics_.ascent() + d;
 454         descent = metrics_.descent() + d;
 455 }
 456
 457
 458 void GuiFontMetrics::buttonText(docstring const & str,
 459         int & w, int & ascent, int & descent) const
 460 {
 461         rectText(str, w, ascent, descent);
 462         w += Inset::TEXT_TO_INSET_OFFSET;
 463 }
 464
 465
 466 Dimension const GuiFontMetrics::defaultDimension() const
 467 {
 468         return Dimension(0, maxAscent(), maxDescent());
 469 }
 470
 471
 472 Dimension const GuiFontMetrics::dimension(char_type c) const
 473 {
 474         return Dimension(width(c), ascent(c), descent(c));
 475 }
 476
 477
 478 GuiFontMetrics::AscendDescend const GuiFontMetrics::fillMetricsCache(
 479                 char_type c) const
 480 {
 481         QRect r;
 482         if (is_utf16(c))
 483                 r = metrics_.boundingRect(ucs4_to_qchar(c));
 484         else
 485                 r = metrics_.boundingRect(toqstr(docstring(1, c)));
 486
 487         AscendDescend ad = { -r.top(), r.bottom() + 1};
 488         // We could as well compute the width but this is not really
 489         // needed for now as it is done directly in width() below.
 490         metrics_cache_.insert(c, ad);
 491
 492         return ad;
 493 }
 494
 495
 496 int GuiFontMetrics::width(char_type c) const
 497 {
 498         int value = width_cache_.value(c, outOfLimitMetric);
 499         if (value != outOfLimitMetric)
 500                 return value;
 501
 502         if (is_utf16(c))
 503                 value = metrics_.width(ucs4_to_qchar(c));
 504         else
 505                 value = metrics_.width(toqstr(docstring(1, c)));
 506
 507         width_cache_.insert(c, value);
 508
 509         return value;
 510 }
 511
 512
 513 int GuiFontMetrics::ascent(char_type c) const
 514 {
 515         static AscendDescend const outOfLimitAD =
 516                 {outOfLimitMetric, outOfLimitMetric};
 517         AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
 518         if (value.ascent != outOfLimitMetric)
 519                 return value.ascent;
 520
 521         value = fillMetricsCache(c);
 522         return value.ascent;
 523 }
 524
 525
 526 int GuiFontMetrics::descent(char_type c) const
 527 {
 528         static AscendDescend const outOfLimitAD =
 529                 {outOfLimitMetric, outOfLimitMetric};
 530         AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
 531         if (value.descent != outOfLimitMetric)
 532                 return value.descent;
 533
 534         value = fillMetricsCache(c);
 535         return value.descent;
 536 }
 537
 538 } // namespace frontend
 539 } // namespace lyx