Class: RubyProf::CallStackPrinter

Inherits:
AbstractPrinter show all
Includes:
ERB::Util
Defined in:
lib/ruby-prof/printers/call_stack_printer.rb

Overview

prints a HTML visualization of the call tree

Instance Method Summary collapse

Methods inherited from AbstractPrinter

#editor_uri, #initialize, #method_name, #min_percent, needs_dir?, #print_file, #print_thread, #print_threads, #setup_options, #sort_method

Constructor Details

This class inherits a constructor from RubyProf::AbstractPrinter

Instance Method Details

#application ⇒ Object 



169
170
171
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 169

def application
  @options[:application] || $PROGRAM_NAME
end

#arguments ⇒ Object 



173
174
175
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 173

def arguments
  ARGV.join(' ')
end

#base64_image ⇒ Object 



215
216
217
218
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 215

def base64_image
  file = open_asset('call_stack_printer.png')
  Base64.encode64(file).gsub(/\n/, '')
end

#color(p) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 156

def color(p)
  case i = p.to_i
  when 0..5
    "01"
  when 5..10
    "05"
  when 100
    "9"
  else
    "#{i/10}"
  end
end

#dump(ci) ⇒ Object 



152
153
154
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 152

def dump(ci)
  $stderr.printf "%s/%d t:%f s:%f w:%f  \n", ci, ci.object_id, ci.total_time, ci.self_time, ci.wait_time
end

#expansion ⇒ Object 



185
186
187
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 185

def expansion
  @options[:expansion] || 10.0
end

#graph_link(call_info) ⇒ Object 



133
134
135
136
137
138
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 133

def graph_link(call_info)
  total_calls = call_info.target.call_infos.inject(0){|t, ci| t += ci.called}
  href = "#{@graph_html}##{method_href(call_info.target)}"
  totals = @graph_html ? "<a href='#{href}'>#{total_calls}</a>" : total_calls.to_s
  "[#{call_info.called} calls, #{totals} total]"
end

#link(call_info) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 117

def link(call_info)
  method = call_info.target
  file = File.expand_path(method.source_file)
  if file =~ /\/ruby_runtime$/
    h(name(call_info))
  else
    if @editor
      "<a href=\"#{@editor}://" \
      "open?url=file://#{file}&line=#{method.line}\">" \
      "#{h(name(call_info))}</a>"
    else
      "<a href=\"file://#{file}##{method.line}\">#{h(name(call_info))}</a>"
    end
  end
end

#method_href(method) ⇒ Object 



140
141
142
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 140

def method_href(method)
  h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + @current_thread_id.to_s)
end

#name(call_info) ⇒ Object 



112
113
114
115
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 112

def name(call_info)
  method = call_info.target
  method.full_name
end

#open_asset(file) ⇒ Object 



205
206
207
208
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 205

def open_asset(file)
  path = File.join(File.expand_path('../../assets', __FILE__), file)
  File.open(path, 'rb').read
end

#print(output = STDOUT, options = {}) ⇒ Object

Specify print options.

options - Hash table

:min_percent - Number 0 to 100 that specifes the minimum
               %self (the methods self time divided by the
               overall total time) that a method must take
               for it to be printed out in the report.
               Default value is 0.

:print_file  - True or false. Specifies if a method's source
               file should be printed.  Default value if false.

:threshold   - a float from 0 to 100 that sets the threshold of
               results displayed.
               Default value is 1.0

:title       - a String to overide the default "ruby-prof call tree"
               title of the report.

:expansion   - a float from 0 to 100 that sets the threshold of
               results that are expanded, if the percent_total
               exceeds it.
               Default value is 10.0

:application - a String to overide the name of the application,
               as it appears on the report.

 :editor_uri - Specifies editor uri scheme used for opening files
               e.g. :atm or :mvim. For OS X default is :txmt.
               Use RUBY_PROF_EDITOR_URI environment variable to overide.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 42

def print(output = STDOUT, options = {})
  @output = output
  setup_options(options)
  @editor = editor_uri
  if @graph_html = options.delete(:graph)
    @graph_html = "file://" + @graph_html if @graph_html[0]=="/"
  end

  print_header

  @overall_threads_time = @result.threads.inject(0) do |val, thread|
    val += thread.total_time
  end

  @result.threads.each do |thread|
    @current_thread_id = thread.fiber_id
    @overall_time = thread.total_time
thread_info = String.new("Thread: #{thread.id}")
    thread_info << ", Fiber: #{thread.fiber_id}" unless thread.id == thread.fiber_id
    thread_info << " (#{"%4.2f%%" % ((@overall_time/@overall_threads_time)*100)} ~ #{@overall_time})"
    @output.print "<div class=\"thread\">#{thread_info}</div>"
    @output.print "<ul name=\"thread\">"
    thread.methods.each do |m|
      # $stderr.print m.dump
      next unless m.root?
      m.call_infos.each do |ci|
        next unless ci.root?
        print_stack ci, thread.total_time
      end
    end
    @output.print "</ul>"
  end

  print_footer

end

#print_commands ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 234

def print_commands
  @output.puts <<-"end_commands"
<div id=\"commands\">
<span style=\"font-size: 11pt; font-weight: bold;\">Threshold:</span>
<input value=\"#{h threshold}\" size=\"3\" id=\"threshold\" type=\"text\">
<input value=\"Apply\" onclick=\"setThreshold();\" type=\"submit\">
<input value=\"Expand All\" onclick=\"expandAll(event);\" type=\"submit\">
<input value=\"Collapse All\" onclick=\"collapseAll(event);\" type=\"submit\">
<input value=\"Show Help\" onclick=\"toggleHelp(this);\" type=\"submit\">
</div>
end_commands
end

#print_css ⇒ Object 



210
211
212
213
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 210

def print_css
  html = open_asset('call_stack_printer.css.html')
  @output.puts html.gsub('%s', base64_image)
end

#print_footer ⇒ Object 



201
202
203
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 201

def print_footer
  @output.puts '<div id="sentinel"></div></div></body></html>'
end

#print_header ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 189

def print_header
  @output.puts "<html><head>"
  @output.puts '<meta http-equiv="content-type" content="text/html; charset=utf-8">'
  @output.puts "<title>#{h title}</title>"
  print_css
  print_java_script
  @output.puts '</head><body><div style="display: inline-block;">'
  print_title_bar
  print_commands
  print_help
end

#print_help ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 247

def print_help
  @output.puts <<-'end_help'
<div style="display: none;" id="help">
&#8226; Enter a decimal value <i>d</i> into the threshold field and click "Apply"
    to hide all nodes marked with time values lower than <i>d</i>.<br>
&#8226; Click on "Expand All" for full tree expansion.<br>
&#8226; Click on "Collapse All" to show only top level nodes.<br>
&#8226; Use a, s, d, w as in Quake or Urban Terror to navigate the tree.<br>
&#8226; Use f and b to navigate the tree in preorder forward and backwards.<br>
&#8226; Use x to toggle visibility of a subtree.<br>
&#8226; Use * to expand/collapse a whole subtree.<br>
&#8226; Use h to navigate to thread root.<br>
&#8226; Use n and p to navigate between threads.<br>
&#8226; Click on background to move focus to a subtree.<br>
</div>
end_help
end

#print_java_script ⇒ Object 



220
221
222
223
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 220

def print_java_script
  html = open_asset('call_stack_printer.js.html')
  @output.puts html
end

#print_stack(call_info, parent_time) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 79

def print_stack(call_info, parent_time)
  total_time = call_info.total_time
  percent_parent = (total_time/parent_time)*100
  percent_total = (total_time/@overall_time)*100
  return unless percent_total > min_percent
  color = self.color(percent_total)
  kids = call_info.children
  visible = percent_total >= threshold
  expanded = percent_total >= expansion
  display = visible ? "block" : "none"
  @output.print "<li class=\"color#{color}\" style=\"display:#{display}\">"
  if kids.empty?
    @output.print "<a href=\"#\" class=\"toggle empty\" ></a>"
  else
    visible_children = kids.any?{|ci| (ci.total_time/@overall_time)*100 >= threshold}
    image = visible_children ? (expanded ? "minus" : "plus") : "empty"
    @output.print "<a href=\"#\" class=\"toggle #{image}\" ></a>"
  end
  @output.printf "<span> %4.2f%% (%4.2f%%) %s %s</span>\n", percent_total, percent_parent, link(call_info), graph_link(call_info)
  unless kids.empty?
    if expanded
      @output.print "<ul>"
    else
      @output.print '<ul style="display:none">'
    end
    kids.sort_by{|c| -c.total_time}.each do |callinfo|
      print_stack callinfo, total_time
    end
    @output.print "</ul>"
  end
  @output.print "</li>"
end

#print_title_bar ⇒ Object 



225
226
227
228
229
230
231
232
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 225

def print_title_bar
  @output.puts <<-"end_title_bar"
<div id="titlebar">
Call tree for application <b>#{h application} #{h arguments}</b><br/>
Generated on #{Time.now} with options #{h @options.inspect}<br/>
</div>
end_title_bar
end

#sum(a) ⇒ Object 



148
149
150
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 148

def sum(a)
  a.inject(0.0){|s,t| s+=t}
end

#threshold ⇒ Object 



181
182
183
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 181

def threshold
  @options[:threshold] || 1.0
end

#title ⇒ Object 



177
178
179
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 177

def title
  @title ||= @options.delete(:title) || "ruby-prof call tree"
end

#total_time(call_infos) ⇒ Object 



144
145
146
 
# File 'lib/ruby-prof/printers/call_stack_printer.rb', line 144

def total_time(call_infos)
  sum(call_infos.map{|ci| ci.total_time})
end