一不小心又標題黨了?不好意思哈~
翻看了以前的博客,發下廢話太多了自己都看不下去啊,恩,以後儘量寫得簡潔一些。
本文不涉及lua語法學習,如果有需要,請移步:http://book.luaer.cn/
一.lua堆棧
要理解lua和c++交互,首先要理解lua堆棧。
簡單來說,Lua和C/c++語言通信的主要方法是一個無處不在的虛擬棧。棧的特點是先進後出。
在lua中,lua堆棧就是一個struct,堆棧索引的方式可是是正數也可以是負數,區別是:正數索引1永遠表示棧底,負數索引-1永遠表示棧頂。如圖:
#include
<iostream>
#include
<string.h>
using
namespace std;
extern
C
{
#include
lua.h
#include
lauxlib.h
#include
lualib.h
}
void
main()
{
//1.創建一個state
lua_State
*L = luaL_newstate();
//2.入棧操作
lua_pushstring(L,
I am so cool~);
lua_pushnumber(L,
20
);
//3.取值操作
if
(
lua_isstring(L,
1
)){
//判斷是否可以轉爲string
cout<<lua_tostring(l,
1
)<<endl;
pre=
""
return
=
""
state=
""
><p> </p><p> </p><p>可以簡單理解爲luaL_newstate返回一個指向堆棧的指針,其它看註釋應該能懂了吧。</p>
如果對extern
C不熟悉的可以點擊這裏:http:
//blog.csdn.net/shun_fzll/article/details/39078971。<p> </p><p>其他一些棧操作:</p><p> </p><p> </p><pre
class="brush:java;">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位置的值</pre>
<p> </p>
<p> </p>
<p>lua_settop將棧頂設置爲一個指定的位置,即修改棧中元素的數量。如果值比原棧頂高,則高的部分nil補足,如果值比原棧低,則原棧高出的部分捨棄。</p>
<strong>所以可以用lua_settop(
0
)來清空棧。</strong>
<p> </p>
<h1>三.c++調用lua</h1>
<p><br>
我們經常可以使用lua文件來作配置文件。類似ini,xml等文件配置信息。<br>
現在我們來使用c++來讀取lua文件中的變量,table,函數。</p>
<p><br>
現在有這樣一個hello.lua
文件:</p>
<p> </p>
<pre
class
=
"brush:java;"
>str
= I am so cool
tbl
= {name = shun, id =
20114442
}
function
add(a,b)
return
a + b
end</pre>
<p> </p>
<p> </p>
我們寫一個test.cpp來讀取它:
<p> </p>
<pre
class
=
"brush:java;"
>#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
1
=
""
2
=
""
3
=
""
30
=
""
4
=
""
am=
""
bret=
"lua_pcall(L,0,0,0);"
char
=
""
const
=
""
cout=
""
double
=
""
file=
""
fvalue=
"lua_tonumber(L,"
i=
""
if
=
""
int
=
""
iret=
"lua_pcall(L,"
is=
""
pcall=
""
perrormsg=
""
pre=
""
result=
""
return
=
""
shun=
""
so=
""
state=
""
str=
"<<str.c_str()<<endl;"
string=
""
string:=
""
table=
""
table:=
""
tbl=
""
tbl:name=
"shun"
><p> </p><p> </p>
知道怎麼讀取後,我們來看下如何修改上面代碼中table的值:<p> </p><p> </p><pre
class
=
"brush:java;"
>
//
將需要設置的值設置到棧中
lua_pushstring(L,
我是一個大帥鍋~);
//
將這個值設置到table中(此時tbl在棧的位置爲2)
lua_setfield(L,
2
,
name);</pre>
<p> </p>
<p> </p>
我們還可以新建一個table:
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>
//
創建一個新的table,並壓入棧
lua_newtable(L);
//
往table中設置值
lua_pushstring(L,
Give me a girl friend !);
//將值壓入棧
lua_setfield(L,
-
2
,
str);
//將值設置到table中,並將Give
me a girl friend 出棧</pre>
<p> </p>
<p> </p>
<strong>需要注意的是:堆棧操作是基於棧頂的,就是說它只會去操作棧頂的值。</strong>
<p><br>
舉個比較簡單的例子,函數調用流程是先將函數入棧,參數入棧,然後用lua_pcall調用函數,此時棧頂爲參數,棧底爲函數,所以棧過程大致會是:參數出棧->保存參數->參數出棧->保存參數->函數出棧->調用函數->返回結果入棧。</p>
<p>類似的還有lua_setfield,設置一個表的值,肯定要先將值出棧,保存,再去找表的位置。</p>
<p><br>
再不理解可看如下例子:<br>
</p>
<pre
class
=
"brush:java;"
>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);
//
會將我是一個大帥鍋~出棧</pre>
<br>
另外補充一下:
<p> </p>
<p>lua_getglobal(L,var)會執行兩步操作:
1
.將var放入棧中,
2
.由lua去尋找變量var的值,並將變量var的值返回棧頂(替換var)。<br>
lua_getfield(L,-
1
,name)
的作用等價於 lua_pushstring(L,name) + lua_gettable(L,-
2
)</p>
<p> </p>
<h1>四.lua調用c++</h1>
<p> </p>
<p>我們分三個方法實現它。</p>
<p> </p>
<h2>方法一:直接將模塊寫入lua源碼中</h2>
<p><br>
在lua中調用c/c++,我們可以將函數寫lua.c中,然後重新編譯lua文件。<br>
也許你用的是lua
for
windows集成環境,沒關係,不會編譯lua可以參考這篇:http:
//blog.csdn.net/snlscript/article/details/15533373</p>
<p><br>
編譯好後是這樣子的:(如圖)</p>
<p> </p>
<p><img
alt=
"\"
src="
"
style="
display:
none;
"><img
alt="
加載中...
"
title="
圖片加載中...
"
src="
http:
//www.2cto.com/statics/images/s_nopic.gif"></p>
<p> </p>
<p>然後我們可以在lua.c中加入我們自己的函數。函數要遵循規範(可在lua.h中查看)如下:</p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>typedef
int
(*lua_CFunction) (lua_State *L);</pre>
<p> </p>
<p> </p>
換句話說,所有的函數必須接收一個lua_State作爲參數,同時返回一個整數值。因爲這個函數使用Lua棧作爲參數,所以它可以從棧裏面讀取任意數量和任意類型的參數。而這個函數的返回值則表示函數返回時有多少返回值被壓入Lua棧。(因爲Lua的函數是可以返回多個值的)<br>
<br>
<br>
然後我們在lua.c中加入如下函數:
<p> </p>
<pre
class
=
"brush:java;"
>
//
This is my function
static
int
getTwoVar(lua_State *L)
{
//
向函數棧中壓入2個值
lua_pushnumber(L,
10
);
lua_pushstring(L,hello);
return
2
;
}</pre>
<p> </p>
<p> </p>
在pmain函數中,luaL_openlibs函數後加入以下代碼:
<p> </p>
<pre
class
=
"brush:java;"
>
//註冊函數
lua_pushcfunction(L,
getTwoVar);
//將函數放入棧中
lua_setglobal(L,
getTwoVar);
//設置lua全局變量getTwoVar</pre>
<br>
通過查找lua.h
<p> </p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>/#define
lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))</pre>
<p> </p>
<p> </p>
<p>我們發現之前的註冊函數可以這樣子寫:</p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>lua_register(L,getTwoVar,getTwoVar);</pre>
<p> </p>
<p> </p>
運行,結果如圖:
<p> </p>
<p><img
alt=
"\"
src="
"
style="
display:
none;
"><img
alt="
加載中...
"
title="
圖片加載中...
"
src="
http:
//www.2cto.com/statics/images/s_nopic.gif"></p>
<p> </p>
<p>當然,一般我們不建議去修改別人的代碼,更傾向於自己編寫獨立的c/c++模塊,供lua調用,下面來講講如何實現。</p>
<p> </p>
<h2>方法二:使用靜態依賴的方式</h2>
<p> </p>
<p><br>
1
.新建一個空的win32控制檯工程,記得在vc++目錄中,把lua中的頭文件和lib文件的目錄包含進來,然後->鏈接器->附加依賴項->將lua51.lib和lua5.
1
.lib也包含進來。</p>
<p><br>
2
.在目錄下新建一個avg.lua如下:</p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>avg,
sum = average(
10
,
20
,
30
,
40
,
50
)
print(The
average is , avg)
print(The
sum is , sum)</pre>
<p> </p>
<p> </p>
3
.新建test.cpp如下:
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>#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
;
}</stdio.h></pre>
<p> </p>
<p> </p>
執行一下,我們可以得到結果:
<p> </p>
<p><img
alt=
"\"
src="
"
style="
display:
none;
"><img
alt="
加載中...
"
title="
圖片加載中...
"
src="
http:
//www.2cto.com/statics/images/s_nopic.gif"></p>
<p><br>
大概順序就是:我們在c++中寫一個模塊函數,將函數註冊到lua解釋器中,然後由c++去執行我們的lua文件,然後在lua中調用剛剛註冊的函數。</p>
<p><br>
看上去很彆扭啊有木有。。。接下來介紹一下dll調用方式。</p>
<p> </p>
<h2>方法三:使用dll動態鏈接的方式</h2>
<p> </p>
<p><br>
我們先新建一個dll工程,工程名爲mLualib。(因此最後導出的dll也爲mLualib.dll)</p>
<p><br>
然後編寫我們的c++模塊,以函數爲例,我們先新建一個.h文件和.cpp文件。</p>
<p> </p>
<p>h文件如下:(如果你不是很能明白頭文件的內容,點擊這裏:http:
//blog.csdn.net/shun_fzll/article/details/39078971。)</p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>#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);
//定義導出函數</pre>
<br>
.cpp文件如下:
<p> </p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>#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
}</stdio.h></pre>
<br>
不理解沒關係,我們先編譯它,然後新建一個lua文件,在lua中我們這樣子來調用:<strong>(調用之前記得把dll文件複製到lua文件目錄下)</strong>
<p> </p>
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>require
mLualib
local
ave,sum = ss.average(
1
,
2
,
3
,
4
,
5
)
//參數對應堆棧中的數據
print(ave,sum)
--
3
15
ss.sayHello()
-- hello world!</pre>
<br>
成功調用了有木有?我們看到了輸出信息。<strong>(木有成功你留言,我教你!)</strong><br>
<br>
至此都發生了什麼呢?梳理一下:<br>
<br>
1
.我們編寫了averageFunc求平均值和sayHelloFunc函數,<br>
2
.然後把函數封裝myLib數組裏面,類型必須是luaL_Reg<br>
3
.由luaopen_mLualib函數導出並在lua中註冊這兩個函數。<br>
<br>
那麼爲什麼要這樣子寫呢?實際上當我們在lua中:<br>
<br>
<pre
class
=
"brush:java;"
>require
mLualib</pre>
<p> </p>
<p> </p>
這樣子寫的時候,lua會這麼幹:
<p> </p>
<p> </p>
<pre
class
=
"brush:java;"
>local
path = mLualib.dll
local
f =
package
.loadlib(path,luaopen_mLualib)
-- 返回luaopen_mLualib函數
f()
-- 執行
</pre>
<br>
<strong>所以當我們在編寫一個這樣的模塊的時候,</strong><strong>編寫luaopen_xxx導出函數的時候,xxx最好是和項目名一樣(因爲項目名和dll一樣)</strong>。<br>
<br>
需要注意的是:函數參數裏的lua_State是私有的,每一個函數都有自己的棧。當一個c/c++函數把返回值壓入Lua棧以後,該棧會自動被清空。
<p> </p>
<p> </p>
<h1>五.總結</h1>
<p><br>
這篇文章花了好幾天才整理的,最後總結一下就是:<br>
<br>
lua和c++是通過一個虛擬棧來交互的。</p>
<p>c++調用lua實際上是:由c++先把數據放入棧中,由lua去棧中取數據,然後返回數據對應的值到棧頂,再由棧頂返回c++。</p>
<p>lua調c++也一樣:先編寫自己的c模塊,然後註冊函數到lua解釋器中,然後由lua去調用這個模塊的函數。</p>
<p><br>
</p>
</load></string.h></iostream></pre>
</lua_tostring(l,
1
)<<endl;></string.h></iostream>