класс TracePoint

# File trace_point.rb, line 150
def self.allow_reentry
  Primitive.tracepoint_allow_reentry
end

В общем случае, пока выполняется обратный вызов TracePoint, другие зарегистрированные обратные вызовы не вызываются, чтобы избежать путаницы из-за повторного входа. Этот метод разрешает повторный вход в заданном блоке. Этот метод следует использовать с осторожностью, иначе обратный вызов может быть легко вызван бесконечно.

Если этот метод вызывается, когда повторный вход уже разрешен, он генерирует исключение RuntimeError.

# File trace_point.rb, line 97
def self.new(*events)
  Primitive.tracepoint_new_s(events)
end

Возвращает новый объект TracePoint, по умолчанию не активированный.

Далее, для активации отслеживания необходимо использовать TracePoint#enable

trace = TracePoint.new(:call) do |tp|
    p [tp.lineno, tp.defined_class, tp.method_id, tp.event]
end
#=> #<TracePoint:disabled>

trace.enable
#=> false

puts "Hello, TracePoint!"
# ...
# [48, IRB::Notifier::AbstractNotifier, :printf, :call]
# ...

При необходимости деактивации отслеживания необходимо использовать TracePoint#disable

trace.disable

См. События в TracePoint для возможных событий и дополнительной информации.

Блок должен быть передан, в противном случае генерируется исключение ArgumentError.

Если метод отслеживания не включён в фильтры заданных событий, генерируется исключение RuntimeError.

TracePoint.trace(:line) do |tp|
    p tp.raised_exception
end
#=> RuntimeError: 'raised_exception' not supported by this event

Если метод отслеживания вызывается вне блока, генерируется исключение RuntimeError.

TracePoint.trace(:line) do |tp|
  $tp = tp
end
$tp.lineno #=> access from outside (RuntimeError)

Доступ из других потоков также запрещён.

# File trace_point.rb, line 119
def self.stat
  Primitive.tracepoint_stat_s
end

Возвращает внутреннюю информацию о TracePoint.

Содержимое возвращаемого значения зависит от реализации. Оно может быть изменено в будущем.

Этот метод предназначен только для отладки TracePoint самого.

# File trace_point.rb, line 134
def self.trace(*events)
  Primitive.tracepoint_trace_s(events)
end

Удобный метод для TracePoint.new, который активирует отслеживание автоматически.

trace = TracePoint.trace(:call) { |tp| [tp.lineno, tp.event] }
#=> #<TracePoint:enabled>

trace.enabled? #=> true

# File trace_point.rb, line 333
def binding
  Primitive.tracepoint_attr_binding
end

Возвращает сгенерированный объект привязки из события.

Обратите внимание, что для событий c_call и c_return возвращаемая привязка является привязкой ближайшего вызова Ruby-метода, вызывающего C-метод, так как у самих C-методов нет привязок.

# File trace_point.rb, line 288
def callee_id
  Primitive.tracepoint_attr_callee_id
end

Возвращает вызываемое имя вызываемого метода.

# File trace_point.rb, line 324
def defined_class
  Primitive.tracepoint_attr_defined_class
end

Возвращает класс или модуль вызываемого метода.

class C; def foo; end; end
trace = TracePoint.new(:call) do |tp|
  p tp.defined_class #=> C
end.enable do
  C.new.foo
end

Если метод определен модулем, то возвращается этот модуль.

module M; def foo; end; end
class C; include M; end;
trace = TracePoint.new(:call) do |tp|
  p tp.defined_class #=> M
end.enable do
  C.new.foo
end

Примечание: defined_class возвращает синглтон-класс.

6-й параметр блока Kernel#set_trace_func передает исходный класс, присоединенный синглтон-классом.

Это различие между Kernel#set_trace_func и TracePoint.

class C; def self.foo; end; end
trace = TracePoint.new(:call) do |tp|
  p tp.defined_class #=> #<Class:C>
end.enable do
  C.foo
end

# File trace_point.rb, line 247
def disable
  Primitive.tracepoint_disable_m
end

Деактивирует отслеживание.

Возвращает true, если отслеживание было включено. Возвращает false, если отслеживание было выключено.

trace.enabled?      #=> true
trace.disable       #=> true (previous status)
trace.enabled?      #=> false
trace.disable       #=> false

Если задан блок, отслеживание будет отключено только в пределах этого блока.

trace.enabled?
#=> true

trace.disable do
    trace.enabled?
    # only disabled for this block
end

trace.enabled?
#=> true

Примечание: Вы не можете получить доступ к обработчикам событий внутри блока.

trace.disable { p tp.lineno }
#=> RuntimeError: access from outside

# File trace_point.rb, line 211
def enable(target: nil, target_line: nil, target_thread: nil)
  Primitive.tracepoint_enable_m(target, target_line, target_thread)
end

Включает отслеживание.

Возвращает true если отслеживание было включено. Возвращает false если отслеживание было выключено.

trace.enabled?  #=> false
trace.enable    #=> false (previous state)
                #   trace is enabled
trace.enabled?  #=> true
trace.enable    #=> true (previous state)
                #   trace is still enabled

Если задан блок, отслеживание будет включено только в пределах этого блока.

trace.enabled?
#=> false

trace.enable do
  trace.enabled?
  # only enabled for this block
end

trace.enabled?
#=> false

Параметры target, target_line и target_thread используются для ограничения отслеживания только определенными объектами кода. target должен быть объектом кода, для которого RubyVM::InstructionSequence.of вернет последовательность инструкций.

t = TracePoint.new(:line) { |tp| p tp }

def m1
  p 1
end

def m2
  p 2
end

t.enable(target: method(:m1))

m1
# prints #<TracePoint:line test.rb:4 in `m1'>
m2
# prints nothing

Примечание: Вы не можете получить доступ к обработчикам событий внутри блока enable.

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

# File trace_point.rb, line 255
def enabled?
  Primitive.tracepoint_enabled_p
end

Текущий статус отслеживания.

# File trace_point.rb, line 359
def eval_script
  Primitive.tracepoint_attr_eval_script
end

Скомпилированный исходный код (String) в методах *eval для события :script_compiled. Если загружено из файла, вернет nil.

# File trace_point.rb, line 262
def event
  Primitive.tracepoint_attr_event
end

Тип события.

См. События в TracePoint для получения дополнительной информации.

# File trace_point.rb, line 106
def inspect
  Primitive.tracepoint_inspect
end

Возвращает строку, содержащую удобочитаемый статус TracePoint.

# File trace_point.rb, line 367
def instruction_sequence
  Primitive.tracepoint_attr_instruction_sequence
end

Скомпилированная последовательность инструкций, представленная экземпляром RubyVM::InstructionSequence в событии :script_compiled.

Обратите внимание, что этот метод специфичен для MRI.

# File trace_point.rb, line 267
def lineno
  Primitive.tracepoint_attr_lineno
end

Номер строки события.

# File trace_point.rb, line 283
def method_id
  Primitive.tracepoint_attr_method_id
end

Возвращает имя метода при его определении.

# File trace_point.rb, line 278
def parameters
  Primitive.tracepoint_attr_parameters
end

Возвращает определение параметров метода или блока, к которому относится текущий обработчик. Формат аналогичен формату для Method#parameters.

# File trace_point.rb, line 272
def path
  Primitive.tracepoint_attr_path
end

Путь к файлу, который выполняется.

# File trace_point.rb, line 353
def raised_exception
  Primitive.tracepoint_attr_raised_exception
end

Значение исключения, поднятого в событии :raise.

# File trace_point.rb, line 348
def return_value
  Primitive.tracepoint_attr_return_value
end

Возвращаемое значение из событий :return, c_return и b_return.

# File trace_point.rb, line 343
def self
  Primitive.tracepoint_attr_self
end

Возвращает объект отслеживания во время события.

То же самое, что и ниже, за исключением того, что оно возвращает правильный объект (получатель метода) для событий c_call и c_return.

trace.binding.eval('self')