]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/GuiFontMetrics.cpp
Add missing initialization
[lyx.git] / src / frontends / qt4 / GuiFontMetrics.cpp
index 77cda8043409223c62a0b4dc39a24d57ec1025d6..33df3cf1267a68c5f7a3e51084e150d65b6abc9c 100644 (file)
 
 #include "insets/Inset.h"
 
+#include "support/convert.h"
 #include "support/lassert.h"
 
+#define DISABLE_PMPROF
+#include "support/pmprof.h"
+
+#include <QByteArray>
+
 using namespace std;
 using namespace lyx::support;
 
+namespace std {
+
+/*
+ * Argument-dependent lookup implies that this function shall be
+ * declared in the namespace of its argument. But this is std
+ * namespace, since lyx::docstring is just std::basic_string<wchar_t>.
+ */
+uint qHash(lyx::docstring const & s)
+{
+       return qHash(QByteArray(reinterpret_cast<char const *>(s.data()),
+                               s.size() * sizeof(lyx::docstring::value_type)));
+}
+
+}
+
 namespace lyx {
 namespace frontend {
 
+
+/*
+ * Limit (strwidth|breakat)_cache_ size to 512kB of string data.
+ * Limit qtextlayout_cache_ size to 500 elements (we do not know the
+ * size of the QTextLayout objects anyway).
+ * Note that all these numbers are arbitrary.
+ * Also, setting size to 0 is tantamount to disabling the cache.
+ */
+int cache_metrics_width_size = 1 << 19;
+int cache_metrics_breakat_size = 1 << 19;
+// Qt 5.x already has its own caching of QTextLayout objects
+#if (QT_VERSION < 0x050000)
+int cache_metrics_qtextlayout_size = 500;
+#else
+int cache_metrics_qtextlayout_size = 0;
+#endif
+
+
 namespace {
 /**
  * Convert a UCS4 character into a QChar.
@@ -51,11 +90,11 @@ inline QChar const ucs4_to_qchar(char_type const ucs4)
 } // anon namespace
 
 
-// Limit strwidth_cache_ size to 512kB of string data
 GuiFontMetrics::GuiFontMetrics(QFont const & font)
        : font_(font), metrics_(font, 0),
-         strwidth_cache_(1 << 19),
-         tl_cache_rtl_(false), tl_cache_wordspacing_(-1.0)
+         strwidth_cache_(cache_metrics_width_size),
+         breakat_cache_(cache_metrics_breakat_size),
+         qtextlayout_cache_(cache_metrics_qtextlayout_size)
 {
 }
 
@@ -140,23 +179,32 @@ int GuiFontMetrics::rbearing(char_type c) const
 
 int GuiFontMetrics::width(docstring const & s) const
 {
-       QByteArray qba =
-               QByteArray(reinterpret_cast<char const *>(s.data()),
-                          s.size() * sizeof(docstring::value_type));
-       int * pw = strwidth_cache_[qba];
-       if (pw)
-               return *pw;
-       // For some reason QMetrics::width returns a wrong value with Qt5
-       // int w = metrics_.width(toqstr(s));
-       QTextLayout tl;
-       tl.setText(toqstr(s));
-       tl.setFont(font_);
-       tl.beginLayout();
-       QTextLine line = tl.createLine();
-       tl.endLayout();
-       int w = int(line.naturalTextWidth());
-
-       strwidth_cache_.insert(qba, new int(w), qba.size());
+       PROFILE_THIS_BLOCK(width);
+       if (strwidth_cache_.contains(s))
+               return strwidth_cache_[s];
+       PROFILE_CACHE_MISS(width);
+       /* For some reason QMetrics::width returns a wrong value with Qt5
+        * with some arabic text. OTOH, QTextLayout is broken for single
+        * characters with null width (like \not in mathed). Also, as a
+        * safety measure, always use QMetrics::width with our math fonts.
+       */
+       int w = 0;
+       if (s.length() == 1
+#if QT_VERSION >= 0x040800
+           || font_.styleName() == "LyX"
+#endif
+           )
+               w = metrics_.width(toqstr(s));
+       else {
+               QTextLayout tl;
+               tl.setText(toqstr(s));
+               tl.setFont(font_);
+               tl.beginLayout();
+               QTextLine line = tl.createLine();
+               tl.endLayout();
+               w = int(line.naturalTextWidth());
+       }
+       strwidth_cache_.insert(s, w, s.size() * sizeof(char_type));
        return w;
 }
 
@@ -179,58 +227,63 @@ int GuiFontMetrics::signedWidth(docstring const & s) const
 }
 
 
-QTextLayout const &
-GuiFontMetrics::getTextLayout(docstring const & s, QFont font,
-                              bool const rtl, double const wordspacing) const
+shared_ptr<QTextLayout const>
+GuiFontMetrics::getTextLayout(docstring const & s, bool const rtl,
+                              double const wordspacing) const
 {
-       if (s != tl_cache_s_ || font != tl_cache_font_ || rtl != tl_cache_rtl_
-           || wordspacing != tl_cache_wordspacing_) {
-               tl_cache_.setText(toqstr(s));
-               font.setWordSpacing(wordspacing);
-               tl_cache_.setFont(font);
-               // Note that both setFlags and the enums are undocumented
-               tl_cache_.setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
-               tl_cache_.beginLayout();
-               tl_cache_.createLine();
-               tl_cache_.endLayout();
-               tl_cache_s_ = s;
-               tl_cache_font_ = font;
-               tl_cache_rtl_ = rtl;
-               tl_cache_wordspacing_ = wordspacing;
-       }
-       return tl_cache_;
+       PROFILE_THIS_BLOCK(getTextLayout);
+       docstring const s_cache =
+               s + (rtl ? "r" : "l") + convert<docstring>(wordspacing);
+       if (auto ptl = qtextlayout_cache_[s_cache])
+               return ptl;
+       PROFILE_CACHE_MISS(getTextLayout);
+       auto const ptl = make_shared<QTextLayout>();
+       ptl->setCacheEnabled(true);
+       ptl->setText(toqstr(s));
+       QFont copy = font_;
+       copy.setWordSpacing(wordspacing);
+       ptl->setFont(copy);
+       // Note that both setFlags and the enums are undocumented
+       ptl->setFlags(rtl ? Qt::TextForceRightToLeft : Qt::TextForceLeftToRight);
+       ptl->beginLayout();
+       ptl->createLine();
+       ptl->endLayout();
+       qtextlayout_cache_.insert(s_cache, ptl);
+       return ptl;
 }
 
 
-int GuiFontMetrics::pos2x(docstring const & s, int const pos, bool const rtl,
+int GuiFontMetrics::pos2x(docstring const & s, int pos, bool const rtl,
                           double const wordspacing) const
 {
-       QTextLayout const & tl = getTextLayout(s, font_, rtl, wordspacing);
+       if (pos <= 0)
+               pos = 0;
+       shared_ptr<QTextLayout const> tl = getTextLayout(s, rtl, wordspacing);
        /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
         * not be the same when there are high-plan unicode characters
         * (bug #10443).
         */
        int const qpos = toqstr(s.substr(0, pos)).length();
-       return static_cast<int>(tl.lineForTextPosition(qpos).cursorToX(qpos));
+       return static_cast<int>(tl->lineForTextPosition(qpos).cursorToX(qpos));
 }
 
 
 int GuiFontMetrics::x2pos(docstring const & s, int & x, bool const rtl,
                           double const wordspacing) const
 {
-       QTextLayout const & tl = getTextLayout(s, font_, rtl, wordspacing);
-       int const qpos = tl.lineForTextPosition(0).xToCursor(x);
+       shared_ptr<QTextLayout const> tl = getTextLayout(s, rtl, wordspacing);
+       int const qpos = tl->lineForTextPosition(0).xToCursor(x);
        // correct x value to the actual cursor position.
-       x = static_cast<int>(tl.lineForTextPosition(0).cursorToX(qpos));
+       x = static_cast<int>(tl->lineForTextPosition(0).cursorToX(qpos));
        /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
         * not be the same when there are high-plan unicode characters
         * (bug #10443).
         */
 #if QT_VERSION < 0x040801 || QT_VERSION >= 0x050100
-       return qstring_to_ucs4(tl.text().left(qpos)).length();
+       return qstring_to_ucs4(tl->text().left(qpos)).length();
 #else
        /* Due to QTBUG-25536 in 4.8.1 <= Qt < 5.1.0, the string returned
-        * by QString::toUcs4 (used by qstring_to_ucs4)may have wrong
+        * by QString::toUcs4 (used by qstring_to_ucs4) may have wrong
         * length. We work around the problem by trying all docstring
         * positions until the right one is found. This is slow only if
         * there are many high-plane Unicode characters. It might be
@@ -267,10 +320,10 @@ int GuiFontMetrics::countExpanders(docstring const & str) const
 }
 
 
-bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const force) const
+pair<int, int>
+GuiFontMetrics::breakAt_helper(docstring const & s, int const x,
+                               bool const rtl, bool const force) const
 {
-       if (s.empty())
-               return false;
        QTextLayout tl;
        /* Qt will not break at a leading or trailing space, and we need
         * that sometimes, see http://www.lyx.org/trac/ticket/9921.
@@ -278,7 +331,7 @@ bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const
         * To work around the problem, we enclose the string between
         * zero-width characters so that the QTextLayout algorithm will
         * agree to break the text at these extremal spaces.
-       */
+        */
        // Unicode character ZERO WIDTH NO-BREAK SPACE
        QChar const zerow_nbsp(0xfeff);
        QString qs = zerow_nbsp + toqstr(s) + zerow_nbsp;
@@ -312,8 +365,7 @@ bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const
        tl.createLine();
        tl.endLayout();
        if ((force && line.textLength() == offset) || int(line.naturalTextWidth()) > x)
-               return false;
-       x = int(line.naturalTextWidth());
+               return {-1, -1};
        /* Since QString is UTF-16 and docstring is UCS-4, the offsets may
         * not be the same when there are high-plan unicode characters
         * (bug #10443).
@@ -322,10 +374,10 @@ bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const
        // The ending character zerow_nbsp has to be ignored if the line is complete.
        int const qlen = line.textLength() - offset - (line.textLength() == qs.length());
 #if QT_VERSION < 0x040801 || QT_VERSION >= 0x050100
-       s = qstring_to_ucs4(qs.mid(offset, qlen));
+       int len = qstring_to_ucs4(qs.mid(offset, qlen)).length();
 #else
        /* Due to QTBUG-25536 in 4.8.1 <= Qt < 5.1.0, the string returned
-        * by QString::toUcs4 (used by qstring_to_ucs4)may have wrong
+        * by QString::toUcs4 (used by qstring_to_ucs4) may have wrong
         * length. We work around the problem by trying all docstring
         * positions until the right one is found. This is slow only if
         * there are many high-plane Unicode characters. It might be
@@ -336,8 +388,33 @@ bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const
        while (len >= 0 && toqstr(s.substr(0, len)).length() != qlen)
                --len;
        LASSERT(len > 0 || qlen == 0, /**/);
-       s = s.substr(0, len);
 #endif
+       // The -1 is here to account for the leading zerow_nbsp.
+       return {len, int(line.naturalTextWidth())};
+}
+
+
+bool GuiFontMetrics::breakAt(docstring & s, int & x, bool const rtl, bool const force) const
+{
+       PROFILE_THIS_BLOCK(breakAt);
+       if (s.empty())
+               return false;
+
+       docstring const s_cache =
+               s + convert<docstring>(x) + (rtl ? "r" : "l") + (force ? "f" : "w");
+       pair<int, int> pp;
+
+       if (breakat_cache_.contains(s_cache))
+               pp = breakat_cache_[s_cache];
+       else {
+               PROFILE_CACHE_MISS(breakAt);
+               pp = breakAt_helper(s, x, rtl, force);
+               breakat_cache_.insert(s_cache, pp, s_cache.size() * sizeof(char_type));
+       }
+       if (pp.first == -1)
+               return false;
+       s = s.substr(0, pp.first);
+       x = pp.second;
        return true;
 }
 
@@ -353,7 +430,6 @@ void GuiFontMetrics::rectText(docstring const & str,
 }
 
 
-
 void GuiFontMetrics::buttonText(docstring const & str,
        int & w, int & ascent, int & descent) const
 {