Lua 调试(Debug)

Dear 丶 2022-07-15 12:11 206阅读 0赞

# Lua 提供了 debug 库用于提供创建我们自定义调速器的功能。Lua 本身并未有内置的调速器，但很多开发者共享了他们的 Lua 调速器代码。 #

Lua 中 debug 库包含以下函数：

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

<table style="border:0px; margin:4px 0px; padding:0px; border-collapse:collapse; width:729px"> 
 <tbody style="border:0px; margin:0px; padding:0px"> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <th style="border:1px solid rgb(85,85,85); margin:0px; padding:3px; color:rgb(255,255,255); vertical-align:top; width:29px; background-color:rgb(85,85,85)"> 序号</th> 
 <th style="border:1px solid rgb(85,85,85); margin:0px; padding:3px; color:rgb(255,255,255); vertical-align:top; background-color:rgb(85,85,85)"> 方法 &amp; 用途</th> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 1.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> debug(): 进入一个用户交互模式，运行用户输入的每个字符串。 使用简单的命令以及其它调试设置，用户可以检阅全局变量和局部变量， 改变变量的值，计算一些表达式，等等。&nbsp; 输入一行仅包含 cont 的字符串将结束这个函数， 这样调用者就可以继续向下运行。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 2.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> getfenv(object): 返回对象的环境变量。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 3.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> gethook(optional thread): 返回三个表示线程钩子设置的值： 当前钩子函数，当前钩子掩码，当前钩子计数 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 4.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> getinfo ([thread,] f [, what]): 返回关于一个函数信息的表。 你可以直接提供该函数， 也可以用一个数字 f 表示该函数。 数字 f 表示运行在指定线程的调用栈对应层次上的函数： 0 层表示当前函数（getinfo 自身）； 1 层表示调用 getinfo 的函数 （除非是尾调用，这种情况不计入栈）；等等。 如果 f 是一个比活动函数数量还大的数字， getinfo 返回 nil。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 5.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> debug.getlocal ([thread,] f, local): 此函数返回在栈的 f 层处函数的索引为 local 的局部变量 的名字和值。 这个函数不仅用于访问显式定义的局部变量，也包括形参、临时变量等。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 6.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> getmetatable(value): 把给定索引指向的值的元表压入堆栈。如果索引无效，或是这个值没有元表，函数将返回 0 并且不会向栈上压任何东西。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 7.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> getregistry(): 返回注册表表，这是一个预定义出来的表， 可以用来保存任何 C 代码想保存的 Lua 值。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 8.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> getupvalue (f, up) 此函数返回函数 f 的第 up 个上值的名字和值。 如果该函数没有那个上值，返回 nil 。&nbsp; 以 '(' （开括号）打头的变量名表示没有名字的变量 （去除了调试信息的代码块）。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 10.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 将一个函数作为钩子函数设入。 字符串 mask 以及数字 count 决定了钩子将在何时调用。 掩码是由下列字符组合成的字符串，每个字符有其含义： 
 <ul style="border:0px; margin:1em 0px; padding:0px; line-height:16.8px; list-style-type:none"> 
 <li style="border:0px; margin:0px 0px 1em 1em; padding:0px 0px 0px 1.5em; line-height:1.5em; font-size:1em"> '<code style="border:0px; margin:0px; padding:0px">c</code>':&nbsp;每当 Lua 调用一个函数时，调用钩子；</li> 
 <li style="border:0px; margin:0px 0px 1em 1em; padding:0px 0px 0px 1.5em; line-height:1.5em; font-size:1em"> '<code style="border:0px; margin:0px; padding:0px">r</code>':&nbsp;每当 Lua 从一个函数内返回时，调用钩子；</li> 
 <li style="border:0px; margin:0px 0px 1em 1em; padding:0px 0px 0px 1.5em; line-height:1.5em; font-size:1em"> '<code style="border:0px; margin:0px; padding:0px">l</code>':&nbsp;每当 Lua 进入新的一行时，调用钩子。</li> 
 </ul> </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 11.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> setlocal ([thread,] level, local, value): 这个函数将 value 赋给 栈上第 level 层函数的第 local 个局部变量。 如果没有那个变量，函数返回 nil 。 如果 level 越界，抛出一个错误。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 12.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> setmetatable (value, table): 将 value 的元表设为 table （可以是 nil）。 返回 value。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px; background-color:rgb(246,244,240)"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 13.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> setupvalue (f, up, value): 这个函数将 value 设为函数 f 的第 up 个上值。 如果函数没有那个上值，返回 nil 否则，返回该上值的名字。 </td> 
 </tr> 
 <tr style="border:0px; margin:0px; padding:0px"> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> 14.</td> 
 <td style="border:1px solid rgb(212,212,212); margin:0px; padding:7px 5px; font-size:1em; word-break:break-all; word-wrap:break-word; vertical-align:top"> traceback ([thread,] [message [, level]]): 如果 message 有，且不是字符串或 nil， 函数不做任何处理直接返回 message。 否则，它返回调用栈的栈回溯信息。 字符串可选项 message 被添加在栈回溯信息的开头。 数字可选项 level 指明从栈的哪一层开始回溯 （默认为 1 ，即调用 traceback 的那里）。 </td> 
 </tr> 
 </tbody> 
</table>

上表列出了我们常用的调试函数，接下来我们可以看些简单的例子：

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。