Generate (ba70cfe)

ruby · May 16, 2024 · 094eec7 · 094eec7
1 parent 15ba6ad
commit 094eec7
Show file tree

Hide file tree

Showing 5 changed files with 109 additions and 18 deletions.
diff --git a/REXML/IOSource.html b/REXML/IOSource.html
@@ -87,6 +87,8 @@ <h3>Methods</h3>
 
     <li ><a href="#method-i-read">#read</a>
 
+    <li ><a href="#method-i-read_until">#read_until</a>
+
   </ul>
 </div>
 
@@ -145,7 +147,7 @@ <h3>Public Class Methods</h3>
 
 
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 140</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 144</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">arg</span>, <span class="ruby-identifier">block_size</span>=<span class="ruby-value">500</span>, <span class="ruby-identifier">encoding</span>=<span class="ruby-keyword">nil</span>)
   <span class="ruby-ivar">@er_source</span> = <span class="ruby-ivar">@source</span> = <span class="ruby-identifier">arg</span>
   <span class="ruby-ivar">@to_utf</span> = <span class="ruby-keyword">false</span>
@@ -203,7 +205,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="current_line-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 199</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 218</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">current_line</span>
   <span class="ruby-keyword">begin</span>
     <span class="ruby-identifier">pos</span> = <span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">pos</span>        <span class="ruby-comment"># The byte position in the source</span>
@@ -258,7 +260,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="empty-3F-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 194</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 213</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
   <span class="ruby-keyword">super</span> <span class="ruby-keyword">and</span> ( <span class="ruby-ivar">@source</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@source</span>.<span class="ruby-identifier">eof?</span> )
 <span class="ruby-keyword">end</span></pre>
@@ -291,7 +293,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="ensure_buffer-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 171</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 190</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ensure_buffer</span>
   <span class="ruby-identifier">read</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">eos?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@source</span>
 <span class="ruby-keyword">end</span></pre>
@@ -329,7 +331,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="match-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 178</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 197</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match</span>( <span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">cons</span>=<span class="ruby-keyword">false</span> )
   <span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span>
     <span class="ruby-keyword">if</span> <span class="ruby-identifier">cons</span>
@@ -359,7 +361,7 @@ <h3>Public Instance Methods</h3>
 
         <div class="method-heading">
           <span class="method-name">read</span><span
-            class="method-args">()</span>
+            class="method-args">(term = nil)</span>
 
           <span class="method-click-advice">click to toggle source</span>
 
@@ -374,10 +376,10 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="read-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 161</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 165</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>(<span class="ruby-identifier">term</span> = <span class="ruby-keyword">nil</span>)
   <span class="ruby-keyword">begin</span>
-    <span class="ruby-ivar">@scanner</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">readline</span>
+    <span class="ruby-ivar">@scanner</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">readline</span>(<span class="ruby-identifier">term</span>)
     <span class="ruby-keyword">true</span>
   <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>, <span class="ruby-constant">NameError</span>
     <span class="ruby-ivar">@source</span> = <span class="ruby-keyword">nil</span>
@@ -391,6 +393,50 @@ <h3>Public Instance Methods</h3>
 
 
 
+      </div>
+
+
+      <div id="method-i-read_until" class="method-detail ">
+
+        <div class="method-heading">
+          <span class="method-name">read_until</span><span
+            class="method-args">(term)</span>
+
+          <span class="method-click-advice">click to toggle source</span>
+
+        </div>
+
+
+        <div class="method-description">
+
+
+
+
+
+
+          <div class="method-source-code" id="read_until-source">
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 175</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read_until</span>(<span class="ruby-identifier">term</span>)
+  <span class="ruby-identifier">pattern</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">union</span>(<span class="ruby-identifier">term</span>)
+  <span class="ruby-identifier">data</span> = []
+  <span class="ruby-keyword">begin</span>
+    <span class="ruby-keyword">until</span> <span class="ruby-identifier">str</span> = <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">scan_until</span>(<span class="ruby-identifier">pattern</span>)
+      <span class="ruby-ivar">@scanner</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">readline</span>(<span class="ruby-identifier">term</span>)
+    <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">EOFError</span>
+    <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">rest</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">read</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">eos?</span> <span class="ruby-keyword">and</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@source</span>.<span class="ruby-identifier">eof?</span>
+    <span class="ruby-identifier">str</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+
+        </div>
+
+
+
+
       </div>
 
 

diff --git a/REXML/Source.html b/REXML/Source.html
@@ -108,6 +108,8 @@ <h3>Methods</h3>
 
     <li ><a href="#method-i-read">#read</a>
 
+    <li ><a href="#method-i-read_until">#read_until</a>
+
   </ul>
 </div>
 
@@ -309,7 +311,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="current_line-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 96</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 100</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">current_line</span>
   <span class="ruby-identifier">lines</span> = <span class="ruby-ivar">@orig</span>.<span class="ruby-identifier">split</span>
   <span class="ruby-identifier">res</span> = <span class="ruby-identifier">lines</span>.<span class="ruby-identifier">grep</span> <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">rest</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">30</span>]
@@ -345,7 +347,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="empty-3F-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 91</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 95</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
   <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">eos?</span>
 <span class="ruby-keyword">end</span></pre>
@@ -417,7 +419,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="ensure_buffer-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 71</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 75</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ensure_buffer</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
@@ -449,7 +451,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="match-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 74</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 78</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match</span>(<span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">cons</span>=<span class="ruby-keyword">false</span>)
   <span class="ruby-keyword">if</span> <span class="ruby-identifier">cons</span>
     <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-identifier">pattern</span>).<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@scanner</span>
@@ -486,7 +488,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="position-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 82</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 86</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">position</span>
   <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">pos</span>
 <span class="ruby-keyword">end</span></pre>
@@ -519,7 +521,7 @@ <h3>Public Instance Methods</h3>
 
 
           <div class="method-source-code" id="position-3D-source">
-            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 86</span>
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 90</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">position=</span>(<span class="ruby-identifier">pos</span>)
   <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">pos</span> = <span class="ruby-identifier">pos</span>
 <span class="ruby-keyword">end</span></pre>
@@ -537,7 +539,7 @@ <h3>Public Instance Methods</h3>
 
         <div class="method-heading">
           <span class="method-name">read</span><span
-            class="method-args">()</span>
+            class="method-args">(term = nil)</span>
 
           <span class="method-click-advice">click to toggle source</span>
 
@@ -553,7 +555,40 @@ <h3>Public Instance Methods</h3>
 
           <div class="method-source-code" id="read-source">
             <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 68</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>(<span class="ruby-identifier">term</span> = <span class="ruby-keyword">nil</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+
+        </div>
+
+
+
+
+      </div>
+
+
+      <div id="method-i-read_until" class="method-detail ">
+
+        <div class="method-heading">
+          <span class="method-name">read_until</span><span
+            class="method-args">(term)</span>
+
+          <span class="method-click-advice">click to toggle source</span>
+
+        </div>
+
+
+        <div class="method-description">
+
+
+
+
+
+
+          <div class="method-source-code" id="read_until-source">
+            <pre><span class="ruby-comment"># File lib/rexml/source.rb, line 71</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read_until</span>(<span class="ruby-identifier">term</span>)
+  <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">scan_until</span>(<span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">union</span>(<span class="ruby-identifier">term</span>)) <span class="ruby-keyword">or</span> <span class="ruby-ivar">@scanner</span>.<span class="ruby-identifier">rest</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
 

diff --git a/js/search_index.js b/js/search_index.js
diff --git a/js/search_index.js.gz b/js/search_index.js.gz
diff --git a/table_of_contents.html b/table_of_contents.html
@@ -3153,6 +3153,16 @@ <h2 id="methods">Methods</h2>
     &mdash;
     <span class="container">REXML::IOSource</span>
 
+  <li class="method">
+    <a href="REXML/Source.html#method-i-read_until">#read_until</a>
+    &mdash;
+    <span class="container">REXML::Source</span>
+
+  <li class="method">
+    <a href="REXML/IOSource.html#method-i-read_until">#read_until</a>
+    &mdash;
+    <span class="container">REXML::IOSource</span>
+
   <li class="method">
     <a href="REXML/Validation/RelaxNG.html#method-i-receive">#receive</a>
     &mdash;