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 {

    27

	uint32 id;

    28

	ChunkSaveLoadProc *save_proc;

    29

	ChunkSaveLoadProc *load_proc;

    30

	uint32 flags;

    31

} ChunkHandler;

    32

    33

typedef struct {

    34

	byte null;

    35

} NullStruct;

    36

    37

typedef enum SLRefType {

    38

	REF_ORDER       = 0,

    39

	REF_VEHICLE     = 1,

    40

	REF_STATION     = 2,

    41

	REF_TOWN        = 3,

    42

	REF_VEHICLE_OLD = 4,

    43

	REF_ROADSTOPS   = 5,

    44

	REF_ENGINE_RENEWS = 6,

    45

} SLRefType;

    46

    47

#define SL_MAX_VERSION 255

    48

    49

enum {

    50

	INC_VEHICLE_COMMON = 0,

    51

};

    52

    53

enum {

    54

	CH_RIFF         = 0,

    55

	CH_ARRAY        = 1,

    56

	CH_SPARSE_ARRAY = 2,

    57

	CH_TYPE_MASK    = 3,

    58

	CH_LAST         = 8,

    59

	CH_AUTO_LENGTH  = 16,

    60

    61

	CH_PRI_0          = 0 << 4,

    62

	CH_PRI_1          = 1 << 4,

    63

	CH_PRI_2          = 2 << 4,

    64

	CH_PRI_3          = 3 << 4,

    65

	CH_PRI_SHL        = 4,

    66

	CH_NUM_PRI_LEVELS = 4,

    67

};

    68

    69

enum VarTypes {

    70

	/* 4 bytes allocated a maximum of 16 types for NumberType */

    71

	SLE_FILE_I8       = 0,

    72

	SLE_FILE_U8       = 1,

    73

	SLE_FILE_I16      = 2,

    74

	SLE_FILE_U16      = 3,

    75

	SLE_FILE_I32      = 4,

    76

	SLE_FILE_U32      = 5,

    77

	SLE_FILE_I64      = 6,

    78

	SLE_FILE_U64      = 7,

    79

	SLE_FILE_STRINGID = 8, /// StringID offset into strings-array

    80

	SLE_FILE_STRING   = 9,

    81

	/* 6 more possible primitives */

    82

    83

	/* 4 bytes allocated a maximum of 16 types for NumberType */

    84

	SLE_VAR_BL   =  0 << 4,

    85

	SLE_VAR_I8   =  1 << 4,

    86

	SLE_VAR_U8   =  2 << 4,

    87

	SLE_VAR_I16  =  3 << 4,

    88

	SLE_VAR_U16  =  4 << 4,

    89

	SLE_VAR_I32  =  5 << 4,

    90

	SLE_VAR_U32  =  6 << 4,

    91

	SLE_VAR_I64  =  7 << 4,

    92

	SLE_VAR_U64  =  8 << 4,

    93

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

    94

	SLE_VAR_STRB = 10 << 4, /// normal string (with pre-allocated buffer)

    95

	SLE_VAR_STRQ = 11 << 4, /// string enclosed in parentheses

    96

	/* 4 more possible primitives */

    97

    98

	/* Shortcut values */

    99

	SLE_VAR_CHAR = SLE_VAR_I8,

   100

   101

	/* Default combinations of variables. As savegames change, so can variables

   102

	 * and thus it is possible that the saved value and internal size do not

   103

	 * match and you need to specify custom combo. The defaults are listed here */

   104

	SLE_BOOL        = SLE_FILE_I8  | SLE_VAR_BL,

   105

	SLE_INT8        = SLE_FILE_I8  | SLE_VAR_I8,

   106

	SLE_UINT8       = SLE_FILE_U8  | SLE_VAR_U8,

   107

	SLE_INT16       = SLE_FILE_I16 | SLE_VAR_I16,

   108

	SLE_UINT16      = SLE_FILE_U16 | SLE_VAR_U16,

   109

	SLE_INT32       = SLE_FILE_I32 | SLE_VAR_I32,

   110

	SLE_UINT32      = SLE_FILE_U32 | SLE_VAR_U32,

   111

	SLE_INT64       = SLE_FILE_I64 | SLE_VAR_I64,

   112

	SLE_UINT64      = SLE_FILE_U64 | SLE_VAR_U64,

   113

	SLE_CHAR        = SLE_FILE_I8  | SLE_VAR_CHAR,

   114

	SLE_STRINGID    = SLE_FILE_STRINGID | SLE_VAR_U16,

   115

	SLE_STRINGBUF   = SLE_FILE_STRING   | SLE_VAR_STRB,

   116

	SLE_STRINGQUOTE = SLE_FILE_STRING   | SLE_VAR_STRQ,

   117

   118

	/* Shortcut values */

   119

	SLE_UINT = SLE_UINT32,

   120

	SLE_INT  = SLE_INT32,

   121

	SLE_STRB = SLE_STRINGBUF,

   122

	SLE_STRQ = SLE_STRINGQUOTE,

   123

};

   124

   125

typedef uint32 VarType;

   126

   127

enum SaveLoadTypes {

   128

	SL_VAR       = 0,

   129

	SL_REF       = 1,

   130

	SL_ARR       = 2,

   131

	SL_STR       = 3,

   132

	// non-normal save-load types

   133

	SL_WRITEBYTE = 8,

   134

	SL_INCLUDE   = 9,

   135

	SL_END       = 15

   136

};

   137

   138

typedef byte SaveLoadType;

   139

typedef uint16 OffSetType;

   140

   141

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

   142

typedef struct SaveLoad {

   143

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

   144

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

   145

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

   146

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

   147

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

   148

	/* NOTE: This element either denotes the address of the variable for a global

   149

	 * variable, or the offset within a struct which is then bound to a variable

   150

	 * during runtime. Decision on which one to use is controlled by the function

   151

	 * that is called to save it. address: SlGlobList, offset: SlObject */

   152

	union {

   153

		void *address;      /// address of variable

   154

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

   155

	} s;

   156

} SaveLoad;

   157

   158

/* Same as SaveLoad but global variables are used (for better readability); */

   159

typedef SaveLoad SaveLoadGlobVarList;

   160

   161

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

   162

#define SLE_GENERAL(cmd, base, variable, type, length, from, to) {cmd, type, length, from, to, {(void*)offsetof(base, variable)}}

   163

#define SLE_CONDVAR(base, variable, type, from, to) SLE_GENERAL(SL_VAR, base, variable, type, 0, from, to)

   164

#define SLE_CONDREF(base, variable, type, from, to) SLE_GENERAL(SL_REF, base, variable, type, 0, from, to)

   165

#define SLE_CONDARR(base, variable, type, length, from, to) SLE_GENERAL(SL_ARR, base, variable, type, length, from, to)

   166

#define SLE_CONDSTR(base, variable, type, length, from, to) SLE_GENERAL(SL_STR, base, variable, type, length, from, to)

   167

   168

#define SLE_VAR(base, variable, type) SLE_CONDVAR(base, variable, type, 0, SL_MAX_VERSION)

   169

#define SLE_REF(base, variable, type) SLE_CONDREF(base, variable, type, 0, SL_MAX_VERSION)

   170

#define SLE_ARR(base, variable, type, length) SLE_CONDARR(base, variable, type, length, 0, SL_MAX_VERSION)

   171

#define SLE_STR(base, variable, type, length) SLE_CONDSTR(base, variable, type, length, 0, SL_MAX_VERSION)

   172

   173

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

   174

#define SLE_WRITEBYTE(base, variable, game_value, file_value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, game_value, file_value)

   175

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

   176

#define SLE_INCLUDE(base, variable, include_index) SLE_GENERAL(SL_INCLUDE, base, variable, 0, 0, include_index, 0)

   177

   178

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

   179

#define SLE_GENERALX(cmd, offset, type, param1, param2) {cmd, type, 0, param1, param2, {(void*)(offset)}}

   180

#define SLE_CONDVARX(offset, type, from, to) SLE_GENERALX(SL_VAR, offset, type, from, to)

   181

#define SLE_CONDREFX(offset, type, from, to) SLE_GENERALX(SL_REF, offset, type, from, to)

   182

   183

#define SLE_VARX(offset, type) SLE_CONDVARX(offset, type, 0, SL_MAX_VERSION)

   184

#define SLE_REFX(offset, type) SLE_CONDREFX(offset, type, 0, SL_MAX_VERSION)

   185

   186

#define SLE_WRITEBYTEX(offset, something) SLE_GENERALX(SL_WRITEBYTE, offset, 0, something, 0)

   187

#define SLE_INCLUDEX(offset, type) SLE_GENERALX(SL_INCLUDE, offset, type, 0, SL_MAX_VERSION)

   188

   189

/* End marker */

   190

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

   191

   192

/* Simple variables, references (pointers) and arrays, but for global variables */

   193

#define SLEG_GENERAL(cmd, variable, type, length, from, to) {cmd, type, length, from, to, {&variable}}

   194

   195

#define SLEG_CONDVAR(variable, type, from, to) SLEG_GENERAL(SL_VAR, variable, type, 0, from, to)

   196

#define SLEG_CONDREF(variable, type, from, to) SLEG_GENERAL(SL_REF, variable, type, 0, from, to)

   197

#define SLEG_CONDARR(variable, type, length, from, to) SLEG_GENERAL(SL_ARR, variable, type, length, from, to)

   198

#define SLEG_CONDSTR(variable, type, length, from, to) SLEG_GENERAL(SL_STR, variable, type, length, from, to)

   199

   200

#define SLEG_VAR(variable, type) SLEG_CONDVAR(variable, type, 0, SL_MAX_VERSION)

   201

#define SLEG_REF(variable, type) SLEG_CONDREF(variable, type, 0, SL_MAX_VERSION)

   202

#define SLEG_ARR(variable, type) SLEG_CONDARR(variable, type, lengthof(variable), SL_MAX_VERSION)

   203

#define SLEG_STR(variable, type) SLEG_CONDSTR(variable, type, lengthof(variable), SL_MAX_VERSION)

   204

   205

#define SLEG_END() {SL_END, 0, 0, 0, 0, {NULL}}

   206

   207

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

   208

 */

   209

static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor)

   210

{

   211

	extern uint16 _sl_version;

   212

	extern byte   _sl_minor_version;

   213

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

   214

}

   215

   216

/** Checks if the savegame is below version.

   217

 */

   218

static inline bool CheckSavegameVersion(uint16 version)

   219

{

   220

	extern uint16 _sl_version;

   221

	return _sl_version < version;

   222

}

   223

   224

void SlSetArrayIndex(uint index);

   225

int SlIterateArray(void);

   226

   227

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

   228

uint SlGetFieldLength(void);

   229

void SlSetLength(size_t length);

   230

size_t SlCalcObjMemberLength(const SaveLoad *sld);

   231

   232

byte SlReadByte(void);

   233

void SlWriteByte(byte b);

   234

   235

void SlGlobList(const SaveLoadGlobVarList *sldg);

   236

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

   237

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

   238

bool SlObjectMember(void *object, const SaveLoad *sld);

   239

   240

void SaveFileStart(void);

   241

void SaveFileDone(void);

   242

void SaveFileError(void);

   243

#endif /* SAVELOAD_H */