#include "support/convert.h"
#include "support/lassert.h"
-#ifdef CACHE_SOME_METRICS
#include <QByteArray>
-#endif
using namespace std;
using namespace lyx::support;
-#ifdef CACHE_SOME_METRICS
namespace std {
/*
}
}
-#endif
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.
} // anon namespace
-/*
- * 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.
- */
GuiFontMetrics::GuiFontMetrics(QFont const & font)
- : font_(font), metrics_(font, 0)
-#ifdef CACHE_METRICS_WIDTH
- , strwidth_cache_(1 << 19)
-#endif
-#ifdef CACHE_METRICS_BREAKAT
- , breakat_cache_(1 << 19)
-#endif
-#ifdef CACHE_METRICS_QTEXTLAYOUT
- , qtextlayout_cache_(500)
-#endif
+ : font_(font), metrics_(font, 0),
+ strwidth_cache_(cache_metrics_width_size),
+ breakat_cache_(cache_metrics_breakat_size),
+ qtextlayout_cache_(cache_metrics_qtextlayout_size)
{
}
int GuiFontMetrics::width(docstring const & s) const
{
-#ifdef CACHE_METRICS_WIDTH
- int * pw = strwidth_cache_[s];
- if (pw)
- return *pw;
-#endif
+ if (strwidth_cache_.contains(s))
+ return strwidth_cache_[s];
/* 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
tl.endLayout();
w = int(line.naturalTextWidth());
}
-#ifdef CACHE_METRICS_WIDTH
- strwidth_cache_.insert(s, new int(w), s.size() * sizeof(char_type));
-#endif
+ strwidth_cache_.insert(s, w, s.size() * sizeof(char_type));
return w;
}
}
-QTextLayout const *
+shared_ptr<QTextLayout const>
GuiFontMetrics::getTextLayout(docstring const & s, bool const rtl,
double const wordspacing) const
{
- QTextLayout * ptl;
-#ifdef CACHE_METRICS_QTEXTLAYOUT
- docstring const s_cache = s + (rtl ? "r" : "l") + convert<docstring>(wordspacing);
- ptl = qtextlayout_cache_[s_cache];
- if (!ptl) {
-#endif
- ptl = new 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();
-#ifdef CACHE_METRICS_QTEXTLAYOUT
- qtextlayout_cache_.insert(s_cache, ptl);
- }
-#endif
+ docstring const s_cache =
+ s + (rtl ? "r" : "l") + convert<docstring>(wordspacing);
+ if (shared_ptr<QTextLayout const> ptl = qtextlayout_cache_[s_cache])
+ return ptl;
+ shared_ptr<QTextLayout> 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;
}
{
if (pos <= 0)
pos = 0;
- QTextLayout const * tl = getTextLayout(s, rtl, wordspacing);
+ 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 GuiFontMetrics::x2pos(docstring const & s, int & x, bool const rtl,
double const wordspacing) const
{
- QTextLayout const * tl = getTextLayout(s, rtl, wordspacing);
+ 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));
-pair<int, int> *
+pair<int, int>
GuiFontMetrics::breakAt_helper(docstring const & s, int const x,
bool const rtl, bool const force) const
{
tl.createLine();
tl.endLayout();
if ((force && line.textLength() == offset) || int(line.naturalTextWidth()) > x)
- return new pair<int, int>(-1, -1);
+ return make_pair(-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).
LASSERT(len > 0 || qlen == 0, /**/);
#endif
// The -1 is here to account for the leading zerow_nbsp.
- return new pair<int, int>(len, int(line.naturalTextWidth()));
+ return make_pair(len, int(line.naturalTextWidth()));
}
{
if (s.empty())
return false;
- pair<int, int> * pp;
-#ifdef CACHE_METRICS_BREAKAT
- docstring const s_cache = s + convert<docstring>(x) + (rtl ? "r" : "l") + (force ? "f" : "w");
- pp = breakat_cache_[s_cache];
- if (!pp) {
-#endif
+ 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 {
pp = breakAt_helper(s, x, rtl, force);
-#ifdef CACHE_METRICS_BREAKAT
breakat_cache_.insert(s_cache, pp, s_cache.size() * sizeof(char_type));
}
-#endif
- if (pp->first == -1)
+ if (pp.first == -1)
return false;
- s = s.substr(0, pp->first);
- x = pp->second;
-#ifndef CACHE_METRICS_BREAKAT
- delete pp;
-#endif
+ s = s.substr(0, pp.first);
+ x = pp.second;
return true;
}
#include "frontends/FontMetrics.h"
+#include "support/Cache.h"
#include "support/docstring.h"
+#include "support/shared_ptr.h"
#include <QFont>
#include <QFontMetrics>
#include <QHash>
#include <QTextLayout>
-// Declare which font metrics elements have to be cached
-
-#define CACHE_METRICS_WIDTH
-#define CACHE_METRICS_BREAKAT
-// Qt 5.x already has its own caching of QTextLayout objects
-#if (QT_VERSION < 0x050000)
-#define CACHE_METRICS_QTEXTLAYOUT
-#endif
-
-#if defined(CACHE_METRICS_WIDTH) || defined(CACHE_METRICS_BREAKAT) \
- || defined(CACHE_METRICS_QTEXTLAYOUT)
-#define CACHE_SOME_METRICS
-#endif
-
-#ifdef CACHE_SOME_METRICS
-#include <QCache>
-#endif
+#include <memory>
namespace lyx {
namespace frontend {
int width(QString const & str) const;
/// Return a pointer to a cached QTextLayout object
- QTextLayout const *
+ shared_ptr<QTextLayout const>
getTextLayout(docstring const & s, bool const rtl,
- double const wordspacing) const;
+ double const wordspacing) const;
private:
- std::pair<int, int> *
- breakAt_helper(docstring const & s, int const x,
- bool const rtl, bool const force) const;
+ std::pair<int, int> breakAt_helper(docstring const & s, int const x,
+ bool const rtl, bool const force) const;
/// The font
QFont font_;
/// Cache of char widths
mutable QHash<char_type, int> width_cache_;
-
-#ifdef CACHE_METRICS_WIDTH
/// Cache of string widths
- mutable QCache<docstring, int> strwidth_cache_;
-#endif
-
-#ifdef CACHE_METRICS_BREAKAT
+ mutable Cache<docstring, int> strwidth_cache_;
/// Cache for breakAt
- mutable QCache<docstring, std::pair<int, int> > breakat_cache_;
-#endif
-
-#ifdef CACHE_METRICS_QTEXTLAYOUT
- /// Cache for QTextLayout:s
- mutable QCache<docstring, QTextLayout> qtextlayout_cache_;
-#endif
+ mutable Cache<docstring, std::pair<int, int> > breakat_cache_;
+ /// Cache for QTextLayout
+ mutable Cache<docstring, shared_ptr<QTextLayout> > qtextlayout_cache_;
struct AscendDescend {
int ascent;
--- /dev/null
+// -*- C++ -*-
+/**
+ * \file Cache.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Guillaume Munch
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
+#ifndef CACHE_H
+#define CACHE_H
+
+#include <QCache>
+
+#include <list>
+#ifdef LYX_USE_CXX11
+#include <type_traits>
+#endif
+
+namespace lyx {
+
+/**
+ * Cache<Key, T> implements a cache where objects are stored by copy.
+ *
+ * This is a wrapper for QCache. See the documentation of QCache:
+ * <https://doc.qt.io/qt-5/qcache.html>.
+ *
+ * It is especially useful for storing shared pointers. This turns QCache into a
+ * shared-ownership cache with no risks of dangling pointer. It is also useful
+ * for small copyable objects.
+ *
+ * Use this rather than QCache directly, to avoid naked pointers.
+ */
+template <class Key, class Val>
+class Cache : private QCache<Key, Val> {
+#if defined(LYX_USE_CXX11) && !(defined(__GNUC__) && (__GNUC__ == 4) && (__GNUC_MINOR__ == 6))
+ static_assert(std::is_copy_constructible<Val>::value,
+ "lyx::Cache only stores copyable objects!");
+ static_assert(std::is_default_constructible<Val>::value,
+ "lyx::Cache only stores default-constructible objects!");
+ using Q = QCache<Key, Val>;
+#else
+ typedef QCache<Key, Val> Q;
+#endif
+
+public:
+ ///
+ Cache(int max_cost = 100) : Q(max_cost) {}
+ ///
+#ifdef LYX_USE_CXX11
+ bool insert(Key const & key, Val object, int cost = 1)
+ {
+ return Q::insert(key, new Val(std::move(object)), cost);
+ }
+#else
+ bool insert(Key const & key, Val const & object, int cost = 1)
+ {
+ return Q::insert(key, new Val(object), cost);
+ }
+#endif
+ // Returns the default value (e.g. null pointer) if not found in the
+ // cache. If this is not convenient for your class Val, check if it exists
+ // beforehand with Cache::contains.
+ Val object(Key const & key) const
+ {
+ if (Val * obj = Q::object(key))
+ return *obj;
+ return Val();
+ }
+ /// Synonymous for object, same remark as above.
+ Val operator[](Key const & key) const { return object(key); }
+ /// Everything from QCache except QCache::take.
+ using Q::clear;
+ using Q::contains;
+ using Q::count;
+ using Q::remove;
+ using Q::size;
+ bool empty() const { return Q::isEmpty(); }
+ std::list<Key> keys() { return Q::keys().toStdList(); }
+ int max_cost() const { return Q::maxCost(); }
+ void set_max_cost(int cost) { Q::setMaxCost(cost); }
+ int total_cost() const { return Q::totalCost(); }
+};
+
+} // namespace lyx
+
+#endif
projects / features.git / commitdiff