<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: TracePoint</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">TracePoint</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/carat/tracepoint_rb.html">
lib/carat/tracepoint.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="Object.html">
Object
</a>
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
You can’t subclass <a href="Binding.html">Binding</a>, so we delegate
(which is better anyway).
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000024">===</a>
<a href="#M000011">active</a>
<a href="#M000012">active=</a>
<a href="#M000016">back</a>
<a href="#M000015">bind</a>
<a href="#M000018">called</a>
<a href="#M000022">event?</a>
<a href="#M000021">event_map</a>
<a href="#M000023">eventless?</a>
<a href="#M000020">me</a>
<a href="#M000019">method_name</a>
<a href="#M000014">new</a>
<a href="#M000017">self</a>
<a href="#M000013">trace</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">EVENT_MAP</td>
<td>=</td>
<td class="context-item-value">{ :all => ['call', 'c-call', 'return', 'c-return', 'line', 'class', 'end', 'raise'], :before => ['call', 'c-call'], :after => ['return', 'c-return'], :call => ['call'], :return => ['return'], :ccall => ['c-call'], :creturn => ['c-return'], :line => ['line'], :class => ['class'], :end => ['end'], :raise => ['raise']</td>
<td width="3em"> </td>
<td class="context-item-desc">
methods for working with events
</td>
</tr>
</table>
</div>
</div>
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">back_binding</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
— instance ——————-
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">binding</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
— instance ——————-
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">event</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
— instance ——————-
</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000011" class="method-detail">
<a name="M000011"></a>
<div class="method-heading">
<a href="#M000011" class="method-signature">
<span class="method-name">active</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000011-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 44</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">active</span> ; <span class="ruby-ivar">@@active</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="#M000012" class="method-signature">
<span class="method-name">active=</span><span class="method-args">(x)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000012-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 46</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">active=</span>(<span class="ruby-identifier">x</span>)
<span class="ruby-ivar">@@active</span> = <span class="ruby-identifier">x</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">false</span>
<span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@@active</span>
<span class="ruby-identifier">set_trace_func</span> <span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="#M000014" class="method-signature">
<span class="method-name">new</span><span class="method-args">( event, method, bind, back_binding=bind )</span>
</a>
</div>
<div class="method-description">
<p>
Until Ruby has a built-in way to get the name of the calling method that
information must be passed into the <a
href="TracePoint.html">TracePoint</a>.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000014-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 79</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">event</span>, <span class="ruby-identifier">method</span>, <span class="ruby-identifier">bind</span>, <span class="ruby-identifier">back_binding</span>=<span class="ruby-identifier">bind</span> )
<span class="ruby-ivar">@event</span> = <span class="ruby-identifier">event</span>
<span class="ruby-ivar">@method</span> = <span class="ruby-identifier">method</span>
<span class="ruby-ivar">@binding</span> = <span class="ruby-identifier">bind</span>
<span class="ruby-ivar">@back_binding</span> = <span class="ruby-identifier">back_binding</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="#M000013" class="method-signature">
<span class="method-name">trace</span><span class="method-args">( {|| ...}</span>
</a>
</div>
<div class="method-description">
<p>
Trace execution using a <a href="TracePoint.html">TracePoint</a>.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000013-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 54</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">trace</span> <span class="ruby-comment cmt"># :yield:</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">active</span>
<span class="ruby-identifier">bb_stack</span> = []
<span class="ruby-identifier">set_trace_func</span> <span class="ruby-identifier">proc</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">e</span>, <span class="ruby-identifier">f</span>, <span class="ruby-identifier">l</span>, <span class="ruby-identifier">m</span>, <span class="ruby-identifier">b</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span>
<span class="ruby-comment cmt">#(p e, f, l, m, b, k, @@bb_stack; puts "---") if $DEBUG</span>
<span class="ruby-keyword kw">if</span> [<span class="ruby-value str">'call'</span>,<span class="ruby-value str">'c-call'</span>,<span class="ruby-value str">'class'</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-identifier">bb_stack</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">b</span>
<span class="ruby-keyword kw">elsif</span> [<span class="ruby-value str">'return'</span>,<span class="ruby-value str">'c-return'</span>,<span class="ruby-value str">'end'</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-identifier">bb</span> = <span class="ruby-identifier">bb_stack</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">b</span> = <span class="ruby-identifier">bb</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">b</span> <span class="ruby-comment cmt"># this sucks!</span>
<span class="ruby-identifier">tp</span> = <span class="ruby-constant">TracePoint</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">e</span>,<span class="ruby-identifier">m</span>,<span class="ruby-identifier">b</span>,<span class="ruby-identifier">bb</span>)
<span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">tp</span>)
}
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000024" class="method-detail">
<a name="M000024"></a>
<div class="method-heading">
<a href="#M000024" class="method-signature">
<span class="method-name">===</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p>
For use in case conditions
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000024-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 130</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-operator">===</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-constant">EVENT_MAP</span>[<span class="ruby-identifier">e</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@event</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="#M000016" class="method-signature">
<span class="method-name">back</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
shorthand for back_binding
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000016-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 90</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">back</span> ; <span class="ruby-ivar">@back_binding</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="#M000015" class="method-signature">
<span class="method-name">bind</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
shorthand for binding
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000015-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 87</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">bind</span> ; <span class="ruby-ivar">@binding</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="#M000018" class="method-signature">
<span class="method-name">called</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns the name of the event’s method. This could delegate to the
binding if Ruby had an internal way to retrieve the current method name.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000018-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 99</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">called</span> ; <span class="ruby-ivar">@method</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000022" class="method-detail">
<a name="M000022"></a>
<div class="method-heading">
<a href="#M000022" class="method-signature">
<span class="method-name">event?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Is the trace point defined or undefined?
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000022-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 126</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">event?</span> ; <span class="ruby-operator">!</span><span class="ruby-operator">!</span> <span class="ruby-ivar">@event</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000021" class="method-detail">
<a name="M000021"></a>
<div class="method-heading">
<a href="#M000021" class="method-signature">
<span class="method-name">event_map</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000021-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 123</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">event_map</span>(<span class="ruby-identifier">e</span>) ; <span class="ruby-constant">EVENT_MAP</span>[<span class="ruby-identifier">e</span>] ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000023" class="method-detail">
<a name="M000023"></a>
<div class="method-heading">
<a href="#M000023" class="method-signature">
<span class="method-name">eventless?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000023-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 127</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eventless?</span> ; <span class="ruby-operator">!</span> <span class="ruby-ivar">@event</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000020" class="method-detail">
<a name="M000020"></a>
<div class="method-heading">
<span class="method-name">me</span><span class="method-args">()</span>
</div>
<div class="method-description">
<p>
Alias for <a href="TracePoint.html#M000018">called</a>
</p>
</div>
</div>
<div id="method-M000019" class="method-detail">
<a name="M000019"></a>
<div class="method-heading">
<span class="method-name">method_name</span><span class="method-args">()</span>
</div>
<div class="method-description">
<p>
Alias for <a href="TracePoint.html#M000018">called</a>
</p>
</div>
</div>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="#M000017" class="method-signature">
<span class="method-name">self</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Delegates "self" to the binding which in turn delegates the
binding object.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000017-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/tracepoint.rb, line 94</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span> ; <span class="ruby-ivar">@binding</span>.<span class="ruby-identifier">self</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>