merged an old head into main branch

[oweals/minetest.git] / src / serialization.h

diff --git a/src/serialization.h b/src/serialization.h
index fd9b39535680cf3910089e2bfd04a8a90f99cabf..fad1388e0bf9572938d458820b13dc4b0e7c8ac3 100644 (file)
--- a/src/serialization.h
+++ b/src/serialization.h
@@ -1,5 +1,20 @@
 /*
-(c) 2010 Perttu Ahola <celeron55@gmail.com>
+Minetest-c55
+Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+
+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
+(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.
+
+You should have received a copy of the GNU 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.
 */
 
 #ifndef SERIALIZATION_HEADER
@@ -11,10 +26,15 @@
 #include "utility.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:
+                 
        0: original networked test with 1-byte nodes
        1: update with 2-byte nodes
        2: lighting is transmitted in param
@@ -23,27 +43,38 @@
        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
+       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
 */
 // This represents an uninitialized or invalid format
 #define SER_FMT_VER_INVALID 255
 // Highest supported serialization version
-#define SER_FMT_VER_HIGHEST 9
+#define SER_FMT_VER_HIGHEST 17
 // Lowest supported serialization version
 #define SER_FMT_VER_LOWEST 0
 
 #define ser_ver_supported(v) (v >= SER_FMT_VER_LOWEST && v <= SER_FMT_VER_HIGHEST)
 
+/*
+       Misc. serialization functions
+*/
+
+void compressZlib(SharedBuffer<u8> data, std::ostream &os);
+void compressZlib(const std::string &data, std::ostream &os);
+void decompressZlib(std::istream &is, std::ostream &os);
+
+// These choose between zlib and a self-made one according to version
 void compress(SharedBuffer<u8> 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