浅析C++绑定到Lua的方法

注：原文也在公司内部论坛上发了 

概述

---

      尽管将C++对象绑定到Lua已经有tolua++(Cocos2d-x 3.0用的就是这个)、LuaBridge(我们游戏client对这个库进行了改进)和luabind等各种库能够直接使用了（lua-users.org上有对各种语言绑定到lua库的汇总），但弄清楚C++对象绑定到Lua的常见方法，不但有助于更深的了解Lua的机制，还能够方便改动第三方库以满足实际项目需求。

本文通过分析第三方库Lunar（我们游戏服务端用的是Luna，Lunar是Luna添加版。但仍然足够简洁）的实现，来理解C++对象绑定到Lua的通常方法。Lunar的測试代码放在我的github上。

 

Lunar实现的功能以及原理

---

       Lunar实现很简洁，同一时候实现了C++绑定到Lua主要功能。使用Lunar至少能够做到下面几点：

       1、在脚本中，能够使用注冊过的类创建C++对象，此类C++对象，由Lua控制何时释放。

       2、在C++创建的对象，能够压入栈中，供脚本使用这个对象，而且提供一个可选參数。来决定这个对象是由C++控制释放，还是Lua控制释放。

       3、脚本中的C++类对象。能够调用注冊过的类成员函数。

       4、在C++中，能够获取在脚本中创建的对象。而且在C++中能够调用这个对象的成员函数。

       5、能够在脚本中定义对象的成员函数，而且能在C++中调用这些用脚本实现的成员函数。

 

       在脚本中创建C++对象，实质返回给脚本是一个userdata类型的值ud。ud中保存一个指针，该指针指向所创建的C++对象。这时候Lua控制对象何时释放，即在Lua在回收userdata时，同一时候利用userdata的元表__gc字段来回收动态分配的对象， 这时候就不须要C++释放内存了。注意这里返回给脚本不能是lightuserdata。由于lightuserdata实质上仅仅是一个指针。不受垃圾回收收集器的管理，而且它也没有元表。

 

       在脚本中创建的对象是由Lua来维护对象的生命周期。

在Lunar中还能够使用Lunar<T>::push(lua_State *L, T *obj, bool gc=false)向栈中压入对象供脚本使用，当中第三个參数能够决定创建的对象是由C++控制释放。还是Lua控制释放。 其原理是在把要传递给Lua的对象obj压入栈时，它首先利用对象地址在lookup表中查找（lookup是一个mode为"v"的weak table。保存全部在脚本中使用的对象。该表的key是对象地址。value是对象相应的userdata），若不在lookup中。则会创建一个新的userdata。并把它保存在lookup中，若第三个參数为false，即由C++控制对象释放。还会把上面的userdata保存在一个nottrash表中，nottrash是一个mode为"k"的weak table，保存全部不会随userdata回收其对应对象也释放的userdata，该表key为userdata。value为true。

这样处理后，在Lua回收userdata时，首先检測userdata是否在nottrash中。若不在。则删除userdata所指向对象，否则须要C++自己释放所创建的对象。

 

       在调用Lunar<T>::Register(lua_State *L)向脚本注冊类时，会创建两个表，一个是methods表。该表的key为函数名，value为函数地址（函数能够是C++中定义类的方法，也能够在Lua中定义函数），在Lua中调用的对象方法。都保存在该表中；还有一个是metatable表，做为userdata的元表，该metatable表保存了上面的lookup表和nottrash表。而且设置了metatable.__metatable = methods，这样在脚本中就隐藏了metatable表，也就是说在Lua中，调用getmetatable(userdata)得到的是methods表，而不是metatable表，在脚本中，给对象加入成员方法也是会保存在methods表中。

 

Lunar源代码分析

---

      以下逐行分析了Luanr的实现，在附件中是Lunar的測试代码。例如以下：