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 
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 };
00087 
00089 enum ChunkType {
00090   CH_RIFF         =  0,
00091   CH_ARRAY        =  1,
00092   CH_SPARSE_ARRAY =  2,
00093   CH_TYPE_MASK    =  3,
00094   CH_LAST         =  8, 
00095   CH_AUTO_LENGTH  = 16,
00096 };
00097 
00106 enum VarTypes {
00107   /* 4 bits allocated a maximum of 16 types for NumberType */
00108   SLE_FILE_I8       = 0,
00109   SLE_FILE_U8       = 1,
00110   SLE_FILE_I16      = 2,
00111   SLE_FILE_U16      = 3,
00112   SLE_FILE_I32      = 4,
00113   SLE_FILE_U32      = 5,
00114   SLE_FILE_I64      = 6,
00115   SLE_FILE_U64      = 7,
00116   SLE_FILE_STRINGID = 8, 
00117   SLE_FILE_STRING   = 9,
00118   /* 6 more possible file-primitives */
00119 
00120   /* 4 bits allocated a maximum of 16 types for NumberType */
00121   SLE_VAR_BL    =  0 << 4,
00122   SLE_VAR_I8    =  1 << 4,
00123   SLE_VAR_U8    =  2 << 4,
00124   SLE_VAR_I16   =  3 << 4,
00125   SLE_VAR_U16   =  4 << 4,
00126   SLE_VAR_I32   =  5 << 4,
00127   SLE_VAR_U32   =  6 << 4,
00128   SLE_VAR_I64   =  7 << 4,
00129   SLE_VAR_U64   =  8 << 4,
00130   SLE_VAR_NULL  =  9 << 4, 
00131   SLE_VAR_STRB  = 10 << 4, 
00132   SLE_VAR_STRBQ = 11 << 4, 
00133   SLE_VAR_STR   = 12 << 4, 
00134   SLE_VAR_STRQ  = 13 << 4, 
00135   SLE_VAR_NAME  = 14 << 4, 
00136   /* 1 more possible memory-primitives */
00137 
00138   /* Shortcut values */
00139   SLE_VAR_CHAR = SLE_VAR_I8,
00140 
00141   /* Default combinations of variables. As savegames change, so can variables
00142    * and thus it is possible that the saved value and internal size do not
00143    * match and you need to specify custom combo. The defaults are listed here */
00144   SLE_BOOL         = SLE_FILE_I8  | SLE_VAR_BL,
00145   SLE_INT8         = SLE_FILE_I8  | SLE_VAR_I8,
00146   SLE_UINT8        = SLE_FILE_U8  | SLE_VAR_U8,
00147   SLE_INT16        = SLE_FILE_I16 | SLE_VAR_I16,
00148   SLE_UINT16       = SLE_FILE_U16 | SLE_VAR_U16,
00149   SLE_INT32        = SLE_FILE_I32 | SLE_VAR_I32,
00150   SLE_UINT32       = SLE_FILE_U32 | SLE_VAR_U32,
00151   SLE_INT64        = SLE_FILE_I64 | SLE_VAR_I64,
00152   SLE_UINT64       = SLE_FILE_U64 | SLE_VAR_U64,
00153   SLE_CHAR         = SLE_FILE_I8  | SLE_VAR_CHAR,
00154   SLE_STRINGID     = SLE_FILE_STRINGID | SLE_VAR_U16,
00155   SLE_STRINGBUF    = SLE_FILE_STRING   | SLE_VAR_STRB,
00156   SLE_STRINGBQUOTE = SLE_FILE_STRING   | SLE_VAR_STRBQ,
00157   SLE_STRING       = SLE_FILE_STRING   | SLE_VAR_STR,
00158   SLE_STRINGQUOTE  = SLE_FILE_STRING   | SLE_VAR_STRQ,
00159   SLE_NAME         = SLE_FILE_STRINGID | SLE_VAR_NAME,
00160 
00161   /* Shortcut values */
00162   SLE_UINT  = SLE_UINT32,
00163   SLE_INT   = SLE_INT32,
00164   SLE_STRB  = SLE_STRINGBUF,
00165   SLE_STRBQ = SLE_STRINGBQUOTE,
00166   SLE_STR   = SLE_STRING,
00167   SLE_STRQ  = SLE_STRINGQUOTE,
00168 
00169   /* 8 bits allocated for a maximum of 8 flags
00170    * Flags directing saving/loading of a variable */
00171   SLF_NOT_IN_SAVE     = 1 <<  8, 
00172   SLF_NOT_IN_CONFIG   = 1 <<  9, 
00173   SLF_NO_NETWORK_SYNC = 1 << 10, 
00174   /* 5 more possible flags */
00175 };
00176 
00177 typedef uint32 VarType;
00178 
00180 enum SaveLoadTypes {
00181   SL_VAR         =  0, 
00182   SL_REF         =  1, 
00183   SL_ARR         =  2, 
00184   SL_STR         =  3, 
00185   SL_LST         =  4, 
00186   /* non-normal save-load types */
00187   SL_WRITEBYTE   =  8,
00188   SL_VEH_INCLUDE =  9,
00189   SL_ST_INCLUDE  = 10,
00190   SL_END         = 15
00191 };
00192 
00193 typedef byte SaveLoadType; 
00194 
00196 struct SaveLoad {
00197   bool global;         
00198   SaveLoadType cmd;    
00199   VarType conv;        
00200   uint16 length;       
00201   uint16 version_from; 
00202   uint16 version_to;   
00203   /* NOTE: This element either denotes the address of the variable for a global
00204    * variable, or the offset within a struct which is then bound to a variable
00205    * during runtime. Decision on which one to use is controlled by the function
00206    * that is called to save it. address: global=true, offset: global=false */
00207   void *address;       
00208 };
00209 
00211 typedef SaveLoad SaveLoadGlobVarList;
00212 
00223 #define SLE_GENERAL(cmd, base, variable, type, length, from, to) {false, cmd, type, length, from, to, (void*)cpp_offsetof(base, variable)}
00224 
00233 #define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)
00234 
00243 #define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)
00244 
00254 #define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)
00255 
00265 #define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)
00266 
00275 #define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)
00276 
00283 #define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, 0, SL_MAX_VERSION)
00284 
00291 #define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, 0, SL_MAX_VERSION)
00292 
00300 #define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, 0, SL_MAX_VERSION)
00301 
00309 #define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, 0, SL_MAX_VERSION)
00310 
00317 #define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, 0, SL_MAX_VERSION)
00318 
00323 #define SLE_NULL(length) SLE_CONDNULL(length, 0, SL_MAX_VERSION)
00324 
00331 #define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to)
00332 
00334 #define SLE_WRITEBYTE(base, variable, value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, value, value)
00335 
00336 #define SLE_VEH_INCLUDE() {false, SL_VEH_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00337 #define SLE_ST_INCLUDE() {false, SL_ST_INCLUDE, 0, 0, 0, SL_MAX_VERSION, NULL}
00338 
00340 #define SLE_END() {false, SL_END, 0, 0, 0, 0, NULL}
00341 
00351 #define SLEG_GENERAL(cmd, variable, type, length, from, to) {true, cmd, type, length, from, to, (void*)&variable}
00352 
00360 #define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)
00361 
00369 #define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)
00370 
00379 #define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)
00380 
00389 #define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)
00390 
00398 #define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)
00399 
00405 #define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, 0, SL_MAX_VERSION)
00406 
00412 #define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, 0, SL_MAX_VERSION)
00413 
00419 #define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00420 
00426 #define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, lengthof(variable), 0, SL_MAX_VERSION)
00427 
00433 #define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, 0, SL_MAX_VERSION)
00434 
00441 #define SLEG_CONDNULL(length, from, to) {true, SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to, (void*)NULL}
00442 
00444 #define SLEG_END() {true, SL_END, 0, 0, 0, 0, NULL}
00445 
00452 static inline bool IsSavegameVersionBefore(uint16 major, byte minor = 0)
00453 {
00454   extern uint16 _sl_version;
00455   extern byte   _sl_minor_version;
00456   return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
00457 }
00458 
00466 static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)
00467 {
00468   extern const uint16 SAVEGAME_VERSION;
00469   if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION > version_to) return false;
00470 
00471   return true;
00472 }
00473 
00480 static inline VarType GetVarMemType(VarType type)
00481 {
00482   return type & 0xF0; // GB(type, 4, 4) << 4;
00483 }
00484 
00491 static inline VarType GetVarFileType(VarType type)
00492 {
00493   return type & 0xF; // GB(type, 0, 4);
00494 }
00495 
00501 static inline bool IsNumericType(VarType conv)
00502 {
00503   return GetVarMemType(conv) <= SLE_VAR_U64;
00504 }
00505 
00512 static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)
00513 {
00514   return const_cast<byte *>((const byte*)(sld->global ? NULL : object) + (ptrdiff_t)sld->address);
00515 }
00516 
00517 int64 ReadValue(const void *ptr, VarType conv);
00518 void WriteValue(void *ptr, VarType conv, int64 val);
00519 
00520 void SlSetArrayIndex(uint index);
00521 int SlIterateArray();
00522 
00523 void SlAutolength(AutolengthProc *proc, void *arg);
00524 size_t SlGetFieldLength();
00525 void SlSetLength(size_t length);
00526 size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);
00527 size_t SlCalcObjLength(const void *object, const SaveLoad *sld);
00528 
00529 byte SlReadByte();
00530 void SlWriteByte(byte b);
00531 
00532 void SlGlobList(const SaveLoadGlobVarList *sldg);
00533 void SlArray(void *array, size_t length, VarType conv);
00534 void SlObject(void *object, const SaveLoad *sld);
00535 bool SlObjectMember(void *object, const SaveLoad *sld);
00536 void NORETURN SlError(StringID string, const char *extra_msg = NULL);
00537 void NORETURN SlErrorCorrupt(const char *msg);
00538 
00539 bool SaveloadCrashWithMissingNewGRFs();
00540 
00541 extern char _savegame_format[8];
00542 extern bool _do_autosave;
00543 
00548 enum SaveLoadVersions {
00549   SL_TRUNK = 167,
00550   SL_RESERVATION = SL_TRUNK + 10,
00551   SL_CAPACITIES = SL_TRUNK + 20,
00552   SL_COMPONENTS,
00553   SL_DEMANDS = SL_COMPONENTS + 20,
00554   SL_MCF,
00555   SL_FLOWMAP,
00556   SL_CARGOMAP,
00557   SL_EXT_RATING,
00558 
00560   SL_MAX_VERSION = 255
00561 };
00562 
00563 #endif /* SAVELOAD_H */