src/map.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 MAP_HEADER
  21 #define MAP_HEADER
  22
  23 #include <iostream>
  24 #include <sstream>
  25 #include <set>
  26 #include <map>
  27 #include <list>
  28
  29 #include "irrlichttypes_bloated.h"
  30 #include "mapnode.h"
  31 #include "constants.h"
  32 #include "voxel.h"
  33 #include "modifiedstate.h"
  34 #include "util/container.h"
  35 #include "util/cpp11_container.h"
  36 #include "nodetimer.h"
  37 #include "map_settings_manager.h"
  38
  39 class Settings;
  40 class Database;
  41 class ClientMap;
  42 class MapSector;
  43 class ServerMapSector;
  44 class MapBlock;
  45 class NodeMetadata;
  46 class IGameDef;
  47 class IRollbackManager;
  48 class EmergeManager;
  49 class ServerEnvironment;
  50 struct BlockMakeData;
  51
  52 /*
  53         MapEditEvent
  54 */
  55
  56 #define MAPTYPE_BASE 0
  57 #define MAPTYPE_SERVER 1
  58 #define MAPTYPE_CLIENT 2
  59
  60 enum MapEditEventType{
  61         // Node added (changed from air or something else to something)
  62         MEET_ADDNODE,
  63         // Node removed (changed to air)
  64         MEET_REMOVENODE,
  65         // Node swapped (changed without metadata change)
  66         MEET_SWAPNODE,
  67         // Node metadata of block changed (not knowing which node exactly)
  68         // p stores block coordinate
  69         MEET_BLOCK_NODE_METADATA_CHANGED,
  70         // Anything else (modified_blocks are set unsent)
  71         MEET_OTHER
  72 };
  73
  74 struct MapEditEvent
  75 {
  76         MapEditEventType type;
  77         v3s16 p;
  78         MapNode n;
  79         std::set<v3s16> modified_blocks;
  80         u16 already_known_by_peer;
  81
  82         MapEditEvent():
  83                 type(MEET_OTHER),
  84                 n(CONTENT_AIR),
  85                 already_known_by_peer(0)
  86         { }
  87
  88         MapEditEvent * clone()
  89         {
  90                 MapEditEvent *event = new MapEditEvent();
  91                 event->type = type;
  92                 event->p = p;
  93                 event->n = n;
  94                 event->modified_blocks = modified_blocks;
  95                 return event;
  96         }
  97
  98         VoxelArea getArea()
  99         {
 100                 switch(type){
 101                 case MEET_ADDNODE:
 102                         return VoxelArea(p);
 103                 case MEET_REMOVENODE:
 104                         return VoxelArea(p);
 105                 case MEET_SWAPNODE:
 106                         return VoxelArea(p);
 107                 case MEET_BLOCK_NODE_METADATA_CHANGED:
 108                 {
 109                         v3s16 np1 = p*MAP_BLOCKSIZE;
 110                         v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
 111                         return VoxelArea(np1, np2);
 112                 }
 113                 case MEET_OTHER:
 114                 {
 115                         VoxelArea a;
 116                         for(std::set<v3s16>::iterator
 117                                         i = modified_blocks.begin();
 118                                         i != modified_blocks.end(); ++i)
 119                         {
 120                                 v3s16 p = *i;
 121                                 v3s16 np1 = p*MAP_BLOCKSIZE;
 122                                 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
 123                                 a.addPoint(np1);
 124                                 a.addPoint(np2);
 125                         }
 126                         return a;
 127                 }
 128                 }
 129                 return VoxelArea();
 130         }
 131 };
 132
 133 class MapEventReceiver
 134 {
 135 public:
 136         // event shall be deleted by caller after the call.
 137         virtual void onMapEditEvent(MapEditEvent *event) = 0;
 138 };
 139
 140 class Map /*: public NodeContainer*/
 141 {
 142 public:
 143
 144         Map(std::ostream &dout, IGameDef *gamedef);
 145         virtual ~Map();
 146
 147         /*virtual u16 nodeContainerId() const
 148         {
 149                 return NODECONTAINER_ID_MAP;
 150         }*/
 151
 152         virtual s32 mapType() const
 153         {
 154                 return MAPTYPE_BASE;
 155         }
 156
 157         /*
 158                 Drop (client) or delete (server) the map.
 159         */
 160         virtual void drop()
 161         {
 162                 delete this;
 163         }
 164
 165         void addEventReceiver(MapEventReceiver *event_receiver);
 166         void removeEventReceiver(MapEventReceiver *event_receiver);
 167         // event shall be deleted by caller after the call.
 168         void dispatchEvent(MapEditEvent *event);
 169
 170         // On failure returns NULL
 171         MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
 172         // Same as the above (there exists no lock anymore)
 173         MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
 174         // On failure throws InvalidPositionException
 175         MapSector * getSectorNoGenerate(v2s16 p2d);
 176         // Gets an existing sector or creates an empty one
 177         //MapSector * getSectorCreate(v2s16 p2d);
 178
 179         /*
 180                 This is overloaded by ClientMap and ServerMap to allow
 181                 their differing fetch methods.
 182         */
 183         virtual MapSector * emergeSector(v2s16 p){ return NULL; }
 184         virtual MapSector * emergeSector(v2s16 p,
 185                         std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
 186
 187         // Returns InvalidPositionException if not found
 188         MapBlock * getBlockNoCreate(v3s16 p);
 189         // Returns NULL if not found
 190         MapBlock * getBlockNoCreateNoEx(v3s16 p);
 191
 192         /* Server overrides */
 193         virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
 194         { return getBlockNoCreateNoEx(p); }
 195
 196         // Returns InvalidPositionException if not found
 197         bool isNodeUnderground(v3s16 p);
 198
 199         bool isValidPosition(v3s16 p);
 200
 201         // throws InvalidPositionException if not found
 202         void setNode(v3s16 p, MapNode & n);
 203
 204         // Returns a CONTENT_IGNORE node if not found
 205         // If is_valid_position is not NULL then this will be set to true if the
 206         // position is valid, otherwise false
 207         MapNode getNodeNoEx(v3s16 p, bool *is_valid_position = NULL);
 208
 209         void unspreadLight(enum LightBank bank,
 210                         std::map<v3s16, u8> & from_nodes,
 211                         std::set<v3s16> & light_sources,
 212                         std::map<v3s16, MapBlock*> & modified_blocks);
 213
 214         void spreadLight(enum LightBank bank,
 215                         std::set<v3s16> & from_nodes,
 216                         std::map<v3s16, MapBlock*> & modified_blocks);
 217
 218         void updateLighting(enum LightBank bank,
 219                         std::map<v3s16, MapBlock*>  & a_blocks,
 220                         std::map<v3s16, MapBlock*> & modified_blocks);
 221
 222         void updateLighting(std::map<v3s16, MapBlock*>  & a_blocks,
 223                         std::map<v3s16, MapBlock*> & modified_blocks);
 224
 225         /*
 226                 These handle lighting but not faces.
 227         */
 228         void addNodeAndUpdate(v3s16 p, MapNode n,
 229                         std::map<v3s16, MapBlock*> &modified_blocks,
 230                         bool remove_metadata = true);
 231         void removeNodeAndUpdate(v3s16 p,
 232                         std::map<v3s16, MapBlock*> &modified_blocks);
 233
 234         /*
 235                 Wrappers for the latter ones.
 236                 These emit events.
 237                 Return true if succeeded, false if not.
 238         */
 239         bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
 240         bool removeNodeWithEvent(v3s16 p);
 241
 242         /*
 243                 Takes the blocks at the edges into account
 244         */
 245         bool getDayNightDiff(v3s16 blockpos);
 246
 247         //core::aabbox3d<s16> getDisplayedBlockArea();
 248
 249         //bool updateChangedVisibleArea();
 250
 251         // Call these before and after saving of many blocks
 252         virtual void beginSave() { return; }
 253         virtual void endSave() { return; }
 254
 255         virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
 256
 257         // Server implements these.
 258         // Client leaves them as no-op.
 259         virtual bool saveBlock(MapBlock *block) { return false; }
 260         virtual bool deleteBlock(v3s16 blockpos) { return false; }
 261
 262         /*
 263                 Updates usage timers and unloads unused blocks and sectors.
 264                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 265         */
 266         void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
 267                         std::vector<v3s16> *unloaded_blocks=NULL);
 268
 269         /*
 270                 Unloads all blocks with a zero refCount().
 271                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 272         */
 273         void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
 274
 275         // Deletes sectors and their blocks from memory
 276         // Takes cache into account
 277         // If deleted sector is in sector cache, clears cache
 278         void deleteSectors(std::vector<v2s16> &list);
 279
 280         // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
 281         virtual void PrintInfo(std::ostream &out);
 282
 283         void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks);
 284
 285         /*
 286                 Node metadata
 287                 These are basically coordinate wrappers to MapBlock
 288         */
 289
 290         std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
 291         NodeMetadata *getNodeMetadata(v3s16 p);
 292
 293         /**
 294          * Sets metadata for a node.
 295          * This method sets the metadata for a given node.
 296          * On success, it returns @c true and the object pointed to
 297          * by @p meta is then managed by the system and should
 298          * not be deleted by the caller.
 299          *
 300          * In case of failure, the method returns @c false and the
 301          * caller is still responsible for deleting the object!
 302          *
 303          * @param p node coordinates
 304          * @param meta pointer to @c NodeMetadata object
 305          * @return @c true on success, false on failure
 306          */
 307         bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
 308         void removeNodeMetadata(v3s16 p);
 309
 310         /*
 311                 Node Timers
 312                 These are basically coordinate wrappers to MapBlock
 313         */
 314
 315         NodeTimer getNodeTimer(v3s16 p);
 316         void setNodeTimer(const NodeTimer &t);
 317         void removeNodeTimer(v3s16 p);
 318
 319         /*
 320                 Misc.
 321         */
 322         std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
 323
 324         /*
 325                 Variables
 326         */
 327
 328         void transforming_liquid_add(v3s16 p);
 329         s32 transforming_liquid_size();
 330
 331 protected:
 332         friend class LuaVoxelManip;
 333
 334         std::ostream &m_dout; // A bit deprecated, could be removed
 335
 336         IGameDef *m_gamedef;
 337
 338         std::set<MapEventReceiver*> m_event_receivers;
 339
 340         std::map<v2s16, MapSector*> m_sectors;
 341
 342         // Be sure to set this to NULL when the cached sector is deleted
 343         MapSector *m_sector_cache;
 344         v2s16 m_sector_cache_p;
 345
 346         // Queued transforming water nodes
 347         UniqueQueue<v3s16> m_transforming_liquid;
 348
 349 private:
 350         f32 m_transforming_liquid_loop_count_multiplier;
 351         u32 m_unprocessed_count;
 352         u32 m_inc_trending_up_start_time; // milliseconds
 353         bool m_queue_size_timer_started;
 354
 355         DISABLE_CLASS_COPY(Map);
 356 };
 357
 358 /*
 359         ServerMap
 360
 361         This is the only map class that is able to generate map.
 362 */
 363
 364 class ServerMap : public Map
 365 {
 366 public:
 367         /*
 368                 savedir: directory to which map data should be saved
 369         */
 370         ServerMap(std::string savedir, IGameDef *gamedef, EmergeManager *emerge);
 371         ~ServerMap();
 372
 373         s32 mapType() const
 374         {
 375                 return MAPTYPE_SERVER;
 376         }
 377
 378         /*
 379                 Get a sector from somewhere.
 380                 - Check memory
 381                 - Check disk (doesn't load blocks)
 382                 - Create blank one
 383         */
 384         ServerMapSector *createSector(v2s16 p);
 385
 386         /*
 387                 Blocks are generated by using these and makeBlock().
 388         */
 389         bool initBlockMake(v3s16 blockpos, BlockMakeData *data);
 390         void finishBlockMake(BlockMakeData *data,
 391                 std::map<v3s16, MapBlock*> *changed_blocks);
 392
 393         /*
 394                 Get a block from somewhere.
 395                 - Memory
 396                 - Create blank
 397         */
 398         MapBlock *createBlock(v3s16 p);
 399
 400         /*
 401                 Forcefully get a block from somewhere.
 402                 - Memory
 403                 - Load from disk
 404                 - Create blank filled with CONTENT_IGNORE
 405
 406         */
 407         MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
 408
 409         /*
 410                 Try to get a block.
 411                 If it does not exist in memory, add it to the emerge queue.
 412                 - Memory
 413                 - Emerge Queue (deferred disk or generate)
 414         */
 415         MapBlock *getBlockOrEmerge(v3s16 p3d);
 416
 417         // Carries out any initialization necessary before block is sent
 418         void prepareBlock(MapBlock *block);
 419
 420         // Helper for placing objects on ground level
 421         s16 findGroundLevel(v2s16 p2d);
 422
 423         /*
 424                 Misc. helper functions for fiddling with directory and file
 425                 names when saving
 426         */
 427         void createDirs(std::string path);
 428         // returns something like "map/sectors/xxxxxxxx"
 429         std::string getSectorDir(v2s16 pos, int layout = 2);
 430         // dirname: final directory name
 431         v2s16 getSectorPos(std::string dirname);
 432         v3s16 getBlockPos(std::string sectordir, std::string blockfile);
 433         static std::string getBlockFilename(v3s16 p);
 434
 435         /*
 436                 Database functions
 437         */
 438         static Database *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
 439         // Verify we can read/write to the database
 440         void verifyDatabase();
 441
 442         // Returns true if the database file does not exist
 443         bool loadFromFolders();
 444
 445         // Call these before and after saving of blocks
 446         void beginSave();
 447         void endSave();
 448
 449         void save(ModifiedState save_level);
 450         void listAllLoadableBlocks(std::vector<v3s16> &dst);
 451         void listAllLoadedBlocks(std::vector<v3s16> &dst);
 452
 453         MapgenParams *getMapgenParams();
 454
 455         /*void saveChunkMeta();
 456         void loadChunkMeta();*/
 457
 458         // The sector mutex should be locked when calling most of these
 459
 460         // This only saves sector-specific data such as the heightmap
 461         // (no MapBlocks)
 462         // DEPRECATED? Sectors have no metadata anymore.
 463         void saveSectorMeta(ServerMapSector *sector);
 464         MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
 465         bool loadSectorMeta(v2s16 p2d);
 466
 467         // Full load of a sector including all blocks.
 468         // returns true on success, false on failure.
 469         bool loadSectorFull(v2s16 p2d);
 470         // If sector is not found in memory, try to load it from disk.
 471         // Returns true if sector now resides in memory
 472         //bool deFlushSector(v2s16 p2d);
 473
 474         bool saveBlock(MapBlock *block);
 475         static bool saveBlock(MapBlock *block, Database *db);
 476         // This will generate a sector with getSector if not found.
 477         void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
 478         MapBlock* loadBlock(v3s16 p);
 479         // Database version
 480         void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
 481
 482         bool deleteBlock(v3s16 blockpos);
 483
 484         void updateVManip(v3s16 pos);
 485
 486         // For debug printing
 487         virtual void PrintInfo(std::ostream &out);
 488
 489         bool isSavingEnabled(){ return m_map_saving_enabled; }
 490
 491         u64 getSeed();
 492         s16 getWaterLevel();
 493
 494         MapSettingsManager settings_mgr;
 495
 496 private:
 497         // Emerge manager
 498         EmergeManager *m_emerge;
 499
 500         std::string m_savedir;
 501         bool m_map_saving_enabled;
 502
 503 #if 0
 504         // Chunk size in MapSectors
 505         // If 0, chunks are disabled.
 506         s16 m_chunksize;
 507         // Chunks
 508         core::map<v2s16, MapChunk*> m_chunks;
 509 #endif
 510
 511         /*
 512                 Metadata is re-written on disk only if this is true.
 513                 This is reset to false when written on disk.
 514         */
 515         bool m_map_metadata_changed;
 516         Database *dbase;
 517 };
 518
 519
 520 #define VMANIP_BLOCK_DATA_INEXIST     1
 521 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
 522
 523 class MMVManip : public VoxelManipulator
 524 {
 525 public:
 526         MMVManip(Map *map);
 527         virtual ~MMVManip();
 528
 529         virtual void clear()
 530         {
 531                 VoxelManipulator::clear();
 532                 m_loaded_blocks.clear();
 533         }
 534
 535         void setMap(Map *map)
 536         {m_map = map;}
 537
 538         void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
 539                 bool load_if_inexistent = true);
 540
 541         // This is much faster with big chunks of generated data
 542         void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
 543                 bool overwrite_generated = true);
 544
 545         bool m_is_dirty;
 546
 547 protected:
 548         bool m_create_area;
 549         Map *m_map;
 550         /*
 551                 key = blockpos
 552                 value = flags describing the block
 553         */
 554         std::map<v3s16, u8> m_loaded_blocks;
 555 };
 556
 557 #endif