src/CoordCache.h

   1 // -*- C++ -*-
   2 /* \file CoordCache.h
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #ifndef COORDCACHE_H
  12 #define COORDCACHE_H
  13
  14 // It seems that MacOSX define the check macro.
  15 #undef check
  16
  17 #include "Dimension.h"
  18
  19 #include <unordered_map>
  20
  21 namespace lyx {
  22
  23 class Inset;
  24 class MathData;
  25
  26 void lyxbreaker(void const * data, const char * hint, int size);
  27
  28 struct Geometry {
  29         Point pos = {-10000, -10000 };
  30         Dimension dim;
  31
  32         bool covers(int x, int y) const
  33         {
  34                 return x >= pos.x_
  35                         && x <= pos.x_ + dim.wid
  36                         && y >= pos.y_ - dim.asc
  37                         && y <= pos.y_ + dim.des;
  38         }
  39
  40         int squareDistance(int x, int y) const
  41         {
  42                 int xx = 0;
  43                 int yy = 0;
  44
  45                 if (x < pos.x_)
  46                         xx = pos.x_ - x;
  47                 else if (x > pos.x_ + dim.wid)
  48                         xx = x - pos.x_ - dim.wid;
  49
  50                 if (y < pos.y_ - dim.asc)
  51                         yy = pos.y_ - dim.asc - y;
  52                 else if (y > pos.y_ + dim.des)
  53                         yy = y - pos.y_ - dim.des;
  54
  55                 // Optimisation: We avoid to compute the sqrt on purpose.
  56                 return xx*xx + yy*yy;
  57         }
  58 };
  59
  60
  61 template <class T> class CoordCacheBase {
  62 public:
  63         void clear()
  64         {
  65                 data_.clear();
  66         }
  67
  68         bool empty() const
  69         {
  70                 return data_.empty();
  71         }
  72
  73         void add(T const * thing, int x, int y)
  74         {
  75                 data_[thing].pos = Point(x, y);
  76         }
  77
  78         void add(T const * thing, Dimension const & dim)
  79         {
  80                 data_[thing].dim = dim;
  81         }
  82
  83         Geometry & geometry(T const * thing)
  84         {
  85                 checkDim(thing, "geometry");
  86                 return data_.find(thing)->second;
  87         }
  88
  89         Geometry const & geometry(T const * thing) const
  90         {
  91                 checkDim(thing, "geometry");
  92                 return data_.find(thing)->second;
  93         }
  94
  95         Dimension const & dim(T const * thing) const
  96         {
  97                 checkDim(thing, "dim");
  98                 return data_.find(thing)->second.dim;
  99         }
 100
 101         int x(T const * thing) const
 102         {
 103                 check(thing, "x");
 104                 return data_.find(thing)->second.pos.x_;
 105         }
 106
 107         int y(T const * thing) const
 108         {
 109                 check(thing, "y");
 110                 return data_.find(thing)->second.pos.y_;
 111         }
 112
 113         Point xy(T const * thing) const
 114         {
 115                 check(thing, "xy");
 116                 return data_.find(thing)->second.pos;
 117         }
 118
 119         bool has(T const * thing) const
 120         {
 121                 typename cache_type::const_iterator it = data_.find(thing);
 122
 123                 if (it == data_.end())
 124                         return false;
 125                 return it->second.pos.x_ != -10000;
 126         }
 127
 128         bool hasDim(T const * thing) const
 129         {
 130                 return data_.find(thing) != data_.end();
 131         }
 132
 133         bool covers(T const * thing, int x, int y) const
 134         {
 135                 typename cache_type::const_iterator it = data_.find(thing);
 136                 return it != data_.end() && it->second.covers(x, y);
 137         }
 138
 139         int squareDistance(T const * thing, int x, int y) const
 140         {
 141                 typename cache_type::const_iterator it = data_.find(thing);
 142                 if (it == data_.end())
 143                         return 1000000;
 144                 return it->second.squareDistance(x, y);
 145         }
 146
 147 private:
 148         friend class CoordCache;
 149
 150 #ifdef ENABLE_ASSERTIONS
 151         void checkDim(T const * thing, char const * hint) const
 152         {
 153                 if (!hasDim(thing))
 154                         lyxbreaker(thing, hint, data_.size());
 155         }
 156
 157         void check(T const * thing, char const * hint) const
 158         {
 159                 if (!has(thing))
 160                         lyxbreaker(thing, hint, data_.size());
 161         }
 162 #else
 163         void checkDim(T const *, char const * const ) const {}
 164
 165         void check(T const *, char const *) const {}
 166 #endif
 167
 168         typedef std::unordered_map<T const *, Geometry> cache_type;
 169         cache_type data_;
 170 };
 171
 172 /**
 173  * A BufferView dependent cache that allows us to come from an inset in
 174  * a document to a position point and dimension on the screen.
 175  * All points cached in this cache are only valid between subsequent
 176  * updates. (x,y) == (0,0) is the upper left screen corner, x increases
 177  * to the right, y increases downwords.
 178  * The dimension part is built in BufferView::updateMetrics() and the
 179  * diverse Inset::metrics() calls.
 180  * The individual points are added at drawing time in
 181  * BufferView::draw(). The math inset position are cached in
 182  * the diverse InsetMathXXX::draw() calls and the in-text inset position
 183  * are cached in RowPainter::paintInset().
 184  * FIXME: For mathed, it would be nice if the insets did not saves their
 185  * position themselves. That should be the duty of the containing math
 186  * array.
 187  */
 188 class CoordCache {
 189 public:
 190         void clear();
 191
 192         /// A map from MathData to position on the screen
 193         typedef CoordCacheBase<MathData> Arrays;
 194         Arrays & arrays() { return arrays_; }
 195         Arrays const & getArrays() const { return arrays_; }
 196         /// A map from insets to positions on the screen
 197         typedef CoordCacheBase<Inset> Insets;
 198         Insets & insets() { return insets_; }
 199         Insets const & getInsets() const { return insets_; }
 200
 201         /// Dump the contents of the cache to lyxerr in debugging form
 202         void dump() const;
 203 private:
 204         /// MathDatas
 205         Arrays arrays_;
 206         // All insets
 207         Insets insets_;
 208 };
 209
 210 } // namespace lyx
 211
 212 #endif