Omnicleanup: header cleanup, add ModApiUtil shared between game and mainmenu
[oweals/minetest.git] / src / mapsector.h
index fda290cd79f040978fb88a609664afbdc17fe359..dac4ee8d634992d55d933b63e7d587e4b2863bcd 100644 (file)
@@ -1,34 +1,34 @@
 /*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 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.
 */
 
-/*
-(c) 2010 Perttu Ahola <celeron55@gmail.com>
-*/
-
 #ifndef MAPSECTOR_HEADER
 #define MAPSECTOR_HEADER
 
-#include <jmutex.h>
-#include "common_irrlicht.h"
-#include "mapblock.h"
-//#include "heightmap.h"
-#include "exceptions.h"
+#include "irrlichttypes.h"
+#include "irr_v2d.h"
+#include <ostream>
+#include <map>
+#include <list>
+
+class MapBlock;
+class Map;
+class IGameDef;
 
 /*
        This is an Y-wise stack of MapBlocks.
@@ -37,18 +37,13 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define MAPSECTOR_SERVER 0
 #define MAPSECTOR_CLIENT 1
 
-class MapSector: public NodeContainer
+class MapSector
 {
 public:
        
-       MapSector(NodeContainer *parent, v2s16 pos);
+       MapSector(Map *parent, v2s16 pos, IGameDef *gamedef);
        virtual ~MapSector();
 
-       virtual u16 nodeContainerId() const
-       {
-               return NODECONTAINER_ID_MAPSECTOR;
-       }
-
        virtual u32 getId() const = 0;
 
        void deleteBlocks();
@@ -59,167 +54,34 @@ public:
        }
 
        MapBlock * getBlockNoCreateNoEx(s16 y);
-       MapBlock * getBlockNoCreate(s16 y);
        MapBlock * createBlankBlockNoInsert(s16 y);
        MapBlock * createBlankBlock(s16 y);
-       //MapBlock * getBlock(s16 y, bool generate=true);
 
        void insertBlock(MapBlock *block);
        
-       // This is used to remove a dummy from the sector while generating it.
-       // Block is only removed from internal container, not deleted.
-       void removeBlock(MapBlock *block);
-       
-       /*
-               This might not be a thread-safe depending on the day.
-               See the implementation.
-       */
-       void getBlocks(core::list<MapBlock*> &dest);
+       void deleteBlock(MapBlock *block);
        
-       /*
-               If all nodes in area can be accessed, returns true and
-               adds all blocks in area to blocks.
-
-               If all nodes in area cannot be accessed, returns false.
-
-               The implementation of this is quite slow
-
-               if blocks==NULL; it is not accessed at all.
-       */
-       bool isValidArea(v3s16 p_min_nodes, v3s16 p_max_nodes,
-                       core::map<s16, MapBlock*> *blocks)
-       {
-               core::map<s16, MapBlock*> bs;
-               
-               v3s16 p_min = getNodeBlockPos(p_min_nodes);
-               v3s16 p_max = getNodeBlockPos(p_max_nodes);
-               if(p_min.X != 0 || p_min.Z != 0
-                               || p_max.X != 0 || p_max.Z != 0)
-                       return false;
-               v3s16 y;
-               for(s16 y=p_min.Y; y<=p_max.Y; y++)
-               {
-                       try{
-                               MapBlock *block = getBlockNoCreate(y);
-                               if(block->isDummy())
-                                       return false;
-                               if(blocks!=NULL)
-                                       bs[y] = block;
-                       }
-                       catch(InvalidPositionException &e)
-                       {
-                               return false;
-                       }
-               }
-
-               if(blocks!=NULL)
-               {
-                       for(core::map<s16, MapBlock*>::Iterator i=bs.getIterator();
-                                       i.atEnd()==false; i++)
-                       {
-                               MapBlock *block = i.getNode()->getValue();
-                               s16 y = i.getNode()->getKey();
-                               blocks->insert(y, block);
-                       }
-               }
-               return true;
-       }
-
-       void getBlocksInArea(v3s16 p_min_nodes, v3s16 p_max_nodes,
-                       core::map<v3s16, MapBlock*> &blocks)
-       {
-               v3s16 p_min = getNodeBlockPos(p_min_nodes);
-               v3s16 p_max = getNodeBlockPos(p_max_nodes);
-               v3s16 y;
-               for(s16 y=p_min.Y; y<=p_max.Y; y++)
-               {
-                       try{
-                               MapBlock *block = getBlockNoCreate(y);
-                               blocks.insert(block->getPos(), block);
-                       }
-                       catch(InvalidPositionException &e)
-                       {
-                       }
-               }
-       }
+       void getBlocks(std::list<MapBlock*> &dest);
        
-       // virtual from NodeContainer
-       bool isValidPosition(v3s16 p)
-       {
-               v3s16 blockpos = getNodeBlockPos(p);
-
-               if(blockpos.X != 0 || blockpos.Z != 0)
-                       return false;
-
-               MapBlock *blockref;
-               try{
-                       blockref = getBlockNoCreate(blockpos.Y);
-               }
-               catch(InvalidPositionException &e)
-               {
-                       return false;
-               }
-
-               return true;
-       }
-
-       // virtual from NodeContainer
-       MapNode getNode(v3s16 p)
-       {
-               v3s16 blockpos = getNodeBlockPos(p);
-               if(blockpos.X != 0 || blockpos.Z != 0)
-                       throw InvalidPositionException
-                               ("MapSector only allows Y");
-
-               MapBlock * blockref = getBlockNoCreate(blockpos.Y);
-               v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
-
-               return blockref->getNode(relpos);
-       }
-       // virtual from NodeContainer
-       void setNode(v3s16 p, MapNode & n)
-       {
-               v3s16 blockpos = getNodeBlockPos(p);
-               if(blockpos.X != 0 || blockpos.Z != 0)
-                       throw InvalidPositionException
-                               ("MapSector only allows Y");
-
-               MapBlock * blockref = getBlockNoCreate(blockpos.Y);
-               v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
-               blockref->setNode(relpos, n);
-       }
-
-       // DEPRECATED?
-       virtual f32 getGroundHeight(v2s16 p, bool generate=false)
-       {
-               return GROUNDHEIGHT_NOTFOUND_SETVALUE;
-       }
-       virtual void setGroundHeight(v2s16 p, f32 y, bool generate=false)
-       {
-       }
-       
-       // When true, sector metadata is changed from the one on disk
-       // (sector metadata = all but blocks)
-       // Basically, this should be changed to true in every setter method
+       // Always false at the moment, because sector contains no metadata.
        bool differs_from_disk;
 
 protected:
        
        // The pile of MapBlocks
-       core::map<s16, MapBlock*> m_blocks;
-       //JMutex m_blocks_mutex; // For public access functions
+       std::map<s16, MapBlock*> m_blocks;
 
-       NodeContainer *m_parent;
+       Map *m_parent;
        // Position on parent (in MapBlock widths)
        v2s16 m_pos;
 
+       IGameDef *m_gamedef;
+       
+       // Last-used block is cached here for quicker access.
        // Be sure to set this to NULL when the cached block is deleted 
        MapBlock *m_block_cache;
        s16 m_block_cache_y;
        
-       // This is used for protecting m_blocks
-       JMutex m_mutex;
-       
        /*
                Private methods
        */
@@ -230,29 +92,27 @@ protected:
 class ServerMapSector : public MapSector
 {
 public:
-       ServerMapSector(NodeContainer *parent, v2s16 pos);
+       ServerMapSector(Map *parent, v2s16 pos, IGameDef *gamedef);
        ~ServerMapSector();
        
        u32 getId() const
        {
                return MAPSECTOR_SERVER;
        }
-       
-       // DEPRECATED?
-       f32 getGroundHeight(v2s16 p, bool generate=false);
-       void setGroundHeight(v2s16 p, f32 y, bool generate=false);
 
        /*
                These functions handle metadata.
                They do not handle blocks.
        */
+
        void serialize(std::ostream &os, u8 version);
        
        static ServerMapSector* deSerialize(
                        std::istream &is,
-                       NodeContainer *parent,
+                       Map *parent,
                        v2s16 p2d,
-                       core::map<v2s16, MapSector*> & sectors
+                       std::map<v2s16, MapSector*> & sectors,
+                       IGameDef *gamedef
                );
                
 private:
@@ -262,7 +122,7 @@ private:
 class ClientMapSector : public MapSector
 {
 public:
-       ClientMapSector(NodeContainer *parent, v2s16 pos);
+       ClientMapSector(Map *parent, v2s16 pos, IGameDef *gamedef);
        ~ClientMapSector();
        
        u32 getId() const
@@ -270,16 +130,7 @@ public:
                return MAPSECTOR_CLIENT;
        }
 
-       void deSerialize(std::istream &is);
-
-       /*s16 getCorner(u16 i)
-       {
-               return m_corners[i];
-       }*/
-               
 private:
-       // The ground height of the corners is stored in here
-       //s16 m_corners[4];
 };
 #endif