1

/* $Id$ */

     2

     3

/** @file newgrf_config.h */

     4

     5

#ifndef NEWGRF_CONFIG_H

     6

#define NEWGRF_CONFIG_H

     7

     8

#include "openttd.h"

     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

};

    19

    20

enum GRFStatus {

    21

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

    22

	GCS_DISABLED,     ///< GRF file is disabled

    23

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

    24

	GCS_INITIALISED,  ///< GRF file has been initialised

    25

	GCS_ACTIVATED     ///< GRF file has been activated

    26

};

    27

    28

enum GRFListCompatibility{

    29

	GLC_ALL_GOOD,

    30

	GLC_COMPATIBLE,

    31

	GLC_NOT_FOUND

    32

};

    33

    34

struct GRFIdentifier {

    35

	uint32 grfid;

    36

	uint8 md5sum[16];

    37

};

    38

    39

struct GRFError {

    40

	char *custom_message;

    41

	char *data;

    42

	StringID message;

    43

	StringID severity;

    44

	uint8 num_params;

    45

	uint8 param_number[2];

    46

};

    47

    48

struct GRFConfig : public GRFIdentifier {

    49

	char *filename;

    50

	char *name;

    51

	char *info;

    52

	GRFError *error;

    53

    54

	uint8 flags;

    55

	GRFStatus status;

    56

	uint32 param[0x80];

    57

	uint8 num_params;

    58

    59

	struct GRFConfig *next;

    60

};

    61

    62

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

    63

extern GRFConfig *_all_grfs;

    64

    65

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

    66

extern GRFConfig *_grfconfig;

    67

    68

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

    69

extern GRFConfig *_grfconfig_newgame;

    70

    71

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

    72

extern GRFConfig *_grfconfig_static;

    73

    74

void ScanNewGRFFiles();

    75

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

    76

GRFConfig *GetGRFConfig(uint32 grfid);

    77

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

    78

void AppendStaticGRFConfigs(GRFConfig **dst);

    79

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

    80

void ClearGRFConfig(GRFConfig **config);

    81

void ClearGRFConfigList(GRFConfig **config);

    82

void ResetGRFConfig(bool defaults);

    83

GRFListCompatibility IsGoodGRFConfigList();

    84

bool FillGRFDetails(GRFConfig *config, bool is_static);

    85

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

    86

    87

/* In newgrf_gui.cpp */

    88

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

    89

    90

#ifdef ENABLE_NETWORK

    91

/* For communication about GRFs over the network */

    92

#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"

    93

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

    94

#endif /* ENABLE_NETWORK */

    95

    96

#endif /* NEWGRF_CONFIG_H */