src/objdef.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2015 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   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 OBJDEF_HEADER
  21 #define OBJDEF_HEADER
  22
  23 #include "util/basic_macros.h"
  24 #include "porting.h"
  25
  26 class IGameDef;
  27 class INodeDefManager;
  28
  29 #define OBJDEF_INVALID_INDEX ((u32)(-1))
  30 #define OBJDEF_INVALID_HANDLE 0
  31 #define OBJDEF_HANDLE_SALT 0x00585e6fu
  32 #define OBJDEF_MAX_ITEMS (1 << 18)
  33 #define OBJDEF_UID_MASK ((1 << 7) - 1)
  34
  35 typedef u32 ObjDefHandle;
  36
  37 enum ObjDefType {
  38         OBJDEF_GENERIC,
  39         OBJDEF_BIOME,
  40         OBJDEF_ORE,
  41         OBJDEF_DECORATION,
  42         OBJDEF_SCHEMATIC,
  43 };
  44
  45 class ObjDef {
  46 public:
  47         virtual ~ObjDef() {}
  48
  49         u32 index;
  50         u32 uid;
  51         ObjDefHandle handle;
  52         std::string name;
  53 };
  54
  55 // WARNING: Ownership of ObjDefs is transferred to the ObjDefManager it is
  56 // added/set to.  Note that ObjDefs managed by ObjDefManager are NOT refcounted,
  57 // so the same ObjDef instance must not be referenced multiple
  58 class ObjDefManager {
  59 public:
  60         ObjDefManager(IGameDef *gamedef, ObjDefType type);
  61         virtual ~ObjDefManager();
  62
  63         virtual const char *getObjectTitle() const { return "ObjDef"; }
  64
  65         virtual void clear();
  66         virtual ObjDef *getByName(const std::string &name) const;
  67
  68         //// Add new/get/set object definitions by handle
  69         virtual ObjDefHandle add(ObjDef *obj);
  70         virtual ObjDef *get(ObjDefHandle handle) const;
  71         virtual ObjDef *set(ObjDefHandle handle, ObjDef *obj);
  72
  73         //// Raw variants that work on indexes
  74         virtual u32 addRaw(ObjDef *obj);
  75
  76         // It is generally assumed that getRaw() will always return a valid object
  77         // This won't be true if people do odd things such as call setRaw() with NULL
  78         virtual ObjDef *getRaw(u32 index) const;
  79         virtual ObjDef *setRaw(u32 index, ObjDef *obj);
  80
  81         size_t getNumObjects() const { return m_objects.size(); }
  82         ObjDefType getType() const { return m_objtype; }
  83         INodeDefManager *getNodeDef() const { return m_ndef; }
  84
  85         u32 validateHandle(ObjDefHandle handle) const;
  86         static ObjDefHandle createHandle(u32 index, ObjDefType type, u32 uid);
  87         static bool decodeHandle(ObjDefHandle handle, u32 *index,
  88                 ObjDefType *type, u32 *uid);
  89
  90 protected:
  91         INodeDefManager *m_ndef;
  92         std::vector<ObjDef *> m_objects;
  93         ObjDefType m_objtype;
  94
  95 private:
  96         DISABLE_CLASS_COPY(ObjDefManager);
  97 };
  98
  99 #endif