如何使用Lua扩展C/C++应用系列3

Posted 2021-06-18 ouyangbuxiu

作者：buxiu 转自：Lua中文网站(www.luachina.net)

这次与第二篇文章相反，介绍如何在Lua中调用C/C++函数，首先，我们用C/C++创建一个函数并告诉Lua解释器，然后在Lua中调用这个函数并使用函数的返回值。
定义一个C/C++函数：
要想C/C++中的函数能被Lua调用，函数定义必须这样：

代码:

typedef int (*lua_CFunction) (lua_State *L);

也就是说，函数必须以Lua解释器作为参数，并且返回值为int类型。既然Lua解释器作为函数的参数，那么实际上函数可以从栈中取得任意多个参数。下面我们将看到，返回的整数值代表入栈的值的数目。如果有一个C/C++函数，你想在Lua中调用他，很容易封装一下就可以满足上述要求。
下面的C++的average函数例子中，可以清楚地看到Lua中调用C/C++函数是如何实现的。
1． lua_gettop()返回栈顶的下标索引，由于Lua中栈的下标从1开始，这个返回值实际上也就是函数参数的个数。
2． For循环计算各个参数总和。
3． Average的参数是通过调用lua_pushnumber()入栈的。
4． 然后参数之和被入栈。
5． 最后，函数返回值为2，表明有两个返回值，并且已经入栈。
函数被定义之后，我们必须告诉Lua编译器他的存在，这在main()函数中，在Lua解释器被初始化，类库加载之后完成的。
将下面的代码保存为luaavg.cpp,如果你喜欢用C而不是C++,需要保存文件为luatest.c并且把extern去掉。

代码:

#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, "avg.lua");

    /* cleanup Lua */
    lua_close(L);

    return 0;
}

一个简单的Lua脚本，调用C/C++函数，并打印其返回值，保存为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

如果正常的话程序应该显示："The sum is 25"
如果你不是Linux操作系统，使用的是Vc++编译器，你需要：
1． 创建一个新的win32控制台应用工程。
2． 将文件luaavg.cpp添加到你的工程中。
3． 到Project, Settings点击Link页。
4． 添加lua+lib.lib到Object/library modules列表中。
5． 按F7编译程序。
运行程序以前，你需要确保lua+lib.dll文件放在windows可以找到的地方，将这个文件从C:/Program Files/Lua-5.0拷贝到Visual C++ project目录，如果编译没有错误的话，现在可以Ctrl+F5运行程序了。
关于错误处理：
如果你看过Lua API文档，你会发现在上面的average函数中并未进行参数检查，这样做的目的是为了更容易解释问题，但是在一个实际的程序中错误检查是必要的。在上面的例子中我们至少应该确保每一个参数是一个整数，可以用下面代码实现：

代码:

if (!lua_isnumber(L, i)) {
    lua_pushstring(L, "Incorrect argument to 'average'");
    lua_error(L);
}

这样易于以后的调试。在使用两种语言进行开发的时候这是非常重要的一点，否则你会发现你将陷于忙于两种语言之间进行调试。