docs/CommandLine.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>CommandLine 2.0 Library Manual</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   CommandLine 2.0 Library Manual
  12 </div>
  13
  14 <ol>
  15   <li><a href="#introduction">Introduction</a></li>
  16
  17   <li><a href="#quickstart">Quick Start Guide</a>
  18     <ol>
  19       <li><a href="#bool">Boolean Arguments</a></li>
  20       <li><a href="#alias">Argument Aliases</a></li>
  21       <li><a href="#onealternative">Selecting an alternative from a
  22                                     set of possibilities</a></li>
  23       <li><a href="#namedalternatives">Named alternatives</a></li>
  24       <li><a href="#list">Parsing a list of options</a></li>
  25       <li><a href="#description">Adding freeform text to help output</a></li>
  26     </ol></li>
  27
  28   <li><a href="#referenceguide">Reference Guide</a>
  29     <ol>
  30       <li><a href="#positional">Positional Arguments</a>
  31         <ul>
  32         <li><a href="#--">Specifying positional options with hyphens</a></li>
  33         <li><a href="#getPosition">Determining absolute position with
  34           getPosition</a></li>
  35         <li><a href="#cl::ConsumeAfter">The <tt>cl::ConsumeAfter</tt>
  36              modifier</a></li>
  37         </ul></li>
  38
  39       <li><a href="#storage">Internal vs External Storage</a></li>
  40
  41       <li><a href="#attributes">Option Attributes</a></li>
  42
  43       <li><a href="#modifiers">Option Modifiers</a>
  44         <ul>
  45         <li><a href="#hiding">Hiding an option from <tt>--help</tt>
  46             output</a></li>
  47         <li><a href="#numoccurrences">Controlling the number of occurrences
  48                                      required and allowed</a></li>
  49         <li><a href="#valrequired">Controlling whether or not a value must be
  50                                    specified</a></li>
  51         <li><a href="#formatting">Controlling other formatting options</a></li>
  52         <li><a href="#misc">Miscellaneous option modifiers</a></li>
  53         </ul></li>
  54
  55       <li><a href="#toplevel">Top-Level Classes and Functions</a>
  56         <ul>
  57         <li><a href="#cl::ParseCommandLineOptions">The
  58             <tt>cl::ParseCommandLineOptions</tt> function</a></li>
  59         <li><a href="#cl::ParseEnvironmentOptions">The
  60             <tt>cl::ParseEnvironmentOptions</tt> function</a></li>
  61         <li><a href="#cl::opt">The <tt>cl::opt</tt> class</a></li>
  62         <li><a href="#cl::list">The <tt>cl::list</tt> class</a></li>
  63         <li><a href="#cl::alias">The <tt>cl::alias</tt> class</a></li>
  64         </ul></li>
  65
  66       <li><a href="#builtinparsers">Builtin parsers</a>
  67         <ul>
  68         <li><a href="#genericparser">The Generic <tt>parser&lt;t&gt;</tt>
  69             parser</a></li>
  70         <li><a href="#boolparser">The <tt>parser&lt;bool&gt;</tt>
  71             specialization</a></li>
  72         <li><a href="#stringparser">The <tt>parser&lt;string&gt;</tt>
  73             specialization</a></li>
  74         <li><a href="#intparser">The <tt>parser&lt;int&gt;</tt>
  75             specialization</a></li>
  76         <li><a href="#doubleparser">The <tt>parser&lt;double&gt;</tt> and
  77             <tt>parser&lt;float&gt;</tt> specializations</a></li>
  78         </ul></li>
  79     </ol></li>
  80   <li><a href="#extensionguide">Extension Guide</a>
  81     <ol>
  82       <li><a href="#customparser">Writing a custom parser</a></li>
  83       <li><a href="#explotingexternal">Exploiting external storage</a></li>
  84       <li><a href="#dynamicopts">Dynamically adding command line
  85           options</a></li>
  86     </ol></li>
  87 </ol>
  88
  89 <div class="doc_author">
  90   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
  91 </div>
  92
  93 <!-- *********************************************************************** -->
  94 <div class="doc_section">
  95   <a name="introduction">Introduction</a>
  96 </div>
  97 <!-- *********************************************************************** -->
  98
  99 <div class="doc_text">
 100
 101 <p>This document describes the CommandLine argument processing library.  It will
 102 show you how to use it, and what it can do.  The CommandLine library uses a
 103 declarative approach to specifying the command line options that your program
 104 takes.  By default, these options declarations implicitly hold the value parsed
 105 for the option declared (of course this <a href="#storage">can be
 106 changed</a>).</p>
 107
 108 <p>Although there are a <b>lot</b> of command line argument parsing libraries
 109 out there in many different languages, none of them fit well with what I needed.
 110 By looking at the features and problems of other libraries, I designed the
 111 CommandLine library to have the following features:</p>
 112
 113 <ol>
 114 <li>Speed: The CommandLine library is very quick and uses little resources.  The
 115 parsing time of the library is directly proportional to the number of arguments
 116 parsed, not the the number of options recognized.  Additionally, command line
 117 argument values are captured transparently into user defined global variables,
 118 which can be accessed like any other variable (and with the same
 119 performance).</li>
 120
 121 <li>Type Safe: As a user of CommandLine, you don't have to worry about
 122 remembering the type of arguments that you want (is it an int?  a string? a
 123 bool? an enum?) and keep casting it around.  Not only does this help prevent
 124 error prone constructs, it also leads to dramatically cleaner source code.</li>
 125
 126 <li>No subclasses required: To use CommandLine, you instantiate variables that
 127 correspond to the arguments that you would like to capture, you don't subclass a
 128 parser.  This means that you don't have to write <b>any</b> boilerplate
 129 code.</li>
 130
 131 <li>Globally accessible: Libraries can specify command line arguments that are
 132 automatically enabled in any tool that links to the library.  This is possible
 133 because the application doesn't have to keep a "list" of arguments to pass to
 134 the parser.  This also makes supporting <a href="#dynamicopts">dynamically
 135 loaded options</a> trivial.</li>
 136
 137 <li>Cleaner: CommandLine supports enum and other types directly, meaning that
 138 there is less error and more security built into the library.  You don't have to
 139 worry about whether your integral command line argument accidentally got
 140 assigned a value that is not valid for your enum type.</li>
 141
 142 <li>Powerful: The CommandLine library supports many different types of
 143 arguments, from simple <a href="#boolparser">boolean flags</a> to <a
 144 href="#cl::opt">scalars arguments</a> (<a href="#stringparser">strings</a>, <a
 145 href="#intparser">integers</a>, <a href="#genericparser">enums</a>, <a
 146 href="#doubleparser">doubles</a>), to <a href="#cl::list">lists of
 147 arguments</a>.  This is possible because CommandLine is...</li>
 148
 149 <li>Extensible: It is very simple to add a new argument type to CommandLine.
 150 Simply specify the parser that you want to use with the command line option when
 151 you declare it.  <a href="#customparser">Custom parsers</a> are no problem.</li>
 152
 153 <li>Labor Saving: The CommandLine library cuts down on the amount of grunt work
 154 that you, the user, have to do.  For example, it automatically provides a
 155 <tt>--help</tt> option that shows the available command line options for your
 156 tool.  Additionally, it does most of the basic correctness checking for
 157 you.</li>
 158
 159 <li>Capable: The CommandLine library can handle lots of different forms of
 160 options often found in real programs.  For example, <a
 161 href="#positional">positional</a> arguments, <tt>ls</tt> style <a
 162 href="#cl::Grouping">grouping</a> options (to allow processing '<tt>ls
 163 -lad</tt>' naturally), <tt>ld</tt> style <a href="#cl::Prefix">prefix</a>
 164 options (to parse '<tt>-lmalloc -L/usr/lib</tt>'), and <a
 165 href="#cl::ConsumeAfter">interpreter style options</a>.</li>
 166
 167 </ol>
 168
 169 <p>This document will hopefully let you jump in and start using CommandLine in
 170 your utility quickly and painlessly.  Additionally it should be a simple
 171 reference manual to figure out how stuff works.  If it is failing in some area
 172 (or you want an extension to the library), nag the author, <a
 173 href="mailto:sabre@nondot.org">Chris Lattner</a>.</p>
 174
 175 </div>
 176
 177 <!-- *********************************************************************** -->
 178 <div class="doc_section">
 179   <a name="quickstart">Quick Start Guide</a>
 180 </div>
 181 <!-- *********************************************************************** -->
 182
 183 <div class="doc_text">
 184
 185 <p>This section of the manual runs through a simple CommandLine'ification of a
 186 basic compiler tool.  This is intended to show you how to jump into using the
 187 CommandLine library in your own program, and show you some of the cool things it
 188 can do.</p>
 189
 190 <p>To start out, you need to include the CommandLine header file into your
 191 program:</p>
 192
 193 <pre>
 194   #include "Support/CommandLine.h"
 195 </pre>
 196
 197 <p>Additionally, you need to add this as the first line of your main
 198 program:</p>
 199
 200 <pre>
 201 int main(int argc, char **argv) {
 202   <a href="#cl::ParseCommandLineOptions">cl::ParseCommandLineOptions</a>(argc, argv);
 203   ...
 204 }
 205 </pre>
 206
 207 <p>... which actually parses the arguments and fills in the variable
 208 declarations.</p>
 209
 210 <p>Now that you are ready to support command line arguments, we need to tell the
 211 system which ones we want, and what type of argument they are.  The CommandLine
 212 library uses a declarative syntax to model command line arguments with the
 213 global variable declarations that capture the parsed values.  This means that
 214 for every command line option that you would like to support, there should be a
 215 global variable declaration to capture the result.  For example, in a compiler,
 216 we would like to support the unix standard '<tt>-o &lt;filename&gt;</tt>' option
 217 to specify where to put the output.  With the CommandLine library, this is
 218 represented like this:</p>
 219
 220 <a name="value_desc_example"></a>
 221 <pre>
 222 <a href="#cl::opt">cl::opt</a>&lt;string&gt; OutputFilename("<i>o</i>", <a href="#cl::desc">cl::desc</a>("<i>Specify output filename</i>"), <a href="#cl::value_desc">cl::value_desc</a>("<i>filename</i>"));
 223 </pre>
 224
 225 <p>This declares a global variable "<tt>OutputFilename</tt>" that is used to
 226 capture the result of the "<tt>o</tt>" argument (first parameter).  We specify
 227 that this is a simple scalar option by using the "<tt><a
 228 href="#cl::opt">cl::opt</a></tt>" template (as opposed to the <a
 229 href="#list">"<tt>cl::list</tt> template</a>), and tell the CommandLine library
 230 that the data type that we are parsing is a string.</p>
 231
 232 <p>The second and third parameters (which are optional) are used to specify what
 233 to output for the "<tt>--help</tt>" option.  In this case, we get a line that
 234 looks like this:</p>
 235
 236 <pre>
 237 USAGE: compiler [options]
 238
 239 OPTIONS:
 240   -help             - display available options (--help-hidden for more)
 241   <b>-o &lt;filename&gt;     - Specify output filename</b>
 242 </pre>
 243
 244 <p>Because we specified that the command line option should parse using the
 245 <tt>string</tt> data type, the variable declared is automatically usable as a
 246 real string in all contexts that a normal C++ string object may be used.  For
 247 example:</p>
 248
 249 <pre>
 250   ...
 251   ofstream Output(OutputFilename.c_str());
 252   if (Out.good()) ...
 253   ...
 254 </pre>
 255
 256 <p>There are many different options that you can use to customize the command
 257 line option handling library, but the above example shows the general interface
 258 to these options.  The options can be specified in any order, and are specified
 259 with helper functions like <a href="#cl::desc"><tt>cl::desc(...)</tt></a>, so
 260 there are no positional dependencies to remember.  The available options are
 261 discussed in detail in the <a href="#referenceguide">Reference Guide</a>.</p>
 262
 263 <p>Continuing the example, we would like to have our compiler take an input
 264 filename as well as an output filename, but we do not want the input filename to
 265 be specified with a hyphen (ie, not <tt>-filename.c</tt>).  To support this
 266 style of argument, the CommandLine library allows for <a
 267 href="#positional">positional</a> arguments to be specified for the program.
 268 These positional arguments are filled with command line parameters that are not
 269 in option form.  We use this feature like this:</p>
 270
 271 <pre>
 272 <a href="#cl::opt">cl::opt</a>&lt;string&gt; InputFilename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"), <a href="#cl::init">cl::init</a>("<i>-</i>"));
 273 </pre>
 274
 275 <p>This declaration indicates that the first positional argument should be
 276 treated as the input filename.  Here we use the <tt><a
 277 href="#cl::init">cl::init</a></tt> option to specify an initial value for the
 278 command line option, which is used if the option is not specified (if you do not
 279 specify a <tt><a href="#cl::init">cl::init</a></tt> modifier for an option, then
 280 the default constructor for the data type is used to initialize the value).
 281 Command line options default to being optional, so if we would like to require
 282 that the user always specify an input filename, we would add the <tt><a
 283 href="#cl::Required">cl::Required</a></tt> flag, and we could eliminate the
 284 <tt><a href="#cl::init">cl::init</a></tt> modifier, like this:</p>
 285
 286 <pre>
 287 <a href="#cl::opt">cl::opt</a>&lt;string&gt; InputFilename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"), <b><a href="#cl::Required">cl::Required</a></b>);
 288 </pre>
 289
 290 <p>Again, the CommandLine library does not require the options to be specified
 291 in any particular order, so the above declaration is equivalent to:</p>
 292
 293 <pre>
 294 <a href="#cl::opt">cl::opt</a>&lt;string&gt; InputFilename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::Required">cl::Required</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"));
 295 </pre>
 296
 297 <p>By simply adding the <tt><a href="#cl::Required">cl::Required</a></tt> flag,
 298 the CommandLine library will automatically issue an error if the argument is not
 299 specified, which shifts all of the command line option verification code out of
 300 your application into the library.  This is just one example of how using flags
 301 can alter the default behaviour of the library, on a per-option basis.  By
 302 adding one of the declarations above, the <tt>--help</tt> option synopsis is now
 303 extended to:</p>
 304
 305 <pre>
 306 USAGE: compiler [options] <b>&lt;input file&gt;</b>
 307
 308 OPTIONS:
 309   -help             - display available options (--help-hidden for more)
 310   -o &lt;filename&gt;     - Specify output filename
 311 </pre>
 312
 313 <p>... indicating that an input filename is expected.</p>
 314
 315 </div>
 316
 317 <!-- ======================================================================= -->
 318 <div class="doc_subsection">
 319   <a name="bool">Boolean Arguments</a>
 320 </div>
 321
 322 <div class="doc_text">
 323
 324 <p>In addition to input and output filenames, we would like the compiler example
 325 to support three boolean flags: "<tt>-f</tt>" to force overwriting of the output
 326 file, "<tt>--quiet</tt>" to enable quiet mode, and "<tt>-q</tt>" for backwards
 327 compatibility with some of our users.  We can support these by declaring options
 328 of boolean type like this:</p>
 329
 330 <pre>
 331 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Overwrite output files</i>"));
 332 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet ("<i>quiet</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"));
 333 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet2("<i>q</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"), <a href="#cl::Hidden">cl::Hidden</a>);
 334 </pre>
 335
 336 <p>This does what you would expect: it declares three boolean variables
 337 ("<tt>Force</tt>", "<tt>Quiet</tt>", and "<tt>Quiet2</tt>") to recognize these
 338 options.  Note that the "<tt>-q</tt>" option is specified with the "<a
 339 href="#cl::Hidden"><tt>cl::Hidden</tt></a>" flag.  This modifier prevents it
 340 from being shown by the standard "<tt>--help</tt>" output (note that it is still
 341 shown in the "<tt>--help-hidden</tt>" output).</p>
 342
 343 <p>The CommandLine library uses a <a href="#builtinparsers">different parser</a>
 344 for different data types.  For example, in the string case, the argument passed
 345 to the option is copied literally into the content of the string variable... we
 346 obviously cannot do that in the boolean case, however, so we must use a smarter
 347 parser.  In the case of the boolean parser, it allows no options (in which case
 348 it assigns the value of true to the variable), or it allows the values
 349 "<tt>true</tt>" or "<tt>false</tt>" to be specified, allowing any of the
 350 following inputs:</p>
 351
 352 <pre>
 353  compiler -f          # No value, 'Force' == true
 354  compiler -f=true     # Value specified, 'Force' == true
 355  compiler -f=TRUE     # Value specified, 'Force' == true
 356  compiler -f=FALSE    # Value specified, 'Force' == false
 357 </pre>
 358
 359 <p>... you get the idea.  The <a href="#boolparser">bool parser</a> just turns
 360 the string values into boolean values, and rejects things like '<tt>compiler
 361 -f=foo</tt>'.  Similarly, the <a href="#doubleparser">float</a>, <a
 362 href="#doubleparser">double</a>, and <a href="#intparser">int</a> parsers work
 363 like you would expect, using the '<tt>strtol</tt>' and '<tt>strtod</tt>' C
 364 library calls to parse the string value into the specified data type.</p>
 365
 366 <p>With the declarations above, "<tt>compiler --help</tt>" emits this:</p>
 367
 368 <pre>
 369 USAGE: compiler [options] &lt;input file&gt;
 370
 371 OPTIONS:
 372   <b>-f     - Overwrite output files</b>
 373   -o     - Override output filename
 374   <b>-quiet - Don't print informational messages</b>
 375   -help  - display available options (--help-hidden for more)
 376 </pre>
 377
 378 <p>and "<tt>opt --help-hidden</tt>" prints this:</p>
 379
 380 <pre>
 381 USAGE: compiler [options] &lt;input file&gt;
 382
 383 OPTIONS:
 384   -f     - Overwrite output files
 385   -o     - Override output filename
 386   <b>-q     - Don't print informational messages</b>
 387   -quiet - Don't print informational messages
 388   -help  - display available options (--help-hidden for more)
 389 </pre>
 390
 391 <p>This brief example has shown you how to use the '<tt><a
 392 href="#cl::opt">cl::opt</a></tt>' class to parse simple scalar command line
 393 arguments.  In addition to simple scalar arguments, the CommandLine library also
 394 provides primitives to support CommandLine option <a href="#alias">aliases</a>,
 395 and <a href="#list">lists</a> of options.</p>
 396
 397 </div>
 398
 399 <!-- ======================================================================= -->
 400 <div class="doc_subsection">
 401   <a name="alias">Argument Aliases</a>
 402 </div>
 403
 404 <div class="doc_text">
 405
 406 <p>So far, the example works well, except for the fact that we need to check the
 407 quiet condition like this now:</p>
 408
 409 <pre>
 410 ...
 411   if (!Quiet &amp;&amp; !Quiet2) printInformationalMessage(...);
 412 ...
 413 </pre>
 414
 415 <p>... which is a real pain!  Instead of defining two values for the same
 416 condition, we can use the "<tt><a href="#cl::alias">cl::alias</a></tt>" class to make the "<tt>-q</tt>"
 417 option an <b>alias</b> for the "<tt>-quiet</tt>" option, instead of providing
 418 a value itself:</p>
 419
 420 <pre>
 421 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Overwrite output files</i>"));
 422 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet ("<i>quiet</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"));
 423 <a href="#cl::alias">cl::alias</a>     QuietA("<i>q</i>", <a href="#cl::desc">cl::desc</a>("<i>Alias for -quiet</i>"), <a href="#cl::aliasopt">cl::aliasopt</a>(Quiet));
 424 </pre>
 425
 426 <p>The third line (which is the only one we modified from above) defines a
 427 "<tt>-q</tt> alias that updates the "<tt>Quiet</tt>" variable (as specified by
 428 the <tt><a href="#cl::aliasopt">cl::aliasopt</a></tt> modifier) whenever it is
 429 specified.  Because aliases do not hold state, the only thing the program has to
 430 query is the <tt>Quiet</tt> variable now.  Another nice feature of aliases is
 431 that they automatically hide themselves from the <tt>-help</tt> output
 432 (although, again, they are still visible in the <tt>--help-hidden
 433 output</tt>).</p>
 434
 435 <p>Now the application code can simply use:</p>
 436
 437 <pre>
 438 ...
 439   if (!Quiet) printInformationalMessage(...);
 440 ...
 441 </pre>
 442
 443 <p>... which is much nicer!  The "<tt><a href="#cl::alias">cl::alias</a></tt>"
 444 can be used to specify an alternative name for any variable type, and has many
 445 uses.</p>
 446
 447 </div>
 448
 449 <!-- ======================================================================= -->
 450 <div class="doc_subsection">
 451   <a name="onealternative">Selecting an alternative from a set of
 452   possibilities</a>
 453 </div>
 454
 455 <div class="doc_text">
 456
 457 <p>So far, we have seen how the CommandLine library handles builtin types like
 458 <tt>std::string</tt>, <tt>bool</tt> and <tt>int</tt>, but how does it handle
 459 things it doesn't know about, like enums or '<tt>int*</tt>'s?</p>
 460
 461 <p>The answer is that it uses a table driven generic parser (unless you specify
 462 your own parser, as described in the <a href="#extensionguide">Extension
 463 Guide</a>).  This parser maps literal strings to whatever type is required, and
 464 requires you to tell it what this mapping should be.</p>
 465
 466 <p>Lets say that we would like to add four optimization levels to our
 467 optimizer, using the standard flags "<tt>-g</tt>", "<tt>-O0</tt>",
 468 "<tt>-O1</tt>", and "<tt>-O2</tt>".  We could easily implement this with boolean
 469 options like above, but there are several problems with this strategy:</p>
 470
 471 <ol>
 472 <li>A user could specify more than one of the options at a time, for example,
 473 "<tt>opt -O3 -O2</tt>".  The CommandLine library would not be able to catch this
 474 erroneous input for us.</li>
 475
 476 <li>We would have to test 4 different variables to see which ones are set.</li>
 477
 478 <li>This doesn't map to the numeric levels that we want... so we cannot easily
 479 see if some level &gt;= "<tt>-O1</tt>" is enabled.</li>
 480
 481 </ol>
 482
 483 <p>To cope with these problems, we can use an enum value, and have the
 484 CommandLine library fill it in with the appropriate level directly, which is
 485 used like this:</p>
 486
 487 <pre>
 488 enum OptLevel {
 489   g, O1, O2, O3
 490 };
 491
 492 <a href="#cl::opt">cl::opt</a>&lt;OptLevel&gt; OptimizationLevel(<a href="#cl::desc">cl::desc</a>("<i>Choose optimization level:</i>"),
 493   <a href="#cl::values">cl::values</a>(
 494     clEnumVal(g , "<i>No optimizations, enable debugging</i>"),
 495     clEnumVal(O1, "<i>Enable trivial optimizations</i>"),
 496     clEnumVal(O2, "<i>Enable default optimizations</i>"),
 497     clEnumVal(O3, "<i>Enable expensive optimizations</i>"),
 498    clEnumValEnd));
 499
 500 ...
 501   if (OptimizationLevel &gt;= O2) doPartialRedundancyElimination(...);
 502 ...
 503 </pre>
 504
 505 <p>This declaration defines a variable "<tt>OptimizationLevel</tt>" of the
 506 "<tt>OptLevel</tt>" enum type.  This variable can be assigned any of the values
 507 that are listed in the declaration (Note that the declaration list must be
 508 terminated with the "<tt>clEnumValEnd</tt>" argument!).  The CommandLine
 509 library enforces
 510 that the user can only specify one of the options, and it ensure that only valid
 511 enum values can be specified.  The "<tt>clEnumVal</tt>" macros ensure that the
 512 command line arguments matched the enum values.  With this option added, our
 513 help output now is:</p>
 514
 515 <pre>
 516 USAGE: compiler [options] &lt;input file&gt;
 517
 518 OPTIONS:
 519   <b>Choose optimization level:
 520     -g          - No optimizations, enable debugging
 521     -O1         - Enable trivial optimizations
 522     -O2         - Enable default optimizations
 523     -O3         - Enable expensive optimizations</b>
 524   -f            - Overwrite output files
 525   -help         - display available options (--help-hidden for more)
 526   -o &lt;filename&gt; - Specify output filename
 527   -quiet        - Don't print informational messages
 528 </pre>
 529
 530 <p>In this case, it is sort of awkward that flag names correspond directly to
 531 enum names, because we probably don't want a enum definition named "<tt>g</tt>"
 532 in our program.  Because of this, we can alternatively write this example like
 533 this:</p>
 534
 535 <pre>
 536 enum OptLevel {
 537   Debug, O1, O2, O3
 538 };
 539
 540 <a href="#cl::opt">cl::opt</a>&lt;OptLevel&gt; OptimizationLevel(<a href="#cl::desc">cl::desc</a>("<i>Choose optimization level:</i>"),
 541   <a href="#cl::values">cl::values</a>(
 542    clEnumValN(Debug, "g", "<i>No optimizations, enable debugging</i>"),
 543     clEnumVal(O1        , "<i>Enable trivial optimizations</i>"),
 544     clEnumVal(O2        , "<i>Enable default optimizations</i>"),
 545     clEnumVal(O3        , "<i>Enable expensive optimizations</i>"),
 546    clEnumValEnd));
 547
 548 ...
 549   if (OptimizationLevel == Debug) outputDebugInfo(...);
 550 ...
 551 </pre>
 552
 553 <p>By using the "<tt>clEnumValN</tt>" macro instead of "<tt>clEnumVal</tt>", we
 554 can directly specify the name that the flag should get.  In general a direct
 555 mapping is nice, but sometimes you can't or don't want to preserve the mapping,
 556 which is when you would use it.</p>
 557
 558 </div>
 559
 560 <!-- ======================================================================= -->
 561 <div class="doc_subsection">
 562   <a name="namedalternatives">Named Alternatives</a>
 563 </div>
 564
 565 <div class="doc_text">
 566
 567 <p>Another useful argument form is a named alternative style.  We shall use this
 568 style in our compiler to specify different debug levels that can be used.
 569 Instead of each debug level being its own switch, we want to support the
 570 following options, of which only one can be specified at a time:
 571 "<tt>--debug-level=none</tt>", "<tt>--debug-level=quick</tt>",
 572 "<tt>--debug-level=detailed</tt>".  To do this, we use the exact same format as
 573 our optimization level flags, but we also specify an option name.  For this
 574 case, the code looks like this:</p>
 575
 576 <pre>
 577 enum DebugLev {
 578   nodebuginfo, quick, detailed
 579 };
 580
 581 // Enable Debug Options to be specified on the command line
 582 <a href="#cl::opt">cl::opt</a>&lt;DebugLev&gt; DebugLevel("<i>debug_level</i>", <a href="#cl::desc">cl::desc</a>("<i>Set the debugging level:</i>"),
 583   <a href="#cl::values">cl::values</a>(
 584     clEnumValN(nodebuginfo, "none", "<i>disable debug information</i>"),
 585      clEnumVal(quick,               "<i>enable quick debug information</i>"),
 586      clEnumVal(detailed,            "<i>enable detailed debug information</i>"),
 587     clEnumValEnd));
 588 </pre>
 589
 590 <p>This definition defines an enumerated command line variable of type "<tt>enum
 591 DebugLev</tt>", which works exactly the same way as before.  The difference here
 592 is just the interface exposed to the user of your program and the help output by
 593 the "<tt>--help</tt>" option:</p>
 594
 595 <pre>
 596 USAGE: compiler [options] &lt;input file&gt;
 597
 598 OPTIONS:
 599   Choose optimization level:
 600     -g          - No optimizations, enable debugging
 601     -O1         - Enable trivial optimizations
 602     -O2         - Enable default optimizations
 603     -O3         - Enable expensive optimizations
 604   <b>-debug_level  - Set the debugging level:
 605     =none       - disable debug information
 606     =quick      - enable quick debug information
 607     =detailed   - enable detailed debug information</b>
 608   -f            - Overwrite output files
 609   -help         - display available options (--help-hidden for more)
 610   -o &lt;filename&gt; - Specify output filename
 611   -quiet        - Don't print informational messages
 612 </pre>
 613
 614 <p>Again, the only structural difference between the debug level declaration and
 615 the optimiation level declaration is that the debug level declaration includes
 616 an option name (<tt>"debug_level"</tt>), which automatically changes how the
 617 library processes the argument.  The CommandLine library supports both forms so
 618 that you can choose the form most appropriate for your application.</p>
 619
 620 </div>
 621
 622 <!-- ======================================================================= -->
 623 <div class="doc_subsection">
 624   <a name="list">Parsing a list of options</a>
 625 </div>
 626
 627 <div class="doc_text">
 628
 629 <p>Now that we have the standard run of the mill argument types out of the way,
 630 lets get a little wild and crazy.  Lets say that we want our optimizer to accept
 631 a <b>list</b> of optimizations to perform, allowing duplicates.  For example, we
 632 might want to run: "<tt>compiler -dce -constprop -inline -dce -strip</tt>".  In
 633 this case, the order of the arguments and the number of appearances is very
 634 important.  This is what the "<tt><a href="#cl::list">cl::list</a></tt>"
 635 template is for.  First, start by defining an enum of the optimizations that you
 636 would like to perform:</p>
 637
 638 <pre>
 639 enum Opts {
 640   // 'inline' is a C++ keyword, so name it 'inlining'
 641   dce, constprop, inlining, strip
 642 };
 643 </pre>
 644
 645 <p>Then define your "<tt><a href="#cl::list">cl::list</a></tt>" variable:</p>
 646
 647 <pre>
 648 <a href="#cl::list">cl::list</a>&lt;Opts&gt; OptimizationList(<a href="#cl::desc">cl::desc</a>("<i>Available Optimizations:</i>"),
 649   <a href="#cl::values">cl::values</a>(
 650     clEnumVal(dce               , "<i>Dead Code Elimination</i>"),
 651     clEnumVal(constprop         , "<i>Constant Propagation</i>"),
 652    clEnumValN(inlining, "<i>inline</i>", "<i>Procedure Integration</i>"),
 653     clEnumVal(strip             , "<i>Strip Symbols</i>"),
 654   clEnumValEnd));
 655 </pre>
 656
 657 <p>This defines a variable that is conceptually of the type
 658 "<tt>std::vector&lt;enum Opts&gt;</tt>".  Thus, you can access it with standard
 659 vector methods:</p>
 660
 661 <pre>
 662   for (unsigned i = 0; i != OptimizationList.size(); ++i)
 663     switch (OptimizationList[i])
 664        ...
 665 </pre>
 666
 667 <p>... to iterate through the list of options specified.</p>
 668
 669 <p>Note that the "<tt><a href="#cl::list">cl::list</a></tt>" template is
 670 completely general and may be used with any data types or other arguments that
 671 you can use with the "<tt><a href="#cl::opt">cl::opt</a></tt>" template.  One
 672 especially useful way to use a list is to capture all of the positional
 673 arguments together if there may be more than one specified.  In the case of a
 674 linker, for example, the linker takes several '<tt>.o</tt>' files, and needs to
 675 capture them into a list.  This is naturally specified as:</p>
 676
 677 <pre>
 678 ...
 679 <a href="#cl::list">cl::list</a>&lt;std::string&gt; InputFilenames(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("&lt;Input files&gt;"), <a href="#cl::OneOrMore">cl::OneOrMore</a>);
 680 ...
 681 </pre>
 682
 683 <p>This variable works just like a "<tt>vector&lt;string&gt;</tt>" object.  As
 684 such, accessing the list is simple, just like above.  In this example, we used
 685 the <tt><a href="#cl::OneOrMore">cl::OneOrMore</a></tt> modifier to inform the
 686 CommandLine library that it is an error if the user does not specify any
 687 <tt>.o</tt> files on our command line.  Again, this just reduces the amount of
 688 checking we have to do.</p>
 689
 690 </div>
 691
 692 <!-- ======================================================================= -->
 693 <div class="doc_subsection">
 694   <a name="description">Adding freeform text to help output</a>
 695 </div>
 696
 697 <div class="doc_text">
 698
 699 <p>As our program grows and becomes more mature, we may decide to put summary
 700 information about what it does into the help output.  The help output is styled
 701 to look similar to a Unix <tt>man</tt> page, providing concise information about
 702 a program.  Unix <tt>man</tt> pages, however often have a description about what
 703 the program does.  To add this to your CommandLine program, simply pass a third
 704 argument to the <a
 705 href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>
 706 call in main.  This additional argument is then printed as the overview
 707 information for your program, allowing you to include any additional information
 708 that you want.  For example:</p>
 709
 710 <pre>
 711 int main(int argc, char **argv) {
 712   <a href="#cl::ParseCommandLineOptions">cl::ParseCommandLineOptions</a>(argc, argv, " CommandLine compiler example\n\n"
 713                               "  This program blah blah blah...\n");
 714   ...
 715 }
 716 </pre>
 717
 718 <p>Would yield the help output:</p>
 719
 720 <pre>
 721 <b>OVERVIEW: CommandLine compiler example
 722
 723   This program blah blah blah...</b>
 724
 725 USAGE: compiler [options] &lt;input file&gt;
 726
 727 OPTIONS:
 728   ...
 729   -help             - display available options (--help-hidden for more)
 730   -o &lt;filename&gt;     - Specify output filename
 731 </pre>
 732
 733 </div>
 734
 735
 736 <!-- *********************************************************************** -->
 737 <div class="doc_section">
 738   <a name="referenceguide">Reference Guide</a>
 739 </div>
 740 <!-- *********************************************************************** -->
 741
 742 <div class="doc_text">
 743
 744 <p>Now that you know the basics of how to use the CommandLine library, this
 745 section will give you the detailed information you need to tune how command line
 746 options work, as well as information on more "advanced" command line option
 747 processing capabilities.</p>
 748
 749 </div>
 750
 751 <!-- ======================================================================= -->
 752 <div class="doc_subsection">
 753   <a name="positional">Positional Arguments</a>
 754 </div>
 755
 756 <div class="doc_text">
 757
 758 <p>Positional arguments are those arguments that are not named, and are not
 759 specified with a hyphen.  Positional arguments should be used when an option is
 760 specified by its position alone.  For example, the standard Unix <tt>grep</tt>
 761 tool takes a regular expression argument, and an optional filename to search
 762 through (which defaults to standard input if a filename is not specified).
 763 Using the CommandLine library, this would be specified as:</p>
 764
 765 <pre>
 766 <a href="#cl::opt">cl::opt</a>&lt;string&gt; Regex   (<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;regular expression&gt;</i>"), <a href="#cl::Required">cl::Required</a>);
 767 <a href="#cl::opt">cl::opt</a>&lt;string&gt; Filename(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input file&gt;</i>"), <a href="#cl::init">cl::init</a>("<i>-</i>"));
 768 </pre>
 769
 770 <p>Given these two option declarations, the <tt>--help</tt> output for our grep
 771 replacement would look like this:</p>
 772
 773 <pre>
 774 USAGE: spiffygrep [options] <b>&lt;regular expression&gt; &lt;input file&gt;</b>
 775
 776 OPTIONS:
 777   -help - display available options (--help-hidden for more)
 778 </pre>
 779
 780 <p>... and the resultant program could be used just like the standard
 781 <tt>grep</tt> tool.</p>
 782
 783 <p>Positional arguments are sorted by their order of construction.  This means
 784 that command line options will be ordered according to how they are listed in a
 785 .cpp file, but will not have an ordering defined if the positional arguments
 786 are defined in multiple .cpp files.  The fix for this problem is simply to
 787 define all of your positional arguments in one .cpp file.</p>
 788
 789 </div>
 790
 791
 792 <!-- _______________________________________________________________________ -->
 793 <div class="doc_subsubsection">
 794   <a name="--">Specifying positional options with hyphens</a>
 795 </div>
 796
 797 <div class="doc_text">
 798
 799 <p>Sometimes you may want to specify a value to your positional argument that
 800 starts with a hyphen (for example, searching for '<tt>-foo</tt>' in a file).  At
 801 first, you will have trouble doing this, because it will try to find an argument
 802 named '<tt>-foo</tt>', and will fail (and single quotes will not save you).
 803 Note that the system <tt>grep</tt> has the same problem:</p>
 804
 805 <pre>
 806   $ spiffygrep '-foo' test.txt
 807   Unknown command line argument '-foo'.  Try: spiffygrep --help'
 808
 809   $ grep '-foo' test.txt
 810   grep: illegal option -- f
 811   grep: illegal option -- o
 812   grep: illegal option -- o
 813   Usage: grep -hblcnsviw pattern file . . .
 814 </pre>
 815
 816 <p>The solution for this problem is the same for both your tool and the system
 817 version: use the '<tt>--</tt>' marker.  When the user specifies '<tt>--</tt>' on
 818 the command line, it is telling the program that all options after the
 819 '<tt>--</tt>' should be treated as positional arguments, not options.  Thus, we
 820 can use it like this:</p>
 821
 822 <pre>
 823   $ spiffygrep -- -foo test.txt
 824     ...output...
 825 </pre>
 826
 827 </div>
 828
 829 <!-- _______________________________________________________________________ -->
 830 <div class="doc_subsubsection">
 831   <a name="getPosition">Determining absolute position with getPosition()</a>
 832 </div>
 833 <div class="doc_text">
 834   <p>Sometimes an option can affect or modify the meaning of another option. For
 835   example, consider <tt>gcc</tt>'s <tt>-x LANG</tt> option. This tells
 836   <tt>gcc</tt> to ignore the suffix of subsequent positional arguments and force
 837   the file to be interpreted as if it contained source code in language
 838   <tt>LANG</tt>. In order to handle this properly , you need to know the
 839   absolute position of each argument, especially those in lists, so their
 840   interaction(s) can be applied correctly. This is also useful for options like
 841   <tt>-llibname</tt> which is actually a positional argument that starts with
 842   a dash.</p>
 843   <p>So, generally, the problem is that you have two <tt>cl::list</tt> variables
 844   that interact in some way. To ensure the correct interaction, you can use the
 845   <tt>cl::list::getPosition(optnum)</tt> method. This method returns the
 846   absolute position (as found on the command line) of the <tt>optnum</tt>
 847   item in the <tt>cl::list</tt>.</p>
 848   <p>The idiom for usage is like this:<pre><tt>
 849   static cl::list&lt;std::string&gt; Files(cl::Positional, cl::OneOrMore);
 850   static cl::listlt;std::string&gt; Libraries("l", cl::ZeroOrMore);
 851
 852   int main(int argc, char**argv) {
 853     // ...
 854     std::vector&lt;std::string&gt;::iterator fileIt = Files.begin();
 855     std::vector&lt;std::string&gt;::iterator libIt  = Libraries.begin();
 856     unsigned libPos = 0, filePos = 0;
 857     while ( 1 ) {
 858       if ( libIt != Libraries.end() )
 859         libPos = Libraries.getPosition( libIt - Libraries.begin() );
 860       else
 861         libPos = 0;
 862       if ( fileIt != Files.end() )
 863         filePos = Files.getPosition( fileIt - Files.begin() );
 864       else
 865         filePos = 0;
 866
 867       if ( filePos != 0 &amp;&amp; (libPos == 0 || filePos &lt; libPos) ) {
 868         // Source File Is next
 869         ++fileIt;
 870       }
 871       else if ( libPos != 0 &amp;&amp; (filePos == 0 || libPos &lt; filePos) ) {
 872         // Library is next
 873         ++libIt;
 874       }
 875       else
 876         break; // we're done with the list
 877     }
 878   }</tt></pre></p>
 879   <p>Note that, for compatibility reasons, the <tt>cl::opt</tt> also supports an
 880   <tt>unsigned getPosition()</tt> option that will provide the absolute position
 881   of that option. You can apply the same approach as above with a
 882   <tt>cl::opt</tt> and a <tt>cl::list</tt> option as you can with two lists.</p>
 883 </div>
 884
 885 <!-- _______________________________________________________________________ -->
 886 <div class="doc_subsubsection">
 887   <a name="cl::ConsumeAfter">The <tt>cl::ConsumeAfter</tt> modifier</a>
 888 </div>
 889
 890 <div class="doc_text">
 891
 892 <p>The <tt>cl::ConsumeAfter</tt> <a href="#formatting">formatting option</a> is
 893 used to construct programs that use "interpreter style" option processing.  With
 894 this style of option processing, all arguments specified after the last
 895 positional argument are treated as special interpreter arguments that are not
 896 interpreted by the command line argument.</p>
 897
 898 <p>As a concrete example, lets say we are developing a replacement for the
 899 standard Unix Bourne shell (<tt>/bin/sh</tt>).  To run <tt>/bin/sh</tt>, first
 900 you specify options to the shell itself (like <tt>-x</tt> which turns on trace
 901 output), then you specify the name of the script to run, then you specify
 902 arguments to the script.  These arguments to the script are parsed by the bourne
 903 shell command line option processor, but are not interpreted as options to the
 904 shell itself.  Using the CommandLine library, we would specify this as:</p>
 905
 906 <pre>
 907 <a href="#cl::opt">cl::opt</a>&lt;string&gt; Script(<a href="#cl::Positional">cl::Positional</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;input script&gt;</i>"), <a href="#cl::init">cl::init</a>("-"));
 908 <a href="#cl::list">cl::list</a>&lt;string&gt;  Argv(<a href="#cl::ConsumeAfter">cl::ConsumeAfter</a>, <a href="#cl::desc">cl::desc</a>("<i>&lt;program arguments&gt;...</i>"));
 909 <a href="#cl::opt">cl::opt</a>&lt;bool&gt;    Trace("<i>x</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable trace output</i>"));
 910 </pre>
 911
 912 <p>which automatically provides the help output:</p>
 913
 914 <pre>
 915 USAGE: spiffysh [options] <b>&lt;input script&gt; &lt;program arguments&gt;...</b>
 916
 917 OPTIONS:
 918   -help - display available options (--help-hidden for more)
 919   <b>-x    - Enable trace output</b>
 920 </pre>
 921
 922 <p>At runtime, if we run our new shell replacement as '<tt>spiffysh -x test.sh
 923 -a -x -y bar</tt>', the <tt>Trace</tt> variable will be set to true, the
 924 <tt>Script</tt> variable will be set to "<tt>test.sh</tt>", and the
 925 <tt>Argv</tt> list will contain <tt>["-a", "-x", "-y", "bar"]</tt>, because they
 926 were specified after the last positional argument (which is the script
 927 name).</p>
 928
 929 <p>There are several limitations to when <tt>cl::ConsumeAfter</tt> options can
 930 be specified.  For example, only one <tt>cl::ConsumeAfter</tt> can be specified
 931 per program, there must be at least one <a href="#positional">positional
 932 argument</a> specified, there must not be any <a href="#cl::list">cl::list</a>
 933 positional arguments, and the <tt>cl::ConsumeAfter</tt> option should be a <a
 934 href="#cl::list">cl::list</a> option.</p>
 935
 936 </div>
 937
 938 <!-- ======================================================================= -->
 939 <div class="doc_subsection">
 940   <a name="storage">Internal vs External Storage</a>
 941 </div>
 942
 943 <div class="doc_text">
 944
 945 <p>By default, all command line options automatically hold the value that they
 946 parse from the command line.  This is very convenient in the common case,
 947 especially when combined with the ability to define command line options in the
 948 files that use them.  This is called the internal storage model.</p>
 949
 950 <p>Sometimes, however, it is nice to separate the command line option processing
 951 code from the storage of the value parsed.  For example, lets say that we have a
 952 '<tt>-debug</tt>' option that we would like to use to enable debug information
 953 across the entire body of our program.  In this case, the boolean value
 954 controlling the debug code should be globally accessable (in a header file, for
 955 example) yet the command line option processing code should not be exposed to
 956 all of these clients (requiring lots of .cpp files to #include
 957 <tt>CommandLine.h</tt>).</p>
 958
 959 <p>To do this, set up your .h file with your option, like this for example:</p>
 960
 961 <pre>
 962 <i>// DebugFlag.h - Get access to the '-debug' command line option
 963 //
 964
 965 // DebugFlag - This boolean is set to true if the '-debug' command line option
 966 // is specified.  This should probably not be referenced directly, instead, use
 967 // the DEBUG macro below.
 968 //</i>
 969 extern bool DebugFlag;
 970
 971 <i>// DEBUG macro - This macro should be used by code to emit debug information.
 972 // In the '-debug' option is specified on the command line, and if this is a
 973 // debug build, then the code specified as the option to the macro will be
 974 // executed.  Otherwise it will not be.  Example:
 975 //
 976 // DEBUG(cerr << "Bitset contains: " << Bitset << "\n");
 977 //</i>
 978 <span class="doc_red">#ifdef NDEBUG
 979 #define DEBUG(X)
 980 #else
 981 #define DEBUG(X)</span> \
 982   do { if (DebugFlag) { X; } } while (0)
 983 <span class="doc_red">#endif</span>
 984 </pre>
 985
 986 <p>This allows clients to blissfully use the <tt>DEBUG()</tt> macro, or the
 987 <tt>DebugFlag</tt> explicitly if they want to.  Now we just need to be able to
 988 set the <tt>DebugFlag</tt> boolean when the option is set.  To do this, we pass
 989 an additial argument to our command line argument processor, and we specify
 990 where to fill in with the <a href="#cl::location">cl::location</a>
 991 attribute:</p>
 992
 993 <pre>
 994 bool DebugFlag;      <i>// the actual value</i>
 995 static <a href="#cl::opt">cl::opt</a>&lt;bool, true&gt;       <i>// The parser</i>
 996 Debug("<i>debug</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable debug output</i>"), <a href="#cl::Hidden">cl::Hidden</a>,
 997       <a href="#cl::location">cl::location</a>(DebugFlag));
 998 </pre>
 999
1000 <p>In the above example, we specify "<tt>true</tt>" as the second argument to
1001 the <a href="#cl::opt">cl::opt</a> template, indicating that the template should
1002 not maintain a copy of the value itself.  In addition to this, we specify the <a
1003 href="#cl::location">cl::location</a> attribute, so that <tt>DebugFlag</tt> is
1004 automatically set.</p>
1005
1006 </div>
1007
1008 <!-- ======================================================================= -->
1009 <div class="doc_subsection">
1010   <a name="attributes">Option Attributes</a>
1011 </div>
1012
1013 <div class="doc_text">
1014
1015 <p>This section describes the basic attributes that you can specify on
1016 options.</p>
1017
1018 <ul>
1019
1020 <li>The option name attribute (which is required for all options, except <a
1021 href="#positional">positional options</a>) specifies what the option name is.
1022 This option is specified in simple double quotes:
1023
1024 <pre>
1025 <a href="#cl::opt">cl::opt</a>&lt;<b>bool</b>&gt; Quiet("<i>quiet</i>");
1026 </pre>
1027
1028 </li>
1029
1030 <li><a name="cl::desc">The <b><tt>cl::desc</tt></b></a> attribute specifies a
1031 description for the option to be shown in the <tt>--help</tt> output for the
1032 program.</li>
1033
1034 <li><a name="cl::value_desc">The <b><tt>cl::value_desc</tt></b></a> attribute
1035 specifies a string that can be used to fine tune the <tt>--help</tt> output for
1036 a command line option.  Look <a href="#value_desc_example">here</a> for an
1037 example.</li>
1038
1039 <li><a name="cl::init">The <b><tt>cl::init</tt></b></a> attribute specifies an
1040 inital value for a <a href="#cl::opt">scalar</a> option.  If this attribute is
1041 not specified then the command line option value defaults to the value created
1042 by the default constructor for the type. <b>Warning</b>: If you specify both
1043 <b><tt>cl::init</tt></b> and <b><tt>cl::location</tt></b> for an option,
1044 you must specify <b><tt>cl::location</tt></b> first, so that when the
1045 command-line parser sees <b><tt>cl::init</tt></b>, it knows where to put the
1046 initial value. (You will get an error at runtime if you don't put them in
1047 the right order.)</li>
1048
1049 <li><a name="cl::location">The <b><tt>cl::location</tt></b></a> attribute where to
1050 store the value for a parsed command line option if using external storage.  See
1051 the section on <a href="#storage">Internal vs External Storage</a> for more
1052 information.</li>
1053
1054 <li><a name="cl::aliasopt">The <b><tt>cl::aliasopt</tt></b></a> attribute
1055 specifies which option a <a href="#cl::alias">cl::alias</a> option is an alias
1056 for.</li>
1057
1058 <li><a name="cl::values">The <b><tt>cl::values</tt></b></a> attribute specifies
1059 the string-to-value mapping to be used by the generic parser.  It takes a
1060 <b>clEnumValEnd terminated</b> list of (option, value, description) triplets
1061 that
1062 specify the option name, the value mapped to, and the description shown in the
1063 <tt>--help</tt> for the tool.  Because the generic parser is used most
1064 frequently with enum values, two macros are often useful:
1065
1066 <ol>
1067
1068 <li><a name="clEnumVal">The <b><tt>clEnumVal</tt></b></a> macro is used as a
1069 nice simple way to specify a triplet for an enum.  This macro automatically
1070 makes the option name be the same as the enum name.  The first option to the
1071 macro is the enum, the second is the description for the command line
1072 option.</li>
1073
1074 <li><a name="clEnumValN">The <b><tt>clEnumValN</tt></b></a> macro is used to
1075 specify macro options where the option name doesn't equal the enum name.  For
1076 this macro, the first argument is the enum value, the second is the flag name,
1077 and the second is the description.</li>
1078
1079 </ol>
1080
1081 You will get a compile time error if you try to use cl::values with a parser
1082 that does not support it.</li>
1083
1084 </ul>
1085
1086 </div>
1087
1088 <!-- ======================================================================= -->
1089 <div class="doc_subsection">
1090   <a name="modifiers">Option Modifiers</a>
1091 </div>
1092
1093 <div class="doc_text">
1094
1095 <p>Option modifiers are the flags and expressions that you pass into the
1096 constructors for <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
1097 href="#cl::list">cl::list</a></tt>.  These modifiers give you the ability to
1098 tweak how options are parsed and how <tt>--help</tt> output is generated to fit
1099 your application well.</p>
1100
1101 <p>These options fall into five main catagories:</p>
1102
1103 <ol>
1104 <li><a href="#hiding">Hiding an option from <tt>--help</tt> output</a></li>
1105 <li><a href="#numoccurrences">Controlling the number of occurrences
1106                              required and allowed</a></li>
1107 <li><a href="#valrequired">Controlling whether or not a value must be
1108                            specified</a></li>
1109 <li><a href="#formatting">Controlling other formatting options</a></li>
1110 <li><a href="#misc">Miscellaneous option modifiers</a></li>
1111 </ol>
1112
1113 <p>It is not possible to specify two options from the same catagory (you'll get
1114 a runtime error) to a single option, except for options in the miscellaneous
1115 catagory.  The CommandLine library specifies defaults for all of these settings
1116 that are the most useful in practice and the most common, which mean that you
1117 usually shouldn't have to worry about these.</p>
1118
1119 </div>
1120
1121 <!-- _______________________________________________________________________ -->
1122 <div class="doc_subsubsection">
1123   <a name="hiding">Hiding an option from <tt>--help</tt> output</a>
1124 </div>
1125
1126 <div class="doc_text">
1127
1128 <p>The <tt>cl::NotHidden</tt>, <tt>cl::Hidden</tt>, and
1129 <tt>cl::ReallyHidden</tt> modifiers are used to control whether or not an option
1130 appears in the <tt>--help</tt> and <tt>--help-hidden</tt> output for the
1131 compiled program:</p>
1132
1133 <ul>
1134
1135 <li><a name="cl::NotHidden">The <b><tt>cl::NotHidden</tt></b></a> modifier
1136 (which is the default for <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
1137 href="#cl::list">cl::list</a></tt> options), indicates the option is to appear
1138 in both help listings.</li>
1139
1140 <li><a name="cl::Hidden">The <b><tt>cl::Hidden</tt></b></a> modifier (which is the
1141 default for <tt><a href="#cl::alias">cl::alias</a></tt> options), indicates that
1142 the option should not appear in the <tt>--help</tt> output, but should appear in
1143 the <tt>--help-hidden</tt> output.</li>
1144
1145 <li><a name="cl::ReallyHidden">The <b><tt>cl::ReallyHidden</tt></b></a> modifier,
1146 indicates that the option should not appear in any help output.</li>
1147
1148 </ul>
1149
1150 </div>
1151
1152 <!-- _______________________________________________________________________ -->
1153 <div class="doc_subsubsection">
1154   <a name="numoccurrences">Controlling the number of occurrences required and
1155   allowed</a>
1156 </div>
1157
1158 <div class="doc_text">
1159
1160 <p>This group of options is used to control how many time an option is allowed
1161 (or required) to be specified on the command line of your program.  Specifying a
1162 value for this setting allows the CommandLine library to do error checking for
1163 you.</p>
1164
1165 <p>The allowed values for this option group are:</p>
1166
1167 <ul>
1168
1169 <li><a name="cl::Optional">The <b><tt>cl::Optional</tt></b></a> modifier (which
1170 is the default for the <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a
1171 href="#cl::alias">cl::alias</a></tt> classes) indicates that your program will
1172 allow either zero or one occurrence of the option to be specified.</li>
1173
1174 <li><a name="cl::ZeroOrMore">The <b><tt>cl::ZeroOrMore</tt></b></a> modifier
1175 (which is the default for the <tt><a href="#cl::list">cl::list</a></tt> class)
1176 indicates that your program will allow the option to be specified zero or more
1177 times.</li>
1178
1179 <li><a name="cl::Required">The <b><tt>cl::Required</tt></b></a> modifier
1180 indicates that the specified option must be specified exactly one time.</li>
1181
1182 <li><a name="cl::OneOrMore">The <b><tt>cl::OneOrMore</tt></b></a> modifier
1183 indicates that the option must be specified at least one time.</li>
1184
1185 <li>The <b><tt>cl::ConsumeAfter</tt></b> modifier is described in the <a
1186 href="#positional">Positional arguments section</a></li>
1187
1188 </ul>
1189
1190 <p>If an option is not specified, then the value of the option is equal to the
1191 value specified by the <tt><a href="#cl::init">cl::init</a></tt> attribute.  If
1192 the <tt><a href="#cl::init">cl::init</a></tt> attribute is not specified, the
1193 option value is initialized with the default constructor for the data type.</p>
1194
1195 <p>If an option is specified multiple times for an option of the <tt><a
1196 href="#cl::opt">cl::opt</a></tt> class, only the last value will be
1197 retained.</p>
1198
1199 </div>
1200
1201 <!-- _______________________________________________________________________ -->
1202 <div class="doc_subsubsection">
1203   <a name="valrequired">Controlling whether or not a value must be specified</a>
1204 </div>
1205
1206 <div class="doc_text">
1207
1208 <p>This group of options is used to control whether or not the option allows a
1209 value to be present.  In the case of the CommandLine library, a value is either
1210 specified with an equal sign (e.g. '<tt>-index-depth=17</tt>') or as a trailing
1211 string (e.g. '<tt>-o a.out</tt>').</p>
1212
1213 <p>The allowed values for this option group are:</p>
1214
1215 <ul>
1216
1217 <li><a name="cl::ValueOptional">The <b><tt>cl::ValueOptional</tt></b></a> modifier
1218 (which is the default for <tt>bool</tt> typed options) specifies that it is
1219 acceptable to have a value, or not.  A boolean argument can be enabled just by
1220 appearing on the command line, or it can have an explicit '<tt>-foo=true</tt>'.
1221 If an option is specified with this mode, it is illegal for the value to be
1222 provided without the equal sign.  Therefore '<tt>-foo true</tt>' is illegal.  To
1223 get this behavior, you must use the <a
1224 href="#cl::ValueRequired">cl::ValueRequired</a> modifier.</li>
1225
1226 <li><a name="cl::ValueRequired">The <b><tt>cl::ValueRequired</tt></b></a> modifier
1227 (which is the default for all other types except for <a
1228 href="#onealternative">unnamed alternatives using the generic parser</a>)
1229 specifies that a value must be provided.  This mode informs the command line
1230 library that if an option is not provides with an equal sign, that the next
1231 argument provided must be the value.  This allows things like '<tt>-o
1232 a.out</tt>' to work.</li>
1233
1234 <li><a name="cl::ValueDisallowed">The <b><tt>cl::ValueDisallowed</tt></b></a>
1235 modifier (which is the default for <a href="#onealternative">unnamed
1236 alternatives using the generic parser</a>) indicates that it is a runtime error
1237 for the user to specify a value.  This can be provided to disallow users from
1238 providing options to boolean options (like '<tt>-foo=true</tt>').</li>
1239
1240 </ul>
1241
1242 <p>In general, the default values for this option group work just like you would
1243 want them to.  As mentioned above, you can specify the <a
1244 href="#cl::ValueDisallowed">cl::ValueDisallowed</a> modifier to a boolean
1245 argument to restrict your command line parser.  These options are mostly useful
1246 when <a href="#extensionguide">extending the library</a>.</p>
1247
1248 </div>
1249
1250 <!-- _______________________________________________________________________ -->
1251 <div class="doc_subsubsection">
1252   <a name="formatting">Controlling other formatting options</a>
1253 </div>
1254
1255 <div class="doc_text">
1256
1257 <p>The formatting option group is used to specify that the command line option
1258 has special abilities and is otherwise different from other command line
1259 arguments.  As usual, you can only specify at most one of these arguments.</p>
1260
1261 <ul>
1262
1263 <li><a name="cl::NormalFormatting">The <b><tt>cl::NormalFormatting</tt></b></a>
1264 modifier (which is the default all options) specifies that this option is
1265 "normal".</li>
1266
1267 <li><a name="cl::Positional">The <b><tt>cl::Positional</tt></b></a> modifier
1268 specifies that this is a positional argument, that does not have a command line
1269 option associated with it.  See the <a href="#positional">Positional
1270 Arguments</a> section for more information.</li>
1271
1272 <li>The <b><a href="#cl::ConsumeAfter"><tt>cl::ConsumeAfter</tt></a></b> modifier
1273 specifies that this option is used to capture "interpreter style" arguments.  See <a href="#cl::ConsumeAfter">this section for more information</a>.</li>
1274
1275 <li><a name="cl::Prefix">The <b><tt>cl::Prefix</tt></b></a> modifier specifies
1276 that this option prefixes its value.  With 'Prefix' options, there is no equal
1277 sign that separates the value from the option name specified.  This is useful
1278 for processing odd arguments like '<tt>-lmalloc -L/usr/lib'</tt> in a linker
1279 tool.  Here, the '<tt>l</tt>' and '<tt>L</tt>' options are normal string (list)
1280 options, that have the <a href="#cl::Prefix">cl::Prefix</a> modifier added to
1281 allow the CommandLine library to recognize them.  Note that <a
1282 href="#cl::Prefix">cl::Prefix</a> options must not have the <a
1283 href="#cl::ValueDisallowed">cl::ValueDisallowed</a> modifier specified.</li>
1284
1285 <li><a name="cl::Grouping">The <b><tt>cl::Grouping</tt></b></a> modifier is used
1286 to implement unix style tools (like <tt>ls</tt>) that have lots of single letter
1287 arguments, but only require a single dash.  For example, the '<tt>ls -labF</tt>'
1288 command actually enables four different options, all of which are single
1289 letters.  Note that <a href="#cl::Grouping">cl::Grouping</a> options cannot have
1290 values.</li>
1291
1292 </ul>
1293
1294 <p>The CommandLine library does not restrict how you use the <a
1295 href="#cl::Prefix">cl::Prefix</a> or <a href="#cl::Grouping">cl::Grouping</a>
1296 modifiers, but it is possible to specify ambiguous argument settings.  Thus, it
1297 is possible to have multiple letter options that are prefix or grouping options,
1298 and they will still work as designed.</p>
1299
1300 <p>To do this, the CommandLine library uses a greedy algorithm to parse the
1301 input option into (potentially multiple) prefix and grouping options.  The
1302 strategy basically looks like this:</p>
1303
1304 <p><tt>parse(string OrigInput) {</tt>
1305
1306 <ol>
1307 <li><tt>string input = OrigInput;</tt>
1308 <li><tt>if (isOption(input)) return getOption(input).parse();</tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>// Normal option</i>
1309 <li><tt>while (!isOption(input) &amp;&amp; !input.empty()) input.pop_back();</tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>// Remove the last letter</i>
1310 <li><tt>if (input.empty()) return error();</tt>&nbsp;&nbsp;&nbsp;&nbsp;<i>// No matching option</i>
1311 <li><tt>if (getOption(input).isPrefix())<br>
1312 &nbsp;&nbsp;return getOption(input).parse(input);</tt>
1313 <li><tt>while (!input.empty()) {&nbsp;&nbsp;&nbsp;&nbsp;<i>// Must be grouping options</i><br>
1314 &nbsp;&nbsp;getOption(input).parse();<br>
1315 &nbsp;&nbsp;OrigInput.erase(OrigInput.begin(), OrigInput.begin()+input.length());<br>
1316 &nbsp;&nbsp;input = OrigInput;<br>
1317 &nbsp;&nbsp;while (!isOption(input) &amp;&amp; !input.empty()) input.pop_back();<br>
1318 }</tt>
1319 <li><tt>if (!OrigInput.empty()) error();</tt></li>
1320
1321 </ol>
1322
1323 <p><tt>}</tt></p>
1324
1325 </div>
1326
1327 <!-- _______________________________________________________________________ -->
1328 <div class="doc_subsubsection">
1329   <a name="misc">Miscellaneous option modifiers</a>
1330 </div>
1331
1332 <div class="doc_text">
1333
1334 <p>The miscellaneous option modifiers are the only flags where you can specify
1335 more than one flag from the set: they are not mutually exclusive.  These flags
1336 specify boolean properties that modify the option.</p>
1337
1338 <ul>
1339
1340 <li><a name="cl::CommaSeparated">The <b><tt>cl::CommaSeparated</tt></b></a> modifier
1341 indicates that any commas specified for an option's value should be used to
1342 split the value up into multiple values for the option.  For example, these two
1343 options are equivalent when <tt>cl::CommaSeparated</tt> is specified:
1344 "<tt>-foo=a -foo=b -foo=c</tt>" and "<tt>-foo=a,b,c</tt>".  This option only
1345 makes sense to be used in a case where the option is allowed to accept one or
1346 more values (i.e. it is a <a href="#cl::list">cl::list</a> option).</li>
1347
1348 <li><a name="cl::PositionalEatsArgs">The
1349 <b><tt>cl::PositionalEatsArgs</tt></b></a> modifier (which only applies to
1350 positional arguments, and only makes sense for lists) indicates that positional
1351 argument should consume any strings after it (including strings that start with
1352 a "-") up until another recognized positional argument.  For example, if you
1353 have two "eating" positional arguments "<tt>pos1</tt>" and "<tt>pos2</tt>" the
1354 string "<tt>-pos1 -foo -bar baz -pos2 -bork</tt>" would cause the "<tt>-foo -bar
1355 -baz</tt>" strings to be applied to the "<tt>-pos1</tt>" option and the
1356 "<tt>-bork</tt>" string to be applied to the "<tt>-pos2</tt>" option.</li>
1357
1358 </ul>
1359
1360 <p>So far, these are the only two miscellaneous option modifiers.</p>
1361
1362 </div>
1363
1364 <!-- ======================================================================= -->
1365 <div class="doc_subsection">
1366   <a name="toplevel">Top-Level Classes and Functions</a>
1367 </div>
1368
1369 <div class="doc_text">
1370
1371 <p>Despite all of the built-in flexibility, the CommandLine option library
1372 really only consists of one function (<a
1373 href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>)
1374 and three main classes: <a href="#cl::opt"><tt>cl::opt</tt></a>, <a
1375 href="#cl::list"><tt>cl::list</tt></a>, and <a
1376 href="#cl::alias"><tt>cl::alias</tt></a>.  This section describes these three
1377 classes in detail.</p>
1378
1379 </div>
1380
1381 <!-- _______________________________________________________________________ -->
1382 <div class="doc_subsubsection">
1383   <a name="cl::ParseCommandLineOptions">The <tt>cl::ParseCommandLineOptions</tt>
1384   function</a>
1385 </div>
1386
1387 <div class="doc_text">
1388
1389 <p>The <tt>cl::ParseCommandLineOptions</tt> function is designed to be called
1390 directly from <tt>main</tt>, and is used to fill in the values of all of the
1391 command line option variables once <tt>argc</tt> and <tt>argv</tt> are
1392 available.</p>
1393
1394 <p>The <tt>cl::ParseCommandLineOptions</tt> function requires two parameters
1395 (<tt>argc</tt> and <tt>argv</tt>), but may also take an optional third parameter
1396 which holds <a href="#description">additional extra text</a> to emit when the
1397 <tt>--help</tt> option is invoked.</p>
1398
1399 </div>
1400
1401 <!-- _______________________________________________________________________ -->
1402 <div class="doc_subsubsection">
1403   <a name="cl::ParseEnvironmentOptions">The <tt>cl::ParseEnvironmentOptions</tt>
1404   function</a>
1405 </div>
1406
1407 <div class="doc_text">
1408
1409 <p>The <tt>cl::ParseEnvironmentOptions</tt> function has mostly the same effects
1410 as <a
1411 href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>,
1412 except that it is designed to take values for options from an environment
1413 variable, for those cases in which reading the command line is not convenient or
1414 not desired. It fills in the values of all the command line option variables
1415 just like <a
1416 href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>
1417 does.</p>
1418
1419 <p>It takes three parameters: first, the name of the program (since
1420 <tt>argv</tt> may not be available, it can't just look in <tt>argv[0]</tt>),
1421 second, the name of the environment variable to examine, and third, the optional
1422 <a href="#description">additional extra text</a> to emit when the
1423 <tt>--help</tt> option is invoked.</p>
1424
1425 <p><tt>cl::ParseEnvironmentOptions</tt> will break the environment
1426 variable's value up into words and then process them using
1427 <a href="#cl::ParseCommandLineOptions"><tt>cl::ParseCommandLineOptions</tt></a>.
1428 <b>Note:</b> Currently <tt>cl::ParseEnvironmentOptions</tt> does not support
1429 quoting, so an environment variable containing <tt>-option "foo bar"</tt> will
1430 be parsed as three words, <tt>-option</tt>, <tt>"foo</tt>, and <tt>bar"</tt>,
1431 which is different from what you would get from the shell with the same
1432 input.</p>
1433
1434 </div>
1435
1436 <!-- _______________________________________________________________________ -->
1437 <div class="doc_subsubsection">
1438   <a name="cl::opt">The <tt>cl::opt</tt> class</a>
1439 </div>
1440
1441 <div class="doc_text">
1442
1443 <p>The <tt>cl::opt</tt> class is the class used to represent scalar command line
1444 options, and is the one used most of the time.  It is a templated class which
1445 can take up to three arguments (all except for the first have default values
1446 though):</p>
1447
1448 <pre>
1449 <b>namespace</b> cl {
1450   <b>template</b> &lt;<b>class</b> DataType, <b>bool</b> ExternalStorage = <b>false</b>,
1451             <b>class</b> ParserClass = parser&lt;DataType&gt; &gt;
1452   <b>class</b> opt;
1453 }
1454 </pre>
1455
1456 <p>The first template argument specifies what underlying data type the command
1457 line argument is, and is used to select a default parser implementation.  The
1458 second template argument is used to specify whether the option should contain
1459 the storage for the option (the default) or whether external storage should be
1460 used to contain the value parsed for the option (see <a href="#storage">Internal
1461 vs External Storage</a> for more information).</p>
1462
1463 <p>The third template argument specifies which parser to use.  The default value
1464 selects an instantiation of the <tt>parser</tt> class based on the underlying
1465 data type of the option.  In general, this default works well for most
1466 applications, so this option is only used when using a <a
1467 href="#customparser">custom parser</a>.</p>
1468
1469 </div>
1470
1471 <!-- _______________________________________________________________________ -->
1472 <div class="doc_subsubsection">
1473   <a name="cl::list">The <tt>cl::list</tt> class</a>
1474 </div>
1475
1476 <div class="doc_text">
1477
1478 <p>The <tt>cl::list</tt> class is the class used to represent a list of command
1479 line options.  It too is a templated class which can take up to three
1480 arguments:</p>
1481
1482 <pre>
1483 <b>namespace</b> cl {
1484   <b>template</b> &lt;<b>class</b> DataType, <b>class</b> Storage = <b>bool</b>,
1485             <b>class</b> ParserClass = parser&lt;DataType&gt; &gt;
1486   <b>class</b> list;
1487 }
1488 </pre>
1489
1490 <p>This class works the exact same as the <a
1491 href="#cl::opt"><tt>cl::opt</tt></a> class, except that the second argument is
1492 the <b>type</b> of the external storage, not a boolean value.  For this class,
1493 the marker type '<tt>bool</tt>' is used to indicate that internal storage should
1494 be used.</p>
1495
1496 </div>
1497
1498 <!-- _______________________________________________________________________ -->
1499 <div class="doc_subsubsection">
1500   <a name="cl::alias">The <tt>cl::alias</tt> class</a>
1501 </div>
1502
1503 <div class="doc_text">
1504
1505 <p>The <tt>cl::alias</tt> class is a nontemplated class that is used to form
1506 aliases for other arguments.</p>
1507
1508 <pre>
1509 <b>namespace</b> cl {
1510   <b>class</b> alias;
1511 }
1512 </pre>
1513
1514 <p>The <a href="#cl::aliasopt"><tt>cl::aliasopt</tt></a> attribute should be
1515 used to specify which option this is an alias for.  Alias arguments default to
1516 being <a href="#cl::Hidden">Hidden</a>, and use the aliased options parser to do
1517 the conversion from string to data.</p>
1518
1519 </div>
1520
1521 <!-- ======================================================================= -->
1522 <div class="doc_subsection">
1523   <a name="builtinparsers">Builtin parsers</a>
1524 </div>
1525
1526 <div class="doc_text">
1527
1528 <p>Parsers control how the string value taken from the command line is
1529 translated into a typed value, suitable for use in a C++ program.  By default,
1530 the CommandLine library uses an instance of <tt>parser&lt;type&gt;</tt> if the
1531 command line option specifies that it uses values of type '<tt>type</tt>'.
1532 Because of this, custom option processing is specified with specializations of
1533 the '<tt>parser</tt>' class.</p>
1534
1535 <p>The CommandLine library provides the following builtin parser
1536 specializations, which are sufficient for most applications. It can, however,
1537 also be extended to work with new data types and new ways of interpreting the
1538 same data.  See the <a href="#customparser">Writing a Custom Parser</a> for more
1539 details on this type of library extension.</p>
1540
1541 <ul>
1542
1543 <li><a name="genericparser">The <b>generic <tt>parser&lt;t&gt;</tt> parser</b></a>
1544 can be used to map strings values to any data type, through the use of the <a
1545 href="#cl::values">cl::values</a> property, which specifies the mapping
1546 information.  The most common use of this parser is for parsing enum values,
1547 which allows you to use the CommandLine library for all of the error checking to
1548 make sure that only valid enum values are specified (as opposed to accepting
1549 arbitrary strings).  Despite this, however, the generic parser class can be used
1550 for any data type.</li>
1551
1552 <li><a name="boolparser">The <b><tt>parser&lt;bool&gt;</tt> specialization</b></a>
1553 is used to convert boolean strings to a boolean value.  Currently accepted
1554 strings are "<tt>true</tt>", "<tt>TRUE</tt>", "<tt>True</tt>", "<tt>1</tt>",
1555 "<tt>false</tt>", "<tt>FALSE</tt>", "<tt>False</tt>", and "<tt>0</tt>".</li>
1556
1557 <li><a name="stringparser">The <b><tt>parser&lt;string&gt;</tt>
1558 specialization</b></a> simply stores the parsed string into the string value
1559 specified.  No conversion or modification of the data is performed.</li>
1560
1561 <li><a name="intparser">The <b><tt>parser&lt;int&gt;</tt> specialization</b></a>
1562 uses the C <tt>strtol</tt> function to parse the string input.  As such, it will
1563 accept a decimal number (with an optional '+' or '-' prefix) which must start
1564 with a non-zero digit.  It accepts octal numbers, which are identified with a
1565 '<tt>0</tt>' prefix digit, and hexadecimal numbers with a prefix of
1566 '<tt>0x</tt>' or '<tt>0X</tt>'.</li>
1567
1568 <li><a name="doubleparser">The <b><tt>parser&lt;double&gt;</tt></b></a> and
1569 <b><tt>parser&lt;float&gt;</tt> specializations</b> use the standard C
1570 <tt>strtod</tt> function to convert floating point strings into floating point
1571 values.  As such, a broad range of string formats is supported, including
1572 exponential notation (ex: <tt>1.7e15</tt>) and properly supports locales.
1573 </li>
1574
1575 </ul>
1576
1577 </div>
1578
1579 <!-- *********************************************************************** -->
1580 <div class="doc_section">
1581   <a name="extensionguide">Extension Guide</a>
1582 </div>
1583 <!-- *********************************************************************** -->
1584
1585 <div class="doc_text">
1586
1587 <p>Although the CommandLine library has a lot of functionality built into it
1588 already (as discussed previously), one of its true strengths lie in its
1589 extensibility.  This section discusses how the CommandLine library works under
1590 the covers and illustrates how to do some simple, common, extensions.</p>
1591
1592 </div>
1593
1594 <!-- ======================================================================= -->
1595 <div class="doc_subsection">
1596   <a name="customparser">Writing a custom parser</a>
1597 </div>
1598
1599 <div class="doc_text">
1600
1601 <p>One of the simplest and most common extensions is the use of a custom parser.
1602 As <a href="#builtinparsers">discussed previously</a>, parsers are the portion
1603 of the CommandLine library that turns string input from the user into a
1604 particular parsed data type, validating the input in the process.</p>
1605
1606 <p>There are two ways to use a new parser:</p>
1607
1608 <ol>
1609
1610 <li>
1611
1612 <p>Specialize the <a href="#genericparser"><tt>cl::parser</tt></a> template for
1613 your custom data type.<p>
1614
1615 <p>This approach has the advantage that users of your custom data type will
1616 automatically use your custom parser whenever they define an option with a value
1617 type of your data type.  The disadvantage of this approach is that it doesn't
1618 work if your fundemental data type is something that is already supported.</p>
1619
1620 </li>
1621
1622 <li>
1623
1624 <p>Write an independent class, using it explicitly from options that need
1625 it.</p>
1626
1627 <p>This approach works well in situations where you would line to parse an
1628 option using special syntax for a not-very-special data-type.  The drawback of
1629 this approach is that users of your parser have to be aware that they are using
1630 your parser, instead of the builtin ones.</p>
1631
1632 </li>
1633
1634 </ol>
1635
1636 <p>To guide the discussion, we will discuss a custom parser that accepts file
1637 sizes, specified with an optional unit after the numeric size.  For example, we
1638 would like to parse "102kb", "41M", "1G" into the appropriate integer value.  In
1639 this case, the underlying data type we want to parse into is
1640 '<tt>unsigned</tt>'.  We choose approach #2 above because we don't want to make
1641 this the default for all <tt>unsigned</tt> options.</p>
1642
1643 <p>To start out, we declare our new <tt>FileSizeParser</tt> class:</p>
1644
1645 <pre>
1646 <b>struct</b> FileSizeParser : <b>public</b> cl::basic_parser&lt;<b>unsigned</b>&gt; {
1647   <i>// parse - Return true on error.</i>
1648   <b>bool</b> parse(cl::Option &amp;O, <b>const char</b> *ArgName, <b>const</b> std::string &amp;ArgValue,
1649              <b>unsigned</b> &amp;Val);
1650 };
1651 </pre>
1652
1653 <p>Our new class inherits from the <tt>cl::basic_parser</tt> template class to
1654 fill in the default, boiler plate, code for us.  We give it the data type that
1655 we parse into (the last argument to the <tt>parse</tt> method so that clients of
1656 our custom parser know what object type to pass in to the parse method (here we
1657 declare that we parse into '<tt>unsigned</tt>' variables.</p>
1658
1659 <p>For most purposes, the only method that must be implemented in a custom
1660 parser is the <tt>parse</tt> method.  The <tt>parse</tt> method is called
1661 whenever the option is invoked, passing in the option itself, the option name,
1662 the string to parse, and a reference to a return value.  If the string to parse
1663 is not well formed, the parser should output an error message and return true.
1664 Otherwise it should return false and set '<tt>Val</tt>' to the parsed value.  In
1665 our example, we implement <tt>parse</tt> as:</p>
1666
1667 <pre>
1668 <b>bool</b> FileSizeParser::parse(cl::Option &amp;O, <b>const char</b> *ArgName,
1669                            <b>const</b> std::string &amp;Arg, <b>unsigned</b> &amp;Val) {
1670   <b>const char</b> *ArgStart = Arg.c_str();
1671   <b>char</b> *End;
1672
1673   <i>// Parse integer part, leaving 'End' pointing to the first non-integer char</i>
1674   Val = (unsigned)strtol(ArgStart, &amp;End, 0);
1675
1676   <b>while</b> (1) {
1677     <b>switch</b> (*End++) {
1678     <b>case</b> 0: <b>return</b> false;   <i>// No error</i>
1679     <b>case</b> 'i':               <i>// Ignore the 'i' in KiB if people use that</i>
1680     <b>case</b> 'b': <b>case</b> 'B':     <i>// Ignore B suffix</i>
1681       <b>break</b>;
1682
1683     <b>case</b> 'g': <b>case</b> 'G': Val *= 1024*1024*1024; <b>break</b>;
1684     <b>case</b> 'm': <b>case</b> 'M': Val *= 1024*1024;      <b>break</b>;
1685     <b>case</b> 'k': <b>case</b> 'K': Val *= 1024;           <b>break</b>;
1686
1687     default:
1688       <i>// Print an error message if unrecognized character!</i>
1689       <b>return</b> O.error(": '" + Arg + "' value invalid for file size argument!");
1690     }
1691   }
1692 }
1693 </pre>
1694
1695 <p>This function implements a very simple parser for the kinds of strings we are
1696 interested in.  Although it has some holes (it allows "<tt>123KKK</tt>" for
1697 example), it is good enough for this example.  Note that we use the option
1698 itself to print out the error message (the <tt>error</tt> method always returns
1699 true) in order to get a nice error message (shown below).  Now that we have our
1700 parser class, we can use it like this:</p>
1701
1702 <pre>
1703 <b>static</b> <a href="#cl::opt">cl::opt</a>&lt;<b>unsigned</b>, <b>false</b>, FileSizeParser&gt;
1704 MFS(<i>"max-file-size"</i>, <a href="#cl::desc">cl::desc</a>(<i>"Maximum file size to accept"</i>),
1705     <a href="#cl::value_desc">cl::value_desc</a>("<i>size</i>"));
1706 </pre>
1707
1708 <p>Which adds this to the output of our program:</p>
1709
1710 <pre>
1711 OPTIONS:
1712   -help                 - display available options (--help-hidden for more)
1713   ...
1714   <b>-max-file-size=&lt;size&gt; - Maximum file size to accept</b>
1715 </pre>
1716
1717 <p>And we can test that our parse works correctly now (the test program just
1718 prints out the max-file-size argument value):</p>
1719
1720 <pre>
1721 $ ./test
1722 MFS: 0
1723 $ ./test -max-file-size=123MB
1724 MFS: 128974848
1725 $ ./test -max-file-size=3G
1726 MFS: 3221225472
1727 $ ./test -max-file-size=dog
1728 -max-file-size option: 'dog' value invalid for file size argument!
1729 </pre>
1730
1731 <p>It looks like it works.  The error message that we get is nice and helpful,
1732 and we seem to accept reasonable file sizes.  This wraps up the "custom parser"
1733 tutorial.</p>
1734
1735 </div>
1736
1737 <!-- ======================================================================= -->
1738 <div class="doc_subsection">
1739   <a name="explotingexternal">Exploiting external storage</a>
1740 </div>
1741
1742 <div class="doc_text">
1743
1744 <p>TODO: fill in this section</p>
1745
1746 </div>
1747
1748 <!-- ======================================================================= -->
1749 <div class="doc_subsection">
1750   <a name="dynamicopts">Dynamically adding command line options</a>
1751 </div>
1752
1753 <div class="doc_text">
1754
1755 <p>TODO: fill in this section</p>
1756
1757 </div>
1758
1759 <!-- *********************************************************************** -->
1760
1761 <hr>
1762 <address>
1763   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1764   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1765   <a href="http://validator.w3.org/check/referer"><img
1766   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
1767
1768   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1769   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
1770   Last modified: $Date$
1771 </address>
1772
1773 </body>
1774 </html>