taskjuggler 0.0.3 → 0.0.4

data/doc/classes/TaskJuggler/TextParser.html

@@ -53,9 +53,9 @@
             <td>
 
 
-                <a href="../../files/lib/TextParser/StackElement_rb.html">
+                <a href="../../files/lib/TextParser_rb.html">
 
-                lib/TextParser/StackElement.rb
+                lib/TextParser.rb
 
                 </a>
 
@@ -63,9 +63,9 @@
         <br />
 
 
-                <a href="../../files/lib/TextParser/TokenDoc_rb.html">
+                <a href="../../files/lib/TextParser/Pattern_rb.html">
 
-                lib/TextParser/TokenDoc.rb
+                lib/TextParser/Pattern.rb
 
                 </a>
 
@@ -83,9 +83,9 @@
         <br />
 
 
-                <a href="../../files/lib/TextParser/Pattern_rb.html">
+                <a href="../../files/lib/TextParser/TokenDoc_rb.html">
 
-                lib/TextParser/Pattern.rb
+                lib/TextParser/TokenDoc.rb
 
                 </a>
 
@@ -93,9 +93,9 @@
         <br />
 
 
-                <a href="../../files/lib/TextParser_rb.html">
+                <a href="../../files/lib/TextParser/StackElement_rb.html">
 
-                lib/TextParser.rb
+                lib/TextParser/StackElement.rb
 
                 </a>
 
@@ -129,36 +129,17 @@
 
     <div id="description">
       <p>
-The <a href="TextParser.html">TextParser</a> implements a regular LALR
-parser. But it uses a recursive rule traversor instead of the more commonly
-found state machine generated by yacc-like tools. Since stack depths is not
-really an issue with a Ruby implementation this approach has one big
-advantage. The syntax of the parser can be modified during parsing. This
-allows support for languages that can extend themself. The <a
-href="../TaskJuggler.html">TaskJuggler</a> syntax is such an beast.
-Traditional yacc generated parsers would fail with such a syntax.
-</p>
-<p>
-This class is just a base class. A complete parser would derive from this
-class and implement the rule set and the functions _nextToken()_ and
-_returnToken()_. It also needs to set the array <em>variables</em> to
-declare all variables ($SOMENAME) that the scanner may deliver.
+encoding: UTF-8
 </p>
+<h1>StackElement.rb &#8212; The <a href="../TaskJuggler.html">TaskJuggler</a> III <a href="Project.html">Project</a> Management Software</h1>
 <p>
-To describe the syntax the functions <a
-href="TextParser.html#M000241">TextParser#pattern</a>, <a
-href="TextParser.html#M000242">TextParser#optional</a> and <a
-href="TextParser.html#M000243">TextParser#repeatable</a> can be used. When
-the rule set is changed during parsing, <a
-href="TextParser.html#M000244">TextParser#updateParserTables</a> must be
-called to make the changes effective. The parser can also document the
-syntax automatically. To document a pattern, the functions TextParser#doc,
-TextParser#descr, TextParser#also and TextParser#arg can be used.
+Copyright &#169; 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger
+<cs@kde.org>
 </p>
 <p>
-To start parsing the input the function <a
-href="TextParser.html#M000245">TextParser#parse</a> needs to be called with
-the name of the start rule.
+This program is free software; you can redistribute it and/or modify it
+under the terms of version 2 of the GNU General Public License as published
+by the Free Software Foundation.
 </p>
 
     </div>
@@ -171,29 +152,31 @@ the name of the start rule.
 
       <div class="name-list">
 
-        <a href="#M000248">error</a>&nbsp;&nbsp;
+        <a href="#M000543">error</a>&nbsp;&nbsp;
 
-        <a href="#M000239">initRules</a>&nbsp;&nbsp;
+        <a href="#M000534">initRules</a>&nbsp;&nbsp;
 
-        <a href="#M000247">matchingRules</a>&nbsp;&nbsp;
+        <a href="#M000533">limitTokenSet</a>&nbsp;&nbsp;
 
-        <a href="#M000238">new</a>&nbsp;&nbsp;
+        <a href="#M000542">matchingRules</a>&nbsp;&nbsp;
 
-        <a href="#M000240">newRule</a>&nbsp;&nbsp;
+        <a href="#M000532">new</a>&nbsp;&nbsp;
 
-        <a href="#M000242">optional</a>&nbsp;&nbsp;
+        <a href="#M000535">newRule</a>&nbsp;&nbsp;
 
-        <a href="#M000245">parse</a>&nbsp;&nbsp;
+        <a href="#M000537">optional</a>&nbsp;&nbsp;
 
-        <a href="#M000241">pattern</a>&nbsp;&nbsp;
+        <a href="#M000540">parse</a>&nbsp;&nbsp;
 
-        <a href="#M000243">repeatable</a>&nbsp;&nbsp;
+        <a href="#M000536">pattern</a>&nbsp;&nbsp;
 
-        <a href="#M000246">sourceFileInfo</a>&nbsp;&nbsp;
+        <a href="#M000538">repeatable</a>&nbsp;&nbsp;
 
-        <a href="#M000244">updateParserTables</a>&nbsp;&nbsp;
+        <a href="#M000541">sourceFileInfo</a>&nbsp;&nbsp;
 
-        <a href="#M000249">warning</a>&nbsp;&nbsp;
+        <a href="#M000539">updateParserTables</a>&nbsp;&nbsp;
+
+        <a href="#M000544">warning</a>&nbsp;&nbsp;
 
       </div>
     </div>
@@ -243,12 +226,12 @@ Class <a href="TextParser/TokenDoc.html" class="link">TaskJuggler::TextParser::T
       <h3 class="section-bar">Public Class methods</h3>
 
 
-      <div id="method-M000238" class="method-detail">
-        <a name="M000238"></a>
+      <div id="method-M000532" class="method-detail">
+        <a name="M000532"></a>
 
         <div class="method-heading">
 
-          <a href="#M000238" class="method-signature">
+          <a href="#M000532" class="method-signature">
 
           <span class="method-name">new</span><span class="method-args">()</span>
 
@@ -263,18 +246,18 @@ Create a new <a href="TextParser.html">TextParser</a> object.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000238-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000238-source">
+            onclick="toggleCode('M000532-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000532-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 70</span>
 70:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
 71:       <span class="ruby-ivar">@rules</span> = { }
 72:       <span class="ruby-comment cmt"># Array to hold the token types that the scanner can return.</span>
 73:       <span class="ruby-ivar">@variables</span> = []
-74:       <span class="ruby-comment cmt"># The currently processed rule.</span>
-75:       <span class="ruby-ivar">@cr</span> = <span class="ruby-keyword kw">nil</span>
-76:       <span class="ruby-comment cmt"># If set to a value larger than 0 debug output will be generated.</span>
-77:       <span class="ruby-ivar">@@debug</span> = <span class="ruby-value">30</span>
+74:       <span class="ruby-comment cmt"># An list of token types that are not allowed in the current context.</span>
+75:       <span class="ruby-ivar">@badVariables</span> = []
+76:       <span class="ruby-comment cmt"># The currently processed rule.</span>
+77:       <span class="ruby-ivar">@cr</span> = <span class="ruby-keyword kw">nil</span>
 78:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
@@ -286,12 +269,12 @@ Create a new <a href="TextParser.html">TextParser</a> object.
       <h3 class="section-bar">Public Instance methods</h3>
 
 
-      <div id="method-M000248" class="method-detail">
-        <a name="M000248"></a>
+      <div id="method-M000543" class="method-detail">
+        <a name="M000543"></a>
 
         <div class="method-heading">
 
-          <a href="#M000248" class="method-signature">
+          <a href="#M000543" class="method-signature">
 
           <span class="method-name">error</span><span class="method-args">(id, text, property = nil)</span>
 
@@ -302,13 +285,13 @@ Create a new <a href="TextParser.html">TextParser</a> object.
         <div class="method-description">
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000248-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000248-source">
+            onclick="toggleCode('M000543-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000543-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 181</span>
-181:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>)
-182:       <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span>)
-183:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 190</span>
+190:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>)
+191:       <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span>)
+192:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -316,12 +299,12 @@ Create a new <a href="TextParser.html">TextParser</a> object.
       </div>
 
 
-      <div id="method-M000239" class="method-detail">
-        <a name="M000239"></a>
+      <div id="method-M000534" class="method-detail">
+        <a name="M000534"></a>
 
         <div class="method-heading">
 
-          <a href="#M000239" class="method-signature">
+          <a href="#M000534" class="method-signature">
 
           <span class="method-name">initRules</span><span class="method-args">()</span>
 
@@ -337,20 +320,58 @@ rules.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000239-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000239-source">
+            onclick="toggleCode('M000534-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000534-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/TextParser.rb, line 90</span>
+90:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initRules</span>
+91:       <span class="ruby-identifier">methods</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
+92:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">m</span>[<span class="ruby-value">0</span>, <span class="ruby-value">5</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">'rule_'</span>
+93:           <span class="ruby-comment cmt"># Create a new rule with the suffix of the function name as name.</span>
+94:           <span class="ruby-identifier">newRule</span>(<span class="ruby-identifier">m</span>[<span class="ruby-value">5</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>])
+95:           <span class="ruby-comment cmt"># Call the function.</span>
+96:           <span class="ruby-identifier">send</span>(<span class="ruby-identifier">m</span>)
+97:         <span class="ruby-keyword kw">end</span>
+98:       <span class="ruby-keyword kw">end</span>
+99:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+
+        </div>
+      </div>
+
+
+      <div id="method-M000533" class="method-detail">
+        <a name="M000533"></a>
+
+        <div class="method-heading">
+
+          <a href="#M000533" class="method-signature">
+
+          <span class="method-name">limitTokenSet</span><span class="method-args">(tokenSet)</span>
+
+          </a>
+
+        </div>
+
+        <div class="method-description">
+
+          <p>
+Limit the allowed tokens of the scanner to the subset passed by the
+<em>tokenSet</em> Array.
+</p>
+
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000533-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000533-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser.rb, line 81</span>
-81:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initRules</span>
-82:       <span class="ruby-identifier">methods</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
-83:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">m</span>[<span class="ruby-value">0</span>, <span class="ruby-value">5</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">'rule_'</span>
-84:           <span class="ruby-comment cmt"># Create a new rule with the suffix of the function name as name.</span>
-85:           <span class="ruby-identifier">newRule</span>(<span class="ruby-identifier">m</span>[<span class="ruby-value">5</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>])
-86:           <span class="ruby-comment cmt"># Call the function.</span>
-87:           <span class="ruby-identifier">send</span>(<span class="ruby-identifier">m</span>)
-88:         <span class="ruby-keyword kw">end</span>
-89:       <span class="ruby-keyword kw">end</span>
-90:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/TextParser.rb, line 82</span>
+82:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">limitTokenSet</span>(<span class="ruby-identifier">tokenSet</span>)
+83:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">tokenSet</span>
+84: 
+85:       <span class="ruby-ivar">@badVariables</span> = <span class="ruby-ivar">@variables</span>.<span class="ruby-identifier">dup</span>
+86:       <span class="ruby-ivar">@badVariables</span>.<span class="ruby-identifier">delete_if</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">tokenSet</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">v</span>) }
+87:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -358,12 +379,12 @@ rules.
       </div>
 
 
-      <div id="method-M000247" class="method-detail">
-        <a name="M000247"></a>
+      <div id="method-M000542" class="method-detail">
+        <a name="M000542"></a>
 
         <div class="method-heading">
 
-          <a href="#M000247" class="method-signature">
+          <a href="#M000542" class="method-signature">
 
           <span class="method-name">matchingRules</span><span class="method-args">(keyword)</span>
 
@@ -374,18 +395,18 @@ rules.
         <div class="method-description">
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000247-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000247-source">
+            onclick="toggleCode('M000542-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000542-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 172</span>
-172:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">matchingRules</span>(<span class="ruby-identifier">keyword</span>)
-173:       <span class="ruby-identifier">matches</span> = []
-174:       <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
-175:         <span class="ruby-identifier">patIdx</span> = <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">matchingPatternIndex</span>(<span class="ruby-value str">'_'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">keyword</span>)
-176:         <span class="ruby-identifier">matches</span> <span class="ruby-operator">&lt;&lt;</span> [ <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">patIdx</span> ] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">patIdx</span>
-177:       <span class="ruby-keyword kw">end</span>
-178:       <span class="ruby-identifier">matches</span>
-179:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 181</span>
+181:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">matchingRules</span>(<span class="ruby-identifier">keyword</span>)
+182:       <span class="ruby-identifier">matches</span> = []
+183:       <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
+184:         <span class="ruby-identifier">patIdx</span> = <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">matchingPatternIndex</span>(<span class="ruby-value str">'_'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">keyword</span>)
+185:         <span class="ruby-identifier">matches</span> <span class="ruby-operator">&lt;&lt;</span> [ <span class="ruby-identifier">rule</span>, <span class="ruby-identifier">patIdx</span> ] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">patIdx</span>
+186:       <span class="ruby-keyword kw">end</span>
+187:       <span class="ruby-identifier">matches</span>
+188:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -393,12 +414,12 @@ rules.
       </div>
 
 
-      <div id="method-M000240" class="method-detail">
-        <a name="M000240"></a>
+      <div id="method-M000535" class="method-detail">
+        <a name="M000535"></a>
 
         <div class="method-heading">
 
-          <a href="#M000240" class="method-signature">
+          <a href="#M000535" class="method-signature">
 
           <span class="method-name">newRule</span><span class="method-args">(name) {|| ...}</span>
 
@@ -411,29 +432,29 @@ rules.
           <p>
 Add a new rule to the rule set. <em>name</em> must be a unique identifier.
 The function also sets the class variable @cr to the new rule. Subsequent
-calls to <a href="TextParser.html#M000241">TextParser#pattern</a>, <a
-href="TextParser.html#M000242">TextParser#optional</a> or <a
-href="TextParser.html#M000243">TextParser#repeatable</a> will then
+calls to <a href="TextParser.html#M000536">TextParser#pattern</a>, <a
+href="TextParser.html#M000537">TextParser#optional</a> or <a
+href="TextParser.html#M000538">TextParser#repeatable</a> will then
 implicitely operate on the most recently added rule.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000240-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000240-source">
+            onclick="toggleCode('M000535-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000535-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 97</span>
- 97:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newRule</span>(<span class="ruby-identifier">name</span>)
- 98:       <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Fatal Error: Rule #{name} already exists&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>)
- 99: 
-100:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-101:         <span class="ruby-identifier">saveCr</span> = <span class="ruby-ivar">@cr</span>
-102:         <span class="ruby-ivar">@rules</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-ivar">@cr</span> = <span class="ruby-constant">TextParser</span><span class="ruby-operator">::</span><span class="ruby-constant">Rule</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>)
-103:         <span class="ruby-keyword kw">yield</span>
-104:         <span class="ruby-ivar">@cr</span> = <span class="ruby-identifier">saveCr</span>
-105:       <span class="ruby-keyword kw">else</span>
-106:         <span class="ruby-ivar">@rules</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-ivar">@cr</span> = <span class="ruby-constant">TextParser</span><span class="ruby-operator">::</span><span class="ruby-constant">Rule</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>)
-107:       <span class="ruby-keyword kw">end</span>
-108:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 106</span>
+106:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">newRule</span>(<span class="ruby-identifier">name</span>)
+107:       <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Fatal Error: Rule #{name} already exists&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>)
+108: 
+109:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+110:         <span class="ruby-identifier">saveCr</span> = <span class="ruby-ivar">@cr</span>
+111:         <span class="ruby-ivar">@rules</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-ivar">@cr</span> = <span class="ruby-constant">TextParser</span><span class="ruby-operator">::</span><span class="ruby-constant">Rule</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>)
+112:         <span class="ruby-keyword kw">yield</span>
+113:         <span class="ruby-ivar">@cr</span> = <span class="ruby-identifier">saveCr</span>
+114:       <span class="ruby-keyword kw">else</span>
+115:         <span class="ruby-ivar">@rules</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-ivar">@cr</span> = <span class="ruby-constant">TextParser</span><span class="ruby-operator">::</span><span class="ruby-constant">Rule</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>)
+116:       <span class="ruby-keyword kw">end</span>
+117:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -441,12 +462,12 @@ implicitely operate on the most recently added rule.
       </div>
 
 
-      <div id="method-M000242" class="method-detail">
-        <a name="M000242"></a>
+      <div id="method-M000537" class="method-detail">
+        <a name="M000537"></a>
 
         <div class="method-heading">
 
-          <a href="#M000242" class="method-signature">
+          <a href="#M000537" class="method-signature">
 
           <span class="method-name">optional</span><span class="method-args">()</span>
 
@@ -462,13 +483,13 @@ elements.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000242-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000242-source">
+            onclick="toggleCode('M000537-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000537-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 127</span>
-127:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">optional</span>
-128:       <span class="ruby-ivar">@cr</span>.<span class="ruby-identifier">setOptional</span>
-129:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 136</span>
+136:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">optional</span>
+137:       <span class="ruby-ivar">@cr</span>.<span class="ruby-identifier">setOptional</span>
+138:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -476,12 +497,12 @@ elements.
       </div>
 
 
-      <div id="method-M000245" class="method-detail">
-        <a name="M000245"></a>
+      <div id="method-M000540" class="method-detail">
+        <a name="M000540"></a>
 
         <div class="method-heading">
 
-          <a href="#M000245" class="method-signature">
+          <a href="#M000540" class="method-signature">
 
           <span class="method-name">parse</span><span class="method-args">(ruleName)</span>
 
@@ -498,23 +519,23 @@ top-level parser rule that was specified by <em>ruleName</em>.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000245-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000245-source">
+            onclick="toggleCode('M000540-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000540-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 150</span>
-150:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">ruleName</span>)
-151:       <span class="ruby-ivar">@stack</span> = []
-152:       <span class="ruby-ivar">@@expectedTokens</span> = []
-153:       <span class="ruby-identifier">updateParserTables</span>
-154:       <span class="ruby-keyword kw">begin</span>
-155:         <span class="ruby-identifier">result</span> = <span class="ruby-identifier">parseRule</span>(<span class="ruby-ivar">@rules</span>[<span class="ruby-identifier">ruleName</span>])
-156:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">TjException</span>
-157:         <span class="ruby-comment cmt"># error('parse_error', $!.message)</span>
-158:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
-159:       <span class="ruby-keyword kw">end</span>
-160: 
-161:       <span class="ruby-identifier">result</span>
-162:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 159</span>
+159:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">ruleName</span>)
+160:       <span class="ruby-ivar">@stack</span> = []
+161:       <span class="ruby-ivar">@@expectedTokens</span> = []
+162:       <span class="ruby-identifier">updateParserTables</span>
+163:       <span class="ruby-keyword kw">begin</span>
+164:         <span class="ruby-identifier">result</span> = <span class="ruby-identifier">parseRule</span>(<span class="ruby-ivar">@rules</span>[<span class="ruby-identifier">ruleName</span>])
+165:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">TjException</span>
+166:         <span class="ruby-comment cmt"># error('parse_error', $!.message)</span>
+167:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+168:       <span class="ruby-keyword kw">end</span>
+169: 
+170:       <span class="ruby-identifier">result</span>
+171:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -522,12 +543,12 @@ top-level parser rule that was specified by <em>ruleName</em>.
       </div>
 
 
-      <div id="method-M000241" class="method-detail">
-        <a name="M000241"></a>
+      <div id="method-M000536" class="method-detail">
+        <a name="M000536"></a>
 
         <div class="method-heading">
 
-          <a href="#M000241" class="method-signature">
+          <a href="#M000536" class="method-signature">
 
           <span class="method-name">pattern</span><span class="method-args">(tokens, func = nil)</span>
 
@@ -560,13 +581,13 @@ completed the processing of this rule.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000241-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000241-source">
+            onclick="toggleCode('M000536-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000536-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 121</span>
-121:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pattern</span>(<span class="ruby-identifier">tokens</span>, <span class="ruby-identifier">func</span> = <span class="ruby-keyword kw">nil</span>)
-122:       <span class="ruby-ivar">@cr</span>.<span class="ruby-identifier">addPattern</span>(<span class="ruby-constant">TextParser</span><span class="ruby-operator">::</span><span class="ruby-constant">Pattern</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tokens</span>, <span class="ruby-identifier">func</span>))
-123:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 130</span>
+130:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pattern</span>(<span class="ruby-identifier">tokens</span>, <span class="ruby-identifier">func</span> = <span class="ruby-keyword kw">nil</span>)
+131:       <span class="ruby-ivar">@cr</span>.<span class="ruby-identifier">addPattern</span>(<span class="ruby-constant">TextParser</span><span class="ruby-operator">::</span><span class="ruby-constant">Pattern</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tokens</span>, <span class="ruby-identifier">func</span>))
+132:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -574,12 +595,12 @@ completed the processing of this rule.
       </div>
 
 
-      <div id="method-M000243" class="method-detail">
-        <a name="M000243"></a>
+      <div id="method-M000538" class="method-detail">
+        <a name="M000538"></a>
 
         <div class="method-heading">
 
-          <a href="#M000243" class="method-signature">
+          <a href="#M000538" class="method-signature">
 
           <span class="method-name">repeatable</span><span class="method-args">()</span>
 
@@ -595,13 +616,13 @@ elements.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000243-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000243-source">
+            onclick="toggleCode('M000538-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000538-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 133</span>
-133:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repeatable</span>
-134:       <span class="ruby-ivar">@cr</span>.<span class="ruby-identifier">setRepeatable</span>
-135:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 142</span>
+142:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">repeatable</span>
+143:       <span class="ruby-ivar">@cr</span>.<span class="ruby-identifier">setRepeatable</span>
+144:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -609,12 +630,12 @@ elements.
       </div>
 
 
-      <div id="method-M000246" class="method-detail">
-        <a name="M000246"></a>
+      <div id="method-M000541" class="method-detail">
+        <a name="M000541"></a>
 
         <div class="method-heading">
 
-          <a href="#M000246" class="method-signature">
+          <a href="#M000541" class="method-signature">
 
           <span class="method-name">sourceFileInfo</span><span class="method-args">()</span>
 
@@ -632,14 +653,14 @@ nil if we don&#8217;t have a current position.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000246-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000246-source">
+            onclick="toggleCode('M000541-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000541-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 167</span>
-167:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sourceFileInfo</span>
-168:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">empty?</span>
-169:       <span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">sourceFileInfo</span>
-170:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 176</span>
+176:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sourceFileInfo</span>
+177:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">empty?</span>
+178:       <span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">sourceFileInfo</span>
+179:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -647,12 +668,12 @@ nil if we don&#8217;t have a current position.
       </div>
 
 
-      <div id="method-M000244" class="method-detail">
-        <a name="M000244"></a>
+      <div id="method-M000539" class="method-detail">
+        <a name="M000539"></a>
 
         <div class="method-heading">
 
-          <a href="#M000244" class="method-signature">
+          <a href="#M000539" class="method-signature">
 
           <span class="method-name">updateParserTables</span><span class="method-args">()</span>
 
@@ -665,21 +686,21 @@ nil if we don&#8217;t have a current position.
           <p>
 This function needs to be called whenever new rules or patterns have been
 added and before the next call to <a
-href="TextParser.html#M000245">TextParser#parse</a>.
+href="TextParser.html#M000540">TextParser#parse</a>.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000244-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000244-source">
+            onclick="toggleCode('M000539-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000539-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 139</span>
-139:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updateParserTables</span>
-140:       <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">rule</span><span class="ruby-operator">|</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">transitions</span> = {} }
-141:       <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
-142:         <span class="ruby-identifier">getTransitions</span>(<span class="ruby-identifier">rule</span>)
-143:         <span class="ruby-identifier">checkRule</span>(<span class="ruby-identifier">rule</span>)
-144:       <span class="ruby-keyword kw">end</span>
-145:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 148</span>
+148:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">updateParserTables</span>
+149:       <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">rule</span><span class="ruby-operator">|</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">transitions</span> = {} }
+150:       <span class="ruby-ivar">@rules</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
+151:         <span class="ruby-identifier">getTransitions</span>(<span class="ruby-identifier">rule</span>)
+152:         <span class="ruby-identifier">checkRule</span>(<span class="ruby-identifier">rule</span>)
+153:       <span class="ruby-keyword kw">end</span>
+154:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -687,12 +708,12 @@ href="TextParser.html#M000245">TextParser#parse</a>.
       </div>
 
 
-      <div id="method-M000249" class="method-detail">
-        <a name="M000249"></a>
+      <div id="method-M000544" class="method-detail">
+        <a name="M000544"></a>
 
         <div class="method-heading">
 
-          <a href="#M000249" class="method-signature">
+          <a href="#M000544" class="method-signature">
 
           <span class="method-name">warning</span><span class="method-args">(id, text, property = nil)</span>
 
@@ -703,13 +724,13 @@ href="TextParser.html#M000245">TextParser#parse</a>.
         <div class="method-description">
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000249-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000249-source">
+            onclick="toggleCode('M000544-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000544-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 185</span>
-185:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warning</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>)
-186:       <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">warning</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span>)
-187:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/TextParser.rb, line 194</span>
+194:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warning</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span> = <span class="ruby-keyword kw">nil</span>)
+195:       <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">warning</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">text</span>, <span class="ruby-identifier">property</span>)
+196:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>