lua和整合实践

这几天研究了一下lua，主要关注的是lua和vc之间的整合，把代码都写好放在VC宿主程序里，然后在lua里调用宿主程序的这些代码（或者叫接口、组件，随便你怎么叫），希望能用脚本来控制主程序的行为。这实际上也是一种把业务分离，用脚本控制的架构，可能有些人把这种脚本叫做业务引擎，工作流等。

为什么选择lua？

因为它是一个能和C/C++结合得很紧的脚本语言，而我们的程序是用VC++ 写的；另外一点是因为它的名气，连WOW都用lua来提供API让玩家修改其游戏行为，那我是找不到什么理由拒绝它了。

Lua是什么？在哪里获取LUA？

详细的不说了，在网上一搜大把，只说一下它的官网吧：www.lua.org，在这里可以查到lua的应用，lua发布的版本，我用的是5.3.2，下载的是源代码的版本。

LUA和VC MFC的整合？

• 1、 包含LUA：要使用LUA，当然要先把它包含进我们的工程里，可以有lib/dll方式、也可以用静态lib方式，当然也可以把整个lua的代码放进我们的工程，然后编译，因为lua只有几百K，很小。。。包含整个代码的方法我说一下：
• a) 在VC MFC新建一个工程（例如Dialog base工程）
• b) 去到工程里的文件tab页，新建一个文件夹，然后把所有lua里的.c、.h文件包含进来，注意有几个不用包含，lua.c、wmain.c、luac.c，包含进来之后，选中这个文件夹下面的所有.c文件，然后右键选setting，选择Not using precompiler file，具体自己找找哈。这步做完就马上编译一下，应该是没问题的了！
• c) 还有动态库和静态lib两种方式把lua包含进工程里的，自己可以尝试一下。
• 2、 在某个地方（我是在MFCLua1Dlg.cpp文件开始处）包含lua的头文件，并声明一个lua_state指针，如下：

 1 extern "C"
 2 
 3 {
 4 
 5 #include "lua.h"
 6 
 7 #include "lualib.h"
 8 
 9 #include "lauxlib.h"
10 
11 }
12 
13 lua_State *lua;

在某个适当的地方（我是在OnInitDialog里）调用下面一段代码，这段代码的作用是打开一些必要的库：

 1      lua = luaL_newstate();
 2 
 3        if(lua)
 4 
 5        {
 6 
 7               luaopen_base (lua);
 8 
 9               luaopen_table (lua);
10 
11               luaopen_string (lua);
12 
13               luaopen_math (lua);
14 
15               luaopen_debug (lua);
16 
17               //luaopen_io (lua);
18 
19        }

用完lua的时候，调用下面一句来关闭lua库：

lua_close (lua);

好了，到现在为止，lua已经完全变成我们程序的一部分了，试着编译一下，看看能不能顺利通过。。。

LUA和MFC的交互？

Lua变成我们程序的一部分之后，我们还要使用它，要记住我们的目标是用脚本程序控制我们宿主程序的执行流程，那我们就要完成两步，一是用mfc程序调用lua的函数，二是用lua调用mfc的函数，下面的内容对于初学者可能会开始有点难理解了，请打醒十二分精神，我会尽量简单的说。。。

1、 mfc调用lua的函数，这里用到一个StackDump的函数，是关于主程序和lua的交互栈的问题，下面会对交互栈的问题专门说明。

首先我们用记事本建立一个test.lua，内容是一个相加函数：

function add ( x, y )

return x + y;

end

然后再VC里调用它，如下的一段代码，看这段代码的时候，先把StackDump函数忽略，只需要知道它是一个输出lua和vc交互栈内容的函数，对了，你可以新建一个button的click函数，然后把这段代码放进去：

 1 StackDump(lua);   
 2 
 3 luaL_dofile(lua, "test.lua");     // 解释分析lua文件
 4 
 5 StackDump(lua);
 6 
 7 lua_getglobal(lua, "add");       // 取到一个全局标号add，取的同时会把add函数压栈
 8 
 9 StackDump(lua);   
10 
11 lua_pushnumber(lua, 1);        // 把第一个参数压入栈里
12 
13 StackDump(lua);
14 
15 lua_pushnumber(lua, 2);        // 第二个参数压栈
16 
17 StackDump(lua);
18 
19 //lua_call(lua, 2, 1);
20 
21 if(lua_pcall(lua, 2, 1, 0) != 0)        // 执行add函数
22 
23 {
24 
25         AfxMessageBox("lua_pcall error!");            
26 
27 return;
28 
29 }
30 
31 StackDump(lua);
32 
33 // 函数执行完了，执行结果被压栈，所以取得最顶端的一个数就是结果值，-1就是指取栈顶的值
34 
35 int d = (int)lua_tonumber(lua, -1);        
36 
37 CString str;
38 
39 str.Format("%d", d);
40 
41 AfxMessageBox(str);
42 
43 StackDump(lua);
44 
45 lua_pop(lua, 1);      // 把值从栈里清除，pop（弹出）一个值
46 
47 StackDump(lua);

好好分析一下这段代码，我们大概知道调用lua函数的一个过程是：dofile--〉函数名压栈--〉参数依序压栈--〉lua_pcall执行（执行结果压栈）--〉取出执行结果（如果有多个，就从栈里取出多个。。。），这样我们就能很轻松的调用到lua里的函数，其实就是要知道栈里发生了什么。。。

2、 lua调用MFC函数，比如我们想在lua里调用一个Msg函数，能弹出一个窗口来显示我们想显示的字串，然后返回值是1个"MsgOK!"字串。

lua文件是这样的，第一句是调用Msg函数，第二句是测试返回的字串是不是"MsgOK!"：

c = Msg ("123");

Msg(c);

MFC程序里是这样的：

首先写一个将要被导出的函数，很多文章叫它为粘合函数(glue function)：

static int Msg(lua_State* L)

{

const char *s1 = luaL_checkstring(L, 1);     // 测试第一个参数是否为字串形式，并取得这个字串

StackDump(L);

MessageBox(NULL, s1, "caption", MB_OK);

lua_pop(lua, 1);      // 清除栈里的这个字串

StackDump(L);

lua_pushlstring(L, "MsgOK!", 6);  // 把返回值压进栈里

// 这个返回是指返回值的个数

return 1;

}

然后就导出这个函数，如下：

lua_pushcfunction(lua, Msg);

lua_setglobal(lua, "Msg");

接着就执行刚才的lua文件就行了，记得执行之前要先lua_open () 哦：

luaL_dofile(lua, "test.lua");

运行的结果就是连续跳出两个messagebox，第一个是123，第二个是"MsgOK!"，说明我们返回的字串被lua接收到了，lua的第二行我们没有接收它的返回值，则这个返回值会自动被抛弃了。

如果需要多返回值，则我们要把下面一句：

lua_pushlstring(L, "MsgOK!", 6); // 把返回值压进栈里

// 这个返回是指返回值的个数

return 1;

改为：

lua_pushlstring(L, "MsgOK!", 6); // 把返回值压进栈里

lua_pushlstring(L, "haha!", 5); // 把返回值压进栈里

// 这个返回是指返回值的个数

return 2;

这样我们在lua文件里就可以像下面一样取得两个返回值了：

c,d = Msg("123");

那c和d就分别是"MsgOK!"和"haha!"两个字串了。 这种自动机制用起来还是比较方便的。

3、交互栈

上面两个调用其实都是对lua栈的实用，那我们就要好好理解一个概念，lua和vc的交互栈（栈是什么？请参考数据结构的书哈。。。）lua和vc就是通过这个栈来实现交互的，这个栈的访问函数有lua_gettop，lua_settop，lua_tostring，lua_toXXX等等的函数，我们要清楚当一个函数调用发生的时候，栈里是发生了什么。上面我用了一个StackDump函数，当我们调用的时候，能很清楚的看到栈里发生了什么。

首先我们要知道从栈顶往下数就是-1、-2，从栈底往上数就是1、2。

如果使用lua_gettop(L, 1)，就是取得栈底第一个元素。lua_gettop(L, -1)就是取得栈顶的第一个元素。lua_pop() (L, 1)就是把栈顶的一个元素弹出来，lua_pop()(L, 2)就是把栈顶的两个元素弹出。

好了，写了一通，最后是这个StackDump函数的实现：

 1 int StackDump(lua_State* L)
 2 
 3 {
 4 
 5        int nTop = lua_gettop(L); //得到栈的元素个数。栈顶的位置。
 6 
 7        OutputDebugString("The Length of stack is %d/n", nTop); //输出栈顶位置
 8 
 9        for (int i = 1; i <= nTop; ++i)
10 
11        {
12 
13               int t = lua_type(L, i);
14 
15               OutputDebugString("%s:", lua_typename(L, t)); 
16　　　　　　　　 //这里的typename是把类型的枚举变成字符串，是类型名。不是栈中的位置。 
17               switch(t)
18 
19               {
20 
21               case LUA_TNUMBER:
22 
23                      OutputDebugString("%f", lua_tonumber(L, i));
24 
25                      break;
26 
27               case LUA_TSTRING:
28 
29                      OutputDebugString("%s", lua_tostring(L, i));
30 
31                      break;
32 
33               case LUA_TTABLE:
34 
35                      //OutputDebugString("%s/n", lua_tostring(L,i));
36 
37                      break;
38 
39               case LUA_TFUNCTION:
40 
41                      //OutputDebugString("%s/n", lua_tostring(L,i));
42 
43                      break;
44 
45               case LUA_TNIL:
46 
47                      OutputDebugString("Is NULL");
48 
49                      break;
50 
51               case LUA_TBOOLEAN:
52 
53                      OutputDebugString("%s", lua_toboolean(L, i) ? "true" : "false");
54 
55                      break;
56 
57               default:
58 
59                      break;
60 
61               }
62 
63               OutputDebugString("/n");
64 
65        }
66 
67        return 0;
68 
69 }

本篇文章主要讲了lua和VC的整合、把LUA源代码和VC工程一起编译，VC调用LUA的代码，LUA调用VC的代码，返回值以及多个返回值、交互栈、输出交互栈里的元素信息等内容，下一篇将会说说如何避免阻塞的脚本，lua和多线程的使用等内容。

最后附上demo的代码工程.环境用的是 vs2010的.

地址:http://pan.baidu.com/s/1qXi3Jbe