调用Lua函数

翻译自http://gamedevgeek.com/tutorials/calling-lua-functions/

调用Lua函数

这是Lua脚本语言教程系列之二。在第一篇中，我们学习了在Windows和Linux下编译并运行"Hello, World!"程序。如果你没有看过，请参考Lua入门一文。

本教程涵盖了Lua5.1。在Lua的每一个版本中都有一些非常不同之处。下面的示例代码将不能在老版本的Lua下运行。如果你仍然在使用老版本而且不愿意升级，不用担心，我已经在文章底部提供了4.0和5.0教程的源代码下载连接。好了，让我们开始吧！

这篇文章将教你如何在Lua中定义一个函数，然后在C/C++程序中调用它。同时，我们将学习到参数传递，返回值，以及处理全局变量。

你的第一个Lua函数

在Lua中定义函数是相当简单的。Lua函数以关键字"function"开头，后面跟随函数名，然后是参数列表。函数定义以关键字"end"结束。Lua函数能够接受多个参数，而且可以返回多个参数。

下面是一个实现两个数相加并返回结果的Lua函数。我们将它保存为"add.lua"文件。

-- add two numbers
function add ( x, y )
return x + y
end

在Lua入门中，我们已经知道调用luaL_dofile()就是执行脚本。因为在本文中我们只定义了一个函数，故只需简单地调用luaL_dofile()函数就能执行add函数。

我在前面已经说过，Lua函数能够接受多个参数，返回多个结果。这是用栈来实现的。

为了调用一个Lua函数，首先需要将函数压入栈中。再将参数压入。然后，调用lua_call()去调用Lua函数。函数调用完成之后，返回值存在于栈中。所有这些步骤将被展示在luaadd()函数定义中。

1. 调用lua_getglobal()将add()函数压入栈中。
2. 调用lua_pushnumber()将第一个参数x压入栈中。
3. 同样，调用lua_pushnumber()将第二个参数y压入栈中。
4. 调用lua_call()，其参数的意思是两个参数，一个返回值。
5. 现在，我们可以利用lua_tointeger()获得整型返回值。
6. 最后，调用lua_pop()将值从栈中移出。

保存文件为luaadd.cpp。如果你直接使用C而不是C++，将文件名改为luaadd.c，然后将extern "C"删除。

#include <stdio.h>

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

/* 指向Lua解释器的指针 */
lua_State* L;
int luaadd ( int x, int y )
{
int sum;
/* 通过名字得到Lua函数 */
lua_getglobal(L, "add");
/* 第一个参数 */
lua_pushnumber(L, x);
/* 第二个参数 */
lua_pushnumber(L, y);
 /* 调用函数，告知有两个参数，一个返回值 */
lua_call(L, 2, 1);
/* 得到结果 */
sum = (int)lua_tointeger(L, -1);
lua_pop(L, 1);
return sum;
}

int main ( int argc, char *argv[] )
{
int sum;
/* 初始化Lua */
L = lua_open();
/* 载入Lua基本库 */
luaL_openlibs(L);
/* 载入脚本 */
luaL_dofile(L, "add.lua");
/* 调用Lua函数 */
sum = luaadd( 10, 15 );
/* 显示结果 */
printf( "The sum is %d/n", sum );
/* 清除Lua */
lua_close(L);
/* 暂停 */
printf( "Press enter to exit…" );
getchar();
return 0;
}

编译

在Linux下，在命令行键入：

g++ luaadd.cpp -llua -ldl -o luaadd

然后，键入下列命令运行：

./luaadd

如果没有问题, 程序将显示结果为： "The sum is 25"。

在Visual C++你将需要进行下列步骤：

1. 创建一个新的空Win32控制台应用工程。
2. 将"luatest.cpp"加入你的工程。
3. 选择项目菜单中的属性菜单。
4. 在"连接器"的"输入"栏目的"附加依赖项"中输入"lua5.1.lib"。
5. 确定。

此时，按F7构建程序。

如果你采用的是dll库，请确保将其放在应用程序的目录中或者windows系统能够找到它的地方。如果你采用的是静态连接库，则不需要。 

全局变量

全局变量在Lua中也很好处理。就像我们看到的，lua_getglobal()将一个Lua全局变量压入栈中。例如，在Lua脚本中包含一个全局变量z，下面代码的功能就是得到它的值：

lua_getglobal(L, "z");
z = (int)lua_tointeger(L, -1);
lua_pop(L, 1);

相应地，lua_setglobal()函数能够设置全局变量地值。下面这段代码演示了如何将Lua全局变量z的值变为10：

lua_pushnumber(L, 10);
lua_setglobal(L, "z");

应该记住：在Lua中，我们没有必要显式定义一个全局变量。如果全局变量不存在，调用lua_setglobal()将为你创建一个。

(本文由Groov0V翻译，转载请指明出处！)