The Battle for Wesnoth  1.15.9+dev
Classes | Public Types | Static Public Member Functions | Static Private Attributes | List of all members
synced_context Class Reference

#include <synced_context.hpp>

Classes

class  server_choice
 

Public Types

enum  synced_state { UNSYNCED, SYNCED, LOCAL_CHOICE }
 
typedef std::deque< std::pair< config, game_events::queued_event > > event_list
 

Static Public Member Functions

static bool run (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
 Sets the context to 'synced', initialises random context, and calls the given function. More...
 
static bool run_and_store (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
 
static bool run_and_throw (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
 
static bool run_in_synced_context_if_not_already (const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
 Checks whether we are currently running in a synced context, and if not we enters it. More...
 
static synced_state get_synced_state ()
 
static bool is_synced ()
 
static bool is_unsynced ()
 
static void set_synced_state (synced_state newstate)
 Should only be called form set_scontext_synced, set_scontext_local_choice. More...
 
static std::string generate_random_seed ()
 Generates a new seed for a synced event, by asking the 'server'. More...
 
static void pull_remote_user_input ()
 called from get_user_choice while waiting for a remove user choice. More...
 
static void send_user_choice ()
 called from get_user_choice to send a recently made choice to the other clients. More...
 
static void default_error_function (const std::string &message)
 A function to be passed to run_in_synced_context to assert false on error (the default). More...
 
static void just_log_error_function (const std::string &message)
 A function to be passed to run_in_synced_context to log the error. More...
 
static void ignore_error_function (const std::string &message)
 A function to be passed to run_in_synced_context to ignore the error. More...
 
static std::shared_ptr< randomness::rngget_rng_for_action ()
 
static bool is_simultaneous ()
 
static void reset_is_simultaneous ()
 Sets is_simultaneous_ = false, called when entering the synced context. More...
 
static void set_is_simultaneous ()
 Sets is_simultaneous_ = true, called using a user choice that is not the currently playing side. More...
 
static bool can_undo ()
 
static void set_last_unit_id (int id)
 
static int get_unit_id_diff ()
 
static config ask_server_choice (const server_choice &)
 If we are in a mp game, ask the server, otherwise generate the answer ourselves. More...
 
static event_listget_undo_commands ()
 
static void add_undo_commands (const config &commands, const game_events::queued_event &ctx)
 
static void reset_undo_commands ()
 

Static Private Attributes

static synced_state state_ = synced_context::UNSYNCED
 Weather we are in a synced move, in a user_choice, or none of them. More...
 
static bool is_simultaneous_ = false
 As soon as get_user_choice is used with side != current_side (for example in generate_random_seed) other sides execute the command simultaneously and is_simultaneously is set to true. More...
 
static int last_unit_id_ = 0
 Used to restore the unit id manager when undoing. More...
 
static event_list undo_commands_ {}
 Actions wml to be executed when the current action is undone. More...
 

Detailed Description

Definition at line 32 of file synced_context.hpp.

Member Typedef Documentation

◆ event_list

Definition at line 190 of file synced_context.hpp.

Member Enumeration Documentation

◆ synced_state

Enumerator
UNSYNCED 
SYNCED 
LOCAL_CHOICE 

Definition at line 35 of file synced_context.hpp.

Member Function Documentation

◆ add_undo_commands()

void synced_context::add_undo_commands ( const config commands,
const game_events::queued_event ctx 
)
static

Definition at line 331 of file synced_context.cpp.

References undo_commands_.

Referenced by get_undo_commands(), and game_events::WML_HANDLER_FUNCTION().

◆ ask_server_choice()

config synced_context::ask_server_choice ( const server_choice sch)
static

◆ can_undo()

bool synced_context::can_undo ( )
static
Returns
Whether there were recently no methods called that prevent undoing.

Definition at line 202 of file synced_context.cpp.

References randomness::generator, randomness::rng::get_random_calls(), is_simultaneous_, and is_synced().

Referenced by actions::recall_unit(), actions::recruit_unit(), reset_is_simultaneous(), run(), and SYNCED_COMMAND_HANDLER_FUNCTION().

◆ default_error_function()

void synced_context::default_error_function ( const std::string &  message)
static

A function to be passed to run_in_synced_context to assert false on error (the default).

Definition at line 148 of file synced_context.cpp.

References ERR_REPLAY.

Referenced by set_synced_state().

◆ generate_random_seed()

std::string synced_context::generate_random_seed ( )
static

Generates a new seed for a synced event, by asking the 'server'.

Definition at line 188 of file synced_context.cpp.

References ask_server_choice(), and config_attribute_value::str().

Referenced by get_rng_for_action(), and set_synced_state().

◆ get_rng_for_action()

std::shared_ptr< randomness::rng > synced_context::get_rng_for_action ( )
static
Returns
A rng_deterministic if in determinsic mode otherwise a rng_synced.

Definition at line 228 of file synced_context.cpp.

References resources::classification, resources::gamedata, generate_random_seed(), game_classification::random_mode, and game_data::rng().

Referenced by set_synced_state().

◆ get_synced_state()

static synced_state synced_context::get_synced_state ( )
inlinestatic

◆ get_undo_commands()

static event_list& synced_context::get_undo_commands ( )
inlinestatic

Definition at line 191 of file synced_context.hpp.

References add_undo_commands(), and undo_commands_.

Referenced by actions::undo_action::undo_action().

◆ get_unit_id_diff()

int synced_context::get_unit_id_diff ( )
static

◆ ignore_error_function()

void synced_context::ignore_error_function ( const std::string &  message)
static

A function to be passed to run_in_synced_context to ignore the error.

Definition at line 159 of file synced_context.cpp.

References DBG_REPLAY, name, and seed_rng::next_seed_str().

Referenced by ai::recall_result::do_execute(), wb::recall::execute(), events::menu_handler::recall(), and set_synced_state().

◆ is_simultaneous()

static bool synced_context::is_simultaneous ( )
inlinestatic
Returns
whether we already sent data about the current action to other clients. which means we cannot undo it.

Definition at line 146 of file synced_context.hpp.

References is_simultaneous_.

Referenced by user_choice_manager::ask_local_choice(), and turn_info::send_data().

◆ is_synced()

static bool synced_context::is_synced ( )
inlinestatic
Returns
Whether we are currently executing a synced action like recruit, start, recall, disband, movement, attack, init_side, end_turn, fire_event, lua_ai, auto_shroud or similar.

Definition at line 101 of file synced_context.hpp.

References get_synced_state(), and SYNCED.

Referenced by actions::undo_list::apply_shroud_changes(), ask_server_choice(), can_undo(), game_display::display_unit_hex(), ai::attack_result::do_execute(), do_replay_handle(), get_unit_id_diff(), mp_sync::get_user_choice(), mp_sync::get_user_choice_multiple_sides(), game_display::highlight_hex(), unit::mark_clone(), side_filter::match_internal(), and unit::set_underlying_id().

◆ is_unsynced()

static bool synced_context::is_unsynced ( )
inlinestatic
Returns
Whether we are not currently executing a synced action like recruit, start, recall, disband, movement, attack, init_side, end_turn, fire_event, lua_ai, auto_shroud or similar. and not doing a local choice.

Definition at line 110 of file synced_context.hpp.

References get_synced_state(), and UNSYNCED.

Referenced by turn_info::send_data().

◆ just_log_error_function()

void synced_context::just_log_error_function ( const std::string &  message)
static

A function to be passed to run_in_synced_context to log the error.

Definition at line 154 of file synced_context.cpp.

References ERR_REPLAY.

Referenced by set_synced_state().

◆ pull_remote_user_input()

void synced_context::pull_remote_user_input ( )
static

called from get_user_choice while waiting for a remove user choice.

Definition at line 217 of file synced_context.cpp.

References syncmp_registry::pull_remote_choice().

Referenced by ask_server_choice(), user_choice_manager::pull(), and set_synced_state().

◆ reset_is_simultaneous()

static void synced_context::reset_is_simultaneous ( )
inlinestatic

Sets is_simultaneous_ = false, called when entering the synced context.

Definition at line 152 of file synced_context.hpp.

References can_undo(), is_simultaneous_, and set_is_simultaneous().

Referenced by set_scontext_synced_base::set_scontext_synced_base().

◆ reset_undo_commands()

static void synced_context::reset_undo_commands ( )
inlinestatic

Definition at line 198 of file synced_context.hpp.

References undo_commands_.

Referenced by set_scontext_synced_base::set_scontext_synced_base().

◆ run()

bool synced_context::run ( const std::string &  commandname,
const config data,
bool  use_undo = true,
bool  show = true,
synced_command::error_handler_function  error_handler = default_error_function 
)
static

Sets the context to 'synced', initialises random context, and calls the given function.

The plan is that in replays and in real game the same function is called. However, if you cannot call this function you can also use set_scontext_synced directly (use it like it's used in this method).

Movement commands are currently treated specially because actions::move_unit returns a value and some function use that value. Maybe I should add a way to return a value here.

AI attacks are also treated special because the ai wants to pass advancement_aspects.

Redoing does normally not take place in a synced context, because we saved the dependent=true replay commands in the replay stack data. There are also no events of similar fired when redoing an action (in most cases).

Parameters
commandnameThe command to run.
dataThe data to use with the command.
use_undoThis parameter is used to ignore undos during an ai move to optimize.
show
error_handlerAn error handler for the case that data contains invalid data.
Returns
True if the action was successful.

Definition at line 49 of file synced_context.cpp.

References can_undo(), play_controller::check_victory(), resources::controller, DBG_REPLAY, set_scontext_synced::do_final_checkup(), synced_command::registry(), and resources::undo_stack.

Referenced by do_replay_handle(), actions::undo_list::redo(), and run_and_store().

◆ run_and_store()

bool synced_context::run_and_store ( const std::string &  commandname,
const config data,
bool  use_undo = true,
bool  show = true,
synced_command::error_handler_function  error_handler = default_error_function 
)
static

◆ run_and_throw()

bool synced_context::run_and_throw ( const std::string &  commandname,
const config data,
bool  use_undo = true,
bool  show = true,
synced_command::error_handler_function  error_handler = default_error_function 
)
static

◆ run_in_synced_context_if_not_already()

bool synced_context::run_in_synced_context_if_not_already ( const std::string &  commandname,
const config data,
bool  use_undo = true,
bool  show = true,
synced_command::error_handler_function  error_handler = default_error_function 
)
static

Checks whether we are currently running in a synced context, and if not we enters it.

This is never called from so_replay_handle.

Definition at line 117 of file synced_context.cpp.

References ERR_REPLAY, get_synced_state(), LOCAL_CHOICE, synced_command::registry(), run_and_throw(), SYNCED, and UNSYNCED.

Referenced by ai::recall_result::do_execute(), ai::recruit_result::do_execute(), game_events::wml_menu_item::fire_event(), and game_events::WML_HANDLER_FUNCTION().

◆ send_user_choice()

void synced_context::send_user_choice ( )
static

called from get_user_choice to send a recently made choice to the other clients.

Does not receive any data from the network any sends data.

Definition at line 222 of file synced_context.cpp.

References is_simultaneous_, and syncmp_registry::send_user_choice().

Referenced by user_choice_manager::ask_local_choice(), and set_synced_state().

◆ set_is_simultaneous()

void synced_context::set_is_simultaneous ( )
static

Sets is_simultaneous_ = true, called using a user choice that is not the currently playing side.

Definition at line 196 of file synced_context.cpp.

References actions::undo_list::clear(), is_simultaneous_, and resources::undo_stack.

Referenced by ask_server_choice(), reset_is_simultaneous(), and user_choice_manager::user_choice_manager().

◆ set_last_unit_id()

static void synced_context::set_last_unit_id ( int  id)
inlinestatic

◆ set_synced_state()

static void synced_context::set_synced_state ( synced_state  newstate)
inlinestatic

Member Data Documentation

◆ is_simultaneous_

bool synced_context::is_simultaneous_ = false
inlinestaticprivate

As soon as get_user_choice is used with side != current_side (for example in generate_random_seed) other sides execute the command simultaneously and is_simultaneously is set to true.

It's impossible to undo data that has been sent over the network.

false = we are on a local turn and haven't sent anything yet.

TODO: it would be better if the following variable were not static.

Definition at line 216 of file synced_context.hpp.

Referenced by can_undo(), is_simultaneous(), reset_is_simultaneous(), send_user_choice(), and set_is_simultaneous().

◆ last_unit_id_

int synced_context::last_unit_id_ = 0
inlinestaticprivate

Used to restore the unit id manager when undoing.

Definition at line 219 of file synced_context.hpp.

Referenced by get_unit_id_diff(), and set_last_unit_id().

◆ state_

synced_state synced_context::state_ = synced_context::UNSYNCED
inlinestaticprivate

Weather we are in a synced move, in a user_choice, or none of them.

Definition at line 205 of file synced_context.hpp.

Referenced by get_synced_state(), and set_synced_state().

◆ undo_commands_

event_list synced_context::undo_commands_ {}
inlinestaticprivate

Actions wml to be executed when the current action is undone.

Definition at line 222 of file synced_context.hpp.

Referenced by add_undo_commands(), get_undo_commands(), and reset_undo_commands().


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