File: C:/Ruby27-x64/share/doc/ruby/html/RubyVM/AbstractSyntaxTree.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RubyVM::AbstractSyntaxTree - 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="module">
<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">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-of">::of</a>
<li ><a href="#method-c-parse">::parse</a>
<li ><a href="#method-c-parse_file">::parse_file</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RubyVM::AbstractSyntaxTree">
<h1 id="module-RubyVM::AbstractSyntaxTree" class="module">
module RubyVM::AbstractSyntaxTree
</h1>
<section class="description">
<p><a href="AbstractSyntaxTree.html"><code>AbstractSyntaxTree</code></a> provides methods to parse Ruby code into abstract syntax trees. The nodes in the tree are instances of <a href="AbstractSyntaxTree/Node.html"><code>RubyVM::AbstractSyntaxTree::Node</code></a>.</p>
<p>This class is MRI specific as it exposes implementation details of the MRI abstract syntax tree.</p>
<p>This class is experimental and its API is not stable, therefore it might change without notice. As examples, the order of children nodes is not guaranteed, the number of children nodes might change, there is no way to access children nodes by name, etc.</p>
<p>If you are looking for a stable API or an API working under multiple Ruby implementations, consider using the <em>parser</em> gem or <a href="../Ripper.html"><code>Ripper</code></a>. If you would like to make <a href="AbstractSyntaxTree.html"><code>RubyVM::AbstractSyntaxTree</code></a> stable, please join the discussion at <a href="https://bugs.ruby-lang.org/issues/14844">bugs.ruby-lang.org/issues/14844</a>.</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-of" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
RubyVM::AbstractSyntaxTree.of(proc) → RubyVM::AbstractSyntaxTree::Node
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
RubyVM::AbstractSyntaxTree.of(method) → RubyVM::AbstractSyntaxTree::Node
</span>
</div>
<div class="method-description">
<p>Returns AST nodes of the given <em>proc</em> or <em>method</em>.</p>
<pre class="ruby"><span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">AbstractSyntaxTree</span>.<span class="ruby-identifier">of</span>(<span class="ruby-identifier">proc</span> {<span class="ruby-value">1</span> <span class="ruby-operator">+</span> <span class="ruby-value">2</span>})
<span class="ruby-comment"># => #<RubyVM::AbstractSyntaxTree::Node:SCOPE@1:35-1:42></span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hello</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"hello, world"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">AbstractSyntaxTree</span>.<span class="ruby-identifier">of</span>(<span class="ruby-identifier">method</span>(<span class="ruby-value">:hello</span>))
<span class="ruby-comment"># => #<RubyVM::AbstractSyntaxTree::Node:SCOPE@1:0-3:3></span>
</pre>
<div class="method-source-code" id="of-source">
<pre><span class="ruby-comment"># File ast.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">of</span> <span class="ruby-identifier">body</span>
<span class="ruby-identifier">__builtin_ast_s_of</span> <span class="ruby-identifier">body</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
RubyVM::AbstractSyntaxTree.parse(string) → RubyVM::AbstractSyntaxTree::Node
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses the given <em>string</em> into an abstract syntax tree, returning the root node of that tree.</p>
<p><a href="../SyntaxError.html"><code>SyntaxError</code></a> is raised if the given <em>string</em> is invalid syntax.</p>
<pre class="ruby"><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-comment"># => #<RubyVM::AbstractSyntaxTree::Node:SCOPE@1:0-1:9></span>
</pre>
<div class="method-source-code" id="parse-source">
<pre><span class="ruby-comment"># File ast.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse</span> <span class="ruby-identifier">string</span>
<span class="ruby-identifier">__builtin_ast_s_parse</span> <span class="ruby-identifier">string</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse_file" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
RubyVM::AbstractSyntaxTree.parse_file(pathname) → RubyVM::AbstractSyntaxTree::Node
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads the file from <em>pathname</em>, then parses it like <a href="AbstractSyntaxTree.html#method-c-parse"><code>::parse</code></a>, returning the root node of the abstract syntax tree.</p>
<p><a href="../SyntaxError.html"><code>SyntaxError</code></a> is raised if <em>pathname</em>'s contents are not valid Ruby syntax.</p>
<pre class="ruby"><span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">AbstractSyntaxTree</span>.<span class="ruby-identifier">parse_file</span>(<span class="ruby-string">"my-app/app.rb"</span>)
<span class="ruby-comment"># => #<RubyVM::AbstractSyntaxTree::Node:SCOPE@1:0-31:3></span>
</pre>
<div class="method-source-code" id="parse_file-source">
<pre><span class="ruby-comment"># File ast.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse_file</span> <span class="ruby-identifier">pathname</span>
<span class="ruby-identifier">__builtin_ast_s_parse_file</span> <span class="ruby-identifier">pathname</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>