The Battle for Wesnoth  1.19.5+dev
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
unit_map::iterator_base< iter_types > Struct Template Reference

#include <map.hpp>

Public Types

typedef std::forward_iterator_tag iterator_category
 
typedef int difference_type
 
typedef iter_types::value_type value_type
 
typedef std::shared_ptr< value_type > pointer
 
typedef value_type & reference
 
typedef iter_types::container_type container_type
 
typedef iter_types::iterator_type iterator_type
 

Public Member Functions

 ~iterator_base ()
 
 iterator_base ()
 
 iterator_base (iterator_type i, container_type *m)
 
 iterator_base (const iterator_base &that)
 
iterator_base & operator= (const iterator_base &that)
 
 operator iterator_base< const_iter_types > () const
 
pointer operator-> () const
 
pointer get_shared_ptr () const
 This is exactly the same as operator-> but it's slightly more readable, and can replace &*iter syntax easily. More...
 
reference operator* () const
 
iterator_base & operator++ ()
 
iterator_base operator++ (int)
 
iterator_base & operator-- ()
 
iterator_base operator-- (int)
 
bool valid () const
 
 operator bool () const
 
bool operator== (const iterator_base &rhs) const
 
bool operator!= (const iterator_base &rhs) const
 

Private Member Functions

 iterator_base (lmap::iterator ui, container_type *m)
 Constructs an iterator from the location map. More...
 
bool valid_for_dereference () const
 
bool valid_entry () const
 
void valid_exit () const
 
bool valid_ref_count () const
 
void inc ()
 Increment the reference counter. More...
 
void dec ()
 Decrement the reference counter Delete the umap entry if the unit is gone and the reference counter is zero. More...
 
unit_map::umap & the_map () const
 

Private Attributes

iterator_type i_
 local iterator More...
 
container_type * tank_
 the unit_map for i_ More...
 

Friends

template<typename Y >
struct iterator_base
 
class unit_map
 

Detailed Description

template<typename iter_types>
struct unit_map::iterator_base< iter_types >

Definition at line 140 of file map.hpp.

Member Typedef Documentation

◆ container_type

template<typename iter_types >
typedef iter_types::container_type unit_map::iterator_base< iter_types >::container_type

Definition at line 147 of file map.hpp.

◆ difference_type

template<typename iter_types >
typedef int unit_map::iterator_base< iter_types >::difference_type

Definition at line 143 of file map.hpp.

◆ iterator_category

template<typename iter_types >
typedef std::forward_iterator_tag unit_map::iterator_base< iter_types >::iterator_category

Definition at line 142 of file map.hpp.

◆ iterator_type

template<typename iter_types >
typedef iter_types::iterator_type unit_map::iterator_base< iter_types >::iterator_type

Definition at line 148 of file map.hpp.

◆ pointer

template<typename iter_types >
typedef std::shared_ptr<value_type> unit_map::iterator_base< iter_types >::pointer

Definition at line 145 of file map.hpp.

◆ reference

template<typename iter_types >
typedef value_type& unit_map::iterator_base< iter_types >::reference

Definition at line 146 of file map.hpp.

◆ value_type

template<typename iter_types >
typedef iter_types::value_type unit_map::iterator_base< iter_types >::value_type

Definition at line 144 of file map.hpp.

Constructor & Destructor Documentation

◆ ~iterator_base()

template<typename iter_types >
unit_map::iterator_base< iter_types >::~iterator_base ( )
inline

Definition at line 150 of file map.hpp.

References unit_map::iterator_base< iter_types >::dec().

◆ iterator_base() [1/4]

template<typename iter_types >
unit_map::iterator_base< iter_types >::iterator_base ( )
inline

Definition at line 155 of file map.hpp.

◆ iterator_base() [2/4]

template<typename iter_types >
unit_map::iterator_base< iter_types >::iterator_base ( iterator_type  i,
container_type *  m 
)
inline

Definition at line 161 of file map.hpp.

References unit_map::iterator_base< iter_types >::inc(), and unit_map::iterator_base< iter_types >::valid_exit().

◆ iterator_base() [3/4]

template<typename iter_types >
unit_map::iterator_base< iter_types >::iterator_base ( const iterator_base< iter_types > &  that)
inline

Definition at line 169 of file map.hpp.

References unit_map::iterator_base< iter_types >::inc(), and unit_map::iterator_base< iter_types >::valid_exit().

◆ iterator_base() [4/4]

template<typename iter_types >
unit_map::iterator_base< iter_types >::iterator_base ( lmap::iterator  ui,
container_type *  m 
)
inlineprivate

Constructs an iterator from the location map.

Definition at line 197 of file map.hpp.

References unit_map::iterator_base< iter_types >::inc(), and unit_map::iterator_base< iter_types >::valid_exit().

Member Function Documentation

◆ dec()

template<typename iter_types >
void unit_map::iterator_base< iter_types >::dec ( )
inlineprivate

Decrement the reference counter Delete the umap entry if the unit is gone and the reference counter is zero.

Note
this deletion will advance i_ to the next umap entry.

Definition at line 333 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::valid_ref_count().

Referenced by unit_map::iterator_base< iter_types >::operator++(), unit_map::iterator_base< iter_types >::operator--(), unit_map::iterator_base< iter_types >::operator=(), and unit_map::iterator_base< iter_types >::~iterator_base().

◆ get_shared_ptr()

template<typename iter_types >
pointer unit_map::iterator_base< iter_types >::get_shared_ptr ( ) const
inline

This is exactly the same as operator-> but it's slightly more readable, and can replace &*iter syntax easily.

Definition at line 217 of file map.hpp.

References unit_map::iterator_base< iter_types >::operator->().

Referenced by battle_context::battle_context(), gui2::dialogs::unit_attack::damage_calc_callback(), lua_unit::get(), gui2::dialogs::game_stats::get_leader(), actions::get_recalls(), lua_unit::get_shared(), game_events::entity_location::get_unit(), wb::move::get_unit(), wb::suppose_dead::get_unit(), display_context::get_visible_unit_shared_ptr(), game_lua_kernel::intf_find_path(), game_lua_kernel::intf_find_reach(), game_lua_kernel::intf_find_vision_range(), game_lua_kernel::intf_teleport(), events::mouse_handler::mouse_motion(), gui2::dialogs::unit_attack::pre_show(), wb::highlighter::set_mouseover_hex(), attack_type::special_active_impl(), events::mouse_handler::touch_motion(), actions::undo::move_action::undo(), actions::undo::recall_action::undo(), unit_display::unit_attack(), and unit_display::unit_recruited().

◆ inc()

template<typename iter_types >
void unit_map::iterator_base< iter_types >::inc ( )
inlineprivate

Increment the reference counter.

Definition at line 320 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, and unit_map::iterator_base< iter_types >::valid_ref_count().

Referenced by unit_map::iterator_base< iter_types >::iterator_base(), unit_map::iterator_base< iter_types >::operator++(), unit_map::iterator_base< iter_types >::operator--(), and unit_map::iterator_base< iter_types >::operator=().

◆ operator bool()

template<typename iter_types >
unit_map::iterator_base< iter_types >::operator bool ( ) const
inlineexplicit

Definition at line 278 of file map.hpp.

References unit_map::iterator_base< iter_types >::valid().

◆ operator iterator_base< const_iter_types >()

template<typename iter_types >
unit_map::iterator_base< iter_types >::operator iterator_base< const_iter_types > ( ) const
inline

Definition at line 190 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, and unit_map::iterator_base< iter_types >::tank_.

◆ operator!=()

template<typename iter_types >
bool unit_map::iterator_base< iter_types >::operator!= ( const iterator_base< iter_types > &  rhs) const
inline

Definition at line 288 of file map.hpp.

References unit_map::iterator_base< iter_types >::operator==().

◆ operator*()

template<typename iter_types >
reference unit_map::iterator_base< iter_types >::operator* ( ) const
inline

Definition at line 222 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::valid().

◆ operator++() [1/2]

template<typename iter_types >
iterator_base& unit_map::iterator_base< iter_types >::operator++ ( )
inline

Definition at line 229 of file map.hpp.

References unit_map::iterator_base< iter_types >::dec(), unit_map::end(), unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::inc(), unit_map::iterator_base< iter_types >::tank_, unit_map::iterator_base< iter_types >::the_map(), unit_map::iterator_base< iter_types >::valid_entry(), and unit_map::iterator_base< iter_types >::valid_exit().

Referenced by unit_map::iterator_base< iter_types >::operator++().

◆ operator++() [2/2]

template<typename iter_types >
iterator_base unit_map::iterator_base< iter_types >::operator++ ( int  )
inline

Definition at line 244 of file map.hpp.

References unit_map::iterator_base< iter_types >::operator++().

◆ operator--() [1/2]

template<typename iter_types >
iterator_base& unit_map::iterator_base< iter_types >::operator-- ( )
inline

Definition at line 251 of file map.hpp.

References unit_map::begin(), unit_map::iterator_base< iter_types >::dec(), unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::inc(), unit_map::iterator_base< iter_types >::tank_, unit_map::iterator_base< iter_types >::the_map(), and unit_map::iterator_base< iter_types >::valid_exit().

Referenced by unit_map::iterator_base< iter_types >::operator--().

◆ operator--() [2/2]

template<typename iter_types >
iterator_base unit_map::iterator_base< iter_types >::operator-- ( int  )
inline

Definition at line 266 of file map.hpp.

References unit_map::iterator_base< iter_types >::operator--().

◆ operator->()

template<typename iter_types >
pointer unit_map::iterator_base< iter_types >::operator-> ( ) const
inline

Definition at line 206 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::valid().

Referenced by unit_map::iterator_base< iter_types >::get_shared_ptr().

◆ operator=()

template<typename iter_types >
iterator_base& unit_map::iterator_base< iter_types >::operator= ( const iterator_base< iter_types > &  that)
inline

Definition at line 177 of file map.hpp.

References unit_map::iterator_base< iter_types >::dec(), unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::inc(), unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::valid_exit().

◆ operator==()

template<typename iter_types >
bool unit_map::iterator_base< iter_types >::operator== ( const iterator_base< iter_types > &  rhs) const
inline

Definition at line 283 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, and unit_map::iterator_base< iter_types >::tank_.

Referenced by unit_map::iterator_base< iter_types >::operator!=().

◆ the_map()

template<typename iter_types >
unit_map::umap& unit_map::iterator_base< iter_types >::the_map ( ) const
inlineprivate

Definition at line 344 of file map.hpp.

References unit_map::iterator_base< iter_types >::tank_.

Referenced by unit_map::iterator_base< iter_types >::operator++(), unit_map::iterator_base< iter_types >::operator--(), unit_map::iterator_base< iter_types >::valid_entry(), unit_map::iterator_base< iter_types >::valid_exit(), unit_map::iterator_base< iter_types >::valid_for_dereference(), and unit_map::iterator_base< iter_types >::valid_ref_count().

◆ valid()

template<typename iter_types >
bool unit_map::iterator_base< iter_types >::valid ( ) const
inline

Definition at line 273 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, and unit_map::iterator_base< iter_types >::valid_for_dereference().

Referenced by replay::add_unit_checksum(), advance_unit(), BOOST_AUTO_TEST_CASE(), playsingle_controller::hotkey_handler::can_execute_command(), play_controller::hotkey_handler::can_execute_command(), actions::shroud_clearer::clear_loc(), events::mouse_handler::current_unit_attacks_from(), ai::move_result::do_execute(), do_replay_handle(), ai::ai_default_rca::combat_phase::evaluate(), ai::ai_default_rca::move_leader_to_keep_phase::evaluate(), ai::ai_default_rca::leader_shares_keep_phase::execute(), wb::attack::execute(), unit_creator::find_location(), events::mouse_handler::find_unit(), events::mouse_handler::find_unit_nonowning(), game_board::find_visible_unit(), lua_unit::get(), lua_unit::get_shared(), wb::move::get_unit(), wb::suppose_dead::get_unit(), display_context::get_visible_unit(), display_context::get_visible_unit_shared_ptr(), game_board::has_visible_unit(), ai::helper_check_village(), events::mouse_handler::hex_hosts_unit(), game_lua_kernel::intf_find_cost_map(), game_lua_kernel::intf_find_path(), game_lua_kernel::intf_find_reach(), game_lua_kernel::intf_find_vision_range(), game_lua_kernel::intf_get_displayed_unit(), game_lua_kernel::intf_get_unit(), terrain_filter::match_internal(), game_events::entity_location::matches_unit(), game_events::entity_location::matches_unit_filter(), events::mouse_handler::mouse_motion(), unit_map::iterator_base< iter_types >::operator bool(), unit_map::iterator_base< iter_types >::operator*(), unit_map::iterator_base< iter_types >::operator->(), actions::place_recruit(), wb::manager::post_draw(), wb::manager::pre_draw(), play_controller::process_keyup_event(), game_display::scroll_to_leader(), game_board::side_change_controller(), game_board::side_drop_to(), attack_type::special_active_impl(), SYNCED_COMMAND_HANDLER_FUNCTION(), game_board::team_is_defeated(), events::mouse_handler::touch_motion(), unit_display::unit_attack(), pathfind::vision_path::vision_path(), unit_helper::will_certainly_advance(), and display_context::would_be_discovered().

◆ valid_entry()

template<typename iter_types >
bool unit_map::iterator_base< iter_types >::valid_entry ( ) const
inlineprivate

Definition at line 302 of file map.hpp.

References unit_map::end(), unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::the_map().

Referenced by unit_map::iterator_base< iter_types >::operator++().

◆ valid_exit()

template<typename iter_types >
void unit_map::iterator_base< iter_types >::valid_exit ( ) const
inlineprivate

Definition at line 307 of file map.hpp.

References unit_map::end(), unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::the_map().

Referenced by unit_map::iterator_base< iter_types >::iterator_base(), unit_map::iterator_base< iter_types >::operator++(), unit_map::iterator_base< iter_types >::operator--(), and unit_map::iterator_base< iter_types >::operator=().

◆ valid_for_dereference()

template<typename iter_types >
bool unit_map::iterator_base< iter_types >::valid_for_dereference ( ) const
inlineprivate

Definition at line 297 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::the_map().

Referenced by unit_map::iterator_base< iter_types >::valid().

◆ valid_ref_count()

template<typename iter_types >
bool unit_map::iterator_base< iter_types >::valid_ref_count ( ) const
inlineprivate

Definition at line 314 of file map.hpp.

References unit_map::iterator_base< iter_types >::i_, unit_map::iterator_base< iter_types >::tank_, and unit_map::iterator_base< iter_types >::the_map().

Referenced by unit_map::iterator_base< iter_types >::dec(), and unit_map::iterator_base< iter_types >::inc().

Friends And Related Function Documentation

◆ iterator_base

template<typename iter_types >
template<typename Y >
friend struct iterator_base
friend

Definition at line 294 of file map.hpp.

◆ unit_map

template<typename iter_types >
friend class unit_map
friend

Definition at line 349 of file map.hpp.

Member Data Documentation

◆ i_

template<typename iter_types >
iterator_type unit_map::iterator_base< iter_types >::i_
private

local iterator

Definition at line 352 of file map.hpp.

Referenced by unit_map::iterator_base< iter_types >::dec(), unit_map::iterator_base< iter_types >::inc(), unit_map::iterator_base< iter_types >::operator iterator_base< const_iter_types >(), unit_map::iterator_base< iter_types >::operator*(), unit_map::iterator_base< iter_types >::operator++(), unit_map::iterator_base< iter_types >::operator--(), unit_map::iterator_base< iter_types >::operator->(), unit_map::iterator_base< iter_types >::operator=(), unit_map::iterator_base< iter_types >::operator==(), unit_map::iterator_base< iter_types >::valid(), unit_map::iterator_base< iter_types >::valid_entry(), unit_map::iterator_base< iter_types >::valid_exit(), unit_map::iterator_base< iter_types >::valid_for_dereference(), and unit_map::iterator_base< iter_types >::valid_ref_count().

◆ tank_

template<typename iter_types >
container_type* unit_map::iterator_base< iter_types >::tank_
private

the unit_map for i_

Definition at line 354 of file map.hpp.

Referenced by unit_map::iterator_base< iter_types >::dec(), unit_map::iterator_base< iter_types >::operator iterator_base< const_iter_types >(), unit_map::iterator_base< iter_types >::operator*(), unit_map::iterator_base< iter_types >::operator++(), unit_map::iterator_base< iter_types >::operator--(), unit_map::iterator_base< iter_types >::operator->(), unit_map::iterator_base< iter_types >::operator=(), unit_map::iterator_base< iter_types >::operator==(), unit_map::iterator_base< iter_types >::the_map(), unit_map::iterator_base< iter_types >::valid_entry(), unit_map::iterator_base< iter_types >::valid_exit(), unit_map::iterator_base< iter_types >::valid_for_dereference(), and unit_map::iterator_base< iter_types >::valid_ref_count().

The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.1