Variant for storing WML attributes. More...

#include <config_attribute_value.hpp>

Classes
class	equality_visitor
	Visitor handling equality checks. More...

class	string_visitor
	Visitor for converting a variant to a string. More...

class	true_false
	A wrapper for bool to get the correct streaming ("true"/"false"). More...

class	yes_no
	A wrapper for bool to get the correct streaming ("yes"/"no"). More...

Public Member Functions
config_attribute_value &	operator= (bool v)

config_attribute_value &	operator= (int v)

config_attribute_value &	operator= (long v)

config_attribute_value &	operator= (long long v)

config_attribute_value &	operator= (unsigned v)

config_attribute_value &	operator= (unsigned long v)

config_attribute_value &	operator= (unsigned long long v)

config_attribute_value &	operator= (double v)

config_attribute_value &	operator= (const char *v)

config_attribute_value &	operator= (std::string &&v)

config_attribute_value &	operator= (const std::string &v)

config_attribute_value &	operator= (const std::string_view &v)

config_attribute_value &	operator= (const t_string &v)

template<typename... Args>
config_attribute_value &	operator= (const std::chrono::duration< Args... > &v)

void	write_if_not_empty (const std::string &v)
	Calls operator=(const std::string&) if v is not empty. More...

void	write_if_not_empty (const t_string &v)

bool	to_bool (bool def=false) const

int	to_int (int def=0) const

long long	to_long_long (long long def=0) const

unsigned	to_unsigned (unsigned def=0) const

std::size_t	to_size_t (std::size_t def=0) const

double	to_double (double def=0.) const

std::string	str (const std::string &fallback="") const

t_string	t_str () const

bool	to (const bool def) const

int	to (int def) const

unsigned	to (unsigned def) const

double	to (double def) const

std::string	to (const std::string &def) const

	operator std::string () const

bool	blank () const
	Tests for an attribute that was never set. More...

bool	empty () const
	Tests for an attribute that either was never set or was set to "". More...

bool	operator== (const config_attribute_value &other) const
	Checks for equality of the attribute values when viewed as strings. More...

bool	operator!= (const config_attribute_value &other) const

template<typename T >
std::enable_if_t< std::is_constructible_v< std::string, T >, bool > friend	operator== (const config_attribute_value &attribute, const T &comp)

template<typename T >
std::enable_if_t< std::is_constructible_v< std::string, T >, bool > friend	operator== (const T &comp, const config_attribute_value &val)

template<typename T >
std::enable_if_t< std::is_constructible_v< std::string, T >, bool > friend	operator!= (const config_attribute_value &val, const T &comp)

template<typename T >
std::enable_if_t< std::is_constructible_v< std::string, T >, bool > friend	operator!= (const T &comp, const config_attribute_value &val)

template<typename V >
auto	apply_visitor (const V &visitor) const
	Visitor support: Applies a visitor to the underlying variant. More...

Static Public Member Functions
template<typename T >
static config_attribute_value	create (const T val)

Private Types
typedef utils::variant< utils::monostate, true_false, yes_no, int, unsigned long long, double, std::string, t_string >	value_type

Private Attributes
value_type	value_
	The stored value will always use the first type from the variant definition that can represent it and that can be streamed to the correct string representation (if applicable). More...

Static Private Attributes
static const std::string	s_yes

static const std::string	s_no

static const std::string	s_true

static const std::string	s_false

Friends
std::ostream &	operator<< (std::ostream &os, const true_false &v)

std::ostream &	operator<< (std::ostream &os, const yes_no &v)

std::ostream &	operator<< (std::ostream &os, const config_attribute_value &v)

Detailed Description

Variant for storing WML attributes.

The most efficient type is used when assigning a value. For instance, strings "yes", "no", "true", "false" will be detected and stored as boolean.

Note: The blank variant is only used when querying missing attributes. It is not stored in config objects.

Definition at line 54 of file config_attribute_value.hpp.

Member Typedef Documentation

◆ value_type

typedef utils::variant<utils::monostate, true_false, yes_no, int, unsigned long long, double, std::string, t_string > config_attribute_value::value_type

private

Definition at line 109 of file config_attribute_value.hpp.

Member Function Documentation

◆ apply_visitor()

template<typename V >

auto config_attribute_value::apply_visitor ( const V & visitor ) const

inline

Visitor support: Applies a visitor to the underlying variant.

(See the documentation for Boost.Variant.)

Definition at line 242 of file config_attribute_value.hpp.

References value_.

Referenced by unit_filter_impl::unit_filter_compound::create_attribute(), vconfig::expand(), luaW_pushscalar(), schema_validation::wml_type_simple::matches(), schema_validation::wml_type_tstring::matches(), operator==(), str(), to_double(), to_int(), to_long_long(), to_size_t(), to_unsigned(), and io::write_key_val().

◆ blank()

bool config_attribute_value::blank ( ) const

Tests for an attribute that was never set.

Definition at line 344 of file config_attribute_value.cpp.

References value_.

Referenced by ability_active_adjacent_helper(), name_generator_factory::add_name_generator_from_config(), unit_filter_impl::unit_filter_compound::create_attribute(), empty(), config::get_or(), team::get_village(), team_builder::handle_leader(), unit_type::has_random_traits(), config::inherit_attributes(), side_filter::match_internal(), and game_events::WML_HANDLER_FUNCTION().

◆ create()

template<typename T >

static config_attribute_value config_attribute_value::create ( const T val )

inlinestatic

Definition at line 138 of file config_attribute_value.hpp.

Referenced by BOOST_AUTO_TEST_CASE(), operator==(), and actions::undo_event::undo().

◆ empty()

bool config_attribute_value::empty ( ) const

Tests for an attribute that either was never set or was set to "".

Definition at line 352 of file config_attribute_value.cpp.

References blank(), p, and value_.

Referenced by add_simple_anim(), attack_type::apply_effect(), ng::connect_engine::connect_engine(), attack_type::describe_effect(), do_interpolation(), unit_abilities::filter_base_matches(), help::generate_era_topics(), help::generate_faction_topics(), savegame::save_index_class::get(), game_lua_kernel::get_sides_vector(), campaignd::server::handle_delete(), hotkey::load_from_config(), terrain_filter::match_internal(), terrain_label::read(), saved_game::set_defaults(), carryover_info::transfer_to(), game_events::wml_menu_item::update_command(), verify_and_clear_global_variable(), verify_and_get_global_variable(), verify_and_set_global_variable(), and game_events::WML_HANDLER_FUNCTION().

◆ operator std::string()

config_attribute_value::operator std::string ( ) const

inline

Definition at line 172 of file config_attribute_value.hpp.

References str().

◆ operator!=() [1/3]

bool config_attribute_value::operator!= ( const config_attribute_value & other ) const

inline

Definition at line 181 of file config_attribute_value.hpp.

References operator==().

◆ operator!=() [2/3]

template<typename T >

std::enable_if_t<std::is_constructible_v<std::string, T>, bool> friend config_attribute_value::operator!=	(	const config_attribute_value &	val,
		const T &	comp
	)

inline

Definition at line 220 of file config_attribute_value.hpp.

◆ operator!=() [3/3]

template<typename T >

std::enable_if_t<std::is_constructible_v<std::string, T>, bool> friend config_attribute_value::operator!=	(	const T &	comp,
		const config_attribute_value &	val
	)

inline

Definition at line 227 of file config_attribute_value.hpp.

◆ operator=() [1/14]

config_attribute_value & config_attribute_value::operator= ( bool v )

Definition at line 41 of file config_attribute_value.cpp.

References value_.

Referenced by operator=().

◆ operator=() [2/14]

config_attribute_value& config_attribute_value::operator= ( const char * v )

inline

Definition at line 130 of file config_attribute_value.hpp.

References operator=().

Referenced by operator=().

◆ operator=() [3/14]

template<typename... Args>

config_attribute_value& config_attribute_value::operator= ( const std::chrono::duration< Args... > & v )

inline

Definition at line 146 of file config_attribute_value.hpp.

References operator=().

◆ operator=() [4/14]

config_attribute_value & config_attribute_value::operator= ( const std::string & v )

Definition at line 207 of file config_attribute_value.cpp.

References operator=().

◆ operator=() [5/14]

config_attribute_value & config_attribute_value::operator= ( const std::string_view & v )

Definition at line 212 of file config_attribute_value.cpp.

References operator=().

◆ operator=() [6/14]

config_attribute_value & config_attribute_value::operator= ( const t_string & v )

Definition at line 219 of file config_attribute_value.cpp.

References t_string::str(), t_string::translatable(), and value_.

◆ operator=() [7/14]

config_attribute_value & config_attribute_value::operator= ( double v )

Definition at line 85 of file config_attribute_value.cpp.

References i, and value_.

◆ operator=() [8/14]

config_attribute_value & config_attribute_value::operator= ( int v )

Definition at line 47 of file config_attribute_value.cpp.

References value_.

◆ operator=() [9/14]

config_attribute_value & config_attribute_value::operator= ( long long v )

Definition at line 53 of file config_attribute_value.cpp.

References value_.

◆ operator=() [10/14]

config_attribute_value& config_attribute_value::operator= ( long v )

inline

Definition at line 122 of file config_attribute_value.hpp.

References operator=().

Referenced by operator=().

◆ operator=() [11/14]

config_attribute_value & config_attribute_value::operator= ( std::string && v )

Definition at line 144 of file config_attribute_value.cpp.

References d, utils::charconv::from_chars(), i, s_false, s_no, s_true, s_yes, and value_.

◆ operator=() [12/14]

config_attribute_value & config_attribute_value::operator= ( unsigned long long v )

Definition at line 74 of file config_attribute_value.cpp.

References value_.

◆ operator=() [13/14]

config_attribute_value& config_attribute_value::operator= ( unsigned long v )

inline

Definition at line 125 of file config_attribute_value.hpp.

References operator=().

Referenced by operator=().

◆ operator=() [14/14]

config_attribute_value& config_attribute_value::operator= ( unsigned v )

inline

Definition at line 124 of file config_attribute_value.hpp.

References operator=().

Referenced by operator=().

◆ operator==() [1/3]

template<typename T >

std::enable_if_t<std::is_constructible_v<std::string, T>, bool> friend config_attribute_value::operator==	(	const config_attribute_value &	attribute,
		const T &	comp
	)

inline

Definition at line 200 of file config_attribute_value.hpp.

References apply_visitor(), and create().

◆ operator==() [2/3]

bool config_attribute_value::operator== ( const config_attribute_value & other ) const

Checks for equality of the attribute values when viewed as strings.

Exception: Boolean synonyms can be equal ("yes" == "true"). Note: Blanks have no string representation, so do not equal "" (an empty string).

Definition at line 403 of file config_attribute_value.cpp.

References value_.

Referenced by operator!=().

◆ operator==() [3/3]

template<typename T >

std::enable_if_t<std::is_constructible_v<std::string, T>, bool> friend config_attribute_value::operator==	(	const T &	comp,
		const config_attribute_value &	val
	)

inline

Definition at line 213 of file config_attribute_value.hpp.

◆ str()

std::string config_attribute_value::str ( const std::string & fallback = "" ) const

Definition at line 327 of file config_attribute_value.cpp.

References apply_visitor().

Referenced by ng::connect_engine::connect_engine(), unit_filter_impl::unit_filter_compound::create_attribute(), schema_validation::schema_self_validator::detect_schema_derivation_cycles(), gui2::dialogs::mp_options_helper::display_custom_options(), synced_context::generate_random_seed(), game_lua_kernel::get_sides_vector(), campaignd::server::handle_delete(), unit_type::has_random_traits(), luaW_toconfig(), config::matches(), schema_validation::wml_type_simple::matches(), schema_validation::wml_type_list::matches(), randomness::mt_rng::mt_rng(), operator std::string(), tod_manager::resolve_random(), attack_type::special_tooltips(), utils::split(), t_str(), to(), game_events::wml_menu_item::update(), schema_validation::schema_self_validator::validate_key(), verify_and_clear_global_variable(), verify_and_get_global_variable(), verify_and_set_global_variable(), attack_type::weapon_specials(), attack_type::weapon_specials_impl_adj(), and attack_type::weapon_specials_impl_self().

◆ t_str()

t_string config_attribute_value::t_str ( ) const

Definition at line 332 of file config_attribute_value.cpp.

References p, str(), and value_.

Referenced by ng::connect_engine::connect_engine(), gui2::dialogs::mp_options_helper::display_custom_options(), gui2::text_shape::draw(), help::generate_era_topics(), help::generate_faction_topics(), and unit::init().

◆ to() [1/5]

bool config_attribute_value::to ( const bool def ) const

inline

Definition at line 165 of file config_attribute_value.hpp.

References to_bool().

◆ to() [2/5]

std::string config_attribute_value::to ( const std::string & def ) const

inline

Definition at line 169 of file config_attribute_value.hpp.

References str().

◆ to() [3/5]

double config_attribute_value::to ( double def ) const

inline

Definition at line 168 of file config_attribute_value.hpp.

References to_double().

◆ to() [4/5]

int config_attribute_value::to ( int def ) const

inline

Definition at line 166 of file config_attribute_value.hpp.

References to_int().

◆ to() [5/5]

unsigned config_attribute_value::to ( unsigned def ) const

inline

Definition at line 167 of file config_attribute_value.hpp.

References to_unsigned().

◆ to_bool()

bool config_attribute_value::to_bool ( bool def = false ) const

Definition at line 243 of file config_attribute_value.cpp.

References p, and value_.

Referenced by gui2::dialogs::mp_options_helper::display_custom_options(), tod_manager::resolve_random(), to(), and game_events::wml_menu_item::update().

◆ to_double()

double config_attribute_value::to_double ( double def = 0. ) const

Definition at line 300 of file config_attribute_value.cpp.

References apply_visitor().

Referenced by to().

◆ to_int()

int config_attribute_value::to_int ( int def = 0 ) const

Definition at line 280 of file config_attribute_value.cpp.

References apply_visitor().

Referenced by attack_type::apply_effect(), attack_type::describe_effect(), gui2::dialogs::mp_options_helper::display_custom_options(), unit_abilities::filter_base_matches(), get_global_variable(), hotkey::load_from_config(), terrain_filter::match_internal(), movetype::resistances::merge(), movetype::terrain_info::data::merge(), terrain_label::read(), to(), verify_and_clear_global_variable(), verify_and_get_global_variable(), verify_and_set_global_variable(), and game_events::WML_HANDLER_FUNCTION().

◆ to_long_long()

long long config_attribute_value::to_long_long ( long long def = 0 ) const

Definition at line 285 of file config_attribute_value.cpp.

References apply_visitor().

Referenced by chrono::parse_timestamp().

◆ to_size_t()

std::size_t config_attribute_value::to_size_t ( std::size_t def = 0 ) const

Definition at line 295 of file config_attribute_value.cpp.

References apply_visitor().

◆ to_unsigned()

unsigned config_attribute_value::to_unsigned ( unsigned def = 0 ) const

Definition at line 290 of file config_attribute_value.cpp.

References apply_visitor().

Referenced by to().

◆ write_if_not_empty() [1/2]

void config_attribute_value::write_if_not_empty ( const std::string & v )

Calls operator=(const std::string&) if v is not empty.

Definition at line 229 of file config_attribute_value.cpp.

◆ write_if_not_empty() [2/2]

void config_attribute_value::write_if_not_empty ( const t_string & v )

Definition at line 236 of file config_attribute_value.cpp.

References t_string::empty().

Friends And Related Function Documentation

◆ operator<< [1/3]

std::ostream& operator<<	(	std::ostream &	os,
		const config_attribute_value &	v
	)

friend

Definition at line 408 of file config_attribute_value.cpp.

◆ operator<< [2/3]

std::ostream& operator<<	(	std::ostream &	os,
		const true_false &	v
	)

friend

Definition at line 73 of file config_attribute_value.hpp.

◆ operator<< [3/3]

std::ostream& operator<<	(	std::ostream &	os,
		const yes_no &	v
	)

friend

Definition at line 91 of file config_attribute_value.hpp.

Member Data Documentation

◆ s_false

const std::string config_attribute_value::s_false

staticprivate

Definition at line 250 of file config_attribute_value.hpp.

Referenced by operator=(), and config_attribute_value::true_false::str().

◆ s_no

const std::string config_attribute_value::s_no

staticprivate

Definition at line 249 of file config_attribute_value.hpp.

Referenced by operator=(), and config_attribute_value::yes_no::str().

◆ s_true

const std::string config_attribute_value::s_true

staticprivate

Definition at line 250 of file config_attribute_value.hpp.

Referenced by operator=(), and config_attribute_value::true_false::str().

◆ s_yes

const std::string config_attribute_value::s_yes

staticprivate

Definition at line 249 of file config_attribute_value.hpp.

Referenced by operator=(), and config_attribute_value::yes_no::str().

◆ value_

value_type config_attribute_value::value_

private

The stored value will always use the first type from the variant definition that can represent it and that can be streamed to the correct string representation (if applicable).

This is enforced upon assignment.

Definition at line 116 of file config_attribute_value.hpp.

Referenced by apply_visitor(), blank(), empty(), operator=(), operator==(), t_str(), and to_bool().

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

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ value_type

Member Function Documentation

◆ apply_visitor()

◆ blank()

◆ create()

◆ empty()

◆ operator std::string()

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator=() [1/14]

◆ operator=() [2/14]

◆ operator=() [3/14]

◆ operator=() [4/14]

◆ operator=() [5/14]

◆ operator=() [6/14]

◆ operator=() [7/14]

◆ operator=() [8/14]

◆ operator=() [9/14]

◆ operator=() [10/14]

◆ operator=() [11/14]

◆ operator=() [12/14]

◆ operator=() [13/14]

◆ operator=() [14/14]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ str()

◆ t_str()

◆ to() [1/5]

◆ to() [2/5]

◆ to() [3/5]

◆ to() [4/5]

◆ to() [5/5]

◆ to_bool()

◆ to_double()

◆ to_int()

◆ to_long_long()

◆ to_size_t()

◆ to_unsigned()

◆ write_if_not_empty() [1/2]

◆ write_if_not_empty() [2/2]

Friends And Related Function Documentation

◆ operator<< [1/3]

◆ operator<< [2/3]

◆ operator<< [3/3]

Member Data Documentation

◆ s_false

◆ s_no

◆ s_true

◆ s_yes

◆ value_