lua: tolua++实现分析

项目正在使用cocos2dx的lua绑定，绑定的方式是tolua++。对大规模使用lua代码信心不是很足，花了一些时间阅读tolua++的代码，希望对绑定实现的了解，有助于项目对lua代码的把控。从阅读结果上来看，起码在内存管理上，帮助还是很大的。

1.tolua++如何将c++对象导入到lua里

tolua++为每一个传入lua的对象建立一个userdata，userdata的值，是c++对象的地址。userdata的metatable，是一个tolua++建立的，记录了userdata对应c++类型信息的表格，包括导出的成员变量、成员函数等信息。

对于成员变量的读取赋值，tolua++是在metatable里新建了.get和.set两个表。两个表里分别存储了以变量名为键，以读取设置c函数为值的表项。在metatable的__index和__newindex里，以变量名为键，从.get和.set表里取得读取设置函数并调用。

对于成员函数的调用，只需要以函数名为键，函数为值，存储在metatable里就好了。

传入c++对象的tolua++函数是tolua_pushusertype。一般情况下，第一次使用这个函数将一个c++对象push到lua堆栈上时，才会新建userdata。tolua++会以c++对象地址为键，userdata为值，将键值对存储在tolua_ubox表里。下次推入同样的c++对象时，从这个表里取出userdata推入堆栈即可。

—————————————————

2.tolua++如何处理类型的继承

父类的metatable,是子类metatable的metatable。这样调用父类方法时，就会去父类的metatable里查找了。

tolua++还维护了一个tolua_super表，这个表以c++类型的metatable为键，以一个表格为值。这个值表格以类型名称为键，以true为值，记录了metatable对应c++类型的父类有哪些。这个表格可以用来帮助判断对象是否是某一个类型（子类实例也可以认为是父类类型）

—————————————————

3.tolua++如何管理对象的生命周期

一般情况下，当lua里对c++对象的引用变量可以被垃圾回收时，tolua++只是简单的释放userdata占用的4字节指针地址内存。但是也可以通过绑定或者代码指定的方式，让tolua++真正释放对象所占内存。

绑定的方式，是指在将c++类型构造函数使用tolua++导出到lua里时，tolua++会自动生成new_local方法。如果在lua代码里，用这个方法新建对象时，tolua++会调用tolua_register_gc方法，指明回收对象时回收对象内存。

在c++代码里，使用tolua_pushusertype_and_takeownership；在lua代码里，使用tolua.takeownership，都可以达到同样的目的。

对于这些指定由tolua++回收内存的对象，如果其类型的析构函数也通过tolua++导出了，则在回收内存时，会通过delete运算符，调用对象的析构函数。否则只会使用free方法回收。

tolua_register_gc方法，做的事情，是以对象指针为键，以对象metatable为值，将键值对存储在tolua_gc表里。在对象类型的metatable表的__gc方法里，tolua++会检查tolua_gc表是否包含以这个地址为键的表项。包含的话才会进行上述的内存回收工作。

4.其它

有的时候，在lua里取得一个c++对象后，我们想赋给它一些只在lua环境下有意义的属性。或者，我们想在lua里扩展一个c++类。tolua++也提供了实现这种需求的机制。

tolua++在LUA_REGISTRY里维护了一张tolua_peers表。这张表以表示c++对象的userdata为键，以一张表格t为值。t里面就记录了这个对象在lua里扩展的属性。

cocos2dx并没有完全使用tolua++的方式，而是自己进行了一些修正。下篇博客应该会记录修正的原因和方式，并介绍一些cocos2dx lua bind特定的东西。

cocos2dx的lua绑定

一、cocos2dx对tolua++绑定的修正

A.c对lua回调函数的引用

在使用cocos2dx编写游戏时，我们经常会设置一些回调函数（时钟、菜单选择等）。如果采用脚本方式编写游戏的话，这些回调函数也是需要写在脚本里的。实现这个功能，就需要lua将自己的函数传递给c++，c++保持对这个函数的引用，不要让这个lua函数被垃圾回收，并在适当的时候回调这个lua函数。

这种需求的一般抽象是在C环境下保存lua状态，在PIL(Programming In Lua)里有比较详尽的描述。可以使用luaL_ref函数，将一个luaValue(function、table等没有直接对应c类型的数据)存储到LUA_REGISTRY里（luaL_ref返回一个唯一整数，c++可以用这个整数来索引对应的luaValue）

不过cocos2dx因为某种原因，并没有使用这个功能，而是自己实现了一套类似的引用机制。

cocos2dx注册回调函数的接口，除了一个参数为c函数指针的版本外，都会提供一个参数为int的对应版本。阅读一下自动生成的cocos2dx lua绑定代码，会发现注册回调函数的接口，都会调用toluafix_ref_function函数，将lua函数转换为一个LUA_FUNCTION（int），并调用响应的注册回调函数的cocos2dx api。

这个toluafix_ref_function，定义在tolua_fix.c里，干的事情就很类似luaL_ref了。区别是对lua函数的引用，没有直接保存在LUA_REGISTRY里，而是放在一个自己创建的表格里。

B.野指针预防

使用已经释放的指针，通常是一个令人头疼的bug来源。如果能提早发现对野指针的使用，对于bug的定位有很大好处。tolua_fix.c里也提供了这样一套检查机制。

阅读自动生成的cocos2dx lua绑定代码，会发现每当把一个继承自CCObject类型的对象传给lua时，会调用toluafix_pushusertype_ccobject函数。

如果这个对象是第一次传递给lua，toluafix_pushusertype_ccobject会为这个对象生成一个索引id，并将这个对象的指针、类型字符串和这个索引相关联。cocos2dx再将这个索引存储在CCObject数据结构里。

在c++里析构这个对象时，CCObject的析构函数会调用toluafix_remove_ccobject_by_refid。这个函数先利用整数索引，找到指针、类型字符串，再通过tolua的tolua_ubox表格（见tolua++实现分析），取到对象的userdata（值为对象的地址），将它置空。这样，以后lua环境再使用这个对象，调用这个对象的c接口时，只能取到空地址，错误也能提早发现了。

二、使用tolua++导出自定义类时，注意定制tolua++

上面提到的cocos2dx对tolua++的修正，体现在代码上，要对标准的tolua++自动生成的绑定代码，进行上百处修改。手工修改显然不适合。tolua++提供了通过重定义lua文件来定制自己的机制。

参考cocos2dx里调用tolua++的shell脚本命令

${TOLUA} -L basic.lua -o ../../scripting/lua/cocos2dx_support/LuaCocos2d.cpp Cocos2d.pkg

这里的-L basic.lua就指定了一个重定义文件。

在这个文件里，指定了LUA_FUNCTION类型的转换函数（toluafix_ref_function）、类型判断函数（toluafix_isfunction），指定了对哪些继承自CCObject的类型，使用自定的推入函数（toluafix_pushusertype_ccobject），另外还进行了一些文本替换，达到一些特殊的功能。

如果你的导出类需要注册lua回调函数，或者继承自CCObject，那么这个重定义文件的帮助就很大了。另外还要注意，在tolua++的pkg定义文件里，对回调函数，使用LUA_FUNCTION做类型名称，而不是int(与重定义文件一致)

三、lua里的类型系统，对c++类型的继承

游戏开发是比较适合使用面向对象模型的，lua语言本身虽然没有提供面向对象模型，但是通过它的metatable机制，也有各种方式来实现这种模型。cocos2dx的LuaTest工程的extern.lua文件里，就提供了一种方式，既可以继承lua里的table类型，又可以通过调用c++生成对象接口的方式，继承c++类型。对c++对象的继承，在子类新增成员时，使用了tolua++的peer功能，给userdata添加字段。

四、其它的cocos2dx lua资源

quick-cocos2d-x

提供了一整套成熟的cocos2dx lua framework。上面提到的lua++绑定修正、类型继承方式，cocos2dx应该都是吸收了quick-cocos2d-x中的相应功能。

本文上面对lua++绑定修正的分析，也得到了quick-cocos2d-x作者dualface的帮助。

cocos2dx-LuaProxy

针对cocos2dx-extension的lua绑定做了一些工作。包括绑定cocosbuilder、tableview等

五、cocos2dx 2.1.4

在cocos2dx 2.1.4的change log上看到新增了大部分lua test。如果是这样的话，那么对lua绑定的支持又上了一个台阶。

令我比较感兴趣的更新是对cocosbuilder的新绑定方式。相较cocos2dx-LuaProxy对cocosbuilder的绑定，新的绑定采用类似官方js绑定的方式，每个cocosbuilder自定义类型对应一个lua里面的模块，自动导出cocosbuilder的成员变量到对应模块里。虽然要写模块定义文件，但对于较大型项目，这种方式感觉更合适一些。