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 = }  
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,,,);  
    if(bRet)  
    {  
        cout<<"pcall error"<<endl;  
        return ;  
    }  

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

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

    //6.讀取函數  
    lua_getglobal(L, "add");        // 擷取函數，壓入棧中  
    lua_pushnumber(L, );          // 壓入第一個參數  
    lua_pushnumber(L, );          // 壓入第二個參數  
    int iRet= lua_pcall(L, , , );// 調用函數，調用完成以後，會将傳回值壓入棧中，2表示參數個數，1表示傳回結果個數。  
    if (iRet)                       // 調用出錯  
    {  
        const char *pErrorMsg = lua_tostring(L, -);  
        cout << pErrorMsg << endl;  
        lua_close(L);  
        return ;  
    }  
    if (lua_isnumber(L, -))        //取值輸出  
    {  
        double fValue = lua_tonumber(L, -);  
        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, );          // 壓入第一個參數  
lua_pushnumber(L, );          // 壓入第二個參數  
int iRet= lua_pcall(L, , , );// 将2個參數出棧，函數出棧，壓入函數傳回結果  

lua_pushstring(L, "我是一個大帥鍋～");  //   
lua_setfield(L, , "name");             // 會将"我是一個大帥鍋～"出棧




===========================================================================
lua中調用c++

方法一 : 在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, );  
        lua_pushstring(L,"hello");    
        return ;  
    }  

    在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);

方法二：使用靜态依賴的方式

     建立一個空的win32控制台工程，記得在vc++目錄中，把lua中的頭檔案和lib檔案的目錄包含進來，然後->連結器->附加依賴項->将lua51.lib和lua5.lib也包含進來。

     在目錄下建立一個avg.lua如下：
    avg, sum = average(, , , , )  
    print("The average is ", avg)  
    print("The sum is ", sum)

    建立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 = ;  
        int i;  

        /* 循環求參數之和 */  
        for (i = ; i <= n; i++)  
        {  
            /* 求和 */  
            sum += lua_tonumber(L, i);  
        }  
        /* 壓入平均值 */  
        lua_pushnumber(L, sum / n);  
        /* 壓入和 */  
        lua_pushnumber(L, sum);  
        /* 傳回傳回值的個數 */  
        return ;  
    }  

    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 ;  
    }
大概順序就是：我們在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 = ;  
        int i;  

        /* 循環求參數之和 */  
        for (i = ; i <= n; i++)  
            sum += lua_tonumber(L, i);  

        lua_pushnumber(L, sum / n);     //壓入平均值  
        lua_pushnumber(L, sum);         //壓入和  

        return ;                       //傳回兩個結果  
    }  

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

    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 ;       // 把myLib表壓入了棧中，是以就需要傳回1  
    }

    不了解沒關系，我們先編譯它，然後建立一個lua檔案，在lua中我們這樣子來調用：（調用之前記得把dll檔案複制到lua檔案目錄下）

    require "mLualib"  
    local ave,sum = ss.average(,,,,)//參數對應堆棧中的資料  
    print(ave,sum)  --    
    ss.sayHello()   -- hello world!
    成功調用了有木有？我們看到了輸出資訊。



    至此都發生了什麼呢？梳理一下：

    我們編寫了averageFunc求平均值和sayHelloFunc函數，

    然後把函數封裝myLib數組裡面，類型必須是luaL_Reg

    由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去調用這個子產品的函數。