Lua教程（二十）：Lua调用C函数

lua可以调用c函数的能力将极大的提高lua的可扩展性和可用性。对于有些和操作系统相关的功能，或者是对效率要求较高的模块，我们完全可以通过c函数来实现，之后再通过lua调用指定的c函数。对于那些可被lua调用的c函数而言，其接口必须遵循lua要求的形式，即typedef int (*lua_cfunction)(lua_state* l)。简单说明一下，该函数类型仅仅包含一个表示lua环境的指针作为其唯一的参数，实现者可以通过该指针进一步获取lua代码中实际传入的参数。返回值是整型，表示该c函数将返回给lua代码的返回值数量，如果没有返回值，则return 0即可。需要说明的是，c函数无法直接将真正的返回值返回给lua代码，而是通过虚拟栈来传递lua代码和c函数之间的调用参数和返回值的。这里我们将介绍两种lua调用c函数的规则。

1. c函数作为应用程序的一部分。

#include <stdio.h>
#include <string.h>
#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

//待lua调用的c注册函数。
static int add2(lua_state* l)
{
    //检查栈中的参数是否合法，1表示lua调用时的第一个参数(从左到右)，依此类推。
    //如果lua代码在调用时传递的参数不为number，该函数将报错并终止程序的执行。
    double op1 = lual_checknumber(l,1);
    double op2 = lual_checknumber(l,2);
    //将函数的结果压入栈中。如果有多个返回值，可以在这里多次压入栈中。
    lua_pushnumber(l,op1 + op2);
    //返回值用于提示该c函数的返回值数量，即压入栈中的返回值数量。
    return 1;
}

//另一个待lua调用的c注册函数。
static int sub2(lua_state* l)
{
    double op1 = lual_checknumber(l,1);
    double op2 = lual_checknumber(l,2);
    lua_pushnumber(l,op1 - op2);
    return 1;
}

const char* testfunc = "print(add2(1.0,2.0)) print(sub2(20.1,19))";

int main()
{
    lua_state* l = lual_newstate();
    lual_openlibs(l);
    //将指定的函数注册为lua的全局函数变量，其中第一个字符串参数为lua代码
    //在调用c函数时使用的全局函数名，第二个参数为实际c函数的指针。
    lua_register(l, "add2", add2);
    lua_register(l, "sub2", sub2);
    //在注册完所有的c函数之后，即可在lua的代码块中使用这些已经注册的c函数了。
    if (lual_dostring(l,testfunc))
        printf("failed to invoke.\n");
    lua_close(l);
    return 0;
}

2. c函数库成为lua的模块。

将包含c函数的代码生成库文件，如linux的so，或windows的dll，同时拷贝到lua代码所在的当前目录，或者是lua_cpath环境变量所指向的目录，以便于lua解析器可以正确定位到他们。在我当前的windows系统中，我将其copy到"c:\program files\lua\5.1\clibs\"，这里包含了所有lua可调用的c库。见如下c语言代码和关键性注释：

#include <stdio.h>
#include <string.h>
#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

//待注册的c函数，该函数的声明形式在上面的例子中已经给出。
//需要说明的是，该函数必须以c的形式被导出，因此extern "c"是必须的。
//函数代码和上例相同，这里不再赘述。
extern "c" int add(lua_state* l)
{
    double op1 = lual_checknumber(l,1);
    double op2 = lual_checknumber(l,2);
    lua_pushnumber(l,op1 + op2);
    return 1;
}

extern "c" int sub(lua_state* l)
{
    double op1 = lual_checknumber(l,1);
    double op2 = lual_checknumber(l,2);
    lua_pushnumber(l,op1 - op2);
    return 1;
}

//lual_reg结构体的第一个字段为字符串，在注册时用于通知lua该函数的名字。
//第一个字段为c函数指针。
//结构体数组中的最后一个元素的两个字段均为null，用于提示lua注册函数已经到达数组的末尾。
static lual_reg mylibs[] = {
    {"add", add},
    {"sub", sub},
    {null, null}
};

//该c库的唯一入口函数。其函数签名等同于上面的注册函数。见如下几点说明：
//1. 我们可以将该函数简单的理解为模块的工厂函数。
//2. 其函数名必须为luaopen_xxx，其中xxx表示library名称。lua代码require "xxx"需要与之对应。
//3. 在lual_register的调用中，其第一个字符串参数为模块名"xxx"，第二个参数为待注册函数的数组。
//4. 需要强调的是，所有需要用到"xxx"的代码，不论c还是lua，都必须保持一致，这是lua的约定，
//   否则将无法调用。
extern "c" __declspec(dllexport)
int luaopen_mytestlib(lua_state* l)
{
    const char* libname = "mytestlib";
    lual_register(l,libname,mylibs);
    return 1;
}

见如下lua代码：

 require "mytestlib"  --指定包名称
 
 --在调用时，必须是package.function
 print(mytestlib.add(1.0,2.0))
 print(mytestlib.sub(20.1,19))