在c++中集成lua脚本

作者： 沐枫 （第二人生成员）
版权所有转载请注明原出处
主页：第二人生 http://www.d2-life.com
　　　http://www.d2-life.com/lbs/blogview.asp?logid=41

为什么要用lua作脚本？
　　使用lua作脚本，主要是因为它小巧玲珑（体积小，运行快），而且它的语法又比较简单明了。不过，使用luaapi将lua引擎集成到程序中，确实有一些不方便——用落木随风网友的话来说，就是"就象用汇编"。当然，现在你不用再这么辛苦了，因为你可以使用luawrapper for c++。使用这个工具，在c++中集成lua脚本就是轻而易举的事。你原有的c++函数和类，几乎不需要任何改变，就可以与lua脚本共享。
　　我们接下来，用实例来说明，如何用luawrapper来集成lua脚本到你的程序中去。

1.??创建lua引擎
　　luawrap lua; 或者 luawrap* lua = new luawrap;
　　创建一个luawrap对象，就是创建一个lua脚本引擎。并且根据lua的特性，你可以创建任意多个lua引擎，甚至可以分布在不同的线程当中。

2.??装载并执行脚本程序
　　你可以从缓冲区中装载lua脚本：
　　lua.loadstring(
　　　　"print('hello world')"
　　);
　　当然，你也可以从文件中装入，并执行lua脚本：
　　lua.loadfile("./test.lua");
　　lua的脚本，可以是源代码，也可以经过编译后的中间代码。也许你对编译后的中间代码更感兴趣——如果你不希望让源代码赤裸裸的袒露在大家的眼前。

3.??获取和设置lua变量
　　能够获取和设置脚本变量的内容，是一个最基本的功能。你可以使用getglobal和setglobal函数来做到这一点：
　　(1)??获取变量：
　　　　int a = lua.getglobal("a");
　　　　luatable table = lua.getglobal("t");
　　　　这里，<> 里头的类型，就是想要的变量的类型。
　　(2)??设置变量：
　　　　lua.setglobal("a", a);
　　　　lua.setglobal("t", table);

4.??调用lua函数
　　使用call函数，就可以很简单的从你的程序中调用lua函数：
　　lua.call("print", "hello world");
　　int sum = lua.call("add", 2, 3);
　　这里，<> 里头的类型是返回值的类型。

5.??如何让lua也能调用c++的函数
　　精采的地方来了。假如有下面这样的一个函数：
　　int add(int a, int b)
　　{
　　　　return a + b;
　　}
　　如果想让它能够让lua使用，只需将它注册到lua引擎当中就可以了：
　　lua.registerfunc("add", int(int,int), add);
　　这样，lua中就可以用直接使用了：
　　（lua脚本）sum = add(1, 3)

　　(*) registerfunc的功能，就是让你把c++的函数注册到lua中，供lua脚本使用。
　　　　第一个参数，是想要在lua中用的函数名。
　　　　第二个参数，是c++中函数的原型； c++允许函数重载的，你可以使用函数原型，来选择需要注册到lua引擎中的那个函数。
　　　　第三个参数，就是c++中函数的指针了。

6.??如何能让c++的类在lua中使用
　　我们先看看下面这个c++类：
class myarray
{
??std::vector array;
public:
??void setvalue(int index, double value);
??double getvalue(int index);
??int size();
??const char* tostring();
};

　　你准备要让lua能够自由访问并操作这个类。很简单，你只需增加几个宏定义就可以了：

class myarray
{
??std::vector array;
public:
??void setvalue(int index, double value);
??double getvalue(int index);
??int size();
??const char* tostring();
??// 将一个 class 作为一个 lua 对象是很容易的，只需要增加以下宏定义。
??define_typename("my.array");
??begin_reglualib("array")
??????lualib_item_create("new", myarray )??// 创建myarray?
??????lualib_item_destroy("del", myarray )??// 消除myarray。
??end_reglualib()
??begin_reglualib_member()
????lualib_item_func("size", int (myarray*), &myarray::size)
????lualib_item_func("__getindex", double(myarray*, int), &myarray::getvalue)??
????lualib_item_func("__newindex", void (myarray*, int, double), &myarray::setvalue)
????lualib_item_func("__tostring", const char* (myarray*), &myarray::tostring)
????lualib_item_destroy("__gc", myarray ) ??// 垃圾收集时消除对象用。
??end_reglualib_member()
};

　　只要有了这些宏定义，这个类就是可以在lua中使用的类了，我们就可以在lua中注册这个类了：
　　lua.register()

　　这样注册以后，我们在lua中就可以使用这个类了：
　　a = array.new()??-- 创建对象，相当于 a = new myarray
　　a[1] = 10??-- 调用__newindex，也就是c++中的 a->setvalue(1, 10)
　　a[2] = 20??-- 调用__newindex，也就是c++中的 a->setvalue(2, 20)
　　print(
　　　　a,??-- 调用 __tostring，也就是c++中的 a->tostring()
　　　　a:size(), -- 相当于c++中的 a->size()
　　　　a[1], -- 调用__getindex，也就是c++中的a->getvalue(1)
　　　　a[2]) --调用__getindex，也就是c++中的a->getvalue(2)
　　array.del(a)??-- 清除对象，相当于 delete a
　　a = nil??-- 清空 a，很象c++中的 a = null

　　当然，你也可以不用del这个对象，而是等待lua帮你自动进行垃圾回收。在lua进行垃圾回收时，它会自动调用这个对象的 __gc ，相当于 delete。

　　那么，在c++中要创建myarray对象，并且传递给lua全局变量怎么办？就象前面讲过的一样，使用setglobal：
　　myarray* a = new myarray;
　　lua.setglobal("a", a);
　　要获取该对象，同样的，应该使用getglobal：
　　myarray* a = lua.getglobal("a");
　　
　　对于传递给lua的对象，就让lua来管理该对象的生存周期好了。如果你非要删除它的话，你可以使用delglobalobject：
　　lua.delglobalobject("a");
　　不过这么做的话，你应当明白你在做什么，因为在lua的脚本中，可能已经在多处引用了这个对象了。删除了其中一个，将导致其它引用对象失效，从而可能引致系统崩溃。

　　(1)??define_typename("my.array");
　　　　定义类型的名称。在lua中，这个类型名称是唯一用来识别c++类型的，你必须为不同的对象给予不同的名称。

　　(2)??begin_reglualib("array") … end_reglualib()
　　　　你可以为一个对象定义一个程序库，"array"就是程序库的名字。在程序库中定义的函数是全局函数，在lua中，使用该函数，需要在函数前加上库的名字，如：array.new（）。通常，程序库会包含创建对象的方法。如：
　　　　lualib_item_create("new", myarray )??// 创建myarray
　　　　这样子，你才能在lua中创建myarray：
　　　　a = array.new()
　　
　　　　你也可以选择增加一个删除对象操作：
　　　　lualib_item_destroy("del", myarray ) ??// 删除myarray
　　　　这样，你就可以直接删除一个对象了：
　　　　array.del(a)

　　(3)??begin_reglualib_member() …end_reglualib_member()
在此处，你可以定义对象的成员函数，也可以重载对象的操作符——是的，就象c++的operator重载。例如：
　　　　lualib_item_func("__newindex", void (myarray*, int, double), &myarray::setvalue)
　　　　就是重载 operator[] 操作符。lua中可重载的操作符还有许多，如：

　　　　__getindex：操作符[]，支持读取访问，如 v = a[10]
　　　　__newindex：操作符[]，支持赋值访问，如 a[10] = 1.22
　　　　__tostring：将变量转换成字串__add：等同于operator +
　　　　__add：操作符 ＋
　　　　__sub：操作符 ╟
　　　　__mul：操作符 ×
　　　　__div：操作符 ÷
　　　　__pow：操作符 ^ (乘方)
　　　　__unm：一元操作符 ╟
　　　　__concat：操作符 .. (字符串连接)
　　　　__eq：操作符 == (a ~= b等价于 not a == b)
　　　　__lt：操作符 < (a > b 等价于 b < a)
　　　　__le：操作符 <= (a >= b 等价于 b <= a，要注意的是，如果没有定义"__le"，则lua将会尝试将a<=b 转换成 not (b < a) )

　　　　__gc：在垃圾回收时调用此函数，相当于c++的析构函数。强烈建议定义此操作符，以免造成内存泄漏等情况。比如：
　　　　lualib_item_destroy("__gc", myarray ) ??// 垃圾收集时消除对象用。

　　　　(注) 这里要说明一下，在lua中，访问索引操作符是__index，不是__getindex，在luawrapper库中，为了方便使用，将其映射为__getindex，同时，对__index的定义将会被忽略。

　　　　就这么简单。假如你已经有现成的类，而你没有修改该类的权力，如何将其加入到lua中呢？答案就是，继承它，将把派生类加入到lua中。

结束语
　　luawrapper 需要用到boost库的支持：boost/type_traits.hpp, boost/function.hpp, boost/bind.hpp，它使用了c++的模板部份特化，因此，c++编译器如果不支持此特性，将无法编译。目前支持此特性的编译器已经有很多。在visualstudo产品系列中，只有vc7.1能支持此特性，因此，您如果正在使用visualstudio，请确认你用的是visualstudio2003。
　　如果你觉得 luawrapper for c++ 能够帮助你，我会感觉很荣幸。我很愿意将这个程序库分享给大家。顺便一提的是，如果你在使用过程中发现bug，或是有好的建议，希望您能与我联系。你在使用过程中，请不要删除文件中的署名信息；如果你修改了程序库，请您在修改的文件中加入您的修改说明。当然，我会非常欢迎您能将修改后的程序回馈给我。我会继续优化并完善它