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

    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

};

    30

    31

/** Encountered GRF bugs */

    32

enum GRFBugs {

    33

	GBUG_VEH_LENGTH,  ///< Length of rail vehicle changes when not inside a depot

    34

};

    35

    36

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

    37

enum GRFListCompatibility {

    38

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

    39

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

    40

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

    41

};

    42

    43

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

    44

struct GRFIdentifier {

    45

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

    46

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

    47

};

    48

    49

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

    50

struct GRFError {

    51

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

    52

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

    53

	StringID message;      ///< Default message

    54

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

    55

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

    56

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

    57

};

    58

    59

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

    60

struct GRFConfig : public GRFIdentifier {

    61

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

    62

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

    63

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

    64

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

    65

    66

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

    67

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

    68

	uint32 grf_bugs;    ///< NOSAVE: bugs in this GRF in this run, @see enum GRFBugs

    69

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

    70

	uint8 num_params;   ///< Number of used parameters

    71

	bool windows_paletted;  ///< Whether the NewGRF is Windows paletted or not

    72

    73

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

    74

    75

	bool IsOpenTTDBaseGRF() const;

    76

};

    77

    78

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

    79

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

    80

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

    81

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

    82

    83

void ScanNewGRFFiles();

    84

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

    85

GRFConfig *GetGRFConfig(uint32 grfid);

    86

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

    87

void AppendStaticGRFConfigs(GRFConfig **dst);

    88

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

    89

void ClearGRFConfig(GRFConfig **config);

    90

void ClearGRFConfigList(GRFConfig **config);

    91

void ResetGRFConfig(bool defaults);

    92

GRFListCompatibility IsGoodGRFConfigList();

    93

bool FillGRFDetails(GRFConfig *config, bool is_static);

    94

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

    95

    96

/* In newgrf_gui.cpp */

    97

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

    98

    99

#ifdef ENABLE_NETWORK

   100

/* For communication about GRFs over the network */

   101

#define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"

   102

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

   103

#endif /* ENABLE_NETWORK */

   104

   105

#endif /* NEWGRF_CONFIG_H */