<!DOCTYPE html>

<html> <head> <meta charset=“UTF-8”>

<title>class ReVIEW::Preprocessor - review-2.2.0 Documentation</title>

<script type=“text/javascript”>

var rdoc_rel_prefix = "../";
var index_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="../Object.html">Object</a>

</div>

  <div id="includes-section" class="nav-section">
<h3>Included Modules</h3>

<ul class="link-list">

  <li><a class="include" href="ErrorUtils.html">ReVIEW::ErrorUtils</a>

</ul>

</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-c-strip">::strip</a>

  <li ><a href="#method-i-defvar">#defvar</a>

  <li ><a href="#method-i-evaluate">#evaluate</a>

  <li ><a href="#method-i-expand">#expand</a>

  <li ><a href="#method-i-get_output">#get_output</a>

  <li ><a href="#method-i-init_vars">#init_vars</a>

  <li ><a href="#method-i-known_directive-3F">#known_directive?</a>

  <li ><a href="#method-i-minimum_indent">#minimum_indent</a>

  <li ><a href="#method-i-optarg_value">#optarg_value</a>

  <li ><a href="#method-i-parse_directive">#parse_directive</a>

  <li ><a href="#method-i-parse_optargs">#parse_optargs</a>

  <li ><a href="#method-i-preproc">#preproc</a>

  <li ><a href="#method-i-print_number">#print_number</a>

  <li ><a href="#method-i-process">#process</a>

  <li ><a href="#method-i-replace_block">#replace_block</a>

  <li ><a href="#method-i-skip_list">#skip_list</a>

  <li ><a href="#method-i-unindent">#unindent</a>

</ul>

</div>

</div>

</nav>

<main role=“main” aria-labelledby=“class-ReVIEW::Preprocessor”>

<h1 id="class-ReVIEW::Preprocessor" class="class">
  class ReVIEW::Preprocessor
</h1>

<section class="description">

</section>

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

  <section class="constants-list">
    <header>
      <h3>Constants</h3>
    </header>
    <dl>

      <dt id="INF_INDENT">INF_INDENT

      <dd>

      <dt id="KNOWN_DIRECTIVES">KNOWN_DIRECTIVES

      <dd>

      <dt id="TYPES">TYPES

      <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">(repo, param)</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 lib/review/preprocessor.rb, line 93</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>repo</span>, <span class=“ruby-identifier”>param</span>)

<span class="ruby-ivar">@repository</span> = <span class="ruby-identifier">repo</span>
<span class="ruby-ivar">@config</span> = <span class="ruby-identifier">param</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-c-strip" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">strip</span><span
      class="method-args">(f)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="strip-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 54</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Preprocessor</span>.<span class=“ruby-identifier”>strip</span>(<span class=“ruby-identifier”>f</span>)

<span class="ruby-identifier">buf</span> = <span class="ruby-string">&#39;&#39;</span>
<span class="ruby-constant">Strip</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">f</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">buf</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">rstrip</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-string">&quot;\n&quot;</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">buf</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-process" class="method-detail ">

    <div class="method-heading">
      <span class="method-name">process</span><span
        class="method-args">(inf, outf)</span>

      <span class="method-click-advice">click to toggle source</span>

    </div>

    <div class="method-description">

      <div class="method-source-code" id="process-source">
        <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 98</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>process</span>(<span class=“ruby-identifier”>inf</span>, <span class=“ruby-identifier”>outf</span>)

<span class="ruby-identifier">init_ErrorUtils</span> <span class="ruby-identifier">inf</span>
<span class="ruby-ivar">@f</span> = <span class="ruby-identifier">outf</span>
<span class="ruby-keyword">begin</span>
  <span class="ruby-identifier">preproc</span> <span class="ruby-identifier">inf</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOENT</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">err</span>
  <span class="ruby-identifier">error</span> <span class="ruby-identifier">err</span>.<span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span>

<span class=“ruby-keyword”>end</span></pre>

      </div>

    </div>

  </div>

</section>

 <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
   <header>
     <h3>Private Instance Methods</h3>
   </header>

  <div id="method-i-defvar" class="method-detail ">

    <div class="method-heading">
      <span class="method-name">defvar</span><span
        class="method-args">(name, value)</span>

      <span class="method-click-advice">click to toggle source</span>

    </div>

    <div class="method-description">

      <div class="method-source-code" id="defvar-source">
        <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 275</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>defvar</span>(<span class=“ruby-identifier”>name</span>, <span class=“ruby-identifier”>value</span>)

<span class="ruby-ivar">@vartable</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-evaluate" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">evaluate</span><span
      class="method-args">(path, chunk)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="evaluate-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 299</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>evaluate</span>(<span class=“ruby-identifier”>path</span>, <span class=“ruby-identifier”>chunk</span>)

<span class="ruby-identifier">outputs</span> = <span class="ruby-identifier">get_output</span>(<span class="ruby-node">&quot;ruby #{path}&quot;</span>, <span class="ruby-keyword">false</span>).<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\n/</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">strip</span> }
<span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
  <span class="ruby-keyword">if</span> <span class="ruby-node">/\# \$\d+/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">string</span>
    <span class="ruby-comment"># map result into source.</span>
    <span class="ruby-identifier">line</span>.<span class="ruby-identifier">edit</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
      <span class="ruby-identifier">s</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\$(\d+)/</span>) { <span class="ruby-identifier">outputs</span>[<span class="ruby-node">$1</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] }
    }
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">end</span>
}

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-expand" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">expand</span><span
      class="method-args">(str)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="expand-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 279</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>expand</span>(<span class=“ruby-identifier”>str</span>)

<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\$\w+/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">s</span> = <span class="ruby-ivar">@vartable</span>[<span class="ruby-identifier">name</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-string">&#39;$&#39;</span>, <span class="ruby-string">&#39;&#39;</span>)]
  <span class="ruby-identifier">s</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">expand</span>(<span class="ruby-identifier">s</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>
}

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-get_output" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">get_output</span><span
      class="method-args">(cmd, use_stderr)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="get_output-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 315</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>get_output</span>(<span class=“ruby-identifier”>cmd</span>, <span class=“ruby-identifier”>use_stderr</span>)

<span class="ruby-identifier">out</span> = <span class="ruby-identifier">err</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-constant">Open3</span>.<span class="ruby-identifier">popen3</span>(<span class="ruby-identifier">cmd</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">stdin</span>, <span class="ruby-identifier">stdout</span>, <span class="ruby-identifier">stderr</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">out</span> = <span class="ruby-identifier">stdout</span>.<span class="ruby-identifier">readlines</span>
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">use_stderr</span>
    <span class="ruby-identifier">out</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">readlines</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">err</span> = <span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">readlines</span>
  <span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">if</span> <span class="ruby-identifier">err</span> <span class="ruby-keyword">and</span> <span class="ruby-operator">!</span><span class="ruby-identifier">err</span>.<span class="ruby-identifier">empty?</span>
  <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;[unexpected stderr message]&quot;</span>
  <span class="ruby-identifier">err</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">error</span> <span class="ruby-string">&quot;get_output: got unexpected output&quot;</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">num</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">out</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> <span class="ruby-constant">Line</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">num</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">line</span>) }

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-init_vars" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">init_vars</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="init_vars-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 271</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>init_vars</span>

<span class="ruby-ivar">@vartable</span> = {}

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-known_directive-3F" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">known_directive?</span><span
      class="method-args">(op)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="known_directive-3F-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 166</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>known_directive?</span>(<span class=“ruby-identifier”>op</span>)

<span class="ruby-constant">KNOWN_DIRECTIVES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">op</span>)

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-minimum_indent" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">minimum_indent</span><span
      class="method-args">(chunk)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="minimum_indent-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 294</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>minimum_indent</span>(<span class=“ruby-identifier”>chunk</span>)

<span class="ruby-identifier">n</span> = <span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">?</span> <span class="ruby-constant">INF_INDENT</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">num_indent</span> }.<span class="ruby-identifier">min</span>
<span class="ruby-identifier">n</span> <span class="ruby-operator">==</span> <span class="ruby-constant">INF_INDENT</span> <span class="ruby-operator">?</span> <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">n</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-optarg_value" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">optarg_value</span><span
      class="method-args">(spec)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="optarg_value-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 259</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>optarg_value</span>(<span class=“ruby-identifier”>spec</span>)

<span class="ruby-keyword">case</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">&#39;true&#39;</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">true</span> <span class="ruby-comment"># [name=true]</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">&#39;false&#39;</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">false</span> <span class="ruby-comment"># [name=false]</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">&#39;nil&#39;</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">nil</span> <span class="ruby-comment"># [name=nil]</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">true</span> <span class="ruby-comment"># [name]</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/^\d+$/</span> <span class="ruby-keyword">then</span> <span class="ruby-node">$&amp;</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-comment"># [name=8]</span>
<span class="ruby-keyword">else</span> <span class="ruby-comment"># [name=val]</span>
  <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-parse_directive" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">parse_directive</span><span
      class="method-args">(line, argc, *optdecl)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="parse_directive-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 228</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parse_directive</span>(<span class=“ruby-identifier”>line</span>, <span class=“ruby-identifier”>argc</span>, <span class=“ruby-operator”>*</span><span class=“ruby-identifier”>optdecl</span>)

<span class="ruby-identifier">m</span> = <span class="ruby-node">/\A\#@(\w+)\((.*?)\)(?:\[(.*?)\])?\z/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span>) <span class="ruby-keyword">or</span>
        <span class="ruby-identifier">error</span> <span class="ruby-node">&quot;wrong directive: #{line.strip}&quot;</span>
<span class="ruby-identifier">op</span> = <span class="ruby-identifier">m</span>[<span class="ruby-value">1</span>]
<span class="ruby-identifier">args</span> = <span class="ruby-identifier">m</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/,\s*/</span>)
<span class="ruby-identifier">opts</span> = <span class="ruby-identifier">parse_optargs</span>(<span class="ruby-identifier">m</span>[<span class="ruby-value">3</span>])
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">argc</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">argc</span> <span class="ruby-operator">==</span> <span class="ruby-value">-1</span>
  <span class="ruby-comment"># Any number of arguments are allowed.</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">argc</span>
  <span class="ruby-identifier">error</span> <span class="ruby-string">&quot;wrong arg size&quot;</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>
  <span class="ruby-identifier">wrong_opts</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">keys</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">optdecl</span>
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">wrong_opts</span>.<span class="ruby-identifier">empty?</span>
    <span class="ruby-identifier">error</span> <span class="ruby-node">&quot;wrong option: #{wrong_opts.keys.join(&#39; &#39;)}&quot;</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Directive</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">op</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">opts</span> <span class="ruby-operator">||</span> {})

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-parse_optargs" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">parse_optargs</span><span
      class="method-args">(str)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="parse_optargs-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 249</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parse_optargs</span>(<span class=“ruby-identifier”>str</span>)

<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">str</span>
<span class="ruby-identifier">table</span> = {}
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/,\s*/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">name</span>, <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">a</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/=/</span>, <span class="ruby-value">2</span>)
  <span class="ruby-identifier">table</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">optarg_value</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">table</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-preproc" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">preproc</span><span
      class="method-args">(f)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="preproc-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 112</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>preproc</span>(<span class=“ruby-identifier”>f</span>)

<span class="ruby-identifier">init_vars</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">gets</span>
  <span class="ruby-keyword">case</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@\#/</span>, <span class="ruby-node">/\A\#\#\#\#/</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>

  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@defvar/</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
    <span class="ruby-identifier">direc</span> = <span class="ruby-identifier">parse_directive</span>(<span class="ruby-identifier">line</span>, <span class="ruby-value">2</span>)
    <span class="ruby-identifier">defvar</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">direc</span>.<span class="ruby-identifier">args</span>)

  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@mapoutput/</span>
    <span class="ruby-identifier">direc</span> = <span class="ruby-identifier">parse_directive</span>(<span class="ruby-identifier">line</span>, <span class="ruby-value">1</span>, <span class="ruby-string">&#39;stderr&#39;</span>)
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
    <span class="ruby-identifier">get_output</span>(<span class="ruby-identifier">expand</span>(<span class="ruby-identifier">direc</span>.<span class="ruby-identifier">arg</span>), <span class="ruby-identifier">direc</span>[<span class="ruby-string">&#39;stderr&#39;</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">out</span><span class="ruby-operator">|</span>
      <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">out</span>.<span class="ruby-identifier">string</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">skip_list</span> <span class="ruby-identifier">f</span>

  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@mapfile/</span>
    <span class="ruby-identifier">direc</span> = <span class="ruby-identifier">parse_directive</span>(<span class="ruby-identifier">line</span>, <span class="ruby-value">1</span>, <span class="ruby-string">&#39;eval&#39;</span>)
    <span class="ruby-identifier">path</span> = <span class="ruby-identifier">expand</span>(<span class="ruby-identifier">direc</span>.<span class="ruby-identifier">arg</span>)
    <span class="ruby-identifier">ent</span> = <span class="ruby-ivar">@repository</span>.<span class="ruby-identifier">fetch_file</span>(<span class="ruby-identifier">path</span>)
    <span class="ruby-identifier">ent</span> = <span class="ruby-identifier">evaluate</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">ent</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">direc</span>[<span class="ruby-string">&#39;eval&#39;</span>]
    <span class="ruby-identifier">replace_block</span>(<span class="ruby-identifier">f</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">ent</span>, <span class="ruby-keyword">false</span>) <span class="ruby-comment"># FIXME: turn off lineno: tmp</span>

  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@map(?:range)?/</span>
    <span class="ruby-identifier">direc</span> = <span class="ruby-identifier">parse_directive</span>(<span class="ruby-identifier">line</span>, <span class="ruby-value">2</span>, <span class="ruby-string">&#39;unindent&#39;</span>)
    <span class="ruby-identifier">path</span> = <span class="ruby-identifier">expand</span>(<span class="ruby-identifier">direc</span>.<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
    <span class="ruby-identifier">ent</span> = <span class="ruby-ivar">@repository</span>.<span class="ruby-identifier">fetch_range</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">direc</span>.<span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>]) <span class="ruby-keyword">or</span>
            <span class="ruby-identifier">error</span> <span class="ruby-node">&quot;unknown range: #{path}: #{direc.args[1]}&quot;</span>
    <span class="ruby-identifier">ent</span> = (<span class="ruby-identifier">direc</span>[<span class="ruby-string">&#39;unindent&#39;</span>] <span class="ruby-operator">?</span> <span class="ruby-identifier">unindent</span>(<span class="ruby-identifier">ent</span>, <span class="ruby-identifier">direc</span>[<span class="ruby-string">&#39;unindent&#39;</span>]) <span class="ruby-operator">:</span> <span class="ruby-identifier">ent</span>)
    <span class="ruby-identifier">replace_block</span>(<span class="ruby-identifier">f</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">ent</span>, <span class="ruby-keyword">false</span>) <span class="ruby-comment"># FIXME: turn off lineno: tmp</span>

  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@end/</span>
    <span class="ruby-identifier">error</span> <span class="ruby-string">&#39;unbaranced #@end&#39;</span>

  <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@/</span>
    <span class="ruby-identifier">op</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-regexp">/@(\w+)/</span>, <span class="ruby-value">1</span>)
    <span class="ruby-comment">#error &quot;unkown directive: #{line.strip}&quot; unless known_directive?(op)</span>
    <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;unkown directive: #{line.strip}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">known_directive?</span>(<span class="ruby-identifier">op</span>)
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>

  <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A\s*\z/</span> <span class="ruby-comment"># empty line</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">puts</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</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-print_number" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">print_number</span><span
      class="method-args">(num)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="print_number-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 179</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>print_number</span>(<span class=“ruby-identifier”>num</span>)

<span class="ruby-ivar">@f</span>.<span class="ruby-identifier">printf</span> <span class="ruby-string">&#39;%4s  &#39;</span>, (<span class="ruby-identifier">num</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">num</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">:</span> <span class="ruby-string">&#39;&#39;</span>)

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-replace_block" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">replace_block</span><span
      class="method-args">(f, directive_line, newlines, with_lineno)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="replace_block-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 170</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>replace_block</span>(<span class=“ruby-identifier”>f</span>, <span class=“ruby-identifier”>directive_line</span>, <span class=“ruby-identifier”>newlines</span>, <span class=“ruby-identifier”>with_lineno</span>)

<span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">directive_line</span>
<span class="ruby-identifier">newlines</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">print_number</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">number</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">with_lineno</span>
  <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">string</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">skip_list</span> <span class="ruby-identifier">f</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-skip_list" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">skip_list</span><span
      class="method-args">(f)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="skip_list-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 183</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>skip_list</span>(<span class=“ruby-identifier”>f</span>)

<span class="ruby-identifier">begline</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">lineno</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">gets</span>
  <span class="ruby-keyword">case</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">when</span> <span class="ruby-node">%r[\A\#@end]</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
    <span class="ruby-keyword">return</span>
  <span class="ruby-keyword">when</span> <span class="ruby-regexp">%r[\A//\}]</span>
    <span class="ruby-identifier">warn</span> <span class="ruby-string">&#39;//} seen in list&#39;</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
    <span class="ruby-keyword">return</span>
  <span class="ruby-keyword">when</span> <span class="ruby-node">%r[\A\#@\w]</span>
    <span class="ruby-identifier">warn</span> <span class="ruby-node">&quot;#{line.slice(/\A\#@\w+/)} seen in list&quot;</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">when</span> <span class="ruby-node">%r[\A\#@]</span>
    <span class="ruby-ivar">@f</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">error</span> <span class="ruby-node">&quot;list reached end of file (beginning line = #{begline})&quot;</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-unindent" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">unindent</span><span
      class="method-args">(chunk, n)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="unindent-source">
      <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 286</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>unindent</span>(<span class=“ruby-identifier”>chunk</span>, <span class=“ruby-identifier”>n</span>)

<span class="ruby-identifier">n</span> = <span class="ruby-identifier">minimum_indent</span>(<span class="ruby-identifier">chunk</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Integer</span>)
<span class="ruby-identifier">re</span> = <span class="ruby-node">/\A#{&#39; &#39; * n}/</span>
<span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">edit</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-identifier">re</span>,<span class="ruby-string">&#39;&#39;</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>