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 () | |
Default implementation, but defined out-of-line for efficiency reasons. More... | |
~config_attribute_value () | |
Default implementation, but defined out-of-line for efficiency reasons. More... | |
config_attribute_value (const config_attribute_value &) | |
Default implementation, but defined out-of-line for efficiency reasons. More... | |
config_attribute_value & | operator= (const config_attribute_value &) |
Default implementation, but defined out-of-line for efficiency reasons. More... | |
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= (const std::string &v) |
config_attribute_value & | operator= (const std::string_view &v) |
config_attribute_value & | operator= (const t_string &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 |
std::time_t | to_time_t (std::time_t def=0) const |
double | to_double (double def=0.) const |
std::string | str (const std::string &fallback="") const |
t_string | t_str () const |
operator int () const | |
operator std::string () const | |
operator t_string () const | |
operator bool () 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 |
bool | equals (const std::string &str) const |
Checks for equality of the attribute values when viewed as strings. More... | |
template<typename T > | |
std::enable_if_t< std::is_same_v< const std::string, std::add_const_t< T > >, bool > friend | operator== (const config_attribute_value &val, const T &str) |
template<typename T > | |
std::enable_if_t< std::is_same_v< const char *, T >, bool > friend | operator== (const config_attribute_value &val, T str) |
template<typename T > | |
bool friend | operator== (const T &str, const config_attribute_value &val) |
template<typename T > | |
bool friend | operator!= (const config_attribute_value &val, const T &str) |
template<typename T > | |
bool friend | operator!= (const T &str, 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... | |
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) |
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.
Definition at line 48 of file config_attribute_value.hpp.
|
private |
Definition at line 103 of file config_attribute_value.hpp.
config_attribute_value::config_attribute_value | ( | ) |
Default implementation, but defined out-of-line for efficiency reasons.
Definition at line 41 of file config_attribute_value.cpp.
config_attribute_value::~config_attribute_value | ( | ) |
Default implementation, but defined out-of-line for efficiency reasons.
Definition at line 47 of file config_attribute_value.cpp.
config_attribute_value::config_attribute_value | ( | const config_attribute_value & | that | ) |
Default implementation, but defined out-of-line for efficiency reasons.
Definition at line 52 of file config_attribute_value.cpp.
|
inline |
Visitor support: Applies a visitor to the underlying variant.
(See the documentation for Boost.Variant.)
Definition at line 217 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(), str(), to_double(), to_int(), to_long_long(), to_size_t(), to_time_t(), to_unsigned(), and write_key_val().
bool config_attribute_value::blank | ( | ) | const |
Tests for an attribute that was never set.
Definition at line 357 of file config_attribute_value.cpp.
References value_.
Referenced by 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().
bool config_attribute_value::empty | ( | ) | const |
Tests for an attribute that either was never set or was set to "".
Definition at line 365 of file config_attribute_value.cpp.
References blank(), p, and value_.
Referenced by add_simple_anim(), ng::connect_engine::connect_engine(), 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(), game_lua_kernel::impl_current_get(), 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().
bool config_attribute_value::equals | ( | const std::string & | str | ) | 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). Also note that translatable string are never equal to non translatable strings.
Definition at line 427 of file config_attribute_value.cpp.
References str().
Referenced by operator==().
|
inlineexplicit |
Definition at line 158 of file config_attribute_value.hpp.
References to_bool().
|
inline |
Definition at line 154 of file config_attribute_value.hpp.
References to_int().
|
inline |
Definition at line 155 of file config_attribute_value.hpp.
References str().
|
inline |
Definition at line 156 of file config_attribute_value.hpp.
References t_str().
|
inline |
Definition at line 168 of file config_attribute_value.hpp.
References operator==().
|
inline |
Definition at line 197 of file config_attribute_value.hpp.
References str().
|
inline |
Definition at line 203 of file config_attribute_value.hpp.
References str().
config_attribute_value & config_attribute_value::operator= | ( | bool | v | ) |
Definition at line 64 of file config_attribute_value.cpp.
References value_.
|
inline |
Definition at line 133 of file config_attribute_value.hpp.
References operator=().
Referenced by operator=().
config_attribute_value & config_attribute_value::operator= | ( | const config_attribute_value & | that | ) |
Default implementation, but defined out-of-line for efficiency reasons.
Definition at line 58 of file config_attribute_value.cpp.
References value_.
Referenced by operator=().
config_attribute_value & config_attribute_value::operator= | ( | const std::string & | v | ) |
config_attribute_value & config_attribute_value::operator= | ( | const std::string_view & | v | ) |
Definition at line 221 of file config_attribute_value.cpp.
References operator=().
config_attribute_value & config_attribute_value::operator= | ( | const t_string & | v | ) |
Definition at line 228 of file config_attribute_value.cpp.
References t_string::str(), t_string::translatable(), and value_.
config_attribute_value & config_attribute_value::operator= | ( | double | v | ) |
Definition at line 108 of file config_attribute_value.cpp.
config_attribute_value & config_attribute_value::operator= | ( | int | v | ) |
Definition at line 70 of file config_attribute_value.cpp.
References value_.
config_attribute_value & config_attribute_value::operator= | ( | long long | v | ) |
Definition at line 76 of file config_attribute_value.cpp.
References value_.
|
inline |
Definition at line 125 of file config_attribute_value.hpp.
References operator=().
Referenced by operator=().
config_attribute_value & config_attribute_value::operator= | ( | unsigned long long | v | ) |
Definition at line 97 of file config_attribute_value.cpp.
References value_.
|
inline |
Definition at line 128 of file config_attribute_value.hpp.
References operator=().
Referenced by operator=().
|
inline |
Definition at line 127 of file config_attribute_value.hpp.
References operator=().
Referenced by operator=().
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 416 of file config_attribute_value.cpp.
References value_.
Referenced by operator!=().
|
inline |
Definition at line 178 of file config_attribute_value.hpp.
|
inline |
Definition at line 185 of file config_attribute_value.hpp.
|
inline |
Definition at line 191 of file config_attribute_value.hpp.
References str().
std::string config_attribute_value::str | ( | const std::string & | fallback = "" | ) | const |
Definition at line 340 of file config_attribute_value.cpp.
References apply_visitor().
Referenced by ng::connect_engine::connect_engine(), unit_filter_impl::unit_filter_compound::create_attribute(), gui2::dialogs::mp_options_helper::display_custom_options(), equals(), synced_context::generate_random_seed(), game_lua_kernel::get_sides_vector(), 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(), operator!=(), operator==(), tod_manager::resolve_random(), utils::split(), t_str(), game_events::wml_menu_item::update(), schema_validation::schema_self_validator::validate_key(), verify_and_clear_global_variable(), verify_and_get_global_variable(), and verify_and_set_global_variable().
t_string config_attribute_value::t_str | ( | ) | const |
Definition at line 345 of file config_attribute_value.cpp.
References p, str(), and value_.
Referenced by ng::connect_engine::connect_engine(), help::generate_era_topics(), help::generate_faction_topics(), unit::init(), and operator t_string().
bool config_attribute_value::to_bool | ( | bool | def = false | ) | const |
Definition at line 252 of file config_attribute_value.cpp.
Referenced by gui2::dialogs::mp_options_helper::display_custom_options(), operator bool(), tod_manager::resolve_random(), and game_events::wml_menu_item::update().
double config_attribute_value::to_double | ( | double | def = 0. | ) | const |
Definition at line 314 of file config_attribute_value.cpp.
References apply_visitor().
int config_attribute_value::to_int | ( | int | def = 0 | ) | const |
Definition at line 289 of file config_attribute_value.cpp.
References apply_visitor().
Referenced by 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(), operator int(), terrain_label::read(), verify_and_clear_global_variable(), verify_and_get_global_variable(), and game_events::WML_HANDLER_FUNCTION().
long long config_attribute_value::to_long_long | ( | long long | def = 0 | ) | const |
Definition at line 294 of file config_attribute_value.cpp.
References apply_visitor().
std::size_t config_attribute_value::to_size_t | ( | std::size_t | def = 0 | ) | const |
Definition at line 304 of file config_attribute_value.cpp.
References apply_visitor().
std::time_t config_attribute_value::to_time_t | ( | std::time_t | def = 0 | ) | const |
Definition at line 309 of file config_attribute_value.cpp.
References apply_visitor().
Referenced by savegame::save_index_class::get().
unsigned config_attribute_value::to_unsigned | ( | unsigned | def = 0 | ) | const |
Definition at line 299 of file config_attribute_value.cpp.
References apply_visitor().
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 238 of file config_attribute_value.cpp.
void config_attribute_value::write_if_not_empty | ( | const t_string & | v | ) |
Definition at line 245 of file config_attribute_value.cpp.
References t_string::empty().
|
friend |
Definition at line 438 of file config_attribute_value.cpp.
|
friend |
Definition at line 67 of file config_attribute_value.hpp.
|
friend |
Definition at line 85 of file config_attribute_value.hpp.
|
staticprivate |
Definition at line 225 of file config_attribute_value.hpp.
Referenced by operator=(), and config_attribute_value::true_false::str().
|
staticprivate |
Definition at line 224 of file config_attribute_value.hpp.
Referenced by operator=(), and config_attribute_value::yes_no::str().
|
staticprivate |
Definition at line 225 of file config_attribute_value.hpp.
Referenced by operator=(), and config_attribute_value::true_false::str().
|
staticprivate |
Definition at line 224 of file config_attribute_value.hpp.
Referenced by operator=(), and config_attribute_value::yes_no::str().
|
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 110 of file config_attribute_value.hpp.
Referenced by apply_visitor(), blank(), empty(), operator=(), operator==(), t_str(), and to_bool().