閱讀(23.9k) 書簽贊(0) 我要糾錯

Lua 調試(Debug)

2022-06-25 15:20 更新

Lua 提供了 debug 庫用于提供創(chuàng)建我們自定義調速器的功能。Lua 本身并未有內(nèi)置的調速器，但很多開發(fā)者共享了他們的 Lua 調速器代碼。

Lua 中 debug 庫包含以下函數(shù)：

sethook ([thread,] hook, mask [, count]):

序號	方法 & 用途
1.	debug(): 進入一個用戶交互模式，運行用戶輸入的每個字符串。使用簡單的命令以及其它調試設置，用戶可以檢閱全局變量和局部變量，改變變量的值，計算一些表達式，等等。輸入一行僅包含 cont 的字符串將結束這個函數(shù)，這樣調用者就可以繼續(xù)向下運行。
2.	getfenv(object): 返回對象的環(huán)境變量。
3.	gethook(optional thread): 返回三個表示線程鉤子設置的值：當前鉤子函數(shù)，當前鉤子掩碼，當前鉤子計數(shù)
4.	getinfo ([thread,] f [, what]): 返回關于一個函數(shù)信息的表。你可以直接提供該函數(shù)，也可以用一個數(shù)字 f 表示該函數(shù)。數(shù)字 f 表示運行在指定線程的調用棧對應層次上的函數(shù)： 0 層表示當前函數(shù)（getinfo 自身）； 1 層表示調用 getinfo 的函數(shù) （除非是尾調用，這種情況不計入棧）；等等。如果 f 是一個比活動函數(shù)數(shù)量還大的數(shù)字， getinfo 返回 nil。
5.	debug.getlocal ([thread,] f, local): 此函數(shù)返回在棧的 f 層處函數(shù)的索引為 local 的局部變量的名字和值。這個函數(shù)不僅用于訪問顯式定義的局部變量，也包括形參、臨時變量等。
6.	getmetatable(value): 把給定索引指向的值的元表壓入堆棧。如果索引無效，或是這個值沒有元表，函數(shù)將返回 0 并且不會向棧上壓任何東西。
7.	getregistry(): 返回注冊表表，這是一個預定義出來的表，可以用來保存任何 C 代碼想保存的 Lua 值。
8.	getupvalue (f, up) 此函數(shù)返回函數(shù) f 的第 up 個上值的名字和值。如果該函數(shù)沒有那個上值，返回 nil 。以 '(' （開括號）打頭的變量名表示沒有名字的變量（去除了調試信息的代碼塊）。
10.	將一個函數(shù)作為鉤子函數(shù)設入。字符串 mask 以及數(shù)字 count 決定了鉤子將在何時調用。掩碼是由下列字符組合成的字符串，每個字符有其含義： '`c`': 每當 Lua 調用一個函數(shù)時，調用鉤子； '`r`': 每當 Lua 從一個函數(shù)內(nèi)返回時，調用鉤子； '`l`': 每當 Lua 進入新的一行時，調用鉤子。
11.	setlocal ([thread,] level, local, value): 這個函數(shù)將 value 賦給棧上第 level 層函數(shù)的第 local 個局部變量。如果沒有那個變量，函數(shù)返回 nil 。如果 level 越界，拋出一個錯誤。
12.	setmetatable (value, table): 將 value 的元表設為 table （可以是 nil）。返回 value。
13.	setupvalue (f, up, value): 這個函數(shù)將 value 設為函數(shù) f 的第 up 個上值。如果函數(shù)沒有那個上值，返回 nil 否則，返回該上值的名字。
14.	traceback ([thread,] [message [, level]]): 如果 message 有，且不是字符串或 nil，函數(shù)不做任何處理直接返回 message。否則，它返回調用棧的?；厮菪畔?。字符串可選項 message 被添加在?；厮菪畔⒌拈_頭。數(shù)字可選項 level 指明從棧的哪一層開始回溯（默認為 1 ，即調用 traceback 的那里）。

上表列出了我們常用的調試函數(shù)，接下來我們可以看些簡單的例子：

function myfunction ()
print(debug.traceback("Stack trace"))
print(debug.getinfo(1))
print("Stack trace end")
    return 10
end
myfunction ()
print(debug.getinfo(1))

執(zhí)行以上代碼輸出結果為：

Stack trace
stack traceback:
   test2.lua:2: in function 'myfunction'
   test2.lua:8: in main chunk
    [C]: ?
table: 0054C6C8
Stack trace end

在以實例中，我們使用到了 debug 庫的 traceback 和 getinfo 函數(shù)， getinfo 函數(shù)用于返回函數(shù)信息的表。

另一個實例

我們經(jīng)常需要調試函數(shù)的內(nèi)的局部變量。我們可以使用 getupvalue 函數(shù)來設置這些局部變量。實例如下：

function newCounter ()
  local n = 0
  local k = 0
  return function ()
    k = n
    n = n + 1
    return n
    end
end

counter = newCounter ()
print(counter())
print(counter())

local i = 1

repeat
  name, val = debug.getupvalue(counter, i)
  if name then
    print ("index", i, name, "=", val)
    if(name == "n") then
        debug.setupvalue (counter,2,10)
   end
    i = i + 1
  end -- if
until not name

print(counter())

執(zhí)行以上代碼輸出結果為：

1
2
index   1   k   =   1
index    2   n   =   2
11

在以上實例中，計數(shù)器在每次調用時都會自增1。實例中我們使用了 getupvalue 函數(shù)查看局部變量的當前狀態(tài)。我們可以設置局部變量為新值。實例中，在設置前 n 的值為 2,使用 setupvalue 函數(shù)將其設置為 10。現(xiàn)在我們調用函數(shù)，執(zhí)行后輸出為 11 而不是 3。