在C++中集成Lua脚本

 

http://xiaobang185.blog.163.com

C++中集成Lua脚本 ( Mon, 10 Sep 2007 17:32:31 +0800 )

Description:

 

在C++中集成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。

　　如果你觉得 LuaWrapperFor C++能够帮助你，我会感觉很荣幸。我很愿意将这个程序库分享给大家。顺便一提的是，如果你在使用过程中发现BUG，或是有好的建议，希望您能与我联系。你在使用过程中，请不要删除文件中的署名信息；如果你修改了程序库，请您在修改的文件中加入您的修改说明。当然，我会非常欢迎您能将修改后的程序回馈给我。我会继续优化并完善它。

需要下载 LuaWrapper For C++，请到 http://www.d2-life.com/LBS/blogview.asp?logID=41

 

LUA脚本语言 ( Mon, 10 Sep 2007 17:31:10 +0800 )

Description:

Lua脚本语法说明（增加lua5.1部份特性）

　　Lua 的语法比较简单，学习起来也比较省力，但功能却并不弱。

　　所以，我只简单的归纳一下Lua的一些语法规则，使用起来方便好查就可以了。估计看完了，就懂得怎么写Lua程序了。

　　在Lua中，一切都是变量，除了关键字。

I.  首先是注释

　　写一个程序，总是少不了注释的。

　　在Lua中，你可以使用单行注释和多行注释。

　　单行注释中，连续两个减号"--"表示注释的开始，一直延续到行末为止。相当于C++语言中的"//"。

　　多行注释中，由"--[["表示注释开始，并且一直延续到"]]"为止。这种注释相当于C语言中的"/*...*/"。在注释当中，"[["和"]]"是可以嵌套的（在lua5.1中，中括号中间是可以加若干个"="号的，如 [==[ ... ]==]），见下面的字符串表示说明。

II.  Lua编程

　　经典的"Hello world"的程序总是被用来开始介绍一种语言。在Lua中，写一个这样的程序很简单：

　　print("Hello world")

　　在Lua中，语句之间可以用分号"；"隔开，也可以用空白隔开。一般来说，如果多个语句写在同一行的话，建议总是用分号隔开。

　　Lua 有好几种程序控制语句，如：

控制语句格式示例Ifif 条件 then ... elseif 条件 then ... else ... end

if 1+1=2 then print("true")

elseif 1+2~=3 then print("true")

else print("false") end

Whilewhile 条件 do ... end

while 1+1~=2 do print("true") end

Repeatrepeat ... until 条件

repeat print("Hello") until 1+1~=2

Forfor 变量=初值, 终点值, 步进 do ... end

for i = 1, 10, 2 do print(i) end

Forfor 变量1, 变量2, ... 变量n in 表或枚举函数 do ... end

for a,b in mylist do print(a, b) end

　　注意一下，for的循环变量总是只作用于for的局部变量；当省略步进值时，for循环会使用1作为步进值。

　　使用break可以用来中止一个循环。

　　相对C语言来说，Lua有几个地方是明显不同的，所以面要特别注意一下：

　　．语句块

　　　　语句块在C中是用"{"和"}"括起来的，在Lua中，它是用do 和 end 括起来的。比如：

　　　　do print("Hello") end

　　　　可以在 函数 中和 语句块 中定局部变量。

　　．赋值语句

　　　　赋值语句在Lua被强化了。它可以同时给多个变量赋值。

　　　　例如：

　　　　a,b,c,d=1,2,3,4

　　　　甚至是：

　　　　a,b=b,a  -- 多么方便的交换变量功能啊。

　　　　在默认情况下，变量总是认为是全局的。假如需要定义局部变量，则在第一次赋值的时候，需要用local说明。比如：

　　　　local a,b,c = 1,2,3  -- a,b,c都是局部变量

　　．数值运算

　　　　和C语言一样，支持 +, -, *, /。但Lua还多了一个"^"。这表示指数乘方运算。比如2^3 结果为8, 2^4结果为16。

　　　　连接两个字符串，可以用".."运处符。如：

　　　　"This a " .. "string." -- 等于 "this a string"

　　．比较运算

比较符号<><=>===~=含义小于大于小于或等于大于或等于相等不相等

　　　　所有这些操作符总是返回true或false。

　　　　对于Table，Function和Userdata类型的数据，只有 == 和 ~=可以用。相等表示两个变量引用的是同一个数据。比如：

　　　　a={1,2}

　　　　b=a

　　　　print(a==b, a~=b)  --输出 true, false

　　　　a={1,2}

　　　　b={1,2}

　　　　print(a==b, a~=b)  --输出 false, true

　　．逻辑运算

　　　　and, or, not

　　　　其中，and 和 or 与C语言区别特别大。

　　　　在这里，请先记住，在Lua中，只有false和nil才计算为false，其它任何数据都计算为true，0也是true！

　　　　and 和 or的运算结果不是true和false，而是和它的两个操作数相关。

　　　　a and b：如果a为false，则返回a；否则返回b

　　　　a or b：如果 a 为true，则返回a；否则返回b

　　　　举几个例子：

　　　　 print(4 and 5) --输出 5

　　　　 print(nil and 13) --输出 nil

　　　　 print(false and 13) --输出 false

　　　　 print(4 or 5) --输出 4

　　　　 print(false or 5) --输出 5

　　　　在Lua中这是很有用的特性，也是比较令人混洧的特性。

　　　　我们可以模拟C语言中的语句：x = a? b : c，在Lua中，可以写成：x = a and b or c。

　　　　最有用的语句是： x = x or v，它相当于：if not x then x = v end 。

　　．运算符优先级，从低到高顺序如下：

     or

     and

     <     >     <=    >=    ~=    ==

     .. (字符串连接)

     +     -

     *     /     %

     not   #(lua5.1 取长度运算)     - (一元运算)

     ^

和C语言一样，括号可以改变优先级。

III.  关键字

　　关键字是不能做为变量的。Lua的关键字不多，就以下几个：

     andbreakdoelseelseifendfalseforfunctionifinlocalnilnotorrepeatreturnthentrueuntilwhile

IV.  变量类型

　　怎么确定一个变量是什么类型的呢？大家可以用type()函数来检查。Lua支持的类型有以下几种：

Nil空值，所有没有使用过的变量，都是nil。nil既是值，又是类型。Boolean布尔值，只有两个有效值：true和falseNumber数值，在Lua里，数值相当于C语言的doubleString字符串，如果你愿意的话，字符串是可以包含"/0"字符的（这和C语言总是以"/0"结尾是不一样的）Table关系表类型，这个类型功能比较强大，请参考后面的内容。Function函数类型，不要怀疑，函数也是一种类型，也就是说，所有的函数，它本身就是一个变量。Userdata嗯，这个类型专门用来和Lua的宿主打交道的。宿主通常是用C和C++来编写的，在这种情况下，Userdata可以是宿主的任意数据类型，常用的有Struct和指针。Thread线程类型，在Lua中没有真正的线程。Lua中可以将一个函数分成几部份运行。如果感兴趣的话，可以去看看Lua的文档。

现在回过头来看看，倒觉得不是线程类型。反而象是用来做遍历的，象是Iterator函数。

如：

function range(n)

  local i = 0

  while(i < n) do

    coroutine.yield( i )

    i = i + 1

  end

end

可惜的是要继续运行，需要coroutine.resume函数，有点鸡肋。请指教。

V.  变量的定义

　　所有的语言，都要用到变量。在Lua中，不管在什么地方使用变量，都不需要声明，并且所有的这些变量总是全局变量，除非我们在前面加上"local"。这一点要特别注意，因为我们可能想在函数里使用局部变量，却忘了用local来说明。

　　至于变量名字，它是大小写相关的。也就是说，A和a是两个不同的变量。

　　定义一个变量的方法就是赋值。"＝"操作就是用来赋值的

　　我们一起来定义几种常用类型的变量吧。

　　A.  Nil

　　　　正如前面所说的，没有使用过的变量的值，都是Nil。有时候我们也需要将一个变量清除，这时候，我们可以直接给变量赋以nil值。如：

　　　　var1=nil  -- 请注意 nil 一定要小写

　　B.  Boolean

　　　　布尔值通常是用在进行条件判断的时候。布尔值有两种：true 和false。在Lua中，只有false和nil才被计算为false，而所有任何其它类型的值，都是true。比如0，空串等等，都是true。不要被C语言的习惯所误导，0在Lua中的的确确是true。你也可以直接给一个变量赋以Boolean类型的值，如：

　　　　theBoolean = true

　　C.  Number

　　　　在Lua中，是没有整数类型的，也不需要。一般情况下，只要数值不是很大（比如不超过100,000,000,000,000），是不会产生舍入误差的。在WindowsXP能跑的当今主流PC上，实数的运算并不比整数慢。

　　　　实数的表示方法，同C语言类似，如：

　　　　4 0.4 4.57e-3 0.3e12 5e+20

　　D.  String

　　　　字符串，总是一种非常常用的高级类型。在Lua中，我们可以非常方便的定义很长很长的字符串。

　　　　字符串在Lua中有几种方法来表示，最通用的方法，是用双引号或单引号来括起一个字符串的，如：

　　　　"That's go!"

　　　　或

　　　　'Hello world!'

　　　　和C语言相同的，它支持一些转义字符，列表如下：

　　　　/a  bell

　　　　/b  back space

　　　　/f  form feed

　　　　/n  newline

　　　　/r  carriage return

　　　　/t  horizontal tab

　　　　/v  vertical tab

　　　　//  backslash

　　　　/"  double quote

　　　　/"  single quote

　　　　/[  left square bracket

　　　　/]  right square bracket

　　　　由于这种字符串只能写在一行中，因此，不可避免的要用到转义字符。加入了转义字符的串，看起来实在是不敢恭维，比如：

　　　　"one line/nnext line/n/"in quotes/", "in quotes""

　　　　一大堆的"/"符号让人看起来很倒胃口。如果你与我有同感，那么，我们在Lua中，可以用另一种表示方法：用"[["和"]]"将多行的字符串括起来。（lua5.1: 中括号中间可以加入若干个"="号，如 [==[ ... ]==]，详见下面示例）

　　　　示例：下面的语句所表示的是完全相同的字符串：

a = 'alo/n123"'

a = "alo/n123/""

a = '/97lo/10/04923"'

a = [[alo

123"]]

a = [==[

alo

123"]==]

　　　　值得注意的是，在这种字符串中，如果含有单独使用的"[["或"]]"就仍然得用"/["或"/]"来避免歧义。当然，这种情况是极少会发生的。

　　E.  Table

　　　　关系表类型，这是一个很强大的类型。我们可以把这个类型看作是一个数组。只是C语言的数组，只能用正整数来作索引；在Lua中，你可以用任意类型来作数组的索引，除了nil。同样，在C语言中，数组的内容只允许一种类型；在Lua中，你也可以用任意类型的值来作数组的内容，除了nil。

　　　　Table的定义很简单，它的主要特征是用"{"和"}"来括起一系列数据元素的。比如：

　　　　T1 = {}  -- 定义一个空表

　　　　T1[1]=10  -- 然后我们就可以象C语言一样来使用它了。

　　　　T1["John"]={Age=27, Gender="Male"}

　　　　这一句相当于：

　　　　T1["John"]={}  -- 必须先定义成一个表，还记得未定义的变量是nil类型吗

　　　　T1["John"]["Age"]=27

　　　　T1["John"]["Gender"]="Male"

　　　　当表的索引是字符串的时候，我们可以简写成：

　　　　T1.John={}

　　　　T1.John.Age=27

　　　　T1.John.Gender="Male"

　　　　或

　　　　T1.John{Age=27, Gender="Male"}

这是一个很强的特性。

　　　　在定义表的时候，我们可以把所有的数据内容一起写在"{"和"}"之间，这样子是非常方便，而且很好看。比如，前面的T1的定义，我们可以这么写：

　　　　T1=

　　　　{

　　　　　　10,  -- 相当于 [1] = 10

　　　　　　[100] = 40,

　　　　　　John=  -- 如果你原意，你还可以写成：["John"] =

　　　　　　{

　　　　　　　　Age=27,   -- 如果你原意，你还可以写成：["Age"] =27

　　　　　　　　Gender=Male   -- 如果你原意，你还可以写成：["Gender"] =Male

　　　　　　},

　　　　　　20  -- 相当于 [2] = 20

　　　　}

　　　　看起来很漂亮，不是吗？我们在写的时候，需要注意三点：

　　　　第一，所有元素之间，总是用逗号"，"隔开；

　　　　第二，所有索引值都需要用"["和"]"括起来；如果是字符串，还可以去掉引号和中括号；

　　　　第三，如果不写索引，则索引就会被认为是数字，并按顺序自动从1往后编；

　　　　表类型的构造是如此的方便，以致于常常被人用来代替配置文件。是的，不用怀疑，它比ini文件要漂亮，并且强大的多。

　　F.  Function

　　　　函数，在Lua中，函数的定义也很简单。典型的定义如下：

　　　　function add(a,b)  -- add 是函数名字，a和b是参数名字

　　　　 return a+b  -- return 用来返回函数的运行结果

　　　　end

　　　　请注意，return语言一定要写在end之前。假如我们非要在中间放上一句return，那么就应该要写成：do return end。

　　　　还记得前面说过，函数也是变量类型吗？上面的函数定义，其实相当于：

　　　　add = function (a,b) return a+b end

当重新给add赋值时，它就不再表示这个函数了。我们甚至可以赋给add任意数据，包括nil （这样，赋值为nil，将会把该变量清除）。Function是不是很象C语言的函数指针呢？

　　　　和C语言一样，Lua的函数可以接受可变参数个数，它同样是用"..."来定义的，比如：

　　　　function sum (a,b,)

如果想取得...所代表的参数，可以在函数中访问arg局部变量（表类型）得到 (lua5.1: 取消arg，并直接用"..."来代表可变参数了，本质还是arg)。

　　　　如 sum(1,2,3,4)

　　　　则，在函数中，a = 1, b = 2, arg = {3, 4}  (lua5.1:  a = 1, b = 2, ... = {3, 4})

　　　　更可贵的是，它可以同时返回多个结果，比如：

　　　　function s()

　　　　　　return 1,2,3,4

　　　　end

　　　　a,b,c,d = s()  -- 此时，a = 1, b = 2, c = 3, d = 4

　　　　前面说过，表类型可以拥有任意类型的值，包括函数！因此，有一个很强大的特性是，拥有函数的表，哦，我想更恰当的应该说是对象吧。Lua可以使用面向对象编程了。不信？举例如下：

　　　　t =

　　　　{

　　　　 Age = 27

　　　　 add = function(self, n) self.Age = self.Age+n end

　　　　}

　　　　print(t.Age)  -- 27

　　　　t.add(t, 10)

　　　　print(t.Age)  -- 37

　　　　不过，t.add(t,10) 这一句实在是有点土对吧？没关系，在Lua中，我们可以简写成：

　　　　t:add(10)    -- 相当于 t.add(t,10)

　　G.  Userdata 和 Thread

　　　　这两个类型的话题，超出了本文的内容，就不打算细说了。