File: C:/Ruby27-x64/share/doc/ruby/html/REXML/IOSource.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::IOSource - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Source.html">REXML::Source</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-consume">#consume</a>
<li ><a href="#method-i-current_line">#current_line</a>
<li class="calls-super" ><a href="#method-i-empty-3F">#empty?</a>
<li class="calls-super" ><a href="#method-i-encoding_updated">#encoding_updated</a>
<li ><a href="#method-i-match">#match</a>
<li ><a href="#method-i-position">#position</a>
<li ><a href="#method-i-read">#read</a>
<li ><a href="#method-i-readline">#readline</a>
<li class="calls-super" ><a href="#method-i-scan">#scan</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::IOSource">
<h1 id="class-REXML::IOSource" class="class">
class REXML::IOSource
</h1>
<section class="description">
<p>A <a href="Source.html"><code>Source</code></a> that wraps an <a href="../IO.html"><code>IO</code></a>. See the <a href="Source.html"><code>Source</code></a> class for method documentation</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(arg, block_size=500, encoding=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>block_size has been deprecated</p>
<div class="method-calls-super">
Calls superclass method
<a href="Source.html#method-c-new"><code>REXML::Source::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 163</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>
<span class="ruby-ivar">@pending_buffer</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">encoding</span>
<span class="ruby-keyword">super</span>(<span class="ruby-string">""</span>, <span class="ruby-identifier">encoding</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">super</span>(<span class="ruby-ivar">@source</span>.<span class="ruby-identifier">read</span>(<span class="ruby-value">3</span>) <span class="ruby-operator">||</span> <span class="ruby-string">""</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@to_utf</span> <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@buffer</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:force_encoding</span>) <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@source</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:external_encoding</span>) <span class="ruby-keyword">and</span>
<span class="ruby-ivar">@source</span>.<span class="ruby-identifier">external_encoding</span> <span class="ruby-operator">!=</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>
<span class="ruby-ivar">@force_utf8</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@force_utf8</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-consume" class="method-detail ">
<div class="method-heading">
<span class="method-name">consume</span><span
class="method-args">( pattern )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="consume-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 215</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">consume</span>( <span class="ruby-identifier">pattern</span> )
<span class="ruby-identifier">match</span>( <span class="ruby-identifier">pattern</span>, <span class="ruby-keyword">true</span> )
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-current_line" class="method-detail ">
<div class="method-heading">
<span class="method-name">current_line</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return the current line in the source</p>
<div class="method-source-code" id="current_line-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 244</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>
<span class="ruby-identifier">lineno</span> = <span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">lineno</span> <span class="ruby-comment"># The XML < position in the source</span>
<span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">rewind</span>
<span class="ruby-identifier">line</span> = <span class="ruby-value">0</span> <span class="ruby-comment"># The \r\n position in the source</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">while</span> <span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">pos</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">pos</span>
<span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">readline</span>
<span class="ruby-identifier">line</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-identifier">pos</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IOError</span>
<span class="ruby-identifier">pos</span> = <span class="ruby-value">-1</span>
<span class="ruby-identifier">line</span> = <span class="ruby-value">-1</span>
<span class="ruby-keyword">end</span>
[<span class="ruby-identifier">pos</span>, <span class="ruby-identifier">lineno</span>, <span class="ruby-identifier">line</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="Source.html#method-i-empty-3F"><code>REXML::Source#empty?</code></a>
</div>
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 235</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>
</div>
</div>
</div>
<div id="method-i-match" class="method-detail ">
<div class="method-heading">
<span class="method-name">match</span><span
class="method-args">( pattern, cons=false )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="match-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 219</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-identifier">rv</span> = <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@buffer</span>)
<span class="ruby-ivar">@buffer</span> = <span class="ruby-node">$'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">cons</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">while</span> <span class="ruby-operator">!</span><span class="ruby-identifier">rv</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@source</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">readline</span>
<span class="ruby-identifier">rv</span> = <span class="ruby-identifier">pattern</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@buffer</span>)
<span class="ruby-ivar">@buffer</span> = <span class="ruby-node">$'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">cons</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-ivar">@source</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rv</span>.<span class="ruby-identifier">taint</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">RUBY_VERSION</span> <span class="ruby-operator"><</span> <span class="ruby-string">'2.7'</span>
<span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-position" class="method-detail ">
<div class="method-heading">
<span class="method-name">position</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="position-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 239</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">position</span>
<span class="ruby-ivar">@er_source</span>.<span class="ruby-identifier">pos</span> <span class="ruby-keyword">rescue</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-read" class="method-detail ">
<div class="method-heading">
<span class="method-name">read</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="read-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 207</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">readline</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>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scan" class="method-detail ">
<div class="method-heading">
<span class="method-name">scan</span><span
class="method-args">(pattern, cons=false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="Source.html#method-i-scan"><code>REXML::Source#scan</code></a>
</div>
<div class="method-source-code" id="scan-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 184</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scan</span>(<span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">cons</span>=<span class="ruby-keyword">false</span>)
<span class="ruby-identifier">rv</span> = <span class="ruby-keyword">super</span>
<span class="ruby-comment"># You'll notice that this next section is very similar to the same</span>
<span class="ruby-comment"># section in match(), but just a liiittle different. This is</span>
<span class="ruby-comment"># because it is a touch faster to do it this way with scan()</span>
<span class="ruby-comment"># than the way match() does it; enough faster to warrant duplicating</span>
<span class="ruby-comment"># some code</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">rv</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">until</span> <span class="ruby-ivar">@buffer</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">pattern</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@source</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">readline</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Iconv</span><span class="ruby-operator">::</span><span class="ruby-constant">IllegalSequence</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-ivar">@source</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rv</span> = <span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rv</span>.<span class="ruby-identifier">taint</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">RUBY_VERSION</span> <span class="ruby-operator"><</span> <span class="ruby-string">'2.7'</span>
<span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-encoding_updated" class="method-detail ">
<div class="method-heading">
<span class="method-name">encoding_updated</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="Source.html#method-i-encoding_updated"><code>REXML::Source#encoding_updated</code></a>
</div>
<div class="method-source-code" id="encoding_updated-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 286</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">encoding_updated</span>
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@encoding</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">"UTF-16BE"</span>, <span class="ruby-string">"UTF-16LE"</span>
<span class="ruby-ivar">@source</span>.<span class="ruby-identifier">binmode</span>
<span class="ruby-ivar">@source</span>.<span class="ruby-identifier">set_encoding</span>(<span class="ruby-ivar">@encoding</span>, <span class="ruby-ivar">@encoding</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@line_break</span> = <span class="ruby-identifier">encode</span>(<span class="ruby-string">">"</span>)
<span class="ruby-ivar">@pending_buffer</span>, <span class="ruby-ivar">@buffer</span> = <span class="ruby-ivar">@buffer</span>, <span class="ruby-string">""</span>
<span class="ruby-ivar">@pending_buffer</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-ivar">@encoding</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-readline" class="method-detail ">
<div class="method-heading">
<span class="method-name">readline</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="readline-source">
<pre><span class="ruby-comment"># File lib/rexml/source.rb, line 266</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readline</span>
<span class="ruby-identifier">str</span> = <span class="ruby-ivar">@source</span>.<span class="ruby-identifier">readline</span>(<span class="ruby-ivar">@line_break</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@pending_buffer</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">str</span> = <span class="ruby-ivar">@pending_buffer</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">str</span> = <span class="ruby-ivar">@pending_buffer</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@pending_buffer</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@to_utf</span>
<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@force_utf8</span>
<span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>