00001
00002
00003
00004
00005
00006
00007
00008
00009
00012 #ifndef SAVELOAD_H
00013 #define SAVELOAD_H
00014
00015 #include "../fileio_type.h"
00016
00017 #ifdef SIZE_MAX
00018 #undef SIZE_MAX
00019 #endif
00020
00021 #define SIZE_MAX ((size_t)-1)
00022
00024 enum SaveOrLoadResult {
00025 SL_OK = 0,
00026 SL_ERROR = 1,
00027 SL_REINIT = 2,
00028 };
00029
00031 enum SaveOrLoadMode {
00032 SL_INVALID = -1,
00033 SL_LOAD = 0,
00034 SL_SAVE = 1,
00035 SL_OLD_LOAD = 2,
00036 SL_PNG = 3,
00037 SL_BMP = 4,
00038 SL_LOAD_CHECK = 5,
00039 };
00040
00042 enum SavegameType {
00043 SGT_TTD,
00044 SGT_TTDP1,
00045 SGT_TTDP2,
00046 SGT_OTTD,
00047 SGT_TTO,
00048 SGT_INVALID = 0xFF
00049 };
00050
00051 void GenerateDefaultSaveName(char *buf, const char *last);
00052 void SetSaveLoadError(uint16 str);
00053 const char *GetSaveLoadErrorString();
00054 SaveOrLoadResult SaveOrLoad(const char *filename, int mode, Subdirectory sb, bool threaded = true);
00055 void WaitTillSaved();
00056 void DoExitSave();
00057
00058 SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded);
00059 SaveOrLoadResult LoadWithFilter(struct LoadFilter *reader);
00060
00061 typedef void ChunkSaveLoadProc();
00062 typedef void AutolengthProc(void *arg);
00063
00065 struct ChunkHandler {
00066 uint32 id;
00067 ChunkSaveLoadProc *save_proc;
00068 ChunkSaveLoadProc *load_proc;
00069 ChunkSaveLoadProc *ptrs_proc;
00070 ChunkSaveLoadProc *load_check_proc;
00071 uint32 flags;
00072 };
00073
00074 struct NullStruct {
00075 byte null;
00076 };
00077
00079 enum SLRefType {
00080 REF_ORDER = 0,
00081 REF_VEHICLE = 1,
00082 REF_STATION = 2,
00083 REF_TOWN = 3,
00084 REF_VEHICLE_OLD = 4,
00085 REF_ROADSTOPS = 5,
00086 REF_ENGINE_RENEWS = 6,
00087 REF_CARGO_PACKET = 7,
00088 REF_ORDERLIST = 8,
00089 };
00090
00092 #define SL_MAX_VERSION 255
00093
00095 enum ChunkType {
00096 CH_RIFF = 0,
00097 CH_ARRAY = 1,
00098 CH_SPARSE_ARRAY = 2,
00099 CH_TYPE_MASK = 3,
00100 CH_LAST = 8,
00101 CH_AUTO_LENGTH = 16,
00102 };
00103
00112 enum VarTypes {
00113
00114 SLE_FILE_I8 = 0,
00115 SLE_FILE_U8 = 1,
00116 SLE_FILE_I16 = 2,
00117 SLE_FILE_U16 = 3,
00118 SLE_FILE_I32 = 4,
00119 SLE_FILE_U32 = 5,
00120 SLE_FILE_I64 = 6,
00121 SLE_FILE_U64 = 7,
00122 SLE_FILE_STRINGID = 8,
00123 SLE_FILE_STRING = 9,
00124
00125
00126
00127 SLE_VAR_BL = 0 << 4,
00128 SLE_VAR_I8 = 1 << 4,
00129 SLE_VAR_U8 = 2 << 4,
00130 SLE_VAR_I16 = 3 << 4,
00131 SLE_VAR_U16 = 4 << 4,
00132 SLE_VAR_I32 = 5 << 4,
00133 SLE_VAR_U32 = 6 << 4,
00134 SLE_VAR_I64 = 7 << 4,
00135 SLE_VAR_U64 = 8 << 4,
00136 SLE_VAR_NULL = 9 << 4,
00137 SLE_VAR_STRB = 10 << 4,
00138 SLE_VAR_STRBQ = 11 << 4,
00139 SLE_VAR_STR = 12 << 4,
00140 SLE_VAR_STRQ = 13 << 4,
00141 SLE_VAR_NAME = 14 << 4,
00142
00143
00144
00145 SLE_VAR_CHAR = SLE_VAR_I8,
00146
00147
00148
00149
00150 SLE_BOOL = SLE_FILE_I8 | SLE_VAR_BL,
00151 SLE_INT8 = SLE_FILE_I8 | SLE_VAR_I8,
00152 SLE_UINT8 = SLE_FILE_U8 | SLE_VAR_U8,
00153 SLE_INT16 = SLE_FILE_I16 | SLE_VAR_I16,
00154 SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,
00155 SLE_INT32 = SLE_FILE_I32 | SLE_VAR_I32,
00156 SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,
00157 SLE_INT64 = SLE_FILE_I64 | SLE_VAR_I64,
00158 SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,
00159 SLE_CHAR = SLE_FILE_I8 | SLE_VAR_CHAR,
00160 SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,
00161 SLE_STRINGBUF = SLE_FILE_STRING | SLE_VAR_STRB,
00162 SLE_STRINGBQUOTE = SLE_FILE_STRING | SLE_VAR_STRBQ,
00163 SLE_STRING = SLE_FILE_STRING | SLE_VAR_STR,
00164 SLE_STRINGQUOTE = SLE_FILE_STRING | SLE_VAR_STRQ,
00165 SLE_NAME = SLE_FILE_STRINGID | SLE_VAR_NAME,
00166
00167
00168 SLE_UINT = SLE_UINT32,
00169 SLE_INT = SLE_INT32,
00170 SLE_STRB = SLE_STRINGBUF,
00171 SLE_STRBQ = SLE_STRINGBQUOTE,
00172 SLE_STR = SLE_STRING,
00173 SLE_STRQ = SLE_STRINGQUOTE,
00174
00175
00176
00177 SLF_SAVE_NO = 1 << 8,
00178 SLF_CONFIG_NO = 1 << 9,
00179 SLF_NETWORK_NO = 1 << 10,
00180
00181 };
00182
00183 typedef uint32 VarType;
00184
00186 enum SaveLoadTypes {
00187 SL_VAR = 0,
00188 SL_REF = 1,
00189 SL_ARR = 2,
00190 SL_STR = 3,
00191 SL_LST = 4,
00192
00193 SL_WRITEBYTE = 8,
00194 SL_VEH_INCLUDE = 9,
00195 SL_ST_INCLUDE = 10,
00196 SL_END = 15
00197 };
00198
00199 typedef byte SaveLoadType;
00200
00202 struct SaveLoad {
00203 bool global;
00204 SaveLoadType cmd;
00205 VarType conv;
00206 uint16 length;
00207 uint16 version_from;
00208 uint16 version_to;
00209
00210
00211
00212
00213 void *address;
00214 };
00215
00217 typedef SaveLoad SaveLoadGlobVarList;
00218
00229 #define SLE_GENERAL(cmd, base, variable, type, length, from, to) {false, cmd, type, length, from, to, (void*)cpp_offsetof(base, variable)}
00230
00239 #define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)
00240
00249 #define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)
00250
00260 #define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)
00261
00271 #define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)
00272
00281 #define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)
00282
00289 #define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, 0, SL_MAX_VERSION)
00290
00297 #define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, 0, SL_MAX_VERSION)
00298
00306 #define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, 0, SL_MAX_VERSION)
00307
00315 #define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, 0, SL_MAX_VERSION)
00316
00323 #define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, 0, SL_MAX_VERSION)
00324
00329 #define SLE_NULL(length) SLE_CONDNULL(length, 0, SL_MAX_VERSION)
00330
00337 #define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_CONFIG_NO, length, from, to)
00338
00340 #define SLE_WRITEBYTE(base, variable, value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, value, value)
00341
00342 #define SLE_VEH_INCLUDE() {false, SL_VEH_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00343 #define SLE_ST_INCLUDE() {false, SL_ST_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00344
00346 #define SLE_END() {false, SL_END, 0, 0, 0, 0, NULL}
00347
00357 #define SLEG_GENERAL(cmd, variable, type, length, from, to) {true, cmd, type, length, from, to, (void*)&variable}
00358
00366 #define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)
00367
00375 #define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)
00376
00385 #define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)
00386
00395 #define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)
00396
00404 #define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)
00405
00411 #define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, 0, SL_MAX_VERSION)
00412
00418 #define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, 0, SL_MAX_VERSION)
00419
00425 #define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00426
00432 #define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00433
00439 #define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, 0, SL_MAX_VERSION)
00440
00447 #define SLEG_CONDNULL(length, from, to) {true, SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_CONFIG_NO, length, from, to, (void*)NULL}
00448
00450 #define SLEG_END() {true, SL_END, 0, 0, 0, 0, NULL}
00451
00458 static inline bool IsSavegameVersionBefore(uint16 major, byte minor = 0)
00459 {
00460 extern uint16 _sl_version;
00461 extern byte _sl_minor_version;
00462 return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
00463 }
00464
00472 static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)
00473 {
00474 extern const uint16 SAVEGAME_VERSION;
00475 if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION > version_to) return false;
00476
00477 return true;
00478 }
00479
00486 static inline VarType GetVarMemType(VarType type)
00487 {
00488 return type & 0xF0;
00489 }
00490
00497 static inline VarType GetVarFileType(VarType type)
00498 {
00499 return type & 0xF;
00500 }
00501
00507 static inline bool IsNumericType(VarType conv)
00508 {
00509 return GetVarMemType(conv) <= SLE_VAR_U64;
00510 }
00511
00518 static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)
00519 {
00520 return (byte*)(sld->global ? NULL : object) + (ptrdiff_t)sld->address;
00521 }
00522
00523 int64 ReadValue(const void *ptr, VarType conv);
00524 void WriteValue(void *ptr, VarType conv, int64 val);
00525
00526 void SlSetArrayIndex(uint index);
00527 int SlIterateArray();
00528
00529 void SlAutolength(AutolengthProc *proc, void *arg);
00530 size_t SlGetFieldLength();
00531 void SlSetLength(size_t length);
00532 size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);
00533 size_t SlCalcObjLength(const void *object, const SaveLoad *sld);
00534
00535 byte SlReadByte();
00536 void SlWriteByte(byte b);
00537
00538 void SlGlobList(const SaveLoadGlobVarList *sldg);
00539 void SlArray(void *array, size_t length, VarType conv);
00540 void SlObject(void *object, const SaveLoad *sld);
00541 bool SlObjectMember(void *object, const SaveLoad *sld);
00542 void NORETURN SlErrorCorrupt(const char *msg);
00543
00544 bool SaveloadCrashWithMissingNewGRFs();
00545
00546 extern char _savegame_format[8];
00547 extern bool _do_autosave;
00548
00549 #endif