Cocos2d 之 tolua

LiteralliJeff · 发表于 2021-8-11 12:07

前言

在游戏开发过程中，主要业务逻辑等由Lua开发（因为可以动态热更、灵活便捷等），但是Lua毕竟是脚本语言，遇到一些高性能需求或其他涉及底层变动，需要用C++来实现（你大爷还是你大爷）。
对于将C++的类或方法导出给Lua调用，
Cocos2d-x引擎采用的是 tolua++，通过便携tolua++的pkg配置文件，来定义要导出的每一个类的信息，这个步骤相当于用tolua++的规则将类的头文件重写成pkg文件，tolua++会根据这个文件以及类的cpp文件来生成C++代码文件。
直接使用tolua++在批量导出的时候会比较麻烦，基于此，引擎提供了 genbindings.py 文件来完成批量导出的工作，流程如下：

本文主要内容一览：

环境搭建

Windows平台

r9b 版本NDK

Mac 平台

待补充

配置介绍

genbindings.py 文件

这个脚本文件主要作用是根据ini文件，执行 cocos2d\tools\bindings-generator\generator.py 来生成导出C++代码。
这个文件需要修改的地方不多，多注意下列几个地方即可：

ini 文件配置

ini配置文件主要作用于描述要导出的类，一个ini文件可以配置多个类，一般都以文件夹为单位。
配置文件的结构由三部分组成：

例如：

# 注释A
[sectionA]
keyA1 =
keyA2 = valueA2
keyA3 = valueA3 valueA4
# 注释B
[sectionB]
keyB1 = valueB1
keyB2 =

复制代码

除了上述配置文件基本规则，还需要注意一些常用且重要的键：

逗号

空格

正则表达式

例如：

逗号

空格

rename_functions = ClassA::[oldFuncNameA=newFuncNameA oldFuncNameB=newFuncNameB], ClassB::[oldFuncNameC=newFuncNameC]

复制代码

还有一些其他键，不是很常用或重要，一般上面都有注释，可以自行分析填写。
结构

genbindings.py 文件和 ini文件都是为 generator.py 文件传递配置的。
一般为了将自建的类文件与引擎的区分开，都会新建一个文件夹专门放自建类文件，并与引擎文件同级，同样的导出方法也需要新建一套。
大概结构如下：

实操

修改引擎代码

创建或修改自建类

配置相应 ini文件、genbindings 文件
- 检查相应ini文件中是否已经导出了该类
- 检查 genbindings.py，确定导出配置
执行genbindings脚本（注意用python2.x - 32bit）使用VS编译导出的文件运行游戏验证

出现问题及解决方案

主要是由于自建类独立文件夹导致，generator.py 在生成头文件路径的时候，是以引擎为准，所以指定在 xxx/cocos2d/cocos 目录下查找，可见 generator.py 的 search_path 变量：
1. 'search_path': os.path.abspath(os.path.join(userconfig.get('DEFAULT','cocosdir'),'cocos')),
复制代码
所以，导出自建类文件的时候，头文件所属的文件夹均忽略了。可见 cocos2d\tools\bindings-generator\targets\lua\templates\layout_head.c
1. \#include "scripting/lua-bindings/auto/${out_file}.hpp"#if $macro_judgement
2. $macro_judgement
3. #end if#for header in $headers#set relative = os.path.relpath(header, $search_path)#if not '..' in relative
4. \#include "${relative.replace(os.path.sep, '/')}"#else
5. \#include "${os.path.basename(header)}"#end if#end for
6. \#include "scripting/lua-bindings/manual/tolua_fix.h"
7. \#include "scripting/lua-bindings/manual/LuaBasicConversions.h"#if $cpp_headers#for header in $cpp_headers
8. \#include "${header}"#end for#end if
复制代码
解决：根据之前的结构来看，genbindings.py 是会像 generator.py 传递参数的，我们可以由genbindings根据自己代码源目录指定搜索路径。
在genbindings.py中添加搜索路径参数：
1. search_root = os.path.abspath(os.path.join(源文件根目录))
2. config.set('DEFAULT','searchdir', search_root)
复制代码
然后再generator.py中不再自行拼接搜索路径，而是使用传递过来的路径：
1. # 'search_path': os.path.abspath(os.path.join(userconfig.get('DEFAULT', 'cocosdir'), 'cocos')),'search_path': os.path.abspath(os.path.join(userconfig.get('DEFAULT','searchdir'))),
复制代码
至此，兼容了引擎和自建类。

参考资料：

		自动登录	找回密码
密码			立即注册

Cocos2d 之 tolua

本帖子中包含更多资源