<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::Unfold - 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>
<!-- 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-unfold">::unfold</a> <li ><a href="#method-c-unfold_author_source">::unfold_author_source</a> <li ><a href="#method-i-blank">#blank</a> <li ><a href="#method-i-do_unfold">#do_unfold</a> <li ><a href="#method-i-flush_blank">#flush_blank</a> <li ><a href="#method-i-println">#println</a> <li ><a href="#method-i-skip_block">#skip_block</a> <li ><a href="#method-i-unfold">#unfold</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::Unfold”>
<h1 id="class-ReVIEW::Unfold" class="class"> class ReVIEW::Unfold </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> <dt id="ZSPACE">ZSPACE <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">(indent_paragraph = false)</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/unfold.rb, line 30</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>indent_paragraph</span> = <span class=“ruby-keyword”>false</span>)
<span class="ruby-ivar">@indent_paragraph</span> = <span class="ruby-identifier">indent_paragraph</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-unfold" class="method-detail "> <div class="method-heading"> <span class="method-name">unfold</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="unfold-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 26</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Unfold</span>.<span class=“ruby-identifier”>unfold</span>(<span class=“ruby-identifier”>f</span>)
<span class="ruby-identifier">new</span>().<span class="ruby-identifier">unfold</span>(<span class="ruby-identifier">f</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-unfold_author_source" class="method-detail "> <div class="method-heading"> <span class="method-name">unfold_author_source</span><span class="method-args">(s)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>unfold paragraphs and strip preprocessor tags.</p> <div class="method-source-code" id="unfold_author_source-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 22</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Unfold</span>.<span class=“ruby-identifier”>unfold_author_source</span>(<span class=“ruby-identifier”>s</span>)
<span class="ruby-identifier">unfold</span>(<span class="ruby-constant">Preprocessor</span><span class="ruby-operator">::</span><span class="ruby-constant">Strip</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">s</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-unfold" class="method-detail "> <div class="method-heading"> <span class="method-name">unfold</span><span class="method-args">(input, output = nil)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>unfold(f) -> <a href="../String.html">String</a> unfold(input, output)
-> nil</p>
<div class="method-source-code" id="unfold-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 36</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>unfold</span>(<span class=“ruby-identifier”>input</span>, <span class=“ruby-identifier”>output</span> = <span class=“ruby-keyword”>nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">output</span> <span class="ruby-ivar">@output</span> = <span class="ruby-identifier">output</span> <span class="ruby-identifier">do_unfold</span> <span class="ruby-identifier">input</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">else</span> <span class="ruby-ivar">@output</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">do_unfold</span> <span class="ruby-identifier">input</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">string</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-blank" class="method-detail "> <div class="method-heading"> <span class="method-name">blank</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="blank-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 120</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>blank</span>
<span class="ruby-ivar">@blank_needed</span> = <span class="ruby-keyword">true</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-do_unfold" class="method-detail "> <div class="method-heading"> <span class="method-name">do_unfold</span><span class="method-args">(input)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="do_unfold-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 52</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>do_unfold</span>(<span class=“ruby-identifier”>input</span>)
<span class="ruby-ivar">@blank_needed</span> = <span class="ruby-keyword">false</span> <span class="ruby-identifier">first</span> = <span class="ruby-keyword">true</span> <span class="ruby-identifier">indent</span> = <span class="ruby-ivar">@indent_paragraph</span> <span class="ruby-operator">?</span> <span class="ruby-constant">ZSPACE</span> <span class="ruby-operator">:</span> <span class="ruby-string">''</span> <span class="ruby-identifier">f</span> = <span class="ruby-constant">LineInput</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">input</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-identifier">raise</span> <span class="ruby-node">"must not happen: input includes preproc directive: #{line.inspect}"</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A=/</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">first</span> <span class="ruby-identifier">first</span> = <span class="ruby-keyword">false</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">blank</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">line</span> <span class="ruby-comment"># blank</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A\s+\*/</span> <span class="ruby-identifier">blank</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">skip_block</span> <span class="ruby-identifier">f</span>, <span class="ruby-regexp">/\A\s+\*|\A\s+\S/</span> <span class="ruby-identifier">blank</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A\s+\d+\./</span> <span class="ruby-identifier">blank</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">skip_block</span> <span class="ruby-identifier">f</span>, <span class="ruby-regexp">/\A\s+\d+\.|\A\s+\S/</span> <span class="ruby-identifier">blank</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A:/</span> <span class="ruby-identifier">blank</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">skip_block</span> <span class="ruby-identifier">f</span>, <span class="ruby-regexp">/\A:|\A\s+\S/</span> <span class="ruby-identifier">blank</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">%r<\A//\w.*\{\s*\z></span> <span class="ruby-identifier">blank</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">until_terminator</span>(<span class="ruby-regexp">%r<\A//\}></span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">s</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">println</span> <span class="ruby-string">'//}'</span> <span class="ruby-identifier">blank</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">%r<\A//\w></span> <span class="ruby-identifier">blank</span> <span class="ruby-identifier">println</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">blank</span> <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A\S/</span> <span class="ruby-keyword">if</span> <span class="ruby-regexp">%r<\A//\[></span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"warning: #{f.path}:#{f.lineno}: paragraph begin with `//['; missing ReVIEW directive name?"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">flush_blank</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">indent</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">rstrip</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">until_match</span>(<span class="ruby-regexp">%r<\A\s*\z|\A//\w></span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">print</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">rstrip</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">puts</span> <span class="ruby-keyword">else</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">WrongInput</span>, <span class="ruby-node">"#{f.path}:#{f.lineno}: wrong input: #{line.inspect}"</span> <span class="ruby-keyword">end</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-flush_blank" class="method-detail "> <div class="method-heading"> <span class="method-name">flush_blank</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="flush_blank-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 129</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>flush_blank</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@blank_needed</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@blank_needed</span> = <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-println" class="method-detail "> <div class="method-heading"> <span class="method-name">println</span><span class="method-args">(s)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="println-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 124</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>println</span>(<span class=“ruby-identifier”>s</span>)
<span class="ruby-identifier">flush_blank</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">rstrip</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-skip_block" class="method-detail "> <div class="method-heading"> <span class="method-name">skip_block</span><span class="method-args">(f, re)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="skip_block-source"> <pre><span class="ruby-comment"># File lib/review/unfold.rb, line 114</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>skip_block</span>(<span class=“ruby-identifier”>f</span>, <span class=“ruby-identifier”>re</span>)
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">while_match</span>(<span class="ruby-identifier">re</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-ivar">@output</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">rstrip</span> <span class="ruby-keyword">end</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>