通过例子学习Lua(7) ---- Lua中调用C/C++函数

1.前言
上次偶说到从C/C++中调用Lua的函数,然后就有朋友问从Lua中如何调用C/C++的
函数,所以偶们这次就来说说这个问题. 首先偶们会在C++中建立一个函数,然后
告知Lua有这个函数,最后再执行它. 另外,由于函数不是在Lua中定义的,所以
无法确定函数的正确性,可能在调用过程中会出错,因此偶们还会说说Lua出错处
理的问题.

2.Lua中调用C函数
在lua中是以函数指针的形式调用函数,并且所有的函数指针都必须满足如下此种
类型:
typedef int (*lua_CFunction) (lua_State *L);

也就是说,偶们在C++中定义函数时必须以lua_State为参数,以int为返回值才能
被Lua所调用. 但是不要忘记了,偶们的lua_State是支持栈的,所以通过栈可以
传递无穷个参数,大小只受内存大小限制. 而返回的int值也只是指返回值的个数
真正的返回值都存储在lua_State的栈中. 偶们通常的做法是做一个wrapper,把
所有需要调用的函数都wrap一下,这样就可以调用任意的函数了.

下面这个例子是一个C++的average()函数,它将展示如何用多个参数并返回多个值

例e14.cpp
#include <stdio.h>

extern "C" {
#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"
}

/* the Lua interpreter */
lua_State* L;

static 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;
}

int main ( int argc,char *argv[] )
{
/* initialize Lua */
L = lua_open();

/* load Lua base libraries */
lua_baselibopen(L);

/* register our function */
lua_register(L,"average",average);

/* run the script */
lua_dofile(L,"e15.lua");

/* cleanup Lua */
lua_close(L);

return 0;
}

例e15.lua
-- call a C++ function

avg,sum = average(10,20,30,40,50)

print("The average is ",avg)
print("The sum is ",sum)


程序说明:
* lua_gettop()的作用是返回栈顶元素的序号. 由于Lua的栈是从1开始编号的,
所以栈顶元素的序号也相当于栈中的元素个数. 在这里,栈中元素的个数就
是传入的参数个数.
* for循环计算所有传入参数的总和. 这里用到了数值转换lua_tonumber().
* 然后偶们用lua_pushnumber()把平均值和总和push到栈中.
* 最后,偶们返回2,表示有两个返回值.
* 偶们虽然在C++中定义了average()函数,但偶们的Lua程序并不知道,所以需
要在main函数中加入

  /* register our function */
lua_register(L,average);

这两行的作用就是告诉e15.lua有average()这样一个函数.
* 这个程序可以存成cpp也可以存成c,如果以.c为扩展名就不需要加extern "C"

编译的方法偶们上次说过了,方法相同.
e15.lua执行的方法只能用上例中的C++中执行,而不能用命令行方式执行.

3.错误处理
在上例中,偶们没有对传入的参数是否为数字进行检测,这样做不好. 所以这里偶
们再加上错误处理的片断.

把这段加在for循环之内:
if (!lua_isnumber(L,i)) {
lua_pushstring(L,"Incorrect argument to 'average'");
lua_error(L);
}
这段的作用就是检测传入的是否为数字.

加上这段之后,偶们debug的时候就会简单许多. 对于结合两种语言的编程,它们之
间传递数据的正确性检测是非常重要的.

这里有别人写好的例子:
VC的 http://tonyandpaige.com/tutorials/luaavg.zip
Linux的 http://tonyandpaige.com/tutorials/luaavg.tar.gz 至此,Lua与C的结合就基本讲完了,下次偶要开始说说Lua与面向对象. 但是偶自己还没有学完,所以大家可能要多等两天了. Sorry!