File: C:/Ruby27-x64/share/doc/ruby/html/Psych/TreeBuilder.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Psych::TreeBuilder - 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="Handler.html">Psych::Handler</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-alias">#alias</a>
<li ><a href="#method-i-end_document">#end_document</a>
<li ><a href="#method-i-end_stream">#end_stream</a>
<li ><a href="#method-i-event_location">#event_location</a>
<li ><a href="#method-i-pop">#pop</a>
<li ><a href="#method-i-push">#push</a>
<li ><a href="#method-i-scalar">#scalar</a>
<li ><a href="#method-i-set_end_location">#set_end_location</a>
<li ><a href="#method-i-set_location">#set_location</a>
<li ><a href="#method-i-set_start_location">#set_start_location</a>
<li ><a href="#method-i-start_document">#start_document</a>
<li ><a href="#method-i-start_stream">#start_stream</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Psych::TreeBuilder">
<h1 id="class-Psych::TreeBuilder" class="class">
class Psych::TreeBuilder
</h1>
<section class="description">
<p>This class works in conjunction with <a href="Parser.html"><code>Psych::Parser</code></a> to build an in-memory parse tree that represents a YAML document.</p>
<h2 id="class-Psych::TreeBuilder-label-Example">Example<span><a href="#class-Psych::TreeBuilder-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">parser</span> = <span class="ruby-constant">Psych</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">new</span> <span class="ruby-constant">Psych</span><span class="ruby-operator">::</span><span class="ruby-constant">TreeBuilder</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">'--- foo'</span>)
<span class="ruby-identifier">tree</span> = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">handler</span>.<span class="ruby-identifier">root</span>
</pre>
<p>See <a href="Handler.html"><code>Psych::Handler</code></a> for documentation on the event methods used in this class.</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-root" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">root</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Returns the root node for the built tree</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">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new <a href="TreeBuilder.html"><code>TreeBuilder</code></a> instance</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@stack</span> = []
<span class="ruby-ivar">@last</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@root</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@start_line</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@start_column</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@end_line</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@end_column</span> = <span class="ruby-keyword">nil</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-alias" class="method-detail ">
<div class="method-heading">
<span class="method-name">alias</span><span
class="method-args">(anchor)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="alias-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">alias</span> <span class="ruby-identifier ruby-title">anchor</span>
<span class="ruby-identifier">a</span> = <span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Alias</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">anchor</span>)
<span class="ruby-identifier">set_location</span>(<span class="ruby-identifier">a</span>)
<span class="ruby-ivar">@last</span>.<span class="ruby-identifier">children</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a</span>
<span class="ruby-identifier">a</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-end_document" class="method-detail ">
<div class="method-heading">
<span class="method-name">end_document</span><span
class="method-args">(implicit_end = !streaming?)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Handles <a href="TreeBuilder.html#method-i-end_document"><code>end_document</code></a> events with <code>version</code>, <code>tag_directives</code>, and <code>implicit</code> styling.</p>
<p>See <a href="Handler.html#method-i-start_document"><code>Psych::Handler#start_document</code></a></p>
<div class="method-source-code" id="end_document-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_document</span> <span class="ruby-identifier">implicit_end</span> = <span class="ruby-operator">!</span><span class="ruby-identifier">streaming?</span>
<span class="ruby-ivar">@last</span>.<span class="ruby-identifier">implicit_end</span> = <span class="ruby-identifier">implicit_end</span>
<span class="ruby-identifier">n</span> = <span class="ruby-identifier">pop</span>
<span class="ruby-identifier">set_end_location</span>(<span class="ruby-identifier">n</span>)
<span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-end_stream" class="method-detail ">
<div class="method-heading">
<span class="method-name">end_stream</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="end_stream-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_stream</span>
<span class="ruby-identifier">n</span> = <span class="ruby-identifier">pop</span>
<span class="ruby-identifier">set_end_location</span>(<span class="ruby-identifier">n</span>)
<span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-event_location" class="method-detail ">
<div class="method-heading">
<span class="method-name">event_location</span><span
class="method-args">(start_line, start_column, end_line, end_column)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="event_location-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">event_location</span>(<span class="ruby-identifier">start_line</span>, <span class="ruby-identifier">start_column</span>, <span class="ruby-identifier">end_line</span>, <span class="ruby-identifier">end_column</span>)
<span class="ruby-ivar">@start_line</span> = <span class="ruby-identifier">start_line</span>
<span class="ruby-ivar">@start_column</span> = <span class="ruby-identifier">start_column</span>
<span class="ruby-ivar">@end_line</span> = <span class="ruby-identifier">end_line</span>
<span class="ruby-ivar">@end_column</span> = <span class="ruby-identifier">end_column</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scalar" class="method-detail ">
<div class="method-heading">
<span class="method-name">scalar</span><span
class="method-args">(value, anchor, tag, plain, quoted, style)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="scalar-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 96</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scalar</span> <span class="ruby-identifier">value</span>, <span class="ruby-identifier">anchor</span>, <span class="ruby-identifier">tag</span>, <span class="ruby-identifier">plain</span>, <span class="ruby-identifier">quoted</span>, <span class="ruby-identifier">style</span>
<span class="ruby-identifier">s</span> = <span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Scalar</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">value</span>,<span class="ruby-identifier">anchor</span>,<span class="ruby-identifier">tag</span>,<span class="ruby-identifier">plain</span>,<span class="ruby-identifier">quoted</span>,<span class="ruby-identifier">style</span>)
<span class="ruby-identifier">set_location</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-ivar">@last</span>.<span class="ruby-identifier">children</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>
<span class="ruby-identifier">s</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start_document" class="method-detail ">
<div class="method-heading">
<span class="method-name">start_document</span><span
class="method-args">(version, tag_directives, implicit)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Handles <a href="TreeBuilder.html#method-i-start_document"><code>start_document</code></a> events with <code>version</code>, <code>tag_directives</code>, and <code>implicit</code> styling.</p>
<p>See <a href="Handler.html#method-i-start_document"><code>Psych::Handler#start_document</code></a></p>
<div class="method-source-code" id="start_document-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 65</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_document</span> <span class="ruby-identifier">version</span>, <span class="ruby-identifier">tag_directives</span>, <span class="ruby-identifier">implicit</span>
<span class="ruby-identifier">n</span> = <span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">version</span>, <span class="ruby-identifier">tag_directives</span>, <span class="ruby-identifier">implicit</span>
<span class="ruby-identifier">set_start_location</span>(<span class="ruby-identifier">n</span>)
<span class="ruby-ivar">@last</span>.<span class="ruby-identifier">children</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">n</span>
<span class="ruby-identifier">push</span> <span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start_stream" class="method-detail ">
<div class="method-heading">
<span class="method-name">start_stream</span><span
class="method-args">(encoding)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="start_stream-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_stream</span> <span class="ruby-identifier">encoding</span>
<span class="ruby-ivar">@root</span> = <span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Stream</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">encoding</span>)
<span class="ruby-identifier">set_start_location</span>(<span class="ruby-ivar">@root</span>)
<span class="ruby-identifier">push</span> <span class="ruby-ivar">@root</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-pop" class="method-detail ">
<div class="method-heading">
<span class="method-name">pop</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="pop-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 116</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pop</span>
<span class="ruby-identifier">x</span> = <span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-ivar">@last</span> = <span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">last</span>
<span class="ruby-identifier">x</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-push" class="method-detail ">
<div class="method-heading">
<span class="method-name">push</span><span
class="method-args">(value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="push-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 111</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">push</span> <span class="ruby-identifier">value</span>
<span class="ruby-ivar">@stack</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">value</span>
<span class="ruby-ivar">@last</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_end_location" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_end_location</span><span
class="method-args">(node)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="set_end_location-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 132</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_end_location</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">end_line</span> = <span class="ruby-ivar">@end_line</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">end_column</span> = <span class="ruby-ivar">@end_column</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_location" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_location</span><span
class="method-args">(node)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="set_location-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_location</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">set_start_location</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">set_end_location</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_start_location" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_start_location</span><span
class="method-args">(node)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="set_start_location-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/tree_builder.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_start_location</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">start_line</span> = <span class="ruby-ivar">@start_line</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">start_column</span> = <span class="ruby-ivar">@start_column</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>