#ifndef SAVELOAD_H

#define SAVELOAD_H

#include "../fileio_type.h"

#include "../strings_type.h"

#include <string>

/** SaveLoad versions

 * Previous savegame versions, the trunk revision where they were

 * introduced and the released version that had that particular

 * savegame version.

	SL_DEQUE       =  5, ///< Save/load a deque.

	SL_STDSTR      =  6, ///< Save/load a \c std::string.

	/* non-normal save-load types */

	SL_WRITEBYTE   =  8,

	SL_VEH_INCLUDE =  9,

	SL_ST_INCLUDE  = 10,

};

typedef void *SaveLoadAddrProc(void *base, size_t extra);

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

struct SaveLoad {

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

	size_t size;                    ///< the sizeof size.

	SaveLoadAddrProc *address_proc; ///< callback proc the get the actual variable address in memory

	size_t extra_data;              ///< extra data for the callback proc

};

/**

 * Storage of simple variables, references (pointers), and arrays.

 * @param cmd      Load/save type. @see SaveLoadType

 * @param base     Name of the class or struct containing the variable.

 * @param variable Name of the variable in the class or struct referenced by \a base.

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

#define SLE_WRITEBYTE(base, variable) SLE_GENERAL(SL_WRITEBYTE, base, variable, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION, 0)

#define SLE_VEH_INCLUDE() {SL_VEH_INCLUDE, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION, 0, [] (void *b, size_t) { return b; }, 0}

#define SLE_ST_INCLUDE() {SL_ST_INCLUDE, 0, 0, SL_MIN_VERSION, SL_MAX_VERSION, 0, [] (void *b, size_t) { return b; }, 0}

/**

 * Storage of global simple variables, references (pointers), and arrays.

 * @param cmd      Load/save type. @see SaveLoadType

 * @param variable Name of the global variable.

 * @param type     Storage of the data in memory and in the savegame.

 * @param from     First savegame version that has the field.

 * @param length Length of the empty space.

 * @param from   First savegame version that has the empty space.

 * @param to     Last savegame version that has the empty space.

 */

#define SLEG_CONDNULL(length, from, to) {SL_ARR, SLE_FILE_U8 | SLE_VAR_NULL | SLF_NOT_IN_CONFIG, length, from, to, 0, nullptr, 0}

/**

 * Checks whether the savegame is below \a major.\a minor.

 * @param major Major number of the version to check against.

 * @param minor Minor number of the version to check against. If \a minor is 0 or not specified, only the major number is checked.

 * @return Savegame version is earlier than the specified version.

 */

/**

 * Get the address of the variable. Null-variables don't have an address,

 * everything else has a callback function that returns the address based

 * on the saveload data and the current object for non-globals.

 */

{

	/* Entry is a null-variable, mostly used to read old savegames etc. */

		return nullptr;

	}

	/* Everything else should be a non-null pointer. */

}

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

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

void SlSetArrayIndex(uint index);

int SlIterateArray();

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

size_t SlGetFieldLength();

void SlSetLength(size_t length);

byte SlReadByte();

void SlWriteByte(byte b);

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

void NORETURN SlError(StringID string, const char *extra_msg = nullptr);

void NORETURN SlErrorCorrupt(const char *msg);

void NORETURN SlErrorCorruptFmt(const char *format, ...) WARN_FORMAT(1, 2);

bool SaveloadCrashWithMissingNewGRFs();