00001
00002
00003
00004
00005
00006
00007
00008
00009
00012 #ifndef SAVELOAD_H
00013 #define SAVELOAD_H
00014
00015 #include "../fileio_type.h"
00016 #include "../strings_type.h"
00017
00018 #ifdef SIZE_MAX
00019 #undef SIZE_MAX
00020 #endif
00021
00022 #define SIZE_MAX ((size_t)-1)
00023
00025 enum SaveOrLoadResult {
00026 SL_OK = 0,
00027 SL_ERROR = 1,
00028 SL_REINIT = 2,
00029 };
00030
00032 enum SaveOrLoadMode {
00033 SL_INVALID = -1,
00034 SL_LOAD = 0,
00035 SL_SAVE = 1,
00036 SL_OLD_LOAD = 2,
00037 SL_PNG = 3,
00038 SL_BMP = 4,
00039 SL_LOAD_CHECK = 5,
00040 };
00041
00043 enum SavegameType {
00044 SGT_TTD,
00045 SGT_TTDP1,
00046 SGT_TTDP2,
00047 SGT_OTTD,
00048 SGT_TTO,
00049 SGT_INVALID = 0xFF
00050 };
00051
00052 void GenerateDefaultSaveName(char *buf, const char *last);
00053 void SetSaveLoadError(uint16 str);
00054 const char *GetSaveLoadErrorString();
00055 SaveOrLoadResult SaveOrLoad(const char *filename, int mode, Subdirectory sb, bool threaded = true);
00056 void WaitTillSaved();
00057 void ProcessAsyncSaveFinish();
00058 void DoExitSave();
00059
00060 SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded);
00061 SaveOrLoadResult LoadWithFilter(struct LoadFilter *reader);
00062
00063 typedef void ChunkSaveLoadProc();
00064 typedef void AutolengthProc(void *arg);
00065
00067 struct ChunkHandler {
00068 uint32 id;
00069 ChunkSaveLoadProc *save_proc;
00070 ChunkSaveLoadProc *load_proc;
00071 ChunkSaveLoadProc *ptrs_proc;
00072 ChunkSaveLoadProc *load_check_proc;
00073 uint32 flags;
00074 };
00075
00076 struct NullStruct {
00077 byte null;
00078 };
00079
00081 enum SLRefType {
00082 REF_ORDER = 0,
00083 REF_VEHICLE = 1,
00084 REF_STATION = 2,
00085 REF_TOWN = 3,
00086 REF_VEHICLE_OLD = 4,
00087 REF_ROADSTOPS = 5,
00088 REF_ENGINE_RENEWS = 6,
00089 REF_CARGO_PACKET = 7,
00090 REF_ORDERLIST = 8,
00091 };
00092
00096 enum SaveLoadVersions {
00097 BEFORE_ADDING_PATCHES_SL = 185,
00098 BACK_ONE_WAY_SIGNAL_SAFE_WAITING_SL = 186,
00099 TREE_GROWTH_RATE_SL = 188,
00100 PROG_SIGS_SL = 189,
00101 DAYLENGHT_SL = 190,
00102 TOWN_CARGO_FACTOR_SL = 191,
00103 SL_RESERVATION = 192,
00104 SL_CAPACITIES = 193,
00105 SL_COMPONENTS = 194,
00106 SL_DEMANDS = 195,
00107 SL_MCF = 196,
00108 SL_FLOWMAP = 197,
00109 SL_CARGOMAP = 198,
00110 SL_EXT_RATING = 199,
00111 TIMESEP_SV = 200,
00112 MORE_HEIGHTLEVEL_SAVEGAME_VERSION = 201,
00113 KEEP_COMPATIBLE_1_SV = 202,
00114 KEEP_COMPATIBLE_2_SV = 203,
00115 KEEP_COMPATIBLE_3_SV = 204,
00116 KEEP_COMPATIBLE_4_SV = 205,
00117 KEEP_COMPATIBLE_5_SV = 206,
00118 KEEP_COMPATIBLE_6_SV = 206,
00119 KEEP_COMPATIBLE_7_SV = 206,
00120 KEEP_COMPATIBLE_8_SV = 207,
00121 INGAME_TREELINE_SV = 208,
00122 KEEP_COMPATIBLE_9_SV = 209,
00123 KEEP_COMPATIBLE_10_SV = 210,
00124 KEEP_COMPATIBLE_11_SV = 210,
00125 IS_SL = 211,
00126 EXCLUSIVE_DL_SL = 212,
00127 KEEP_COMPATIBLE_12_SV = 213,
00128 KEEP_COMPATIBLE_13_SV = 214,
00129 KEEP_COMPATIBLE_14_SV = 215,
00130 KEEP_COMPATIBLE_15_SV = 216,
00131 KEEP_COMPATIBLE_16_SV = 217,
00132 KEEP_COMPATIBLE_17_SV = 218,
00133 KEEP_COMPATIBLE_18_SV = 219,
00134 KEEP_COMPATIBLE_19_SV = 220,
00135 KEEP_COMPATIBLE_20_SV = 221,
00136 SL_IB = 222,
00137 TL_SV = 223,
00138 TOWN_GROWTH_SV = 224,
00139 DESERT_SV = 225,
00140 KEEP_COMPATIBLE_21_SV = 226,
00141 SPEED_SIGNALS_SV = 227,
00142 KEEP_COMPATIBLE_22_SV = 228,
00143 KEEP_COMPATIBLE_23_SV = 229,
00144 KEEP_COMPATIBLE_24_SV = 230,
00145 TREEDRAG_SV = 231,
00146 INFRA_MAINT_SV = 232,
00147
00149 SL_MAX_VERSION = 255
00150 };
00151
00153 enum ChunkType {
00154 CH_RIFF = 0,
00155 CH_ARRAY = 1,
00156 CH_SPARSE_ARRAY = 2,
00157 CH_TYPE_MASK = 3,
00158 CH_LAST = 8,
00159 CH_AUTO_LENGTH = 16,
00160 };
00161
00170 enum VarTypes {
00171
00172 SLE_FILE_I8 = 0,
00173 SLE_FILE_U8 = 1,
00174 SLE_FILE_I16 = 2,
00175 SLE_FILE_U16 = 3,
00176 SLE_FILE_I32 = 4,
00177 SLE_FILE_U32 = 5,
00178 SLE_FILE_I64 = 6,
00179 SLE_FILE_U64 = 7,
00180 SLE_FILE_STRINGID = 8,
00181 SLE_FILE_STRING = 9,
00182
00183
00184
00185 SLE_VAR_BL = 0 << 4,
00186 SLE_VAR_I8 = 1 << 4,
00187 SLE_VAR_U8 = 2 << 4,
00188 SLE_VAR_I16 = 3 << 4,
00189 SLE_VAR_U16 = 4 << 4,
00190 SLE_VAR_I32 = 5 << 4,
00191 SLE_VAR_U32 = 6 << 4,
00192 SLE_VAR_I64 = 7 << 4,
00193 SLE_VAR_U64 = 8 << 4,
00194 SLE_VAR_NULL = 9 << 4,
00195 SLE_VAR_STRB = 10 << 4,
00196 SLE_VAR_STRBQ = 11 << 4,
00197 SLE_VAR_STR = 12 << 4,
00198 SLE_VAR_STRQ = 13 << 4,
00199 SLE_VAR_NAME = 14 << 4,
00200
00201
00202
00203 SLE_VAR_CHAR = SLE_VAR_I8,
00204
00205
00206
00207
00208 SLE_BOOL = SLE_FILE_I8 | SLE_VAR_BL,
00209 SLE_INT8 = SLE_FILE_I8 | SLE_VAR_I8,
00210 SLE_UINT8 = SLE_FILE_U8 | SLE_VAR_U8,
00211 SLE_INT16 = SLE_FILE_I16 | SLE_VAR_I16,
00212 SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,
00213 SLE_INT32 = SLE_FILE_I32 | SLE_VAR_I32,
00214 SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,
00215 SLE_INT64 = SLE_FILE_I64 | SLE_VAR_I64,
00216 SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,
00217 SLE_CHAR = SLE_FILE_I8 | SLE_VAR_CHAR,
00218 SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,
00219 SLE_STRINGBUF = SLE_FILE_STRING | SLE_VAR_STRB,
00220 SLE_STRINGBQUOTE = SLE_FILE_STRING | SLE_VAR_STRBQ,
00221 SLE_STRING = SLE_FILE_STRING | SLE_VAR_STR,
00222 SLE_STRINGQUOTE = SLE_FILE_STRING | SLE_VAR_STRQ,
00223 SLE_NAME = SLE_FILE_STRINGID | SLE_VAR_NAME,
00224
00225
00226 SLE_UINT = SLE_UINT32,
00227 SLE_INT = SLE_INT32,
00228 SLE_STRB = SLE_STRINGBUF,
00229 SLE_STRBQ = SLE_STRINGBQUOTE,
00230 SLE_STR = SLE_STRING,
00231 SLE_STRQ = SLE_STRINGQUOTE,
00232
00233
00234
00235 SLF_NOT_IN_SAVE = 1 << 8,
00236 SLF_NOT_IN_CONFIG = 1 << 9,
00237 SLF_NO_NETWORK_SYNC = 1 << 10,
00238
00239 };
00240
00241 typedef uint32 VarType;
00242
00244 enum SaveLoadTypes {
00245 SL_VAR = 0,
00246 SL_REF = 1,
00247 SL_ARR = 2,
00248 SL_STR = 3,
00249 SL_LST = 4,
00250
00251 SL_WRITEBYTE = 8,
00252 SL_VEH_INCLUDE = 9,
00253 SL_ST_INCLUDE = 10,
00254 SL_END = 15
00255 };
00256
00257 typedef byte SaveLoadType;
00258
00260 struct SaveLoad {
00261 bool global;
00262 SaveLoadType cmd;
00263 VarType conv;
00264 uint16 length;
00265 uint16 version_from;
00266 uint16 version_to;
00267
00268
00269
00270
00271 void *address;
00272 };
00273
00275 typedef SaveLoad SaveLoadGlobVarList;
00276
00287 #define SLE_GENERAL(cmd, base, variable, type, length, from, to) {false, cmd, type, length, from, to, (void*)cpp_offsetof(base, variable)}
00288
00297 #define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)
00298
00307 #define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)
00308
00318 #define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)
00319
00329 #define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)
00330
00339 #define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)
00340
00347 #define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, 0, SL_MAX_VERSION)
00348
00355 #define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, 0, SL_MAX_VERSION)
00356
00364 #define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, 0, SL_MAX_VERSION)
00365
00373 #define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, 0, SL_MAX_VERSION)
00374
00381 #define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, 0, SL_MAX_VERSION)
00382
00387 #define SLE_NULL(length) SLE_CONDNULL(length, 0, SL_MAX_VERSION)
00388
00395 #define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to)
00396
00398 #define SLE_WRITEBYTE(base, variable, value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, value, value)
00399
00400 #define SLE_VEH_INCLUDE() {false, SL_VEH_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00401 #define SLE_ST_INCLUDE() {false, SL_ST_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00402
00404 #define SLE_END() {false, SL_END, 0, 0, 0, 0, NULL}
00405
00415 #define SLEG_GENERAL(cmd, variable, type, length, from, to) {true, cmd, type, length, from, to, (void*)&variable}
00416
00424 #define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)
00425
00433 #define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)
00434
00443 #define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)
00444
00453 #define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)
00454
00462 #define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)
00463
00469 #define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, 0, SL_MAX_VERSION)
00470
00476 #define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, 0, SL_MAX_VERSION)
00477
00483 #define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00484
00490 #define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00491
00497 #define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, 0, SL_MAX_VERSION)
00498
00505 #define SLEG_CONDNULL(length, from, to) {true, SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to, (void*)NULL}
00506
00508 #define SLEG_END() {true, SL_END, 0, 0, 0, 0, NULL}
00509
00516 static inline bool IsSavegameVersionBefore(uint16 major, byte minor = 0)
00517 {
00518 extern uint16 _sl_version;
00519 extern byte _sl_minor_version;
00520 return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
00521 }
00522
00530 static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)
00531 {
00532 extern const uint16 SAVEGAME_VERSION;
00533 if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION > version_to) return false;
00534
00535 return true;
00536 }
00537
00544 static inline VarType GetVarMemType(VarType type)
00545 {
00546 return type & 0xF0;
00547 }
00548
00555 static inline VarType GetVarFileType(VarType type)
00556 {
00557 return type & 0xF;
00558 }
00559
00565 static inline bool IsNumericType(VarType conv)
00566 {
00567 return GetVarMemType(conv) <= SLE_VAR_U64;
00568 }
00569
00576 static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)
00577 {
00578 return (byte*)(sld->global ? NULL : object) + (ptrdiff_t)sld->address;
00579 }
00580
00581 int64 ReadValue(const void *ptr, VarType conv);
00582 void WriteValue(void *ptr, VarType conv, int64 val);
00583
00584 void SlSetArrayIndex(uint index);
00585 int SlIterateArray();
00586
00587 void SlAutolength(AutolengthProc *proc, void *arg);
00588 size_t SlGetFieldLength();
00589 void SlSetLength(size_t length);
00590 size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);
00591 size_t SlCalcObjLength(const void *object, const SaveLoad *sld);
00592
00593 byte SlReadByte();
00594 void SlWriteByte(byte b);
00595
00596 void SlGlobList(const SaveLoadGlobVarList *sldg);
00597 void SlArray(void *array, size_t length, VarType conv);
00598 void SlObject(void *object, const SaveLoad *sld);
00599 bool SlObjectMember(void *object, const SaveLoad *sld);
00600 void NORETURN SlError(StringID string, const char *extra_msg = NULL);
00601 void NORETURN SlErrorCorrupt(const char *msg);
00602
00603 bool SaveloadCrashWithMissingNewGRFs();
00604
00605 extern char _savegame_format[8];
00606 extern bool _do_autosave;
00607
00608 #endif