Contains code common to the application and game lua kernels which cannot or should not go into the lua kernel base files. More...

#include "scripting/lua_common.hpp"
#include "global.hpp"
#include "config.hpp"
#include "scripting/lua_api.hpp"
#include "scripting/lua_types.hpp"
#include "tstring.hpp"
#include "variable.hpp"
#include "log.hpp"
#include "gettext.hpp"
#include <cstring>
#include <iterator>
#include <new>
#include <string>
#include "lua/lauxlib.h"
#include "lua/lua.h"

Include dependency graph for lua_common.cpp:

Go to the source code of this file.

Namespaces
	lua_common

Macros
#define	LOG_LUA LOG_STREAM(info, log_scripting_lua)

#define	WRN_LUA LOG_STREAM(warn, log_scripting_lua)

#define	ERR_LUA LOG_STREAM(err, log_scripting_lua)

#define	return_misformed() do { lua_settop(L, initial_top); return false; } while (0)

Typedefs
typedef std::pair < vconfig::all_children_iterator, vconfig::all_children_iterator >	lua_common::vconfig_child_range

Functions
static int	lua_common::impl_gettext (lua_State *L)
	Creates a t_string object (__call metamethod). More...

int	lua_common::intf_textdomain (lua_State *L)
	Creates an interface for gettext. More...

static void	lua_common::tstring_concat_aux (lua_State *L, t_string &dst, int src)
	Converts a Lua value at position src and appends it to dst. More...

static int	lua_common::impl_tstring_concat (lua_State *L)
	Appends a scalar to a t_string object (__concat metamethod). More...

static int	lua_common::impl_tstring_collect (lua_State *L)
	Destroys a t_string object before it is collected (__gc metamethod). More...

static int	lua_common::impl_tstring_lt (lua_State *L)

static int	lua_common::impl_tstring_le (lua_State *L)

static int	lua_common::impl_tstring_eq (lua_State *L)

static int	lua_common::impl_tstring_tostring (lua_State *L)
	Converts a t_string object to a string (__tostring metamethod); that is, performs a translation. More...

static int	lua_common::impl_vconfig_get (lua_State *L)
	Gets the parsed field of a vconfig object (_index metamethod). More...

static int	lua_common::impl_vconfig_size (lua_State *L)
	Returns the number of a child of a vconfig object. More...

static int	lua_common::impl_vconfig_collect (lua_State *L)
	Destroys a vconfig object before it is collected (__gc metamethod). More...

static int	lua_common::impl_vconfig_pairs_iter (lua_State *L)
	Iterate through the attributes of a vconfig. More...

static int	lua_common::impl_vconfig_pairs_collect (lua_State *L)
	Destroy a vconfig pairs iterator. More...

static int	lua_common::impl_vconfig_pairs (lua_State *L)
	Construct an iterator to iterate through the attributes of a vconfig. More...

static int	lua_common::impl_vconfig_ipairs_iter (lua_State *L)
	Iterate through the subtags of a vconfig. More...

static int	lua_common::impl_vconfig_ipairs_collect (lua_State *L)
	Destroy a vconfig ipairs iterator. More...

static int	lua_common::impl_vconfig_ipairs (lua_State *L)
	Construct an iterator to iterate through the subtags of a vconfig. More...

int	lua_common::intf_tovconfig (lua_State *L)
	Creates a vconfig containing the WML table. More...

std::string	lua_common::register_gettext_metatable (lua_State *L)
	Adds the gettext metatable. More...

std::string	lua_common::register_tstring_metatable (lua_State *L)
	Adds the tstring metatable. More...

std::string	lua_common::register_vconfig_metatable (lua_State *L)
	Adds the vconfig metatable. More...

void	luaW_pushvconfig (lua_State *L, vconfig const &cfg)
	Pushes a vconfig on the top of the stack. More...

void	luaW_pushtstring (lua_State *L, t_string const &v)
	Pushes a t_string on the top of the stack. More...

void	luaW_pushscalar (lua_State *L, config::attribute_value const &v)
	Converts an attribute value into a Lua object pushed at the top of the stack. More...

bool	luaW_toscalar (lua_State *L, int index, config::attribute_value &v)
	Converts the value at the top of the stack to an attribute value. More...

bool	luaW_hasmetatable (lua_State *L, int index, luatypekey key)
	Returns true if the metatable of the object is the one found in the registry. More...

bool	luaW_totstring (lua_State *L, int index, t_string &str)
	Converts a scalar to a translatable string. More...

t_string	luaW_checktstring (lua_State *L, int index)
	Converts a scalar to a translatable string. More...

void	luaW_filltable (lua_State *L, config const &cfg)
	Converts a config object to a Lua table. More...

void	luaW_pushlocation (lua_State *L, const map_location &ml)
	Converts a map location object to a Lua table pushed at the top of the stack. More...

bool	luaW_tolocation (lua_State *L, int index, map_location &loc)
	Converts an optional table or pair of integers to a map location object. More...

map_location	luaW_checklocation (lua_State *L, int index)
	Converts an optional table or pair of integers to a map location object. More...

void	luaW_pushconfig (lua_State *L, config const &cfg)
	Converts a config object to a Lua table pushed at the top of the stack. More...

bool	luaW_toconfig (lua_State *L, int index, config &cfg)
	Converts an optional table or vconfig to a config object. More...

config	luaW_checkconfig (lua_State *L, int index)
	Converts an optional table or vconfig to a config object. More...

bool	luaW_tovconfig (lua_State *L, int index, vconfig &vcfg)
	Gets an optional vconfig from either a table or a userdata. More...

vconfig	luaW_checkvconfig (lua_State *L, int index, bool allow_missing)
	Gets an optional vconfig from either a table or a userdata. More...

bool	luaW_getglobal (lua_State *L, const std::vector< std::string > &path)
	Pushes the value found by following the variadic names (char *), if the value is not nil. More...

bool	luaW_toboolean (lua_State *L, int n)

bool	luaW_pushvariable (lua_State *L, variable_access_const &v)

bool	luaW_checkvariable (lua_State *L, variable_access_create &v, int n)

Variables
static const char *	gettextKey = "gettext"

static const char *	vconfigKey = "vconfig"

static const char *	vconfigpairsKey = "vconfig pairs"

static const char *	vconfigipairsKey = "vconfig ipairs"

const char *	tstringKey = "translatable string"

static lg::log_domain	log_scripting_lua ("scripting/lua")

Detailed Description

Contains code common to the application and game lua kernels which cannot or should not go into the lua kernel base files.

Currently contains implementation functions related to vconfig and gettext, also some macros to assist in writing C lua callbacks.

Definition in file lua_common.cpp.

Macro Definition Documentation

#define ERR_LUA LOG_STREAM(err, log_scripting_lua)

Definition at line 53 of file lua_common.cpp.

#define LOG_LUA LOG_STREAM(info, log_scripting_lua)

Definition at line 51 of file lua_common.cpp.

#define return_misformed ( ) do { lua_settop(L, initial_top); return false; } while (0)

Definition at line 672 of file lua_common.cpp.

Referenced by luaW_toconfig().

#define WRN_LUA LOG_STREAM(warn, log_scripting_lua)

Definition at line 52 of file lua_common.cpp.

Referenced by luaW_checkvariable(), and luaW_pushvariable().

Function Documentation

config luaW_checkconfig	(	lua_State *	L,
		int	index
	)

Converts an optional table or vconfig to a config object.

Definition at line 749 of file lua_common.cpp.

References luaL_typerror(), and luaW_toconfig().

Referenced by game_lua_kernel::cfun_builtin_effect(), impl_context_backend(), impl_unit_attack_set(), impl_unit_variables_set(), intf_add_modification(), game_lua_kernel::intf_add_sound_source(), game_lua_kernel::intf_add_tile_overlay(), intf_create_unit(), intf_debug(), game_lua_kernel::intf_erase_unit(), game_lua_kernel::intf_find_vacant_tile(), game_lua_kernel::intf_fire_event(), game_lua_kernel::intf_put_recall_unit(), game_lua_kernel::intf_put_unit(), lua_gui2::intf_set_dialog_canvas(), intf_set_music(), lua_check_impl::lua_check(), lua_gui2::show_dialog(), and lua_gui2::show_message_dialog().

map_location luaW_checklocation	(	lua_State *	L,
		int	index
	)

Converts an optional table or pair of integers to a map location object.

Note: If a pair of integers was found, the first one will be removed from the stack when the function returns.

Definition at line 655 of file lua_common.cpp.

References luaL_typerror(), and luaW_tolocation().

t_string luaW_checktstring	(	lua_State *	L,
		int	index
	)

Converts a scalar to a translatable string.

Definition at line 562 of file lua_common.cpp.

References luaL_typerror(), and luaW_totstring().

Referenced by game_lua_kernel::intf_float_label(), game_lua_kernel::intf_message(), lua_gui2::intf_set_dialog_value(), game_lua_kernel::intf_set_end_campaign_text(), and lua_check_impl::lua_check().

bool luaW_checkvariable	(	lua_State *	L,
		variable_access_create &	v,
		int	n
	)

Definition at line 845 of file lua_common.cpp.

References variable_info< vit >::as_container(), variable_info< vit >::as_scalar(), config::clear(), variable_info< vit >::get_error_message(), LUA_TBOOLEAN, LUA_TNUMBER, lua_tonumber, lua_tostring, LUA_TSTRING, LUA_TTABLE, LUA_TUSERDATA, lua_type(), lua_typename(), luaL_testudata(), luaL_typerror(), luaW_toboolean(), luaW_toconfig(), tstringKey, and WRN_LUA.

Referenced by impl_unit_variables_set(), game_lua_kernel::intf_set_side_variable(), and game_lua_kernel::intf_set_variable().

vconfig luaW_checkvconfig	(	lua_State *	L,
		int	index,
		bool	allow_missing = `false`
	)

Gets an optional vconfig from either a table or a userdata.

Parameters

allow_missing true if missing values are allowed; the function then returns an unconstructed vconfig.

Definition at line 784 of file lua_common.cpp.

References luaL_typerror(), luaW_tovconfig(), vconfig::null(), and vconfig::unconstructed_vconfig().

void luaW_filltable	(	lua_State *	L,
		config const &	cfg
	)

Converts a config object to a Lua table.

The destination table should be at the top of the stack on entry. It is still at the top on exit.

Definition at line 570 of file lua_common.cpp.

References config::all_children_range(), config::attribute_range(), lua_checkstack(), lua_createtable(), LUA_MINSTACK, lua_newtable, lua_pushstring(), lua_rawseti(), lua_setfield(), luaW_filltable(), and luaW_pushscalar().

Referenced by luaW_filltable(), luaW_pushconfig(), and luaW_pushvariable().

bool luaW_getglobal	(	lua_State *	L,
		const std::vector< std::string > &	path
	)

Pushes the value found by following the variadic names (char *), if the value is not nil.

Returns: true if an element was pushed.

Definition at line 792 of file lua_common.cpp.

References lua_isnil, lua_istable, lua_pop, lua_pushglobaltable, lua_pushlstring(), lua_rawget(), and lua_remove().

Referenced by game_lua_kernel::apply_effect(), game_lua_kernel::game_lua_kernel(), ai::impl_ai_aspect_get(), game_lua_kernel::load_game(), luaW_getglobal(), game_lua_kernel::mouse_over_hex_callback(), game_lua_kernel::run_event(), game_lua_kernel::run_filter(), game_lua_kernel::run_wml_action(), game_lua_kernel::run_wml_conditional(), game_lua_kernel::save_game(), and game_lua_kernel::select_hex_callback().

bool luaW_hasmetatable	(	lua_State *	L,
		int	index,
		luatypekey	key
	)

Returns true if the metatable of the object is the one found in the registry.

Definition at line 524 of file lua_common.cpp.

References lua_getmetatable(), lua_pop, lua_pushlightuserdata(), lua_rawequal(), lua_rawget(), and LUA_REGISTRYINDEX.

Referenced by game_lua_kernel::intf_erase_unit(), lua_formula_bridge::intf_eval_formula(), game_lua_kernel::intf_extract_unit(), game_lua_kernel::intf_find_vacant_tile(), game_lua_kernel::intf_match_unit(), game_lua_kernel::intf_put_recall_unit(), game_lua_kernel::intf_put_unit(), luaW_tounit(), and luaW_tounit_ptr().

void luaW_pushconfig	(	lua_State *	L,
		config const &	cfg
	)

Converts a config object to a Lua table pushed at the top of the stack.

Definition at line 663 of file lua_common.cpp.

References lua_newtable, and luaW_filltable().

Referenced by game_lua_kernel::apply_effect(), ai::cfun_ai_get_leader_goal(), ai::lua_ai_action_handler::handle(), ai::impl_ai_aspect_get(), impl_context_accessor(), game_lua_kernel::impl_current_get(), impl_race_get(), game_lua_kernel::impl_theme_item(), impl_unit_type_get(), lua_common::impl_vconfig_get(), game_lua_kernel::intf_get_all_vars(), intf_get_era(), game_lua_kernel::intf_get_sound_source(), intf_get_traits(), intf_synchronize_choice(), game_lua_kernel::load_game(), lua_check_impl::lua_push(), mapgen_lua_kernel::run_generator(), lua_kernel_base::run_lua_tag(), application_lua_kernel::thread::run_script(), ai::lua_ai_context::set_arguments(), and ai::lua_ai_context::set_persistent_data().

void luaW_pushlocation	(	lua_State *	L,
		const map_location &	ml
	)

Converts a map location object to a Lua table pushed at the top of the stack.

Definition at line 593 of file lua_common.cpp.

References lua_createtable(), lua_pushinteger(), lua_rawset(), map_location::x, and map_location::y.

Referenced by ai::cfun_ai_get_targets(), lua_map_location::intf_get_adjacent_tiles(), lua_map_location::intf_get_direction(), lua_map_location::intf_rotate_right_around_center(), game_lua_kernel::intf_select_hex(), lua_map_location::intf_vector_negation(), lua_map_location::intf_vector_sum(), lua_map_location::intf_vector_zero(), lua_check_impl::lua_push(), luaW_pushfaivariant(), ai::push_attack_analysis(), ai::push_move_map(), and ai::push_movements().

void luaW_pushscalar	(	lua_State *	L,
		config::attribute_value const &	v
	)

Converts an attribute value into a Lua object pushed at the top of the stack.

Definition at line 492 of file lua_common.cpp.

References config::attribute_value::apply_visitor().

Referenced by lua_common::impl_vconfig_get(), lua_common::impl_vconfig_pairs_iter(), luaW_filltable(), and luaW_pushvariable().

void luaW_pushtstring	(	lua_State *	L,
		t_string const &	v
	)

Pushes a t_string on the top of the stack.

Definition at line 462 of file lua_common.cpp.

References lua_newuserdata(), luaL_setmetatable(), and tstringKey.

Referenced by lua_common::impl_gettext(), game_lua_kernel::intf_get_terrain_info(), game_lua_kernel::intf_get_time_of_day(), and lua_check_impl::lua_push().

bool luaW_pushvariable	(	lua_State *	L,
		variable_access_const &	v
	)

Definition at line 816 of file lua_common.cpp.

References variable_info< vit >::as_container(), variable_info< vit >::as_scalar(), variable_info< vit >::exists_as_attribute(), variable_info< vit >::exists_as_container(), variable_info< vit >::get_error_message(), lua_newtable, lua_pushnil(), luaW_filltable(), luaW_pushscalar(), luaW_toboolean(), and WRN_LUA.

Referenced by impl_unit_variables_get(), game_lua_kernel::intf_get_side_variable(), and game_lua_kernel::intf_get_variable().

void luaW_pushvconfig	(	lua_State *	L,
		vconfig const &	cfg
	)

Pushes a vconfig on the top of the stack.

Definition at line 456 of file lua_common.cpp.

References lua_newuserdata(), luaL_setmetatable(), and vconfigKey.

Referenced by lua_common::impl_vconfig_get(), lua_common::impl_vconfig_ipairs_iter(), lua_common::intf_tovconfig(), game_lua_kernel::run_wml_action(), and game_lua_kernel::run_wml_conditional().

bool luaW_toboolean	(	lua_State *	L,
		int	n
	)

Definition at line 811 of file lua_common.cpp.

References lua_toboolean().

bool luaW_toconfig	(	lua_State *	L,
		int	index,
		config &	cfg
	)

Converts an optional table or vconfig to a config object.

Parameters

index stack position of the table.

Returns: false if some attributes had not the proper type.

Note: If the table has holes in the integer keys or floating-point keys, some keys will be ignored and the error will go undetected.

Definition at line 675 of file lua_common.cpp.

References config::add_child(), i, lua_absindex(), lua_checkstack(), lua_gettop(), lua_isnumber(), lua_isstring(), lua_istable, LUA_MINSTACK, lua_next(), lua_pop, lua_pushnil(), lua_rawgeti(), lua_rawlen(), lua_settop(), LUA_TNIL, LUA_TNONE, lua_tostring, LUA_TTABLE, LUA_TUSERDATA, lua_type(), luaL_testudata(), luaW_toconfig(), luaW_toscalar(), return_misformed, config::attribute_value::str(), and vconfigKey.

Referenced by mapgen_lua_kernel::create_scenario(), ai::lua_ai_context::get_arguments(), ai::lua_ai_context::get_persistent_data(), impl_context_accessor(), intf_modify_ai(), luaW_checkconfig(), luaW_checkvariable(), luaW_toconfig(), luaW_tovconfig(), game_lua_kernel::save_game(), lua_gui2::show_message_dialog(), and ai::lua_object< T >::to_type().

bool luaW_tolocation	(	lua_State *	L,
		int	index,
		map_location &	loc
	)

Converts an optional table or pair of integers to a map location object.

Parameters

index stack position of the table or first integer.

Returns: false if a map location couldn't be matched.

Definition at line 606 of file lua_common.cpp.

References lua_absindex(), lua_checkstack(), lua_getfield(), lua_isnoneornil, lua_isnumber(), lua_istable, lua_isuserdata(), LUA_MINSTACK, lua_pop, lua_rawgeti(), lua_remove(), lua_tonumber, lua_tonumberx(), luaW_tounit(), luaW_tovconfig(), vconfig::unconstructed_vconfig(), map_location::x, and map_location::y.

bool luaW_toscalar	(	lua_State *	L,
		int	index,
		config::attribute_value &	v
	)

Converts the value at the top of the stack to an attribute value.

Definition at line 497 of file lua_common.cpp.

References LUA_TBOOLEAN, LUA_TNUMBER, lua_tonumber, lua_tostring, LUA_TSTRING, LUA_TUSERDATA, lua_type(), luaL_testudata(), luaW_toboolean(), and tstringKey.

Referenced by luaW_toconfig().

bool luaW_totstring	(	lua_State *	L,
		int	index,
		t_string &	str
	)

Converts a scalar to a translatable string.

Definition at line 537 of file lua_common.cpp.

References LUA_TBOOLEAN, LUA_TNUMBER, lua_toboolean(), lua_tostring, LUA_TSTRING, LUA_TUSERDATA, lua_type(), luaL_testudata(), and tstringKey.

Referenced by intf_synchronize_choice(), intf_synchronize_choices(), luaW_checktstring(), luaW_tofaivariant(), and lua_gui2::show_message_dialog().

bool luaW_tovconfig	(	lua_State *	L,
		int	index,
		vconfig &	vcfg
	)

Gets an optional vconfig from either a table or a userdata.

Returns: false in case of failure.

Definition at line 757 of file lua_common.cpp.

References LUA_TNIL, LUA_TNONE, LUA_TTABLE, LUA_TUSERDATA, lua_type(), luaL_testudata(), luaW_toconfig(), and vconfigKey.

Referenced by game_lua_kernel::intf_find_cost_map(), luaW_checkvconfig(), luaW_tofaivariant(), luaW_tolocation(), and ai::lua_object< T >::to_type().

Variable Documentation

const char* gettextKey = "gettext"

static

Definition at line 44 of file lua_common.cpp.

Referenced by lua_common::intf_textdomain(), and lua_common::register_gettext_metatable().

lg::log_domain log_scripting_lua("scripting/lua")

static

const char* tstringKey = "translatable string"

Definition at line 48 of file lua_common.cpp.

Referenced by lua_common::impl_tstring_concat(), luaW_checkvariable(), luaW_pushtstring(), luaW_toscalar(), luaW_totstring(), lua_common::register_tstring_metatable(), and lua_common::tstring_concat_aux().

const char* vconfigipairsKey = "vconfig ipairs"

static

Definition at line 47 of file lua_common.cpp.

Referenced by lua_common::impl_vconfig_ipairs(), lua_common::impl_vconfig_ipairs_iter(), and lua_common::register_vconfig_metatable().

const char* vconfigKey = "vconfig"

static

Definition at line 45 of file lua_common.cpp.

Referenced by luaW_pushvconfig(), luaW_toconfig(), luaW_tovconfig(), and lua_common::register_vconfig_metatable().

const char* vconfigpairsKey = "vconfig pairs"

static

Definition at line 46 of file lua_common.cpp.

Referenced by lua_common::impl_vconfig_pairs(), lua_common::impl_vconfig_pairs_iter(), and lua_common::register_vconfig_metatable().

Namespaces

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

Function Documentation

Variable Documentation