Step By Step(Lua-C API简介)

? ? Lua是一种嵌入式脚本语言，即Lua不是可以单独运行的程序，在实际应用中，主要存在两种应用形式。第一种形式是，C/C++作为主程序，调用Lua代码，此时可以将Lua看做“可扩展的语言”，我们将这种应用称为“应用程序代码”。第二种形式是Lua具有控制权，而C/C++代码则作为Lua的“库代码”。在这两种形式中，都是通过Lua提供的C API完成两种语言之间的通信的。

??? 1. 基础知识：
?? ?C API是一组能使C/C++代码与Lua交互的函数。其中包括读写Lua全局变量、调用Lua函数、运行一段Lua代码，以及注册C函数以供Lua代码调用等。这里先给出一个简单的示例代码：

 1 #include <stdio.h>
 2 #include <string.h>
 3 #include <lua.hpp>
 4 #include <lauxlib.h>
 5 #include <lualib.h>
 6 
 7 int main(void)
 8 {
 9     const char* buff = "print("hello")";
10     int error;
11     lua_State* L = luaL_newstate();
12     luaL_openlibs(L);
13 
14     error = luaL_loadbuffer(L,buff,strlen(buff),line") || lua_pcall(L,128)">0,128)">0);
15     int s = lua_gettop(L);
16     if (error) {
17         fprintf(stderr,0)">%s",lua_tostring(L,-1));
18         lua_pop(L,128)">1);
19     }
20     lua_close(L);
21     return 0;
22 }

??? 下面是针对以上代码给出的具体解释：
?? ?1). 上面的代码是基于我的C++工程，而非C工程，因此包含的头文件是lua.hpp，如果是C工程，可以直接包含lua.h。
?? ?2). Lua库中没有定义任何全局变量，而是将所有的状态都保存在动态结构lua_State中，后面所有的C API都需要该指针作为第一个参数。
?? ?3). luaL_openlibs函数是用于打开Lua中的所有标准库，如io库、string库等。
?? ?4). luaL_loadbuffer编译了buff中的Lua代码，如果没有错误，则返回0，同时将编译后的程序块压入虚拟栈中。
?? ?5). lua_pcall函数会将程序块从栈中弹出，并在保护模式下运行该程序块。执行成功返回0，否则将错误信息压入栈中。
?? ?6). lua_tostring函数中的-1，表示栈顶的索引值，栈底的索引值为1，以此类推。该函数将返回栈顶的错误信息，但是不会将其从栈中弹出。
?? ?7). lua_pop是一个宏，用于从虚拟栈中弹出指定数量的元素，这里的1表示仅弹出栈顶的元素。
?? ?8). lua_close用于释放状态指针所引用的资源。

??? 2. 栈：
?? ?在Lua和C语言之间进行数据交换时，由于两种语言之间有着较大的差异，比如Lua是动态类型，C语言是静态类型，Lua是自动内存管理，而C语言则是手动内存管理。为了解决这些问题，Lua的设计者使用了虚拟栈作为二者之间数据交互的介质。在C/C++程序中，如果要获取Lua的值，只需调用Lua的C API函数，Lua就会将指定的值压入栈中。要将一个值传给Lua时，需要先将该值压入栈，然后调用Lua的C API，Lua就会获取该值并将其从栈中弹出。为了可以将不同类型的值压入栈，以及从栈中取出不同类型的值，Lua为每种类型均设定了一个特定函数。
?? ?1). 压入元素：
?? ?Lua针对每种C类型，都有一个C API函数与之对应，如：
?? ?void lua_pushnil(lua_State* L);??--nil值
?? ?void lua_pushboolean(lua_State* L,int b);?--布尔值
?? ?void lua_pushnumber(lua_State* L,lua_Number n);?--浮点数
?? ?void lua_pushinteger(lua_State* L,lua_Integer n);??--整型
?? ?void lua_pushlstring(lua_State* L,const char* s,size_t len);?--指定长度的内存数据
?? ?void lua_pushstring(lua_State* L,const char* s);??--以零结尾的字符串，其长度可由strlen得出。
?? ?对于字符串数据，Lua不会持有他们的指针，而是调用在API时生成一个内部副本，因此，即使在这些函数返回后立刻释放或修改这些字符串指针，也不会有任何问题。
?? ?在向栈中压入数据时，可以通过调用下面的函数判断是否有足够的栈空间可用，一般而言，Lua会预留20个槽位，对于普通应用来说已经足够了，除非是遇到有很多参数的函数。
?? ?int lua_checkstack(lua_State* L,int extra)?--期望得到extra数量的空闲槽位，如果不能扩展并获得，返回false。?
?? ?
?? ?2). 查询元素：
?? ?API使用“索引”来引用栈中的元素，第一个压入栈的为1，第二个为2，依此类推。我们也可以使用负数作为索引值，其中-1表示为栈顶元素，-2为栈顶下面的元素，同样依此类推。
?? ?Lua提供了一组特定的函数用于检查返回元素的类型，如：
?? ?int lua_isboolean (lua_State *L,int index);
?? ?int lua_iscfunction (lua_State *L,255)">?? ?int lua_isfunction (lua_State *L,255)">?? ?int lua_isnil (lua_State *L,255)">?? ?int lua_islightuserdata (lua_State *L,255)">?? ?int lua_isnumber (lua_State *L,255)">?? ?int lua_isstring (lua_State *L,255)">?? ?int lua_istable (lua_State *L,255)">?? ?int lua_isuserdata (lua_State *L,int index);
?? ?以上函数，成功返回1，否则返回0。需要特别指出的是，对于lua_isnumber而言，不会检查值是否为数字类型，而是检查值是否能转换为数字类型。
?? ?Lua还提供了一个函数lua_type，用于获取元素的类型，函数原型如下：
?? ?int lua_type (lua_State *L,int index);
?? ?该函数的返回值为一组常量值，分别是：LUA_TNIL、LUA_TNUMBER、LUA_TBOOLEAN、LUA_TSTRING、LUA_TTABLE、LUA_TFUNCTION、LUA_TUSERDATA、LUA_TTHREAD和LUA_TLIGHTUSERDATA。这些常量通常用于switch语句中。
?? ?除了上述函数之外，Lua还提供了一组转换函数，如：
?? ?int lua_toboolean (lua_State *L,255)">?? ?lua_CFunction lua_tocfunction (lua_State *L,255)">?? ?lua_Integer lua_tointeger (lua_State *L,int index);?? ?
?? ?const char *lua_tolstring (lua_State *L,int index,size_t *len);
?? ?lua_Number lua_tonumber (lua_State *L,255)">?? ?const void *lua_topointer (lua_State *L,255)">?? ?const char *lua_tostring (lua_State *L,255)">?? ?void *lua_touserdata (lua_State *L,0)">?? ?--string类型返回字符串长度，table类型返回操作符'#'等同的结果，userdata类型返回分配的内存块长度。
?? ?size_t lua_objlen (lua_State *L,int index);　
?? ?对于上述函数，如果调用失败，lua_toboolean、lua_tonumber、lua_tointeger和lua_objlen均返回0，而其他函数则返回NULL。在很多时候0不是一个很有效的用于判断错误的值，但是ANSI C没有提供其他可以表示错误的值。因此对于这些函数，在有些情况下需要先使用lua_is*系列函数判断是否类型正确，而对于剩下的函数，则可以直接通过判断返回值是否为NULL即可。
?? ?对于lua_tolstring函数返回的指向内部字符串的指针，在该索引指向的元素被弹出之后，将无法保证仍然有效。该函数返回的字符串末尾均会有一个尾部0。
?? ?下面将给出一个工具函数，可用于演示上面提到的部分函数，如：