File: C:/Ruby27-x64/share/doc/ruby/html/Thread/Backtrace/Location.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Thread::Backtrace::Location - 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-absolute_path">#absolute_path</a>
<li ><a href="#method-i-base_label">#base_label</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-label">#label</a>
<li ><a href="#method-i-lineno">#lineno</a>
<li ><a href="#method-i-path">#path</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Thread::Backtrace::Location">
<h1 id="class-Thread::Backtrace::Location" class="class">
class Thread::Backtrace::Location
</h1>
<section class="description">
<p>An object representation of a stack frame, initialized by <a href="../../Kernel.html#method-i-caller_locations"><code>Kernel#caller_locations</code></a>.</p>
<p>For example:</p>
<pre class="ruby"><span class="ruby-comment"># caller_locations.rb</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">a</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-identifier">caller_locations</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">b</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-identifier">a</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">c</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-identifier">b</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">c</span>(<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">2</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">call</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">call</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Running <code>ruby caller_locations.rb</code> will produce:</p>
<pre>caller_locations.rb:2:in `a'
caller_locations.rb:5:in `b'
caller_locations.rb:8:in `c'</pre>
<p>Here's another example with a slightly different result:</p>
<pre class="ruby"><span class="ruby-comment"># foo.rb</span>
<span class="ruby-keyword">class</span> <span class="ruby-constant">Foo</span>
<span class="ruby-identifier">attr_accessor</span> <span class="ruby-value">:locations</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-ivar">@locations</span> = <span class="ruby-identifier">caller_locations</span>(<span class="ruby-identifier">skip</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Foo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">2</span>).<span class="ruby-identifier">locations</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">call</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">call</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Now run <code>ruby foo.rb</code> and you should see:</p>
<pre>init.rb:4:in `initialize'
init.rb:8:in `new'
init.rb:8:in `<main>'</pre>
</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-absolute_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">absolute_path</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the full file path of this frame.</p>
<p>Same as <a href="Location.html#method-i-path"><code>path</code></a>, but includes the absolute path.</p>
<div class="method-source-code" id="absolute_path-source">
<pre>static VALUE
location_absolute_path_m(VALUE self)
{
return location_realpath(location_ptr(self));
}</pre>
</div>
</div>
</div>
<div id="method-i-base_label" class="method-detail ">
<div class="method-heading">
<span class="method-name">base_label</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the base label of this frame.</p>
<p>Usually same as <a href="Location.html#method-i-label"><code>label</code></a>, without decoration.</p>
<div class="method-source-code" id="base_label-source">
<pre>static VALUE
location_base_label_m(VALUE self)
{
return location_base_label(location_ptr(self));
}</pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the same as calling <code>inspect</code> on the string representation of to_str</p>
<div class="method-source-code" id="inspect-source">
<pre>static VALUE
location_inspect_m(VALUE self)
{
return rb_str_inspect(location_to_str(location_ptr(self)));
}</pre>
</div>
</div>
</div>
<div id="method-i-label" class="method-detail ">
<div class="method-heading">
<span class="method-name">label</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the label of this frame.</p>
<p>Usually consists of method, class, module, etc names with decoration.</p>
<p>Consider the following example:</p>
<pre class="ruby"><span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">caller_locations</span>(<span class="ruby-value">0</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">label</span>
<span class="ruby-value">1</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">caller_locations</span>(<span class="ruby-value">0</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">label</span>
<span class="ruby-value">1</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">caller_locations</span>(<span class="ruby-value">0</span>).<span class="ruby-identifier">first</span>.<span class="ruby-identifier">label</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<p>The result of calling <code>foo</code> is this:</p>
<pre>label: foo
label: block in foo
label: block (2 levels) in foo</pre>
<div class="method-source-code" id="label-source">
<pre>static VALUE
location_label_m(VALUE self)
{
return location_label(location_ptr(self));
}</pre>
</div>
</div>
</div>
<div id="method-i-lineno" class="method-detail ">
<div class="method-heading">
<span class="method-name">lineno</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the line number of this frame.</p>
<p>For example, using <code>caller_locations.rb</code> from <a href="Location.html"><code>Thread::Backtrace::Location</code></a></p>
<pre class="ruby"><span class="ruby-identifier">loc</span> = <span class="ruby-identifier">c</span>(<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">1</span>).<span class="ruby-identifier">first</span>
<span class="ruby-identifier">loc</span>.<span class="ruby-identifier">lineno</span> <span class="ruby-comment">#=> 2</span>
</pre>
<div class="method-source-code" id="lineno-source">
<pre>static VALUE
location_lineno_m(VALUE self)
{
return INT2FIX(location_lineno(location_ptr(self)));
}</pre>
</div>
</div>
</div>
<div id="method-i-path" class="method-detail ">
<div class="method-heading">
<span class="method-name">path</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the file name of this frame.</p>
<p>For example, using <code>caller_locations.rb</code> from <a href="Location.html"><code>Thread::Backtrace::Location</code></a></p>
<pre class="ruby"><span class="ruby-identifier">loc</span> = <span class="ruby-identifier">c</span>(<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">1</span>).<span class="ruby-identifier">first</span>
<span class="ruby-identifier">loc</span>.<span class="ruby-identifier">path</span> <span class="ruby-comment">#=> caller_locations.rb</span>
</pre>
<div class="method-source-code" id="path-source">
<pre>static VALUE
location_path_m(VALUE self)
{
return location_path(location_ptr(self));
}</pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a <a href="../../Kernel.html#method-i-caller"><code>Kernel#caller</code></a> style string representing this frame.</p>
<div class="method-source-code" id="to_s-source">
<pre>static VALUE
location_to_str_m(VALUE self)
{
return location_to_str(location_ptr(self));
}</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>