Lua 學習筆記 （五）—— 基礎庫函數

時間  2019-12-05
標籤 lua 學習 筆記 基礎 函數 欄目 Lua 简体版
原文   原文鏈接

基礎庫爲 Lua 提供了一些核心函數。若是沒有包含這個庫，那麼就可能須要本身來實現一些 Lua 語言特性了。html

assert (v [, message])

若是其參數 v 的值爲假（nil 或 false）， 它就調用 error； 不然，返回全部的參數。 在錯誤狀況時， message 指那個錯誤對象； 若是不提供這個參數，參數默認爲 "assertion failed!" 。函數

例子

assert(5==4,"Number Not Equal!")    --> 報錯 Number Not Equal!
assert(nil)                         --> 報錯 assertion failed!

collectgarbage (opt [, arg])

控制垃圾回收器的參數有兩個，pause 和 step multipier。工具

參數 pause 控制了收集器在開始一個新的收集週期以前要等待多久。 隨着數字的增大就致使收集器工做工做的不那麼主動。 小於 1 的值意味着收集器在新的週期開始時再也不等待。 當值爲 2 的時候意味着在總使用內存數量達到原來的兩倍時再開啓新的週期。ui

參數 step multiplier 控制了收集器相對內存分配的速度。 更大的數字將致使收集器工做的更主動的同時，也使每步收集的尺寸增長。 小於 1 的值會使收集器工做的很是慢，可能致使收集器永遠都結束不了當前週期。 缺省值爲 2 ，這意味着收集器將之內存分配器的兩倍速運行。this

該函數是垃圾回收器的通用接口，根據 opt 參數的不一樣實現不一樣的功能。lua

  • "stop": 中止垃圾回收。
  • "restart": 重啓垃圾回收。
  • "collect": 執行垃圾回收的完整循環。
  • "count": 返回 Lua 當前使用的總內存（單位爲 Kb）。
  • "step": 執行一步（一步可由多步組成）垃圾回收。步數可由參數 arg 控制（值越大，步數越多，0 表示執行一步（指最小的一步））。若是執行後完成了回收循環，返回 true。
  • "setpause": 把 arg/100 做爲垃圾回收參數 pause 的新值。
  • "setstepmul": 把 arg/100 做爲垃圾回收參數 step mutiplier 的新值。

例子

進行垃圾回收先後的內存佔用狀況：.net

x = collectgarbage("count")
print(x)            --> 27.5615234375
collectgarbage("collect")
x = collectgarbage("count")
print(x)            --> 26.7490234375

dofile (filename)

打開該名字的文件，並執行文件中的 Lua 代碼塊。 不帶參數調用時， dofile 執行標準輸入的內容（stdin）。 返回該代碼塊的全部返回值。 對於有錯誤的狀況，dofile 將錯誤反饋給調用者 （即，dofile 沒有運行在保護模式下）。debug

例子

同一目錄下新建兩個 Lua 文件，代碼及輸出：3d

-- another.lua
return "Message from another file!"

-- sample.lua
x = dofile("./another.lua")
print(x)    --> Message from another file!

dofile 在這裏等價於調試

function dofile()
    function func()
        return "Message from another file!"
    end

    return func()
end

因而等價的輸出爲

print(dofile()) --> Message from another file!

error (message [, level])

終止所保護的函數，拋出 message 消息，再也不返回。

一般這個函數會在拋出的消息前面加上發生錯誤的地址信息。堆棧等級決定添加哪一個地址。若是堆棧等級爲 0 ，不返回地址信息；若是爲 1，返回 error 語句所在位置；若是爲 2，返回調用 error所在函數的位置；依此類推。

定義

error([報錯消息],[堆棧等級]=1)

例子

function division(a,b)
    if b == 0 then error("Divisor cannot be 0!",2) end      -- level 值爲 1 時，錯誤信息指向這裏
    return a / b
end

print(division(5,1))
print(division(5,0))        -- level 值爲 2 時，錯誤信息指向這裏

_G

_G 持有全局環境的變量，Lua 自己用不到這個變量，更改變量不會影響到全局環境；反過來也同樣。

getfenv (f)

返回函數的環境。 f 能夠是一個 Lua 函數，也能夠是函數在堆棧中的等級。等級 1 表明調用 getfenv() 的那個函數。若是傳入的函數不是 Lua 函數，或者 f 是 0，那麼 getfenv 返回 全局環境。

~~[待補充]不是太明白，沒能給出合適的代碼~~
參考 Lua中的環境概念

定義

getfenv([目標函數]=1)

例子

獲取全局環境：

for k,v in pairs(_G) do
print(k,v)
end

--string            table: 0x7ff200f02330
--xpcall            function: 0x7ff200d03cc0
--package           table: 0x7ff200e00000
--tostring          function: 0x7ff200d04560
--print             function: 0x7ff200d046a0
--os                table: 0x7ff200f01cb0
--unpack            function: 0x7ff200d04610
--require           function: 0x7ff200f006f0
--getfenv           function: 0x7ff200d042f0
--setmetatable      function: 0x7ff200d044a0
--next              function: 0x7ff200d04260
--assert            function: 0x7ff200d03fc0
--tonumber          function: 0x7ff200d04500
--io                table: 0x7ff200f014a0
--rawequal          function: 0x7ff200d046f0
--collectgarbage    function: 0x7ff200d04010
--arg               table: 0x7ff200e01360
--getmetatable      function: 0x7ff200d04340
--module            function: 0x7ff200f006a0
--rawset            function: 0x7ff200d047a0
--math              table: 0x7ff200e00040
--debug             table: 0x7ff200e00a00
--pcall             function: 0x7ff200d042b0
--table             table: 0x7ff200f00790
--newproxy          function: 0x7ff200d04820
--type              function: 0x7ff200d045c0
--coroutine         table: 0x7ff200d048c0
--_G                table: 0x7ff200d02fc0
--select            function: 0x7ff200d04400
--gcinfo            function: 0x7ff200d03000
--pairs             function: 0x7ff200d03e00
--rawget            function: 0x7ff200d04750
--loadstring        function: 0x7ff200d04200
--ipairs            function: 0x7ff200d03d70
--_VERSION          Lua 5.1
--dofile            function: 0x7ff200d04110
--setfenv           function: 0x7ff200d04450
--load              function: 0x7ff200d041b0
--error             function: 0x7ff200d04160
--loadfile          function: 0x7ff200d043a0

getmetatable (object)

若是對象沒有元表，返回空；若是對象有 __metatable 域，返回對應的值；不然，返回對象的元表。

例子

對象有 __metatable 域的狀況：

t = {num = "a table"}

mt = {__index = {x = 1,y = 2},__metatable = {__index = {x = 5,y = 6}}}
setmetatable(t, mt)

print(getmetatable(t).__index.x)  --> 5
print(t.x)                        --> 1

~~進行操做時的元表依舊是與值直接關聯的那個元表，不知道這樣子處理有什麼做用？~~

ipairs (t)

返回三個值：迭代器、傳入的表 t、值 0 。迭代器可以根據傳入的表 t 和索引 i 獲得 i+1 和 t[i+1] 的值。

其實現形式相似於這樣：

function ipairs(t)

    function iterator(t,i)
        i = i + 1
        i = t[i] and i      -- 若是 t[i] == nil 則 i = nil；不然 i = i
        return i,t[i]
    end

    return iterator,t,0

end

例子

使用 ipairs 對錶進行遍歷，會從鍵值爲 1 開始依次向後遍歷，直到值爲 nil。

t = {"1","2",nil,[4]="4"}
-- t = {"1","2",[4]="4"}   -- 使用該表會獲得相同的輸出

for i,v in ipairs(t) do
    print(i,v)
end

--> 1   1
--> 2   2

load (func [, chunkname])

經過傳入函數 func 的返回值獲取代碼塊片斷。func 函數的後一次調用返回的字符串應當能與前一次調用返回的字符串銜接在一塊兒，最終獲得完整的代碼塊。函數返回 nil 或無返回值時表示代碼塊結束。

load 函數會將獲得的代碼塊做爲函數返回。返回函數的環境爲全局環境。若是出現錯誤，load 會返回 nil 和 錯誤信息。

chunkname 做爲該代碼塊的名稱，用在錯誤信息與調試信息中。

例子

[待補充]

loadfile ([filename])

使用方式與 dofile 相似，函數內容與 load 相似。從文件中獲取代碼塊，若是沒有指定文件，則從標準輸入中獲取。

loadfile 把文件代碼編譯爲中間碼，以文件代碼做爲一個代碼塊（chunk）,並返回包含此代碼塊的函數。
編譯代碼成中間碼，並返回編譯後的chunk做爲一個函數。 若是出現錯誤，則返回 nil 以及錯誤信息。

使用 loadfile，能夠一次編譯屢次運行；而每次使用 dofile，都會執行一次編譯。

例子

同一目錄下新建兩個 Lua 文件，代碼及輸出：

-- sample.lua
f = loadfile("./sample.lua")
print(f())
--> Message from another file!
--> 0

-- another.lua
function fun()
 print("Message from another file!")
 return 0
end
res = fun()
return res

loadfile 在這裏等價於

function loadfile()
    function fun()
     print("Message from another file!")
     return 0
    end
    res = fun()
    return res
end

loadstring (string [, chunkname])

與 load 相似，只不過是從字符串中獲取代碼塊。

要想加載並運行所給的字符串，使用以下慣用形式：

assert(loadingstring(s))()

next (table [, index])

返回傳入的表中下一個鍵值對。

定義

next([表],[鍵]=nil)

第一個參數是要操做的表，第二個參數是表中的某個鍵。若是傳入的鍵值爲 nil ，則函數返回第一個鍵值對。若是傳入一個有效的鍵值，則輸出下一對鍵值對。若是沒有下一個鍵值對，返回 nil。

根據定義，可使用 next 來判斷一個表是否爲空表。

注意：

鍵值對的遍歷順序是不必定的，即便是對數字索引也是如此。若是想要按照數字索引的順序獲取鍵值對，參見 ipairs (t) 函數。

例子

t = {"table",["a"] = 5, ["c"] = 6}

-- index 爲 nil
print(next(t, nil))         --> 1   table

-- index 爲 無效鍵
print(next(t,"d"))          --> 編譯錯誤

-- index 爲 數字索引
print(next(t,1))            --> a   5

-- index 爲 通常鍵
print(next(t, "a"))         --> c   6

-- index 爲 最後一個鍵
print(next(t,"c"))          --> nil

遍歷順序與定義順序不一致的例子：

t = {[1]="table",b = 4,["a"] = 5, ["c"] = 6, func}

t.func = function (...)
    return true
end

for k,v in pairs(t) do
    print(k,v)
end
--> a   5
--> func    function: 0x7f7f63c0ad50
--> c   6
--> b   4

並且從上面的例子中能夠看出 name = exp 的鍵值對形式會佔用

pairs (t)

返回三個值：next 函數，表 t，nil。一般用來遍歷表中的全部鍵值對。
若是 t 有元方法 __pairs ，將 t 做爲參數 傳入該函數並返回前三個返回值。

在使用 pairs 函數遍歷表的過程當中，能夠刪除域或者修改已有的域，可是若是添加新的域，可能出現沒法預期的問題。

例子

t = {"table",["a"] = 5, ["c"] = 6}
for k,v in pairs(t) do
    print(k,v)
end
--> 1   table
--> a   5
--> c   6

在遍歷表的過程當中添加新的域致使問題出現的狀況：

t = {"table",["a"] = 5, ["c"] = 6}

for k,v in pairs(t) do
    -- 添加一個新的域
    if k == 'a' then
        t[2] = 8
    end
    print(k,v)
end
--> 1   table
--> a   5

pcall (f [, arg1, ...])

以保護模式調用傳入的函數，也就是說不會拋出錯誤。若是捕獲到拋出的錯誤，第一個參數返回 false，第二個參數返回錯誤信息；若是沒有出現錯誤，第一個參數返回 ture，後面的參數返回傳入函數的返回值。

#

function fun(a,b)

    assert(not(b == 0), "divisor can't be 0 !")

    return a / b    
end

success, res = pcall(fun,5,0) --> false .../sample.lua:3: divisor can't be 0 !
success, res = pcall(fun,5,1) --> true  5

print (...)

僅做爲快速查看某個值的工具，不用作格式化輸出。正式的格式化輸出見 string.format 與 io.write。

rawequal (v1, v2)

以 raw 做爲前綴的函數均表示該方法在不觸發任何元方法的狀況下調用。

rawequal 檢查 v1 是否與 v2 相等，返回比較結果。

例子

t = {"value"}
s = "value"
s2 = "value"
print(rawequal(t, s))     --> false
print(rawequal(s, s2))    --> true

rawget (table, index)

獲取 table 中鍵 index 的關聯值，table 參數必須是一個表，找不到返回 nil 。

例子

t = {"value",x = 5}

print(rawget(t, 1))     --> value
print(rawget(t, "x"))   --> 5
print(rawget(t, 2))     --> nil
print(rawget("value",1))--> bad argument #1 to 'rawget' (table expected, got string)

rawset (table, index, value)

將 table[index] 的值設置爲 value 。table 必須是一張表，index 不能是 nil 或 NaN 。value 能夠是任何值。返回修改後的 table 。

例子

t = {"value",x = 5}
t2 = {"sub table"}
rawset(t, 1,"new value")
rawset(t, "y", 6)
rawset(t, t2,"sub table")
rawset(t,NaN,"NaN")         --> table index is nil

print(t[1])                 --> new value
print(t.y)                  --> 6
print(t[t2])                --> sub table

select (index, ...)

index 能夠是數字或者字符 '#' 。當 index 爲數字時，返回第 index + 1 個參數及後面的參數（支持負數形式的 index）；當 index 爲 '#' 時，返回參數的個數（不包括第一個參數）。

例子

t = {"table",x = 5}
t2 = {"table2"}

print(select(  1, 1, t, t2))    --> 1  table: 0x7fad7bc0a830 table: 0x7fad7bc0ac20
print(select( -3, 1, t, t2))    --> 1  table: 0x7fad7bc0a830 table: 0x7fad7bc0ac20
print(select("#", 1, t, t2))    --> 3

setfenv (f, table)

設置函數 f 的環境表爲 table 。f 能夠是一個函數，或者是表明棧層級的數字。棧層級爲 1 的函數是那個調用 setfenv 的函數，棧層級爲 2 的函數就是更上一層的函數。 setfenv 返回 f。

特別的，若是 f 爲 0，那麼 setfenv 會把全局環境設置爲 table 。而且不作任何返回。

Lua 的以後版本中去掉了 setfenv 和 getfenv 函數。

例子

使用棧層級操做 setfenv 的例子：

function foobar(...)

    -- 設置 foobar 的環境
    t = {}
    setmetatable(t, {__index = _G })
    setfenv(1,t)
    a = 1
    b = 2

    -- 輸出 foobar 的環境
    for k,v in pairs(getfenv(1)) do
        print(k,v)
    end
    print()

    function foo(...)
        -- 設置 foo 的環境，繼承 foobar 的環境
        local t = {}
        setmetatable(t, {__index = _G})
        setfenv(1,t)
        x = 3
        y = 4

        -- 輸出 foo 的環境
        for k,v in pairs(getfenv(1)) do
            print(k,v)
        end
        print()

        -- 再次設置 foobar 的環境
        setfenv(2, t)
    end


    foo()

    -- 再次輸出 foobar 的環境
    for k,v in pairs(getfenv(1)) do
        print(k,v)
    end
end

foobar()

--> a   1
--> b   2
--> 
--> y   4
--> x   3
--> 
--> y   4
--> x   3

將 setfenv 用於模塊加載：

-- sample.lua 文件
local FuncEnv={}    -- 做爲環境
setmetatable(FuncEnv, {__index = _G}) -- 爲了可以訪問本來全局環境的值，將全局環境表（_G）放在元表中

local func=loadfile("other.lua")    -- 返回一個函數，函數以 other 文件內容做爲代碼塊
setfenv(func,FuncEnv)
func()                              -- 執行代碼塊，獲得定義的 message 函數，該函數會存在環境中
FuncEnv.message()                   --經過環境調用函數，FuncEnv 此時就至關於一個獨立模塊
-- other.lua 文件
function message()
    print("Message from another file!")
end

本小節參考了 斯芬克斯 的 設置函數環境——setfenv ，icyday 的 lua5.1中的setfenv使用 兩篇博客。

setmetatable (table, metatable)

給 table 關聯元表 metatable 。返回參數 table 。

若是元表定義了 __metatable 域，會拋出錯誤。

metatable 參數爲 nil 表示解除已經關聯的元表。

例子

-- 關聯一個定義了加法操做的元表
t = setmetatable({}, {__add = function(a,b)
    if type(a) == "table" and type(b) == "table" then
        return a.num + b.num
    end
end})

t.num = 5
t2 = {num = 6}
print(t+t2)         --> 11      -- 只要有一個表進行了關聯就可以進行運算

setmetatable(t, nil)            

-- 解除關聯後再進行加法運算會報錯
print(t+t2)         --> attempt to perform arithmetic on global 't' (a table value)

tonumber (e [, base])

tonumber([值],[基數]=10)

嘗試把 e 轉換爲十進制數值並返回。若是沒法轉換返回 nil 。

base 表示傳入參數的進制，默認爲 10 進制。base 的可輸入範圍 [2,36]。高於 10 的數字用字母表示，A-Z 分別表示 11-35 。

例子

print(tonumber(123))            --> 123
print(tonumber("123"))          --> 123
print(tonumber("abc"))          --> nil
print(tonumber("abc", 20))      --> 4232
print(tonumber("ABC", 20))      --> 4232

tostring (e)

能將任意類型的值轉換爲合適的字符串形式返回。要控制數字轉換爲字符串的方式，使用 string.format(formatstring,...) 。

若是值所關聯的元表有 __tostring 域，則使用該域的元方法獲取字符串。

例子

function func()
    print("this is a function")
end
t = {name = "table"}

print(tostring(123))        --> 123
print(tostring("abc"))      --> abc
print(tostring(func))       --> function: 0x7f86348013b0
print(tostring(t))          --> table: 0x7f86348013e0

type (v)

返回 v 的類型，類型以字符串形式返回。 有如下八種返回值： "nil" ， "number"， "string"， "boolean"， "table"， "function"， "thread"， "userdata"。

例子

type(nil)                   --> "nil"
type(false)                 --> "boolean"
type(123)                   --> "number"
type("abc")                 --> "string"

print(type(nil) == "nil")   --> true

unpack (list [, i [, j]])

unpack([列表],[起始位置]=1,[返回個數]=[列表長度])

返回表中的各個域的值，等價於返回

return list[i], list[i+1], ···, list[j]

例子

t = {1,2,3,a = 4,b = 5}

print(unpack(t, 1, 4))      --> 1   2   3   nil

_VERSION

包含有當前解釋器版本號的全局變量，當前版本的值爲 "Lua 5.1"。

xpcall (f, err [, arg1, ...]

與 pcall (f, arg1, ...) 相似。不一樣的是，若是 f 函數拋出了錯誤，那麼 xpcall 不會返回從 f 拋出的錯誤信息，而是使用 err 函數返回的錯誤信息。

例子

function fun(a,b)   -- 這裏的參數沒什麼實際做用，就是展現下用法
    error("something wrong !!", 1)
end

-- pcall 
local success, res = pcall(fun,1,2)
print(success,res)      --> false   .../sample.lua:2: something wrong !!

-- xpcall
local success, res = xpcall(fun,function()
    return "an error occured !!"
end,1,2)
print(success,res)      --> false   an error occured !!

參考連接

設置函數環境——setfenv（解釋瞭如何方便地設置函數的環境，以及爲何要那樣設置）
lua5.1中的setfenv使用（介紹了該環境的設置在實際中的一個應用）
Lua入門系列-果凍想（對Lua進行了較爲全面的介紹）

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程