Lua栈

一、Lua栈

1. 什么是lua栈

lua的栈类似于以下的定义, 它是在创建lua_State的时候创建的:  TValue stack[max_stack_len]  // 欲知内情可以查 lstate.c 的stack_init函数

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

2. TValue结构

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

  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存在栈上元素里的只是指针, 他们都会在生命周期结束后被垃圾回收.

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++的通讯

1. Lua和C通讯的约定

    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只负责它的世界。

2. 栈的索引规则

栈底到栈顶索引呈+1递增的规律，同时索引有正数索引和负数索引两种表示方式：

1. 正数索引，不需要知道栈的大小，我们就能知道栈底在哪，栈底的索引永远是1

即：栈底是1，然后一直到栈顶逐渐+1
2. 负数索引，不需要知道栈的大小，我们就能知道栈顶在哪，栈顶的索引永远是-1

即：栈顶是-1，然后一直到栈底逐渐-1

3. Lua和C++通讯实例

假设在一个lua文件中有如下定义：

[python] view plain copy

1. -- hello.lua 文件  
2. myName = "beauty girl"  

想要在C++中获取到myName的值，可以lua_getglobal 来获取：

[cpp] view plain copy

1. /* 取得table变量，在栈顶 */    
2. lua_getglobal(pL, "myName ");    

lua_getglobal的处理过程如下：（请注意红色数字，代表通信顺序）

1） C++想获取Lua的myName字符串的值，所以它把myName放到Lua堆栈（栈顶），以便Lua能看到
2） Lua从堆栈（栈顶）中获取myName，此时栈顶再次变为空
3） Lua拿着这个myName去Lua全局表查找myName对应的字符串
4） 全局表返回一个字符串”beauty girl”
5） Lua把取得的“beauty girl”字符串放到堆栈（栈顶）
6） C++可以从Lua堆栈中取得“beauty girl”

现在，我们给helloLua.lua文件添加一个table全局变量：

[cpp] view plain copy

1. -- helloLua.lua文件    
2. myName = "beauty girl"    
3. helloTable = {name = "mutou", IQ = 125}    

我们看到，多了一个helloTable的变量，它和数组十分相似，又和HashMap有点类似，总之它很强大。
获取helloTable变量的方式和以前是一样的：

[cpp] view plain copy

1. /* 取得table变量，在栈顶 */    
2. lua_getglobal(pL, "helloTable");    

这样，helloTable变量就被存放到栈顶。
可我们并不是要取table变量，因为C++中是无法识别Lua的table类型的，所以我们要取得table中具体的值，也就是name和IQ的值。
 
有一个和lua_getglobal类似的函数，叫做lua_gettable，顾名思义，它是用来取得table相关的数据的。
lua_gettable函数会从栈顶取得一个值，然后根据这个值去table中寻找对应的值，最后把找到的值放到栈顶。
lua_pushstring()函数可以把C++中的字符串存放到Lua的栈里；
然后再用lua_gettable()取执行前面所说的步骤，lua_gettable的第二个参数是指定的table变量在栈中的索引。

为了方便理解，我们画个图来表示：

这是初始状态，堆栈里还没有任何东西，那么，现在要先把helloTable变量放到栈顶：

[cpp] view plain copy

1. /* 取得table变量，在栈顶 */    
2. lua_getglobal(pL, "helloTable");    

然后就变成了这样：

接着，我们要取得table的name对应的值，那么，先要做的就是把”name”字符串入栈：

[cpp] view plain copy

1. /* 将C++的字符串放到Lua的栈中，此时，栈顶变为“name”， helloTable对象变为栈底 */    
2. lua_pushstring(pL, "name");    

然后变成这样：

注意了，我把栈的索引也加上了，因为我们即将要使用，这次我们用负数索引。
由于”name”的入栈，现在helloTable变量已经不在栈顶了。
接着，我们调用要做最重要的一步了，取得name在table中对应的值：

[cpp] view plain copy

1. /*   
2.         从table对象寻找“name”对应的值（table对象现在在索引为-2的栈中，也就是当前的栈底）,  
3.         取得对应值之后，将值放回栈顶  
4.     */    
5.     lua_gettable(pL, -2);    

此时，栈变成这样：

lua_gettable倒底做了什么事情？
首先，我们来解释一下lua_gettable的第二个参数，-2是什么意思，-2就是刚刚helloTable变量在栈中的索引。
然后，Lua会去取得栈顶的值（之前的栈顶是”name”），然后拿着这个值去helloTable变量中寻找对应的值，当然就找到”mutou”了。
最后，Lua会把找到的值入栈，于是”mutou”就到了栈顶了。