X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fserialization.h;h=01d37d3632fb0e5f3985d42c0e7737edb59e1c0a;hb=ad5ac39d8d1a8b8f6f0fe077e20bac914ddc624b;hp=c7cafc5d19306e60a87ed86acb8417a9e420ba9c;hpb=c638442e78b953556e7dadd4c0c34cb0c719bbc8;p=oweals%2Fminetest.git diff --git a/src/serialization.h b/src/serialization.h index c7cafc5d1..01d37d363 100644 --- a/src/serialization.h +++ b/src/serialization.h @@ -1,18 +1,18 @@ /* -Minetest-c55 -Copyright (C) 2010 celeron55, Perttu Ahola +Minetest +Copyright (C) 2013 celeron55, Perttu Ahola This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or +it under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. +GNU Lesser General Public License for more details. -You should have received a copy of the GNU General Public License along +You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ @@ -20,59 +20,78 @@ with this program; if not, write to the Free Software Foundation, Inc., #ifndef SERIALIZATION_HEADER #define SERIALIZATION_HEADER -#include "common_irrlicht.h" +#include "irrlichttypes.h" #include "exceptions.h" #include -#include "utility.h" +#include "util/pointer.h" /* + Map format serialization version + -------------------------------- + + For map data (blocks, nodes, sectors). + NOTE: The goal is to increment this so that saved maps will be loadable by any version. Other compatibility is not maintained. - Serialization format versions (for raw map data (blocks, nodes, sectors)): - == Unsupported == + 0: original networked test with 1-byte nodes 1: update with 2-byte nodes - == Supported == 2: lighting is transmitted in param 3: optional fetching of far blocks 4: block compression 5: sector objects NOTE: block compression was left accidentally out 6: failed attempt at switching block compression on again 7: block compression switched on again - 8: (dev) server-initiated block transfers and all kinds of stuff - 9: (dev) block objects - 10: (dev) water pressure - 11: (dev) zlib'd blocks, block flags - 12: (dev) UnlimitedHeightmap now uses interpolated areas - 13: (dev) Mapgen v2 - 14: (dev) NodeMetadata - 15: (dev) StaticObjects - 16: (dev) larger maximum size of node metadata, and compression + 8: server-initiated block transfers and all kinds of stuff + 9: block objects + 10: water pressure + 11: zlib'd blocks, block flags + 12: UnlimitedHeightmap now uses interpolated areas + 13: Mapgen v2 + 14: NodeMetadata + 15: StaticObjects + 16: larger maximum size of node metadata, and compression + 17: MapBlocks contain timestamp + 18: new generator (not really necessary, but it's there) + 19: new content type handling + 20: many existing content types translated to extended ones + 21: dynamic content type allocation + 22: minerals removed, facedir & wallmounted changed + 23: new node metadata format + 24: 16-bit node ids and node timers (never released as stable) + 25: Improved node timer format + 26: Never written; read the same as 25 */ // This represents an uninitialized or invalid format #define SER_FMT_VER_INVALID 255 // Highest supported serialization version -#define SER_FMT_VER_HIGHEST 16 +#define SER_FMT_VER_HIGHEST_READ 26 +// Saved on disk version +#define SER_FMT_VER_HIGHEST_WRITE 25 // Lowest supported serialization version -#define SER_FMT_VER_LOWEST 0 +#define SER_FMT_VER_LOWEST_READ 0 +// Lowest serialization version for writing +// Can't do < 24 anymore; we have 16-bit dynamically allocated node IDs +// in memory; conversion just won't work in this direction. +#define SER_FMT_VER_LOWEST_WRITE 24 -#define ser_ver_supported(v) (v >= SER_FMT_VER_LOWEST && v <= SER_FMT_VER_HIGHEST) +inline bool ser_ver_supported(s32 v) { + return v >= SER_FMT_VER_LOWEST_READ && v <= SER_FMT_VER_HIGHEST_READ; +} -void compressZlib(SharedBuffer data, std::ostream &os); -void compressZlib(const std::string &data, std::ostream &os); +/* + Misc. serialization functions +*/ + +void compressZlib(SharedBuffer data, std::ostream &os, int level = -1); +void compressZlib(const std::string &data, std::ostream &os, int level = -1); void decompressZlib(std::istream &is, std::ostream &os); +// These choose between zlib and a self-made one according to version void compress(SharedBuffer data, std::ostream &os, u8 version); //void compress(const std::string &data, std::ostream &os, u8 version); void decompress(std::istream &is, std::ostream &os, u8 version); -/*class Serializable -{ -public: - void serialize(std::ostream &os, u8 version) = 0; - void deSerialize(std::istream &istr); -};*/ - #endif