<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class Function - Class Function</title>
<link href="faldoc.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
<div class="tabs">
<ul>
<li><a href="./index.html"><span>Main</span></a></li>
<li><a href="./pages.html"><span>Related pages</span></a></li>
<li><a href="./groups.html"><span>Groups</span></a></li>
<li><a href="./funset.html"><span>Function sets</span></a></li>
<li><a href="./classes.html"><span>Classes</span></a></li>
<li><a href="./objects.html"><span>Objects</span></a></li>
<li><a href="./functions.html"><span>All functions</span></a></li>
<li><a href="./globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Class Function</h1>
<p class="faldoc_brief">Metaclass for Falcon function type. </p>
<p class="faldoc_funcdecl">
<b>class</b> Function \
<b>from</b> <a href="./class_BOM.html">BOM</a>
</p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#attributes">attributes()</a></td><td>Returns a dictionary containing annotation attributes of the given function. </td></tr>
<tr><td><a href="#caller">caller()</a></td><td>Gets the direct caller or one of the calling ancestors. </td></tr>
<tr><td><a href="#name">name()</a></td><td>Gets the symbolic name of the given function. </td></tr>
<tr><td><a href="#trace">trace()</a></td><td>Gets a trace step in the call stack. </td></tr>
</table>
<h3 class="faldoc_title">Inherited methods</h3>
<table class="faldoc_list">
<tr><td><a href="./class_BOM.html#__add">__add</a> from BOM </td><td>Overrides binary addition operand. </td></tr>
<tr><td><a href="./class_BOM.html#__call">__call</a> from BOM </td><td>Overrides call operator "self()". </td></tr>
<tr><td><a href="./class_BOM.html#__dec">__dec</a> from BOM </td><td>Overrides decrement unary prefix operand. </td></tr>
<tr><td><a href="./class_BOM.html#__decpost">__decpost</a> from BOM </td><td>Overrides decrement unary postfix operand. </td></tr>
<tr><td><a href="./class_BOM.html#__div">__div</a> from BOM </td><td>Overrides binary division operand. </td></tr>
<tr><td><a href="./class_BOM.html#__getIndex">__getIndex</a> from BOM </td><td>Overrides array access operator [] </td></tr>
<tr><td><a href="./class_BOM.html#__inc">__inc</a> from BOM </td><td>Overrides increment unary prefix operand. </td></tr>
<tr><td><a href="./class_BOM.html#__incpost">__incpost</a> from BOM </td><td>Overrides increment unary postifx operand. </td></tr>
<tr><td><a href="./class_BOM.html#__mod">__mod</a> from BOM </td><td>Overrides modulo operand. </td></tr>
<tr><td><a href="./class_BOM.html#__mul">__mul</a> from BOM </td><td>Overrides binary multiplication operand. </td></tr>
<tr><td><a href="./class_BOM.html#__pow">__pow</a> from BOM </td><td>Overrides power operand. </td></tr>
<tr><td><a href="./class_BOM.html#__setIndex">__setIndex</a> from BOM </td><td>Overrides array write operator [] </td></tr>
<tr><td><a href="./class_BOM.html#__sub">__sub</a> from BOM </td><td>Overrides binary subtraction operand. </td></tr>
<tr><td><a href="./class_BOM.html#baseClass">baseClass</a> from BOM </td><td>Returns the class item from which an object has been instantiated. </td></tr>
<tr><td><a href="./class_BOM.html#bound">bound</a> from BOM </td><td>Determines if an item is bound or not. </td></tr>
<tr><td><a href="./class_BOM.html#className">className</a> from BOM </td><td>Returns the name of the class an instance is instantiated from. </td></tr>
<tr><td><a href="./class_BOM.html#clone">clone</a> from BOM </td><td>Performs a deep copy of the item. </td></tr>
<tr><td><a href="./class_BOM.html#compare">compare</a> from BOM </td><td>Performs a lexicographical comparison. </td></tr>
<tr><td><a href="./class_BOM.html#derivedFrom">derivedFrom</a> from BOM </td><td>Checks if this item has a given parent. </td></tr>
<tr><td><a href="./class_BOM.html#describe">describe</a> from BOM </td><td>Returns the deep contents of an item on a string representation. </td></tr>
<tr><td><a href="./class_BOM.html#isCallable">isCallable</a> from BOM </td><td>Determines if an item is callable. </td></tr>
<tr><td><a href="./class_BOM.html#len">len</a> from BOM </td><td>Retrieves the length of a collection </td></tr>
<tr><td><a href="./class_BOM.html#metaclass">metaclass</a> from BOM </td><td>Returns the metaclass associated with this item. </td></tr>
<tr><td><a href="./class_BOM.html#ptr">ptr</a> from BOM </td><td>Returns a raw memory pointer out of this data (as an integer). </td></tr>
<tr><td><a href="./class_BOM.html#serialize">serialize</a> from BOM </td><td>Serialize the item on a stream for persistent storage. </td></tr>
<tr><td><a href="./class_BOM.html#toString">toString</a> from BOM </td><td>Coverts the object to string. </td></tr>
<tr><td><a href="./class_BOM.html#typeId">typeId</a> from BOM </td><td>Returns an integer indicating the type of this item. </td></tr>
</table>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="attributes">attributes()</a></h3>
<p class="item_brief">Returns a dictionary containing annotation attributes of the given function. </p>
<p class="faldoc_funcdecl">Function.attributes( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">Nil if the function has no attributes, or a string-indexed dictionary. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="caller">caller()</a></h3>
<p class="item_brief">Gets the direct caller or one of the calling ancestors. </p>
<p class="faldoc_funcdecl">Function.caller( [level] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">level</td><td class="faldoc_optparamdesc">Caller level (starting from zero, the default). </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The item having performed the nth call. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This function returns the n-th caller (zero based) that caused this function to be called. It may be a function, a method or another callable item from which the call has originated. </p>
<p class="faldoc_note"><span class="faldoc_notetype">Note:</span> The method can also be called statically on the Function metaclass. </p>
</p>
<h3 class="faldoc_funcname"><a name="name">name()</a></h3>
<p class="item_brief">Gets the symbolic name of the given function. </p>
<p class="faldoc_funcdecl">Function.name( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A string containing the function name </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> This is useful if the function symbol or has been re-assigned to temporary variables, or if it is applied to the <b>fself</b> keyword. </p>
</p>
<h3 class="faldoc_funcname"><a name="trace">trace()</a></h3>
<p class="item_brief">Gets a trace step in the call stack. </p>
<p class="faldoc_funcdecl">Function.trace( [level] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">level</td><td class="faldoc_optparamdesc">Caller level (starting from zero, the default). </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">An array containing the data relative to the given trace level. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">The returned data is organized as follows: </p>
<pre class="faldoc_code">
[ 'symbol name', 'module name', 'module path', line_in_module, PC_in_vm]
</pre>
<p class="faldoc_note"><span class="faldoc_notetype">Note:</span> The method can also be called statically on the Function metaclass. </p>
</p>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./funset.html">Function sets</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./globals.html">Globals</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
