saveload.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef SAVELOAD_H
#define SAVELOAD_H
 
#include "../fileio_type.h"
#include "../strings_type.h"
#include <string>
 
enum SaveLoadVersion : uint16 {
  SL_MIN_VERSION,                         
 
  SLV_1,                                  
  SLV_2,                                  
  SLV_3,                                  
  SLV_4,                                  
  SLV_5,                                  
  SLV_6,                                  
  SLV_7,                                  
  SLV_8,                                  
  SLV_9,                                  
 
  SLV_10,                                 
  SLV_11,                                 
  SLV_12,                                 
  SLV_13,                                 
  SLV_14,                                 
 
  SLV_15,                                 
  SLV_16,                                 
  SLV_17,                                 
  SLV_18,                                 
  SLV_19,                                 
 
  SLV_20,                                 
  SLV_21,                                 
  SLV_22,                                 
  SLV_23,                                 
  SLV_24,                                 
 
  SLV_25,                                 
  SLV_26,                                 
  SLV_27,                                 
  SLV_28,                                 
  SLV_29,                                 
 
  SLV_30,                                 
  SLV_31,                                 
  SLV_32,                                 
  SLV_33,                                 
  SLV_34,                                 
 
  SLV_35,                                 
  SLV_36,                                 
  SLV_37,                                 
  SLV_38,                                 
  SLV_39,                                 
 
  SLV_40,                                 
  SLV_41,                                 
  SLV_42,                                 
  SLV_43,                                 
  SLV_44,                                 
 
  SLV_45,                                 
  SLV_46,                                 
  SLV_47,                                 
  SLV_48,                                 
  SLV_49,                                 
 
  SLV_50,                                 
  SLV_51,                                 
  SLV_52,                                 
  SLV_53,                                 
  SLV_54,                                 
 
  SLV_55,                                 
  SLV_56,                                 
  SLV_57,                                 
  SLV_58,                                 
  SLV_59,                                 
 
  SLV_60,                                 
  SLV_61,                                 
  SLV_62,                                 
  SLV_63,                                 
  SLV_64,                                 
 
  SLV_65,                                 
  SLV_66,                                 
  SLV_67,                                 
  SLV_68,                                 
  SLV_69,                                 
 
  SLV_70,                                 
  SLV_71,                                 
  SLV_72,                                 
  SLV_73,                                 
  SLV_74,                                 
 
  SLV_75,                                 
  SLV_76,                                 
  SLV_77,                                 
  SLV_78,                                 
  SLV_79,                                 
 
  SLV_80,                                 
  SLV_81,                                 
  SLV_82,                                 
  SLV_83,                                 
  SLV_84,                                 
 
  SLV_85,                                 
  SLV_86,                                 
  SLV_87,                                 
  SLV_88,                                 
  SLV_89,                                 
 
  SLV_90,                                 
  SLV_91,                                 
  SLV_92,                                 
  SLV_93,                                 
  SLV_94,                                 
 
  SLV_95,                                 
  SLV_96,                                 
  SLV_97,                                 
  SLV_98,                                 
  SLV_99,                                 
 
  SLV_100,                                
  SLV_101,                                
  SLV_102,                                
  SLV_103,                                
  SLV_104,                                
 
  SLV_105,                                
  SLV_106,                                
  SLV_107,                                
  SLV_108,                                
  SLV_109,                                
 
  SLV_110,                                
  SLV_111,                                
  SLV_112,                                
  SLV_113,                                
  SLV_114,                                
 
  SLV_115,                                
  SLV_116,                                
  SLV_117,                                
  SLV_118,                                
  SLV_119,                                
 
  SLV_120,                                
  SLV_121,                                
  SLV_122,                                
  SLV_123,                                
  SLV_124,                                
 
  SLV_125,                                
  SLV_126,                                
  SLV_127,                                
  SLV_128,                                
  SLV_129,                                
 
  SLV_130,                                
  SLV_131,                                
  SLV_132,                                
  SLV_133,                                
  SLV_134,                                
 
  SLV_135,                                
  SLV_136,                                
  SLV_137,                                
  SLV_138,                                
  SLV_139,                                
 
  SLV_140,                                
  SLV_141,                                
  SLV_142,                                
  SLV_143,                                
  SLV_144,                                
 
  SLV_145,                                
  SLV_146,                                
  SLV_147,                                
  SLV_148,                                
  SLV_149,                                
 
  SLV_150,                                
  SLV_151,                                
  SLV_152,                                
  SLV_153,                                
  SLV_154,                                
 
  SLV_155,                                
  SLV_156,                                
  SLV_157,                                
  SLV_158,                                
  SLV_159,                                
 
  SLV_160,                                
  SLV_161,                                
  SLV_162,                                
  SLV_163,                                
  SLV_164,                                
 
  SLV_165,                                
  SLV_166,                                
  SLV_167,                                
  SLV_168,                                
  SLV_169,                                
 
  SLV_170,                                
  SLV_171,                                
  SLV_172,                                
  SLV_173,                                
  SLV_174,                                
 
  SLV_175,                                
  SLV_176,                                
  SLV_177,                                
  SLV_178,                                
  SLV_179,                                
 
  SLV_180,                                
  SLV_181,                                
  SLV_182,                                
  SLV_183,                                
  SLV_184,                                
 
  SLV_185,                                
  SLV_186,                                
  SLV_187,                                
  SLV_188,                                
  SLV_189,                                
 
  SLV_190,                                
  SLV_191,                                
  SLV_192,                                
  SLV_193,                                
  SLV_194,                                
 
  SLV_195,                                
  SLV_196,                                
  SLV_197,                                
  SLV_198,                                
  SLV_EXTEND_CARGOTYPES,                  
 
  SLV_EXTEND_RAILTYPES,                   
  SLV_EXTEND_PERSISTENT_STORAGE,          
  SLV_EXTEND_INDUSTRY_CARGO_SLOTS,        
  SLV_SHIP_PATH_CACHE,                    
  SLV_SHIP_ROTATION,                      
 
  SLV_GROUP_LIVERIES,                     
  SLV_SHIPS_STOP_IN_LOCKS,                
  SLV_FIX_CARGO_MONITOR,                  
  SLV_TOWN_CARGOGEN,                      
  SLV_SHIP_CURVE_PENALTY,                 
 
  SLV_SERVE_NEUTRAL_INDUSTRIES,           
  SLV_ROADVEH_PATH_CACHE,                 
  SLV_REMOVE_OPF,                         
  SLV_TREES_WATER_CLASS,                  
  SLV_ROAD_TYPES,                         
 
  SLV_SCRIPT_MEMLIMIT,                    
  SLV_MULTITILE_DOCKS,                    
  SLV_TRADING_AGE,                        
  SLV_ENDING_YEAR,                        
  SLV_REMOVE_TOWN_CARGO_CACHE,            
 
  /* Patchpacks for a while considered it a good idea to jump a few versions
   * above our version for their savegames. But as time continued, this gap
   * has been closing, up to the point we would start to reuse versions from
   * their patchpacks. This is not a problem from our perspective: the
   * savegame will simply fail to load because they all contain chunks we
   * cannot digest. But, this gives for ugly errors. As we have plenty of
   * versions anyway, we simply skip the versions we know belong to
   * patchpacks. This way we can present the user with a clean error
   * indicate he is loading a savegame from a patchpack.
   * For future patchpack creators: please follow a system like JGRPP, where
   * the version is masked with 0x8000, and the true version is stored in
   * its own chunk with feature toggles.
   */
  SLV_START_PATCHPACKS,                   
  SLV_END_PATCHPACKS = 286,               
 
  SLV_GS_INDUSTRY_CONTROL,                
  SLV_VEH_MOTION_COUNTER,                 
  SLV_INDUSTRY_TEXT,                      
 
  SL_MAX_VERSION,                         
};
 
enum SaveOrLoadResult {
  SL_OK     = 0, 
  SL_ERROR  = 1, 
  SL_REINIT = 2, 
};
 
struct FileToSaveLoad {
  SaveLoadOperation file_op;           
  DetailedFileType detail_ftype;   
  AbstractFileType abstract_ftype; 
  std::string name;                
  char title[255];                 
 
  void SetMode(FiosType ft);
  void SetMode(SaveLoadOperation fop, AbstractFileType aft, DetailedFileType dft);
  void SetName(const char *name);
  void SetTitle(const char *title);
};
 
enum SavegameType {
  SGT_TTD,    
  SGT_TTDP1,  
  SGT_TTDP2,  
  SGT_OTTD,   
  SGT_TTO,    
  SGT_INVALID = 0xFF, 
};
 
extern FileToSaveLoad _file_to_saveload;
 
void GenerateDefaultSaveName(char *buf, const char *last);
void SetSaveLoadError(StringID str);
const char *GetSaveLoadErrorString();
SaveOrLoadResult SaveOrLoad(const std::string &filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded = true);
void WaitTillSaved();
void ProcessAsyncSaveFinish();
void DoExitSave();
 
SaveOrLoadResult SaveWithFilter(struct SaveFilter *writer, bool threaded);
SaveOrLoadResult LoadWithFilter(struct LoadFilter *reader);
 
typedef void ChunkSaveLoadProc();
typedef void AutolengthProc(void *arg);
 
struct ChunkHandler {
  uint32 id;                          
  ChunkSaveLoadProc *save_proc;       
  ChunkSaveLoadProc *load_proc;       
  ChunkSaveLoadProc *ptrs_proc;       
  ChunkSaveLoadProc *load_check_proc; 
  uint32 flags;                       
};
 
struct NullStruct {
  byte null;
};
 
enum SLRefType {
  REF_ORDER          =  0, 
  REF_VEHICLE        =  1, 
  REF_STATION        =  2, 
  REF_TOWN           =  3, 
  REF_VEHICLE_OLD    =  4, 
  REF_ROADSTOPS      =  5, 
  REF_ENGINE_RENEWS  =  6, 
  REF_CARGO_PACKET   =  7, 
  REF_ORDERLIST      =  8, 
  REF_STORAGE        =  9, 
  REF_LINK_GRAPH     = 10, 
  REF_LINK_GRAPH_JOB = 11, 
};
 
enum ChunkType {
  CH_RIFF         =  0,
  CH_ARRAY        =  1,
  CH_SPARSE_ARRAY =  2,
  CH_TYPE_MASK    =  3,
  CH_LAST         =  8, 
};
 
enum VarTypes {
  /* 4 bits allocated a maximum of 16 types for NumberType */
  SLE_FILE_I8       = 0,
  SLE_FILE_U8       = 1,
  SLE_FILE_I16      = 2,
  SLE_FILE_U16      = 3,
  SLE_FILE_I32      = 4,
  SLE_FILE_U32      = 5,
  SLE_FILE_I64      = 6,
  SLE_FILE_U64      = 7,
  SLE_FILE_STRINGID = 8, 
  SLE_FILE_STRING   = 9,
  /* 6 more possible file-primitives */
 
  /* 4 bits allocated a maximum of 16 types for NumberType */
  SLE_VAR_BL    =  0 << 4,
  SLE_VAR_I8    =  1 << 4,
  SLE_VAR_U8    =  2 << 4,
  SLE_VAR_I16   =  3 << 4,
  SLE_VAR_U16   =  4 << 4,
  SLE_VAR_I32   =  5 << 4,
  SLE_VAR_U32   =  6 << 4,
  SLE_VAR_I64   =  7 << 4,
  SLE_VAR_U64   =  8 << 4,
  SLE_VAR_NULL  =  9 << 4, 
  SLE_VAR_STRB  = 10 << 4, 
  SLE_VAR_STRBQ = 11 << 4, 
  SLE_VAR_STR   = 12 << 4, 
  SLE_VAR_STRQ  = 13 << 4, 
  SLE_VAR_NAME  = 14 << 4, 
  /* 1 more possible memory-primitives */
 
  /* Shortcut values */
  SLE_VAR_CHAR = SLE_VAR_I8,
 
  /* Default combinations of variables. As savegames change, so can variables
   * and thus it is possible that the saved value and internal size do not
   * match and you need to specify custom combo. The defaults are listed here */
  SLE_BOOL         = SLE_FILE_I8  | SLE_VAR_BL,
  SLE_INT8         = SLE_FILE_I8  | SLE_VAR_I8,
  SLE_UINT8        = SLE_FILE_U8  | SLE_VAR_U8,
  SLE_INT16        = SLE_FILE_I16 | SLE_VAR_I16,
  SLE_UINT16       = SLE_FILE_U16 | SLE_VAR_U16,
  SLE_INT32        = SLE_FILE_I32 | SLE_VAR_I32,
  SLE_UINT32       = SLE_FILE_U32 | SLE_VAR_U32,
  SLE_INT64        = SLE_FILE_I64 | SLE_VAR_I64,
  SLE_UINT64       = SLE_FILE_U64 | SLE_VAR_U64,
  SLE_CHAR         = SLE_FILE_I8  | SLE_VAR_CHAR,
  SLE_STRINGID     = SLE_FILE_STRINGID | SLE_VAR_U32,
  SLE_STRINGBUF    = SLE_FILE_STRING   | SLE_VAR_STRB,
  SLE_STRINGBQUOTE = SLE_FILE_STRING   | SLE_VAR_STRBQ,
  SLE_STRING       = SLE_FILE_STRING   | SLE_VAR_STR,
  SLE_STRINGQUOTE  = SLE_FILE_STRING   | SLE_VAR_STRQ,
  SLE_NAME         = SLE_FILE_STRINGID | SLE_VAR_NAME,
 
  /* Shortcut values */
  SLE_UINT  = SLE_UINT32,
  SLE_INT   = SLE_INT32,
  SLE_STRB  = SLE_STRINGBUF,
  SLE_STRBQ = SLE_STRINGBQUOTE,
  SLE_STR   = SLE_STRING,
  SLE_STRQ  = SLE_STRINGQUOTE,
 
  /* 8 bits allocated for a maximum of 8 flags
   * Flags directing saving/loading of a variable */
  SLF_NOT_IN_SAVE     = 1 <<  8, 
  SLF_NOT_IN_CONFIG   = 1 <<  9, 
  SLF_NO_NETWORK_SYNC = 1 << 10, 
  SLF_ALLOW_CONTROL   = 1 << 11, 
  SLF_ALLOW_NEWLINE   = 1 << 12, 
  SLF_HEX             = 1 << 13, 
  /* 2 more possible flags */
};
 
typedef uint32 VarType;
 
enum SaveLoadTypes {
  SL_VAR         =  0, 
  SL_REF         =  1, 
  SL_ARR         =  2, 
  SL_STR         =  3, 
  SL_LST         =  4, 
  SL_DEQUE       =  5, 
  SL_STDSTR      =  6, 
  /* non-normal save-load types */
  SL_WRITEBYTE   =  8,
  SL_VEH_INCLUDE =  9,
  SL_ST_INCLUDE  = 10,
  SL_END         = 15
};
 
typedef byte SaveLoadType; 
 
struct SaveLoad {
  bool global;         
  SaveLoadType cmd;    
  VarType conv;        
  uint16 length;       
  SaveLoadVersion version_from; 
  SaveLoadVersion version_to;   
  /* NOTE: This element either denotes the address of the variable for a global
   * variable, or the offset within a struct which is then bound to a variable
   * during runtime. Decision on which one to use is controlled by the function
   * that is called to save it. address: global=true, offset: global=false */
  void *address;       
  size_t size;         
};
 
typedef SaveLoad SaveLoadGlobVarList;
 
#define SLE_GENERAL(cmd, base, variable, type, length, from, to) {false, cmd, type, length, from, to, (void*)cpp_offsetof(base, variable), cpp_sizeof(base, variable)}
 
#define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)
 
#define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)
 
#define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)
 
#define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)
 
#define SLE_CONDSSTR(base, variable, type, from, to) SLE_GENERAL(SL_STDSTR, base, variable, type, 0, from, to)
 
#define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)
 
#define SLE_CONDDEQUE(base, variable, type, from, to) SLE_GENERAL(SL_DEQUE, base, variable, type, 0, from, to)
 
#define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_SSTR(base, variable, type) SLE_CONDSSTR(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_NULL(length) SLE_CONDNULL(length, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to)
 
#define SLE_WRITEBYTE(base, variable) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLE_VEH_INCLUDE() {false, SL_VEH_INCLUDE, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION, nullptr, 0}
#define SLE_ST_INCLUDE() {false, SL_ST_INCLUDE, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION, nullptr, 0}
 
#define SLE_END() {false, SL_END, 0, 0, SL_MIN_VERSION, SL_MIN_VERSION, nullptr, 0}
 
#define SLEG_GENERAL(cmd, variable, type, length, from, to) {true, cmd, type, length, from, to, (void*)&variable, sizeof(variable)}
 
#define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)
 
#define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)
 
#define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)
 
#define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)
 
#define SLEG_CONDSSTR(variable, type, from, to) SLEG_GENERAL(SL_STDSTR, variable, type, 0, from, to)
 
#define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)
 
#define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, sizeof(variable), SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLEG_SSTR(variable, type) SLEG_CONDSSTR(variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, SL_MIN_VERSION, SL_MAX_VERSION)
 
#define SLEG_CONDNULL(length, from, to) {true, SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to, (void*)nullptr}
 
#define SLEG_END() {true, SL_END, 0, 0, SL_MIN_VERSION, SL_MIN_VERSION, nullptr, 0}
 
static inline bool IsSavegameVersionBefore(SaveLoadVersion major, byte minor = 0)
{
  extern SaveLoadVersion _sl_version;
  extern byte            _sl_minor_version;
  return _sl_version < major || (minor > 0 && _sl_version == major && _sl_minor_version < minor);
}
 
static inline bool IsSavegameVersionUntil(SaveLoadVersion major)
{
  extern SaveLoadVersion _sl_version;
  return _sl_version <= major;
}
 
static inline bool SlIsObjectCurrentlyValid(SaveLoadVersion version_from, SaveLoadVersion version_to)
{
  extern const SaveLoadVersion SAVEGAME_VERSION;
  if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION >= version_to) return false;
 
  return true;
}
 
static inline VarType GetVarMemType(VarType type)
{
  return type & 0xF0; // GB(type, 4, 4) << 4;
}
 
static inline VarType GetVarFileType(VarType type)
{
  return type & 0xF; // GB(type, 0, 4);
}
 
static inline bool IsNumericType(VarType conv)
{
  return GetVarMemType(conv) <= SLE_VAR_U64;
}
 
static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)
{
  /* Entry is a global address. */
  if (sld->global) return sld->address;
 
  /* Entry is a null-variable, mostly used to read old savegames etc. */
  if (GetVarMemType(sld->conv) == SLE_VAR_NULL) {
    assert(sld->address == nullptr);
    return nullptr;
  }
 
  /* Everything else should be a non-null pointer. */
  assert(object != nullptr);
  return const_cast<byte *>((const byte *)object + (ptrdiff_t)sld->address);
}
 
int64 ReadValue(const void *ptr, VarType conv);
void WriteValue(void *ptr, VarType conv, int64 val);
 
void SlSetArrayIndex(uint index);
int SlIterateArray();
 
void SlAutolength(AutolengthProc *proc, void *arg);
size_t SlGetFieldLength();
void SlSetLength(size_t length);
size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);
size_t SlCalcObjLength(const void *object, const SaveLoad *sld);
 
byte SlReadByte();
void SlWriteByte(byte b);
 
void SlGlobList(const SaveLoadGlobVarList *sldg);
void SlArray(void *array, size_t length, VarType conv);
void SlObject(void *object, const SaveLoad *sld);
bool SlObjectMember(void *object, const SaveLoad *sld);
void NORETURN SlError(StringID string, const char *extra_msg = nullptr);
void NORETURN SlErrorCorrupt(const char *msg);
void NORETURN SlErrorCorruptFmt(const char *format, ...) WARN_FORMAT(1, 2);
 
bool SaveloadCrashWithMissingNewGRFs();
 
static inline void SlSkipBytes(size_t length)
{
  for (; length != 0; length--) SlReadByte();
}
 
extern char _savegame_format[8];
extern bool _do_autosave;
 
#endif /* SAVELOAD_H */