<!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: csutil/strhash.h Source File (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><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csutil/strhash.h</h1><a href="strhash_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2002 by Jorrit Tyberghein</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span> <a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00017"></a>00017 <span class="comment">*/</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_STRHASH_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_STRHASH_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#include "csextern.h"</span> <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="hash_8h.html" title="A generic hash table.">csutil/hash.h</a>"</span> <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="mempool_8h.html" title="Generic Memory Allocator.">csutil/mempool.h</a>"</span> <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="iutil_2strset_8h.html" title="Stringset interface.">iutil/strset.h</a>"</span> <a name="l00026"></a>00026 <a name="l00038"></a><a class="code" href="classcsStringHash.html">00038</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> <a name="l00039"></a>00039 { <a name="l00040"></a>00040 <span class="keyword">private</span>: <a name="l00041"></a>00041 <span class="keyword">typedef</span> <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">csHash<csStringID, char const*></a> <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">HashType</a>; <a name="l00042"></a>00042 <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">HashType</a> registry; <a name="l00043"></a>00043 <a class="code" href="classcsMemoryPool.html" title="A quick-allocation pool for storage of arbitrary data.">csMemoryPool</a> pool; <a name="l00044"></a>00044 <a name="l00045"></a>00045 <span class="keywordtype">void</span> Copy(<a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> <span class="keyword">const</span>&); <a name="l00046"></a>00046 <a name="l00047"></a>00047 <span class="keyword">public</span>: <a name="l00048"></a><a class="code" href="classcsStringHash.html#bc9f04415cbe70e38503e9193bb627d1">00048</a> <span class="keyword">typedef</span> <a class="code" href="classcsHash_1_1ConstGlobalIterator.html" title="An const iterator class for the hash.">HashType::ConstGlobalIterator</a> <a class="code" href="classcsHash_1_1ConstGlobalIterator.html" title="An const iterator class for the hash.">GlobalIterator</a>; <a name="l00049"></a>00049 <a name="l00050"></a>00050 <span class="keyword">public</span>: <a name="l00052"></a>00052 <a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> (<span class="keywordtype">size_t</span> size = 23); <a name="l00054"></a><a class="code" href="classcsStringHash.html#e0994fd1ead9695c06b82c694d7afef2">00054</a> <a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> (<a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> <span class="keyword">const</span>& h) { Copy(h); } <a name="l00056"></a>00056 ~<a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> (); <a name="l00058"></a><a class="code" href="classcsStringHash.html#3d27640fdff527b20c9485773b5ec29a">00058</a> <a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a>& operator=(<a class="code" href="classcsStringHash.html" title="A string-to-ID hash table.">csStringHash</a> <span class="keyword">const</span>& h) { Copy(h); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } <a name="l00059"></a>00059 <a name="l00079"></a>00079 <span class="keyword">const</span> <span class="keywordtype">char</span>* Register (<span class="keyword">const</span> <span class="keywordtype">char</span>* s, <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> <span class="keywordtype">id</span> = 0); <a name="l00080"></a>00080 <a name="l00086"></a>00086 <a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> Request (<span class="keyword">const</span> <span class="keywordtype">char</span>* s) <span class="keyword">const</span>; <a name="l00087"></a>00087 <a name="l00098"></a>00098 <span class="keyword">const</span> <span class="keywordtype">char</span>* Request (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> <span class="keywordtype">id</span>) <span class="keyword">const</span>; <a name="l00099"></a>00099 <a name="l00105"></a><a class="code" href="classcsStringHash.html#f664069dcfda1b5195b026be73687f0e">00105</a> <span class="keywordtype">bool</span> Contains(<span class="keywordtype">char</span> <span class="keyword">const</span>* s)<span class="keyword"> const</span> <a name="l00106"></a>00106 <span class="keyword"> </span>{ <span class="keywordflow">return</span> Request(s) != <a class="code" href="group__util.html#g441e9321397d7398ee7f4da14ba477c8" title="An invalid csStringID.">csInvalidStringID</a>; } <a name="l00107"></a>00107 <a name="l00116"></a><a class="code" href="classcsStringHash.html#8f1dede993638e1905dbdbd0a5d4a3fb">00116</a> <span class="keywordtype">bool</span> Contains(<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> <span class="keywordtype">id</span>)<span class="keyword"> const</span> <a name="l00117"></a>00117 <span class="keyword"> </span>{ <span class="keywordflow">return</span> Request(<span class="keywordtype">id</span>) != 0; } <a name="l00118"></a>00118 <a name="l00123"></a>00123 <span class="keywordtype">bool</span> Delete(<span class="keywordtype">char</span> <span class="keyword">const</span>* s); <a name="l00124"></a>00124 <a name="l00131"></a>00131 <span class="keywordtype">bool</span> Delete(<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> <span class="keywordtype">id</span>); <a name="l00132"></a>00132 <a name="l00136"></a>00136 <span class="keywordtype">void</span> Empty (); <a name="l00137"></a>00137 <a name="l00142"></a>00142 <span class="comment">/*CS_DEPRECATED_METHOD("Use Empty() instead.")*/</span> <a name="l00143"></a><a class="code" href="classcsStringHash.html#8c69d63cd90d1642a21a49561ce80e06">00143</a> <span class="keywordtype">void</span> Clear () <a name="l00144"></a>00144 { Empty(); } <a name="l00145"></a>00145 <a name="l00147"></a><a class="code" href="classcsStringHash.html#5919b02edb524864ce7137ea3185e6a7">00147</a> <span class="keywordtype">size_t</span> GetSize ()<span class="keyword"> const</span> <a name="l00148"></a>00148 <span class="keyword"> </span>{ <span class="keywordflow">return</span> registry.GetSize (); } <a name="l00149"></a>00149 <a name="l00155"></a><a class="code" href="classcsStringHash.html#64eddf4090ec31dadf6f9b15beb8729c">00155</a> <span class="keywordtype">bool</span> IsEmpty()<span class="keyword"> const</span> <a name="l00156"></a>00156 <span class="keyword"> </span>{ <span class="keywordflow">return</span> GetSize() == 0; } <a name="l00157"></a>00157 <a name="l00163"></a><a class="code" href="classcsStringHash.html#87c7e5528207b6ec6080ed847e27bf56">00163</a> <a class="code" href="classcsHash_1_1ConstGlobalIterator.html" title="An const iterator class for the hash.">GlobalIterator</a> GetIterator ()<span class="keyword"> const</span> <a name="l00164"></a>00164 <span class="keyword"> </span>{ <span class="keywordflow">return</span> registry.GetIterator(); } <a name="l00165"></a>00165 }; <a name="l00166"></a>00166 <a name="l00167"></a>00167 <span class="preprocessor">#endif // __CS_STRHASH_H__</span> </pre></div><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>