Lua 調試(Debug)


Lua 提供了 debug 函式庫用於提供建立我們自訂調速器的功能。 Lua 本身並未有內建的調速器，但許多開發者共享了他們的 Lua 調速器程式碼。

Lua 中debug 函式庫包含以下函數：

sethook ([thread,] hook, mask [, count]):
序號方法& 用途
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. 將一個函數作為鉤子函數設入。


  • ##'

    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。