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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
|
<!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>pam_pkcs11: strings.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_55f9682142a78e45196901be32452b47.html">src</a> » <a class="el" href="dir_782c1fcd7529e1a05f3f2af490691324.html">common</a>
</div>
</div>
<div class="contents">
<h1>strings.h File Reference</h1><code>#include <stdlib.h></code><br/>
<code>#include <string.h></code><br/>
<p><a href="strings_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#ae3fd0a2c68f60144e9b18b1ba45763e1">M_EXTERN</a> extern</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">String management library. <a href="#ae3fd0a2c68f60144e9b18b1ba45763e1"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#a9631e70f79c6394494793f7c52c0b194">is_empty_str</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check for a null or spaced string. <a href="#a9631e70f79c6394494793f7c52c0b194"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#a371a8cb3e3e24b794a5a871fff24242e">clone_str</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Duplicate a string. <a href="#a371a8cb3e3e24b794a5a871fff24242e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#ae73c7044be9e0f7e49ef2fecc0e1c143">toupper_str</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Duplicate a string converting all chars to upper-case. <a href="#ae73c7044be9e0f7e49ef2fecc0e1c143"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#ae51f5a5400748bc9b8b50f4d3480d588">tolower_str</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Duplicate a string converting all chars to lower-case. <a href="#ae51f5a5400748bc9b8b50f4d3480d588"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#a24e94eaf64482af3501c9f060b73d6f7">bin2hex</a> (const unsigned char *binstr, const int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a byte array into a colon-separated hexadecimal sequence. <a href="#a24e94eaf64482af3501c9f060b73d6f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#ae3f4c76d88e1efa97cb1d057c2abdc80">hex2bin</a> (const char *hexstr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a colon-separated hexadecimal data into a byte array. <a href="#ae3f4c76d88e1efa97cb1d057c2abdc80"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#a827a0b95a57290a2d2059d712cb168ee">hex2bin_static</a> (const char *hexstr, unsigned char **res, int *size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a colon-separated hexadecimal data into a byte array, store result into a previously allocated space. <a href="#a827a0b95a57290a2d2059d712cb168ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#a9b7df0677fdea0c65c0faddfc40ff7ad">split</a> (const char *str, char sep, int nelems)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Splits a string to an array of nelems by using sep as character separator. <a href="#a9b7df0677fdea0c65c0faddfc40ff7ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#a5d3af2a4e490a5b521b7b2f22c6a4bbf">split_static</a> (const char *str, char sep, int nelems, char *dst)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Splits a string to an array of nelems by using sep as character separator, using dest as pre-allocated destination memory for the resulting array. <a href="#a5d3af2a4e490a5b521b7b2f22c6a4bbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">M_EXTERN char * </td><td class="memItemRight" valign="bottom"><a class="el" href="strings_8h.html#ac255ca3660b53737550b93d1020a1dd2">trim</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all extra spaces from a string. <a href="#ac255ca3660b53737550b93d1020a1dd2"></a><br/></td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ae3fd0a2c68f60144e9b18b1ba45763e1"></a><!-- doxytag: member="strings.h::M_EXTERN" ref="ae3fd0a2c68f60144e9b18b1ba45763e1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_EXTERN extern</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>String management library. </p>
<p>Definition at line <a class="el" href="strings_8h_source.html#l00037">37</a> of file <a class="el" href="strings_8h_source.html">strings.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a24e94eaf64482af3501c9f060b73d6f7"></a><!-- doxytag: member="strings.h::bin2hex" ref="a24e94eaf64482af3501c9f060b73d6f7" args="(const unsigned char *binstr, const int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char* bin2hex </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>binstr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a byte array into a colon-separated hexadecimal sequence. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>binstr</em> </td><td>ByteArray to be parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Number of bytes to be converted </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to result string or null if error in allocating memory </dd></dl>
</div>
</div>
<a class="anchor" id="a371a8cb3e3e24b794a5a871fff24242e"></a><!-- doxytag: member="strings.h::clone_str" ref="a371a8cb3e3e24b794a5a871fff24242e" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char* clone_str </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Duplicate a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to be cloned </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to cloned string or null if error in allocating memory </dd></dl>
</div>
</div>
<a class="anchor" id="ae3f4c76d88e1efa97cb1d057c2abdc80"></a><!-- doxytag: member="strings.h::hex2bin" ref="ae3f4c76d88e1efa97cb1d057c2abdc80" args="(const char *hexstr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN unsigned char* hex2bin </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>hexstr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a colon-separated hexadecimal data into a byte array. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hexstr</em> </td><td>String to be parsed </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to resulting byte array, or null if no memory available </dd></dl>
</div>
</div>
<a class="anchor" id="a827a0b95a57290a2d2059d712cb168ee"></a><!-- doxytag: member="strings.h::hex2bin_static" ref="a827a0b95a57290a2d2059d712cb168ee" args="(const char *hexstr, unsigned char **res, int *size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN unsigned char* hex2bin_static </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>hexstr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char ** </td>
<td class="paramname"> <em>res</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a colon-separated hexadecimal data into a byte array, store result into a previously allocated space. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hexstr</em> </td><td>String to be parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>res</em> </td><td>Pointer to pre-allocated user space </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Pointer to store lenght of data parsed </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to resulting byte array, or null on parse error </dd></dl>
</div>
</div>
<a class="anchor" id="a9631e70f79c6394494793f7c52c0b194"></a><!-- doxytag: member="strings.h::is_empty_str" ref="a9631e70f79c6394494793f7c52c0b194" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN int is_empty_str </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check for a null or spaced string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Tested string </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>nonzero on null, empty or spaced string, else zero </dd></dl>
</div>
</div>
<a class="anchor" id="a9b7df0677fdea0c65c0faddfc40ff7ad"></a><!-- doxytag: member="strings.h::split" ref="a9b7df0677fdea0c65c0faddfc40ff7ad" args="(const char *str, char sep, int nelems)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char** split </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelems</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Splits a string to an array of nelems by using sep as character separator. </p>
<p>To free() memory used by this call, call free(res[0]); free(res); </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to be parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sep</em> </td><td>Character to be used as separator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nelems</em> </td><td>Number of elements of resulting array </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>res: Pointer to resulting string array, or null if malloc() error </dd></dl>
</div>
</div>
<a class="anchor" id="a5d3af2a4e490a5b521b7b2f22c6a4bbf"></a><!-- doxytag: member="strings.h::split_static" ref="a5d3af2a4e490a5b521b7b2f22c6a4bbf" args="(const char *str, char sep, int nelems, char *dst)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char** split_static </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>dst</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Splits a string to an array of nelems by using sep as character separator, using dest as pre-allocated destination memory for the resulting array. </p>
<p>To free() memory used by this call, just call free result pointer </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to be parsed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sep</em> </td><td>Character to be used as separator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nelems</em> </td><td>Number of elements of resulting array </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dst</em> </td><td>Char array to store temporary data </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to resulting string array, or null if malloc() error </dd></dl>
</div>
</div>
<a class="anchor" id="ae51f5a5400748bc9b8b50f4d3480d588"></a><!-- doxytag: member="strings.h::tolower_str" ref="ae51f5a5400748bc9b8b50f4d3480d588" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char* tolower_str </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Duplicate a string converting all chars to lower-case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to be cloned & lowercased </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to result string or null if error in allocating memory </dd></dl>
</div>
</div>
<a class="anchor" id="ae73c7044be9e0f7e49ef2fecc0e1c143"></a><!-- doxytag: member="strings.h::toupper_str" ref="ae73c7044be9e0f7e49ef2fecc0e1c143" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char* toupper_str </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Duplicate a string converting all chars to upper-case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to be cloned & uppercassed </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to result string or null if error in allocating memory </dd></dl>
</div>
</div>
<a class="anchor" id="ac255ca3660b53737550b93d1020a1dd2"></a><!-- doxytag: member="strings.h::trim" ref="ac255ca3660b53737550b93d1020a1dd2" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">M_EXTERN char* trim </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all extra spaces from a string. </p>
<p>a char is considered space if trues isspace()</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to be trimmed </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to cloned string with all spaces trimmed or null if error in allocating memory </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Jun 12 17:28:16 2010 for pam_pkcs11 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|
