# saveload.h

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * OpenTTD 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, version 2.
    00006  * OpenTTD 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.
    00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
    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
    00094 #define SL_MAX_VERSION 255
    00095
    00097 enum ChunkType {
    00098   CH_RIFF         =  0,
    00099   CH_ARRAY        =  1,
    00100   CH_SPARSE_ARRAY =  2,
    00101   CH_TYPE_MASK    =  3,
    00102   CH_LAST         =  8,
    00103   CH_AUTO_LENGTH  = 16,
    00104 };
    00105
    00114 enum VarTypes {
    00115   /* 4 bits allocated a maximum of 16 types for NumberType */
    00116   SLE_FILE_I8       = 0,
    00117   SLE_FILE_U8       = 1,
    00118   SLE_FILE_I16      = 2,
    00119   SLE_FILE_U16      = 3,
    00120   SLE_FILE_I32      = 4,
    00121   SLE_FILE_U32      = 5,
    00122   SLE_FILE_I64      = 6,
    00123   SLE_FILE_U64      = 7,
    00124   SLE_FILE_STRINGID = 8,
    00125   SLE_FILE_STRING   = 9,
    00126   /* 6 more possible file-primitives */
    00127
    00128   /* 4 bits allocated a maximum of 16 types for NumberType */
    00129   SLE_VAR_BL    =  0 << 4,
    00130   SLE_VAR_I8    =  1 << 4,
    00131   SLE_VAR_U8    =  2 << 4,
    00132   SLE_VAR_I16   =  3 << 4,
    00133   SLE_VAR_U16   =  4 << 4,
    00134   SLE_VAR_I32   =  5 << 4,
    00135   SLE_VAR_U32   =  6 << 4,
    00136   SLE_VAR_I64   =  7 << 4,
    00137   SLE_VAR_U64   =  8 << 4,
    00138   SLE_VAR_NULL  =  9 << 4,
    00139   SLE_VAR_STRB  = 10 << 4,
    00140   SLE_VAR_STRBQ = 11 << 4,
    00141   SLE_VAR_STR   = 12 << 4,
    00142   SLE_VAR_STRQ  = 13 << 4,
    00143   SLE_VAR_NAME  = 14 << 4,
    00144   /* 1 more possible memory-primitives */
    00145
    00146   /* Shortcut values */
    00147   SLE_VAR_CHAR = SLE_VAR_I8,
    00148
    00149   /* Default combinations of variables. As savegames change, so can variables
    00150    * and thus it is possible that the saved value and internal size do not
    00151    * match and you need to specify custom combo. The defaults are listed here */
    00152   SLE_BOOL         = SLE_FILE_I8  | SLE_VAR_BL,
    00153   SLE_INT8         = SLE_FILE_I8  | SLE_VAR_I8,
    00154   SLE_UINT8        = SLE_FILE_U8  | SLE_VAR_U8,
    00155   SLE_INT16        = SLE_FILE_I16 | SLE_VAR_I16,
    00156   SLE_UINT16       = SLE_FILE_U16 | SLE_VAR_U16,
    00157   SLE_INT32        = SLE_FILE_I32 | SLE_VAR_I32,
    00158   SLE_UINT32       = SLE_FILE_U32 | SLE_VAR_U32,
    00159   SLE_INT64        = SLE_FILE_I64 | SLE_VAR_I64,
    00160   SLE_UINT64       = SLE_FILE_U64 | SLE_VAR_U64,
    00161   SLE_CHAR         = SLE_FILE_I8  | SLE_VAR_CHAR,
    00162   SLE_STRINGID     = SLE_FILE_STRINGID | SLE_VAR_U16,
    00163   SLE_STRINGBUF    = SLE_FILE_STRING   | SLE_VAR_STRB,
    00164   SLE_STRINGBQUOTE = SLE_FILE_STRING   | SLE_VAR_STRBQ,
    00165   SLE_STRING       = SLE_FILE_STRING   | SLE_VAR_STR,
    00166   SLE_STRINGQUOTE  = SLE_FILE_STRING   | SLE_VAR_STRQ,
    00167   SLE_NAME         = SLE_FILE_STRINGID | SLE_VAR_NAME,
    00168
    00169   /* Shortcut values */
    00170   SLE_UINT  = SLE_UINT32,
    00171   SLE_INT   = SLE_INT32,
    00172   SLE_STRB  = SLE_STRINGBUF,
    00173   SLE_STRBQ = SLE_STRINGBQUOTE,
    00174   SLE_STR   = SLE_STRING,
    00175   SLE_STRQ  = SLE_STRINGQUOTE,
    00176
    00177   /* 8 bits allocated for a maximum of 8 flags
    00178    * Flags directing saving/loading of a variable */
    00179   SLF_SAVE_NO      = 1 <<  8,
    00180   SLF_CONFIG_NO    = 1 <<  9,
    00181   SLF_NETWORK_NO   = 1 << 10,
    00182   /* 5 more possible flags */
    00183 };
    00184
    00185 typedef uint32 VarType;
    00186
    00188 enum SaveLoadTypes {
    00189   SL_VAR         =  0,
    00190   SL_REF         =  1,
    00191   SL_ARR         =  2,
    00192   SL_STR         =  3,
    00193   SL_LST         =  4,
    00194   /* non-normal save-load types */
    00195   SL_WRITEBYTE   =  8,
    00196   SL_VEH_INCLUDE =  9,
    00197   SL_ST_INCLUDE  = 10,
    00198   SL_END         = 15
    00199 };
    00200
    00201 typedef byte SaveLoadType;
    00202
    00204 struct SaveLoad {
    00205   bool global;
    00206   SaveLoadType cmd;
    00207   VarType conv;
    00208   uint16 length;
    00209   uint16 version_from;
    00210   uint16 version_to;
    00211   /* NOTE: This element either denotes the address of the variable for a global
    00212    * variable, or the offset within a struct which is then bound to a variable
    00213    * during runtime. Decision on which one to use is controlled by the function
    00214    * that is called to save it. address: global=true, offset: global=false */
    00215   void *address;
    00216 };
    00217
    00219 typedef SaveLoad SaveLoadGlobVarList;
    00220
    00231 #define SLE_GENERAL(cmd, base, variable, type, length, from, to) {false, cmd, type, length, from, to, (void*)cpp_offsetof(base, variable)}
    00232
    00241 #define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)
    00242
    00251 #define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)
    00252
    00262 #define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)
    00263
    00273 #define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)
    00274
    00283 #define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)
    00284
    00291 #define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, 0, SL_MAX_VERSION)
    00292
    00299 #define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, 0, SL_MAX_VERSION)
    00300
    00308 #define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, 0, SL_MAX_VERSION)
    00309
    00317 #define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, 0, SL_MAX_VERSION)
    00318
    00325 #define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, 0, SL_MAX_VERSION)
    00326
    00331 #define SLE_NULL(length) SLE_CONDNULL(length, 0, SL_MAX_VERSION)
    00332
    00339 #define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_CONFIG_NO, length, from, to)
    00340
    00342 #define SLE_WRITEBYTE(base, variable, value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, value, value)
    00343
    00344 #define SLE_VEH_INCLUDE() {false, SL_VEH_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
    00345 #define SLE_ST_INCLUDE() {false, SL_ST_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
    00346
    00348 #define SLE_END() {false, SL_END, 0, 0, 0, 0, NULL}
    00349
    00359 #define SLEG_GENERAL(cmd, variable, type, length, from, to) {true, cmd, type, length, from, to, (void*)&variable}
    00360
    00368 #define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)
    00369
    00377 #define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)
    00378
    00387 #define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)
    00388
    00397 #define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)
    00398
    00406 #define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)
    00407
    00413 #define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, 0, SL_MAX_VERSION)
    00414
    00420 #define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, 0, SL_MAX_VERSION)
    00421
    00427 #define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
    00428
    00434 #define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
    00435
    00441 #define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, 0, SL_MAX_VERSION)
    00442
    00449 #define SLEG_CONDNULL(length, from, to) {true, SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_CONFIG_NO, length, from, to, (void*)NULL}
    00450
    00452 #define SLEG_END() {true, SL_END, 0, 0, 0, 0, NULL}
    00453
    00460 static inline bool IsSavegameVersionBefore(uint16 major, byte minor = 0)
    00461 {
    00462   extern uint16 _sl_version;
    00463   extern byte   _sl_minor_version;
    00464   return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
    00465 }
    00466
    00474 static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)
    00475 {
    00476   extern const uint16 SAVEGAME_VERSION;
    00477   if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION > version_to) return false;
    00478
    00479   return true;
    00480 }
    00481
    00488 static inline VarType GetVarMemType(VarType type)
    00489 {
    00490   return type & 0xF0; // GB(type, 4, 4) << 4;
    00491 }
    00492
    00499 static inline VarType GetVarFileType(VarType type)
    00500 {
    00501   return type & 0xF; // GB(type, 0, 4);
    00502 }
    00503
    00509 static inline bool IsNumericType(VarType conv)
    00510 {
    00511   return GetVarMemType(conv) <= SLE_VAR_U64;
    00512 }
    00513
    00520 static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)
    00521 {
    00522   return (byte*)(sld->global ? NULL : object) + (ptrdiff_t)sld->address;
    00523 }
    00524
    00525 int64 ReadValue(const void *ptr, VarType conv);
    00526 void WriteValue(void *ptr, VarType conv, int64 val);
    00527
    00528 void SlSetArrayIndex(uint index);
    00529 int SlIterateArray();
    00530
    00531 void SlAutolength(AutolengthProc *proc, void *arg);
    00532 size_t SlGetFieldLength();
    00533 void SlSetLength(size_t length);
    00534 size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);
    00535 size_t SlCalcObjLength(const void *object, const SaveLoad *sld);
    00536
    00537 byte SlReadByte();
    00538 void SlWriteByte(byte b);
    00539
    00540 void SlGlobList(const SaveLoadGlobVarList *sldg);
    00541 void SlArray(void *array, size_t length, VarType conv);
    00542 void SlObject(void *object, const SaveLoad *sld);
    00543 bool SlObjectMember(void *object, const SaveLoad *sld);
    00544 void NORETURN SlError(StringID string, const char *extra_msg = NULL);
    00545 void NORETURN SlErrorCorrupt(const char *msg);
    00546
    00547 bool SaveloadCrashWithMissingNewGRFs();
    00548
    00549 extern char _savegame_format[8];
    00550 extern bool _do_autosave;
    00551
    00552 #endif /* SAVELOAD_H */