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

/** VarTypes is the general bitmasked magic type that tells us

    70

 * certain characteristics about the variable it refers to. For example

    71

 * SLE_FILE_* gives the size(type) as it would be in the savegame and

    72

 * SLE_VAR_* the size(type) as it is in memory during runtime. These are

    73

 * the first 8 bytes (0-3 SLE_FILE, 4-7 SLE_VAR).

    74

 * Bytes 8-15 are reserved for various flags as explained below */

    75

enum VarTypes {

    76

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

    77

	SLE_FILE_I8       = 0,

    78

	SLE_FILE_U8       = 1,

    79

	SLE_FILE_I16      = 2,

    80

	SLE_FILE_U16      = 3,

    81

	SLE_FILE_I32      = 4,

    82

	SLE_FILE_U32      = 5,

    83

	SLE_FILE_I64      = 6,

    84

	SLE_FILE_U64      = 7,

    85

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

    86

	SLE_FILE_STRING   = 9,

    87

	/* 6 more possible file-primitives */

    88

    89

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

    90

	SLE_VAR_BL   =  0 << 4,

    91

	SLE_VAR_I8   =  1 << 4,

    92

	SLE_VAR_U8   =  2 << 4,

    93

	SLE_VAR_I16  =  3 << 4,

    94

	SLE_VAR_U16  =  4 << 4,

    95

	SLE_VAR_I32  =  5 << 4,

    96

	SLE_VAR_U32  =  6 << 4,

    97

	SLE_VAR_I64  =  7 << 4,

    98

	SLE_VAR_U64  =  8 << 4,

    99

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

   100

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

   101

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

   102

	/* 4 more possible memory-primitives */

   103

   104

	/* Shortcut values */

   105

	SLE_VAR_CHAR = SLE_VAR_I8,

   106

   107

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

   108

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

   109

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

   110

	SLE_BOOL        = SLE_FILE_I8  | SLE_VAR_BL,

   111

	SLE_INT8        = SLE_FILE_I8  | SLE_VAR_I8,

   112

	SLE_UINT8       = SLE_FILE_U8  | SLE_VAR_U8,

   113

	SLE_INT16       = SLE_FILE_I16 | SLE_VAR_I16,

   114

	SLE_UINT16      = SLE_FILE_U16 | SLE_VAR_U16,

   115

	SLE_INT32       = SLE_FILE_I32 | SLE_VAR_I32,

   116

	SLE_UINT32      = SLE_FILE_U32 | SLE_VAR_U32,

   117

	SLE_INT64       = SLE_FILE_I64 | SLE_VAR_I64,

   118

	SLE_UINT64      = SLE_FILE_U64 | SLE_VAR_U64,

   119

	SLE_CHAR        = SLE_FILE_I8  | SLE_VAR_CHAR,

   120

	SLE_STRINGID    = SLE_FILE_STRINGID | SLE_VAR_U16,

   121

	SLE_STRINGBUF   = SLE_FILE_STRING   | SLE_VAR_STRB,

   122

	SLE_STRINGQUOTE = SLE_FILE_STRING   | SLE_VAR_STRQ,

   123

   124

	/* Shortcut values */

   125

	SLE_UINT = SLE_UINT32,

   126

	SLE_INT  = SLE_INT32,

   127

	SLE_STRB = SLE_STRINGBUF,

   128

	SLE_STRQ = SLE_STRINGQUOTE,

   129

   130

	/* 8 bytes allocated for a maximum of 8 flags

   131

	 * Flags directing saving/loading of a variable */

   132

	SLF_SAVE_NO      = 1 <<  8, ///< do not save with savegame, basically player-based

   133

	SLF_CONFIG_NO    = 1 <<  9, ///< do not save to config file

   134

	SLF_NETWORK_NO   = 1 << 10, ///< do not synchronize over network (but it is saved if SSF_SAVE_NO is not set)

   135

	/* 5 more possible flags */

   136

};

   137

   138

typedef uint32 VarType;

   139

   140

enum SaveLoadTypes {

   141

	SL_VAR       = 0,

   142

	SL_REF       = 1,

   143

	SL_ARR       = 2,

   144

	SL_STR       = 3,

   145

	// non-normal save-load types

   146

	SL_WRITEBYTE = 8,

   147

	SL_INCLUDE   = 9,

   148

	SL_END       = 15

   149

};

   150

   151

typedef byte SaveLoadType;

   152

   153

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

   154

typedef struct SaveLoad {

   155

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

   156

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

   157

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

   158

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

   159

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

   160

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

   161

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

   162

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

   163

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

   164

	void *address;       ///< address of variable OR offset of variable in the struct (max offset is 65536)

   165

} SaveLoad;

   166

   167

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

   168

typedef SaveLoad SaveLoadGlobVarList;

   169

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

   177

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

   178

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

   179

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

   180

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

   181

   182

#define SLE_CONDNULL(length, from, to) SLE_CONDARR(NullStruct, null, SLE_FILE_U8 | SLE_VAR_NULL | SLF_CONFIG_NO, length, from, to)

   183

   184

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

   185

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

   186

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

   187

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

   188

   189

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

   190

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

   191

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

   192

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

   193

   194

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

   195

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

   196

   197

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

   198

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

   199

   200

/* End marker */

   201

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

   202

   203

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

   204

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

   205

   206

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

   207

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

   208

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

   209

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

   210

   211

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

   212

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

   213

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

   214

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

   215

   216

#define SLEG_CONDNULL(length, from, to) {SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_CONFIG_NO, length, from, to, (void*)NULL}

   217

   218

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

   219

   220

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

   221

 */

   222

static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor)

   223

{

   224

	extern uint16 _sl_version;

   225

	extern byte   _sl_minor_version;

   226

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

   227

}

   228

   229

/** Checks if the savegame is below version.

   230

 */

   231

static inline bool CheckSavegameVersion(uint16 version)

   232

{

   233

	extern uint16 _sl_version;

   234

	return _sl_version < version;

   235

}

   236

   237

/** Checks if some version from/to combination falls within the range of the

   238

 * active savegame version */

   239

static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)

   240

{

   241

	extern const uint16 SAVEGAME_VERSION;

   242

	if (SAVEGAME_VERSION < version_from || SAVEGAME_VERSION > version_to) return false;

   243

   244

	return true;

   245

}

   246

   247

/* Get the NumberType of a setting. This describes the integer type

   248

 * as it is represented in memory

   249

 * @param type VarType holding information about the variable-type

   250

 * @return return the SLE_VAR_* part of a variable-type description */

   251

static inline VarType GetVarMemType(VarType type)

   252

{

   253

	return type & 0xF0; // GB(type, 4, 4) << 4;

   254

}

   255

   256

/* Get the FileType of a setting. This describes the integer type

   257

 * as it is represented in a savegame/file

   258

 * @param type VarType holding information about the variable-type

   259

 * @param return the SLE_FILE_* part of a variable-type description */

   260

static inline VarType GetVarFileType(VarType type)

   261

{

   262

	return type & 0xF; // GB(type, 0, 4);

   263

}

   264

   265

int64 ReadValue(const void *ptr, VarType conv);

   266

void WriteValue(void *ptr, VarType conv, int64 val);

   267

   268

void SlSetArrayIndex(uint index);

   269

int SlIterateArray(void);

   270

   271

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

   272

uint SlGetFieldLength(void);

   273

void SlSetLength(size_t length);

   274

size_t SlCalcObjMemberLength(const SaveLoad *sld);

   275

   276

byte SlReadByte(void);

   277

void SlWriteByte(byte b);

   278

   279

void SlGlobList(const SaveLoadGlobVarList *sldg);

   280

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

   281

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

   282

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

   283

   284

void SaveFileStart(void);

   285

void SaveFileDone(void);

   286

void SaveFileError(void);

   287

#endif /* SAVELOAD_H */