Finding NewGRFs and configuring them. More...

#include "stdafx.h"
#include "debug.h"
#include "3rdparty/md5/md5.h"
#include "newgrf.h"
#include "network/network_func.h"
#include "gfx_func.h"
#include "newgrf_text.h"
#include "window_func.h"
#include "progress.h"
#include "video/video_driver.hpp"
#include "string_func.h"
#include "strings_func.h"
#include "textfile_gui.h"
#include "thread.h"
#include "newgrf_config.h"
#include "fileio_func.h"
#include "fios.h"
#include "safeguards.h"

Data Structures
class	GRFFileScanner
	Helper for scanning for files with GRF as extension. More...

Functions
void	UpdateNewGRFConfigPalette (int32_t)
	Update the palettes of the graphics from the config file.

size_t	GRFGetSizeOfDataSection (FileHandle &f)
	Get the data section size of a GRF.

static bool	CalcGRFMD5Sum (GRFConfig &config, Subdirectory subdir)
	Calculate the MD5 sum for a GRF, and store it in the config.

bool	FillGRFDetails (GRFConfig &config, bool is_static, Subdirectory subdir)
	Find the GRFID of a given grf, and calculate its md5sum.

void	ClearGRFConfigList (GRFConfigList &config)
	Clear a GRF Config list, freeing all nodes.

static void	AppendGRFConfigList (GRFConfigList &dst, const GRFConfigList &src, bool init_only)
	Append a GRF Config list onto another list.

void	CopyGRFConfigList (GRFConfigList &dst, const GRFConfigList &src, bool init_only)
	Copy a GRF Config list.

static void	RemoveDuplicatesFromGRFConfigList (GRFConfigList &list)
	Removes duplicates from lists of GRFConfigs.

void	AppendStaticGRFConfigs (GRFConfigList &dst)
	Appends the static GRFs to a list of GRFs.

void	AppendToGRFConfigList (GRFConfigList &dst, std::unique_ptr< GRFConfig > &&el)
	Appends an element to a list of GRFs.

void	ResetGRFConfig (bool defaults)
	Reset the current GRF Config to either blank or newgame settings.

GRFListCompatibility	IsGoodGRFConfigList (GRFConfigList &grfconfig)
	Check if all GRFs in the GRF config from a savegame can be loaded.

static bool	GRFSorter (std::unique_ptr< GRFConfig > const &c1, std::unique_ptr< GRFConfig > const &c2)
	Simple sorter for GRFS.

void	DoScanNewGRFFiles (NewGRFScanCallback *callback)
	Really perform the scan for all NewGRFs.

void	ScanNewGRFFiles (NewGRFScanCallback *callback)
	Scan for all NewGRFs.

const GRFConfig *	FindGRFConfig (uint32_t grfid, FindGRFConfigMode mode, const MD5Hash *md5sum, uint32_t desired_version)
	Find a NewGRF in the scanned list.

GRFConfig *	GetGRFConfig (uint32_t grfid, uint32_t mask)
	Retrieve a NewGRF from the current config by its grfid.

std::string	GRFBuildParamList (const GRFConfig &c)
	Build a string containing space separated parameter values, and terminate.

Variables
GRFConfigList	_all_grfs
	First item in list of all scanned NewGRFs.

GRFConfigList	_grfconfig
	First item in list of current GRF set up.

GRFConfigList	_grfconfig_newgame
	First item in list of default GRF set up.

GRFConfigList	_grfconfig_static
	First item in list of static GRF set up.

uint	_missing_extra_graphics = 0
	Number of sprites provided by the fallback extra GRF, i.e. missing in the baseset.

int	_skip_all_newgrf_scanning = 0
	Set this flag to prevent any NewGRF scanning from being done.

Detailed Description

Finding NewGRFs and configuring them.

Definition in file newgrf_config.cpp.

Function Documentation

◆ AppendGRFConfigList()

static void AppendGRFConfigList	(	GRFConfigList &	dst,
		const GRFConfigList &	src,
		bool	init_only
	)

static

Append a GRF Config list onto another list.

Parameters

dst	The destination list
src	The source list
init_only	the copied GRF will be processed up to GLS_INIT

Definition at line 340 of file newgrf_config.cpp.

References InitOnly.

Referenced by AppendStaticGRFConfigs(), and CopyGRFConfigList().

◆ AppendStaticGRFConfigs()

void AppendStaticGRFConfigs ( GRFConfigList & dst )

Appends the static GRFs to a list of GRFs.

Parameters

dst	the head of the list to add to

Definition at line 393 of file newgrf_config.cpp.

References _grfconfig_static, AppendGRFConfigList(), and RemoveDuplicatesFromGRFConfigList().

Referenced by NGRFChunkHandler::Load(), and ResetGRFConfig().

◆ AppendToGRFConfigList()

void AppendToGRFConfigList	(	GRFConfigList &	dst,
		std::unique_ptr< GRFConfig > &&	el
	)

Appends an element to a list of GRFs.

Parameters

dst	the head of the list to add to
el	the new tail to be

Definition at line 404 of file newgrf_config.cpp.

References RemoveDuplicatesFromGRFConfigList().

◆ CalcGRFMD5Sum()

static bool CalcGRFMD5Sum	(	GRFConfig &	config,
		Subdirectory	subdir
	)

static

Calculate the MD5 sum for a GRF, and store it in the config.

Parameters

config	GRF to compute.
subdir	The subdirectory to look in.

Returns: MD5 sum was successfully computed

Definition at line 262 of file newgrf_config.cpp.

References GRFConfig::filename, FioFOpenFile(), GRFGetSizeOfDataSection(), GRFConfig::ident, and GRFIdentifier::md5sum.

Referenced by FillGRFDetails().

◆ ClearGRFConfigList()

void ClearGRFConfigList ( GRFConfigList & config )

Clear a GRF Config list, freeing all nodes.

Parameters

config Start of the list.

Postcondition: config is set to nullptr.

Definition at line 329 of file newgrf_config.cpp.

Referenced by LoadCheckData::Clear(), CopyGRFConfigList(), DoLoad(), DoScanNewGRFFiles(), NetworkAddServer(), NewGRFWindow::OnDropdownSelect(), ClientNetworkCoordinatorSocketHandler::Receive_GC_LISTING(), QueryNetworkGameSocketHandler::Receive_SERVER_GAME_INFO(), and SaveOrLoad().

◆ CopyGRFConfigList()

void CopyGRFConfigList	(	GRFConfigList &	dst,
		const GRFConfigList &	src,
		bool	init_only
	)

Copy a GRF Config list.

Parameters

dst	The destination list
src	The source list
init_only	the copied GRF will be processed up to GLS_INIT

Definition at line 358 of file newgrf_config.cpp.

References AppendGRFConfigList(), and ClearGRFConfigList().

Referenced by NewGRFWindow::Close(), NewGRFConfirmationCallback(), NewGRFWindow::OnClick(), and ResetGRFConfig().

◆ DoScanNewGRFFiles()

void DoScanNewGRFFiles ( NewGRFScanCallback * callback )

Really perform the scan for all NewGRFs.

Parameters

callback The callback to call after the scanning is complete.

Definition at line 559 of file newgrf_config.cpp.

References _all_grfs, ClearGRFConfigList(), CloseWindowByClass(), Debug, GRFFileScanner::DoScan(), TarScanner::DoScan(), GOID_NEWGRF_RESCANNED, GRFSorter(), InvalidateWindowClassesData(), InvalidateWindowData(), MarkWholeScreenDirty(), NetworkAfterNewGRFScan(), TarScanner::NEWGRF, NewGRFScanCallback::OnNewGRFsScanned(), SetModalProgress(), WC_GAME_OPTIONS, WC_MODAL_PROGRESS, WC_SAVELOAD, and WN_GAME_OPTIONS_NEWGRF_STATE.

Referenced by ScanNewGRFFiles().

◆ FillGRFDetails()

bool FillGRFDetails	(	GRFConfig &	config,
		bool	is_static,
		Subdirectory	subdir
	)

Find the GRFID of a given grf, and calculate its md5sum.

Parameters

config	grf to fill.
is_static	grf is static.
subdir	the subdirectory to search in.

Returns: Operation was successfully completed.

Definition at line 297 of file newgrf_config.cpp.

References CalcGRFMD5Sum(), GRFConfig::filename, GRFConfig::FinalizeParameterInfo(), FioCheckFileExists(), GRFConfig::flags, GCS_NOT_FOUND, GRFIdentifier::grfid, GRFConfig::ident, LoadNewGRFFile(), GRFConfig::SetSuitablePalette(), GRFConfig::status, System, EnumBitSet< Tenum, Tstorage >::Test(), and Unsafe.

Referenced by GRFFileScanner::AddFile(), GetDefaultExtraGRFConfig(), GraphicsSet::GetOrCreateExtraConfig(), and GRFLoadConfig().

◆ FindGRFConfig()

const GRFConfig * FindGRFConfig	(	uint32_t	grfid,
		FindGRFConfigMode	mode,
		const MD5Hash *	md5sum,
		uint32_t	desired_version
	)

Find a NewGRF in the scanned list.

Parameters

grfid	GRFID to look for,
mode	Restrictions for matching grfs
md5sum	Expected MD5 sum
desired_version	Requested version

Returns: The matching grf, if it exists in _all_grfs, else nullptr.

Definition at line 603 of file newgrf_config.cpp.

References _all_grfs, FGCM_ANY, FGCM_COMPATIBLE, FGCM_EXACT, FGCM_NEWEST, Invalid, and GRFConfig::version.

Referenced by AddGrfInfo(), ContentInfo::GetTextfile(), GRFLoadConfig(), HasGRFConfig(), IsGoodGRFConfigList(), NetworkAfterNewGRFScan(), NewGRFWindow::OnInvalidateData(), and ClientNetworkGameSocketHandler::Receive_SERVER_CHECK_NEWGRFS().

◆ GetGRFConfig()

GRFConfig * GetGRFConfig	(	uint32_t	grfid,
		uint32_t	mask
	)

Retrieve a NewGRF from the current config by its grfid.

Parameters

grfid	grf to look for.
mask	GRFID mask to allow for partial matching.

Returns: The grf config, if it exists, else nullptr.

Definition at line 629 of file newgrf_config.cpp.

References _grfconfig.

Referenced by DrawVehiclePurchaseInfo(), ErrorUnknownCallbackResult(), ParamSet(), ShowNewGrfVehicleError(), TranslateGRFStrings(), and VehicleLengthChanged().

◆ GRFBuildParamList()

std::string GRFBuildParamList ( const GRFConfig & c )

Build a string containing space separated parameter values, and terminate.

Definition at line 639 of file newgrf_config.cpp.

References GRFConfig::param.

Referenced by GraphicsSetSaveConfig().

◆ GRFGetSizeOfDataSection()

size_t GRFGetSizeOfDataSection ( FileHandle & f )

Get the data section size of a GRF.

Parameters

f GRF.

Returns: Size of the data section or SIZE_MAX if the file has no separate data section.

Definition at line 232 of file newgrf_config.cpp.

References _grf_cont_v2_sig, Debug, and MemCmpT().

Referenced by CalcGRFMD5Sum(), and GraphicsSet::CheckMD5().

◆ GRFSorter()

static bool GRFSorter	(	std::unique_ptr< GRFConfig > const &	c1,
		std::unique_ptr< GRFConfig > const &	c2
	)

static

Simple sorter for GRFS.

Parameters

c1	the first GRFConfig *
c2	the second GRFConfig *

Returns: true if the name of first NewGRF is before the name of the second.

Definition at line 550 of file newgrf_config.cpp.

References StrNaturalCompare().

Referenced by DoScanNewGRFFiles().

◆ IsGoodGRFConfigList()

GRFListCompatibility IsGoodGRFConfigList ( GRFConfigList & grfconfig )

Check if all GRFs in the GRF config from a savegame can be loaded.

Parameters

grfconfig GrfConfig to check

Returns

will return any of the following 3 values:

GLC_ALL_GOOD: No problems occurred, all GRF files were found and loaded
GLC_COMPATIBLE: For one or more GRF's no exact match was found, but a compatible GRF with the same grfid was found and used instead
GLC_NOT_FOUND: For one or more GRF's no match was found at all

Definition at line 430 of file newgrf_config.cpp.

References Compatible, Copy, Debug, FGCM_COMPATIBLE, FGCM_EXACT, GRFConfig::filename, FindGRFConfig(), GRFConfig::flags, FormatArrayAsHex(), GCS_NOT_FOUND, GLC_ALL_GOOD, GLC_COMPATIBLE, GLC_NOT_FOUND, GRFIdentifier::grfid, GRFConfig::has_param_defaults, GRFConfig::ident, Invalid, GRFIdentifier::md5sum, GRFConfig::min_loadable_version, GRFConfig::name, GRFConfig::num_valid_params, GRFConfig::param_info, EnumBitSet< Tenum, Tstorage >::Test(), and GRFConfig::version.

Referenced by AfterLoadGame(), and DoLoad().

◆ RemoveDuplicatesFromGRFConfigList()

static void RemoveDuplicatesFromGRFConfigList ( GRFConfigList & list )

static

Removes duplicates from lists of GRFConfigs.

These duplicates are introduced when the _grfconfig_static GRFs are appended to the _grfconfig on a newgame or savegame. As the parameters of the static GRFs could be different that the parameters of the ones used non-statically. This can result in desyncs in multiplayers, so the duplicate static GRFs have to be removed.

This function assumes that all static GRFs are placed after the non-static GRFs.

Parameters

list	the list to remove the duplicates from

Definition at line 378 of file newgrf_config.cpp.

Referenced by AppendStaticGRFConfigs(), and AppendToGRFConfigList().

◆ ResetGRFConfig()

void ResetGRFConfig ( bool defaults )

Reset the current GRF Config to either blank or newgame settings.

Definition at line 412 of file newgrf_config.cpp.

References _grfconfig, _grfconfig_newgame, AppendStaticGRFConfigs(), and CopyGRFConfigList().

Referenced by NewGRFWindow::Close(), NGRFChunkHandler::Load(), LoadIntroGame(), NewGRFWindow::OnClick(), and AfterNewGRFScan::OnNewGRFsScanned().

◆ ScanNewGRFFiles()

void ScanNewGRFFiles ( NewGRFScanCallback * callback )

Scan for all NewGRFs.

Parameters

callback The callback to call after the scanning is complete.

Definition at line 585 of file newgrf_config.cpp.

References DoScanNewGRFFiles(), MarkWholeScreenDirty(), and SetModalProgress().

◆ UpdateNewGRFConfigPalette()

void UpdateNewGRFConfigPalette ( int32_t new_value )

Update the palettes of the graphics from the config file.

Called when changing the default palette in advanced settings.

Definition at line 220 of file newgrf_config.cpp.

References _all_grfs, _grfconfig_newgame, and _grfconfig_static.

Referenced by AfterNewGRFScan::OnNewGRFsScanned().

Variable Documentation

◆ _all_grfs

GRFConfigList _all_grfs

First item in list of all scanned NewGRFs.

Definition at line 149 of file newgrf_config.cpp.

Referenced by GRFFileScanner::AddFile(), NewGRFWindow::CanUpgradeCurrent(), DoScanNewGRFFiles(), FindGRFConfig(), UpdateNewGRFConfigPalette(), and NewGRFWindow::UpgradeCurrent().

◆ _grfconfig

GRFConfigList _grfconfig

First item in list of current GRF set up.

Definition at line 150 of file newgrf_config.cpp.

Referenced by AfterLoadGame(), DoLoad(), GetGRFConfig(), HandleSavegameLoadCrash(), NGRFChunkHandler::Load(), LoadNewGRF(), MakePNGImage(), MenuClickSettings(), NewGRFConfirmationCallback(), ResetGRFConfig(), ResetNewGRFErrors(), NGRFChunkHandler::Save(), SaveOrLoad(), ServerNetworkGameSocketHandler::SendNewGRFCheck(), ShowNewGRFError(), SurveyGrfs(), and SwitchNewGRFBlitter().

◆ _grfconfig_newgame

GRFConfigList _grfconfig_newgame

First item in list of default GRF set up.

Definition at line 151 of file newgrf_config.cpp.

Referenced by LoadFromConfig(), GenerateLandscapeWindow::OnClick(), SelectGameWindow::OnClick(), ResetGRFConfig(), SaveToConfig(), and UpdateNewGRFConfigPalette().

◆ _grfconfig_static

GRFConfigList _grfconfig_static

First item in list of static GRF set up.

Definition at line 152 of file newgrf_config.cpp.

Referenced by AppendStaticGRFConfigs(), LoadFromConfig(), SaveToConfig(), and UpdateNewGRFConfigPalette().

◆ _missing_extra_graphics

uint _missing_extra_graphics = 0

Number of sprites provided by the fallback extra GRF, i.e. missing in the baseset.

Definition at line 153 of file newgrf_config.cpp.

Referenced by SelectGameWindow::DrawWidget(), SelectGameWindow::OnInit(), and SelectGameWindow::OnResize().

◆ _skip_all_newgrf_scanning

int _skip_all_newgrf_scanning = 0

Set this flag to prevent any NewGRF scanning from being done.

Definition at line 486 of file newgrf_config.cpp.

Referenced by GRFFileScanner::DoScan(), and openttd_main().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ AppendGRFConfigList()

◆ AppendStaticGRFConfigs()

◆ AppendToGRFConfigList()

◆ CalcGRFMD5Sum()

◆ ClearGRFConfigList()

◆ CopyGRFConfigList()

◆ DoScanNewGRFFiles()

◆ FillGRFDetails()

◆ FindGRFConfig()

◆ GetGRFConfig()

◆ GRFBuildParamList()

◆ GRFGetSizeOfDataSection()

◆ GRFSorter()

◆ IsGoodGRFConfigList()

◆ RemoveDuplicatesFromGRFConfigList()

◆ ResetGRFConfig()

◆ ScanNewGRFFiles()

◆ UpdateNewGRFConfigPalette()

Variable Documentation

◆ _all_grfs

◆ _grfconfig

◆ _grfconfig_newgame

◆ _grfconfig_static

◆ _missing_extra_graphics

◆ _skip_all_newgrf_scanning