<!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>ANTLR3C: ANTLR3_HASH_ENTRY_struct Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ANTLR3C <span id="projectnumber">3.1.2</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" 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>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>ANTLR3_HASH_ENTRY_struct Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ANTLR3_HASH_ENTRY_struct" -->
<p>Internal structure representing an element in a hash bucket.
<a href="#_details">More...</a></p>
<p><code>#include <antlr3collections.h></code></p>
<div class="dynheader">
Collaboration diagram for ANTLR3_HASH_ENTRY_struct:</div>
<div class="dyncontent">
<div class="center"><img src="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct__coll__graph.png" border="0" usemap="#_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct_coll__map" alt="Collaboration graph"/></div>
<map name="_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct_coll__map" id="_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct_coll__map">
<area shape="rect" id="node3" href="struct_a_n_t_l_r3___h_a_s_h___k_e_y__struct.html" title="ANTLR3_HASH_KEY_struct" alt="" coords="15,5,257,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<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="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#afadbac81f409738376f4bc88a9d0a154">void</a> (ANTLR3_CDECL *free)(void *<a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#afc2e60867f757681c1d0c32582c0a4e5">data</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to routine that knows how to release the memory structure pointed at by data. <a href="#afadbac81f409738376f4bc88a9d0a154"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#afc2e60867f757681c1d0c32582c0a4e5">data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the data for this particular entry. <a href="#afc2e60867f757681c1d0c32582c0a4e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___h_a_s_h___k_e_y__struct.html">ANTLR3_HASH_KEY</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#a4d8303b5c6bfcfb33c6db86c88915d37">keybase</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Key that created this particular entry. <a href="#a4d8303b5c6bfcfb33c6db86c88915d37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html">ANTLR3_HASH_ENTRY_struct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#a915d0ff5431c587100dbd7b93e19f6f6">nextEntry</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the next entry in this bucket if there is one. <a href="#a915d0ff5431c587100dbd7b93e19f6f6"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Internal structure representing an element in a hash bucket. </p>
<p>Stores the original key so that duplicate keys can be rejected if necessary, and contains function can be supported. If the hash key could be unique I would have invented the perfect compression algorithm ;-) </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afadbac81f409738376f4bc88a9d0a154"></a><!-- doxytag: member="ANTLR3_HASH_ENTRY_struct::void" ref="afadbac81f409738376f4bc88a9d0a154" args="(ANTLR3_CDECL *free)(void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANTLR3_HASH_ENTRY_struct::void </td>
<td>(</td>
<td class="paramtype">ANTLR3_CDECL * </td>
<td class="paramname"><em>free</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to routine that knows how to release the memory structure pointed at by data. </p>
<p>If this is NULL then we assume that the data pointer does not need to be freed when the entry is deleted from the table. </p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="afc2e60867f757681c1d0c32582c0a4e5"></a><!-- doxytag: member="ANTLR3_HASH_ENTRY_struct::data" ref="afc2e60867f757681c1d0c32582c0a4e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#afc2e60867f757681c1d0c32582c0a4e5">ANTLR3_HASH_ENTRY_struct::data</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the data for this particular entry. </p>
<p>Referenced by <a class="el" href="antlr3collections_8c.html#a691a8aa16bc41bc97f89d0cd902c31f5">antlr3EnumNext()</a>, <a class="el" href="antlr3collections_8c.html#aaea6272a5954d13fb3214a5d3027f796">antlr3HashDelete()</a>, <a class="el" href="antlr3collections_8c.html#a1b74c417ac295e8d76b4dc395bf979ab">antlr3HashDeleteI()</a>, <a class="el" href="antlr3collections_8c.html#a51a90be3333359353ae3d5edd2eb5089">antlr3HashFree()</a>, <a class="el" href="antlr3collections_8c.html#a7024681654bc4c2d2a967d46cf3c2709">antlr3HashGet()</a>, <a class="el" href="antlr3collections_8c.html#a6a13e744e2b7cfd0065366ebc37d212e">antlr3HashGetI()</a>, <a class="el" href="antlr3collections_8c.html#a2e1eb0280223979fb6fde18c4c31a218">antlr3HashPut()</a>, <a class="el" href="antlr3collections_8c.html#ab1cfbe163e017a81802608cba170ab6a">antlr3HashPutI()</a>, and <a class="el" href="antlr3collections_8c.html#a23fc2b9acdc4ef65f95d763b21fdf05c">antlr3ListRemove()</a>.</p>
</div>
</div>
<a class="anchor" id="a4d8303b5c6bfcfb33c6db86c88915d37"></a><!-- doxytag: member="ANTLR3_HASH_ENTRY_struct::keybase" ref="a4d8303b5c6bfcfb33c6db86c88915d37" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_n_t_l_r3___h_a_s_h___k_e_y__struct.html">ANTLR3_HASH_KEY</a> <a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#a4d8303b5c6bfcfb33c6db86c88915d37">ANTLR3_HASH_ENTRY_struct::keybase</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Key that created this particular entry. </p>
<p>Referenced by <a class="el" href="antlr3collections_8c.html#a691a8aa16bc41bc97f89d0cd902c31f5">antlr3EnumNext()</a>, <a class="el" href="antlr3collections_8c.html#a51a90be3333359353ae3d5edd2eb5089">antlr3HashFree()</a>, <a class="el" href="antlr3collections_8c.html#a7024681654bc4c2d2a967d46cf3c2709">antlr3HashGet()</a>, <a class="el" href="antlr3collections_8c.html#a6a13e744e2b7cfd0065366ebc37d212e">antlr3HashGetI()</a>, <a class="el" href="antlr3collections_8c.html#a2e1eb0280223979fb6fde18c4c31a218">antlr3HashPut()</a>, <a class="el" href="antlr3collections_8c.html#ab1cfbe163e017a81802608cba170ab6a">antlr3HashPutI()</a>, <a class="el" href="antlr3collections_8c.html#acf11629cadc4a779debec12de281c830">antlr3HashRemove()</a>, and <a class="el" href="antlr3collections_8c.html#abc5a008b51c86e80d5c46aefd22af6a1">antlr3HashRemoveI()</a>.</p>
</div>
</div>
<a class="anchor" id="a915d0ff5431c587100dbd7b93e19f6f6"></a><!-- doxytag: member="ANTLR3_HASH_ENTRY_struct::nextEntry" ref="a915d0ff5431c587100dbd7b93e19f6f6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html">ANTLR3_HASH_ENTRY_struct</a>* <a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html#a915d0ff5431c587100dbd7b93e19f6f6">ANTLR3_HASH_ENTRY_struct::nextEntry</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the next entry in this bucket if there is one. </p>
<p>Sometimes different keys will hash to the same bucket (especially if the number of buckets is small). We could implement dual hashing algorithms to minimize this, but that seems over the top for what this is needed for. </p>
<p>Referenced by <a class="el" href="antlr3collections_8c.html#abe4443f489f623fd658f5a9f67655fbb">antlr3EnumNextEntry()</a>, <a class="el" href="antlr3collections_8c.html#a51a90be3333359353ae3d5edd2eb5089">antlr3HashFree()</a>, <a class="el" href="antlr3collections_8c.html#a7024681654bc4c2d2a967d46cf3c2709">antlr3HashGet()</a>, <a class="el" href="antlr3collections_8c.html#a6a13e744e2b7cfd0065366ebc37d212e">antlr3HashGetI()</a>, <a class="el" href="antlr3collections_8c.html#a2e1eb0280223979fb6fde18c4c31a218">antlr3HashPut()</a>, <a class="el" href="antlr3collections_8c.html#ab1cfbe163e017a81802608cba170ab6a">antlr3HashPutI()</a>, <a class="el" href="antlr3collections_8c.html#acf11629cadc4a779debec12de281c830">antlr3HashRemove()</a>, and <a class="el" href="antlr3collections_8c.html#abc5a008b51c86e80d5c46aefd22af6a1">antlr3HashRemoveI()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="antlr3collections_8h.html">antlr3collections.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html">ANTLR3_HASH_ENTRY_struct</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for ANTLR3C by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
