Lua 5.1 参考手册（四）

云风几年前译的Lua 5.1文档，这里直接转载过来，方便记录。原地址

2.9 - 环境

类型为 thread ，function ，以及 userdata 的对象，除了 metatable 外还可以用另外一个与之关联的被称作它们的环境的一个表，像 metatable 一样，环境也是一个常规的 table ，多个对象可以共享同一个环境。

userdata 的环境在 Lua 中没有意义。这个东西只是为了在程序员想把一个表关联到一个 userdata 上时提供便利。

关联在线程上的环境被称作全局环境。全局环境被用作它其中的线程以及线程创建的非嵌套函数（通过 loadfile ， loadstring 或是 load ）的缺省环境。而且它可以被 C 代码直接访问（参见 §3.3）。

关联在 C 函数上的环境可以直接被 C 代码访问（参见 §3.3）。它们会作为这个 C 函数中创建的其它函数的缺省环境。

关联在 Lua 函数上的环境用来接管在函数内对全局变量（参见 §2.3）的所有访问。它们也会作为这个函数内创建的其它函数的缺省环境。

你可以通过调用 setfenv 来改变一个 Lua 函数或是正在运行中的线程的环境。而想操控其它对象（userdata、C 函数、其它线程）的环境的话，就必须使用 C API 。

2.10 - 垃圾收集

Lua 提供了一个自动的内存管理。这就是说你不需要关心创建新对象的分配内存操作，也不需要在这些对象不再需要时的主动释放内存。 Lua 通过运行一个垃圾收集器来自动管理内存，以此一遍又一遍的回收死掉的对象（这是指 Lua 中不再访问的到的对象）占用的内存。 Lua 中所有对象都被自动管理，包括： table, userdata、函数、线程、和字符串。

Lua 实现了一个增量标记清除的收集器。它用两个数字来控制垃圾收集周期： garbage-collector pause 和 garbage-collector step multiplier 。

garbage-collector pause 控制了收集器在开始一个新的收集周期之前要等待多久。随着数字的增大就导致收集器工作工作的不那么主动。小于 1 的值意味着收集器在新的周期开始时不再等待。当值为 2 的时候意味着在总使用内存数量达到原来的两倍时再开启新的周期。

step multiplier 控制了收集器相对内存分配的速度。更大的数字将导致收集器工作的更主动的同时，也使每步收集的尺寸增加。小于 1 的值会使收集器工作的非常慢，可能导致收集器永远都结束不了当前周期。缺省值为 2 ，这意味着收集器将以内存分配器的两倍速运行。

你可以通过在 C 中调用 lua_gc 或是在 Lua 中调用 collectgarbage 来改变这些数字。两者都接受百分比数值（因此传入参数 100 意味着实际值 1 ）。通过这些函数，你也可以直接控制收集器（例如，停止或是重启）。

2.10.1 - 垃圾收集的元方法

使用 C API　，你可以给 userdata （参见 §2.8）设置一个垃圾收集的元方法。这个元方法也被称为结束子。结束子允许你用额外的资源管理器和 Lua 的内存管理器协同工作（比如关闭文件、网络连接、或是数据库连接，也可以说释放你自己的内存）。

一个 userdata 可被回收，若它的 metatable 中有 __gc 这个域　，垃圾收集器就不立即收回它。取而代之的是，Lua 把它们放到一个列表中。最收集结束后，Lua 针对列表中的每个 userdata 执行了下面这个函数的等价操作：

function gc_event (udata)
  local h = metatable(udata).__gc
  if h then
    h(udata)
  end
end

在每个垃圾收集周期的结尾，每个在当前周期被收集起来的 userdata 的结束子会以它们构造时的逆序依次调用。也就是说，收集列表中，最后一个在程序中被创建的 userdata 的结束子会被第一个调用。

2.10.2 - Weak Table（弱表）

weak table 是一个这样的 table，它其中的元素都被弱引用。弱引用将被垃圾收集器忽略掉，换句话说，如果对一个对象的引用只有弱引用，垃圾收集器将回收这个对象。

weak table 的键和值都可以是 weak 的。如果一个 table 只有键是 weak 的，那么将运行收集器回收它们的键，但是会阻止回收器回收对应的值。而一个 table 的键和值都是 weak 时，就即允许收集器回收键又允许收回值。任何情况下，如果键和值中任一个被回收了，整个键值对就会从 table 中拿掉。 table 的 weak 特性可以通过在它的 metatable 中设置 __mode 域来改变。如果 __mode 域中是一个包含有字符 ‘k’ 的字符串时， table 的键就是 weak 的。如果 __mode 域中是一个包含有字符 ‘v’ 的字符串时， table 的值就是 weak 的。

在你把一个 table 当作一个 metatable 使用之后，就不能再修改 __mode 域的值。否则，受这个 metatable 控制的 table 的 weak 行为就成了未定义的。

2.11 - Coroutine （协同例程）

Lua 支持 coroutine ，这个东西也被称为协同式多线程 (collaborative multithreading)　。 Lua 为每个 coroutine 提供一个独立的运行线路。然而和多线程系统中的线程不同，coroutine 只在显式的调用了 yield 函数时才会挂起。

创建一个 coroutine 需要调用一次 coroutine.create 。它只接收单个参数，这个参数是 coroutine 的主函数。 create 函数仅仅创建一个新的 coroutine 然后返回它的控制器（一个类型为 thread 的对象）；它并不会启动 coroutine 的运行。

当你第一次调用 coroutine.resume 时，所需传入的第一个参数就是 coroutine.create 的返回值。这时，coroutine 从主函数的第一行开始运行。接下来传入 coroutine.resume 的参数将被传进 coroutine 的主函数。在 coroutine 开始运行后，它讲运行到自身终止或是遇到一个 yields 。

coroutine 可以通过两种方式来终止运行：一种是正常退出，指它的主函数返回（最后一条指令被运行后，无论有没有显式的返回指令）; 另一种是非正常退出，它发生在未保护的错误发生的时候。第一种情况中， coroutine.resume 返回 true ，接下来会跟着 coroutine 主函数的一系列返回值。第二种发生错误的情况下， coroutine.resume 返回 false ，紧接着是一条错误信息。

coroutine 中切换出去，可以调用 coroutine.yield。当 coroutine 切出，与之配合的 coroutine.resume 就立即返回，甚至在 yield 发生在内层的函数调用中也可以（就是说，这不限于发生在主函数中，也可以是主函数直接或间接调用的某个函数里）。在 yield 的情况下，coroutine.resume 也是返回 true，紧跟着那些被传入 coroutine.yield 的参数。等到下次你在继续同样的 coroutine ，将从调用 yield 的断点处运行下去。断点处 yield 的返回值将是 coroutine.resume 传入的参数。

类似 coroutine.create ， coroutine.wrap 这个函数也将创建一个 coroutine ，但是它并不返回 coroutine 本身，而是返回一个函数取而代之。一旦你调用这个返回函数，就会切入 coroutine 运行。所有传入这个函数的参数等同于传入 coroutine.resume 的参数。 coroutine.wrap 会返回所有应该由除第一个（错误代码的那个布尔量）之外的由 coroutine.resume 返回的值。和 coroutine.resume 不同， coroutine.wrap 不捕获任何错误；所有的错误都应该由调用者自己传递。

看下面这段代码展示的一个例子：

function foo (a)
  print("foo", a)
  return coroutine.yield(2*a)
end

co = coroutine.create(function (a,b)
      print("co-body", a, b)
      local r = foo(a+1)
      print("co-body", r)
      local r, s = coroutine.yield(a+b, a-b)
      print("co-body", r, s)
      return b, "end"
end)
       
print("main", coroutine.resume(co, 1, 10))
print("main", coroutine.resume(co, "r"))
print("main", coroutine.resume(co, "x", "y"))
print("main", coroutine.resume(co, "x", "y"))

当你运行它，将得到如下输出结果：

co-body 1       10
foo     2

main    true    4
co-body r
main    true    11      -9
co-body x       y
main    true    10      end
main    false   cannot resume dead coroutine