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
00019 enum SaveOrLoadResult {
00020 SL_OK = 0,
00021 SL_ERROR = 1,
00022 SL_REINIT = 2,
00023 };
00024
00026 enum SaveOrLoadMode {
00027 SL_INVALID = -1,
00028 SL_LOAD = 0,
00029 SL_SAVE = 1,
00030 SL_OLD_LOAD = 2,
00031 SL_PNG = 3,
00032 SL_BMP = 4,
00033 SL_LOAD_CHECK = 5,
00034 };
00035
00037 enum SavegameType {
00038 SGT_TTD,
00039 SGT_TTDP1,
00040 SGT_TTDP2,
00041 SGT_OTTD,
00042 SGT_TTO,
00043 SGT_INVALID = 0xFF,
00044 };
00045
00046 void GenerateDefaultSaveName(char *buf, const char *last);
00047 void SetSaveLoadError(uint16 str);
00048 const char *GetSaveLoadErrorString();
00049 SaveOrLoadResult SaveOrLoad(const char *filename, int mode, Subdirectory sb, bool threaded = true);
00050 void WaitTillSaved();
00051 void ProcessAsyncSaveFinish();
00052 void DoExitSave();
00053
00054 SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded);
00055 SaveOrLoadResult LoadWithFilter(struct LoadFilter *reader);
00056
00057 typedef void ChunkSaveLoadProc();
00058 typedef void AutolengthProc(void *arg);
00059
00061 struct ChunkHandler {
00062 uint32 id;
00063 ChunkSaveLoadProc *save_proc;
00064 ChunkSaveLoadProc *load_proc;
00065 ChunkSaveLoadProc *ptrs_proc;
00066 ChunkSaveLoadProc *load_check_proc;
00067 uint32 flags;
00068 };
00069
00070 struct NullStruct {
00071 byte null;
00072 };
00073
00075 enum SLRefType {
00076 REF_ORDER = 0,
00077 REF_VEHICLE = 1,
00078 REF_STATION = 2,
00079 REF_TOWN = 3,
00080 REF_VEHICLE_OLD = 4,
00081 REF_ROADSTOPS = 5,
00082 REF_ENGINE_RENEWS = 6,
00083 REF_CARGO_PACKET = 7,
00084 REF_ORDERLIST = 8,
00085 REF_STORAGE = 9,
00086 REF_LINK_GRAPH = 10,
00087 REF_LINK_GRAPH_JOB = 11,
00088 };
00089
00091 enum ChunkType {
00092 CH_RIFF = 0,
00093 CH_ARRAY = 1,
00094 CH_SPARSE_ARRAY = 2,
00095 CH_TYPE_MASK = 3,
00096 CH_LAST = 8,
00097 CH_AUTO_LENGTH = 16,
00098 };
00099
00108 enum VarTypes {
00109
00110 SLE_FILE_I8 = 0,
00111 SLE_FILE_U8 = 1,
00112 SLE_FILE_I16 = 2,
00113 SLE_FILE_U16 = 3,
00114 SLE_FILE_I32 = 4,
00115 SLE_FILE_U32 = 5,
00116 SLE_FILE_I64 = 6,
00117 SLE_FILE_U64 = 7,
00118 SLE_FILE_STRINGID = 8,
00119 SLE_FILE_STRING = 9,
00120
00121
00122
00123 SLE_VAR_BL = 0 << 4,
00124 SLE_VAR_I8 = 1 << 4,
00125 SLE_VAR_U8 = 2 << 4,
00126 SLE_VAR_I16 = 3 << 4,
00127 SLE_VAR_U16 = 4 << 4,
00128 SLE_VAR_I32 = 5 << 4,
00129 SLE_VAR_U32 = 6 << 4,
00130 SLE_VAR_I64 = 7 << 4,
00131 SLE_VAR_U64 = 8 << 4,
00132 SLE_VAR_NULL = 9 << 4,
00133 SLE_VAR_STRB = 10 << 4,
00134 SLE_VAR_STRBQ = 11 << 4,
00135 SLE_VAR_STR = 12 << 4,
00136 SLE_VAR_STRQ = 13 << 4,
00137 SLE_VAR_NAME = 14 << 4,
00138
00139
00140
00141 SLE_VAR_CHAR = SLE_VAR_I8,
00142
00143
00144
00145
00146 SLE_BOOL = SLE_FILE_I8 | SLE_VAR_BL,
00147 SLE_INT8 = SLE_FILE_I8 | SLE_VAR_I8,
00148 SLE_UINT8 = SLE_FILE_U8 | SLE_VAR_U8,
00149 SLE_INT16 = SLE_FILE_I16 | SLE_VAR_I16,
00150 SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,
00151 SLE_INT32 = SLE_FILE_I32 | SLE_VAR_I32,
00152 SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,
00153 SLE_INT64 = SLE_FILE_I64 | SLE_VAR_I64,
00154 SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,
00155 SLE_CHAR = SLE_FILE_I8 | SLE_VAR_CHAR,
00156 SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,
00157 SLE_STRINGBUF = SLE_FILE_STRING | SLE_VAR_STRB,
00158 SLE_STRINGBQUOTE = SLE_FILE_STRING | SLE_VAR_STRBQ,
00159 SLE_STRING = SLE_FILE_STRING | SLE_VAR_STR,
00160 SLE_STRINGQUOTE = SLE_FILE_STRING | SLE_VAR_STRQ,
00161 SLE_NAME = SLE_FILE_STRINGID | SLE_VAR_NAME,
00162
00163
00164 SLE_UINT = SLE_UINT32,
00165 SLE_INT = SLE_INT32,
00166 SLE_STRB = SLE_STRINGBUF,
00167 SLE_STRBQ = SLE_STRINGBQUOTE,
00168 SLE_STR = SLE_STRING,
00169 SLE_STRQ = SLE_STRINGQUOTE,
00170
00171
00172
00173 SLF_NOT_IN_SAVE = 1 << 8,
00174 SLF_NOT_IN_CONFIG = 1 << 9,
00175 SLF_NO_NETWORK_SYNC = 1 << 10,
00176 SLF_ALLOW_CONTROL = 1 << 11,
00177 SLF_ALLOW_NEWLINE = 1 << 12,
00178
00179 };
00180
00181 typedef uint32 VarType;
00182
00184 enum SaveLoadTypes {
00185 SL_VAR = 0,
00186 SL_REF = 1,
00187 SL_ARR = 2,
00188 SL_STR = 3,
00189 SL_LST = 4,
00190
00191 SL_WRITEBYTE = 8,
00192 SL_VEH_INCLUDE = 9,
00193 SL_ST_INCLUDE = 10,
00194 SL_END = 15
00195 };
00196
00197 typedef byte SaveLoadType;
00198
00200 struct SaveLoad {
00201 bool global;
00202 SaveLoadType cmd;
00203 VarType conv;
00204 uint16 length;
00205 uint16 version_from;
00206 uint16 version_to;
00207
00208
00209
00210
00211 void *address;
00212 };
00213
00215 typedef SaveLoad SaveLoadGlobVarList;
00216
00227 #define SLE_GENERAL(cmd, base, variable, type, length, from, to) {false, cmd, type, length, from, to, (void*)cpp_offsetof(base, variable)}
00228
00237 #define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)
00238
00247 #define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)
00248
00258 #define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)
00259
00269 #define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)
00270
00279 #define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)
00280
00287 #define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, 0, SL_MAX_VERSION)
00288
00295 #define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, 0, SL_MAX_VERSION)
00296
00304 #define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, 0, SL_MAX_VERSION)
00305
00313 #define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, 0, SL_MAX_VERSION)
00314
00321 #define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, 0, SL_MAX_VERSION)
00322
00327 #define SLE_NULL(length) SLE_CONDNULL(length, 0, SL_MAX_VERSION)
00328
00335 #define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to)
00336
00338 #define SLE_WRITEBYTE(base, variable, value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, value, value)
00339
00340 #define SLE_VEH_INCLUDE() {false, SL_VEH_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00341 #define SLE_ST_INCLUDE() {false, SL_ST_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00342
00344 #define SLE_END() {false, SL_END, 0, 0, 0, 0, NULL}
00345
00355 #define SLEG_GENERAL(cmd, variable, type, length, from, to) {true, cmd, type, length, from, to, (void*)&variable}
00356
00364 #define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)
00365
00373 #define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)
00374
00383 #define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)
00384
00393 #define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)
00394
00402 #define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)
00403
00409 #define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, 0, SL_MAX_VERSION)
00410
00416 #define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, 0, SL_MAX_VERSION)
00417
00423 #define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00424
00430 #define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00431
00437 #define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, 0, SL_MAX_VERSION)
00438
00445 #define SLEG_CONDNULL(length, from, to) {true, SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to, (void*)NULL}
00446
00448 #define SLEG_END() {true, SL_END, 0, 0, 0, 0, NULL}
00449
00456 static inline bool IsSavegameVersionBefore(uint16 major, byte minor = 0)
00457 {
00458 extern uint16 _sl_version;
00459 extern byte _sl_minor_version;
00460 return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
00461 }
00462
00470 static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)
00471 {
00472 extern const uint16 SAVEGAME_VERSION;
00473 if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION > version_to) return false;
00474
00475 return true;
00476 }
00477
00484 static inline VarType GetVarMemType(VarType type)
00485 {
00486 return type & 0xF0;
00487 }
00488
00495 static inline VarType GetVarFileType(VarType type)
00496 {
00497 return type & 0xF;
00498 }
00499
00505 static inline bool IsNumericType(VarType conv)
00506 {
00507 return GetVarMemType(conv) <= SLE_VAR_U64;
00508 }
00509
00516 static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)
00517 {
00518 return const_cast<byte *>((const byte*)(sld->global ? NULL : object) + (ptrdiff_t)sld->address);
00519 }
00520
00521 int64 ReadValue(const void *ptr, VarType conv);
00522 void WriteValue(void *ptr, VarType conv, int64 val);
00523
00524 void SlSetArrayIndex(uint index);
00525 int SlIterateArray();
00526
00527 void SlAutolength(AutolengthProc *proc, void *arg);
00528 size_t SlGetFieldLength();
00529 void SlSetLength(size_t length);
00530 size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);
00531 size_t SlCalcObjLength(const void *object, const SaveLoad *sld);
00532
00533 byte SlReadByte();
00534 void SlWriteByte(byte b);
00535
00536 void SlGlobList(const SaveLoadGlobVarList *sldg);
00537 void SlArray(void *array, size_t length, VarType conv);
00538 void SlObject(void *object, const SaveLoad *sld);
00539 bool SlObjectMember(void *object, const SaveLoad *sld);
00540 void NORETURN SlError(StringID string, const char *extra_msg = NULL);
00541 void NORETURN SlErrorCorrupt(const char *msg);
00542
00543 bool SaveloadCrashWithMissingNewGRFs();
00544
00545 extern char _savegame_format[8];
00546 extern bool _do_autosave;
00547
00552 enum SaveLoadVersions {
00553 SL_TRUNK = 181,
00554 SL_COMPONENTS,
00555 SL_CAPACITIES,
00556 SL_DEMANDS,
00557 SL_MCF,
00558 SL_FLOWMAP,
00559 SL_CARGOMAP,
00560 SL_EXT_RATING,
00561
00563 SL_MAX_VERSION = 255
00564 };
00565
00566 #endif