File Manager

Path: /opt/chef.upgrade/embedded/lib/ruby/gems/2.3.0/gems/ruby-prof-0.16.2/doc/RubyProf/

Viewing File: Cmd.html

<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class RubyProf::Cmd - 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">Object
  
</div>

    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-c-new">::new</a>
    
    <li ><a href="#method-i-load_pre_execs">#load_pre_execs</a>
    
    <li ><a href="#method-i-load_pre_libs">#load_pre_libs</a>
    
    <li ><a href="#method-i-option_parser">#option_parser</a>
    
    <li ><a href="#method-i-parse_args">#parse_args</a>
    
    <li ><a href="#method-i-run">#run</a>
    
    <li ><a href="#method-i-setup_options">#setup_options</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-RubyProf::Cmd">
  <h1 id="class-RubyProf::Cmd" class="class">
    class RubyProf::Cmd
  </h1>

  <section class="description">
    
  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    
    <section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

      
      <div id="attribute-i-options" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">options</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
    </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">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>
  <span class="ruby-identifier">setup_options</span>
  <span class="ruby-identifier">parse_args</span>

  <span class="ruby-identifier">load_pre_libs</span>
  <span class="ruby-identifier">load_pre_execs</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-load_pre_execs" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">load_pre_execs</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="load_pre_execs-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 269</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_pre_execs</span>
  <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>
    <span class="ruby-identifier">eval</span>(<span class="ruby-identifier">exec</span>)
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-load_pre_libs" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">load_pre_libs</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="load_pre_libs-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 263</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_pre_libs</span>
  <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>
    <span class="ruby-identifier">require</span> <span class="ruby-identifier">lib</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-option_parser" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">option_parser</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="option_parser-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option_parser</span>
  <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>
    <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>
        <span class="ruby-string">&quot;Usage: ruby-prof [options] &lt;script.rb&gt; [--] [profiled-script-command-line-options]&quot;</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-string">&quot;&quot;</span>
    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-string">&quot;Options:&quot;</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-p printer&#39;</span>, <span class="ruby-string">&#39;--printer=printer&#39;</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>, <span class="ruby-value">:multi</span>],
            <span class="ruby-string">&#39;Select a printer:&#39;</span>,
            <span class="ruby-string">&#39;  flat - Prints a flat profile as text (default).&#39;</span>,
            <span class="ruby-string">&#39;  flat_with_line_numbers - same as flat, with line numbers.&#39;</span>,
            <span class="ruby-string">&#39;  graph - Prints a graph profile as text.&#39;</span>,
            <span class="ruby-string">&#39;  graph_html - Prints a graph profile as html.&#39;</span>,
            <span class="ruby-string">&#39;  call_tree - format for KCacheGrind&#39;</span>,
            <span class="ruby-string">&#39;  call_stack - prints a HTML visualization of the call tree&#39;</span>,
            <span class="ruby-string">&#39;  dot - Prints a graph profile as a dot file&#39;</span>,
            <span class="ruby-string">&#39;  multi - Creates several reports in output directory&#39;</span>
    ) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">printer</span><span class="ruby-operator">|</span>


      <span class="ruby-keyword">case</span> <span class="ruby-identifier">printer</span>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:flat</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:flat_with_line_numbers</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:graph</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:graph_html</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:call_tree</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:call_stack</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:dot</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:multi</span>
        <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">MultiPrinter</span>
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-m min_percent&#39;</span>, <span class="ruby-string">&#39;--min_percent=min_percent&#39;</span>, <span class="ruby-constant">Float</span>,
            <span class="ruby-string">&#39;The minimum percent a method must take before &#39;</span>,
            <span class="ruby-string">&#39;  being included in output reports.&#39;</span>,
            <span class="ruby-string">&#39;  this option is not supported for call tree.&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">min_percent</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">min_percent</span> = <span class="ruby-identifier">min_percent</span>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-f path&#39;</span>, <span class="ruby-string">&#39;--file=path&#39;</span>,
            <span class="ruby-string">&#39;Output results to a file instead of standard out.&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">file</span> = <span class="ruby-identifier">file</span>
      <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>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;--mode=measure_mode&#39;</span>,
            [<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>],
            <span class="ruby-string">&#39;Select what ruby-prof should measure:&#39;</span>,
            <span class="ruby-string">&#39;  wall - Wall time (default).&#39;</span>,
            <span class="ruby-string">&#39;  process - Process time.&#39;</span>,
            <span class="ruby-string">&#39;  cpu - CPU time (Pentium and PowerPCs only).&#39;</span>,
            <span class="ruby-string">&#39;  allocations - Object allocations (requires patched Ruby interpreter).&#39;</span>,
            <span class="ruby-string">&#39;  memory - Allocated memory in KB (requires patched Ruby interpreter).&#39;</span>,
            <span class="ruby-string">&#39;  gc_runs - Number of garbage collections (requires patched Ruby interpreter).&#39;</span>,
            <span class="ruby-string">&#39;  gc_time - Time spent in garbage collection (requires patched Ruby interpreter).&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">measure_mode</span><span class="ruby-operator">|</span>

      <span class="ruby-keyword">case</span> <span class="ruby-identifier">measure_mode</span>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:wall</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:process</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:cpu</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:allocations</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:memory</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:gc_runs</span>
        <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>
      <span class="ruby-keyword">when</span> <span class="ruby-value">:gc_time</span>
        <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>
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-s sort_mode&#39;</span>, <span class="ruby-string">&#39;--sort=sort_mode&#39;</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>],
            <span class="ruby-string">&#39;Select how ruby-prof results should be sorted:&#39;</span>,
            <span class="ruby-string">&#39;  total - Total time&#39;</span>,
            <span class="ruby-string">&#39;  self - Self time&#39;</span>,
            <span class="ruby-string">&#39;  wait - Wait time&#39;</span>,
            <span class="ruby-string">&#39;  child - Child time&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sort_mode</span><span class="ruby-operator">|</span>

      <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>
                            <span class="ruby-keyword">when</span> <span class="ruby-value">:total</span>
                              <span class="ruby-value">:total_time</span>
                            <span class="ruby-keyword">when</span> <span class="ruby-value">:self</span>
                              <span class="ruby-value">:self_time</span>
                            <span class="ruby-keyword">when</span> <span class="ruby-value">:wait</span>
                              <span class="ruby-value">:wait_time</span>
                            <span class="ruby-keyword">when</span> <span class="ruby-value">:child</span>
                              <span class="ruby-value">:children_time</span>
                            <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>

    <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>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">replace_prog_name</span> = <span class="ruby-keyword">true</span>
    <span class="ruby-keyword">end</span>

    <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">RubyVM</span>)
      <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>
        <span class="ruby-identifier">options</span>.<span class="ruby-identifier">specialized_instruction</span> = <span class="ruby-keyword">true</span>
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>

    <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>
      <span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>
      <span class="ruby-identifier">exit</span>
    <span class="ruby-keyword">end</span>

    <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>
      <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>
      <span class="ruby-identifier">exit</span>
    <span class="ruby-keyword">end</span>

    <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>
      <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">&#39; &#39;</span>)
      <span class="ruby-identifier">$VERBOSE</span> = <span class="ruby-keyword">true</span>
    <span class="ruby-keyword">end</span>

    <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>
      <span class="ruby-identifier">$DEBUG</span> = <span class="ruby-keyword">true</span>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-R lib&#39;</span>, <span class="ruby-string">&#39;--require-noprof lib&#39;</span>, <span class="ruby-string">&#39;require a specific library (not profiled)&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lib</span><span class="ruby-operator">|</span>
      <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>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-E code&#39;</span>, <span class="ruby-string">&#39;--eval-noprof code&#39;</span>, <span class="ruby-string">&#39;execute the ruby statements (not profiled)&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">code</span><span class="ruby-operator">|</span>
      <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>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-x regexp&#39;</span>, <span class="ruby-string">&#39;--exclude regexp&#39;</span>, <span class="ruby-string">&#39;exclude methods by regexp (see method elimination)&#39;</span>) <span class="ruby-keyword">do</span><span class="ruby-operator">|</span><span class="ruby-identifier">meth</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">||=</span> []
      <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>)
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;-X file&#39;</span>, <span class="ruby-string">&#39;--exclude-file file&#39;</span>, <span class="ruby-string">&#39;exclude methods by regexp listed in file (see method elimination)&#39;</span>) <span class="ruby-keyword">do</span><span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods_files</span> <span class="ruby-operator">||=</span> []
      <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>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;--exclude-common-cycles&#39;</span>, <span class="ruby-string">&#39;make common iterators like Integer#times appear inlined&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">meth</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">||=</span> []
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">+=</span> <span class="ruby-node">%w{
        Integer#times
        Integer#upto
        Integer#downto
        Enumerator#each
        Enumerator#each_with_index
        Enumerator#each_with_object

        Array#each
        Array#each_index
        Array#reverse_each
        Array#map

        Hash#each
        Hash#each_pair
        Hash#each_key
        Hash#each_value

        Range#each
        Enumerable#each_cons
        Enumerable#each_entry
        Enumerable#each_slice
        Enumerable#each_with_index
        Enumerable#each_with_object
        Enumerable#reverse_each
        Enumerable#inject
        Enumerable#collect
        Enumerable#reduce
      }</span>
      <span class="ruby-comment">#TODO: may be the whole Enumerable module should be excluded via &#39;Enumerable#.*&#39;, we need feedback on use cases.</span>
    <span class="ruby-keyword">end</span>

    <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">&#39;--exclude-common-callbacks&#39;</span>, <span class="ruby-string">&#39;make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph&#39;</span>) <span class="ruby-keyword">do</span><span class="ruby-operator">|</span><span class="ruby-identifier">meth</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">||=</span> []
      <span class="ruby-identifier">options</span>.<span class="ruby-identifier">eliminate_methods</span> <span class="ruby-operator">+=</span> <span class="ruby-node">%w{
        Method#call
        Proc#call
        ActiveSupport::Callbacks::ClassMethods#__run_callback
      }</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-parse_args" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">parse_args</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="parse_args-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 242</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_args</span>
  <span class="ruby-comment"># Make sure the user specified at least one file</span>
  <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>
    <span class="ruby-identifier">puts</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">option_parser</span>
    <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;&quot;</span>
    <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Must specify a script to run&quot;</span>
    <span class="ruby-identifier">exit</span>(<span class="ruby-value">-1</span>)
  <span class="ruby-keyword">end</span>

  <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>

  <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">printer</span> <span class="ruby-operator">==</span> <span class="ruby-constant">RubyProf</span><span class="ruby-operator">::</span><span class="ruby-constant">MultiPrinter</span>
    <span class="ruby-identifier">options</span>.<span class="ruby-identifier">file</span> <span class="ruby-operator">||=</span> <span class="ruby-string">&quot;.&quot;</span>
    <span class="ruby-identifier">options</span>.<span class="ruby-identifier">old_wd</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>
  <span class="ruby-keyword">end</span>
<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>
  <span class="ruby-identifier">puts</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">option_parser</span>
  <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
  <span class="ruby-identifier">exit</span>(<span class="ruby-value">-1</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-run" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">run</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="run-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 275</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>
  <span class="ruby-comment"># Get the script we will execute</span>
  <span class="ruby-identifier">script</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">replace_prog_name</span>
    <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>)
  <span class="ruby-keyword">end</span>

  <span class="ruby-comment"># Set VM compile option</span>
  <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">RubyVM</span>)
    <span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">InstructionSequence</span>.<span class="ruby-identifier">compile_option</span> = {
        <span class="ruby-value">:trace_instruction</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword">true</span>,
        <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>
    }
  <span class="ruby-keyword">end</span>

  <span class="ruby-comment"># Set the measure mode</span>
  <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> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">measure_mode</span>
  <span class="ruby-constant">RubyProf</span>.<span class="ruby-identifier">start_script</span>(<span class="ruby-identifier">script</span>)
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-i-setup_options" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">setup_options</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="setup_options-source">
            <pre><span class="ruby-comment"># File bin/ruby-prof, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">setup_options</span>
  <span class="ruby-ivar">@options</span> = <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>
  <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>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">min_percent</span> = <span class="ruby-value">0</span>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">file</span> = <span class="ruby-keyword">nil</span>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">replace_prog_name</span> = <span class="ruby-keyword">false</span>
  <span class="ruby-identifier">options</span>.<span class="ruby-identifier">specialized_instruction</span> = <span class="ruby-keyword">false</span>

  <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>
  <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>
<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>