<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>FAUST compiler: Symbol Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</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="contents"> <h1>Symbol Class Reference</h1><!-- doxytag: class="Symbol" --> <p>Symbols are unique objects with a name stored in a hash table. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="symbol_8hh_source.html">symbol.hh</a>></code></p> <div class="dynheader"> Collaboration diagram for Symbol:</div> <div class="dynsection"> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classSymbol-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a80aa251523a4a1c24e9e9e679205f18e">print</a> (ostream &fout) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">print a symbol on a stream <a href="#a80aa251523a4a1c24e9e9e679205f18e"></a><br/></td></tr> <tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a28b3233002ab61fa790e1d3281bd5f4e">Symbol</a> (const char *str, unsigned int hsh, <a class="el" href="classSymbol.html">Symbol</a> *nxt)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new symbol ready to be placed in the hash table. <a href="#a28b3233002ab61fa790e1d3281bd5f4e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a505360ad4bd2e0bd1e3954eca1b05723">~Symbol</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The Destructor is never used. <a href="#a505360ad4bd2e0bd1e3954eca1b05723"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#ae5e90343699911affcc3372bcb131c50">equiv</a> (unsigned int hash, const char *str) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the name of the symbol is equal to string <code>str</code>. <a href="#ae5e90343699911affcc3372bcb131c50"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a5c9ccccee95f2d09e34b060076d52a29">calcHashKey</a> (const char *str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the 32-bits hash key of string <code>str</code>. <a href="#a5c9ccccee95f2d09e34b060076d52a29"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#af8badc954a2122bb8087e084224af76e">get</a> (const string &str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the symbol of name <code>str</code>. <a href="#af8badc954a2122bb8087e084224af76e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a95ac2abd0de9839bb238e48a02e4d83a">get</a> (const char *str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the symbol of name <code>str</code>. <a href="#a95ac2abd0de9839bb238e48a02e4d83a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#acab6dd6c1c62c49b03ca629f7e0dab36">prefix</a> (const char *str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new symbol of name prefixed by <code>str</code>. <a href="#acab6dd6c1c62c49b03ca629f7e0dab36"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a2fd22ca0779942ebaafcdf24a0d758f6">isnew</a> (const char *str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <b>true</b> if no symbol of name <code>str</code> exists. <a href="#a2fd22ca0779942ebaafcdf24a0d758f6"></a><br/></td></tr> <tr><td colspan="2"><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1">fName</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the symbol. <a href="#a500120e613d60cba8faffc9544c06ad1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a96342ef5b450e2edbdb9149798c7d435">fHash</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Hash key computed from the name and used to determine the hash table entry. <a href="#a96342ef5b450e2edbdb9149798c7d435"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a2fc73a8c7c4a86ed96c48236e397bbf0">fNext</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Next symbol in the hash table entry. <a href="#a2fc73a8c7c4a86ed96c48236e397bbf0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a43a1fda1b5819fc200c19509a0eae03e">fData</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Field to user disposal to store additional data. <a href="#a43a1fda1b5819fc200c19509a0eae03e"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#abb8b44fb98513a5d545a684c6024be4d">kHashTableSize</a> = 511</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Size of the hash table (a prime number is recommended). <a href="#abb8b44fb98513a5d545a684c6024be4d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#ad28a6fe0f613177e77bc29b98ad22ecd">gSymbolTable</a> [<a class="el" href="classSymbol.html#abb8b44fb98513a5d545a684c6024be4d">kHashTableSize</a>]</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Hash table used to store the symbols. <a href="#ad28a6fe0f613177e77bc29b98ad22ecd"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#aaa87083235b70d1042e59ae25e0800d8">symbol</a> (const char *str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns (and creates if new) the symbol of name <code>str</code>. <a href="#aaa87083235b70d1042e59ae25e0800d8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#abfc1191889039b578e061d8c7780ec5f">symbol</a> (const string &str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns (and creates if new) the symbol of name <code>str</code>. <a href="#abfc1191889039b578e061d8c7780ec5f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSymbol.html">Symbol</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a377309446e0e86ae663cd6709e02889d">unique</a> (const char *str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a new unique symbol of name strxxx. <a href="#a377309446e0e86ae663cd6709e02889d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a8243134fbbd9d924ebbb3f833922e310">name</a> (<a class="el" href="classSymbol.html">Symbol</a> *sym)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of a symbol. <a href="#a8243134fbbd9d924ebbb3f833922e310"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a603fcb6c07eacf2688c2a8470637d0ff">getUserData</a> (<a class="el" href="classSymbol.html">Symbol</a> *sym)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns user data. <a href="#a603fcb6c07eacf2688c2a8470637d0ff"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSymbol.html#a936471e3b0afa59ffec0a94f7d1b6570">setUserData</a> (<a class="el" href="classSymbol.html">Symbol</a> *sym, void *d)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set user data. <a href="#a936471e3b0afa59ffec0a94f7d1b6570"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Symbols are unique objects with a name stored in a hash table. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00053">53</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a28b3233002ab61fa790e1d3281bd5f4e"></a><!-- doxytag: member="Symbol::Symbol" ref="a28b3233002ab61fa790e1d3281bd5f4e" args="(const char *str, unsigned int hsh, Symbol *nxt)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Symbol::Symbol </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>hsh</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classSymbol.html">Symbol</a> * </td> <td class="paramname"> <em>nxt</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructs a new symbol ready to be placed in the hash table. </p> <p>Constructs a symbol ready to be placed in the hash table.</p> <p>It makes a private copy of its name. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the name of the symbol </td></tr> <tr><td valign="top"></td><td valign="top"><em>hsh</em> </td><td>the hash key of the symbol </td></tr> <tr><td valign="top"></td><td valign="top"><em>nxt</em> </td><td>a pointer to the next symbol in the hash table entry </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00158">158</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>References <a class="el" href="symbol_8hh_source.html#l00066">fData</a>, <a class="el" href="symbol_8hh_source.html#l00064">fHash</a>, <a class="el" href="symbol_8hh_source.html#l00063">fName</a>, <a class="el" href="symbol_8hh_source.html#l00065">fNext</a>, and <a class="el" href="list_8cpp_source.html#l00198">len()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00159"></a>00159 { <a name="l00160"></a>00160 <span class="keywordtype">int</span> <a class="code" href="list_8cpp.html#a0b58ea1a5d8649e8afb0f70c48776347">len</a> = strlen(str); <a name="l00161"></a>00161 <a name="l00162"></a>00162 <a class="code" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1" title="Name of the symbol.">fName</a> = <span class="keyword">new</span> <span class="keywordtype">char</span> [len+1]; <a name="l00163"></a>00163 memcpy(<a class="code" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1" title="Name of the symbol.">fName</a>, str, len+1); <a name="l00164"></a>00164 <a class="code" href="classSymbol.html#a96342ef5b450e2edbdb9149798c7d435" title="Hash key computed from the name and used to determine the hash table entry.">fHash</a> = hsh; <a name="l00165"></a>00165 <a class="code" href="classSymbol.html#a2fc73a8c7c4a86ed96c48236e397bbf0" title="Next symbol in the hash table entry.">fNext</a> = nxt; <a name="l00166"></a>00166 <a class="code" href="classSymbol.html#a43a1fda1b5819fc200c19509a0eae03e" title="Field to user disposal to store additional data.">fData</a> = 0; <a name="l00167"></a>00167 } </pre></div></p> <p><div class="dynheader"> Here is the call graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="a505360ad4bd2e0bd1e3954eca1b05723"></a><!-- doxytag: member="Symbol::~Symbol" ref="a505360ad4bd2e0bd1e3954eca1b05723" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Symbol::~Symbol </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The Destructor is never used. </p> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00169">169</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>References <a class="el" href="symbol_8hh_source.html#l00063">fName</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00170"></a>00170 { <a name="l00171"></a>00171 <span class="keyword">delete</span> [] <a class="code" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1" title="Name of the symbol.">fName</a>; <a name="l00172"></a>00172 } </pre></div></p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a5c9ccccee95f2d09e34b060076d52a29"></a><!-- doxytag: member="Symbol::calcHashKey" ref="a5c9ccccee95f2d09e34b060076d52a29" args="(const char *str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int Symbol::calcHashKey </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Compute the 32-bits hash key of string <code>str</code>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a 32-bits hash key </dd></dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00140">140</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00067">get()</a>, and <a class="el" href="symbol_8cpp_source.html#l00085">isnew()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00141"></a>00141 { <a name="l00142"></a>00142 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> h = 0; <a name="l00143"></a>00143 <a name="l00144"></a>00144 <span class="keywordflow">while</span> (*str) h = (h << 1) ^ (h >> 20) ^ (*str++); <a name="l00145"></a>00145 <span class="keywordflow">return</span> h; <a name="l00146"></a>00146 } </pre></div></p> <p><div class="dynheader"> Here is the caller graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="ae5e90343699911affcc3372bcb131c50"></a><!-- doxytag: member="Symbol::equiv" ref="ae5e90343699911affcc3372bcb131c50" args="(unsigned int hash, const char *str) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Symbol::equiv </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>hash</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Check if the name of the symbol is equal to string <code>str</code>. </p> <p>Check if the name of the symbol is equal to string <code>str</code> This method is used by <a class="el" href="classSymbol.html#a2fd22ca0779942ebaafcdf24a0d758f6" title="Returns true if no symbol of name str exists.">isnew()</a> and make() when searching the hashtable for an existing 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>hash</em> </td><td>the hash key of the string (used to speedup the comparison) </td></tr> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string to compare </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the name of the symbol and <code>str</code> are the same </dd></dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00127">127</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>References <a class="el" href="symbol_8hh_source.html#l00064">fHash</a>, and <a class="el" href="symbol_8hh_source.html#l00063">fName</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00067">get()</a>, and <a class="el" href="symbol_8cpp_source.html#l00085">isnew()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00128"></a>00128 { <a name="l00129"></a>00129 <span class="keywordflow">return</span> (<a class="code" href="classSymbol.html#a96342ef5b450e2edbdb9149798c7d435" title="Hash key computed from the name and used to determine the hash table entry.">fHash</a> == hash) && (strcmp(<a class="code" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1" title="Name of the symbol.">fName</a>,str) == 0); <a name="l00130"></a>00130 } </pre></div></p> <p><div class="dynheader"> Here is the caller graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="a95ac2abd0de9839bb238e48a02e4d83a"></a><!-- doxytag: member="Symbol::get" ref="a95ac2abd0de9839bb238e48a02e4d83a" args="(const char *str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a> * Symbol::get </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the symbol of name <code>str</code>. </p> <p>Search the hash table for the symbol of name <code>str</code> or returns a new one.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the name of the symbol </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a symbol of name str </dd></dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00067">67</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>References <a class="el" href="symbol_8cpp_source.html#l00140">calcHashKey()</a>, <a class="el" href="symbol_8cpp_source.html#l00127">equiv()</a>, <a class="el" href="symbol_8hh_source.html#l00065">fNext</a>, <a class="el" href="symbol_8hh_source.html#l00059">gSymbolTable</a>, and <a class="el" href="symbol_8hh_source.html#l00058">kHashTableSize</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00068"></a>00068 { <a name="l00069"></a>00069 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hsh = <a class="code" href="classSymbol.html#a5c9ccccee95f2d09e34b060076d52a29" title="Compute the 32-bits hash key of string str.">calcHashKey</a>(str); <a name="l00070"></a>00070 <span class="keywordtype">int</span> bckt = hsh % <a class="code" href="classSymbol.html#abb8b44fb98513a5d545a684c6024be4d" title="Size of the hash table (a prime number is recommended).">kHashTableSize</a>; <a name="l00071"></a>00071 <a class="code" href="classSymbol.html" title="Symbols are unique objects with a name stored in a hash table.">Symbol</a>* item = <a class="code" href="classSymbol.html#ad28a6fe0f613177e77bc29b98ad22ecd" title="Hash table used to store the symbols.">gSymbolTable</a>[bckt]; <a name="l00072"></a>00072 <a name="l00073"></a>00073 <span class="keywordflow">while</span> ( item && !item-><a class="code" href="classSymbol.html#ae5e90343699911affcc3372bcb131c50" title="Check if the name of the symbol is equal to string str.">equiv</a>(hsh,str) ) item = item-><a class="code" href="classSymbol.html#a2fc73a8c7c4a86ed96c48236e397bbf0" title="Next symbol in the hash table entry.">fNext</a>; <a name="l00074"></a>00074 <a class="code" href="classSymbol.html" title="Symbols are unique objects with a name stored in a hash table.">Symbol</a>* r = item ? item : <a class="code" href="classSymbol.html#ad28a6fe0f613177e77bc29b98ad22ecd" title="Hash table used to store the symbols.">gSymbolTable</a>[bckt] = <span class="keyword">new</span> <a class="code" href="classSymbol.html" title="Symbols are unique objects with a name stored in a hash table.">Symbol</a>(str, hsh, <a class="code" href="classSymbol.html#ad28a6fe0f613177e77bc29b98ad22ecd" title="Hash table used to store the symbols.">gSymbolTable</a>[bckt]); <a name="l00075"></a>00075 <span class="keywordflow">return</span> r; <a name="l00076"></a>00076 } </pre></div></p> <p><div class="dynheader"> Here is the call graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="af8badc954a2122bb8087e084224af76e"></a><!-- doxytag: member="Symbol::get" ref="af8badc954a2122bb8087e084224af76e" args="(const string &str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a> * Symbol::get </td> <td>(</td> <td class="paramtype">const string & </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the symbol of name <code>str</code>. </p> <p>Search the hash table for the symbol of name <code>str</code> or returns a new one.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the name of the symbol </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a symbol of name str </dd></dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00046">46</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>Referenced by <a class="el" href="symbol_8hh_source.html#l00095">symbol()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00047"></a>00047 { <a name="l00048"></a>00048 <span class="keywordtype">char</span> buf[1024]; <a name="l00049"></a>00049 <span class="keywordtype">int</span> i; <a name="l00050"></a>00050 <span class="keywordtype">int</span> n = str.length(); <a name="l00051"></a>00051 <a name="l00052"></a>00052 <span class="keywordflow">if</span> (n>1023) n = 1023; <a name="l00053"></a>00053 <span class="keywordflow">for</span> (i = 0; i < n; i++) { buf[i] = str[i]; } <a name="l00054"></a>00054 buf[i] = 0; <a name="l00055"></a>00055 <a name="l00056"></a>00056 <span class="keywordflow">return</span> <a class="code" href="classSymbol.html#af8badc954a2122bb8087e084224af76e" title="Get the symbol of name str.">Symbol::get</a>(buf); <a name="l00057"></a>00057 } </pre></div></p> <p><div class="dynheader"> Here is the caller graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="a2fd22ca0779942ebaafcdf24a0d758f6"></a><!-- doxytag: member="Symbol::isnew" ref="a2fd22ca0779942ebaafcdf24a0d758f6" args="(const char *str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Symbol::isnew </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns <b>true</b> if no symbol of name <code>str</code> exists. </p> <p>Static method that searches the symbol table for a string.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>string to search </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if the string is NOT in the table (it is a new string) </dd></dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00085">85</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>References <a class="el" href="symbol_8cpp_source.html#l00140">calcHashKey()</a>, <a class="el" href="symbol_8cpp_source.html#l00127">equiv()</a>, <a class="el" href="symbol_8hh_source.html#l00065">fNext</a>, <a class="el" href="symbol_8hh_source.html#l00059">gSymbolTable</a>, and <a class="el" href="symbol_8hh_source.html#l00058">kHashTableSize</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00102">prefix()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00086"></a>00086 { <a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hsh = <a class="code" href="classSymbol.html#a5c9ccccee95f2d09e34b060076d52a29" title="Compute the 32-bits hash key of string str.">calcHashKey</a>(str); <a name="l00088"></a>00088 <span class="keywordtype">int</span> bckt = hsh % <a class="code" href="classSymbol.html#abb8b44fb98513a5d545a684c6024be4d" title="Size of the hash table (a prime number is recommended).">kHashTableSize</a>; <a name="l00089"></a>00089 <a class="code" href="classSymbol.html" title="Symbols are unique objects with a name stored in a hash table.">Symbol</a>* item = <a class="code" href="classSymbol.html#ad28a6fe0f613177e77bc29b98ad22ecd" title="Hash table used to store the symbols.">gSymbolTable</a>[bckt]; <a name="l00090"></a>00090 <a name="l00091"></a>00091 <span class="keywordflow">while</span> ( item && !item-><a class="code" href="classSymbol.html#ae5e90343699911affcc3372bcb131c50" title="Check if the name of the symbol is equal to string str.">equiv</a>(hsh,str) ) item = item-><a class="code" href="classSymbol.html#a2fc73a8c7c4a86ed96c48236e397bbf0" title="Next symbol in the hash table entry.">fNext</a>; <a name="l00092"></a>00092 <span class="keywordflow">return</span> item == 0; <a name="l00093"></a>00093 } </pre></div></p> <p><div class="dynheader"> Here is the call graph for this function:</div> <div class="dynsection"> </div> </p> <p><div class="dynheader"> Here is the caller graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="acab6dd6c1c62c49b03ca629f7e0dab36"></a><!-- doxytag: member="Symbol::prefix" ref="acab6dd6c1c62c49b03ca629f7e0dab36" args="(const char *str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a> * Symbol::prefix </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a new symbol of name prefixed by <code>str</code>. </p> <p>Creates a new symbol with a name obtained by concatenating the <code>str</code> prefix with a number in order to make it unique.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the prefix of the name </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a symbol of name <code>prefix++n</code> </dd></dl> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00102">102</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>References <a class="el" href="symbol_8cpp_source.html#l00085">isnew()</a>, and <a class="el" href="symbol_8hh_source.html#l00098">name</a>.</p> <p>Referenced by <a class="el" href="symbol_8hh_source.html#l00097">unique()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00103"></a>00103 { <a name="l00104"></a>00104 <span class="keywordtype">char</span> <a class="code" href="classSymbol.html#a8243134fbbd9d924ebbb3f833922e310" title="Returns the name of a symbol.">name</a>[256]; <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="keyword">static</span> map<const char*, unsigned int> gPrefixCounters; <a name="l00107"></a>00107 <a name="l00108"></a>00108 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> n = 0; n<10000; n++) { <a name="l00109"></a>00109 snprintf(name, 256, <span class="stringliteral">"%s%d"</span>, str, gPrefixCounters[str]++); <a name="l00110"></a>00110 <span class="keywordflow">if</span> (<a class="code" href="classSymbol.html#a2fd22ca0779942ebaafcdf24a0d758f6" title="Returns true if no symbol of name str exists.">isnew</a>(name)) <span class="keywordflow">return</span> <span class="keyword">get</span>(name); <a name="l00111"></a>00111 } <a name="l00112"></a>00112 assert(<span class="keyword">false</span>); <a name="l00113"></a>00113 <span class="keywordflow">return</span> <span class="keyword">get</span>(<span class="stringliteral">"UNIQUEOVERFLOW"</span>); <a name="l00114"></a>00114 } </pre></div></p> <p><div class="dynheader"> Here is the call graph for this function:</div> <div class="dynsection"> </div> </p> <p><div class="dynheader"> Here is the caller graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <a class="anchor" id="a80aa251523a4a1c24e9e9e679205f18e"></a><!-- doxytag: member="Symbol::print" ref="a80aa251523a4a1c24e9e9e679205f18e" args="(ostream &fout) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ostream & Symbol::print </td> <td>(</td> <td class="paramtype">ostream & </td> <td class="paramname"> <em>fout</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>print a symbol on a stream </p> <p>< print a symbol on a stream </p> <p>Definition at line <a class="el" href="symbol_8cpp_source.html#l00174">174</a> of file <a class="el" href="symbol_8cpp_source.html">symbol.cpp</a>.</p> <p>Referenced by <a class="el" href="symbol_8hh_source.html#l00103">operator<<()</a>.</p> <p><div class="fragment"><pre class="fragment"><a name="l00175"></a>00175 { <a name="l00176"></a>00176 <span class="keywordflow">return</span> fout << <a class="code" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1" title="Name of the symbol.">fName</a>; <a name="l00177"></a>00177 } </pre></div></p> <p><div class="dynheader"> Here is the caller graph for this function:</div> <div class="dynsection"> </div> </p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a603fcb6c07eacf2688c2a8470637d0ff"></a><!-- doxytag: member="Symbol::getUserData" ref="a603fcb6c07eacf2688c2a8470637d0ff" args="(Symbol *sym)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* getUserData </td> <td>(</td> <td class="paramtype"><a class="el" href="classSymbol.html">Symbol</a> * </td> <td class="paramname"> <em>sym</em></td> <td> ) </td> <td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns user data. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00100">100</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> </div> </div> <a class="anchor" id="a8243134fbbd9d924ebbb3f833922e310"></a><!-- doxytag: member="Symbol::name" ref="a8243134fbbd9d924ebbb3f833922e310" args="(Symbol *sym)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* name </td> <td>(</td> <td class="paramtype"><a class="el" href="classSymbol.html">Symbol</a> * </td> <td class="paramname"> <em>sym</em></td> <td> ) </td> <td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the name of a symbol. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00098">98</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00102">prefix()</a>.</p> </div> </div> <a class="anchor" id="a936471e3b0afa59ffec0a94f7d1b6570"></a><!-- doxytag: member="Symbol::setUserData" ref="a936471e3b0afa59ffec0a94f7d1b6570" args="(Symbol *sym, void *d)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void setUserData </td> <td>(</td> <td class="paramtype"><a class="el" href="classSymbol.html">Symbol</a> * </td> <td class="paramname"> <em>sym</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"> <em>d</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set user data. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00101">101</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> </div> </div> <a class="anchor" id="abfc1191889039b578e061d8c7780ec5f"></a><!-- doxytag: member="Symbol::symbol" ref="abfc1191889039b578e061d8c7780ec5f" args="(const string &str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a>* symbol </td> <td>(</td> <td class="paramtype">const string & </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns (and creates if new) the symbol of name <code>str</code>. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00096">96</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> </div> </div> <a class="anchor" id="aaa87083235b70d1042e59ae25e0800d8"></a><!-- doxytag: member="Symbol::symbol" ref="aaa87083235b70d1042e59ae25e0800d8" args="(const char *str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a>* symbol </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns (and creates if new) the symbol of name <code>str</code>. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00095">95</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> </div> </div> <a class="anchor" id="a377309446e0e86ae663cd6709e02889d"></a><!-- doxytag: member="Symbol::unique" ref="a377309446e0e86ae663cd6709e02889d" args="(const char *str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a>* unique </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>str</em></td> <td> ) </td> <td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a new unique symbol of name strxxx. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00097">97</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a43a1fda1b5819fc200c19509a0eae03e"></a><!-- doxytag: member="Symbol::fData" ref="a43a1fda1b5819fc200c19509a0eae03e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* <a class="el" href="classSymbol.html#a43a1fda1b5819fc200c19509a0eae03e">Symbol::fData</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Field to user disposal to store additional data. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00066">66</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8hh_source.html#l00100">getUserData()</a>, <a class="el" href="symbol_8hh_source.html#l00101">setUserData()</a>, and <a class="el" href="symbol_8cpp_source.html#l00158">Symbol()</a>.</p> </div> </div> <a class="anchor" id="a96342ef5b450e2edbdb9149798c7d435"></a><!-- doxytag: member="Symbol::fHash" ref="a96342ef5b450e2edbdb9149798c7d435" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="classSymbol.html#a96342ef5b450e2edbdb9149798c7d435">Symbol::fHash</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Hash key computed from the name and used to determine the hash table entry. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00064">64</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00127">equiv()</a>, and <a class="el" href="symbol_8cpp_source.html#l00158">Symbol()</a>.</p> </div> </div> <a class="anchor" id="a500120e613d60cba8faffc9544c06ad1"></a><!-- doxytag: member="Symbol::fName" ref="a500120e613d60cba8faffc9544c06ad1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* <a class="el" href="classSymbol.html#a500120e613d60cba8faffc9544c06ad1">Symbol::fName</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Name of the symbol. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00063">63</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00127">equiv()</a>, <a class="el" href="symbol_8hh_source.html#l00098">name()</a>, <a class="el" href="symbol_8cpp_source.html#l00158">Symbol()</a>, and <a class="el" href="symbol_8cpp_source.html#l00169">~Symbol()</a>.</p> </div> </div> <a class="anchor" id="a2fc73a8c7c4a86ed96c48236e397bbf0"></a><!-- doxytag: member="Symbol::fNext" ref="a2fc73a8c7c4a86ed96c48236e397bbf0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a>* <a class="el" href="classSymbol.html#a2fc73a8c7c4a86ed96c48236e397bbf0">Symbol::fNext</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Next symbol in the hash table entry. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00065">65</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00067">get()</a>, <a class="el" href="symbol_8cpp_source.html#l00085">isnew()</a>, and <a class="el" href="symbol_8cpp_source.html#l00158">Symbol()</a>.</p> </div> </div> <a class="anchor" id="ad28a6fe0f613177e77bc29b98ad22ecd"></a><!-- doxytag: member="Symbol::gSymbolTable" ref="ad28a6fe0f613177e77bc29b98ad22ecd" args="[kHashTableSize]" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSymbol.html">Symbol</a> * <a class="el" href="classSymbol.html#ad28a6fe0f613177e77bc29b98ad22ecd">Symbol::gSymbolTable</a><code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Hash table used to store the symbols. </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00059">59</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00067">get()</a>, and <a class="el" href="symbol_8cpp_source.html#l00085">isnew()</a>.</p> </div> </div> <a class="anchor" id="abb8b44fb98513a5d545a684c6024be4d"></a><!-- doxytag: member="Symbol::kHashTableSize" ref="abb8b44fb98513a5d545a684c6024be4d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const int <a class="el" href="classSymbol.html#abb8b44fb98513a5d545a684c6024be4d">Symbol::kHashTableSize</a> = 511<code> [static, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Size of the hash table (a prime number is recommended). </p> <p>Definition at line <a class="el" href="symbol_8hh_source.html#l00058">58</a> of file <a class="el" href="symbol_8hh_source.html">symbol.hh</a>.</p> <p>Referenced by <a class="el" href="symbol_8cpp_source.html#l00067">get()</a>, and <a class="el" href="symbol_8cpp_source.html#l00085">isnew()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="symbol_8hh_source.html">symbol.hh</a></li> <li><a class="el" href="symbol_8cpp_source.html">symbol.cpp</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Apr 29 00:00:24 2010 for FAUST compiler by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>