<!DOCTYPE html>

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

<title>class ReVIEW::TOCParser - 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-chapter_node">::chapter_node</a>

  <li ><a href="#method-c-parse">::parse</a>

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

  <li ><a href="#method-i-error-21">#error!</a>

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

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

</ul>

</div>

</div>

</nav>

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

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

<section class="description">

</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-chapter_node" class="method-detail ">

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

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

      </div>

      <div class="method-description">

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

<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>TOCParser</span>.<span class=“ruby-identifier”>chapter_node</span>(<span class=“ruby-identifier”>chap</span>)

<span class="ruby-identifier">toc</span> = <span class="ruby-constant">TOCParser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">chap</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">toc</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
  <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;warning: chapter #{toc.join} contains more than 1 chapter&quot;</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">toc</span>.<span class="ruby-identifier">first</span>

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

    </div>

  </div>

</div>

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

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

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

  </div>

  <div class="method-description">

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

<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>TOCParser</span>.<span class=“ruby-identifier”>parse</span>(<span class=“ruby-identifier”>chap</span>)

<span class="ruby-identifier">f</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">chap</span>.<span class="ruby-identifier">content</span>, <span class="ruby-string">&#39;r:BOM|utf-8&#39;</span>)
<span class="ruby-identifier">stream</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-identifier">f</span>)
<span class="ruby-identifier">new</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">stream</span>, <span class="ruby-identifier">chap</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">root</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">root</span>.<span class="ruby-identifier">number</span> = <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">number</span>
  <span class="ruby-identifier">root</span>
<span class="ruby-keyword">end</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-compile_label" class="method-detail ">

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

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

<span class="ruby-identifier">b</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">TEXTBuilder</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">dummy_book</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Book</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">load</span>
<span class="ruby-identifier">dummy_chapter</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Book</span><span class="ruby-operator">::</span><span class="ruby-constant">Chapter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">dummy_book</span>, <span class="ruby-value">1</span>, <span class="ruby-string">&#39;-&#39;</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>)
<span class="ruby-identifier">dummy_loc</span> = <span class="ruby-constant">Location</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&quot;&quot;</span>, <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>)
<span class="ruby-identifier">b</span>.<span class="ruby-identifier">bind</span>(<span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Compiler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">b</span>), <span class="ruby-identifier">dummy_chapter</span>, <span class="ruby-identifier">dummy_loc</span>)
<span class="ruby-identifier">b</span>.<span class="ruby-identifier">compile_inline</span>(<span class="ruby-identifier">line</span>)

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

    </div>

  </div>

</div>

<div id="method-i-error-21" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">error!</span><span
      class="method-args">(filename, lineno, msg)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="error-21-source">
      <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 116</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>error!</span>(<span class=“ruby-identifier”>filename</span>, <span class=“ruby-identifier”>lineno</span>, <span class=“ruby-identifier”>msg</span>)

<span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;#{filename}:#{lineno}: #{msg}&quot;</span>

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

    </div>

  </div>

</div>

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

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

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

<span class="ruby-identifier">line</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\A=+\s*/</span>, <span class="ruby-string">&#39;&#39;</span>)
<span class="ruby-identifier">compile_label</span>(<span class="ruby-identifier">line</span>)

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

    </div>

  </div>

</div>

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

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

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

  </div>

  <div class="method-description">

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

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

<span class="ruby-identifier">roots</span> = [] <span class="ruby-comment">## list of chapters</span>
<span class="ruby-identifier">node_stack</span> = []
<span class="ruby-identifier">filename</span> = <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">path</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-comment"># do nothing</span>
  <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A\s*\z/</span>
    <span class="ruby-comment"># do nothing</span>
  <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A(={2,})[\[\s\{]/</span>
    <span class="ruby-identifier">lev</span> = <span class="ruby-node">$1</span>.<span class="ruby-identifier">size</span>
    <span class="ruby-identifier">error!</span> <span class="ruby-identifier">filename</span>, <span class="ruby-identifier">f</span>.<span class="ruby-identifier">lineno</span>, <span class="ruby-node">&quot;section level too deep: #{lev}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">lev</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">5</span>
    <span class="ruby-identifier">label</span> = <span class="ruby-identifier">get_label</span>(<span class="ruby-identifier">line</span>)
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">empty?</span>
      <span class="ruby-comment"># missing chapter label</span>
      <span class="ruby-identifier">dummy_chapter</span> = <span class="ruby-constant">Chapter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">label</span>, <span class="ruby-identifier">chap</span>)
      <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">dummy_chapter</span>
      <span class="ruby-identifier">roots</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">dummy_chapter</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">label</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A\[\//</span> <span class="ruby-comment"># ex) &quot;[/column]&quot;</span>
    <span class="ruby-identifier">sec</span> = <span class="ruby-constant">Section</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">lev</span>, <span class="ruby-identifier">label</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\A\{.*?\}\s?/</span>, <span class="ruby-string">&quot;&quot;</span>))
    <span class="ruby-keyword">until</span> <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">level</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">level</span>
      <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">pop</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">add_child</span> <span class="ruby-identifier">sec</span>
    <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">sec</span>

  <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A=[^=]/</span>
    <span class="ruby-identifier">label</span> = <span class="ruby-identifier">get_label</span>(<span class="ruby-identifier">line</span>)
    <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">clear</span>
    <span class="ruby-identifier">new_chapter</span> = <span class="ruby-constant">Chapter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">label</span>, <span class="ruby-identifier">chap</span>)
    <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">new_chapter</span>
    <span class="ruby-identifier">roots</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">new_chapter</span>

  <span class="ruby-keyword">when</span> <span class="ruby-regexp">%r&lt;\A//\w+(?:\[.*?\])*\{\s*\z&gt;</span>
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">empty?</span>
      <span class="ruby-identifier">error!</span> <span class="ruby-identifier">filename</span>, <span class="ruby-identifier">f</span>.<span class="ruby-identifier">lineno</span>, <span class="ruby-string">&#39;list found before section label&#39;</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">add_child</span>(<span class="ruby-identifier">list</span> = <span class="ruby-constant">List</span>.<span class="ruby-identifier">new</span>)
    <span class="ruby-identifier">beg</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">lineno</span>
    <span class="ruby-identifier">list</span>.<span class="ruby-identifier">add</span> <span class="ruby-identifier">line</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">break</span> <span class="ruby-keyword">if</span> <span class="ruby-regexp">%r&lt;\A//\}&gt;</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>
      <span class="ruby-identifier">list</span>.<span class="ruby-identifier">add</span> <span class="ruby-identifier">line</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">error!</span> <span class="ruby-identifier">filename</span>, <span class="ruby-identifier">beg</span>, <span class="ruby-string">&#39;unterminated list&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">line</span>

  <span class="ruby-keyword">when</span> <span class="ruby-regexp">%r&lt;\A//\w&gt;</span>
    <span class="ruby-comment"># do nothing</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-comment">#if node_stack.empty?</span>
    <span class="ruby-comment">#  error! filename, f.lineno, &#39;text found before section label&#39;</span>
    <span class="ruby-comment">#end</span>
    <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">empty?</span>
    <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">add_child</span>(<span class="ruby-identifier">par</span> = <span class="ruby-constant">Paragraph</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">chap</span>))
    <span class="ruby-identifier">par</span>.<span class="ruby-identifier">add</span> <span class="ruby-identifier">line</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">break</span> <span class="ruby-keyword">if</span> <span class="ruby-regexp">/\A\s*\z/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span>
      <span class="ruby-identifier">par</span>.<span class="ruby-identifier">add</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>

<span class="ruby-identifier">roots</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>