Lua教程(四):在Lua中调用C语言、C++的函数
程序员文章站
2022-06-16 23:48:53
本教程将介绍如何在lua里面调用c/c++函数。
在lua里面调用c/c++函数其实是比较简单,本文将通过两个示例演示具体的做法:一个是求平均数,另一个是打印lua函数的...
本教程将介绍如何在lua里面调用c/c++函数。
在lua里面调用c/c++函数其实是比较简单,本文将通过两个示例演示具体的做法:一个是求平均数,另一个是打印lua函数的一些参数信息。
最后,本文会介绍如何把这两个函数定义成一个模块,这样lua代码里面就可以不再使用全局的名字空间了。
前言
当我们需要在lua里面调用c/c++函数时,所有的函数都必须满足以下函数签名:
复制代码 代码如下:
typedef int (*lua_cfunction) (lua_state *l);
换句话说,所有的函数必须接收一个lua_state作为参数,同时返回一个整数值。因为这个函数使用lua栈作为参数,所以它可以从栈里面读取任意数量和任意类型的参数。而这个函数的返回值则表示函数返回时有多少返回值被压入lua栈。(因为lua的函数是可以返回多个值的)
示例一
定义c++函数指针
复制代码 代码如下:
int average(lua_state *l)
{
// get number of arguments
int n = lua_gettop(l);
double sum = 0;
int i;
// loop through each argument
for (i = 1; i <= n; i++)
{
// total the arguments
sum += lua_tonumber(l, i);
}
// push the average
lua_pushnumber(l, sum / n);
// push the sum
lua_pushnumber(l, sum);
// return the number of results
return 2;
}
注册此函数给lua
复制代码 代码如下:
lua_register(l, "average", average);
lua里面调用此函数
复制代码 代码如下:
avg, sum = average(10, 20, 30, 40, 50)
print("the average is ", avg)
print("the sum is ", sum)
示例二
定义c++函数
复制代码 代码如下:
int displayluafunction(lua_state *l)
{
// number of input arguments
int argc = lua_gettop(l);
// print input arguments
std::cout << "[c++] function called from lua with " << argc
<< " input arguments" << std::endl;
for(int i=0; i<argc; i++)
{
std::cout << " input argument #" << argc-i << ": "
<< lua_tostring(l, lua_gettop(l)) << std::endl;
lua_pop(l, 1);
}
// push to the stack the multiple return values
std::cout << "[c++] returning some values" << std::endl;
lua_pushnumber(l, 12);
lua_pushstring(l, "see you space cowboy");
// number of return values
return 2;
}
注册此lua函数
复制代码 代码如下:
// push the c++ function to be called from lua
std::cout << "[c++] pushing the c++ function" << std::endl;
lua_pushcfunction(l, displayluafunction);
lua_setglobal(l, "displayluafunction");
注意,上一个示例,我们使用的是函数是
复制代码 代码如下:
lua_register(l, "average", average);
它其实只是一个宏定义,其实现也是上面两个函数组成的。
在lua里调用此函数
复制代码 代码如下:
io.write('[lua] calling the c functionn')
a,b = displayluafunction(12, 3.141592, 'hola')
-- print the return values
io.write('[lua] the c function returned <' .. a .. '> and <' .. b .. '>\n')
实现一个lua模块
首先,我们把这两个c函数封装到一个数组里面:
复制代码 代码如下:
static const lual_reg mylibs[]=
{
{"average", average},
{"displayluafunction", displayluafunction},
{null, null}
};
接下来,我们定义另一个c函数,让它注册我们的lua模块:
复制代码 代码如下:
int lua_openmylib(lua_state *l)
{
lual_newlib(l, mylibs);
return 1;
};
这里的lual_newlib会生成一个table,并把所有的mylibs里面的函数填充进去。最后,lua_openmylib返回值为1,表示会把刚刚生成的table压入栈。
最后,我们像之前注册lua的标准库一样,注册我们新的库,并给它起名字为mylib:
复制代码 代码如下:
static const lual_reg lualibs[] =
{
{"base", luaopen_base},
{"io", luaopen_io},
{"mylib", lua_openmylib},
{null, null}
};
此时,我们在lua里面调用之前的两个函数就需要带上模块名字前缀了:
复制代码 代码如下:
avg, sum = mylib.average(10, 20, 30, 40, 50)
a,b = mylib.displayluafunction(12, 3.141592, 'hola')
结语
注意:这里c函数参数里的lua栈是私有的,每一个函数都有自己的栈。当一个c/c++函数把返回值压入lua栈以后,该栈会自动被清空。