Optimize headers (part 2) (#6272)

[minetest.git] / src / mg_schematic.h

diff --git a/src/mg_schematic.h b/src/mg_schematic.h
index 4a85f69a679787ea0491a4d9c17b4f450c216d5a..069b594f10e02018ba2c31f76100c63f3dda5c99 100644 (file)
--- a/src/mg_schematic.h
+++ b/src/mg_schematic.h
@@ -1,6 +1,7 @@
 /*
 Minetest
-Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
+Copyright (C) 2014-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
+Copyright (C) 2015-2017 paramat
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -17,80 +18,130 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef MG_SCHEMATIC_HEADER
-#define MG_SCHEMATIC_HEADER
+#pragma once
 
 #include <map>
 #include "mg_decoration.h"
 #include "util/string.h"
 
 class Map;
+class ServerMap;
 class Mapgen;
 class MMVManip;
 class PseudoRandom;
 class NodeResolver;
+class Server;
 
-/////////////////// Schematic flags
-#define SCHEM_CIDS_UPDATED 0x08
+/*
+       Minetest Schematic File Format
+
+       All values are stored in big-endian byte order.
+       [u32] signature: 'MTSM'
+       [u16] version: 4
+       [u16] size X
+       [u16] size Y
+       [u16] size Z
+       For each Y:
+               [u8] slice probability value
+       [Name-ID table] Name ID Mapping Table
+               [u16] name-id count
+               For each name-id mapping:
+                       [u16] name length
+                       [u8[]] name
+       ZLib deflated {
+       For each node in schematic:  (for z, y, x)
+               [u16] content
+       For each node in schematic:
+               [u8] param1
+                 bit 0-6: probability
+                 bit 7:   specific node force placement
+       For each node in schematic:
+               [u8] param2
+       }
 
+       Version changes:
+       1 - Initial version
+       2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
+       3 - Added y-slice probabilities; this allows for variable height structures
+       4 - Compressed range of node occurence prob., added per-node force placement bit
+*/
 
+//// Schematic constants
 #define MTSCHEM_FILE_SIGNATURE 0x4d54534d // 'MTSM'
-#define MTSCHEM_FILE_VER_HIGHEST_READ  3
-#define MTSCHEM_FILE_VER_HIGHEST_WRITE 3
+#define MTSCHEM_FILE_VER_HIGHEST_READ  4
+#define MTSCHEM_FILE_VER_HIGHEST_WRITE 4
 
-#define MTSCHEM_PROB_NEVER  0x00
-#define MTSCHEM_PROB_ALWAYS 0xFF
+#define MTSCHEM_PROB_MASK       0x7F
 
+#define MTSCHEM_PROB_NEVER      0x00
+#define MTSCHEM_PROB_ALWAYS     0x7F
+#define MTSCHEM_PROB_ALWAYS_OLD 0xFF
 
-class Schematic : public ObjDef, public NodeResolver {
-public:
-       std::vector<content_t> c_nodes;
+#define MTSCHEM_FORCE_PLACE     0x80
 
-       u32 flags;
-       v3s16 size;
-       MapNode *schemdata;
-       u8 *slice_probs;
+enum SchematicType
+{
+       SCHEMATIC_NORMAL,
+};
 
+enum SchematicFormatType {
+       SCHEM_FMT_HANDLE,
+       SCHEM_FMT_MTS,
+       SCHEM_FMT_LUA,
+};
+
+class Schematic : public ObjDef, public NodeResolver {
+public:
        Schematic();
        virtual ~Schematic();
 
-       virtual void resolveNodeNames(NodeResolveInfo *nri);
+       virtual void resolveNodeNames();
 
-       void updateContentIds();
+       bool loadSchematicFromFile(const std::string &filename, INodeDefManager *ndef,
+               StringMap *replace_names=NULL);
+       bool saveSchematicToFile(const std::string &filename, INodeDefManager *ndef);
+       bool getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2);
 
-       void blitToVManip(v3s16 p, MMVManip *vm,
-               Rotation rot, bool force_placement, INodeDefManager *ndef);
+       bool deserializeFromMts(std::istream *is, std::vector<std::string> *names);
+       bool serializeToMts(std::ostream *os, const std::vector<std::string> &names);
+       bool serializeToLua(std::ostream *os, const std::vector<std::string> &names,
+               bool use_comments, u32 indent_spaces);
 
-       bool loadSchematicFromFile(const char *filename, INodeDefManager *ndef,
-               StringMap *replace_names);
-       void saveSchematicToFile(const char *filename, INodeDefManager *ndef);
-       bool getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2);
+       void blitToVManip(MMVManip *vm, v3s16 p, Rotation rot, bool force_place);
+       bool placeOnVManip(MMVManip *vm, v3s16 p, u32 flags, Rotation rot, bool force_place);
+       void placeOnMap(ServerMap *map, v3s16 p, u32 flags, Rotation rot, bool force_place);
 
-       void placeStructure(Map *map, v3s16 p, u32 flags,
-               Rotation rot, bool force_placement, INodeDefManager *nef);
        void applyProbabilities(v3s16 p0,
                std::vector<std::pair<v3s16, u8> > *plist,
                std::vector<std::pair<s16, u8> > *splist);
+
+       std::vector<content_t> c_nodes;
+       u32 flags = 0;
+       v3s16 size;
+       MapNode *schemdata = nullptr;
+       u8 *slice_probs = nullptr;
 };
 
 class SchematicManager : public ObjDefManager {
 public:
-       SchematicManager(IGameDef *gamedef);
-       ~SchematicManager() {}
+       SchematicManager(Server *server);
+       virtual ~SchematicManager() = default;
+
+       virtual void clear();
 
        const char *getObjectTitle() const
        {
                return "schematic";
        }
 
-       Schematic *create(int type)
+       static Schematic *create(SchematicType type)
        {
                return new Schematic;
        }
-};
-
-void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
-       std::vector<content_t> *usednodes);
 
+private:
+       Server *m_server;
+};
 
-#endif
+void generate_nodelist_and_update_ids(MapNode *nodes, size_t nodecount,
+       std::vector<std::string> *usednodes, INodeDefManager *ndef);