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 <jmutex.h>
  24 #include <jmutexautolock.h>
  25 #include <jthread.h>
  26 #include <iostream>
  27 #include <sstream>
  28 #include <set>
  29 #include <map>
  30 #include <list>
  31
  32 #include "irrlichttypes_bloated.h"
  33 #include "mapnode.h"
  34 #include "constants.h"
  35 #include "voxel.h"
  36 #include "mapgen.h" //for BlockMakeData and EmergeManager
  37 #include "modifiedstate.h"
  38 #include "util/container.h"
  39 #include "nodetimer.h"
  40
  41 extern "C" {
  42         #include "sqlite3.h"
  43 }
  44
  45 class ClientMap;
  46 class MapSector;
  47 class ServerMapSector;
  48 class MapBlock;
  49 class NodeMetadata;
  50 class IGameDef;
  51 class IRollbackReportSink;
  52 class EmergeManager;
  53 struct BlockMakeData;
  54
  55
  56 /*
  57         MapEditEvent
  58 */
  59
  60 #define MAPTYPE_BASE 0
  61 #define MAPTYPE_SERVER 1
  62 #define MAPTYPE_CLIENT 2
  63
  64 enum MapEditEventType{
  65         // Node added (changed from air or something else to something)
  66         MEET_ADDNODE,
  67         // Node removed (changed to air)
  68         MEET_REMOVENODE,
  69         // Node metadata of block changed (not knowing which node exactly)
  70         // p stores block coordinate
  71         MEET_BLOCK_NODE_METADATA_CHANGED,
  72         // Anything else (modified_blocks are set unsent)
  73         MEET_OTHER
  74 };
  75
  76 struct MapEditEvent
  77 {
  78         MapEditEventType type;
  79         v3s16 p;
  80         MapNode n;
  81         std::set<v3s16> modified_blocks;
  82         u16 already_known_by_peer;
  83
  84         MapEditEvent():
  85                 type(MEET_OTHER),
  86                 already_known_by_peer(0)
  87         {
  88         }
  89
  90         MapEditEvent * clone()
  91         {
  92                 MapEditEvent *event = new MapEditEvent();
  93                 event->type = type;
  94                 event->p = p;
  95                 event->n = n;
  96                 event->modified_blocks = modified_blocks;
  97                 return event;
  98         }
  99
 100         VoxelArea getArea()
 101         {
 102                 switch(type){
 103                 case MEET_ADDNODE:
 104                         return VoxelArea(p);
 105                 case MEET_REMOVENODE:
 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 allow_generate=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         MapNode getNode(v3s16 p);
 203
 204         // throws InvalidPositionException if not found
 205         void setNode(v3s16 p, MapNode & n);
 206
 207         // Returns a CONTENT_IGNORE node if not found
 208         MapNode getNodeNoEx(v3s16 p);
 209
 210         void unspreadLight(enum LightBank bank,
 211                         std::map<v3s16, u8> & from_nodes,
 212                         std::set<v3s16> & light_sources,
 213                         std::map<v3s16, MapBlock*> & modified_blocks);
 214
 215         void unLightNeighbors(enum LightBank bank,
 216                         v3s16 pos, u8 lightwas,
 217                         std::set<v3s16> & light_sources,
 218                         std::map<v3s16, MapBlock*> & modified_blocks);
 219
 220         void spreadLight(enum LightBank bank,
 221                         std::set<v3s16> & from_nodes,
 222                         std::map<v3s16, MapBlock*> & modified_blocks);
 223
 224         void lightNeighbors(enum LightBank bank,
 225                         v3s16 pos,
 226                         std::map<v3s16, MapBlock*> & modified_blocks);
 227
 228         v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
 229
 230         s16 propagateSunlight(v3s16 start,
 231                         std::map<v3s16, MapBlock*> & modified_blocks);
 232
 233         void updateLighting(enum LightBank bank,
 234                         std::map<v3s16, MapBlock*>  & a_blocks,
 235                         std::map<v3s16, MapBlock*> & modified_blocks);
 236
 237         void updateLighting(std::map<v3s16, MapBlock*>  & a_blocks,
 238                         std::map<v3s16, MapBlock*> & modified_blocks);
 239
 240         /*
 241                 These handle lighting but not faces.
 242         */
 243         void addNodeAndUpdate(v3s16 p, MapNode n,
 244                         std::map<v3s16, MapBlock*> &modified_blocks);
 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);
 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 this.
 272         // Client leaves it as no-op.
 273         virtual void saveBlock(MapBlock *block){};
 274
 275         /*
 276                 Updates usage timers and unloads unused blocks and sectors.
 277                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 278         */
 279         void timerUpdate(float dtime, float unload_timeout,
 280                         std::list<v3s16> *unloaded_blocks=NULL);
 281
 282         /*
 283                 Unloads all blocks with a zero refCount().
 284                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 285         */
 286         void unloadUnreferencedBlocks(std::list<v3s16> *unloaded_blocks=NULL);
 287
 288         // Deletes sectors and their blocks from memory
 289         // Takes cache into account
 290         // If deleted sector is in sector cache, clears cache
 291         void deleteSectors(std::list<v2s16> &list);
 292
 293 #if 0
 294         /*
 295                 Unload unused data
 296                 = flush changed to disk and delete from memory, if usage timer of
 297                   block is more than timeout
 298         */
 299         void unloadUnusedData(float timeout,
 300                         core::list<v3s16> *deleted_blocks=NULL);
 301 #endif
 302
 303         // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
 304         virtual void PrintInfo(std::ostream &out);
 305
 306         void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks);
 307         void transformLiquidsFinite(std::map<v3s16, MapBlock*> & modified_blocks);
 308
 309         /*
 310                 Node metadata
 311                 These are basically coordinate wrappers to MapBlock
 312         */
 313
 314         NodeMetadata* getNodeMetadata(v3s16 p);
 315         void setNodeMetadata(v3s16 p, NodeMetadata *meta);
 316         void removeNodeMetadata(v3s16 p);
 317
 318         /*
 319                 Node Timers
 320                 These are basically coordinate wrappers to MapBlock
 321         */
 322
 323         NodeTimer getNodeTimer(v3s16 p);
 324         void setNodeTimer(v3s16 p, NodeTimer t);
 325         void removeNodeTimer(v3s16 p);
 326
 327         /*
 328                 Misc.
 329         */
 330         std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
 331
 332         /*
 333                 Variables
 334         */
 335
 336         void transforming_liquid_add(v3s16 p);
 337         s32 transforming_liquid_size();
 338
 339 protected:
 340         friend class LuaVoxelManip;
 341
 342         std::ostream &m_dout; // A bit deprecated, could be removed
 343
 344         IGameDef *m_gamedef;
 345
 346         std::set<MapEventReceiver*> m_event_receivers;
 347
 348         std::map<v2s16, MapSector*> m_sectors;
 349
 350         // Be sure to set this to NULL when the cached sector is deleted
 351         MapSector *m_sector_cache;
 352         v2s16 m_sector_cache_p;
 353
 354         // Queued transforming water nodes
 355         UniqueQueue<v3s16> m_transforming_liquid;
 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(BlockMakeData *data, v3s16 blockpos);
 390         MapBlock *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         // Helper for placing objects on ground level
 410         s16 findGroundLevel(v2s16 p2d);
 411
 412         /*
 413                 Misc. helper functions for fiddling with directory and file
 414                 names when saving
 415         */
 416         void createDirs(std::string path);
 417         // returns something like "map/sectors/xxxxxxxx"
 418         std::string getSectorDir(v2s16 pos, int layout = 2);
 419         // dirname: final directory name
 420         v2s16 getSectorPos(std::string dirname);
 421         v3s16 getBlockPos(std::string sectordir, std::string blockfile);
 422         static std::string getBlockFilename(v3s16 p);
 423
 424         /*
 425                 Database functions
 426         */
 427         // Create the database structure
 428         void createDatabase();
 429         // Verify we can read/write to the database
 430         void verifyDatabase();
 431         // Get an integer suitable for a block
 432         static sqlite3_int64 getBlockAsInteger(const v3s16 pos);
 433         static v3s16 getIntegerAsBlock(sqlite3_int64 i);
 434
 435         // Returns true if the database file does not exist
 436         bool loadFromFolders();
 437
 438         // Call these before and after saving of blocks
 439         void beginSave();
 440         void endSave();
 441
 442         void save(ModifiedState save_level);
 443         void listAllLoadableBlocks(std::list<v3s16> &dst);
 444         void listAllLoadedBlocks(std::list<v3s16> &dst);
 445         // Saves map seed and possibly other stuff
 446         void saveMapMeta();
 447         void loadMapMeta();
 448
 449         /*void saveChunkMeta();
 450         void loadChunkMeta();*/
 451
 452         // The sector mutex should be locked when calling most of these
 453
 454         // This only saves sector-specific data such as the heightmap
 455         // (no MapBlocks)
 456         // DEPRECATED? Sectors have no metadata anymore.
 457         void saveSectorMeta(ServerMapSector *sector);
 458         MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
 459         bool loadSectorMeta(v2s16 p2d);
 460
 461         // Full load of a sector including all blocks.
 462         // returns true on success, false on failure.
 463         bool loadSectorFull(v2s16 p2d);
 464         // If sector is not found in memory, try to load it from disk.
 465         // Returns true if sector now resides in memory
 466         //bool deFlushSector(v2s16 p2d);
 467
 468         void saveBlock(MapBlock *block);
 469         // This will generate a sector with getSector if not found.
 470         void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
 471         MapBlock* loadBlock(v3s16 p);
 472         // Database version
 473         void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
 474
 475         // For debug printing
 476         virtual void PrintInfo(std::ostream &out);
 477
 478         bool isSavingEnabled(){ return m_map_saving_enabled; }
 479
 480         u64 getSeed(){ return m_seed; }
 481
 482         MapgenParams *getMapgenParams(){ return m_mgparams; }
 483
 484         // Parameters fed to the Mapgen
 485         MapgenParams *m_mgparams;
 486 private:
 487         // Seed used for all kinds of randomness in generation
 488         u64 m_seed;
 489
 490         // Emerge manager
 491         EmergeManager *m_emerge;
 492
 493         std::string m_savedir;
 494         bool m_map_saving_enabled;
 495
 496 #if 0
 497         // Chunk size in MapSectors
 498         // If 0, chunks are disabled.
 499         s16 m_chunksize;
 500         // Chunks
 501         core::map<v2s16, MapChunk*> m_chunks;
 502 #endif
 503
 504         /*
 505                 Metadata is re-written on disk only if this is true.
 506                 This is reset to false when written on disk.
 507         */
 508         bool m_map_metadata_changed;
 509
 510         /*
 511                 SQLite database and statements
 512         */
 513         sqlite3 *m_database;
 514         sqlite3_stmt *m_database_read;
 515         sqlite3_stmt *m_database_write;
 516         sqlite3_stmt *m_database_list;
 517 };
 518
 519 #define VMANIP_BLOCK_DATA_INEXIST     1
 520 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
 521
 522 class MapVoxelManipulator : public VoxelManipulator
 523 {
 524 public:
 525         MapVoxelManipulator(Map *map);
 526         virtual ~MapVoxelManipulator();
 527
 528         virtual void clear()
 529         {
 530                 VoxelManipulator::clear();
 531                 m_loaded_blocks.clear();
 532         }
 533
 534         virtual void emerge(VoxelArea a, s32 caller_id=-1);
 535
 536         void blitBack(std::map<v3s16, MapBlock*> & modified_blocks);
 537
 538 protected:
 539         Map *m_map;
 540         /*
 541                 key = blockpos
 542                 value = flags describing the block
 543         */
 544         std::map<v3s16, u8> m_loaded_blocks;
 545 };
 546
 547 class ManualMapVoxelManipulator : public MapVoxelManipulator
 548 {
 549 public:
 550         ManualMapVoxelManipulator(Map *map);
 551         virtual ~ManualMapVoxelManipulator();
 552
 553         void setMap(Map *map)
 554         {m_map = map;}
 555
 556         virtual void emerge(VoxelArea a, s32 caller_id=-1);
 557
 558         void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max);
 559
 560         // This is much faster with big chunks of generated data
 561         void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks);
 562
 563 protected:
 564         bool m_create_area;
 565 };
 566
 567 #endif
 568