#include <QHash>
#include <QVector>
#include "tolua.h"
#include "log.h"
#include "support.h"
#include "luascript_func.h"
#include "luascript_signal.h"
#include "luascript_types.h"

Include dependency graph for luascript.h:

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

Go to the source code of this file.

Classes
struct	fc_lua

Macros
#define	LUASCRIPT_ASSERT(check, ...)

#define	LUASCRIPT_CHECK_STATE(L, ...)

#define	LUASCRIPT_CHECK(L, check, msg, ...)

#define	LUASCRIPT_CHECK_ARG(L, check, narg, msg, ...)

#define	LUASCRIPT_CHECK_ARG_NIL(L, value, narg, type, ...)

#define	LUASCRIPT_CHECK_SELF(L, value, ...)

Typedefs
typedef void(*	luascript_log_func_t) (struct fc_lua fcl, QtMsgType level, const char format,...) fc__attribute((__format__(__printf__

Functions
int	luascript_error (lua_State L, const char format,...) fc__attribute((__format__(__printf__

int int	luascript_error_vargs (lua_State L, const char format, va_list vargs)
	Internal api error function. More...

int	luascript_arg_error (lua_State L, int narg, const char msg)
	Like script_error, but using a prefix identifying the called lua function: More...

struct fc_lua *	luascript_new (luascript_log_func_t outputfct, bool secured_environment)
	Initialize the scripting state. More...

void	luascript_init (fc_lua *fcl)
	Sets the freeciv lua struct for a lua state. More...

struct fc_lua *	luascript_get_fcl (lua_State *L)
	Get the freeciv lua struct from a lua state. More...

void	luascript_destroy (struct fc_lua *fcl)
	Free the scripting data. More...

void	luascript_common_a (lua_State *L)
	Runs tolua_common_a.lua. More...

void	luascript_common_z (lua_State *L)
	Runs tolua_common_z.lua. More...

void	luascript_log (struct fc_lua fcl, QtMsgType level, const char format,...) fc__attribute((__format__(__printf__

void void	luascript_log_vargs (struct fc_lua fcl, QtMsgType level, const char format, va_list args)
	Print a message to the selected output handle. More...

void	luascript_push_args (struct fc_lua fcl, int nargs, enum api_types parg_types, va_list args)
	Push arguments into the Lua stack. More...

void	luascript_pop_returns (struct fc_lua fcl, const char func_name, int nreturns, enum api_types *preturn_types, va_list args)
	Pop return values from the Lua stack. More...

bool	luascript_check_function (struct fc_lua fcl, const char funcname)
	Return if the function 'funcname' is define in the lua state 'fcl->state'. More...

int	luascript_call (struct fc_lua fcl, int narg, int nret, const char code)
	Evaluate a Lua function call or loaded script on the stack. More...

int	luascript_do_string (struct fc_lua fcl, const char str, const char *name)
	lua_dostring replacement with error message showing on errors. More...

int	luascript_do_file (struct fc_lua fcl, const char filename)
	Parse and execute the script at filename. More...

bool	luascript_callback_invoke (struct fc_lua fcl, const char callback_name, int nargs, enum api_types *parg_types, va_list args)
	Invoke the 'callback_name' Lua function. More...

void	luascript_remove_exported_object (struct fc_lua fcl, void object)
	Mark any, if exported, full userdata representing 'object' in the current script state as 'Nonexistent'. More...

void	luascript_vars_save (struct fc_lua fcl, struct section_file file, const char *section)
	Save lua variables to file. More...

void	luascript_vars_load (struct fc_lua fcl, struct section_file file, const char *section)
	Load lua variables from file. More...

const Direction *	luascript_dir (enum direction8)
	Returns a pointer to a given value of enum direction8 (always the same address for the same value), or nullptr if the direction is invalid on the current map. More...

Macro Definition Documentation

◆ LUASCRIPT_ASSERT

#define LUASCRIPT_ASSERT	(	check,
		...
	)

Definition at line 107 of file luascript.h.

◆ LUASCRIPT_CHECK

#define LUASCRIPT_CHECK	(	L,
		check,
		msg,
		...
	)

Value:

  if (!(check)) {                                                           \
    luascript_error(L, msg);                                                \
    return __VA_ARGS__;                                                     \
  }

Definition at line 117 of file luascript.h.

◆ LUASCRIPT_CHECK_ARG

#define LUASCRIPT_CHECK_ARG	(	L,
		check,
		narg,
		msg,
		...
	)

Value:

  if (!(check)) {                                                           \
    luascript_arg_error(L, narg, msg);                                      \
    return __VA_ARGS__;                                                     \
  }

Definition at line 124 of file luascript.h.

◆ LUASCRIPT_CHECK_ARG_NIL

#define LUASCRIPT_CHECK_ARG_NIL	(	L,
		value,
		narg,
		type,
		...
	)

Value:

  if ((value) == nullptr) {                                                 \
    luascript_arg_error(L, narg, "got 'nil', '" #type "' expected");        \
    return __VA_ARGS__;                                                     \
  }

Definition at line 131 of file luascript.h.

◆ LUASCRIPT_CHECK_SELF

#define LUASCRIPT_CHECK_SELF	(	L,
		value,
		...
	)

Value:

  if ((value) == nullptr) {                                                 \
    luascript_arg_error(L, 2, "got 'nil' for self");                        \
    return __VA_ARGS__;                                                     \
  }

Definition at line 139 of file luascript.h.

◆ LUASCRIPT_CHECK_STATE

#define LUASCRIPT_CHECK_STATE	(	L,
		...
	)

Value:

  if (!L) {                                                                 \
    qCritical("No lua state available");                                    \
    return __VA_ARGS__;                                                     \
  }

Definition at line 110 of file luascript.h.

Typedef Documentation

◆ luascript_log_func_t

typedef void(* luascript_log_func_t) (struct fc_lua *fcl, QtMsgType level, const char *format,...) fc__attribute((__format__(__printf__

Definition at line 33 of file luascript.h.

Function Documentation

◆ luascript_arg_error()

int luascript_arg_error	(	lua_State *	L,
		int	narg,
		const char *	msg
	)

Like script_error, but using a prefix identifying the called lua function:

bad argument #narg to 'func': msg

Definition at line 264 of file luascript.cpp.

◆ luascript_call()

int luascript_call	(	struct fc_lua *	fcl,
		int	narg,
		int	nret,
		const char *	code
	)

Evaluate a Lua function call or loaded script on the stack.

Return nonzero if an error occurred.

If available pass the source code string as code, else nullptr.

Will pop function and arguments (1 + narg values) from the stack. Will push nret return values to the stack.

On error, print an error message with traceback. Nothing is pushed to the stack.

Definition at line 580 of file luascript.cpp.

Referenced by luascript_callback_invoke(), luascript_do_file(), luascript_do_string(), luascript_func_call_valist(), and luascript_vars_save().

◆ luascript_callback_invoke()

bool luascript_callback_invoke	(	struct fc_lua *	fcl,
		const char *	callback_name,
		int	nargs,
		enum api_types *	parg_types,
		va_list	args
	)

Invoke the 'callback_name' Lua function.

Definition at line 657 of file luascript.cpp.

Referenced by luascript_signal_emit_valist(), and script_client_callback_invoke().

◆ luascript_check_function()

bool luascript_check_function	(	struct fc_lua *	fcl,
		const char *	funcname
	)

Return if the function 'funcname' is define in the lua state 'fcl->state'.

Definition at line 554 of file luascript.cpp.

Referenced by luascript_func_check().

◆ luascript_common_a()

void luascript_common_a ( lua_State * L )

Runs tolua_common_a.lua.

Definition at line 410 of file luascript.cpp.

Referenced by script_client_init(), script_fcdb_init(), and script_server_init().

◆ luascript_common_z()

void luascript_common_z ( lua_State * L )

Runs tolua_common_z.lua.

Definition at line 420 of file luascript.cpp.

Referenced by script_client_init(), script_fcdb_init(), and script_server_init().

◆ luascript_destroy()

void luascript_destroy ( struct fc_lua * fcl )

Free the scripting data.

Definition at line 335 of file luascript.cpp.

Referenced by script_client_free(), script_client_init(), script_server_free(), and script_server_init().

◆ luascript_dir()

const Direction* luascript_dir ( enum direction8 )

Returns a pointer to a given value of enum direction8 (always the same address for the same value), or nullptr if the direction is invalid on the current map.

Definition at line 789 of file luascript.cpp.

Referenced by api_methods_unit_orientation_get(), api_utilities_dir_ccw(), api_utilities_dir_cw(), api_utilities_opposite_dir(), and api_utilities_str2dir().

◆ luascript_do_file()

int luascript_do_file	(	struct fc_lua *	fcl,
		const char *	filename
	)

Parse and execute the script at filename.

Definition at line 638 of file luascript.cpp.

Referenced by script_client_do_file(), and script_server_do_file_shared().

◆ luascript_do_string()

int luascript_do_string	(	struct fc_lua *	fcl,
		const char *	str,
		const char *	name
	)

lua_dostring replacement with error message showing on errors.

Definition at line 618 of file luascript.cpp.

Referenced by luascript_vars_load(), script_client_code_load(), script_client_do_string(), script_server_code_load(), and script_server_do_string_shared().

◆ luascript_error()

int luascript_error	(	lua_State *	L,
		const char *	format,
			...
	)

◆ luascript_error_vargs()

int int luascript_error_vargs	(	lua_State *	L,
		const char *	format,
		va_list	vargs
	)

Internal api error function.

Invoking this will cause Lua to stop executing the current context and throw an exception, so to speak.

Definition at line 248 of file luascript.cpp.

Referenced by luascript_error().

◆ luascript_get_fcl()

struct fc_lua* luascript_get_fcl ( lua_State * L )

Get the freeciv lua struct from a lua state.

Definition at line 315 of file luascript.cpp.

Referenced by api_edit_create_player(), api_edit_create_unit_full(), api_signal_by_index(), api_signal_callback_by_index(), api_signal_connect(), api_signal_defined(), api_signal_remove(), and api_utilities_log_base().

◆ luascript_init()

void luascript_init ( fc_lua * fcl )

Sets the freeciv lua struct for a lua state.

Definition at line 304 of file luascript.cpp.

Referenced by luascript_new(), and script_fcdb_init().

◆ luascript_log()

void luascript_log	(	struct fc_lua *	fcl,
		QtMsgType	level,
		const char *	format,
			...
	)

◆ luascript_log_vargs()

void void luascript_log_vargs	(	struct fc_lua *	fcl,
		QtMsgType	level,
		const char *	format,
		va_list	args
	)

Print a message to the selected output handle.

Definition at line 441 of file luascript.cpp.

Referenced by luascript_log().

◆ luascript_new()

struct fc_lua* luascript_new	(	luascript_log_func_t	outputfct,
		bool	secured_environment
	)

Initialize the scripting state.

Definition at line 272 of file luascript.cpp.

Referenced by script_client_init(), and script_server_init().

◆ luascript_pop_returns()

void luascript_pop_returns	(	struct fc_lua *	fcl,
		const char *	func_name,
		int	nreturns,
		enum api_types *	preturn_types,
		va_list	args
	)

Pop return values from the Lua stack.

Definition at line 461 of file luascript.cpp.

Referenced by luascript_func_call_valist().

◆ luascript_push_args()

void luascript_push_args	(	struct fc_lua *	fcl,
		int	nargs,
		enum api_types *	parg_types,
		va_list	args
	)

Push arguments into the Lua stack.

Definition at line 512 of file luascript.cpp.

Referenced by luascript_callback_invoke(), and luascript_func_call_valist().

◆ luascript_remove_exported_object()

void luascript_remove_exported_object	(	struct fc_lua *	fcl,
		void *	object
	)

Mark any, if exported, full userdata representing 'object' in the current script state as 'Nonexistent'.

This changes the type of the lua variable.

Definition at line 699 of file luascript.cpp.

Referenced by script_server_remove_exported_object().

◆ luascript_vars_load()

void luascript_vars_load	(	struct fc_lua *	fcl,
		struct section_file *	file,
		const char *	section
	)

Load lua variables from file.

Definition at line 763 of file luascript.cpp.

Referenced by script_client_vars_load(), and script_server_vars_load().

◆ luascript_vars_save()

void luascript_vars_save	(	struct fc_lua *	fcl,
		struct section_file *	file,
		const char *	section
	)

Save lua variables to file.

Definition at line 737 of file luascript.cpp.

Referenced by script_client_vars_save(), and script_server_vars_save().

Classes

Macros

Typedefs

Functions

Macro Definition Documentation

◆ LUASCRIPT_ASSERT

◆ LUASCRIPT_CHECK

◆ LUASCRIPT_CHECK_ARG

◆ LUASCRIPT_CHECK_ARG_NIL

◆ LUASCRIPT_CHECK_SELF

◆ LUASCRIPT_CHECK_STATE

Typedef Documentation

◆ luascript_log_func_t

Function Documentation

◆ luascript_arg_error()

◆ luascript_call()

◆ luascript_callback_invoke()

◆ luascript_check_function()

◆ luascript_common_a()

◆ luascript_common_z()

◆ luascript_destroy()

◆ luascript_dir()

◆ luascript_do_file()

◆ luascript_do_string()

◆ luascript_error()

◆ luascript_error_vargs()

◆ luascript_get_fcl()

◆ luascript_init()

◆ luascript_log()

◆ luascript_log_vargs()

◆ luascript_new()

◆ luascript_pop_returns()

◆ luascript_push_args()

◆ luascript_remove_exported_object()

◆ luascript_vars_load()

◆ luascript_vars_save()