ToLua原理和使用教程

七彩极

ToLua原理和使用教程

Tolua是用来实现C++程序中的类、变量、函数等绑定到lua程序中。绑定后lua代码可以直接调用C++程序中的类、变量、函数等等。

Tolua原理

Tolua做了哪些事

要想知道tolua原理，先了解tolua到底做了些什么事。先看一下下面“lua实现get/set方法”的例子。这个例子包含了三个文件luaBind.cpp文件、Main.cpp文件、a.lua文件。
luaBind.cpp文件

1. extern "C" {
2. #include "lua\lua.h"
3. #include "lua\lualib.h"
4. #include "lua\lauxlib.h"
5. }
7. const char *HandlesGetSet = "HandlesGetSet";
9. extern double a /*= 166*/;
10. int a_get(lua_State*L)
11. {
12.         lua_pushnumber(L, a);
13.         return 1;
14. }
16. int a_set(lua_State *L)
17. {
18.         if (lua_isnumber(L, 1))
19.         {
20.                 a = lua_tonumber(L, 1);
21.         }
23.         return 0;
24. }
26. int index_event(lua_State*L)
27. {
28.         //从 registry  中获取变量的get set 方法
29.         luaL_getmetatable(L, HandlesGetSet);
30.         lua_pushvalue(L, 2);
31.         lua_rawget(L, -2);
33.         if (lua_isnil(L, -1))// 没有get set方法
34.         {
35.                 lua_pop(L, 2);
36.                 lua_rawget(L, -2);
37.         }
38.         else
39.         {
40.                 lua_pushstring(L, "get");
41.                 lua_rawget(L, -2);
42.                 lua_pcall(L, 0, 1, 0);//调用get方法
43.         }
44.         return 1;
45. }
47. int newindex_event(lua_State *L)
48. {
49.         //从 registry  中获取变量的get set 方法
50.         luaL_getmetatable(L, HandlesGetSet);
51.         lua_pushvalue(L, 2);
52.         lua_rawget(L, -2);
54.         if (lua_isnil(L, -1))// 没有get set方法
55.         {
56.                 lua_pop(L, 2);
57.                 lua_rawset(L, -3);
58.         }
59.         else
60.         {
61.                 lua_pushstring(L, "set");//调用set方法
62.                 lua_rawget(L, -2);
63.                 lua_pushvalue(L, 3);
64.                 lua_pcall(L, 1, 0, 0);
65.         }
66.         return 0;
67. }
69. void BindLua(lua_State *L)
70. {
72.         //获取 _G表
73. #if defined (LUA_VERSION_NUM) && LUA_VERSION_NUM >= 502 /* after lua 5.2 */
74.         lua_pushvalue(L, LUA_REGISTRYINDEX); /* registry */
75.         lua_pushnumber(L, LUA_RIDX_GLOBALS); /* registry globalsindex */
76.         lua_rawget(L, -2);                  /* registry registry[globalsindex] */
77.         lua_remove(L, -2);                  /* registry */
78. #else
79.         lua_pushvalue(L, LUA_GLOBALSINDEX);
80. #endif
82.         //创建 _G表的元表
83.         lua_newtable(L);
84.         lua_pushstring(L, "__index");
85.         lua_pushcfunction(L, index_event);
86.         lua_rawset(L, -3);
87.         lua_pushstring(L, "__newindex");
88.         lua_pushcfunction(L, newindex_event);
89.         lua_rawset(L, -3);
91.         lua_setmetatable(L, -2);//设置 _G表的元表
92.         lua_pop(L, 1);
94.         //创建一张表存储在 registry  中
95.         luaL_newmetatable(L, HandlesGetSet);
96.         //注册 a 变量的get set方法
97.         lua_pushstring(L, "a");
98.         lua_newtable(L);
99.         lua_pushstring(L, "get");
100.         lua_pushcfunction(L, a_get);
101.         lua_rawset(L, -3);
102.         lua_pushstring(L, "set");
103.         lua_pushcfunction(L, a_set);
104.         lua_rawset(L, -3);
105.         lua_rawset(L, -3);
106.         lua_pop(L, 1);
107. }

复制代码

Main.cpp文件

1. #include<iostream>
2. extern "C" {
3. #include "lua\lua.h"
4. #include "lua\lualib.h"
5. #include "lua\lauxlib.h"
6. }
8. using namespace std;
9. double a = 166;
11. void BindLua(lua_State *L);
12. int main()
13. {
14.         lua_State *L = luaL_newstate();
15.         luaL_openlibs(L);
16.         BindLua(L);
17.         a = 99;
18.         if (0 != luaL_dofile(L, "a.lua"))
19.         {
20.                 printf("%s\n", lua_tostring(L, -1));
21.         }
22.         printf("a = %f\n\n\n", a);
23.         a = a+1000;
24.         if (0 != luaL_dofile(L, "a.lua"))
25.         {
26.                 printf("%s\n", lua_tostring(L, -1));
27.         }
28.         printf("a = %f\n", a);
29.         lua_close(L);
31.         return 0;
32. }

复制代码

a.lua文件

1. print(a)
2. a = a+1
3. print("c=", c)
4. b = "adas"
5. print("b=", b)

复制代码

这个个例子实现了将C++程序中的double a变量绑定到了lua程序中。在C++程序中改变了变量a的值，lua程序中可以获取改变后的值，同样lua程序中对变量a赋值后，C++程序也可以获取赋值后的值，具体原理参见：Lua任意类型的get/set方法， 。
三个文件的作用如下。
luaBind.cpp文件：  实现将变量double a 绑定到lua程序中
Main.cpp文件： C程序代码
a.lua文件：lua程序代码

可以看到为了绑定double a变量，luaBind.cpp中的代码并不少。为了简化这种绑定，我们可以使用tolua来实现绑定。Tolua可以帮我们生成luaBind.cpp文件，我们只需要将生成后的文件加入到程序中即可完成绑定。
如何生成lua绑定文件

要生成绑定文件，首先我们需要一个tolua++.exe的程序，然后还需要一个.pkg文件。.pkg文件是一个代码文件，代码格式与C++类似。我们首先需要编写一个pkg文件，有了这个文件之后，然后使用tolua++程序对pkg程序进行转换，转换后就就会生成相应的绑定文件。具体操作，请看后续文章。

Tolua使用

Tulua官网http://webserver2.tecgraf.puc-rio.br/~celes/tolua/，更新到tolua-5.2.4，支持lua5.2.4。官网只提供了tolua的源代码，没有提供任何程序。
下载代码解压后，在src目录下有三个目录，如下：

Bin目录中包含了生成tolua++.exe转换程序的代码，我以使用VS2015编译，文章最后有下载地址。
Lib目录包含了程序使用tolua时需要包含的库的代码，因为代码比较少，我一般直接将lib文件夹中的代码直接包含到程序中。
Tests目录包含了tolua的一些例子，这些例子我以全部使用VS2015进行了编译，文章最后有下载地址。

VS2015编译tolua++.exe程序

在Bin目录下有两个.c文件，tolua.c、toluabind.c，将这两个文件加入到项目中，另外项目中还须要lua5.2.4代码和Lib目录下的代码。如下：

编写pkg文件

pkg文件语法，这里不讲解，具体情况tolua官网：http://webserver2.tecgraf.puc-rio.br/~celes/tolua/tolua-3.2.html。语法规则不多，与C++非常接近，很容易看懂。

这里编写一个绑定double a变量的方法。

Bindlua.pkg文件

$extern double a;

double a;

生成绑定文件

Tolua++.exe支持的命令参数。

执行以下命令生成绑定文件。

使用绑定文件

将生成的绑定文件Bindlua.cpp添加到项目中，另外还需要添加tolua源代码src/lib目录下的文件到项目中。如下：

更多有关tolua的例子请参见官方的例子，官方提供我已经转换成VS2015项目，文章结尾由相应的下载地址。
补充：

文中的代码，以及提到到tolua学习资源下载地址：https://pan.baidu.com/s/1boWtfw7