<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>vrq: CSymbol Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td width="180"><a href="index.html"><img src="vrq.png" width="150" height="100" border="0" alt="vrq"></a></td>
<td background="top_bg.png" align="right" width="100%">
<img src="glyth.png" width="500" height="100" border="0" alt="">
</td>
</tr>
<tr>
<td background="#FFFFFF" align="right" width="50" height="4"></td>
</tr>
</table>
</head><body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<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>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>CSymbol Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CSymbol" --><!-- doxytag: inherits="CObject" -->
<p>Holder for character strings.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="csymbol_8h_source.html">csymbol.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CSymbol:</div>
<div class="dyncontent">
<div class="center">
<img src="classCSymbol.png" usemap="#CSymbol_map" alt=""/>
<map id="CSymbol_map" name="CSymbol_map">
<area href="classCObject.html" alt="CObject" shape="rect" coords="0,0,62,24"/>
</map>
</div>
<p><a href="classCSymbol-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>SymbolCompare</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a1d2915b5d91307c8e7351cf53263f06f">CSymbol</a> (const char *aName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a symbol. <a href="#a1d2915b5d91307c8e7351cf53263f06f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#ab00432bd7072d861f45a0eddcd9c24e3">~CSymbol</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy symbol. <a href="#ab00432bd7072d861f45a0eddcd9c24e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a9736de9ba821265b58513e8045300df7">GetName</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get symbol's text. <a href="#a9736de9ba821265b58513e8045300df7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#ade764a0a7f49d0187d6bb4db964405b2">Escaped</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if string is an escaped symbol. <a href="#ade764a0a7f49d0187d6bb4db964405b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a1f6c14488df8b100b01c8f3fffeb3304">External</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if symbol is external reference return non-zero if symbol is external. <a href="#a1f6c14488df8b100b01c8f3fffeb3304"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCSymbol.html">CSymbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a625749f6baff22dc83435449d5792914">Lookup</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find symbol for given string. <a href="#a625749f6baff22dc83435449d5792914"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCSymbol.html">CSymbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a93e194bda3fc3c7be18619445e259edd">GenSymbol</a> (const char *prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generated a new symbol with a unique name using the given prefix. <a href="#a93e194bda3fc3c7be18619445e259edd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a8b6c5dca74be6b89412654941a1b707f">DumpTable</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump symbol table. <a href="#a8b6c5dca74be6b89412654941a1b707f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a89ecc8be0217f9b5c9c817826a60f68e">SetObstack</a> (<a class="el" href="classCObstack.html">CObstack</a> *aObstack)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set heap to use for storage. <a href="#a89ecc8be0217f9b5c9c817826a60f68e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCSymbol.html#a4ce290f4b5b9b0fd4fde32ea3bb72e0b">DumpStats</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump hash table stats. <a href="#a4ce290f4b5b9b0fd4fde32ea3bb72e0b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Holder for character strings. </p>
<p>All tokens are registered as symbols to allow pointers to be compared for string equality instead of the contents of the strings. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1d2915b5d91307c8e7351cf53263f06f"></a><!-- doxytag: member="CSymbol::CSymbol" ref="a1d2915b5d91307c8e7351cf53263f06f" args="(const char *aName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSymbol::CSymbol </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aName</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a symbol. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aName</em> </td><td>text for symbold. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab00432bd7072d861f45a0eddcd9c24e3"></a><!-- doxytag: member="CSymbol::~CSymbol" ref="ab00432bd7072d861f45a0eddcd9c24e3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSymbol::~CSymbol </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy symbol. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4ce290f4b5b9b0fd4fde32ea3bb72e0b"></a><!-- doxytag: member="CSymbol::DumpStats" ref="a4ce290f4b5b9b0fd4fde32ea3bb72e0b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CSymbol::DumpStats </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump hash table stats. </p>
</div>
</div>
<a class="anchor" id="a8b6c5dca74be6b89412654941a1b707f"></a><!-- doxytag: member="CSymbol::DumpTable" ref="a8b6c5dca74be6b89412654941a1b707f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CSymbol::DumpTable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump symbol table. </p>
</div>
</div>
<a class="anchor" id="ade764a0a7f49d0187d6bb4db964405b2"></a><!-- doxytag: member="CSymbol::Escaped" ref="ade764a0a7f49d0187d6bb4db964405b2" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CSymbol::Escaped </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if string is an escaped symbol. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>non-zero if string is escaped </dd></dl>
</div>
</div>
<a class="anchor" id="a1f6c14488df8b100b01c8f3fffeb3304"></a><!-- doxytag: member="CSymbol::External" ref="a1f6c14488df8b100b01c8f3fffeb3304" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CSymbol::External </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if symbol is external reference return non-zero if symbol is external. </p>
</div>
</div>
<a class="anchor" id="a93e194bda3fc3c7be18619445e259edd"></a><!-- doxytag: member="CSymbol::GenSymbol" ref="a93e194bda3fc3c7be18619445e259edd" args="(const char *prefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCSymbol.html">CSymbol</a>* CSymbol::GenSymbol </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generated a new symbol with a unique name using the given prefix. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>to use when generating symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new symbol. </dd></dl>
</div>
</div>
<a class="anchor" id="a9736de9ba821265b58513e8045300df7"></a><!-- doxytag: member="CSymbol::GetName" ref="a9736de9ba821265b58513e8045300df7" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* CSymbol::GetName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get symbol's text. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>text string for symbol. </dd></dl>
</div>
</div>
<a class="anchor" id="a625749f6baff22dc83435449d5792914"></a><!-- doxytag: member="CSymbol::Lookup" ref="a625749f6baff22dc83435449d5792914" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCSymbol.html">CSymbol</a>* CSymbol::Lookup </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find symbol for given string. </p>
<p>If not found create a symbol for it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>text string to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>symbol for name </dd></dl>
</div>
</div>
<a class="anchor" id="a89ecc8be0217f9b5c9c817826a60f68e"></a><!-- doxytag: member="CSymbol::SetObstack" ref="a89ecc8be0217f9b5c9c817826a60f68e" args="(CObstack *aObstack)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CSymbol::SetObstack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCObstack.html">CObstack</a> * </td>
<td class="paramname"> <em>aObstack</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set heap to use for storage. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/net/fileserver/nas/home/mdh/vrq/src/<a class="el" href="csymbol_8h_source.html">csymbol.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
ffa1e6f5ad04360808fe8840fe3ba036
>
files
>
201
