lua呼叫自定義c++類

阿新 • • 發佈：2020-10-13

【嘮叨】

本節要講的是如果將自己寫的C++類註冊進Lua環境，讓Lua去呼叫自定義的C++類。

網上有很多都是用原始的tolua++工具來註冊C++類的，我看了很多這樣的教程，感覺操作起來十分麻煩，而且也很難看懂他們到底在講什麼。

其實，在cocos2dx v3.2版本中，提供了bindings-generator指令碼來封裝toLua++的用法，從而節省了工作量。

【致謝】

http://segmentfault.com/blog/hongliang/1190000000718145（講得非常好！）

http://cn.cocos2d-x.org/article/index?type=code-ide&url=/doc/cocos-docs-master/manual/code-ide/binding-custom-class-to-lua/zh.md

（官方文件）

【使用工具】

Windows7 x64

Cocos2dx v3.2

Cocos Code IDE 1.0.1 （支援自定義類的智慧提示功能）

python 2.7.x（v3.2版本不一定要2.7.3，我用2.7.8也成功了的）

NDK r9d，解壓並配置環境變數NDK_ROOT（v3.2版本不一定要r9b，我用r9d成功了的）

pyyaml ，安裝到 "Python的安裝目錄\Lib\site-packages"

http://pyyaml.org/download/pyyaml/PyYAML-3.10.win32-py2.7.exe

Cheetah ，並解壓到 "Python的安裝目錄\Lib\site-packages"

https://raw.github.com/dumganhar/my_old_cocos2d-x_backup/download/downloads/Cheetah.zip

dos2unix ，windows下可能在執行指令碼時有這個錯誤。

解壓到一某個目錄下面, 並設定PATH環境變數的值指向bin目錄下。

http://waterlan.home.xs4all.nl/dos2unix/dos2unix-7.1-win32.zip

【繫結方法】

以下介紹的是在Windows7 + VS2013 + Cocos Code IDE

。

並使用Cocos Code IDE建立的Lua專案，繫結方法。

1、將自定義的C++程式碼放在frameworks\runtime-src\Classes 下

當然放哪裡是隨意的，我喜歡放在Classes下。

2、新增自定義類的.ini檔案

在frameworks\cocos2d-x\tools\tolua 中，複製一份該資料夾下cocos2dx.ini的配置資訊，然後修改一些引數，改成我們自定義類的引數。

以下列出需要修改的引數配置：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

[custom_api] #prefix會被新增到生成的函式.你也可以選擇不新增這個到你的模板 prefix=custom_api #所有的類都會嵌入到這個名稱空間 target_namespace=my #類所在的路徑，如果有多個，用空格隔開 headers=%(cocosdir)s/../runtime-src/Classes/PanZoomLayer.h #需要註冊的類，如果有多個，用空格隔開 classes=PanZoomLayer #不提供給Lua的public成員函式 skip=PanZoomLayer::[onTouchesBeganonTouchesMovedonTouchesEndedinitonEnteronExitupdate] #這些全空就好了 rename_functions= rename_classes= remove_prefix= classes_have_no_parents= base_classes_to_skip= abstract_classes= script_control_cpp=no

3、genbindings.py 新增自定義的配置.ini

在frameworks\cocos2d-x\tools\tolua 的genbindings.py中的129行找到cmd_args 。

將我們自定義的custom_api.ini 新增進去，並註釋掉其他.ini（這些已經不需要重新生成）

4、執行genbindings.py 指令碼

在終端執行genbindings.py 指令碼。

在這裡，我是直接寫了一個批處理檔案 .bat 。

注意：只要需要用到的工具都下載，安裝，配置好了，一般就能生成成功。

生成失敗的，基本都是因為工具沒有配置好。

生成成功後，在frameworks\cocos2d-x\cocos\scripting\lua-bindings\auto 中會找到我們生成的C++的橋接檔案， lua_custom_api_auto.cpp 和 lua_custom_api_auto.hpp 。

其中 lua_custom_api_auto.hpp 中的register_all_custom_api 就是我們用來將PanZoomLayer類註冊到Lua環境中的關鍵函式。

以及在frameworks\cocos2d-x\cocos\scripting\lua-bindings\auto\api 中也能夠找到我們提供給Lua呼叫的介面檔案。

5、編譯註冊到Lua

註冊自定義類的函式在我們的lua_custom_api_auto.hpp 中可以看到。

register_all_custom_api(lua_State* tolua_S)

使用 VS2013 開啟frameworks\runtime-src\proj.win32 下的工程。

（1）將自定義的類 PanZoomLayer 新增到專案工程的Classes下。

（2）將lua_custom_api_auto.cpp、lua_custom_api_auto.hpp新增到工程liblua的auto下。

（3）新增lualib工程的檔案搜尋路徑。

將$(EngineRoot)../runtime-src/Classes 路徑加進去。

（4）編輯frameworks\runtime-src\Classes 下的入口類 AppDelegate.cpp

>新增：lua_custom_api_auto.hpp標頭檔案

> 註冊：register_all_custom_api(state)

> 注意：register_all_custom_api 的上下兩句話，必須加上！

（5）編譯執行整個專案，完成C++類的註冊到Lua。

然後就可以再Lua中愉快的使用自定義的類了！

【開啟智慧提示】

雖然我們將我們自定義的C++類註冊到了Lua中呼叫，但是在Cocos Code IDE中卻沒有我們自定義類的智慧提示。

我們需要修改一些配置，讓Cocos Code IDE加上對我們自定義類的智慧提示。

1、Cocos2dx引擎中的智慧提示

首先我們來看一下Cocos Code IDE中cocos2dx引擎的智慧提示是怎麼搞的。

隨便找個 cc.Label 把！

我們按住鍵盤的 ctrl 鍵，然後點選 cc 和 Label，就會跳轉到宣告它們的地方。

檔案跳轉到了如下兩幅圖的地方：

可能看到以上兩幅圖，你就明白應該怎麼給我們自定義的C++類加上智慧提示了吧？

我們先找到以下檔案路徑：（可能每個人的不一樣）

\CocosCodeIDE\configuration\org.eclipse.osgi\bundles\61\1\.cp\resource\cocos2dx-3.2

可以發現該路徑下有一個 api.zip 這個壓縮包。

我們將其 api.zip 解壓出來看看裡面都是什麼東西。

可以發現裡面全是cocos2dx的C++類提供給Lua的介面宣告。

這些也就是IDE中智慧提示的原因。

2、新增自定義類的智慧提示（方式一）

我們仿照 api.zip 中的 cc.lua 和 label.lua 來寫一個自定義類的介面宣告。

> my.lua ：宣告名稱空間

> PanZoomLayer.lua：宣告自定義類。（這個在使用指令碼繫結時，自動生成）

其中PanZoomLayer.lua 在使用genbindings.py指令碼時，就自動生成了的。

就在frameworks\cocos2d-x\cocos\scripting\lua-bindings\auto\api 中。

那麼，我們再寫一個 my.lua ，也放在這個目錄下好了。

其中，my.lua 程式碼如下：

1 2 3 4 5 6 7 8 9

-------------------------------- --@modulemy -------------------------------------------------------- --themyPanZoomLayer --@field[parent=#my]PanZoomLayer#PanZoomLayerPanZoomLayerpreloadedmodule returnnil

PanZoomLayer.lua 程式碼如下：

然後我們將 my.lua 和PanZoomLayer.lua 一併壓縮到 myapi.zip 中。

就放在\frameworks\cocos2d-x\cocos\scripting\lua-bindings\auto\api 中好了。

然後我們開啟Cocos Code IDE的工程專案，配置屬性。

Lua->Build Path->Libraries->Add External Zips。

將我們的 myapi.zip 壓縮包新增進去，點選“確定”。

這樣，就可以在 Cocos Code IDE 中愉快的玩我們自定義的類了。

有智慧提示，就是爽啊！！！

3、新增智慧提示（方式二）

通過上面的方式一的方法雖然可以有智慧提示，可是後來我發現定義的名稱空間 my 卻無法識別。這樣的結果將導致建立的 my.PanZoomLayer:create() 賦值給 self 的成員 self.pzLayer 後，繼續使用self.pzLayer 時，對應的函式又無法提示了。