/*
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 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
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "nodemetadata.h"
-#include "utility.h"
-#include "mapnode.h"
#include "exceptions.h"
+#include "gamedef.h"
#include "inventory.h"
+#include "log.h"
+#include "util/serialize.h"
+#include "util/basic_macros.h"
+#include "constants.h" // MAP_BLOCKSIZE
#include <sstream>
/*
NodeMetadata
*/
-core::map<u16, NodeMetadata::Factory> NodeMetadata::m_types;
+NodeMetadata::NodeMetadata(IItemDefManager *item_def_mgr):
+ m_inventory(new Inventory(item_def_mgr))
+{}
-NodeMetadata::NodeMetadata()
+NodeMetadata::~NodeMetadata()
{
+ delete m_inventory;
}
-NodeMetadata::~NodeMetadata()
+void NodeMetadata::serialize(std::ostream &os, u8 version, bool disk) const
{
+ int num_vars = disk ? m_stringvars.size() : countNonPrivate();
+ writeU32(os, num_vars);
+ for (const auto &sv : m_stringvars) {
+ bool priv = isPrivate(sv.first);
+ if (!disk && priv)
+ continue;
+
+ os << serializeString(sv.first);
+ os << serializeLongString(sv.second);
+ if (version >= 2)
+ writeU8(os, (priv) ? 1 : 0);
+ }
+
+ m_inventory->serialize(os);
}
-NodeMetadata* NodeMetadata::deSerialize(std::istream &is)
+void NodeMetadata::deSerialize(std::istream &is, u8 version)
{
- // Read id
- u8 buf[2];
- is.read((char*)buf, 2);
- s16 id = readS16(buf);
-
- // Read data
- std::string data = deSerializeString(is);
-
- // Find factory function
- core::map<u16, Factory>::Node *n;
- n = m_types.find(id);
- if(n == NULL)
- {
- // If factory is not found, just return.
- dstream<<"WARNING: NodeMetadata: No factory for typeId="
- <<id<<std::endl;
- return NULL;
- }
-
- // Try to load the metadata. If it fails, just return.
- try
- {
- std::istringstream iss(data, std::ios_base::binary);
-
- Factory f = n->getValue();
- NodeMetadata *meta = (*f)(iss);
- return meta;
- }
- catch(SerializationError &e)
- {
- dstream<<"WARNING: NodeMetadata: ignoring SerializationError"<<std::endl;
- return NULL;
+ clear();
+ int num_vars = readU32(is);
+ for(int i=0; i<num_vars; i++){
+ std::string name = deSerializeString(is);
+ std::string var = deSerializeLongString(is);
+ m_stringvars[name] = var;
+ if (version >= 2) {
+ if (readU8(is) == 1)
+ markPrivate(name, true);
+ }
}
+
+ m_inventory->deSerialize(is);
}
-void NodeMetadata::serialize(std::ostream &os)
+void NodeMetadata::clear()
{
- u8 buf[2];
- writeU16(buf, typeId());
- os.write((char*)buf, 2);
-
- std::ostringstream oss(std::ios_base::binary);
- serializeBody(oss);
- os<<serializeString(oss.str());
+ Metadata::clear();
+ m_privatevars.clear();
+ m_inventory->clear();
}
-void NodeMetadata::registerType(u16 id, Factory f)
+bool NodeMetadata::empty() const
{
- core::map<u16, Factory>::Node *n;
- n = m_types.find(id);
- if(n)
- return;
- m_types.insert(id, f);
+ return Metadata::empty() && m_inventory->getLists().empty();
}
-/*
- SignNodeMetadata
-*/
-
-// Prototype
-SignNodeMetadata proto_SignNodeMetadata("");
-SignNodeMetadata::SignNodeMetadata(std::string text):
- m_text(text)
+void NodeMetadata::markPrivate(const std::string &name, bool set)
{
- NodeMetadata::registerType(typeId(), create);
-}
-u16 SignNodeMetadata::typeId() const
-{
- return CONTENT_SIGN_WALL;
-}
-NodeMetadata* SignNodeMetadata::create(std::istream &is)
-{
- std::string text = deSerializeString(is);
- return new SignNodeMetadata(text);
-}
-NodeMetadata* SignNodeMetadata::clone()
-{
- return new SignNodeMetadata(m_text);
-}
-void SignNodeMetadata::serializeBody(std::ostream &os)
-{
- os<<serializeString(m_text);
+ if (set)
+ m_privatevars.insert(name);
+ else
+ m_privatevars.erase(name);
}
-std::string SignNodeMetadata::infoText()
+
+int NodeMetadata::countNonPrivate() const
{
- return std::string("\"")+m_text+"\"";
+ // m_privatevars can contain names not actually present
+ // DON'T: return m_stringvars.size() - m_privatevars.size();
+ int n = 0;
+ for (const auto &sv : m_stringvars) {
+ if (!isPrivate(sv.first))
+ n++;
+ }
+ return n;
}
/*
- ChestNodeMetadata
+ NodeMetadataList
*/
-// Prototype
-ChestNodeMetadata proto_ChestNodeMetadata;
-
-ChestNodeMetadata::ChestNodeMetadata()
-{
- NodeMetadata::registerType(typeId(), create);
-
- m_inventory = new Inventory();
- m_inventory->addList("0", 8*4);
-}
-ChestNodeMetadata::~ChestNodeMetadata()
-{
- delete m_inventory;
-}
-u16 ChestNodeMetadata::typeId() const
-{
- return CONTENT_CHEST;
-}
-NodeMetadata* ChestNodeMetadata::create(std::istream &is)
-{
- ChestNodeMetadata *d = new ChestNodeMetadata();
- d->m_inventory->deSerialize(is);
- return d;
-}
-NodeMetadata* ChestNodeMetadata::clone()
-{
- ChestNodeMetadata *d = new ChestNodeMetadata();
- *d->m_inventory = *m_inventory;
- return d;
-}
-void ChestNodeMetadata::serializeBody(std::ostream &os)
-{
- m_inventory->serialize(os);
-}
-std::string ChestNodeMetadata::infoText()
-{
- return "Chest";
-}
-bool ChestNodeMetadata::nodeRemovalDisabled()
+void NodeMetadataList::serialize(std::ostream &os, u8 blockver, bool disk,
+ bool absolute_pos) const
{
/*
- Disable removal if chest contains something
+ Version 0 is a placeholder for "nothing to see here; go away."
*/
- InventoryList *list = m_inventory->getList("0");
- if(list == NULL)
- return false;
- if(list->getUsedSlots() == 0)
- return false;
- return true;
-}
-/*
- FurnaceNodeMetadata
-*/
+ u16 count = countNonEmpty();
+ if (count == 0) {
+ writeU8(os, 0); // version
+ return;
+ }
-// Prototype
-FurnaceNodeMetadata proto_FurnaceNodeMetadata;
+ u8 version = (blockver > 27) ? 2 : 1;
+ writeU8(os, version);
+ writeU16(os, count);
-FurnaceNodeMetadata::FurnaceNodeMetadata()
-{
- NodeMetadata::registerType(typeId(), create);
-
- m_inventory = new Inventory();
- m_inventory->addList("fuel", 1);
- m_inventory->addList("src", 1);
- m_inventory->addList("dst", 4);
-
- m_step_accumulator = 0;
- m_fuel_totaltime = 0;
- m_fuel_time = 0;
- m_src_totaltime = 0;
- m_src_time = 0;
-}
-FurnaceNodeMetadata::~FurnaceNodeMetadata()
-{
- delete m_inventory;
-}
-u16 FurnaceNodeMetadata::typeId() const
-{
- return CONTENT_FURNACE;
-}
-NodeMetadata* FurnaceNodeMetadata::clone()
-{
- FurnaceNodeMetadata *d = new FurnaceNodeMetadata();
- *d->m_inventory = *m_inventory;
- return d;
+ for (NodeMetadataMap::const_iterator
+ i = m_data.begin();
+ i != m_data.end(); ++i) {
+ v3s16 p = i->first;
+ NodeMetadata *data = i->second;
+ if (data->empty())
+ continue;
+
+ if (absolute_pos) {
+ writeS16(os, p.X);
+ writeS16(os, p.Y);
+ writeS16(os, p.Z);
+ } else {
+ // Serialize positions within a mapblock
+ u16 p16 = (p.Z * MAP_BLOCKSIZE + p.Y) * MAP_BLOCKSIZE + p.X;
+ writeU16(os, p16);
+ }
+ data->serialize(os, version, disk);
+ }
}
-NodeMetadata* FurnaceNodeMetadata::create(std::istream &is)
-{
- FurnaceNodeMetadata *d = new FurnaceNodeMetadata();
- d->m_inventory->deSerialize(is);
+void NodeMetadataList::deSerialize(std::istream &is,
+ IItemDefManager *item_def_mgr, bool absolute_pos)
+{
+ clear();
- int temp;
- is>>temp;
- d->m_fuel_totaltime = (float)temp/10;
- is>>temp;
- d->m_fuel_time = (float)temp/10;
+ u8 version = readU8(is);
- return d;
-}
-void FurnaceNodeMetadata::serializeBody(std::ostream &os)
-{
- m_inventory->serialize(os);
- os<<itos(m_fuel_totaltime*10)<<" ";
- os<<itos(m_fuel_time*10)<<" ";
-}
-std::string FurnaceNodeMetadata::infoText()
-{
- //return "Furnace";
- if(m_fuel_time >= m_fuel_totaltime)
- {
- InventoryList *src_list = m_inventory->getList("src");
- assert(src_list);
- InventoryItem *src_item = src_list->getItem(0);
-
- if(src_item)
- return "Furnace is out of fuel";
- else
- return "Furnace is inactive";
+ if (version == 0) {
+ // Nothing
+ return;
}
- else
- {
- std::string s = "Furnace is active (";
- s += itos(m_fuel_time/m_fuel_totaltime*100);
- s += "%)";
- return s;
+
+ if (version > 2) {
+ std::string err_str = std::string(FUNCTION_NAME)
+ + ": version " + itos(version) + " not supported";
+ infostream << err_str << std::endl;
+ throw SerializationError(err_str);
}
-}
-void FurnaceNodeMetadata::inventoryModified()
-{
- dstream<<"Furnace inventory modification callback"<<std::endl;
-}
-bool FurnaceNodeMetadata::step(float dtime)
-{
- if(dtime > 60.0)
- dstream<<"Furnace stepping a long time ("<<dtime<<")"<<std::endl;
- // Update at a fixed frequency
- const float interval = 2.0;
- m_step_accumulator += dtime;
- bool changed = false;
- while(m_step_accumulator > interval)
- {
- m_step_accumulator -= interval;
- dtime = interval;
-
- //dstream<<"Furnace step dtime="<<dtime<<std::endl;
-
- InventoryList *dst_list = m_inventory->getList("dst");
- assert(dst_list);
-
- InventoryList *src_list = m_inventory->getList("src");
- assert(src_list);
- InventoryItem *src_item = src_list->getItem(0);
-
- // Start only if there are free slots in dst, so that it can
- // accomodate any result item
- if(dst_list->getFreeSlots() > 0 && src_item && src_item->isCookable())
- {
- m_src_totaltime = 3;
- }
- else
- {
- m_src_time = 0;
- m_src_totaltime = 0;
+
+ u16 count = readU16(is);
+
+ for (u16 i = 0; i < count; i++) {
+ v3s16 p;
+ if (absolute_pos) {
+ p.X = readS16(is);
+ p.Y = readS16(is);
+ p.Z = readS16(is);
+ } else {
+ u16 p16 = readU16(is);
+ p.X = p16 & (MAP_BLOCKSIZE - 1);
+ p16 /= MAP_BLOCKSIZE;
+ p.Y = p16 & (MAP_BLOCKSIZE - 1);
+ p16 /= MAP_BLOCKSIZE;
+ p.Z = p16;
}
-
- /*
- If fuel is burning, increment the burn counters.
- If item finishes cooking, move it to result.
- */
- if(m_fuel_time < m_fuel_totaltime)
- {
- //dstream<<"Furnace is active"<<std::endl;
- m_fuel_time += dtime;
- m_src_time += dtime;
- if(m_src_time >= m_src_totaltime && m_src_totaltime > 0.001
- && src_item)
- {
- InventoryItem *cookresult = src_item->createCookResult();
- dst_list->addItem(cookresult);
- src_list->decrementMaterials(1);
- m_src_time = 0;
- m_src_totaltime = 0;
- }
- changed = true;
+ if (m_data.find(p) != m_data.end()) {
+ warningstream << "NodeMetadataList::deSerialize(): "
+ << "already set data at position " << PP(p)
+ << ": Ignoring." << std::endl;
continue;
}
-
- /*
- If there is no source item or source item is not cookable, stop loop.
- */
- if(src_item == NULL || m_src_totaltime < 0.001)
- {
- m_step_accumulator = 0;
- break;
- }
-
- //dstream<<"Furnace is out of fuel"<<std::endl;
-
- InventoryList *fuel_list = m_inventory->getList("fuel");
- assert(fuel_list);
- InventoryItem *fuel_item = fuel_list->getItem(0);
-
- if(ItemSpec(ITEM_MATERIAL, CONTENT_TREE).checkItem(fuel_item))
- {
- m_fuel_totaltime = 30;
- m_fuel_time = 0;
- fuel_list->decrementMaterials(1);
- changed = true;
- }
- else if(ItemSpec(ITEM_MATERIAL, CONTENT_WOOD).checkItem(fuel_item))
- {
- m_fuel_totaltime = 30/4;
- m_fuel_time = 0;
- fuel_list->decrementMaterials(1);
- changed = true;
- }
- else if(ItemSpec(ITEM_CRAFT, "Stick").checkItem(fuel_item))
- {
- m_fuel_totaltime = 30/4/4;
- m_fuel_time = 0;
- fuel_list->decrementMaterials(1);
- changed = true;
- }
- else if(ItemSpec(ITEM_CRAFT, "lump_of_coal").checkItem(fuel_item))
- {
- m_fuel_totaltime = 40;
- m_fuel_time = 0;
- fuel_list->decrementMaterials(1);
- changed = true;
- }
- else
- {
- //dstream<<"No fuel found"<<std::endl;
- // No fuel, stop loop.
- m_step_accumulator = 0;
- break;
- }
+
+ NodeMetadata *data = new NodeMetadata(item_def_mgr);
+ data->deSerialize(is, version);
+ m_data[p] = data;
}
- return changed;
}
-/*
- NodeMetadatalist
-*/
-
-void NodeMetadataList::serialize(std::ostream &os)
+NodeMetadataList::~NodeMetadataList()
{
- u8 buf[6];
-
- u16 version = 1;
- writeU16(buf, version);
- os.write((char*)buf, 2);
-
- u16 count = m_data.size();
- writeU16(buf, count);
- os.write((char*)buf, 2);
-
- for(core::map<v3s16, NodeMetadata*>::Iterator
- i = m_data.getIterator();
- i.atEnd()==false; i++)
- {
- v3s16 p = i.getNode()->getKey();
- NodeMetadata *data = i.getNode()->getValue();
-
- u16 p16 = p.Z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + p.Y*MAP_BLOCKSIZE + p.X;
- writeU16(buf, p16);
- os.write((char*)buf, 2);
-
- data->serialize(os);
- }
-
+ clear();
}
-void NodeMetadataList::deSerialize(std::istream &is)
-{
- m_data.clear();
- u8 buf[6];
-
- is.read((char*)buf, 2);
- u16 version = readU16(buf);
+std::vector<v3s16> NodeMetadataList::getAllKeys()
+{
+ std::vector<v3s16> keys;
- if(version > 1)
- {
- dstream<<__FUNCTION_NAME<<": version "<<version<<" not supported"
- <<std::endl;
- throw SerializationError("NodeMetadataList::deSerialize");
- }
-
- is.read((char*)buf, 2);
- u16 count = readU16(buf);
-
- for(u16 i=0; i<count; i++)
- {
- is.read((char*)buf, 2);
- u16 p16 = readU16(buf);
-
- v3s16 p(0,0,0);
- p.Z += p16 / MAP_BLOCKSIZE / MAP_BLOCKSIZE;
- p16 -= p.Z * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
- p.Y += p16 / MAP_BLOCKSIZE;
- p16 -= p.Y * MAP_BLOCKSIZE;
- p.X += p16;
-
- NodeMetadata *data = NodeMetadata::deSerialize(is);
-
- if(data == NULL)
- continue;
-
- if(m_data.find(p))
- {
- dstream<<"WARNING: NodeMetadataList::deSerialize(): "
- <<"already set data at position"
- <<"("<<p.X<<","<<p.Y<<","<<p.Z<<"): Ignoring."
- <<std::endl;
- delete data;
- continue;
- }
+ NodeMetadataMap::const_iterator it;
+ for (it = m_data.begin(); it != m_data.end(); ++it)
+ keys.push_back(it->first);
- m_data.insert(p, data);
- }
-}
-
-NodeMetadataList::~NodeMetadataList()
-{
- for(core::map<v3s16, NodeMetadata*>::Iterator
- i = m_data.getIterator();
- i.atEnd()==false; i++)
- {
- delete i.getNode()->getValue();
- }
+ return keys;
}
-NodeMetadata* NodeMetadataList::get(v3s16 p)
+NodeMetadata *NodeMetadataList::get(v3s16 p)
{
- core::map<v3s16, NodeMetadata*>::Node *n;
- n = m_data.find(p);
- if(n == NULL)
+ NodeMetadataMap::const_iterator n = m_data.find(p);
+ if (n == m_data.end())
return NULL;
- return n->getValue();
+ return n->second;
}
void NodeMetadataList::remove(v3s16 p)
{
NodeMetadata *olddata = get(p);
- if(olddata)
- {
- delete olddata;
- m_data.remove(p);
+ if (olddata) {
+ if (m_is_metadata_owner)
+ delete olddata;
+ m_data.erase(p);
}
}
void NodeMetadataList::set(v3s16 p, NodeMetadata *d)
{
remove(p);
- m_data.insert(p, d);
+ m_data.insert(std::make_pair(p, d));
}
-bool NodeMetadataList::step(float dtime)
+void NodeMetadataList::clear()
{
- bool something_changed = false;
- for(core::map<v3s16, NodeMetadata*>::Iterator
- i = m_data.getIterator();
- i.atEnd()==false; i++)
- {
- v3s16 p = i.getNode()->getKey();
- NodeMetadata *meta = i.getNode()->getValue();
- bool changed = meta->step(dtime);
- if(changed)
- something_changed = true;
- /*if(res.inventory_changed)
- {
- std::string inv_id;
- inv_id += "nodemeta:";
- inv_id += itos(p.X);
- inv_id += ",";
- inv_id += itos(p.Y);
- inv_id += ",";
- inv_id += itos(p.Z);
- InventoryContext c;
- c.current_player = NULL;
- inv_mgr->inventoryModified(&c, inv_id);
- }*/
+ if (m_is_metadata_owner) {
+ NodeMetadataMap::const_iterator it;
+ for (it = m_data.begin(); it != m_data.end(); ++it)
+ delete it->second;
}
- return something_changed;
+ m_data.clear();
}
+int NodeMetadataList::countNonEmpty() const
+{
+ int n = 0;
+ NodeMetadataMap::const_iterator it;
+ for (it = m_data.begin(); it != m_data.end(); ++it) {
+ if (!it->second->empty())
+ n++;
+ }
+ return n;
+}