Cocos2d-x 3.0 中的lua binding - fonzieyang

http://www.tuicool.com/articles/zQRbia

Cocos2d-x 3.0 中的lua binding

How it work

cocos2d-x 发展到了3.0，发生了非常大的变化。脚本的绑定也由过去简单的tolua++生成为主，然后通过luafix修正传递回调，到现在更加智能的方式去做。

新的绑定方式简单来讲是分为三步：

1. 使用llvm前端clang对c++代码进行分析，获取AST(抽象语法树)
2. 利用预先写好的tolua代码作为模版，使用AST信息去填写模版
3. 一些需要fix的回调，通过manual的方式进行包装(这样c++代码就不用专门提供脚本注册函数registerScript(int functionId)之类的接口)，然后再回调到正确的lua函数。

优点：

• 一套c++多套统绑定
• 脚本系统透明化，c++代码不必提供脚本接口

缺点：

• 熟悉tolua++的同学需要重新学习
• 回调显得稍微麻烦一些，难以自动化绑定，每次需要绑定回调都要自己写c++代码

生成绑定

在$(EngineDir)/tools/tolua/目录下，执行genbindings.sh生成绑定代码，前提是你已经配置好环境，完成ini文件，如何编写以及配置，具体请看github上的文档 ，通常有误都是头文件目录错误，注意查看使用的是哪个版本的头文件。

扩展绑定

新版本的回调函数绑定步骤如下：

1. 增加函数对目标回调接口传递lua function
2. 在该回调lua_CFunction里面，把lua function注册到事件管理器，同时增加自己的事件类型
3. 在目标触发回调的地方，派发事件，传递自己的数据
4. 把数据传递到注册起来的函数中

第一、二步如下代码：

1. static int lua_cocos2dx_AssetsManager_setDelegate(lua_State* L)
2. {
3. if (nullptr == L)
4. return 0;
5. 
   
6. int argc = 0;
7. AssetsManager* self = nullptr;
8. 
   
9. #if COCOS2D_DEBUG >= 1
10. tolua_Error tolua_err;
11. if (!tolua_isusertype(L,1,"AssetsManager",0,&tolua_err))goto tolua_lerror;
12. #endif
13. 
    
14. self = (AssetsManager*) tolua_tousertype(L,1,0);
15. 
    
16. #if COCOS2D_DEBUG >= 1
17. if (nullptr == self)
18. {
19. tolua_error(L,"invalid 'self' in function 'lua_cocos2dx_AssetsManager_setDelegate'\n", nullptr);
20. return 0;
21. }
22. #endif
23. 
    
24. argc = lua_gettop(L) - 1;
25. 
    
26. if (2 == argc)
27. {
28. #if COCOS2D_DEBUG >= 1
29. if (!toluafix_isfunction(L, 2,"LUA_FUNCTION", 0, &tolua_err) ||
30. !tolua_isnumber(L, 3, 0, &tolua_err) )
31. {
32. goto tolua_lerror;
33. }
34. #endif
35. LuaAssetsManagerDelegateProtocol* delegate = dynamic_cast<LuaAssetsManagerDelegateProtocol*>( self->getDelegate());
36. if (nullptr == delegate)
37. {
38. delegate = new LuaAssetsManagerDelegateProtocol();
39. if (nullptr == delegate)
40. return 0;
41. 
    
42. self->setUserObject(delegate);
43. self->setDelegate(delegate);
44. delegate->release();
45. }
46. 
    
47. LUA_FUNCTION handler = toluafix_ref_function(L, 2, 0);
48. ScriptHandlerMgr::HandlerType handlerType = (ScriptHandlerMgr::HandlerType) ((int)tolua_tonumber(L,3,0) + (int)ScriptHandlerMgr::HandlerType::ASSETSMANAGER_PROGRESS);
49. 
    
50. ScriptHandlerMgr::getInstance()->addObjectHandler((void*)delegate, handler, handlerType);
51. return 0;
52. }
53. 
    
54. CCLOG("'setDelegate' function of AssetsManager has wrong number of arguments: %d, was expecting %d\n", argc, 2);
55. return 0;
56. 
    
57. #if COCOS2D_DEBUG >= 1
58. tolua_lerror:
59. tolua_error(L,"#ferror in function 'setDelegate'.",&tolua_err);
60. return 0;
61. #endif
62. }

第三步：

1. int LuaEngine::handleAssetsManagerEvent(ScriptHandlerMgr::HandlerType type,void* data)
2. {
3. if (nullptr == data)
4. return 0;
5. 
   
6. BasicScriptData* eventData = static_cast<BasicScriptData*>(data);
7. if (nullptr == eventData->nativeObject ||nullptr == eventData->value)
8. return 0;
9. 
   
10. LuaAssetsManagerEventData* assetsManagerData = static_cast<LuaAssetsManagerEventData*>(eventData->value);
11. 
    
12. int handler = ScriptHandlerMgr::getInstance()->getObjectHandler((void*)eventData->nativeObject, type);
13. 
    
14. if (0 == handler)
15. return 0;
16. 
    
17. int ret = 0;
18. switch (type)
19. {
20. case ScriptHandlerMgr::HandlerType::ASSETSMANAGER_PROGRESS:
21. case ScriptHandlerMgr::HandlerType::ASSETSMANAGER_ERROR:
22. {
23. _stack->pushInt(assetsManagerData->value);
24. ret = _stack->executeFunctionByHandler(handler,1);
25. }
26. break;
27. 
    
28. case ScriptHandlerMgr::HandlerType::ASSETSMANAGER_SUCCESS:
29. {
30. ret = _stack->executeFunctionByHandler(handler,0);
31. }
32. break;
33. 
    
34. default:
35. break;
36. }
37. 
    
38. return ret;
39. }

第四步：

1. int LuaStack::executeFunctionByHandler(int nHandler,int numArgs)
2. {
3. int ret = 0;
4. if (pushFunctionByHandler(nHandler))/* L: ... arg1 arg2 ... func */
5. {
6. if (numArgs > 0)
7. {
8. lua_insert(_state, -(numArgs + 1));/* L: ... func arg1 arg2 ... */
9. }
10. ret = executeFunction(numArgs);
11. }
12. lua_settop(_state, 0
13. return ret;
14. }