非常教程

Ruby 2.4参考手册

追踪 | Tracer

Tracer

Parent:Object

输出Ruby程序的源代码级执行轨迹。

它通过注册一个具有Kernel#set_trace_func的事件处理程序来处理传入事件。它还提供了用于过滤不需要的跟踪输出的方法(请参阅::add_filter,::on和::off)。

示例

考虑下面的Ruby脚本

class A
  def square(a)
    return a*a
  end
end

a = A.new
a.square(5)

使用上面的脚本运行ruby -r tracer example.rb将输出以下跟踪到STDOUT(注意,你也可以明确地require 'tracer'

#0:<internal:lib/rubygems/custom_require>:38:Kernel:<: -
#0:example.rb:3::-: class A
#0:example.rb:3::C: class A
#0:example.rb:4::-:   def square(a)
#0:example.rb:7::E: end
#0:example.rb:9::-: a = A.new
#0:example.rb:10::-: a.square(5)
#0:example.rb:4:A:>:   def square(a)
#0:example.rb:5:A:-:     return a*a
#0:example.rb:6:A:<:   end
 |  |         | |  |
 |  |         | |   ---------------------+ event
 |  |         |  ------------------------+ class
 |  |          --------------------------+ line
 |   ------------------------------------+ filename
  ---------------------------------------+ thread

用于显示传入事件的符号表:

+}+

调用一个C语言例程

+{+

从C语言例程返回

+>+

调用Ruby方法

C

启动一个类或模块定义

E

完成一个类或模块的定义

-

在新行上执行代码

+^+

引发异常

+<+

从Ruby方法返回

常量

EVENT_SYMBOL

用于显示跟踪信息的符号表

Single

参考Tracer的单例实例

display_c_call display_process_id display_thread_id stdout verbose

属性

display_c_callRW

在跟踪输出中显示C-routine调用(默认为false)

display_c_call?RW

在跟踪输出中显示C-routine调用(默认为false)

display_process_idRW

在跟踪输出中显示进程ID(默认为false)

display_process_id?RW

在跟踪输出中显示进程ID(默认为false)

display_thread_idRW

在跟踪输出中显示线程ID(默认为true)

display_thread_id?RW

在跟踪输出中显示线程ID(默认为true)

stdoutRW

用于输出跟踪的输出流(默认为STDOUT)

stdout_mutexR

互斥锁被跟踪器用于显示跟踪输出

verboseRW

显示额外的调试信息(默认为false)

verbose?RW

显示额外的调试信息(默认为false)

公共类别方法

add_filter(p = proc) Show source

用于过滤不需要的跟踪输出

仅输出在Kernel类中执行的代码行的示例:

Tracer.add_filter do |event, file, line, id, binding, klass, *rest|
  "Kernel" == klass.to_s
end
# File lib/tracer.rb, line 263
def Tracer.add_filter(p = proc)
  Single.add_filter(p)
end

off() Show source

禁用跟踪

# File lib/tracer.rb, line 236
def Tracer.off
  Single.off
end

on() { || ... } Show source

开始追踪

示例

Tracer.on
# code to trace here
Tracer.off

你也可以传递一个块:

Tracer.on {
  # trace everything in this block
}
# File lib/tracer.rb, line 225
def Tracer.on
  if block_given?
    Single.on{yield}
  else
    Single.on
  end
end

set_get_line_procs(file_name, p = proc) Show source

注册一个事件处理程序p,每file_name执行一行就调用它。

示例:

Tracer.set_get_line_procs("example.rb", lambda { |line|
  puts "line number executed is #{line}"
})
# File lib/tracer.rb, line 250
def Tracer.set_get_line_procs(file_name, p = proc)
  Single.set_get_line_procs(file_name, p)
end

追踪 | Tracer相关

Ruby 2.4

Ruby 是一种面向对象、命令式、函数式、动态的通用编程语言,是世界上最优美而巧妙的语言。

主页 https://www.ruby-lang.org/
源码 https://github.com/ruby/ruby
版本 2.4
发布版本 2.4.1

Ruby 2.4目录

1.缩略 | Abbrev
2.ARGF
3.数组 | Array
4.Base64
5.基本对象 | BasicObject
6.基准测试 | Benchmark
7.BigDecimal
8.绑定 | Binding
9.CGI
10.类 | Class
11.比较 | Comparable
12.负责 | Complex
13.计算续体 | Continuation
14.覆盖 | Coverage
15.CSV
16.日期 | Date
17.日期时间 | DateTime
18.DBM
19.代理 | Delegator
20.摘要 | Digest
21.Dir
22.DRb
23.编码 | Encoding
24.枚举 | Enumerable
25.枚举 | Enumerator
26.ENV
27.ERB
28.错误 | Errors
29.Etc
30.期望值 | Exception
31.错误类 | FalseClass
32.Fiber
33.Fiddle
34.文件 | File
35.文件实用程序 | FileUtils
36.查找 | Find
37.浮点 | Float
38.Forwardable
39.GC
40.GDBM
41.GetoptLong
42.Hash
43.Integer
44.IO
45.IPAddr
46.JSON
47.Kernel
48.语言 | 3Language
49.记录 | Logger
50.编排 | Marshal
51.MatchData
52.数学 | Math
53.矩阵 | Matrix
54.方法 | Method
55.模型 | Module
56.监控 | Monitor
57. 互斥 | Mutex
58.Net
59.Net::FTP
60.Net::HTTP
61.Net::IMAP
62.Net::SMTP
63.NilClass
64.数字 | Numeric
65.对象 | Object
66.ObjectSpace
67.Observable
68.Open3
69.OpenSSL
70.OpenStruct
71.OpenURI
72.OptionParser
73.路径名 | Pathname
74.完整输出 | PrettyPrint
75.Prime
76.Proc
77.过程 | Process
78.PStore
79.PTY
80.队列 | Queue
81.随机 | Random
82.范围 | Range
83.合理的 | Rational
84.Readline
85.Regexp
86.Resolv
87.Ripper
88.RubyVM
89.Scanf
90.SDBM
91.SecureRandom
92.Set
93.Shell
94.信号 | Signal
95.Singleton
96.套接字 | Socket
97.字符串 | String
98.StringIO
99.StringScanner
100.结构 | Struct