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

#include <undo.hpp>

Inheritance diagram for actions::undo_list:

Public Member Functions
	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 boost::ptr_vector < undo_action_base >	action_list

typedef boost::ptr_vector < undo_action >	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 38 of file undo.hpp.

Member Typedef Documentation

typedef boost::ptr_vector<undo_action_base> actions::undo_list::action_list

private

Definition at line 40 of file undo.hpp.

typedef boost::ptr_vector<undo_action> actions::undo_list::redos_list

private

Definition at line 41 of file undo.hpp.

Constructor & Destructor Documentation

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

explicit

Constructor.

The config is allowed to be invalid.

Definition at line 132 of file undo.cpp.

References read().

actions::undo_list::~undo_list ( )

Destructor.

Definition at line 142 of file undo.cpp.

Member Function Documentation

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

inlineprivate

Adds an action to the undo stack.

Definition at line 101 of file undo.hpp.

References redos_, and undos_.

Referenced by add_auto_shroud(), add_dismissal(), add_dummy(), add_move(), add_recall(), add_recruit(), and add_update_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 152 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

void actions::undo_list::add_dismissal ( const unit_const_ptr u )

Adds a dismissal to the undo stack.

Definition at line 171 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

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 160 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

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 179 of file undo.cpp.

References add().

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 191 of file undo.cpp.

References add().

Referenced by actions::recall_unit().

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 200 of file undo.cpp.

References add().

Referenced by actions::recruit_unit().

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 211 of file undo.cpp.

References add().

Referenced by SYNCED_COMMAND_HANDLER_FUNCTION().

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 454 of file undo.cpp.

References team::auto_shroud_updates(), actions::clear_shroud(), actions::shroud_clearer::clear_unit(), display::draw(), actions::shroud_clearer::fire_events(), team::fog_or_shroud(), i, actions::shroud_clearer::invalidate_after_clear(), game_display::invalidate_unit(), synced_context::is_synced(), LOG_NG, resources::screen, side_, and undos_.

Referenced by clear(), and commit_vision().

bool actions::undo_list::can_redo ( ) const

inline

True if there are actions that can be redone.

Definition at line 93 of file undo.hpp.

References redos_.

Referenced by play_controller::can_redo().

bool actions::undo_list::can_undo ( ) const

inline

True if there are actions that can be undone.

Definition at line 91 of file undo.hpp.

References undos_.

Referenced by play_controller::can_undo().

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 226 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(), and SYNCED_COMMAND_HANDLER_FUNCTION().