在C++中集成Lua脚本

为什么要用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，或是有好的建议，希望您能与我联系。你在使用过程中，请不要删除文件中的署名信息;如果你修改了程序库，请您在修改的文件中加入您的修改说明。当然，我会非常欢迎您能将修改后的程序回馈给我。我会继续优化并完善它。