lua 5.1 参考手册.txt

lua的参考文档请大家好好看看很不错

--------------------------------------------------------------------------------

Lua 5.1 参考手册 
by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes 
云风 译 www.codingnow.com 

Copyright ? 2006 Lua.org, PUC-Rio. All rights reserved. 


--------------------------------------------------------------------------------


1 - 介绍
Lua 是一个扩展式程序设计语言，它被设计成支持通用的过程式编程，并有相关数据描述的设施。 Lua 也能对面向对象编程，函数式编程，数据驱动式编程提供很好的支持。它可以作为一个强大、轻量的脚本语言，供任何需要的程序使用。 Lua 以一个用 clean C 写成的库形式提供。（所谓 Clean C ，指的 ANSI C 和 C++ 中共通的一个子集） 

作为一个扩展式语言，Lua 没有 "main" 程序的概念：它只能 嵌入 一个宿主程序中工作，这个宿主程序被称作 embedding program 或简称为 host 。宿主程序可以通过调用函数执行一小段 Lua 代码，可以读写 Lua 变量，可以注入 C 函数让 Lua 代码调用。这些扩展的 C 函数，可以大大的扩展了 Lua 可以处理事务的领域，这样就可以订制出各种语言，而它们共享一个统一的句法格式的框架。 Lua 的官方发布版就包含了一个叫做 lua 的简单的宿主程序，它用 Lua 库提供了一个保证独立的 Lua 解释器。 

Lua 是一个自由软件，它的使用许可决定了对它的使用过程一般没有任何保证。这份手册中描述的东西的实现，可以在 Lua 的官方网站 www.lua.org 找到， 

跟其它的许多参考手册一样，这份文档有些地方比较枯燥。关于 Lua 的设计想法的探讨，可以看看 Lua 网站上提供的技术论文。有关用 Lua 编程的细节介绍，可以读一下 Roberto 的书，Programming in Lua (Second Edition) 。 

2 - 语言
这一节从词法、语法、句法上描述 Lua 。换句话说，这一节描述了哪些 token （符记）是有效的，它们如何被组合起来，这些组合方式有什么含义。 

关于语言的构成概念将用常见的扩展 BNF 表达式写出。也就是这个样子： {a} 意思是 0 或多个 a ， [a] 意思是一个可选的 a 。非最终的符号会保留原来的样子，关键字则看起来像这样 kword ，其它最终的符号则写成 `=′ 。完整的 Lua 语法可以在本手册最后找到。 

2.1 - 词法约定
Lua 中用到的 名字（也称作 标识符）可以是任何非数字开头的字母、数字、下划线组成的字符串。这符合几乎所有编程语言中关于名字的定义。（字母的定义依赖于当前环境：系统环境中定义的字母表中的字母都可以被用于标识符。）标识符用来命名变量，或作为表的域名。 

下面的关键字是保留的，不能用作名字： 

     and       break     do        else      elseif
     end       false     for       function  if
     in        local     nil       not       or
     repeat    return    then      true      until     while

Lua 是一个大小写敏感的语言： and 是一个保留字，但是 And 和 AND 则是两个不同的合法的名字。一般约定，以下划线开头连接一串大写字母的名字（比如 _VERSION）被保留用于 Lua 内部全局变量。 

下面这些是其它的 token ： 

     +     -     *     /     %     ^     #
     ==    ~=    <=    >=    <     >     =
     (     )     {     }     [     ]
     ;     :     ,     .     ..    ...

字符串既可以用一对单引号引起，也可以是双引号，里面还可以包含类似 C 的转义符： '\a' （响铃）， '\b' （退格）， '\f' （表单）， '\n' （换行）， '\r' （回车）， '\t' （横向制表）， '\v' （纵向制表）， '\\' （反斜杠）， '\"' （双引号），以及 '\'' （单引号)。而且，如果在一个反斜杠后跟了一个真正的换行符，其结果就是在字符串中产生一个换行符。我们还可以用反斜杠加数字的形式 \ddd 来描述一个字符。这里， ddd 是一串最多三位的十进制数字。（注意，如果需要在这种描述方法后接一个是数字的字符，那么反斜杠后必须写满三个数字。）Lua 中的字符串可以包含任何 8 位的值。包括用 '\0' 表示的零。 

只有在你需要把不同的引号、换行、反斜杠、或是零结束符这些字符置入字符串时，你才必须使用转义符。别的任何字符都可以直接写在文本里。（一些控制符可以会影响文件系统造成某些问题，但是不会引起 Lua 的任何问题。） 

字符串还可以用一种长括号括起来的方式定义。我们把两个正的方括号间插入 n 个等号定义为第 n 级正长括号。就是说，0 级正的长括号写作 [[ ，一级正的长括号写作 [=[ ，如此等等。反的长扩展也作类似定义；举个例子，4 级反的长括号写作 ]====] 。一个长字符串可以由任何一级的正的长括号开始，而由第一个碰到的同级反的长括号结束。整个词法分析过程将不受分行限制，不处理任何转意符，并且忽略掉任何不同级别的长括号。这种方式描述的字符串可以包含任何东西，当然特定级别的反长括号除外。 

另一个约定是，当正的长括号后面立即跟了一个换行符，这个换行符就不包含在这个字符串内。举个例子，假设一个系统使用 ASCII 码（这时，'a' 编码为 97 ，换行符编码为 10 ，'1' 编码为 49 ），下面五种方式描述了完全相同的字符串： 

     a = 'alo\n123"'
     a = "alo\n123\""
     a = '\97lo\10\04923"'
     a = [[alo
     123"]]
     a = [==[
     alo
     123"]==]

数字常量可以分两部分写，十进制底数部分和十进制的指数部分。指数部分是可选的。 Lua 也支持十六进制整数常量，只需要在前面加上前缀 0x 。下面是一些合法的数字常量的例子： 

     3   3.0   3.1416   314.16e-2   0.31416E1   0xff   0x56

注释可以在除字符串内的任何地方是以两横 (--) 开始。如果跟在两横后面的不是一个长括号，这就是一个短注释，它的作用范围直到行末；否则就是一个长注释，其作用范围直到遇到反的长括号。长注释通常被用来临时屏蔽代码块。 

2.2 - 值与类型
Lua 是一种 动态类型语言。这意味着变量没有类型，只有值才有类型。语言中不存在类型定义。而所有的值本身携带它们自己的类型信息。 

Lua 中的所有值都是一致 (first-class) 的。这意味着所有的值都可以被放在变量里，当作参数传递到另一个函数中，并被函数作为结果返回。 

Lua 中有八种基本类型： nil, boolean, number, string, function, userdata, thread, and table. Nil 类型只有一种值 nil ，它的主要用途用于标表识和别的任何值的差异；通常，当需要描述一个无意义的值时会用到它。 Boolean 类型只有两种值：false 和 true。 nil 和 false 都能导致条件为假；而另外所有的值都被当作真。 Number 表示实数（双精度浮点数）。（编译一个其它内部数字类型的 Lua 解释器是件很容易的事；比如把内部数字类型改作单精度浮点数或长整型。参见文件 luaconf.h 。） String 表示一串字符的数组。 Lua 是 8-bit clean 的：字符串可以包含任何 8 位字符，包括零结束符 ('\0') （参见 §2.1）。 

Lua 可以调用（和处理）用 Lua 写的函数以及用 C 写的函数（参见 §2.5.8）. 

userdata 类型用来将任意 C 数据保存在 Lua 变量中。这个类型相当于一块原生的内存，除了赋值和相同性判断，Lua 没有为之预定义任何操作。然而，通过使用 metatable （元表） ，程序员可以为 userdata 自定义一组操作（参见 §2.8）。 userdata 不能在 Lua 中创建出来，也不能在 Lua 中修改。这样的操作只能通过 C API。这一点保证了宿主程序完全掌管其中的数据。 

thread 类型用来区别独立的执行线程，它被用来实现 coroutine （协同例程）（参见 §2.11）。不要把 Lua 线程跟操作系统的线程搞混。 Lua 可以在所有的系统上提供对 coroutine 的支持，即使系统并不支持线程。 

table 类型实现了一个关联数组。也就是说，数组可以用任何东西（除了nil）做索引，而不限于数字。 table 可以以不同类型的值构成；它可以包含所有的类型的值（除 nil 外）。 table 是 lua 中唯一的一种数据结构；它可以用来描述原始的数组、符号表、集合、记录、图、树、等等。用于表述记录时，lua 使用域名作为索引。语言本身采用一种语法糖，支持以 a.name 的形式表示 a["name"]。有很多形式用于在 lua 中创建一个 table （参见 §2.5.7）。 

跟索引一样， table 每个域中的值也可以是任何类型（除 nil外）。特别的，因为函数本身也是值，所以 table 的域中也可以放函数。这样 table 中就可以有一些 methods 了 （参见see §2.5.9）。 

table， function ，thread ，和 (full) userdata 这些类型的值是所谓的对象：变量本身并不会真正的存放它们的值，而只是放了一个对对象的引用。赋值，参数传递，函数返回，都是对这些对象的引用进行操作；这些操作不会做暗地里做任何性质的拷贝。 

库函数 type 可以返回一个描述给定值的类型的字符串。 

2.2.1 - 强制转换
Lua 提供运行时字符串到数字的自动转换。任何对字符串的数学运算操作都会尝试用一般的转换规则把这个字符串转换成一个数字。相反，无论何时，一个数字需要作为字符串来使用时，数字都会以合理的格式转换为字符串。需要完全控制数字怎样转换为字符串，可以使用字符串库中的 format 函数（参见 string.format）。 

2.3 - 变量
写上变量的地方意味着当以其保存的值来替代之。 Lua 中有三类变量：全局变量，局部变量，还有 table 的域。 

一个单一的名字可以表示一个全局变量，也可以表示一个局部变量 （或者是一个函数的参数，这是一种特殊形式的局部变量）： 

	var ::= Name

Name 就是 §2.1 中所定义的标识符。 

任何变量都被假定为全局变量，除非显式的以 local 修饰定义 （参见 §2.4.7）。局部变量有其作用范围：局部变量可以被定义在它作用范围中的函数自由使用（参见 §2.6）。 

在变量的首次赋值之前，变量的值均为 nil。 

方括号被用来对 table 作索引： 

	var ::= prefixexp `[′ exp `]′

对全局变量以及 table 域之访问的含义可以通过 metatable 来改变。以取一个变量下标指向的量 t[i] 等价于调用 gettable_event(t,i)。（参见 §2.8 ，有一份完整的关于 gettable_event 函数的说明。这个函数并没有在 lua 中定义出来，也不能在 lua 中调用。这里我们把它列出来只是方便说明。） 

var.Name 这种语法只是一个语法糖，用来表示 var["Name"]： 

	var ::= prefixexp `.′ Name

所有的全局变量都是放在一个特定 lua table 的诸个域中，这个特定的 table 叫作 environment （环境）table 或者简称为 环境 （参见 §2.9）。每个函数都有对一个环境的引用，所以一个函数中可见的所有全局变量都放在这个函数所引用的环境表（environment table）中。当一个函数被创建出来，它会从创建它的函数中继承其环境，你可以调用 getfenv 取得其环境。如果想改变环境，可以调用 setfenv。（对于 C 函数，你只能通过 debug 库来改变其环境；参见 §5.9）。 

对一个全局变量 x 的访问等价于 _env.x，而这又可以等价于 

     gettable_event(_env, "x")

这里，_env 是当前运行的函数的环境。（函数 gettable_event 的完整说明参见 §2.8。这个函数并没有在 lua 中定义出来，也不能调用。当然，_env 这个变量也同样没有在 Lua 中定义出来。我们在这里使用它们，仅仅只是方便解释而已。） 

2.4 - 语句段（Statement）
Lua 支持惯例形式的语句段，它和 Pascal 或是 C 很相象。这个集合包括赋值，控制结构，函数调用，还有变量声明。 

2.4.1 - Chunk（语句组）
Lua 的一个执行单元被称作 chunk。一个 chunk 就是一串语句段，它们会被循序的执行。每个语句段可以以一个分号结束： 

	chunk ::= {stat [`;′]}

这儿不允许有空的语句段，所以 ';;' 是非法的。 

lua 把一个 chunk 当作一个拥有不定参数的匿名函数（参见 §2.5.9）处理。正是这样，chunk 内可以定义局部变量，接收参数，并且返回值。 

chunk 可以被保存在一个文件中，也可以保存在宿主程序的一个字符串中。当一个 chunk 被执行，首先它会被预编译成虚拟机中的指令序列，然后被虚拟机解释运行这些指令。 

chunk 也可以被预编译成二进制形式；细节参考程序 luac。用源码形式提供的程序和被编译过的二进制形式的程序是可以相互替换的； Lua 会自动识别文件类型并做正确的处理。 

2.4.2 - 语句块
语句块是一列语句段；从语法上来说，一个语句块跟一个 chunk 相同： 

	block ::= chunk

一个语句块可以被显式的写成一个单独的语句段： 

	stat ::= do block end

显式的语句块对于控制变量的作用范围很有用。有时候，显式的语句块被用来在另一个语句块中插入 return 或是 break （参见 §2.4.4）。 

2.4.3 - 赋值
Lua 允许多重赋值。因此，赋值的语法定义是等号左边放一系列变量，而等号右边放一系列的表达式。两边的元素都用逗号间开： 

	stat ::= varlist1 `=′ explist1
	varlist1 ::= var {`,′ var}
	explist1 ::= exp {`,′ exp}

表达式放在 §2.5 里讨论。 

在作赋值操作之前，那一系列的右值会被对齐到左边变量需要的个数。如果右值比需要的更多的话，多余的值就被扔掉。如果右值的数量不够需求，将会按所需扩展若干个 nil。如果表达式列表以一个函数调用结束，这个函数所返回的所有值都会在对齐操作之前被置入右值序列中。（除非这个函数调用被用括号括了起来；参见 §2.5）。 

赋值段首先会做运算完所有的表达式，然后仅仅做赋值操作。因此，下面这段代码 

     i = 3
     i, a[i] = i+1, 20

会把 a[3] 设置为 20，而不会影响到 a[4] 。这是因为 a[i] 中的 i 在被赋值为 4 之前就被拿出来了（那时是 3 ）。简单说 ，这样一行 

     x, y = y, x

可以用来交换 x 和 y 中的值。 

对全局变量以及 table 中的域的赋值操作的含义可以通过 metatable 来改变。对变量下标指向的赋值，即 t[i] = val 等价于 settable_event(t,i,val)。（关于函数 settable_event 的详细说明，参见 §2.8。这个函数并没有在 Lua 中定义出来，也不可以被调用。这里我们列出来，仅仅出于方便解释的目的） 

对于全局变量的赋值 x = val 等价于 _env.x = val，这个又可以等价于 

     settable_event(_env, "x", val)

这里，_env 指的是正在运行中的函数的环境。（变量 _env 并没有在 Lua 中定义出来。我们仅仅出于解释的目的在这里写出来。） 

2.4.4 - 控制结构
if、 while、以及 repeat 这些控制结构符合通常的意义，而且也有类似的语法： 

	stat ::= while exp do block end
	stat ::= repeat block until exp
	stat ::= if exp then block {elseif exp then block} [else block] end

Lua 也有一个 for 语句，它有两种形式（参见 §2.4.5）。 

控制结构中的条件表达式可以返回任何值。 false 和 nil 两者都被认为是假条件。所有不同于 nil 和 false 的其它值都被认为是真（特别需要注意的是，数字 0 和空字符串也被认为是真）。 

在 repeat–until 循环中，内部语句块的结束点不是在 until 这个关键字处，它还包括了其后的条件表达式。因此，条件表达式中可以使用循环内部语句块中的定义的局部变量。 

return 被用于从函数或是 chunk（其实它就是一个函数）中返回值。 函数和 chunk 可以返回不只一个值，所以 return 的语法为 

	stat ::= return [explist1]

break 被用来结束 while、 repeat、或 for 循环，它将忽略掉循环中下面的语句段的运行： 

	stat ::= break

break 跳出最内层的循环。