Porytiles
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
porytiles::InfraConfig Class Referenceabstract

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

#include <infra_config.hpp>

Inheritance diagram for porytiles::InfraConfig:
[legend]

Public Member Functions

virtual ~InfraConfig ()=default
 
virtual void add_provider (std::unique_ptr< ConfigProvider > provider)=0
 Prepends a ConfigProvider to the provider chain at highest priority.
 
ChainableResult< ConfigValue< std::string > > tileset_paths_primary_src (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< std::string > > tileset_paths_primary_bin (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< std::string > > tileset_paths_secondary_src (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< std::string > > tileset_paths_secondary_bin (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< std::optional< std::size_t > > > metatile_attribute_size (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< std::optional< std::size_t > > > metatile_attribute_declaration_size (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< MetatileAttributeFieldDefinitions > > metatile_attribute_fields (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< MetatileAttributeFieldOverrides > > metatile_attribute_field_overrides (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< RolePinDefinitions > > role_pins (ConfigScopeType type, const std::string &scope) const
 
ChainableResult< ConfigValue< bool > > tileset_animations_wire_anim_code (ConfigScopeType type, const std::string &scope) const
 

Protected Member Functions

virtual ChainableResult< ConfigValue< std::string > > tileset_paths_primary_src_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_primary_src_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_primary_bin_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_primary_bin_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_secondary_src_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_secondary_src_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_secondary_bin_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< std::string > > tileset_paths_secondary_bin_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > metatile_attribute_size_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > metatile_attribute_size_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > metatile_attribute_declaration_size_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > metatile_attribute_declaration_size_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< MetatileAttributeFieldDefinitions > > metatile_attribute_fields_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< MetatileAttributeFieldDefinitions > > metatile_attribute_fields_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< MetatileAttributeFieldOverrides > > metatile_attribute_field_overrides_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< MetatileAttributeFieldOverrides > > metatile_attribute_field_overrides_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< RolePinDefinitions > > role_pins_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< RolePinDefinitions > > role_pins_raw (ConfigScopeType type, const std::string &scope) const =0
 
virtual ChainableResult< ConfigValue< bool > > tileset_animations_wire_anim_code_validated (ConfigScopeType type, const std::string &scope) const
 
virtual ChainableResult< ConfigValue< bool > > tileset_animations_wire_anim_code_raw (ConfigScopeType type, const std::string &scope) const =0
 

Detailed Description

Interface that defines a complete infra layer configuration.

Definition at line 23 of file infra_config.hpp.

Constructor & Destructor Documentation

◆ ~InfraConfig()

virtual porytiles::InfraConfig::~InfraConfig ( )
virtualdefault

Member Function Documentation

◆ add_provider()

virtual void porytiles::InfraConfig::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
providerThe provider to prepend. Must be non-null.

Implemented in porytiles::LazyLayeredConfig.

◆ metatile_attribute_declaration_size()

ChainableResult< ConfigValue< std::optional< std::size_t > > > porytiles::InfraConfig::metatile_attribute_declaration_size ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 79 of file infra_config.hpp.

◆ metatile_attribute_declaration_size_raw()

virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > porytiles::InfraConfig::metatile_attribute_declaration_size_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ metatile_attribute_declaration_size_validated()

virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > porytiles::InfraConfig::metatile_attribute_declaration_size_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 184 of file infra_config.hpp.

◆ metatile_attribute_field_overrides()

ChainableResult< ConfigValue< MetatileAttributeFieldOverrides > > porytiles::InfraConfig::metatile_attribute_field_overrides ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 95 of file infra_config.hpp.

◆ metatile_attribute_field_overrides_raw()

virtual ChainableResult< ConfigValue< MetatileAttributeFieldOverrides > > porytiles::InfraConfig::metatile_attribute_field_overrides_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ metatile_attribute_field_overrides_validated()

virtual ChainableResult< ConfigValue< MetatileAttributeFieldOverrides > > porytiles::InfraConfig::metatile_attribute_field_overrides_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 212 of file infra_config.hpp.

◆ metatile_attribute_fields()

ChainableResult< ConfigValue< MetatileAttributeFieldDefinitions > > porytiles::InfraConfig::metatile_attribute_fields ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 87 of file infra_config.hpp.

◆ metatile_attribute_fields_raw()

virtual ChainableResult< ConfigValue< MetatileAttributeFieldDefinitions > > porytiles::InfraConfig::metatile_attribute_fields_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ metatile_attribute_fields_validated()

virtual ChainableResult< ConfigValue< MetatileAttributeFieldDefinitions > > porytiles::InfraConfig::metatile_attribute_fields_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 200 of file infra_config.hpp.

◆ metatile_attribute_size()

ChainableResult< ConfigValue< std::optional< std::size_t > > > porytiles::InfraConfig::metatile_attribute_size ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 71 of file infra_config.hpp.

◆ metatile_attribute_size_raw()

virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > porytiles::InfraConfig::metatile_attribute_size_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ metatile_attribute_size_validated()

virtual ChainableResult< ConfigValue< std::optional< std::size_t > > > porytiles::InfraConfig::metatile_attribute_size_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 168 of file infra_config.hpp.

◆ role_pins()

ChainableResult< ConfigValue< RolePinDefinitions > > porytiles::InfraConfig::role_pins ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 103 of file infra_config.hpp.

◆ role_pins_raw()

virtual ChainableResult< ConfigValue< RolePinDefinitions > > porytiles::InfraConfig::role_pins_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ role_pins_validated()

virtual ChainableResult< ConfigValue< RolePinDefinitions > > porytiles::InfraConfig::role_pins_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 224 of file infra_config.hpp.

◆ tileset_animations_wire_anim_code()

ChainableResult< ConfigValue< bool > > porytiles::InfraConfig::tileset_animations_wire_anim_code ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 111 of file infra_config.hpp.

◆ tileset_animations_wire_anim_code_raw()

virtual ChainableResult< ConfigValue< bool > > porytiles::InfraConfig::tileset_animations_wire_anim_code_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ tileset_animations_wire_anim_code_validated()

virtual ChainableResult< ConfigValue< bool > > porytiles::InfraConfig::tileset_animations_wire_anim_code_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 236 of file infra_config.hpp.

◆ tileset_paths_primary_bin()

ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_primary_bin ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 47 of file infra_config.hpp.

◆ tileset_paths_primary_bin_raw()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_primary_bin_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ tileset_paths_primary_bin_validated()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_primary_bin_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 132 of file infra_config.hpp.

◆ tileset_paths_primary_src()

ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_primary_src ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 39 of file infra_config.hpp.

◆ tileset_paths_primary_src_raw()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_primary_src_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ tileset_paths_primary_src_validated()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_primary_src_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 120 of file infra_config.hpp.

◆ tileset_paths_secondary_bin()

ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_secondary_bin ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 63 of file infra_config.hpp.

◆ tileset_paths_secondary_bin_raw()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_secondary_bin_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ tileset_paths_secondary_bin_validated()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_secondary_bin_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 156 of file infra_config.hpp.

◆ tileset_paths_secondary_src()

ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_secondary_src ( ConfigScopeType  type,
const std::string &  scope 
) const
inline

Definition at line 55 of file infra_config.hpp.

◆ tileset_paths_secondary_src_raw()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_secondary_src_raw ( ConfigScopeType  type,
const std::string &  scope 
) const
protectedpure virtual

Implemented in porytiles::LazyLayeredConfig.

◆ tileset_paths_secondary_src_validated()

virtual ChainableResult< ConfigValue< std::string > > porytiles::InfraConfig::tileset_paths_secondary_src_validated ( ConfigScopeType  type,
const std::string &  scope 
) const
inlineprotectedvirtual

Definition at line 144 of file infra_config.hpp.

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