nodemetadata.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
#pragma once
 
#include <unordered_set>
#include <map>
#include <memory>
#include "metadata.h"
 
/*
        NodeMetadata stores arbitary amounts of data for special blocks.
        Used for furnaces, chests and signs.
 
        There are two interaction methods: inventory menu and text input.
        Only one can be used for a single metadata, thus only inventory OR
        text input should exist in a metadata.
*/
 
class Inventory;
class IItemDefManager;
 
class NodeMetadata : public SimpleMetadata
{
public:
        NodeMetadata(IItemDefManager *item_def_mgr);
        ~NodeMetadata();
 
        void serialize(std::ostream &os, u8 version, bool disk=true) const;
        void deSerialize(std::istream &is, u8 version);
 
        void clear();
        bool empty() const;
 
        // The inventory
        Inventory *getInventory()
        {
                return m_inventory.get();
        }
 
        inline bool isPrivate(const std::string &name) const
        {
                return m_privatevars.count(name) != 0;
        }

        bool markPrivate(const std::string &name, bool set);
 
private:
        int countNonPrivate() const;
 
        std::unique_ptr<Inventory> m_inventory;
        std::unordered_set<std::string> m_privatevars;
};
 
 
/*
        List of metadata of all the nodes of a block
*/
 
typedef std::map<v3s16, NodeMetadata *> NodeMetadataMap;
 
class NodeMetadataList
{
public:
        NodeMetadataList(bool is_metadata_owner = true) :
                m_is_metadata_owner(is_metadata_owner)
        {}
 
        ~NodeMetadataList();
 
        void serialize(std::ostream &os, u8 blockver, bool disk = true,
                bool absolute_pos = false, bool include_empty = false) const;
        void deSerialize(std::istream &is, IItemDefManager *item_def_mgr,
                bool absolute_pos = false);
 
        // Return all keys
        std::vector<v3s16> getAllKeys() const;
        // Get pointer to data
        NodeMetadata *get(v3s16 p) const;

        std::unique_ptr<NodeMetadata> remove(v3s16 p);
        std::unique_ptr<NodeMetadata> set(v3s16 p, NodeMetadata *d);
        void clear();
 
        size_t size() const { return m_data.size(); }
 
        NodeMetadataMap::const_iterator begin() const
        {
                return m_data.begin();
        }
 
        NodeMetadataMap::const_iterator end() const
        {
                return m_data.end();
        }
 
private:
        int countNonEmpty() const;
 
        // FIXME: having a single class own or not own pointers depending on a variable
        // is not clean and prevents refactoring this to unique_ptr...
        const bool m_is_metadata_owner;
        NodeMetadataMap m_data;
};