导出C++到LUA

Lua是现在比较常用的一种脚本语言,尤其在游戏开发领域。平时经常需要将C++的类、函数、变量等导出到Lua,以在脚本中编写逻辑。有很多现有的库,如LuaBind、LuaPlus、ToLua++等,可以实现该功能。下面简要描述下原理,假定读者对Lua有基本的掌握。

注册C++类到Lua有几个步骤:

1.注册C++类定义

  • A.添加一个以类名命名的table到Lua全局表。

  • B.添加一个以类名命名的matatable,并将其设为A中table的matatable。接下来的类成员变量和函数都会添加到这个metatable中。

2.注册C++类成员变量

  • A.设置1.B中metatable的__index__newindex等metamethod为实现了get、set等操作的c函数。Lua脚本中索引类成员变量进行取值或设值操作时,将调用对应的的c函数。

  • B.将类成员变量以变量名为键,以成员变量偏移为值,添加到1.B的metatable中。为了方便2.A的get、set等C函数操作,我们可能对该数据用结构体做数据封装。

3.注册C++成员函数

  • A.与2.B类似,但我们以函数名为键,以一个ccloure作为值。该closure包括一个类似get/set的以函数偏移作为upvalue的c函数。同样为了该c函数的操作方便,我们可能对该upvalue用结构体做数据封装。

4.注册C++类实例

  • A. 创建一个userdata来保存该实例地址,同样也可能用结构体做数据封装,并设置1.B的metatable作为该userdata的metatable。该userdata会以实例名为键添加到Lua全局表。

下面举例说明实际调用流程。

  • 假设C++中有如下类A,其有成员函数f,成员变量v,A的一个实例为a。我们已经进行了上述工作将所有数据注册到Lua脚本。

  • 当在脚本中调用a.f()时,a在Lua全局表,实际为4.A所述userdata,userdata中没有f,则到其1.B中metatable查找,由于metable设置了__index元方法,会使用2.A中的get函数将f为键值的即3.A中所述cclosure放到栈顶,然后进行()函数调用,执行3.A中C函数,该C函数取得a实例地址aa,根据upvalue取得函数偏移fo,最终调用aa->fo(),即成功执行。

  • 当在脚本使用local data = a.v时,流程类似,但会在get函数中根据实例地址aa和成员变量偏移fo取aa->fo值设给data,而不进行后续操作。

  • 当在脚本使用a.v = data时,流程类似,但会使用__newindex元方法set函数,实例地址aa和成员变量偏移vo得到aa->vo并设置data值。

理解了类似方法和思想,再添加更多特性比如继承类注册、全局函数注册等,就相对容易了。

本文导出方法参考了网络上的部分实现,代码在这里