File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Entity.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Entity - 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="Child.html">REXML::Child</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="XMLTokens.html">REXML::XMLTokens</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-matches-3F">::matches?</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-normalized">#normalized</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-unnormalized">#unnormalized</a>
<li ><a href="#method-i-value">#value</a>
<li ><a href="#method-i-write">#write</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Entity">
<h1 id="class-REXML::Entity" class="class">
class REXML::Entity
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ENTITYDECL">ENTITYDECL
<dd>
<dt id="ENTITYDEF">ENTITYDEF
<dd>
<dt id="ENTITYVALUE">ENTITYVALUE
<dd>
<dt id="EXTERNALID">EXTERNALID
<dd>
<dt id="GEDECL">GEDECL
<dd>
<dt id="NDATADECL">NDATADECL
<dd>
<dt id="PEDECL">PEDECL
<dd>
<dt id="PEDEF">PEDEF
<dd>
<dt id="PEREFERENCE">PEREFERENCE
<dd>
<dt id="PEREFERENCE_RE">PEREFERENCE_RE
<dd>
<dt id="PUBIDCHAR">PUBIDCHAR
<dd>
<dt id="PUBIDLITERAL">PUBIDLITERAL
<dd>
<dt id="SYSTEMLITERAL">SYSTEMLITERAL
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-external" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">external</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-ndata" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">ndata</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-pubid" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">pubid</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-ref" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">ref</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-matches-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">matches?</span><span
class="method-args">(string)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Evaluates whether the given string matches an entity definition, returning true if so, and false otherwise.</p>
<div class="method-source-code" id="matches-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Entity</span><span class="ruby-operator">::</span><span class="ruby-identifier ruby-title">matches?</span> <span class="ruby-identifier">string</span>
(<span class="ruby-constant">ENTITYDECL</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">string</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(stream, value=nil, parent=nil, reference=false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new entity. Simple entities can be constructed by passing a name, value to the constructor; this creates a generic, plain entity reference. For anything more complicated, you have to pass a <a href="Source.html"><code>Source</code></a> to the constructor with the entity definition, or use the accessor methods. <code>WARNING</code>: There is no validation of entity state except when the entity is read from a stream. If you start poking around with the accessors, you can easily create a non-conformant <a href="Entity.html"><code>Entity</code></a>.</p>
<pre class="ruby"><span class="ruby-identifier">e</span> = <span class="ruby-constant">Entity</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">'amp'</span>, <span class="ruby-string">'&'</span> )
</pre>
<div class="method-calls-super">
Calls superclass method
<a href="Child.html#method-c-new"><code>REXML::Child::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">stream</span>, <span class="ruby-identifier">value</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">parent</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reference</span>=<span class="ruby-keyword">false</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">parent</span>)
<span class="ruby-ivar">@ndata</span> = <span class="ruby-ivar">@pubid</span> = <span class="ruby-ivar">@value</span> = <span class="ruby-ivar">@external</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Array</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">1</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'%'</span>
<span class="ruby-ivar">@reference</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">stream</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@reference</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>[<span class="ruby-value">2</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/SYSTEM|PUBLIC/</span>
<span class="ruby-ivar">@external</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">2</span>]
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@external</span> <span class="ruby-operator">==</span> <span class="ruby-string">'SYSTEM'</span>
<span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">3</span>]
<span class="ruby-ivar">@ndata</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">4</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">stream</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">5</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@pubid</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">3</span>]
<span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">4</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@value</span> = <span class="ruby-identifier">stream</span>[<span class="ruby-value">2</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@reference</span> = <span class="ruby-identifier">reference</span>
<span class="ruby-ivar">@external</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">stream</span>
<span class="ruby-ivar">@value</span> = <span class="ruby-identifier">value</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-normalized" class="method-detail ">
<div class="method-heading">
<span class="method-name">normalized</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the value of this entity unprocessed – raw. This is the normalized value; that is, with all %ent; and &ent; entities intact</p>
<div class="method-source-code" id="normalized-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">normalized</span>
<span class="ruby-ivar">@value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns this entity as a string. See write().</p>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 119</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-identifier">rv</span> = <span class="ruby-string">''</span>
<span class="ruby-identifier">write</span> <span class="ruby-identifier">rv</span>
<span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unnormalized" class="method-detail ">
<div class="method-heading">
<span class="method-name">unnormalized</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Evaluates to the unnormalized value of this entity; that is, replacing all entities – both %ent; and &ent; entities. This differs from +value()+ in that <code>value</code> only replaces %ent; entities.</p>
<div class="method-source-code" id="unnormalized-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unnormalized</span>
<span class="ruby-identifier">document</span>.<span class="ruby-identifier">record_entity_expansion</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">document</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">v</span> = <span class="ruby-identifier">value</span>()
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@unnormalized</span> = <span class="ruby-constant">Text</span><span class="ruby-operator">::</span><span class="ruby-identifier">unnormalize</span>(<span class="ruby-identifier">v</span>, <span class="ruby-identifier">parent</span>)
<span class="ruby-ivar">@unnormalized</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-value" class="method-detail ">
<div class="method-heading">
<span class="method-name">value</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the value of this entity. At the moment, only internal entities are processed. If the value contains internal references (IE, %blah;), those are replaced with their values. IE, if the doctype contains:</p>
<pre><!ENTITY % foo "bar">
<!ENTITY yada "nanoo %foo; nanoo></pre>
<p>then:</p>
<pre class="ruby"><span class="ruby-identifier">doctype</span>.<span class="ruby-identifier">entity</span>(<span class="ruby-string">'yada'</span>).<span class="ruby-identifier">value</span> <span class="ruby-comment">#-> "nanoo bar nanoo"</span>
</pre>
<div class="method-source-code" id="value-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">value</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@value</span>
<span class="ruby-identifier">matches</span> = <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-constant">PEREFERENCE_RE</span>)
<span class="ruby-identifier">rv</span> = <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">clone</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@parent</span>
<span class="ruby-identifier">sum</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">matches</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entity_reference</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">entity_value</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">entity</span>( <span class="ruby-identifier">entity_reference</span>[<span class="ruby-value">0</span>] )
<span class="ruby-keyword">if</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">entity_value</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">></span> <span class="ruby-constant">Security</span>.<span class="ruby-identifier">entity_expansion_text_limit</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">"entity expansion has grown too large"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">sum</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">entity_value</span>.<span class="ruby-identifier">bytesize</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">rv</span>.<span class="ruby-identifier">gsub!</span>( <span class="ruby-regexp">/%#{entity_reference.join};/um</span>, <span class="ruby-identifier">entity_value</span> )
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(out, indent=-1)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Write out a fully formed, correct entity definition (assuming the <a href="Entity.html"><code>Entity</code></a> object itself is valid.)</p>
<dl class="rdoc-list note-list"><dt>out
<dd>
<p>An object implementing <code>&lt;&lt;</code> to which the entity will be output</p>
</dd><dt>indent
<dd>
<p><strong>DEPRECATED</strong> and ignored</p>
</dd></dl>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rexml/entity.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span> <span class="ruby-identifier">out</span>, <span class="ruby-identifier">indent</span>=<span class="ruby-value">-1</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'<!ENTITY '</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'% '</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@reference</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@name</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@external</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@external</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@pubid</span>
<span class="ruby-identifier">q</span> = <span class="ruby-ivar">@pubid</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'"'</span>)<span class="ruby-operator">?</span><span class="ruby-string">"'"</span><span class="ruby-operator">:</span><span class="ruby-string">'"'</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">q</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@pubid</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">q</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">q</span> = <span class="ruby-ivar">@ref</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'"'</span>)<span class="ruby-operator">?</span><span class="ruby-string">"'"</span><span class="ruby-operator">:</span><span class="ruby-string">'"'</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">q</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@ref</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">q</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' NDATA '</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@ndata</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@ndata</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">q</span> = <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'"'</span>)<span class="ruby-operator">?</span><span class="ruby-string">"'"</span><span class="ruby-operator">:</span><span class="ruby-string">'"'</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">q</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@value</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">q</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'>'</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>