add config.h

[lyx.git] / src / coordcache.h

diff --git a/src/coordcache.h b/src/coordcache.h
index ab9073c5788a5a5d42ac9f5b76e6b54af4bd70ad..dba9b89fd4d283a2a27c7c31e9ecf2dac1a4c379 100644 (file)
--- a/src/coordcache.h
+++ b/src/coordcache.h
@@ -1,42 +1,43 @@
+// -*- 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
 
-class InsetBase;
-class LyXText;
-class MathArray;
-class Paragraph;
+// It seems that MacOSX define the check macro.
+#undef check
 
 #include "support/types.h"
 
-#include <boost/assert.hpp>
-
 #include <map>
 
+namespace lyx {
 
-// 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.
+class InsetBase;
+class LyXText;
+class MathArray;
+class Paragraph;
 
 void lyxbreaker(void const * data, const char * hint, int size);
-void lyxaborter(int x, int y);
 
-struct Point {
+class Point {
+public:
        Point()
                : x_(0), y_(0)
        {}
 
-       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);
-       }
+       Point(int x, int y);
 
        int x_, y_;
 };
 
-
 template <class T> class CoordCacheBase {
 public:
        void clear()
@@ -44,6 +45,11 @@ public:
                data_.clear();
        }
 
+       bool const empty() const
+       {
+               return data_.empty();
+       }
+
        void add(T const * thing, int x, int y)
        {
                data_[thing] = Point(x, y);
@@ -89,25 +95,67 @@ private:
 
        typedef std::map<T const *, Point> cache_type;
        cache_type data_;
-};
 
+public:
+       cache_type const & getData() const { return 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
+ * updates. (x,y) == (0,0) is the upper left screen corner, x increases
+ * to the right, y increases downwords.
+ * The cache is built in BufferView::updateMetrics which is called
+ * from BufferView::update. The individual points are added
+ * while we paint them. See for instance paintPar in RowPainter.C.
+ */
 class CoordCache {
 public:
        void clear();
-       Point get(LyXText const *, lyx::pit_type);
+       Point get(LyXText const *, pit_type) const;
+
+       /// A map from paragraph index number to screen point
+       typedef std::map<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() { return arrays_; }
+       CoordCacheBase<MathArray> const & getArrays() const { return arrays_; }
+       /// A map from insets to positions on the screen
+       CoordCacheBase<InsetBase> & insets() { return insets_; }
+       CoordCacheBase<InsetBase> const & getInsets() const { return insets_; }
+       /// A map from (LyXText, paragraph) pair to screen positions
+       ParPosCache & parPos() { return pars_; }
+       ParPosCache const & getParPos() const { return pars_; }
+       ///
+       SliceCache & slice(bool boundary)
+       {
+               return boundary ? slices1_ : slices0_;
+       }
+       SliceCache const & getSlice(bool boundary) const
+       {
+               return boundary ? slices1_ : slices0_;
+       }
 
+       /// Dump the contents of the cache to lyxerr in debugging form
+       void dump() const;
+private:
+       /// MathArrays
        CoordCacheBase<MathArray> arrays_;
-       
-       // all insets
+       // All insets
        CoordCacheBase<InsetBase> insets_;
-
-       // paragraph grouped by owning text
-       typedef std::map<lyx::pit_type, Point> InnerParPosCache;
-       typedef std::map<LyXText const *, InnerParPosCache> ParPosCache;
+       /// Paragraph grouped by owning text
        ParPosCache pars_;
+       /// Used with boundary == 0
+       SliceCache slices0_;
+       /// Used with boundary == 1
+       SliceCache slices1_;
 };
 
-extern CoordCache theCoords;
+} // namespace lyx
 
 #endif