Optimize headers (part 2) (#6272)
[oweals/minetest.git] / src / inventory.h
1 /*
2 Minetest
3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.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 #pragma once
21
22 #include "itemdef.h"
23 #include "irrlichttypes.h"
24 #include "itemstackmetadata.h"
25 #include <istream>
26 #include <ostream>
27 #include <string>
28 #include <vector>
29 #include <cassert>
30
31 struct ToolCapabilities;
32
33 struct ItemStack
34 {
35         ItemStack() {}
36         ItemStack(const std::string &name_, u16 count_,
37                         u16 wear, IItemDefManager *itemdef);
38
39         ~ItemStack() {}
40
41         // Serialization
42         void serialize(std::ostream &os) const;
43         // Deserialization.  Pass itemdef unless you don't want aliases resolved.
44         void deSerialize(std::istream &is, IItemDefManager *itemdef = NULL);
45         void deSerialize(const std::string &s, IItemDefManager *itemdef = NULL);
46
47         // Returns the string used for inventory
48         std::string getItemString() const;
49
50         /*
51                 Quantity methods
52         */
53
54         bool empty() const
55         {
56                 return count == 0;
57         }
58
59         void clear()
60         {
61                 name = "";
62                 count = 0;
63                 wear = 0;
64                 metadata.clear();
65         }
66
67         void add(u16 n)
68         {
69                 count += n;
70         }
71
72         void remove(u16 n)
73         {
74                 assert(count >= n); // Pre-condition
75                 count -= n;
76                 if(count == 0)
77                         clear(); // reset name, wear and metadata too
78         }
79
80         // Maximum size of a stack
81         u16 getStackMax(IItemDefManager *itemdef) const
82         {
83                 return itemdef->get(name).stack_max;
84         }
85
86         // Number of items that can be added to this stack
87         u16 freeSpace(IItemDefManager *itemdef) const
88         {
89                 u16 max = getStackMax(itemdef);
90                 if (count >= max)
91                         return 0;
92                 return max - count;
93         }
94
95         // Returns false if item is not known and cannot be used
96         bool isKnown(IItemDefManager *itemdef) const
97         {
98                 return itemdef->isKnown(name);
99         }
100
101         // Returns a pointer to the item definition struct,
102         // or a fallback one (name="unknown") if the item is unknown.
103         const ItemDefinition& getDefinition(
104                         IItemDefManager *itemdef) const
105         {
106                 return itemdef->get(name);
107         }
108
109         // Get tool digging properties, or those of the hand if not a tool
110         const ToolCapabilities& getToolCapabilities(
111                         IItemDefManager *itemdef) const
112         {
113                 ToolCapabilities *cap;
114                 cap = itemdef->get(name).tool_capabilities;
115                 if(cap == NULL)
116                         cap = itemdef->get("").tool_capabilities;
117                 assert(cap != NULL);
118                 return *cap;
119         }
120
121         // Wear out (only tools)
122         // Returns true if the item is (was) a tool
123         bool addWear(s32 amount, IItemDefManager *itemdef)
124         {
125                 if(getDefinition(itemdef).type == ITEM_TOOL)
126                 {
127                         if(amount > 65535 - wear)
128                                 clear();
129                         else if(amount < -wear)
130                                 wear = 0;
131                         else
132                                 wear += amount;
133                         return true;
134                 }
135                 else
136                 {
137                         return false;
138                 }
139         }
140
141         // If possible, adds newitem to this item.
142         // If cannot be added at all, returns the item back.
143         // If can be added partly, decremented item is returned back.
144         // If can be added fully, empty item is returned.
145         ItemStack addItem(ItemStack newitem, IItemDefManager *itemdef);
146
147         // Checks whether newitem could be added.
148         // If restitem is non-NULL, it receives the part of newitem that
149         // would be left over after adding.
150         bool itemFits(ItemStack newitem,
151                         ItemStack *restitem,  // may be NULL
152                         IItemDefManager *itemdef) const;
153
154         // Takes some items.
155         // If there are not enough, takes as many as it can.
156         // Returns empty item if couldn't take any.
157         ItemStack takeItem(u32 takecount);
158
159         // Similar to takeItem, but keeps this ItemStack intact.
160         ItemStack peekItem(u32 peekcount) const;
161
162         /*
163                 Properties
164         */
165         std::string name = "";
166         u16 count = 0;
167         u16 wear = 0;
168         ItemStackMetadata metadata;
169 };
170
171 class InventoryList
172 {
173 public:
174         InventoryList(const std::string &name, u32 size, IItemDefManager *itemdef);
175         ~InventoryList() = default;
176         void clearItems();
177         void setSize(u32 newsize);
178         void setWidth(u32 newWidth);
179         void setName(const std::string &name);
180         void serialize(std::ostream &os) const;
181         void deSerialize(std::istream &is);
182
183         InventoryList(const InventoryList &other);
184         InventoryList & operator = (const InventoryList &other);
185         bool operator == (const InventoryList &other) const;
186         bool operator != (const InventoryList &other) const
187         {
188                 return !(*this == other);
189         }
190
191         const std::string &getName() const;
192         u32 getSize() const;
193         u32 getWidth() const;
194         // Count used slots
195         u32 getUsedSlots() const;
196         u32 getFreeSlots() const;
197
198         // Get reference to item
199         const ItemStack& getItem(u32 i) const;
200         ItemStack& getItem(u32 i);
201         // Returns old item. Parameter can be an empty item.
202         ItemStack changeItem(u32 i, const ItemStack &newitem);
203         // Delete item
204         void deleteItem(u32 i);
205
206         // Adds an item to a suitable place. Returns leftover item (possibly empty).
207         ItemStack addItem(const ItemStack &newitem);
208
209         // If possible, adds item to given slot.
210         // If cannot be added at all, returns the item back.
211         // If can be added partly, decremented item is returned back.
212         // If can be added fully, empty item is returned.
213         ItemStack addItem(u32 i, const ItemStack &newitem);
214
215         // Checks whether the item could be added to the given slot
216         // If restitem is non-NULL, it receives the part of newitem that
217         // would be left over after adding.
218         bool itemFits(const u32 i, const ItemStack &newitem,
219                         ItemStack *restitem = NULL) const;
220
221         // Checks whether there is room for a given item
222         bool roomForItem(const ItemStack &item) const;
223
224         // Checks whether the given count of the given item
225         // exists in this inventory list.
226         // If match_meta is false, only the items' names are compared.
227         bool containsItem(const ItemStack &item, bool match_meta) const;
228
229         // Removes the given count of the given item name from
230         // this inventory list. Walks the list in reverse order.
231         // If not as many items exist as requested, removes as
232         // many as possible.
233         // Returns the items that were actually removed.
234         ItemStack removeItem(const ItemStack &item);
235
236         // Takes some items from a slot.
237         // If there are not enough, takes as many as it can.
238         // Returns empty item if couldn't take any.
239         ItemStack takeItem(u32 i, u32 takecount);
240
241         // Move an item to a different list (or a different stack in the same list)
242         // count is the maximum number of items to move (0 for everything)
243         // returns number of moved items
244         u32 moveItem(u32 i, InventoryList *dest, u32 dest_i,
245                 u32 count = 0, bool swap_if_needed = true, bool *did_swap = NULL);
246
247         // like moveItem, but without a fixed destination index
248         // also with optional rollback recording
249         void moveItemSomewhere(u32 i, InventoryList *dest, u32 count);
250
251 private:
252         std::vector<ItemStack> m_items;
253         std::string m_name;
254         u32 m_size;
255         u32 m_width = 0;
256         IItemDefManager *m_itemdef;
257 };
258
259 class Inventory
260 {
261 public:
262         ~Inventory();
263
264         void clear();
265         void clearContents();
266
267         Inventory(IItemDefManager *itemdef);
268         Inventory(const Inventory &other);
269         Inventory & operator = (const Inventory &other);
270         bool operator == (const Inventory &other) const;
271         bool operator != (const Inventory &other) const
272         {
273                 return !(*this == other);
274         }
275
276         void serialize(std::ostream &os) const;
277         void deSerialize(std::istream &is);
278
279         InventoryList * addList(const std::string &name, u32 size);
280         InventoryList * getList(const std::string &name);
281         const InventoryList * getList(const std::string &name) const;
282         std::vector<const InventoryList*> getLists();
283         bool deleteList(const std::string &name);
284         // A shorthand for adding items. Returns leftover item (possibly empty).
285         ItemStack addItem(const std::string &listname, const ItemStack &newitem)
286         {
287                 m_dirty = true;
288                 InventoryList *list = getList(listname);
289                 if(list == NULL)
290                         return newitem;
291                 return list->addItem(newitem);
292         }
293
294         bool checkModified() const
295         {
296                 return m_dirty;
297         }
298
299         void setModified(const bool x)
300         {
301                 m_dirty = x;
302         }
303
304 private:
305         // -1 if not found
306         const s32 getListIndex(const std::string &name) const;
307
308         std::vector<InventoryList*> m_lists;
309         IItemDefManager *m_itemdef;
310         bool m_dirty = false;
311 };