Lua脚本在C++下的舞步（一）

**该文转载自网上**

     现在，越来越多的C++服务器和客户端融入了脚本的支持，尤其在网游领域，脚本语言已经渗透到了方方面面，比如你可以在你的客户端增加一个脚本，这个脚本将会帮你在界面上显示新的数据，亦或帮你完成某些任务，亦或帮你查看别的玩家或者NPC的状态。。。如此等等。

但是我觉得，其实脚本语言与C++的结合，远远比你在游戏中看到的特效要来的迅猛。它可以运用到方方面面的领域，比如你最常见的应用领域。比如，你可以用文本编辑器，写一个脚本语言，然后用你的程序加载一下，就会产生出很绚丽的界面。亦或一两句文本语言，就会让你的程序发送数据给服务器，是不是很酷呢？
本来我想，写一篇关于主流脚本语言Lua和Python的文章，但是感觉这样过于乏味，于是分开来一一介绍，相信对C++了解的你，看过我的文章后会对脚本语言这种东西产生浓厚的兴趣，我想起以前听的一个故事，当年Java的创造者讲课的时候，一开始先拿一个简单的不能简单的小例子，不断的扩展，最后成为一个复杂而完美的程序。今天我也就这样实验一下吧，呵呵。

当然，我本人不敢说对脚本语言了如指掌，只能说略微掌握一些，用过几年，偏颇之处请大家指正。
下面，开始吧，先说LUA！（本文面向初学者）

Lua语言（http://www.lua.org/），想必不少程序员都听过，据我所知，由于《魔兽世界》里面对它的加载，它一下子变成了很多游戏开发者竞相研究的对象，至于这个巴西创造者么，我不过多介绍，大家有兴趣可以谷歌一下。其实网上有很多关于lua的教材和例子，说真的，对于当年的我而言，几乎看不懂，当时很郁闷，感觉Lua复杂的要命，有些惧怕，后来沉下心来一点点研究，觉得其实还是蛮简洁的。只是网上的资料或许偏向于某些功能，导致了逻辑和代码的复杂。后来总结，其实学习一种脚本语言，完全可以抱着放松的心态一点点的研究，反而效果会更好。

在讲代码之前，我要说Lua的一些特点，这些特点有利于你在复杂的代码调用中，清晰的掌握中间的来龙去脉。实际上，你能常常用到的lua的API，不过超过10个，再复杂的逻辑。基本上也是这么多API组成的。至于它们是什么，下面的文章会介绍。另外一个重要之重要的概念，就是栈。Lua与别的语言交互以及交换数据，是通过栈完成的。其实简单的解释一下，你可以把栈想象成一个箱子，你要给他数据，就要按顺序一个个的把数据放进去，当然，Lua执行完毕，可能会有结果返回给你，那么Lua还会利用你的箱子，一个个的继续放下去。而你取出返回数据呢，要从箱子顶上取出，如果你想要获得你的输入参数呢？那也很简单，按照顶上返回数据的个数，再按顺序一个个的取出，就行了。不过这里提醒大家，关于栈的位置，永远是相对的，比如-1代表的是当前栈顶，-2代表的是当前栈顶下一个数据的位置。栈是数据交换的地方，一定要有一些栈的概念。

好了，基础的lua语法不在这里讲，百度一下有很多。
先去http://www.lua.org/ 去下载一个最新的Lua代码（现在稳定版是lua-5.1.4）。它的代码是用C写的，所以很容易兼容很多平台。
在linux下，目录src下就有专门的Makefile。很简单，啥都不用做，指定一下位置编译即可。
在windows下，以VS2005为例，建立一个空的静态库工程（最好不使用预编译头，把预编译头的选项勾去掉），然后把src下的所有文件（除了Makefile）一股脑拷到工程中去。然后将这些文件添加到你的工程中，编译，会生成一个*.llib(*是你起的lua库名)，行了，建立一个目录lib，把它拷过去，然后再建立一个include的文件夹，把你工程目录下的lua.h，lualib.h，lauxlib.h，拷贝过去。行了，拿着这两个文件夹，你就可以在你的工程里使用lua了。
行了，材料齐了，我们来看看怎么写一个简单的lua程序吧。

建立一个文件，起名Sample.lua
里面添加这样的代码。
function func_Add(x, y)
   return x+y;
end

这是一个标准的lua语法，一个函数，实现简单的a+b操作，并返回操作结果。
保存退出。
多一句嘴，在Lua里面，是可以支持多数据返回的。
比如你这么写：
function func_Add(x, y)
   return x+y, x-y;
end

意思是返回第一个参数是相加的结果，第二个是相减的结果，也是可以的。在lua里面没有类型的概念。当然，在C++接受这样的返回值的时候，也很简单，请往下看。
好了，材料齐备了，咱们来看看C++程序怎么调用它。
首先，建立一个类，负责加载这个lua文件，并执行函数操作，我们姑且叫做CLuaFn
要加载这个lua文件，按照正常的思路，我们应该先加载，然后再调用不同的函数。恩，对了，咱们就这么做。

1. extern "C"   
2. {  
3.         #include "lua.h"  
4.         #include "lualib.h"  
5.         #include "lauxlib.h"  
6. };  
7.   
8. class CLuaFn  
9. {  
10. public:  
11.         CLuaFn(void);  
12.         ~CLuaFn(void);  
13.   
14.         void Init();            //初始化Lua对象指针参数  
15.         void Close();         //关闭Lua对象指针  
16.   
17.         bool LoadLuaFile(const char* pFileName);                              //加载指定的Lua文件  
18.         bool CallFileFn(const char* pFunctionName, int nParam1, int nParam2);        //执行指定Lua文件中的函数  
19.   
20. private:  
21.         lua_State* m_pState;   //这个是Lua的State对象指针，你可以一个lua文件对应一个。  
22. };  

     恩，头文件就这么多，看看，一点也不复杂吧，看了cpp我想你会更高兴，因为代码一样很少。我一个个函数给你们介绍。

1. void CLuaFn::Init()  
2. {  
3.         if(NULL == m_pState)  
4.         {  
5.                 m_pState = lua_open();  
6.                 luaL_openlibs(m_pState);  
7.         }  
8. }  

初始化函数，标准代码，没啥好说的，lua_open()是返回给你一个lua对象指针，luaL_openlibs()是一个好东西，在lua4，初始化要做一大堆的代码，比如加载lua的string库，io库，math库等等等等，代码洋洋洒洒一大堆，其实都是不必要的，因为这些库你基本都需要用到，除了练习你的打字能力别的意义不大，因为代码写法都是固定的。于是在5以后，Lua的创造者修改了很多，这就是其一，一句话帮你加载了所有你可能用到的Lua基本库。

1. void CLuaFn::Close()  
2. {  
3.         if(NULL != m_pState)  
4.         {  
5.                 lua_close(m_pState);  
6.                 m_pState = NULL;  
7.         }  
8. }  

 

顾名思义，我用完了，关闭我的Lua对象并释放资源。呵呵，标准写法，没啥好说的。

1. bool CLuaFn:: LoadLuaFile(const char* pFileName)  
2.   
3. {  
4.   
5.         int nRet = 0;  
6.   
7.         if(NULL == m_pState)  
8.   
9.         {  
10.   
11.                 printf("[CLuaFn:: LoadLuaFile]m_pState is NULL./n");  
12.   
13.                 return false;  
14.   
15.         }  
16.   
17.   
18.   
19.         nRet = luaL_dofile(m_pState, pFileName);  
20.   
21.         if (nRet != 0)  
22.   
23.         {  
24.   
25.                 printf("[CLuaFn:: LoadLuaFile]luaL_loadfile(%s) is file(%d)(%s)./n", pFileName, nRet, lua_tostring(m_pState, -1));  
26.   
27.                 return false;  
28.   
29.         }  
30.   
31.   
32.   
33.         return true;  
34.   
35. }  

呵呵，这个有点意思，加载一个Lua文件。
这里我要详细的说一下，因为Lua是脚本语言，加载lua文件本身的时候才会编译。
所以，推荐大家在加载文件的时候尽量放在程序的初始化中，因为当你执行luaL_dofile()函数的时候，Lua会启用语法分析器，去分析你的脚本语法是否符合Lua规则，如果你胡乱的传一个文件过去，Lua就会告诉你文件语法错误，无法加载。如果你的Lua脚本很大，函数很多，语法分析器会比较耗时，所以，加载的时候，尽量放在合适的地方，而且，对于一个Lua文件而言，反复加载luaL_dofile()除了会使你的CPU变热没有任何意义。

或许你对printf("[CLuaFn:: LoadLuaFile]luaL_loadfile(%s) is file(%d)(%s)./n", pFileName, nRet, lua_tostring(m_pState, -1));这句话很感兴趣，这个在干什么？这里我先说lua_tostring(m_pState, -1)这是在干什么，还记得我说的Lua是基于栈传输数据的么？那么，如果报错，我怎么知道错误是什么？luaL_dofile标准返回一个int，我总不能到lua.h里面遍历这个nRet 是啥意思吧，恩，Lua创造者早就为你想好了，只不过你需要稍微动一下你的脑筋。Lua的创造者在语法分析器分析你的语法的时候，发现错误，会有一段文字告诉你是什么错误，它会把这个字符串放在栈顶。那么，怎么取得栈顶的字符串呢？lua_tostring(m_pState, -1)就可以，-1代表的是当前栈的位置是相对栈顶。当然，你也可以看看栈里面还有一些什么其他古怪的数据，你可以用1,2,3（这些是绝对位置，而-1是相对位置）去尝试，呵呵。不过，相信你得到的也很难看懂，因为一个Lua对象执行的时候，会用很多次栈进行数据交换，而你看到的，有可能是交换中的数据。那么，话说回来，这句话的意思就是"[CLuaFn:: LoadLuaFile]luaL_loadfile(文件名) is file(错误编号)(错误具体描述文字)./n"

1. bool CLuaFn::CallFileFn(const char* pFunctionName, int nParam1, int nParam2)  
2.   
3. {  
4.   
5.         int nRet = 0;  
6.   
7.         if(NULL == m_pState)  
8.   
9.         {  
10.   
11.                 printf("[CLuaFn::CallFileFn]m_pState is NULL./n");  
12.   
13.                 return false;  
14.   
15.         }  
16.   
17.   
18.   
19.         lua_getglobal(m_pState, pFunctionName);  
20.   
21.   
22.   
23.         lua_pushnumber(m_pState, nParam1);  
24.   
25.         lua_pushnumber(m_pState, nParam2);  
26.   
27.   
28.   
29.         nRet = lua_pcall(m_pState, 2, 1, 0);  
30.   
31.         if (nRet != 0)  
32.   
33.         {  
34.   
35.                 printf("[CLuaFn::CallFileFn]call function(%s) error(%d)./n", pFunctionName, nRet);  
36.   
37.                 return false;  
38.   
39.         }  
40.   
41.   
42.   
43.         if (lua_isnumber(m_pState, -1) == 1)  
44.   
45.         {  
46.   
47.                 int nSum = lua_tonumber(m_pState, -1);  
48.   
49.                 printf("[CLuaFn::CallFileFn]Sum = %d./n", nSum);  
50.   
51.         }  
52.   
53.   
54.   
55.         return true;  
56.   
57. }  

这个函数是，传入函数名称和参数，去你的Lua文件中去执行。
lua_getglobal(m_pState, pFunctionName);
这个函数是验证你的Lua函数是否在你当前加载的Lua文件中，并把指针指向这个函数位置。

lua_pushnumber(m_pState, nParam1);   <---对应你的x参数
lua_pushnumber(m_pState, nParam2);   <---对应你的y参数

这就是著名的压栈操作了，把你的参数压入Lua的数据栈。供Lua语法器去获得你的数据。
lua_pushnumber()是一个压入数字，lua_pushstring()是压入一个字符串。。。

那么你会问，如果我有一个自己的类型，一个类指针或者别的什么，我怎么压入？别着急，方法当然是有的，呵呵，不过你先看看如果简单的如何做，在下几讲中，我会告诉你更强大的Lua压栈艺术。
这里需要注意的是，压栈的顺序，对，简单说，就是从左到右的参数，左边的先进栈，右边的最后进栈。

nRet = lua_pcall(m_pState, 2, 1, 0);
这句话的意思是，执行这个函数，2是输入参数的个数，1是输出参数的个数。当然，如果你把Lua函数改成
return x+y, x-y;
代码需要改成nRet = lua_pcall(m_pState, 2, 2, 0);
明白了吧，呵呵，很简单吧。
当然，如果函数执行失败，会触发nRet，我这里偷了个懒，如果你想得到为什么错了？可以用lua_tostring(m_pState, -1)去栈顶找，明白？是不是有点感觉了？

lua_isnumber(m_pState, -1) 
这句话是判定栈顶的元素是不是数字。因为如果执行成功，栈顶就应该是你的数据返回值。
int nSum = lua_tonumber(m_pState, -1);
printf("[CLuaFn::CallFileFn]Sum = %d./n", nSum);
这个nSum就是返回的结果。
当然，你会问，如果 return x+y, x-y;我该怎么办？
int nSum = lua_tonumber(m_pState, -1);
int nSub = lua_tonumber(m_pState, -2);
搞定，看见没。按照压栈顺序。呵呵，是不是又有感觉了，对，栈就是数据交互的核心。对Lua的理解程度和运用技巧，其实就是对栈的灵活运用和操作。
好了。你的第一个Lua程序大功告成！竟然不是Hello world，呵呵。
好了，我们看看Main函数怎么写吧，相信大家都会写。

1. #include "LuaFn.h"  
2.   
3.   
4.   
5. int _tmain(int argc, _TCHAR* argv[])  
6.   
7. {  
8.   
9.         CLuaFn LuaFn;  
10.   
11.   
12.   
13.         //LuaFn.InitClass();  
14.   
15.   
16.   
17.         LuaFn.LoadLuaFile("Sample.lua");  
18.   
19.         LuaFn.CallFileFn("func_Add", 11, 12);  
20.   
21.         getchar();  
22.   
23.   
24.   
25.         return 0;  
26.   
27. }  

行了，Build一下，看看，是不是你要的结果？如果是，贺喜你，你已经迈出了Lua的第一步。
洋洋洒洒写了一个小时，喝口水吧，呵呵，下一讲，我将强化这个LuaFn类，让它给我做更多的事情。呵呵，最后，我会让你打到，用Lua文件直接画出一个Windows窗体来。并在上面画出各种按钮，列表，以及复选框。是不是感觉很酷？用文本去创造一个程序？很激动吧，恩，确实，Lua能给你做到。只要你有耐心看下去。。。