cocos2dx原生lua绑定工具的总结
发表于2015-07-31
一、个人对“绑定”这词有两种理解
1、lua绑定到C++，就是C++能调用到lua的东西，那必须让C++知道有哪些lua函数或变量可以用
2、C++绑定到lua，就是lua能调用到C++的东西，当然也必须让lua知道有哪些C++东东可以给lua调用，所谓的“暴露”
这里说的绑定就是第2种情况，在lua中能调用到Cocos2dx的函数。
Cocos2dx通过工程里面的tools/toLua工具生成注册C++函数到lua的函数cpp文件
二、环境设置
工具：
NDK_ROOT 必须为android-ndk-r9b 64bit版
Python 为32bit版，2.7版（因为有个插件是32位的（Cheetah），如果这个插件有64的，个人觉得用python64位没问题）
python插件：Cheetah、PyYAML（3.10以上版本、有32、64可选，但现在必选32）
环境设置具体查看https://github.com/cocos2d/bindings-generator
三、生成工具
生成工具是一个python文件控制(genbindings.py)，这个python文件中可以设置自己的生成规则文件（ini）、生成路径等重要信息，可以参考http://www.cocoachina.com/bbs/read.php?tid=196416
编写或者修改genbindings.py要注意点的：
1、 设置cmd_args参数时，第一是ini文件名，最后一个是要生成的文件名，重点是第二个，这个参数是生成器在ini文件里面查找对应的块（即ini文件中中括号对应的文字，如[cocos2dx]，一般是第一行），形如cmd_args = {'custom.ini' : ('custom', 'lua_custom_auto') }就是查找custom.ini中的[custom]段配置，最后生成名为lua_custom_auto的文件，如果第二个参数没对应上，出现Section not found in config file的错误
四、这里重点是，编写ini
1、首先必须了解正则表达式，百度直接搜索正则表达式
2、关键参数
prefix 关系到lua函数开头的名字，如prefix=cocos2dx，那么生成的代码就是以lua_cocos2dx开头
target_namespace 表面这些lua函数注册到哪个命名空间，在lua中，就是代表注册到那个表中，如target_namespace=custom，那么在lua中调用就是以 custom. 开头（但这个参数好像控制不到，真正能控制的是在C++里面是否有custom的命名空间）
这里有两点要注意的
（1）、如果有自定义的命名空间，cocos2dx主目录的tools文件夹下bindings-generatortargetslua下的conversions.yaml（js的是bindings-generatortargetsspidermonkey下的conversions.yaml）添加自己的命名空间：
ns_map:
"cocos2d::extension::": "cc."
"cocos2d::ui::": "ccui."
"cocos2d::": "cc."
"spine::": "sp."
"cocostudio::": "ccs."
"cocosbuilder::": "cc."
"CocosDenshion::": "cc."
"custom::": "custom."
这个文件貌似是一些替换操作配置（就是在生成C++文件中替换掉所设置的的字符串），自己研究一下就知道了。
（2）如果自己的代码没有命名空间，建议弄一个，不然遇到C++类中的类型，诸如下面的的C++代码：
舀鱙A类中有函数参数或返回值用到State类型的，在生成过程中汇报错，报错消息称没有A的命名空间。。。那么这时候就得到第一点提及的地方加入一行："A::":"A."的信息。在有命名空间的情况下，生成器直接通过。这里是个奇怪的问题。
headers 填入你所编写的代码的头文件
classes 填入要生成的类，支持多个类，支持正则表达式，如classes = A，^A，^A$
skip 指定屏蔽函数，即不需要暴露给lua的函数，支持正则表达式，如 skip = Sprite::[getQuad getBlendFunc ^setPosition$ setBlendFunc]
rename_functions 重新命名暴露到lua中函数名（一般以C++编写函数名暴露到lua），如 rename_functions = SpriteFrameCache::[addSpriteFramesWithFile=addSpriteFrames getSpriteFrameByName=getSpriteFrame]，
等号前是原函数名，等号后是lua中的新函数名
rename_classes重命名类，如 rename_classes = SimpleAudioEngine::AudioEngine。前面是原名，后面是lua新名。这个好像没效果，生成后还是那个名字
classes_have_no_parents 指定一些没有父类的类
base_classes_to_skip 指定一些需要跳过的基类
abstract_classes 指定一些抽象类或者没有构造函数的类，以手动方式编写注册到lua函数
编写完后，把只要执行修改过的自定义的或者修改过的genbindings.py（http://www.cocoachina.com/bbs/read.php?tid=196416 提及）就可以生成出相关的代码
3、自动生成的代码会自动过滤掉C++中的protect、private属性、重载父类的函数、带省略号参数的函数（如Menu::create(MenuItem* item, ...) )
五、嵌入到CPP代码中
1、一般情况下，我们会在AppDelegate.cpp下注册自己的函数，如
但是在3.0中，LuaEngine初始化过程中会加载几个lua文件，把lua栈清空，导致程序崩溃。这里参考http://www.cocoachina.com/bbs/read.php?tid=226180&page=1#1042506
建议是把那几个文件放到注册完自己函数后加载，如
1、lua绑定到C++，就是C++能调用到lua的东西，那必须让C++知道有哪些lua函数或变量可以用
2、C++绑定到lua，就是lua能调用到C++的东西，当然也必须让lua知道有哪些C++东东可以给lua调用，所谓的“暴露”
这里说的绑定就是第2种情况，在lua中能调用到Cocos2dx的函数。
Cocos2dx通过工程里面的tools/toLua工具生成注册C++函数到lua的函数cpp文件
二、环境设置
工具：
NDK_ROOT 必须为android-ndk-r9b 64bit版
Python 为32bit版，2.7版（因为有个插件是32位的（Cheetah），如果这个插件有64的，个人觉得用python64位没问题）
python插件：Cheetah、PyYAML（3.10以上版本、有32、64可选，但现在必选32）
环境设置具体查看https://github.com/cocos2d/bindings-generator
三、生成工具
生成工具是一个python文件控制(genbindings.py)，这个python文件中可以设置自己的生成规则文件（ini）、生成路径等重要信息，可以参考http://www.cocoachina.com/bbs/read.php?tid=196416
编写或者修改genbindings.py要注意点的：
1、 设置cmd_args参数时，第一是ini文件名，最后一个是要生成的文件名，重点是第二个，这个参数是生成器在ini文件里面查找对应的块（即ini文件中中括号对应的文字，如[cocos2dx]，一般是第一行），形如cmd_args = {'custom.ini' : ('custom', 'lua_custom_auto') }就是查找custom.ini中的[custom]段配置，最后生成名为lua_custom_auto的文件，如果第二个参数没对应上，出现Section not found in config file的错误
四、这里重点是，编写ini
1、首先必须了解正则表达式，百度直接搜索正则表达式
2、关键参数
prefix 关系到lua函数开头的名字，如prefix=cocos2dx，那么生成的代码就是以lua_cocos2dx开头
target_namespace 表面这些lua函数注册到哪个命名空间，在lua中，就是代表注册到那个表中，如target_namespace=custom，那么在lua中调用就是以 custom. 开头（但这个参数好像控制不到，真正能控制的是在C++里面是否有custom的命名空间）
这里有两点要注意的
（1）、如果有自定义的命名空间，cocos2dx主目录的tools文件夹下bindings-generatortargetslua下的conversions.yaml（js的是bindings-generatortargetsspidermonkey下的conversions.yaml）添加自己的命名空间：
ns_map:
"cocos2d::extension::": "cc."
"cocos2d::ui::": "ccui."
"cocos2d::": "cc."
"spine::": "sp."
"cocostudio::": "ccs."
"cocosbuilder::": "cc."
"CocosDenshion::": "cc."
"custom::": "custom."
这个文件貌似是一些替换操作配置（就是在生成C++文件中替换掉所设置的的字符串），自己研究一下就知道了。
（2）如果自己的代码没有命名空间，建议弄一个，不然遇到C++类中的类型，诸如下面的的C++代码：
class A
{
enum class State
{
StateOne,
StateTwo,
}
}
舀鱙A类中有函数参数或返回值用到State类型的，在生成过程中汇报错，报错消息称没有A的命名空间。。。那么这时候就得到第一点提及的地方加入一行："A::":"A."的信息。在有命名空间的情况下，生成器直接通过。这里是个奇怪的问题。
headers 填入你所编写的代码的头文件
classes 填入要生成的类，支持多个类，支持正则表达式，如classes = A，^A，^A$
skip 指定屏蔽函数，即不需要暴露给lua的函数，支持正则表达式，如 skip = Sprite::[getQuad getBlendFunc ^setPosition$ setBlendFunc]
rename_functions 重新命名暴露到lua中函数名（一般以C++编写函数名暴露到lua），如 rename_functions = SpriteFrameCache::[addSpriteFramesWithFile=addSpriteFrames getSpriteFrameByName=getSpriteFrame]，
等号前是原函数名，等号后是lua中的新函数名
rename_classes重命名类，如 rename_classes = SimpleAudioEngine::AudioEngine。前面是原名，后面是lua新名。这个好像没效果，生成后还是那个名字
classes_have_no_parents 指定一些没有父类的类
base_classes_to_skip 指定一些需要跳过的基类
abstract_classes 指定一些抽象类或者没有构造函数的类，以手动方式编写注册到lua函数
编写完后，把只要执行修改过的自定义的或者修改过的genbindings.py（http://www.cocoachina.com/bbs/read.php?tid=196416 提及）就可以生成出相关的代码
3、自动生成的代码会自动过滤掉C++中的protect、private属性、重载父类的函数、带省略号参数的函数（如Menu::create(MenuItem* item, ...) )
五、嵌入到CPP代码中
1、一般情况下，我们会在AppDelegate.cpp下注册自己的函数，如
auto engine = LuaEngine::getInstance();
register_all_custom(engine->getLuaStack()->getLuaState());
register_all_custom_manual(engine->getLuaStack()->getLuaState());
noxssEngineManager::getInstance()->setScriptEngine(engine);
engine->executeScriptFile("src/main.lua");
但是在3.0中，LuaEngine初始化过程中会加载几个lua文件，把lua栈清空，导致程序崩溃。这里参考http://www.cocoachina.com/bbs/read.php?tid=226180&page=1#1042506
建议是把那几个文件放到注册完自己函数后加载，如
auto engine = LuaEngine::getInstance();
register_all_custom(engine->getLuaStack()->getLuaState());
register_all_custom_manual(engine->getLuaStack()->getLuaState());
noxssEngineManager::getInstance()->setScriptEngine(engine);
engine->executeScriptFile("DeprecatedEnum.lua");
engine->executeScriptFile("DeprecatedClass.lua");
engine->executeScriptFile("Deprecated.lua");
engine->executeScriptFile("src/main.lua");