Classes
struct	ConstSmartUserDataWrapper

struct	LuaParsing

struct	LuaParsing< bool >

struct	LuaParsing< const char * >

struct	LuaParsing< const std::string & >

struct	LuaParsing< const void * >

struct	LuaParsing< ConstSmartPtr< void > >

struct	LuaParsing< double >

struct	LuaParsing< float >

struct	LuaParsing< int >

struct	LuaParsing< size_t >

struct	LuaParsing< SmartPtr< void > >

struct	LuaParsing< std::string >

struct	LuaParsing< void * >

struct	RawUserDataWrapper

struct	SmartUserDataWrapper

struct	UserDataWrapper

Enumerations
enum	UserDataWrapperTypes { RAW_POINTER = 1 , SMART_POINTER = 1 << 1 , IS_CONST = 1 << 2 }

Functions
bool	CreateBindings_LUA (lua_State *L, Registry &reg)
	creates bindings for ug_interface and a given lua-state. More...

static int	ExecuteMethod (lua_State L, const ExportedMethodGroup methodGrp, UserDataWrapper self, const ClassNameNode classNameNode, bool errorOutput)

void	GetBestMatchingMember (const char classname, const char name, std::string &minname, int &mind)

void	GetBestMatchingMember (const IExportedClass c, const char name, std::string &minname, int &mind)

std::string	GetColonWarning (std::string name)

static string	GetLuaParametersString (lua_State *L, int offsetToFirstParam=0)
	returns a String describing the parameters on the lua stack ex. "GlobalMultiGridRefiner, LuaUserNumber2d, number, string" More...

string	GetNilWarning (lua_State *L, int offsetToFirstParam)

static string	GetTypeMismatchString (const ParameterInfo &paramsTemplate, lua_State *L, int offsetToFirstParam, int badParamOneBased)

static int	LuaConstructor (lua_State L, IExportedClass c, const char *groupname=nullptr)

static int	LuaProxyConstructor (lua_State *L)

static int	LuaProxyDelete (lua_State *L)

static int	LuaProxyFunction (lua_State *L)

static int	LuaProxyGroupConstructor (lua_State *L)

static int	LuaProxyMethod (lua_State *L)

static int	LuaProxyRelease (lua_State *L)

static int	LuaToStringDefault (lua_State *L)

static int	MetatableIndexer (lua_State *L)

std::string	ParameterStackString (ParameterStack &s)

void	PrintLUACallStack ()

string	UGErrorTraceback (UGError &err)


SmartUserDataWrapper *	CreateNewUserData (lua_State L, const SmartPtr< void > &ptr, const char metatableName)
	creates a new UserDataWrapper and associates it with ptr in luas registry More...

ConstSmartUserDataWrapper *	CreateNewUserData (lua_State L, const ConstSmartPtr< void > &ptr, const char metatableName)
	creates a new UserDataWrapper and associates it with ptr in luas registry More...

RawUserDataWrapper *	CreateNewUserData (lua_State L, void ptr, const char metatableName, void(deleteFunc)(const void *), bool is_const)
	creates a new UserDataWrapper and associates it with ptr in luas registry More...

Variables
const bool	IMLPICIT_SMART_PTR_TO_PTR_CONVERSION = true

Enumeration Type Documentation

◆ UserDataWrapperTypes

enum ug::bridge::lua::UserDataWrapperTypes

Enumerator
RAW_POINTER
SMART_POINTER
IS_CONST

Function Documentation

◆ CreateBindings_LUA()

bool ug::bridge::lua::CreateBindings_LUA	(	lua_State *	L,
		Registry &	reg
	)

creates bindings for ug_interface and a given lua-state.

Registers a meta-object for each class and class group found in the ug registry reg. Global functions are registered for all GlobalFunction-objects in the registry reg.

Parameters

L	the Lua State
reg	the ug registry

Returns: true on success

If you use ug::script, this method will be invoked automatically.

References ug::bridge::IExportedClass::class_name_node(), ug::bridge::IExportedClass::class_names(), ug::bridge::Registry::get_class(), ug::bridge::Registry::get_class_group(), ug::bridge::IExportedClass::get_const_method_group(), ug::bridge::Registry::get_function_group(), ug::bridge::IExportedClass::get_method_group(), ug::bridge::IExportedClass::is_instantiable(), LuaProxyConstructor(), LuaProxyDelete(), LuaProxyFunction(), LuaProxyGroupConstructor(), LuaProxyMethod(), LuaProxyRelease(), LuaToStringDefault(), MetatableIndexer(), ug::bridge::ExportedMethodGroup::name(), ug::bridge::ExportedFunctionGroup::name(), ug::bridge::ClassGroupDesc::name(), ug::bridge::IExportedClass::name(), ug::bridge::Registry::num_class_groups(), ug::bridge::Registry::num_classes(), ug::bridge::IExportedClass::num_const_methods(), ug::bridge::Registry::num_functions(), and ug::bridge::IExportedClass::num_methods().

Referenced by ug::script::GetDefaultLuaState(), and ug::script::UpdateScriptAfterRegistryChange().

◆ CreateNewUserData() [1/3]

ConstSmartUserDataWrapper * ug::bridge::lua::CreateNewUserData	(	lua_State *	L,
		const ConstSmartPtr< void > &	ptr,
		const char *	metatableName
	)

creates a new UserDataWrapper and associates it with ptr in luas registry

Creates a new userdata in lua, which encapsulates the given pointer / smart-pointer. It then assigns the specified metatable to the userdata. When the function is done, the userdata is left on luas stack.

References IS_CONST, SMART_POINTER, ug::bridge::lua::ConstSmartUserDataWrapper::smartPtr, and ug::bridge::lua::UserDataWrapper::type.

◆ CreateNewUserData() [2/3]

SmartUserDataWrapper * ug::bridge::lua::CreateNewUserData	(	lua_State *	L,
		const SmartPtr< void > &	ptr,
		const char *	metatableName
	)

creates a new UserDataWrapper and associates it with ptr in luas registry

Creates a new userdata in lua, which encapsulates the given pointer / smart-pointer. It then assigns the specified metatable to the userdata. When the function is done, the userdata is left on luas stack.

References SMART_POINTER, ug::bridge::lua::SmartUserDataWrapper::smartPtr, and ug::bridge::lua::UserDataWrapper::type.

Referenced by ug::bridge::lua::LuaParsing< const void * >::push(), ug::bridge::lua::LuaParsing< ConstSmartPtr< void > >::push(), ug::bridge::lua::LuaParsing< SmartPtr< void > >::push(), and ug::bridge::lua::LuaParsing< void * >::push().

◆ CreateNewUserData() [3/3]

RawUserDataWrapper * ug::bridge::lua::CreateNewUserData	(	lua_State *	L,
		void *	ptr,
		const char *	metatableName,
		void()(const void )	deleteFunc,
		bool	is_const
	)

creates a new UserDataWrapper and associates it with ptr in luas registry

Creates a new userdata in lua, which encapsulates the given pointer / smart-pointer. It then assigns the specified metatable to the userdata. When the function is done, the userdata is left on luas stack.

References ug::bridge::lua::RawUserDataWrapper::deleteFunc, IS_CONST, ug::bridge::lua::RawUserDataWrapper::obj, RAW_POINTER, and ug::bridge::lua::UserDataWrapper::type.

Referenced by LuaConstructor().

◆ ExecuteMethod()

static int ug::bridge::lua::ExecuteMethod	(	lua_State *	L,
		const ExportedMethodGroup *	methodGrp,
		UserDataWrapper *	self,
		const ClassNameNode *	classNameNode,
		bool	errorOutput
	)

static

This method is not called by lua, but a helper to LuaProxyMethod. It recursively calls itself until a matching overload was found.

Parameters

L
methodGrp
self
classNameNode
errorOutput

Returns: The number of items pushed to the stack

References ug::bridge::ClassNameNode::base_class(), ug::bridge::ExportedMethod::class_name(), ug::bridge::ExportedMethod::execute(), func(), ug::bridge::FunctionInfo(), ug::bridge::ExportedMethodGroup::get_overload(), GetTypeMismatchString(), ug::bridge::ExportedMethod::has_custom_return(), ug::bridge::LuaClassMethodInfo(), ug::bridge::LuaStackToParams(), ug::bridge::ExportedMethodGroup::name(), ug::bridge::ClassNameNode::name(), ug::bridge::ClassNameNode::num_base_classes(), ug::bridge::ExportedMethodGroup::num_overloads(), ParameterStackString(), ug::bridge::ExportedFunctionBase::params_in(), ug::bridge::ParamsToLuaStack(), UG_LOG, and UG_LUA_BINDINGS_CATCH.

Referenced by LuaProxyMethod().

◆ GetBestMatchingMember() [1/2]

void ug::bridge::lua::GetBestMatchingMember	(	const char *	classname,
		const char *	name,
		std::string &	minname,
		int &	mind
	)

See also: GetBestMatchingMember

References ug::bridge::Registry::get_class(), ug::bridge::GetUGRegistry(), and name.

Referenced by GetBestMatchingMember(), and MetatableIndexer().

◆ GetBestMatchingMember() [2/2]

void ug::bridge::lua::GetBestMatchingMember	(	const IExportedClass *	c,
		const char *	name,
		std::string &	minname,
		int &	mind
	)

This function is used if the user enters a member function wrong and returns the best guess what he means. Also searches in base classes.

Parameters

c	(in) the class
name	(in) the name of the member function we are searching
minname	(out) the name of the closest match to name (in Levenshtein-Distance)
mind	(out) number of edits needed from name -> minname

References ug::bridge::IExportedClass::class_names(), ug::bridge::Registry::get_class(), ug::bridge::IExportedClass::get_const_method(), ug::bridge::IExportedClass::get_method(), GetBestMatchingMember(), ug::bridge::GetUGRegistry(), ug::LevenshteinDistance(), name, ug::bridge::ExportedFunctionBase::name(), ug::bridge::IExportedClass::num_const_methods(), and ug::bridge::IExportedClass::num_methods().

◆ GetColonWarning()

std::string ug::bridge::lua::GetColonWarning ( std::string name )

users sometimes use the . operator (like in myObject.the_method(parameter) ), which sometimes print very weird error messages. this function tries to catch some of those errors. NOTE: this function can NOT catch errors like approxSpace.print_statistic() ( note the wrong . )

Parameters

name	the name of the function. will be used to search "."+name in the code.

Returns: error string or ""

References errSymb, ug::script::GetDefaultLuaState(), ug::bridge::GetLuaLine(), and name.

Referenced by LuaProxyMethod().

◆ GetLuaParametersString()

static string ug::bridge::lua::GetLuaParametersString	(	lua_State *	L,
		int	offsetToFirstParam = `0`
	)

static

returns a String describing the parameters on the lua stack ex. "GlobalMultiGridRefiner*, LuaUserNumber2d*, number, string"

References ug::bridge::GetLuaTypeString().

Referenced by LuaConstructor(), LuaProxyFunction(), and LuaProxyMethod().

◆ GetNilWarning()

string ug::bridge::lua::GetNilWarning	(	lua_State *	L,
		int	offsetToFirstParam
	)

if one of the parameters is nil, this returns an error to warn the user about not initialised variables

Parameters

L	the lua state
offsetToFirstParam	offset to first param

Returns: error string or ""

References errSymb.

Referenced by LuaConstructor(), LuaProxyFunction(), and LuaProxyMethod().

◆ GetTypeMismatchString()

static string ug::bridge::lua::GetTypeMismatchString	(	const ParameterInfo &	paramsTemplate,
		lua_State *	L,
		int	offsetToFirstParam,
		int	badParamOneBased
	)