luascript_signal.h File Reference

#include "support.h"
#include "luascript_types.h"

Include dependency graph for luascript_signal.h:

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

Go to the source code of this file.

Classes
struct	signal_callback
struct	signal

Typedefs
typedef char *	signal_deprecator

Functions
void	luascript_signal_init (struct fc_lua *fcl)
	Initialize script signals and callbacks. More...
void	luascript_signal_free (struct fc_lua *fcl)
	Free script signals and callbacks. More...
void	luascript_signal_emit_valist (struct fc_lua *fcl, const char *signal_name, va_list args)
	Invoke all the callback functions attached to a given signal. More...
void	luascript_signal_emit (struct fc_lua *fcl, const char *signal_name,...)
	Invoke all the callback functions attached to a given signal. More...
signal_deprecator *	luascript_signal_create (struct fc_lua *fcl, const char *signal_name, int nargs,...)
	Create a new signal type. More...
void	deprecate_signal (signal_deprecator *deprecator, const char *signal_name, const char *replacement, const char *deprecated_since)
	Mark signal deprecated. More...
void	luascript_signal_callback (struct fc_lua *fcl, const char *signal_name, const char *callback_name, bool create)
	Connects a callback function to a certain signal. More...
bool	luascript_signal_callback_defined (struct fc_lua *fcl, const char *signal_name, const char *callback_name)
	Returns if a callback function to a certain signal is defined. More...
QString	luascript_signal_by_index (struct fc_lua *fcl, int sindex)
	Return the name of the signal with the given index. More...
const char *	luascript_signal_callback_by_index (struct fc_lua *fcl, const char *signal_name, int sindex)
	Return the name of the 'index' callback function of the signal with the name 'signal_name'. More...

Typedef Documentation

signal_deprecator

typedef char* signal_deprecator

Definition at line 17 of file luascript_signal.h.

Function Documentation

deprecate_signal()

void deprecate_signal	(	signal_deprecator *	deprecator,
		const char *	signal_name,
		const char *	replacement,
		const char *	deprecated_since
	)

Mark signal deprecated.

Definition at line 202 of file luascript_signal.cpp.

Referenced by script_server_signals_create().

luascript_signal_by_index()

QString luascript_signal_by_index	(	struct fc_lua *	fcl,
		int	sindex
	)

Return the name of the signal with the given index.

Definition at line 331 of file luascript_signal.cpp.

Referenced by api_signal_by_index().

luascript_signal_callback()

void luascript_signal_callback	(	struct fc_lua *	fcl,
		const char *	signal_name,
		const char *	callback_name,
		bool	create
	)

Connects a callback function to a certain signal.

Definition at line 230 of file luascript_signal.cpp.

Referenced by api_signal_connect(), and api_signal_remove().

luascript_signal_callback_by_index()

const char* luascript_signal_callback_by_index	(	struct fc_lua *	fcl,
		const char *	signal_name,
		int	sindex
	)

Return the name of the 'index' callback function of the signal with the name 'signal_name'.

Definition at line 344 of file luascript_signal.cpp.

Referenced by api_signal_callback_by_index().

luascript_signal_callback_defined()

bool luascript_signal_callback_defined	(	struct fc_lua *	fcl,
		const char *	signal_name,
		const char *	callback_name
	)

Returns if a callback function to a certain signal is defined.

Definition at line 276 of file luascript_signal.cpp.

Referenced by api_signal_defined().

luascript_signal_create()

signal_deprecator* luascript_signal_create	(	struct fc_lua *	fcl,
		const char *	signal_name,
		int	nargs,
			...
	)

Create a new signal type.

Definition at line 181 of file luascript_signal.cpp.

Referenced by script_client_signal_create(), and script_server_signals_create().

luascript_signal_emit()

void luascript_signal_emit	(	struct fc_lua *	fcl,
		const char *	signal_name,
			...
	)

Invoke all the callback functions attached to a given signal.

Definition at line 135 of file luascript_signal.cpp.

luascript_signal_emit_valist()

void luascript_signal_emit_valist	(	struct fc_lua *	fcl,
		const char *	signal_name,
		va_list	args
	)

Invoke all the callback functions attached to a given signal.

Definition at line 103 of file luascript_signal.cpp.

Referenced by luascript_signal_emit(), script_client_signal_emit(), and script_server_signal_emit().

luascript_signal_free()

void luascript_signal_free

(

struct fc_lua *

fcl

)

Free script signals and callbacks.

Definition at line 314 of file luascript_signal.cpp.

Referenced by luascript_destroy(), and script_client_free().

luascript_signal_init()

void luascript_signal_init

(

struct fc_lua *

fcl

)

Initialize script signals and callbacks.

Definition at line 301 of file luascript_signal.cpp.

Referenced by script_client_init(), and script_server_init().