Line data    Source code

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