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_DISABLED,  ///< GRF file is disabled

    11

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

    12

	GCF_ACTIVATED, ///< GRF file is active

    13

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

    14

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

    15

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

    16

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

    17

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

    18

} GCF_Flags;

    19

    20

typedef struct GRFIdentifier {

    21

	uint32 grfid;

    22

	uint8 md5sum[16];

    23

} GRF;

    24

    25

typedef struct GRFError {

    26

	StringID message;

    27

	StringID data;

    28

	StringID severity;

    29

	uint8 num_params;

    30

	uint8 param_number[2];

    31

} GRFError;

    32

    33

typedef struct GRFConfig : public GRFIdentifier {

    34

	char *filename;

    35

	char *name;

    36

	char *info;

    37

	GRFError *error;

    38

    39

	uint8 flags;

    40

	uint32 param[0x80];

    41

	uint8 num_params;

    42

    43

	struct GRFConfig *next;

    44

} GRFConfig;

    45

    46

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

    47

extern GRFConfig *_all_grfs;

    48

    49

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

    50

extern GRFConfig *_grfconfig;

    51

    52

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

    53

extern GRFConfig *_grfconfig_newgame;

    54

    55

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

    56

extern GRFConfig *_grfconfig_static;

    57

    58

void ScanNewGRFFiles(void);

    59

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

    60

GRFConfig *GetGRFConfig(uint32 grfid);

    61

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

    62

void AppendStaticGRFConfigs(GRFConfig **dst);

    63

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

    64

void ClearGRFConfig(GRFConfig **config);

    65

void ClearGRFConfigList(GRFConfig **config);

    66

void ResetGRFConfig(bool defaults);

    67

GCF_Flags IsGoodGRFConfigList(void);

    68

bool FillGRFDetails(GRFConfig *config, bool is_static);

    69

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

    70

    71

/* In newgrf_gui.c */

    72

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

    73

    74

#ifdef ENABLE_NETWORK

    75

/* For communication about GRFs over the network */

    76

#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"

    77

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

    78

#endif /* ENABLE_NETWORK */

    79

    80

#endif /* NEWGRF_CONFIG_H */