关于cocos2d-x下Lua调用C++的文档看了不少,但没有一篇真正把这事给讲明白了,我自己也是个初学者,摸索了半天,总结如下:
cocos2d-x下Lua调用C++这事之所以看起来这么复杂、网上所有的文档都没讲清楚,是因为存在5个层面的知识点:
1、在纯C环境下,把C函数注册进Lua环境,理解Lua和C之间可以互相调用的本质
2、在cocos2d-x项目里,把纯C函数注册进Lua环境,理解cocos2d-x是怎样创建Lua环境的、以及怎样得到这个环境并继续自定义它
3、了解为什么要使用toLua++来注册C++类
4、在纯C++环境下,使用toLua++来把一个C++类注册进Lua环境,理解toLua++的用法
5、在cocos2d-x项目里,使用cocos2d-x注册自身的方式把自定义的C++类注册进Lua环境,理解cocos2d-x是怎样通过bindings-generator脚本来封装toLua++的用法来节省工作量的
只有理解了前4层,在最后使用bindings-generator脚本的时候心里才会清清楚楚。而网上的文档,要么是只解释了第1层,要么是只填鸭式地告诉你第5层怎么用bindings-generator脚本,不仅中间重要的知识点一概不提,示例代码往往也写的不够简洁,这让我这种看见C++就眼晕的人理解起来大为头疼(不是我不会C++,而是我非常不接受C++的设计哲学,能避就避)。所以接下来的讲解我会对每一层知识点逐一讲解,示例代码也不求完整严谨,而是尽量用最简洁的方式把程序的关键点说明白。
第一层:纯C环境下,把C函数注册进Lua环境
直接看代码比啰哩啰嗦讲一大堆概念要清晰明了的多。建立一个a.lua和一个a.c文件,内容如下,一看就明白是怎么回事了:
a.lua
print(foo(99))
a.c
#include
#include
#include
int foo(lua_State *L)
{
int n = lua_tonumber(L, 1);
lua_pushnumber(L, n + 1);
return 1;
}
int main()
{
lua_State *L = lua_open();
luaL_openlibs(L);
lua_register(L, "foo", foo);
luaL_dofile(L, "a.lua");
lua_close(L);
return 0;
}
怎么样,这代码简单吧?一看就明白,简单的不能再简单了。我特别烦示例代码里又是判断错误又是加代码注释的,本来看自己不会的代码就够吃力的了,还加那么多花花绿绿的干扰项,纯粹增加学习负担。
在命令行下用gcc来编译并执行吧:
gcc a.c -llua && ./a.out
注意-llua选项是必要的,因为要连接lua的库。
看完上面那段代码,再解释起来就容易多了:
1、要想注册进Lua环境,函数需要定义为这个样:int xxx(lua_State *L)
2、使用lua_tonumber、lua_tostring等函数,来取得传入的参数,比如lua_tonumber(L, 1)就是得到传入的第一个参数,且类型为数字
3、使用lua_pushnumber、lua_pushstring等函数,来将返回值压入Lua的环境中,因为Lua支持函数返回多个值,所以可以push多个返回值进Lua环境
4、最终函数返回的数字表示有多少个返回值被压入了Lua环境
5、使用lua_register宏定义来将这个函数注册进Lua环境,Lua脚本里就可以用它了,大功告成!就这么简单!
第二层:在cocos2d-x环境下,把C函数注册进Lua环境
也简单:
1、在frameworks/runtime-src/Classes/目录下,找到AppDelegate.cpp文件。如果frameworks目录不存在,则需要参考这篇Blog:用Cocos Code IDE写Lua,如何与项目中的C++代码和谐相处
AppDelegate.cpp文件中的关键代码如下:
```c++
auto engine = LuaEngine::getInstance();
ScriptEngineManager::getInstance()->setScriptEngine(engine);
LuaStack* stack = engine->getLuaStack();
stack->setXXTEAKeyAndSign("2dxLua", strlen("2dxLua"), "XXTEA", strlen("XXTEA"));
//register custom function
//LuaStack* stack = engine->getLuaStack();
//register_custom_function(stack->getLuaState());
可以看到cocos2d-x已经为我们留出了注册自定义C函数的位置,在注释代码后面这么写就可以了:
```cpp
lua_State *L = stack->getLuaState();
lua_register(L, "test_lua_bind", test_lua_bind);
也可以通过ScriptEngineManager类从头取得当前的LuaEngine对象,然后再getLuaStack()方法得到封装的LuaStack对象,再调用getLuaState()得到原始的lua_State结构指针。只要知道了入口位置,其他一切就不成问题了,还是挺简单的。
感兴趣的话可以去看一下ScriptEngineManager类的详细定义,在frameworks/cocos2d-x/cocos/base/CCScriptSupport.h文件中。
BTW:这里还有一个小知识点,插入在AppDelegate.cpp中的自定义代码尽量写在COCOS2D_DEBUG宏定义的判断前面,因为在调试环境下和真机环境下后续执行的代码是不一样的:
#if (COCOS2D_DEBUG>0)
if (startRuntime())
return true;
#endif
// 调试环境下代码就不会走到这里了
engine->executeScriptFile(ConfigParser