<!DOCTYPE html>

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

<title>class LineInput - 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-i-break">#break</a>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</ul>

</div>

</div>

</nav>

<main role=“main” aria-labelledby=“class-LineInput”>

<h1 id="class-LineInput" class="class">
  class LineInput
</h1>

<section class="description">

<p>$Id: lineinput.rb 2226 2006-04-15 03:05:09Z aamine $</p>

<p>Copyright © 2002-2005 Minero Aoki</p>

<p>This program is free software. You can distribute/modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1.</p>

</section>

<section id="5Buntitled-5D" class="documentation-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">(f)</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/lineinput.rb, line 13</span>

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

<span class="ruby-ivar">@input</span> = <span class="ruby-identifier">f</span>
<span class="ruby-ivar">@buf</span> = []
<span class="ruby-ivar">@lineno</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@eof_p</span> = <span class="ruby-keyword">false</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-break" class="method-detail method-alias">

    <div class="method-heading">
      <span class="method-name">break</span><span
        class="method-args">(re)</span>

    </div>

    <div class="method-description">

    </div>

    <div class="aliases">
      Alias for: <a href="LineInput.html#method-i-getlines_until">getlines_until</a>
    </div>

  </div>

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

    <div class="method-heading">
      <span class="method-name">each</span><span
        class="method-args">() { |line| ... }</span>

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

    </div>

    <div class="method-description">

      <div class="method-source-code" id="each-source">
        <pre><span class="ruby-comment"># File lib/lineinput.rb, line 91</span>

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

<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
  <span class="ruby-keyword">yield</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-eof-3F" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">eof?</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="eof-3F-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 24</span>

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

<span class="ruby-ivar">@eof_p</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">getblock</span><span
      class="method-args">(term_re)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="getblock-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 147</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>getblock</span>(<span class=“ruby-identifier”>term_re</span>)

<span class="ruby-identifier">buf</span> = []
<span class="ruby-identifier">until_terminator</span>(<span class="ruby-identifier">term_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-identifier">buf</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">buf</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">getlines_until</span><span
      class="method-args">(re)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="getlines_until-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 129</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>getlines_until</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-identifier">buf</span> = []
<span class="ruby-identifier">until_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-identifier">buf</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">buf</span>

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

    </div>

  </div>

  <div class="aliases">
    Also aliased as: <a href="LineInput.html#method-i-break">break</a>
  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">getlines_while</span><span
      class="method-args">(re)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="getlines_while-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 108</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>getlines_while</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-identifier">buf</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-identifier">buf</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">buf</span>

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

    </div>

  </div>

  <div class="aliases">
    Also aliased as: <a href="LineInput.html#method-i-span">span</a>
  </div>

</div>

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

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

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

<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">empty?</span>
  <span class="ruby-ivar">@lineno</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@eof_p</span> <span class="ruby-comment"># to avoid ARGF blocking.</span>
<span class="ruby-identifier">line</span> = <span class="ruby-ivar">@input</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-ivar">@eof_p</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">line</span>
<span class="ruby-ivar">@lineno</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-gets_if" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">gets_if</span><span
      class="method-args">(re)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="gets_if-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 73</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>gets_if</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">line</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">not</span> (<span class="ruby-identifier">re</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>)
  <span class="ruby-identifier">ungets</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">line</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">gets_unless</span><span
      class="method-args">(re)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="gets_unless-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 82</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>gets_unless</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">line</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">re</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>
  <span class="ruby-identifier">ungets</span> <span class="ruby-identifier">line</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">line</span>

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

    </div>

  </div>

</div>

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

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

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

<span class="ruby-node">&quot;\#&lt;#{self.class} file=#{@input.inspect} line=#{lineno()}&gt;&quot;</span>

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

    </div>

  </div>

</div>

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

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

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

<span class="ruby-ivar">@lineno</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">next?</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="next-3F-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 57</span>

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

<span class="ruby-identifier">peek</span>() <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>

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

    </div>

  </div>

</div>

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

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

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

<span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
<span class="ruby-identifier">ungets</span> <span class="ruby-identifier">line</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>
<span class="ruby-identifier">line</span>

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

    </div>

  </div>

</div>

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

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

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

<span class="ruby-identifier">n</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</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">ungets</span> <span class="ruby-identifier">line</span>
    <span class="ruby-keyword">return</span> <span class="ruby-identifier">n</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">n</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">n</span>

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

    </div>

  </div>

</div>

<div id="method-i-span" class="method-detail method-alias">

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

  </div>

  <div class="method-description">

  </div>

  <div class="aliases">
    Alias for: <a href="LineInput.html#method-i-getlines_while">getlines_while</a>
  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">ungets</span><span
      class="method-args">(line)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="ungets-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 44</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>ungets</span>(<span class=“ruby-identifier”>line</span>)

<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">line</span>
<span class="ruby-ivar">@lineno</span> <span class="ruby-operator">-=</span> <span class="ruby-value">1</span>
<span class="ruby-ivar">@buf</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">line</span>
<span class="ruby-identifier">line</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">until_match</span><span
      class="method-args">(re) { |line| ... }</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="until_match-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 118</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>until_match</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">re</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>
    <span class="ruby-identifier">ungets</span> <span class="ruby-identifier">line</span>
    <span class="ruby-keyword">return</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">yield</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">until_terminator</span><span
      class="method-args">(re) { |line| ... }</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="until_terminator-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 139</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>until_terminator</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">re</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span> <span class="ruby-comment"># discard terminal line</span>
  <span class="ruby-keyword">yield</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">while_match</span><span
      class="method-args">(re) { |line| ... }</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="while_match-source">
      <pre><span class="ruby-comment"># File lib/lineinput.rb, line 97</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>while_match</span>(<span class=“ruby-identifier”>re</span>)

<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">gets</span>()
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">re</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>
    <span class="ruby-identifier">ungets</span> <span class="ruby-identifier">line</span>
    <span class="ruby-keyword">return</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">yield</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</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="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.

</footer>