1

/* $Id$ */

     2

     3

#ifndef SAVELOAD_H

     4

#define SAVELOAD_H

     5

     6

#include <setjmp.h>

     7

     8

typedef enum SaveOrLoadResult {

     9

	SL_OK = 0, // completed successfully

    10

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

    11

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

    12

} SaveOrLoadResult;

    13

    14

typedef enum SaveOrLoadMode {

    15

	SL_INVALID = -1,

    16

	SL_LOAD = 0,

    17

	SL_SAVE = 1,

    18

	SL_OLD_LOAD = 2,

    19

} SaveOrLoadMode;

    20

    21

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

    23

    24

    25

typedef void ChunkSaveLoadProc(void);

    26

typedef void AutolengthProc(void *arg);

    27

    28

typedef struct SaveLoadGlobVarList {

    29

	void *address;

    30

	byte conv;

    31

	byte from_version;

    32

	byte to_version;

    33

} SaveLoadGlobVarList;

    34

    35

typedef struct {

    36

	uint32 id;

    37

	ChunkSaveLoadProc *save_proc;

    38

	ChunkSaveLoadProc *load_proc;

    39

	uint32 flags;

    40

} ChunkHandler;

    41

    42

typedef struct {

    43

	byte null;

    44

} NullStruct;

    45

    46

typedef void WriterProc(uint len);

    47

typedef uint ReaderProc(void);

    48

    49

typedef enum SLRefType {

    50

	REF_ORDER       = 0,

    51

	REF_VEHICLE     = 1,

    52

	REF_STATION     = 2,

    53

	REF_TOWN        = 3,

    54

	REF_VEHICLE_OLD = 4,

    55

	REF_ROADSTOPS   = 5

    56

} SLRefType;

    57

    58

typedef uint ReferenceToIntProc(const void *obj, SLRefType rt);

    59

typedef void *IntToReferenceProc(uint index, SLRefType rt);

    60

    61

typedef struct SaveLoad SaveLoad;

    62

    63

/** The saveload struct, containing reader-writer functions, bufffer, version, etc. */

    64

typedef struct {

    65

	bool save;                           /// are we doing a save or a load atm. True when saving

    66

	byte need_length;                    /// ???

    67

	byte block_mode;                     /// ???

    68

	bool error;                          /// did an error occur or not

    69

	byte version;                        /// the major savegame version identifier

    70

	uint16 full_version;                 /// the full version of the savegame

    71

    72

	int obj_len;                         /// the length of the current object we are busy with

    73

	int array_index, last_array_index;   /// in the case of an array, the current and last positions

    74

    75

	uint32 offs_base;                    /// the offset in number of bytes since we started writing data (eg uncompressed savegame size)

    76

    77

	WriterProc *write_bytes;             /// savegame writer function

    78

	ReaderProc *read_bytes;              /// savegame loader function

    79

    80

	ReferenceToIntProc *ref_to_int_proc; /// function to convert pointers to numbers when saving a game

    81

	IntToReferenceProc *int_to_ref_proc; /// function to convert numbers to pointers when loading a game

    82

    83

	const ChunkHandler* const *chs;      /// the chunk of data that is being processed atm (vehicles, signs, etc.)

    84

	const SaveLoad* const *includes;     /// the internal layouf of the given chunk

    85

    86

	/** When saving/loading savegames, they are always saved to a temporary memory-place

    87

	 * to be flushed to file (save) or to final place (load) when full. */

    88

	byte *bufp, *bufe;                   /// bufp(ointer) gives the current position in the buffer bufe(nd) gives the end of the buffer

    89

    90

	// these 3 may be used by compressor/decompressors.

    91

	byte *buf;                           /// pointer to temporary memory to read/write, initialized by SaveLoadFormat->initread/write

    92

	uint bufsize;                        /// the size of the temporary memory *buf

    93

	FILE *fh;                            /// the file from which is read or written to

    94

    95

	void (*excpt_uninit)(void);          /// the function to execute on any encountered error

    96

	const char *excpt_msg;               /// the error message

    97

	jmp_buf excpt;                       /// @todo used to jump to "exception handler";  really ugly

    98

} SaverLoader;

    99

   100

extern SaverLoader _sl;

   101

   102

enum {

   103

	INC_VEHICLE_COMMON = 0,

   104

};

   105

   106

enum {

   107

	CH_RIFF = 0,

   108

	CH_ARRAY = 1,

   109

	CH_SPARSE_ARRAY = 2,

   110

	CH_TYPE_MASK = 3,

   111

	CH_LAST = 8,

   112

	CH_AUTO_LENGTH = 16,

   113

	CH_PRI_0 = 0 << 4,

   114

	CH_PRI_1 = 1 << 4,

   115

	CH_PRI_2 = 2 << 4,

   116

	CH_PRI_3 = 3 << 4,

   117

	CH_PRI_SHL = 4,

   118

	CH_NUM_PRI_LEVELS = 4,

   119

};

   120

   121

typedef enum VarTypes {

   122

	SLE_FILE_I8  = 0,

   123

	SLE_FILE_U8  = 1,

   124

	SLE_FILE_I16 = 2,

   125

	SLE_FILE_U16 = 3,

   126

	SLE_FILE_I32 = 4,

   127

	SLE_FILE_U32 = 5,

   128

	SLE_FILE_I64 = 6,

   129

	SLE_FILE_U64 = 7,

   130

   131

	SLE_FILE_STRINGID = 8,

   132

//	SLE_FILE_IVAR = 8,

   133

//	SLE_FILE_UVAR = 9,

   134

   135

	SLE_VAR_I8   = 0 << 4,

   136

	SLE_VAR_U8   = 1 << 4,

   137

	SLE_VAR_I16  = 2 << 4,

   138

	SLE_VAR_U16  = 3 << 4,

   139

	SLE_VAR_I32  = 4 << 4,

   140

	SLE_VAR_U32  = 5 << 4,

   141

	SLE_VAR_I64  = 6 << 4,

   142

	SLE_VAR_U64  = 7 << 4,

   143

   144

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

   145

   146

	SLE_VAR_INT  = SLE_VAR_I32,

   147

	SLE_VAR_UINT = SLE_VAR_U32,

   148

   149

	SLE_INT8   = SLE_FILE_I8  | SLE_VAR_I8,

   150

	SLE_UINT8  = SLE_FILE_U8  | SLE_VAR_U8,

   151

	SLE_INT16  = SLE_FILE_I16 | SLE_VAR_I16,

   152

	SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,

   153

	SLE_INT32  = SLE_FILE_I32 | SLE_VAR_I32,

   154

	SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,

   155

	SLE_INT64  = SLE_FILE_I64 | SLE_VAR_I64,

   156

	SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,

   157

   158

	SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,

   159

} VarType;

   160

   161

enum SaveLoadTypes {

   162

	SL_VAR       = 0,

   163

	SL_REF       = 1,

   164

	SL_ARR       = 2,

   165

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

   166

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

   167

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

   168

	// non-normal save-load types

   169

	SL_WRITEBYTE = 8,

   170

	SL_INCLUDE   = 9,

   171

	SL_END       = 15

   172

};

   173

   174

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

   175

struct SaveLoad {

   176

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

   177

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

   178

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

   179

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

   180

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

   181

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

   182

};

   183

   184

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

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

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

   196

   197

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

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

   205

/* End marker */

   206

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

   207

   208

void SlSetArrayIndex(uint index);

   209

int SlIterateArray(void);

   210

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

   211

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

   212

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

   213

uint SlGetFieldLength(void);

   214

int SlReadByte(void);

   215

void SlSetLength(size_t length);

   216

void SlWriteByte(byte b);

   217

void SlGlobList(const SaveLoadGlobVarList *desc);

   218

   219

#endif /* SAVELOAD_H */