taskjuggler 0.0.2 → 0.0.3

data/doc/classes/TaskJuggler/RichTextScanner.html

@@ -70,8 +70,12 @@
             <td><strong>Parent:</strong></td>
             <td>
 
+                <a href="../Object.html">
+
                 Object
 
+               </a>
+
             </td>
         </tr>
 
@@ -88,8 +92,8 @@
 The <a href="RichTextScanner.html">RichTextScanner</a> is used by the <a
 href="RichTextParser.html">RichTextParser</a> to chop the input text into
 digestable tokens. The parser and the scanner only communicate over <a
-href="RichTextScanner.html#M000610">RichTextScanner#nextToken</a> and <a
-href="RichTextScanner.html#M000611">RichTextScanner#returnToken</a>. The
+href="RichTextScanner.html#M000939">RichTextScanner#nextToken</a> and <a
+href="RichTextScanner.html#M000940">RichTextScanner#returnToken</a>. The
 scanner can break the text into words and special tokens.
 </p>
 
@@ -103,17 +107,17 @@ scanner can break the text into words and special tokens.
 
       <div class="name-list">
 
-        <a href="#M000614">error</a>&nbsp;&nbsp;
+        <a href="#M000943">error</a>&nbsp;&nbsp;
 
-        <a href="#M000613">fileName</a>&nbsp;&nbsp;
+        <a href="#M000942">fileName</a>&nbsp;&nbsp;
 
-        <a href="#M000609">new</a>&nbsp;&nbsp;
+        <a href="#M000938">new</a>&nbsp;&nbsp;
 
-        <a href="#M000610">nextToken</a>&nbsp;&nbsp;
+        <a href="#M000939">nextToken</a>&nbsp;&nbsp;
 
-        <a href="#M000611">returnToken</a>&nbsp;&nbsp;
+        <a href="#M000940">returnToken</a>&nbsp;&nbsp;
 
-        <a href="#M000612">sourceFileInfo</a>&nbsp;&nbsp;
+        <a href="#M000941">sourceFileInfo</a>&nbsp;&nbsp;
 
       </div>
     </div>
@@ -134,12 +138,12 @@ scanner can break the text into words and special tokens.
       <h3 class="section-bar">Public Class methods</h3>
 
 
-      <div id="method-M000609" class="method-detail">
-        <a name="M000609"></a>
+      <div id="method-M000938" class="method-detail">
+        <a name="M000938"></a>
 
         <div class="method-heading">
 
-          <a href="#M000609" class="method-signature">
+          <a href="#M000938" class="method-signature">
 
           <span class="method-name">new</span><span class="method-args">(text)</span>
 
@@ -155,8 +159,8 @@ initialize all state variables.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000609-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000609-source">
+            onclick="toggleCode('M000938-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000938-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 24</span>
 24:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">text</span>)
@@ -177,12 +181,16 @@ initialize all state variables.
 39:       <span class="ruby-comment cmt"># This is the position of the start of the currently processed line.</span>
 40:       <span class="ruby-comment cmt"># It's only used for error reporting.</span>
 41:       <span class="ruby-ivar">@lineStart</span> = <span class="ruby-value">0</span>
-42:       <span class="ruby-comment cmt"># Most of the wiki markup interpretation can be turned on/off by using</span>
-43:       <span class="ruby-comment cmt"># &lt;nowiki&gt;...&lt;/nowiki&gt; in the text. This flag keeps this state.</span>
-44:       <span class="ruby-ivar">@wikiEnabled</span> = <span class="ruby-keyword kw">true</span>
-45:       <span class="ruby-comment cmt"># Enable to trigger printout instead of exception.</span>
-46:       <span class="ruby-ivar">@debug</span> = <span class="ruby-keyword kw">false</span>
-47:     <span class="ruby-keyword kw">end</span>
+42:       <span class="ruby-comment cmt"># This variable stores the mode that the parser is operating in. The</span>
+43:       <span class="ruby-comment cmt"># following modes are supported:</span>
+44:       <span class="ruby-comment cmt"># :wiki : accept supported MediaWiki subset plus TJ extensions</span>
+45:       <span class="ruby-comment cmt"># :nowiki : ignore most markup except for the &lt;/nowiki&gt; token</span>
+46:       <span class="ruby-comment cmt"># :funcarg : parse name and parameters of an block  or inline parser</span>
+47:       <span class="ruby-comment cmt"># function.</span>
+48:       <span class="ruby-ivar">@mode</span> = <span class="ruby-identifier">:wiki</span>
+49:       <span class="ruby-comment cmt"># Enable to trigger printout instead of exception.</span>
+50:       <span class="ruby-ivar">@debug</span> = <span class="ruby-keyword kw">false</span>
+51:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -193,12 +201,12 @@ initialize all state variables.
       <h3 class="section-bar">Public Instance methods</h3>
 
 
-      <div id="method-M000614" class="method-detail">
-        <a name="M000614"></a>
+      <div id="method-M000943" class="method-detail">
+        <a name="M000943"></a>
 
         <div class="method-heading">
 
-          <a href="#M000614" class="method-signature">
+          <a href="#M000943" class="method-signature">
 
           <span class="method-name">error</span><span class="method-args">(id, text, foo)</span>
 
@@ -213,19 +221,19 @@ The parser uses this function to report any errors during parsing.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000614-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000614-source">
+            onclick="toggleCode('M000943-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000943-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 253</span>
-253:     <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">foo</span>)
-254:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@debug</span>
-255:         <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Line #{@lineNo}: #{text}\n&quot;</span> <span class="ruby-operator">+</span>
-256:                      <span class="ruby-node">&quot;#{@text[@lineStart, @pos - @lineStart]}&quot;</span>
-257:       <span class="ruby-keyword kw">else</span>
-258:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">RichTextException</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">id</span>, <span class="ruby-ivar">@lineNo</span>, <span class="ruby-identifier">text</span>,
-259:                                     <span class="ruby-ivar">@text</span>[<span class="ruby-ivar">@lineStart</span>, <span class="ruby-ivar">@pos</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@lineStart</span>])
-260:       <span class="ruby-keyword kw">end</span>
-261:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 110</span>
+110:     <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">foo</span>)
+111:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@debug</span>
+112:         <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Line #{@lineNo}: #{text}\n&quot;</span> <span class="ruby-operator">+</span>
+113:                      <span class="ruby-node">&quot;#{@text[@lineStart, @pos - @lineStart]}&quot;</span>
+114:       <span class="ruby-keyword kw">else</span>
+115:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">RichTextException</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">id</span>, <span class="ruby-ivar">@lineNo</span>, <span class="ruby-identifier">text</span>,
+116:                                     <span class="ruby-ivar">@text</span>[<span class="ruby-ivar">@lineStart</span>, <span class="ruby-ivar">@pos</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@lineStart</span>])
+117:       <span class="ruby-keyword kw">end</span>
+118:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -233,12 +241,12 @@ The parser uses this function to report any errors during parsing.
       </div>
 
 
-      <div id="method-M000613" class="method-detail">
-        <a name="M000613"></a>
+      <div id="method-M000942" class="method-detail">
+        <a name="M000942"></a>
 
         <div class="method-heading">
 
-          <a href="#M000613" class="method-signature">
+          <a href="#M000942" class="method-signature">
 
           <span class="method-name">fileName</span><span class="method-args">()</span>
 
@@ -254,13 +262,13 @@ don&#8217;t have a file name, we just return &#8216;input text&#8217;.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000613-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000613-source">
+            onclick="toggleCode('M000942-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000942-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 248</span>
-248:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fileName</span>
-249:       <span class="ruby-value str">'input text'</span>
-250:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 105</span>
+105:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fileName</span>
+106:       <span class="ruby-value str">'input text'</span>
+107:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -268,12 +276,12 @@ don&#8217;t have a file name, we just return &#8216;input text&#8217;.
       </div>
 
 
-      <div id="method-M000610" class="method-detail">
-        <a name="M000610"></a>
+      <div id="method-M000939" class="method-detail">
+        <a name="M000939"></a>
 
         <div class="method-heading">
 
-          <a href="#M000610" class="method-signature">
+          <a href="#M000939" class="method-signature">
 
           <span class="method-name">nextToken</span><span class="method-args">()</span>
 
@@ -288,185 +296,38 @@ Return the next token from the input text.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000610-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000610-source">
+            onclick="toggleCode('M000939-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000939-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 57</span>
- 57:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">nextToken</span>
- 58:       <span class="ruby-comment cmt"># If we have a returned token, this is returned first.</span>
- 59:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@tokenBuffer</span>
- 60:         <span class="ruby-identifier">tok</span> = <span class="ruby-ivar">@tokenBuffer</span>
- 61:         <span class="ruby-ivar">@tokenBuffer</span> = <span class="ruby-keyword kw">nil</span>
- 62:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">tok</span>
- 63:       <span class="ruby-keyword kw">end</span>
- 64: 
- 65:       <span class="ruby-comment cmt"># Some characters have only a special meaning at the start of the line.</span>
- 66:       <span class="ruby-comment cmt"># When the last token pushed the cursor into a new line, this flag is set</span>
- 67:       <span class="ruby-comment cmt"># to true.</span>
- 68:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@beginOfLine</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@wikiEnabled</span>
- 69:         <span class="ruby-comment cmt"># Reset the flag again.</span>
- 70:         <span class="ruby-ivar">@beginOfLine</span> = <span class="ruby-keyword kw">false</span>
- 71: 
- 72:         <span class="ruby-comment cmt"># We already know that the last newline was a real linebreak. Further</span>
- 73:         <span class="ruby-comment cmt"># newlines can safely be ignored.</span>
- 74:         <span class="ruby-identifier">readSequence</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
- 75: 
- 76:         <span class="ruby-keyword kw">case</span> (<span class="ruby-identifier">c</span> = <span class="ruby-identifier">nextChar</span>)
- 77:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'='</span>
- 78:           <span class="ruby-comment cmt"># Headings start with 2 or more = and must be followed by a space.</span>
- 79:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">'='</span>, <span class="ruby-value">4</span>)
- 80:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
- 81:             <span class="ruby-comment cmt"># 1 = does not mean anything. Push it back and process it as normal</span>
- 82:             <span class="ruby-comment cmt"># text further down.</span>
- 83:             <span class="ruby-identifier">returnChar</span>
- 84:           <span class="ruby-keyword kw">else</span>
- 85:             <span class="ruby-comment cmt"># Between the = characters and the title text must be exactly one</span>
- 86:             <span class="ruby-comment cmt"># space.</span>
- 87:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-node">&quot;TITLE#{level - 1}&quot;</span>, <span class="ruby-value str">'='</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">nextChar</span> <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span>
- 88:             <span class="ruby-comment cmt"># If that's missing, The = are treated as normal text further down.</span>
- 89:             <span class="ruby-identifier">returnChar</span>(<span class="ruby-identifier">level</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
- 90:           <span class="ruby-keyword kw">end</span>
- 91:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'-'</span>
- 92:           <span class="ruby-comment cmt"># Horizontal ruler. Must have exactly 4 -.</span>
- 93:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">'-'</span>, <span class="ruby-value">4</span>)
- 94:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">&quot;HLINE&quot;</span>, <span class="ruby-value str">'-'</span> <span class="ruby-operator">*</span> <span class="ruby-value">4</span> ] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
- 95:           <span class="ruby-identifier">returnChar</span>(<span class="ruby-identifier">level</span>)
- 96:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'*'</span>
- 97:           <span class="ruby-comment cmt"># Bullet lists start with one to three * characters.</span>
- 98:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">'*'</span>)
- 99:           <span class="ruby-comment cmt"># Between the * characters and the bullet text must be exactly one</span>
-100:           <span class="ruby-comment cmt"># space.</span>
-101:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-node">&quot;BULLET#{level}&quot;</span>, <span class="ruby-value str">'*'</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">nextChar</span> <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span>
-102:           <span class="ruby-comment cmt"># If that's missing, The # are treated as normal text further down.</span>
-103:           <span class="ruby-identifier">returnChar</span>(<span class="ruby-identifier">level</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-104:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'#'</span>
-105:           <span class="ruby-comment cmt"># Numbered list start with one to three # characters.</span>
-106:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">'#'</span>)
-107:           <span class="ruby-comment cmt"># Between the # characters and the bullet text must be exactly one</span>
-108:           <span class="ruby-comment cmt"># space.</span>
-109:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-node">&quot;NUMBER#{level}&quot;</span>, <span class="ruby-value str">'#'</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">nextChar</span> <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span>
-110:           <span class="ruby-comment cmt"># If that's missing, The # are treated as normal text further down.</span>
-111:           <span class="ruby-identifier">returnChar</span>(<span class="ruby-identifier">level</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-112:         <span class="ruby-keyword kw">when</span> <span class="ruby-value str">' '</span>
-113:           <span class="ruby-comment cmt"># Lines that start with a space are treated as verbatim text.</span>
-114:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">&quot;PRE&quot;</span>, <span class="ruby-identifier">readCode</span> ] <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">c</span> = <span class="ruby-identifier">peek</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">&quot;\n&quot;</span>
-115:         <span class="ruby-keyword kw">else</span>
-116:           <span class="ruby-comment cmt"># If the character is not a known control character we push it back</span>
-117:           <span class="ruby-comment cmt"># and treat it as normal text further down.</span>
-118:           <span class="ruby-identifier">returnChar</span>
-119:         <span class="ruby-keyword kw">end</span>
-120:       <span class="ruby-keyword kw">end</span>
-121: 
-122:       <span class="ruby-comment cmt"># Not all sequences of inline markup characters are control sequences. In</span>
-123:       <span class="ruby-comment cmt"># case we detect a sequence that has not the right number of characters,</span>
-124:       <span class="ruby-comment cmt"># we push them back and start over with this flag set to true.</span>
-125:       <span class="ruby-identifier">ignoreInlineMarkup</span> = <span class="ruby-keyword kw">false</span>
-126: 
-127:       <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
-128:         <span class="ruby-identifier">c</span> = <span class="ruby-identifier">nextChar</span>
-129:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span>
-130:           <span class="ruby-comment cmt"># We've reached the end of the text.</span>
-131:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'.'</span>, <span class="ruby-value str">'&lt;END&gt;'</span> ]
-132:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">' '</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;\t&quot;</span>
-133:           <span class="ruby-comment cmt"># Sequences of tabs or spaces are treated as token boundaries, but</span>
-134:           <span class="ruby-comment cmt"># otherwise they are ignored.</span>
-135:           <span class="ruby-identifier">readSequence</span>(<span class="ruby-value str">' '</span>, <span class="ruby-value str">&quot;\t&quot;</span>)
-136:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'SPACE'</span>, <span class="ruby-value str">' '</span> ]
-137:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ignoreInlineMarkup</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@wikiEnabled</span>
-138:           <span class="ruby-comment cmt"># Sequence of 2 ' means italic, 3 ' means bold, 4 ' means monospaced</span>
-139:           <span class="ruby-comment cmt"># code, 5 ' means italic and bold. Anything else is just normal text.</span>
-140:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">&quot;'&quot;</span>, <span class="ruby-value">5</span>)
-141:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
-142:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'ITALIC'</span>, <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-143:           <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">3</span>
-144:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'BOLD'</span>, <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-145:           <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
-146:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'CODE'</span>, <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-147:           <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">5</span>
-148:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'BOLDITALIC'</span>, <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-149:           <span class="ruby-keyword kw">else</span>
-150:             <span class="ruby-comment cmt"># We have not found the right syntax. Treat the found characters as</span>
-151:             <span class="ruby-comment cmt"># normal text.  Push all ' back and start again but ignoring the '</span>
-152:             <span class="ruby-comment cmt"># code for once.</span>
-153:             <span class="ruby-identifier">returnChar</span>(<span class="ruby-identifier">level</span>)
-154:             <span class="ruby-identifier">ignoreInlineMarkup</span> = <span class="ruby-keyword kw">true</span>
-155:             <span class="ruby-keyword kw">next</span>
-156:           <span class="ruby-keyword kw">end</span>
-157:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'='</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ignoreInlineMarkup</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@wikiEnabled</span>
-158:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">'='</span>, <span class="ruby-value">4</span>)
-159:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">level</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
-160:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-node">&quot;TITLE#{level - 1}END&quot;</span>, <span class="ruby-value str">'='</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-161:           <span class="ruby-keyword kw">else</span>
-162:             <span class="ruby-comment cmt"># We have not found the right syntax. Treat found characters as</span>
-163:             <span class="ruby-comment cmt"># normal text.  Push all = back and start again but ignoring the =</span>
-164:             <span class="ruby-comment cmt"># code for once.</span>
-165:             <span class="ruby-identifier">returnChar</span>(<span class="ruby-identifier">level</span>)
-166:             <span class="ruby-identifier">ignoreInlineMarkup</span> = <span class="ruby-keyword kw">true</span>
-167:             <span class="ruby-keyword kw">next</span>
-168:           <span class="ruby-keyword kw">end</span>
-169:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'['</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@wikiEnabled</span>
-170:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">'['</span>, <span class="ruby-value">2</span>)
-171:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-value str">'HREF'</span> <span class="ruby-operator">:</span> <span class="ruby-value str">'REF'</span>, <span class="ruby-value str">'['</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-172:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">']'</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@wikiEnabled</span>
-173:           <span class="ruby-identifier">level</span> = <span class="ruby-identifier">readSequenceMax</span>(<span class="ruby-value str">']'</span>, <span class="ruby-value">2</span>)
-174:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-identifier">level</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-value str">'HREFEND'</span> <span class="ruby-operator">:</span> <span class="ruby-value str">'REFEND'</span>, <span class="ruby-value str">']'</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">level</span> ]
-175:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;\n&quot;</span>
-176:           <span class="ruby-comment cmt"># Newlines are pretty important as they can terminate blocks and turn</span>
-177:           <span class="ruby-comment cmt"># the next character into the start of a control sequence.</span>
-178:           <span class="ruby-comment cmt"># Hard linebreaks consist of a newline followed by another newline or</span>
-179:           <span class="ruby-comment cmt"># any of the begin-of-line control characters.</span>
-180:           <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">c</span> = <span class="ruby-identifier">nextChar</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-value str">&quot;\n*# =-&quot;</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">c</span>)
-181:             <span class="ruby-identifier">returnChar</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">&quot;\n&quot;</span>
-182:             <span class="ruby-comment cmt"># The next character may be a control character.</span>
-183:             <span class="ruby-ivar">@beginOfLine</span> = <span class="ruby-keyword kw">true</span>
-184:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'LINEBREAK'</span>, <span class="ruby-value str">&quot;\n&quot;</span> ]
-185:           <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span>
-186:             <span class="ruby-comment cmt"># We hit the end of the text.</span>
-187:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'.'</span>, <span class="ruby-value str">'&lt;END&gt;'</span> ]
-188:           <span class="ruby-keyword kw">else</span>
-189:             <span class="ruby-comment cmt"># Single line breaks are treated as spaces. Return the char after</span>
-190:             <span class="ruby-comment cmt"># the newline and start with this one again.</span>
-191:             <span class="ruby-identifier">returnChar</span>
-192:             <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'SPACE'</span>, <span class="ruby-value str">' '</span> ]
-193:           <span class="ruby-keyword kw">end</span>
-194:         <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'&lt;'</span>
-195:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">peekMatch</span>(<span class="ruby-value str">'nowiki&gt;'</span>)
-196:             <span class="ruby-comment cmt"># Turn most wiki markup interpretation off.</span>
-197:             <span class="ruby-ivar">@pos</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'nowiki&gt;'</span>.<span class="ruby-identifier">length</span>
-198:             <span class="ruby-ivar">@wikiEnabled</span> = <span class="ruby-keyword kw">false</span>
-199:             <span class="ruby-keyword kw">next</span>
-200:           <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">peekMatch</span>(<span class="ruby-value str">'/nowiki&gt;'</span>)
-201:             <span class="ruby-comment cmt"># Turn most wiki markup interpretation on.</span>
-202:             <span class="ruby-ivar">@pos</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">'/nowiki&gt;'</span>.<span class="ruby-identifier">length</span>
-203:             <span class="ruby-ivar">@wikiEnabled</span> = <span class="ruby-keyword kw">true</span>
-204:             <span class="ruby-keyword kw">next</span>
-205:           <span class="ruby-keyword kw">else</span>
-206:             <span class="ruby-identifier">returnChar</span>
-207:           <span class="ruby-keyword kw">end</span>
-208:         <span class="ruby-keyword kw">else</span>
-209:           <span class="ruby-comment cmt"># Reset this flag again.</span>
-210:           <span class="ruby-identifier">ignoreInlineMarkup</span> = <span class="ruby-keyword kw">false</span>
-211:           <span class="ruby-identifier">str</span> = <span class="ruby-value str">''</span>
-212:           <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">c</span>
-213:           <span class="ruby-comment cmt"># Now we can collect characters of a word until we hit a whitespace.</span>
-214:           <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">c</span> = <span class="ruby-identifier">nextChar</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-value str">&quot; \n\t&quot;</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">c</span>)
-215:             <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@wikiEnabled</span>
-216:               <span class="ruby-comment cmt"># Or at least to ' characters in a row.</span>
-217:               <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;'&quot;</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">peek</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;'&quot;</span>
-218:               <span class="ruby-comment cmt"># Or a ] or &lt;</span>
-219:               <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-value str">']&lt;'</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">c</span>)
-220:             <span class="ruby-keyword kw">else</span>
-221:               <span class="ruby-comment cmt"># Make sure we find the &lt;/nowiki&gt; tag even within a word.</span>
-222:               <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'&lt;'</span>
-223:             <span class="ruby-keyword kw">end</span>
-224:             <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">c</span>
-225:           <span class="ruby-keyword kw">end</span>
-226:           <span class="ruby-comment cmt"># Return the character that indicated the word end.</span>
-227:           <span class="ruby-identifier">returnChar</span>
-228:           <span class="ruby-keyword kw">return</span> [ <span class="ruby-value str">'WORD'</span>, <span class="ruby-identifier">str</span> ]
-229:         <span class="ruby-keyword kw">end</span>
-230:       <span class="ruby-keyword kw">end</span>
-231:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 61</span>
+61:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">nextToken</span>
+62:       <span class="ruby-comment cmt"># If we have a returned token, this is returned first.</span>
+63:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@tokenBuffer</span>
+64:         <span class="ruby-identifier">tok</span> = <span class="ruby-ivar">@tokenBuffer</span>
+65:         <span class="ruby-ivar">@tokenBuffer</span> = <span class="ruby-keyword kw">nil</span>
+66:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">tok</span>
+67:       <span class="ruby-keyword kw">end</span>
+68: 
+69:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:funcarg</span>
+70:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">nextTokenFuncArg</span>
+71:       <span class="ruby-keyword kw">end</span>
+72:       <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@beginOfLine</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:wiki</span>
+73:         <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">res</span> = <span class="ruby-identifier">nextTokenWikiBOL</span>)
+74:           <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">res</span>
+75:         <span class="ruby-keyword kw">end</span>
+76:       <span class="ruby-keyword kw">end</span>
+77: 
+78:       <span class="ruby-comment cmt"># Many inline control character sequences consit of multiple characters.</span>
+79:       <span class="ruby-comment cmt"># In case of incomplete sequences, we roll back to the start character</span>
+80:       <span class="ruby-comment cmt"># and set the ignoreInlineMarkup flag to simply treat them as normal</span>
+81:       <span class="ruby-comment cmt"># text.</span>
+82:       <span class="ruby-ivar">@ignoreInlineMarkup</span> = <span class="ruby-keyword kw">false</span>
+83:       <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
+84:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">res</span> = (<span class="ruby-ivar">@mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:wiki</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">nextTokenWikiInline</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">nextTokenNoWikiInline</span>)
+85:           <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">res</span>
+86:         <span class="ruby-keyword kw">end</span>
+87:       <span class="ruby-keyword kw">end</span>
+88:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -474,12 +335,12 @@ Return the next token from the input text.
       </div>
 
 
-      <div id="method-M000611" class="method-detail">
-        <a name="M000611"></a>
+      <div id="method-M000940" class="method-detail">
+        <a name="M000940"></a>
 
         <div class="method-heading">
 
-          <a href="#M000611" class="method-signature">
+          <a href="#M000940" class="method-signature">
 
           <span class="method-name">returnToken</span><span class="method-args">(token)</span>
 
@@ -494,16 +355,16 @@ Return the last issued token to the token buffer.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000611-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000611-source">
+            onclick="toggleCode('M000940-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000940-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 234</span>
-234:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">returnToken</span>(<span class="ruby-identifier">token</span>)
-235:       <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@tokenBuffer</span>.<span class="ruby-identifier">nil?</span>
-236:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">TjException</span>.<span class="ruby-identifier">new</span>, <span class="ruby-value str">'Token buffer overflow!'</span>
-237:       <span class="ruby-keyword kw">end</span>
-238:       <span class="ruby-ivar">@tokenBuffer</span> = <span class="ruby-identifier">token</span>
-239:     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 91</span>
+91:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">returnToken</span>(<span class="ruby-identifier">token</span>)
+92:       <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@tokenBuffer</span>.<span class="ruby-identifier">nil?</span>
+93:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">TjException</span>.<span class="ruby-identifier">new</span>, <span class="ruby-value str">'Token buffer overflow!'</span>
+94:       <span class="ruby-keyword kw">end</span>
+95:       <span class="ruby-ivar">@tokenBuffer</span> = <span class="ruby-identifier">token</span>
+96:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
 
@@ -511,12 +372,12 @@ Return the last issued token to the token buffer.
       </div>
 
 
-      <div id="method-M000612" class="method-detail">
-        <a name="M000612"></a>
+      <div id="method-M000941" class="method-detail">
+        <a name="M000941"></a>
 
         <div class="method-heading">
 
-          <a href="#M000612" class="method-signature">
+          <a href="#M000941" class="method-signature">
 
           <span class="method-name">sourceFileInfo</span><span class="method-args">()</span>
 
@@ -531,13 +392,13 @@ Return the last issued token to the token buffer.
 </p>
 
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000612-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000612-source">
+            onclick="toggleCode('M000941-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000941-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 242</span>
-242:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sourceFileInfo</span>
-243:       [ <span class="ruby-ivar">@lineNo</span>, <span class="ruby-ivar">@pos</span> ]
-244:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/RichTextScanner.rb, line 99</span>
+ 99:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sourceFileInfo</span>
+100:       [ <span class="ruby-ivar">@lineNo</span>, <span class="ruby-ivar">@pos</span> ]
+101:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>