base_media_func.h File Reference

Generic function implementations for base data (graphics, sounds). More...

#include "base_media_base.h"
#include "debug.h"
#include "ini_type.h"
#include "string_func.h"
#include "error_func.h"
#include "network/core/tcp_content_type.h"

Go to the source code of this file.

Macros
#define	fetch_metadata(name)
	Try to read a single piece of metadata and return false if it doesn't exist.
#define	INSTANTIATE_BASE_MEDIA_METHODS(repl_type, set_type)
	Force instantiation of methods so we don't get linker errors.

Functions
void	CheckExternalFiles ()
	Checks whether the MD5 checksums of the files are correct.
template<class Tbase_set >
const char *	TryGetBaseSetFile (const ContentInfo *ci, bool md5sum, const Tbase_set *s)
	Check whether there's a base set matching some information.

Detailed Description

Generic function implementations for base data (graphics, sounds).

Note

You should never include this file due to the SET_TYPE define.

Definition in file base_media_func.h.

Macro Definition Documentation

fetch_metadata

#define fetch_metadata

(

name

)

Value:

  item = metadata->GetItem(name); \
  if (item == nullptr || !item->value.has_value() || item->value->empty()) { \
    Debug(grf, 0, "Base " SET_TYPE "set detail loading: {} field missing.", name); \
    Debug(grf, 0, "  Is {} readable for the user running OpenTTD?", full_filename); \
    return false; \
  }

Try to read a single piece of metadata and return false if it doesn't exist.

Parameters

name	the name of the item to fetch.

Definition at line 25 of file base_media_func.h.

INSTANTIATE_BASE_MEDIA_METHODS

#define INSTANTIATE_BASE_MEDIA_METHODS	(		repl_type,
			set_type
	)

Value:

  template const char *repl_type::GetExtension(); \
  template bool repl_type::AddFile(const std::string &filename, size_t pathlength, const std::string &tar_filename); \
  template bool repl_type::HasSet(const struct ContentInfo *ci, bool md5sum); \
  template bool repl_type::SetSet(const set_type *set); \
  template bool repl_type::SetSetByName(const std::string &name); \
  template bool repl_type::SetSetByShortname(uint32_t shortname); \
  template void repl_type::GetSetsList(std::back_insert_iterator<std::string> &output_iterator); \
  template int repl_type::GetNumSets(); \
  template int repl_type::GetIndexOfUsedSet(); \
  template const set_type *repl_type::GetSet(int index); \
  template const set_type *repl_type::GetUsedSet(); \
  template bool repl_type::DetermineBestSet(); \
  template set_type *repl_type::GetAvailableSets(); \
  template const char *TryGetBaseSetFile(const ContentInfo *ci, bool md5sum, const set_type *s);

Force instantiation of methods so we don't get linker errors.

Parameters

repl_type	the type of the BaseMedia to instantiate
set_type	the type of the BaseSet to instantiate

Definition at line 414 of file base_media_func.h.

Function Documentation

CheckExternalFiles()

void CheckExternalFiles ( )

extern

Checks whether the MD5 checksums of the files are correct.

Note

Also checks sample.cat and other required non-NewGRF GRFs for corruption.

Definition at line 114 of file gfxinit.cpp.

References BASESET_DIR, BaseSet< SoundsSet, 1, true >::CheckMD5(), GraphicsSet::CheckMD5(), MD5File::CR_MATCH, MD5File::CR_MISMATCH, Debug, MD5File::filename, BaseSet< T, Tnum_files, Tsearch_in_tars >::files, BaseSet< T, Tnum_files, Tsearch_in_tars >::GetNumInvalid(), BaseMedia< GraphicsSet >::GetUsedSet(), BaseMedia< SoundsSet >::GetUsedSet(), MD5File::missing_warning, BaseSet< T, Tnum_files, Tsearch_in_tars >::name, and BaseSet< SoundsSet, 1, true >::NUM_FILES.

Referenced by BaseMedia< Tbase_set >::SetSet().

TryGetBaseSetFile()

template<class Tbase_set >

const char * TryGetBaseSetFile	(	const ContentInfo *	ci,
		bool	md5sum,
		const Tbase_set *	s
	)

Check whether there's a base set matching some information.

Parameters

ci	The content info to compare it to.
md5sum	Should the MD5 checksum be tested as well?
s	The list with sets.

Returns

The filename of the first file of the base set, or nullptr if there is no match.

Definition at line 319 of file base_media_func.h.

References MD5File::hash, ContentInfo::md5sum, and ContentInfo::unique_id.

Referenced by ContentInfo::GetTextfile(), and BaseMedia< Tbase_set >::HasSet().