File: C:/Ruby27-x64/share/doc/ruby/html/RubyVM/AbstractSyntaxTree/Node.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RubyVM::AbstractSyntaxTree::Node - 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="../../Object.html">Object</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-i-children">#children</a>
<li ><a href="#method-i-first_column">#first_column</a>
<li ><a href="#method-i-first_lineno">#first_lineno</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-last_column">#last_column</a>
<li ><a href="#method-i-last_lineno">#last_lineno</a>
<li ><a href="#method-i-pretty_print">#pretty_print</a>
<li ><a href="#method-i-pretty_print_children">#pretty_print_children</a>
<li ><a href="#method-i-type">#type</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RubyVM::AbstractSyntaxTree::Node">
<h1 id="class-RubyVM::AbstractSyntaxTree::Node" class="class">
class RubyVM::AbstractSyntaxTree::Node
</h1>
<section class="description">
<p><a href="Node.html"><code>RubyVM::AbstractSyntaxTree::Node</code></a> instances are created by parse methods in <a href="../AbstractSyntaxTree.html"><code>RubyVM::AbstractSyntaxTree</code></a>.</p>
<p>This class is MRI specific.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-children" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
children → array
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns AST nodes under this one. Each kind of node has different children, depending on what kind of node it is.</p>
<p>The returned array may contain other nodes or <code>nil</code>.</p>
<div class="method-source-code" id="children-source">
<pre><span class="ruby-comment"># File ast.rb, line 131</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">children</span>
<span class="ruby-identifier">__builtin_ast_node_children</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-first_column" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
first_column → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The column number in the source code where this AST's text began.</p>
<div class="method-source-code" id="first_column-source">
<pre><span class="ruby-comment"># File ast.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">first_column</span>
<span class="ruby-identifier">__builtin_ast_node_first_column</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-first_lineno" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
first_lineno → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The line number in the source code where this AST's text began.</p>
<div class="method-source-code" id="first_lineno-source">
<pre><span class="ruby-comment"># File ast.rb, line 96</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">first_lineno</span>
<span class="ruby-identifier">__builtin_ast_node_first_lineno</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
inspect → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns debugging information about this node as a string.</p>
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File ast.rb, line 139</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>
<span class="ruby-identifier">__builtin_ast_node_inspect</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-last_column" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
last_column → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The column number in the source code where this AST's text ended.</p>
<div class="method-source-code" id="last_column-source">
<pre><span class="ruby-comment"># File ast.rb, line 120</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">last_column</span>
<span class="ruby-identifier">__builtin_ast_node_last_column</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-last_lineno" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
last_lineno → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The line number in the source code where this AST's text ended.</p>
<div class="method-source-code" id="last_lineno-source">
<pre><span class="ruby-comment"># File ast.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">last_lineno</span>
<span class="ruby-identifier">__builtin_ast_node_last_lineno</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-pretty_print" class="method-detail ">
<div class="method-heading">
<span class="method-name">pretty_print</span><span
class="method-args">(q)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="pretty_print-source">
<pre><span class="ruby-comment"># File lib/pp.rb, line 542</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pretty_print</span>(<span class="ruby-identifier">q</span>)
<span class="ruby-identifier">q</span>.<span class="ruby-identifier">group</span>(<span class="ruby-value">1</span>, <span class="ruby-node">"(#{type}@#{first_lineno}:#{first_column}-#{last_lineno}:#{last_column}"</span>, <span class="ruby-string">")"</span>) {
<span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:SCOPE</span>
<span class="ruby-identifier">pretty_print_children</span>(<span class="ruby-identifier">q</span>, <span class="ruby-node">%w"tbl args body"</span>)
<span class="ruby-keyword">when</span> <span class="ruby-value">:ARGS</span>
<span class="ruby-identifier">pretty_print_children</span>(<span class="ruby-identifier">q</span>, <span class="ruby-node">%w[pre_num pre_init opt first_post post_num post_init rest kw kwrest block]</span>)
<span class="ruby-keyword">when</span> <span class="ruby-value">:DEFN</span>
<span class="ruby-identifier">pretty_print_children</span>(<span class="ruby-identifier">q</span>, <span class="ruby-node">%w[mid body]</span>)
<span class="ruby-keyword">when</span> <span class="ruby-value">:ARYPTN</span>
<span class="ruby-identifier">pretty_print_children</span>(<span class="ruby-identifier">q</span>, <span class="ruby-node">%w[const pre rest post]</span>)
<span class="ruby-keyword">when</span> <span class="ruby-value">:HSHPTN</span>
<span class="ruby-identifier">pretty_print_children</span>(<span class="ruby-identifier">q</span>, <span class="ruby-node">%w[const kw kwrest]</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">pretty_print_children</span>(<span class="ruby-identifier">q</span>)
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-pretty_print_children" class="method-detail ">
<div class="method-heading">
<span class="method-name">pretty_print_children</span><span
class="method-args">(q, names = [])</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="pretty_print_children-source">
<pre><span class="ruby-comment"># File lib/pp.rb, line 529</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pretty_print_children</span>(<span class="ruby-identifier">q</span>, <span class="ruby-identifier">names</span> = [])
<span class="ruby-identifier">children</span>.<span class="ruby-identifier">zip</span>(<span class="ruby-identifier">names</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>, <span class="ruby-identifier">n</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">n</span>
<span class="ruby-identifier">q</span>.<span class="ruby-identifier">breakable</span>
<span class="ruby-identifier">q</span>.<span class="ruby-identifier">text</span> <span class="ruby-node">"#{n}:"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">q</span>.<span class="ruby-identifier">group</span>(<span class="ruby-value">2</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">q</span>.<span class="ruby-identifier">breakable</span>
<span class="ruby-identifier">q</span>.<span class="ruby-identifier">pp</span> <span class="ruby-identifier">c</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-type" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
type → symbol
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the type of this node as a symbol.</p>
<pre class="ruby"><span class="ruby-identifier">root</span> = <span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">AbstractSyntaxTree</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">"x = 1 + 2"</span>)
<span class="ruby-identifier">root</span>.<span class="ruby-identifier">type</span> <span class="ruby-comment"># => :SCOPE</span>
<span class="ruby-identifier">call</span> = <span class="ruby-identifier">root</span>.<span class="ruby-identifier">children</span>[<span class="ruby-value">2</span>]
<span class="ruby-identifier">call</span>.<span class="ruby-identifier">type</span> <span class="ruby-comment"># => :OPCALL</span>
</pre>
<div class="method-source-code" id="type-source">
<pre><span class="ruby-comment"># File ast.rb, line 88</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">type</span>
<span class="ruby-identifier">__builtin_ast_node_type</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>