Detailed Description

A LuaFunction is a faudes-function that executes a luafaudes script.

LuaFunction is derived from Function and implements the DoTypeCheck and DoExecute interface to run the lua code as supplied by the corresponding function defintion. Thus, it is considered an error to set the function definition to an object that does not cast to a LuaFunctionDefinition.

Definition at line 678 of file lbp_function.h.

#include <lbp_function.h>

Public Member Functions
	LuaFunction (const LuaFunctionDefinition *fdef)

	~LuaFunction (void)

virtual LuaFunction *	New () const

void	Definition (const FunctionDefinition *fdef)

const LuaFunctionDefinition *	Definition (void) const

void	SyntaxCheck (void)

void	Evaluate (void)

void	L (LuaState *l)

LuaState *	L (void)

Public Member Functions inherited from faudes::Function
	Function (const FunctionDefinition *fdef)

	~Function ()

const FunctionDefinition *	Definition (void) const

int	VariantsSize (void) const

void	Variant (int n)

void	Variant (const std::string &rVariantName)

const Signature *	Variant (void) const

int	ParamsSize (void) const

void	ParamValue (int n, Type *param)

Type *	ParamValue (int n) const

void	AllocateValues (void)

void	AllocateValue (int i)

void	FreeValues (void)

bool	TypeCheck (int n)

bool	TypeCheck (void)

void	Execute (void)

Type &	operator= (const Type &rSrc)

Type &	operator= (Type &&rSrc)

Public Member Functions inherited from faudes::Type
	Type (void)

	Type (const Type &rType)

virtual	~Type (void)

virtual Type *	NewCpy (void) const

virtual const Type *	Cast (const Type *pOther) const

virtual void	Clear (void)

virtual bool	IsDefault (void) const

virtual Type &	Copy (const Type &rSrc)

virtual Type &	Move (Type &rSrc)

Type &	operator= (const Type &rSrc)

Type &	operator= (Type &&rSrc)

virtual bool	Equal (const Type &rOther) const

bool	operator== (const Type &rOther) const

bool	operator!= (const Type &rOther) const

virtual void	Name (const std::string &rName)

virtual const std::string &	Name (void) const

virtual const std::string &	TypeName (void) const

void	Write (const Type *pContext=0) const

void	Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out\|std::ios::trunc) const

void	Write (const std::string &pFileName, std::ios::openmode openmode) const

void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const

void	XWrite (const Type *pContext=0) const

void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const

std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const

void	DWrite (const Type *pContext=0) const

void	DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out\|std::ios::trunc) const

void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

void	SWrite (TokenWriter &rTw) const

void	SWrite (void) const

std::string	ToSText (void) const

void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)

void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)

void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

Protected Member Functions
virtual void	DoVariant (int n)

virtual bool	DoTypeCheck (int n)

virtual void	DoExecute ()

virtual void	DoExecuteA ()

virtual void	DoExecuteB ()

virtual void	DoExecuteC ()

virtual void	DoExecuteD ()

virtual void	DoExecuteE ()

Protected Member Functions inherited from faudes::Function
template<class T >
bool	DoTypeCast (int n, T *&rTypedRef)

void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

Protected Member Functions inherited from faudes::Type
void	DoCopy (const Type &rSrc)

void	DoMove (Type &rSrc)

bool	DoEqual (const Type &rOther) const

virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const

virtual void	DoSWrite (TokenWriter &rTw) const

virtual const TypeDefinition *	TypeDefinitionp (void) const

virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Protected Attributes
const LuaFunctionDefinition *	pLuaFuncDef

LuaState *	pL

lua_State *	pLL

int	mFtable

int	mEntryStack

void *	mFType

std::vector< bool >	mLReturn

std::vector< bool >	mLParameter

int	mLReturnCount

int	mLParameterCount

Protected Attributes inherited from faudes::Function
const FunctionDefinition *	pFuncDef

int	mVariantIndex

std::vector< Type * >	mParameterValues

Constructor & Destructor Documentation

◆ LuaFunction()

faudes::LuaFunction::LuaFunction ( const LuaFunctionDefinition * fdef )

Constructor. For the function to be operational, a valid reference to the corresponding LuaFunctionDefinition is required. The only exception is the prototype function object used in the LuaFunctionDefinition itself.

Definition at line 637 of file lbp_function.cpp.

◆ ~LuaFunction()

faudes::LuaFunction::~LuaFunction ( void )

inline

Destructor

Definition at line 690 of file lbp_function.h.

Member Function Documentation

◆ Definition() [1/2]

void faudes::LuaFunction::Definition ( const FunctionDefinition * fdef )

virtual

Set function definition. Normally, functions are provided with a function definition on construction. The only exception are prototype objects used in function definitions themselfs and in the function registry.

Parameters

fdef	Function definition to set.

Reimplemented from faudes::Function.

Definition at line 652 of file lbp_function.cpp.

◆ Definition() [2/2]

const LuaFunctionDefinition * faudes::LuaFunction::Definition ( void ) const

Get function definition.

Returns: Function definition used by this function.

Definition at line 659 of file lbp_function.cpp.

◆ DoExecute()

void faudes::LuaFunction::DoExecute ( void )

protectedvirtual

Executes code as supplied by FunctionDefinition

Exceptions

Exception

Exception during lua setup (id 49)
Any exception during execution of script

Implements faudes::Function.

Definition at line 705 of file lbp_function.cpp.

◆ DoExecuteA()

void faudes::LuaFunction::DoExecuteA ( void )

protectedvirtual

Execute stages

Exceptions

Exception

Exception during lua setup (id 49)

Definition at line 763 of file lbp_function.cpp.

◆ DoExecuteB()

void faudes::LuaFunction::DoExecuteB ( void )

protectedvirtual

Execute stages

Exceptions

Exception

Exception during lua setup (id 49)

Definition at line 797 of file lbp_function.cpp.

◆ DoExecuteC()

void faudes::LuaFunction::DoExecuteC ( void )

protectedvirtual

Execute stages

Exceptions

Exception

Exception during lua setup (id 49)
Any exception during execution of script

Definition at line 852 of file lbp_function.cpp.

◆ DoExecuteD()

void faudes::LuaFunction::DoExecuteD ( void )

protectedvirtual

Execute stages

Exceptions

Exception

Exception during lua setup (id 49)

Definition at line 967 of file lbp_function.cpp.

◆ DoExecuteE()

void faudes::LuaFunction::DoExecuteE ( void )

protectedvirtual

Execute stages

Exceptions

Exception

Exception during lua setup (id 49)

Definition at line 1024 of file lbp_function.cpp.

◆ DoTypeCheck()

bool faudes::LuaFunction::DoTypeCheck ( int n )

protectedvirtual

Method to test the type of an assigned parameter with the specified faudes::Signature (i.e. their TypeDefinition label).

Note: this method is called by Function::Execute() before actual function execution via DoExecute(). It may be used to perform a dynamic cast in preparation of DoExecute(). The latter is only called, if all types match.

Parameters

n	Position of parameter to check

Returns: True if type matches signature.

Exceptions

Exception

Signature undefined (id 48)
Parameter number out of range (id 48)

Implements faudes::Function.

Definition at line 677 of file lbp_function.cpp.

◆ DoVariant()

void faudes::LuaFunction::DoVariant ( int n )

protectedvirtual

Reimplemented from faudes::Function.

Definition at line 664 of file lbp_function.cpp.

◆ Evaluate()

void faudes::LuaFunction::Evaluate ( void )

Evaluate lua code.

This routine avaluates the associated Lua code literally, i.e. no arguments are passed, no specific function is invoked. See also Execute().

Exceptions

Exception

Error in Lua script (id 49)

Definition at line 749 of file lbp_function.cpp.

◆ L() [1/2]

void faudes::LuaFunction::L ( LuaState * l )

Set lua state

Sets the lua state which this function will use for execution. If set to NULL (e.g. on consruction), the function definition's default state will be used. If this is not set either, the global state is used.

Parameters

l Lua state

Definition at line 699 of file lbp_function.cpp.

◆ L() [2/2]

LuaState * faudes::LuaFunction::L ( void )

Get default lua state

Returns: Lua state

Definition at line 693 of file lbp_function.cpp.

◆ New()

LuaFunction * faudes::LuaFunction::New ( void ) const

virtual

Construct on heap. Create a new instance of this function class and return pointer. The new instance will use the same function definition as this instance.

Returns: Pointer to faudes::Function instance.

Implements faudes::Function.

Definition at line 647 of file lbp_function.cpp.

◆ SyntaxCheck()

void faudes::LuaFunction::SyntaxCheck ( void )

Syntax check lua code.

This routine does all it needs to run the script, except to invoke the specified function. The reasoning is, that the script may hang and, thus, never return. A consequence is, that you must set a variant and you must supply parameter values befor checking. You may use AllocateValues() and FreeValues() for this purpose. Errors are indicated by an exception.

Note that the LuaFunctionDefinition provides a convenience wrapper that runs the check on all variants and cares about value allocation.

Exceptions

Exception

No such variant (id 47)
Error in Lua script (id 49)

Definition at line 729 of file lbp_function.cpp.

Member Data Documentation

◆ mEntryStack

int faudes::LuaFunction::mEntryStack

protected

Definition at line 876 of file lbp_function.h.

◆ mFtable

int faudes::LuaFunction::mFtable

protected

Definition at line 875 of file lbp_function.h.

◆ mFType

void* faudes::LuaFunction::mFType

protected

Definition at line 877 of file lbp_function.h.

◆ mLParameter

std::vector<bool> faudes::LuaFunction::mLParameter

protected

Definition at line 879 of file lbp_function.h.

◆ mLParameterCount

int faudes::LuaFunction::mLParameterCount

protected

Definition at line 881 of file lbp_function.h.

◆ mLReturn

std::vector<bool> faudes::LuaFunction::mLReturn

protected

Definition at line 878 of file lbp_function.h.

◆ mLReturnCount

int faudes::LuaFunction::mLReturnCount

protected

Definition at line 880 of file lbp_function.h.

◆ pL

LuaState* faudes::LuaFunction::pL

protected

State of Lua interpreter

Definition at line 873 of file lbp_function.h.

◆ pLL

lua_State* faudes::LuaFunction::pLL

protected

Definition at line 874 of file lbp_function.h.

◆ pLuaFuncDef

const LuaFunctionDefinition* faudes::LuaFunction::pLuaFuncDef

protected

Typed reference to definition

Definition at line 870 of file lbp_function.h.

The documentation for this class was generated from the following files:

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ LuaFunction()

◆ ~LuaFunction()

Member Function Documentation

◆ Definition() [1/2]

◆ Definition() [2/2]

◆ DoExecute()

◆ DoExecuteA()

◆ DoExecuteB()

◆ DoExecuteC()

◆ DoExecuteD()

◆ DoExecuteE()

◆ DoTypeCheck()

◆ DoVariant()

◆ Evaluate()

◆ L() [1/2]

◆ L() [2/2]

◆ New()

◆ SyntaxCheck()

Member Data Documentation

◆ mEntryStack

◆ mFtable

◆ mFType

◆ mLParameter

◆ mLParameterCount

◆ mLReturn

◆ mLReturnCount

◆ pL

◆ pLL

◆ pLuaFuncDef