Interface that defines a complete app layer configuration. More...

#include <app_config.hpp>

Inheritance diagram for porytiles::AppConfig:

Public Member Functions
virtual	~AppConfig ()=default

virtual void	add_provider (std::unique_ptr< ConfigProvider > provider)=0
	Prepends a `ConfigProvider` to the provider chain at highest priority.

ChainableResult< ConfigValue< bool > >	verify_checksums (ConfigScopeType type, const std::string &scope) const

ChainableResult< ConfigValue< PrimaryPairingMode > >	primary_pairing_mode (ConfigScopeType type, const std::string &scope) const

ChainableResult< ConfigValue< std::vector< std::string > > >	primary_pairing_partners (ConfigScopeType type, const std::string &scope) const

ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_warnings_exclude (ConfigScopeType type, const std::string &scope) const

ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_warnings_include (ConfigScopeType type, const std::string &scope) const

ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_remarks_exclude (ConfigScopeType type, const std::string &scope) const

ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_remarks_include (ConfigScopeType type, const std::string &scope) const

Protected Member Functions
virtual ChainableResult< ConfigValue< bool > >	verify_checksums_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< bool > >	verify_checksums_raw (ConfigScopeType type, const std::string &scope) const =0

virtual ChainableResult< ConfigValue< PrimaryPairingMode > >	primary_pairing_mode_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< PrimaryPairingMode > >	primary_pairing_mode_raw (ConfigScopeType type, const std::string &scope) const =0

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	primary_pairing_partners_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	primary_pairing_partners_raw (ConfigScopeType type, const std::string &scope) const =0

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_warnings_exclude_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_warnings_exclude_raw (ConfigScopeType type, const std::string &scope) const =0

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_warnings_include_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_warnings_include_raw (ConfigScopeType type, const std::string &scope) const =0

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_remarks_exclude_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_remarks_exclude_raw (ConfigScopeType type, const std::string &scope) const =0

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_remarks_include_validated (ConfigScopeType type, const std::string &scope) const

virtual ChainableResult< ConfigValue< std::vector< std::string > > >	diagnostic_remarks_include_raw (ConfigScopeType type, const std::string &scope) const =0

Detailed Description

Interface that defines a complete app layer configuration.

Definition at line 26 of file app_config.hpp.

Constructor & Destructor Documentation

◆ ~AppConfig()

virtual porytiles::AppConfig::~AppConfig ( )

virtualdefault

Member Function Documentation

◆ add_provider()

virtual void porytiles::AppConfig::add_provider ( std::unique_ptr< ConfigProvider > provider )

pure virtual

Prepends a ConfigProvider to the provider chain at highest priority.

Allows use cases to layer an override provider on top of the user's configuration for operations that run the compiler on Porytiles's own behalf. Implementations must invalidate any cached value resolutions so that subsequent reads consult the newly prepended provider.

Parameters

provider The provider to prepend. Must be non-null.

Implemented in porytiles::LazyLayeredConfig.

◆ diagnostic_remarks_exclude()

ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_remarks_exclude	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 84 of file app_config.hpp.

◆ diagnostic_remarks_exclude_raw()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_remarks_exclude_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ diagnostic_remarks_exclude_validated()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_remarks_exclude_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 163 of file app_config.hpp.

◆ diagnostic_remarks_include()

ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_remarks_include	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 92 of file app_config.hpp.

◆ diagnostic_remarks_include_raw()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_remarks_include_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ diagnostic_remarks_include_validated()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_remarks_include_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 175 of file app_config.hpp.

◆ diagnostic_warnings_exclude()

ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_warnings_exclude	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 68 of file app_config.hpp.

◆ diagnostic_warnings_exclude_raw()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_warnings_exclude_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ diagnostic_warnings_exclude_validated()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_warnings_exclude_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 139 of file app_config.hpp.

◆ diagnostic_warnings_include()

ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_warnings_include	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 76 of file app_config.hpp.

◆ diagnostic_warnings_include_raw()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_warnings_include_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ diagnostic_warnings_include_validated()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::diagnostic_warnings_include_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 151 of file app_config.hpp.

◆ primary_pairing_mode()

ChainableResult< ConfigValue< PrimaryPairingMode > > porytiles::AppConfig::primary_pairing_mode	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 52 of file app_config.hpp.

◆ primary_pairing_mode_raw()

virtual ChainableResult< ConfigValue< PrimaryPairingMode > > porytiles::AppConfig::primary_pairing_mode_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ primary_pairing_mode_validated()

virtual ChainableResult< ConfigValue< PrimaryPairingMode > > porytiles::AppConfig::primary_pairing_mode_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 115 of file app_config.hpp.

◆ primary_pairing_partners()

ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::primary_pairing_partners	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 60 of file app_config.hpp.

◆ primary_pairing_partners_raw()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::primary_pairing_partners_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ primary_pairing_partners_validated()

virtual ChainableResult< ConfigValue< std::vector< std::string > > > porytiles::AppConfig::primary_pairing_partners_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 127 of file app_config.hpp.

◆ verify_checksums()

ChainableResult< ConfigValue< bool > > porytiles::AppConfig::verify_checksums	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inline

Definition at line 44 of file app_config.hpp.

◆ verify_checksums_raw()

virtual ChainableResult< ConfigValue< bool > > porytiles::AppConfig::verify_checksums_raw	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ verify_checksums_validated()

virtual ChainableResult< ConfigValue< bool > > porytiles::AppConfig::verify_checksums_validated	(	ConfigScopeType	type,
		const std::string &	scope
	)		const

inlineprotectedvirtual

Definition at line 103 of file app_config.hpp.

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

porytiles/include/porytiles/app/config/app_config.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~AppConfig()

Member Function Documentation

◆ add_provider()

◆ diagnostic_remarks_exclude()

◆ diagnostic_remarks_exclude_raw()

◆ diagnostic_remarks_exclude_validated()

◆ diagnostic_remarks_include()

◆ diagnostic_remarks_include_raw()

◆ diagnostic_remarks_include_validated()

◆ diagnostic_warnings_exclude()

◆ diagnostic_warnings_exclude_raw()

◆ diagnostic_warnings_exclude_validated()

◆ diagnostic_warnings_include()

◆ diagnostic_warnings_include_raw()

◆ diagnostic_warnings_include_validated()

◆ primary_pairing_mode()

◆ primary_pairing_mode_raw()

◆ primary_pairing_mode_validated()

◆ primary_pairing_partners()

◆ primary_pairing_partners_raw()

◆ primary_pairing_partners_validated()

◆ verify_checksums()

◆ verify_checksums_raw()

◆ verify_checksums_validated()