1、Lua堆栈ios
要理解Lua和C++交互,首先要理解Lua堆栈。c++
简单来讲,Lua和C/C++语言通讯的主要方法是一个无处不在的虚拟栈。栈的特色是先进后出。api
在Lua中,Lua堆栈就是一个struct,堆栈索引的方式但是是正数也能够是负数,区别是:正数索引1永远表示栈底,负数索引-1永远表示栈顶。如图:数组
lua的栈相似于如下的定义, 它是在建立lua_State的时候建立的:数据结构
TValue stack[max_stack_len] // 欲知内情能够查 lstate.c 的stack_init函数闭包
存入栈的数据类型包括数值, 字符串, 指针, talbe, 闭包等, 下面是一个栈的例子:函数
执行下面的代码就可让你的lua栈上呈现图中的状况学习
lua_pushcclosure(L, func, 0) // 建立并压入一个闭包ui
lua_createtable(L, 0, 0) // 新建并压入一个表lua
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, closure, table, proto, upvalue, thread
从下面的图能够的得出以下结论:
1. lua中, number, boolean, nil, light userdata四种类型的值是直接存在栈上元素里的, 和垃圾回收无关.
2. lua中, string, table, closure, userdata, thread存在栈上元素里的只是指针, 他们都会在生命周期结束后被垃圾回收.
2、堆栈的操做
由于Lua与C/C++是经过栈来通讯,Lua提供了C API对栈进行操做。
咱们先来看一个最简单的例子:
#include <iostream> #include <string.h> using namespace std; extern "C" { #include "lua.h" #include "lauxlib.h" #include "lualib.h" } void main() { //1.建立一个state lua_State *L = luaL_newstate(); //2.入栈操做 lua_pushstring(L, "I am so cool~"); lua_pushnumber(L,20); //3.取值操做 if( lua_isstring(L,1)){ //判断是否能够转为string cout<<lua_tostring(L,1)<<endl; //转为string并返回 } if( lua_isnumber(L,2)){ cout<<lua_tonumber(L,2)<<endl; } //4.关闭state lua_close(L); return ; }
能够简单理解为luaL_newstate返回一个指向堆栈的指针,其它看注释应该能懂了吧。
其余一些栈操做:
int lua_gettop (lua_State *L); //返回栈顶索引(即栈长度) void lua_settop (lua_State *L, int idx); // void lua_pushvalue (lua_State *L, int idx);//将idx索引上的值的副本压入栈顶 void lua_remove (lua_State *L, int idx); //移除idx索引上的值 void lua_insert (lua_State *L, int idx); //弹出栈顶元素,并插入索引idx位置 void lua_replace (lua_State *L, int idx); //弹出栈顶元素,并替换索引idx位置的值
ua_settop将栈顶设置为一个指定的位置,即修改栈中元素的数量。若是值比原栈顶高,则高的部分nil补足,若是值比原栈低,则原栈高出的部分舍弃。因此能够用lua_settop(0)来清空栈。
3、C++调用Lua
咱们常常可使用Lua文件来做配置文件。相似ini,xml等文件配置信息。如今咱们来使用C++来读取Lua文件中的变量,table,函数。
lua和c通讯时有这样的约定: 全部的lua中的值由lua来管理, c++中产生的值lua不知道, 相似表达了这样一种意思: "若是你(c/c++)想要什么, 你告诉我(lua), 我来产生, 而后放到栈上, 你只能经过api来操做这个值, 我只管个人世界", 这个很重要, 由于:
"若是你想要什么, 你告诉我, 我来产生"就能够保证, 凡是lua中的变量, lua要负责这些变量的生命周期和垃圾回收, 因此, 必须由lua来建立这些值(在建立时就加入了生命周期管理要用到的簿记信息)
"而后放到栈上, 你只能经过api来操做这个值", lua api给c提供了一套完备的操做界面, 这个就至关于约定的通讯协议, 若是lua客户使用这个操做界面, 那么lua自己不会出现任何"意料以外"的错误.
"我只管个人世界"这句话体现了lua和c/c++做为两个不一样系统的分界, c/c++中的值, lua是不知道的, lua只负责它的世界
如今有这样一个hello.lua 文件:
str = "I am so cool" tbl = {name = "shun", id = 20114442} function add(a,b) return a + b end
咱们写一个test.cpp来读取它:
#include <iostream> #include <string.h> using namespace std; extern "C" { #include "lua.h" #include "lauxlib.h" #include "lualib.h" } void main() { //1.建立Lua状态 lua_State *L = luaL_newstate(); if (L == NULL) { return ; } //2.加载Lua文件 int bRet = luaL_loadfile(L,"hello.lua"); if(bRet) { cout<<"load file error"<<endl; return ; } //3.运行Lua文件 bRet = lua_pcall(L,0,0,0); if(bRet) { cout<<"pcall error"<<endl; return ; } //4.读取变量 lua_getglobal(L,"str"); string str = lua_tostring(L,-1); cout<<"str = "<<str.c_str()<<endl; //str = I am so cool~ //5.读取table lua_getglobal(L,"tbl"); lua_getfield(L,-1,"name"); str = lua_tostring(L,-1); cout<<"tbl:name = "<<str.c_str()<<endl; //tbl:name = shun //6.读取函数 lua_getglobal(L, "add"); // 获取函数,压入栈中 lua_pushnumber(L, 10); // 压入第一个参数 lua_pushnumber(L, 20); // 压入第二个参数 int iRet= lua_pcall(L, 2, 1, 0);// 调用函数,调用完成之后,会将返回值压入栈中,2表示参数个数,1表示返回结果个数。 if (iRet) // 调用出错 { const char *pErrorMsg = lua_tostring(L, -1); cout << pErrorMsg << endl; lua_close(L); return ; } if (lua_isnumber(L, -1)) //取值输出 { double fValue = lua_tonumber(L, -1); cout << "Result is " << fValue << endl; } //至此,栈中的状况是: //=================== 栈顶 =================== // 索引 类型 值 // 4 int: 30 // 3 string: shun // 2 table: tbl // 1 string: I am so cool~ //=================== 栈底 =================== //7.关闭state lua_close(L); return ; }
知道怎么读取后,咱们来看下如何修改上面代码中table的值:
// 将须要设置的值设置到栈中 lua_pushstring(L, "我是一个大帅锅~"); // 将这个值设置到table中(此时tbl在栈的位置为2) lua_setfield(L, 2, "name");
咱们还能够新建一个table:
// 建立一个新的table,并压入栈 lua_newtable(L); // 往table中设置值 lua_pushstring(L, "Give me a girl friend !"); //将值压入栈 lua_setfield(L, -2, "str"); //将值设置到table中,并将Give me a girl friend 出栈
须要注意的是:堆栈操做是基于栈顶的,就是说它只会去操做栈顶的值。
举个比较简单的例子,函数调用流程是先将函数入栈,参数入栈,而后用lua_pcall调用函数,此时栈顶为参数,栈底为函数,因此栈过程大体会是:参数出栈->保存参数->参数出栈->保存参数->函数出栈->调用函数->返回结果入栈。
相似的还有lua_setfield,设置一个表的值,确定要先将值出栈,保存,再去找表的位置。
再不理解可看以下例子:
lua_getglobal(L, "add"); // 获取函数,压入栈中 lua_pushnumber(L, 10); // 压入第一个参数 lua_pushnumber(L, 20); // 压入第二个参数 int iRet= lua_pcall(L, 2, 1, 0);// 将2个参数出栈,函数出栈,压入函数返回结果 lua_pushstring(L, "我是一个大帅锅~"); // lua_setfield(L, 2, "name"); // 会将"我是一个大帅锅~"出栈
另外补充一下:
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的对应关系
c | lua | |
nil | 无 | {value=0, tt = t_nil} |
boolean | int 非0, 0 | {value=非0/0, tt = t_boolean} |
number | int/float等 1.5 | {value=1.5, tt = t_number} |
lightuserdata | void*, int*, 各类* point | {value=point, tt = t_lightuserdata} |
string | char str[] | {value=gco, tt = t_string} gco=TString obj |
table | 无 | {value=gco, tt = t_table} gco=Table obj |
userdata | 无 | {value=gco, tt = t_udata} gco=Udata obj |
closure | 无 | {value=gco, tt = t_function} gco=Closure obj |
能够看出来, 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,func, 0) lua根据func建立一个 Closure obj, 绑定到新分配的栈顶元素上
lua_pushnumber(L,5) lua直接修改新分配的栈顶元素, 将5赋值到对应的域
lua_createtable(L,0, 0)lua建立一个Tabke obj, 绑定到新分配的栈顶元素上
总之, 这是一个 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这样的接口.
4、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, 10); lua_pushstring(L,"hello"); return 2; } 在pmain函数中,luaL_openlibs函数后加入如下代码: //注册函数 lua_pushcfunction(L, getTwoVar); //将函数放入栈中 lua_setglobal(L, "getTwoVar"); //设置lua全局变量getTwoVar
经过查找lua.h
/#define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
咱们发现以前的注册函数能够这样子写:
lua_register(L,"getTwoVar",getTwoVar);
运行,结果如图:
固然,通常咱们不建议去修改别人的代码,更倾向于本身编写独立的C/C++模块,供Lua调用,下面来说讲如何实现。
方法二:使用静态依赖的方式
1. 新建一个空的win32控制台工程,记得在vc++目录中,把lua中的头文件和lib文件的目录包含进来,而后->连接器->附加依赖项->将lua51.lib和lua5.1.lib也包含进来。
2. 在目录下新建一个avg.lua以下:
avg, sum = average(10, 20, 30, 40, 50) print("The average is ", avg) print("The sum is ", sum)
3.新建test.cpp以下:
#include <stdio.h> extern "C" { #include "lua.h" #include "lualib.h" #include "lauxlib.h" } /* 指向Lua解释器的指针 */ lua_State* L; static 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); /* 压入和 */ lua_pushnumber(L, sum); /* 返回返回值的个数 */ return 2; } int main ( int argc, char *argv[] ) { /* 初始化Lua */ L = lua_open(); /* 载入Lua基本库 */ luaL_openlibs(L); /* 注册函数 */ lua_register(L, "average", average); /* 运行脚本 */ luaL_dofile(L, "avg.lua"); /* 清除Lua */ lua_close(L); /* 暂停 */ printf( "Press enter to exit…" ); getchar(); return 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 extern "C" { #include "lua.h" #include "lualib.h" #include "lauxlib.h" } #ifdef LUA_EXPORTS #define LUA_API __declspec(dllexport) #else #define LUA_API __declspec(dllimport) #endif extern "C" LUA_API int luaopen_mLualib(lua_State *L);//定义导出函数
.cpp文件以下:
#include <stdio.h> #include "mLualib.h" static int averageFunc(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); //压入平均值 lua_pushnumber(L, sum); //压入和 return 2; //返回两个结果 } static int sayHelloFunc(lua_State* L) { printf("hello world!"); return 0; } static const struct luaL_Reg myLib[] = { {"average", averageFunc}, {"sayHello", sayHelloFunc}, {NULL, NULL} //数组中最后一对必须是{NULL, NULL},用来表示结束 }; int luaopen_mLualib(lua_State *L) { luaL_register(L, "ss", myLib); return 1; // 把myLib表压入了栈中,因此就须要返回1 }
不理解不要紧,咱们先编译它,而后新建一个lua文件,在lua中咱们这样子来调用:(调用以前记得把dll文件复制到lua文件目录下)
require "mLualib" local ave,sum = ss.average(1,2,3,4,5)//参数对应堆栈中的数据 print(ave,sum) -- 3 15 ss.sayHello() -- hello world!
成功调用了有木有?咱们看到了输出信息。
至此都发生了什么呢?梳理一下:
1.咱们编写了averageFunc求平均值和sayHelloFunc函数,
2.而后把函数封装myLib数组里面,类型必须是luaL_Reg
3.由luaopen_mLualib函数导出并在lua中注册这两个函数。
那么为何要这样子写呢?实际上当咱们在Lua中:
require "mLualib"
这样子写的时候,Lua会这么干:
local path = "mLualib.dll" local f = package.loadlib(path,"luaopen_mLualib") -- 返回luaopen_mLualib函数 f() -- 执行
因此当咱们在编写一个这样的模块的时候,编写luaopen_xxx导出函数的时候,xxx最好是和项目名同样(由于项目名和dll同样)。
须要注意的是:函数参数里的lua_State是私有的,每个函数都有本身的栈。当一个C/C++函数把返回值压入Lua栈之后,该栈会自动被清空。
5、总结
Lua和C++是经过一个虚拟栈来交互的。
C++调用Lua其实是:由C++先把数据放入栈中,由Lua去栈中取数据,而后返回数据对应的值到栈顶,再由栈顶返回C++。
Lua调C++也同样:先编写本身的C模块,而后注册函数到Lua解释器中,而后由Lua去调用这个模块的函数。
本文不涉及lua语法学习,若是有须要,请移步:http://book.luaer.cn/