The Battle for Wesnoth  1.17.0-dev
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
config Class Reference

A config object defines a single node in a WML file, with access to child nodes. More...

#include <config.hpp>

Classes

struct  all_children_iterator
 
struct  any_child
 
struct  attribute_iterator
 
struct  child_iterator
 
struct  child_pos
 
struct  const_all_children_iterator
 
struct  const_attribute_iterator
 
struct  const_child_iterator
 
struct  error
 
class  throw_when_child_not_found
 An object of this type will cause the following functions to throw a config::error instead of returning a reference to the invalid config for the duration of its lfetime. More...
 

Public Types

typedef std::vector< std::unique_ptr< config > > child_list
 
typedef std::map< std::string, child_list, std::less<> > child_map
 
typedef boost::iterator_range< child_iteratorchild_itors
 
typedef boost::iterator_range< const_child_iteratorconst_child_itors
 
using attribute_value = config_attribute_value
 Variant for storing WML attributes. More...
 
typedef std::map< std::string, attribute_value, std::less<> > attribute_map
 
typedef attribute_map::value_type attribute
 
typedef boost::iterator_range< const_attribute_iteratorconst_attr_itors
 
typedef boost::iterator_range< attribute_iteratorattr_itors
 
typedef boost::iterator_range< all_children_iteratorall_children_itors
 
typedef boost::iterator_range< const_all_children_iteratorconst_all_children_itors
 

Public Member Functions

 config ()
 
 config (const config &)
 
configoperator= (const config &)
 
 config (config &&)
 
configoperator= (config &&)
 
 config (config_key_type child)
 Creates a config object with an empty child of name child. More...
 
template<typename... T>
 config (config_key_type first, T &&... args)
 Creates a config with several attributes and children. More...
 
 ~config ()
 
 operator bool () const
 
child_itors child_range (config_key_type key)
 
const_child_itors child_range (config_key_type key) const
 
unsigned child_count (config_key_type key) const
 
unsigned all_children_count () const
 
unsigned attribute_count () const
 Count the number of non-blank attributes. More...
 
bool has_child (config_key_type key) const
 Determine whether a config has a child or not. More...
 
const configchild_or_empty (config_key_type key) const
 Returns the first child with the given key, or an empty config if there is none. More...
 
configchild (config_key_type key, int n=0)
 Returns the nth child with the given key, or a reference to an invalid config if there is none. More...
 
const configchild (config_key_type key, int n=0) const
 Returns the nth child with the given key, or a reference to an invalid config if there is none. More...
 
utils::optional_reference< configoptional_child (config_key_type key, int n=0)
 Euivalent to child, but returns an empty optional if the nth child was not found. More...
 
utils::optional_reference< const configoptional_child (config_key_type key, int n=0) const
 Euivalent to child, but returns an empty optional if the nth child was not found. More...
 
configchild (config_key_type key, const std::string &parent)
 Returns a mandatory child node. More...
 
const configchild (config_key_type key, const std::string &parent) const
 Returns a mandatory child node. More...
 
utils::optional_reference< const configget_deprecated_child (config_key_type old_key, const std::string &in_tag, DEP_LEVEL level, const std::string &message) const
 Get a deprecated child and log a deprecation message. More...
 
const_child_itors get_deprecated_child_range (config_key_type old_key, const std::string &in_tag, DEP_LEVEL level, const std::string &message) const
 Get a deprecated child rangw and log a deprecation message. More...
 
configadd_child (config_key_type key)
 
configadd_child (config_key_type key, const config &val)
 
configadd_child_at (config_key_type key, const config &val, unsigned index)
 
configadd_child (config_key_type key, config &&val)
 
attribute_valueoperator[] (config_key_type key)
 Returns a reference to the attribute with the given key. More...
 
const attribute_valueoperator[] (config_key_type key) const
 Returns a reference to the attribute with the given key or to a dummy empty attribute if it does not exist. More...
 
attribute_valueoperator[] (const std::string &key)
 Returns a reference to the attribute with the given key. More...
 
const attribute_valueoperator[] (const std::string &key) const
 Returns a reference to the attribute with the given key or to a dummy empty attribute if it does not exist. More...
 
attribute_valueoperator[] (const char *key)
 Returns a reference to the attribute with the given key. More...
 
const attribute_valueoperator[] (const char *key) const
 Returns a reference to the attribute with the given key or to a dummy empty attribute if it does not exist. More...
 
const attribute_valueget (config_key_type key) const
 Returns a pointer to the attribute with the given key or nullptr if it does not exist. More...
 
const attribute_valueget_old_attribute (config_key_type key, const std::string &old_key, const std::string &in_tag, const std::string &message="") const
 Function to handle backward compatibility Get the value of key and if missing try old_key and log a deprecation message. More...
 
const attribute_valueget_deprecated_attribute (config_key_type old_key, const std::string &in_tag, DEP_LEVEL level, const std::string &message) const
 Get a deprecated attribute without a direct substitute, and log a deprecation message. More...
 
template<typename T >
void insert (config_key_type key, T &&value)
 Inserts an attribute into the config. More...
 
configchild_or_add (config_key_type key)
 Returns a reference to the first child with the given key. More...
 
bool has_attribute (config_key_type key) const
 
void remove_attribute (config_key_type key)
 
void merge_attributes (const config &)
 
template<typename... T>
void remove_attributes (T... keys)
 
template<typename... T>
void copy_attributes (const config &from, T... keys)
 
const_attr_itors attribute_range () const
 
attr_itors attribute_range ()
 
configfind_child (config_key_type key, const std::string &name, const std::string &value)
 Returns the first child of tag key with a name attribute containing value. More...
 
const configfind_child (config_key_type key, const std::string &name, const std::string &value) const
 
template<typename... T>
void clear_children (T... keys)
 
void splice_children (config &src, const std::string &key)
 Moves all the children with tag key from src to this. More...
 
void remove_child (config_key_type key, unsigned index)
 
void remove_children (config_key_type key, std::function< bool(const config &)> p)
 Removes all children with tag key for which p returns true. More...
 
void recursive_clear_value (config_key_type key)
 
void clear ()
 
void clear_all_children ()
 
void clear_attributes ()
 
bool empty () const
 
std::string debug () const
 
std::string hash () const
 
configadd_child_at_total (config_key_type key, const config &val, size_t pos)
 
size_t find_total_first_of (config_key_type key, size_t start=0)
 
const_all_children_itors all_children_range () const
 In-order iteration over all children. More...
 
all_children_itors all_children_range ()
 
const_all_children_iterator ordered_cbegin () const
 
const_all_children_iterator ordered_cend () const
 
const_all_children_iterator ordered_begin () const
 
const_all_children_iterator ordered_end () const
 
all_children_iterator ordered_begin ()
 
all_children_iterator ordered_end ()
 
all_children_iterator erase (const all_children_iterator &i)
 
config get_diff (const config &c) const
 A function to get the differences between this object, and 'c', as another config object. More...
 
void get_diff (const config &c, config &res) const
 
void apply_diff (const config &diff, bool track=false)
 A function to apply a diff config onto this config object. More...
 
void clear_diff_track (const config &diff)
 Clear any tracking info from a previous apply_diff call with tracking. More...
 
void merge_with (const config &c)
 Merge config 'c' into this config, overwriting this config's values. More...
 
void inherit_from (const config &c)
 Merge config 'c' into this config, preserving this config's values. More...
 
void inherit_attributes (const config &c)
 Merge the attributes of config 'c' into this config, preserving this config's values. More...
 
bool matches (const config &filter) const
 
void append (const config &cfg)
 Append data from another config object to this one. More...
 
void append (config &&cfg)
 
void append_children (const config &cfg)
 Adds children from cfg. More...
 
void append_children (config &&cfg)
 
void append_children (const config &cfg, const std::string &key)
 Adds children from cfg. More...
 
void append_children_by_move (config &cfg, const std::string &key)
 Moves children with the given name from the given config to this one. More...
 
void append_attributes (const config &cfg)
 Adds attributes from cfg. More...
 
void merge_children (const std::string &key)
 All children with the given key will be merged into the first element with that key. More...
 
void merge_children_by_attribute (const std::string &key, const std::string &attribute)
 All children with the given key and with equal values of the specified attribute will be merged into the element with that key and that value of the attribute. More...
 
void swap (config &cfg)
 
bool validate_wml () const
 Returns true if this object represents valid WML, i.e. More...
 

Static Public Member Functions

static bool valid_tag (config_key_type name)
 
static bool valid_attribute (config_key_type name)
 
static configget_invalid ()
 

Static Public Attributes

static const char * diff_track_attribute = "__diff_track"
 The name of the attribute used for tracking diff changes. More...
 

Private Member Functions

void check_valid () const
 Raises an exception if this is not valid. More...
 
void check_valid (const config &cfg) const
 Raises an exception if this or cfg is not valid. More...
 
void clear_children_impl (config_key_type key)
 
std::vector< child_pos >::iterator remove_child (const child_map::iterator &l, unsigned pos)
 Removes the child at position pos of l. More...
 

Private Attributes

attribute_map values_
 All the attributes of this node. More...
 
child_map children_
 A list of all children of this node. More...
 
std::vector< child_posordered_children
 

Static Private Attributes

static config invalid
 

Friends

struct config_implementation
 
bool operator== (const config &a, const config &b)
 

Detailed Description

A config object defines a single node in a WML file, with access to child nodes.

Definition at line 61 of file config.hpp.

Member Typedef Documentation

◆ all_children_itors

typedef boost::iterator_range<all_children_iterator> config::all_children_itors

Definition at line 718 of file config.hpp.

◆ attr_itors

typedef boost::iterator_range<attribute_iterator> config::attr_itors

Definition at line 283 of file config.hpp.

◆ attribute

typedef attribute_map::value_type config::attribute

Definition at line 222 of file config.hpp.

◆ attribute_map

typedef std::map< std::string , attribute_value , std::less<> > config::attribute_map

Definition at line 221 of file config.hpp.

◆ attribute_value

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 215 of file config.hpp.

◆ child_itors

typedef boost::iterator_range<child_iterator> config::child_itors

Definition at line 205 of file config.hpp.

◆ child_list

typedef std::vector<std::unique_ptr<config> > config::child_list

Definition at line 115 of file config.hpp.

◆ child_map

typedef std::map<std::string, child_list, std::less<> > config::child_map

Definition at line 116 of file config.hpp.

◆ const_all_children_itors

Definition at line 719 of file config.hpp.

◆ const_attr_itors

typedef boost::iterator_range<const_attribute_iterator> config::const_attr_itors

Definition at line 282 of file config.hpp.

◆ const_child_itors

typedef boost::iterator_range<const_child_iterator> config::const_child_itors

Definition at line 206 of file config.hpp.

Constructor & Destructor Documentation

◆ config() [1/5]

config::config ( )

Definition at line 130 of file config.cpp.

Referenced by add_child(), add_child_at(), and add_child_at_total().

◆ config() [2/5]

config::config ( const config cfg)

Definition at line 137 of file config.cpp.

References append_children().

◆ config() [3/5]

config::config ( config &&  cfg)

Definition at line 169 of file config.cpp.

◆ config() [4/5]

config::config ( config_key_type  child)
explicit

Creates a config object with an empty child of name child.

Definition at line 145 of file config.cpp.

References add_child().

◆ config() [5/5]

template<typename... T>
config::config ( config_key_type  first,
T &&...  args 
)
inlineexplicit

Creates a config with several attributes and children.

Pass the keys/tags and values/children alternately. For example: config("key", 42, "value", config())

Definition at line 898 of file config.hpp.

◆ ~config()

config::~config ( )

Definition at line 153 of file config.cpp.

References clear().

Member Function Documentation

◆ add_child() [1/3]

config & config::add_child ( config_key_type  key)

Definition at line 514 of file config.cpp.

References check_valid(), children_, config(), and ordered_children.

Referenced by unit_animation::add_anims(), add_child_at_total(), replay::add_countdown_update(), add_image(), replay::add_label(), campaignd::add_license(), replay::add_log_data(), unit::add_modification(), terrain_builder::add_off_map_rule(), replay::add_rename(), replay::add_start(), replay::add_surrender(), schema_validation::wml_tag::add_switch(), replay::add_synced_command(), add_text(), replay::add_unit_checksum(), desktop::add_user_bookmark(), append_children(), append_children_by_move(), unit::apply_builtin_effect(), attack_type::apply_modification(), archive_addon(), archive_dir(), BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE(), unit_type::build_help_index(), cave_map_generator::cave_map_generator_job::cave_map_generator_job(), turn_info::change_side_controller(), saved_game::check_require_scenario(), child(), child_or_add(), battle_context::choose_defender_weapon(), replay::clear_labels(), persist_file_context::clear_var(), replay_network_sender::commit_and_sync(), config(), savegame::convert_old_saves_1_11_0(), savegame::convert_old_saves_1_13_0(), savegame::loadgame::copy_era(), default_map_generator::create_scenario(), savegame::save_index_class::data(), campaignd::data_apply_addlist(), addons_client::delete_remote_addon(), gui2::dialogs::story_viewer::display_part(), events::chat_command_handler::do_info(), do_resolve_rects(), addons_client::download_addon(), gui2::dialogs::story_viewer::draw_floating_image(), gui2::dialogs::attack_predictions::draw_hp_graph(), editor::editor_display::draw_sidebar(), replay::end_turn(), gui2::dialogs::mp_lobby::enter_game(), expand_partialresolution(), ai::configuration::expand_simplified_aspects(), savegame::extract_summary_from_config(), help::generate_contents(), unit::generate_traits(), replay_helper::get_attack(), ai::readonly_context_impl::get_avoid(), get_checksum(), variable_info_implementation::vi_policy_create::get_child_at(), replay::get_data_range(), get_diff(), replay_helper::get_event(), gui2::dialogs::mp_options_helper::get_options_config(), vconfig::get_parsed_config(), replay_helper::get_recall(), replay_helper::get_recruit(), persist_file_context::get_var(), campaignd::server::handle_request_campaign_list(), campaignd::server::handle_upload(), game_lua_kernel::impl_current_get(), inherit_scenario(), unit::init(), replay::init_side(), mp::initial_level_config(), ai::default_recruitment::recruitment::integrate_recruitment_pattern_in_recruitment_instructions(), intf_append_ai(), intf_debug_ai(), game_lua_kernel::intf_fire_event(), intf_invoke_synced_command(), gui2::dialogs::addon_manager::load_addon_list(), game_config_manager::load_addons_cfg(), game_config_manager::load_game_config(), saved_game::load_non_scenario(), synced_checkup::local_checkup(), luaW_toconfig(), wb::side_actions::make_net_cmd_insert(), wb::side_actions::make_net_cmd_refresh(), wb::side_actions::make_net_cmd_replace(), make_updatepack(), ng::depcheck::manager::manager(), animation_branch::merge(), merge_children(), merge_children_by_attribute(), merge_with(), variable_info_implementation::merge_range_h::operator()(), ai::configuration::parse_side_config(), cave_map_generator::cave_map_generator_job::place_chamber(), saved_game::post_scenario_generation(), ai::ai_composite::preparse_cfg(), ng::connect_engine::process_network_data(), playmp_controller::process_oos(), persist_choice::query_user(), playturn_network_adapter::read(), ai::default_recruitment::recruitment_aspect::recalculate(), ai::default_recruitment::recruitment_aspect::recruitment_aspect(), display::refresh_report(), preferences::save_acquaintances(), hotkey::save_hotkeys(), events::chat_handler::send_chat_room_message(), events::chat_handler::send_command(), ng::connect_engine::send_level_data(), wb::manager::send_network_data(), addons_client::send_simple_request(), events::chat_handler::send_whisper(), about::set_about(), preferences::editor::set_draw_num_of_bitmaps(), set_global_variable(), game_config_manager::set_multiplayer_hashes(), ng::scenario::set_sides(), preferences::set_user_servers_list(), persist_file_context::set_var(), setup_test_config(), gui2::dialogs::mp_join_game::show_flg_select(), ng::side_engine::side_engine(), replay::speak(), scoped_wml_variable::store(), campaignd::support_translation(), replay_network_sender::sync_non_undoable(), mp_game_settings::to_config(), tod_manager::to_config(), ai::ai_default_rca::candidate_action_evaluation_loop::to_config(), ai::engine_fai::to_config(), carryover::to_config(), saved_game::to_config(), wb::attack::to_config(), ai::ai_composite::to_config(), ai::ai_default_rca::aspect_attacks::to_config(), wb::suppose_dead::to_config(), wb::recall::to_config(), ai::engine_lua::to_config(), wb::recruit::to_config(), ai::formula_ai::to_config(), game_events::wmi_manager::to_config(), ai::lua_candidate_action_wrapper_base::to_config(), ai::aspect_attacks_lua::to_config(), wb::move::to_config(), carryover_info::to_config(), ai::candidate_action::to_config(), game_events::wml_menu_item::to_config(), pathfind::manager::to_config(), play_controller::to_config(), ai::lua_stage_wrapper::to_config(), ai::composite_aspect< T >::to_config(), editor::map_context::to_config(), team::to_config(), ai::lua_aspect< T >::to_config(), ai::readonly_context_impl::to_readonly_context_config(), carryover::transfer_all_recalls_to(), carryover_info::transfer_to(), ng::connect_engine::update_and_send_diff(), ng::connect_engine::update_level(), addons_client::upload_addon(), replay::user_input(), ai::config_value_translator< config >::value_to_cfg(), ai::config_value_translator< terrain_filter >::value_to_cfg(), detail::config_construct_unpacker< T, config, Rest... >::visit(), detail::config_construct_unpacker< T, config &, Rest... >::visit(), statistics::stats::write(), sound::music_track::write(), actions::undo::recall_action::write(), actions::undo::recruit_action::write(), actions::undo::dismiss_action::write(), map_labels::write(), unit_formula_manager::write(), replay_recorder_base::write(), actions::clearer_info::write(), actions::shroud_clearing_action::write(), game_state::write(), actions::undo_list::write(), mp_game_settings::addon_version_info::write(), team::team_info::write(), attack_type::write(), movetype::terrain_info::data::write(), addon_info::write(), wesnothd::ban_manager::write(), team::write(), movetype::resistances::write(), movetype::write(), display::write(), unit::write(), write_addon_install_info(), write_battle_result_map(), write_by_cth_map(), game_board::write_config(), write_difference(), actions::undo_action::write_event_vector(), game_events::manager::write_events(), write_hashlist(), game_data::write_snapshot(), soundsource::manager::write_sourcespecs(), statistics::write_stats(), and preferences::manager::~manager().

◆ add_child() [2/3]

config & config::add_child ( config_key_type  key,
const config val 
)

Definition at line 524 of file config.cpp.

References check_valid(), children_, config(), and ordered_children.

◆ add_child() [3/3]

config & config::add_child ( config_key_type  key,
config &&  val 
)

Definition at line 535 of file config.cpp.

References check_valid(), children_, config(), and ordered_children.

◆ add_child_at()

config & config::add_child_at ( config_key_type  key,
const config val,
unsigned  index 
)

◆ add_child_at_total()

config & config::add_child_at_total ( config_key_type  key,
const config val,
size_t  pos 
)
Parameters
keythe tag name
valthe contents of the tag
posis the index of the new child in all children.

Definition at line 594 of file config.cpp.

References add_child(), config(), utf8::index(), next, ordered_children, p, and config::child_pos::pos.

Referenced by saved_game::load_non_scenario().

◆ all_children_count()

unsigned config::all_children_count ( ) const

◆ all_children_range() [1/2]

config::const_all_children_itors config::all_children_range ( ) const

◆ all_children_range() [2/2]

config::all_children_itors config::all_children_range ( )

Definition at line 996 of file config.cpp.

References ordered_children.

◆ append() [1/2]

void config::append ( const config cfg)

◆ append() [2/2]

void config::append ( config &&  cfg)

Definition at line 277 of file config.cpp.

References append_children(), and values_.

◆ append_attributes()

void config::append_attributes ( const config cfg)

Adds attributes from cfg.

Definition at line 252 of file config.cpp.

References check_valid(), and values_.

Referenced by default_map_generator_job::default_generate_map().

◆ append_children() [1/3]

void config::append_children ( const config cfg)

◆ append_children() [2/3]

void config::append_children ( config &&  cfg)

Definition at line 232 of file config.cpp.

References add_child(), check_valid(), children_, and ordered_children.

◆ append_children() [3/3]

void config::append_children ( const config cfg,
const std::string &  key 
)

Adds children from cfg.

Definition at line 260 of file config.cpp.

References add_child(), check_valid(), and child_range().

◆ append_children_by_move()

void config::append_children_by_move ( config cfg,
const std::string &  key 
)

Moves children with the given name from the given config to this one.

Definition at line 294 of file config.cpp.

References add_child(), check_valid(), child_range(), and clear_children_impl().

Referenced by game_config_manager::load_addons_cfg().

◆ apply_diff()

void config::apply_diff ( const config diff,
bool  track = false 
)

A function to apply a diff config onto this config object.

If the "track" parameter is true, the changes made will be marked in a magic attribute (defined above) of this and child nodes of this config, with "new" value indicating an added child, "modified" a modified one, and "deleted" for the deleted items, which will not be actually deleted (so calling code can easily see what they are). Use clear_diff_track with the same diff object to clear the tracking info and actually delete the nodes.

Definition at line 1125 of file config.cpp.

References add_child_at(), check_valid(), child_range(), children_, diff_track_attribute, error(), i, utf8::index(), lexical_cast(), optional_child(), remove_child(), and values_.

Referenced by lua_wml::intf_wml_patch(), gui2::dialogs::mp_join_game::network_handler(), process_command_args(), and mp::lobby_info::process_gamelist_diff_impl().

◆ attribute_count()

unsigned config::attribute_count ( ) const

Count the number of non-blank attributes.

Definition at line 389 of file config.cpp.

References values_.

Referenced by intf_remove_modifications(), and game_events::builtin_conditions::variable_matches().

◆ attribute_range() [1/2]

config::const_attr_itors config::attribute_range ( ) const

◆ attribute_range() [2/2]

config::attr_itors config::attribute_range ( )

Definition at line 872 of file config.cpp.

References check_valid(), and values_.

◆ check_valid() [1/2]

void config::check_valid ( ) const
private

◆ check_valid() [2/2]

void config::check_valid ( const config cfg) const
private

Raises an exception if this or cfg is not valid.

Definition at line 123 of file config.cpp.

References error().

◆ child() [1/4]

config & config::child ( config_key_type  key,
int  n = 0 
)

Returns the nth child with the given key, or a reference to an invalid config if there is none.

Note
A negative n accesses from the end of the object. For instance, -1 is the index of the last child.

Definition at line 402 of file config.cpp.

References check_valid(), children_, DBG_CF, config::throw_when_child_not_found::do_throw(), error(), i, invalid, and n.

Referenced by unit::ability_active(), unit::ability_affects_self(), unit::ability_affects_weapon(), ai::component_manager::add_component(), schema_validation::wml_tag::add_filter(), unit::add_modification(), theme::add_object(), schema_validation::wml_tag::add_switch(), ai::target_unit_goal::add_targets(), ai::protect_goal::add_targets(), unit::apply_builtin_effect(), attack_type::apply_modification(), synced_context::ask_server_choice(), ai::ai_default_rca::aspect_attacks::aspect_attacks(), BOOST_AUTO_TEST_CASE(), team::build(), replay::build_chat_log(), unit_type::build_help_index(), gui2::implementation::builder_grid_listbox::builder_grid_listbox(), gui2::implementation::builder_horizontal_listbox::builder_horizontal_listbox(), gui2::implementation::builder_listbox::builder_listbox(), gui2::implementation::builder_matrix::builder_matrix(), gui2::implementation::builder_multi_page::builder_multi_page(), gui2::implementation::builder_panel::builder_panel(), gui2::implementation::builder_scrollbar_panel::builder_scrollbar_panel(), gui2::implementation::builder_size_lock::builder_size_lock(), gui2::implementation::builder_slider::builder_slider(), gui2::implementation::builder_stacked_widget::builder_stacked_widget(), gui2::implementation::builder_toggle_panel::builder_toggle_panel(), ai::candidate_action::candidate_action(), wfl::candidate_action_with_filters::candidate_action_with_filters(), ai::config_value_translator< config >::cfg_to_value(), ai::config_value_translator< terrain_filter >::cfg_to_value(), ai::component_manager::change_component(), game_config_view::child(), vconfig::child(), child(), persist_file_context::clear_var(), ai::composite_aspect< T >::composite_aspect(), default_map_generator::config_name(), addons_client::connect(), ng::connect_engine::connect_engine(), savegame::convert_old_saves_1_11_0(), savegame::convert_old_saves_1_13_0(), savegame::convert_old_saves_1_13_1(), savegame::loadgame::copy_era(), actions::undo_list::create_action(), create_side_engine(), default_map_generator_job::default_generate_map(), addons_client::delete_remote_addon(), do_replay_handle(), wb::side_actions::execute_net_cmd(), saved_game::expand_mp_events(), saved_game::expand_random_scenario(), unit::expire_modifications(), savegame::extract_summary_from_config(), gui2::dialogs::mp_join_game::fetch_game_config(), unit_abilities::filter_base_matches(), game_events::wml_event_pump::filter_event(), game_config_view::find_child(), schema_validation::wml_type::from_config(), test_utils::game_config_manager::game_config_manager(), game_state::game_state(), unit_type::get_ability_list(), get_addon_install_info(), variable_info_implementation::vi_policy_const::get_child_at(), variable_info_implementation::vi_policy_create::get_child_at(), variable_info_implementation::vi_policy_throw::get_child_at(), ng::flg_manager::get_default_faction(), get_diff(), get_global_variable(), unit::get_modification_advances(), persist_context::get_node(), saved_game::get_replay_starting_point(), gui2::dialogs::mp_join_game::get_scenario(), persist_file_context::get_var(), gui2::gui_definition::gui_definition(), campaignd::server::handle_upload(), vconfig::has_child(), game_lua_kernel::impl_current_get(), ai::configuration::init(), unit::init(), mp::initial_level_config(), intf_append_ai(), ng::depcheck::manager::is_modification_active(), campaignd::server::load_config(), wesnothd::server::load_config(), game_config::load_config(), font::load_font_config(), ng::connect_engine::load_previous_sides_users(), synced_checkup::local_checkup(), pathfind::manager::manager(), attack_type::modified_damage(), wb::move::move(), gui2::dialogs::mp_join_game::network_handler(), ai::target_location_goal::on_create(), ai::protect_goal::on_create(), variable_info_implementation::replace_range_h::operator()(), operator<<(), optional_child(), help::parse_config(), ai::configuration::parse_side_config(), cave_map_generator::cave_map_generator_job::place_chamber(), gui2::dialogs::mp_join_game::post_show(), gui2::dialogs::campaign_difficulty::post_show(), gui2::dialogs::mp_join_game::pre_show(), game_events::wml_event_pump::process_event(), mp::lobby_info::process_gamelist(), mp::lobby_info::process_gamelist_diff_impl(), turn_info::process_network_data(), ng::connect_engine::process_network_data(), gui2::dialogs::mp_lobby::process_network_data(), wb::manager::process_network_data(), ng::random_map::random_map(), wesnothd::ban_manager::read(), unit_type_data::read_hide_help(), ai::default_recruitment::recruitment_aspect::recruitment_aspect(), actions::undo_list::redo(), display::refresh_report(), remove_children(), addons_client::request_addons_list(), addons_client::request_distribution_terms(), gui2::scrollbar_panel_definition::resolution::resolution(), gui2::progress_bar_definition::resolution::resolution(), gui2::vertical_scrollbar_definition::resolution::resolution(), gui2::panel_definition::resolution::resolution(), gui2::horizontal_scrollbar_definition::resolution::resolution(), gui2::size_lock_definition::resolution::resolution(), gui2::minimap_definition::resolution::resolution(), gui2::image_definition::resolution::resolution(), gui2::unit_preview_pane_definition::resolution::resolution(), gui2::button_definition::resolution::resolution(), gui2::repeating_button_definition::resolution::resolution(), gui2::scroll_label_definition::resolution::resolution(), gui2::menu_button_definition::resolution::resolution(), gui2::stacked_widget_definition::resolution::resolution(), gui2::addon_list_definition::resolution::resolution(), gui2::multimenu_button_definition::resolution::resolution(), gui2::tree_view_definition::resolution::resolution(), gui2::label_definition::resolution::resolution(), gui2::multi_page_definition::resolution::resolution(), gui2::matrix_definition::resolution::resolution(), gui2::chatbox_definition::resolution::resolution(), gui2::slider_definition::resolution::resolution(), gui2::text_box_definition::resolution::resolution(), gui2::listbox_definition::resolution::resolution(), gui2::window_definition::resolution::resolution(), lua_kernel_base::run_lua_tag(), ng::connect_engine::save_reserved_sides_information(), ng::connect_engine::scenario(), user_choice_manager::search_in_replay(), help::section_is_referenced(), campaignd::server::server_info(), saved_game::set_data(), set_global_variable(), gui2::dialogs::team_mode_controller::show_array(), gui2::dialogs::mp_join_game::show_flg_select(), ng::side_engine::side_engine(), ng::connect_engine::start_game(), theme::status_item::status_item(), help::topic_is_referenced(), gui2::implementation::tree_node::tree_node(), ng::depcheck::manager::try_era_by_index(), ng::depcheck::manager::try_modification_by_index(), ng::depcheck::manager::try_scenario_by_index(), actions::undo_action::undo_action(), unit_type::unit_type(), unit_type_data::unit_type_data(), addons_client::update_last_error(), addons_client::upload_addon(), campaignd::server::validate_addon(), gui2::builder_window::window_resolution::window_resolution(), actions::undo::recruit_action::write(), and actions::undo::move_action::write().

◆ child() [2/4]

const config& config::child ( config_key_type  key,
int  n = 0 
) const
inline

Returns the nth child with the given key, or a reference to an invalid config if there is none.

Note
A negative n accesses from the end of the object. For instance, -1 is the index of the last child.

Definition at line 352 of file config.hpp.

References add_child(), add_child_at(), child(), get_deprecated_child(), get_deprecated_child_range(), utf8::index(), game_config::images::level, n, operator[](), and optional_child().

◆ child() [3/4]

config & config::child ( config_key_type  key,
const std::string &  parent 
)

Returns a mandatory child node.

If the child is not found a wml_exception is thrown.

Precondition
parent[0] == '['
parent[parent.size() - 1] == ']'
Parameters
keyThe key of the child item to return.
parentThe section in which the child should reside. This is only used for error reporting.
Returns
The wanted child node.

Definition at line 435 of file config.cpp.

References config_implementation::child().

◆ child() [4/4]

const config & config::child ( config_key_type  key,
const std::string &  parent 
) const

Returns a mandatory child node.

If the child is not found a wml_exception is thrown.

Precondition
parent[0] == '['
parent[parent.size() - 1] == ']'
Parameters
keyThe key of the child item to return.
parentThe section in which the child should reside. This is only used for error reporting.
Returns
The wanted child node.

Definition at line 440 of file config.cpp.

References config_implementation::child().

◆ child_count()

unsigned config::child_count ( config_key_type  key) const

◆ child_or_add()

config & config::child_or_add ( config_key_type  key)

◆ child_or_empty()

const config & config::child_or_empty ( config_key_type  key) const

◆ child_range() [1/2]

config::child_itors config::child_range ( config_key_type  key)

Definition at line 344 of file config.cpp.

References check_valid(), children_, dummy, i, and p.

Referenced by unit::ability_active(), unit::ability_affects_adjacent(), about::credits_group::about_group::about_group(), game_classification::active_addons(), unit_animation::add_anims(), gui2::dialogs::campaign_selection::add_campaign_to_tree(), replay::add_config(), schema_validation::wml_tag::add_filter(), terrain_builder::add_images_from_config(), unit::add_modification(), theme::add_object(), schema_validation::wml_tag::add_switch(), addon_filename_legal(), mp_game_settings::addon_version_info::addon_version_info(), unit_type::advancements(), ai::holder::append_ai(), append_children(), append_children_by_move(), replay_recorder_base::append_config(), unit::apply_builtin_effect(), apply_diff(), editor::brush::brush(), team::build(), unit_type::build_help_index(), gui2::builder_grid::builder_grid(), gui2::implementation::builder_menu_button::builder_menu_button(), gui2::implementation::builder_multi_page::builder_multi_page(), gui2::implementation::builder_multimenu_button::builder_multimenu_button(), gui2::implementation::builder_slider::builder_slider(), gui2::implementation::builder_stacked_widget::builder_stacked_widget(), gui2::implementation::builder_tree_view::builder_tree_view(), saved_game::cancel_orders(), carryover::carryover(), carryover_info::carryover_info(), ng::depcheck::manager::change_era(), ng::depcheck::manager::change_modifications(), ng::depcheck::manager::change_scenario(), vconfig::child(), game_config_view::child_range(), clear_diff_track(), ai::composite_aspect< T >::composite_aspect(), ng::connect_engine::connect_engine(), contains_hashlist(), savegame::convert_old_saves_1_11_0(), savegame::convert_old_saves_1_13_1(), about::credits_group::credits_group(), campaignd::data_apply_addlist(), campaignd::data_apply_removelist(), default_map_generator_job::default_generate_map(), gui2::dialogs::mp_options_helper::display_custom_options(), gui2::dialogs::game_load::display_savegame_internal(), events::console_handler::do_choose_level(), do_gameloop(), mp::do_notify(), unit_type::events(), gui2::dialogs::sp_options_configure::execute(), wb::side_actions::execute_net_cmd(), ng::depcheck::manager::exists(), saved_game::expand_mp_options(), expand_partialresolution(), ai::configuration::expand_simplified_aspects(), savegame::extract_summary_from_config(), find_next_scenarios(), campaignd::find_translations(), savegame::save_index_class::fix_leader_image_path(), ng::flg_manager::flg_manager(), schema_validation::wml_type::from_config(), mp::game_info::game_info(), cave_map_generator::cave_map_generator_job::generate_chambers(), help::generate_contents(), help::generate_faction_topics(), gui2::dialogs::mp_join_game::generate_side_list(), unit::generate_traits(), help::generate_weapon_special_topics(), get_checksum(), ng::depcheck::manager::get_era_index(), ai::default_recruitment::recruitment::get_most_important_job(), gui2::dialogs::addon_manager::get_name_filter_visibility(), get_resolution(), ng::depcheck::manager::get_scenario_index(), ng::side_engine::get_side_children(), unit::get_traits_list(), campaignd::get_version_map(), gui2::gui_definition::gui_definition(), campaignd::server::handle_request_campaign(), campaignd::server::handle_request_campaign_list(), campaignd::server::handle_upload(), vconfig::has_child(), impl_music_get(), inherit_scenario(), gui2::init(), ai::configuration::init(), ai::holder::init(), game_state::init(), unit::init(), editor::editor_controller::init_music(), editor::editor_controller::init_tods(), game_lua_kernel::initialize(), intf_remove_modifications(), team_builder::leader(), ai::default_recruitment::recruitment::limit_ok(), gui2::tip_of_the_day::load(), preferences::load_acquaintances(), game_config_manager::load_addons_cfg(), campaignd::server::load_config(), wesnothd::ban_manager::load_config(), wesnothd::server::load_config(), game_config::load_config(), savegame::loadgame::load_game(), game_config_manager::load_game_config(), preferences::load_game_prefs(), load_language_list(), saved_game::load_non_scenario(), gui2::styled_widget_definition::load_resolutions(), editor::map_context::load_scenario(), ng::campaign::mark_if_completed(), matches(), movetype::merge(), merge_children(), merge_children_by_attribute(), game_config_view::merged_children_view(), unit_type::modification_advancements(), unit::modification_count(), theme::modify(), wb::move::move(), movetype::movetype(), mp_game_settings::mp_game_settings(), unit_type::musthave_status(), gui2::dialogs::mp_join_game::network_handler(), gui2::dialogs::mp_staging::network_handler(), ng::side_engine::new_config(), ai::ai_default_rca::candidate_action_evaluation_loop::on_create(), ai::ai_composite::on_create(), ai::formula_ai::on_create(), ai::readonly_context_impl::on_readonly_context_create(), terrain_builder::parse_config(), gui2::parse_linked_group_definitions(), gui2::implementation::parse_list_data(), ai::configuration::parse_side_config(), time_of_day::parse_times(), unit_animation::particle::particle(), game_state::place_sides_in_preferred_locations(), play_controller::play_controller(), playsingle_controller::play_scenario(), unit_type::possible_traits(), gui2::dialogs::preferences_dialog::post_build(), saved_game::post_scenario_generation(), gui2::dialogs::unit_advance::pre_show(), gui2::dialogs::help_browser::pre_show(), gui2::dialogs::campaign_difficulty::pre_show(), prepare_animation(), team_builder::prepare_units(), mp::lobby_info::process_gamelist(), mp::lobby_info::process_gamelist_diff_impl(), wb::manager::process_network_data(), mp::room_info::process_room_members(), mp::lobby_info::process_userlist(), purge_dir(), map_labels::read(), actions::undo_list::read(), preproc_define::read(), addon_info::read(), wesnothd::ban_manager::read(), gui2::builder_window::read(), read_addons_list(), read_battle_result_map(), read_by_cth_map(), schema_validation::schema_validator::read_config_file(), actions::undo_action::read_event_vector(), game_events::manager::read_scenario(), statistics::read_stats(), ai::default_recruitment::recruitment_aspect::recruitment_aspect(), replay::redo(), display::refresh_report(), unit_type::resistance_against(), gui2::toggle_button_definition::resolution::resolution(), gui2::toggle_panel_definition::resolution::resolution(), help::section_is_referenced(), saved_game::set_data(), saved_game::set_defaults(), preferences::editor::set_draw_num_of_bitmaps(), game_events::wmi_manager::set_menu_items(), theme::set_resolution(), ng::scenario::set_sides(), gui2::dialogs::mp_join_game::show_flg_select(), attack_type::special_active_impl(), gui2::styled_widget_definition::styled_widget_definition(), help::topic_is_referenced(), unarchive_dir(), saved_game::unify_controllers(), unit_animation::unit_animation(), gui2::dialogs::mp_options_helper::update_options_data_map_menu_button(), desktop::user_bookmarks(), verify(), schema_validation::wml_tag::wml_tag(), write_difference(), write_hashlist(), ng::configure_engine::write_parameters(), and scoped_wml_variable::~scoped_wml_variable().

◆ child_range() [2/2]

config::const_child_itors config::child_range ( config_key_type  key) const

Definition at line 358 of file config.cpp.

References check_valid(), children_, dummy, i, and p.

◆ clear()

void config::clear ( )

◆ clear_all_children()

void config::clear_all_children ( )

Definition at line 928 of file config.cpp.

References children_, and ordered_children.

Referenced by clear_children().

◆ clear_attributes()

void config::clear_attributes ( )

Definition at line 935 of file config.cpp.

References values_.

Referenced by clear_children().

◆ clear_children()

template<typename... T>
void config::clear_children ( T...  keys)
inline

◆ clear_children_impl()

void config::clear_children_impl ( config_key_type  key)
private

◆ clear_diff_track()

void config::clear_diff_track ( const config diff)

Clear any tracking info from a previous apply_diff call with tracking.

This also removes the nodes that are to be deleted, in effect making apply_diff(c, true); clear_diff_tracking(c); equivalent to apply_diff(c, false);

Definition at line 1188 of file config.cpp.

References child_range(), children_, diff_track_attribute, error(), i, utf8::index(), lexical_cast(), p, remove_attribute(), and remove_child().

Referenced by mp::lobby_info::process_gamelist_diff_impl().

◆ copy_attributes()

template<typename... T>
void config::copy_attributes ( const config from,
T...  keys 
)
inline

Definition at line 529 of file config.hpp.

References attribute_range(), find_child(), and get().

Referenced by campaignd::server::handle_upload().

◆ debug()

std::string config::debug ( ) const

◆ empty()

bool config::empty ( ) const

Definition at line 941 of file config.cpp.

References check_valid(), children_, and values_.

Referenced by unit_animation::add_anims(), game_events::event_handlers::add_event_handler(), unit::add_modification(), schema_validation::wml_tag::add_switch(), hotkey::add_wml_hotkey(), BOOST_AUTO_TEST_CASE(), gui2::implementation::builder_drawing::builder_drawing(), ng::campaign::can_launch_game(), saved_game::check_require_scenario(), clear_children(), persist_file_context::clear_var(), replay_network_sender::commit_and_sync(), ng::connect_engine::connect_engine(), savegame::convert_old_saves_1_11_0(), savegame::convert_old_saves_1_13_0(), default_map_generator_job::default_generate_map(), gui2::dialogs::story_viewer::display_part(), gui2::dialogs::game_load::display_savegame_internal(), unit_abilities::effect::effect(), vconfig::empty(), gui2::dialogs::mp_lobby::enter_game(), ai::ai_default_rca::move_leader_to_goals_phase::evaluate(), gui2::dialogs::sp_options_configure::execute(), savegame::extract_summary_from_config(), unit_filter_impl::unit_filter_compound::fill(), game_events::wml_menu_item::finish_handler(), campaignd::format_addon_feedback_url(), mp::game_info::game_info(), gui2::dialogs::generate_difficulty_config(), get_heal_sound(), saved_game::get_replay_starting_point(), saved_game::get_scenario_id(), ai::lua_ai_action_handler::handle(), wesnothd_connection::handle_read(), campaignd::server::handle_request_campaign(), campaignd::server::handle_request_campaign_list(), unit::init(), game_events::wml_menu_item::init_handler(), game_lua_kernel::initialize(), installed_addons_and_versions(), game_lua_kernel::intf_skip_messages(), game_config_manager::load_addons_cfg(), campaignd::server::load_config(), wesnothd::server::load_config(), game_config_manager::load_game_config_with_loadscreen(), synced_checkup::local_checkup(), ignored_checkup::local_checkup(), mp_debug_checkup::local_checkup(), schema_validation::wml_condition::matches(), ng::side_engine::new_config(), unit_animation::particle::particle(), playsingle_controller::play_scenario(), playsingle_controller::play_scenario_init(), gui2::dialogs::mp_create_game::post_show(), gui2::dialogs::faction_select::pre_show(), playturn_network_adapter::read(), read_config(), playturn_network_adapter::read_from_network(), savegame::read_save_file(), refresh_addon_version_info_cache(), display::refresh_report(), persist_file_context::save_context(), wb::manager::send_network_data(), about::set_about(), lua_gui2::show_message_dialog(), replay_network_sender::sync_non_undoable(), saved_game::to_config(), ai::aspect_attacks_lua::to_config(), game_events::wml_menu_item::to_config(), carryover_info::transfer_all_to(), replay::undo_cut(), ng::connect_engine::update_and_send_diff(), game_events::wml_menu_item::update_command(), gui2::dialogs::mp_create_game::update_details(), team::team_info::write(), movetype::terrain_info::data::write(), and saved_game::write_config().

◆ erase()

◆ find_child() [1/2]

config & config::find_child ( config_key_type  key,
const std::string &  name,
const std::string &  value 
)

◆ find_child() [2/2]

const config& config::find_child ( config_key_type  key,
const std::string &  name,
const std::string &  value 
) const
inline

Definition at line 549 of file config.hpp.

References clear_children_impl(), and find_child().

◆ find_total_first_of()

size_t config::find_total_first_of ( config_key_type  key,
size_t  start = 0 
)

◆ get()

const config::attribute_value * config::get ( config_key_type  key) const

◆ get_deprecated_attribute()

const config::attribute_value & config::get_deprecated_attribute ( config_key_type  old_key,
const std::string &  in_tag,
DEP_LEVEL  level,
const std::string &  message 
) const

Get a deprecated attribute without a direct substitute, and log a deprecation message.

Parameters
old_keyThe deprecated attribute to return if present
in_tagThe name of the tag this attribute appears in
levelThe deprecation level
messageAn explanation of the deprecation, possibly mentioning an alternative

Definition at line 824 of file config.cpp.

References check_valid(), deprecated_message(), i, and values_.

Referenced by operator[](), and unit_formula_manager::read().

◆ get_deprecated_child()

utils::optional_reference< const config > config::get_deprecated_child ( config_key_type  old_key,
const std::string &  in_tag,
DEP_LEVEL  level,
const std::string &  message 
) const

Get a deprecated child and log a deprecation message.

Parameters
old_keyThe deprecated child to return if present
in_tagThe name of the tag this child appears in
levelThe deprecation level
messageAn explanation of the deprecation, possibly mentioning an alternative
Note
The deprecation message will be a level 3 deprecation.

Definition at line 488 of file config.cpp.

References check_valid(), children_, deprecated_message(), and i.

Referenced by child(), and unit_formula_manager::read().

◆ get_deprecated_child_range()

config::const_child_itors config::get_deprecated_child_range ( config_key_type  old_key,
const std::string &  in_tag,
DEP_LEVEL  level,
const std::string &  message 
) const

Get a deprecated child rangw and log a deprecation message.

Parameters
old_keyThe deprecated child to return if present
in_tagThe name of the tag this child appears in
levelThe deprecation level
messageAn explanation of the deprecation, possibly mentioning an alternative
Note
The deprecation message will be a level 3 deprecation.

Definition at line 500 of file config.cpp.

References check_valid(), children_, deprecated_message(), dummy, i, and p.

Referenced by child().

◆ get_diff() [1/2]

config config::get_diff ( const config c) const

A function to get the differences between this object, and 'c', as another config object.

I.e. calling cfg2.apply_diff(cfg1.get_diff(cfg2)) will make cfg2 identical to cfg1.

Definition at line 1004 of file config.cpp.

References check_valid().

Referenced by get_diff(), lua_wml::intf_wml_diff(), process_command_args(), and ng::connect_engine::update_and_send_diff().

◆ get_diff() [2/2]

void config::get_diff ( const config c,
config res 
) const

Definition at line 1013 of file config.cpp.

References a, add_child(), b, check_valid(), child(), children_, dummy, get_diff(), and values_.

◆ get_invalid()

static config& config::get_invalid ( )
inlinestatic

Definition at line 112 of file config.hpp.

Referenced by campaignd::server::get_addon().

◆ get_old_attribute()

const config::attribute_value & config::get_old_attribute ( config_key_type  key,
const std::string &  old_key,
const std::string &  in_tag,
const std::string &  message = "" 
) const

Function to handle backward compatibility Get the value of key and if missing try old_key and log a deprecation message.

Parameters
keyThe non-deprecated attribute to return
old_keyThe deprecated attribute to return if key is missing
in_tagThe name of the tag these attributes appear in
messageAn explanation of the deprecation, to be output if old_key is present.
Note
The deprecation message will be a level 1 deprecation.

Definition at line 800 of file config.cpp.

References check_valid(), deprecated_message(), has_attribute(), i, INDEFINITE, wfl::msg(), and values_.

Referenced by default_map_generator_job::default_generate_map(), and operator[]().

◆ has_attribute()

bool config::has_attribute ( config_key_type  key) const

Definition at line 211 of file config.cpp.

References check_valid(), and values_.

Referenced by name_generator_factory::add_name_generator_from_config(), ai::aspect_attacks_lua::aspect_attacks_lua(), storyscreen::background_layer::background_layer(), gui2::implementation::builder_addon_list::builder_addon_list(), ng::campaign::campaign(), mp::game_info::check_addon_version_compatibility(), persist_file_context::clear_var(), default_map_generator_job::default_generate_map(), ai::engine_lua::do_parse_candidate_action_from_config(), ng::depcheck::manager::does_conflict(), ng::depcheck::manager::does_require(), ai::configuration::expand_simplified_aspects(), savegame::extract_summary_from_config(), gui2::dialogs::mp_join_game::fetch_game_config(), unit_creator::find_location(), frame_builder::frame_builder(), schema_validation::wml_type::from_config(), get_addon_tracking_info(), ai::engine_lua::get_engine_code(), get_old_attribute(), ng::depcheck::manager::get_required(), ai::vector_property_handler< T >::handle_change(), ai::aspect_property_handler< T >::handle_change(), team::team_info::handle_legacy_share_vision(), campaignd::server::handle_read_from_fifo(), vconfig::has_attribute(), unit::init(), ng::create_engine::init_generated_level_data(), insert(), intf_default_generate(), intf_default_generate_height_map(), theme::label::label(), game_config::load_config(), ai::lua_aspect< T >::lua_aspect(), ai::lua_candidate_action_wrapper_external::lua_candidate_action_wrapper_external(), ai::lua_goal::lua_goal(), lua_map_generator::lua_map_generator(), ng::side_engine::new_config(), ai::target_location_goal::on_create(), gui2::dialogs::mp_lobby::pre_show(), turn_info::process_network_data(), ng::random_map::random_map(), wesnothd::banned::read(), team::team_info::read(), preproc_define::read_argument(), unit_type_data::set_config(), persist_file_context::set_var(), lua_gui2::show_message_dialog(), theme::status_item::status_item(), font::subset_descriptor::subset_descriptor(), pathfind::teleport_group::teleport_group(), tod_manager::tod_manager(), carryover_info::transfer_all_to(), carryover_info::transfer_to(), unit_type_data::unit_type_data(), schema_validation::wml_key::wml_key(), game_events::wml_menu_item::wml_menu_item(), schema_validation::wml_tag::wml_tag(), and write_str_int_map().

◆ has_child()

bool config::has_child ( config_key_type  key) const

Determine whether a config has a child or not.

Parameters
keyThe key of the child to find.
Returns
Whether a child is available.

Definition at line 394 of file config.cpp.

References check_valid(), children_, and i.

Referenced by unit::ability_affects_weapon(), replay::add_chat_message_location(), replay::add_config(), schema_validation::wml_tag::add_filter(), replay::add_start_if_not_there_yet(), schema_validation::wml_tag::add_switch(), unit::apply_builtin_effect(), unit::apply_modifications(), synced_context::ask_server_choice(), gui2::implementation::builder_grid_listbox::builder_grid_listbox(), gui2::implementation::builder_horizontal_listbox::builder_horizontal_listbox(), gui2::implementation::builder_listbox::builder_listbox(), gui2::implementation::builder_size_lock::builder_size_lock(), gui2::implementation::builder_stacked_widget::builder_stacked_widget(), persist_file_context::clear_var(), savegame::convert_old_saves_1_11_0(), savegame::convert_old_saves_1_13_0(), ng::create_engine::current_level_has_side_data(), campaignd::data_apply_removelist(), default_map_generator_job::default_generate_map(), gui2::dialogs::mp_options_helper::display_custom_options(), do_replay_handle(), saved_game::expand_mp_events(), ai::configuration::expand_simplified_aspects(), savegame::extract_summary_from_config(), schema_validation::wml_type::from_config(), persist_context::get_node(), persist_file_context::get_var(), turn_info::handle_turn(), unit::init(), addons_client::install_addon(), intf_append_ai(), campaignd::server::load_config(), gui2::dialogs::mp_join_game::network_handler(), gui2::dialogs::mp_staging::network_handler(), ai::configuration::parse_side_config(), turn_info::process_network_data(), ng::random_map::random_map(), ai::default_recruitment::recruitment_aspect::recruitment_aspect(), user_choice_manager::search_in_replay(), ng::scenario::set_sides(), carryover_info::transfer_to(), unit_type_data::unit_type_data(), and desktop::user_bookmarks().

◆ hash()

std::string config::hash ( ) const

◆ inherit_attributes()

void config::inherit_attributes ( const config c)

Merge the attributes of config 'c' into this config, preserving this config's values.

Definition at line 1289 of file config.cpp.

References config_attribute_value::blank(), check_valid(), and values_.

Referenced by inherit_scenario().

◆ inherit_from()

void config::inherit_from ( const config c)

Merge config 'c' into this config, preserving this config's values.

Definition at line 1277 of file config.cpp.

References merge_with(), and swap().

Referenced by unit_type_data::apply_base_unit(), and unit_type::create_sub_type().

◆ insert()

template<typename T >
void config::insert ( config_key_type  key,
T &&  value 
)
inline

Inserts an attribute into the config.

Parameters
keyThe name of the attribute
valueThe attribute value

Definition at line 506 of file config.hpp.

References child_or_add(), has_attribute(), merge_attributes(), operator[](), and remove_attribute().

Referenced by battle_context::choose_defender_weapon(), and detail::config_construct_unpacker< K, V, Rest... >::visit().

◆ matches()

bool config::matches ( const config filter) const

◆ merge_attributes()

void config::merge_attributes ( const config cfg)

◆ merge_children()

void config::merge_children ( const std::string &  key)

All children with the given key will be merged into the first element with that key.

Definition at line 307 of file config.cpp.

References add_child(), append(), check_valid(), child_count(), child_range(), and clear_children_impl().

◆ merge_children_by_attribute()

void config::merge_children_by_attribute ( const std::string &  key,
const std::string &  attribute 
)

All children with the given key and with equal values of the specified attribute will be merged into the element with that key and that value of the attribute.

Definition at line 324 of file config.cpp.

References add_child(), check_valid(), child_count(), child_range(), clear_children_impl(), and i.

Referenced by ai::configuration::parse_side_config().

◆ merge_with()

void config::merge_with ( const config c)

◆ operator bool()

config::operator bool ( ) const
inlineexplicit

Definition at line 109 of file config.hpp.

◆ operator=() [1/2]

config & config::operator= ( const config cfg)

Definition at line 158 of file config.cpp.

References swap().

◆ operator=() [2/2]

config & config::operator= ( config &&  cfg)

Definition at line 176 of file config.cpp.

References clear(), and swap().

◆ operator[]() [1/6]

config::attribute_value & config::operator[] ( config_key_type  key)

Returns a reference to the attribute with the given key.

Creates it if it does not exist.

Definition at line 787 of file config.cpp.

References check_valid(), and values_.

Referenced by child(), insert(), and operator[]().

◆ operator[]() [2/6]

const config::attribute_value & config::operator[] ( config_key_type  key) const

Returns a reference to the attribute with the given key or to a dummy empty attribute if it does not exist.

Definition at line 767 of file config.cpp.

References check_valid(), i, and values_.

◆ operator[]() [3/6]

attribute_value& config::operator[] ( const std::string &  key)
inline

Returns a reference to the attribute with the given key.

Creates it if it does not exist.

Definition at line 440 of file config.hpp.

References operator[]().

◆ operator[]() [4/6]

const attribute_value& config::operator[] ( const std::string &  key) const
inline

Returns a reference to the attribute with the given key or to a dummy empty attribute if it does not exist.

Definition at line 449 of file config.hpp.

References operator[]().

◆ operator[]() [5/6]

attribute_value& config::operator[] ( const char *  key)
inline

Returns a reference to the attribute with the given key.

Creates it if it does not exist.

Definition at line 458 of file config.hpp.

References operator[]().

◆ operator[]() [6/6]

const attribute_value& config::operator[] ( const char *  key) const
inline

Returns a reference to the attribute with the given key or to a dummy empty attribute if it does not exist.

Definition at line 467 of file config.hpp.

References get_deprecated_attribute(), get_old_attribute(), and operator[]().

◆ optional_child() [1/2]

utils::optional_reference< config > config::optional_child ( config_key_type  key,
int  n = 0 
)

◆ optional_child() [2/2]

utils::optional_reference< const config > config::optional_child ( config_key_type  key,
int  n = 0 
) const

Euivalent to child, but returns an empty optional if the nth child was not found.

Definition at line 455 of file config.cpp.

References child().

◆ ordered_begin() [1/2]

config::const_all_children_iterator config::ordered_begin ( ) const

◆ ordered_begin() [2/2]

config::all_children_iterator config::ordered_begin ( )

Definition at line 986 of file config.cpp.

References ordered_children.

◆ ordered_cbegin()

config::const_all_children_iterator config::ordered_cbegin ( ) const

Definition at line 963 of file config.cpp.

References ordered_children.

◆ ordered_cend()

config::const_all_children_iterator config::ordered_cend ( ) const

Definition at line 973 of file config.cpp.

References ordered_children.

◆ ordered_end() [1/2]

config::const_all_children_iterator config::ordered_end ( ) const

◆ ordered_end() [2/2]

config::all_children_iterator config::ordered_end ( )

Definition at line 991 of file config.cpp.

References ordered_children.

◆ recursive_clear_value()

void config::recursive_clear_value ( config_key_type  key)

Definition at line 690 of file config.cpp.

References check_valid(), children_, p, and values_.

Referenced by clear_children(), and get_checksum().

◆ remove_attribute()

void config::remove_attribute ( config_key_type  key)

◆ remove_attributes()

template<typename... T>
void config::remove_attributes ( T...  keys)
inline

◆ remove_child() [1/2]

void config::remove_child ( config_key_type  key,
unsigned  index 
)

◆ remove_child() [2/2]

std::vector< config::child_pos >::iterator config::remove_child ( const child_map::iterator &  l,
unsigned  pos 
)
private

Removes the child at position pos of l.

Definition at line 703 of file config.cpp.

References utf8::index(), ordered_children, and p.

◆ remove_children()

void config::remove_children ( config_key_type  key,
std::function< bool(const config &)>  p 
)

◆ splice_children()

void config::splice_children ( config src,
const std::string &  key 
)

Moves all the children with tag key from src to this.

Definition at line 664 of file config.cpp.

References check_valid(), children_, and ordered_children.

Referenced by clear_children(), inherit_scenario(), and game_lua_kernel::save_game().

◆ swap()

void config::swap ( config cfg)

◆ valid_attribute()

bool config::valid_attribute ( config_key_type  name)
static

◆ valid_tag()

bool config::valid_tag ( config_key_type  name)
static

Definition at line 183 of file config.cpp.

References c.

Referenced by luaW_toconfig(), valid_attribute(), validate_wml(), and write_internal().

◆ validate_wml()

bool config::validate_wml ( ) const

Returns true if this object represents valid WML, i.e.

can be saved to disk and again loaded by the WML parser.

Definition at line 1461 of file config.cpp.

References c, children_, valid_attribute(), valid_tag(), and values_.

Referenced by lua_wml::intf_wml_valid().

Friends And Related Function Documentation

◆ config_implementation

friend struct config_implementation
friend

Definition at line 64 of file config.hpp.

◆ operator==

bool operator== ( const config a,
const config b 
)
friend

Definition at line 1475 of file config.cpp.

Referenced by operator!=().

Member Data Documentation

◆ children_

child_map config::children_
private

◆ diff_track_attribute

const char * config::diff_track_attribute = "__diff_track"
static

The name of the attribute used for tracking diff changes.

Definition at line 745 of file config.hpp.

Referenced by apply_diff(), config_implementation::child(), clear_diff_track(), mp::do_notify(), and mp::lobby_info::process_gamelist_diff_impl().

◆ invalid

config config::invalid
staticprivate

Definition at line 66 of file config.hpp.

Referenced by config_implementation::child(), child(), and find_child().

◆ ordered_children

std::vector<child_pos> config::ordered_children
private

◆ values_

attribute_map config::values_
private

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