1

/* $Id$ */

     2

     3

#ifndef NEWGRF_CONFIG_H

     4

#define NEWGRF_CONFIG_H

     5

     6

#include "openttd.h"

     7

     8

/* GRF config bit flags */

     9

typedef enum {

    10

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

    11

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

    12

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

    13

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

    14

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

    15

} GCF_Flags;

    16

    17

typedef enum {

    18

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

    19

	GCS_DISABLED,     ///< GRF file is disabled

    20

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

    21

	GCS_INITIALISED,  ///< GRF file has been initialised

    22

	GCS_ACTIVATED     ///< GRF file has been activated

    23

} GRFStatus;

    24

    25

typedef enum {

    26

	GLC_ALL_GOOD,

    27

	GLC_COMPATIBLE,

    28

	GLC_NOT_FOUND

    29

} GRFListCompatibility;

    30

    31

typedef struct GRFIdentifier {

    32

	uint32 grfid;

    33

	uint8 md5sum[16];

    34

} GRF;

    35

    36

typedef struct GRFError {

    37

	StringID message;

    38

	StringID data;

    39

	StringID severity;

    40

	uint8 num_params;

    41

	uint8 param_number[2];

    42

} GRFError;

    43

    44

typedef struct GRFConfig : public GRFIdentifier {

    45

	char *filename;

    46

	char *name;

    47

	char *info;

    48

	GRFError *error;

    49

    50

	uint8 flags;

    51

	GRFStatus status;

    52

	uint32 param[0x80];

    53

	uint8 num_params;

    54

    55

	struct GRFConfig *next;

    56

} GRFConfig;

    57

    58

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

    59

extern GRFConfig *_all_grfs;

    60

    61

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

    62

extern GRFConfig *_grfconfig;

    63

    64

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

    65

extern GRFConfig *_grfconfig_newgame;

    66

    67

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

    68

extern GRFConfig *_grfconfig_static;

    69

    71

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

    72

GRFConfig *GetGRFConfig(uint32 grfid);

    73

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

    74

void AppendStaticGRFConfigs(GRFConfig **dst);

    75

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

    76

void ClearGRFConfig(GRFConfig **config);

    77

void ClearGRFConfigList(GRFConfig **config);

    78

void ResetGRFConfig(bool defaults);

    80

bool FillGRFDetails(GRFConfig *config, bool is_static);

    81

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

    82

    83

/* In newgrf_gui.c */

    84

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

    85

    86

#ifdef ENABLE_NETWORK

    87

/* For communication about GRFs over the network */

    88

#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"

    89

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

    90

#endif /* ENABLE_NETWORK */

    91

    92

#endif /* NEWGRF_CONFIG_H */