peter1138@5228: /* $Id$ */
peter1138@5228: 
peter1138@5228: #ifndef NEWGRF_CONFIG_H
peter1138@5228: #define NEWGRF_CONFIG_H
peter1138@5228: 
bjarni@6268: #include "openttd.h"
bjarni@6268: 
peter1138@5228: /* GRF config bit flags */
bjarni@6298: enum GCF_Flags {
Darkvater@5898: 	GCF_SYSTEM,    ///< GRF file is an openttd-internal system grf
Darkvater@5898: 	GCF_UNSAFE,    ///< GRF file is unsafe for static usage
Darkvater@5898: 	GCF_STATIC,    ///< GRF file is used statically (can be used in any MP game)
Darkvater@5898: 	GCF_COMPATIBLE,///< GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)
rubidium@5339: 	GCF_COPY,      ///< The data is copied from a grf in _all_grfs
bjarni@6298: };
peter1138@5228: 
bjarni@6298: enum GRFStatus {
bjarni@6298: 	GCS_UNKNOWN,      ///< The status of this grf file is unknown
bjarni@6298: 	GCS_DISABLED,     ///< GRF file is disabled
bjarni@6298: 	GCS_NOT_FOUND,    ///< GRF file was not found in the local cache
bjarni@6298: 	GCS_INITIALISED,  ///< GRF file has been initialised
bjarni@6298: 	GCS_ACTIVATED     ///< GRF file has been activated
bjarni@6298: };
bjarni@6298: 
bjarni@6298: enum GRFListCompatibility{
bjarni@6298: 	GLC_ALL_GOOD,
bjarni@6298: 	GLC_COMPATIBLE,
bjarni@6298: 	GLC_NOT_FOUND
bjarni@6298: };
bjarni@6298: 
bjarni@6298: struct GRFIdentifier {
rubidium@6016: 	uint32 grfid;
rubidium@6016: 	uint8 md5sum[16];
bjarni@6298: };
rubidium@6016: 
bjarni@6298: struct GRFError {
bjarni@6268: 	StringID message;
bjarni@6268: 	StringID data;
bjarni@6268: 	StringID severity;
bjarni@6268: 	uint8 num_params;
bjarni@6268: 	uint8 param_number[2];
bjarni@6298: };
bjarni@6268: 
bjarni@6298: struct GRFConfig : public GRFIdentifier {
peter1138@5228: 	char *filename;
peter1138@5228: 	char *name;
peter1138@5228: 	char *info;
bjarni@6268: 	GRFError *error;
peter1138@5228: 
peter1138@5228: 	uint8 flags;
bjarni@6298: 	GRFStatus status;
peter1138@5228: 	uint32 param[0x80];
peter1138@5228: 	uint8 num_params;
peter1138@5228: 
peter1138@5228: 	struct GRFConfig *next;
bjarni@6298: };
peter1138@5228: 
peter1138@5228: /* First item in list of all scanned NewGRFs */
peter1138@5228: extern GRFConfig *_all_grfs;
peter1138@5228: 
peter1138@5228: /* First item in list of current GRF set up */
peter1138@5228: extern GRFConfig *_grfconfig;
peter1138@5228: 
peter1138@5228: /* First item in list of default GRF set up */
peter1138@5228: extern GRFConfig *_grfconfig_newgame;
peter1138@5228: 
peter1138@5329: /* First item in list of static GRF set up */
peter1138@5329: extern GRFConfig *_grfconfig_static;
peter1138@5329: 
bjarni@6298: void ScanNewGRFFiles();
Darkvater@5897: const GRFConfig *FindGRFConfig(uint32 grfid, const uint8 *md5sum = NULL);
peter1138@5333: GRFConfig *GetGRFConfig(uint32 grfid);
Darkvater@5346: GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src);
rubidium@5581: void AppendStaticGRFConfigs(GRFConfig **dst);
bjarni@6268: void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el);
Darkvater@5346: void ClearGRFConfig(GRFConfig **config);
Darkvater@5347: void ClearGRFConfigList(GRFConfig **config);
peter1138@5228: void ResetGRFConfig(bool defaults);
bjarni@6298: GRFListCompatibility IsGoodGRFConfigList();
peter1138@5329: bool FillGRFDetails(GRFConfig *config, bool is_static);
peter1138@5308: char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last);
peter1138@5228: 
peter1138@5237: /* In newgrf_gui.c */
Darkvater@5352: void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config);
peter1138@5237: 
Darkvater@5692: #ifdef ENABLE_NETWORK
rubidium@5339: /* For communication about GRFs over the network */
rubidium@5339: #define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"
rubidium@5339: char *FindUnknownGRFName(uint32 grfid, uint8 *md5sum, bool create);
Darkvater@5692: #endif /* ENABLE_NETWORK */
rubidium@5339: 
peter1138@5228: #endif /* NEWGRF_CONFIG_H */