File: C:/Ruby27-x64/share/doc/ruby/html/IRB/Frame.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class IRB::Frame - 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-c-bottom">::bottom</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-sender">::sender</a>
<li ><a href="#method-c-top">::top</a>
<li ><a href="#method-i-bottom">#bottom</a>
<li ><a href="#method-i-top">#top</a>
<li ><a href="#method-i-trace_func">#trace_func</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-IRB::Frame">
<h1 id="class-IRB::Frame" class="class">
class IRB::Frame
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="CALL_STACK_OFFSET">CALL_STACK_OFFSET
<dd><p>Default number of frames offset</p>
<dt id="INIT_STACK_TIMES">INIT_STACK_TIMES
<dd><p>Default number of stack frames</p>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-bottom" class="method-detail ">
<div class="method-heading">
<span class="method-name">bottom</span><span
class="method-args">(n = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convenience method for <a href="Frame.html#method-i-bottom"><code>Frame#bottom</code></a></p>
<div class="method-source-code" id="bottom-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Frame</span>.<span class="ruby-identifier ruby-title">bottom</span>(<span class="ruby-identifier">n</span> = <span class="ruby-value">0</span>)
<span class="ruby-ivar">@backtrace</span>.<span class="ruby-identifier">bottom</span>(<span class="ruby-identifier">n</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">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new stack frame</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@frames</span> = [<span class="ruby-constant">TOPLEVEL_BINDING</span>] <span class="ruby-operator">*</span> <span class="ruby-constant">INIT_STACK_TIMES</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-sender" class="method-detail ">
<div class="method-heading">
<span class="method-name">sender</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the binding context of the caller from the last frame initialized</p>
<div class="method-source-code" id="sender-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Frame</span>.<span class="ruby-identifier ruby-title">sender</span>
<span class="ruby-identifier">eval</span> <span class="ruby-string">"self"</span>, <span class="ruby-ivar">@backtrace</span>.<span class="ruby-identifier">top</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-top" class="method-detail ">
<div class="method-heading">
<span class="method-name">top</span><span
class="method-args">(n = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convenience method for <a href="Frame.html#method-i-top"><code>Frame#top</code></a></p>
<div class="method-source-code" id="top-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">Frame</span>.<span class="ruby-identifier ruby-title">top</span>(<span class="ruby-identifier">n</span> = <span class="ruby-value">0</span>)
<span class="ruby-ivar">@backtrace</span>.<span class="ruby-identifier">top</span>(<span class="ruby-identifier">n</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-bottom" class="method-detail ">
<div class="method-heading">
<span class="method-name">bottom</span><span
class="method-args">(n = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the <code>n</code> number of frames on the call stack from the first frame initialized.</p>
<p>Raises <a href="Frame/FrameOverflow.html"><code>FrameOverflow</code></a> if there are no frames in the given stack range.</p>
<div class="method-source-code" id="bottom-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bottom</span>(<span class="ruby-identifier">n</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">bind</span> = <span class="ruby-ivar">@frames</span>[<span class="ruby-identifier">n</span>]
<span class="ruby-identifier">fail</span> <span class="ruby-constant">FrameOverflow</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">bind</span>
<span class="ruby-identifier">bind</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-top" class="method-detail ">
<div class="method-heading">
<span class="method-name">top</span><span
class="method-args">(n = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the <code>n</code> number of frames on the call stack from the last frame initialized.</p>
<p>Raises <a href="Frame/FrameUnderflow.html"><code>FrameUnderflow</code></a> if there are no frames in the given stack range.</p>
<div class="method-source-code" id="top-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">top</span>(<span class="ruby-identifier">n</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">bind</span> = <span class="ruby-ivar">@frames</span>[<span class="ruby-operator">-</span>(<span class="ruby-identifier">n</span> <span class="ruby-operator">+</span> <span class="ruby-constant">CALL_STACK_OFFSET</span>)]
<span class="ruby-identifier">fail</span> <span class="ruby-constant">FrameUnderflow</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">bind</span>
<span class="ruby-identifier">bind</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-trace_func" class="method-detail ">
<div class="method-heading">
<span class="method-name">trace_func</span><span
class="method-args">(event, file, line, id, binding)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Used by <a href="../Kernel.html#method-i-set_trace_func"><code>Kernel#set_trace_func</code></a> to register each event in the call stack</p>
<div class="method-source-code" id="trace_func-source">
<pre><span class="ruby-comment"># File lib/irb/frame.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">trace_func</span>(<span class="ruby-identifier">event</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">binding</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">event</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'call'</span>, <span class="ruby-string">'class'</span>
<span class="ruby-ivar">@frames</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">binding</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'return'</span>, <span class="ruby-string">'end'</span>
<span class="ruby-ivar">@frames</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">end</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>