个人工作笔记记录

# lua的C语言接口

这个部分描述了lua的c api, 也就是宿主程序和lua通讯用的一组c函数，所有的API函数按相关的类型以及常量都生命在头文件lua.h中。

虽然我们说的是函数， 但一部分简单的API是以宏的形式提供的，所有的这些宏都使用它们的参数一次(除了第一个参数，也就是lua状态机), 因此你不需要担心这些宏的展开会引起一些副作用。

在所有的c库中，lua api函数都不去检查参数的有效性和坚固性，然而，你可以在编译lua时加上一个宏开关来开启luaconf.h中的宏lua_apicheck以改变这个行为。

# 3.1 堆栈

lua使用一个虚拟栈来和C传递值，栈上每个元素有一个lua值(nil, 数字，字符串等等)。

无论何时lua调用C，被调用的函数都得到一个新的栈，这个栈不同于c函数栈，栈中包含了lua传递给C函数的所有参数， C函数要把返回结果也压栈，返回会给调用者lua。

针对栈的API，不同于真正的栈操作，先进后出，而是使用数组的方式访问，1是第一个入栈的，n是最后一个最后一个元素(假设栈中有n个元素); 负数索引是-1栈顶(n的位置), -n是(1的位置，即栈底)

# 3.2 堆栈的大小限制

使用Lua API，你有责任控制栈不溢出， 可以通过lua_checkstack函数扩大可用尺寸。

lua调用C，只能保证一般是20个栈空间可用，宏是LUA_MINSTACK, 只要不频繁压栈，一般不需要关心。

所有的查询函数，都可以指定索引， 比如lua_type，查询一个栈值是lua哪个类型的

#define LUA_TNIL                0
#define LUA_TBOOLEAN            1
#define LUA_TLIGHTUSERDATA      2
#define LUA_TNUMBER             3
#define LUA_TSTRING             4
#define LUA_TTABLE              5
#define LUA_TFUNCTION           6
#define LUA_TUSERDATA           7
#define LUA_TTHREAD             8
1
2
3
4
5
6
7
8
9

0 永远不可以是索引，因为lua是从1开始的，不仅lua中数组，栈也是这样。

# 3.3-伪索引

被用来访问线程的环境，函数的环境，注册表，和c函数的upvalue

访问方式: lua_getfield(L, LUA_GLOBALSINDEX, varname) 线程的环境(全局变量存放的地方)

# 3.4- C Closure

闭包 --TODO

# 3.6 C中的错误处理

运行在保护环境下的API，会设置恢复点，不会产生错误出来,例如

lua_newstate, lua_close, lua_load, lua_pcall, lua_cpcall

在c函数中。也可以调用lua_error主动产生一个错误

# 3.7 函数和类型

lua_call

  • 是c调用lua中的函数

lua_checkstack(L, int extra):

  • 确保stack至少有extra个空位，不会缩小栈，只会扩展。

lua_close(L):

  • 销毁lua状态机中的所有对象

lua_concat(L, int n):

  • 链接栈顶n个元素未一个字符串，这n个元素出栈，新拼接的字符串入栈。

lua_cpcall(L, lua_CFunction func, void *ud):

  • 已保护模式在c语言中调用c函数

lua_createtable(L, int narr, int nrec):

  • 创建新table，并入栈, 适合明确知道元素个数的情况

lua_newtable(L):

  • 创建空table并入栈, == lua_createtable(L, 0, 0)

lua_dump(L, lua_Writer writer, void *data):

  • 将函数dump成二进制chunk

lua_equal(L, int index1, int index2):

  • 比较索引index1和index2处的元素是否相等，相等返回1，否则0， 索引不存在也返回0

lua_error(L):

  • 产生一个lua错误, 错误信息可以是任意lua类型置入栈顶

lua_gc(L, int what, int data):

  • 垃圾回收器
  • what可选值
LUA_GCSTOP: 停止垃圾收集器。
LUA_GCRESTART: 重启垃圾收集器。
LUA_GCCOLLECT: 发起一次完整的垃圾收集循环。
LUA_GCCOUNT: 返回 Lua 使用的内存总量（以 K 字节为单位）。
LUA_GCCOUNTB: 返回当前内存使用量除以 1024 的余数。
LUA_GCSTEP: 发起一步增量垃圾收集。 步数由 data 控制（越大的值意味着越多步）， 而其具体含义（具体数字表示了多少）并未标准化。 如果你想控制这个步数，必须实验性的测试 data 的值。 如果这一步结束了一个垃圾收集周期，返回返回 1 。
LUA_GCSETPAUSE: 把 data/100 设置为 garbage-collector pause 的新值（参见 §2.10）。 函数返回以前的值。
LUA_GCSETSTEPMUL: 把 arg/100 设置成 step multiplier （参见 §2.10）。 函数返回以前的值
1
2
3
4
5
6
7
8

lua_getallocf(L, void **ud):

  • 返回给定状态机的内存分配器函数。 如果 ud 不是 NULL ，Lua 把调用 lua_newstate 时传入的那个指针放入 *ud 。

lua_getfenv(L, int index):

  • 把索引处值的环境表压入堆栈

lua_getfield(L, int index, const char *k):

  • 把 t[k] 值压入堆栈， 这里的 t 是指有效索引 index 指向的值。 在 Lua 中，这个函数可能触发对应 "index" 事件的元方法

lua_getglobal(L, const char *name):

  • 把全局变量 name 里的值压入堆栈。 这个是用一个宏定义出来的：
  • #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, s)

lua_getmetatable(L, int index):

  • 将给定索引指向的值的元表入栈，如果索引无效，返回0， 不会向栈压入任何东西.

lua_gettable(L, int index):

  • 把t[k]压栈， t是index索引处的值，k是栈顶的值。

lua_gettop(L):

  • 获取栈元素个数，也就是栈顶的索引

lua_insert(L, int index):

  • 将栈顶元素插入到index处， 依次移动这个索引上面的元素

lua_Integer

  • 这个类型用于Lua API接收整数值

lua_isboolen(L, int index):

  • 判断给定索引是不是bool类型，是返回1，否则返回0

lua_iscfunction(L, int index):

  • 判断给定索引处是c函数或者lua函数皆可，是返回1，否则0

lua_islightuserdata(L, int index):

lua_isnil(L, int index)

lua_isnumber(L, int index) 字符串或数字则返回1，否则0，字符串需要是可转数字的字符串

lua_isstring(L, int index) 字符串或数字则返回1，否则0

lua_istable(L, int index)

lua_isuserdata(L, int index) userdata或light userdata 返回1， 否则返回0

lua_isthread(L, int index)

lua_lessthen(L, int index1, int index2) index1 < index2 则返回1, 否则返回0

lua_load(L, lua_Reader reader, void *data, const char *chunkname)

lua_newstate(lua_Alloc f, void *ud) 创建lua状态机

lua_newtable(L) 创建空table，并入栈

lua_newthread(L) 创建一个新线程并入栈

lua_newuserdata(L, size_t size): 分配一块内存，内存地址入栈

lua_next（L, int index): 弹出栈顶的key, 在-2处的table中找到一对key，key入栈，value入栈，再弹出value,保留key，如此循环，弹出全部的key=>value

lua_objlen(L, int index): 字符串长度、 #table、 userdata内存大小，其他情况返回0

lua_pcall(L, int ngars, int nrets, int errfunc):

  • 保护方式调用一个函数，如果不发生错误，和lua_call且完全一致； 如果发生错误，会把error信息压栈(errfunc=0); 如果errfunc!=0, 则认为是错误处理函数在errfunc这个索引上，会调用这个索引上的函数，错误处理完的信息会再次压栈，作为lua_pcall的出错信息进行压栈。
  • 调用成功返回0，其他 LUA_ERRRUN: 运行时错误。LUA_ERRMEM: 内存分配错误。 对于这种错，Lua 调用不了错误处理函数。LUA_ERRERR: 在运行错误处理函数时发生的错误。

void lua_pop(L, int n): 弹出n个元素, 丢弃。

#

lua_pushboolean(L, int b): b作为bool值入栈

lua_pushcclosure(L, lua_CFcuntion fn, n): c闭包压栈，n表示闭包内关联的变量个数

lua_pushcfunction(L, lua_CFcuntion fn): 将c函数压栈; 本质是宏 #define lua_pushcfunction(L,f) lua_pushcclosure(L,f,0)

lua_pushfstring(L, const char *fmt, ...): 类似sprintf， 返回字符串, 内存由lua管理， 不用在c中专门申请空间

lua_pushinteger(L, lua_Interger n): n作为数字入栈

lua_pushlightuserdata(L, void *p): light userdata 压栈，表示一个指针

lua_pushlstring(L, const char *s, size_t len) s处长度为len的字符串压栈，会做一次内存copy

lua_pushnil(L)

lua_pushnumber(L, lua_Number n)

lua_pushstring(L, const char *s)

lua_pushthread(L): 把L中提供的线程压栈，如果是主线程，返回1.

lua_pushvalue(L, int index): 将index处的元素copy一份，再次压栈

lua_pushvfstring(L, const char *fmt, va_list argp): 等价于lua_pushfstring，只不过实际参数是va_list接收

lua_rawequal(L, int index1, int index2) 简单比较相等（不调用元方法) 相等返回1， 否则返回0

lua_rawget(L, int index) 做一次直接访问，不触发元方法

lua_rawgeti(L, int index, int n) 将index处的table[n]压栈

lua_rawset(L, int index) 赋值操作 index处的table[-2的key] = [-1的value], 不会触发元方法

lua_rawseti(L, int index, int n) index处的table[n] = (-1栈顶的v)

lua_Reader(L, void *data, size_t *size) lua_load用到的读取器函数

lua_register(L, const char *name, lua_CFction f) 将函数f设到全局变量name中 是宏 - #define lua_register(L,n,f)
- (lua_pushcfunction(L, f), lua_setglobal(L, n))

lua_remove(L, int index) 删除index处的元素，上面的元素移到下面补充。

lua_replace(L, int index) 把栈顶的元素弹出，替换到index处的元素

lua_resume(L, int narg) 启动或继续一个协程

lua_setallocf(L, lua_Alloc f, void *ud) 指定L的分配器函数为f

lua_setenv(L, int index) 从栈上弹出table， 并把它作为指定索引index的环境

lua_setfield(L, int index, const char *k) 把index处的table的[k] 赋值位栈顶的v

lua_setglobal(L, const char *name) 宏，把栈顶弹出的值设置到全局变量name中。

  • #define lua_setglobal(L,s) lua_setfield(L, LUA_GLOBALSINDEX, s)

lua_settable(L, int index) 设置index 处的table t[k] = v , v是栈顶, k是-2处的值。

lua_settop(L, int index) 设置栈顶位置, 0则清空栈，设置的位置大于当前栈顶，中间空位补nil

lua_State 变量, 保存lua解释器的状态。

lua_status(L) 返回线程L的状态

lua_toboolean(L, index) 把栈index处的lua值转为c中的bool值。

lua_tointeger(L, int index) lua值转为lua_integer的值

lua_tolstring(L, int index, size_t *size) lua值转为字符串， 如果size 不是NULL，就存字符串长度

lua_tonumber(L, int index) lua值转为lua_Number类型

lua_topointer(L, int index) 索引处的值转为c指针 void *

lua_tostring(L,int index) 等价于lua_tolstring , len 设为null

lua_tothread(L, int index) 索引处的值转为lua_State* 线程

lua_touserdata(L, int index) 返回userdata内存块的地址

lua_type(L, index) 返回index处的值的类型（lua.h中定义的lua类型 9种）

lua_typename(L, int tp) 返回tp表示的类型名， lua.h 定义的9种类型

lua_xmove(lua_state* from, lua_state *to, int n) 传递同一个全局状态机下不同线程中的值。

lua yield(L, int nresults) 切出一个协程， 只能 return yield(L, nresults) 这么用

# 3.8 调试接口

lua_Debug是结构体

lua_gethook(L) 返回当前钩子函数

lua_gethookcount(L) 返回当前钩子计数

lua_getinfo(L, const char *what, lua_Debug *ar) 根据what指定的字符，确定要获取的字段，存到ar中

  • what 以> 开头

lua_getlocal(L, *ar, int n ) 从活动记录中获取一个局部变量的值， n表示第一个参数或第一个局部变量

lua_getstack（L, level, *ar) 获取解释器的栈信息

lua_getupvalue(L, int funcindex, int n): 获取闭包中第n个元素，压入栈顶

lua_Hook 用于调试的钩子函数

lua_sethook(L, f, mask, count): 设置钩子函数

lua_setlocal(L ,*ar, int n): 设置给定活动记录中局部变量的值

lua_setupvalue(L, int funcindex, int n) 设置闭包的upvalue

# 4 扩展库

luaL_addchar(luaL_Buff *B, char c)

luaL_addlstring(B, const char *s , size_t l) add s to B, with length l

luaL_addsize(B, size_t n)

luaL_addstring(B, const char *s)

luaL_addvalue(B)

lua 正则操作 →