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 #pragma once 21 22 #include "util/basic_macros.h" 23 #include "porting.h" 24 25 class IGameDef; 26 class NodeDefManager; 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 class ObjDef { 45 public: 46 virtual ~ObjDef() = default; 47 48 // Only implemented by child classes (leafs in class hierarchy) 49 // Should create new object of its own type, call cloneTo() of parent class 50 // and copy its own instance variables over 51 virtual ObjDef *clone() const = 0; 52 53 u32 index; 54 u32 uid; 55 ObjDefHandle handle; 56 std::string name; 57 58 protected: 59 // Only implemented by classes that have children themselves 60 // by copying the defintion and changing that argument type (!!!) 61 // Should defer to parent class cloneTo() if applicable and then copy 62 // over its own properties 63 void cloneTo(ObjDef *def) const; 64 }; 65 66 // WARNING: Ownership of ObjDefs is transferred to the ObjDefManager it is 67 // added/set to. Note that ObjDefs managed by ObjDefManager are NOT refcounted, 68 // so the same ObjDef instance must not be referenced multiple 69 // TODO: const correctness for getter methods 70 class ObjDefManager { 71 public: 72 ObjDefManager(IGameDef *gamedef, ObjDefType type); 73 virtual ~ObjDefManager(); 74 DISABLE_CLASS_COPY(ObjDefManager); 75 76 // T *clone() const; // implemented in child class with correct type 77 getObjectTitle()78 virtual const char *getObjectTitle() const { return "ObjDef"; } 79 80 virtual void clear(); 81 virtual ObjDef *getByName(const std::string &name) const; 82 83 //// Add new/get/set object definitions by handle 84 virtual ObjDefHandle add(ObjDef *obj); 85 virtual ObjDef *get(ObjDefHandle handle) const; 86 virtual ObjDef *set(ObjDefHandle handle, ObjDef *obj); 87 88 //// Raw variants that work on indexes 89 virtual u32 addRaw(ObjDef *obj); 90 91 // It is generally assumed that getRaw() will always return a valid object 92 // This won't be true if people do odd things such as call setRaw() with NULL 93 virtual ObjDef *getRaw(u32 index) const; 94 virtual ObjDef *setRaw(u32 index, ObjDef *obj); 95 getNumObjects()96 size_t getNumObjects() const { return m_objects.size(); } getType()97 ObjDefType getType() const { return m_objtype; } getNodeDef()98 const NodeDefManager *getNodeDef() const { return m_ndef; } 99 100 u32 validateHandle(ObjDefHandle handle) const; 101 static ObjDefHandle createHandle(u32 index, ObjDefType type, u32 uid); 102 static bool decodeHandle(ObjDefHandle handle, u32 *index, 103 ObjDefType *type, u32 *uid); 104 105 protected: ObjDefManager()106 ObjDefManager() {}; 107 // Helper for child classes to implement clone() 108 void cloneTo(ObjDefManager *mgr) const; 109 110 const NodeDefManager *m_ndef; 111 std::vector<ObjDef *> m_objects; 112 ObjDefType m_objtype; 113 }; 114