1

/* $Id$ */

     2

     3

#ifndef SAVELOAD_H

     4

#define SAVELOAD_H

     5

     6

typedef enum SaveOrLoadResult {

     7

	SL_OK = 0, // completed successfully

     8

	SL_ERROR = 1, // error that was caught before internal structures were modified

     9

	SL_REINIT = 2, // error that was caught in the middle of updating game state, need to clear it. (can only happen during load)

    10

} SaveOrLoadResult;

    11

    12

typedef enum SaveOrLoadMode {

    13

	SL_INVALID = -1,

    14

	SL_LOAD = 0,

    15

	SL_SAVE = 1,

    16

	SL_OLD_LOAD = 2,

    17

} SaveOrLoadMode;

    18

    19

SaveOrLoadResult SaveOrLoad(const char *filename, int mode);

    20

void WaitTillSaved(void);

    21

    22

    23

typedef void ChunkSaveLoadProc(void);

    24

typedef void AutolengthProc(void *arg);

    25

    26

typedef struct SaveLoadGlobVarList {

    27

	void *address;

    28

	byte conv;

    29

	uint16 from_version;

    30

	uint16 to_version;

    31

} SaveLoadGlobVarList;

    32

    33

typedef struct {

    34

	uint32 id;

    35

	ChunkSaveLoadProc *save_proc;

    36

	ChunkSaveLoadProc *load_proc;

    37

	uint32 flags;

    38

} ChunkHandler;

    39

    40

typedef struct {

    41

	byte null;

    42

} NullStruct;

    43

    44

typedef enum SLRefType {

    45

	REF_ORDER       = 0,

    46

	REF_VEHICLE     = 1,

    47

	REF_STATION     = 2,

    48

	REF_TOWN        = 3,

    49

	REF_VEHICLE_OLD = 4,

    50

	REF_ROADSTOPS   = 5,

    51

	REF_ENGINE_RENEWS = 6,

    52

} SLRefType;

    53

    54

    55

extern uint16 _sl_version;       /// the major savegame version identifier

    56

extern byte   _sl_minor_version; /// the minor savegame version, DO NOT USE!

    57

    58

    59

enum {

    60

	INC_VEHICLE_COMMON = 0,

    61

};

    62

    63

enum {

    64

	CH_RIFF = 0,

    65

	CH_ARRAY = 1,

    66

	CH_SPARSE_ARRAY = 2,

    67

	CH_TYPE_MASK = 3,

    68

	CH_LAST = 8,

    69

	CH_AUTO_LENGTH = 16,

    70

	CH_PRI_0 = 0 << 4,

    71

	CH_PRI_1 = 1 << 4,

    72

	CH_PRI_2 = 2 << 4,

    73

	CH_PRI_3 = 3 << 4,

    74

	CH_PRI_SHL = 4,

    75

	CH_NUM_PRI_LEVELS = 4,

    76

};

    77

    78

typedef enum VarTypes {

    79

	SLE_FILE_I8  = 0,

    80

	SLE_FILE_U8  = 1,

    81

	SLE_FILE_I16 = 2,

    82

	SLE_FILE_U16 = 3,

    83

	SLE_FILE_I32 = 4,

    84

	SLE_FILE_U32 = 5,

    85

	SLE_FILE_I64 = 6,

    86

	SLE_FILE_U64 = 7,

    87

    88

	SLE_FILE_STRINGID = 8,

    89

//	SLE_FILE_IVAR = 8,

    90

//	SLE_FILE_UVAR = 9,

    91

    92

	SLE_VAR_I8   = 0 << 4,

    93

	SLE_VAR_U8   = 1 << 4,

    94

	SLE_VAR_I16  = 2 << 4,

    95

	SLE_VAR_U16  = 3 << 4,

    96

	SLE_VAR_I32  = 4 << 4,

    97

	SLE_VAR_U32  = 5 << 4,

    98

	SLE_VAR_I64  = 6 << 4,

    99

	SLE_VAR_U64  = 7 << 4,

   100

   101

	SLE_VAR_NULL = 8 << 4, // useful to write zeros in savegame.

   102

   103

	SLE_VAR_INT  = SLE_VAR_I32,

   104

	SLE_VAR_UINT = SLE_VAR_U32,

   105

   106

	SLE_INT8   = SLE_FILE_I8  | SLE_VAR_I8,

   107

	SLE_UINT8  = SLE_FILE_U8  | SLE_VAR_U8,

   108

	SLE_INT16  = SLE_FILE_I16 | SLE_VAR_I16,

   109

	SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,

   110

	SLE_INT32  = SLE_FILE_I32 | SLE_VAR_I32,

   111

	SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,

   112

	SLE_INT64  = SLE_FILE_I64 | SLE_VAR_I64,

   113

	SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,

   114

   115

	SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,

   116

} VarType;

   117

   118

enum SaveLoadTypes {

   119

	SL_VAR       = 0,

   120

	SL_REF       = 1,

   121

	SL_ARR       = 2,

   122

	SL_CONDVAR   = 0 | (1 << 2), // 4

   123

	SL_CONDREF   = 1 | (1 << 2), // 5

   124

	SL_CONDARR   = 2 | (1 << 2), // 6

   125

	// non-normal save-load types

   126

	SL_WRITEBYTE = 8,

   127

	SL_INCLUDE   = 9,

   128

	SL_END       = 15

   129

};

   130

   131

/** SaveLoad type struct. Do NOT use this directly but use the SLE_ macros defined just below! */

   132

typedef struct SaveLoad {

   133

	byte cmd;             /// the action to take with the saved/loaded type, All types need different action

   134

	VarType type;         /// type of the variable to be saved, int

   135

	uint16 offset;        /// offset of this variable in the struct (max offset is 65536)

   136

	uint16 length;        /// (conditional) length of the variable (eg. arrays) (max array size is 65536 elements)

   137

	uint16 version_from;  /// save/load the variable starting from this savegame version

   138

	uint16 version_to;    /// save/load the variable until this savegame version

   139

} SaveLoad;

   140

   141

/* Simple variables, references (pointers) and arrays */

   142

#define SLE_VAR(base, variable, type) {SL_VAR, type, offsetof(base, variable), 0, 0, 0}

   143

#define SLE_REF(base, variable, type) {SL_REF, type, offsetof(base, variable), 0, 0, 0}

   144

#define SLE_ARR(base, variable, type, length) {SL_ARR, type, offsetof(base, variable), length, 0, 0}

   145

/* Conditional variables, references (pointers) and arrays that are only valid for certain savegame versions */

   146

#define SLE_CONDVAR(base, variable, type, from, to) {SL_CONDVAR, type, offsetof(base, variable), 0, from, to}

   147

#define SLE_CONDREF(base, variable, type, from, to) {SL_CONDREF, type, offsetof(base, variable), 0, from, to}

   148

#define SLE_CONDARR(base, variable, type, length, from, to) {SL_CONDARR, type, offsetof(base, variable), length, from, to}

   149

/* Translate values ingame to different values in the savegame and vv */

   150

#define SLE_WRITEBYTE(base, variable, game_value, file_value) {SL_WRITEBYTE, 0, offsetof(base, variable), 0, game_value, file_value}

   151

/* Load common code and put it into each struct (currently only for vehicles */

   152

#define SLE_INCLUDE(base, variable, include_index) {SL_INCLUDE, 0, offsetof(base, variable), 0, include_index, 0}

   153

   154

/* The same as the ones at the top, only the offset is given directly; used for unions */

   155

#define SLE_VARX(offset, type) {SL_VAR, type, offset, 0, 0, 0}

   156

#define SLE_REFX(offset, type) {SL_REF, type, offset, 0, 0, 0}

   157

#define SLE_CONDVARX(offset, type, from, to) {SL_CONDVAR, type, offset, 0, from, to}

   158

#define SLE_CONDREFX(offset, type, from, to) {SL_CONDREF, type, offset, 0, from, to}

   159

#define SLE_WRITEBYTEX(offset, something) {SL_WRITEBYTE, 0, offset, 0, something, 0}

   160

#define SLE_INCLUDEX(offset, type) {SL_INCLUDE, type, offset, 0, 0, 0}

   161

   162

/* End marker */

   163

#define SLE_END() {SL_END, 0, 0, 0, 0, 0}

   164

   165

/** Checks if the savegame is below major.minor.

   166

 */

   167

static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor)

   168

{

   169

	return (_sl_version < major) || (_sl_version == major && _sl_minor_version < minor);

   170

}

   171

   172

/** Checks if the savegame is below version.

   173

 */

   174

static inline bool CheckSavegameVersion(uint16 version)

   175

{

   176

	return _sl_version < version;

   177

}

   178

   179

void SlSetArrayIndex(uint index);

   180

int SlIterateArray(void);

   181

void SlArray(void *array, uint length, VarType conv);

   182

void SlObject(void *object, const SaveLoad *desc);

   183

void SlAutolength(AutolengthProc *proc, void *arg);

   184

uint SlGetFieldLength(void);

   185

int SlReadByte(void);

   186

void SlSetLength(size_t length);

   187

void SlWriteByte(byte b);

   188

void SlGlobList(const SaveLoadGlobVarList *desc);

   189

   190

void SaveFileStart(void);

   191

void SaveFileDone(void);

   192

void SaveFileError(void);

   193

#endif /* SAVELOAD_H */