lua和c++的交互

https://www.cnblogs.com/sevenyuan/p/4511808.html

C++调用Lua

我们经常可以使用Lua文件来作配置文件。类似ini，xml等文件配置信息。现在我们来使用C++来读取Lua文件中的变量，table，函数。
 lua和c通信时有这样的约定: 所有的lua中的值由lua来管理, c++中产生的值lua不知道, 
 类似表达了这样一种意思: "如果你(c/c++)想要什么, 你告诉我(lua), 我来产生, 然后放到栈上, 你只能通过api来操作这个值, 我只管我的世界",
  这个很重要, 因为:

"如果你想要什么, 你告诉我, 我来产生"就可以保证, 凡是lua中的变量, lua要负责这些变量的生命周期和垃圾回收, 
 所以, 必须由lua来创建这些值(在创建时就加入了生命周期管理要用到的簿记信息)

"然后放到栈上, 你只能通过api来操作这个值", lua api给c提供了一套完备的操作界面, 这个就相当于约定的通信协议, 
如果lua客户使用这个操作界面, 那么lua本身不会出现任何"意料之外"的错误.

"我只管我的世界"这句话体现了lua和c/c++作为两个不同系统的分界, c/c++中的值, lua是不知道的, lua只负责它的世界

--------------------------------------------
现在有这样一个hello.lua 文件：

str = "I am so cool"  
tbl = {name = "shun", id = 20114442}  
function add(a,b)  
    return a + b  
end
--------------------------------------------
============================================
我们写一个test.cpp来读取它：
---------------------------------------------------------------
#include <iostream>  
#include <string.h>  
using namespace std;  

extern "C"  
{  
    #include "lua.h"  
    #include "lauxlib.h"  
    #include "lualib.h"  
}  
void main()  
{  
    //1.创建Lua状态  
    lua_State *L = luaL_newstate();  
    if (L == NULL)  
    {  
        return ;  
    }  

    //2.加载Lua文件  
    int bRet = luaL_loadfile(L,"hello.lua");  
    if(bRet)  
    {  
        cout<<"load file error"<<endl;  
        return ;  
    }  

    //3.运行Lua文件  
    bRet = lua_pcall(L,0,0,0);  
    if(bRet)  
    {  
        cout<<"pcall error"<<endl;  
        return ;  
    }  

    //4.读取变量  
    lua_getglobal(L,"str");  
    string str = lua_tostring(L,-1);  
    cout<<"str = "<<str.c_str()<<endl;        //str = I am so cool~  

    //5.读取table  
    lua_getglobal(L,"tbl");   
    lua_getfield(L,-1,"name");  
    str = lua_tostring(L,-1);  
    cout<<"tbl:name = "<<str.c_str()<<endl; //tbl:name = shun  

    //6.读取函数  
    lua_getglobal(L, "add");        // 获取函数，压入栈中  
    lua_pushnumber(L, 10);          // 压入第一个参数  
    lua_pushnumber(L, 20);          // 压入第二个参数  
    int iRet= lua_pcall(L, 2, 1, 0);// 调用函数，调用完成以后，会将返回值压入栈中，2表示参数个数，1表示返回结果个数。  
    if (iRet)                       // 调用出错  
    {  
        const char *pErrorMsg = lua_tostring(L, -1);  
        cout << pErrorMsg << endl;  
        lua_close(L);  
        return ;  
    }  
    if (lua_isnumber(L, -1))        //取值输出  
    {  
        double fValue = lua_tonumber(L, -1);  
        cout << "Result is " << fValue << endl;  
    }  

    //至此，栈中的情况是：  
    //=================== 栈顶 ===================   
    //  索引  类型      值  
    //   4   int：      30   
    //   3   string：   shun   
    //   2   table:     tbl  
    //   1   string:    I am so cool~  
    //=================== 栈底 ===================   

    //7.关闭state  
    lua_close(L);  
    return ;  
}
----------------------------------------------------------------------

==========================================================================
==========================================================================

举个比较简单的例子，函数调用流程是先将函数入栈，参数入栈，然后用lua_pcall调用函数，此时栈顶为参数，栈底为函数，
所以栈过程大致会是：参数出栈->保存参数->参数出栈->保存参数->函数出栈->调用函数->返回结果入栈。

类似的还有lua_setfield，设置一个表的值，肯定要先将值出栈，保存，再去找表的位置。

lua_getglobal(L, "add");        // 获取函数，压入栈中  
lua_pushnumber(L, 10);          // 压入第一个参数  
lua_pushnumber(L, 20);          // 压入第二个参数  
int iRet= lua_pcall(L, 2, 1, 0);// 将2个参数出栈，函数出栈，压入函数返回结果  

lua_pushstring(L, "我是一个大帅锅～");  //   
lua_setfield(L, 2, "name");             // 会将"我是一个大帅锅～"出栈




===========================================================================
lua中调用c++

1.方法一 : 在Lua中调用C/C++，我们可以将函数写lua.c中，然后重新编译Lua文件

    然后我们可以在lua.c中加入我们自己的函数。函数要遵循规范（可在lua.h中查看）如下：

    typedef int (*lua_CFunction) (lua_State *L);
    换句话说，所有的函数必须接收一个lua_State作为参数，同时返回一个整数值。因为这个函数使用Lua栈作为参数，
    所以它可以从栈里面读取任意数量和任意类型的参数。而这个函数的返回值则表示函数返回时有多少返回值被压入Lua栈。（因为Lua的函数是可以返回多个值的）
    然后我们在lua.c中加入如下函数：


    // This is my function  
    static int getTwoVar(lua_State *L)  
    {  
        // 向函数栈中压入2个值  
        lua_pushnumber(L, 10);  
        lua_pushstring(L,"hello");    
        return 2;  
    }  

    在pmain函数中，luaL_openlibs函数后加入以下代码：
    //注册函数  
    lua_pushcfunction(L, getTwoVar); //将函数放入栈中  
    lua_setglobal(L, "getTwoVar");   //设置lua全局变量getTwoVar

    通过查找lua.h
    /#define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
    我们发现之前的注册函数可以这样子写：
    lua_register(L,"getTwoVar",getTwoVar);

2方法二：使用静态依赖的方式

    1. 新建一个空的win32控制台工程，记得在vc++目录中，把lua中的头文件和lib文件的目录包含进来，然后->链接器->附加依赖项->将lua51.lib和lua5.1.lib也包含进来。

    2. 在目录下新建一个avg.lua如下：
    avg, sum = average(10, 20, 30, 40, 50)  
    print("The average is ", avg)  
    print("The sum is ", sum)

    3.新建test.cpp如下：
    #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;  
    }
大概顺序就是：我们在C++中写一个模块函数，将函数注册到Lua解释器中，然后由C++去执行我们的Lua文件，然后在Lua中调用刚刚注册的函数。



方法三：使用dll动态链接的方式
    我们先新建一个dll工程，工程名为mLualib。（因此最后导出的dll也为mLualib.dll） 
    然后编写我们的c++模块，以函数为例，我们先新建一个.h文件和.cpp文件。

    -------------------------------------------------------------------------------------------------------------------------
    h文件如下：（如果你不是很能明白头文件的内容，点击这里：http://blog.csdn.net/shun_fzll/article/details/39078971。）
    #pragma once  
    extern "C" {  
    #include "lua.h"  
    #include "lualib.h"  
    #include "lauxlib.h"  
    }      
    #ifdef LUA_EXPORTS  
    #define LUA_API __declspec(dllexport)  
    #else  
    #define LUA_API __declspec(dllimport)  
    #endif  

    extern "C" LUA_API int luaopen_mLualib(lua_State *L);//定义导出函数
    -------------------------------------------------------------------------------------------------------------------------
    -------------------------------------------------------------------------------------------------------------------------
    cpp文件如下：


    #include <stdio.h>  
    #include "mLualib.h"  
    static int averageFunc(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;                       //返回两个结果  
    }  

    static int sayHelloFunc(lua_State* L)  
    {  
        printf("hello world!");  
        return 0;  
    }  

    static const struct luaL_Reg myLib[] =   
    {  
        {"average", averageFunc},  
        {"sayHello", sayHelloFunc},  
        {NULL, NULL}       //数组中最后一对必须是{NULL, NULL}，用来表示结束      
    };  

    int luaopen_mLualib(lua_State *L)  
    {  
        luaL_register(L, "ss", myLib);  
        return 1;       // 把myLib表压入了栈中，所以就需要返回1  
    }

    不理解没关系，我们先编译它，然后新建一个lua文件，在lua中我们这样子来调用：（调用之前记得把dll文件复制到lua文件目录下）

    require "mLualib"  
    local ave,sum = ss.average(1,2,3,4,5)//参数对应堆栈中的数据  
    print(ave,sum)  -- 3 15  
    ss.sayHello()   -- hello world!
    成功调用了有木有？我们看到了输出信息。



    至此都发生了什么呢？梳理一下：

    1.我们编写了averageFunc求平均值和sayHelloFunc函数，

    2.然后把函数封装myLib数组里面，类型必须是luaL_Reg

    3.由luaopen_mLualib函数导出并在lua中注册这两个函数。



那么为什么要这样子写呢？实际上当我们在Lua中：

require "mLualib"
这样子写的时候，Lua会这么干：

local path = "mLualib.dll"    
local f = package.loadlib(path,"luaopen_mLualib")   -- 返回luaopen_mLualib函数  
f()                                                 -- 执行
所以当我们在编写一个这样的模块的时候，编写luaopen_xxx导出函数的时候，xxx最好是和项目名一样（因为项目名和dll一样）。



需要注意的是：函数参数里的lua_State是私有的，每一个函数都有自己的栈。当一个C/C++函数把返回值压入Lua栈以后，该栈会自动被清空。



五、总结 

Lua和C++是通过一个虚拟栈来交互的。

C++调用Lua实际上是：由C++先把数据放入栈中，由Lua去栈中取数据，然后返回数据对应的值到栈顶，再由栈顶返回C++。

Lua调C++也一样：先编写自己的C模块，然后注册函数到Lua解释器中，然后由Lua去调用这个模块的函数。