lua基本库函数总结

lua库函数

lua5.2官网手册：Lua 5.2 Reference Manual：

http://www.lua.org/manual/5.2/（基本函数参考第6章节）

lua所有文档：lua Documentation :

http://www.lua.org/docs.html

assert (v [, message])
功能：相当于C的断言，
参数：
v：当表达式v为nil或false将触发错误,
message：发生错误时返回的信息，默认为"assertion failed!"


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

collectgarbage (opt [, arg])
功能：是垃圾收集器的通用接口，用于操作垃圾收集器
参数：
opt：操作方法标志
"Stop": 停止垃圾收集器 
"Restart": 重启垃圾收集器 
"Collect": 执行一次全垃圾收集循环
"Count": 返回当前Lua中使用的内存量(以KB为单位)
"Step": 单步执行一个垃圾收集. 步长 "Size" 由参数arg指定　(大型的值需要多步才能完成)，如果要准确指定步长，需要多次实验以达最优效果。如果步长完成一次收集循环，将返回True
"Setpause": 设置 arg/100 的值作为暂定收集的时长 
"Setstepmul": 设置 arg/100 的值，作为步长的增幅(即新步长＝旧步长*arg/100)


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

dofile (filename)
功能：打开并且执行一个lua块,当忽略参数filename时，将执行标准输入设备(stdin)的内容。返回所有块的返回值。当发生错误时，dofile将错误反射给调用者
注：dofile不能在保护模式下运行


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

error (message [, level])
功能：终止正在执行的函数，并返回message的内容作为错误信息(error函数永远都不会返回)
通常情况下，error会附加一些错误位置的信息到message头部.
Level参数指示获得错误的位置,
Level=1[默认]：为调用error位置(文件+行号)
Level=2：指出哪个调用error的函数的函数
Level=0:不添加错误位置信息


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

_G全局环境表(全局变量)
功能：记录全局环境的变量值的表 _G._G = _G


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

getfenv(f)
功能：返回函数f的当前环境表
参数：f可以为函数或调用栈的级别，级别1[默认]为当前的函数,级别0或其它值将返回全局环境_G


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

getmetatable(object)
功能：返回指定对象的元表(若object的元表.__metatable项有值，则返回object的元表.__metatable的值)，当object没有元表时将返回nil


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

ipairs (t)
功能：返回三个值 迭代函数、表、0
多用于穷举表的键名和键值对
如：for i,v in ipairs(t) do 

end
每次循环将索引赋级i，键值赋给v
注：本函数只能用于以数字索引访问的表 如：t={"1","cash"}


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

load (func [, chunkname])
功能：装载一个块中的函数，每次调用func将返回一个连接前一结的字串，在块结尾处将返回nil
当没有发生错误时，将返回一个编译完成的块作为函数,否则返回nil加上错误信息，此函数的环境为全局环境
chunkname用于错误和调试信息


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

loadfile ([filename])
功能：与load类似，但装载的是文件或当没有指定filename时装载标准输入(stdin)的内容


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

loadstring (string [, chunkname])
功能：与load类似，但装载的内容是一个字串
如：assert(loadstring(s))()


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

next (table [, index])
功能：允许程序遍历表中的每一个字段，返回下一索引和该索引的值。
参数：table：要遍历的表
　　　index：要返回的索引的前一索中的号，当index为nil[]时，将返回第一个索引的值，当索引号为最后一个索引或表为空时将返回nil
注：可以用next(t)来检测表是否为空(此函数只能用于以数字索引的表与ipairs相类似)


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

ipairs (t)
功能：返回三个值 next函数、表、0
多用于穷举表的键名和键值对
如：for n,v in pairs(t) do 

end
每次循环将索引赋级i，键值赋给v
注：本函数只能用于以键名索引访问的表 如：t={id="1",name="cash"}


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

pcall (f, arg1, ···)
功能：在保护模式下调用函数(即发生的错误将不会反射给调用者)
当调用函数成功能返回true,失败时将返回false加错误信息


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

print (···)
功能：简单的以tostring方式格式化输出参数的内容


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

rawequal (v1, v2)
功能：检测v1是否等于v2，此函数不会调用任何元表的方法


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

rawget (table, index)
功能：获取表中指定索引的值，此函数不会调用任何元表的方法，成功返回相应的值，当索引不存在时返回nil
注：本函数只能用于以数字索引访问的表 如：t={"1","cash"}


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

rawset (table, index, value)
功能：设置表中指定索引的值，此函数不会调用任何元表的方法，此函数将返回table


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

select (index, ···)
功能：当index为数字将返回所有index大于index的参数:如：select(2,"a","b") 返回 "b"
当index为"#"，则返回参数的总个数(不包括index)


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

setfenv (f, table)
功能：设置函数f的环境表为table
参数：f可以为函数或调用栈的级别，级别1[默认]为当前的函数,级别0将设置当前线程的环境表


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

setmetatable (table, metatable)
功能：为指定的table设置元表metatable，如果metatable为nil则取消table的元表，当metatable有__metatable字段时，将触发错误
注：只能为LUA_TTABLE 表类型指定元表


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

tonumber (e [, base])
功能：尝试将参数e转换为数字，当不能转换时返回nil
base(2~36)指出参数e当前使用的进制，默认为10进制，如tonumber(11,2)=3


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

tostirng(e)
功能：将参数e转换为字符串，此函数将会触发元表的__tostring事件


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

type(v)
功能：返回参数的类型名("nil"，"number", "string", "boolean", "table", "function", "thread", "userdata")


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

unpack (list [, i [, j]])
功能：返回指定表的索引的值,i为起始索引，j为结束索引

注：本函数只能用于以数字索引访问的表,否则只会返回nil 如：t={"1","cash"}

    > lua
    > print(unpack{10,20,30})
    10  20  30
    > a,b = unpack{10,20,30}
    > print(a,b)
    10  20
    > string.find(unpack{"hello","ll"})  --等同于string.find("hello","ll")
    在Lua中unpack函数是用C语言实现的。为了便于理解，下面给出在Lua中通过递归实现一样的效果，如：

1 function unpack(t,i)2     i = i or 13     if t[i] then4         return t[i], unpack(t,i + 1)5     end6 end

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

_VERSION
功能：返回当前Lua的版本号"Lua 5.1". 


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

xpcall (f, err)
功能：与pcall类似，在保护模式下调用函数(即发生的错误将不会反射给调用者)
但可指定一个新的错误处理函数句柄

当调用函数成功能返回true,失败时将返回false加err返回的结果

====================================================================================

string库：

------------------------------------------------------------------------------------string.find（s,pattern）

s,e = string.find("Hello Lua users","Lua")print("The begin index is " .. s .. ", the end index is " .. e .. ".");-- The begin index is 7, the end index is 9.

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

1、基础字符串函数

    1). string.len(s) 返回字符串s的长度；

    2). string.rep(s,n) 返回字符串s重复n次的结果；

    3). string.lower(s) 返回s的副本，其中所有的大写都被转换为了小写形式，其他字符不变；

    4). string.upper(s) 和lower相反，将小写转换为大写；

    5). string.sub(s,i,j) 

提取字符串s的第i个到第j个字符。Lua中，第一个字符的索引值为1，最后一个为-1，以此类推，如：print(string.sub("[hello world]",2,-2))      --输出hello world

    6). string.format(s,...) 

返回格式化后的字符串，其格式化规则等同于C语言中printf函数，如：
    print(string.format("pi = %.4f",math.pi)) --输出pi = 3.1416

    7). string.char(...) 

参数为0到多个整数，并将每个整数转换为对应的字符。然后返回一个由这些字符连接而成的字符串，如：
    print(string.char(97,98,99)) --输出abc

    8). string.byte(s,i) 

返回字符串s的第i个字符的Ascii值，如果没有第二个参数，缺省返回第一个字符的Ascii值。
    print(string.byte("abc"))      --输出97
    print(string.byte("abc",-1))  --输出99

    由于字符串类型的变量都是不可变类型的变量，因此在所有和string相关的函数中，都无法改变参数中的字符串值，而是生成一个新值返回。

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

2、模式匹配函数

 Lua的字符串库提供了一组强大的模式匹配函数，如find、match、gsub和gmatch。

    1). string.find：
    

在目标字符串中搜索一个模式，如果找到，则返回匹配的起始索引和结束索引，否则返回nil。如：

1 s = "hello world"2 i, j = string.find(s,"hello")  3 print(i, j)        --输出1  54 i, j = string.find(s,"l")5 print(i, j)        --输出3  36 print(string.find(s,"lll"))  --输出nil

函数还有一个可选参数，它是一个索引，用于告诉函数从目标字符串的哪个位置开始搜索。主要用于搜索目标字符串中所有匹配的子字符串，且每次搜索都从上一次找到的位置开始。如：

1 local t = {}2 local i = 03 while true do4     i = string.find(s,"\n",i+1)5     if i == nil then6         break7     end8     t[#t + 1] = i9 end

    2). string.match：

     该函数返回目标字符串中和模式字符串匹配的部分。如：

1 date = "Today is 2012-01-01"2 d = string.match(date,"%d+\-%d+\-%d+")3 print(d)  --输出2012-01-01

    3). string.gsub：

该函数有3个参数，目标字符串、模式和替换字符串。基本用法是将目标字符串中所有出现模式的地方替换为替换字符串。如：
    print(string.gsub("Lua is cute","cute","great"))  --输出Lua is great
    该函数还有可选的第4个参数，即实际替换的次数。
    print(string.gsub("all lii","l","x",1))  --输出axl lii
    print(string.gsub("all lii","l","x",2))  --输出axx lii
    函数string.gsub还有另一个结果，即实际替换的次数。
    count = select(2, string.gsub(str," "," "))  --输出str中空格的数量

    4). string.gmatch：

    返回一个函数，通过这个返回的函数可以遍历到一个字符串中所有出现指定模式的地方。如：

1 words = {}2 s = "hello world"3 for w in string.gmatch(s,"%a+") do4     print(w)5     words[#words + 1] = w6 end7 --输出结果为：8 --hello9 --world

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

下面的列表给出了Lua目前支持的模式元字符；

模式元字符描述.所有字符%a字母%c控制字符%d数字%l小写字母%p标点符号%s空白字符%u大写字母%w字母和数字字符%x十六进制数字%z内部表示为0的字符

    这些元字符的大写形式表示它们的补集，如%A，表示所有非字母字符。
    print(string.gsub("hello, up-down!","%S","."))   --输出hello..up.down. 4
    上例中的4表示替换的次数。
    除了上述元字符之外，Lua还提供了另外几个关键字符。如：( ) . % + - * ? [ ] ^ $
    其中%表示转义字符，如%.表示点(.)，%%表示百分号(%)。
    方括号[]表示将不同的字符分类，即可创建出属于自己的字符分类，如[%w_]表示匹配字符、数字和下划线。
    横线(-)表示连接一个范围，比如[0-9A-Z]
    如果^字符在方括号内，如[^\n]，表示除\n之外的所有字符，即表示方括号中的分类的补集。如果^不在方括号内，则表示以后面的字符开头，$和它正好相反，表示以前面的字符结束。如：^Hello%d$，匹配的字符串可能为Hello1、Hello2等。
    在Lua中还提供了4种用来修饰模式中的重复部分，如：+(重复1次或多次)、*(重复0次或多次)、-(重复0次或多次)和?(出现0或1次)。如：
    print(string.gsub("one, and two; and three","%a+","word")) --输出word, word word; word word
    print(string.match("the number 1298 is even","%d+")) --输出1298
    星号(*)和横线(-)的主要差别是，星号总是试图匹配更多的字符，而横线则总是试图匹配最少的字符。
---------------------------------------
    捕获(capture)：
    捕获功能可根据一个模式从目标字符串中抽出匹配于该模式的内容。在指定捕获是，应将模式中需要捕获的部分写到一对圆括号内。对于具有捕获的模式，函数string.match会将所有捕获到的值作为单独的结果返回。即它会将目标字符串切成多个捕获到的部分。如：

1 pair = "name = Anna"2 key,value = string.match(pair,"(%a+)%s*=%s*(%a+)")3 print(key,value)  --输出name anna4 5 date = "Today is 2012-01-02"6 y,m,d = string.match(date,"(%d+)\-(%d+)\-(%d+)")7 print(y,m,d)      --输出2012    01      02

    还可以对模式本身使用捕获。即%1表示第一个捕获，以此类推，%0表示整个匹配，如：

1 print(string.gsub("hello Lua","(.)(.)","%2%1"))  --将相邻的两个字符对调，输出为ehll ouLa2 print(string.gsub("hello Lua!","%a","%0-%0"))    --输出为h-he-el-ll-lo-o L-Lu-ua-a!

--------------------------------------
 替换：
    string.gsub函数的第三个参数不仅可以是字符串，也可以是函数或table，如果是函数，string.gsub会在每次找到匹配时调用该函数，调用时的参数就是捕获到的内容，而该函数的返回值则作为要替换的字符串。当用一个table来调用时，string.gsub会用每次捕获到的内容作为key，在table中查找，并将对应的value作为要替换的字符串。如果table中不包含这个key，那么string.gsub不改变这个匹配。如：

 1 function expand(s) 2     return (string.gsub(s,"$(%w+)",_G)) 3 end 4  5 name = "Lua"; status = "great" 6 print(expand("$name is $status, isn't it?"))  --输出 Lua is great, isn't it? 7 print(expand("$othername is $status, isn't it?"))  --输出 $othername is great, isn't it? 8  9 function expand2(s)10     return (string.gsub(s,"$(%w+)",function(n) return tostring(_G[n]) end))11 end12 13 print(expand2("print = $print; a = $a")) --输出 print = function: 002B77C0; a = nil