详解关于在Lua中调用C++函数
关于在Lua中调用C++函数是本文要介绍的内容,主要是来了解在Lua中调用C++函数。由于我没有想到一个简单的例子来说明这种情况,因此,我借用了Lua官方文档中的average函数来进行讲解。
本教程涵盖了Lua5.1。在Lua的每一个版本中都有一些非常不同之处。下面的示例代码将不能在老版本的Lua下运行。如果你仍然在使用老版本而且不愿意升级,不用担心,我已经在文章底部提供了4.0和5.0教程的源代码下载连接。好了,让我们开始吧!
在本文中我们将用C++创建一个函数,告诉Lua解释器它的情况,最后从Lua中调用它并使用其结果。本文在后面也将谈一谈Lua程序中的错误检查。
定义函数
第一步是定义函数。所有在Lua中被调用的C/C++函数将使用下面一类指针进行调用:
typedef int (*lua_CFunction) (lua_State *L);换句话说,函数必须要以Lua解释器作为唯一的参数,并且返回一个唯一的整数。由于用一个Lua解释器作为参数,因此函数实际上能够从栈中取得任意数量的参数。在后面我们将看到,返回的整数实际上是被压入栈的值的个数。通过如此容易的封装,就能满足你在Lua中调用C++函数的需求。
下面给出的C++函数average()演示了如何接受多个参数且返回超过一个值。记住,该函数是一个与上面typedef相匹配的函数。
lua_gettop函数返回栈顶的索引值。因为在Lua中栈是从1开始编号的,因此该函数获得的值就是参数的个数。
在for循环中计算所有参数之和。
调用lua_pushnumber()将参数的平均值压栈。
将参数之和压入栈中。
最后,函数返回2,说明有两个返回值在栈中。
现在C++函数已经被定义好了,我们必须将它告诉Lua解释器。这将在main函数中初始化Lua解释器和载入库完成之后完成:
/* 注册函数 */ lua_register(L, "average", average);
保存文件为luaavg.cpp。如果你直接使用C而不是C++,将文件名改为luaavg.c,然后将extern "C"删除。
#include <stdio.h> extern "C" { #include "lua.h" #include "lualib.h" #include "lauxlib.h" } /* 指向Lua解释器的指针 */ lua_State* L; static int average(lua_State *L) { /* 得到参数个数 */ int n = lua_gettop(L); double sum = 0; int i; /* 循环求参数之和 */ for (i = 1; i <= n; i++) { /* 求和 */ sum += lua_tonumber(L, i); } /* 压入平均值 */ lua_pushnumber(L, sum / n); /* 压入和 */ lua_pushnumber(L, sum); /* 返回返回值的个数 */ return 2; } int main ( int argc, char *argv[] ) { /* 初始化Lua */ L = lua_open(); /* 载入Lua基本库 */ luaL_openlibs(L); /* 注册函数 */ lua_register(L, "average", average); /* 运行脚本 */ luaL_dofile(L, "avg.lua"); /* 清除Lua */ lua_close(L); /* 暂停 */ printf( "Press enter to exit…" ); getchar(); return 0; }
下面是以5个参数调用average函数并且显示两个返回值的Lua脚本,我们将其保存为avg.lua:
-- call a C++ function avg, sum = average(10, 20, 30, 40, 50) print("The average is ", avg) print("The sum is ", sum)
编译
在Linux下,在命令行键入:
g++ luaavg.cpp -llua -llualib -o luaavg然后,键入下列命令运行:
./luaavg如果没有问题, 程序将显示出平均值、和。
在Visual C++你将需要进行下列步骤:
创建一个新的空Win32控制台应用工程。
将"luatest.cpp"加入你的工程。
选择项目菜单中的属性菜单。
在"连接器"的"输入"栏目的"附加依赖项"中输入"lua5.1.lib"。
确定。
此时,按F7构建程序。
如果你采用的是dll库,请确保将其放在应用程序的目录中或者windows系统能够找到它的地方。如果你采用的是静态连接库,则不需要。
错误处理
如果你已经阅读了Lua的API文档,你将看出实际上我上面的average函数没有进行错误检查。这样做是为了更容易地讲解,然而在真实的程序中你应该做一些错误检测。在上面的例子中,我们至少应该检查每个参数是不是数字。通过在for循环中添加下面的代码来实现:
if (!lua_isnumber(L, i)) { lua_pushstring(L, "Incorrect argument to 'average'"); lua_error(L); }