【lua学习】Lua中调用C函数

　Lua利用一个虚拟的堆栈来给C传递值或从C获取值。每当Lua调用C函数，都会获得一个新的堆栈，该堆栈初始包含所有的调用C函数所需要的参数值（Lua传给C函数的调用实参），并且C函数执行完毕后，会把返回值压入这个栈（Lua从中拿到C函数调用结果）。
　于此相关的C API有几个比较重要的定义如下：

（1）typedef struct lua_State lua_State;

　lua虚拟机（或叫解释器），可以理解为一个thread，和一个完整的Lua虚拟环境的执行状态。

（2）typedef int (*lua_CFunction) (lua_State *L);

能够被Lua调用的C函数都必须是这种规则。函数的返回的int值表示C函数返回值的个数。

（3）void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n);

将一个C闭包压栈；
首先将upvalues依次压栈，然后调用该函数，将c函数压栈，并将n个upvalues出栈；
　　参数fn：C函数指针
　　参数n：函数关联的upvalue的个数。

（4）void lua_pushcfunction (lua_State *L, lua_CFunction f);

将C函数压栈；
接收一个C函数的指针参数，然后将一个Lua.function类型的对象压栈。

（5）void lua_register (lua_State *L, const char *name, lua_CFunction f);

注册C函数为一个全局变量；

#define lua_register(L,n,f) (lua_pushcfunction(L, f), lua_setglobal(L, n))

（6）void luaL_setfuncs (lua_State *L, const luaL_Reg *l, int nup);

注册函数到栈顶的表中；
　　参数l：luaL_Reg列表，记录了要注册的函数信息，注意，该列表以{NULL, NULL}结尾；
　　nup参数：upvalue的个数，如果不为0，则注册的所有函数都共享这些upvalues；
　　先将table压栈，然后将upvalues依次压栈，然后调用该函数进行函数注册。注册完毕后upvalues会出栈。
　　注意：luaL_register函数已经不再使用，取而代之的是luaL_setfuncs，因为该函数不会创建全局变量。

typedef struct luaL_Reg { const char *name; lua_CFunction func; } luaL_Reg;

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函数作为应用程序的一部分（文件名为luavinvokec.cpp）

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

编译：

g++ luavinvokec.c -o luvinvokec -llua

运行结果：

2. C函数库成为Lua的模块（文件名为mytestlib.c）

将包含C函数的代码生成库文件，如Linux的so，或Windows的DLL，同时拷贝到Lua代码所在的当前目录，或者是LUA_CPATH环境变量所指向的目录，以便于Lua解析器可以正确定位到他们。这里包含了所有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" 
int luaopen_mytestlib(lua_State* L) 
{
    const char* libName = "mytestlib";
    luaL_register(L,libName,mylibs);
    return 1;
}

编译：

g++ mytestlib.c -fPIC -shared -o mytestlib.so

Lua代码如下（test.lua）：

require "mytestlib"  --指定包名称

--在调用时，必须是package.function
print(mytestlib.add(1.0,2.0))
print(mytestlib.sub(20.1,19))

或者如下：

local m = require "mytestlib"  --指定包名称

--在调用时，必须是package.function
print(m.add(1.0,2.0))
print(m.sub(20.1,19))

运行结果如下：

注意：上面生成的mytestlib.so和lua文件（test.lua）放在同一个目录下面。

参考：https://www.cnblogs.com/sifenkesi/p/3876745.html