src/newgrf_config.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file newgrf_config.h Functions to find and configure NewGRFs. */
  11
  12 #ifndef NEWGRF_CONFIG_H
  13 #define NEWGRF_CONFIG_H
  14
  15 #include "strings_type.h"
  16 #include "core/alloc_type.hpp"
  17 #include "core/smallmap_type.hpp"
  18 #include "misc/countedptr.hpp"
  19 #include "fileio_type.h"
  20 #include "textfile_type.h"
  21
  22 /** GRF config bit flags */
  23 enum GCF_Flags {
  24         GCF_SYSTEM,     ///< GRF file is an openttd-internal system grf
  25         GCF_UNSAFE,     ///< GRF file is unsafe for static usage
  26         GCF_STATIC,     ///< GRF file is used statically (can be used in any MP game)
  27         GCF_COMPATIBLE, ///< GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)
  28         GCF_COPY,       ///< The data is copied from a grf in _all_grfs
  29         GCF_INIT_ONLY,  ///< GRF file is processed up to GLS_INIT
  30         GCF_RESERVED,   ///< GRF file passed GLS_RESERVE stage
  31         GCF_INVALID,    ///< GRF is unusable with this version of OpenTTD
  32 };
  33
  34 /** Status of GRF */
  35 enum GRFStatus {
  36         GCS_UNKNOWN,      ///< The status of this grf file is unknown
  37         GCS_DISABLED,     ///< GRF file is disabled
  38         GCS_NOT_FOUND,    ///< GRF file was not found in the local cache
  39         GCS_INITIALISED,  ///< GRF file has been initialised
  40         GCS_ACTIVATED,    ///< GRF file has been activated
  41 };
  42
  43 /** Encountered GRF bugs */
  44 enum GRFBugs {
  45         GBUG_VEH_LENGTH,        ///< Length of rail vehicle changes when not inside a depot
  46         GBUG_VEH_REFIT,         ///< Articulated vehicles carry different cargoes resp. are differently refittable than specified in purchase list
  47         GBUG_VEH_POWERED_WAGON, ///< Powered wagon changed poweredness state when not inside a depot
  48         GBUG_UNKNOWN_CB_RESULT, ///< A callback returned an unknown/invalid result
  49         GBUG_VEH_CAPACITY,      ///< Capacity of vehicle changes when not refitting or arranging
  50 };
  51
  52 /** Status of post-gameload GRF compatibility check */
  53 enum GRFListCompatibility {
  54         GLC_ALL_GOOD,   ///< All GRF needed by game are present
  55         GLC_COMPATIBLE, ///< Compatible (eg. the same ID, but different checksum) GRF found in at least one case
  56         GLC_NOT_FOUND,  ///< At least one GRF couldn't be found (higher priority than GLC_COMPATIBLE)
  57 };
  58
  59 /** Information that can/has to be stored about a GRF's palette. */
  60 enum GRFPalette {
  61         GRFP_USE_BIT     = 0,   ///< The bit used for storing the palette to use.
  62         GRFP_GRF_OFFSET  = 2,   ///< The offset of the GRFP_GRF data.
  63         GRFP_GRF_SIZE    = 2,   ///< The size of the GRFP_GRF data.
  64         GRFP_BLT_OFFSET  = 4,   ///< The offset of the GRFP_BLT data.
  65         GRFP_BLT_SIZE    = 1,   ///< The size of the GRFP_BLT data.
  66
  67         GRFP_USE_DOS     = 0x0, ///< The palette state is set to use the DOS palette.
  68         GRFP_USE_WINDOWS = 0x1, ///< The palette state is set to use the Windows palette.
  69         GRFP_USE_MASK    = 0x1, ///< Bitmask to get only the use palette use states.
  70
  71         GRFP_GRF_UNSET   = 0x0 << GRFP_GRF_OFFSET,          ///< The NewGRF provided no information.
  72         GRFP_GRF_DOS     = 0x1 << GRFP_GRF_OFFSET,          ///< The NewGRF says the DOS palette can be used.
  73         GRFP_GRF_WINDOWS = 0x2 << GRFP_GRF_OFFSET,          ///< The NewGRF says the Windows palette can be used.
  74         GRFP_GRF_ANY     = GRFP_GRF_DOS | GRFP_GRF_WINDOWS, ///< The NewGRF says any palette can be used.
  75         GRFP_GRF_MASK    = GRFP_GRF_ANY,                    ///< Bitmask to get only the NewGRF supplied information.
  76
  77         GRFP_BLT_UNSET   = 0x0 << GRFP_BLT_OFFSET,          ///< The NewGRF provided no information or doesn't care about a 32 bpp blitter.
  78         GRFP_BLT_32BPP   = 0x1 << GRFP_BLT_OFFSET,          ///< The NewGRF prefers a 32 bpp blitter.
  79         GRFP_BLT_MASK    = GRFP_BLT_32BPP,                  ///< Bitmask to only get the blitter information.
  80 };
  81
  82
  83 /** Basic data to distinguish a GRF. Used in the server list window */
  84 struct GRFIdentifier {
  85         uint32 grfid;     ///< GRF ID (defined by Action 0x08)
  86         uint8 md5sum[16]; ///< MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)
  87
  88         /**
  89          * Does the identification match the provided values?
  90          * @param grfid  Expected grfid.
  91          * @param md5sum Expected md5sum, may be \c NULL (in which case, do not check it).
  92          * @return the object has the provided grfid and md5sum.
  93          */
  94         inline bool HasGrfIdentifier(uint32 grfid, const uint8 *md5sum) const
  95         {
  96                 if (this->grfid != grfid) return false;
  97                 if (md5sum == NULL) return true;
  98                 return memcmp(md5sum, this->md5sum, sizeof(this->md5sum)) == 0;
  99         }
 100 };
 101
 102 /** Information about why GRF had problems during initialisation */
 103 struct GRFError : ZeroedMemoryAllocator {
 104         GRFError(StringID severity, StringID message = 0);
 105         GRFError(const GRFError &error);
 106         ~GRFError();
 107
 108         char *custom_message;  ///< Custom message (if present)
 109         char *data;            ///< Additional data for message and custom_message
 110         StringID message;      ///< Default message
 111         StringID severity;     ///< Info / Warning / Error / Fatal
 112         uint32 param_value[2]; ///< Values of GRF parameters to show for message and custom_message
 113 };
 114
 115 /** The possible types of a newgrf parameter. */
 116 enum GRFParameterType {
 117         PTYPE_UINT_ENUM, ///< The parameter allows a range of numbers, each of which can have a special name
 118         PTYPE_BOOL,      ///< The parameter is either 0 or 1
 119         PTYPE_END,       ///< Invalid parameter type
 120 };
 121
 122 /** Information about one grf parameter. */
 123 struct GRFParameterInfo {
 124         GRFParameterInfo(uint nr);
 125         GRFParameterInfo(GRFParameterInfo &info);
 126         ~GRFParameterInfo();
 127         struct GRFText *name;  ///< The name of this parameter
 128         struct GRFText *desc;  ///< The description of this parameter
 129         GRFParameterType type; ///< The type of this parameter
 130         uint32 min_value;      ///< The minimal value this parameter can have
 131         uint32 max_value;      ///< The maximal value of this parameter
 132         uint32 def_value;      ///< Default value of this parameter
 133         byte param_nr;         ///< GRF parameter to store content in
 134         byte first_bit;        ///< First bit to use in the GRF parameter
 135         byte num_bit;          ///< Number of bits to use for this parameter
 136         SmallMap<uint32, struct GRFText *, 8> value_names; ///< Names for each value.
 137         bool complete_labels;  ///< True if all values have a label.
 138
 139         uint32 GetValue(struct GRFConfig *config) const;
 140         void SetValue(struct GRFConfig *config, uint32 value);
 141         void Finalize();
 142 };
 143
 144 /** Reference counted wrapper around a GRFText pointer. */
 145 struct GRFTextWrapper : public SimpleCountedObject {
 146         struct GRFText *text; ///< The actual text
 147
 148         GRFTextWrapper();
 149         ~GRFTextWrapper();
 150 };
 151
 152 /** Information about GRF, used in the game and (part of it) in savegames */
 153 struct GRFConfig : ZeroedMemoryAllocator {
 154         GRFConfig(const char *filename = NULL);
 155         GRFConfig(const GRFConfig &config);
 156         ~GRFConfig();
 157
 158         GRFIdentifier ident;                           ///< grfid and md5sum to uniquely identify newgrfs
 159         uint8 original_md5sum[16];                     ///< MD5 checksum of original file if only a 'compatible' file was loaded
 160         char *filename;                                ///< Filename - either with or without full path
 161         GRFTextWrapper *name;                          ///< NOSAVE: GRF name (Action 0x08)
 162         GRFTextWrapper *info;                          ///< NOSAVE: GRF info (author, copyright, ...) (Action 0x08)
 163         GRFTextWrapper *url;                           ///< NOSAVE: URL belonging to this GRF.
 164         GRFError *error;                               ///< NOSAVE: Error/Warning during GRF loading (Action 0x0B)
 165
 166         uint32 version;                                ///< NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown
 167         uint32 min_loadable_version;                   ///< NOSAVE: Minimum compatible version a NewGRF can define
 168         uint8 flags;                                   ///< NOSAVE: GCF_Flags, bitset
 169         GRFStatus status;                              ///< NOSAVE: GRFStatus, enum
 170         uint32 grf_bugs;                               ///< NOSAVE: bugs in this GRF in this run, @see enum GRFBugs
 171         uint32 param[0x80];                            ///< GRF parameters
 172         uint8 num_params;                              ///< Number of used parameters
 173         uint8 num_valid_params;                        ///< NOSAVE: Number of valid parameters (action 0x14)
 174         uint8 palette;                                 ///< GRFPalette, bitset
 175         SmallVector<GRFParameterInfo *, 4> param_info; ///< NOSAVE: extra information about the parameters
 176         bool has_param_defaults;                       ///< NOSAVE: did this newgrf specify any defaults for it's parameters
 177
 178         struct GRFConfig *next;                        ///< NOSAVE: Next item in the linked list
 179
 180         void CopyParams(const GRFConfig &src);
 181
 182         const char *GetTextfile(TextfileType type) const;
 183         const char *GetName() const;
 184         const char *GetDescription() const;
 185         const char *GetURL() const;
 186
 187         void SetParameterDefaults();
 188         void SetSuitablePalette();
 189         void FinalizeParameterInfo();
 190 };
 191
 192 /** Method to find GRFs using FindGRFConfig */
 193 enum FindGRFConfigMode {
 194         FGCM_EXACT,       ///< Only find Grfs matching md5sum
 195         FGCM_COMPATIBLE,  ///< Find best compatible Grf wrt. desired_version
 196         FGCM_NEWEST,      ///< Find newest Grf
 197         FGCM_NEWEST_VALID,///< Find newest Grf, ignoring Grfs with GCF_INVALID set
 198         FGCM_ANY,         ///< Use first found
 199 };
 200
 201 extern GRFConfig *_all_grfs;          ///< First item in list of all scanned NewGRFs
 202 extern GRFConfig *_grfconfig;         ///< First item in list of current GRF set up
 203 extern GRFConfig *_grfconfig_newgame; ///< First item in list of default GRF set up
 204 extern GRFConfig *_grfconfig_static;  ///< First item in list of static GRF set up
 205 extern uint _missing_extra_graphics;  ///< Number of sprites provided by the fallback extra GRF, i.e. missing in the baseset.
 206
 207 /** Callback for NewGRF scanning. */
 208 struct NewGRFScanCallback {
 209         /** Make sure the right destructor gets called. */
 210         virtual ~NewGRFScanCallback() {}
 211         /** Called whenever the NewGRF scan completed. */
 212         virtual void OnNewGRFsScanned() = 0;
 213 };
 214
 215 size_t GRFGetSizeOfDataSection(FILE *f);
 216
 217 void ScanNewGRFFiles(NewGRFScanCallback *callback);
 218 const GRFConfig *FindGRFConfig(uint32 grfid, FindGRFConfigMode mode, const uint8 *md5sum = NULL, uint32 desired_version = 0);
 219 GRFConfig *GetGRFConfig(uint32 grfid, uint32 mask = 0xFFFFFFFF);
 220 GRFConfig **CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only);
 221 void AppendStaticGRFConfigs(GRFConfig **dst);
 222 void AppendToGRFConfigList(GRFConfig **dst, GRFConfig *el);
 223 void ClearGRFConfigList(GRFConfig **config);
 224 void ResetGRFConfig(bool defaults);
 225 GRFListCompatibility IsGoodGRFConfigList(GRFConfig *grfconfig);
 226 bool FillGRFDetails(GRFConfig *config, bool is_static, Subdirectory subdir = NEWGRF_DIR);
 227 char *GRFBuildParamList(char *dst, const GRFConfig *c, const char *last);
 228
 229 /* In newgrf_gui.cpp */
 230 void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config);
 231
 232 #ifdef ENABLE_NETWORK
 233 /** For communication about GRFs over the network */
 234 #define UNKNOWN_GRF_NAME_PLACEHOLDER "<Unknown>"
 235 GRFTextWrapper *FindUnknownGRFName(uint32 grfid, uint8 *md5sum, bool create);
 236 #endif /* ENABLE_NETWORK */
 237
 238 void UpdateNewGRFScanStatus(uint num, const char *name);
 239 bool UpdateNewGRFConfigPalette(int32 p1 = 0);
 240
 241 #endif /* NEWGRF_CONFIG_H */