3 Copyright (C) 2010-2015 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
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.
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.
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.
23 #include "util/basic_macros.h"
27 class INodeDefManager;
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)
35 typedef u32 ObjDefHandle;
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
60 ObjDefManager(IGameDef *gamedef, ObjDefType type);
61 virtual ~ObjDefManager();
63 virtual const char *getObjectTitle() const { return "ObjDef"; }
66 virtual ObjDef *getByName(const std::string &name) const;
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);
73 //// Raw variants that work on indexes
74 virtual u32 addRaw(ObjDef *obj);
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);
81 size_t getNumObjects() const { return m_objects.size(); }
82 ObjDefType getType() const { return m_objtype; }
83 INodeDefManager *getNodeDef() const { return m_ndef; }
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);
91 INodeDefManager *m_ndef;
92 std::vector<ObjDef *> m_objects;
96 DISABLE_CLASS_COPY(ObjDefManager);