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);

    22

void WaitTillSaved(void);

    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

    64

    65

    66

enum {

    67

	INC_VEHICLE_COMMON = 0,

    68

};

    69

    70

enum {

    71

	CH_RIFF = 0,

    72

	CH_ARRAY = 1,

    73

	CH_SPARSE_ARRAY = 2,

    74

	CH_TYPE_MASK = 3,

    75

	CH_LAST = 8,

    76

	CH_AUTO_LENGTH = 16,

    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

typedef enum VarTypes {

    86

	SLE_FILE_I8  = 0,

    87

	SLE_FILE_U8  = 1,

    88

	SLE_FILE_I16 = 2,

    89

	SLE_FILE_U16 = 3,

    90

	SLE_FILE_I32 = 4,

    91

	SLE_FILE_U32 = 5,

    92

	SLE_FILE_I64 = 6,

    93

	SLE_FILE_U64 = 7,

    94

    95

	SLE_FILE_STRINGID = 8,

    96

//	SLE_FILE_IVAR = 8,

    97

//	SLE_FILE_UVAR = 9,

    98

    99

	SLE_VAR_I8   = 0 << 4,

   100

	SLE_VAR_U8   = 1 << 4,

   101

	SLE_VAR_I16  = 2 << 4,

   102

	SLE_VAR_U16  = 3 << 4,

   103

	SLE_VAR_I32  = 4 << 4,

   104

	SLE_VAR_U32  = 5 << 4,

   105

	SLE_VAR_I64  = 6 << 4,

   106

	SLE_VAR_U64  = 7 << 4,

   107

   108

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

   109

   110

	SLE_VAR_INT  = SLE_VAR_I32,

   111

	SLE_VAR_UINT = SLE_VAR_U32,

   112

   113

	SLE_INT8   = SLE_FILE_I8  | SLE_VAR_I8,

   114

	SLE_UINT8  = SLE_FILE_U8  | SLE_VAR_U8,

   115

	SLE_INT16  = SLE_FILE_I16 | SLE_VAR_I16,

   116

	SLE_UINT16 = SLE_FILE_U16 | SLE_VAR_U16,

   117

	SLE_INT32  = SLE_FILE_I32 | SLE_VAR_I32,

   118

	SLE_UINT32 = SLE_FILE_U32 | SLE_VAR_U32,

   119

	SLE_INT64  = SLE_FILE_I64 | SLE_VAR_I64,

   120

	SLE_UINT64 = SLE_FILE_U64 | SLE_VAR_U64,

   121

   122

	SLE_STRINGID = SLE_FILE_STRINGID | SLE_VAR_U16,

   123

} VarType;

   124

   125

enum SaveLoadTypes {

   126

	SL_VAR       = 0,

   127

	SL_REF       = 1,

   128

	SL_ARR       = 2,

   129

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

   130

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

   131

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

   132

	// non-normal save-load types

   133

	SL_WRITEBYTE = 8,

   134

	SL_INCLUDE   = 9,

   135

	SL_END       = 15

   136

};

   137

   138

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   147

   148

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

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

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

   156

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

   157

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

   158

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

   159

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

   160

   161

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

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

   169

/* End marker */

   170

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

   171

   172

void SlSetArrayIndex(uint index);

   173

int SlIterateArray(void);

   174

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

   175

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

   176

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

   177

uint SlGetFieldLength(void);

   178

int SlReadByte(void);

   179

void SlSetLength(size_t length);

   180

void SlWriteByte(byte b);

   181

void SlGlobList(const SaveLoadGlobVarList *desc);

   182

   183

#endif /* SAVELOAD_H */