taskjuggler 0.0.7 → 0.0.8

data/doc/TaskJuggler/TextParser/Rule.html

@@ -73,9 +73,13 @@
 					
 					<li><a href="#method-i-addPattern">#addPattern</a></li>
 					
+					<li><a href="#method-i-addTransitionsToState">#addTransitionsToState</a></li>
+					
 					<li><a href="#method-i-dump">#dump</a></li>
 					
-					<li><a href="#method-i-matchingPatternIndex">#matchingPatternIndex</a></li>
+					<li><a href="#method-i-flushCache">#flushCache</a></li>
+					
+					<li><a href="#method-i-generateStates">#generateStates</a></li>
 					
 					<li><a href="#method-i-optional%3F">#optional?</a></li>
 					
@@ -175,12 +179,18 @@
 				
 					<li><a href="../../TaskJuggler/ChargeSetListAttribute.html">TaskJuggler::ChargeSetListAttribute</a></li>
 				
+					<li><a href="../../TaskJuggler/CollisionDetector.html">TaskJuggler::CollisionDetector</a></li>
+				
 					<li><a href="../../TaskJuggler/ColumnListAttribute.html">TaskJuggler::ColumnListAttribute</a></li>
 				
 					<li><a href="../../TaskJuggler/ColumnTable.html">TaskJuggler::ColumnTable</a></li>
 				
 					<li><a href="../../TaskJuggler/Daemon.html">TaskJuggler::Daemon</a></li>
 				
+					<li><a href="../../TaskJuggler/DataCache.html">TaskJuggler::DataCache</a></li>
+				
+					<li><a href="../../TaskJuggler/DataCacheEntry.html">TaskJuggler::DataCacheEntry</a></li>
+				
 					<li><a href="../../TaskJuggler/DateAttribute.html">TaskJuggler::DateAttribute</a></li>
 				
 					<li><a href="../../TaskJuggler/DefinitionListAttribute.html">TaskJuggler::DefinitionListAttribute</a></li>
@@ -287,7 +297,7 @@
 				
 					<li><a href="../../TaskJuggler/NodeListAttribute.html">TaskJuggler::NodeListAttribute</a></li>
 				
-					<li><a href="../../TaskJuggler/OnShiftCache.html">TaskJuggler::OnShiftCache</a></li>
+					<li><a href="../../TaskJuggler/PlaceHolderCell.html">TaskJuggler::PlaceHolderCell</a></li>
 				
 					<li><a href="../../TaskJuggler/ProcessIntercom.html">TaskJuggler::ProcessIntercom</a></li>
 				
@@ -467,6 +477,10 @@
 				
 					<li><a href="../../TaskJuggler/TextParser/StackElement.html">TaskJuggler::TextParser::StackElement</a></li>
 				
+					<li><a href="../../TaskJuggler/TextParser/State.html">TaskJuggler::TextParser::State</a></li>
+				
+					<li><a href="../../TaskJuggler/TextParser/StateTransition.html">TaskJuggler::TextParser::StateTransition</a></li>
+				
 					<li><a href="../../TaskJuggler/TextParser/TextParserResultArray.html">TaskJuggler::TextParser::TextParserResultArray</a></li>
 				
 					<li><a href="../../TaskJuggler/TextParser/TokenDoc.html">TaskJuggler::TextParser::TokenDoc</a></li>
@@ -684,23 +698,6 @@ the parsed file.
 				
 				
 				
-				</div>
-			</div>
-			
-			<div id="transitions-attribute-method" class="method-detail">
-				<a name="transitions"></a>
-				
-				<a name="transitions="></a>
-				
-				<div class="method-heading attribute-method-heading">
-					<span class="method-name">transitions</span><span
-						class="attribute-access-type">[RW]</span>
-				</div>
-
-				<div class="method-description">
-				
-				
-				
 				</div>
 			</div>
 			
@@ -735,18 +732,16 @@ Create a new syntax rule called <tt>name</tt>.
 					<div class="method-source-code"
 						id="new-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 31</span>
-31:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>)
-32:       <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
-33:       <span class="ruby-ivar">@patterns</span> = []
-34:       <span class="ruby-ivar">@repeatable</span> = <span class="ruby-keyword kw">false</span>
-35:       <span class="ruby-ivar">@optional</span> = <span class="ruby-keyword kw">false</span>
-36:       <span class="ruby-ivar">@transitions</span> = []
-37:       <span class="ruby-comment cmt"># In case a rule is optional or any of the patterns is fully optional,</span>
-38:       <span class="ruby-comment cmt"># this variable is set to true.</span>
-39:       <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">nil</span>
-40:       <span class="ruby-ivar">@keyword</span> = <span class="ruby-keyword kw">nil</span>
-41:     <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 32</span>
+32:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>)
+33:       <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
+34:       <span class="ruby-ivar">@patterns</span> = []
+35:       <span class="ruby-ivar">@repeatable</span> = <span class="ruby-keyword kw">false</span>
+36:       <span class="ruby-ivar">@optional</span> = <span class="ruby-keyword kw">false</span>
+37:       <span class="ruby-ivar">@keyword</span> = <span class="ruby-keyword kw">nil</span>
+38: 
+39:       <span class="ruby-identifier">flushCache</span>
+40:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -786,10 +781,51 @@ be of type <a href="Pattern.html">TextParser::Pattern</a>.
 					<div class="method-source-code"
 						id="add-attern-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 45</span>
-45:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addPattern</span>(<span class="ruby-identifier">pattern</span>)
-46:       <span class="ruby-ivar">@patterns</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">pattern</span>
-47:     <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 51</span>
+51:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addPattern</span>(<span class="ruby-identifier">pattern</span>)
+52:       <span class="ruby-ivar">@patterns</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">pattern</span>
+53:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="add-ransitions-o-tate-method" class="method-detail ">
+				<a name="method-i-addTransitionsToState"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">addTransitionsToState</span><span
+						class="method-args">(states, rules, stateStack, sourceState, loopBack)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+Return a Hash of all state transitions caused by the 1st token of each
+pattern of this rule.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="add-ransitions-o-tate-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 94</span>
+ 94:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">addTransitionsToState</span>(<span class="ruby-identifier">states</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">stateStack</span>, <span class="ruby-identifier">sourceState</span>,
+ 95:                               <span class="ruby-identifier">loopBack</span>)
+ 96:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pattern</span><span class="ruby-operator">|</span>
+ 97:         <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">addTransitionsToState</span>(<span class="ruby-identifier">states</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">stateStack</span>.<span class="ruby-identifier">dup</span>, <span class="ruby-identifier">sourceState</span>,
+ 98:                                       <span class="ruby-keyword kw">self</span>, <span class="ruby-value">0</span>, <span class="ruby-identifier">loopBack</span>)
+ 99:       <span class="ruby-keyword kw">end</span>
+100:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -820,28 +856,28 @@ be of type <a href="Pattern.html">TextParser::Pattern</a>.
 					<div class="method-source-code"
 						id="dump-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 154</span>
-154:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dump</span>
-155:       <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Rule: #{name} #{@optional ? &quot;[optional]&quot; : &quot;&quot;} &quot;</span> <span class="ruby-operator">+</span>
-156:            <span class="ruby-node">&quot;#{@repeatable ? &quot;[repeatable]&quot; : &quot;&quot;}&quot;</span>
-157:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">length</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-158:         <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;  Pattern: \&quot;#{@patterns[i]}\&quot;&quot;</span>
-159:         <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@transitions</span>[<span class="ruby-identifier">i</span>]
-160:           <span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;No transitions for this pattern!&quot;</span>
-161:           <span class="ruby-keyword kw">next</span>
-162:         <span class="ruby-keyword kw">end</span>
-163: 
-164:         <span class="ruby-ivar">@transitions</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
-165:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">key</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">__</span>
-166:             <span class="ruby-identifier">token</span> = <span class="ruby-value str">&quot;\&quot;&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;\&quot;&quot;</span>
-167:           <span class="ruby-keyword kw">else</span>
-168:             <span class="ruby-identifier">token</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
-169:           <span class="ruby-keyword kw">end</span>
-170:           <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;    #{token} -&gt; #{rule.name}&quot;</span>
-171:         <span class="ruby-keyword kw">end</span>
-172:       <span class="ruby-keyword kw">end</span>
-173:       <span class="ruby-identifier">puts</span>
-174:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 170</span>
+170:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dump</span>
+171:       <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Rule: #{name} #{@optional ? &quot;[optional]&quot; : &quot;&quot;} &quot;</span> <span class="ruby-operator">+</span>
+172:            <span class="ruby-node">&quot;#{@repeatable ? &quot;[repeatable]&quot; : &quot;&quot;}&quot;</span>
+173:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">length</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+174:         <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;  Pattern: \&quot;#{@patterns[i]}\&quot;&quot;</span>
+175:         <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@transitions</span>[<span class="ruby-identifier">i</span>]
+176:           <span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;No transitions for this pattern!&quot;</span>
+177:           <span class="ruby-keyword kw">next</span>
+178:         <span class="ruby-keyword kw">end</span>
+179: 
+180:         <span class="ruby-ivar">@transitions</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">rule</span><span class="ruby-operator">|</span>
+181:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">key</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">__</span>
+182:             <span class="ruby-identifier">token</span> = <span class="ruby-value str">&quot;\&quot;&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;\&quot;&quot;</span>
+183:           <span class="ruby-keyword kw">else</span>
+184:             <span class="ruby-identifier">token</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
+185:           <span class="ruby-keyword kw">end</span>
+186:           <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;    #{token} -&gt; #{rule.name}&quot;</span>
+187:         <span class="ruby-keyword kw">end</span>
+188:       <span class="ruby-keyword kw">end</span>
+189:       <span class="ruby-identifier">puts</span>
+190:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -852,39 +888,75 @@ be of type <a href="Pattern.html">TextParser::Pattern</a>.
 			</div>
 
 		
-			<div id="matching-attern-ndex-method" class="method-detail ">
-				<a name="method-i-matchingPatternIndex"></a>
+			<div id="flush-ache-method" class="method-detail ">
+				<a name="method-i-flushCache"></a>
 
 				<div class="method-heading">
 				
-					<span class="method-name">matchingPatternIndex</span><span
-						class="method-args">(token)</span>
+					<span class="method-name">flushCache</span><span
+						class="method-args">()</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
 				</div>
 
 				<div class="method-description">
 					
-					<p>
-Return the pattern of this rule that matches the given <tt>token</tt>. If
-no pattern matches, return nil.
-</p>
+					
 					
 
 					
 					<div class="method-source-code"
-						id="matching-attern-ndex-source">
+						id="flush-ache-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 122</span>
-122:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">matchingPatternIndex</span>(<span class="ruby-identifier">token</span>)
-123:       <span class="ruby-identifier">i</span> = <span class="ruby-value">0</span>
-124:       <span class="ruby-ivar">@transitions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
-125:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">token</span>)
-126:         <span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
-127:       <span class="ruby-keyword kw">end</span>
-128: 
-129:       <span class="ruby-keyword kw">nil</span>
-130:     <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 42</span>
+42:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">flushCache</span>
+43:       <span class="ruby-comment cmt"># A rule is considered to describe optional tokens in case the @optional</span>
+44:       <span class="ruby-comment cmt"># flag is set or all of the patterns reference optional rules again.</span>
+45:       <span class="ruby-comment cmt"># This variable caches the transitively determined optional value.</span>
+46:       <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">nil</span>
+47:     <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+			<div id="generate-tates-method" class="method-detail ">
+				<a name="method-i-generateStates"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">generateStates</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="generate-tates-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 80</span>
+80:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generateStates</span>
+81:       <span class="ruby-comment cmt"># First, add an entry State for this rule. Entry states are never</span>
+82:       <span class="ruby-comment cmt"># reached by normal state transitions. They are only used as (re-)start</span>
+83:       <span class="ruby-comment cmt"># states.</span>
+84:       <span class="ruby-identifier">states</span> = [ <span class="ruby-constant">State</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>) ]
+85: 
+86:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pattern</span><span class="ruby-operator">|</span>
+87:         <span class="ruby-identifier">states</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">generateStates</span>(<span class="ruby-keyword kw">self</span>)
+88:       <span class="ruby-keyword kw">end</span>
+89:       <span class="ruby-identifier">states</span>
+90:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -919,23 +991,23 @@ be reused for later calls.
 					<div class="method-source-code"
 						id="optional--source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 57</span>
-57:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">optional?</span>(<span class="ruby-identifier">rules</span>)
-58:       <span class="ruby-comment cmt"># If we have a cached result, use this.</span>
-59:       <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@transitiveOptional</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@transitiveOptional</span>
-60: 
-61:       <span class="ruby-comment cmt"># If the rule is marked optional, then it is optional.</span>
-62:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optional</span>
-63:         <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">true</span>
-64:       <span class="ruby-keyword kw">end</span>
-65: 
-66:       <span class="ruby-comment cmt"># If all patterns describe optional content, then this rule is optional</span>
-67:       <span class="ruby-comment cmt"># as well.</span>
-68:       <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">true</span>
-69:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pat</span><span class="ruby-operator">|</span>
-70:         <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pat</span>.<span class="ruby-identifier">optional?</span>(<span class="ruby-identifier">rules</span>)
-71:       <span class="ruby-keyword kw">end</span>
-72:     <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 63</span>
+63:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">optional?</span>(<span class="ruby-identifier">rules</span>)
+64:       <span class="ruby-comment cmt"># If we have a cached result, use this.</span>
+65:       <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@transitiveOptional</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@transitiveOptional</span>
+66: 
+67:       <span class="ruby-comment cmt"># If the rule is marked optional, then it is optional.</span>
+68:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optional</span>
+69:         <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">true</span>
+70:       <span class="ruby-keyword kw">end</span>
+71: 
+72:       <span class="ruby-comment cmt"># If all patterns describe optional content, then this rule is optional</span>
+73:       <span class="ruby-comment cmt"># as well.</span>
+74:       <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">true</span>
+75:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pat</span><span class="ruby-operator">|</span>
+76:         <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@transitiveOptional</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pat</span>.<span class="ruby-identifier">optional?</span>(<span class="ruby-identifier">rules</span>)
+77:       <span class="ruby-keyword kw">end</span>
+78:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -968,10 +1040,10 @@ Return a reference the pattern of this <a href="Rule.html">Rule</a>.
 					<div class="method-source-code"
 						id="pattern-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 116</span>
-116:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pattern</span>(<span class="ruby-identifier">idx</span>)
-117:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-identifier">idx</span>]
-118:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 144</span>
+144:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pattern</span>(<span class="ruby-identifier">idx</span>)
+145:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-identifier">idx</span>]
+146:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1004,11 +1076,11 @@ Add a description for a pattern element of the last added pattern.
 					<div class="method-source-code"
 						id="set-rg-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 90</span>
-90:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setArg</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">doc</span>)
-91:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
-92:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setArg</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">doc</span>)
-93:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 118</span>
+118:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setArg</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">doc</span>)
+119:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
+120:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setArg</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">doc</span>)
+121:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1045,11 +1117,11 @@ scope can be appended, separated by a dot (E.g. name.scope).
 					<div class="method-source-code"
 						id="set-oc-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 84</span>
-84:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setDoc</span>(<span class="ruby-identifier">keyword</span>, <span class="ruby-identifier">doc</span>)
-85:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
-86:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setDoc</span>(<span class="ruby-identifier">keyword</span>, <span class="ruby-identifier">doc</span>)
-87:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 112</span>
+112:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setDoc</span>(<span class="ruby-identifier">keyword</span>, <span class="ruby-identifier">doc</span>)
+113:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
+114:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setDoc</span>(<span class="ruby-identifier">keyword</span>, <span class="ruby-identifier">doc</span>)
+115:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1083,10 +1155,10 @@ Add a reference to a code example. <tt>file</tt> is the name of the file.
 					<div class="method-source-code"
 						id="set-xample-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 111</span>
-111:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setExample</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">tag</span>)
-112:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setExample</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">tag</span>)
-113:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 139</span>
+139:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setExample</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">tag</span>)
+140:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setExample</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">tag</span>)
+141:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1120,12 +1192,12 @@ documentation. All subsequent tokens will be ignored.
 					<div class="method-source-code"
 						id="set-ast-yntax-oken-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 97</span>
- 97:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setLastSyntaxToken</span>(<span class="ruby-identifier">idx</span>)
- 98:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
- 99:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'Token index too large'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">idx</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">tokens</span>.<span class="ruby-identifier">length</span>
-100:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setLastSyntaxToken</span>(<span class="ruby-identifier">idx</span>)
-101:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 125</span>
+125:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setLastSyntaxToken</span>(<span class="ruby-identifier">idx</span>)
+126:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
+127:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'Token index too large'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">idx</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">tokens</span>.<span class="ruby-identifier">length</span>
+128:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setLastSyntaxToken</span>(<span class="ruby-identifier">idx</span>)
+129:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1158,10 +1230,10 @@ Mark the rule as an optional element of the syntax.
 					<div class="method-source-code"
 						id="set-ptional-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 50</span>
-50:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setOptional</span>
-51:       <span class="ruby-ivar">@optional</span> = <span class="ruby-keyword kw">true</span>
-52:     <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 56</span>
+56:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setOptional</span>
+57:       <span class="ruby-ivar">@optional</span> = <span class="ruby-keyword kw">true</span>
+58:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1195,10 +1267,10 @@ repeatable element that can occur once or more times in sequence.
 					<div class="method-source-code"
 						id="set-epeatable-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 76</span>
-76:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setRepeatable</span>
-77:       <span class="ruby-ivar">@repeatable</span> = <span class="ruby-keyword kw">true</span>
-78:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 104</span>
+104:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setRepeatable</span>
+105:       <span class="ruby-ivar">@repeatable</span> = <span class="ruby-keyword kw">true</span>
+106:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1231,11 +1303,11 @@ Add a reference to another rule for documentation purposes.
 					<div class="method-source-code"
 						id="set-ee-lso-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 104</span>
-104:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setSeeAlso</span>(<span class="ruby-identifier">also</span>)
-105:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
-106:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setSeeAlso</span>(<span class="ruby-identifier">also</span>)
-107:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 132</span>
+132:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setSeeAlso</span>(<span class="ruby-identifier">also</span>)
+133:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">'No pattern defined yet'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">empty?</span>
+134:       <span class="ruby-ivar">@patterns</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">setSeeAlso</span>(<span class="ruby-identifier">also</span>)
+135:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -1266,28 +1338,28 @@ Add a reference to another rule for documentation purposes.
 					<div class="method-source-code"
 						id="to-syntax-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 132</span>
-132:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_syntax</span>(<span class="ruby-identifier">stack</span>, <span class="ruby-identifier">docs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span>)
-133:       <span class="ruby-identifier">str</span> = <span class="ruby-value str">''</span>
-134:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'['</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optional</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@repeatable</span>
-135:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'('</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
-136:       <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
-137:       <span class="ruby-identifier">pStr</span> = <span class="ruby-value str">''</span>
-138:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pat</span><span class="ruby-operator">|</span>
-139:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
-140:           <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
-141:         <span class="ruby-keyword kw">else</span>
-142:           <span class="ruby-identifier">pStr</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">' | '</span>
-143:         <span class="ruby-keyword kw">end</span>
-144:         <span class="ruby-identifier">pStr</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">pat</span>.<span class="ruby-identifier">to_syntax_r</span>(<span class="ruby-identifier">stack</span>, <span class="ruby-identifier">docs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span>)
-145:       <span class="ruby-keyword kw">end</span>
-146:       <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pStr</span> <span class="ruby-operator">==</span> <span class="ruby-value str">''</span>
-147:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">pStr</span>
-148:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'...'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@repeatable</span>
-149:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">')'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
-150:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">']'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optional</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@repeatable</span>
-151:       <span class="ruby-identifier">str</span>
-152:     <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/TextParser/Rule.rb, line 148</span>
+148:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_syntax</span>(<span class="ruby-identifier">stack</span>, <span class="ruby-identifier">docs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span>)
+149:       <span class="ruby-identifier">str</span> = <span class="ruby-value str">''</span>
+150:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'['</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optional</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@repeatable</span>
+151:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'('</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
+152:       <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
+153:       <span class="ruby-identifier">pStr</span> = <span class="ruby-value str">''</span>
+154:       <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pat</span><span class="ruby-operator">|</span>
+155:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
+156:           <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
+157:         <span class="ruby-keyword kw">else</span>
+158:           <span class="ruby-identifier">pStr</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">' | '</span>
+159:         <span class="ruby-keyword kw">end</span>
+160:         <span class="ruby-identifier">pStr</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">pat</span>.<span class="ruby-identifier">to_syntax_r</span>(<span class="ruby-identifier">stack</span>, <span class="ruby-identifier">docs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span>)
+161:       <span class="ruby-keyword kw">end</span>
+162:       <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pStr</span> <span class="ruby-operator">==</span> <span class="ruby-value str">''</span>
+163:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">pStr</span>
+164:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'...'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@repeatable</span>
+165:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">')'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@patterns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
+166:       <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">']'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@optional</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@repeatable</span>
+167:       <span class="ruby-identifier">str</span>
+168:     <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>