http://xiaobang185.blog.163.com
在C++中集成Lua腳本
使用Lua作腳本,主要是因爲它小巧玲瓏(體積小,運行快),而且它的語法又比較簡單明瞭。不過,使用LuaAPI將Lua引擎集成到程序中,確實有一些不方便——用落木隨風網友的話來說,就是"就象用匯編"。當然,現在你不用再這麼辛苦了,因爲你可以使用LuaWrapper For C++。使用這個工具,在C++中集成Lua腳本就是輕而易舉的事。你原有的C++函數和類,幾乎不需要任何改變,就可以與Lua腳本共享。
我們接下來,用實例來說明,如何用LuaWrapper來集成Lua腳本到你的程序中去。
1.??創建Lua引擎
LuaWrap lua; 或者 LuaWrap* lua = new LuaWrap;
創建一個LuaWrap對象,就是創建一個Lua腳本引擎。並且根據Lua的特性,你可以創建任意多個Lua引擎,甚至可以分佈在不同的線程當中。
2.??裝載並執行腳本程序
你可以從緩衝區中裝載Lua腳本:
lua.LoadString(
"print('Hello World')"
);
當然,你也可以從文件中裝入,並執行Lua腳本:
Lua.LoadFile("./test.lua");
Lua的腳本,可以是源代碼,也可以經過編譯後的中間代碼。也許你對編譯後的中間代碼更感興趣——如果你不希望讓源代碼赤裸裸的袒露在大家的眼前。
3.??獲取和設置Lua變量
能夠獲取和設置腳本變量的內容,是一個最基本的功能。你可以使用GetGlobal和SetGlobal函數來做到這一點:
(1)??獲取變量:
int a = lua.GetGlobal("a");
LuaTable table = lua.GetGlobal("t");
這裏,<> 裏頭的類型,就是想要的變量的類型。
(2)??設置變量:
lua.SetGlobal("a", a);
lua.SetGlobal("t", table);
4.??調用Lua函數
使用Call函數,就可以很簡單的從你的程序中調用Lua函數:
lua.Call("print", "Hello World");
int sum = lua.Call("add", 2, 3);
這裏,<> 裏頭的類型是返回值的類型。
5.??如何讓Lua也能調用C++的函數
精采的地方來了。假如有下面這樣的一個函數:
int add(int a, int b)
{
return a + b;
}
如果想讓它能夠讓Lua使用,只需將它註冊到Lua引擎當中就可以了:
lua.RegisterFunc("add", int(int,int), add);
這樣,Lua中就可以用直接使用了:
(Lua腳本)sum = add(1, 3)
(*) RegisterFunc的功能,就是讓你把C++的函數註冊到Lua中,供Lua腳本使用。
第一個參數,是想要在Lua中用的函數名。
第二個參數,是C++中函數的原型; C++允許函數重載的,你可以使用函數原型,來選擇需要註冊到Lua引擎中的那個函數。
第三個參數,就是C++中函數的指針了。
6.??如何能讓C++的類在Lua中使用
我們先看看下面這個C++類:
class MyArray
{
??std::vector array;
public:
??void setvalue(int index, double value);
??double getvalue(int index);
??int size();
??const char* ToString();
};
你準備要讓Lua能夠自由訪問並操作這個類。很簡單,你只需增加幾個宏定義就可以了:
class MyArray
{
??std::vector array;
public:
??void setvalue(int index, double value);
??double getvalue(int index);
??int size();
??const char* ToString();
??// 將一個 class 作爲一個 Lua 對象是很容易的,只需要增加以下宏定義。
??DEFINE_TYPENAME("My.array");
??BEGIN_REGLUALIB("array")
??????LUALIB_ITEM_CREATE("new", MyArray )??// 創建MyArray?
??????LUALIB_ITEM_DESTROY("del", MyArray )??// 消除MyArray。
??END_REGLUALIB()
??BEGIN_REGLUALIB_MEMBER()
????LUALIB_ITEM_FUNC("size", int (MyArray*), &MyArray::size)
????LUALIB_ITEM_FUNC("__getindex", double(MyArray*, int), &MyArray::getvalue)??
????LUALIB_ITEM_FUNC("__newindex", void (MyArray*, int, double), &MyArray::setvalue)
????LUALIB_ITEM_FUNC("__tostring", const char* (MyArray*), &MyArray::ToString)
????LUALIB_ITEM_DESTROY("__gc", MyArray ) ??// 垃圾收集時消除對象用。
??END_REGLUALIB_MEMBER()
};
只要有了這些宏定義,這個類就是可以在Lua中使用的類了,我們就可以在Lua中註冊這個類了:
lua.Register()
這樣註冊以後,我們在Lua中就可以使用這個類了:
a = array.new()??-- 創建對象,相當於 a = new Myarray
a[1] = 10??-- 調用__newindex,也就是C++中的 a->setvalue(1, 10)
a[2] = 20??-- 調用__newindex,也就是C++中的 a->setvalue(2, 20)
print(
a,??-- 調用 __tostring,也就是C++中的 a->ToString()
a:size(), -- 相當於C++中的 a->size()
a[1], -- 調用__getindex,也就是C++中的a->getvalue(1)
a[2]) --調用__getindex,也就是C++中的a->getvalue(2)
array.del(a)??-- 清除對象,相當於 delete a
a = nil??-- 清空 a,很象C++中的 a = NULL
當然,你也可以不用del這個對象,而是等待Lua幫你自動進行垃圾回收。在Lua進行垃圾回收時,它會自動調用這個對象的 __gc ,相當於 delete。
那麼,在C++中要創建MyArray對象,並且傳遞給Lua全局變量怎麼辦?就象前面講過的一樣,使用SetGlobal:
MyArray* a = new MyArray;
lua.SetGlobal("a", a);
要獲取該對象,同樣的,應該使用GetGlobal:
MyArray* a = lua.GetGlobal("a");
對於傳遞給Lua的對象,就讓Lua來管理該對象的生存週期好了。如果你非要刪除它的話,你可以使用DelGlobalObject:
lua.DelGlobalObject("a");
不過這麼做的話,你應當明白你在做什麼,因爲在Lua的腳本中,可能已經在多處引用了這個對象了。刪除了其中一個,將導致其它引用對象失效,從而可能引致系統崩潰。
(1)??DEFINE_TYPENAME("My.array");
定義類型的名稱。在Lua中,這個類型名稱是唯一用來識別C++類型的,你必須爲不同的對象給予不同的名稱。
(2)??BEGIN_REGLUALIB("array") … END_REGLUALIB()
你可以爲一個對象定義一個程序庫,"array"就是程序庫的名字。在程序庫中定義的函數是全局函數,在Lua中,使用該函數,需要在函數前加上庫的名字,如:array.new()。通常,程序庫會包含創建對象的方法。如:
LUALIB_ITEM_CREATE("new", MyArray )??// 創建MyArray
這樣子,你才能在Lua中創建MyArray:
a = array.new()
你也可以選擇增加一個刪除對象操作:
LUALIB_ITEM_DESTROY("del", MyArray ) ??// 刪除MyArray
這樣,你就可以直接刪除一個對象了:
array.del(a)
(3)??BEGIN_REGLUALIB_MEMBER() …END_REGLUALIB_MEMBER()
在此處,你可以定義對象的成員函數,也可以重載對象的操作符——是的,就象C++的operator重載。例如:
LUALIB_ITEM_FUNC("__newindex", void (MyArray*, int, double), &MyArray::setvalue)
就是重載 operator[] 操作符。Lua中可重載的操作符還有許多,如:
__getindex:操作符[],支持讀取訪問,如 v = a[10]
__newindex:操作符[],支持賦值訪問,如 a[10] = 1.22
__tostring:將變量轉換成字串__add:等同於operator +
__add:操作符 +
__sub:操作符 –
__mul:操作符 ×
__div:操作符 ÷
__pow:操作符 ^ (乘方)
__unm:一元操作符 –
__concat:操作符 .. (字符串連接)
__eq:操作符 == (a ~= b等價於 not a == b)
__lt:操作符 < (a > b 等價於 b < a)
__le:操作符 <= (a >= b 等價於 b <= a,要注意的是,如果沒有定義"__le",則Lua將會嘗試將a<=b 轉換成 not (b < a) )
__gc:在垃圾回收時調用此函數,相當於C++的析構函數。強烈建議定義此操作符,以免造成內存泄漏等情況。比如:
LUALIB_ITEM_DESTROY("__gc", MyArray ) ??// 垃圾收集時消除對象用。
(注) 這裏要說明一下,在lua中,訪問索引操作符是__index,不是__getindex,在luaWrapper庫中,爲了方便使用,將其映射爲__getindex,同時,對__index的定義將會被忽略。
就這麼簡單。假如你已經有現成的類,而你沒有修改該類的權力,如何將其加入到Lua中呢?答案就是,繼承它,將把派生類加入到Lua中。
結束語
LuaWrapper 需要用到boost庫的支持:boost/type_traits.hpp, boost/function.hpp, boost/bind.hpp,它使用了C++的模板部份特化,因此,C++編譯器如果不支持此特性,將無法編譯。目前支持此特性的編譯器已經有很多。在 VisualStudo產品系列中,只有VC7.1能支持此特性,因此,您如果正在使用VisualStudio,請確認你用的是 VisualStudio2003。
如果你覺得 LuaWrapper For C++ 能夠幫助你,我會感覺很榮幸。我很願意將這個程序庫分享給大家。順便一提的是,如果你在使用過程中發現BUG,或是有好的建議,希望您能與我聯繫。你在使 用過程中,請不要刪除文件中的署名信息;如果你修改了程序庫,請您在修改的文件中加入您的修改說明。當然,我會非常歡迎您能將修改後的程序回饋給我。我會 繼續優化並完善它。
需要下載 LuaWrapper For C++,請到 http://www.d2-life.com/LBS/blogview.asp?logID=41
Description:
Lua腳本語法說明(增加lua5.1部份特性)
Lua 的語法比較簡單,學習起來也比較省力,但功能卻並不弱。
所以,我只簡單的歸納一下Lua的一些語法規則,使用起來方便好查就可以了。估計看完了,就懂得怎麼寫Lua程序了。
在Lua中,一切都是變量,除了關鍵字。
I. 首先是註釋
寫一個程序,總是少不了註釋的。
在Lua中,你可以使用單行註釋和多行註釋。
單行註釋中,連續兩個減號"--"表示註釋的開始,一直延續到行末爲止。相當於C++語言中的"//"。
多行註釋中,由"--[["表示註釋開始,並且一直延續到"]]"爲止。這種註釋相當於C語言中的"/*...*/"。在註釋當中,"[["和"]]" 是可以嵌套的(在lua5.1中,中括號中間是可以加若干個"="號的,如 [==[ ... ]==]),見下面的字符串表示說明。
II. Lua編程
經典的"Hello world"的程序總是被用來開始介紹一種語言。在Lua中,寫一個這樣的程序很簡單:
print("Hello world")
在Lua中,語句之間可以用分號";"隔開,也可以用空白隔開。一般來說,如果多個語句寫在同一行的話,建議總是用分號隔開。
Lua 有好幾種程序控制語句,如:
控制語句 | 格式 | 示例 |
If | if 條件 then ... elseif 條件 then ... else ... end |
if 1+1=2 then print("true") elseif 1+2~=3 then print("true") else print("false") end |
While | while 條件 do ... end |
while 1+1~=2 do print("true") end |
Repeat | repeat ... until 條件 |
repeat print("Hello") until 1+1~=2 |
For | for 變量=初值, 終點值, 步進 do ... end |
for i = 1, 10, 2 do print(i) end |
For | for 變量1, 變量2, ... 變量n in 表或枚舉函數 do ... end |
for a,b in mylist do print(a, b) end |
注意一下,for的循環變量總是隻作用於for的局部變量;當省略步進值時,for循環會使用1作爲步進值。
使用break可以用來中止一個循環。
相對C語言來說,Lua有幾個地方是明顯不同的,所以面要特別注意一下:
.語句塊
語句塊在C中是用"{"和"}"括起來的,在Lua中,它是用do 和 end 括起來的。比如:
do print("Hello") end
可以在 函數 中和 語句塊 中定局部變量。
.賦值語句
賦值語句在Lua被強化了。它可以同時給多個變量賦值。
例如:
a,b,c,d=1,2,3,4
甚至是:
a,b=b,a -- 多麼方便的交換變量功能啊。
在默認情況下,變量總是認爲是全局的。假如需要定義局部變量,則在第一次賦值的時候,需要用local說明。比如:
local a,b,c = 1,2,3 -- a,b,c都是局部變量
.數值運算
和C語言一樣,支持 +, -, *, /。但Lua還多了一個"^"。這表示指數乘方運算。比如2^3 結果爲8, 2^4結果爲16。
連接兩個字符串,可以用".."運處符。如:
"This a " .. "string." -- 等於 "this a string"
.比較運算
比較符號 | < | > | <= | >= | == | ~= |
含義 | 小於 | 大於 | 小於或等於 | 大於或等於 | 相等 | 不相等 |
所有這些操作符總是返回true或false。
對於Table,Function和Userdata類型的數據,只有 == 和 ~=可以用。相等表示兩個變量引用的是同一個數據。比如:
a={1,2}
b=a
print(a==b, a~=b) --輸出 true, false
a={1,2}
b={1,2}
print(a==b, a~=b) --輸出 false, true
.邏輯運算
and, or, not
其中,and 和 or 與C語言區別特別大。
在這裏,請先記住,在Lua中,只有false和nil才計算爲false,其它任何數據都計算爲true,0也是true!
and 和 or的運算結果不是true和false,而是和它的兩個操作數相關。
a and b:如果a爲false,則返回a;否則返回b
a or b:如果 a 爲true,則返回a;否則返回b
舉幾個例子:
print(4 and 5) --輸出 5
print(nil and 13) --輸出 nil
print(false and 13) --輸出 false
print(4 or 5) --輸出 4
print(false or 5) --輸出 5
在Lua中這是很有用的特性,也是比較令人混洧的特性。
我們可以模擬C語言中的語句:x = a? b : c,在Lua中,可以寫成:x = a and b or c。
最有用的語句是: x = x or v,它相當於:if not x then x = v end 。
.運算符優先級,從低到高順序如下:
or
and < > <= >= ~= == .. (字符串連接) + - * / % not #(lua5.1 取長度運算) - (一元運算) ^ |
III. 關鍵字
關鍵字是不能做爲變量的。Lua的關鍵字不多,就以下幾個:
and | break | do | else | elseif | |
end | false | for | function | if | |
in | local | nil | not | or | |
repeat | return | then | true | until | while |
IV. 變量類型
怎麼確定一個變量是什麼類型的呢?大家可以用type()函數來檢查。Lua支持的類型有以下幾種:
Nil | 空值,所有沒有使用過的變量,都是nil。nil既是值,又是類型。 |
Boolean | 布爾值,只有兩個有效值:true和false |
Number | 數值,在Lua裏,數值相當於C語言的double |
String | 字符串,如果你願意的話,字符串是可以包含"/0"字符的(這和C語言總是以"/0"結尾是不一樣的) |
Table | 關係表類型,這個類型功能比較強大,請參考後面的內容。 |
Function | 函數類型,不要懷疑,函數也是一種類型,也就是說,所有的函數,它本身就是一個變量。 |
Userdata | 嗯,這個類型專門用來和Lua的宿主打交道的。宿主通常是用C和C++來編寫的,在這種情況下,Userdata可以是宿主的任意數據類型,常用的有Struct和指針。 |
Thread | 線程類型,在Lua中沒有真正的線程。Lua中可以將一個函數分成幾部份運行。如果感興趣的話,可以去看看Lua的文檔。
現在回過頭來看看,倒覺得不是線程類型。反而象是用來做遍歷的,象是Iterator函數。 如: function range(n) local i = 0 while(i < n) do coroutine.yield( i ) i = i + 1 end end 可惜的是要繼續運行,需要coroutine.resume函數,有點雞肋。請指教。 |
V. 變量的定義
所有的語言,都要用到變量。在Lua中,不管在什麼地方使用變量,都不需要聲明,並且所有的這些變量總是全局變量,除非我們在前面加上"local"。這一點要特別注意,因爲我們可能想在函數裏使用局部變量,卻忘了用local來說明。
至於變量名字,它是大小寫相關的。也就是說,A和a是兩個不同的變量。
定義一個變量的方法就是賦值。"="操作就是用來賦值的
我們一起來定義幾種常用類型的變量吧。
A. Nil
正如前面所說的,沒有使用過的變量的值,都是Nil。有時候我們也需要將一個變量清除,這時候,我們可以直接給變量賦以nil值。如:
var1=nil -- 請注意 nil 一定要小寫
B. Boolean
布爾值通常是用在進行條件判斷的時候。布爾值有兩種:true 和 false。在Lua中,只有false和nil才被計算爲false,而所有任何其它類型的值,都是true。比如0,空串等等,都是true。不要被 C語言的習慣所誤導,0在Lua中的的確確是true。你也可以直接給一個變量賦以Boolean類型的值,如:
theBoolean = true
C. Number
在Lua中,是沒有整數類型的,也不需要。一般情況下,只要數值不是很大(比如不超過100,000,000,000,000),是不會產生舍入誤差的。在WindowsXP能跑的當今主流PC上,實數的運算並不比整數慢。
實數的表示方法,同C語言類似,如:
4 0.4 4.57e-3 0.3e12 5e+20
D. String
字符串,總是一種非常常用的高級類型。在Lua中,我們可以非常方便的定義很長很長的字符串。
字符串在Lua中有幾種方法來表示,最通用的方法,是用雙引號或單引號來括起一個字符串的,如:
"That's go!"
或
'Hello world!'
和C語言相同的,它支持一些轉義字符,列表如下:
/a bell
/b back space
/f form feed
/n newline
/r carriage return
/t horizontal tab
/v vertical tab
// backslash
/" double quote
/" single quote
/[ left square bracket
/] right square bracket
由於這種字符串只能寫在一行中,因此,不可避免的要用到轉義字符。加入了轉義字符的串,看起來實在是不敢恭維,比如:
"one line/nnext line/n/"in quotes/", "in quotes""
一大堆的"/"符號讓人看起來很倒胃口。如果你與我有同感,那麼,我們在Lua中,可以用另一種表示方法:用"[["和"]]"將多行的字符串括起來。(lua5.1: 中括號中間可以加入若干個"="號,如 [==[ ... ]==],詳見下面示例)
示例:下面的語句所表示的是完全相同的字符串:
a = 'alo/n123"'
a = "alo/n123/""
a = '/97lo/10/04923"'
a = [[alo
123"]]
a = [==[
alo
123"]==]
值得注意的是,在這種字符串中,如果含有單獨使用的"[["或"]]"就仍然得用"/["或"/]"來避免歧義。當然,這種情況是極少會發生的。
E. Table
關係表類型,這是一個很強大的類型。我們可以把這個類型看作是一個數組。只是C語言的數組,只能用正整數來作索引;在Lua中,你可以用任意類型來 作數組的索引,除了nil。同樣,在C語言中,數組的內容只允許一種類型;在Lua中,你也可以用任意類型的值來作數組的內容,除了nil。
Table的定義很簡單,它的主要特徵是用"{"和"}"來括起一系列數據元素的。比如:
T1 = {} -- 定義一個空表
T1[1]=10 -- 然後我們就可以象C語言一樣來使用它了。
T1["John"]={Age=27, Gender="Male"}
這一句相當於:
T1["John"]={} -- 必須先定義成一個表,還記得未定義的變量是nil類型嗎
T1["John"]["Age"]=27
T1["John"]["Gender"]="Male"
當表的索引是字符串的時候,我們可以簡寫成:
T1.John={}
T1.John.Age=27
T1.John.Gender="Male"
或
T1.John{Age=27, Gender="Male"}
這是一個很強的特性。
在定義表的時候,我們可以把所有的數據內容一起寫在"{"和"}"之間,這樣子是非常方便,而且很好看。比如,前面的T1的定義,我們可以這麼寫:
T1=
{
10, -- 相當於 [1] = 10
[100] = 40,
John= -- 如果你原意,你還可以寫成:["John"] =
{
Age=27, -- 如果你原意,你還可以寫成:["Age"] =27
Gender=Male -- 如果你原意,你還可以寫成:["Gender"] =Male
},
20 -- 相當於 [2] = 20
}
看起來很漂亮,不是嗎?我們在寫的時候,需要注意三點:
第一,所有元素之間,總是用逗號","隔開;
第二,所有索引值都需要用"["和"]"括起來;如果是字符串,還可以去掉引號和中括號;
第三,如果不寫索引,則索引就會被認爲是數字,並按順序自動從1往後編;
表類型的構造是如此的方便,以致於常常被人用來代替配置文件。是的,不用懷疑,它比ini文件要漂亮,並且強大的多。
F. Function
函數,在Lua中,函數的定義也很簡單。典型的定義如下:
function add(a,b) -- add 是函數名字,a和b是參數名字
return a+b -- return 用來返回函數的運行結果
end
請注意,return語言一定要寫在end之前。假如我們非要在中間放上一句return,那麼就應該要寫成:do return end。
還記得前面說過,函數也是變量類型嗎?上面的函數定義,其實相當於:
add = function (a,b) return a+b end
當重新給add賦值時,它就不再表示這個函數了。我們甚至可以賦給add任意數據,包括nil (這樣,賦值爲nil,將會把該變量清除)。Function是不是很象C語言的函數指針呢?
和C語言一樣,Lua的函數可以接受可變參數個數,它同樣是用"..."來定義的,比如:
function sum (a,b,)
如果想取得...所代表的參數,可以在函數中訪問arg局部變量(表類型)得到 (lua5.1: 取消arg,並直接用"..."來代表可變參數了,本質還是arg)。
如 sum(1,2,3,4)
則,在函數中,a = 1, b = 2, arg = {3, 4} (lua5.1: a = 1, b = 2, ... = {3, 4})
更可貴的是,它可以同時返回多個結果,比如:
function s()
return 1,2,3,4
end
a,b,c,d = s() -- 此時,a = 1, b = 2, c = 3, d = 4
前面說過,表類型可以擁有任意類型的值,包括函數!因此,有一個很強大的特性是,擁有函數的表,哦,我想更恰當的應該說是對象吧。Lua可以使用面向對象編程了。不信?舉例如下:
t =
{
Age = 27
add = function(self, n) self.Age = self.Age+n end
}
print(t.Age) -- 27
t.add(t, 10)
print(t.Age) -- 37
不過,t.add(t,10) 這一句實在是有點土對吧?沒關係,在Lua中,我們可以簡寫成:
t:add(10) -- 相當於 t.add(t,10)
G. Userdata 和 Thread
這兩個類型的話題,超出了本文的內容,就不打算細說了。