1

#ifndef SAVELOAD_H

     2

#define SAVELOAD_H

     3

     4

#include <setjmp.h>

     5

     6

typedef void ChunkSaveLoadProc(void);

     7

typedef void AutolengthProc(void *arg);

     8

     9

typedef struct SaveLoadGlobVarList {

    10

	void *address;

    11

	byte conv;

    12

	byte from_version;

    13

	byte to_version;

    14

} SaveLoadGlobVarList;

    15

    16

typedef struct {

    17

	uint32 id;

    18

	ChunkSaveLoadProc *save_proc;

    19

	ChunkSaveLoadProc *load_proc;

    20

	uint32 flags;

    21

} ChunkHandler;

    22

    23

typedef struct {

    24

	byte null;

    25

} NullStruct;

    26

    27

typedef void WriterProc(uint len);

    28

typedef uint ReaderProc(void);

    29

    30

typedef enum SLRefType {

    31

	REF_ORDER       = 0,

    32

	REF_VEHICLE     = 1,

    33

	REF_STATION     = 2,

    34

	REF_TOWN        = 3,

    35

	REF_VEHICLE_OLD = 4,

    36

	REF_ROADSTOPS   = 5

    37

} SLRefType;

    38

    39

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

    40

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

    41

    42

typedef struct SaveLoad SaveLoad;

    43

    44

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

    45

typedef struct {

    46

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

    47

	byte need_length;                    /// ???

    48

	byte block_mode;                     /// ???

    49

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

    50

	byte version;                        /// the major savegame version identifier

    51

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

    52

    53

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

    54

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

    55

    56

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

    57

    58

	WriterProc *write_bytes;             /// savegame writer function

    59

	ReaderProc *read_bytes;              /// savegame loader function

    60

    61

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

    62

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

    63

    64

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

    65

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

    66

    67

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

    68

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

    69

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

    70

    71

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

    72

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

    73

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

    74

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

    75

    76

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

    77

	const char *excpt_msg;               /// the error message

    78

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

    79

} SaverLoader;

    80

    81

extern SaverLoader _sl;

    82

    83

enum {

    84

	INC_VEHICLE_COMMON = 0,

    85

};

    86

    87

enum {

    88

	CH_RIFF = 0,

    89

	CH_ARRAY = 1,

    90

	CH_SPARSE_ARRAY = 2,

    91

	CH_TYPE_MASK = 3,

    92

	CH_LAST = 8,

    93

	CH_AUTO_LENGTH = 16,

    94

	CH_PRI_0 = 0 << 4,

    95

	CH_PRI_1 = 1 << 4,

    96

	CH_PRI_2 = 2 << 4,

    97

	CH_PRI_3 = 3 << 4,

    98

	CH_PRI_SHL = 4,

    99

	CH_NUM_PRI_LEVELS = 4,

   100

};

   101

   102

typedef enum VarTypes {

   103

	SLE_FILE_I8  = 0,

   104

	SLE_FILE_U8  = 1,

   105

	SLE_FILE_I16 = 2,

   106

	SLE_FILE_U16 = 3,

   107

	SLE_FILE_I32 = 4,

   108

	SLE_FILE_U32 = 5,

   109

	SLE_FILE_I64 = 6,

   110

	SLE_FILE_U64 = 7,

   111

   112

	SLE_FILE_STRINGID = 8,

   113

//	SLE_FILE_IVAR = 8,

   114

//	SLE_FILE_UVAR = 9,

   115

   116

	SLE_VAR_I8   = 0 << 4,

   117

	SLE_VAR_U8   = 1 << 4,

   118

	SLE_VAR_I16  = 2 << 4,

   119

	SLE_VAR_U16  = 3 << 4,

   120

	SLE_VAR_I32  = 4 << 4,

   121

	SLE_VAR_U32  = 5 << 4,

   122

	SLE_VAR_I64  = 6 << 4,

   123

	SLE_VAR_U64  = 7 << 4,

   124

   125

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

   126

   127

	SLE_VAR_INT  = SLE_VAR_I32,

   128

	SLE_VAR_UINT = SLE_VAR_U32,

   129

   130

	SLE_INT8   = SLE_FILE_I8  | SLE_VAR_I8,

   131

	SLE_UINT8  = SLE_FILE_U8  | SLE_VAR_U8,

   132

	SLE_INT16  = SLE_FILE_I16 | SLE_VAR_I16,

   133

	SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,

   134

	SLE_INT32  = SLE_FILE_I32 | SLE_VAR_I32,

   135

	SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,

   136

	SLE_INT64  = SLE_FILE_I64 | SLE_VAR_I64,

   137

	SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,

   138

   139

	SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,

   140

} VarType;

   141

   142

enum SaveLoadTypes {

   143

	SL_VAR       = 0,

   144

	SL_REF       = 1,

   145

	SL_ARR       = 2,

   146

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

   147

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

   148

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

   149

	// non-normal save-load types

   150

	SL_WRITEBYTE = 8,

   151

	SL_INCLUDE   = 9,

   152

	SL_END       = 15

   153

};

   154

   155

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

   156

struct SaveLoad {

   157

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

   158

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

   159

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

   160

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

   161

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

   162

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

   163

};

   164

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

#define SLE_WRITEBYTE(base, variable, game_value, file_value) {SL_WRITEBYTE, 0, offsetof(base, variable), 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) {SL_INCLUDE, 0, offsetof(base, variable), 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_VARX(offset, type) {SL_VAR, type, offset, 0, 0, 0}

   180

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

   181

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

   182

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

   183

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

   184

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

   185

   186

/* End marker */

   187

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

   188

   189

void SlSetArrayIndex(uint index);

   190

int SlIterateArray(void);

   192

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

   193

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

   194

uint SlGetFieldLength(void);

   195

int SlReadByte(void);

   196

void SlSetLength(size_t length);

   197

void SlWriteByte(byte b);

   198

void SlGlobList(const SaveLoadGlobVarList *desc);

   199

   200

#endif /* SAVELOAD_H */