1

/* $Id$ */

     2

     3

/** @file saveload.h */

     4

     5

#ifndef SAVELOAD_H

     6

#define SAVELOAD_H

     7

     8

#include "fileio.h"

     9

    10

#ifdef SIZE_MAX

    11

#undef SIZE_MAX

    12

#endif

    13

    14

#define SIZE_MAX ((size_t)-1)

    15

    16

enum SaveOrLoadResult {

    17

	SL_OK     = 0, ///< completed successfully

    18

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

    19

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

    20

};

    21

    22

enum SaveOrLoadMode {

    23

	SL_INVALID  = -1,

    24

	SL_LOAD     =  0,

    25

	SL_SAVE     =  1,

    26

	SL_OLD_LOAD =  2,

    27

	SL_PNG      =  3,

    28

	SL_BMP      =  4,

    29

};

    30

    33

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

    34

void WaitTillSaved();

    35

void DoExitSave();

    36

    37

    38

typedef void ChunkSaveLoadProc();

    39

typedef void AutolengthProc(void *arg);

    40

    41

struct ChunkHandler {

    42

	uint32 id;

    43

	ChunkSaveLoadProc *save_proc;

    44

	ChunkSaveLoadProc *load_proc;

    45

	uint32 flags;

    46

};

    47

    48

struct NullStruct {

    49

	byte null;

    50

};

    51

    52

enum SLRefType {

    53

	REF_ORDER         = 0,

    54

	REF_VEHICLE       = 1,

    55

	REF_STATION       = 2,

    56

	REF_TOWN          = 3,

    57

	REF_VEHICLE_OLD   = 4,

    58

	REF_ROADSTOPS     = 5,

    59

	REF_ENGINE_RENEWS = 6,

    60

	REF_CARGO_PACKET  = 7,

    61

};

    62

    63

#define SL_MAX_VERSION 255

    64

    65

enum {

    66

	INC_VEHICLE_COMMON = 0,

    67

};

    68

    69

enum {

    70

	CH_RIFF         =  0,

    71

	CH_ARRAY        =  1,

    72

	CH_SPARSE_ARRAY =  2,

    73

	CH_TYPE_MASK    =  3,

    74

	CH_LAST         =  8,

    75

	CH_AUTO_LENGTH  = 16,

    76

    77

	CH_PRI_0          = 0 << 4,

    78

	CH_PRI_1          = 1 << 4,

    79

	CH_PRI_2          = 2 << 4,

    80

	CH_PRI_3          = 3 << 4,

    81

	CH_PRI_SHL        = 4,

    82

	CH_NUM_PRI_LEVELS = 4,

    83

};

    84

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

enum VarTypes {

    92

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

    93

	SLE_FILE_I8       = 0,

    94

	SLE_FILE_U8       = 1,

    95

	SLE_FILE_I16      = 2,

    96

	SLE_FILE_U16      = 3,

    97

	SLE_FILE_I32      = 4,

    98

	SLE_FILE_U32      = 5,

    99

	SLE_FILE_I64      = 6,

   100

	SLE_FILE_U64      = 7,

   101

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

   102

	SLE_FILE_STRING   = 9,

   103

	/* 6 more possible file-primitives */

   104

   105

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

   106

	SLE_VAR_BL    =  0 << 4,

   107

	SLE_VAR_I8    =  1 << 4,

   108

	SLE_VAR_U8    =  2 << 4,

   109

	SLE_VAR_I16   =  3 << 4,

   110

	SLE_VAR_U16   =  4 << 4,

   111

	SLE_VAR_I32   =  5 << 4,

   112

	SLE_VAR_U32   =  6 << 4,

   113

	SLE_VAR_I64   =  7 << 4,

   114

	SLE_VAR_U64   =  8 << 4,

   115

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

   116

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

   117

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

   118

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

   119

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

   120

	/* 2 more possible memory-primitives */

   121

   122

	/* Shortcut values */

   123

	SLE_VAR_CHAR = SLE_VAR_I8,

   124

   125

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

   126

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

   127

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

   128

	SLE_BOOL         = SLE_FILE_I8  | SLE_VAR_BL,

   129

	SLE_INT8         = SLE_FILE_I8  | SLE_VAR_I8,

   130

	SLE_UINT8        = SLE_FILE_U8  | SLE_VAR_U8,

   131

	SLE_INT16        = SLE_FILE_I16 | SLE_VAR_I16,

   132

	SLE_UINT16       = SLE_FILE_U16 | SLE_VAR_U16,

   133

	SLE_INT32        = SLE_FILE_I32 | SLE_VAR_I32,

   134

	SLE_UINT32       = SLE_FILE_U32 | SLE_VAR_U32,

   135

	SLE_INT64        = SLE_FILE_I64 | SLE_VAR_I64,

   136

	SLE_UINT64       = SLE_FILE_U64 | SLE_VAR_U64,

   137

	SLE_CHAR         = SLE_FILE_I8  | SLE_VAR_CHAR,

   138

	SLE_STRINGID     = SLE_FILE_STRINGID | SLE_VAR_U16,

   139

	SLE_STRINGBUF    = SLE_FILE_STRING   | SLE_VAR_STRB,

   140

	SLE_STRINGBQUOTE = SLE_FILE_STRING   | SLE_VAR_STRBQ,

   141

	SLE_STRING       = SLE_FILE_STRING   | SLE_VAR_STR,

   142

	SLE_STRINGQUOTE  = SLE_FILE_STRING   | SLE_VAR_STRQ,

   143

   144

	/* Shortcut values */

   145

	SLE_UINT  = SLE_UINT32,

   146

	SLE_INT   = SLE_INT32,

   147

	SLE_STRB  = SLE_STRINGBUF,

   148

	SLE_STRBQ = SLE_STRINGBQUOTE,

   149

	SLE_STR   = SLE_STRING,

   150

	SLE_STRQ  = SLE_STRINGQUOTE,

   151

   152

	/* 8 bytes allocated for a maximum of 8 flags

   153

	 * Flags directing saving/loading of a variable */

   154

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

   155

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

   156

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

   157

	/* 5 more possible flags */

   158

};

   159

   160

typedef uint32 VarType;

   161

   162

enum SaveLoadTypes {

   163

	SL_VAR       =  0,

   164

	SL_REF       =  1,

   165

	SL_ARR       =  2,

   166

	SL_STR       =  3,

   167

	SL_LST       =  4,

   168

	// non-normal save-load types

   169

	SL_WRITEBYTE =  8,

   170

	SL_INCLUDE   =  9,

   171

	SL_END       = 15

   172

};

   173

   174

typedef byte SaveLoadType;

   175

   176

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

   177

struct SaveLoad {

   178

	bool global;         ///< should we load a global variable or a non-global one

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

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

   187

	 * that is called to save it. address: global=true, offset: global=false */

   188

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

   189

};

   190

   191

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

   192

typedef SaveLoad SaveLoadGlobVarList;

   193

   194

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

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

   202

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

   203

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

   204

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

   205

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

   206

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

   207

   208

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

   209

   210

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

   211

#define SLE_WRITEBYTE(base, variable, value) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, value, value)

   212

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

   213

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

   214

   215

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

   216

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

   217

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

   218

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

   219

   220

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

   221

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

   222

   223

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

   224

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

   225

   226

/* End marker */

   227

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

   228

   229

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

   230

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

   231

   232

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

   233

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

   234

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

   235

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

   236

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

   237

   238

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

   239

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

   240

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

   241

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

   242

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

   243

   244

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

   245

   246

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

   247

   248

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

   249

 */

   250

static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor)

   251

{

   252

	extern uint16 _sl_version;

   253

	extern byte   _sl_minor_version;

   254

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

   255

}

   256

   257

/** Checks if the savegame is below version.

   258

 */

   259

static inline bool CheckSavegameVersion(uint16 version)

   260

{

   261

	extern uint16 _sl_version;

   262

	return _sl_version < version;

   263

}

   264

   265

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

   266

 * active savegame version */

   267

static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to)

   268

{

   269

	extern const uint16 SAVEGAME_VERSION;

   270

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

   271

   272

	return true;

   273

}

   274

   275

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

   276

 * as it is represented in memory

   277

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

   278

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

   279

static inline VarType GetVarMemType(VarType type)

   280

{

   281

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

   282

}

   283

   284

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

   285

 * as it is represented in a savegame/file

   286

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

   287

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

   288

static inline VarType GetVarFileType(VarType type)

   289

{

   290

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

   291

}

   292

   293

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

   294

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

   295

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

   296

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

   297

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

   298

{

   299

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

   300

}

   301

   302

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

   303

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

   304

   305

void SlSetArrayIndex(uint index);

   306

int SlIterateArray();

   307

   308

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

   309

uint SlGetFieldLength();

   310

void SlSetLength(size_t length);

   311

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

   312

   313

byte SlReadByte();

   314

void SlWriteByte(byte b);

   315

   316

void SlGlobList(const SaveLoadGlobVarList *sldg);

   317

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

   318

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

   319

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

   320

   321

void SaveFileStart();

   322

void SaveFileDone();

   323

void SaveFileError();

   324

#endif /* SAVELOAD_H */