ConfigProvider implementation that reads values from CLI options. More...

#include <cli_option_provider.hpp>

Inheritance diagram for porytiles::CliOptionProvider:

Collaboration diagram for porytiles::CliOptionProvider:

Public Member Functions
	CliOptionProvider (const CliOptionStorage &storage)

std::string	name () const override
	Gets the name of this ConfigProvider, useful for diagnostic purposes.

LayerValue< std::size_t >	num_tiles_in_primary (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	num_tiles_total (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	num_metatiles_in_primary (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	num_metatiles_total (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	num_palettes_in_primary (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	num_palettes_total (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	max_map_data_size (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::size_t >	num_tiles_per_metatile (ConfigScopeType type, const std::string &scope) const override

LayerValue< Rgba32 >	extrinsic_transparency (ConfigScopeType type, const std::string &scope) const override

LayerValue< bool >	ignore_triple_layer_content (ConfigScopeType type, const std::string &scope) const override

LayerValue< ArtifactEditMode >	tiles_edit_mode (ConfigScopeType type, const std::string &scope) const override

LayerValue< ArtifactEditMode >	palettes_edit_mode (ConfigScopeType type, const std::string &scope) const override

LayerValue< bool >	palette_hints_enabled (ConfigScopeType type, const std::string &scope) const override

LayerValue< PackingStrategyType >	packing_strategy (ConfigScopeType type, const std::string &scope) const override

LayerValue< TileSharingPacking >	tile_sharing_packing (ConfigScopeType type, const std::string &scope) const override

LayerValue< TileSharingAlignment >	tile_sharing_alignment (ConfigScopeType type, const std::string &scope) const override

LayerValue< TilesPaletteMode >	tiles_palette_mode (ConfigScopeType type, const std::string &scope) const override

LayerValue< AnimPaletteResolutionStrategy >	global_anim_palette_resolution_strategy (ConfigScopeType type, const std::string &scope) const override

LayerValue< AnimKeyFrameResolutionStrategy >	global_anim_key_frame_resolution_strategy (ConfigScopeType type, const std::string &scope) const override

LayerValue< AnimMultiPaletteSubtileResolutionStrategy >	global_anim_multi_palette_subtile_resolution_strategy (ConfigScopeType type, const std::string &scope) const override

LayerValue< FrameLinking >	global_frame_linking (ConfigScopeType type, const std::string &scope) const override

LayerValue< bool >	cross_tileset_anim_linking (ConfigScopeType type, const std::string &scope) const override

LayerValue< bool >	verify_checksums (ConfigScopeType type, const std::string &scope) const override

LayerValue< PrimaryPairingMode >	primary_pairing_mode (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::vector< std::string > >	primary_pairing_partners (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::vector< std::string > >	diagnostic_warnings_exclude (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::vector< std::string > >	diagnostic_warnings_include (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::vector< std::string > >	diagnostic_remarks_exclude (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::vector< std::string > >	diagnostic_remarks_include (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::string >	tileset_paths_primary_src (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::string >	tileset_paths_primary_bin (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::string >	tileset_paths_secondary_src (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::string >	tileset_paths_secondary_bin (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::optional< std::size_t > >	metatile_attribute_size (ConfigScopeType type, const std::string &scope) const override

LayerValue< std::optional< std::size_t > >	metatile_attribute_declaration_size (ConfigScopeType type, const std::string &scope) const override

LayerValue< bool >	tileset_animations_wire_anim_code (ConfigScopeType type, const std::string &scope) const override

Public Member Functions inherited from porytiles::ConfigProvider
virtual	~ConfigProvider ()=default

virtual LayerValue< std::vector< PaletteHint > >	palette_hints (ConfigScopeType type, const std::string &scope) const

virtual LayerValue< PackingStrategyParams >	packing_strategy_params (ConfigScopeType type, const std::string &scope) const

virtual LayerValue< PerAnimOverrides >	per_anim_overrides (ConfigScopeType type, const std::string &scope) const

virtual LayerValue< MetatileAttributeFieldDefinitions >	metatile_attribute_fields (ConfigScopeType type, const std::string &scope) const

virtual LayerValue< MetatileAttributeFieldOverrides >	metatile_attribute_field_overrides (ConfigScopeType type, const std::string &scope) const

virtual LayerValue< RolePinDefinitions >	role_pins (ConfigScopeType type, const std::string &scope) const

Detailed Description

ConfigProvider implementation that reads values from CLI options.

CliOptionProvider wraps a CliOptionStorage struct and implements the ConfigProvider interface. For each config value, it returns LayerValue::valid() if the CLI option was provided, or LayerValue::not_provided() if it was not. This provider should be first in the provider chain to give CLI options the highest priority.

Definition at line 24 of file cli_option_provider.hpp.

Constructor & Destructor Documentation

◆ CliOptionProvider()

porytiles::CliOptionProvider::CliOptionProvider ( const CliOptionStorage & storage )

explicit

Definition at line 12 of file cli_option_provider.cpp.

Member Function Documentation

◆ cross_tileset_anim_linking()

LayerValue< bool > porytiles::CliOptionProvider::cross_tileset_anim_linking	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 170 of file cli_option_provider.cpp.

◆ diagnostic_remarks_exclude()

LayerValue< std::vector< std::string > > porytiles::CliOptionProvider::diagnostic_remarks_exclude	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 212 of file cli_option_provider.cpp.

◆ diagnostic_remarks_include()

LayerValue< std::vector< std::string > > porytiles::CliOptionProvider::diagnostic_remarks_include	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 219 of file cli_option_provider.cpp.

◆ diagnostic_warnings_exclude()

LayerValue< std::vector< std::string > > porytiles::CliOptionProvider::diagnostic_warnings_exclude	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 198 of file cli_option_provider.cpp.

◆ diagnostic_warnings_include()

LayerValue< std::vector< std::string > > porytiles::CliOptionProvider::diagnostic_warnings_include	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 205 of file cli_option_provider.cpp.

◆ extrinsic_transparency()

LayerValue< Rgba32 > porytiles::CliOptionProvider::extrinsic_transparency	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 75 of file cli_option_provider.cpp.

◆ global_anim_key_frame_resolution_strategy()

LayerValue< AnimKeyFrameResolutionStrategy > porytiles::CliOptionProvider::global_anim_key_frame_resolution_strategy	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 146 of file cli_option_provider.cpp.

◆ global_anim_multi_palette_subtile_resolution_strategy()

LayerValue< AnimMultiPaletteSubtileResolutionStrategy > porytiles::CliOptionProvider::global_anim_multi_palette_subtile_resolution_strategy	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 155 of file cli_option_provider.cpp.

◆ global_anim_palette_resolution_strategy()

LayerValue< AnimPaletteResolutionStrategy > porytiles::CliOptionProvider::global_anim_palette_resolution_strategy	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 138 of file cli_option_provider.cpp.

◆ global_frame_linking()

LayerValue< FrameLinking > porytiles::CliOptionProvider::global_frame_linking	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 163 of file cli_option_provider.cpp.

◆ ignore_triple_layer_content()

LayerValue< bool > porytiles::CliOptionProvider::ignore_triple_layer_content	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 82 of file cli_option_provider.cpp.

◆ max_map_data_size()

LayerValue< std::size_t > porytiles::CliOptionProvider::max_map_data_size	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 61 of file cli_option_provider.cpp.

◆ metatile_attribute_declaration_size()

LayerValue< std::optional< std::size_t > > porytiles::CliOptionProvider::metatile_attribute_declaration_size	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 261 of file cli_option_provider.cpp.

◆ metatile_attribute_size()

LayerValue< std::optional< std::size_t > > porytiles::CliOptionProvider::metatile_attribute_size	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 254 of file cli_option_provider.cpp.

◆ name()

std::string porytiles::CliOptionProvider::name ( ) const

overridevirtual

Gets the name of this ConfigProvider, useful for diagnostic purposes.

Returns: The name of this ConfigProvider

Implements porytiles::ConfigProvider.

Definition at line 14 of file cli_option_provider.cpp.

◆ num_metatiles_in_primary()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_metatiles_in_primary	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 33 of file cli_option_provider.cpp.

◆ num_metatiles_total()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_metatiles_total	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 40 of file cli_option_provider.cpp.

◆ num_palettes_in_primary()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_palettes_in_primary	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 47 of file cli_option_provider.cpp.

◆ num_palettes_total()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_palettes_total	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 54 of file cli_option_provider.cpp.

◆ num_tiles_in_primary()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_tiles_in_primary	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 19 of file cli_option_provider.cpp.

◆ num_tiles_per_metatile()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_tiles_per_metatile	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 68 of file cli_option_provider.cpp.

◆ num_tiles_total()

LayerValue< std::size_t > porytiles::CliOptionProvider::num_tiles_total	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 26 of file cli_option_provider.cpp.

◆ packing_strategy()

LayerValue< PackingStrategyType > porytiles::CliOptionProvider::packing_strategy	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 110 of file cli_option_provider.cpp.

◆ palette_hints_enabled()

LayerValue< bool > porytiles::CliOptionProvider::palette_hints_enabled	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 103 of file cli_option_provider.cpp.

◆ palettes_edit_mode()

LayerValue< ArtifactEditMode > porytiles::CliOptionProvider::palettes_edit_mode	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 96 of file cli_option_provider.cpp.

◆ primary_pairing_mode()

LayerValue< PrimaryPairingMode > porytiles::CliOptionProvider::primary_pairing_mode	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 184 of file cli_option_provider.cpp.

◆ primary_pairing_partners()

LayerValue< std::vector< std::string > > porytiles::CliOptionProvider::primary_pairing_partners	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 191 of file cli_option_provider.cpp.

◆ tile_sharing_alignment()

LayerValue< TileSharingAlignment > porytiles::CliOptionProvider::tile_sharing_alignment	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 124 of file cli_option_provider.cpp.

◆ tile_sharing_packing()

LayerValue< TileSharingPacking > porytiles::CliOptionProvider::tile_sharing_packing	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 117 of file cli_option_provider.cpp.

◆ tiles_edit_mode()

LayerValue< ArtifactEditMode > porytiles::CliOptionProvider::tiles_edit_mode	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 89 of file cli_option_provider.cpp.

◆ tiles_palette_mode()

LayerValue< TilesPaletteMode > porytiles::CliOptionProvider::tiles_palette_mode	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 131 of file cli_option_provider.cpp.

◆ tileset_animations_wire_anim_code()

LayerValue< bool > porytiles::CliOptionProvider::tileset_animations_wire_anim_code	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 268 of file cli_option_provider.cpp.

◆ tileset_paths_primary_bin()

LayerValue< std::string > porytiles::CliOptionProvider::tileset_paths_primary_bin	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 233 of file cli_option_provider.cpp.

◆ tileset_paths_primary_src()

LayerValue< std::string > porytiles::CliOptionProvider::tileset_paths_primary_src	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 226 of file cli_option_provider.cpp.

◆ tileset_paths_secondary_bin()

LayerValue< std::string > porytiles::CliOptionProvider::tileset_paths_secondary_bin	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 247 of file cli_option_provider.cpp.

◆ tileset_paths_secondary_src()

LayerValue< std::string > porytiles::CliOptionProvider::tileset_paths_secondary_src	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 240 of file cli_option_provider.cpp.

◆ verify_checksums()

LayerValue< bool > porytiles::CliOptionProvider::verify_checksums	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 177 of file cli_option_provider.cpp.

The documentation for this class was generated from the following files:

porytiles/include/porytiles/infra/config/cli_option_provider.hpp
porytiles/lib/infra/config/cli_option_provider.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CliOptionProvider()

Member Function Documentation

◆ cross_tileset_anim_linking()

◆ diagnostic_remarks_exclude()

◆ diagnostic_remarks_include()

◆ diagnostic_warnings_exclude()

◆ diagnostic_warnings_include()

◆ extrinsic_transparency()

◆ global_anim_key_frame_resolution_strategy()

◆ global_anim_multi_palette_subtile_resolution_strategy()

◆ global_anim_palette_resolution_strategy()

◆ global_frame_linking()

◆ ignore_triple_layer_content()

◆ max_map_data_size()

◆ metatile_attribute_declaration_size()

◆ metatile_attribute_size()

◆ name()

◆ num_metatiles_in_primary()

◆ num_metatiles_total()

◆ num_palettes_in_primary()

◆ num_palettes_total()

◆ num_tiles_in_primary()

◆ num_tiles_per_metatile()

◆ num_tiles_total()

◆ packing_strategy()

◆ palette_hints_enabled()

◆ palettes_edit_mode()

◆ primary_pairing_mode()

◆ primary_pairing_partners()

◆ tile_sharing_alignment()

◆ tile_sharing_packing()

◆ tiles_edit_mode()

◆ tiles_palette_mode()

◆ tileset_animations_wire_anim_code()

◆ tileset_paths_primary_bin()

◆ tileset_paths_primary_src()

◆ tileset_paths_secondary_bin()

◆ tileset_paths_secondary_src()

◆ verify_checksums()