Lua和C++交互

转自：http://cn.cocos2d-x.org/tutorial/show?ID=1474
一、Lua堆栈

要理解Lua和C++交互，首先要理解Lua堆栈。

简单来说，Lua和C/C++语言通信的主要方法是一个无处不在的虚拟栈。栈的特点是先进后出。

在Lua中，Lua堆栈就是一个struct，堆栈索引的方式可是是正数也可以是负数，区别是：正数索引1永远表示栈底，负数索引-1永远表示栈顶。如图：

 lua的栈类似于以下的定义,它是在创建lua_State的时候创建的:

             TValue stack[max_stack_len]  // 欲知内情可以查 lstate.c 的stack_init函数

    存入栈的数据类型包括数值,字符串,指针,talbe,闭包等,下面是一个栈的例子:

   执行下面的代码就可以让你的lua栈上呈现图中的情况

    lua_pushcclosure(L,func,0) // 创建并压入一个闭包

    lua_createtable(L,0)        // 新建并压入一个表

    lua_pushnumber(L,343)      // 压入一个数字

    lua_pushstring(L,“mystr”)   // 压入一个字符串

    这里要说明的是,你压入的类型有数值,表和闭包[在c中看来是不同类型的值],但是最后都是统一用TValue这种数据结构来保存的:),下面用图简单的说明一下这种数据结构:

    TValue结构对应于lua中的所有数据类型,是一个{值,类型} 结构,这就lua中动态类型的实现,它把值和类型绑在一起,用tt记录value的类型,value是一个联合结构,由Value定义,可以看到这个联合有四个域,先说明简单的

        p -- 可以存一个指针,实际上是lua中的light userdata结构

        n -- 所有的数值存在这里,不过是int,还是float

        b -- Boolean值存在这里,注意,lua_pushinteger不是存在这里,而是存在n中,b只存布尔

        gc -- 其他诸如table,thread,closure,string需要内存管理垃圾回收的类型都存在这里

        gc是一个指针,它可以指向的类型由联合体GCObject定义,从图中可以看出,有string,userdata,table,proto,upvalue,thread

    从下面的图可以的得出如下结论:

        1. lua中,number,boolean,nil,light userdata四种类型的值是直接存在栈上元素里的,和垃圾回收无关.

        2. lua中,string,thread存在栈上元素里的只是指针,他们都会在生命周期结束后被垃圾回收.

二、堆栈的 *** 作

因为Lua与C/C++是通过栈来通信，Lua提供了C API对栈进行 *** 作。

我们先来看一个最简单的例子：

点击(此处)折叠或打开

可以简单理解为luaL_newstate返回一个指向堆栈的指针，其它看注释应该能懂了吧。

其他一些栈 *** 作：

点击(此处)折叠或打开

// 将需要设置的值设置到栈中  lua_pushstring(L,"我是一个大帅锅～");  将这个值设置到table中（此时tbl在栈的位置为2）  lua_setfIEld(L,128); line-height:1.5!important">2,0); line-height:1.5!important">name");

需要注意的是：堆栈 *** 作是基于栈顶的，就是说它只会去 *** 作栈顶的值。

举个比较简单的例子，函数调用流程是先将函数入栈，参数入栈，然后用lua_pcall调用函数，此时栈顶为参数，栈底为函数，所以栈过程大致会是：参数出栈->保存参数->参数出栈->保存参数->函数出栈->调用函数->返回结果入栈。

类似的还有lua_setfIEld，设置一个表的值，肯定要先将值出栈，保存，再去找表的位置。

再不理解可看如下例子：

lua_getglobal(L,0); line-height:1.5!important">add 获取函数，压入栈中  lua_pushnumber(L,128); line-height:1.5!important">10);  压入第一个参数  lua_pushnumber(L,128); line-height:1.5!important">20);  压入第二个参数  int iRet= lua_pcall(L,128); line-height:1.5!important">1,128); line-height:1.5!important">0); 将2个参数出栈，函数出栈，压入函数返回结果  lua_pushstring(L,0); line-height:1.5!important">// lua_setfIEld(L,0); line-height:1.5!important"> 会将"我是一个大帅锅～"出栈

另外补充一下：

lua_getglobal(L,"var")会执行两步 *** 作：1.将var放入栈中，2.由Lua去寻找变量var的值，并将变量var的值返回栈顶（替换var）。

lua_getfIEld(L,-1,"name")的作用等价于 lua_pushstring(L,"name") + lua_gettable(L,-2)

lua value 和 c value的对应关系

可以看出来,lua中提供的一些类型和c中是对应的,也提供一些c中没有的类型. 其中有一些药特别的说明一下:

        nil值,c中没有对应,但是可以通过lua_pushnil向lua中压入一个nil值

        注意: lua_push*族函数都有"创建一个类型的值并压入"的语义,因为lua中所有的变量都是lua中创建并保存的,对于那些和c中有对应关系的lua类型,lua会通过API传来的附加参数,创建出对应类型的lua变量放在栈顶,对于c中没有对应类型的lua类型,lua直接创建出对应变量放在栈顶.

       例如:    lua_pushstring(L,“string”) lua根据"string"创建一个 TString obj,绑定到新分配的栈顶元素上

                  lua_pushcclosure(L,0) lua根据func创建一个 Closure obj,sans-serif; Font-size:13.3333px; line-height:19.2px">                   lua_pushnumber(L,5) lua直接修改新分配的栈顶元素,将5赋值到对应的域

                  lua_createtable(L,0)lua创建一个Tabke obj,sans-serif; Font-size:13.3333px; line-height:19.2px">        总之,这是一个 c value –> lua value的流向,不管是想把一个简单的5放入lua的世界,还是创建一个table,都会导致

                  1. 栈顶新分配元素    2. 绑定或赋值

                还是为了重复一句话,一个c value入栈就是进入了lua的世界,lua会生成一个对应的结构并管理起来,从此就不再依赖这个c value

        lua value –> c value时,是通过 lua_to* 族API实现,很简单,取出对应的c中的域的值就行了,只能转化那些c中有对应值的lua value,比如table就不能to c value,所以API中夜没有提供 lua_totable这样的接口.

四、Lua调用C++

我们分三个方法实现它。

方法一：直接将模块写入Lua源码中

在Lua中调用C/C++，我们可以将函数写lua.c中，然后重新编译Lua文件。

编译好后是这样子的：（如图）

然后我们可以在lua.c中加入我们自己的函数。函数要遵循规范（可在lua.h中查看）如下：

typedef int (*lua_CFunction) (lua_State *L);

换句话说，所有的函数必须接收一个lua_State作为参数，同时返回一个整数值。因为这个函数使用Lua栈作为参数，所以它可以从栈里面读取任意数量和任意类型的参数。而这个函数的返回值则表示函数返回时有多少返回值被压入Lua栈。（因为Lua的函数是可以返回多个值的）

然后我们在lua.c中加入如下函数：

 This is my function  static int getTwoVar(lua_State *L)  {  向函数栈中压入2个值  lua_pushnumber(L,128); line-height:1.5!important">10);      lua_pushstring(L,helloreturn 2;  }   在pmain函数中，luaL_openlibs函数后加入以下代码： 注册函数  lua_pushcfunction(L,getTwoVar); 将函数放入栈中  lua_setglobal(L,0); line-height:1.5!important">getTwoVar设置lua全局变量getTwoVar

/#define lua_register(L,n,f) (lua_pushcfunction(L,(f)),lua_setglobal(L,(n)))

lua_register(L,0); line-height:1.5!important">",getTwoVar);

当然，一般我们不建议去修改别人的代码，更倾向于自己编写独立的C/C++模块，供Lua调用，下面来讲讲如何实现。

方法二：使用静态依赖的方式

1. 新建一个空的win32控制台工程，记得在vc++目录中，把lua中的头文件和lib文件的目录包含进来，然后->链接器->附加依赖项->将lua51.lib和lua5.1.lib也包含进来。

2. 在目录下新建一个avg.lua如下：

avg,sum = average(10,128); line-height:1.5!important">20,128); line-height:1.5!important">30,128); line-height:1.5!important">40,128); line-height:1.5!important">50) print(The average is ",avg) The sum is  3.新建test.cpp如下：
 
      
#include <stdio.h> extern C" {  #include lua.h" #include lualib.hlauxlib.h" } /* 指向Lua解释器的指针 */ lua_State* L; int average(lua_State *L)  {  得到参数个数 */ int n = lua_gettop(L); double sum = 0; int i;  循环求参数之和 for (i = 1; i <= n; i++)      {  求和 */ sum += lua_tonumber(L,i);      }  压入平均值 */ lua_pushnumber(L,sum / n);  压入和  返回返回值的个数 2;  } int main ( int argc,char *argv[] )  {  初始化Lua */ L = lua_open();  载入Lua基本库 */ luaL_openlibs(L);  注册函数 */ lua_register(L,0); line-height:1.5!important">average 运行脚本 */ luaL_dofile(L,0); line-height:1.5!important">avg.lua 清除Lua */ lua_close(L);  暂停 */ printf( Press enter to exit…" );      getchar(); 0;  }
      执行一下，我们可以得到结果：
 
 
 
 大概顺序就是：我们在C++中写一个模块函数，将函数注册到Lua解释器中，然后由C++去执行我们的Lua文件，然后在Lua中调用刚刚注册的函数。
 
 看上去很别扭啊有木有。接下来介绍一下dll调用方式。
 
 方法三：使用dll动态链接的方式
 
 我们先新建一个dll工程，工程名为mLualib。（因此最后导出的dll也为mLualib.dll）
 
 然后编写我们的c++模块，以函数为例，我们先新建一个.h文件和.cpp文件。
 
 h文件如下：（如果你不是很能明白头文件的内容，点击这里：http://blog.csdn.net/shun_fzll/article/details/39078971。）
 #pragma once " }     #ifdef LUA_EXPORTS #define LUA_API __declspec(dllexport) #else #define LUA_API __declspec(dllimport) #endif " LUA_API int luaopen_mLualib(lua_State *L);定义导出函数

#include <stdio.h> #include mLualib.h" int averageFunc(lua_State *L)  { 1; i <= n; i++)          sum += lua_tonumber(L,i);         lua_pushnumber(L,sum / n); 压入平均值  lua_pushnumber(L,sum); 压入和  2; 返回两个结果  } int sayHelloFunc(lua_State* L)  {      printf(Hello World!0;  } const struct luaL_Reg mylib[] = {      {sayHello数组中最后一对必须是{NulL,NulL}，用来表示结束  }; int luaopen_mLualib(lua_State *L)  {      luaL_register(L,0); line-height:1.5!important">ss1;  把mylib表压入了栈中，所以就需要返回1  }

require mLualib" local ave,sum = ss.average(3,128); line-height:1.5!important">4,128); line-height:1.5!important">5)参数对应堆栈中的数据  print(ave,sum)  -- 3 15 ss.sayHello() -- Hello World!

这样子写的时候，Lua会这么干：

所以当我们在编写一个这样的模块的时候，编写luaopen_xxx导出函数的时候，xxx最好是和项目名一样（因为项目名和dll一样）。

需要注意的是：函数参数里的lua_State是私有的，每一个函数都有自己的栈。当一个C/C++函数把返回值压入Lua栈以后，该栈会自动被清空。

五、总结 

Lua和C++是通过一个虚拟栈来交互的。

C++调用Lua实际上是：由C++先把数据放入栈中，由Lua去栈中取数据，然后返回数据对应的值到栈顶，再由栈顶返回C++。

Lua调C++也一样：先编写自己的C模块，然后注册函数到Lua解释器中，然后由Lua去调用这个模块的函数。

网址：http://blog.chinaunix.net/xmlrpc.PHP?r=blog/article&uID=20846214&ID=5195503

以上是内存溢出为你收集整理的Lua和C++交互全部内容，希望文章能够帮你解决Lua和C++交互所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。