lua_common.hpp File Reference

#include "config.hpp"
#include "variable_info.hpp"
#include "map/location.hpp"
#include <string>
#include <string_view>
#include <vector>

Include dependency graph for lua_common.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	lua_common

Macros
#define	deprecate_attrib(name, prefix, level, version, msg)   deprecated_message(prefix "." name, DEP_LEVEL::level, version, msg)
#define	return_deprecated_attrib(type_macro, name, accessor, prefix, level, version, msg)
#define	return_tstring_attrib(name, accessor)
#define	return_tstring_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_tstring_attrib, name, accessor, prefix, level, version, msg)
#define	return_cstring_attrib(name, accessor)
#define	return_cstring_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_cstring_attrib, name, accessor, prefix, level, version, msg)
#define	return_string_attrib(name, accessor)
#define	return_string_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_string_attrib, name, accessor, prefix, level, version, msg)
#define	return_int_attrib(name, accessor)
#define	return_int_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_int_attrib, name, accessor, prefix, level, version, msg)
#define	return_float_attrib(name, accessor)
#define	return_float_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_float_attrib, name, accessor, prefix, level, version, msg)
#define	return_bool_attrib(name, accessor)
#define	return_bool_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_bool_attrib, name, accessor, prefix, level, version, msg)
#define	return_cfg_attrib(name, accessor)
#define	return_cfg_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_cfg_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	return_cfgref_attrib(name, accessor)
#define	return_cfgref_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_cfgref_attrib, name, accessor, prefix, level, version, msg)
#define	return_vector_string_attrib(name, accessor)
#define	return_vector_string_attrib_deprecated(name, prefix, level, version, msg, accessor)    return_deprecated_attrib(return_vector_string_attrib, name, accessor, prefix, level, version, msg)
#define	modify_tstring_attrib(name, accessor)
#define	modify_tstring_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_tstring_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	modify_string_attrib(name, accessor)
#define	modify_string_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_string_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	modify_int_attrib(name, accessor)
#define	modify_int_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_int_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	modify_int_attrib_check_range(name, accessor, allowed_min, allowed_max)
#define	modify_int_attrib_check_range_deprecated(name, prefix, level, version, msg, accessor, allowed_min, allowed_max)    modify_int_attrib_check_range(name, deprecate_attrib(name, prefix, level, version, msg); accessor, allowed_min, allowed_max)
#define	modify_float_attrib(name, accessor)
#define	modify_float_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_float_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	modify_float_attrib_check_range(name, accessor, allowed_min, allowed_max)
#define	modify_float_attrib_check_range_deprecated(name, prefix, level, version, msg, accessor, allowed_min, allowed_max)    modify_float_attrib_check_range(name, deprecate_attrib(name, prefix, level, version, msg); accessor, allowed_min, allowed_max)
#define	modify_bool_attrib(name, accessor)
#define	modify_bool_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_bool_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	modify_cfg_attrib(name, accessor)
#define	modify_cfg_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_cfg_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)
#define	modify_vector_string_attrib(name, accessor)
#define	modify_vector_string_attrib_deprecated(name, prefix, level, version, msg, accessor)    modify_vector_string_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Functions
int	lua_common::intf_textdomain (lua_State *L)
	Creates an interface for gettext. 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 *	operator new (std::size_t sz, lua_State *L, int nuv=0)
void	operator delete (void *p, lua_State *L, int nuv)
bool	luaW_getmetafield (lua_State *L, int idx, const char *key)
	Like luaL_getmetafield, but returns false if key is an empty string or begins with two underscores. More...
void	luaW_pushvconfig (lua_State *L, const vconfig &cfg)
	Pushes a vconfig on the top of the stack. More...
void	luaW_pushtstring (lua_State *L, const t_string &v)
	Pushes a t_string on the top of the stack. More...
void	luaW_pushscalar (lua_State *L, const config::attribute_value &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_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...
bool	luaW_iststring (lua_State *L, int index)
void	luaW_filltable (lua_State *L, const config &cfg)
	Converts a config object to a Lua table. More...
void	luaW_push_namedtuple (lua_State *L, const std::vector< std::string > &names)
	Push an empty "named tuple" onto the stack. More...
void	luaW_pushlocation (lua_State *L, const map_location &loc)
	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...
int	luaW_push_locationset (lua_State *L, const std::set< map_location > &locs)
	Converts a set of map locations to a Lua table pushed at the top of the stack. More...
std::set< map_location >	luaW_check_locationset (lua_State *L, int idx)
	Converts a table of integer pairs to a set of map location objects. More...
void	luaW_pushconfig (lua_State *L, const config &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=false)
	Gets an optional vconfig from either a table or a userdata. More...
config	luaW_checkconfig (lua_State *L, int index, const vconfig *&vcfg)
	Like the two-argument version, but if it was a vconfig, also returns a pointer to that vconfig. 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...
template<typename... T>
bool	luaW_getglobal (lua_State *L, T... 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)
bool	luaW_tableget (lua_State *L, int index, const char *key)
std::string_view	luaW_tostring (lua_State *L, int index)
std::string_view	luaW_tostring_or_default (lua_State *L, int index, std::string_view def=std::string_view())
void	chat_message (const std::string &caption, const std::string &msg)
	Displays a message in the chat window. More...
bool	luaW_pcall (lua_State *L, int nArgs, int nRets, bool allow_wml_error=false)
	Calls a Lua function stored below its nArgs arguments at the top of the stack. More...
void	push_error_handler (lua_State *L)
int	luaW_pcall_internal (lua_State *L, int nArgs, int nRets)
int	luaW_type_error (lua_State *L, int narg, const char *tname)
int	luaW_type_error (lua_State *L, int narg, const char *kpath, const char *tname)

Macro Definition Documentation

deprecate_attrib

#define deprecate_attrib	(		name,
			prefix,
			level,
			version,
			msg
	)		deprecated_message(prefix "." name, DEP_LEVEL::level, version, msg)

Definition at line 228 of file lua_common.hpp.

modify_bool_attrib

#define modify_bool_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        bool value = luaW_toboolean(L, 3); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 404 of file lua_common.hpp.

modify_bool_attrib_deprecated

#define modify_bool_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_bool_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 412 of file lua_common.hpp.

modify_cfg_attrib

#define modify_cfg_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        const config& cfg = luaW_checkconfig(L, 3); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 415 of file lua_common.hpp.

modify_cfg_attrib_deprecated

#define modify_cfg_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_cfg_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 423 of file lua_common.hpp.

modify_float_attrib

#define modify_float_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        lua_Number value = luaL_checknumber(L, 3); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 381 of file lua_common.hpp.

modify_float_attrib_check_range

#define modify_float_attrib_check_range	(		name,
			accessor,
			allowed_min,
			allowed_max
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        lua_Number value = luaL_checknumber(L, 3); \
        if (value < (allowed_min) || (allowed_max) < value) return luaL_argerror(L, 3, "out of bounds"); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 392 of file lua_common.hpp.

modify_float_attrib_check_range_deprecated

#define modify_float_attrib_check_range_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor,
			allowed_min,
			allowed_max
	)		modify_float_attrib_check_range(name, deprecate_attrib(name, prefix, level, version, msg); accessor, allowed_min, allowed_max)

Definition at line 401 of file lua_common.hpp.

modify_float_attrib_deprecated

#define modify_float_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_float_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 389 of file lua_common.hpp.

modify_int_attrib

#define modify_int_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        int value = static_cast<int>(luaL_checknumber(L, 3)); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 358 of file lua_common.hpp.

modify_int_attrib_check_range

#define modify_int_attrib_check_range	(		name,
			accessor,
			allowed_min,
			allowed_max
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        int value = static_cast<int>(luaL_checknumber(L, 3)); \
        if (value < (allowed_min) || (allowed_max) < value) return luaL_argerror(L, 3, "out of bounds"); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 369 of file lua_common.hpp.

modify_int_attrib_check_range_deprecated

#define modify_int_attrib_check_range_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor,
			allowed_min,
			allowed_max
	)		modify_int_attrib_check_range(name, deprecate_attrib(name, prefix, level, version, msg); accessor, allowed_min, allowed_max)

Definition at line 378 of file lua_common.hpp.

modify_int_attrib_deprecated

#define modify_int_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_int_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 366 of file lua_common.hpp.

modify_string_attrib

#define modify_string_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        const char *value = luaL_checkstring(L, 3); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 347 of file lua_common.hpp.

modify_string_attrib_deprecated

#define modify_string_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_string_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 355 of file lua_common.hpp.

modify_tstring_attrib

#define modify_tstring_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        t_string value = luaW_checktstring(L, 3); \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 336 of file lua_common.hpp.

modify_tstring_attrib_deprecated

#define modify_tstring_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_tstring_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 344 of file lua_common.hpp.

modify_vector_string_attrib

#define modify_vector_string_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        std::vector<std::string> value; \
        char const* message = "table with unnamed indices holding strings expected"; \
        if (!lua_istable(L, 3)) return luaL_argerror(L, 3, message); \
        unsigned length = lua_rawlen(L, 3); \
        for (unsigned i = 1; i <= length; ++i) { \
            lua_rawgeti(L, 3, i); \
            char const* string = lua_tostring(L, 4); \
            if(!string) return luaL_argerror(L, 2 + i, message); \
            value.push_back(string); \
            lua_pop(L, 1); \
        } \
        {accessor;} \
        return 0; \
    } \
} while(false)

Definition at line 426 of file lua_common.hpp.

modify_vector_string_attrib_deprecated

#define modify_vector_string_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		modify_vector_string_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 444 of file lua_common.hpp.

return_bool_attrib

#define return_bool_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        lua_pushboolean(L, (accessor)); \
        return 1; \
    } \
} while(false)

Definition at line 287 of file lua_common.hpp.

return_bool_attrib_deprecated

#define return_bool_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_bool_attrib, name, accessor, prefix, level, version, msg)

Definition at line 294 of file lua_common.hpp.

return_cfg_attrib

#define return_cfg_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        config cfg; \
        {accessor;} \
        luaW_pushconfig(L, cfg); \
        return 1; \
    } \
} while(false)

Definition at line 297 of file lua_common.hpp.

return_cfg_attrib_deprecated

#define return_cfg_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_cfg_attrib(name, deprecate_attrib(name, prefix, level, version, msg); accessor)

Definition at line 306 of file lua_common.hpp.

return_cfgref_attrib

#define return_cfgref_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        luaW_pushconfig(L, (accessor)); \
        return 1; \
    } \
} while(false)

Definition at line 309 of file lua_common.hpp.

return_cfgref_attrib_deprecated

#define return_cfgref_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_cfgref_attrib, name, accessor, prefix, level, version, msg)

Definition at line 316 of file lua_common.hpp.

return_cstring_attrib

#define return_cstring_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        lua_pushstring(L, (accessor)); \
        return 1; \
    } \
} while(false)

Definition at line 246 of file lua_common.hpp.

return_cstring_attrib_deprecated

#define return_cstring_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_cstring_attrib, name, accessor, prefix, level, version, msg)

Definition at line 253 of file lua_common.hpp.

return_deprecated_attrib

#define return_deprecated_attrib	(		type_macro,
			name,
			accessor,
			prefix,
			level,
			version,
			msg
	)

Value:

    type_macro(name, ( \
        deprecate_attrib(name, prefix, level, version, msg), \
        accessor \
    ))

Definition at line 230 of file lua_common.hpp.

return_float_attrib

#define return_float_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        lua_pushnumber(L, (accessor)); \
        return 1; \
    } \
} while(false)

Definition at line 277 of file lua_common.hpp.

return_float_attrib_deprecated

#define return_float_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_float_attrib, name, accessor, prefix, level, version, msg)

Definition at line 284 of file lua_common.hpp.

return_int_attrib

#define return_int_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        lua_pushinteger(L, (accessor)); \
        return 1; \
    } \
} while(false)

Definition at line 267 of file lua_common.hpp.

return_int_attrib_deprecated

#define return_int_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_int_attrib, name, accessor, prefix, level, version, msg)

Definition at line 274 of file lua_common.hpp.

return_string_attrib

#define return_string_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        const std::string& str = (accessor); \
        lua_pushlstring(L, str.c_str(), str.length()); \
        return 1; \
    } \
} while(false)

Definition at line 256 of file lua_common.hpp.

return_string_attrib_deprecated

#define return_string_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_string_attrib, name, accessor, prefix, level, version, msg)

Definition at line 264 of file lua_common.hpp.

return_tstring_attrib

#define return_tstring_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        luaW_pushtstring(L, (accessor)); \
        return 1; \
    } \
} while(false)

Definition at line 236 of file lua_common.hpp.

return_tstring_attrib_deprecated

#define return_tstring_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_tstring_attrib, name, accessor, prefix, level, version, msg)

Definition at line 243 of file lua_common.hpp.

return_vector_string_attrib

#define return_vector_string_attrib	(		name,
			accessor
	)

Value:

do { \
    if (strcmp(m, (name)) == 0) { \
        const std::vector<std::string>& vector = (accessor); \
        lua_createtable(L, vector.size(), 0); \
        int i = 1; \
        for (const std::string& s : vector) { \
            lua_pushlstring(L, s.c_str(), s.length()); \
            lua_rawseti(L, -2, i); \
            ++i; \
        } \
        return 1; \
    } \
} while(false)

Definition at line 319 of file lua_common.hpp.

return_vector_string_attrib_deprecated

#define return_vector_string_attrib_deprecated	(		name,
			prefix,
			level,
			version,
			msg,
			accessor
	)		return_deprecated_attrib(return_vector_string_attrib, name, accessor, prefix, level, version, msg)

Definition at line 333 of file lua_common.hpp.

Function Documentation

chat_message()

void chat_message	(	const std::string &	caption,
		const std::string &	msg
	)

Displays a message in the chat window.

Definition at line 1098 of file lua_common.cpp.

References display_chat_manager::add_chat_message(), game_display::get_chat_manager(), game_display::get_singleton(), events::chat_handler::MESSAGE_PUBLIC, and wfl::msg().

Referenced by luaW_pcall().

luaW_check_locationset()

std::set<map_location> luaW_check_locationset	(	lua_State *	L,
		int	idx
	)

Converts a table of integer pairs to a set of map location objects.

Definition at line 813 of file lua_common.cpp.

References i, luaW_checklocation(), and luaW_type_error().

Referenced by game_lua_kernel::impl_schedule_set(), game_lua_kernel::intf_add_time_area(), intf_make_shroud_bitmap(), game_lua_kernel::intf_override_shroud(), game_lua_kernel::intf_toggle_fog(), and game_lua_kernel::intf_toggle_shroud().

luaW_checkconfig() [1/2]

config luaW_checkconfig	(	lua_State *	L,
		int	index
	)

Converts an optional table or vconfig to a config object.

Definition at line 920 of file lua_common.cpp.

References utf8::index(), luaW_toconfig(), and luaW_type_error().

Referenced by game_lua_kernel::cfun_builtin_effect(), impl_context_backend(), game_lua_kernel::impl_schedule_set(), impl_unit_attack_match(), impl_unit_attack_set(), impl_unit_attacks_set(), intf_add_modification(), game_lua_kernel::intf_add_time_area(), lua_gui2::intf_add_widget_definition(), intf_append_ai(), lua_wml::intf_clone_wml(), intf_create_attack(), game_lua_kernel::intf_create_side(), intf_create_unit(), intf_default_generate(), intf_default_generate_height_map(), game_lua_kernel::intf_find_vacant_tile(), lua_stringx::intf_format(), intf_invoke_synced_command(), intf_modify_ai(), game_lua_kernel::intf_put_recall_unit(), game_lua_kernel::intf_put_unit(), intf_remove_modifications(), intf_set_dialog_canvas(), intf_show_dialog(), intf_switch_ai(), lua_wml::intf_wml_diff(), lua_wml::intf_wml_equal(), lua_wml::intf_wml_interpolate(), lua_wml::intf_wml_matches_filter(), lua_wml::intf_wml_merge(), lua_wml::intf_wml_patch(), lua_wml::intf_wml_tostring(), lua_check_impl::lua_check(), luaW_checkconfig(), lua_gui2::show_message_dialog(), and lua_gui2::show_story().

luaW_checkconfig() [2/2]

config luaW_checkconfig	(	lua_State *	L,
		int	index,
		const vconfig *&	vcfg
	)

Like the two-argument version, but if it was a vconfig, also returns a pointer to that vconfig.

Definition at line 928 of file lua_common.cpp.

References utf8::index(), luaW_checkconfig(), p, and vconfigKey.

luaW_checklocation()

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 793 of file lua_common.cpp.

References utf8::index(), luaW_tolocation(), and luaW_type_error().

Referenced by ai::ai_attack(), ai::ai_move(), ai::ai_stopunit_select(), impl_slocs_set(), impl_source_set(), impl_terrainmap_iter(), game_lua_kernel::intf_add_tile_overlay(), game_lua_kernel::intf_find_cost_map(), game_lua_kernel::intf_find_path(), intf_find_path(), game_lua_kernel::intf_find_reach(), game_lua_kernel::intf_find_vacant_tile(), game_lua_kernel::intf_find_vision_range(), game_lua_kernel::intf_fire_wml_menu_item(), game_lua_kernel::intf_float_label(), game_lua_kernel::intf_get_fog_or_shroud(), game_lua_kernel::intf_get_label(), game_lua_kernel::intf_get_village_owner(), game_lua_kernel::intf_highlight_hex(), game_lua_kernel::intf_match_location(), intf_on_board(), intf_on_border(), game_lua_kernel::intf_remove_label(), game_lua_kernel::intf_remove_tile_overlay(), game_lua_kernel::intf_scroll_to_tile(), game_lua_kernel::intf_select_unit(), game_lua_kernel::intf_set_floating_label(), game_lua_kernel::intf_set_village_owner(), game_lua_kernel::intf_teleport(), intf_terrain_mask(), intf_unit_resistance(), lua_check_impl::lua_check(), luaW_check_locationset(), and luaW_to_locationset().

luaW_checktstring()

t_string luaW_checktstring	(	lua_State *	L,
		int	index
	)

Converts a scalar to a translatable string.

Definition at line 638 of file lua_common.cpp.

References utf8::index(), luaW_totstring(), and luaW_type_error().

Referenced by intf_deprecated_message(), game_lua_kernel::intf_float_label(), lua_stringx::intf_format(), lua_stringx::intf_format_list(), game_lua_kernel::intf_message(), intf_name_generator(), game_lua_kernel::intf_set_floating_label(), lua_check_impl::lua_check(), lua_gui2::show_message_box(), lua_gui2::show_popup_dialog(), and lua_gui2::show_story().

luaW_checkvariable()

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

Definition at line 1024 of file lua_common.cpp.

References variable_info< V >::as_container(), variable_info< V >::as_scalar(), variable_info< V >::get_error_message(), luaW_toboolean(), luaW_toconfig(), luaW_type_error(), n, tstringKey, and WRN_LUA.

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

luaW_checkvconfig()

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

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

Parameters

L	the pointer to the lua interpreter.
index	the location in the current lua execution stack to look at.
allow_missing	true if missing values are allowed; the function then returns an unconstructed vconfig.

Definition at line 964 of file lua_common.cpp.

References utf8::index(), luaW_tovconfig(), luaW_type_error(), vconfig::null(), and vconfig::unconstructed_vconfig().

Referenced by game_lua_kernel::cfun_wml_action(), cfun_wml_condition(), game_lua_kernel::impl_scenario_set(), lua_common::impl_vconfig_ipairs(), lua_common::impl_vconfig_ipairs_iter(), lua_common::impl_vconfig_pairs(), lua_common::impl_vconfig_pairs_iter(), game_lua_kernel::intf_add_event_wml(), game_lua_kernel::intf_add_label(), game_lua_kernel::intf_add_tile_overlay(), game_lua_kernel::intf_add_time_area(), intf_eval_conditional(), game_lua_kernel::intf_gamestate_inspector(), game_lua_kernel::intf_get_locations(), game_lua_kernel::intf_get_recall_units(), game_lua_kernel::intf_get_sides(), game_lua_kernel::intf_get_units(), game_lua_kernel::intf_match_location(), game_lua_kernel::intf_match_side(), game_lua_kernel::intf_match_unit(), game_lua_kernel::intf_redraw(), game_lua_kernel::intf_replace_schedule(), game_lua_kernel::intf_set_menu_item(), and lua_common::intf_tovconfig().

luaW_filltable()

void luaW_filltable	(	lua_State *	L,
		const config &	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 657 of file lua_common.cpp.

References config::all_children_range(), config::attribute_range(), luaW_push_namedtuple(), and luaW_pushscalar().

Referenced by luaW_pushconfig(), and luaW_pushvariable().

luaW_getglobal() [1/2]

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 972 of file lua_common.cpp.

References game_config::path, and s.

Referenced by game_lua_kernel::apply_effect(), ai::lua_ai_context::apply_micro_ai(), game_lua_kernel::custom_command(), game_lua_kernel::game_lua_kernel(), impl_mp_settings_get(), game_lua_kernel::impl_schedule_get(), impl_side_get(), lua_stringx::impl_str_index(), impl_terrainmap_get(), impl_warn(), lua_widget::impl_widget_dir(), lua_widget::impl_widget_get(), lua_kernel_base::interactive_run(), intf_invoke_synced_command(), intf_object_dir(), intf_run_event_wml(), game_lua_kernel::intf_set_achievement(), lua_kernel_base::load_core(), game_lua_kernel::load_game(), lua_kernel_base::lua_kernel_base(), luaW_getglobal(), mapgen_lua_kernel::mapgen_lua_kernel(), game_lua_kernel::mouse_over_hex_callback(), push_error_handler(), lua_audio::register_table(), lua_common::register_tstring_metatable(), 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(), game_lua_kernel::select_hex_callback(), and WIDGET_SETTER().

luaW_getglobal() [2/2]

template<typename... T>

bool luaW_getglobal	(	lua_State *	L,
		T...	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 190 of file lua_common.hpp.

References luaW_getglobal(), and game_config::path.

luaW_getmetafield()

bool luaW_getmetafield	(	lua_State *	L,
		int	idx,
		const char *	key
	)

Like luaL_getmetafield, but returns false if key is an empty string or begins with two underscores.

Definition at line 527 of file lua_common.cpp.

References n.

Referenced by impl_animator_get(), impl_floating_label_getmethod(), impl_music_get(), impl_source_get(), impl_track_get(), and impl_unit_attack_get().

luaW_iststring()

bool luaW_iststring	(	lua_State *	L,
		int	index
	)

Definition at line 646 of file lua_common.cpp.

References utf8::index(), and tstringKey.

Referenced by game_lua_kernel::intf_allow_end_turn(), and lua_stringx::intf_str_format().

luaW_pcall()

bool luaW_pcall	(	lua_State *	L,
		int	nArgs,
		int	nRets,
		bool	allow_wml_error = false
	)

Calls a Lua function stored below its nArgs arguments at the top of the stack.

Parameters

L	the pointer to the lua interpreter.
nArgs
nRets	LUA_MULTRET for unbounded return values.
allow_wml_error	controls where any stack traces are output.

Returns

true if the call was successful and nRets return values are available.

Definition at line 1134 of file lua_common.cpp.

References chat_message(), e, ERR_LUA, ERR_WML, lg::log_to_chat(), and luaW_pcall_internal().

Referenced by game_lua_kernel::apply_effect(), ai::lua_ai_context::apply_micro_ai(), ai::call_lua_filter_fcn(), lua_pathfind_cost_calculator::cost(), game_lua_kernel::custom_command(), lua_kernel_base::get_attribute_names(), ai::lua_ai_action_handler::handle(), intf_do_unsynced(), intf_invoke_synced_command(), game_lua_kernel::intf_set_achievement(), game_lua_kernel::load_game(), 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::run_wml_event(), game_lua_kernel::save_game(), game_lua_kernel::select_hex_callback(), and ai::lua_ai_context::update_state().

luaW_pcall_internal()

int luaW_pcall_internal	(	lua_State *	L,
		int	nArgs,
		int	nRets
	)

Definition at line 1111 of file lua_common.cpp.

References executeKey, and lua_jailbreak_exception::rethrow().

Referenced by luaW_pcall(), and lua_kernel_base::protected_call().

luaW_push_locationset()

int luaW_push_locationset	(	lua_State *	L,
		const std::set< map_location > &	locs
	)

Converts a set of map locations to a Lua table pushed at the top of the stack.

Definition at line 801 of file lua_common.cpp.

References i, and luaW_pushlocation().

Referenced by ai::cfun_ai_get_avoid(), game_lua_kernel::impl_schedule_get(), game_lua_kernel::intf_get_locations(), intf_mg_get_locations_part2(), intf_mg_get_tiles_radius(), and intf_parse_shroud_bitmap().

luaW_push_namedtuple()

void luaW_push_namedtuple	(	lua_State *	L,
		const std::vector< std::string > &	names
	)

Push an empty "named tuple" onto the stack.

A named tuple is an array where each index can also be accessed by name. Once it's pushed, you can set the elements, eg with lua_rawseti.

Definition at line 715 of file lua_common.cpp.

References impl_namedtuple_dir(), impl_namedtuple_get(), impl_namedtuple_tostring(), lua_push(), and names.

Referenced by game_lua_kernel::intf_find_cost_map(), game_lua_kernel::intf_find_reach(), game_lua_kernel::intf_find_vision_range(), intf_named_tuple(), luaW_filltable(), and luaW_pushlocation().

luaW_pushconfig()

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

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

Definition at line 830 of file lua_common.cpp.

References luaW_filltable().

Referenced by game_lua_kernel::apply_effect(), ai::lua_ai_context::apply_micro_ai(), ai::cfun_ai_get_leader_goal(), game_lua_kernel::custom_command(), ai::lua_object< T >::from_type(), ai::lua_ai_action_handler::handle(), impl_context_accessor(), game_lua_kernel::impl_current_get(), game_lua_kernel::impl_game_config_get(), impl_mp_settings_get(), impl_race_get(), game_lua_kernel::impl_theme_item(), impl_unit_type_get(), lua_common::impl_vconfig_get(), lua_wml::intf_clone_wml(), game_lua_kernel::intf_get_achievement(), game_lua_kernel::intf_get_all_vars(), mapgen_lua_kernel::intf_get_all_vars(), intf_get_era(), game_lua_kernel::intf_get_label(), intf_get_resource(), intf_invoke_synced_command(), lua_wml::intf_load_wml(), lua_wml::intf_parse_wml(), intf_synchronize_choice(), lua_wml::intf_wml_diff(), lua_wml::intf_wml_interpolate(), lua_wml::intf_wml_merge(), lua_wml::intf_wml_patch(), 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().

luaW_pushlocation()

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

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

Definition at line 733 of file lua_common.cpp.

References luaW_push_namedtuple(), map_location::wml_x(), and map_location::wml_y().

Referenced by ai::cfun_ai_get_targets(), ai::lua_object< T >::from_type(), impl_side_get(), impl_slocs_get(), impl_slocs_next(), impl_source_get(), impl_terrainmap_iter(), game_lua_kernel::intf_find_path(), lua_map_location::intf_get_adjacent_tiles(), lua_map_location::intf_get_direction(), lua_map_location::intf_rotate_right_around_center(), intf_terrainmap_iter(), lua_map_location::intf_vector_diff(), lua_map_location::intf_vector_negation(), lua_map_location::intf_vector_sum(), lua_check_impl::lua_push(), luaW_push_locationset(), luaW_pushfaivariant(), ai::push_attack_analysis(), ai::push_move_map(), and ai::push_movements().

luaW_pushscalar()

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

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

Definition at line 581 of file lua_common.cpp.

References config_attribute_value::apply_visitor().

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

luaW_pushtstring()

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

Pushes a t_string on the top of the stack.

Definition at line 548 of file lua_common.cpp.

References tstringKey.

Referenced by game_lua_kernel::impl_get_terrain_info(), lua_common::impl_gettext(), game_lua_kernel::intf_set_achievement(), lua_check_impl::lua_push(), and luaW_push_tod().

luaW_pushvariable()

bool luaW_pushvariable	(	lua_State *	L,
		variable_access_const &	v
	)

Definition at line 996 of file lua_common.cpp.

References variable_info< V >::as_container(), variable_info< V >::as_scalar(), variable_info< V >::exists_as_attribute(), variable_info< V >::exists_as_container(), variable_info< V >::get_error_message(), luaW_filltable(), luaW_pushscalar(), and WRN_LUA.

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

luaW_pushvconfig()

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

Pushes a vconfig on the top of the stack.

Definition at line 542 of file lua_common.cpp.

References vconfigKey.

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

luaW_tableget()

bool luaW_tableget	(	lua_State *	L,
		int	index,
		const char *	key
	)

Definition at line 1066 of file lua_common.cpp.

References utf8::index().

Referenced by game_lua_kernel::intf_add_event(), intf_find_path(), game_lua_kernel::intf_set_floating_label(), lua_stringx::intf_str_map_split(), lua_stringx::intf_str_split(), intf_terrain_mask(), and read_rules_vector().

luaW_toboolean()

bool luaW_toboolean	(	lua_State *	L,
		int	n
	)

Definition at line 991 of file lua_common.cpp.

References n.

Referenced by ai::ai_move(), ai::call_lua_filter_fcn(), game_lua_kernel::cfun_builtin_effect(), cfun_exec_candidate_action(), impl_add_animation(), ai::impl_ai_get(), impl_is_deprecated(), impl_unit_status_set(), intf_add_modification(), intf_advance_unit(), game_lua_kernel::intf_allow_end_turn(), game_lua_kernel::intf_allow_undo(), game_lua_kernel::intf_delay(), game_lua_kernel::intf_find_cost_map(), intf_find_path(), lua_fileops::intf_have_file(), lua_wml::intf_load_wml(), game_lua_kernel::intf_lock_view(), game_lua_kernel::intf_log(), intf_music_add(), intf_on_board(), game_lua_kernel::intf_put_unit(), game_lua_kernel::intf_redraw(), game_lua_kernel::intf_scroll_to_tile(), game_lua_kernel::intf_select_unit(), game_lua_kernel::intf_set_village_owner(), game_lua_kernel::intf_skip_messages(), lua_stringx::intf_str_paren_split(), game_lua_kernel::intf_teleport(), intf_terrainmap_iter(), game_lua_kernel::intf_toggle_fog(), intf_unit_resistance(), game_lua_kernel::intf_zoom(), ai::lua_ai_load::lua_ai_load(), lua_check_impl::lua_check(), lua_check_impl::lua_to_or_default(), luaW_checkvariable(), luaW_get_attributes(), luaW_toscalar(), read_rules_vector(), game_lua_kernel::run_filter(), game_lua_kernel::run_wml_conditional(), game_lua_kernel::run_wml_event(), lua_gui2::show_menu(), lua_gui2::show_message_box(), ai::lua_object< T >::to_type(), and WIDGET_SETTER().

luaW_toconfig()

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

Converts an optional table or vconfig to a config object.

Parameters

L	the pointer to the lua interpreter.
index	stack position of the table.
cfg	the config to write the data to.

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 842 of file lua_common.cpp.

References config::add_child(), config::clear(), i, utf8::index(), luaW_toscalar(), return_misformed, config_attribute_value::str(), config::valid_attribute(), config::valid_tag(), 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(), impl_music_set(), impl_sndsrc_set(), game_lua_kernel::intf_add_event(), game_lua_kernel::intf_fire_event(), game_lua_kernel::intf_log_replay(), intf_modify_ai_old(), lua_wml::intf_wml_valid(), lua_check_impl::lua_to_or_default(), luaW_checkconfig(), luaW_checkvariable(), luaW_tovconfig(), game_lua_kernel::save_game(), lua_gui2::show_message_dialog(), and ai::lua_object< T >::to_type().

luaW_tolocation()

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

L	the pointer to the lua interpreter.
index	stack position of the table or first integer.
loc	the location to write to.

Returns

false if a map location couldn't be matched.

Definition at line 744 of file lua_common.cpp.

References utf8::index(), map_location::set_wml_x(), map_location::set_wml_y(), and vconfig::unconstructed_vconfig().

Referenced by ai::ai_recall(), ai::ai_recruit(), impl_add_animation(), impl_source_set(), impl_terrainmap_get(), impl_terrainmap_set(), lua_map_location::intf_distance_between(), game_lua_kernel::intf_erase_unit(), game_lua_kernel::intf_fire_event(), lua_map_location::intf_get_adjacent_tiles(), lua_map_location::intf_get_direction(), lua_map_location::intf_get_in_basis_N_NE(), lua_map_location::intf_get_relative_dir(), lua_map_location::intf_get_tiles_in_radius(), game_lua_kernel::intf_get_time_area(), game_lua_kernel::intf_get_time_of_day(), game_lua_kernel::intf_get_unit(), game_lua_kernel::intf_get_units(), game_lua_kernel::intf_match_unit(), game_lua_kernel::intf_put_unit(), lua_map_location::intf_rotate_right_around_center(), lua_map_location::intf_tiles_adjacent(), intf_unit_defense(), intf_unit_jamming_cost(), intf_unit_movement_cost(), intf_unit_vision_cost(), lua_map_location::intf_vector_diff(), lua_map_location::intf_vector_negation(), lua_map_location::intf_vector_sum(), load_fake_units(), lua_check_impl::lua_to_or_default(), luaW_checklocation(), luaW_to_locationset(), and luaW_tofaivariant().

luaW_toscalar()

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 586 of file lua_common.cpp.

References utf8::index(), luaW_toboolean(), and tstringKey.

Referenced by impl_preferences_set(), and luaW_toconfig().

luaW_tostring()

std::string_view luaW_tostring	(	lua_State *	L,
		int	index
	)

Definition at line 1078 of file lua_common.cpp.

References utf8::index().

Referenced by game_lua_kernel::intf_set_floating_label(), lua_check_impl::lua_check(), and read_rules_vector().

luaW_tostring_or_default()

std::string_view luaW_tostring_or_default	(	lua_State *	L,
		int	index,
		std::string_view	def = std::string_view()
	)

Definition at line 1088 of file lua_common.cpp.

References utf8::index().

Referenced by lua_check_impl::lua_to_or_default().

luaW_totstring()

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

Converts a scalar to a translatable string.

Definition at line 613 of file lua_common.cpp.

References utf8::index(), and tstringKey.

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

luaW_tovconfig()

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 937 of file lua_common.cpp.

References utf8::index(), luaW_toconfig(), and vconfigKey.

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

luaW_type_error() [1/2]

int luaW_type_error	(	lua_State *	L,
		int	narg,
		const char *	kpath,
		const char *	tname
	)

Definition at line 1184 of file lua_common.cpp.

References wfl::msg().

luaW_type_error() [2/2]

int luaW_type_error	(	lua_State *	L,
		int	narg,
		const char *	tname
	)

Definition at line 1176 of file lua_common.cpp.

References wfl::msg().

Referenced by ai::cfun_ai_get_suitable_keep(), impl_add_animation(), impl_unit_attacks_get(), impl_unit_attacks_len(), impl_unit_attacks_set(), impl_unit_status_get(), impl_unit_status_set(), impl_unit_variables_get(), impl_unit_variables_set(), lua_formula_bridge::intf_compile_formula(), intf_mg_get_locations(), intf_named_tuple(), game_lua_kernel::intf_override_shroud(), game_lua_kernel::intf_screen_fade(), intf_unit_defense(), intf_unit_jamming_cost(), intf_unit_movement_cost(), intf_unit_vision_cost(), luaW_check_locationset(), luaW_check_mgfilter(), LuaW_checkcolor(), luaW_checkconfig(), luaW_checklocation(), luaW_checkterrainmap(), luaW_checktstring(), luaW_checkvariable(), luaW_checkvconfig(), lua_common::tstring_concat_aux(), unit_show_error(), and WIDGET_SETTER().

operator delete()

void operator delete	(	void *	p,
		lua_State *	L,
		int	nuv
	)

Definition at line 519 of file lua_common.cpp.

operator new()

void* operator new	(	std::size_t	sz,
		lua_State *	L,
		int	nuv = 0
	)

Definition at line 514 of file lua_common.cpp.

push_error_handler()

void push_error_handler

(

lua_State *

L

)

Definition at line 1105 of file lua_common.cpp.

References executeKey, and luaW_getglobal().

Referenced by lua_kernel_base::lua_kernel_base().