1

/* $Id$ */

     2

     3

/** @file newgrf_config.h Functions to find and configure NewGRFs. */

     4

     5

#ifndef NEWGRF_CONFIG_H

     6

#define NEWGRF_CONFIG_H

     7

     8

#include "strings_type.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

	GCF_RESERVED,   ///< GRF file passed GLS_RESERVE stage

    19

    GCF_CACHE,      ///< GRF file was loaded from cache

    20

};

    21

    22

/** Status of GRF */

    23

enum GRFStatus {

    24

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

    25

	GCS_DISABLED,     ///< GRF file is disabled

    26

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

    27

	GCS_INITIALISED,  ///< GRF file has been initialised

    28

	GCS_ACTIVATED,    ///< GRF file has been activated

    29

    GCS_AVAILABLE     ///< GRF was not found in the local cache, but the download repo has it

    30

};

    31

    32

/** Status of post-gameload GRF compatibility check */

    33

enum GRFListCompatibility{

    34

	GLC_ALL_GOOD,   ///< All GRF needed by game are present

    35

	GLC_COMPATIBLE, ///< Compatible (eg. the same ID, but different checksum) GRF found in at least one case

    36

	GLC_NOT_FOUND   ///< At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)

    37

};

    38

    39

/** Basic data to distinguish a GRF. Used in the server list window */

    40

struct GRFIdentifier {

    41

	uint32 grfid;     ///< GRF ID (defined by Action 0x08)

    42

	uint8 md5sum[16]; ///< MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)

    43

};

    44

    45

/** Information about why GRF had problems during initialisation */

    46

struct GRFError {

    47

	char *custom_message;  ///< Custom message (if present)

    48

	char *data;            ///< Additional data for message and custom_message

    49

	StringID message;      ///< Default message

    50

	StringID severity;     ///< Info / Warning / Error / Fatal

    51

	uint8 num_params;      ///< Number of additinal parameters for custom_message (0, 1 or 2)

    52

	uint8 param_number[2]; ///< GRF parameters to show for custom_message

    53

};

    54

    55

/** Information about GRF, used in the game and (part of it) in savegames */

    56

struct GRFConfig : public GRFIdentifier {

    57

	char *filename;     ///< Filename - either with or without full path

    58

	char *name;         ///< NOSAVE: GRF name (Action 0x08)

    59

	char *info;         ///< NOSAVE: GRF info (author, copyright, ...) (Action 0x08)

    60

	GRFError *error;    ///< NOSAVE: Error/Warning during GRF loading (Action 0x0B)

    61

    62

	uint8 flags;        ///< NOSAVE: GCF_Flags, bitset

    63

	GRFStatus status;   ///< NOSAVE: GRFStatus, enum

    64

	uint32 param[0x80]; ///< GRF parameters

    65

	uint8 num_params;   ///< Number of used parameters

    66

    67

	struct GRFConfig *next; ///< NOSAVE: Next item in the linked list

    68

    69

	bool IsOpenTTDBaseGRF() const;

    70

};

    71

    72

extern GRFConfig *_all_grfs;          ///< First item in list of all scanned NewGRFs

    73

extern GRFConfig *_grfconfig;         ///< First item in list of current GRF set up

    74

extern GRFConfig *_grfconfig_newgame; ///< First item in list of default GRF set up

    75

extern GRFConfig *_grfconfig_static;  ///< First item in list of static GRF set up

    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 */