1

/* $Id$ */

     2

     3

/** @file newgrf_config.h */

     4

     5

#ifndef NEWGRF_CONFIG_H

     6

#define NEWGRF_CONFIG_H

     7

     9

    10

/* GRF config bit flags */

    11

enum GCF_Flags {

    12

	GCF_SYSTEM,    ///< GRF file is an openttd-internal system grf

    13

	GCF_UNSAFE,    ///< GRF file is unsafe for static usage

    14

	GCF_STATIC,    ///< GRF file is used statically (can be used in any MP game)

    15

	GCF_COMPATIBLE,///< GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)

    16

	GCF_COPY,      ///< The data is copied from a grf in _all_grfs

    17

	GCF_INIT_ONLY, ///< GRF file is processed up to GLS_INIT

    18

	GCF_RESERVED,  ///< GRF file passed GLS_RESERVE stage

    19

};

    20

    21

enum GRFStatus {

    22

	GCS_UNKNOWN,      ///< The status of this grf file is unknown

    23

	GCS_DISABLED,     ///< GRF file is disabled

    24

	GCS_NOT_FOUND,    ///< GRF file was not found in the local cache

    25

	GCS_INITIALISED,  ///< GRF file has been initialised

    26

	GCS_ACTIVATED     ///< GRF file has been activated

    27

};

    28

    29

enum GRFListCompatibility{

    30

	GLC_ALL_GOOD,

    31

	GLC_COMPATIBLE,

    32

	GLC_NOT_FOUND

    33

};

    34

    35

struct GRFIdentifier {

    36

	uint32 grfid;

    37

	uint8 md5sum[16];

    38

};

    39

    40

struct GRFError {

    41

	char *custom_message;

    42

	char *data;

    43

	StringID message;

    44

	StringID severity;

    45

	uint8 num_params;

    46

	uint8 param_number[2];

    47

};

    48

    49

struct GRFConfig : public GRFIdentifier {

    50

	char *filename;

    51

	char *name;

    52

	char *info;

    53

	GRFError *error;

    54

    55

	uint8 flags;

    56

	GRFStatus status;

    57

	uint32 param[0x80];

    58

	uint8 num_params;

    59

    60

	struct GRFConfig *next;

    61

    62

	bool IsOpenTTDBaseGRF() const;

    63

};

    64

    65

/* First item in list of all scanned NewGRFs */

    66

extern GRFConfig *_all_grfs;

    67

    68

/* First item in list of current GRF set up */

    69

extern GRFConfig *_grfconfig;

    70

    71

/* First item in list of default GRF set up */

    72

extern GRFConfig *_grfconfig_newgame;

    73

    74

/* First item in list of static GRF set up */

    75

extern GRFConfig *_grfconfig_static;

    76

    77

void ScanNewGRFFiles();

    78

const GRFConfig *FindGRFConfig(uint32 grfid, const uint8 *md5sum = NULL);

    79

GRFConfig *GetGRFConfig(uint32 grfid);

    80

GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only);

    81

void AppendStaticGRFConfigs(GRFConfig **dst);

    82

void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el);

    83

void ClearGRFConfig(GRFConfig **config);

    84

void ClearGRFConfigList(GRFConfig **config);

    85

void ResetGRFConfig(bool defaults);

    86

GRFListCompatibility IsGoodGRFConfigList();

    87

bool FillGRFDetails(GRFConfig *config, bool is_static);

    88

char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last);

    89

    90

/* In newgrf_gui.cpp */

    91

void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config);

    92

    93

#ifdef ENABLE_NETWORK

    94

/* For communication about GRFs over the network */

    95

#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"

    96

char *FindUnknownGRFName(uint32 grfid, uint8 *md5sum, bool create);

    97

#endif /* ENABLE_NETWORK */

    98

    99

#endif /* NEWGRF_CONFIG_H */