actions::undo_list Class Reference

Class to store the actions that a player can undo and redo. More...

#include <undo.hpp>

Public Member Functions
	undo_list (const undo_list &)=delete
undo_list &	operator= (const undo_list &)=delete
	undo_list (const config &cfg)
	Constructor. More...
	~undo_list ()
	Destructor. More...
void	add_auto_shroud (bool turned_on)
	Adds an auto-shroud toggle to the undo stack. More...
void	add_dummy ()
	Adds an auto-shroud toggle to the undo stack. More...
void	add_dismissal (const unit_const_ptr u)
	Adds a dismissal to the undo stack. More...
void	add_move (const unit_const_ptr u, const std::vector< map_location >::const_iterator &begin, const std::vector< map_location >::const_iterator &end, int start_moves, int timebonus=0, int village_owner=-1, const map_location::DIRECTION dir=map_location::NDIRECTIONS)
	Adds a move to the undo stack. More...
void	add_recall (const unit_const_ptr u, const map_location &loc, const map_location &from, int orig_village_owner, bool time_bonus)
	Adds a recall to the undo stack. More...
void	add_recruit (const unit_const_ptr u, const map_location &loc, const map_location &from, int orig_village_owner, bool time_bonus)
	Adds a recruit to the undo stack. More...
void	add_update_shroud ()
	Adds a shroud update to the undo stack. More...
void	clear ()
	Clears the stack of undoable (and redoable) actions. More...
void	commit_vision ()
	Updates fog/shroud based on the undo stack, then updates stack as needed. More...
void	new_side_turn (int side)
	Performs some initializations and error checks when starting a new side-turn. More...
bool	player_acted () const
	Returns true if the player has performed any actions this turn. More...
void	read (const config &cfg)
	Read the undo_list from the provided config. More...
void	write (config &cfg) const
	Write the undo_list into the provided config. More...
bool	can_undo () const
	True if there are actions that can be undone. More...
bool	can_redo () const
	True if there are actions that can be redone. More...
void	undo ()
	Undoes the top action on the undo stack. More...
void	redo ()
	Redoes the top action on the redo stack. More...

Static Public Member Functions
static undo_action_base *	create_action (const config &cfg)
	Creates an undo_action based on a config. More...

Private Types
typedef std::unique_ptr< undo_action_base >	action_ptr_t
typedef std::vector< action_ptr_t >	action_list
typedef std::vector< std::unique_ptr< config > >	redos_list

Private Member Functions
void	add (undo_action_base *action)
	Adds an action to the undo stack. More...
bool	apply_shroud_changes () const
	Applies the pending fog/shroud changes from the undo stack. More...

Private Attributes
action_list	undos_
redos_list	redos_
int	side_
	Tracks the current side. More...
bool	committed_actions_
	Tracks if actions have been cleared from the stack since the turn began. More...

Detailed Description

Class to store the actions that a player can undo and redo.

Definition at line 35 of file undo.hpp.

Member Typedef Documentation

action_list

typedef std::vector<action_ptr_t> actions::undo_list::action_list

private

Definition at line 38 of file undo.hpp.

action_ptr_t

typedef std::unique_ptr<undo_action_base> actions::undo_list::action_ptr_t

private

Definition at line 37 of file undo.hpp.

redos_list

typedef std::vector<std::unique_ptr<config> > actions::undo_list::redos_list

private

Definition at line 39 of file undo.hpp.

Constructor & Destructor Documentation

undo_list() [1/2]

actions::undo_list::undo_list ( const undo_list &  )

delete

undo_list() [2/2]

actions::undo_list::undo_list ( const config &  cfg )

explicit

Constructor.

The config is allowed to be invalid.

Definition at line 126 of file undo.cpp.

References read().

~undo_list()

actions::undo_list::~undo_list

(

)

Destructor.

Definition at line 136 of file undo.cpp.

Member Function Documentation

add()

void actions::undo_list::add ( undo_action_base *  action )

inlineprivate

Adds an action to the undo stack.

Definition at line 103 of file undo.hpp.

References apply_shroud_changes(), redos_, and undos_.

Referenced by add_auto_shroud(), add_dismissal(), add_dummy(), add_move(), add_recall(), add_recruit(), and add_update_shroud().

add_auto_shroud()

void actions::undo_list::add_auto_shroud

(

bool

turned_on

)

Adds an auto-shroud toggle to the undo stack.

Todo:

: Consecutive shroud actions can be collapsed into one.

Definition at line 146 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

add_dismissal()

void actions::undo_list::add_dismissal

(

const unit_const_ptr

u

)

Adds a dismissal to the undo stack.

Definition at line 165 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

add_dummy()

void actions::undo_list::add_dummy

(

)

Adds an auto-shroud toggle to the undo stack.

Todo:

: Consecutive shroud actions can be collapsed into one.

Definition at line 154 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

add_move()

void actions::undo_list::add_move	(	const unit_const_ptr	u,
		const std::vector< map_location >::const_iterator &	begin,
		const std::vector< map_location >::const_iterator &	end,
		int	start_moves,
		int	timebonus = 0,
		int	village_owner = -1,
		const map_location::DIRECTION	dir = map_location::NDIRECTIONS
	)

Adds a move to the undo stack.

Definition at line 173 of file undo.cpp.

References add().

add_recall()

void actions::undo_list::add_recall	(	const unit_const_ptr	u,
		const map_location &	loc,
		const map_location &	from,
		int	orig_village_owner,
		bool	time_bonus
	)

Adds a recall to the undo stack.

Definition at line 185 of file undo.cpp.

References add().

Referenced by actions::recall_unit().

add_recruit()

void actions::undo_list::add_recruit	(	const unit_const_ptr	u,
		const map_location &	loc,
		const map_location &	from,
		int	orig_village_owner,
		bool	time_bonus
	)

Adds a recruit to the undo stack.

Definition at line 194 of file undo.cpp.

References add().

Referenced by actions::recruit_unit().

add_update_shroud()

void actions::undo_list::add_update_shroud

(

)

Adds a shroud update to the undo stack.

This is called from within commit_vision(), so there should be no need for this to be publicly visible.

Todo:

: Consecutive shroud actions can be collapsed into one.

Definition at line 205 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

apply_shroud_changes()

bool actions::undo_list::apply_shroud_changes ( ) const

private

Applies the pending fog/shroud changes from the undo stack.

Does nothing if the the current side does not use fog or shroud.

Returns

true if shroud or fog was cleared.

Definition at line 447 of file undo.cpp.

References team::auto_shroud_updates(), actions::clear_shroud(), actions::shroud_clearer::clear_unit(), actions::shroud_clearer::fire_events(), team::fog_or_shroud(), resources::gameboard, game_display::get_singleton(), game_board::get_team(), i, actions::shroud_clearer::invalidate_after_clear(), game_display::invalidate_unit(), synced_context::is_synced(), LOG_NG, side_, and undos_.

Referenced by add(), clear(), and commit_vision().

can_redo()

bool actions::undo_list::can_redo ( ) const

inline

True if there are actions that can be redone.

Definition at line 95 of file undo.hpp.

References redo(), redos_, and undo().

Referenced by play_controller::can_redo().

can_undo()

bool actions::undo_list::can_undo ( ) const

inline

True if there are actions that can be undone.

Definition at line 93 of file undo.hpp.

References undos_.

Referenced by play_controller::can_undo(), and turn_info::send_data().

clear()

void actions::undo_list::clear

(

)

Clears the stack of undoable (and redoable) actions.

(Also handles updating fog/shroud if needed.) Call this if an action alters the game state, but add that action to the stack before calling this (if the action is a kind that can be undone). This may fire events and change the game state.

Definition at line 220 of file undo.cpp.

References apply_shroud_changes(), committed_actions_, redos_, and undos_.

Referenced by synced_context::ask_server_choice(), wb::side_actions::execute(), play_controller::finish_side_turn(), playsingle_controller::play_ai_turn(), playmp_controller::play_human_turn(), actions::recall_unit(), actions::recruit_unit(), wb::manager::set_active(), synced_context::set_is_simultaneously(), playmp_controller::surrender(), and SYNCED_COMMAND_HANDLER_FUNCTION().

commit_vision()

void actions::undo_list::commit_vision

(

)

Updates fog/shroud based on the undo stack, then updates stack as needed.

Call this when "updating shroud now". This may fire events and change the game state.

Parameters

[in]

is_replay

Set to true when this is called during a replay.

Definition at line 243 of file undo.cpp.

References apply_shroud_changes(), committed_actions_, and undos_.

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

create_action()

undo_action_base * actions::undo_list::create_action ( const config &  cfg )

static

Creates an undo_action based on a config.

Throws bad_lexical_cast or config::error if it cannot parse the config properly.

Returns

a pointer that must be deleted, or nullptr if the cfg could not be parsed.

Definition at line 71 of file undo.cpp.

References config::child(), config::child_or_empty(), ERR_NG, unit_type_data::find(), map_location::parse_direction(), str, mariadb::value::string, and unit_types.

Referenced by read().

new_side_turn()

void actions::undo_list::new_side_turn

(

int

side

)

Performs some initializations and error checks when starting a new side-turn.

Parameters

[in]

side

The side whose turn is about to start.

Definition at line 262 of file undo.cpp.

References committed_actions_, ERR_NG, redos_, side_, and undos_.

Referenced by play_controller::do_init_side().

operator=()

undo_list& actions::undo_list::operator= ( const undo_list &  )

delete

player_acted()

bool actions::undo_list::player_acted ( ) const

inline

Returns true if the player has performed any actions this turn.

Definition at line 84 of file undo.hpp.

References committed_actions_, read(), undos_, and write().

Referenced by events::menu_handler::end_turn().

read()

void actions::undo_list::read

(

const config &

cfg

)

Read the undo_list from the provided config.

Currently, this is only used when the undo_list is empty, but in theory it could be used to append the config to the current data.

Definition at line 288 of file undo.cpp.

References config::child_range(), committed_actions_, create_action(), e, ERR_NG, redos_, side_, undos_, and game::error::what().

Referenced by player_acted(), and undo_list().

redo()

void actions::undo_list::redo

(

)

Redoes the top action on the redo stack.

Definition at line 404 of file undo.cpp.

References config::all_children_range(), config::child(), mariadb::value::data, game_display::get_singleton(), display::invalidate_game_status(), game_display::invalidate_unit(), resources::recorder, replay::redo(), redos_, display::redraw_minimap(), synced_context::run(), and mariadb::value::string.

Referenced by can_redo(), and play_controller::redo().

undo()

void actions::undo_list::undo

(

)

Undoes the top action on the undo stack.

Definition at line 348 of file undo.cpp.

References ERR_NG, resources::gameboard, n_unit::id_manager::get_save_id(), game_display::get_singleton(), display::invalidate_game_status(), game_display::invalidate_unit(), resources::recorder, replay::redo(), redos_, display::redraw_minimap(), n_unit::id_manager::set_save_id(), side_, replay::undo_cut(), undos_, game_board::unit_id_manager(), and resources::whiteboard.

Referenced by can_redo(), playmp_controller::play_human_turn(), and play_controller::undo().

write()

void actions::undo_list::write

(

config &

cfg

)

const

Write the undo_list into the provided config.

Definition at line 332 of file undo.cpp.

References config::add_child(), committed_actions_, redos_, side_, and undos_.

Referenced by player_acted().

Member Data Documentation

committed_actions_

bool actions::undo_list::committed_actions_

private

Tracks if actions have been cleared from the stack since the turn began.

Definition at line 115 of file undo.hpp.

Referenced by clear(), commit_vision(), new_side_turn(), player_acted(), read(), and write().

redos_

redos_list actions::undo_list::redos_

private

Definition at line 110 of file undo.hpp.

Referenced by add(), can_redo(), clear(), new_side_turn(), read(), redo(), undo(), and write().

side_

int actions::undo_list::side_

private

Tracks the current side.

Definition at line 113 of file undo.hpp.

Referenced by apply_shroud_changes(), new_side_turn(), read(), undo(), and write().

undos_

action_list actions::undo_list::undos_

private

Definition at line 109 of file undo.hpp.

Referenced by add(), apply_shroud_changes(), can_undo(), clear(), commit_vision(), new_side_turn(), player_acted(), read(), undo(), and write().

---

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

• actions/undo.hpp
• actions/undo.cpp