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 "nodetimer.h"
  36
  37 class Settings;
  38 class Database;
  39 class ClientMap;
  40 class MapSector;
  41 class ServerMapSector;
  42 class MapBlock;
  43 class NodeMetadata;
  44 class IGameDef;
  45 class IRollbackManager;
  46 class EmergeManager;
  47 class ServerEnvironment;
  48 struct BlockMakeData;
  49 struct MapgenParams;
  50
  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 unLightNeighbors(enum LightBank bank,
 215                         v3s16 pos, u8 lightwas,
 216                         std::set<v3s16> & light_sources,
 217                         std::map<v3s16, MapBlock*> & modified_blocks);
 218
 219         void spreadLight(enum LightBank bank,
 220                         std::set<v3s16> & from_nodes,
 221                         std::map<v3s16, MapBlock*> & modified_blocks);
 222
 223         void lightNeighbors(enum LightBank bank,
 224                         v3s16 pos,
 225                         std::map<v3s16, MapBlock*> & modified_blocks);
 226
 227         v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
 228
 229         s16 propagateSunlight(v3s16 start,
 230                         std::map<v3s16, MapBlock*> & modified_blocks);
 231
 232         void updateLighting(enum LightBank bank,
 233                         std::map<v3s16, MapBlock*>  & a_blocks,
 234                         std::map<v3s16, MapBlock*> & modified_blocks);
 235
 236         void updateLighting(std::map<v3s16, MapBlock*>  & a_blocks,
 237                         std::map<v3s16, MapBlock*> & modified_blocks);
 238
 239         /*
 240                 These handle lighting but not faces.
 241         */
 242         void addNodeAndUpdate(v3s16 p, MapNode n,
 243                         std::map<v3s16, MapBlock*> &modified_blocks,
 244                         bool remove_metadata = true);
 245         void removeNodeAndUpdate(v3s16 p,
 246                         std::map<v3s16, MapBlock*> &modified_blocks);
 247
 248         /*
 249                 Wrappers for the latter ones.
 250                 These emit events.
 251                 Return true if succeeded, false if not.
 252         */
 253         bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
 254         bool removeNodeWithEvent(v3s16 p);
 255
 256         /*
 257                 Takes the blocks at the edges into account
 258         */
 259         bool getDayNightDiff(v3s16 blockpos);
 260
 261         //core::aabbox3d<s16> getDisplayedBlockArea();
 262
 263         //bool updateChangedVisibleArea();
 264
 265         // Call these before and after saving of many blocks
 266         virtual void beginSave() {return;};
 267         virtual void endSave() {return;};
 268
 269         virtual void save(ModifiedState save_level){assert(0);};
 270
 271         // Server implements these.
 272         // Client leaves them as no-op.
 273         virtual bool saveBlock(MapBlock *block) { return false; };
 274         virtual bool deleteBlock(v3s16 blockpos) { return false; };
 275
 276         /*
 277                 Updates usage timers and unloads unused blocks and sectors.
 278                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 279         */
 280         void timerUpdate(float dtime, float unload_timeout,
 281                         std::vector<v3s16> *unloaded_blocks=NULL);
 282
 283         /*
 284                 Unloads all blocks with a zero refCount().
 285                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 286         */
 287         void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
 288
 289         // Deletes sectors and their blocks from memory
 290         // Takes cache into account
 291         // If deleted sector is in sector cache, clears cache
 292         void deleteSectors(std::vector<v2s16> &list);
 293
 294         // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
 295         virtual void PrintInfo(std::ostream &out);
 296
 297         void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks);
 298
 299         /*
 300                 Node metadata
 301                 These are basically coordinate wrappers to MapBlock
 302         */
 303
 304         NodeMetadata* getNodeMetadata(v3s16 p);
 305
 306         /**
 307          * Sets metadata for a node.
 308          * This method sets the metadata for a given node.
 309          * On success, it returns @c true and the object pointed to
 310          * by @p meta is then managed by the system and should
 311          * not be deleted by the caller.
 312          *
 313          * In case of failure, the method returns @c false and the
 314          * caller is still responsible for deleting the object!
 315          *
 316          * @param p node coordinates
 317          * @param meta pointer to @c NodeMetadata object
 318          * @return @c true on success, false on failure
 319          */
 320         bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
 321         void removeNodeMetadata(v3s16 p);
 322
 323         /*
 324                 Node Timers
 325                 These are basically coordinate wrappers to MapBlock
 326         */
 327
 328         NodeTimer getNodeTimer(v3s16 p);
 329         void setNodeTimer(v3s16 p, NodeTimer t);
 330         void removeNodeTimer(v3s16 p);
 331
 332         /*
 333                 Misc.
 334         */
 335         std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
 336
 337         /*
 338                 Variables
 339         */
 340
 341         void transforming_liquid_add(v3s16 p);
 342         s32 transforming_liquid_size();
 343
 344 protected:
 345         friend class LuaVoxelManip;
 346
 347         std::ostream &m_dout; // A bit deprecated, could be removed
 348
 349         IGameDef *m_gamedef;
 350
 351         std::set<MapEventReceiver*> m_event_receivers;
 352
 353         std::map<v2s16, MapSector*> m_sectors;
 354
 355         // Be sure to set this to NULL when the cached sector is deleted
 356         MapSector *m_sector_cache;
 357         v2s16 m_sector_cache_p;
 358
 359         // Queued transforming water nodes
 360         UniqueQueue<v3s16> m_transforming_liquid;
 361
 362 private:
 363         f32 m_transforming_liquid_loop_count_multiplier;
 364         u32 m_unprocessed_count;
 365         u32 m_inc_trending_up_start_time; // milliseconds
 366         bool m_queue_size_timer_started;
 367 };
 368
 369 /*
 370         ServerMap
 371
 372         This is the only map class that is able to generate map.
 373 */
 374
 375 class ServerMap : public Map
 376 {
 377 public:
 378         /*
 379                 savedir: directory to which map data should be saved
 380         */
 381         ServerMap(std::string savedir, IGameDef *gamedef, EmergeManager *emerge);
 382         ~ServerMap();
 383
 384         s32 mapType() const
 385         {
 386                 return MAPTYPE_SERVER;
 387         }
 388
 389         /*
 390                 Get a sector from somewhere.
 391                 - Check memory
 392                 - Check disk (doesn't load blocks)
 393                 - Create blank one
 394         */
 395         ServerMapSector * createSector(v2s16 p);
 396
 397         /*
 398                 Blocks are generated by using these and makeBlock().
 399         */
 400         bool initBlockMake(BlockMakeData *data, v3s16 blockpos);
 401         void finishBlockMake(BlockMakeData *data,
 402                         std::map<v3s16, MapBlock*> &changed_blocks);
 403
 404         /*
 405                 Get a block from somewhere.
 406                 - Memory
 407                 - Create blank
 408         */
 409         MapBlock * createBlock(v3s16 p);
 410
 411         /*
 412                 Forcefully get a block from somewhere.
 413                 - Memory
 414                 - Load from disk
 415                 - Create blank filled with CONTENT_IGNORE
 416
 417         */
 418         MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
 419
 420         /*
 421                 Try to get a block.
 422                 If it does not exist in memory, add it to the emerge queue.
 423                 - Memory
 424                 - Emerge Queue (deferred disk or generate)
 425         */
 426         MapBlock *getBlockOrEmerge(v3s16 p3d);
 427
 428         // Carries out any initialization necessary before block is sent
 429         void prepareBlock(MapBlock *block);
 430
 431         // Helper for placing objects on ground level
 432         s16 findGroundLevel(v2s16 p2d);
 433
 434         /*
 435                 Misc. helper functions for fiddling with directory and file
 436                 names when saving
 437         */
 438         void createDirs(std::string path);
 439         // returns something like "map/sectors/xxxxxxxx"
 440         std::string getSectorDir(v2s16 pos, int layout = 2);
 441         // dirname: final directory name
 442         v2s16 getSectorPos(std::string dirname);
 443         v3s16 getBlockPos(std::string sectordir, std::string blockfile);
 444         static std::string getBlockFilename(v3s16 p);
 445
 446         /*
 447                 Database functions
 448         */
 449         static Database *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
 450         // Verify we can read/write to the database
 451         void verifyDatabase();
 452
 453         // Returns true if the database file does not exist
 454         bool loadFromFolders();
 455
 456         // Call these before and after saving of blocks
 457         void beginSave();
 458         void endSave();
 459
 460         void save(ModifiedState save_level);
 461         void listAllLoadableBlocks(std::vector<v3s16> &dst);
 462         void listAllLoadedBlocks(std::vector<v3s16> &dst);
 463         // Saves map seed and possibly other stuff
 464         void saveMapMeta();
 465         void loadMapMeta();
 466
 467         /*void saveChunkMeta();
 468         void loadChunkMeta();*/
 469
 470         // The sector mutex should be locked when calling most of these
 471
 472         // This only saves sector-specific data such as the heightmap
 473         // (no MapBlocks)
 474         // DEPRECATED? Sectors have no metadata anymore.
 475         void saveSectorMeta(ServerMapSector *sector);
 476         MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
 477         bool loadSectorMeta(v2s16 p2d);
 478
 479         // Full load of a sector including all blocks.
 480         // returns true on success, false on failure.
 481         bool loadSectorFull(v2s16 p2d);
 482         // If sector is not found in memory, try to load it from disk.
 483         // Returns true if sector now resides in memory
 484         //bool deFlushSector(v2s16 p2d);
 485
 486         bool saveBlock(MapBlock *block);
 487         static bool saveBlock(MapBlock *block, Database *db);
 488         // This will generate a sector with getSector if not found.
 489         void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
 490         MapBlock* loadBlock(v3s16 p);
 491         // Database version
 492         void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
 493
 494         bool deleteBlock(v3s16 blockpos);
 495
 496         void updateVManip(v3s16 pos);
 497
 498         // For debug printing
 499         virtual void PrintInfo(std::ostream &out);
 500
 501         bool isSavingEnabled(){ return m_map_saving_enabled; }
 502
 503         u64 getSeed();
 504         s16 getWaterLevel();
 505
 506 private:
 507         // Emerge manager
 508         EmergeManager *m_emerge;
 509
 510         std::string m_savedir;
 511         bool m_map_saving_enabled;
 512
 513 #if 0
 514         // Chunk size in MapSectors
 515         // If 0, chunks are disabled.
 516         s16 m_chunksize;
 517         // Chunks
 518         core::map<v2s16, MapChunk*> m_chunks;
 519 #endif
 520
 521         /*
 522                 Metadata is re-written on disk only if this is true.
 523                 This is reset to false when written on disk.
 524         */
 525         bool m_map_metadata_changed;
 526         Database *dbase;
 527 };
 528
 529
 530 #define VMANIP_BLOCK_DATA_INEXIST     1
 531 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
 532
 533 class MMVManip : public VoxelManipulator
 534 {
 535 public:
 536         MMVManip(Map *map);
 537         virtual ~MMVManip();
 538
 539         virtual void clear()
 540         {
 541                 VoxelManipulator::clear();
 542                 m_loaded_blocks.clear();
 543         }
 544
 545         void setMap(Map *map)
 546         {m_map = map;}
 547
 548         void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
 549                 bool load_if_inexistent = true);
 550
 551         // This is much faster with big chunks of generated data
 552         void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
 553                 bool overwrite_generated = true);
 554
 555         bool m_is_dirty;
 556
 557 protected:
 558         bool m_create_area;
 559         Map *m_map;
 560         /*
 561                 key = blockpos
 562                 value = flags describing the block
 563         */
 564         std::map<v3s16, u8> m_loaded_blocks;
 565 };
 566
 567 #endif