mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 02:09:17 +02:00
100 lines
23 KiB
HTML
100 lines
23 KiB
HTML
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Delta Chat Core C-API: /home/bpetersen/projects/deltachat-core/src/mrhash.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="user.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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Delta Chat Core C-API
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">mrhash.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Delta Chat Core</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2017 Björn Petersen</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Contact: r10s@b44t.com, http://b44t.com</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify it under</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the terms of the GNU General Public License as published by the Free Software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Foundation, either version 3 of the License, or (at your option) any later</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * version.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This program is distributed in the hope that it will be useful, but WITHOUT</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * details.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License along with</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * this program. If not, see http://www.gnu.org/licenses/ .</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef __MRHASH_H__</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define __MRHASH_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/* Forward declarations of structures.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrhashelem_t mrhashelem_t;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/* A complete hash table is an instance of the following structure.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * The internals of this structure are intended to be opaque -- client</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * code should not attempt to access or modify the fields of this structure</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * directly. Change this structure only by using the routines below.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * However, many of the "procedures" and "functions" for modifying and</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * accessing this structure are really macros, so we can't really make</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * this structure opaque.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrhash_t</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">char</span> keyClass; <span class="comment">/* SJHASH_INT, _POINTER, _STRING, _BINARY */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">char</span> copyKey; <span class="comment">/* True if copy of key made on insert */</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">int</span> count; <span class="comment">/* Number of entries in this table */</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  mrhashelem_t* first; <span class="comment">/* The first element of the array */</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">int</span> htsize; <span class="comment">/* Number of buckets in the hash table */</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">struct </span>_ht</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  { <span class="comment">/* the hash table */</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> count; <span class="comment">/* Number of entries with this hash */</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  mrhashelem_t* chain; <span class="comment">/* Pointer to first entry with this hash */</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  } *ht;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } mrhash_t;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/* Each element in the hash table is an instance of the following</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * structure. All elements are stored on a single doubly-linked list.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> *</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * Again, this structure is intended to be opaque, but it can't really</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * be opaque because it is used by macros.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> */</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>mrhashelem_t</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  mrhashelem_t *next, *prev; <span class="comment">/* Next and previous elements in the table */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span>* data; <span class="comment">/* Data associated with this element */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span>* pKey; <span class="comment">/* Key associated with this element */</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">int</span> nKey; <span class="comment">/* Key associated with this element */</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } mrhashelem_t;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/*</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * There are 4 different modes of operation for a hash table:</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * MRHASH_INT nKey is used as the key and pKey is ignored.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> *</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * MRHASH_POINTER pKey is used as the key and nKey is ignored.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> *</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * MRHASH_STRING pKey points to a string that is nKey bytes long</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * (including the null-terminator, if any). Case</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * is ignored in comparisons.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> *</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * MRHASH_BINARY pKey points to binary data nKey bytes long.</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * memcmp() is used to compare keys.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * A copy of the key is made for MRHASH_STRING and MRHASH_BINARY</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * if the copyKey parameter to mrhash_init() is 1.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#define MRHASH_INT 1</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#define MRHASH_POINTER 2</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#define MRHASH_STRING 3</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#define MRHASH_BINARY 4</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/*</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * Access routines. To delete an element, insert a NULL pointer.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">void</span> mrhash_init (mrhash_t*, <span class="keywordtype">int</span> keytype, <span class="keywordtype">int</span> copyKey);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span>* mrhash_insert (mrhash_t*, <span class="keyword">const</span> <span class="keywordtype">void</span> *pKey, <span class="keywordtype">int</span> nKey, <span class="keywordtype">void</span> *pData);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">void</span>* mrhash_find (<span class="keyword">const</span> mrhash_t*, <span class="keyword">const</span> <span class="keywordtype">void</span> *pKey, <span class="keywordtype">int</span> nKey);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">void</span> mrhash_clear (mrhash_t*);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/*</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * Macros for looping over all elements of a hash table. The idiom is</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * like this:</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> *</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * SjHash h;</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * SjHashElem *p;</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * ...</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * for(p=mrhash_first(&h); p; p=mrhash_next(p)){</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * SomeStructure *pData = mrhash_data(p);</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * // do something with pData</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * }</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> */</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#define mrhash_first(H) ((H)->first)</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#define mrhash_next(E) ((E)->next)</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#define mrhash_data(E) ((E)->data)</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#define mrhash_key(E) ((E)->pKey)</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#define mrhash_keysize(E) ((E)->nKey)</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">/*</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * Number of entries in a hash table</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#define mrhash_count(H) ((H)->count)</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> }; <span class="comment">/* /extern "C" */</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif </span><span class="comment">/* __MRHASH_H__ */</span><span class="preprocessor"></span></div></div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<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.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|