snth
/
CToolBox


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ToolBox Library: include/toolbox/hashtable.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">ToolBox Library<span id="projectnumber">&#160;2.1.0</span>
   </div>
   <div id="projectbrief">An Library containing function and class to make developing in C faster</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_dc8d4286420b7aa8efcc9a53b027321f.html">toolbox</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">hashtable.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="preprocessor">#ifndef TOOLBOX_HASHTABLE_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define TOOLBOX_HASHTABLE_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="preprocessor">#include &quot;toolbox/return_codes.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#ifndef HASHTABLE_SIZE_BYTES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#define HASHTABLE_SIZE_BYTES (1024*1024)</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#ifdef TOOLBOX_TYPEDEF</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structhashtable.html">hashtable</a> hashtable_st;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="keyword">struct </span><a class="code hl_struct" href="structhashtable.html">hashtable</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="keyword">struct </span><a class="code hl_struct" href="structhashtable.html">hashtable</a> *</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>hashtable_create(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>RET_TYPE</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>hashtable_destroy(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> **self);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>hashtable_contain_item(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>                        , <span class="keyword">const</span> <span class="keywordtype">void</span>* item, <span class="keyword">const</span> <span class="keywordtype">size_t</span> item_size);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>hashtable_contain_key(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>                       , <span class="keyword">const</span> <span class="keywordtype">char</span> *key);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>hashtable_contain_key_hash(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>                            , <span class="keyword">const</span> <span class="keywordtype">size_t</span> key_hash);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="keyword">const</span> <span class="keywordtype">void</span> *</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>hashtable_get(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>              , <span class="keyword">const</span> <span class="keywordtype">char</span> *key);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="keyword">const</span> <span class="keywordtype">void</span> *</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>hashtable_get_or_default(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>                         , <span class="keyword">const</span> <span class="keywordtype">char</span> *key</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>                         , <span class="keyword">const</span> <span class="keywordtype">void</span> *default_item);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>__attribute__((__pure__))</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>hashtable_is_empty(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>RET_TYPE</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>hashtable_put(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>              , <span class="keyword">const</span> <span class="keywordtype">char</span> *key</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>              , <span class="keyword">const</span> <span class="keywordtype">void</span> *item, <span class="keyword">const</span> <span class="keywordtype">size_t</span> item_size);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="keyword">const</span> <span class="keywordtype">void</span> *</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>hashtable_remove(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>hashtable_remove_if_equal(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>                          , <span class="keyword">const</span> <span class="keywordtype">char</span> *key</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>                          , <span class="keyword">const</span> <span class="keywordtype">void</span> *item, <span class="keyword">const</span> <span class="keywordtype">size_t</span> item_size);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="keyword">const</span> <span class="keywordtype">void</span> *</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>hashtable_replace(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>                  , <span class="keyword">const</span> <span class="keywordtype">char</span> *key</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>                  , <span class="keyword">const</span> <span class="keywordtype">void</span> *item, <span class="keyword">const</span> <span class="keywordtype">size_t</span> item_size);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>hashtable_replace_if_equal(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>                           , <span class="keyword">const</span> <span class="keywordtype">char</span> *key</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>                           , <span class="keyword">const</span> <span class="keywordtype">void</span> *restrict old_item</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>                           , <span class="keyword">const</span> <span class="keywordtype">size_t</span> item_old_size</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>                           , <span class="keyword">const</span> <span class="keywordtype">void</span> *restrict new_item</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>                           , <span class="keyword">const</span> <span class="keywordtype">size_t</span> item_new_size);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="keywordtype">size_t</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>hashtable_used_size(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>RET_TYPE</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>hashtable_for_each(<span class="keyword">struct</span> <a class="code hl_struct" href="structhashtable.html">hashtable</a> *self</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>                   , <span class="keywordtype">void</span> (*for_each)(<span class="keywordtype">void</span> *item, <span class="keywordtype">size_t</span> *item_size));</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="astructhashtable_html"><div class="ttname"><a href="structhashtable.html">hashtable</a></div><div class="ttdef"><b>Definition:</b> hashtable.c:29</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>