]> git.lizzy.rs Git - minetest.git/blobdiff - src/map.h
Clean up rollback
[minetest.git] / src / map.h
index e151838751185862b5ad0793ce87073334864ec1..c650e51b65090c7defd7febfccf12ad491b6c0cd 100644 (file)
--- a/src/map.h
+++ b/src/map.h
@@ -1,18 +1,18 @@
 /*
-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.
 */
@@ -20,33 +20,33 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef MAP_HEADER
 #define MAP_HEADER
 
-#include <jmutex.h>
-#include <jmutexautolock.h>
-#include <jthread.h>
 #include <iostream>
 #include <sstream>
+#include <set>
+#include <map>
+#include <list>
 
-#include "common_irrlicht.h"
+#include "irrlichttypes_bloated.h"
 #include "mapnode.h"
 #include "constants.h"
 #include "voxel.h"
-#include "utility.h" // Needed for UniqueQueue, a member of Map
 #include "modifiedstate.h"
+#include "util/container.h"
+#include "nodetimer.h"
 
-extern "C" {
-       #include "sqlite3.h"
-}
-
+class Database;
 class ClientMap;
 class MapSector;
 class ServerMapSector;
 class MapBlock;
 class NodeMetadata;
 class IGameDef;
+class IRollbackManager;
+class EmergeManager;
+class ServerEnvironment;
+struct BlockMakeData;
+struct MapgenParams;
 
-namespace mapgen{
-       struct BlockMakeData;
-};
 
 /*
        MapEditEvent
@@ -61,6 +61,8 @@ enum MapEditEventType{
        MEET_ADDNODE,
        // Node removed (changed to air)
        MEET_REMOVENODE,
+       // Node swapped (changed without metadata change)
+       MEET_SWAPNODE,
        // Node metadata of block changed (not knowing which node exactly)
        // p stores block coordinate
        MEET_BLOCK_NODE_METADATA_CHANGED,
@@ -73,7 +75,7 @@ struct MapEditEvent
        MapEditEventType type;
        v3s16 p;
        MapNode n;
-       core::map<v3s16, bool> modified_blocks;
+       std::set<v3s16> modified_blocks;
        u16 already_known_by_peer;
 
        MapEditEvent():
@@ -81,21 +83,14 @@ struct MapEditEvent
                already_known_by_peer(0)
        {
        }
-       
+
        MapEditEvent * clone()
        {
                MapEditEvent *event = new MapEditEvent();
                event->type = type;
                event->p = p;
                event->n = n;
-               for(core::map<v3s16, bool>::Iterator
-                               i = modified_blocks.getIterator();
-                               i.atEnd()==false; i++)
-               {
-                       v3s16 p = i.getNode()->getKey();
-                       bool v = i.getNode()->getValue();
-                       event->modified_blocks.insert(p, v);
-               }
+               event->modified_blocks = modified_blocks;
                return event;
        }
 
@@ -106,6 +101,8 @@ struct MapEditEvent
                        return VoxelArea(p);
                case MEET_REMOVENODE:
                        return VoxelArea(p);
+               case MEET_SWAPNODE:
+                       return VoxelArea(p);
                case MEET_BLOCK_NODE_METADATA_CHANGED:
                {
                        v3s16 np1 = p*MAP_BLOCKSIZE;
@@ -115,11 +112,11 @@ struct MapEditEvent
                case MEET_OTHER:
                {
                        VoxelArea a;
-                       for(core::map<v3s16, bool>::Iterator
-                                       i = modified_blocks.getIterator();
-                                       i.atEnd()==false; i++)
+                       for(std::set<v3s16>::iterator
+                                       i = modified_blocks.begin();
+                                       i != modified_blocks.end(); ++i)
                        {
-                               v3s16 p = i.getNode()->getKey();
+                               v3s16 p = *i;
                                v3s16 np1 = p*MAP_BLOCKSIZE;
                                v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
                                a.addPoint(np1);
@@ -155,7 +152,7 @@ class Map /*: public NodeContainer*/
        {
                return MAPTYPE_BASE;
        }
-       
+
        /*
                Drop (client) or delete (server) the map.
        */
@@ -184,77 +181,77 @@ class Map /*: public NodeContainer*/
        */
        virtual MapSector * emergeSector(v2s16 p){ return NULL; }
        virtual MapSector * emergeSector(v2s16 p,
-                       core::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
+                       std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
 
        // Returns InvalidPositionException if not found
        MapBlock * getBlockNoCreate(v3s16 p);
        // Returns NULL if not found
        MapBlock * getBlockNoCreateNoEx(v3s16 p);
-       
+
        /* Server overrides */
        virtual MapBlock * emergeBlock(v3s16 p, bool allow_generate=true)
        { return getBlockNoCreateNoEx(p); }
 
        // Returns InvalidPositionException if not found
        bool isNodeUnderground(v3s16 p);
-       
+
        bool isValidPosition(v3s16 p);
-       
-       // throws InvalidPositionException if not found
-       MapNode getNode(v3s16 p);
 
        // throws InvalidPositionException if not found
        void setNode(v3s16 p, MapNode & n);
-       
+
        // Returns a CONTENT_IGNORE node if not found
-       MapNode getNodeNoEx(v3s16 p);
+       // If is_valid_position is not NULL then this will be set to true if the
+       // position is valid, otherwise false
+       MapNode getNodeNoEx(v3s16 p, bool *is_valid_position = NULL);
 
        void unspreadLight(enum LightBank bank,
-                       core::map<v3s16, u8> & from_nodes,
-                       core::map<v3s16, bool> & light_sources,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
+                       std::map<v3s16, u8> & from_nodes,
+                       std::set<v3s16> & light_sources,
+                       std::map<v3s16, MapBlock*> & modified_blocks);
 
        void unLightNeighbors(enum LightBank bank,
                        v3s16 pos, u8 lightwas,
-                       core::map<v3s16, bool> & light_sources,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
-       
+                       std::set<v3s16> & light_sources,
+                       std::map<v3s16, MapBlock*> & modified_blocks);
+
        void spreadLight(enum LightBank bank,
-                       core::map<v3s16, bool> & from_nodes,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
-       
+                       std::set<v3s16> & from_nodes,
+                       std::map<v3s16, MapBlock*> & modified_blocks);
+
        void lightNeighbors(enum LightBank bank,
                        v3s16 pos,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
+                       std::map<v3s16, MapBlock*> & modified_blocks);
 
        v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
 
        s16 propagateSunlight(v3s16 start,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
-       
+                       std::map<v3s16, MapBlock*> & modified_blocks);
+
        void updateLighting(enum LightBank bank,
-                       core::map<v3s16, MapBlock*>  & a_blocks,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
-                       
-       void updateLighting(core::map<v3s16, MapBlock*>  & a_blocks,
-                       core::map<v3s16, MapBlock*> & modified_blocks);
-                       
+                       std::map<v3s16, MapBlock*>  & a_blocks,
+                       std::map<v3s16, MapBlock*> & modified_blocks);
+
+       void updateLighting(std::map<v3s16, MapBlock*>  & a_blocks,
+                       std::map<v3s16, MapBlock*> & modified_blocks);
+
        /*
                These handle lighting but not faces.
        */
        void addNodeAndUpdate(v3s16 p, MapNode n,
-                       core::map<v3s16, MapBlock*> &modified_blocks);
+                       std::map<v3s16, MapBlock*> &modified_blocks,
+                       bool remove_metadata = true);
        void removeNodeAndUpdate(v3s16 p,
-                       core::map<v3s16, MapBlock*> &modified_blocks);
+                       std::map<v3s16, MapBlock*> &modified_blocks);
 
        /*
                Wrappers for the latter ones.
                These emit events.
                Return true if succeeded, false if not.
        */
-       bool addNodeWithEvent(v3s16 p, MapNode n);
+       bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
        bool removeNodeWithEvent(v3s16 p);
-       
+
        /*
                Takes the blocks at the edges into account
        */
@@ -267,24 +264,30 @@ class Map /*: public NodeContainer*/
        // Call these before and after saving of many blocks
        virtual void beginSave() {return;};
        virtual void endSave() {return;};
-       
+
        virtual void save(ModifiedState save_level){assert(0);};
-       
+
        // Server implements this.
        // Client leaves it as no-op.
-       virtual void saveBlock(MapBlock *block){};
+       virtual bool saveBlock(MapBlock *block) { return false; };
 
        /*
                Updates usage timers and unloads unused blocks and sectors.
                Saves modified blocks before unloading on MAPTYPE_SERVER.
        */
        void timerUpdate(float dtime, float unload_timeout,
-                       core::list<v3s16> *unloaded_blocks=NULL);
-               
+                       std::list<v3s16> *unloaded_blocks=NULL);
+
+       /*
+               Unloads all blocks with a zero refCount().
+               Saves modified blocks before unloading on MAPTYPE_SERVER.
+       */
+       void unloadUnreferencedBlocks(std::list<v3s16> *unloaded_blocks=NULL);
+
        // Deletes sectors and their blocks from memory
        // Takes cache into account
        // If deleted sector is in sector cache, clears cache
-       void deleteSectors(core::list<v2s16> &list);
+       void deleteSectors(std::list<v2s16> &list);
 
 #if 0
        /*
@@ -298,38 +301,66 @@ class Map /*: public NodeContainer*/
 
        // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
        virtual void PrintInfo(std::ostream &out);
-       
-       void transformLiquids(core::map<v3s16, MapBlock*> & modified_blocks);
+
+       void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks);
 
        /*
                Node metadata
                These are basically coordinate wrappers to MapBlock
        */
-       
+
        NodeMetadata* getNodeMetadata(v3s16 p);
-       void setNodeMetadata(v3s16 p, NodeMetadata *meta);
+
+       /**
+        * Sets metadata for a node.
+        * This method sets the metadata for a given node.
+        * On success, it returns @c true and the object pointed to
+        * by @p meta is then managed by the system and should
+        * not be deleted by the caller.
+        *
+        * In case of failure, the method returns @c false and the
+        * caller is still responsible for deleting the object!
+        *
+        * @param p node coordinates
+        * @param meta pointer to @c NodeMetadata object
+        * @return @c true on success, false on failure
+        */
+       bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
        void removeNodeMetadata(v3s16 p);
 
+       /*
+               Node Timers
+               These are basically coordinate wrappers to MapBlock
+       */
+
+       NodeTimer getNodeTimer(v3s16 p);
+       void setNodeTimer(v3s16 p, NodeTimer t);
+       void removeNodeTimer(v3s16 p);
+
        /*
                Misc.
        */
-       core::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
+       std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
 
        /*
                Variables
        */
-       
+
+       void transforming_liquid_add(v3s16 p);
+       s32 transforming_liquid_size();
+
 protected:
+       friend class LuaVoxelManip;
 
        std::ostream &m_dout; // A bit deprecated, could be removed
 
        IGameDef *m_gamedef;
 
-       core::map<MapEventReceiver*, bool> m_event_receivers;
-       
-       core::map<v2s16, MapSector*> m_sectors;
+       std::set<MapEventReceiver*> m_event_receivers;
+
+       std::map<v2s16, MapSector*> m_sectors;
 
-       // Be sure to set this to NULL when the cached sector is deleted 
+       // Be sure to set this to NULL when the cached sector is deleted
        MapSector *m_sector_cache;
        v2s16 m_sector_cache_p;
 
@@ -349,7 +380,7 @@ class ServerMap : public Map
        /*
                savedir: directory to which map data should be saved
        */
-       ServerMap(std::string savedir, IGameDef *gamedef);
+       ServerMap(std::string savedir, IGameDef *gamedef, EmergeManager *emerge);
        ~ServerMap();
 
        s32 mapType() const
@@ -368,16 +399,10 @@ class ServerMap : public Map
        /*
                Blocks are generated by using these and makeBlock().
        */
-       void initBlockMake(mapgen::BlockMakeData *data, v3s16 blockpos);
-       MapBlock* finishBlockMake(mapgen::BlockMakeData *data,
-                       core::map<v3s16, MapBlock*> &changed_blocks);
-       
-       // A non-threaded wrapper to the above
-       MapBlock * generateBlock(
-                       v3s16 p,
-                       core::map<v3s16, MapBlock*> &modified_blocks
-       );
-       
+       bool initBlockMake(BlockMakeData *data, v3s16 blockpos);
+       void finishBlockMake(BlockMakeData *data,
+                       std::map<v3s16, MapBlock*> &changed_blocks);
+
        /*
                Get a block from somewhere.
                - Memory
@@ -389,10 +414,22 @@ class ServerMap : public Map
                Forcefully get a block from somewhere.
                - Memory
                - Load from disk
-               - Generate
+               - Create blank filled with CONTENT_IGNORE
+
+       */
+       MapBlock * emergeBlock(v3s16 p, bool create_blank=true);
+
+       /*
+               Try to get a block.
+               If it does not exist in memory, add it to the emerge queue.
+               - Memory
+               - Emerge Queue (deferred disk or generate)
        */
-       MapBlock * emergeBlock(v3s16 p, bool allow_generate=true);
-       
+       MapBlock *getBlockOrEmerge(v3s16 p3d);
+
+       // Carries out any initialization necessary before block is sent
+       void prepareBlock(MapBlock *block);
+
        // Helper for placing objects on ground level
        s16 findGroundLevel(v2s16 p2d);
 
@@ -411,13 +448,8 @@ class ServerMap : public Map
        /*
                Database functions
        */
-       // Create the database structure
-       void createDatabase();
        // Verify we can read/write to the database
        void verifyDatabase();
-       // Get an integer suitable for a block
-       static sqlite3_int64 getBlockAsInteger(const v3s16 pos);
-       static v3s16 getIntegerAsBlock(sqlite3_int64 i);
 
        // Returns true if the database file does not exist
        bool loadFromFolders();
@@ -427,51 +459,53 @@ class ServerMap : public Map
        void endSave();
 
        void save(ModifiedState save_level);
-       //void loadAll();
-       
-       void listAllLoadableBlocks(core::list<v3s16> &dst);
-       
+       void listAllLoadableBlocks(std::list<v3s16> &dst);
+       void listAllLoadedBlocks(std::list<v3s16> &dst);
        // Saves map seed and possibly other stuff
        void saveMapMeta();
        void loadMapMeta();
-       
+
        /*void saveChunkMeta();
        void loadChunkMeta();*/
-       
+
        // The sector mutex should be locked when calling most of these
-       
+
        // This only saves sector-specific data such as the heightmap
        // (no MapBlocks)
        // DEPRECATED? Sectors have no metadata anymore.
        void saveSectorMeta(ServerMapSector *sector);
        MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
        bool loadSectorMeta(v2s16 p2d);
-       
+
        // Full load of a sector including all blocks.
        // returns true on success, false on failure.
        bool loadSectorFull(v2s16 p2d);
        // If sector is not found in memory, try to load it from disk.
        // Returns true if sector now resides in memory
        //bool deFlushSector(v2s16 p2d);
-       
-       void saveBlock(MapBlock *block);
+
+       bool saveBlock(MapBlock *block, Database *db);
+       bool saveBlock(MapBlock *block);
        // This will generate a sector with getSector if not found.
        void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
        MapBlock* loadBlock(v3s16 p);
        // Database version
        void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
 
+       void updateVManip(v3s16 pos);
+
        // For debug printing
        virtual void PrintInfo(std::ostream &out);
 
        bool isSavingEnabled(){ return m_map_saving_enabled; }
 
-       u64 getSeed(){ return m_seed; }
+       u64 getSeed();
+       s16 getWaterLevel();
 
 private:
-       // Seed used for all kinds of randomness in generation
-       u64 m_seed;
-       
+       // Emerge manager
+       EmergeManager *m_emerge;
+
        std::string m_savedir;
        bool m_map_saving_enabled;
 
@@ -488,60 +522,45 @@ class ServerMap : public Map
                This is reset to false when written on disk.
        */
        bool m_map_metadata_changed;
-       
-       /*
-               SQLite database and statements
-       */
-       sqlite3 *m_database;
-       sqlite3_stmt *m_database_read;
-       sqlite3_stmt *m_database_write;
-       sqlite3_stmt *m_database_list;
+       Database *dbase;
 };
 
-class MapVoxelManipulator : public VoxelManipulator
+
+#define VMANIP_BLOCK_DATA_INEXIST     1
+#define VMANIP_BLOCK_CONTAINS_CIGNORE 2
+
+class ManualMapVoxelManipulator : public VoxelManipulator
 {
 public:
-       MapVoxelManipulator(Map *map);
-       virtual ~MapVoxelManipulator();
-       
+       ManualMapVoxelManipulator(Map *map);
+       virtual ~ManualMapVoxelManipulator();
+
        virtual void clear()
        {
                VoxelManipulator::clear();
                m_loaded_blocks.clear();
        }
 
-       virtual void emerge(VoxelArea a, s32 caller_id=-1);
-
-       void blitBack(core::map<v3s16, MapBlock*> & modified_blocks);
-
-protected:
-       Map *m_map;
-       /*
-               key = blockpos
-               value = block existed when loaded
-       */
-       core::map<v3s16, bool> m_loaded_blocks;
-};
-
-class ManualMapVoxelManipulator : public MapVoxelManipulator
-{
-public:
-       ManualMapVoxelManipulator(Map *map);
-       virtual ~ManualMapVoxelManipulator();
-
        void setMap(Map *map)
        {m_map = map;}
-       
-       virtual void emerge(VoxelArea a, s32 caller_id=-1);
 
-       void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max);
-       
+       void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
+                       bool load_if_inexistent = true);
+
        // This is much faster with big chunks of generated data
-       void blitBackAll(core::map<v3s16, MapBlock*> * modified_blocks);
+       void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
+                       bool overwrite_generated = true);
+
+       bool m_is_dirty;
 
 protected:
        bool m_create_area;
+       Map *m_map;
+       /*
+               key = blockpos
+               value = flags describing the block
+       */
+       std::map<v3s16, u8> m_loaded_blocks;
 };
 
 #endif
-