学习Lua --- Lua与C交互入门

鼯鼠

1.简介

Lua与C/C++结合是很紧密的, Lua与C++交互是建立在Lua与C的基础上的, 所
以偶先从Lua与C讲起.

正如第一讲所说, 运行Lua程序或者说调用Lua主要有两种方式:
* 通过命令行执行"Lua"命令
* 通过Lua的C库
虽然此前偶们一直用第一种方式, 但偶要告诉你, 通过Lua的C库执行才是游戏中
常用的方式.

2.Lua的C库

Lua的C库可以做为Shared Library调用, 但一般开发游戏时会把Lua的所有源程序
都包含在内, 并不把Lua编译成共享库的形式. 因为Lua程序只有100多K, 而且几乎
可以在任何编译器下Clean Compile. 带Lua源程序的另一个好处时, 可以随时对Lua
本身进行扩充, 增加偶们所需的功能.

Lua的C库提供一系列API:
* 管理全局变量
* 管理tables
* 调用函数
* 定义新函数, 这也可以完全由C实现
* 垃圾收集器Garbage collector, 虽然Lua可以自动进行, 但往往不是立即执行的,
所以对实时性要求比较高的程序, 会自己调用垃圾收集器
* 载入并执行Lua程序, 这也可以由Lua自身实现
* 任何Lua可以实现的功能, 都可以通过Lua的C API实现, 这对于优化程序的运行速度
有帮助. 经常调用的共用的Lua程序片断可以转成C程序, 以提高效率. 连Lua都是C写的
还有什么C不能实现呢?

3.Lua与C集成的例子
例e10.c
/* A simple Lua interpreter. */
#include <stdio.h>
#include <lua.h>
int main(int argc, char *argv[]) {
char line[BUFSIZ];
lua_State *L = lua_open(0);
while (fgets(line, sizeof(line), stdin) != 0)
lua_dostring(L, line);
lua_close(L);
return 0;
}

编译
Linux/Cygwin
* 先编译Lua, 并把头文件放入include路径
* gcc e10.c -llua -llualib -o e10

VC6/VC2003
* 先编译Lua, 在Option中设置头文件和库文件路径
* 新建工程,在工程配置中加入附加库lua.lib和lualib.lib
* 编译成exe

运行结果
本程序的功能是实现一个Lua解释器, 输入的每行字符都会被解释成Lua并执行.

程序说明
* #include <lua.h> 包含lua头文件, 然后才可以使用API
* lua_State *L = lua_open(0) 打开一个Lua执行器
* fgets(line, sizeof(line), stdin) 从标准输入里读入一行
* lua_dostring(L, line) 执行此行
* lua_close(L) 关闭Lua执行器


例e11.c
/* Another simple Lua interpreter. */
#include <stdio.h>
#include <lua.h>
#include <lualib.h>
int main(int argc, char *argv[]) {
char line[BUFSIZ];
lua_State *L = lua_open(0);
lua_baselibopen(L);
lua_iolibopen(L);
lua_strlibopen(L);
lua_mathlibopen(L);
while (fgets(line, sizeof(line), stdin) != 0)
lua_dostring(L, line);
lua_close(L);
return 0;
}

运行结果
本程序的功能是实现一个Lua解释器, 输入的每行字符都会被解释成Lua并执行.
与上例不同的是, 本例调用了Lua的一些标准库.

程序说明
* #include <lualib.h> 包含Lua的标准库
* 以下这几行是用来读入Lua的一些库, 这样偶们的Lua程序就可以有更多的功能.
lua_baselibopen(L);
lua_iolibopen(L);
lua_strlibopen(L);
lua_mathlibopen(L);

4.试试看
把上面两个小例子在你熟悉的编译器中编译执行, 并试试能否与Lua源码树一起编译

鼯鼠

应该尽量使用 local 变量而非 global 变量。这是 Lua 初学者最容易犯的错误。global 变量实际上是放在一张全局的 table 里的。global 变量实际上是利用一个 string (变量名作 key) 去访问这个 table 。虽然 Lua5 的 table 效率很高 ，但是相对于 local 变量，依然有很大的效率损失。local 变量是直接通过 Lua 的堆栈访问的。有些 global 变量的访问是不经意的，比如我们有双重循环操作一个迭代的 table：

for k1,v1 in
		pairs(tbl)
		do
    for k2,v2 in
		pairs(v1)
		do
        ...     
    end
end

这里，pairs 其实是一个全局变量应用的函数。如果我们这样做：

do
    local
		pairs=pairs
    for k1,v1 in
		pairs(tbl)
		do
        for k2,v2 in
		pairs(v1)
		do
            ... 
        end
    end
end

效率会稍微提高一些。如果是单层循环，这样做就没有意义。因为 for ... in 循环中的 pairs 这个函数只会被调用一次，而不是每次循环都去调。我们的原则其实是，被多次读取的 global 变量，都应该提取出来放到 local 变量中。

警惕临时变量 字符串的连接操作，会产生新的对象。这是由 lua 本身的 string 管理机制导致的。lua 在 VM 内对相同的 string 永远只保留一份唯一 copy ，这样，所有字符串比较就可以简化为地址比较。这也是 lua 的 table 工作很快的原因之一。这种 string 管理的策略，跟 java 等一样，所以跟 java 一样，应该尽量避免在循环内不断的连接字符串，比如 a = a..x 这样。每次运行，都很可能会生成一份新的 copy 。

同样，记住，每次构造一份 table 都会多一份 table 的 copy 。比如在 lua 里，把平面坐标封装成 { x, y } 用于参数传递，就需要考虑这个问题。每次你想构造一个坐标对象传递给一个函数，{ 10,20 }  这样明确的写出，都会构造一个新的 table 出来。要么，我们想办法考虑 table 的重用；要么，干脆用 x,y 两个参数传递坐标。

同样需要注意的是以 function foo (...) 这种方式定义函数， ... 这种不定参数，每次调用的时候都会被定义出一个 table 存放不定数量的参数。

这些临时构造的对象往往要到 gc 的时候才被回收，过于频繁的 gc 有时候正是效率瓶颈。

使用 closure 代替 table 上面提到封装坐标的问题。诚然，我们可以用 { x=1,y=2 } 这样封装一个坐标。不过还有一个方法可供选择。它稍微轻量一点。

function point (x,y)
        return
		function
		()
		return x,y end
end
 
-- 使用范例
p=point(1,2)
print(p())
-- 输出 1        2 
 

如果你愿意，还可以做的复杂一点：

function point (x,y)
        return
		function
		(idx) 
                if idx=="x"
		then
		return x
                elseif idx=="y"
		then
		return y
                else
		return x,y end
        end
end
 
-- 使用范例
p=point(1,2)
print(p("x"))
		-- 1
print(p("y"))
		-- 2 
 

x,y 实际被存放在 closure 里，每次调用 function point 都有一份独立的 closure。当然，function 的 code 只有一份。

设法减少从 C 向 Lua 传递字符串 字符串常量在 Lua VM 内部工作的非常快，但是一个从 C 向 lua vm 通过 lua_pushstring 之类的 api 传递进 VM 时，就需要掂量一下了。这至少包含一个再 hash 和匹配的过程。 我的 Blog 上的一篇文章讨论了这个问题。

lua 中的继承 lua 中实现 OO ，虚表往往设置一个 metatable 并设置 __index ，而继承则用 metatable 的 __index 把虚表串起来。当类继承层次过多的时候，效率比较低，那么就可以用下面这个技巧。

function inherit(sub,super)
     setmetatable(sub,
     { __index=function(t,k)
             local ret=super[k]
             sub[k]=ret
             return ret
     end
		}
		)
end

利用逻辑运算的短路效应 lua 编程中，and or 跟 C 一样是有短路效应的，不过他们的返回值并非 bool 类型，而是表达式中的左值或者右值。我们常常利用这个特性来简化代码。

function foo(arg)
     arg=arg or
		"default"
     ...
end

利用 or 运算赋缺省值是最常用的技巧。上例中，如果 arg 为 nil ，arg 就会被赋值为 "default" 。但是这个技巧有个缺陷，当缺省值是 true 的时候会有点问题。

a=a or
		true
		-- 错误的写法，当 a 明确写为 false 的时候，也会被改变成 true 。
a= a ~= false
		-- 正确的写法，当 a 为 nil 的时候，被赋值为 true ；而 false 则不变。 
 

另外，巧妙使用 and or 还可以实现类似 C 语言中的 ?: 三元操作：

function
		max(a,b)
    return a>b and a or b
end

上面这个函数可以返回 a 和 b 中较大的一个，其逻辑类似 C 语言中的 return (a>b) ? a : b ;