使用Lua來擴(kuò)展C++程序的方法

 介紹

如果用戶能夠通過一些腳本語言來修改應(yīng)用本身的行為，那么許多應(yīng)用可以變得更適合用戶使用。一些商業(yè)應(yīng)用就提供了此類便利。例如 Microsoft Office 的 VBA 腳本編程或在視頻游戲 World of Warcraft 中使用 Lua 。腳本語言把應(yīng)用作為一個(gè)平臺提供一系列終端用戶可以獲得并操控的服務(wù)。

做為嵌入到程序中的語言，我們有很多可用的選擇：開源和不開源的腳本引擎，或者可以從頭開始創(chuàng)建一個(gè)?，F(xiàn)在，最為熟知的腳本語言是JavaScript，Lua和Python，還有很多其它的語言等等。在Microsoft Windows平臺上 嵌入腳本引擎的一般方法是使用一個(gè) 包含腳本引擎動態(tài)鏈接庫（DLL）中，然后使用一系列的函數(shù)調(diào)用訪問引擎中的服務(wù)。

在這篇文章里面我們將看到如何使用lua5.2腳本引擎嵌入到C++的代碼中，我們的測試用例使用的開發(fā)工具是Visual Studio 2005.這開始講解之前我們要從lua官方網(wǎng)站下載一些必要的組件，lua5.2中包含有已經(jīng)編譯好的dll以及頭文件和鏈接用的導(dǎo)入庫。需要說明的是當(dāng)你使用lua嵌入到C++代碼的時(shí)候，編譯出來的可執(zhí)行文件必須包含有l(wèi)ua的DLL即動態(tài)鏈接庫，否則會提示運(yùn)行出錯(cuò)，缺少必要的dll。這些例子都是用Visual Studio 2005編寫，當(dāng)然對于VS的后續(xù)版本是兼容的。

這篇文章向您描述了一個(gè)使用lua5.2作為腳本引擎的特定實(shí)現(xiàn)，在lua的官方文檔（lua.org）以及一些網(wǎng)站中有許多關(guān)于這方面的信息，這里僅僅是為你提供一些測試?yán)?，作為你開始lua旅程之前的引導(dǎo)

對于產(chǎn)品開發(fā)而言，開發(fā)一個(gè)完整專業(yè)應(yīng)用程序跟開發(fā)單塊應(yīng)用程序有不同的策略和方法。譬如說：開發(fā)完整專業(yè)應(yīng)用平臺需要對終端用戶提供大量豐富的插件工具和服務(wù)去實(shí)現(xiàn)他們自己特定的領(lǐng)域需求。插件程序的策略和方法被應(yīng)用在許多的軟件中，例如微軟的Office,Visual Studio以及集成開發(fā)環(huán)境Eclipse，甚至是圖片處理軟件Adobe Photoshop. 網(wǎng)游魔獸世界就提供大量的add-on(插件)給用戶，一些其他的游戲提供類似的工具，讓玩家可以增加額外的內(nèi)容從而創(chuàng)造一個(gè)與眾不同的社區(qū)。

作為商業(yè)應(yīng)用程序，GenPOS,有一些特性也是極具工具集的策略的：

•     布局管理器工具然該用戶可以通過調(diào)整窗口，按鈕的位置，文字，內(nèi)容等屬性來調(diào)整界面的布局。
•     字符控制功能可以讓一些工作流自動化
•     豐富的參數(shù)化設(shè)計(jì)可以更改軟件的功能
•     數(shù)據(jù)庫的助記符可以使得顯示不同的語言，使得多語言更容易
•     通過遠(yuǎn)程接口可以動態(tài)地改變參數(shù)和助記符
•     提供接口從終端獲取財(cái)物和運(yùn)行的狀態(tài)數(shù)據(jù)

不管怎樣，有些模塊是被源代碼實(shí)際控制的，這部分模塊的更改需要通過開發(fā)部門的協(xié)作才能完成軟件行為的改變。例如說，打印收據(jù)（一些顯示內(nèi)容是從參數(shù)或者助記符的輸入中獲取的）。簡短列舉這些限制可能包含：

•     現(xiàn)有的字符控制功能缺少狀態(tài)測試和跳轉(zhuǎn)
•     不能溝通動態(tài)地根據(jù)現(xiàn)有的狀態(tài)修改和顯示信息

與其試圖加強(qiáng)和改進(jìn)當(dāng)前的非常簡單的控制字符串功能，以提供包含額外腳本功能的銷售終端，我們最終決定尋找到其它可能的方案，不需要大量開發(fā)到改進(jìn)，且提供更多的產(chǎn)品改進(jìn)能力。就像我們引入的布局管理器使客戶能夠設(shè)計(jì)自己的屏幕布置和工作流程一樣，我們希望有一個(gè)相當(dāng)靈活的機(jī)制讓經(jīng)銷商的銷售終端通過腳本為他們的客戶提供增值服務(wù)。我們還打算提供足夠的應(yīng)用服務(wù)訪問權(quán)限，讓經(jīng)銷商和最終客戶將能夠修改自己的應(yīng)用程序的行為。最后，我們要使用有一定程度到用戶社區(qū)的語言，感興趣到人們可以使用社區(qū)的資源。

我們已經(jīng)用5.2版本的Lua腳本引擎在POS源代碼上做了一些簡單的實(shí)驗(yàn)來觀察向程序中添加功能的難度。從實(shí)驗(yàn)結(jié)果來看，我們想通過程序服務(wù)來展現(xiàn)的各種功能已經(jīng)是可用的了，并且可以通過對Lua腳本引擎做一些修改就可以使用起來。

使用 Lua 5.2 腳本引擎

Lua 腳本引擎本身是由 C 語言寫成的，在 C 或 C++ 中使用 Lua 腳本也相當(dāng)簡單。你在網(wǎng)上也可以找到很多集成了 Lua 5.2 腳本引擎的的程序或程序片段，并且 Lua 5.2 的程序接口和先前 Lua 版本只有在初始化和啟動等接口上存在少量變化，所以舊的 Lua 程序可以不做修改或只做很小的修改就可以移植到 Lua 5.2環(huán)境下。

基本的初始化步驟如下：

•     使用 lua_newstate() 創(chuàng)建一個(gè)新的 Lua 狀態(tài)機(jī)。
•     若有必要，調(diào)用 luaL_openlibs() 函數(shù)加載 Lua 的標(biāo)準(zhǔn)庫。

一旦初始化了 Lua 腳本引擎，你可以通過如下步驟執(zhí)行一段 Lua 腳本：

•     使用 luaL_loadfile 加載一段 Lua 程序或腳本到 Lua 執(zhí)行引擎中；
•     調(diào)用 lua_pcall 函數(shù)執(zhí)行已加載的腳本。

如果想在應(yīng)用程序中加載Lua腳本并執(zhí)行其中的函數(shù)，你必須執(zhí)行被加載的Lua程序塊(chunk)。剛剛加載的程序塊只是編譯后存放于Lua的腳本引擎中，并沒有被執(zhí)行。只有在程序塊被執(zhí)行后，Lua中的全局變量和函數(shù)才會被創(chuàng)建，在這之前這些任何全局變量和函數(shù)對于應(yīng)用程序來說都不可用。作為Lua引擎的環(huán)境由應(yīng)用程序提供給Lua腳本引擎的任何全局變量和函數(shù)也不可用。應(yīng)用程序必須首先創(chuàng)建變量和函數(shù)，并使用函數(shù)lua_setglobal()讓它們可用。在文件 UtilityFunctions.cpp 中的函數(shù)int LuaSimpleWrapper::TriggerGlobalCall()定義了一個(gè)例子，它在Lua虛擬棧上動態(tài)創(chuàng)建一個(gè)Lua函數(shù)調(diào)用，并用Lua腳本引擎中的lua_pcall()函數(shù)，以給定的參數(shù)來執(zhí)行此函數(shù)。

所有Lua腳本引擎函數(shù)或服務(wù)，都用到一個(gè)包含Lua腳本引擎狀態(tài)信息的句柄或數(shù)據(jù)結(jié)構(gòu)指針。這個(gè)句柄被指定為lua_State*或者指向lua_State變量的指針。每次成功的lua_newstate()的調(diào)用都會返回一個(gè)lua_State指針，失敗時(shí)返回NULL。這個(gè)數(shù)據(jù)結(jié)構(gòu)是用來指示特定會話的變量，它允許Lua腳本引擎同時(shí)有多個(gè)會話并行。當(dāng)應(yīng)用程序用到Lua腳本引擎中的函數(shù)，或應(yīng)用程序提供給Lua腳本引擎的服務(wù)被調(diào)用時(shí)，lua_State結(jié)構(gòu)提供的會話環(huán)境唯一指示了某個(gè)Lua會話狀態(tài)。這意味著，應(yīng)用程序提供給Lua腳本引擎的函數(shù)應(yīng)該是完全可重入的，或者提供某種監(jiān)視，比如信號量和臨界區(qū)使得非共享服務(wù)能夠提供線程安全的訪問。

使用代碼

在Visual Studio 2005工程目錄中包含三個(gè)C++文件和一個(gè)測試基本功能的Lua例子。主體部分在Parser01.cpp中。在這里，加載了特定的Lua文件，然后又調(diào)用了一些別的函數(shù)。UtilityFunctions.cpp包含了LuaSimpleWrapper方法的源代碼。InitEnviron則包含了我們希望提供給Lua環(huán)境的的函數(shù)。

我們正考慮使用的這個(gè)方法是， 在銷售點(diǎn)應(yīng)用程序啟動一個(gè)包含Lua腳本的文件被指定。作為啟動，銷售點(diǎn)將啟動一個(gè)初始化Lua腳本引擎并且加載和執(zhí)行指定的Lua源文件的線程。Lua塊將一直保留在內(nèi)存中，并且在銷售點(diǎn)應(yīng)用程序中，隨著事件的進(jìn)行一些事件會被轉(zhuǎn)移到Lua腳本進(jìn)行處理。這個(gè)示例程序中的測試工具是一個(gè)對我們正在考慮的這種方法的探索。

在下面提供的lua源碼的函數(shù)中，我們使用了幾個(gè)在文件InitEnviron.cpp中提供的幾個(gè)函數(shù)，處理非標(biāo)準(zhǔn)Lua字符串的‘寬字符串'。標(biāo)準(zhǔn)的Lua字符串是char字符串（C風(fēng)格的單字節(jié)字符串）。這些附加函數(shù)為Lua處理這些寬字符串提供了方法，例如字符串的連接，比較。

下面展示一個(gè)含有三個(gè)參數(shù)并執(zhí)行一系列操作的Lua函數(shù)。函數(shù)名xxfunc是一個(gè)全局名字，應(yīng)用程序可以通過調(diào)用函數(shù)lua_getglobal()從Lua全局字典中檢索出來并在Lua虛擬堆棧上把句柄傳給lua_getglobal。然后函數(shù)的參數(shù)可以通過調(diào)用像一個(gè)lua_pushstring()的函數(shù)推送到Lua虛擬堆棧上，接著調(diào)用Lua腳本引擎函數(shù)lua_pcall()執(zhí)行xxfunc函數(shù)。

以上在Lua腳本中已經(jīng)被加載的Lua函數(shù)可以被應(yīng)用程序調(diào)用。使用來自LuaSimpleWrapper類中的一個(gè)助手函數(shù)，我們可以調(diào)用帶有以下C++代碼行的Lua函數(shù)。方法TriggerGlobalCall（）需要一個(gè)標(biāo)識全局Lua函數(shù)（函數(shù)或賦給一個(gè)變量或表實(shí)例的函數(shù)）的描述性字符串來調(diào)用帶有描述的參數(shù)類型。這些參數(shù)遵循描述性字符串。這種類型的變量函數(shù)調(diào)用會成為一個(gè)運(yùn)行時(shí)錯(cuò)誤的根源，因?yàn)樗瑤讉€(gè)單獨(dú)的必須匹配的源：

1. TriggerGlobalCall()中的描述性字符串；
2. theTriggerGlobalCall()提供的實(shí)際參數(shù)；
3. 被調(diào)用的Lua函數(shù)。

富有表達(dá)力的字符串使用了由逗號分隔的列表來區(qū)分參數(shù)的類型，列表中每個(gè)字母代表著各自的類型，如一個(gè)ANSI字符串，一個(gè)長字符串，一個(gè)浮點(diǎn)型，一個(gè)整型，一個(gè)函數(shù)的地址。在 TriggerGlobalCall() 方法的代碼中，字母中間的逗號被忽略了，實(shí)際上他們存在的作用只是為了使這個(gè)富有表達(dá)力的字符串更易識別和理解。

上面的方法TriggerGlobalCall()調(diào)用了Lua的xxfunc()函數(shù)會產(chǎn)生如下的結(jié)果輸出。這輸出由Lua函數(shù)使用TriggerGlobalCall()里定義的參數(shù)列表的參數(shù)生成。

我們在LuaSimpleWrapper 類中提供的TriggerGlobalCall()方法允許指定一個(gè)可訪問一個(gè)函數(shù)的表值，這個(gè)函數(shù)已經(jīng)在Lua表中分配了一個(gè)鍵值。描述性字符串的格式是：tablename.key，這里“tablename”是一個(gè)Lua表的全局名而“key”是訪問函數(shù)所需的鍵值。
 

將C/C++函數(shù)導(dǎo)出到Lua引擎中

為了創(chuàng)建一個(gè)要在Lua腳本中使用的C或者C++輔助函數(shù)，C/C++應(yīng)用程序就必需提供該函數(shù)體（the function body）并使用適當(dāng)?shù)腖ua引擎函數(shù)讓該新函數(shù)變?yōu)樵贚ua引擎中可用。在應(yīng)用程序里將一個(gè)函數(shù)提供給在Lua引擎中進(jìn)行使用所需的函數(shù)調(diào)用要將若干值壓入Lua的虛擬堆棧之中，然后調(diào)用lua_setglobal()函數(shù)，就可以把應(yīng)用程序中的函數(shù)作為全局函數(shù)提供給在Lua腳本引擎中使用。
 

Lua為函數(shù)提供閉包概念。當(dāng)一個(gè)Lua腳本引擎調(diào)用應(yīng)用函數(shù)時(shí)，一個(gè)閉包允許一個(gè)應(yīng)用指定一個(gè)或多個(gè)提供給應(yīng)用函數(shù)的值。這些值可以被應(yīng)用函數(shù)更新，這個(gè)例子使用的一個(gè)特性是通過一個(gè)與應(yīng)用函數(shù)關(guān)聯(lián)的計(jì)數(shù)器增量提供一個(gè)惟一值。C++關(guān)于這方面的源代碼的一個(gè)例子可以在方法int LuaSimpleWrapper::InitLuaEnvironment()中找到，這個(gè)方法為Lua腳本引擎提供CreateFrame()函數(shù)。

要導(dǎo)出的C++函數(shù)的源代碼應(yīng)該具有如下所示的形式。函數(shù)concatMultiWideStrings ()使用了一系列的Lua引擎里的函數(shù)處理LUa虛擬堆棧之中的一些數(shù)值并將處理結(jié)果返回給Lua引擎。以下所示函數(shù)說明了要使用lua_State *這個(gè)參數(shù)提供給該函數(shù)相關(guān)的session環(huán)境。這個(gè)函數(shù)用以將多個(gè)字符串拼接到一起。Lua腳本引擎提供了位于Lua虛擬堆棧之中的參數(shù)的個(gè)數(shù)信息。我們還可以使用Lua引擎提供的lua_type()函數(shù)判斷出參數(shù)的數(shù)據(jù)類型，從而可以跳過那些不是正確類型的參數(shù)。
 

然而，實(shí)際上在我們只想使用LUA_STRING這種類型的情況下，Lua腳本引擎會執(zhí)行相應(yīng)的類型轉(zhuǎn)換，但Lua所做的從其它類型到字符串類型的轉(zhuǎn)換的結(jié)果是C風(fēng)格的單字節(jié)字符所組成的字符串串而不是我們所預(yù)期的雙字節(jié)寬度的字符組成的字符串。
 

關(guān)注點(diǎn)

該測試工具（test harness）的第一個(gè)版本只是個(gè)非常簡單的開頭，只是簡單的裝載一個(gè)簡單Lua腳本，在運(yùn)行后也只是使用Lua的輸出函數(shù)在控制臺（console）中輸出一個(gè)“Hello World”。隨著在調(diào)查嵌入式Lua所具有的潛在能力時(shí)，腳本和測試工具會變得越來越復(fù)雜，很快就會發(fā)現(xiàn)明顯需要有某種方式將Lua虛擬堆棧中所有內(nèi)容打印出來，才能理解Lua引擎同應(yīng)用程序之間到底是如何進(jìn)行通信的。 要多次在運(yùn)行突然中斷，使用調(diào)試器單步進(jìn)入C++源代碼時(shí)使用堆棧內(nèi)容輸出函數(shù)查看堆棧中內(nèi)容，只有這樣才能理解到底發(fā)生了什么問題并找出問題的修復(fù)辦法。

Lua語言的動態(tài)特性，像JavaScript這類的松散類型語言一樣，會鼓勵(lì)有冒險(xiǎn)精神的程序員寫出一些非常有趣的代碼，但是也會產(chǎn)生一些非常難以調(diào)試和測試的代碼。這個(gè)難度主要來自于使用了兩種語言，而在Visual Studio中又缺乏對Lua調(diào)試的支持。

在實(shí)現(xiàn)方法int LuaSimpleWrapper::TriggerGlobalCall ()時(shí)，在Visual Studio debugger里運(yùn)行的情況下我們遇到了導(dǎo)致Lua的腳步引擎（script engine）在Windows錯(cuò)誤對話框中要執(zhí)行應(yīng)用程序關(guān)閉或退出操作的測試案例（test case）。我們認(rèn)為，之所以出現(xiàn)這個(gè)問題，是由于在出現(xiàn)了錯(cuò)誤的情況下，有些特定的值被壓入了Lua的虛擬堆棧之中，從而未被恰當(dāng)處理所導(dǎo)致的。為了解決該問題，在發(fā)現(xiàn)錯(cuò)誤的情況下，我們要用下面所示的C++代碼對Lua的虛擬堆棧進(jìn)行清理。在此測試套件（test harness）中，我們有兩個(gè)不同的測試，一個(gè)用來對指定的全局變量是否存在進(jìn)行測試，另一個(gè)測試的是，如果通過使用“global.key”語法指定了一個(gè)關(guān)鍵值（key value），那么其中的全局變量必定為一個(gè)表，否則便為錯(cuò)誤。