src/nodemetadata.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 #ifndef NODEMETADATA_HEADER
  21 #define NODEMETADATA_HEADER
  22
  23 #include "irrlichttypes_bloated.h"
  24 #include <string>
  25 #include <iostream>
  26 #include <map>
  27
  28 /*
  29         NodeMetadata stores arbitary amounts of data for special blocks.
  30         Used for furnaces, chests and signs.
  31
  32         There are two interaction methods: inventory menu and text input.
  33         Only one can be used for a single metadata, thus only inventory OR
  34         text input should exist in a metadata.
  35 */
  36
  37 class Inventory;
  38 class IGameDef;
  39
  40 class NodeMetadata
  41 {
  42 public:
  43         NodeMetadata(IGameDef *gamedef);
  44         ~NodeMetadata();
  45
  46         void serialize(std::ostream &os) const;
  47         void deSerialize(std::istream &is);
  48
  49         void clear();
  50
  51         // Generic key/value store
  52         std::string getString(const std::string &name) const
  53         {
  54                 std::map<std::string, std::string>::const_iterator i;
  55                 i = m_stringvars.find(name);
  56                 if(i == m_stringvars.end())
  57                         return "";
  58                 return resolveString(i->second);
  59         }
  60         void setString(const std::string &name, const std::string &var)
  61         {
  62                 if(var.empty())
  63                         m_stringvars.erase(name);
  64                 else
  65                         m_stringvars[name] = var;
  66         }
  67         // support variable names in values
  68         std::string resolveString(const std::string &str) const
  69         {
  70                 if(str.substr(0,2) == "${" && str[str.length()-1] == '}')
  71                         return resolveString(getString(str.substr(2,str.length()-3)));
  72                 return str;
  73         }
  74         std::map<std::string, std::string> getStrings() const
  75         {
  76                 return m_stringvars;
  77         }
  78
  79         // The inventory
  80         Inventory* getInventory()
  81         {
  82                 return m_inventory;
  83         }
  84
  85 private:
  86         std::map<std::string, std::string> m_stringvars;
  87         Inventory *m_inventory;
  88 };
  89
  90
  91 /*
  92         List of metadata of all the nodes of a block
  93 */
  94
  95 class NodeMetadataList
  96 {
  97 public:
  98         ~NodeMetadataList();
  99
 100         void serialize(std::ostream &os) const;
 101         void deSerialize(std::istream &is, IGameDef *gamedef);
 102
 103         // Get pointer to data
 104         NodeMetadata* get(v3s16 p);
 105         // Deletes data
 106         void remove(v3s16 p);
 107         // Deletes old data and sets a new one
 108         void set(v3s16 p, NodeMetadata *d);
 109         // Deletes all
 110         void clear();
 111
 112 private:
 113         std::map<v3s16, NodeMetadata*> m_data;
 114 };
 115
 116 #endif
 117