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去調用這個模塊的函數。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章