LUPEはピュアLuaで書かれたデバッガです。 Lua 5.1とLua 5.2で動くように実装されています。
- ブレークポイント（追加，削除，一覧表示）
- ステップイン
- ステップアウト
- ステップオーバー
- コードの出力
- ローカル変数一覧の出力
- 式の評価
- ローカル変数とグローバル変数の宣言位置の取得
- ウォッチ式
- 簡易プロファイラ
lupe.luaを生成するには，concat.shを実行する必要があります．
$ ./concat.sh
LUPEをコマンドラインから使うには，lupe.luaを読み込んでLupeオブジェクト使えるようにする必要があります．
lupe.luaはリポジトリ直下にあるため，それをデバッグしたいLuaコードのあるプロジェクトにコピーしておきます．
$ cp lupe.lua myproject/
次にlupe.lua読み込みを行います．ピュアLuaの場合はrequireを使います．読み込みはデバッガを使用したいLuaファイルの先頭で行うと良いでしょう．
そして，読み込んだ後はデバッガをスタートするためにLupe:start()を呼び出します．
なお，デバッガを停止させたい場合はLupe:stop()を呼び出すとブレークポイントなどが無効になります．
-- ピュアLua
require('lupe')
Lupe:start()
...addBreakPointまたはabを使用するとブレークポイントを追加できます．
LUPE>ab [source] line
ソースファイル(source)を省略すると，現在のファイルの指定した行にブレークポイントを追加します．
removeBreakPoint またはrbを使用するとブレークポイントを削除できます．
LUPE>rb [source] line
引数はaddBreakPointと同様です．
breakPointListまたはblを使用するとブレークポイントの一覧を表示できます．
LUPE>bl
@start.lua:63
stepまたはsを使用するとステップオーバーでステップ実行できます．
LUPE>s [num_step]
num_stepで実行するステップ数を指定することができます．
省略した場合は，1ステップだけ実行する．
stepInまたはsiを使用するとステップインでステップ実行できます．
LUPE>si [num_step]
引数についてはstepと同様です．
stepOutまたはsoを使用するとステップインでステップ実行できます．
LUPE>so [num_step]
引数についてはstepと同様です．
runを使用すると処理再開することができます．
次のブレークポイント等でとまるまで実行されます．
LUPE>run
listまたはlを使用すると現在の行の周辺のソースコードが表示されます．
LUPE>l [num_lines]
num_linesで現在の行の前後何行を表示するかを指定できます．
省略すると前後3行を出力します．
LUPE>l
60: local f = function()
61: print(b)
62: end
>*63: f()
64: fuga()
65: fuga()
66: hoge()
現在の行には>がつきます．また，ブレークポイントがある行には*がつきます．
つまり，上記の例では，現在の行は63行目で，ブレークポイントで停止していることがわかります．
ここで上げているデバッグ用のコマンドに当てはまらない場合はLuaのコード（チャンク）として評価を行います． このとき，現在の行の環境（変数や関数）を参照することができ，式の評価による環境の変更（変数の変更）の反映も行います．
LUPE>l
49: Lupe()
50: -- comment
51: local b = 300
> 52: local c = {
53: c1 = 100,
54: c2 = 200,
55: c3 = {
LUPE>b=200
LUPE>print(b)
200
varsまたはvを使用するとローカル変数（上位値も含む）を表示することができます．
$ v [level] [shwo_level]
levelでどの階層のローカル変数を表示することができるか指定することができます．現在の関数が1で，その呼び出し元は2となります．levelを省略すると1となります．
LUPE>l
58: }
59: }
60: local f = function()
>*61: print(b)
62: end
63: f()
64: fuga()
LUPE>v
b: 300
LUPE>v 2
a: 200
b: 300
c: {
c1: 100
c3: {
c32: {
1: 2
2: 4
3: 6
4: 8
5: 10
}
c31: 100
}
c2: 200
}
f: function: 0x7fc270606ae0
show_levelで変数がテーブルの場合にどの深さまで表示するか指定することができます．
省略すると，5となります．指定した深さより深いものは，...で省略されます．
LUPE>v 1 2
a: 200
b: 300
c: {
c1: 100
c3: {
c32: ...
c31: 100
}
c2: 200
}
definedLineまたはdを使用するとローカル変数またはグローバル変数の宣言位置を表示することができます．
LUPE>d var_name
var_nameにはその行までに宣言されているローカル変数およびグローバル変数の名前を指定できます．
なお，同じ変数名が複数存在する場合は現在の行の階層に最も近い階層の変数の宣言位置が表示されます．
LUPE>d a
@start.lua:47
LUPE>d HOGE
@start.lua:4
setWatchまたはswを使用するとウォッチ式を設定することができます．
LUPE>sw a+1
add watch a+1
設定できる式は代入の右辺に使用できるものに限ります．
removeWatchまたはrwを使用するとウォッチ式を削除することができます．
LUPE>rw [index]
indexはウォッチ式の番号です．watchで確認することができます．
LUPE>rw [index]
remove watch a+1
watchまたはwを使用すると設定されているウォッチ式を表示することができます．
LUPE>w
1: a+1 = 201
ここで表示されている番号は，removeWatchの際に使用します．
Lupe:start()を呼び出すことでデバッガを開始します．
デバッガが開始されると，各行を実行時にさまざまなデバッグ情報が集められます．
また，デバッグの起動中にブレークポイントやassertによって処理が一時停止することができます．
処理が停止中に，上記のデバッグコマンドを駆使してデバッグを行うことができます．
Lupe:stop()を呼び出すことでデバッガを停止することができます．
一度停止するとデバッガはデバッグ情報を集めなく成るため，再度Lupe:start()を呼び出しても整合性が取れなくなります．
しかし，デバッガを停止するとデバッグ情報を集めるための処理を行わなく成るため，デバッグ対象のプログラムに影響を与えなくなります．
コールスタックを消します．
Lupe:dump()は引数で渡した値を見やすい形で出力します．
LUPE>Lupe:dump({a = 100, b = 200})
{
a: 100
b: 200
}
コールスタックを表示させます．
LUPE>Lupe:traceback()
@start.lua:39 hoge
@start.lua:66 setup
Lupe:startProfile()呼び出すと，簡易プロファイラが起動します．
プロファイリングの結果はテーブルとしてLupe.profiler:summary()から取得することができます．
また，Lupe:endProfile()を呼び出すとプロファイリングの結果を表示し，プロファイラを停止することができます．
プロファイラが取得するのは各関数の実行時間と使用メモリサイズです．
LUPE>Lupe:startProfile()
...
LUPE>Lupe:endProfile()
{
(=[C]:-1)<function: 0x7fd4e8c05250>: {
count: 1
sum: {
duration_ms: 0.024
use_memory_kB: 2.66796875
}
average: {
duration_ms: 0.024
use_memory_kB: 2.66796875
}
}
print(=[C]:-1)<function: 0x7fd4e8c05390>: {
count: 1
sum: {
duration_ms: 0.090999999999999
use_memory_kB: 8.0654296875
}
average: {
duration_ms: 0.090999999999999
use_memory_kB: 8.0654296875
}
}
f(@start.lua:60)<function: 0x7fd4e8c28820>: {
count: 1
sum: {
duration_ms: 0.244
use_memory_kB: 21.884765625
}
average: {
duration_ms: 0.244
use_memory_kB: 21.884765625
}
}
}