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

};

    18

    19

enum GRFStatus {

    20

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

    21

	GCS_DISABLED,     ///< GRF file is disabled

    22

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

    23

	GCS_INITIALISED,  ///< GRF file has been initialised

    24

	GCS_ACTIVATED     ///< GRF file has been activated

    25

};

    26

    27

enum GRFListCompatibility{

    28

	GLC_ALL_GOOD,

    29

	GLC_COMPATIBLE,

    30

	GLC_NOT_FOUND

    31

};

    32

    33

struct GRFIdentifier {

    34

	uint32 grfid;

    35

	uint8 md5sum[16];

    36

};

    37

    38

struct GRFError {

    39

	StringID message;

    40

	StringID data;

    41

	StringID severity;

    42

	uint8 num_params;

    43

	uint8 param_number[2];

    44

};

    45

    46

struct GRFConfig : public GRFIdentifier {

    47

	char *filename;

    48

	char *full_path;

    49

	char *name;

    50

	char *info;

    51

	GRFError *error;

    52

    53

	uint8 flags;

    54

	GRFStatus status;

    55

	uint32 param[0x80];

    56

	uint8 num_params;

    57

    58

	struct GRFConfig *next;

    59

};

    60

    61

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

    62

extern GRFConfig *_all_grfs;

    63

    64

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

    65

extern GRFConfig *_grfconfig;

    66

    67

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

    68

extern GRFConfig *_grfconfig_newgame;

    69

    70

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

    71

extern GRFConfig *_grfconfig_static;

    72

    73

void ScanNewGRFFiles();

    74

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

    75

GRFConfig *GetGRFConfig(uint32 grfid);

    76

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

    77

void AppendStaticGRFConfigs(GRFConfig **dst);

    78

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

    79

void ClearGRFConfig(GRFConfig **config);

    80

void ClearGRFConfigList(GRFConfig **config);

    81

void ResetGRFConfig(bool defaults);

    82

GRFListCompatibility IsGoodGRFConfigList();

    83

bool FillGRFDetails(GRFConfig *config, bool is_static);

    84

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

    85

    86

/* In newgrf_gui.cpp */

    87

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

    88

    89

#ifdef ENABLE_NETWORK

    90

/* For communication about GRFs over the network */

    91

#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"

    92

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

    93

#endif /* ENABLE_NETWORK */

    94

    95

#endif /* NEWGRF_CONFIG_H */