1

/* $Id$ */

     2

     3

/** @file saveload.h */

     4

     5

#ifndef SAVELOAD_H

     6

#define SAVELOAD_H

     7

     8

#ifdef SIZE_MAX

     9

#undef SIZE_MAX

    10

#endif

    11

    12

#define SIZE_MAX ((size_t)-1)

    13

    14

enum SaveOrLoadResult {

    15

	SL_OK     = 0, ///< completed successfully

    16

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

    17

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

    18

};

    19

    20

enum SaveOrLoadMode {

    21

	SL_INVALID  = -1,

    22

	SL_LOAD     =  0,

    23

	SL_SAVE     =  1,

    24

	SL_OLD_LOAD =  2,

    25

	SL_PNG      =  3,

    26

	SL_BMP      =  4,

    27

};

    28

    29

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

    30

void WaitTillSaved();

    31

void DoExitSave();

    32

    33

    34

typedef void ChunkSaveLoadProc();

    35

typedef void AutolengthProc(void *arg);

    36

    37

struct ChunkHandler {

    38

	uint32 id;

    39

	ChunkSaveLoadProc *save_proc;

    40

	ChunkSaveLoadProc *load_proc;

    41

	uint32 flags;

    42

};

    43

    44

struct NullStruct {

    45

	byte null;

    46

};

    47

    48

enum SLRefType {

    49

	REF_ORDER         = 0,

    50

	REF_VEHICLE       = 1,

    51

	REF_STATION       = 2,

    52

	REF_TOWN          = 3,

    53

	REF_VEHICLE_OLD   = 4,

    54

	REF_ROADSTOPS     = 5,

    55

	REF_ENGINE_RENEWS = 6,

    56

};

    57

    58

#define SL_MAX_VERSION 255

    59

    60

enum {

    61

	INC_VEHICLE_COMMON = 0,

    62

};

    63

    64

enum {

    65

	CH_RIFF         =  0,

    66

	CH_ARRAY        =  1,

    67

	CH_SPARSE_ARRAY =  2,

    68

	CH_TYPE_MASK    =  3,

    69

	CH_LAST         =  8,

    70

	CH_AUTO_LENGTH  = 16,

    71

    72

	CH_PRI_0          = 0 << 4,

    73

	CH_PRI_1          = 1 << 4,

    74

	CH_PRI_2          = 2 << 4,

    75

	CH_PRI_3          = 3 << 4,

    76

	CH_PRI_SHL        = 4,

    77

	CH_NUM_PRI_LEVELS = 4,

    78

};

    79

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

enum VarTypes {

    87

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

    88

	SLE_FILE_I8       = 0,

    89

	SLE_FILE_U8       = 1,

    90

	SLE_FILE_I16      = 2,

    91

	SLE_FILE_U16      = 3,

    92

	SLE_FILE_I32      = 4,

    93

	SLE_FILE_U32      = 5,

    94

	SLE_FILE_I64      = 6,

    95

	SLE_FILE_U64      = 7,

    96

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

    97

	SLE_FILE_STRING   = 9,

    98

	/* 6 more possible file-primitives */

    99

   100

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

   101

	SLE_VAR_BL    =  0 << 4,

   102

	SLE_VAR_I8    =  1 << 4,

   103

	SLE_VAR_U8    =  2 << 4,

   104

	SLE_VAR_I16   =  3 << 4,

   105

	SLE_VAR_U16   =  4 << 4,

   106

	SLE_VAR_I32   =  5 << 4,

   107

	SLE_VAR_U32   =  6 << 4,

   108

	SLE_VAR_I64   =  7 << 4,

   109

	SLE_VAR_U64   =  8 << 4,

   110

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

   111

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

   112

	SLE_VAR_STRBQ = 11 << 4, ///< string enclosed in quotes (with pre-allocated buffer)

   113

	SLE_VAR_STR   = 12 << 4, ///< string pointer

   114

	SLE_VAR_STRQ  = 13 << 4, ///< string pointer enclosed in quotes

   115

	/* 2 more possible memory-primitives */

   116

   117

	/* Shortcut values */

   118

	SLE_VAR_CHAR = SLE_VAR_I8,

   119

   120

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

   121

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

   122

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

   123

	SLE_BOOL         = SLE_FILE_I8  | SLE_VAR_BL,

   124

	SLE_INT8         = SLE_FILE_I8  | SLE_VAR_I8,

   125

	SLE_UINT8        = SLE_FILE_U8  | SLE_VAR_U8,

   126

	SLE_INT16        = SLE_FILE_I16 | SLE_VAR_I16,

   127

	SLE_UINT16       = SLE_FILE_U16 | SLE_VAR_U16,

   128

	SLE_INT32        = SLE_FILE_I32 | SLE_VAR_I32,

   129

	SLE_UINT32       = SLE_FILE_U32 | SLE_VAR_U32,

   130

	SLE_INT64        = SLE_FILE_I64 | SLE_VAR_I64,

   131

	SLE_UINT64       = SLE_FILE_U64 | SLE_VAR_U64,

   132

	SLE_CHAR         = SLE_FILE_I8  | SLE_VAR_CHAR,

   133

	SLE_STRINGID     = SLE_FILE_STRINGID | SLE_VAR_U16,

   134

	SLE_STRINGBUF    = SLE_FILE_STRING   | SLE_VAR_STRB,

   135

	SLE_STRINGBQUOTE = SLE_FILE_STRING   | SLE_VAR_STRBQ,

   136

	SLE_STRING       = SLE_FILE_STRING   | SLE_VAR_STR,

   137

	SLE_STRINGQUOTE  = SLE_FILE_STRING   | SLE_VAR_STRQ,

   138

   139

	/* Shortcut values */

   140

	SLE_UINT  = SLE_UINT32,

   141

	SLE_INT   = SLE_INT32,

   142

	SLE_STRB  = SLE_STRINGBUF,

   143

	SLE_STRBQ = SLE_STRINGBQUOTE,

   144

	SLE_STR   = SLE_STRING,

   145

	SLE_STRQ  = SLE_STRINGQUOTE,

   146

   147

	/* 8 bytes allocated for a maximum of 8 flags

   148

	 * Flags directing saving/loading of a variable */

   149

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

   150

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

   151

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

   152

	/* 5 more possible flags */

   153

};

   154

   155

typedef uint32 VarType;

   156

   157

enum SaveLoadTypes {

   158

	SL_VAR       =  0,

   159

	SL_REF       =  1,

   160

	SL_ARR       =  2,

   161

	SL_STR       =  3,

   162

	SL_LST       =  4,

   163

	// non-normal save-load types

   165

	SL_INCLUDE   =  9,

   166

	SL_END       = 15

   167

};

   168

   169

typedef byte SaveLoadType;

   170

   171

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

   172

struct SaveLoad {

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

};

   184

   185

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

   186

typedef SaveLoad SaveLoadGlobVarList;

   187

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

#define SLE_CONDLST(base, variable, type, from, to) SLE_GENERAL(SL_LST, base, variable, type, 0, from, to)

   195

   196

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

   197

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

   198

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

   199

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

   200

#define SLE_LST(base, variable, type) SLE_CONDLST(base, variable, type, 0, SL_MAX_VERSION)

   201

   202

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

   203

   206

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

   207

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

   208

   209

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

   210

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

   211

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

   212

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

   213

   214

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

   215

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

   216

   218

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

   219

   220

/* End marker */

   221

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

   222

   223

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

   224

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

   225

   226

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

   227

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

   228

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

   229

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

   230

#define SLEG_CONDLST(variable, type, from, to) SLEG_GENERAL(SL_LST, variable, type, 0, from, to)

   231

   232

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

   233

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

   234

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

   235

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

   236

#define SLEG_LST(variable, type) SLEG_CONDLST(variable, type, 0, SL_MAX_VERSION)

   237

   238

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

   239

   240

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

   241

   242

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

   243

 */

   244

static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor)

   245

{

   246

	extern uint16 _sl_version;

   247

	extern byte   _sl_minor_version;

   248

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

   249

}

   250

   251

/** Checks if the savegame is below version.

   252

 */

   253

static inline bool CheckSavegameVersion(uint16 version)

   254

{

   255

	extern uint16 _sl_version;

   256

	return _sl_version < version;

   257

}

   258

   259

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

   260

 * active savegame version */

   261

static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)

   262

{

   263

	extern const uint16 SAVEGAME_VERSION;

   264

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

   265

   266

	return true;

   267

}

   268

   269

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

   270

 * as it is represented in memory

   271

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

   272

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

   273

static inline VarType GetVarMemType(VarType type)

   274

{

   275

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

   276

}

   277

   278

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

   279

 * as it is represented in a savegame/file

   280

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

   281

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

   282

static inline VarType GetVarFileType(VarType type)

   283

{

   284

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

   285

}

   286

   287

/** Get the address of the variable. Which one to pick depends on the object

   288

 * pointer. If it is NULL we are dealing with global variables so the address

   289

 * is taken. If non-null only the offset is stored in the union and we need

   290

 * to add this to the address of the object */

   291

static inline void *GetVariableAddress(const void *object, const SaveLoad *sld)

   292

{

   293

	return (byte*)object + (ptrdiff_t)sld->address;

   294

}

   295

   296

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

   297

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

   298

   299

void SlSetArrayIndex(uint index);

   300

int SlIterateArray();

   301

   302

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

   303

uint SlGetFieldLength();

   304

void SlSetLength(size_t length);

   305

size_t SlCalcObjMemberLength(const void *object, const SaveLoad *sld);

   306

   307

byte SlReadByte();

   308

void SlWriteByte(byte b);

   309

   310

void SlGlobList(const SaveLoadGlobVarList *sldg);

   311

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

   312

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

   313

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

   314

   315

void SaveFileStart();

   316

void SaveFileDone();

   317

void SaveFileError();

   318

#endif /* SAVELOAD_H */