The Battle for Wesnoth: vconfig::all_children_iterator Struct Reference

The Battle for Wesnoth 1.17.14+dev

#include <variable.hpp>

Classes
struct	pointer_proxy

Public Types
typedef const std::pair< std::string, vconfig >	value_type

typedef std::bidirectional_iterator_tag	iterator_category

typedef int	difference_type

typedef const pointer_proxy	pointer

typedef const value_type	reference

typedef config::const_all_children_iterator	Itor

Public Member Functions
	all_children_iterator (const Itor &i, const variable_set &vars)

	all_children_iterator (const Itor &i, const variable_set &vars, const std::shared_ptr< const config > &cache)

all_children_iterator &	operator++ ()

all_children_iterator	operator++ (int)

all_children_iterator &	operator-- ()

all_children_iterator	operator-- (int)

reference	operator* () const

pointer	operator-> () const

std::string	get_key () const

vconfig	get_child () const

void	disable_insertion ()

bool	operator== (const all_children_iterator &i) const

bool	operator!= (const all_children_iterator &i) const

Private Attributes
Itor	i_

int	inner_index_

std::shared_ptr< const config >	cache_

const variable_set *	variables_

Detailed Description

Definition at line 136 of file variable.hpp.

Member Typedef Documentation

◆ difference_type

typedef int vconfig::all_children_iterator::difference_type

Definition at line 142 of file variable.hpp.

◆ iterator_category

typedef std::bidirectional_iterator_tag vconfig::all_children_iterator::iterator_category

Definition at line 141 of file variable.hpp.

◆ Itor

typedef config::const_all_children_iterator vconfig::all_children_iterator::Itor

Definition at line 145 of file variable.hpp.

◆ pointer

typedef const pointer_proxy vconfig::all_children_iterator::pointer

Definition at line 143 of file variable.hpp.

◆ reference

typedef const value_type vconfig::all_children_iterator::reference

Definition at line 144 of file variable.hpp.

◆ value_type

typedef const std::pair<std::string, vconfig> vconfig::all_children_iterator::value_type

Definition at line 138 of file variable.hpp.

Constructor & Destructor Documentation

◆ all_children_iterator() [1/2]

vconfig::all_children_iterator::all_children_iterator	(	const Itor &	i,
		const variable_set &	vars
	)

explicit

Definition at line 374 of file variable.cpp.

Referenced by vconfig::ordered_begin(), and vconfig::ordered_end().

◆ all_children_iterator() [2/2]

vconfig::all_children_iterator::all_children_iterator	(	const Itor &	i,
		const variable_set &	vars,
		const std::shared_ptr< const config > &	cache
	)

Definition at line 379 of file variable.cpp.

Member Function Documentation

◆ disable_insertion()

void vconfig::all_children_iterator::disable_insertion ( )

inline

Definition at line 159 of file variable.hpp.

References i, and operator==().

Referenced by lua_common::impl_vconfig_get().

◆ get_child()

vconfig vconfig::all_children_iterator::get_child ( ) const

Definition at line 456 of file variable.cpp.

References cache_, vconfig::empty_vconfig(), i_, inner_index_, variables_, and vconfig::vconfig().

Referenced by lua_common::impl_vconfig_get(), operator*(), and operator->().

◆ get_key()

std::string vconfig::all_children_iterator::get_key ( ) const

Definition at line 447 of file variable.cpp.

References i_, inner_index_, variables_, and vconfig::vconfig().

Referenced by lua_common::impl_vconfig_get(), operator*(), and operator->().

◆ operator!=()

bool vconfig::all_children_iterator::operator!= ( const all_children_iterator & i ) const

inline

Definition at line 162 of file variable.hpp.

References operator==().

◆ operator*()

vconfig::all_children_iterator::reference vconfig::all_children_iterator::operator* ( ) const

Definition at line 435 of file variable.cpp.

References get_child(), and get_key().

◆ operator++() [1/2]

vconfig::all_children_iterator & vconfig::all_children_iterator::operator++ ( )

Definition at line 384 of file variable.cpp.

References variable_info< V >::as_array(), variable_set::get_variable_access_read(), i_, inner_index_, variables_, and vconfig::vconfig().

Referenced by operator++().

◆ operator++() [2/2]

vconfig::all_children_iterator vconfig::all_children_iterator::operator++ ( int )

Definition at line 409 of file variable.cpp.

References i, and operator++().

◆ operator--() [1/2]

vconfig::all_children_iterator & vconfig::all_children_iterator::operator-- ( )

Definition at line 416 of file variable.cpp.

References i_, and inner_index_.

Referenced by operator--().

◆ operator--() [2/2]

vconfig::all_children_iterator vconfig::all_children_iterator::operator-- ( int )

Definition at line 428 of file variable.cpp.

References i, and operator--().

◆ operator->()

vconfig::all_children_iterator::pointer vconfig::all_children_iterator::operator-> ( ) const

Definition at line 440 of file variable.cpp.

References get_child(), get_key(), and p.

◆ operator==()

bool vconfig::all_children_iterator::operator== ( const all_children_iterator & i ) const

Definition at line 475 of file variable.cpp.

References i_, and inner_index_.

Member Data Documentation

◆ cache_

std::shared_ptr<const config> vconfig::all_children_iterator::cache_

private

Definition at line 179 of file variable.hpp.

Referenced by get_child(), vconfig::ordered_begin(), and vconfig::ordered_end().

◆ i_

Itor vconfig::all_children_iterator::i_

private

Definition at line 166 of file variable.hpp.

Referenced by get_child(), get_key(), operator++(), operator--(), and operator==().

◆ inner_index_

int vconfig::all_children_iterator::inner_index_

private

Definition at line 178 of file variable.hpp.

Referenced by get_child(), get_key(), operator++(), operator--(), and operator==().

◆ variables_

const variable_set* vconfig::all_children_iterator::variables_

private

Definition at line 180 of file variable.hpp.

Referenced by get_child(), get_key(), operator++(), vconfig::ordered_begin(), and vconfig::ordered_end().

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