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 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 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 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.function4 print(mytestlib.add(1.0,2.0)) 5 print(mytestlib.sub(20.1,19))
一般使用的是第二种方法,在linux下要生成.so文件的命令是:gcc mytestlib.c -fPIC -shared -o mytestlib.so
然后luajit 你的lua文件就可以了。
2.C调lua
从一个简单的例子说起:
lua_State* L = NULL;
// 内部调用lua函数
double f(double x, double y)
{
double z;
lua_getglobal(L, "f"); // 获取lua函数f
lua_pushnumber(L, x); // 压入参数x和y
lua_pushnumber(L, y);
if(lua_pcall(L, 2, 1, 0) != 0)
error(L, "error running function 'f': %s", lua_tostring(L, -1));
if(!lua_isnumber(L, -1))
error(L, "function 'f' must return a number");
z = lua_tonumber(L, -1);
lua_pop(L, 1);
return z;
}
int main(void)
{
L = lua_open();
luaL_openlibs(L);
if(luaL_loadfile(L, "c:\\luatest\\functest.lua(将此处换成自己lua文件的目录)") || lua_pcall(L, 0, 0, 0))
error(L, "cannot run configuration file: %s", lua_tostring(L, -1));
printf("%f\n", f(1.0, 2.0));
return 0;
}
functest.lua:
f = function(a, b)
return a + b
end
但是在编译的时候要添加上lua库,gcc -o s s.c /usr/lib64/liblua-5.1.so
否则会报无法识别的错误。然后执行可执行文件就可以了,可以修改一下lua代码看看效果。
还有一点要说明一下:要将上面的 #include <lua.hpp> 换成:他里面的内容即:
#include <lua.h>
#include <lauxlib.h>
#include <lualib.h>
lua.hpp 这个文件位于 /usr/local/include/lua.hpp,可以去里面看,里面的内容就是
#include <lua.h>
#include <lauxlib.h>
#include <lualib.h> ,只不过多了extern “C”,那是用于C++的,用gcc编译时会报错。
这其中最关键的是调用函数的使用,在C中调用Lua函数的API主要由以下几个:
(1)void lua_call (lua_State *L, int nargs, int nresults);
函数调用,nargs表示参数的个数,nresults表示返回值的个数
首先将lua函数压栈,然后将参数依次压栈,最后调用函数即可
函数调用时,参数和函数都会pop出栈,调用返回后,结果会push进栈
nresults==LUA_MULTRET,所有的返回值都会push进栈
nresults!=LUA_MULTRET,返回值个数根据nresults来调整
Lua语句:
a = f("how", t.x, 14)
在C中的实现:
lua_getglobal(L, "f"); // 函数入栈
lua_pushstring(L, "how"); // 参数1入栈
lua_getglobal(L, "t"); // 表t入栈
lua_getfield(L, -1, "x"); // 参数2入栈
lua_remove(L, -2); // 跳t出栈
lua_pushinteger(L, 14); // 参数3入栈
lua_call(L, 3, 1); // 调用函数,参数和函数都会出栈
lua_setglobal(L, "a"); // 给a赋值,栈顶出栈
上述代码执行完毕后,堆栈状态恢复原样。
(2)int lua_pcall (lua_State *L, int nargs, int nresults, int msgh);
函数调用,在安全模式下,并且可以添加错误处理函数。
如果调用期间发生error,lua_pcall会捕获之,然后push stack一个错误信息(会先将函数和参数pop出栈),并且返回一个error code(非0的一个值)。
发生error时,如果指定了错误处理函数,会在error message入栈前调用错误处理函数,具体由msgh参数来决定:
(1)msgh==0,不指定错误处理函数,入栈信息不变;
(2)msgh!=0,msgh表示错误处理函数的堆栈index,错误处理函数会以error message为参数,并将返回的新的error message入栈。主要用来给error message添加 更多的debug信息,比如堆栈跟踪,因为这些信息在pcall调用完之后是收集不到的。
函数返回代码:
LUA_OK(0):调用成功
LUA_ERRRUN:runtime error
LUA_ERRMEM:内存分配错误,这种情况下不会调用错误处理函数
LUA_ERRERR:调用错误处理函数时出错,当然,不会再进一步调用错误处理函数
LUA_ERRGCMM:调用metamethod.__gc时报错,由gc引起,和函数本身没关系
函数调用,在安全模式下,并且允许函数yield。
一个基本常识是,luaL_开头的函数一定能用lua_开头的函数实现。
lua_open和luaL_newstate都是打开一个新的、完全独立的Lua状态。
区别在于,lua_open需要制定一个内存分配函数,而luaL_newstate会帮你自动制定一个用malloc/free实现的内存分配函数,仅此而已。
打开标准库的函数叫做luaL_openlibs。 lua5.0之后推荐使用luaL_newstate。