Lua 调试(Debug)

Lua 语言提供了 debug 库让开发者可以创建自定义调速器的功能。

虽然 Lua 语言本身并未有内置的调速器，但 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 的那里）

范例 1 ： debug 库的简单使用

下面的范例中，我们使用到了 debug 库的 traceback 和 getinfo 函数

getinfo 函数用于返回函数信息的表

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.

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

myfunc ()
print(debug.getinfo(1))

运行以上 Lua 脚本，输出结果如下：

$ lua main.lua
Stack trace
stack traceback:
    main.lua:12: in function 'myfunc'
    main.lua:18: in main chunk
    [C]: in ?
table: 0x7fc5cf504590
Stack trace end
table: 0x7fc5cf504b50

范例 2 ：使用 debug.getupvalue() 函数设置函数内的局部变量

debug.getupvalue() 函数可以设置函数内的局部变量

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


array = {"QQ", "Baidu",'Ali','Sina','Meituan'}


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,8)
      end
    i = i + 1
  end -- if
until not name

print(counter())

运行以上 Lua 脚本，输出结果如下：

$ lua main.lua
1
2
index   1   k   =   1
index   2   n   =   2
9

这个范例中，计数器在每次调用时都会自增1。

范例使用了 getupvalue 函数查看局部变量的当前状态。

可以通过设置局部变量为新值：范例中，在设置前 n 的值为 2,使用 setupvalue 函数将其设置为 10。然后调用函数，执行后输出为 11 而不是 3

调试类型

命令行调试
图形界面调试

命令行调试器有：

RemDebug
clidebugger
ctrace
xdbLua
LuaInterface
Debugger
Rldb
ModDebug

图形界调试器有：

SciTE
Decoda
ZeroBrane Studio
akdebugger
luaedit