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/lassert.h"
  25
  26 using namespace std;
  27 using namespace lyx::support;
  28
  29 namespace lyx {
  30 namespace frontend {
  31
  32 namespace {
  33 /**
  34  * Convert a UCS4 character into a QChar.
  35  * This is a hack (it does only make sense for the common part of the UCS4
  36  * and UTF16 encodings) and should not be used.
  37  * This does only exist because of performance reasons (a real conversion
  38  * using iconv is too slow on windows).
  39  *
  40  * This is no real conversion but a simple cast in reality. This is the reason
  41  * why this works well for symbol fonts used in mathed too, even though
  42  * these are not real ucs4 characters. These are codepoints in the
  43  * computer modern fonts used, nothing unicode related.
  44  * See comment in GuiPainter::text() for more explanation.
  45  **/
  46 inline QChar const ucs4_to_qchar(char_type const ucs4)
  47 {
  48         LATTEST(is_utf16(ucs4));
  49         return QChar(static_cast<unsigned short>(ucs4));
  50 }
  51 } // anon namespace
  52
  53
  54 // Limit strwidth_cache_ size to 512kB of string data
  55 GuiFontMetrics::GuiFontMetrics(QFont const & font)
  56         : font_(font), metrics_(font, 0),
  57           strwidth_cache_(1 << 19),
  58           tl_cache_rtl_(false), tl_cache_wordspacing_(-1.0)
  59 {
  60 }
  61
  62
  63 int GuiFontMetrics::maxAscent() const
  64 {
  65         return metrics_.ascent();
  66 }
  67
  68
  69 int GuiFontMetrics::maxDescent() const
  70 {
  71         // We add 1 as the value returned by QT is different than X
  72         // See http://doc.trolltech.com/2.3/qfontmetrics.html#200b74
  73         return metrics_.descent() + 1;
  74 }
  75
  76
  77 int GuiFontMetrics::em() const
  78 {
  79         return QFontInfo(font_).pixelSize();
  80 }
  81
  82
  83 int GuiFontMetrics::lineWidth() const
  84 {
  85         return metrics_.lineWidth();
  86 }
  87
  88
  89 int GuiFontMetrics::underlinePos() const
  90 {
  91         return metrics_.underlinePos();
  92 }
  93
  94
  95 int GuiFontMetrics::strikeoutPos() const
  96 {
  97         return metrics_.strikeOutPos();
  98 }
  99
 100
 101 int GuiFontMetrics::lbearing(char_type c) const
 102 {
 103         if (!is_utf16(c))
 104                 // FIXME: QFontMetrics::leftBearing does not support the
 105                 //        full unicode range. Once it does, we could use:
 106                 //return metrics_.leftBearing(toqstr(docstring(1, c)));
 107                 return 0;
 108
 109         return metrics_.leftBearing(ucs4_to_qchar(c));
 110 }
 111
 112
 113 namespace {
 114 int const outOfLimitMetric = -10000;
 115 }
 116
 117
 118 int GuiFontMetrics::rbearing(char_type c) const
 119 {
 120         int value = rbearing_cache_.value(c, outOfLimitMetric);
 121         if (value != outOfLimitMetric)
 122                 return value;
 123
 124         // Qt rbearing is from the right edge of the char's width().
 125         if (is_utf16(c)) {
 126                 QChar sc = ucs4_to_qchar(c);
 127                 value = width(c) - metrics_.rightBearing(sc);
 128         } else {
 129                 // FIXME: QFontMetrics::leftBearing does not support the
 130                 //        full unicode range. Once it does, we could use:
 131                 // metrics_.rightBearing(toqstr(docstring(1, c)));
 132                 value = width(c);
 133         }
 134
 135         rbearing_cache_.insert(c, value);
 136
 137         return value;
 138 }
 139
 140
 141 int GuiFontMetrics::width(docstring const & s) const
 142 {
 143         QByteArray qba =
 144                 QByteArray(reinterpret_cast<char const *>(s.data()),
 145                            s.size() * sizeof(docstring::value_type));
 146         int * pw = strwidth_cache_[qba];
 147         if (pw)
 148                 return *pw;
 149         // For some reason QMetrics::width returns a wrong value with Qt5
 150         // int w = metrics_.width(toqstr(s));
 151         QTextLayout tl;
 152         tl.setText(toqstr(s));
 153         tl.setFont(font_);
 154         tl.beginLayout();
 155         QTextLine line = tl.createLine();
 156         tl.endLayout();
 157         int w = int(line.naturalTextWidth());
 158
 159         strwidth_cache_.insert(qba, new int(w), qba.size());
 160         return w;
 161 }
 162
 163
 164 int GuiFontMetrics::width(QString const & ucs2) const
 165 {
 166         return width(qstring_to_ucs4(ucs2));
 167 }
 168
 169
 170 int GuiFontMetrics::signedWidth(docstring const & s) const
 171 {
 172         if (s.empty())
 173                 return 0;
 174
 175         if (s[0] == '-')
 176                 return -width(s.substr(1, s.size() - 1));
 177         else
 178                 return width(s);
 179 }
 180
 181
 182 QTextLayout const &
 183 GuiFontMetrics::getTextLayout(docstring const & s, QFont font,
 184                               bool const rtl, double const wordspacing) const
 185 {
 186         if (s != tl_cache_s_ || font != tl_cache_font_ || rtl != tl_cache_rtl_
 187             || wordspacing != tl_cache_wordspacing_) {
 188                 tl_cache_.setText(toqstr(s));
 189                 font.setWordSpacing(wordspacing);
 190                 tl_cache_.setFont(font);
 191                 // Note that both setFlags and the enums are undocumented
 192                 tl_cache_.setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
 193                 tl_cache_.beginLayout();
 194                 tl_cache_.createLine();
 195                 tl_cache_.endLayout();
 196                 tl_cache_s_ = s;
 197                 tl_cache_font_ = font;
 198                 tl_cache_rtl_ = rtl;
 199                 tl_cache_wordspacing_ = wordspacing;
 200         }
 201         return tl_cache_;
 202 }
 203
 204
 205 int GuiFontMetrics::pos2x(docstring const & s, int const pos, bool const rtl,
 206                           double const wordspacing) const
 207 {
 208         QTextLayout const & tl = getTextLayout(s, font_, rtl, wordspacing);
 209         /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
 210          * not be the same when there are high-plan unicode characters
 211          * (bug #10443).
 212          */
 213         int const qpos = toqstr(s.substr(0, pos)).length();
 214         return static_cast<int>(tl.lineForTextPosition(qpos).cursorToX(qpos));
 215 }
 216
 217
 218 int GuiFontMetrics::x2pos(docstring const & s, int & x, bool const rtl,
 219                           double const wordspacing) const
 220 {
 221         QTextLayout const & tl = getTextLayout(s, font_, rtl, wordspacing);
 222         int const qpos = tl.lineForTextPosition(0).xToCursor(x);
 223         // correct x value to the actual cursor position.
 224         x = static_cast<int>(tl.lineForTextPosition(0).cursorToX(qpos));
 225         /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
 226          * not be the same when there are high-plan unicode characters
 227          * (bug #10443).
 228          */
 229 #if QT_VERSION < 0x040801 || QT_VERSION >= 0x050100
 230         return qstring_to_ucs4(tl.text().left(qpos)).length();
 231 #else
 232         /* Due to QTBUG-25536 in 4.8.1 <= Qt < 5.1.0, the string returned
 233          * by QString::toUcs4 (used by qstring_to_ucs4)may have wrong
 234          * length. We work around the problem by trying all docstring
 235          * positions until the right one is found. This is slow only if
 236          * there are many high-plane Unicode characters. It might be
 237          * worthwhile to implement a dichotomy search if this shows up
 238          * under a profiler.
 239          */
 240         int pos = min(qpos, static_cast<int>(s.length()));
 241         while (pos >= 0 && toqstr(s.substr(0, pos)).length() != qpos)
 242                 --pos;
 243         LASSERT(pos > 0 || qpos == 0, /**/);
 244         return pos;
 245 #endif
 246 }
 247
 248
 249 int GuiFontMetrics::countExpanders(docstring const & str) const
 250 {
 251         // Numbers of characters that are expanded by inter-word spacing.  These
 252         // characters are spaces, except for characters 09-0D which are treated
 253         // specially.  (From a combination of testing with the notepad found in qt's
 254         // examples, and reading the source code.)  In addition, consecutive spaces
 255         // only count as one expander.
 256         bool wasspace = false;
 257         int nexp = 0;
 258         for (char_type c : str)
 259                 if (c > 0x0d && QChar(c).isSpace()) {
 260                         if (!wasspace) {
 261                                 ++nexp;
 262                                 wasspace = true;
 263                         }
 264                 } else
 265                         wasspace = false;
 266         return nexp;
 267 }
 268
 269
 270 bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const force) const
 271 {
 272         if (s.empty())
 273                 return false;
 274         QTextLayout tl;
 275         /* Qt will not break at a leading or trailing space, and we need
 276          * that sometimes, see http://www.lyx.org/trac/ticket/9921.
 277          *
 278          * To work around the problem, we enclose the string between
 279          * zero-width characters so that the QTextLayout algorithm will
 280          * agree to break the text at these extremal spaces.
 281         */
 282         // Unicode character ZERO WIDTH NO-BREAK SPACE
 283         QChar const zerow_nbsp(0xfeff);
 284         QString qs = zerow_nbsp + toqstr(s) + zerow_nbsp;
 285 #if 1
 286         /* Use unicode override characters to enforce drawing direction
 287          * Source: http://www.iamcal.com/understanding-bidirectional-text/
 288          */
 289         if (rtl)
 290                 // Right-to-left override: forces to draw text right-to-left
 291                 qs = QChar(0x202E) + qs;
 292         else
 293                 // Left-to-right override: forces to draw text left-to-right
 294                 qs =  QChar(0x202D) + qs;
 295         int const offset = 2;
 296 #else
 297         // Alternative version that breaks with Qt5 and arabic text (#10436)
 298         // Note that both setFlags and the enums are undocumented
 299         tl.setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
 300         int const offset = 1;
 301 #endif
 302
 303         tl.setText(qs);
 304         tl.setFont(font_);
 305         QTextOption to;
 306         to.setWrapMode(force ? QTextOption::WrapAtWordBoundaryOrAnywhere
 307                              : QTextOption::WordWrap);
 308         tl.setTextOption(to);
 309         tl.beginLayout();
 310         QTextLine line = tl.createLine();
 311         line.setLineWidth(x);
 312         tl.createLine();
 313         tl.endLayout();
 314         if ((force && line.textLength() == offset) || int(line.naturalTextWidth()) > x)
 315                 return false;
 316         x = int(line.naturalTextWidth());
 317         /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
 318          * not be the same when there are high-plan unicode characters
 319          * (bug #10443).
 320          */
 321         // The variable `offset' is here to account for the extra leading characters.
 322         // The ending character zerow_nbsp has to be ignored if the line is complete.
 323         int const qlen = line.textLength() - offset - (line.textLength() == qs.length());
 324 #if QT_VERSION < 0x040801 || QT_VERSION >= 0x050100
 325         s = qstring_to_ucs4(qs.mid(offset, qlen));
 326 #else
 327         /* Due to QTBUG-25536 in 4.8.1 <= Qt < 5.1.0, the string returned
 328          * by QString::toUcs4 (used by qstring_to_ucs4)may have wrong
 329          * length. We work around the problem by trying all docstring
 330          * positions until the right one is found. This is slow only if
 331          * there are many high-plane Unicode characters. It might be
 332          * worthwhile to implement a dichotomy search if this shows up
 333          * under a profiler.
 334          */
 335         int len = min(qlen, static_cast<int>(s.length()));
 336         while (len >= 0 && toqstr(s.substr(0, len)).length() != qlen)
 337                 --len;
 338         LASSERT(len > 0 || qlen == 0, /**/);
 339         s = s.substr(0, len);
 340 #endif
 341         return true;
 342 }
 343
 344
 345 void GuiFontMetrics::rectText(docstring const & str,
 346         int & w, int & ascent, int & descent) const
 347 {
 348         static int const d = Inset::TEXT_TO_INSET_OFFSET / 2;
 349
 350         w = width(str) + Inset::TEXT_TO_INSET_OFFSET;
 351         ascent = metrics_.ascent() + d;
 352         descent = metrics_.descent() + d;
 353 }
 354
 355
 356
 357 void GuiFontMetrics::buttonText(docstring const & str,
 358         int & w, int & ascent, int & descent) const
 359 {
 360         rectText(str, w, ascent, descent);
 361         w += Inset::TEXT_TO_INSET_OFFSET;
 362 }
 363
 364
 365 Dimension const GuiFontMetrics::defaultDimension() const
 366 {
 367         return Dimension(0, maxAscent(), maxDescent());
 368 }
 369
 370
 371 Dimension const GuiFontMetrics::dimension(char_type c) const
 372 {
 373         return Dimension(width(c), ascent(c), descent(c));
 374 }
 375
 376
 377 GuiFontMetrics::AscendDescend const GuiFontMetrics::fillMetricsCache(
 378                 char_type c) const
 379 {
 380         QRect r;
 381         if (is_utf16(c))
 382                 r = metrics_.boundingRect(ucs4_to_qchar(c));
 383         else
 384                 r = metrics_.boundingRect(toqstr(docstring(1, c)));
 385
 386         AscendDescend ad = { -r.top(), r.bottom() + 1};
 387         // We could as well compute the width but this is not really
 388         // needed for now as it is done directly in width() below.
 389         metrics_cache_.insert(c, ad);
 390
 391         return ad;
 392 }
 393
 394
 395 int GuiFontMetrics::width(char_type c) const
 396 {
 397         int value = width_cache_.value(c, outOfLimitMetric);
 398         if (value != outOfLimitMetric)
 399                 return value;
 400
 401         if (is_utf16(c))
 402                 value = metrics_.width(ucs4_to_qchar(c));
 403         else
 404                 value = metrics_.width(toqstr(docstring(1, c)));
 405
 406         width_cache_.insert(c, value);
 407
 408         return value;
 409 }
 410
 411
 412 int GuiFontMetrics::ascent(char_type c) const
 413 {
 414         static AscendDescend const outOfLimitAD =
 415                 {outOfLimitMetric, outOfLimitMetric};
 416         AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
 417         if (value.ascent != outOfLimitMetric)
 418                 return value.ascent;
 419
 420         value = fillMetricsCache(c);
 421         return value.ascent;
 422 }
 423
 424
 425 int GuiFontMetrics::descent(char_type c) const
 426 {
 427         static AscendDescend const outOfLimitAD =
 428                 {outOfLimitMetric, outOfLimitMetric};
 429         AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
 430         if (value.descent != outOfLimitMetric)
 431                 return value.descent;
 432
 433         value = fillMetricsCache(c);
 434         return value.descent;
 435 }
 436
 437 } // namespace frontend
 438 } // namespace lyx