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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
|
<!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: AppArgs 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>AppArgs Class Reference</h1><!-- doxytag: class="AppArgs" -->Application arguments.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="appargs_8h-source.html">appargs.h</a>></code>
<p>
<p>
<a href="classAppArgs-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#5365bfc9a54a0318166cbb003f905dc0">Init</a> (size_t valMinCnt=0, size_t valMaxCnt=APPARGS_NOLIMIT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the processor. <a href="#5365bfc9a54a0318166cbb003f905dc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#42655a3eff85509c7f2ce1fcba0b1f31">Destroy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases resources allocated by the processor. <a href="#42655a3eff85509c7f2ce1fcba0b1f31"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#0f2ab8497fa8c6aaf7b9faf0c75dbcff">Parse</a> (int argc, const char *const *argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses arguments and builds the appropriate structure. <a href="#0f2ab8497fa8c6aaf7b9faf0c75dbcff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#a4a29548cfffac89df731267b79d1d49">IsValid</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the arguments have valid form. <a href="#a4a29548cfffac89df731267b79d1d49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#f3336e77fc109c12def19406787d7126">ExistsOption</a> (const std::string &rArg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether an option exists. <a href="#f3336e77fc109c12def19406787d7126"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#274f64c50b8cbbe3094dde621ef3b11d">GetOption</a> (const std::string &rArg, std::string &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts an option value. <a href="#274f64c50b8cbbe3094dde621ef3b11d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#b19a36ff2e25a416415309b8224bbab1">AddOption</a> (const std::string &rName, char cShort, <a class="el" href="appargs_8h.html#5704dc04528b6c626472cea01c9a7915">AppArgType_t</a> type, bool fMandatory)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an option. <a href="#b19a36ff2e25a416415309b8224bbab1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#4d6e538d8c08bbecc2a3c8dfab75cde7">GetValueCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the count of values. <a href="#4d6e538d8c08bbecc2a3c8dfab75cde7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#050217dd528c4d6c30dc559ba19bbe3d">GetValue</a> (size_t index, std::string &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts a value. <a href="#050217dd528c4d6c30dc559ba19bbe3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#00d5d4d822c8c1bc792313b51eeeec44">Dump</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dumps information about options and value to STDERR. <a href="#00d5d4d822c8c1bc792313b51eeeec44"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#2471f11b0d74e3a427f1d9c02c9d6494">IsOption</a> (const char *pchStr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a string is an option. <a href="#2471f11b0d74e3a427f1d9c02c9d6494"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#7058134b8e90e9ee7ee9c23d98a03708">IsLongOption</a> (const char *pchStr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a string is a long option. <a href="#7058134b8e90e9ee7ee9c23d98a03708"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#1b3384fa201fb04948776c4e79cf633c">ParseLong</a> (const char *pchStr, std::string &rName, std::string &rVal, bool &rfHasVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string and attempts to treat it as a long option. <a href="#1b3384fa201fb04948776c4e79cf633c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#9d503ca65c0025cf6d04a00cb2e8b12e">ParseShort</a> (const char *pchStr, char &rcName, std::string &rVal, bool &rfHasVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string and attempts to treat it as a short option. <a href="#9d503ca65c0025cf6d04a00cb2e8b12e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppArgs.html#ee73398d0548dd1aaeb1eee8c959a3a5">DumpOption</a> (const std::string &rName, char cShort, <a class="el" href="structAppArgOption__t.html">AppArgOption_t</a> *pOpt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dumps an option to STDERR. <a href="#ee73398d0548dd1aaeb1eee8c959a3a5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Application arguments.
<p>
This class is set-up for processing command line arguments. Then it parses these arguments and builds data which can be queried later.<p>
There are two categories of arguments: <ul>
<li>options (a.k.a. switches) </li>
<li>values</li>
</ul>
Options represent changeable parameters of the application. Values are a kind of input data.<p>
Each option has one of the following types: <ul>
<li>no value (two-state logic, e.g. running on foreground/background) </li>
<li>optional value (e.g. for logging: another file than default can be specified) </li>
<li>mandatory value (e.g. custom configuration file)</li>
</ul>
Each option always have two forms - long one (introcuded by two hyphens, e.g. --edit) and short one (introduced by one hyphen, e.g. -e). These forms are functionally equivalent.<p>
Unknown options are silently ignored. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5365bfc9a54a0318166cbb003f905dc0"></a><!-- doxytag: member="AppArgs::Init" ref="5365bfc9a54a0318166cbb003f905dc0" args="(size_t valMinCnt=0, size_t valMaxCnt=APPARGS_NOLIMIT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppArgs::Init </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>valMinCnt</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>valMaxCnt</em> = <code>APPARGS_NOLIMIT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initializes the processor.
<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>valMinCnt</em> </td><td>minimum count of values </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>valMaxCnt</em> </td><td>maximum number of values (no effect if lower than valMinCnt) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="42655a3eff85509c7f2ce1fcba0b1f31"></a><!-- doxytag: member="AppArgs::Destroy" ref="42655a3eff85509c7f2ce1fcba0b1f31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppArgs::Destroy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Releases resources allocated by the processor.
<p>
This method should be called if the argument values are no longer needed.
</div>
</div><p>
<a class="anchor" name="0f2ab8497fa8c6aaf7b9faf0c75dbcff"></a><!-- doxytag: member="AppArgs::Parse" ref="0f2ab8497fa8c6aaf7b9faf0c75dbcff" args="(int argc, const char *const *argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppArgs::Parse </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const * </td>
<td class="paramname"> <em>argv</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses arguments and builds the appropriate structure.
<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>argc</em> </td><td>argument count </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>argv</em> </td><td>argument vector</td></tr>
</table>
</dl>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>All errors are silently ignored. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a4a29548cfffac89df731267b79d1d49"></a><!-- doxytag: member="AppArgs::IsValid" ref="a4a29548cfffac89df731267b79d1d49" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::IsValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether the arguments have valid form.
<p>
Arguments are valid if: <ul>
<li>all mandatory options are present </li>
<li>all options with mandatory values have their values </li>
<li>value count is between its minimum and maximum </li>
<li>there are no unknown options (if unknown options are not accepted)</li>
</ul>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = arguments valid, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="f3336e77fc109c12def19406787d7126"></a><!-- doxytag: member="AppArgs::ExistsOption" ref="f3336e77fc109c12def19406787d7126" args="(const std::string &rArg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::ExistsOption </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rArg</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether an option exists.
<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>rArg</em> </td><td>long option name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = option exists, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="274f64c50b8cbbe3094dde621ef3b11d"></a><!-- doxytag: member="AppArgs::GetOption" ref="274f64c50b8cbbe3094dde621ef3b11d" args="(const std::string &rArg, std::string &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::GetOption </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rArg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extracts an option value.
<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>rArg</em> </td><td>long option name </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>option value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = value extracted, false = option not found or has no value </dd></dl>
</div>
</div><p>
<a class="anchor" name="b19a36ff2e25a416415309b8224bbab1"></a><!-- doxytag: member="AppArgs::AddOption" ref="b19a36ff2e25a416415309b8224bbab1" args="(const std::string &rName, char cShort, AppArgType_t type, bool fMandatory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::AddOption </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>cShort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="appargs_8h.html#5704dc04528b6c626472cea01c9a7915">AppArgType_t</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>fMandatory</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds an option.
<p>
This method is intended to be called between initilization and parsing. It adds an option which may (or must) occur inside the argument vector.<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>rName</em> </td><td>long option name </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cShort</em> </td><td>short (one-character) option name </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>type</em> </td><td>argument type </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>fMandatory</em> </td><td>option is mandatory yes/no </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure (e.g. option already exists) </dd></dl>
</div>
</div><p>
<a class="anchor" name="4d6e538d8c08bbecc2a3c8dfab75cde7"></a><!-- doxytag: member="AppArgs::GetValueCount" ref="4d6e538d8c08bbecc2a3c8dfab75cde7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t AppArgs::GetValueCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the count of values.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>count of values </dd></dl>
</div>
</div><p>
<a class="anchor" name="050217dd528c4d6c30dc559ba19bbe3d"></a><!-- doxytag: member="AppArgs::GetValue" ref="050217dd528c4d6c30dc559ba19bbe3d" args="(size_t index, std::string &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::GetValue </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extracts a value.
<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>index</em> </td><td>value index </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>extracted value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = value extracted, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="00d5d4d822c8c1bc792313b51eeeec44"></a><!-- doxytag: member="AppArgs::Dump" ref="00d5d4d822c8c1bc792313b51eeeec44" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppArgs::Dump </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dumps information about options and value to STDERR.
<p>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>This method may be very slow. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2471f11b0d74e3a427f1d9c02c9d6494"></a><!-- doxytag: member="AppArgs::IsOption" ref="2471f11b0d74e3a427f1d9c02c9d6494" args="(const char *pchStr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::IsOption </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pchStr</em> </td>
<td> ) </td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether a string is an option.
<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>pchStr</em> </td><td>text string </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = option, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="7058134b8e90e9ee7ee9c23d98a03708"></a><!-- doxytag: member="AppArgs::IsLongOption" ref="7058134b8e90e9ee7ee9c23d98a03708" args="(const char *pchStr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::IsLongOption </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pchStr</em> </td>
<td> ) </td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether a string is a long option.
<p>
This methos assumes the string is an option (if not the behavior is undefined).<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>pchStr</em> </td><td>text string </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = option, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="1b3384fa201fb04948776c4e79cf633c"></a><!-- doxytag: member="AppArgs::ParseLong" ref="1b3384fa201fb04948776c4e79cf633c" args="(const char *pchStr, std::string &rName, std::string &rVal, bool &rfHasVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppArgs::ParseLong </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pchStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>rfHasVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string and attempts to treat it as a long option.
<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>pchStr</em> </td><td>text string </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rName</em> </td><td>option name </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>value string </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rfHasVal</em> </td><td>option has value yes/no </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="9d503ca65c0025cf6d04a00cb2e8b12e"></a><!-- doxytag: member="AppArgs::ParseShort" ref="9d503ca65c0025cf6d04a00cb2e8b12e" args="(const char *pchStr, char &rcName, std::string &rVal, bool &rfHasVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppArgs::ParseShort </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pchStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char & </td>
<td class="paramname"> <em>rcName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>rfHasVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string and attempts to treat it as a short option.
<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>pchStr</em> </td><td>text string </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rcName</em> </td><td>option name </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>value string </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rfHasVal</em> </td><td>option has value yes/no</td></tr>
</table>
</dl>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>This method assumes the string is a valid short option. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ee73398d0548dd1aaeb1eee8c959a3a5"></a><!-- doxytag: member="AppArgs::DumpOption" ref="ee73398d0548dd1aaeb1eee8c959a3a5" args="(const std::string &rName, char cShort, AppArgOption_t *pOpt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppArgs::DumpOption </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>cShort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structAppArgOption__t.html">AppArgOption_t</a> * </td>
<td class="paramname"> <em>pOpt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dumps an option to STDERR.
<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>rName</em> </td><td>long option name </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>cShort</em> </td><td>short option name </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pOpt</em> </td><td>option data </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="appargs_8h-source.html">appargs.h</a><li><a class="el" href="appargs_8cpp.html">appargs.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>
|
