File Manager
Viewing File: DotPrinter.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RubyProf::DotPrinter - ruby-prof</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
</script>
<script src="../js/jquery.js"></script>
<script src="../js/darkfish.js"></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="AbstractPrinter.html">RubyProf::AbstractPrinter</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-print">#print</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RubyProf::DotPrinter">
<h1 id="class-RubyProf::DotPrinter" class="class">
class RubyProf::DotPrinter
</h1>
<section class="description">
<p>Generates a graphviz graph in dot format. To use the dot printer:</p>
<pre>result = RubyProf.profile do
[code to profile]
end
printer = RubyProf::DotPrinter.new(result)
printer.print(STDOUT)</pre>
<p>You can use either dot viewer such as GraphViz, or the dot command line
tool to reformat the output into a wide variety of outputs:</p>
<pre>dot -Tpng graph.dot > graph.png</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="CLASS_COLOR">CLASS_COLOR
<dd>
<dt id="EDGE_COLOR">EDGE_COLOR
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(result)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the <a href="DotPrinter.html">DotPrinter</a> using a
RubyProf::Proile.</p>
<div class="method-calls-super">
Calls superclass method
<a href="AbstractPrinter.html#method-c-new">RubyProf::AbstractPrinter.new</a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/ruby-prof/printers/dot_printer.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">result</span>)
<span class="ruby-ivar">@seen_methods</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-print" class="method-detail ">
<div class="method-heading">
<span class="method-name">print</span><span
class="method-args">(output = STDOUT, options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Print a graph report to the provided output.</p>
<p>output - Any IO object, including STDOUT or a file. The default value is
STDOUT.</p>
<p>options - Hash of print options. See <a
href="AbstractPrinter.html#method-i-setup_options">setup_options</a> for
more information.</p>
<p>When profiling results that cover a large number of method calls it helps
to use the :min_percent option, for example:</p>
<pre class="ruby"><span class="ruby-constant">DotPrinter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>).<span class="ruby-identifier">print</span>(<span class="ruby-constant">STDOUT</span>, :<span class="ruby-identifier">min_percent=</span><span class="ruby-operator">></span><span class="ruby-value">5</span>)
</pre>
<div class="method-source-code" id="print-source">
<pre><span class="ruby-comment"># File lib/ruby-prof/printers/dot_printer.rb, line 43</span>
<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> = {})
<span class="ruby-ivar">@output</span> = <span class="ruby-identifier">output</span>
<span class="ruby-identifier">setup_options</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-string">'digraph "Profile" {'</span>
<span class="ruby-comment">#puts "label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"labelloc=t;"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"labeljust=l;"</span>
<span class="ruby-identifier">print_threads</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">'}'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>