Lua 調試(Debug)

Lua 提供了 debug 庫用於提供創建我們自定義調試器的功能。Lua 本身並未有內置的調試器，但很多開發者共用了他們的 Lua 調試器代碼。

Lua 中 debug 庫包含以下函數：

序號方法 & 用途
1.debug():

進入一個用戶交互模式，運行用戶輸入的每個字串。 使用簡單的命令以及其他調試設置，用戶可以檢閱全局變數和局部變數， 改變變數的值，計算一些運算式，等等。
輸入一行僅包含 cont 的字串將結束這個函數， 這樣調用者就可以繼續向下運行。

2.getfenv(object):

返回對象的環境變數。

3.gethook(optional thread):

返回三個表示線程鉤子設置的值： 當前鉤子函數，當前鉤子掩碼，當前鉤子計數

4.getinfo ([thread,] f [, what]):

返回關於一個函數資訊的表。 你可以直接提供該函數， 也可以用一個數字 f 表示該函數。 數字 f 表示運行在指定線程的調用棧對應層次上的函數： 0 層表示當前函數（getinfo 自身）； 1 層表示調用 getinfo 的函數 （除非是尾調用，這種情況不計入棧）；等等。 如果 f 是一個比活動函數數量還大的數字， getinfo 返回 nil。

5.debug.getlocal ([thread,] f, local):

此函數返回在棧的 f 層處函數的索引為 local 的局部變數 的名字和值。 這個函數不僅用於訪問顯式定義的局部變數，也包括形參、臨時變數等。

6.getmetatable(value):

把給定索引指向的值的元表壓入堆疊。如果索引無效，或是這個值沒有元表，函數將返回 0 並且不會向棧上壓任何東西。

7.getregistry():

返回註冊表表，這是一個預定義出來的表， 可以用來保存任何 C 代碼想保存的 Lua 值。

8.getupvalue (f, up)

此函數返回函數 f 的第 up 個上值的名字和值。 如果該函數沒有那個上值，返回 nil 。
以 '(' （開括弧）打頭的變數名表示沒有名字的變數 （去除了調試資訊的代碼塊）。

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

將一個函數作為鉤子函數設入。 字串 mask 以及數字 count 決定了鉤子將在何時調用。 掩碼是由下列字元組合成的字串，每個字元有其含義：

  • 'c': 每當 Lua 調用一個函數時，調用鉤子；
  • 'r': 每當 Lua 從一個函數內返回時，調用鉤子；
  • 'l': 每當 Lua 進入新的一行時，調用鉤子。
11.setlocal ([thread,] level, local, value):

這個函數將 value 賦給 棧上第 level 層函數的第 local 個局部變數。 如果沒有那個變數，函數返回 nil 。 如果 level 越界，拋出一個錯誤。

12.setmetatable (value, table):

將 value 的元表設為 table （可以是 nil）。 返回 value。

13.setupvalue (f, up, value):

這個函數將 value 設為函數 f 的第 up 個上值。 如果函數沒有那個上值，返回 nil 否則，返回該上值的名字。

14.traceback ([thread,] [message [, level]]):

如果 message 有，且不是字串或 nil， 函數不做任何處理直接返回 message。 否則，它返回調用棧的棧回溯資訊。 字串可選項 message 被添加在棧回溯資訊的開頭。 數字可選項 level 指明從棧的哪一層開始回溯 （默認為 1 ，即調用 traceback 的那裏）。

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

實例

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

執行以上代碼輸出結果為：

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 函數， getinfo 函數用於返回函數資訊的表。

另一個實例

我們經常需要調試函數的內的局部變數。我們可以使用 getupvalue 函數來設置這些局部變數。實例如下：

實例

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())

執行以上代碼輸出結果為：

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

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

調試類型

  • 命令行調試
  • 圖形介面調試

命令行調試器有：RemDebug、clidebugger、ctrace、xdbLua、LuaInterface - Debugger、Rldb、ModDebug。

圖形界調試器有：SciTE、Decoda、ZeroBrane Studio、akdebugger、luaedit。