Fix Lint broken by b662a4577d692329b9ca83525e6039f2ddcd1ac1
[oweals/minetest.git] / src / inventory.h
index 676088b94425d41a80fae40076540240285df2b0..a9fef3b05ace1c216a91c42e1c7b6b7c37ddc304 100644 (file)
@@ -20,28 +20,30 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef INVENTORY_HEADER
 #define INVENTORY_HEADER
 
-#include <iostream>
-#include <sstream>
-#include <string>
-#include <vector>
-#include "irrlichttypes_bloated.h"
 #include "debug.h"
 #include "itemdef.h"
+#include "irrlichttypes.h"
+#include "itemstackmetadata.h"
+#include <istream>
+#include <ostream>
+#include <string>
+#include <vector>
 
 struct ToolCapabilities;
 
 struct ItemStack
 {
-       ItemStack(): name(""), count(0), wear(0), metadata("") {}
-       ItemStack(std::string name_, u16 count_,
-                       u16 wear, std::string metadata_,
-                       IItemDefManager *itemdef);
+       ItemStack(): name(""), count(0), wear(0) {}
+       ItemStack(const std::string &name_, u16 count_,
+                       u16 wear, IItemDefManager *itemdef);
+
        ~ItemStack() {}
 
        // Serialization
        void serialize(std::ostream &os) const;
-       void deSerialize(std::istream &is, IItemDefManager *itemdef);
-       void deSerialize(const std::string &s, IItemDefManager *itemdef);
+       // Deserialization.  Pass itemdef unless you don't want aliases resolved.
+       void deSerialize(std::istream &is, IItemDefManager *itemdef = NULL);
+       void deSerialize(const std::string &s, IItemDefManager *itemdef = NULL);
 
        // Returns the string used for inventory
        std::string getItemString() const;
@@ -60,7 +62,7 @@ struct ItemStack
                name = "";
                count = 0;
                wear = 0;
-               metadata = "";
+               metadata.clear();
        }
 
        void add(u16 n)
@@ -70,7 +72,7 @@ struct ItemStack
 
        void remove(u16 n)
        {
-               assert(count >= n);
+               assert(count >= n); // Pre-condition
                count -= n;
                if(count == 0)
                        clear(); // reset name, wear and metadata too
@@ -79,15 +81,14 @@ struct ItemStack
        // Maximum size of a stack
        u16 getStackMax(IItemDefManager *itemdef) const
        {
-               s16 max = itemdef->get(name).stack_max;
-               return (max >= 0) ? max : 0;
+               return itemdef->get(name).stack_max;
        }
 
        // Number of items that can be added to this stack
        u16 freeSpace(IItemDefManager *itemdef) const
        {
                u16 max = getStackMax(itemdef);
-               if(count > max)
+               if (count >= max)
                        return 0;
                return max - count;
        }
@@ -166,13 +167,13 @@ struct ItemStack
        std::string name;
        u16 count;
        u16 wear;
-       std::string metadata;
+       ItemStackMetadata metadata;
 };
 
 class InventoryList
 {
 public:
-       InventoryList(std::string name, u32 size, IItemDefManager *itemdef);
+       InventoryList(const std::string &name, u32 size, IItemDefManager *itemdef);
        ~InventoryList();
        void clearItems();
        void setSize(u32 newsize);
@@ -183,6 +184,11 @@ public:
 
        InventoryList(const InventoryList &other);
        InventoryList & operator = (const InventoryList &other);
+       bool operator == (const InventoryList &other) const;
+       bool operator != (const InventoryList &other) const
+       {
+               return !(*this == other);
+       }
 
        const std::string &getName() const;
        u32 getSize() const;
@@ -233,17 +239,20 @@ public:
        // Returns empty item if couldn't take any.
        ItemStack takeItem(u32 i, u32 takecount);
 
-       // Similar to takeItem, but keeps the slot intact.
-       ItemStack peekItem(u32 i, u32 peekcount) const;
-
        // Move an item to a different list (or a different stack in the same list)
        // count is the maximum number of items to move (0 for everything)
-       void moveItem(u32 i, InventoryList *dest, u32 dest_i, u32 count = 0);
+       // returns number of moved items
+       u32 moveItem(u32 i, InventoryList *dest, u32 dest_i,
+               u32 count = 0, bool swap_if_needed = true, bool *did_swap = NULL);
+
+       // like moveItem, but without a fixed destination index
+       // also with optional rollback recording
+       void moveItemSomewhere(u32 i, InventoryList *dest, u32 count);
 
 private:
        std::vector<ItemStack> m_items;
-       u32 m_size, m_width;
        std::string m_name;
+       u32 m_size, m_width;
        IItemDefManager *m_itemdef;
 };
 
@@ -258,7 +267,12 @@ public:
        Inventory(IItemDefManager *itemdef);
        Inventory(const Inventory &other);
        Inventory & operator = (const Inventory &other);
-       
+       bool operator == (const Inventory &other) const;
+       bool operator != (const Inventory &other) const
+       {
+               return !(*this == other);
+       }
+
        void serialize(std::ostream &os) const;
        void deSerialize(std::istream &is);
 
@@ -270,19 +284,30 @@ public:
        // A shorthand for adding items. Returns leftover item (possibly empty).
        ItemStack addItem(const std::string &listname, const ItemStack &newitem)
        {
+               m_dirty = true;
                InventoryList *list = getList(listname);
                if(list == NULL)
                        return newitem;
                return list->addItem(newitem);
        }
-       
+
+       bool checkModified() const
+       {
+               return m_dirty;
+       }
+
+       void setModified(const bool x)
+       {
+               m_dirty = x;
+       }
+
 private:
        // -1 if not found
        const s32 getListIndex(const std::string &name) const;
 
        std::vector<InventoryList*> m_lists;
        IItemDefManager *m_itemdef;
+       bool m_dirty;
 };
 
 #endif
-