ZFFramework
 
Loading...
Searching...
No Matches
ZFProtocolZFLua.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFProtocolZFLua_h_
7#define _ZFI_ZFProtocolZFLua_h_
8
9#include "ZFCore/ZFProtocol.h"
10#include "ZFLua/ZFLuaDef.h"
11ZF_NAMESPACE_GLOBAL_BEGIN
12
18ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFLua, ZFLua)
19public:
21 virtual void *luaStateOpen(void) zfpurevirtual;
23 virtual void luaStateClose(ZF_IN void *L) zfpurevirtual;
24
26 virtual void luaStateAttach(ZF_IN void *L) zfpurevirtual;
28 virtual void luaStateDetach(ZF_IN void *L) zfpurevirtual;
29
31 virtual void classDataUpdate(
32 ZF_IN void *L
33 , ZF_IN const ZFClassDataUpdateData &data
34 ) zfpurevirtual;
35
40 virtual zfbool luaExecute(
41 ZF_IN void *L
42 , ZF_IN const ZFPathInfo &pathInfoOrNull
43 , ZF_IN const ZFInput &input
44 , ZF_OUT_OPT zfauto *luaResult = zfnull
45 , ZF_IN_OPT const ZFCoreArray<zfauto> *luaParams = zfnull
46 , ZF_OUT_OPT zfstring *errorHint = zfnull
47 ) zfpurevirtual;
48
50 virtual void luaGC(ZF_IN void *L) zfpurevirtual;
51ZFPROTOCOL_INTERFACE_END(ZFLua)
52
53ZF_NAMESPACE_GLOBAL_END
54#endif // #ifndef _ZFI_ZFProtocolZFLua_h_
55
ZF_OUT_OPT
#define ZF_OUT_OPT
dummy macro that shows the param used as optional output
Definition ZFCoreTypeDef_ClassType.h:192
zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
ZF_IN_OPT
#define ZF_IN_OPT
dummy macro that shows the param used as optional input
Definition ZFCoreTypeDef_ClassType.h:184
zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
zfnull
#define zfnull
same as NULL, defined for future use
Definition ZFCoreTypeDef_CoreType.h:88
zfstring
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15
ZFLuaDef.h
global header for ZFLua module
ZFLIB_ZFLua
#define ZFLIB_ZFLua
used to export symbols
Definition ZFLuaDef.h:14
ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
ZFProtocol.h
protocol definitions for ZFFramework
ZFPROTOCOL_INTERFACE_END
#define ZFPROTOCOL_INTERFACE_END(ModuleName)
for more information, please refer to ZFPROTOCOL_INTERFACE_BEGIN
Definition ZFProtocol.h:414
ZFPROTOCOL_INTERFACE_BEGIN
#define ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_, ModuleName)
declare a protocol interface for ZFFramework
Definition ZFProtocol.h:408
ZFClassDataUpdateData
data holder for ZFGlobalEvent::E_ClassDataUpdate
Definition ZFObjectClassTypeFwd.h:143
ZFCoreArray
light weight array
Definition ZFCoreArray.h:331
ZFInput
general input callback
Definition ZFIOCallback_input.h:37
ZFPInterface_ZFLua::luaStateOpen
virtual void * luaStateOpen(void)=0
see ZFLuaStateOpen, ensured called in proper thread with proper mutex
ZFPInterface_ZFLua::luaStateDetach
virtual void luaStateDetach(void *L)=0
see ZFLuaStateDetach, ensured called in proper thread with proper mutex
ZFPInterface_ZFLua::luaExecute
virtual zfbool luaExecute(void *L, const ZFPathInfo &pathInfoOrNull, const ZFInput &input, zfauto *luaResult=zft_zfnull, const ZFCoreArray< zfauto > *luaParams=zft_zfnull, zfstring *errorHint=zft_zfnull)=0
see ZFLuaExecute, ensured called in proper thread with proper mutex, impl must supply all methods men...
ZFPInterface_ZFLua::luaStateAttach
virtual void luaStateAttach(void *L)=0
see ZFLuaStateAttach, ensured called in proper thread with proper mutex
ZFPInterface_ZFLua::luaStateClose
virtual void luaStateClose(void *L)=0
see ZFLuaStateClose, ensured called in proper thread with proper mutex
ZFPInterface_ZFLua::luaGC
virtual void luaGC(void *L)=0
see ZFLuaGC, ensured called in proper thread with proper mutex
ZFPInterface_ZFLua::classDataUpdate
virtual void classDataUpdate(void *L, const ZFClassDataUpdateData &data)=0
called when class or method changed, ensured called in proper thread with proper mutex
ZFPathInfo
path related info storage for impl, actual meaning of the info depends on impl
Definition ZFPathInfo.h:35
zfauto
a ZFObject holder which would release content object automatically when destroyed
Definition zfautoFwd.h:34