在C++中整合Lua指令碼

為什麼要用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，或是有好的建議，希望您能與我聯絡。你在使用過程中，請不要刪除檔案中的署名資訊;如果你修改了程式庫，請您在修改的檔案中加入您的修改說明。當然，我會非常歡迎您能將修改後的程式回饋給我。我會繼續最佳化並完善它。