File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Formatters/Pretty.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Formatters::Pretty - 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="Default.html">REXML::Formatters::Default</a>
</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-new">::new</a>
<li ><a href="#method-i-indent_text">#indent_text</a>
<li ><a href="#method-i-wrap">#wrap</a>
<li class="calls-super" ><a href="#method-i-write_cdata">#write_cdata</a>
<li class="calls-super" ><a href="#method-i-write_comment">#write_comment</a>
<li ><a href="#method-i-write_document">#write_document</a>
<li ><a href="#method-i-write_element">#write_element</a>
<li ><a href="#method-i-write_text">#write_text</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Formatters::Pretty">
<h1 id="class-REXML::Formatters::Pretty" class="class">
class REXML::Formatters::Pretty
</h1>
<section class="description">
<p>Pretty-prints an <a href="../../XML.html"><code>XML</code></a> document. This destroys whitespace in text nodes and will insert carriage returns and indentations.</p>
<p>TODO: Add an option to print attributes on new lines</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-compact" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">compact</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>If compact is set to true, then the formatter will attempt to use as little space as possible</p>
</div>
</div>
<div id="attribute-i-width" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">width</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The width of a page. Used for formatting text</p>
</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">( indentation=2, ie_hack=false )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new pretty printer.</p>
<dl class="rdoc-list note-list"><dt>output
<dd>
<p>An object implementing '<<(<a href="../../String.html"><code>String</code></a>)', to which the output will be written.</p>
</dd><dt>indentation
<dd>
<p>An integer greater than 0. The indentation of each level will be this number of spaces. If this is < 1, the behavior of this object is undefined. Defaults to 2.</p>
</dd><dt>ie_hack
<dd>
<p>If true, the printer will insert whitespace before closing empty tags, thereby allowing Internet Explorer's <a href="../../XML.html"><code>XML</code></a> parser to function. Defaults to false.</p>
</dd></dl>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">indentation</span>=<span class="ruby-value">2</span>, <span class="ruby-identifier">ie_hack</span>=<span class="ruby-keyword">false</span> )
<span class="ruby-ivar">@indentation</span> = <span class="ruby-identifier">indentation</span>
<span class="ruby-ivar">@level</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@ie_hack</span> = <span class="ruby-identifier">ie_hack</span>
<span class="ruby-ivar">@width</span> = <span class="ruby-value">80</span>
<span class="ruby-ivar">@compact</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-write_cdata" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_cdata</span><span
class="method-args">( node, output)</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="Default.html#method-i-write_cdata"><code>REXML::Formatters::Default#write_cdata</code></a>
</div>
<div class="method-source-code" id="write_cdata-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 102</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_cdata</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span>)
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span> <span class="ruby-operator">*</span> <span class="ruby-ivar">@level</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_comment" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_comment</span><span
class="method-args">( node, output)</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="Default.html#method-i-write_comment"><code>REXML::Formatters::Default#write_comment</code></a>
</div>
<div class="method-source-code" id="write_comment-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_comment</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span>)
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span> <span class="ruby-operator">*</span> <span class="ruby-ivar">@level</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_document" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_document</span><span
class="method-args">( node, output )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write_document-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_document</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-comment"># Ok, this is a bit odd. All XML documents have an XML declaration,</span>
<span class="ruby-comment"># but it may not write itself if the user didn't specifically add it,</span>
<span class="ruby-comment"># either through the API or in the input document. If it doesn't write</span>
<span class="ruby-comment"># itself, then we don't need a carriage return... which makes this</span>
<span class="ruby-comment"># logic more complex.</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">child</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">-1</span>] <span class="ruby-keyword">and</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">Text</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">child</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">0</span>] <span class="ruby-keyword">or</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">Text</span>) <span class="ruby-keyword">or</span>
(<span class="ruby-identifier">child</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">1</span>] <span class="ruby-keyword">and</span> <span class="ruby-operator">!</span><span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">writethis</span>)
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">write</span>( <span class="ruby-identifier">child</span>, <span class="ruby-identifier">output</span> )
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_element" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_element</span><span
class="method-args">(node, output)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write_element-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_element</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span>)
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span><span class="ruby-operator">*</span><span class="ruby-ivar">@level</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<#{node.expanded_name}"</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each_attribute</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" "</span>
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">write</span>( <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@ie_hack</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" "</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"/"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">">"</span>
<span class="ruby-comment"># If compact and all children are text, and if the formatted output</span>
<span class="ruby-comment"># is less than the specified width, then try to print everything on</span>
<span class="ruby-comment"># one line</span>
<span class="ruby-identifier">skip</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">compact</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-keyword">true</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span>,<span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">&</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Text</span>)}
<span class="ruby-identifier">string</span> = <span class="ruby-string">""</span>
<span class="ruby-identifier">old_level</span> = <span class="ruby-ivar">@level</span>
<span class="ruby-ivar">@level</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span> <span class="ruby-identifier">write</span>( <span class="ruby-identifier">child</span>, <span class="ruby-identifier">string</span> ) }
<span class="ruby-ivar">@level</span> = <span class="ruby-identifier">old_level</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@width</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">string</span>
<span class="ruby-identifier">skip</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">skip</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-ivar">@level</span> <span class="ruby-operator">+=</span> <span class="ruby-ivar">@indentation</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Text</span>) <span class="ruby-keyword">and</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">write</span>( <span class="ruby-identifier">child</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
}
<span class="ruby-ivar">@level</span> <span class="ruby-operator">-=</span> <span class="ruby-ivar">@indentation</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span><span class="ruby-operator">*</span><span class="ruby-ivar">@level</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"</#{node.expanded_name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">">"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_text" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_text</span><span
class="method-args">( node, output )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write_text-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_text</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">node</span>.<span class="ruby-identifier">to_s</span>()
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">/\s/</span>,<span class="ruby-string">' '</span>)
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">squeeze!</span>(<span class="ruby-string">" "</span>)
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">wrap</span>(<span class="ruby-identifier">s</span>, <span class="ruby-ivar">@width</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@level</span>)
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">indent_text</span>(<span class="ruby-identifier">s</span>, <span class="ruby-ivar">@level</span>, <span class="ruby-string">" "</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> (<span class="ruby-string">' '</span><span class="ruby-operator">*</span><span class="ruby-ivar">@level</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">s</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-indent_text" class="method-detail ">
<div class="method-heading">
<span class="method-name">indent_text</span><span
class="method-args">(string, level=1, style="\t", indentfirstline=true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="indent_text-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 124</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">indent_text</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">level</span>=<span class="ruby-value">1</span>, <span class="ruby-identifier">style</span>=<span class="ruby-string">"\t"</span>, <span class="ruby-identifier">indentfirstline</span>=<span class="ruby-keyword">true</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">string</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">level</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">string</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\n/</span>, <span class="ruby-node">"\n#{style*level}"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-wrap" class="method-detail ">
<div class="method-heading">
<span class="method-name">wrap</span><span
class="method-args">(string, width)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="wrap-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/pretty.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">wrap</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">width</span>)
<span class="ruby-identifier">parts</span> = []
<span class="ruby-keyword">while</span> <span class="ruby-identifier">string</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-identifier">width</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">place</span> = <span class="ruby-identifier">string</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-string">' '</span>, <span class="ruby-identifier">width</span>)
<span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">string</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">place</span>]
<span class="ruby-identifier">string</span> = <span class="ruby-identifier">string</span>[<span class="ruby-identifier">place</span><span class="ruby-value">+1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">parts</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">string</span>
<span class="ruby-identifier">parts</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</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>