+// -*- C++ -*-
+/* \file coordcache.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
#ifndef COORDCACHE_H
#define COORDCACHE_H
-#include "mathed/math_data.h"
-#include "insets/insetbase.h"
-#include "lyxtext.h"
+class InsetBase;
+class LyXText;
+class MathArray;
+class Paragraph;
+
+#include "support/types.h"
#include <boost/assert.hpp>
#include <map>
-
-// All positions cached in this cache are only valid between subsequent
-// updated. (x,y) == (0,0) is the upper left screen corner, x increases
-// to the right, y increases downwords.
-
void lyxbreaker(void const * data, const char * hint, int size);
-struct Point {
+class Point {
+public:
Point()
: x_(0), y_(0)
- {}
+ {}
- Point(int x, int y) : x_(x), y_(y)
+ Point(int x, int y)
+ : x_(x), y_(y)
{
- BOOST_ASSERT(x > -3000);
- BOOST_ASSERT(x < 4000);
- BOOST_ASSERT(y > -3000);
- BOOST_ASSERT(y < 4000);
- }
+ BOOST_ASSERT(x > -1000000);
+ BOOST_ASSERT(x < 1000000);
+ BOOST_ASSERT(y > -1000000);
+ BOOST_ASSERT(y < 1000000);
+ }
int x_, y_;
};
-
template <class T> class CoordCacheBase {
public:
void clear()
// T * find(int x, int y) const
// {
-// T *
+// T *
// cache_type iter
-// }
+// }
private:
friend class CoordCache;
void check(T const * thing, char const * hint) const
{
- if (!has(thing)) {
+ if (!has(thing))
lyxbreaker(thing, hint, data_.size());
- BOOST_ASSERT(false);
- }
}
typedef std::map<T const *, Point> cache_type;
cache_type data_;
};
-
+/**
+ * A global cache that allows us to come from a paragraph in a document
+ * to a position point on the screen.
+ * All points cached in this cache are only valid between subsequent
+ * updated. (x,y) == (0,0) is the upper left screen corner, x increases
+ * to the right, y increases downwords.
+ * The cache is built in BufferView::Pimpl::metrics which is called
+ * from BufferView::Pimpl::update. The individual points are added
+ * while we paint them. See for instance paintPar in RowPainter.C.
+ */
class CoordCache {
public:
- void clear();
+ CoordCache() : updating(false) { }
+ /// In order to find bugs, we record when we start updating the cache
+ void startUpdating();
+ /// When we are done, we record that to help find bugs
+ void doneUpdating();
+ void clear();
+ Point get(LyXText const *, lyx::pit_type);
+
+ /// A map from paragraph index number to screen point
+ typedef std::map<lyx::pit_type, Point> InnerParPosCache;
+ /// A map from a LyXText to the map of paragraphs to screen points
+ typedef std::map<LyXText const *, InnerParPosCache> ParPosCache;
+ /// A map from a CursorSlice to screen points
+ typedef std::map<LyXText const *, InnerParPosCache> SliceCache;
+
+ /// A map from MathArray to position on the screen
+ CoordCacheBase<MathArray> & arrays() { BOOST_ASSERT(updating); return arrays_; }
+ CoordCacheBase<MathArray> const & getArrays() const { return arrays_; }
+ /// A map from insets to positions on the screen
+ CoordCacheBase<InsetBase> & insets() { BOOST_ASSERT(updating); return insets_; }
+ CoordCacheBase<InsetBase> const & getInsets() const { return insets_; }
+ /// A map from (LyXText, paragraph) pair to screen positions
+ ParPosCache & parPos() { BOOST_ASSERT(updating); return pars_; }
+ ParPosCache const & getParPos() const { return pars_; }
+ ///
+ SliceCache & slice(bool boundary)
+ {
+ BOOST_ASSERT(updating);
+ return boundary ? slices1_ : slices0_;
+ }
+ SliceCache const & getSlice(bool boundary) const
+ {
+ return boundary ? slices1_ : slices0_;
+ }
+
+private:
+ /// MathArrays
CoordCacheBase<MathArray> arrays_;
+ // All insets
CoordCacheBase<InsetBase> insets_;
+ /// Paragraph grouped by owning text
+ ParPosCache pars_;
+ /// Used with boundary == 0
+ SliceCache slices0_;
+ /// Used with boundary == 1
+ SliceCache slices1_;
+
+ /**
+ * Debugging flag only: Set to true while the cache is being built.
+ * No changes to the structure are allowed unless we are updating.
+ */
+ bool updating;
};
extern CoordCache theCoords;