ToolDefManager serialization
[oweals/minetest.git] / src / inventory.h
index 07d81a3f7eecb77c8575616bd87a763d447357f4..29b97ccad95b6e2be7dc5ddf343b03846e728069 100644 (file)
@@ -1,6 +1,6 @@
 /*
 Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -17,10 +17,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-/*
-(c) 2010 Perttu Ahola <celeron55@gmail.com>
-*/
-
 #ifndef INVENTORY_HEADER
 #define INVENTORY_HEADER
 
@@ -29,50 +25,58 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <string>
 #include "common_irrlicht.h"
 #include "debug.h"
-#include "mapblockobject.h"
-// For g_materials
-#include "main.h"
+#include "mapnode.h" // For content_t
 
 #define QUANTITY_ITEM_MAX_COUNT 99
 
 class ServerActiveObject;
 class ServerEnvironment;
+class ITextureSource;
+class IGameDef;
 
 class InventoryItem
 {
 public:
-       InventoryItem(u16 count);
+       InventoryItem(IGameDef *gamedef, u16 count);
        virtual ~InventoryItem();
        
-       static InventoryItem* deSerialize(std::istream &is);
+       static InventoryItem* deSerialize(std::istream &is, IGameDef *gamedef);
        
        virtual const char* getName() const = 0;
        // Shall write the name and the parameters
-       virtual void serialize(std::ostream &os) = 0;
+       virtual void serialize(std::ostream &os) const = 0;
        // Shall make an exact clone of the item
        virtual InventoryItem* clone() = 0;
+       // Return the name of the image for this item
+       virtual std::string getImageBasename() const { return ""; }
 #ifndef SERVER
-       // Shall return an image to show in the GUI (or NULL)
-       virtual video::ITexture * getImage() { return NULL; }
+       // Shall return an image of the item (or NULL)
+       virtual video::ITexture * getImage(ITextureSource *tsrc) const
+               { return NULL; }
+       // Shall return an image of the item without embellishments (or NULL)
+       virtual video::ITexture * getImageRaw(ITextureSource *tsrc) const
+               { return getImage(tsrc); }
 #endif
        // Shall return a text to show in the GUI
        virtual std::string getText() { return ""; }
+       // Returns the string used for inventory
+       virtual std::string getItemString();
        // Creates an object from the item, to be placed in the world.
        virtual ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
        // Gets amount of items that dropping one SAO will decrement
-       virtual u16 getDropCount(){ return getCount(); }
+       virtual u16 getDropCount() const { return getCount(); }
 
        /*
                Quantity methods
        */
 
        // Shall return true if the item can be add()ed to the other
-       virtual bool addableTo(InventoryItem *other)
+       virtual bool addableTo(const InventoryItem *other) const
        {
                return false;
        }
        
-       u16 getCount()
+       u16 getCount() const
        {
                return m_count;
        }
@@ -81,7 +85,7 @@ public:
                m_count = count;
        }
        // This should return something else for stackable items
-       virtual u16 freeSpace()
+       virtual u16 freeSpace() const
        {
                return 0;
        }
@@ -99,22 +103,30 @@ public:
        /*
                Other properties
        */
+
        // Whether it can be cooked
-       virtual bool isCookable(){return false;}
+       virtual bool isCookable() const {return false;}
        // Time of cooking
        virtual float getCookTime(){return 3.0;}
-       // Result of cooking
-       virtual InventoryItem *createCookResult(){return NULL;}
+       // Result of cooking (can randomize)
+       virtual InventoryItem *createCookResult() const {return NULL;}
+       
+       // Eat, press, activate, whatever.
+       // Called when item is right-clicked when lying on ground.
+       // If returns true, item shall be deleted.
+       virtual bool use(ServerEnvironment *env,
+                       ServerActiveObject *user){return false;}
 
 protected:
+       IGameDef *m_gamedef;
        u16 m_count;
 };
 
 class MaterialItem : public InventoryItem
 {
 public:
-       MaterialItem(u8 content, u16 count):
-               InventoryItem(count)
+       MaterialItem(IGameDef *gamedef, content_t content, u16 count):
+               InventoryItem(gamedef, count)
        {
                m_content = content;
        }
@@ -125,10 +137,10 @@ public:
        {
                return "MaterialItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                //os.imbue(std::locale("C"));
-               os<<getName();
+               os<<"MaterialItem2";
                os<<" ";
                os<<(unsigned int)m_content;
                os<<" ";
@@ -136,14 +148,10 @@ public:
        }
        virtual InventoryItem* clone()
        {
-               return new MaterialItem(m_content, m_count);
+               return new MaterialItem(m_gamedef, m_content, m_count);
        }
 #ifndef SERVER
-       video::ITexture * getImage()
-       {
-               return content_features(m_content).inventory_texture;
-               return NULL;
-       }
+       video::ITexture * getImage(ITextureSource *tsrc) const;
 #endif
        std::string getText()
        {
@@ -152,7 +160,7 @@ public:
                return os.str();
        }
 
-       virtual bool addableTo(InventoryItem *other)
+       virtual bool addableTo(const InventoryItem *other) const
        {
                if(std::string(other->getName()) != "MaterialItem")
                        return false;
@@ -161,7 +169,7 @@ public:
                        return false;
                return true;
        }
-       u16 freeSpace()
+       u16 freeSpace() const
        {
                if(m_count > QUANTITY_ITEM_MAX_COUNT)
                        return 0;
@@ -170,72 +178,17 @@ public:
        /*
                Other properties
        */
-       bool isCookable();
-       InventoryItem *createCookResult();
+       bool isCookable() const;
+       InventoryItem *createCookResult() const;
        /*
                Special methods
        */
-       u8 getMaterial()
+       content_t getMaterial()
        {
                return m_content;
        }
 private:
-       u8 m_content;
-};
-
-//TODO: Remove
-class MapBlockObjectItem : public InventoryItem
-{
-public:
-       MapBlockObjectItem(std::string inventorystring):
-               InventoryItem(1)
-       {
-               m_inventorystring = inventorystring;
-       }
-       
-       /*
-               Implementation interface
-       */
-       virtual const char* getName() const
-       {
-               return "MBOItem";
-       }
-       virtual void serialize(std::ostream &os)
-       {
-               for(;;)
-               {
-                       size_t t = m_inventorystring.find('|');
-                       if(t == std::string::npos)
-                               break;
-                       m_inventorystring[t] = '?';
-               }
-               os<<getName();
-               os<<" ";
-               os<<m_inventorystring;
-               os<<"|";
-       }
-       virtual InventoryItem* clone()
-       {
-               return new MapBlockObjectItem(m_inventorystring);
-       }
-
-#ifndef SERVER
-       video::ITexture * getImage();
-#endif
-       std::string getText();
-
-       /*
-               Special methods
-       */
-       std::string getInventoryString()
-       {
-               return m_inventorystring;
-       }
-
-       MapBlockObject * createObject(v3f pos, f32 player_yaw, f32 player_pitch);
-
-private:
-       std::string m_inventorystring;
+       content_t m_content;
 };
 
 /*
@@ -246,8 +199,8 @@ private:
 class CraftItem : public InventoryItem
 {
 public:
-       CraftItem(std::string subname, u16 count):
-               InventoryItem(count)
+       CraftItem(IGameDef *gamedef, std::string subname, u16 count):
+               InventoryItem(gamedef, count)
        {
                m_subname = subname;
        }
@@ -258,7 +211,7 @@ public:
        {
                return "CraftItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                os<<getName();
                os<<" ";
@@ -268,10 +221,10 @@ public:
        }
        virtual InventoryItem* clone()
        {
-               return new CraftItem(m_subname, m_count);
+               return new CraftItem(m_gamedef, m_subname, m_count);
        }
 #ifndef SERVER
-       video::ITexture * getImage();
+       video::ITexture * getImage(ITextureSource *tsrc) const;
 #endif
        std::string getText()
        {
@@ -281,9 +234,9 @@ public:
        }
 
        ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
-       u16 getDropCount();
+       u16 getDropCount() const;
 
-       virtual bool addableTo(InventoryItem *other)
+       virtual bool addableTo(const InventoryItem *other) const
        {
                if(std::string(other->getName()) != "CraftItem")
                        return false;
@@ -292,17 +245,22 @@ public:
                        return false;
                return true;
        }
-       u16 freeSpace()
+       u16 freeSpace() const
        {
                if(m_count > QUANTITY_ITEM_MAX_COUNT)
                        return 0;
                return QUANTITY_ITEM_MAX_COUNT - m_count;
        }
+
        /*
                Other properties
        */
-       bool isCookable();
-       InventoryItem *createCookResult();
+
+       bool isCookable() const;
+       InventoryItem *createCookResult() const;
+
+       bool use(ServerEnvironment *env, ServerActiveObject *user);
+       
        /*
                Special methods
        */
@@ -317,8 +275,8 @@ private:
 class ToolItem : public InventoryItem
 {
 public:
-       ToolItem(std::string toolname, u16 wear):
-               InventoryItem(1)
+       ToolItem(IGameDef *gamedef, std::string toolname, u16 wear):
+               InventoryItem(gamedef, 1)
        {
                m_toolname = toolname;
                m_wear = wear;
@@ -330,7 +288,7 @@ public:
        {
                return "ToolItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                os<<getName();
                os<<" ";
@@ -340,58 +298,15 @@ public:
        }
        virtual InventoryItem* clone()
        {
-               return new ToolItem(m_toolname, m_wear);
+               return new ToolItem(m_gamedef, m_toolname, m_wear);
        }
-#ifndef SERVER
-       video::ITexture * getImage()
-       {
-               if(g_texturesource == NULL)
-                       return NULL;
-               
-               std::string basename;
-               if(m_toolname == "WPick")
-                       basename = "tool_woodpick.png";
-               else if(m_toolname == "STPick")
-                       basename = "tool_stonepick.png";
-               else if(m_toolname == "SteelPick")
-                       basename = "tool_steelpick.png";
-               else if(m_toolname == "MesePick")
-                       basename = "tool_mesepick.png";
-               else if(m_toolname == "WShovel")
-                       basename = "tool_woodshovel.png";
-               else if(m_toolname == "STShovel")
-                       basename = "tool_stoneshovel.png";
-               else if(m_toolname == "SteelShovel")
-                       basename = "tool_steelshovel.png";
-               else if(m_toolname == "WAxe")
-                       basename = "tool_woodaxe.png";
-               else if(m_toolname == "STAxe")
-                       basename = "tool_stoneaxe.png";
-               else if(m_toolname == "SteelAxe")
-                       basename = "tool_steelaxe.png";
-               else if(m_toolname == "WSword")
-                       basename = "tool_woodsword.png";
-               else if(m_toolname == "STSword")
-                       basename = "tool_stonesword.png";
-               else if(m_toolname == "SteelSword")
-                       basename = "tool_steelsword.png";
-               else
-                       basename = "cloud.png";
-               
-               /*
-                       Calculate a progress value with sane amount of
-                       maximum states
-               */
-               u32 maxprogress = 30;
-               u32 toolprogress = (65535-m_wear)/(65535/maxprogress);
-               
-               float value_f = (float)toolprogress / (float)maxprogress;
-               std::ostringstream os;
-               os<<basename<<"^[progressbar"<<value_f;
 
-               return g_texturesource->getTextureRaw(os.str());
-       }
+       std::string getImageBasename() const;
+#ifndef SERVER
+       video::ITexture * getImage(ITextureSource *tsrc) const;
+       video::ITexture * getImageRaw(ITextureSource *tsrc) const;
 #endif
+
        std::string getText()
        {
                return "";
@@ -448,13 +363,13 @@ public:
        InventoryList(std::string name, u32 size);
        ~InventoryList();
        void clearItems();
-       void serialize(std::ostream &os);
-       void deSerialize(std::istream &is);
+       void serialize(std::ostream &os) const;
+       void deSerialize(std::istream &is, IGameDef *gamedef);
 
        InventoryList(const InventoryList &other);
        InventoryList & operator = (const InventoryList &other);
 
-       std::string getName();
+       const std::string &getName() const;
        u32 getSize();
        // Count used slots
        u32 getUsedSlots();
@@ -464,6 +379,7 @@ public:
        void setDirty(bool dirty=true){ m_dirty = dirty; }*/
        
        // Get pointer to item
+       const InventoryItem * getItem(u32 i) const;
        InventoryItem * getItem(u32 i);
        // Returns old item (or NULL). Parameter can be NULL.
        InventoryItem * changeItem(u32 i, InventoryItem *newitem);
@@ -481,7 +397,13 @@ public:
        InventoryItem * addItem(u32 i, InventoryItem *newitem);
 
        // Checks whether the item could be added to the given slot
-       bool itemFits(u32 i, InventoryItem *newitem);
+       bool itemFits(const u32 i, const InventoryItem *newitem);
+
+       // Checks whether there is room for a given item
+       bool roomForItem(const InventoryItem *item);
+
+       // Checks whether there is room for a given item aftr it has been cooked
+       bool roomForCookedItem(const InventoryItem *item);
 
        // Takes some items from a slot.
        // If there are not enough, takes as many as it can.
@@ -511,11 +433,12 @@ public:
        Inventory(const Inventory &other);
        Inventory & operator = (const Inventory &other);
        
-       void serialize(std::ostream &os);
-       void deSerialize(std::istream &is);
+       void serialize(std::ostream &os) const;
+       void deSerialize(std::istream &is, IGameDef *gamedef);
 
        InventoryList * addList(const std::string &name, u32 size);
        InventoryList * getList(const std::string &name);
+       const InventoryList * getList(const std::string &name) const;
        bool deleteList(const std::string &name);
        // A shorthand for adding items.
        // Returns NULL if the item was fully added, leftover otherwise.
@@ -529,7 +452,7 @@ public:
        
 private:
        // -1 if not found
-       s32 getListIndex(const std::string &name);
+       const s32 getListIndex(const std::string &name) const;
 
        core::array<InventoryList*> m_lists;
 };
@@ -545,7 +468,7 @@ struct InventoryContext
        {}
 };
 
-class InventoryAction;
+struct InventoryAction;
 
 class InventoryManager
 {
@@ -576,7 +499,7 @@ struct InventoryAction
        static InventoryAction * deSerialize(std::istream &is);
        
        virtual u16 getType() const = 0;
-       virtual void serialize(std::ostream &os) = 0;
+       virtual void serialize(std::ostream &os) const = 0;
        virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
 };
 
@@ -624,7 +547,7 @@ struct IMoveAction : public InventoryAction
                return IACTION_MOVE;
        }
 
-       void serialize(std::ostream &os)
+       void serialize(std::ostream &os) const
        {
                os<<"Move ";
                os<<count<<" ";
@@ -676,14 +599,14 @@ struct ItemSpec
        {
        }
 
-       bool checkItem(InventoryItem *item);
+       bool checkItem(const InventoryItem *item) const;
 };
 
 /*
        items: a pointer to an array of 9 pointers to items
        specs: a pointer to an array of 9 ItemSpecs
 */
-bool checkItemCombination(InventoryItem **items, ItemSpec *specs);
+bool checkItemCombination(const InventoryItem * const*items, const ItemSpec *specs);
 
 #endif