<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csCallStack Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csCallStack Class Reference</h1><!-- doxytag: class="csCallStack" -->Call stack.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="callstack_8h-source.html">csutil/callstack.h</a>></code>
<p>
<p>
<a href="classcsCallStack-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#dc3f1f1fa29a09274ad67157ad2d5088">Free</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the memory for this call stack. <a href="#dc3f1f1fa29a09274ad67157ad2d5088"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsString.html">csString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#9e351a113f2f071fde7c7587b5508f77">GetEntryAll</a> (size_t i, bool brief=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain complete text for an entry. <a href="#9e351a113f2f071fde7c7587b5508f77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#8f2b2844b5e13a79e7bb33d9cdb9e482">GetEntryCount</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of entries in the stack. <a href="#8f2b2844b5e13a79e7bb33d9cdb9e482"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#0586c3c01da3cbe4e8a008bb5174d36b">GetFunctionName</a> (size_t num, <a class="el" href="classcsString.html">csString</a> &str)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the function for an entry. <a href="#0586c3c01da3cbe4e8a008bb5174d36b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#f4fb998e0652788f8b7a4acdb6d260f3">GetLineNumber</a> (size_t num, <a class="el" href="classcsString.html">csString</a> &str)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get file and line number for an entry. <a href="#f4fb998e0652788f8b7a4acdb6d260f3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#7ad1fb1e82d27cb9e7c7f2a2572a5251">GetParameters</a> (size_t num, <a class="el" href="classcsString.html">csString</a> &str)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get function parameter names and values. <a href="#7ad1fb1e82d27cb9e7c7f2a2572a5251"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#9a707b22e1505819b352252a59fcd0d5">Print</a> (FILE *f=stdout, bool brief=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the complete stack. <a href="#9a707b22e1505819b352252a59fcd0d5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="93136f0c636ee343c27c7781309b095d"></a><!-- doxytag: member="csCallStack::~csCallStack" ref="93136f0c636ee343c27c7781309b095d" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCallStack.html#93136f0c636ee343c27c7781309b095d">~csCallStack</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Call stack.
<p>Definition at line <a class="el" href="callstack_8h-source.html#l00031">31</a> of file <a class="el" href="callstack_8h-source.html">callstack.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dc3f1f1fa29a09274ad67157ad2d5088"></a><!-- doxytag: member="csCallStack::Free" ref="dc3f1f1fa29a09274ad67157ad2d5088" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csCallStack::Free </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release the memory for this call stack.
<p>
</div>
</div><p>
<a class="anchor" name="9e351a113f2f071fde7c7587b5508f77"></a><!-- doxytag: member="csCallStack::GetEntryAll" ref="9e351a113f2f071fde7c7587b5508f77" args="(size_t i, bool brief=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsString.html">csString</a> csCallStack::GetEntryAll </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>brief</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Obtain complete text for an entry.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>Index of the entry. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>brief</em> </td><td>Brief - line number and parameters are omitted. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="callstack_8h-source.html#l00085">85</a> of file <a class="el" href="callstack_8h-source.html">callstack.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f2b2844b5e13a79e7bb33d9cdb9e482"></a><!-- doxytag: member="csCallStack::GetEntryCount" ref="8f2b2844b5e13a79e7bb33d9cdb9e482" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t csCallStack::GetEntryCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get number of entries in the stack.
<p>
</div>
</div><p>
<a class="anchor" name="0586c3c01da3cbe4e8a008bb5174d36b"></a><!-- doxytag: member="csCallStack::GetFunctionName" ref="0586c3c01da3cbe4e8a008bb5174d36b" args="(size_t num, csString &str)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csCallStack::GetFunctionName </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsString.html">csString</a> & </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the function for an entry.
<p>
Contains usually raw address, function name and module name. Returns false if an error occured or a name is not available.
</div>
</div><p>
<a class="anchor" name="f4fb998e0652788f8b7a4acdb6d260f3"></a><!-- doxytag: member="csCallStack::GetLineNumber" ref="f4fb998e0652788f8b7a4acdb6d260f3" args="(size_t num, csString &str)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csCallStack::GetLineNumber </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsString.html">csString</a> & </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get file and line number for an entry.
<p>
Returns false if an error occured or a line number is not available.
</div>
</div><p>
<a class="anchor" name="7ad1fb1e82d27cb9e7c7f2a2572a5251"></a><!-- doxytag: member="csCallStack::GetParameters" ref="7ad1fb1e82d27cb9e7c7f2a2572a5251" args="(size_t num, csString &str)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csCallStack::GetParameters </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsString.html">csString</a> & </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get function parameter names and values.
<p>
Returns false if an error occured or if parameters are not available.
</div>
</div><p>
<a class="anchor" name="9a707b22e1505819b352252a59fcd0d5"></a><!-- doxytag: member="csCallStack::Print" ref="9a707b22e1505819b352252a59fcd0d5" args="(FILE *f=stdout, bool brief=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csCallStack::Print </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"> <em>f</em> = <code>stdout</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>brief</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Print the complete stack.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>File handle to print to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>brief</em> </td><td>Brief output - line number and parameters are omitted. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="callstack_8h-source.html#l00065">65</a> of file <a class="el" href="callstack_8h-source.html">callstack.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="callstack_8h-source.html">callstack.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
315
