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         return static_cast<int>(tl.lineForTextPosition(pos).cursorToX(pos));
 210 }
 211
 212
 213 int GuiFontMetrics::x2pos(docstring const & s, int & x, bool const rtl,
 214                           double const wordspacing) const
 215 {
 216         QTextLayout const & tl = getTextLayout(s, font_, rtl, wordspacing);
 217         int pos = tl.lineForTextPosition(0).xToCursor(x);
 218         // correct x value to the actual cursor position.
 219         x = static_cast<int>(tl.lineForTextPosition(0).cursorToX(pos));
 220         return pos;
 221 }
 222
 223
 224 bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const force) const
 225 {
 226         if (s.empty())
 227                 return false;
 228         QTextLayout tl;
 229         /* Qt will not break at a leading or trailing space, and we need
 230          * that sometimes, see http://www.lyx.org/trac/ticket/9921.
 231          *
 232          * To work around the problem, we enclose the string between
 233          * zero-width characters so that the QTextLayout algorithm will
 234          * agree to break the text at these extremal spaces.
 235         */
 236         // Unicode character ZERO WIDTH NO-BREAK SPACE
 237         QChar const zerow_nbsp(0xfeff);
 238         QString str = zerow_nbsp + toqstr(s) + zerow_nbsp;
 239 #if 1
 240         /* Use unicode override characters to enforce drawing direction
 241          * Source: http://www.iamcal.com/understanding-bidirectional-text/
 242          */
 243         if (rtl)
 244                 // Right-to-left override: forces to draw text right-to-left
 245                 str = QChar(0x202E) + str;
 246         else
 247                 // Left-to-right override: forces to draw text left-to-right
 248                 str =  QChar(0x202D) + str;
 249         int const offset = 2;
 250 #else
 251         // Alternative version that breaks with Qt5 and arabic text (#10436)
 252         // Note that both setFlags and the enums are undocumented
 253         tl.setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
 254         int const offset = 1;
 255 #endif
 256
 257         tl.setText(str);
 258         tl.setFont(font_);
 259         QTextOption to;
 260         to.setWrapMode(force ? QTextOption::WrapAnywhere : QTextOption::WordWrap);
 261         tl.setTextOption(to);
 262         tl.beginLayout();
 263         QTextLine line = tl.createLine();
 264         line.setLineWidth(x);
 265         tl.createLine();
 266         tl.endLayout();
 267         if ((force && line.textLength() == offset) || int(line.naturalTextWidth()) > x)
 268                 return false;
 269         x = int(line.naturalTextWidth());
 270         // The offset is here to account for the extra leading characters.
 271         s = s.substr(0, line.textLength() - offset);
 272         return true;
 273 }
 274
 275
 276 void GuiFontMetrics::rectText(docstring const & str,
 277         int & w, int & ascent, int & descent) const
 278 {
 279         static int const d = Inset::TEXT_TO_INSET_OFFSET / 2;
 280
 281         w = width(str) + Inset::TEXT_TO_INSET_OFFSET;
 282         ascent = metrics_.ascent() + d;
 283         descent = metrics_.descent() + d;
 284 }
 285
 286
 287
 288 void GuiFontMetrics::buttonText(docstring const & str,
 289         int & w, int & ascent, int & descent) const
 290 {
 291         rectText(str, w, ascent, descent);
 292         w += Inset::TEXT_TO_INSET_OFFSET;
 293 }
 294
 295
 296 Dimension const GuiFontMetrics::defaultDimension() const
 297 {
 298         return Dimension(0, maxAscent(), maxDescent());
 299 }
 300
 301
 302 Dimension const GuiFontMetrics::dimension(char_type c) const
 303 {
 304         return Dimension(width(c), ascent(c), descent(c));
 305 }
 306
 307
 308 GuiFontMetrics::AscendDescend const GuiFontMetrics::fillMetricsCache(
 309                 char_type c) const
 310 {
 311         QRect r;
 312         if (is_utf16(c))
 313                 r = metrics_.boundingRect(ucs4_to_qchar(c));
 314         else
 315                 r = metrics_.boundingRect(toqstr(docstring(1, c)));
 316
 317         AscendDescend ad = { -r.top(), r.bottom() + 1};
 318         // We could as well compute the width but this is not really
 319         // needed for now as it is done directly in width() below.
 320         metrics_cache_.insert(c, ad);
 321
 322         return ad;
 323 }
 324
 325
 326 int GuiFontMetrics::width(char_type c) const
 327 {
 328         int value = width_cache_.value(c, outOfLimitMetric);
 329         if (value != outOfLimitMetric)
 330                 return value;
 331
 332         if (is_utf16(c))
 333                 value = metrics_.width(ucs4_to_qchar(c));
 334         else
 335                 value = metrics_.width(toqstr(docstring(1, c)));
 336
 337         width_cache_.insert(c, value);
 338
 339         return value;
 340 }
 341
 342
 343 int GuiFontMetrics::ascent(char_type c) const
 344 {
 345         static AscendDescend const outOfLimitAD =
 346                 {outOfLimitMetric, outOfLimitMetric};
 347         AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
 348         if (value.ascent != outOfLimitMetric)
 349                 return value.ascent;
 350
 351         value = fillMetricsCache(c);
 352         return value.ascent;
 353 }
 354
 355
 356 int GuiFontMetrics::descent(char_type c) const
 357 {
 358         static AscendDescend const outOfLimitAD =
 359                 {outOfLimitMetric, outOfLimitMetric};
 360         AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
 361         if (value.descent != outOfLimitMetric)
 362                 return value.descent;
 363
 364         value = fillMetricsCache(c);
 365         return value.descent;
 366 }
 367
 368 } // namespace frontend
 369 } // namespace lyx