Files
@ r2372:a11aa4a17996
Branch filter:
Location: cpp/openttd-patchpack/source/saveload.h - annotation
r2372:a11aa4a17996
5.5 KiB
text/x-c
(svn r2898) Fix typo in r2897
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | r2186:5ee653b1b5e1 r2186:5ee653b1b5e1 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r2285:47dd485c1ae4 r2162:7c64e21f12f9 r2162:7c64e21f12f9 r1093:18f56ef2d029 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r1024:c7c4672d839e r1024:c7c4672d839e r1024:c7c4672d839e r1024:c7c4672d839e r1217:1f9b7fc00eb8 r1217:1f9b7fc00eb8 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r2295:c68f860335d6 r2295:c68f860335d6 r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r1881:ce1fe6a2816a r0:d63b455452f6 r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r1881:ce1fe6a2816a r2295:c68f860335d6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r2295:c68f860335d6 r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r1093:18f56ef2d029 r1887:2a0dedf65fb2 r1881:ce1fe6a2816a r0:d63b455452f6 r1093:18f56ef2d029 r1093:18f56ef2d029 r1881:ce1fe6a2816a r1881:ce1fe6a2816a r0:d63b455452f6 r0:d63b455452f6 r0:d63b455452f6 | /* $Id$ */
#ifndef SAVELOAD_H
#define SAVELOAD_H
typedef enum SaveOrLoadResult {
SL_OK = 0, // completed successfully
SL_ERROR = 1, // error that was caught before internal structures were modified
SL_REINIT = 2, // error that was caught in the middle of updating game state, need to clear it. (can only happen during load)
} SaveOrLoadResult;
typedef enum SaveOrLoadMode {
SL_INVALID = -1,
SL_LOAD = 0,
SL_SAVE = 1,
SL_OLD_LOAD = 2,
} SaveOrLoadMode;
SaveOrLoadResult SaveOrLoad(const char *filename, int mode);
void WaitTillSaved(void);
typedef void ChunkSaveLoadProc(void);
typedef void AutolengthProc(void *arg);
typedef struct SaveLoadGlobVarList {
void *address;
byte conv;
byte from_version;
byte to_version;
} SaveLoadGlobVarList;
typedef struct {
uint32 id;
ChunkSaveLoadProc *save_proc;
ChunkSaveLoadProc *load_proc;
uint32 flags;
} ChunkHandler;
typedef struct {
byte null;
} NullStruct;
typedef enum SLRefType {
REF_ORDER = 0,
REF_VEHICLE = 1,
REF_STATION = 2,
REF_TOWN = 3,
REF_VEHICLE_OLD = 4,
REF_ROADSTOPS = 5
} SLRefType;
extern byte _sl_version; /// the major savegame version identifier
extern uint16 _sl_full_version; /// the full version of the savegame
enum {
INC_VEHICLE_COMMON = 0,
};
enum {
CH_RIFF = 0,
CH_ARRAY = 1,
CH_SPARSE_ARRAY = 2,
CH_TYPE_MASK = 3,
CH_LAST = 8,
CH_AUTO_LENGTH = 16,
CH_PRI_0 = 0 << 4,
CH_PRI_1 = 1 << 4,
CH_PRI_2 = 2 << 4,
CH_PRI_3 = 3 << 4,
CH_PRI_SHL = 4,
CH_NUM_PRI_LEVELS = 4,
};
typedef enum VarTypes {
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_IVAR = 8,
// SLE_FILE_UVAR = 9,
SLE_VAR_I8 = 0 << 4,
SLE_VAR_U8 = 1 << 4,
SLE_VAR_I16 = 2 << 4,
SLE_VAR_U16 = 3 << 4,
SLE_VAR_I32 = 4 << 4,
SLE_VAR_U32 = 5 << 4,
SLE_VAR_I64 = 6 << 4,
SLE_VAR_U64 = 7 << 4,
SLE_VAR_NULL = 8 << 4, // useful to write zeros in savegame.
SLE_VAR_INT = SLE_VAR_I32,
SLE_VAR_UINT = SLE_VAR_U32,
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_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,
} VarType;
enum SaveLoadTypes {
SL_VAR = 0,
SL_REF = 1,
SL_ARR = 2,
SL_CONDVAR = 0 | (1 << 2), // 4
SL_CONDREF = 1 | (1 << 2), // 5
SL_CONDARR = 2 | (1 << 2), // 6
// non-normal save-load types
SL_WRITEBYTE = 8,
SL_INCLUDE = 9,
SL_END = 15
};
/** SaveLoad type struct. Do NOT use this directly but use the SLE_ macros defined just below! */
typedef struct SaveLoad {
byte cmd; /// the action to take with the saved/loaded type, All types need different action
VarType type; /// type of the variable to be saved, int
uint16 offset; /// offset of this variable in the struct (max offset is 65536)
uint16 length; /// (conditional) length of the variable (eg. arrays) (max array size is 65536 elements)
uint16 version_from; /// save/load the variable starting from this savegame version
uint16 version_to; /// save/load the variable until this savegame version
} SaveLoad;
/* Simple variables, references (pointers) and arrays */
#define SLE_VAR(base, variable, type) {SL_VAR, type, offsetof(base, variable), 0, 0, 0}
#define SLE_REF(base, variable, type) {SL_REF, type, offsetof(base, variable), 0, 0, 0}
#define SLE_ARR(base, variable, type, length) {SL_ARR, type, offsetof(base, variable), length, 0, 0}
/* Conditional variables, references (pointers) and arrays that are only valid for certain savegame versions */
#define SLE_CONDVAR(base, variable, type, from, to) {SL_CONDVAR, type, offsetof(base, variable), 0, from, to}
#define SLE_CONDREF(base, variable, type, from, to) {SL_CONDREF, type, offsetof(base, variable), 0, from, to}
#define SLE_CONDARR(base, variable, type, length, from, to) {SL_CONDARR, type, offsetof(base, variable), length, from, to}
/* Translate values ingame to different values in the savegame and vv */
#define SLE_WRITEBYTE(base, variable, game_value, file_value) {SL_WRITEBYTE, 0, offsetof(base, variable), 0, game_value, file_value}
/* Load common code and put it into each struct (currently only for vehicles */
#define SLE_INCLUDE(base, variable, include_index) {SL_INCLUDE, 0, offsetof(base, variable), 0, include_index, 0}
/* The same as the ones at the top, only the offset is given directly; used for unions */
#define SLE_VARX(offset, type) {SL_VAR, type, offset, 0, 0, 0}
#define SLE_REFX(offset, type) {SL_REF, type, offset, 0, 0, 0}
#define SLE_CONDVARX(offset, type, from, to) {SL_CONDVAR, type, offset, 0, from, to}
#define SLE_CONDREFX(offset, type, from, to) {SL_CONDREF, type, offset, 0, from, to}
#define SLE_WRITEBYTEX(offset, something) {SL_WRITEBYTE, 0, offset, 0, something, 0}
#define SLE_INCLUDEX(offset, type) {SL_INCLUDE, type, offset, 0, 0, 0}
/* End marker */
#define SLE_END() {SL_END, 0, 0, 0, 0, 0}
void SlSetArrayIndex(uint index);
int SlIterateArray(void);
void SlArray(void *array, uint length, VarType conv);
void SlObject(void *object, const SaveLoad *desc);
void SlAutolength(AutolengthProc *proc, void *arg);
uint SlGetFieldLength(void);
int SlReadByte(void);
void SlSetLength(size_t length);
void SlWriteByte(byte b);
void SlGlobList(const SaveLoadGlobVarList *desc);
#endif /* SAVELOAD_H */
|