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