Lua和C++交互详细总结
一、Lua堆棧
要理解Lua和C++交互，首先要理解Lua堆棧。
簡單來說，Lua和C/C++語言通信的主要方法是一個無處不在的虛擬棧。棧的特點是先進后出。
在Lua中，Lua堆棧就是一個struct，堆棧索引的方式可是是正數(shù)也可以是負數(shù)，區(qū)別是：正數(shù)索引1永遠表示棧底，負數(shù)索引-1永遠表示棧頂。如圖：
?lua的棧類似于以下的定義, 它是在創(chuàng)建lua_State的時候創(chuàng)建的:
???????????? TValue stack[max_stack_len]? // 欲知內(nèi)情可以查 lstate.c 的stack_init函數(shù)
??? 存入棧的數(shù)據(jù)類型包括數(shù)值, 字符串, 指針, talbe, 閉包等, 下面是一個棧的例子:
??????????
?? 執(zhí)行下面的代碼就可以讓你的lua棧上呈現(xiàn)圖中的情況
lua_pushcclosure(L, func, 0) // 創(chuàng)建并壓入一個閉包 lua_createtable(L, 0, 0)??????? // 新建并壓入一個表 lua_pushnumber(L, 343)????? // 壓入一個數(shù)字 lua_pushstring(L, “mystr”)?? // 壓入一個字符串??? 這里要說明的是, 你壓入的類型有數(shù)值, 字符串, 表和閉包[在c中看來是不同類型的值], 但是最后都是統(tǒng)一用TValue這種數(shù)據(jù)結(jié)構(gòu)來保存的:), 下面用圖簡單的說明一下這種數(shù)據(jù)結(jié)構(gòu):
????
?
??? TValue結(jié)構(gòu)對應(yīng)于lua中的所有數(shù)據(jù)類型, 是一個{值, 類型} 結(jié)構(gòu), 這就lua中動態(tài)類型的實現(xiàn), 它把值和類型綁在一起, 用tt記錄value的類型, value是一個聯(lián)合結(jié)構(gòu), 由Value定義, 可以看到這個聯(lián)合有四個域, 先說明簡單的
??????? p -- 可以存一個指針, 實際上是lua中的light userdata結(jié)構(gòu)
??????? n -- 所有的數(shù)值存在這里, 不管是int , 還是float
??????? b -- Boolean值存在這里, 注意, lua_pushinteger不是存在這里, 而是存在n中, b只存布爾
??????? gc -- 其他諸如table, thread, closure, string需要內(nèi)存管理垃圾回收的類型都存在這里
??????? gc是一個指針, 它可以指向的類型由聯(lián)合體GCObject定義, 從圖中可以看出, 有string, userdata, closure, table, proto, upvalue, thread
??? 從下面的圖可以的得出如下結(jié)論:
??????? 1. lua中, number, boolean, nil, light userdata四種類型的值是直接存在棧上元素里的, 和垃圾回收無關(guān).
??????? 2. lua中, string, table, closure, userdata, thread存在棧上元素里的只是指針, 他們都會在生命周期結(jié)束后被垃圾回收.
?
二、堆棧的操作
因為Lua與C/C++是通過棧來通信，Lua提供了C API對棧進行操作。
我們先來看一個最簡單的例子：
#include <iostream> #include <string.h> using namespace std; extern "C" { #include "lua.h" #include "lauxlib.h" #include "lualib.h" } void main() { //1.創(chuàng)建一個state lua_State *L = luaL_newstate(); //2.入棧操作 lua_pushstring(L, "I am so cool~"); lua_pushnumber(L,20); //3.取值操作 if( lua_isstring(L,1)){ //判斷是否可以轉(zhuǎn)為string cout<<lua_tostring(L,1)<<endl; //轉(zhuǎn)為string并返回 } if( lua_isnumber(L,2)){ cout<<lua_tonumber(L,2)<<endl; } //4.關(guān)閉state lua_close(L); return ; }可以簡單理解為luaL_newstate返回一個指向堆棧的指針，其它看注釋應(yīng)該能懂了吧。
(lua_newstate是核心函數(shù)，要求提供內(nèi)存分配函數(shù)，luaL_newstate是輔助庫函數(shù)，采用默認的內(nèi)存分配函數(shù)。lua_open是5.0時代的產(chǎn)物，5.1是luaL_newstate的宏，5.2里面已經(jīng)沒有了)
其他一些棧操作：
int lua_gettop (lua_State *L); //返回棧頂索引（即棧長度） void lua_settop (lua_State *L, int idx); // void lua_pushvalue (lua_State *L, int idx);//將idx索引上的值的副本壓入棧頂 void lua_remove (lua_State *L, int idx); //移除idx索引上的值 void lua_insert (lua_State *L, int idx); //彈出棧頂元素，并插入索引idx位置 void lua_replace (lua_State *L, int idx); //彈出棧頂元素，并替換索引idx位置的值lua_settop將棧頂設(shè)置為一個指定的位置，即修改棧中元素的數(shù)量。如果值比原棧頂高，則高的部分nil補足，如果值比原棧低，則原棧高出的部分舍棄。所以可以用lua_settop(0)來清空棧。
?
三、C++調(diào)用Lua
我們經(jīng)常可以使用Lua文件來作配置文件。類似ini，xml等文件配置信息。現(xiàn)在我們來使用C++來讀取Lua文件中的變量，table，函數(shù)。
lua和c通信時有這樣的約定: 所有的lua中的值由lua來管理, c++中產(chǎn)生的值lua不知道, 類似表達了這樣一種意思: "如果你(c/c++)想要什么, 你告訴我(lua), 我來產(chǎn)生, 然后放到棧上, 你只能通過api來操作這個值, 我只管我的世界", 這個很重要, 因為:
???????? "如果你想要什么, 你告訴我, 我來產(chǎn)生"就可以保證, 凡是lua中的變量, lua要負責(zé)這些變量的生命周期和垃圾回收, 所以, 必須由lua來創(chuàng)建這些值(在創(chuàng)建時就加入了生命周期管理要用到的簿記信息)
???????? "然后放到棧上, 你只能通過api來操作這個值", lua api給c提供了一套完備的操作界面, 這個就相當(dāng)于約定的通信協(xié)議, 如果lua客戶使用這個操作界面, 那么lua本身不會出現(xiàn)任何"意料之外"的錯誤.
???????? "我只管我的世界"這句話體現(xiàn)了lua和c/c++作為兩個不同系統(tǒng)的分界, c/c++中的值, lua是不知道的, lua只負責(zé)它的世界
現(xiàn)在有這樣一個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.創(chuàng)建Lua狀態(tài) 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.讀取函數(shù) lua_getglobal(L, "add"); // 獲取函數(shù)，壓入棧中 lua_pushnumber(L, 10); // 壓入第一個參數(shù) lua_pushnumber(L, 20); // 壓入第二個參數(shù) int iRet= lua_pcall(L, 2, 1, 0);// 調(diào)用函數(shù)，調(diào)用完成以后，會將返回值壓入棧中，2表示參數(shù)個數(shù)，1表示返回結(jié)果個數(shù)。 if (iRet) // 調(diào)用出錯 { 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.關(guān)閉state lua_close(L); return ; }知道怎么讀取后，我們來看下如何修改上面代碼中table的值：
// 將需要設(shè)置的值設(shè)置到棧中 lua_pushstring(L, "我是一個大帥鍋～"); // 將這個值設(shè)置到table中（此時tbl在棧的位置為2） lua_setfield(L, 2, "name");我們還可以新建一個table：
// 創(chuàng)建一個新的table，并壓入棧 lua_newtable(L); // 往table中設(shè)置值 lua_pushstring(L, "Give me a girl friend !"); //將值壓入棧 lua_setfield(L, -2, "str"); //將值設(shè)置到table中，并將Give me a girl friend 出棧需要注意的是：堆棧操作是基于棧頂?shù)?#xff0c;就是說它只會去操作棧頂?shù)闹怠?/strong>
舉個比較簡單的例子，函數(shù)調(diào)用流程是先將函數(shù)入棧，參數(shù)入棧，然后用lua_pcall調(diào)用函數(shù)，此時棧頂為參數(shù)，棧底為函數(shù)，所以棧過程大致會是：參數(shù)出棧->保存參數(shù)->參數(shù)出棧->保存參數(shù)->函數(shù)出棧->調(diào)用函數(shù)->返回結(jié)果入棧。
類似的還有l(wèi)ua_setfield，設(shè)置一個表的值，肯定要先將值出棧，保存，再去找表的位置。
再不理解可看如下例子：
lua_getglobal(L, "add"); // 獲取函數(shù)，壓入棧中 lua_pushnumber(L, 10); // 壓入第一個參數(shù) lua_pushnumber(L, 20); // 壓入第二個參數(shù) int iRet= lua_pcall(L, 2, 1, 0);// 將2個參數(shù)出棧，函數(shù)出棧，壓入函數(shù)返回結(jié)果 lua_pushstring(L, "我是一個大帥鍋～"); // lua_setfield(L, 2, "name"); // 會將"我是一個大帥鍋～"出棧另外補充一下：
lua_getglobal(L,"var")會執(zhí)行兩步操作：1.將var放入棧中，2.由Lua去尋找變量var的值，并將變量var的值返回棧頂（替換var）。
lua_getfield(L,-1,"name")的作用等價于 lua_pushstring(L,"name") + lua_gettable(L,-2)
lua value 和 c value的對應(yīng)關(guān)系
?| ? | ?????????? c | ???????? lua |
| ???????? nil | ????????? 無 | ?? {value=0, tt = t_nil} |
| ????? boolean | ????? int? 非0, 0 | ?? {value=非0/0， tt = t_boolean} |
| ????? number | ????? int/float等?? 1.5 | ?? {value=1.5, tt = t_number} |
| ?? lightuserdata | ?? void*, int*, 各種*? point | ?? {value=point, tt = t_lightuserdata} |
| ????? string | ???????? char? str[] | ?? {value=gco, tt = t_string}?? gco=TString obj |
| ????? table | ?????????? 無 | ?? {value=gco, tt = t_table}? gco=Table obj |
| ????? userdata | ?????????? 無 | ?? {value=gco, tt = t_udata} gco=Udata obj |
| ????? closure | ?????????? 無 | ?? {value=gco, tt = t_function} gco=Closure obj |
?
可以看出來, lua中提供的一些類型和c中是對應(yīng)的, 也提供一些c中沒有的類型. 其中有一些藥特別的說明一下:
??????? nil值, c中沒有對應(yīng), 但是可以通過lua_pushnil向lua中壓入一個nil值
??????? 注意:?lua_push*族函數(shù)都有"創(chuàng)建一個類型的值并壓入"的語義, 因為lua中所有的變量都是lua中創(chuàng)建并保存的, 對于那些和c中有對應(yīng)關(guān)系的lua類型, lua會通過api傳來的附加參數(shù), 創(chuàng)建出對應(yīng)類型的lua變量放在棧頂, 對于c中沒有對應(yīng)類型的lua類型, lua直接創(chuàng)建出對應(yīng)變量放在棧頂.
?????? 例如:??? lua_pushstring(L, “string”) lua根據(jù)"string"創(chuàng)建一個 TString obj, 綁定到新分配的棧頂元素上
????????????????? lua_pushcclosure(L,func, 0) lua根據(jù)func創(chuàng)建一個 Closure obj, 綁定到新分配的棧頂元素上
????????????????? lua_pushnumber(L,5) lua直接修改新分配的棧頂元素, 將5賦值到對應(yīng)的域
????????????????? lua_createtable(L,0, 0)lua創(chuàng)建一個Tabke obj, 綁定到新分配的棧頂元素上
?
?????? 總之, 這是一個?c value –> lua value的流向, 不管是想把一個簡單的5放入lua的世界, 還是創(chuàng)建一個table, 都會導(dǎo)致
????????????????? 1. 棧頂新分配元素??? 2. 綁定或賦值
??????????????? 還是為了重復(fù)一句話, 一個c value入棧就是進入了lua的世界, lua會生成一個對應(yīng)的結(jié)構(gòu)并管理起來, 從此就不再依賴這個c value
??????? lua value –> c value時, 是通過 lua_to* 族api實現(xiàn), 很簡單, 取出對應(yīng)的c中的域的值就行了, 只能轉(zhuǎn)化那些c中有對應(yīng)值的lua value, 比如table就不能to c value, 所以api中夜沒有提供 lua_totable這樣的接口.
?
四、Lua調(diào)用C++
我們分三個方法實現(xiàn)它。
?
方法一：直接將模塊寫入Lua源碼中
在Lua中調(diào)用C/C++，我們可以將函數(shù)寫lua.c中，然后重新編譯Lua文件。
編譯好后是這樣子的：（如圖）
然后我們可以在lua.c中加入我們自己的函數(shù)。函數(shù)要遵循規(guī)范（可在lua.h中查看）如下：
typedef int (*lua_CFunction) (lua_State *L);換句話說，所有的函數(shù)必須接收一個lua_State作為參數(shù)，同時返回一個整數(shù)值。因為這個函數(shù)使用Lua棧作為參數(shù)，所以它可以從棧里面讀取任意數(shù)量和任意類型的參數(shù)。而這個函數(shù)的返回值則表示函數(shù)返回時有多少返回值被壓入Lua棧。（因為Lua的函數(shù)是可以返回多個值的）
?
然后我們在lua.c中加入如下函數(shù)：
// This is my function static int getTwoVar(lua_State *L) { // 向函數(shù)棧中壓入2個值 lua_pushnumber(L, 10); lua_pushstring(L,"hello"); return 2; } 在pmain函數(shù)中，luaL_openlibs函數(shù)后加入以下代碼： //注冊函數(shù) lua_pushcfunction(L, getTwoVar); //將函數(shù)放入棧中 lua_setglobal(L, "getTwoVar"); //設(shè)置lua全局變量getTwoVar通過查找lua.h
/#define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))我們發(fā)現(xiàn)之前的注冊函數(shù)可以這樣子寫：
lua_register(L,"getTwoVar",getTwoVar);運行，結(jié)果如圖：
當(dāng)然，一般我們不建議去修改別人的代碼，更傾向于自己編寫?yīng)毩⒌腃/C++模塊，供Lua調(diào)用，下面來講講如何實現(xiàn)。
?
方法二：使用靜態(tài)依賴的方式
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) { /* 得到參數(shù)個數(shù) */ int n = lua_gettop(L); double sum = 0; int i; /* 循環(huán)求參數(shù)之和 */ for (i = 1; i <= n; i++) { /* 求和 */ sum += lua_tonumber(L, i); } /* 壓入平均值 */ lua_pushnumber(L, sum / n); /* 壓入和 */ lua_pushnumber(L, sum); /* 返回返回值的個數(shù) */ return 2; } int main ( int argc, char *argv[] ) { /* 初始化Lua */ L = lua_open(); /* 載入Lua基本庫 */ luaL_openlibs(L); /* 注冊函數(shù) */ lua_register(L, "average", average); /* 運行腳本 */ luaL_dofile(L, "avg.lua"); /* 清除Lua */ lua_close(L); /* 暫停 */ printf( "Press enter to exit…" ); getchar(); return 0; }執(zhí)行一下，我們可以得到結(jié)果：
?大概順序就是：我們在C++中寫一個模塊函數(shù)，將函數(shù)注冊到Lua解釋器中，然后由C++去執(zhí)行我們的Lua文件，然后在Lua中調(diào)用剛剛注冊的函數(shù)。
?
看上去很別扭啊有木有。接下來介紹一下dll調(diào)用方式。
?
方法三：使用dll動態(tài)鏈接的方式
我們先新建一個dll工程，工程名為mLualib。（因此最后導(dǎo)出的dll也為mLualib.dll）
?
然后編寫我們的c++模塊，以函數(shù)為例，我們先新建一個.h文件和.cpp文件。
?
h文件如下：（如果你不是很能明白頭文件的內(nèi)容，點擊這里：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);//定義導(dǎo)出函數(shù).cpp文件如下：
#include <stdio.h> #include "mLualib.h" static int averageFunc(lua_State *L) { int n = lua_gettop(L); double sum = 0; int i; /* 循環(huán)求參數(shù)之和 */ for (i = 1; i <= n; i++) sum += lua_tonumber(L, i); lua_pushnumber(L, sum / n); //壓入平均值 lua_pushnumber(L, sum); //壓入和 return 2; //返回兩個結(jié)果 } static int sayHelloFunc(lua_State* L) { printf("hello world!"); return 0; } static const struct luaL_Reg myLib[] = { {"average", averageFunc}, {"sayHello", sayHelloFunc}, {NULL, NULL} //數(shù)組中最后一對必須是{NULL, NULL}，用來表示結(jié)束 }; int luaopen_mLualib(lua_State *L) { luaL_register(L, "ss", myLib); return 1; // 把myLib表壓入了棧中，所以就需要返回1 }不理解沒關(guān)系，我們先編譯它，然后新建一個lua文件，在lua中我們這樣子來調(diào)用：（調(diào)用之前記得把dll文件復(fù)制到lua文件目錄下）
require "mLualib" local ave,sum = ss.average(1,2,3,4,5)//參數(shù)對應(yīng)堆棧中的數(shù)據(jù) print(ave,sum) -- 3 15 ss.sayHello() -- hello world!成功調(diào)用了有木有？我們看到了輸出信息。
?
至此都發(fā)生了什么呢？梳理一下：
1.我們編寫了averageFunc求平均值和sayHelloFunc函數(shù)，
2.然后把函數(shù)封裝myLib數(shù)組里面，類型必須是luaL_Reg
3.由luaopen_mLualib函數(shù)導(dǎo)出并在lua中注冊這兩個函數(shù)。
?
那么為什么要這樣子寫呢？實際上當(dāng)我們在Lua中：
require "mLualib"這樣子寫的時候，Lua會這么干：
local path = "mLualib.dll" local f = package.loadlib(path,"luaopen_mLualib") -- 返回luaopen_mLualib函數(shù) f() -- 執(zhí)行所以當(dāng)我們在編寫一個這樣的模塊的時候，編寫luaopen_xxx導(dǎo)出函數(shù)的時候，xxx最好是和項目名一樣（因為項目名和dll一樣）。
?
需要注意的是：函數(shù)參數(shù)里的lua_State是私有的，每一個函數(shù)都有自己的棧。當(dāng)一個C/C++函數(shù)把返回值壓入Lua棧以后，該棧會自動被清空。
?
五、總結(jié)?
-
Lua和C++是通過一個虛擬棧來交互的。
-
C++調(diào)用Lua實際上是：由C++先把數(shù)據(jù)放入棧中，由Lua去棧中取數(shù)據(jù)，然后返回數(shù)據(jù)對應(yīng)的值到棧頂，再由棧頂返回C++。
-
Lua調(diào)C++也一樣：先編寫自己的C模塊，然后注冊函數(shù)到Lua解釋器中，然后由Lua去調(diào)用這個模塊的函數(shù)。
?
本文不涉及l(fā)ua語法學(xué)習(xí)，如果有需要，請移步：http://book.luaer.cn/
?
==========================================================================
遺留問題：
1.下面是個簡單lua腳本,意圖是生成test.file文件并寫入內(nèi)容
file=io.open("test.file","a+") file:write("ceshi.txt"); io.close(file)? ? 用SciTe運行正常，并生成了想要的文件。采用C++運行該腳本時候總是失敗？
? ? 解答：追查原因，查看堆棧最頂端信息，發(fā)現(xiàn)缺少依賴庫，那理論上在代碼頭部添加?require 'io' 就好了呀，測試發(fā)現(xiàn)無法識別require字符。進一步研究在C代碼里添加代碼 luaL_openlibs(L)，就可以運行成功了。不過仍有問題，C++調(diào)用讀寫數(shù)據(jù)庫的代碼的時候即使添加uaL_openlibs(L)仍然會提示缺少庫。
?
超強干貨來襲 云風(fēng)專訪：近40年碼齡，通宵達旦的技術(shù)人生總結(jié)
以上是生活随笔為你收集整理的Lua和C++交互详细总结的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 使用VS2013编译Lua5.3.2
- 下一篇： QT乱码总结0.Qt乱码产生因素