(Lua调用C函数)
Lua可以调用C函数的能力将极大的提高Lua的可扩展性和可用性。对于有些和操作系统相关的功能,或者是对效率要求较高的模块,我们完全可以通过C函数来实现,之后再通过Lua调用指定的C函数。对于那些可被Lua调用的C函数而言,其接口必须遵循Lua要求的形式,即 typedef int (*lua_CFunction)(lua_State* L) 。简单说明一下,该函数类型仅仅包含一个表示Lua环境的指针作为其唯一的参数,实现者可以通过该指针进一步获取Lua代码中实际传入的参数。返回值是整型,表示该C函数将返回给Lua代码的返回值数量,如果没有返回值,则return 0即可。需要说明的是,C函数无法直接将真正的返回值返回给Lua代码,而是通过虚拟栈来传递Lua代码和C函数之间的调用参数和返回值的。这里我们将介绍两种Lua调用C函数的规则。
1. C函数作为应用程序的一部分。
1 #include <stdio.h> 2 #include < string .h> 3 #include <lua.hpp> 4 #include <lauxlib.h> 5 #include <lualib.h> 6 7 // 待Lua调用的C注册函数。 8 static int add2(lua_State* L) 9 { 10 // 检查栈中的参数是否合法,1表示Lua调用时的第一个参数(从左到右),依此类推。 11 // 如果Lua代码在调用时传递的参数不为number,该函数将报错并终止程序的执行。 12 double op1 = luaL_checknumber(L, 1 ); 13 double op2 = luaL_checknumber(L, 2 ); 14 // 将函数的结果压入栈中。如果有多个返回值,可以在这里多次压入栈中。 15 lua_pushnumber(L,op1 + op2); 16 // 返回值用于提示该C函数的返回值数量,即压入栈中的返回值数量。 17 return 1 ; 18 } 19 20 // 另一个待Lua调用的C注册函数。 21 static int sub2(lua_State* L) 22 { 23 double op1 = luaL_checknumber(L, 1 ); 24 double op2 = luaL_checknumber(L, 2 ); 25 lua_pushnumber(L,op1 - op2); 26 return 1 ; 27 } 28 29 const char * testfunc = " print(add2(1.0,2.0)) print(sub2(20.1,19)) " ; 30 31 int main() 32 { 33 lua_State* L = luaL_newstate(); 34 luaL_openlibs(L); 35 // 将指定的函数注册为Lua的全局函数变量,其中第一个字符串参数为Lua代码 36 // 在调用C函数时使用的全局函数名,第二个参数为实际C函数的指针。 37 lua_register(L, " add2 " , add2); 38 lua_register(L, " sub2 " , sub2); 39 // 在注册完所有的C函数之后,即可在Lua的代码块中使用这些已经注册的C函数了。 40 if (luaL_dostring(L,testfunc)) 41 printf( " Failed to invoke.\n " ); 42 lua_close(L); 43 return 0 ; 44 }
2. C函数库成为Lua的模块。
将包含C函数的代码生成库文件,如Linux的so,或Windows的DLL,同时拷贝到Lua代码所在的当前目录,或者是LUA_CPATH环境变量所指向的目录,以便于Lua解析器可以正确定位到他们。在我当前的Windows系统中,我将其copy到"C:\Program Files\Lua\5.1\clibs\",这里包含了所有Lua可调用的C库。见如下C语言代码和关键性注释:
1 #include <stdio.h> 2 #include < string .h> 3 #include <lua.hpp> 4 #include <lauxlib.h> 5 #include <lualib.h> 6 7 // 待注册的C函数,该函数的声明形式在上面的例子中已经给出。 8 // 需要说明的是,该函数必须以C的形式被导出,因此extern "C"是必须的。 9 // 函数代码和上例相同,这里不再赘述。 10 extern " C " int add(lua_State* L) 11 { 12 double op1 = luaL_checknumber(L, 1 ); 13 double op2 = luaL_checknumber(L, 2 ); 14 lua_pushnumber(L,op1 + op2); 15 return 1 ; 16 } 17 18 extern " C " int sub(lua_State* L) 19 { 20 double op1 = luaL_checknumber(L, 1 ); 21 double op2 = luaL_checknumber(L, 2 ); 22 lua_pushnumber(L,op1 - op2); 23 return 1 ; 24 } 25 26 // luaL_Reg结构体的第一个字段为字符串,在注册时用于通知Lua该函数的名字。 27 // 第一个字段为C函数指针。 28 // 结构体数组中的最后一个元素的两个字段均为NULL,用于提示Lua注册函数已经到达数组的末尾。 29 static luaL_Reg mylibs[] = { 30 { " add " , add}, 31 { " sub " , sub}, 32 {NULL, NULL} 33 }; 34 35 // 该C库的唯一入口函数。其函数签名等同于上面的注册函数。见如下几点说明: 36 // 1. 我们可以将该函数简单的理解为模块的工厂函数。 37 // 2. 其函数名必须为luaopen_xxx,其中xxx表示library名称。Lua代码require "xxx"需要与之对应。 38 // 3. 在luaL_register的调用中,其第一个字符串参数为模块名"xxx",第二个参数为待注册函数的数组。 39 // 4. 需要强调的是,所有需要用到"xxx"的代码,不论C还是Lua,都必须保持一致,这是Lua的约定, 40 // 否则将无法调用。 41 extern " C " __declspec(dllexport) 42 int luaopen_mytestlib(lua_State* L) 43 { 44 const char * libName = " mytestlib " ; 45 luaL_register(L,libName,mylibs); 46 return 1 ; 47 }
见如下Lua代码:
1 require " mytestlib " -- 指定包名称 2 3 -- 在调用时,必须是package.function 4 print (mytestlib.add( 1.0 , 2.0 )) 5 print (mytestlib.sub( 20.1 , 19 ))
分类: Lua编程
作者: Leo_wl
出处: http://www.cnblogs.com/Leo_wl/
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
版权信息