Namespaces
	actions

	builtins

	gamestate

	tokenizer

Classes
class	action_callable

class	action_function_symbol_table

class	ai_function_symbol_table

class	attack_callable

class	attack_candidate_action

class	attack_map_callable

class	attack_type_callable

class	base_breakpoint

class	base_candidate_action

class	builtin_formula_function

struct	call_stack_manager
	Provides debugging information for error messages. More...

struct	callable_die_subscriber

class	candidate_action_with_filters

class	config_callable

class	debug_info

class	decimal_expression

class	dot_callable

class	dot_expression

class	end_breakpoint

struct	fai_variant_visitor

class	fallback_callable

class	formula

class	formula_callable

class	formula_callable_with_backup

class	formula_debugger

struct	formula_error

class	formula_expression

class	formula_function

class	formula_function_expression

struct	formula_input

class	formula_variant_callable_with_backup

class	function_expression

class	function_list_expression
	Classes that encapsulate and handle the various formula functions. More...

class	function_symbol_table

class	gamemap_callable

class	gamestate_function_symbol_table

class	identifier_expression

class	integer_expression

class	key_value_pair

class	list_callable

class	list_expression

class	location_callable

class	map_callable

class	map_expression

class	map_formula_callable

class	move_callable

class	move_candidate_action

class	move_map_callable

class	move_partial_callable

class	next_breakpoint

class	null_expression

class	operator_expression

class	outcome_callable

class	position_callable

class	recall_callable

class	recruit_callable

class	safe_call_callable

class	safe_call_result

class	set_unit_var_callable

class	set_var_callable

class	square_bracket_expression

class	step_in_breakpoint

class	step_out_breakpoint

class	string_callable

class	string_expression

class	team_callable

class	terrain_callable

struct	type_error

class	unary_operator_expression

class	unit_callable

struct	unit_formula_compare

class	unit_type_callable

class	user_formula_function

class	variant

class	variant_callable

class	variant_container
	Generalized implementation handling container variants. More...

class	variant_decimal

class	variant_int

class	variant_iterator
	Iterator class for the variant. More...

class	variant_list

class	variant_map

class	variant_numeric
	Base class for numeric variant values. More...

class	variant_string

class	variant_value_base
	Base class for all variant types. More...

class	where_expression

class	where_variables

class	wrapper_formula

Typedefs
typedef std::pair< unit_map::unit_iterator, int >	unit_formula_pair

typedef std::multiset< unit_formula_pair, unit_formula_compare >	unit_formula_set

typedef std::map< std::string, const_formula_ptr >	candidate_action_filters

typedef std::shared_ptr< base_candidate_action >	candidate_action_ptr

using	map_formula_callable_ptr = std::shared_ptr< map_formula_callable >

using	const_map_formula_callable_ptr = std::shared_ptr< const map_formula_callable >

using	formula_input_vector = std::vector< formula_input >

using	formula_callable_ptr = std::shared_ptr< formula_callable >

using	const_formula_callable_ptr = std::shared_ptr< const formula_callable >

using	formula_seen_stack = std::vector< const_formula_callable_ptr >

typedef std::shared_ptr< base_breakpoint >	breakpoint_ptr

using	expr_table = std::map< std::string, expression_ptr >

using	expr_table_evaluated = std::map< std::string, variant >

using	expr_table_ptr = std::shared_ptr< expr_table >

using	expression_ptr = std::shared_ptr< formula_expression >

typedef std::shared_ptr< formula >	formula_ptr

typedef std::shared_ptr< const formula >	const_formula_ptr

typedef std::shared_ptr< function_expression >	function_expression_ptr

typedef std::shared_ptr< formula_function >	formula_function_ptr

typedef std::map< std::string, formula_function_ptr >	functions_map

using	variant_vector = std::vector< variant >

using	variant_map_raw = std::map< variant, variant >

using	value_base_ptr = std::shared_ptr< variant_value_base >

Enumerations
enum	FORMULA_ACCESS_TYPE { FORMULA_READ_ONLY, FORMULA_WRITE_ONLY, FORMULA_READ_WRITE }

Functions
static void	msg (const char act, debug_info &i, const char to="", const char *result="")

formula_debugger *	add_debug_info (formula_debugger *fdb, int arg_number, const std::string &f_name)

variant	evaluate_arg_callback (formula_debugger &fdb, const formula_expression &expression, const formula_callable &variables)

variant	evaluate_formula_callback (formula_debugger &fdb, const formula &f, const formula_callable &variables)

variant	evaluate_formula_callback (formula_debugger &fdb, const formula &f)

static std::string	tokens_to_string (const tk::token i1, const tk::token i2)

expression_ptr	parse_expression (const tk::token i1, const tk::token i2, function_symbol_table *symbols)

static int	operator_precedence (const tk::token &t)
	Functions to handle the actual parsing of WFL. More...

static void	parse_function_args (const tk::token &i1, const tk::token i2, std::vector< std::string > *res)

static void	parse_args (const tk::token i1, const tk::token i2, std::vector< expression_ptr > res, function_symbol_table symbols)

static void	parse_set_args (const tk::token i1, const tk::token i2, std::vector< expression_ptr > res, function_symbol_table symbols)

static void	parse_where_clauses (const tk::token i1, const tk::token i2, expr_table_ptr res, function_symbol_table *symbols)

static value_base_ptr	null_value (new variant_value_base)

static std::string	variant_type_to_string (VARIANT_TYPE type)

static std::string	was_expecting (const std::string &message, const variant &v)

	MAKE_ENUM (VARIANT_TYPE,(TYPE_NULL, "null")(TYPE_INT, "int")(TYPE_DECIMAL, "decimal")(TYPE_CALLABLE, "object")(TYPE_LIST, "list")(TYPE_STRING, "string")(TYPE_MAP, "map"))
	The various types the variant class is designed to handle. More...

template<typename T >
static std::shared_ptr< T >	value_cast (value_base_ptr ptr)
	Casts a variant_value_base shared pointer to a new derived type. More...

template<typename T >
static T &	value_ref_cast (variant_value_base &ptr)
	Casts a variant_value_base reference to a new derived type. More...

Variables
static thread_local std::deque< std::string >	call_stack
	For printing error messages when WFL parsing or evaluation fails, this contains the names of the WFL functions being evaluated. More...

Typedef Documentation

◆ breakpoint_ptr

typedef std::shared_ptr<base_breakpoint> wfl::breakpoint_ptr

Definition at line 36 of file debugger_fwd.hpp.

◆ candidate_action_filters

typedef std::map< std::string, const_formula_ptr > wfl::candidate_action_filters

Definition at line 33 of file candidates.hpp.

◆ candidate_action_ptr

typedef std::shared_ptr<base_candidate_action> wfl::candidate_action_ptr

Definition at line 36 of file candidates.hpp.

◆ const_formula_callable_ptr

using wfl::const_formula_callable_ptr = typedef std::shared_ptr<const formula_callable>

Definition at line 43 of file callable_fwd.hpp.

◆ const_formula_ptr

typedef std::shared_ptr<const formula> wfl::const_formula_ptr

Definition at line 23 of file formula_fwd.hpp.

◆ const_map_formula_callable_ptr

using wfl::const_map_formula_callable_ptr = typedef std::shared_ptr<const map_formula_callable>

Definition at line 306 of file callable.hpp.

◆ expr_table

using wfl::expr_table = typedef std::map<std::string, expression_ptr>

Definition at line 59 of file formula.cpp.

◆ expr_table_evaluated

using wfl::expr_table_evaluated = typedef std::map<std::string, variant>

Definition at line 60 of file formula.cpp.

◆ expr_table_ptr

using wfl::expr_table_ptr = typedef std::shared_ptr<expr_table>

Definition at line 61 of file formula.cpp.

◆ expression_ptr

typedef std::shared_ptr< formula_expression > wfl::expression_ptr

Definition at line 28 of file formula.hpp.

◆ formula_callable_ptr

using wfl::formula_callable_ptr = typedef std::shared_ptr<formula_callable>

Definition at line 42 of file callable_fwd.hpp.

◆ formula_function_ptr

typedef std::shared_ptr<formula_function> wfl::formula_function_ptr

Definition at line 229 of file function.hpp.

◆ formula_input_vector

using wfl::formula_input_vector = typedef std::vector<formula_input>

Definition at line 41 of file callable_fwd.hpp.

◆ formula_ptr

typedef std::shared_ptr<formula> wfl::formula_ptr

Definition at line 21 of file formula_fwd.hpp.

◆ formula_seen_stack

using wfl::formula_seen_stack = typedef std::vector<const_formula_callable_ptr>

Definition at line 44 of file callable_fwd.hpp.

◆ function_expression_ptr

typedef std::shared_ptr<function_expression> wfl::function_expression_ptr

Definition at line 172 of file function.hpp.

◆ functions_map

typedef std::map<std::string, formula_function_ptr> wfl::functions_map

Definition at line 230 of file function.hpp.

◆ map_formula_callable_ptr

using wfl::map_formula_callable_ptr = typedef std::shared_ptr<map_formula_callable>

Definition at line 305 of file callable.hpp.

◆ unit_formula_pair

typedef std::pair< unit_map::unit_iterator, int> wfl::unit_formula_pair

Definition at line 48 of file ai.hpp.

◆ unit_formula_set

typedef std::multiset< unit_formula_pair, unit_formula_compare > wfl::unit_formula_set

Definition at line 58 of file ai.hpp.

◆ value_base_ptr

using wfl::value_base_ptr = typedef std::shared_ptr<variant_value_base>

Definition at line 50 of file variant_value.hpp.

◆ variant_map_raw

using wfl::variant_map_raw = typedef std::map<variant, variant>

Definition at line 49 of file variant_value.hpp.

◆ variant_vector

using wfl::variant_vector = typedef std::vector<variant>

Definition at line 48 of file variant_value.hpp.

Enumeration Type Documentation

◆ FORMULA_ACCESS_TYPE

enum wfl::FORMULA_ACCESS_TYPE

Enumerator
FORMULA_READ_ONLY
FORMULA_WRITE_ONLY
FORMULA_READ_WRITE

Definition at line 31 of file callable_fwd.hpp.

Function Documentation

◆ add_debug_info()

formula_debugger * wfl::add_debug_info	(	formula_debugger *	fdb,
		int	arg_number,
		const std::string &	f_name
	)

Definition at line 26 of file debugger_fwd.cpp.

References wfl::formula_debugger::add_debug_info().

Referenced by wfl::gamestate::DEFINE_WFL_FUNCTION(), wfl::builtins::DEFINE_WFL_FUNCTION(), wfl::actions::DEFINE_WFL_FUNCTION(), wfl::list_expression::execute(), wfl::map_expression::execute(), wfl::unary_operator_expression::execute(), wfl::dot_expression::execute(), wfl::square_bracket_expression::execute(), wfl::operator_expression::execute(), wfl::where_expression::execute(), wfl::string_expression::execute(), and wfl::where_variables::get_value().

◆ evaluate_arg_callback()

variant wfl::evaluate_arg_callback	(	formula_debugger &	fdb,
		const formula_expression &	expression,
		const formula_callable &	variables
	)

Definition at line 36 of file debugger_fwd.cpp.

References wfl::formula_debugger::evaluate_arg_callback().

Referenced by wfl::formula_expression::evaluate().

◆ evaluate_formula_callback() [1/2]

variant wfl::evaluate_formula_callback	(	formula_debugger &	fdb,
		const formula &	f,
		const formula_callable &	variables
	)

Definition at line 42 of file debugger_fwd.cpp.

References wfl::formula_debugger::evaluate_formula_callback().

Referenced by wfl::formula::evaluate().

◆ evaluate_formula_callback() [2/2]

variant wfl::evaluate_formula_callback	(	formula_debugger &	fdb,
		const formula &	f
	)

Definition at line 48 of file debugger_fwd.cpp.

References wfl::formula_debugger::evaluate_formula_callback().

◆ MAKE_ENUM()

wfl::MAKE_ENUM	(	VARIANT_TYPE	,
		(TYPE_NULL, "null")(TYPE_INT, "int")(TYPE_DECIMAL, "decimal")(TYPE_CALLABLE, "object")(TYPE_LIST, "list")(TYPE_STRING, "string")(TYPE_MAP, "map")
	)

The various types the variant class is designed to handle.

◆ msg()

static void wfl::msg	(	const char *	act,
		debug_info &	i,
		const char *	to = `""`,
		const char *	result = `""`
	)

static

Definition at line 109 of file debugger.cpp.

References wfl::debug_info::counter(), DBG_FDB, wfl::debug_info::name(), and wfl::debug_info::str().

Referenced by display_chat_manager::add_chat_message(), wesnothd::server::adminmsg_handler(), gui2::build(), gui2::builder_grid::builder_grid(), events::menu_handler::can_recruit(), spirit_po::catalog< hashmap_type, pf_compiler >::catalog(), ng::depcheck::manager::change_era(), events::chat_handler::change_logging(), ng::depcheck::manager::change_scenario(), check_readonly(), checkrepeated(), gui2::chatbox::close_window(), addons_client::connect(), help::convert_to_wml(), mapgen_lua_kernel::create_map(), lua_map_generator::create_map(), mapgen_lua_kernel::create_scenario(), lua_map_generator::create_scenario(), db_traceback(), deprecated_message(), gui2::dialogs::mp_create_game::dialog_exit_hook(), set_scontext_synced::do_final_checkup(), events::menu_handler::do_search(), errorlimit(), wfl::formula_debugger::evaluate_arg_callback(), wfl::formula_debugger::evaluate_formula_callback(), game_events::wml_event_pump::fill_wml_messages_map(), findloader(), gui2::event::dispatcher::fire(), help::generate_contents(), spirit_po::catalog< hashmap_type, pf_compiler >::get(), display::get_builder(), editor::terrain_palette::get_help_string(), filesystem::get_logs_dir(), config::get_old_attribute(), ai::readonly_context_impl::get_readonly_context(), gui2::dialogs::get_title_suffix(), help::help_browser::handle_event(), play_controller::handle_generic_event(), wesnothd::server::handle_message(), help::help_text_area::handle_ref_cfg(), campaignd::server::handle_upload(), wesnothd::server::handle_whisper(), config::has_old_attribute(), config::insert(), intf_deprecated_message(), intf_find_path(), lua_map_location::intf_get_direction(), game_lua_kernel::intf_log(), intf_log(), spirit_po::po_message::is_plural(), jumpscopeerror(), editor::context_manager::load_map(), application_lua_kernel::load_script_from_string(), lua_kernel_base::load_string(), ai_testing::log_turn(), lua_map_generator::lua_map_generator(), luaE_warnerror(), luaG_runerror(), luaL_typeerror(), luaO_pushfstring(), luaW_getglobal(), luaW_type_error(), game_lua_kernel::my_name(), panic(), gui2::parse_linked_group_definitions(), help::parse_text(), wesnothd::game::perform_controller_tweaks(), wesnothd::server::pm_handler(), wesnothd::server::process_command(), wesnothd::game::process_message(), play_controller::process_oos(), wesnothd::game::process_turn(), wesnothd::game::process_whiteboard(), lua_kernel_base::protected_call(), gui2::dialogs::addon_manager::publish_addon(), read_long_string(), events::menu_handler::recall(), events::menu_handler::save_map(), editor::map_context::save_map(), editor::map_context::save_scenario(), events::menu_handler::search(), wesnothd::server::send_server_message(), wesnothd::game::send_server_message(), campaignd::server::server_info(), lua_kernel_base::set_external_log(), help::help_text_area::set_items(), gui2::show_error_message(), help::show_help(), lua_gui2::show_popup_dialog(), preferences::show_wesnothd_server_search(), game_events::wml_event_pump::show_wml_messages(), wesnothd::game::start_game(), help::help_text_area::str_to_align(), wesnothd::game::transfer_side_control(), undefgoto(), lua_map_generator::user_config(), vgettext_impl(), vngettext_impl(), display_chat_manager::whisperers(), editor::wrap_exc(), gui2::dialogs::lua_interpreter::lua_model::~lua_model(), and ai::readonly_context::~readonly_context().

◆ null_value()

static value_base_ptr wfl::null_value ( new variant_value_base )

static

◆ operator_precedence()

static int wfl::operator_precedence ( const tk::token & t )

static

Functions to handle the actual parsing of WFL.

Definition at line 1073 of file formula.cpp.

References wfl::tokenizer::token::begin, wfl::tokenizer::token::end, and n.

Referenced by parse_expression().

◆ parse_args()

static void wfl::parse_args	(	const tk::token *	i1,
		const tk::token *	i2,
		std::vector< expression_ptr > *	res,
		function_symbol_table *	symbols
	)

static

Definition at line 1139 of file formula.cpp.

References parse_expression(), wfl::tokenizer::TOKEN_COMMA, wfl::tokenizer::TOKEN_LPARENS, wfl::tokenizer::TOKEN_LSQUARE, wfl::tokenizer::TOKEN_RPARENS, wfl::tokenizer::TOKEN_RSQUARE, and wfl::tokenizer::token::type.

Referenced by parse_expression().

◆ parse_expression()

expression_ptr wfl::parse_expression	(	const tk::token *	i1,
		const tk::token *	i2,
		function_symbol_table *	symbols
	)

Definition at line 1263 of file formula.cpp.

Referenced by wfl::null_expression::execute(), wfl::formula::formula(), parse_args(), parse_set_args(), and parse_where_clauses().

◆ parse_function_args()

static void wfl::parse_function_args	(	const tk::token *&	i1,
		const tk::token *	i2,
		std::vector< std::string > *	res
	)

static

Definition at line 1105 of file formula.cpp.

References wfl::tokenizer::token::begin, wfl::tokenizer::token::end, wfl::tokenizer::token::filename, wfl::formula_error::formula_error(), wfl::tokenizer::token::line_number, wfl::tokenizer::TOKEN_COMMA, wfl::tokenizer::TOKEN_IDENTIFIER, wfl::tokenizer::TOKEN_LPARENS, wfl::tokenizer::TOKEN_RPARENS, tokens_to_string(), wfl::tokenizer::token::type, and wfl::formula_error::type.

Referenced by parse_expression().

◆ parse_set_args()

static void wfl::parse_set_args	(	const tk::token *	i1,
		const tk::token *	i2,
		std::vector< expression_ptr > *	res,
		function_symbol_table *	symbols
	)

static

Definition at line 1163 of file formula.cpp.

References wfl::tokenizer::token::filename, wfl::formula_error::formula_error(), wfl::tokenizer::token::line_number, parse_expression(), wfl::tokenizer::TOKEN_COMMA, wfl::tokenizer::TOKEN_LPARENS, wfl::tokenizer::TOKEN_LSQUARE, wfl::tokenizer::TOKEN_POINTER, wfl::tokenizer::TOKEN_RPARENS, wfl::tokenizer::TOKEN_RSQUARE, tokens_to_string(), and wfl::tokenizer::token::type.

Referenced by parse_expression().

◆ parse_where_clauses()

static void wfl::parse_where_clauses	(	const tk::token *	i1,
		const tk::token *	i2,
		expr_table_ptr	res,
		function_symbol_table *	symbols
	)

static

Definition at line 1202 of file formula.cpp.

References wfl::tokenizer::token::begin, wfl::tokenizer::token::end, wfl::tokenizer::token::filename, wfl::formula_error::formula_error(), wfl::tokenizer::token::line_number, parse_expression(), wfl::tokenizer::TOKEN_COMMA, wfl::tokenizer::TOKEN_IDENTIFIER, wfl::tokenizer::TOKEN_LPARENS, wfl::tokenizer::TOKEN_LSQUARE, wfl::tokenizer::TOKEN_OPERATOR, wfl::tokenizer::TOKEN_RPARENS, wfl::tokenizer::TOKEN_RSQUARE, tokens_to_string(), and wfl::tokenizer::token::type.

Referenced by parse_expression().

◆ tokens_to_string()

static std::string wfl::tokens_to_string	(	const tk::token *	i1,
		const tk::token *	i2
	)

static

Definition at line 65 of file formula.cpp.

References wfl::tokenizer::token::begin, wfl::tokenizer::token::end, and expr().

Referenced by wfl::formula::formula(), parse_expression(), parse_function_args(), parse_set_args(), and parse_where_clauses().

◆ value_cast()

template<typename T >

static std::shared_ptr<T> wfl::value_cast ( value_base_ptr ptr )

static

Casts a variant_value_base shared pointer to a new derived type.

Definition at line 59 of file variant_value.hpp.

References wfl::type_error::type_error().

Referenced by wfl::variant_list::list_op(), and wfl::variant::value_cast().

◆ value_ref_cast()

template<typename T >

static T& wfl::value_ref_cast ( variant_value_base & ptr )

static

Casts a variant_value_base reference to a new derived type.

Definition at line 71 of file variant_value.hpp.

References wfl::type_error::type_error().

Referenced by wfl::variant_numeric::equals(), wfl::variant_callable::equals(), wfl::variant_string::equals(), wfl::variant_list::equals(), wfl::variant_map::equals(), wfl::variant_callable::less_than(), wfl::variant_list::less_than(), and wfl::variant_map::less_than().

◆ variant_type_to_string()

static std::string wfl::variant_type_to_string ( VARIANT_TYPE type )

static

Definition at line 42 of file variant.cpp.

Referenced by wfl::variant::must_be(), and wfl::variant::must_both_be().

◆ was_expecting()

static std::string wfl::was_expecting	(	const std::string &	message,
		const variant &	v
	)

static

Definition at line 48 of file variant.cpp.

References wfl::variant::to_debug_string(), and wfl::variant::type_string().

Referenced by wfl::variant::as_decimal(), wfl::variant::concatenate(), wfl::variant::contains(), wfl::variant::must_be(), wfl::variant::num_elements(), and wfl::variant::operator[]().

Variable Documentation

◆ call_stack

thread_local std::deque<std::string> wfl::call_stack

static

For printing error messages when WFL parsing or evaluation fails, this contains the names of the WFL functions being evaluated.

Two C++ threads might be evaluating WFL at the same; declaring this thread_local is a quick bugfix which should probably be replaced by having a context-object for each WFL evaluation.

Definition at line 46 of file function.cpp.

Referenced by gui2::grid::can_mouse_focus(), gui2::viewport::child_populate_dirty_list(), gui2::pane::child_populate_dirty_list(), gui2::container_base::child_populate_dirty_list(), gui2::matrix::child_populate_dirty_list(), gui2::listbox::child_populate_dirty_list(), gui2::grid::child_populate_dirty_list(), gui2::generator< minimum_selection, maximum_selection, my_placement, select_action >::child_populate_dirty_list(), gui2::window::draw(), gui2::scrollbar_container::finalize_subclass(), gui2::tree_view::get_root_node(), gui2::widget::impl_draw_foreground(), gui2::tree_view_node::impl_populate_dirty_list(), wfl::end_breakpoint::is_break_now(), wfl::step_in_breakpoint::is_break_now(), wfl::step_out_breakpoint::is_break_now(), wfl::next_breakpoint::is_break_now(), and gui2::listbox::select_last_row().

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ breakpoint_ptr

◆ candidate_action_filters

◆ candidate_action_ptr

◆ const_formula_callable_ptr

◆ const_formula_ptr

◆ const_map_formula_callable_ptr

◆ expr_table

◆ expr_table_evaluated

◆ expr_table_ptr

◆ expression_ptr

◆ formula_callable_ptr

◆ formula_function_ptr

◆ formula_input_vector

◆ formula_ptr

◆ formula_seen_stack

◆ function_expression_ptr

◆ functions_map

◆ map_formula_callable_ptr

◆ unit_formula_pair

◆ unit_formula_set

◆ value_base_ptr

◆ variant_map_raw

◆ variant_vector

Enumeration Type Documentation

◆ FORMULA_ACCESS_TYPE

Function Documentation

◆ add_debug_info()

◆ evaluate_arg_callback()

◆ evaluate_formula_callback() [1/2]

◆ evaluate_formula_callback() [2/2]

◆ MAKE_ENUM()

◆ msg()

◆ null_value()

◆ operator_precedence()

◆ parse_args()

◆ parse_expression()

◆ parse_function_args()

◆ parse_set_args()

◆ parse_where_clauses()

◆ tokens_to_string()

◆ value_cast()

◆ value_ref_cast()

◆ variant_type_to_string()

◆ was_expecting()

Variable Documentation

◆ call_stack