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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>incron: StringTokenizer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>StringTokenizer Class Reference</h1><!-- doxytag: class="StringTokenizer" -->Simple string tokenizer class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="strtok_8h-source.html">strtok.h</a>></code>
<p>
<p>
<a href="classStringTokenizer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#abacf484c3ed4e8d9f00801ecbe4881b">StringTokenizer</a> (const std::string &rStr, char cDelim= ',', char cPrefix= '\0')</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#abacf484c3ed4e8d9f00801ecbe4881b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#26a59cd69f871ace17ec831e1508b377">~StringTokenizer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#26a59cd69f871ace17ec831e1508b377"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#f6f1497f3a3f18ff8c8c664782c4d6e2">HasMoreTokens</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the tokenizer can provide more tokens. <a href="#f6f1497f3a3f18ff8c8c664782c4d6e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#62da00196f41b154dfb4c0969fd13f30">GetNextToken</a> (bool fSkipEmpty=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next token. <a href="#62da00196f41b154dfb4c0969fd13f30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#4a089402dd2c2e486221f331bf2b77b6">GetNextTokenRaw</a> (bool fSkipEmpty=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the next token. <a href="#4a089402dd2c2e486221f331bf2b77b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#8f2379a3dd119a1e00aac7a710ac1e72">GetRemainder</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the remainder of the source string. <a href="#8f2379a3dd119a1e00aac7a710ac1e72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#62764b5e11edee9ae256725bcc81b397">SetDelimiter</a> (char cDelim)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a delimiter (separator) character. <a href="#62764b5e11edee9ae256725bcc81b397"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#2a553eebdd4848f0dcdfd63d3bd70ab3">GetDelimiter</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the delimiter (separator) character. <a href="#2a553eebdd4848f0dcdfd63d3bd70ab3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#b448703764e979812c857a1616411e79">SetPrefix</a> (char cPrefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a prefix character. <a href="#b448703764e979812c857a1616411e79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#74f70c56d6fac1eb0006b18f5ad82dcb">GetPrefix</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the prefix character. <a href="#74f70c56d6fac1eb0006b18f5ad82dcb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#627a26cfed1b3159802a7f0cb54b40f5">SetNoPrefix</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the prefix to 'no prefix'. <a href="#627a26cfed1b3159802a7f0cb54b40f5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringTokenizer.html#8084d41ec9c314128c01b6a361e62591">Reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the tokenizer. <a href="#8084d41ec9c314128c01b6a361e62591"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Simple string tokenizer class.
<p>
This class implements a string tokenizer. It splits a string by a character to a number of elements (tokens) which are provided sequentially.<p>
All operations are made on a copy of the original string (which may be in fact a copy-on-write instance).<p>
The original string is left unchanged. All tokens are returned as newly created strings.<p>
There is possibility to specify a prefix character which causes the consecutive character is not considered as a delimiter. If you don't specify this character (or specify the NUL character, 0x00) this feature is disabled. The mostly used prefix is a backslash ('\').<p>
This class is not thread-safe.<p>
Performance note: This class is currently not intended to be very fast. Speed optimizations will be done later. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="abacf484c3ed4e8d9f00801ecbe4881b"></a><!-- doxytag: member="StringTokenizer::StringTokenizer" ref="abacf484c3ed4e8d9f00801ecbe4881b" args="(const std::string &rStr, char cDelim= ',', char cPrefix= '\0')" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::StringTokenizer </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>cDelim</em> = <code>','</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>cPrefix</em> = <code>'\0'</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Creates a ready-to-use tokenizer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rStr</em> </td><td>string for tokenizing </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cDelim</em> </td><td>delimiter (separator) character </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cPrefix</em> </td><td>character which is prepended if a character must not separate tokens </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="26a59cd69f871ace17ec831e1508b377"></a><!-- doxytag: member="StringTokenizer::~StringTokenizer" ref="26a59cd69f871ace17ec831e1508b377" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::~StringTokenizer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f6f1497f3a3f18ff8c8c664782c4d6e2"></a><!-- doxytag: member="StringTokenizer::HasMoreTokens" ref="f6f1497f3a3f18ff8c8c664782c4d6e2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool StringTokenizer::HasMoreTokens </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether the tokenizer can provide more tokens.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = more tokens available, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="62da00196f41b154dfb4c0969fd13f30"></a><!-- doxytag: member="StringTokenizer::GetNextToken" ref="62da00196f41b154dfb4c0969fd13f30" args="(bool fSkipEmpty=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string StringTokenizer::GetNextToken </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>fSkipEmpty</em> = <code>false</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the next token.
<p>
If a prefix is defined it is stripped from the returned string (e.g. 'abc\ def' is transformed to 'abc def' while the prefix is '\').<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>fSkipEmpty</em> </td><td>skip empty strings (more consecutive delimiters) </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>next token or "" if no more tokens available</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classStringTokenizer.html#4a089402dd2c2e486221f331bf2b77b6" title="Returns the next token.">GetNextTokenRaw()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="4a089402dd2c2e486221f331bf2b77b6"></a><!-- doxytag: member="StringTokenizer::GetNextTokenRaw" ref="4a089402dd2c2e486221f331bf2b77b6" args="(bool fSkipEmpty=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string StringTokenizer::GetNextTokenRaw </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>fSkipEmpty</em> = <code>false</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the next token.
<p>
This method always returns an unmodified string even if it contains prefix characters.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>fSkipEmpty</em> </td><td>skip empty strings (more consecutive delimiters) </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>next token or "" if no more tokens available</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classStringTokenizer.html#62da00196f41b154dfb4c0969fd13f30" title="Returns the next token.">GetNextToken()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8f2379a3dd119a1e00aac7a710ac1e72"></a><!-- doxytag: member="StringTokenizer::GetRemainder" ref="8f2379a3dd119a1e00aac7a710ac1e72" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string StringTokenizer::GetRemainder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the remainder of the source string.
<p>
This method returns everything what has not been processed (tokenized) yet and moves the current position to the end of the string.<p>
If a prefix is defined it is stripped from the returned string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>remainder string </dd></dl>
</div>
</div><p>
<a class="anchor" name="62764b5e11edee9ae256725bcc81b397"></a><!-- doxytag: member="StringTokenizer::SetDelimiter" ref="62764b5e11edee9ae256725bcc81b397" args="(char cDelim)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringTokenizer::SetDelimiter </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>cDelim</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a delimiter (separator) character.
<p>
The new delimiter has effect only to tokens returned later; the position in the string is not affected.<p>
If you specify a NUL character (0x00) here the prefix will not be used.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cDelim</em> </td><td>delimiter character </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2a553eebdd4848f0dcdfd63d3bd70ab3"></a><!-- doxytag: member="StringTokenizer::GetDelimiter" ref="2a553eebdd4848f0dcdfd63d3bd70ab3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char StringTokenizer::GetDelimiter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the delimiter (separator) character.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>delimiter character </dd></dl>
</div>
</div><p>
<a class="anchor" name="b448703764e979812c857a1616411e79"></a><!-- doxytag: member="StringTokenizer::SetPrefix" ref="b448703764e979812c857a1616411e79" args="(char cPrefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringTokenizer::SetPrefix </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>cPrefix</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a prefix character.
<p>
The new prefix has effect only to tokens returned later; the position in the string is not affected.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cPrefix</em> </td><td>prefix character</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classStringTokenizer.html#627a26cfed1b3159802a7f0cb54b40f5" title="Sets the prefix to 'no prefix'.">SetNoPrefix()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="74f70c56d6fac1eb0006b18f5ad82dcb"></a><!-- doxytag: member="StringTokenizer::GetPrefix" ref="74f70c56d6fac1eb0006b18f5ad82dcb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char StringTokenizer::GetPrefix </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the prefix character.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>prefix character </dd></dl>
</div>
</div><p>
<a class="anchor" name="627a26cfed1b3159802a7f0cb54b40f5"></a><!-- doxytag: member="StringTokenizer::SetNoPrefix" ref="627a26cfed1b3159802a7f0cb54b40f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringTokenizer::SetNoPrefix </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the prefix to 'no prefix'.
<p>
Calling this method is equivalent to SetPrefix((char) 0).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classStringTokenizer.html#b448703764e979812c857a1616411e79" title="Sets a prefix character.">SetPrefix()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8084d41ec9c314128c01b6a361e62591"></a><!-- doxytag: member="StringTokenizer::Reset" ref="8084d41ec9c314128c01b6a361e62591" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringTokenizer::Reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resets the tokenizer.
<p>
Re-initializes tokenizing to the start of the string.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="strtok_8h-source.html">strtok.h</a><li><a class="el" href="strtok_8cpp.html">strtok.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 21 22:27:24 2009 for incron by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
