fto 0.1.0 → 1.0.0

data/doc/classes/FormatText/FTO.html

@@ -88,20 +88,20 @@ others are for developers modifying or extending the <tt>fto</tt> library.
 <em><a href="FTO.html">FTO</a></em> is a subclass of <em>String</em>, so
 all <em>String</em> methods work on an <em><a href="FTO.html">FTO</a></em>
 object. <em><a href="FTO.html">FTO</a></em> provides the additional <em><a
-href="FTO.html#M000007">format</a>()</em> method.
+href="FTO.html#M000008">format</a>()</em> method.
 </p>
 <p>
 In addition to string text, the constructor (<em><a
 href="FTO.html#M000001">FTO.new</a></em>) can take more than a single
 argument. Additional arguments will be stored as part of the object and
 will be available to the <em><a
-href="FTO.html#M000007">FTO#format</a>()</em> method at runtime.
+href="FTO.html#M000008">FTO#format</a>()</em> method at runtime.
 </p>
 <p>
 An <em><a href="FTO.html">FTO</a></em> object can be created as just a
 formatting string, or the constructor invocation can also include values to
-be applied by the <em><a href="FTO.html#M000007">FTO#format</a>()</em>
-method. At runtime the <em><a href="FTO.html#M000007">format</a>()</em>
+be applied by the <em><a href="FTO.html#M000008">FTO#format</a>()</em>
+method. At runtime the <em><a href="FTO.html#M000008">format</a>()</em>
 method can override any argument list provided at instantiation, but the
 latter is not lost.
 </p>
@@ -115,13 +115,14 @@ latter is not lost.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000004">destroyEffector</a>&nbsp;&nbsp;
-      <a href="#M000005">disableEffector</a>&nbsp;&nbsp;
-      <a href="#M000003">enableEffector</a>&nbsp;&nbsp;
-      <a href="#M000006">findEffectors</a>&nbsp;&nbsp;
-      <a href="#M000007">format</a>&nbsp;&nbsp;
+      <a href="#M000002">clearEffectorList</a>&nbsp;&nbsp;
+      <a href="#M000005">destroyEffector</a>&nbsp;&nbsp;
+      <a href="#M000006">disableEffector</a>&nbsp;&nbsp;
+      <a href="#M000004">enableEffector</a>&nbsp;&nbsp;
+      <a href="#M000007">findEffectors</a>&nbsp;&nbsp;
+      <a href="#M000008">format</a>&nbsp;&nbsp;
       <a href="#M000001">new</a>&nbsp;&nbsp;
-      <a href="#M000002">registerEffector</a>&nbsp;&nbsp;
+      <a href="#M000003">registerEffector</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -136,6 +137,24 @@ latter is not lost.
 
 
 
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">safe</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+Not yet implemented Controls whether the final string is built safely and
+conservatively, or if the output of each effector can alter the input to
+subsequent ones.
+
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
       
 
 
@@ -143,22 +162,21 @@ latter is not lost.
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
 
         <div class="method-heading">
-          <a href="FTO.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('FTO.src/M000004.html');return false;">
-          <span class="method-name">FTO.destroyEffector<i>(Fixnum)</i> => <i>nil</i><br />
+          <a href="FTO.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('FTO.src/M000002.html');return false;">
+          <span class="method-name">FTO.clearEffectorList<i>()</i> => <i>nil</i><br />
 </span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Completely removes the effector with the specified ID from the <a
-href="FTO.html">FTO</a> system. &lt;strong&gt;THIS IS NOT
-REVERSIBLE!&lt;/strong&gt;
+Clear all effectors from the list (as a prelude to using a different
+syntax, for instance).
 </p>
         </div>
       </div>
@@ -169,6 +187,25 @@ REVERSIBLE!&lt;/strong&gt;
         <div class="method-heading">
           <a href="FTO.src/M000005.html" target="Code" class="method-signature"
             onclick="popupCode('FTO.src/M000005.html');return false;">
+          <span class="method-name">FTO.destroyEffector<i>(Fixnum)</i> => <i>nil</i><br />
+</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Completely removes the effector with the specified ID from the <a
+href="FTO.html">FTO</a> system. <b>THIS IS NOT REVERSIBLE!</b>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="FTO.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('FTO.src/M000006.html');return false;">
           <span class="method-name">FTO.disableEffector<i>(Fixnum)</i> => <i>nil</i><br />
 </span>
           </a>
@@ -177,18 +214,18 @@ REVERSIBLE!&lt;/strong&gt;
         <div class="method-description">
           <p>
 Disables the effector with the specified ID (such as from <em><a
-href="FTO.html#M000006">FTO.findEffectors</a>()</em>). This is a no-op if
+href="FTO.html#M000007">FTO.findEffectors</a>()</em>). This is a no-op if
 the effector is already disabled.
 </p>
         </div>
       </div>
 
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
 
         <div class="method-heading">
-          <a href="FTO.src/M000003.html" target="Code" class="method-signature"
-            onclick="popupCode('FTO.src/M000003.html');return false;">
+          <a href="FTO.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('FTO.src/M000004.html');return false;">
           <span class="method-name">FTO.enableEffector<i>(Fixnum)</i> => <i>nil</i><br />
 </span>
           </a>
@@ -202,12 +239,12 @@ Enables the effector with the specified ID (found in the effector&#8216;s
         </div>
       </div>
 
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
 
         <div class="method-heading">
-          <a href="FTO.src/M000006.html" target="Code" class="method-signature"
-            onclick="popupCode('FTO.src/M000006.html');return false;">
+          <a href="FTO.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('FTO.src/M000007.html');return false;">
           <span class="method-name">FTO.findEffectors<i>(String)</i> => <i>Array</i><br />
 FTO.findEffectors<i>(Regexp)</i> => <i>Array</i><br />
 </span>
@@ -238,18 +275,18 @@ new<i>(String, arg [, ...])</i> => <i>FTO object</i><br />
         <div class="method-description">
           <p>
 Any argument list is supplied at object instantiation can be temporarily
-overridden when the <em><a href="FTO.html#M000007">FTO#format</a>()</em>
+overridden when the <em><a href="FTO.html#M000008">FTO#format</a>()</em>
 method is invoked.
 </p>
         </div>
       </div>
 
-      <div id="method-M000002" class="method-detail">
-        <a name="M000002"></a>
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
 
         <div class="method-heading">
-          <a href="FTO.src/M000002.html" target="Code" class="method-signature"
-            onclick="popupCode('FTO.src/M000002.html');return false;">
+          <a href="FTO.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('FTO.src/M000003.html');return false;">
           <span class="method-name">FTO.registerEffector<i>(FormatText::Effector)</i> => <i>nil</i><br />
 FTO.registerEffector<i>({ :symattr => value [, ...] })</i> => <i>nil</i><br />
 </span>
@@ -259,19 +296,19 @@ FTO.registerEffector<i>({ :symattr => value [, ...] })</i> => <i>nil</i><br />
         <div class="method-description">
           <p>
 Add an effector description to the list of those which will be processed by
-the <em><a href="FTO.html#M000007">FTO#format</a>()</em> method.
+the <em><a href="FTO.html#M000008">FTO#format</a>()</em> method.
 </p>
         </div>
       </div>
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
 
         <div class="method-heading">
-          <a href="FTO.src/M000007.html" target="Code" class="method-signature"
-            onclick="popupCode('FTO.src/M000007.html');return false;">
+          <a href="FTO.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('FTO.src/M000008.html');return false;">
           <span class="method-name">format<i>()</i> => <i>String</i><br />
 format<i>(arg [, ...])</i> => <i>String</i><br />
 format<i>(Array)</i> => <i>String</i><br />
@@ -283,7 +320,7 @@ format<i>(FormatText::Context)</i> => <i>String</i> (<u>internal use only</u>)<b
         <div class="method-description">
           <p>
 Process the formatting string, optionally with a runtime argument list. The
-argument list can either be a list of values, an array of values, or an
+argument list can either be a list of values, an array of values, or a
 <em><a href="Context.html">FormatText::Context</a></em> object. (The latter
 is intended only for internal use with recursion.)
 </p>

data/doc/classes/FormatText/FTO.src/M000001.html

@@ -10,9 +10,10 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 287</span>
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 293</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">text</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
       <span class="ruby-constant">String_initialize</span>(<span class="ruby-identifier">text</span>)
+      <span class="ruby-ivar">@safe</span> = <span class="ruby-keyword kw">true</span>
       <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>

data/doc/classes/FormatText/FTO.src/M000002.html

@@ -5,28 +5,14 @@
 
 <html>
 <head>
-  <title>registerEffector (FormatText::FTO)</title>
+  <title>clearEffectorList (FormatText::FTO)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 300</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registerEffector</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/Effector$/</span>))
-        <span class="ruby-identifier">newE</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
-      <span class="ruby-keyword kw">else</span>
-        <span class="ruby-identifier">newE</span> = <span class="ruby-constant">Effector</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'placeholder'</span>)
-        <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Hash</span>))
-          <span class="ruby-identifier">args</span>[<span class="ruby-value">0</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">val</span><span class="ruby-operator">|</span>
-            <span class="ruby-identifier">eval</span>(<span class="ruby-node">&quot;newE.#{key.to_s} = val&quot;</span>)
-          <span class="ruby-keyword kw">end</span>
-        <span class="ruby-keyword kw">else</span>
-          <span class="ruby-identifier">newE</span> = <span class="ruby-constant">Effector</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
-        <span class="ruby-keyword kw">end</span>
-      <span class="ruby-keyword kw">end</span>
-      <span class="ruby-ivar">@@RegisteredEffectors</span>[<span class="ruby-identifier">newE</span>.<span class="ruby-identifier">id</span>] = <span class="ruby-identifier">newE</span>
-      <span class="ruby-identifier">key</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">'%06d-%s'</span>, <span class="ruby-identifier">newE</span>.<span class="ruby-identifier">priority</span>, <span class="ruby-identifier">newE</span>.<span class="ruby-identifier">name</span>)
-      <span class="ruby-identifier">newE</span>.<span class="ruby-identifier">sortKey</span> = <span class="ruby-identifier">key</span>
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 306</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">clearEffectorList</span>()
+      <span class="ruby-ivar">@@RegisteredEffectors</span>.<span class="ruby-identifier">delete_if</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">id</span>,<span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">true</span> }
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rebuildEffectorList</span>()
       <span class="ruby-keyword kw">nil</span>
     <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/FormatText/FTO.src/M000003.html

@@ -5,18 +5,30 @@
 
 <html>
 <head>
-  <title>enableEffector (FormatText::FTO)</title>
+  <title>registerEffector (FormatText::FTO)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 345</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">enableEffector</span>(<span class="ruby-identifier">id</span>)
-      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">e</span> = <span class="ruby-ivar">@@RegisteredEffectors</span>[<span class="ruby-identifier">id</span>]).<span class="ruby-identifier">nil?</span>)
-        <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-identifier">_</span>(<span class="ruby-value str">'No such effector '</span>) <span class="ruby-operator">+</span> <span class="ruby-node">&quot;ID\##{id}&quot;</span>
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 320</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">registerEffector</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/Effector$/</span>)))
+        <span class="ruby-identifier">newE</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-identifier">newE</span> = <span class="ruby-constant">Effector</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'placeholder'</span>)
+        <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Hash</span>))
+          <span class="ruby-identifier">args</span>[<span class="ruby-value">0</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">val</span><span class="ruby-operator">|</span>
+            <span class="ruby-identifier">eval</span>(<span class="ruby-node">&quot;newE.#{key.to_s} = val&quot;</span>)
+          <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-identifier">newE</span> = <span class="ruby-constant">Effector</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
+        <span class="ruby-keyword kw">end</span>
       <span class="ruby-keyword kw">end</span>
-      <span class="ruby-identifier">e</span>.<span class="ruby-identifier">enabled</span> = <span class="ruby-keyword kw">true</span>
+      <span class="ruby-identifier">key</span> = <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">'%06d-%s'</span>, <span class="ruby-identifier">newE</span>.<span class="ruby-identifier">priority</span>, <span class="ruby-identifier">newE</span>.<span class="ruby-identifier">name</span>)
+      <span class="ruby-identifier">newE</span>.<span class="ruby-identifier">sortKey</span> = <span class="ruby-identifier">key</span>
+      <span class="ruby-ivar">@@RegisteredEffectors</span>[<span class="ruby-identifier">newE</span>.<span class="ruby-identifier">id</span>] = <span class="ruby-identifier">newE</span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rebuildEffectorList</span>()
+      <span class="ruby-keyword kw">nil</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/FormatText/FTO.src/M000004.html

@@ -5,14 +5,17 @@
 
 <html>
 <head>
-  <title>destroyEffector (FormatText::FTO)</title>
+  <title>enableEffector (FormatText::FTO)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 360</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">destroyEffector</span>(<span class="ruby-identifier">id</span>)
-      <span class="ruby-ivar">@@RegisteredEffectors</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">id</span>)
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 369</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">enableEffector</span>(<span class="ruby-identifier">id</span>)
+      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">e</span> = <span class="ruby-ivar">@@RegisteredEffectors</span>[<span class="ruby-identifier">id</span>]).<span class="ruby-identifier">nil?</span>)
+        <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-identifier">_</span>(<span class="ruby-value str">'No such effector '</span>) <span class="ruby-operator">+</span> <span class="ruby-node">&quot;ID\##{id}&quot;</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">e</span>.<span class="ruby-identifier">enabled</span> = <span class="ruby-keyword kw">true</span>
       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rebuildEffectorList</span>()
     <span class="ruby-keyword kw">end</span></pre>
 </body>

data/doc/classes/FormatText/FTO.src/M000005.html

@@ -5,18 +5,15 @@
 
 <html>
 <head>
-  <title>disableEffector (FormatText::FTO)</title>
+  <title>destroyEffector (FormatText::FTO)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 373</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">disableEffector</span>(<span class="ruby-identifier">id</span>)
-      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">e</span> = <span class="ruby-ivar">@@RegisteredEffectors</span>[<span class="ruby-identifier">id</span>]).<span class="ruby-identifier">nil?</span>)
-        <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-identifier">_</span>(<span class="ruby-value str">'No such effector '</span>) <span class="ruby-operator">+</span> <span class="ruby-node">&quot;ID\##{id}&quot;</span>
-      <span class="ruby-keyword kw">end</span>
-      <span class="ruby-identifier">e</span>.<span class="ruby-identifier">disable</span>
-      <span class="ruby-keyword kw">nil</span>
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 384</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">destroyEffector</span>(<span class="ruby-identifier">id</span>)
+      <span class="ruby-ivar">@@RegisteredEffectors</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">id</span>)
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">rebuildEffectorList</span>()
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/FormatText/FTO.src/M000006.html

@@ -5,16 +5,18 @@
 
 <html>
 <head>
-  <title>findEffectors (FormatText::FTO)</title>
+  <title>disableEffector (FormatText::FTO)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 389</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">findEffectors</span>(<span class="ruby-identifier">pattern</span>)
-      <span class="ruby-identifier">pattern</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pattern</span>) <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Regexp</span>)
-      <span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@@RegisteredEffectors</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">id</span>,<span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">pattern</span>) }
-      <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">id</span>,<span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span> }
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 397</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">disableEffector</span>(<span class="ruby-identifier">id</span>)
+      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">e</span> = <span class="ruby-ivar">@@RegisteredEffectors</span>[<span class="ruby-identifier">id</span>]).<span class="ruby-identifier">nil?</span>)
+        <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-identifier">_</span>(<span class="ruby-value str">'No such effector '</span>) <span class="ruby-operator">+</span> <span class="ruby-node">&quot;ID\##{id}&quot;</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">e</span>.<span class="ruby-identifier">disable</span>
+      <span class="ruby-keyword kw">nil</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/FormatText/FTO.src/M000007.html

@@ -5,59 +5,16 @@
 
 <html>
 <head>
-  <title>format (FormatText::FTO)</title>
+  <title>findEffectors (FormatText::FTO)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 408</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">format</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">argListp</span>)
-      <span class="ruby-identifier">argList</span> = <span class="ruby-identifier">argListp</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-ivar">@args</span>.<span class="ruby-identifier">clone</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">argListp</span>
-      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Array</span>)) <span class="ruby-operator">&amp;&amp;</span> 
-        <span class="ruby-identifier">argList</span> = <span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>]
-      <span class="ruby-keyword kw">end</span>
-      <span class="ruby-comment cmt">#</span>
-      <span class="ruby-comment cmt"># It's possible we were passed a Context object so we can</span>
-      <span class="ruby-comment cmt"># recurse.  If so, use its values for some of these.</span>
-      <span class="ruby-comment cmt">#</span>
-      <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">FormatText</span><span class="ruby-operator">::</span><span class="ruby-constant">Context</span>))
-        <span class="ruby-identifier">eContext</span> = <span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>]
-        <span class="ruby-identifier">usedArgs</span> = <span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">usedArgs</span>
-        <span class="ruby-identifier">argList</span> = <span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">argList</span>
-      <span class="ruby-keyword kw">else</span>
-        <span class="ruby-identifier">usedArgs</span> = []
-        <span class="ruby-identifier">eContext</span> = <span class="ruby-constant">Context</span>.<span class="ruby-identifier">new</span>({
-                                 <span class="ruby-identifier">:ftoObj</span>   =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">self</span>,
-                                 <span class="ruby-identifier">:usedArgs</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">usedArgs</span>,
-                                 <span class="ruby-identifier">:argList</span>  =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">argList</span>
-                               })
-      <span class="ruby-keyword kw">end</span>
-      <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>
-      <span class="ruby-identifier">effector</span> = <span class="ruby-identifier">sMatched</span> = <span class="ruby-keyword kw">nil</span>
-      <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">m</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@@regex</span>))
-        <span class="ruby-comment cmt">#</span>
-        <span class="ruby-comment cmt"># Find out which effector was matched.  The index in .captures</span>
-        <span class="ruby-comment cmt"># will be the same as the index in @effectors.</span>
-        <span class="ruby-comment cmt">#</span>
-        <span class="ruby-identifier">m</span>.<span class="ruby-identifier">captures</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>
-          <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">m</span>.<span class="ruby-identifier">captures</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">nil?</span>)
-          <span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">effectorObj</span> = <span class="ruby-identifier">effector</span> = <span class="ruby-ivar">@@EnabledEffectors</span>[<span class="ruby-ivar">@@EffectorKeys</span>[<span class="ruby-identifier">i</span>]]
-          <span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">sMatched</span> = <span class="ruby-identifier">sMatched</span> = <span class="ruby-identifier">m</span>.<span class="ruby-identifier">captures</span>[<span class="ruby-identifier">i</span>]
-          <span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">reuseArg</span> = <span class="ruby-keyword kw">false</span>
-          <span class="ruby-keyword kw">break</span>
-        <span class="ruby-keyword kw">end</span>
-        <span class="ruby-comment cmt">#</span>
-        <span class="ruby-comment cmt"># Call the workhorse for this descriptor</span>
-        <span class="ruby-comment cmt">#</span>
-        <span class="ruby-identifier">replacement</span> = <span class="ruby-identifier">effector</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">eContext</span>)
-        <span class="ruby-identifier">result</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-identifier">sMatched</span>, <span class="ruby-identifier">replacement</span>)
-        <span class="ruby-comment cmt">#</span>
-        <span class="ruby-comment cmt"># Mark the item at the front of the argument list as having</span>
-        <span class="ruby-comment cmt"># been used, if the effector agrees.</span>
-        <span class="ruby-comment cmt">#</span>
-        <span class="ruby-identifier">usedArgs</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">shift</span>) <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">reuseArg</span>)
-      <span class="ruby-keyword kw">end</span>
-      <span class="ruby-identifier">result</span>
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 413</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">findEffectors</span>(<span class="ruby-identifier">pattern</span>)
+      <span class="ruby-identifier">pattern</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pattern</span>) <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Regexp</span>)
+      <span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@@RegisteredEffectors</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">id</span>,<span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">pattern</span>) }
+      <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">id</span>,<span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span> }
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/FormatText/FTO.src/M000008.html

@@ -10,15 +10,15 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 387</span>
+  <pre><span class="ruby-comment cmt"># File lib/fto.rb, line 432</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">format</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">argListp</span>)
       <span class="ruby-identifier">argList</span> = <span class="ruby-identifier">argListp</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-ivar">@args</span>.<span class="ruby-identifier">clone</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">argListp</span>
       <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Array</span>)) <span class="ruby-operator">&amp;&amp;</span> 
         <span class="ruby-identifier">argList</span> = <span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>]
       <span class="ruby-keyword kw">end</span>
       <span class="ruby-comment cmt">#</span>
-      <span class="ruby-comment cmt"># It's possible we were passed a Context object so we can recurse.</span>
-      <span class="ruby-comment cmt"># If so, use its values for some of these.</span>
+      <span class="ruby-comment cmt"># It's possible we were passed a Context object so we can</span>
+      <span class="ruby-comment cmt"># recurse.  If so, use its values for some of these.</span>
       <span class="ruby-comment cmt">#</span>
       <span class="ruby-keyword kw">if</span> ((<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">FormatText</span><span class="ruby-operator">::</span><span class="ruby-constant">Context</span>))
         <span class="ruby-identifier">eContext</span> = <span class="ruby-identifier">argList</span>[<span class="ruby-value">0</span>]
@@ -32,9 +32,10 @@
                                  <span class="ruby-identifier">:argList</span>  =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">argList</span>
                                })
       <span class="ruby-keyword kw">end</span>
-      <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>
+      <span class="ruby-identifier">input</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>
+      <span class="ruby-identifier">output</span> = <span class="ruby-identifier">input</span>.<span class="ruby-identifier">clone</span>
       <span class="ruby-identifier">effector</span> = <span class="ruby-identifier">sMatched</span> = <span class="ruby-keyword kw">nil</span>
-      <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">m</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@@regex</span>))
+      <span class="ruby-keyword kw">while</span> (<span class="ruby-identifier">m</span> = <span class="ruby-identifier">input</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@@regex</span>))
         <span class="ruby-comment cmt">#</span>
         <span class="ruby-comment cmt"># Find out which effector was matched.  The index in .captures</span>
         <span class="ruby-comment cmt"># will be the same as the index in @effectors.</span>
@@ -50,14 +51,21 @@
         <span class="ruby-comment cmt"># Call the workhorse for this descriptor</span>
         <span class="ruby-comment cmt">#</span>
         <span class="ruby-identifier">replacement</span> = <span class="ruby-identifier">effector</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">eContext</span>)
-        <span class="ruby-identifier">result</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-identifier">sMatched</span>, <span class="ruby-identifier">replacement</span>)
+        <span class="ruby-identifier">output</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-identifier">sMatched</span>, <span class="ruby-identifier">replacement</span>)
+        <span class="ruby-identifier">input</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-identifier">sMatched</span>, <span class="ruby-value str">''</span>)
         <span class="ruby-comment cmt">#</span>
         <span class="ruby-comment cmt"># Mark the item at the front of the argument list as having</span>
-        <span class="ruby-comment cmt"># been used, if the effector agrees.</span>
+        <span class="ruby-comment cmt"># been used, if the effector agrees.  Assume that an argument</span>
+        <span class="ruby-comment cmt"># was actually used if we're moving it, and that the 'last</span>
+        <span class="ruby-comment cmt"># argument used' hasn't changed if the effector has set</span>
+        <span class="ruby-comment cmt"># _reuseArg_.</span>
         <span class="ruby-comment cmt">#</span>
-        <span class="ruby-identifier">usedArgs</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">shift</span>) <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">reuseArg</span>)
+        <span class="ruby-keyword kw">unless</span> (<span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">reuseArg</span>)
+          <span class="ruby-identifier">usedArgs</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">argList</span>.<span class="ruby-identifier">shift</span>)
+          <span class="ruby-identifier">eContext</span>.<span class="ruby-identifier">lastArgUsed</span> = <span class="ruby-identifier">usedArgs</span>.<span class="ruby-identifier">last</span>
+        <span class="ruby-keyword kw">end</span>
       <span class="ruby-keyword kw">end</span>
-      <span class="ruby-identifier">result</span>
+      <span class="ruby-identifier">output</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>