src/util/areastore.h

   1 /*
   2 Minetest
   3 Copyright (C) 2015 est31 <mtest31@outlook.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef AREA_STORE_H_
  21 #define AREA_STORE_H_
  22
  23 #include "irr_v3d.h"
  24 #include "noise.h" // for PcgRandom
  25 #include <map>
  26 #include <list>
  27 #include <vector>
  28 #include <istream>
  29 #include "util/container.h"
  30 #include "util/numeric.h"
  31 #ifndef ANDROID
  32         #include "cmake_config.h"
  33 #endif
  34 #if USE_SPATIAL
  35         #include <spatialindex/SpatialIndex.h>
  36         #include "util/serialize.h"
  37 #endif
  38
  39
  40 struct Area {
  41         Area() {}
  42         Area(const v3s16 &mine, const v3s16 &maxe)
  43         {
  44                 minedge = mine;
  45                 maxedge = maxe;
  46                 sortBoxVerticies(minedge, maxedge);
  47         }
  48
  49         u32 id;
  50         v3s16 minedge;
  51         v3s16 maxedge;
  52         std::string data;
  53 };
  54
  55
  56 class AreaStore {
  57 protected:
  58         void invalidateCache();
  59         virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos) = 0;
  60         u32 getNextId() { return m_next_id++; }
  61
  62         // Note: This can't be an unordered_map, since all
  63         // references would be invalidated on rehash.
  64         typedef std::map<u32, Area> AreaMap;
  65         AreaMap areas_map;
  66 public:
  67         // Updates the area's ID
  68         virtual bool insertArea(Area *a) = 0;
  69         virtual void reserve(size_t count) {};
  70         virtual bool removeArea(u32 id) = 0;
  71         void getAreasForPos(std::vector<Area *> *result, v3s16 pos);
  72         virtual void getAreasInArea(std::vector<Area *> *result,
  73                 v3s16 minedge, v3s16 maxedge, bool accept_overlap) = 0;
  74
  75 #if 0
  76         // calls a passed function for every stored area, until the
  77         // callback returns true. If that happens, it returns true,
  78         // if the search is exhausted, it returns false
  79         virtual bool forEach(bool (*callback)(void *args, Area *a), void *args) const = 0;
  80 #endif
  81
  82         virtual ~AreaStore()
  83         {}
  84
  85         AreaStore() :
  86                 m_cacheblock_radius(64),
  87                 m_res_cache(1000, &cacheMiss, this),
  88                 m_next_id(0),
  89                 m_cache_enabled(true)
  90         {
  91         }
  92
  93         void setCacheParams(bool enabled, u8 block_radius, size_t limit);
  94
  95         const Area *getArea(u32 id) const;
  96         u16 size() const;
  97
  98         static AreaStore *getOptimalImplementation();
  99 #if 0
 100         bool deserialize(std::istream &is);
 101         void serialize(std::ostream &is) const;
 102 #endif
 103 private:
 104         static void cacheMiss(void *data, const v3s16 &mpos, std::vector<Area *> *dest);
 105         u8 m_cacheblock_radius; // if you modify this, call invalidateCache()
 106         LRUCache<v3s16, std::vector<Area *> > m_res_cache;
 107         u32 m_next_id;
 108         bool m_cache_enabled;
 109 };
 110
 111
 112 class VectorAreaStore : public AreaStore {
 113 protected:
 114         virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos);
 115 public:
 116         virtual void reserve(size_t count) { m_areas.reserve(count); }
 117         virtual bool insertArea(Area *a);
 118         virtual bool removeArea(u32 id);
 119         virtual void getAreasInArea(std::vector<Area *> *result,
 120                 v3s16 minedge, v3s16 maxedge, bool accept_overlap);
 121         // virtual bool forEach(bool (*callback)(void *args, Area *a), void *args) const;
 122 private:
 123         std::vector<Area *> m_areas;
 124 };
 125
 126 #if USE_SPATIAL
 127
 128 class SpatialAreaStore : public AreaStore {
 129 protected:
 130         virtual void getAreasForPosImpl(std::vector<Area *> *result, v3s16 pos);
 131 public:
 132         SpatialAreaStore();
 133         virtual bool insertArea(Area *a);
 134         virtual bool removeArea(u32 id);
 135         virtual void getAreasInArea(std::vector<Area *> *result,
 136                 v3s16 minedge, v3s16 maxedge, bool accept_overlap);
 137         // virtual bool forEach(bool (*callback)(void *args, Area *a), void *args) const;
 138
 139         virtual ~SpatialAreaStore();
 140 private:
 141         SpatialIndex::ISpatialIndex *m_tree;
 142         SpatialIndex::IStorageManager *m_storagemanager;
 143
 144         class VectorResultVisitor : public SpatialIndex::IVisitor {
 145         private:
 146                 SpatialAreaStore *m_store;
 147                 std::vector<Area *> *m_result;
 148         public:
 149                 VectorResultVisitor(std::vector<Area *> *result, SpatialAreaStore *store)
 150                 {
 151                         m_store = store;
 152                         m_result = result;
 153                 }
 154
 155                 virtual void visitNode(const SpatialIndex::INode &in)
 156                 {
 157                 }
 158
 159                 virtual void visitData(const SpatialIndex::IData &in)
 160                 {
 161                         u32 id = in.getIdentifier();
 162
 163                         std::map<u32, Area>::iterator itr = m_store->areas_map.find(id);
 164                         assert(itr != m_store->areas_map.end());
 165                         m_result->push_back(&itr->second);
 166                 }
 167
 168                 virtual void visitData(std::vector<const SpatialIndex::IData *> &v)
 169                 {
 170                         for (size_t i = 0; i < v.size(); i++)
 171                                 visitData(*(v[i]));
 172                 }
 173
 174                 ~VectorResultVisitor() {}
 175         };
 176 };
 177
 178 #endif
 179
 180 #endif // AREA_STORE_H_