[转]lua与c的详细堆栈说明

当在Lua和C之间交换数据时主要的问题是自动回收与手动回收内存管理的不一致。因此,Lua 用一个抽象的栈在Lua与C之间交换值。
本文目录:

1、c与lua的取值传值
(1)取值(到c)
(2)传值(到lua)

2、堆栈操作api
(1) 压入元素
(2) 查询元素(3) 其他堆栈操作3、堆栈操作实例
(1)一些堆栈操作和打印堆栈上所有变量的例子
(2)提供一个打印一张lua表的c的api函数4、项目例子

本文内容:
1、c与lua的取值传值
(1)取值
栈中的每一条记录都可以保存任何Lua值。无论你何时想要从Lua请求一个值(比如一个全局变量的值),调用Lua,被请求的值将会被压入栈。
Lua以一个严格的LIFO规则(后进先出;也就是说,始终存取栈顶)来操作栈。当你调用Lua时,它只会改变栈顶部分。你的C代码却有更多的自由;更明确的来讲,你可以查询栈上的任何元素,甚至是在任何一个位置插入和删除元素。
(2)传值
无论你何时想要传递一个值给Lua,首先将这个值压入栈,然后调用Lua(这个值将被弹出)。我们仍然需要一个不同的函数将每种C类型压入栈和一个不同函数从栈上取值(只是取出不是弹出)。
因为栈是由Lua来管理的,垃圾回收器知道那个值正在被C使用。几乎所有的API函数都用到了栈。例如,luaL_loadbuffer把它的结果留在了栈上(被编译的chunk或一条错误信息);lua_pcall从栈上获取要被调用的函数并把任何临时的错误信息放在这里。
2、堆栈操作api
(1) 压入元素API有一系列压栈的函数,它将每种可以用C来描述的Lua类型压栈:空值(nil)用lua_pushnil,数值型(double)用lua_pushnumber,布尔型(在C中用整数表示)用lua_pushboolean,任意的字符串(char*类型,允许包含”字符)用lua_pushlstring,C语言风格(以”结束)的字符串(const char*)用lua_pushstring:void lua_pushnil (lua_State *L);void lua_pushboolean (lua_State *L, int bool);void lua_pushnumber (lua_State *L, double n);void lua_pushlstring (lua_State *L, const char *s, size_t length);void lua_pushstring (lua_State *L, const char *s);同样也有将C函数和userdata值压入栈的函数,稍后会讨论到它们。Lua中的字符串不是以零为结束符的;它们依赖于一个明确的长度,因此可以包含任意的二进制数据。将字符串压入串的正式函数是lua_pushlstring,它要求一个明确的长度作为参数。对于以零结束的字符串,你可以用lua_pushstring(它用strlen来计算字符串长度)。Lua从来不保持一个指向外部字符串(或任何其它对象,除了C函数——它总是静态指针)的指针。对于它保持的所有字符串,Lua要么做一份内部的拷贝要么重新利用已经存在的字符串。因此,一旦这些函数返回之后你可以自由的修改或是释放你的缓冲区。无论你何时压入一个元素到栈上,你有责任确保在栈上有空间来做这件事情。记住,你现在是C程序员;Lua不会宠着你。当Lua在起始以及在Lua调用C的时候,栈上至少有20个空闲的记录(lua.h中的LUA_MINSTACK宏定义了这个常量)。对于多数普通的用法栈是足够的,所以通常我们不必去考虑它。无论如何,有些任务或许需要更多的栈空间(如,调用一个不定参数数目的函数)。在这种情况下,或许你需要调用下面这个函数:int lua_checkstack (lua_State *L, int sz);它检测栈上是否有足够你需要的空间(稍后会有关于它更多的信息)。
(2) 查询元素API用索引来访问栈中的元素。在栈中的第一个元素(也就是第一个被压入栈的)有索引1,下一个有索引2,以此类推。我们也可以用栈顶作为参照来存取元素,利用负索引。在这种情况下,-1指出栈顶元素(也就是最后被压入的),-2指出它的前一个元素,以此类推。例如,调用lua_tostring(L, -1)以字符串的形式返回栈顶的值。我们下面将看到,在某些场合使用正索引访问栈比较方便,另外一些情况下,使用负索引访问栈更方便。API提供了一套lua_is*函数来检查一个元素是否是一个指定的类型,*可以是任何Lua类型。因此有lua_isnumber,lua_isstring,lua_istable以及类似的函数。所有这些函数都有同样的原型:int lua_is… (lua_State *L, int index);lua_isnumber和lua_isstring函数不检查这个值是否是指定的类型,而是看它是否能被转换成指定的那种类型。例如,任何数字类型都满足lua_isstring。还有一个lua_type函数,它返回栈中元素的类型。(lua_is*中的有些函数实际上是用了这个函数定义的宏)在lua.h头文件中,每种类型都被定义为一个常量:LUA_TNIL、LUA_TBOOLEAN、LUA_TNUMBER、LUA_TSTRING、LUA_TTABLE、LUA_TFUNCTION、LUA_TUSERDATA以及LUA_TTHREAD。这个函数主要被用在与一个switch语句联合使用。当我们需要真正的检查字符串和数字类型时它也是有用的为了从栈中获得值,这里有lua_to*函数:int lua_toboolean (lua_State *L, int index);double lua_tonumber (lua_State *L, int index);const char * lua_tostring (lua_State *L, int index);size_t lua_strlen (lua_State *L, int index);即使给定的元素的类型不正确,调用上面这些函数也没有什么问题。在这种情况下,lua_toboolean、lua_tonumber和lua_strlen返回0,其他函数返回NULL。由于ANSI C没有提供有效的可以用来判断错误发生数字值,所以返回的0是没有什么用处的。对于其他函数而言,我们一般不需要使用对应的lua_is*函数:我们只需要调用lua_is*,测试返回结果是否为NULL即可。Lua_tostring函数返回一个指向字符串的内部拷贝的指针。你不能修改它(使你想起那里有一个const)。只要这个指针对应的值还在栈内,Lua会保证这个指针一直有效。当一个C函数返回后,Lua会清理他的栈,所以,有一个原则:永远不要将指向Lua字符串的指针保存到访问他们的外部函数中(就算Lua_to* 和lua_is*没有弹栈操作,也不该使用c指针指向lua字符串的地址)。
Lua_string返回的字符串结尾总会有一个字符结束标志0,但是字符串中间也可能包含0,lua_strlen返回字符串的实际长度。特殊情况下,假定栈顶的值是一个字符串,下面的断言(assert)总是有效的:const char *s = lua_tostring(L, -1);size_t l = lua_strlen(L, -1);assert(s[l] == ”);assert(strlen(s) <= l);
(3) 其他堆栈操作除开上面所提及的C与堆栈交换值的函数外,API也提供了下列函数来完成通常的堆栈维护工作:(3-1)int lua_gettop (lua_State *L);
函数lua_gettop返回堆栈中的元素个数,它也是栈顶元素的索引。注意一个负数索引-x对应于正数索引gettop-x+1。(3-2)void lua_settop (lua_State *L, int index);
lua_settop设置栈顶(也就是堆栈中的元素个数)为一个指定的值。如果开始的栈顶高于新的栈顶,顶部的值被丢弃。否则,为了得到指定的大小这个函数压入相应个数的空值(nil)到栈上。特别的,lua_settop(L,0)清空堆栈。你也可以用负数索引作为调用lua_settop的参数;那将会设置栈顶到指定的索引。利用这种技巧,API提供了下面这个宏,它从堆栈中弹出n个元素:#define lua_pop(L,n) lua_settop(L, -(n)-1)(3-3)void lua_pushvalue (lua_State *L, int index);
函数lua_pushvalue压入堆栈上指定索引的一个抟贝到栈顶;(3-4)void lua_remove (lua_State *L, int index);
lua_remove移除指定索引位置的元素,并将其上面所有的元素下移来填补这个位置的空白;(3-5)void lua_insert (lua_State *L, int index);
lua_insert移动栈顶元素到指定索引的位置,并将这个索引位置上面的元素全部上移至栈顶被移动留下的空隔;(3-6)void lua_replace (lua_State *L, int index);最后,lua_replace从栈顶弹出元素值并将其设置到指定索引位置,没有任何移动操作。
(3-7)注意到下面的操作对堆栈没有任何影响:lua_settop(L, -1);lua_insert(L, -1);
3、堆栈操作实例(1)一些堆栈操作和打印堆栈上所有变量的例子

//打印栈上的所有的变量  
static void stackDump (lua_State *L)  
{  
    int i;  
    int top = lua_gettop(L);  
    for (i = 1; i <= top; i++)  
    {  
        int t = lua_type(L, i);  
        switch (t)  
        {  
            case LUA_TSTRING:  
                printf("%s", lua_tostring(L, i));  
            break;  
            case LUA_TBOOLEAN:  
                printf(lua_toboolean(L, i)? "true":"false");  
            break;  
            case LUA_TNUMBER:  
                printf("%g", lua_tonumber(L, i));  
                break;  
            default:  
                printf("%s", lua_typename(L, t));  
            break;  
        }  
        printf(" ");  
    }  
    printf("\n");  
}  
  
  
int main (void)   
{  
    lua_State *L = lua_open();  
    //1 依次压入几个变量 true,10,nil,"hello"   
    printf("1:\n");  
    lua_pushboolean(L, 1);  
    lua_pushnumber(L, 10);  
    lua_pushnil(L);  
    lua_pushstring(L,"hello");  
    stackDump(L);//true 10 nil hello   
    //2  
    printf("2:\n");  
    lua_pushvalue(L, -4);  
    stackDump(L);//true 10 nil hello true   
    //3  用栈顶更换第三个  
    printf("3:\n");  
    lua_replace(L, 3);  
    stackDump(L);//true 10 true hello   
    //4 设置栈变量为6个  
    printf("4:\n");  
    lua_settop(L, 6);  
    stackDump(L);//true 10 true hello nil nil   
    //5 移除从栈顶往下数的第三个  
    printf("5:\n");  
    lua_remove(L, -3);  
    stackDump(L);//true 10 true nil nil   
    //6 设置-5位置的变量作为栈顶变量  
    printf("6:\n");  
    lua_settop(L, -5);  
    stackDump(L);//true  
    //7  
    lua_close(L);  
    return 0;  
}  

输出结果(输出是从栈底到栈顶):
1:
true 10 nil hello
2:
true 10 nil hello true
3:
true 10 true hello
4:
true 10 true hello nil nil
5:
true 10 true nil nil
6:
true
(2)提供一个打印一张表的c的api函数

void tableDump (lua_State *L,int index)  
{  
        if (!lua_istable(L,index))  
        {  
                return;  
        }  
        int tLen = lua_objlen(L,index);  
  
        for(int i = 0;i < tLen;i++)  
        {  
                lua_rawgeti(L,index,i+1);  
                int t = lua_type(L, -1);  
                switch (t) {  
                        case LUA_TSTRING:  
                                printf("t[%d]=%s ",i+1, lua_tostring(L,-1));  
                                break;  
                        case LUA_TBOOLEAN:  
                                printf("t[%d]=%s ",i+1,lua_toboolean(L, -1)? "true":"false");  
                                break;  
                        case LUA_TNUMBER:  
                                printf("t[%d]=%g ",i+1, lua_tonumber(L, -1));  
                                break;  
                        default:  
                        printf("t[%d]=%s ",i+1, lua_typename(L, t));  
                        break;  
                }  
                lua_pop(L,1);  
        }  
        printf("\n");  
}  

4、项目例子
这里是将一个c++的配置压入到lua一张叫QuestData(任务表)的全局的表里。这个例子可以看出c构建lua表数据的基本应用

void QuestAccessor::makeScriptQuestData()  
{  
  QuestConfig** ppQuestList = m_Quest.own_ptr();  
  INT_PTR nCount = m_Quest.length();  
  lua_State* L = g_Script->getLuaState();  
  lua_newtable(L);//QuestData表  
  for (INT_PTR i = 1; i < nCount; ++i)  
  {  
    pushToQuestData(L, ppQuestList[i]);  
  }  
  lua_setglobal(L, "QuestData");//设置该表作为全局的表,名为QuestData  
}  
 /* 
QuestData[questId] = {  
        name = "任务名", 
        acceptTalk = { "111", "222", "333" },  
        acceptReply = {"11", "22", "33"}, 
        completeTalk = { "aaa", "bbb", "ccc" }, 
        completeReply = {"aa", "bb", "cc"}, 
} 
*/  
void QuestAccessor::pushToQuestData(lua_State* L, QuestConfig *quest)//最外面建了一张表quests  
{  
    lua_newtable(L);//新建questId作为QuestData表的下标的表  
    lua_pushvalue(L,-1);//拷贝表引用到栈顶  
    lua_rawseti(L, -3, quest->nQid);//设置questId作为QuestData表的下标的表  
    //name = "quest-name"  
    lua_pushstring(L, quest->sName);  
    lua_setfield(L, -2, "name");//questId 表的名字  
    const QuestAccessor::TalkStruct* pTalkStruct =  &(m_questTalkList.get(quest->nQid));  
    if (NULL != pTalkStruct)  
    {  
    if (pTalkStruct->accept.nCount > 0)  
    {  
            lua_newtable(L);//acceptTalk 表  
            lua_pushvalue(L,-1);  
            lua_setfield(L, -3, "acceptTalk");  
      for (int i = 0; i < pTalkStruct->accept.nCount; ++i)  
      {  
        lua_pushstring(L, pTalkStruct->accept.talkList[i].c_str());  
        lua_rawseti(L, -2, i + 1);  
      }  
      lua_pop(L, 1);//弹出acceptTalk表  
      lua_newtable(L);//新建acceptReply表  
      lua_pushvalue(L, -1);  
      lua_setfield(L, -3, "acceptReply");//设置acceptReply表到questId表  
      for (int i = 0; i < pTalkStruct->accept.nCount; ++i)  
      {  
        lua_pushstring(L, pTalkStruct->accept.replyList[i].c_str());  
        lua_rawseti(L, -2, i+1);  
      }  
      lua_pop(L, 1);//弹出acceptReply标  
    }  
        if (pTalkStruct->complete.nCount > 0)  
    {  
      lua_newtable(L);//新建completeTalk表  
      lua_pushvalue(L, -1);  
      lua_setfield(L, -3, "completeTalk");  
      for (int i = 0; i < pTalkStruct->complete.nCount; ++i)  
      {  
        lua_pushstring(L, pTalkStruct->complete.talkList[i].c_str());  
        lua_rawseti(L, -2, i + 1);  
      }  
      lua_pop(L, 1);  
  
  
      lua_newtable(L);//新建completeReply表  
      lua_pushvalue(L, -1);  
      lua_setfield(L, -3, "completeReply");  
      for (int i = 0; i < pTalkStruct->complete.nCount; ++i)  
      {  
        lua_pushstring(L, pTalkStruct->complete.replyList[i].c_str());  
        lua_rawseti(L, -2, i+1);  
      }  
      lua_pop(L, 1);  
    }  
  }  
  lua_pop(L, 1);//弹出questId表  
}  

转自:http://blog.csdn.net/chenjiayi_yun/article/details/23772627

推荐阅读更多精彩内容

  • 第一篇 语言 第0章 序言 Lua仅让你用少量的代码解决关键问题。 Lua所提供的机制是C不擅长的:高级语言,动态...
    testfor阅读 1,705评论 1 7
  • C API 云风Blog:Lua C API 的正确用法 C读取和调用Lua文件的库:lua.h, lauxlib...
    SysuYe阅读 4,577评论 3 10
  • lua C api PS:这里是默认我已经学完了lua脚本的基本知识(包括table,元表,函数,基本库, 文件i...
    绿箭ML阅读 2,125评论 0 1
  • 月儿,那时炎热刚刚退去 雨滴翻山越水而来,在我的窗前不绝清唱 窗户自然是开着的。还有伸长了等待倾听的耳朵 月儿,在...
    杨昊田阅读 414评论 4 12