instance method TracePoint#enable

self のトレースを有効にします。

実行前の TracePoint#enabled? を返します。(トレースが既に有効であった場合は true を返します。そうでなければ false を返します)

[PARAM] target:

Method、UnboundMethod、Proc、RubyVM::InstructionSequence のいずれかを指定します。指定すると、その内部で起きるイベントだけをフックします。

[PARAM] target_line:

target と組み合わせて指定します。その行番号の :line イベントだけをフックします。

[PARAM] target_thread:

指定したスレッドで起きるイベントだけをフックします。ブロックが与えられ、target も target_line も指定されていない場合、デフォルトは現在のスレッド(Thread.current)になります。

[EXCEPTION] ArgumentError:

target を指定せずに target_line だけを指定した場合、または target_line を指定したのに :line イベントがフック対象に含まれていない場合に発生します。

p trace.enabled?  # => false
p trace.enable  # => false (実行前の状態)

# トレースが有効

p trace.enabled?  # => true
p trace.enable  # => true (実行前の状態)

# 引き続きトレースが有効

ブロックが与えられた場合、ブロック内でのみトレースが有効になります。この場合はブロックの評価結果を返します。

p trace.enabled? # => false

trace.enable do
  p trace.enabled? # => true
end

p trace.enabled? # => false

def foo; 1; end
def bar; 2; end
tp = TracePoint.new(:call) {|t| puts "call #{t.method_id}" }
tp.enable(target: method(:foo)) { foo; bar; 1 }  # => 1
# 出力は "call foo" だけ(bar は対象外)

[注意] イベントフックのためのメソッドにブロックの外側で参照した場合は RuntimeError が発生する事に注意してください。

trace.enable { p trace.lineno } # ~> RuntimeError: access from outside

[SEE_ALSO] TracePoint#disable, TracePoint#enabled?