1

/* $Id$ */

     2

     3

/** @file settings.h */

     4

     5

#ifndef SETTINGS_H

     6

#define SETTINGS_H

     7

     8

#include "saveload.h"

     9

    10

/** Convention/Type of settings. This is then further specified if necessary

    11

 * with the SLE_ (SLE_VAR/SLE_FILE) enums in saveload.h

    12

 * @see VarTypes

    13

 * @see SettingDescBase */

    14

enum SettingDescTypeLong {

    15

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

    16

	SDT_BEGIN       = 0,

    17

	SDT_NUMX        = 0, ///< any number-type

    18

	SDT_BOOLX       = 1, ///< a boolean number

    19

	SDT_ONEOFMANY   = 2, ///< bitmasked number where only ONE bit may be set

    20

	SDT_MANYOFMANY  = 3, ///< bitmasked number where MULTIPLE bits may be set

    21

	SDT_INTLIST     = 4, ///< list of integers seperated by a comma ','

    22

	SDT_STRING      = 5, ///< string with a pre-allocated buffer

    23

	SDT_END,

    24

	/* 10 more possible primitives */

    25

};

    26

    27

template <> struct EnumPropsT<SettingDescTypeLong> : MakeEnumPropsT<SettingDescTypeLong, byte, SDT_BEGIN, SDT_END, SDT_END> {};

    28

typedef TinyEnumT<SettingDescTypeLong> SettingDescType;

    29

    30

    31

enum SettingGuiFlagLong {

    32

	/* 8 bytes allocated for a maximum of 8 flags

    33

	 * Flags directing saving/loading of a variable */

    34

	SGF_NONE = 0,

    35

	SGF_0ISDISABLED  = 1 << 0, ///< a value of zero means the feature is disabled

    36

	SGF_NOCOMMA      = 1 << 1, ///< number without any thousand seperators (no formatting)

    37

	SGF_MULTISTRING  = 1 << 2, ///< the value represents a limited number of string-options (internally integer)

    38

	SGF_NETWORK_ONLY = 1 << 3, ///< this setting only applies to network games

    39

	SGF_CURRENCY     = 1 << 4, ///< the number represents money, so when reading value multiply by exchange rate

    40

	SGF_END          = 1 << 5,

    41

	/* 3 more possible flags */

    42

};

    43

    44

DECLARE_ENUM_AS_BIT_SET(SettingGuiFlagLong);

    45

template <> struct EnumPropsT<SettingGuiFlagLong> : MakeEnumPropsT<SettingGuiFlagLong, byte, SGF_NONE, SGF_END, SGF_END> {};

    46

typedef TinyEnumT<SettingGuiFlagLong> SettingGuiFlag;

    47

    48

    49

typedef int32 OnChange(int32 var);          ///< callback prototype on data modification

    50

typedef int32 OnConvert(const char *value); ///< callback prototype for convertion error

    51

    52

struct SettingDescBase {

    53

	const char *name;       ///< name of the setting. Used in configuration file and for console

    54

	const void *def;        ///< default value given when none is present

    55

	SettingDescType cmd;    ///< various flags for the variable

    56

	SettingGuiFlag flags;   ///< handles how a setting would show up in the GUI (text/currency, etc.)

    57

	int32 min, max;         ///< minimum and maximum values

    58

	int32 interval;         ///< the interval to use between settings in the 'patches' window. If interval is '0' the interval is dynamically determined

    59

	const char *many;       ///< ONE/MANY_OF_MANY: string of possible values for this type

    60

	StringID str;           ///< (translated) string with descriptive text; gui and console

    61

	OnChange *proc;         ///< callback procedure for when the value is changed

    62

	OnConvert *proc_cnvt;   ///< callback procedure when loading value mechanism fails

    63

};

    64

    65

struct SettingDesc {

    66

	SettingDescBase desc;   ///< Settings structure (going to configuration file)

    67

	SaveLoad save;          ///< Internal structure (going to savegame, parts to config)

    68

};

    69

    70

/* NOTE: The only difference between SettingDesc and SettingDescGlob is

    71

 * that one uses global variables as a source and the other offsets

    72

 * in a struct which are bound to a certain variable during runtime.

    73

 * The only way to differentiate between these two is to check if an object

    74

 * has been passed to the function or not. If not, then it is a global variable

    75

 * and save->variable has its address, otherwise save->variable only holds the

    76

 * offset in a certain struct */

    77

typedef SettingDesc SettingDescGlobVarList;

    78

    79

enum IniGroupType {

    80

	IGT_VARIABLES = 0, ///< values of the form "landscape = hilly"

    81

	IGT_LIST      = 1, ///< a list of values, seperated by \n and terminated by the next group block

    82

};

    83

    84

/** The patch values that are used for new games and/or modified in config file */

    85

extern Patches _patches_newgame;

    86

    87

bool IConsoleSetPatchSetting(const char *name, int32 value);

    88

void IConsoleGetPatchSetting(const char *name);

    89

void IConsoleListPatches();

    90

const SettingDesc *GetPatchFromName(const char *name, uint *i);

    91

bool SetPatchValue(uint index, const Patches *object, int32 value);

    92

    93

#endif /* SETTINGS_H */