ruby-prof 0.12.1 → 0.12.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. data/CHANGES +5 -1
  2. data/Rakefile +25 -7
  3. data/bin/ruby-prof +2 -2
  4. data/doc/LICENSE.html +155 -0
  5. data/doc/README_rdoc.html +640 -0
  6. data/doc/Rack.html +167 -0
  7. data/doc/Rack/RubyProf.html +319 -0
  8. data/doc/RubyProf.html +999 -0
  9. data/doc/RubyProf/AbstractPrinter.html +580 -0
  10. data/doc/RubyProf/AggregateCallInfo.html +570 -0
  11. data/doc/RubyProf/CallInfo.html +512 -0
  12. data/doc/RubyProf/CallInfoPrinter.html +190 -0
  13. data/doc/RubyProf/CallInfoVisitor.html +332 -0
  14. data/doc/RubyProf/CallStackPrinter.html +1597 -0
  15. data/doc/RubyProf/CallTreePrinter.html +413 -0
  16. data/doc/RubyProf/Cmd.html +669 -0
  17. data/doc/RubyProf/DotPrinter.html +312 -0
  18. data/doc/RubyProf/FlatPrinter.html +229 -0
  19. data/doc/RubyProf/FlatPrinterWithLineNumbers.html +267 -0
  20. data/doc/RubyProf/GraphHtmlPrinter.html +622 -0
  21. data/doc/RubyProf/GraphPrinter.html +209 -0
  22. data/doc/RubyProf/MethodInfo.html +713 -0
  23. data/doc/RubyProf/MultiPrinter.html +407 -0
  24. data/doc/RubyProf/Profile.html +821 -0
  25. data/doc/RubyProf/ProfileTask.html +532 -0
  26. data/doc/RubyProf/Test.html +578 -0
  27. data/doc/RubyProf/Thread.html +262 -0
  28. data/doc/created.rid +31 -0
  29. data/doc/examples/flat_txt.html +191 -0
  30. data/doc/examples/graph_txt.html +305 -0
  31. data/doc/images/add.png +0 -0
  32. data/doc/images/brick.png +0 -0
  33. data/doc/images/brick_link.png +0 -0
  34. data/doc/images/bug.png +0 -0
  35. data/doc/images/bullet_black.png +0 -0
  36. data/doc/images/bullet_toggle_minus.png +0 -0
  37. data/doc/images/bullet_toggle_plus.png +0 -0
  38. data/doc/images/date.png +0 -0
  39. data/doc/images/delete.png +0 -0
  40. data/doc/images/find.png +0 -0
  41. data/doc/images/loadingAnimation.gif +0 -0
  42. data/doc/images/macFFBgHack.png +0 -0
  43. data/doc/images/package.png +0 -0
  44. data/doc/images/page_green.png +0 -0
  45. data/doc/images/page_white_text.png +0 -0
  46. data/doc/images/page_white_width.png +0 -0
  47. data/doc/images/plugin.png +0 -0
  48. data/doc/images/ruby.png +0 -0
  49. data/doc/images/tag_blue.png +0 -0
  50. data/doc/images/tag_green.png +0 -0
  51. data/doc/images/transparent.png +0 -0
  52. data/doc/images/wrench.png +0 -0
  53. data/doc/images/wrench_orange.png +0 -0
  54. data/doc/images/zoom.png +0 -0
  55. data/doc/index.html +639 -0
  56. data/doc/js/darkfish.js +153 -0
  57. data/doc/js/jquery.js +18 -0
  58. data/doc/js/navigation.js +142 -0
  59. data/doc/js/search.js +94 -0
  60. data/doc/js/search_index.js +1 -0
  61. data/doc/js/searcher.js +228 -0
  62. data/doc/rdoc.css +543 -0
  63. data/doc/table_of_contents.html +462 -0
  64. data/examples/empty.png +0 -0
  65. data/examples/minus.png +0 -0
  66. data/examples/plus.png +0 -0
  67. data/ext/ruby_prof/extconf.rb +5 -1
  68. data/ext/ruby_prof/rp_call_info.c +1 -1
  69. data/ext/ruby_prof/rp_measure_gc_time.c +6 -10
  70. data/ext/ruby_prof/rp_measure_memory.c +0 -1
  71. data/ext/ruby_prof/rp_stack.c +0 -5
  72. data/ext/ruby_prof/vc/ruby_prof_18.vcxproj +0 -2
  73. data/ext/ruby_prof/vc/ruby_prof_19.vcxproj +1 -3
  74. data/ext/ruby_prof/vc/ruby_prof_20.vcxproj +1 -3
  75. data/ext/ruby_prof/version.h +2 -2
  76. data/lib/ruby-prof/compatibility.rb +8 -3
  77. data/lib/ruby-prof/images/empty.png +0 -0
  78. data/lib/ruby-prof/images/minus.png +0 -0
  79. data/lib/ruby-prof/images/plus.png +0 -0
  80. data/lib/ruby-prof/task.rb +0 -0
  81. data/ruby-prof.gemspec +2 -1
  82. data/test/aggregate_test.rb +0 -0
  83. data/test/basic_test.rb +0 -0
  84. data/test/duplicate_names_test.rb +0 -0
  85. data/test/dynamic_method_test.rb +8 -1
  86. data/test/enumerable_test.rb +0 -0
  87. data/test/exceptions_test.rb +0 -0
  88. data/test/exclude_threads_test.rb +0 -0
  89. data/test/exec_test.rb +0 -0
  90. data/test/line_number_test.rb +0 -0
  91. data/test/measure_gc_runs_test.rb +4 -1
  92. data/test/measure_gc_time_test.rb +10 -3
  93. data/test/measure_memory_test.rb +3 -8
  94. data/test/measure_process_time_test.rb +10 -4
  95. data/test/method_elimination_test.rb +1 -2
  96. data/test/module_test.rb +0 -0
  97. data/test/multi_printer_test.rb +5 -6
  98. data/test/no_method_class_test.rb +0 -0
  99. data/test/pause_resume_test.rb +6 -8
  100. data/test/printers_test.rb +0 -0
  101. data/test/recursive_test.rb +0 -0
  102. data/test/singleton_test.rb +0 -0
  103. data/test/stack_printer_test.rb +8 -5
  104. data/test/stack_test.rb +0 -0
  105. data/test/start_stop_test.rb +0 -0
  106. data/test/test_helper.rb +16 -4
  107. data/test/thread_test.rb +0 -0
  108. data/test/unique_call_path_test.rb +0 -0
  109. metadata +90 -17
data/doc/RubyProf/CallTreePrinter.html ADDED
@@ -0,0 +1,413 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class RubyProf::CallTreePrinter - ruby-prof</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ruby-prof/printers/call_tree_printer.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link"><a href="AbstractPrinter.html">RubyProf::AbstractPrinter</a>
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-i-convert">#convert</a>
74
+
75
+ <li><a href="#method-i-file">#file</a>
76
+
77
+ <li><a href="#method-i-print">#print</a>
78
+
79
+ <li><a href="#method-i-print_thread">#print_thread</a>
80
+
81
+ <li><a href="#method-i-print_threads">#print_threads</a>
82
+
83
+ </ul>
84
+ </nav>
85
+
86
+ </div>
87
+
88
+ <div id="project-metadata">
89
+ <nav id="fileindex-section" class="section project-section">
90
+ <h3 class="section-header">Pages</h3>
91
+
92
+ <ul>
93
+
94
+ <li class="file"><a href="../LICENSE.html">LICENSE</a>
95
+
96
+ <li class="file"><a href="../README_rdoc.html">README</a>
97
+
98
+ <li class="file"><a href="../examples/flat_txt.html">flat</a>
99
+
100
+ <li class="file"><a href="../examples/graph_txt.html">graph</a>
101
+
102
+ </ul>
103
+ </nav>
104
+
105
+ <nav id="classindex-section" class="section project-section">
106
+ <h3 class="section-header">Class and Module Index</h3>
107
+
108
+ <ul class="link-list">
109
+
110
+ <li><a href="../RubyProf.html">RubyProf</a>
111
+
112
+ <li><a href="../RubyProf/AbstractPrinter.html">RubyProf::AbstractPrinter</a>
113
+
114
+ <li><a href="../RubyProf/AggregateCallInfo.html">RubyProf::AggregateCallInfo</a>
115
+
116
+ <li><a href="../RubyProf/CallInfo.html">RubyProf::CallInfo</a>
117
+
118
+ <li><a href="../RubyProf/CallInfoPrinter.html">RubyProf::CallInfoPrinter</a>
119
+
120
+ <li><a href="../RubyProf/CallInfoVisitor.html">RubyProf::CallInfoVisitor</a>
121
+
122
+ <li><a href="../RubyProf/CallStackPrinter.html">RubyProf::CallStackPrinter</a>
123
+
124
+ <li><a href="../RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a>
125
+
126
+ <li><a href="../RubyProf/Cmd.html">RubyProf::Cmd</a>
127
+
128
+ <li><a href="../RubyProf/DotPrinter.html">RubyProf::DotPrinter</a>
129
+
130
+ <li><a href="../RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a>
131
+
132
+ <li><a href="../RubyProf/FlatPrinterWithLineNumbers.html">RubyProf::FlatPrinterWithLineNumbers</a>
133
+
134
+ <li><a href="../RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a>
135
+
136
+ <li><a href="../RubyProf/GraphPrinter.html">RubyProf::GraphPrinter</a>
137
+
138
+ <li><a href="../RubyProf/MethodInfo.html">RubyProf::MethodInfo</a>
139
+
140
+ <li><a href="../RubyProf/MultiPrinter.html">RubyProf::MultiPrinter</a>
141
+
142
+ <li><a href="../RubyProf/Profile.html">RubyProf::Profile</a>
143
+
144
+ <li><a href="../RubyProf/ProfileTask.html">RubyProf::ProfileTask</a>
145
+
146
+ <li><a href="../RubyProf/Test.html">RubyProf::Test</a>
147
+
148
+ <li><a href="../RubyProf/Thread.html">RubyProf::Thread</a>
149
+
150
+ <li><a href="../Rack.html">Rack</a>
151
+
152
+ <li><a href="../Rack/RubyProf.html">Rack::RubyProf</a>
153
+
154
+ </ul>
155
+ </nav>
156
+
157
+ </div>
158
+ </nav>
159
+
160
+ <div id="documentation">
161
+ <h1 class="class">class RubyProf::CallTreePrinter</h1>
162
+
163
+ <div id="description" class="description">
164
+
165
+ <p>Generate profiling information in calltree format for use by kcachegrind
166
+ and similar tools.</p>
167
+
168
+ </div><!-- description -->
169
+
170
+
171
+
172
+
173
+ <section id="5Buntitled-5D" class="documentation-section">
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <!-- Methods -->
183
+
184
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
185
+ <h3 class="section-header">Public Instance Methods</h3>
186
+
187
+
188
+ <div id="method-i-convert" class="method-detail ">
189
+
190
+ <div class="method-heading">
191
+ <span class="method-name">convert</span><span
192
+ class="method-args">(value)</span>
193
+ <span class="method-click-advice">click to toggle source</span>
194
+ </div>
195
+
196
+
197
+ <div class="method-description">
198
+
199
+
200
+
201
+
202
+
203
+ <div class="method-source-code" id="convert-source">
204
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/call_tree_printer.rb, line 61</span>
205
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">convert</span>(<span class="ruby-identifier">value</span>)
206
+ (<span class="ruby-identifier">value</span> * <span class="ruby-ivar">@value_scale</span>).<span class="ruby-identifier">round</span>
207
+ <span class="ruby-keyword">end</span></pre>
208
+ </div><!-- convert-source -->
209
+
210
+ </div>
211
+
212
+
213
+
214
+
215
+ </div><!-- convert-method -->
216
+
217
+
218
+ <div id="method-i-file" class="method-detail ">
219
+
220
+ <div class="method-heading">
221
+ <span class="method-name">file</span><span
222
+ class="method-args">(method)</span>
223
+ <span class="method-click-advice">click to toggle source</span>
224
+ </div>
225
+
226
+
227
+ <div class="method-description">
228
+
229
+
230
+
231
+
232
+
233
+ <div class="method-source-code" id="file-source">
234
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/call_tree_printer.rb, line 65</span>
235
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">file</span>(<span class="ruby-identifier">method</span>)
236
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">method</span>.<span class="ruby-identifier">source_file</span>)
237
+ <span class="ruby-keyword">end</span></pre>
238
+ </div><!-- file-source -->
239
+
240
+ </div>
241
+
242
+
243
+
244
+
245
+ </div><!-- file-method -->
246
+
247
+
248
+ <div id="method-i-print" class="method-detail ">
249
+
250
+ <div class="method-heading">
251
+ <span class="method-name">print</span><span
252
+ class="method-args">(output = STDOUT, options = {})</span>
253
+ <span class="method-click-advice">click to toggle source</span>
254
+ </div>
255
+
256
+
257
+ <div class="method-description">
258
+
259
+ <p>Specify print options.</p>
260
+
261
+ <p>options - Hash table</p>
262
+
263
+ <pre>:min_percent - Number 0 to 100 that specifes the minimum
264
+ %self (the methods self time divided by the
265
+ overall total time) that a method must take
266
+ for it to be printed out in the report.
267
+ Default value is 0.
268
+
269
+ :print_file - True or false. Specifies if a method's source
270
+ file should be printed. Default value if false.</pre>
271
+
272
+
273
+
274
+ <div class="method-source-code" id="print-source">
275
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/call_tree_printer.rb, line 19</span>
276
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print</span>(<span class="ruby-identifier">output</span> = <span class="ruby-constant">STDOUT</span>, <span class="ruby-identifier">options</span> = {})
277
+ <span class="ruby-ivar">@output</span> = <span class="ruby-identifier">output</span>
278
+ <span class="ruby-identifier">setup_options</span>(<span class="ruby-identifier">options</span>)
279
+
280
+ <span class="ruby-comment"># add a header - this information is somewhat arbitrary</span>
281
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;events: &quot;</span>
282
+ <span class="ruby-keyword">case</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">measure_mode</span>
283
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">PROCESS_TIME</span>
284
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CLOCKS_PER_SEC</span>;
285
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'process_time'</span>
286
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">WALL_TIME</span>
287
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-value">1_000_000</span>
288
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'wall_time'</span>
289
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-value">:CPU_TIME</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CPU_TIME</span>
290
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">cpu_frequency</span>
291
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'cpu_time'</span>
292
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-value">:ALLOCATIONS</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">ALLOCATIONS</span>
293
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-value">1</span>
294
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'allocations'</span>
295
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-value">:MEMORY</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MEMORY</span>
296
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-value">1</span>
297
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'memory'</span>
298
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-value">:GC_RUNS</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GC_RUNS</span>
299
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-value">1</span>
300
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'gc_runs'</span>
301
+ <span class="ruby-keyword">when</span> <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-value">:GC_TIME</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GC_TIME</span>
302
+ <span class="ruby-ivar">@value_scale</span> = <span class="ruby-value">1000000</span>
303
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">'gc_time'</span>
304
+ <span class="ruby-keyword">else</span>
305
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Unknown measure mode: #{RubyProf.measure_mode}&quot;</span>
306
+ <span class="ruby-keyword">end</span>
307
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;\n\n&quot;</span>
308
+
309
+ <span class="ruby-identifier">print_threads</span>
310
+ <span class="ruby-keyword">end</span></pre>
311
+ </div><!-- print-source -->
312
+
313
+ </div>
314
+
315
+
316
+
317
+
318
+ </div><!-- print-method -->
319
+
320
+
321
+ <div id="method-i-print_thread" class="method-detail ">
322
+
323
+ <div class="method-heading">
324
+ <span class="method-name">print_thread</span><span
325
+ class="method-args">(thread)</span>
326
+ <span class="method-click-advice">click to toggle source</span>
327
+ </div>
328
+
329
+
330
+ <div class="method-description">
331
+
332
+
333
+
334
+
335
+
336
+ <div class="method-source-code" id="print_thread-source">
337
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/call_tree_printer.rb, line 69</span>
338
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_thread</span>(<span class="ruby-identifier">thread</span>)
339
+ <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">methods</span>.<span class="ruby-identifier">reverse_each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">method</span><span class="ruby-operator">|</span>
340
+ <span class="ruby-comment"># Print out the file and method name</span>
341
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;fl=#{file(method)}\n&quot;</span>
342
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;fn=#{method_name(method)}\n&quot;</span>
343
+
344
+ <span class="ruby-comment"># Now print out the function line number and its self time</span>
345
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{method.line} #{convert(method.self_time)}\n&quot;</span>
346
+
347
+ <span class="ruby-comment"># Now print out all the children methods</span>
348
+ <span class="ruby-identifier">method</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">callee</span><span class="ruby-operator">|</span>
349
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;cfl=#{file(callee.target)}\n&quot;</span>
350
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;cfn=#{method_name(callee.target)}\n&quot;</span>
351
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;calls=#{callee.called} #{callee.line}\n&quot;</span>
352
+
353
+ <span class="ruby-comment"># Print out total times here!</span>
354
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{callee.line} #{convert(callee.total_time)}\n&quot;</span>
355
+ <span class="ruby-keyword">end</span>
356
+ <span class="ruby-ivar">@output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;\n&quot;</span>
357
+ <span class="ruby-keyword">end</span>
358
+ <span class="ruby-keyword">end</span></pre>
359
+ </div><!-- print_thread-source -->
360
+
361
+ </div>
362
+
363
+
364
+
365
+
366
+ </div><!-- print_thread-method -->
367
+
368
+
369
+ <div id="method-i-print_threads" class="method-detail ">
370
+
371
+ <div class="method-heading">
372
+ <span class="method-name">print_threads</span><span
373
+ class="method-args">()</span>
374
+ <span class="method-click-advice">click to toggle source</span>
375
+ </div>
376
+
377
+
378
+ <div class="method-description">
379
+
380
+
381
+
382
+
383
+
384
+ <div class="method-source-code" id="print_threads-source">
385
+ <pre><span class="ruby-comment"># File lib/ruby-prof/printers/call_tree_printer.rb, line 55</span>
386
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">print_threads</span>
387
+ <span class="ruby-ivar">@result</span>.<span class="ruby-identifier">threads</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">thread</span><span class="ruby-operator">|</span>
388
+ <span class="ruby-identifier">print_thread</span>(<span class="ruby-identifier">thread</span>)
389
+ <span class="ruby-keyword">end</span>
390
+ <span class="ruby-keyword">end</span></pre>
391
+ </div><!-- print_threads-source -->
392
+
393
+ </div>
394
+
395
+
396
+
397
+
398
+ </div><!-- print_threads-method -->
399
+
400
+
401
+ </section><!-- public-instance-method-details -->
402
+
403
+ </section><!-- 5Buntitled-5D -->
404
+
405
+ </div><!-- documentation -->
406
+
407
+
408
+ <footer id="validator-badges">
409
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
410
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
411
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
412
+ </footer>
413
+
data/doc/RubyProf/Cmd.html ADDED
@@ -0,0 +1,669 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class RubyProf::Cmd - ruby-prof</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>bin/ruby-prof
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link">Object
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-new">::new</a>
74
+
75
+ <li><a href="#method-i-load_pre_execs">#load_pre_execs</a>
76
+
77
+ <li><a href="#method-i-load_pre_libs">#load_pre_libs</a>
78
+
79
+ <li><a href="#method-i-option_parser">#option_parser</a>
80
+
81
+ <li><a href="#method-i-parse_args">#parse_args</a>
82
+
83
+ <li><a href="#method-i-run">#run</a>
84
+
85
+ <li><a href="#method-i-setup_options">#setup_options</a>
86
+
87
+ </ul>
88
+ </nav>
89
+
90
+ </div>
91
+
92
+ <div id="project-metadata">
93
+ <nav id="fileindex-section" class="section project-section">
94
+ <h3 class="section-header">Pages</h3>
95
+
96
+ <ul>
97
+
98
+ <li class="file"><a href="../LICENSE.html">LICENSE</a>
99
+
100
+ <li class="file"><a href="../README_rdoc.html">README</a>
101
+
102
+ <li class="file"><a href="../examples/flat_txt.html">flat</a>
103
+
104
+ <li class="file"><a href="../examples/graph_txt.html">graph</a>
105
+
106
+ </ul>
107
+ </nav>
108
+
109
+ <nav id="classindex-section" class="section project-section">
110
+ <h3 class="section-header">Class and Module Index</h3>
111
+
112
+ <ul class="link-list">
113
+
114
+ <li><a href="../RubyProf.html">RubyProf</a>
115
+
116
+ <li><a href="../RubyProf/AbstractPrinter.html">RubyProf::AbstractPrinter</a>
117
+
118
+ <li><a href="../RubyProf/AggregateCallInfo.html">RubyProf::AggregateCallInfo</a>
119
+
120
+ <li><a href="../RubyProf/CallInfo.html">RubyProf::CallInfo</a>
121
+
122
+ <li><a href="../RubyProf/CallInfoPrinter.html">RubyProf::CallInfoPrinter</a>
123
+
124
+ <li><a href="../RubyProf/CallInfoVisitor.html">RubyProf::CallInfoVisitor</a>
125
+
126
+ <li><a href="../RubyProf/CallStackPrinter.html">RubyProf::CallStackPrinter</a>
127
+
128
+ <li><a href="../RubyProf/CallTreePrinter.html">RubyProf::CallTreePrinter</a>
129
+
130
+ <li><a href="../RubyProf/Cmd.html">RubyProf::Cmd</a>
131
+
132
+ <li><a href="../RubyProf/DotPrinter.html">RubyProf::DotPrinter</a>
133
+
134
+ <li><a href="../RubyProf/FlatPrinter.html">RubyProf::FlatPrinter</a>
135
+
136
+ <li><a href="../RubyProf/FlatPrinterWithLineNumbers.html">RubyProf::FlatPrinterWithLineNumbers</a>
137
+
138
+ <li><a href="../RubyProf/GraphHtmlPrinter.html">RubyProf::GraphHtmlPrinter</a>
139
+
140
+ <li><a href="../RubyProf/GraphPrinter.html">RubyProf::GraphPrinter</a>
141
+
142
+ <li><a href="../RubyProf/MethodInfo.html">RubyProf::MethodInfo</a>
143
+
144
+ <li><a href="../RubyProf/MultiPrinter.html">RubyProf::MultiPrinter</a>
145
+
146
+ <li><a href="../RubyProf/Profile.html">RubyProf::Profile</a>
147
+
148
+ <li><a href="../RubyProf/ProfileTask.html">RubyProf::ProfileTask</a>
149
+
150
+ <li><a href="../RubyProf/Test.html">RubyProf::Test</a>
151
+
152
+ <li><a href="../RubyProf/Thread.html">RubyProf::Thread</a>
153
+
154
+ <li><a href="../Rack.html">Rack</a>
155
+
156
+ <li><a href="../Rack/RubyProf.html">Rack::RubyProf</a>
157
+
158
+ </ul>
159
+ </nav>
160
+
161
+ </div>
162
+ </nav>
163
+
164
+ <div id="documentation">
165
+ <h1 class="class">class RubyProf::Cmd</h1>
166
+
167
+ <div id="description" class="description">
168
+
169
+ </div><!-- description -->
170
+
171
+
172
+
173
+
174
+ <section id="5Buntitled-5D" class="documentation-section">
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <!-- Attributes -->
183
+ <section id="attribute-method-details" class="method-section section">
184
+ <h3 class="section-header">Attributes</h3>
185
+
186
+
187
+ <div id="attribute-i-options" class="method-detail">
188
+ <div class="method-heading attribute-method-heading">
189
+ <span class="method-name">options</span><span
190
+ class="attribute-access-type">[RW]</span>
191
+ </div>
192
+
193
+ <div class="method-description">
194
+
195
+
196
+
197
+ </div>
198
+ </div>
199
+
200
+ </section><!-- attribute-method-details -->
201
+
202
+
203
+ <!-- Methods -->
204
+
205
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
206
+ <h3 class="section-header">Public Class Methods</h3>
207
+
208
+
209
+ <div id="method-c-new" class="method-detail ">
210
+
211
+ <div class="method-heading">
212
+ <span class="method-name">new</span><span
213
+ class="method-args">()</span>
214
+ <span class="method-click-advice">click to toggle source</span>
215
+ </div>
216
+
217
+
218
+ <div class="method-description">
219
+
220
+
221
+
222
+
223
+
224
+ <div class="method-source-code" id="new-source">
225
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 28</span>
226
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>
227
+ <span class="ruby-identifier">setup_options</span>
228
+ <span class="ruby-identifier">parse_args</span>
229
+
230
+ <span class="ruby-identifier">load_pre_libs</span>
231
+ <span class="ruby-identifier">load_pre_execs</span>
232
+ <span class="ruby-keyword">end</span></pre>
233
+ </div><!-- new-source -->
234
+
235
+ </div>
236
+
237
+
238
+
239
+
240
+ </div><!-- new-method -->
241
+
242
+
243
+ </section><!-- public-class-method-details -->
244
+
245
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
246
+ <h3 class="section-header">Public Instance Methods</h3>
247
+
248
+
249
+ <div id="method-i-load_pre_execs" class="method-detail ">
250
+
251
+ <div class="method-heading">
252
+ <span class="method-name">load_pre_execs</span><span
253
+ class="method-args">()</span>
254
+ <span class="method-click-advice">click to toggle source</span>
255
+ </div>
256
+
257
+
258
+ <div class="method-description">
259
+
260
+
261
+
262
+
263
+
264
+ <div class="method-source-code" id="load_pre_execs-source">
265
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 262</span>
266
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">load_pre_execs</span>
267
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">pre_execs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exec</span><span class="ruby-operator">|</span>
268
+ <span class="ruby-identifier">eval</span>(<span class="ruby-identifier">exec</span>)
269
+ <span class="ruby-keyword">end</span>
270
+ <span class="ruby-keyword">end</span></pre>
271
+ </div><!-- load_pre_execs-source -->
272
+
273
+ </div>
274
+
275
+
276
+
277
+
278
+ </div><!-- load_pre_execs-method -->
279
+
280
+
281
+ <div id="method-i-load_pre_libs" class="method-detail ">
282
+
283
+ <div class="method-heading">
284
+ <span class="method-name">load_pre_libs</span><span
285
+ class="method-args">()</span>
286
+ <span class="method-click-advice">click to toggle source</span>
287
+ </div>
288
+
289
+
290
+ <div class="method-description">
291
+
292
+
293
+
294
+
295
+
296
+ <div class="method-source-code" id="load_pre_libs-source">
297
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 256</span>
298
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">load_pre_libs</span>
299
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">pre_libs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lib</span><span class="ruby-operator">|</span>
300
+ <span class="ruby-identifier">require</span> <span class="ruby-identifier">lib</span>
301
+ <span class="ruby-keyword">end</span>
302
+ <span class="ruby-keyword">end</span></pre>
303
+ </div><!-- load_pre_libs-source -->
304
+
305
+ </div>
306
+
307
+
308
+
309
+
310
+ </div><!-- load_pre_libs-method -->
311
+
312
+
313
+ <div id="method-i-option_parser" class="method-detail ">
314
+
315
+ <div class="method-heading">
316
+ <span class="method-name">option_parser</span><span
317
+ class="method-args">()</span>
318
+ <span class="method-click-advice">click to toggle source</span>
319
+ </div>
320
+
321
+
322
+ <div class="method-description">
323
+
324
+
325
+
326
+
327
+
328
+ <div class="method-source-code" id="option_parser-source">
329
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 49</span>
330
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">option_parser</span>
331
+ <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
332
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-node">&quot;ruby_prof #{RubyProf::VERSION}\n&quot;</span> <span class="ruby-operator">+</span>
333
+ <span class="ruby-string">&quot;Usage: ruby-prof [options] &lt;script.rb&gt; [--] [profiled-script-command-line-options]&quot;</span>
334
+
335
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-string">&quot;&quot;</span>
336
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-string">&quot;Options:&quot;</span>
337
+
338
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-p printer'</span>, <span class="ruby-string">'--printer=printer'</span>, [<span class="ruby-value">:flat</span>, <span class="ruby-value">:flat_with_line_numbers</span>, <span class="ruby-value">:graph</span>, <span class="ruby-value">:graph_html</span>, <span class="ruby-value">:call_tree</span>, <span class="ruby-value">:call_stack</span>, <span class="ruby-value">:dot</span>],
339
+ <span class="ruby-string">'Select a printer:'</span>,
340
+ <span class="ruby-string">' flat - Prints a flat profile as text (default).'</span>,
341
+ <span class="ruby-string">' flat_with_line_numbers - same as flat, with line numbers.'</span>,
342
+ <span class="ruby-string">' graph - Prints a graph profile as text.'</span>,
343
+ <span class="ruby-string">' graph_html - Prints a graph profile as html.'</span>,
344
+ <span class="ruby-string">' call_tree - format for KCacheGrind'</span>,
345
+ <span class="ruby-string">' call_stack - prints a HTML visualization of the call tree'</span>,
346
+ <span class="ruby-string">' dot - Prints a graph profile as a dot file'</span>
347
+ ) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">printer</span><span class="ruby-operator">|</span>
348
+
349
+
350
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">printer</span>
351
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:flat</span>
352
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">FlatPrinter</span>
353
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:flat_with_line_numbers</span>
354
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">FlatPrinterWithLineNumbers</span>
355
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:graph</span>
356
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphPrinter</span>
357
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:graph_html</span>
358
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphHtmlPrinter</span>
359
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:call_tree</span>
360
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CallTreePrinter</span>
361
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:call_stack</span>
362
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CallStackPrinter</span>
363
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:dot</span>
364
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">DotPrinter</span>
365
+ <span class="ruby-keyword">end</span>
366
+ <span class="ruby-keyword">end</span>
367
+
368
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-m min_percent'</span>, <span class="ruby-string">'--min_percent=min_percent'</span>, <span class="ruby-constant">Float</span>,
369
+ <span class="ruby-string">'The minimum percent a method must take before '</span>,
370
+ <span class="ruby-string">' being included in output reports.'</span>,
371
+ <span class="ruby-string">' this option is not supported for call tree.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">min_percent</span><span class="ruby-operator">|</span>
372
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">min_percent</span> = <span class="ruby-identifier">min_percent</span>
373
+ <span class="ruby-keyword">end</span>
374
+
375
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-f path'</span>, <span class="ruby-string">'--file=path'</span>,
376
+ <span class="ruby-string">'Output results to a file instead of standard out.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
377
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">file</span> = <span class="ruby-identifier">file</span>
378
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">old_wd</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>
379
+ <span class="ruby-keyword">end</span>
380
+
381
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'--mode=measure_mode'</span>,
382
+ [<span class="ruby-value">:process</span>, <span class="ruby-value">:wall</span>, <span class="ruby-value">:cpu</span>, <span class="ruby-value">:allocations</span>, <span class="ruby-value">:memory</span>, <span class="ruby-value">:gc_runs</span>, <span class="ruby-value">:gc_time</span>],
383
+ <span class="ruby-string">'Select what ruby-prof should measure:'</span>,
384
+ <span class="ruby-string">' process - Process time (default).'</span>,
385
+ <span class="ruby-string">' wall - Wall time.'</span>,
386
+ <span class="ruby-string">' cpu - CPU time (Pentium and PowerPCs only).'</span>,
387
+ <span class="ruby-string">' allocations - Object allocations (requires patched Ruby interpreter).'</span>,
388
+ <span class="ruby-string">' memory - Allocated memory in KB (requires patched Ruby interpreter).'</span>,
389
+ <span class="ruby-string">' gc_runs - Number of garbage collections (requires patched Ruby interpreter).'</span>,
390
+ <span class="ruby-string">' gc_time - Time spent in garbage collection (requires patched Ruby interpreter).'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">measure_mode</span><span class="ruby-operator">|</span>
391
+
392
+ <span class="ruby-keyword">case</span> <span class="ruby-identifier">measure_mode</span>
393
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:process</span>
394
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">PROCESS_TIME</span>
395
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:wall</span>
396
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">WALL_TIME</span>
397
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:cpu</span>
398
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">CPU_TIME</span>
399
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:allocations</span>
400
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">ALLOCATIONS</span>
401
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:memory</span>
402
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MEMORY</span>
403
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:gc_runs</span>
404
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GC_RUNS</span>
405
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:gc_time</span>
406
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">GC_TIME</span>
407
+ <span class="ruby-keyword">end</span>
408
+ <span class="ruby-keyword">end</span>
409
+
410
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-s sort_mode'</span>, <span class="ruby-string">'--sort=sort_mode'</span>, [<span class="ruby-value">:total</span>, <span class="ruby-value">:self</span>, <span class="ruby-value">:wait</span>, <span class="ruby-value">:child</span>],
411
+ <span class="ruby-string">'Select how ruby-prof results should be sorted:'</span>,
412
+ <span class="ruby-string">' total - Total time'</span>,
413
+ <span class="ruby-string">' self - Self time'</span>,
414
+ <span class="ruby-string">' wait - Wait time'</span>,
415
+ <span class="ruby-string">' child - Child time'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sort_mode</span><span class="ruby-operator">|</span>
416
+
417
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">sort_method</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">sort_mode</span>
418
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:total</span>
419
+ <span class="ruby-value">:total_time</span>
420
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:self</span>
421
+ <span class="ruby-value">:self_time</span>
422
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:wait</span>
423
+ <span class="ruby-value">:wait_time</span>
424
+ <span class="ruby-keyword">when</span> <span class="ruby-value">:child</span>
425
+ <span class="ruby-value">:children_time</span>
426
+ <span class="ruby-keyword">end</span>
427
+ <span class="ruby-keyword">end</span>
428
+
429
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&quot;--replace-progname&quot;</span>, <span class="ruby-string">&quot;Replace $0 when loading the .rb files.&quot;</span>) <span class="ruby-keyword">do</span>
430
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">replace_prog_name</span> = <span class="ruby-keyword">true</span>
431
+ <span class="ruby-keyword">end</span>
432
+
433
+ <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">VM</span>)
434
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&quot;--specialized-instruction&quot;</span>, <span class="ruby-string">&quot;Turn on specified instruction.&quot;</span>) <span class="ruby-keyword">do</span>
435
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">specialized_instruction</span> = <span class="ruby-keyword">true</span>
436
+ <span class="ruby-keyword">end</span>
437
+ <span class="ruby-keyword">end</span>
438
+
439
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-string">&quot;-h&quot;</span>, <span class="ruby-string">&quot;--help&quot;</span>, <span class="ruby-string">&quot;Show help message&quot;</span>) <span class="ruby-keyword">do</span>
440
+ <span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>
441
+ <span class="ruby-identifier">exit</span>
442
+ <span class="ruby-keyword">end</span>
443
+
444
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-string">&quot;--version&quot;</span>, <span class="ruby-node">&quot;Show version #{RubyProf::VERSION}&quot;</span>) <span class="ruby-keyword">do</span>
445
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;ruby_prof &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
446
+ <span class="ruby-identifier">exit</span>
447
+ <span class="ruby-keyword">end</span>
448
+
449
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&quot;-v&quot;</span>,<span class="ruby-string">&quot;Show version, set $VERBOSE to true, profile script if option given&quot;</span>) <span class="ruby-keyword">do</span>
450
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;ruby version: &quot;</span> <span class="ruby-operator">+</span> [<span class="ruby-constant">RUBY_PATCHLEVEL</span>, <span class="ruby-constant">RUBY_PLATFORM</span>, <span class="ruby-constant">RUBY_VERSION</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>)
451
+ <span class="ruby-identifier">$VERBOSE</span> = <span class="ruby-keyword">true</span>
452
+ <span class="ruby-keyword">end</span>
453
+
454
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&quot;-d&quot;</span>, <span class="ruby-string">&quot;Set $DEBUG to true&quot;</span>) <span class="ruby-keyword">do</span>
455
+ <span class="ruby-identifier">$DEBUG</span> = <span class="ruby-keyword">true</span>
456
+ <span class="ruby-keyword">end</span>
457
+
458
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-R lib'</span>, <span class="ruby-string">'--require-noprof lib'</span>, <span class="ruby-string">'require a specific library (not profiled)'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lib</span><span class="ruby-operator">|</span>
459
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">pre_libs</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">lib</span>
460
+ <span class="ruby-keyword">end</span>
461
+
462
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-E code'</span>, <span class="ruby-string">'--eval-noprof code'</span>, <span class="ruby-string">'execute the ruby statements (not profiled)'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">code</span><span class="ruby-operator">|</span>
463
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">pre_execs</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">code</span>
464
+ <span class="ruby-keyword">end</span>
465
+
466
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-x regexp'</span>, <span class="ruby-string">'--exclude regexp'</span>, <span class="ruby-string">'exclude methods by regexp (see method elimination)'</span>) <span class="ruby-keyword">do</span><span class="ruby-operator">|</span><span class="ruby-identifier">meth</span><span class="ruby-operator">|</span>
467
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">||=</span> []
468
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">meth</span>)
469
+ <span class="ruby-keyword">end</span>
470
+
471
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'-X file'</span>, <span class="ruby-string">'--exclude-file file'</span>, <span class="ruby-string">'exclude methods by regexp listed in file (see method elimination)'</span>) <span class="ruby-keyword">do</span><span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
472
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods_files</span> <span class="ruby-operator">||=</span> []
473
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods_files</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">file</span>
474
+ <span class="ruby-keyword">end</span>
475
+
476
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'--exclude-common-cycles'</span>, <span class="ruby-string">'make common iterators like Integer#times appear inlined'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">meth</span><span class="ruby-operator">|</span>
477
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">||=</span> []
478
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">+=</span> <span class="ruby-node">%w{
479
+ Integer#times
480
+ Integer#upto
481
+ Integer#downto
482
+ Enumerator#each
483
+ Enumerator#each_with_index
484
+ Enumerator#each_with_object
485
+
486
+ Array#each
487
+ Array#each_index
488
+ Array#reverse_each
489
+ Array#map
490
+
491
+ Hash#each
492
+ Hash#each_pair
493
+ Hash#each_key
494
+ Hash#each_value
495
+
496
+ Range#each
497
+ Enumerable#each_cons
498
+ Enumerable#each_entry
499
+ Enumerable#each_slice
500
+ Enumerable#each_with_index
501
+ Enumerable#each_with_object
502
+ Enumerable#reverse_each
503
+ Enumerable#inject
504
+ Enumerable#collect
505
+ Enumerable#reduce
506
+ }</span>
507
+ <span class="ruby-comment">#TODO: may be the whole Enumerable module should be excluded via 'Enumerable#.*', we need feedback on use cases.</span>
508
+ <span class="ruby-keyword">end</span>
509
+
510
+ <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'--exclude-common-callbacks'</span>, <span class="ruby-string">'make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph'</span>) <span class="ruby-keyword">do</span><span class="ruby-operator">|</span><span class="ruby-identifier">meth</span><span class="ruby-operator">|</span>
511
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">||=</span> []
512
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">+=</span> <span class="ruby-node">%w{
513
+ Method#call
514
+ Proc#call
515
+ ActiveSupport::Callbacks::ClassMethods#__run_callback
516
+ }</span>
517
+ <span class="ruby-keyword">end</span>
518
+ <span class="ruby-keyword">end</span>
519
+ <span class="ruby-keyword">end</span></pre>
520
+ </div><!-- option_parser-source -->
521
+
522
+ </div>
523
+
524
+
525
+
526
+
527
+ </div><!-- option_parser-method -->
528
+
529
+
530
+ <div id="method-i-parse_args" class="method-detail ">
531
+
532
+ <div class="method-heading">
533
+ <span class="method-name">parse_args</span><span
534
+ class="method-args">()</span>
535
+ <span class="method-click-advice">click to toggle source</span>
536
+ </div>
537
+
538
+
539
+ <div class="method-description">
540
+
541
+
542
+
543
+
544
+
545
+ <div class="method-source-code" id="parse_args-source">
546
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 240</span>
547
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_args</span>
548
+ <span class="ruby-comment"># Make sure the user specified at least one file</span>
549
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">exec</span>
550
+ <span class="ruby-identifier">puts</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">option_parser</span>
551
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;&quot;</span>
552
+ <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Must specify a script to run&quot;</span>
553
+ <span class="ruby-identifier">exit</span>(<span class="ruby-value">-1</span>)
554
+ <span class="ruby-keyword">end</span>
555
+
556
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">option_parser</span>.<span class="ruby-identifier">parse!</span> <span class="ruby-constant">ARGV</span>
557
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidOption</span>, <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidArgument</span>, <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">MissingArgument</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
558
+ <span class="ruby-identifier">puts</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">option_parser</span>
559
+ <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
560
+ <span class="ruby-identifier">exit</span>(<span class="ruby-value">-1</span>)
561
+ <span class="ruby-keyword">end</span></pre>
562
+ </div><!-- parse_args-source -->
563
+
564
+ </div>
565
+
566
+
567
+
568
+
569
+ </div><!-- parse_args-method -->
570
+
571
+
572
+ <div id="method-i-run" class="method-detail ">
573
+
574
+ <div class="method-heading">
575
+ <span class="method-name">run</span><span
576
+ class="method-args">()</span>
577
+ <span class="method-click-advice">click to toggle source</span>
578
+ </div>
579
+
580
+
581
+ <div class="method-description">
582
+
583
+
584
+
585
+
586
+
587
+ <div class="method-source-code" id="run-source">
588
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 268</span>
589
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>
590
+ <span class="ruby-comment"># Get the script we will execute</span>
591
+ <span class="ruby-identifier">script</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
592
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">replace_prog_name</span>
593
+ <span class="ruby-identifier">$0</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">script</span>)
594
+ <span class="ruby-keyword">end</span>
595
+
596
+ <span class="ruby-comment"># Set VM compile option</span>
597
+ <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">VM</span>)
598
+ <span class="ruby-constant">VM</span><span class="ruby-operator">::</span><span class="ruby-constant">InstructionSequence</span>.<span class="ruby-identifier">compile_option</span> = {
599
+ <span class="ruby-value">:trace_instruction</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword">true</span>,
600
+ <span class="ruby-value">:specialized_instruction</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">specialized_instruction</span>
601
+ }
602
+ <span class="ruby-keyword">end</span>
603
+
604
+ <span class="ruby-comment"># Set the measure mode</span>
605
+ <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span>
606
+ <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start_script</span>(<span class="ruby-identifier">script</span>)
607
+ <span class="ruby-keyword">end</span></pre>
608
+ </div><!-- run-source -->
609
+
610
+ </div>
611
+
612
+
613
+
614
+
615
+ </div><!-- run-method -->
616
+
617
+
618
+ <div id="method-i-setup_options" class="method-detail ">
619
+
620
+ <div class="method-heading">
621
+ <span class="method-name">setup_options</span><span
622
+ class="method-args">()</span>
623
+ <span class="method-click-advice">click to toggle source</span>
624
+ </div>
625
+
626
+
627
+ <div class="method-description">
628
+
629
+
630
+
631
+
632
+
633
+ <div class="method-source-code" id="setup_options-source">
634
+ <pre><span class="ruby-comment"># File bin/ruby-prof, line 36</span>
635
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">setup_options</span>
636
+ <span class="ruby-ivar">@options</span> = <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>
637
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">PROCESS_TIME</span>
638
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> = <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">FlatPrinter</span>
639
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">min_percent</span> = <span class="ruby-value">0</span>
640
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">file</span> = <span class="ruby-keyword">nil</span>
641
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">replace_prog_name</span> = <span class="ruby-keyword">false</span>
642
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">specialized_instruction</span> = <span class="ruby-keyword">false</span>
643
+
644
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">pre_libs</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
645
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">pre_execs</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
646
+ <span class="ruby-keyword">end</span></pre>
647
+ </div><!-- setup_options-source -->
648
+
649
+ </div>
650
+
651
+
652
+
653
+
654
+ </div><!-- setup_options-method -->
655
+
656
+
657
+ </section><!-- public-instance-method-details -->
658
+
659
+ </section><!-- 5Buntitled-5D -->
660
+
661
+ </div><!-- documentation -->
662
+
663
+
664
+ <footer id="validator-badges">
665
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
666
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
667
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
668
+ </footer>
669
+