-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbytemap_8h.html
223 lines (198 loc) · 9.98 KB
/
bytemap_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!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"/>
<title>libusual: usual/bytemap.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libusual
 <span id="projectnumber">0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></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>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">usual/bytemap.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Map 256 byte values to bit or int.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bitmap256.html">Bitmap256</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bitmap of 256 bits. <a href="struct_bitmap256.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bytemap_8h.html#a787843e1d47cac9a33be3cf63bbdad16">BITMAP256_CONST</a>(check)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use C preprocessor to fill <a class="el" href="struct_bitmap256.html" title="Bitmap of 256 bits.">Bitmap256</a>. <a href="#a787843e1d47cac9a33be3cf63bbdad16"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="bytemap_8h.html#a51298f571d750930099aaec35b16324d">INTMAP256_CONST</a>(map_value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use C preprocessor to generate array of 256 values. <a href="#a51298f571d750930099aaec35b16324d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="bytemap_8h.html#a27575fae19eaa5ae3ad88b8d5c894053">bitmap256_init</a> (struct <a class="el" href="struct_bitmap256.html">Bitmap256</a> *bmap)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear bitmap. <a href="#a27575fae19eaa5ae3ad88b8d5c894053"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="bytemap_8h.html#a03057da33beadf17f15548fa9aaea0ca">bitmap256_set</a> (struct <a class="el" href="struct_bitmap256.html">Bitmap256</a> *bmap, uint8_t byte)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set one bit. <a href="#a03057da33beadf17f15548fa9aaea0ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="bytemap_8h.html#a1b84114c47dbbfeba4f299d1a2278128">bitmap256_is_set</a> (const struct <a class="el" href="struct_bitmap256.html">Bitmap256</a> *bmap, uint8_t byte)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if bit is set. <a href="#a1b84114c47dbbfeba4f299d1a2278128"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Map 256 byte values to bit or int. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a787843e1d47cac9a33be3cf63bbdad16"></a><!-- doxytag: member="bytemap.h::BITMAP256_CONST" ref="a787843e1d47cac9a33be3cf63bbdad16" args="(check)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="bytemap_8h.html#a787843e1d47cac9a33be3cf63bbdad16">BITMAP256_CONST</a></td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">check</td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use C preprocessor to fill <a class="el" href="struct_bitmap256.html" title="Bitmap of 256 bits.">Bitmap256</a>. </p>
<p>Usage: </p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #define check_isdigit(c) ((c) >= '0' && (c) <= '9')</span>
<span class="preprocessor"> static const struct Bitmap256 map_isdigit = BITMAP256_CONST(check_isdigit);</span>
</pre></div>
</div>
</div>
<a class="anchor" id="a51298f571d750930099aaec35b16324d"></a><!-- doxytag: member="bytemap.h::INTMAP256_CONST" ref="a51298f571d750930099aaec35b16324d" args="(map_value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="bytemap_8h.html#a51298f571d750930099aaec35b16324d">INTMAP256_CONST</a></td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">map_value</td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use C preprocessor to generate array of 256 values. </p>
<p>Usage: </p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #define my_hexval(c) (((c) >= '0' && (c) <= '9') ? ((c) - '0') : ( \</span>
<span class="preprocessor"> ((c) >= 'A' && (c) <= 'F') ? ((c) - 'A' + 10) : ( \</span>
<span class="preprocessor"> ((c) >= 'a' && (c) <= 'f') ? ((c) - 'a' + 10) : -1 )))</span>
<span class="preprocessor"> static const int map_hexval[] = INTMAP256_CONST(my_hexval);</span>
</pre></div>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a27575fae19eaa5ae3ad88b8d5c894053"></a><!-- doxytag: member="bytemap.h::bitmap256_init" ref="a27575fae19eaa5ae3ad88b8d5c894053" args="(struct Bitmap256 *bmap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="bytemap_8h.html#a27575fae19eaa5ae3ad88b8d5c894053">bitmap256_init</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_bitmap256.html">Bitmap256</a> * </td>
<td class="paramname"><em>bmap</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear bitmap. </p>
</div>
</div>
<a class="anchor" id="a03057da33beadf17f15548fa9aaea0ca"></a><!-- doxytag: member="bytemap.h::bitmap256_set" ref="a03057da33beadf17f15548fa9aaea0ca" args="(struct Bitmap256 *bmap, uint8_t byte)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="bytemap_8h.html#a03057da33beadf17f15548fa9aaea0ca">bitmap256_set</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_bitmap256.html">Bitmap256</a> * </td>
<td class="paramname"><em>bmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>byte</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set one bit. </p>
</div>
</div>
<a class="anchor" id="a1b84114c47dbbfeba4f299d1a2278128"></a><!-- doxytag: member="bytemap.h::bitmap256_is_set" ref="a1b84114c47dbbfeba4f299d1a2278128" args="(const struct Bitmap256 *bmap, uint8_t byte)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="bytemap_8h.html#a1b84114c47dbbfeba4f299d1a2278128">bitmap256_is_set</a> </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="struct_bitmap256.html">Bitmap256</a> * </td>
<td class="paramname"><em>bmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>byte</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if bit is set. </p>
</div>
</div>
</div><!-- contents -->
<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.7.6.1
</small></address>
</body>
</html>