1 ==============================
2 CommandLine 2.0 Library Manual
3 ==============================
11 This document describes the CommandLine argument processing library. It will
12 show you how to use it, and what it can do. The CommandLine library uses a
13 declarative approach to specifying the command line options that your program
14 takes. By default, these options declarations implicitly hold the value parsed
15 for the option declared (of course this `can be changed`_).
17 Although there are a **lot** of command line argument parsing libraries out
18 there in many different languages, none of them fit well with what I needed. By
19 looking at the features and problems of other libraries, I designed the
20 CommandLine library to have the following features:
22 #. Speed: The CommandLine library is very quick and uses little resources. The
23 parsing time of the library is directly proportional to the number of
24 arguments parsed, not the number of options recognized. Additionally,
25 command line argument values are captured transparently into user defined
26 global variables, which can be accessed like any other variable (and with the
29 #. Type Safe: As a user of CommandLine, you don't have to worry about
30 remembering the type of arguments that you want (is it an int? a string? a
31 bool? an enum?) and keep casting it around. Not only does this help prevent
32 error prone constructs, it also leads to dramatically cleaner source code.
34 #. No subclasses required: To use CommandLine, you instantiate variables that
35 correspond to the arguments that you would like to capture, you don't
36 subclass a parser. This means that you don't have to write **any**
39 #. Globally accessible: Libraries can specify command line arguments that are
40 automatically enabled in any tool that links to the library. This is
41 possible because the application doesn't have to keep a list of arguments to
42 pass to the parser. This also makes supporting `dynamically loaded options`_
45 #. Cleaner: CommandLine supports enum and other types directly, meaning that
46 there is less error and more security built into the library. You don't have
47 to worry about whether your integral command line argument accidentally got
48 assigned a value that is not valid for your enum type.
50 #. Powerful: The CommandLine library supports many different types of arguments,
51 from simple `boolean flags`_ to `scalars arguments`_ (`strings`_,
52 `integers`_, `enums`_, `doubles`_), to `lists of arguments`_. This is
53 possible because CommandLine is...
55 #. Extensible: It is very simple to add a new argument type to CommandLine.
56 Simply specify the parser that you want to use with the command line option
57 when you declare it. `Custom parsers`_ are no problem.
59 #. Labor Saving: The CommandLine library cuts down on the amount of grunt work
60 that you, the user, have to do. For example, it automatically provides a
61 ``-help`` option that shows the available command line options for your tool.
62 Additionally, it does most of the basic correctness checking for you.
64 #. Capable: The CommandLine library can handle lots of different forms of
65 options often found in real programs. For example, `positional`_ arguments,
66 ``ls`` style `grouping`_ options (to allow processing '``ls -lad``'
67 naturally), ``ld`` style `prefix`_ options (to parse '``-lmalloc
68 -L/usr/lib``'), and interpreter style options.
70 This document will hopefully let you jump in and start using CommandLine in your
71 utility quickly and painlessly. Additionally it should be a simple reference
72 manual to figure out how stuff works.
77 This section of the manual runs through a simple CommandLine'ification of a
78 basic compiler tool. This is intended to show you how to jump into using the
79 CommandLine library in your own program, and show you some of the cool things it
82 To start out, you need to include the CommandLine header file into your program:
86 #include "llvm/Support/CommandLine.h"
88 Additionally, you need to add this as the first line of your main program:
92 int main(int argc, char **argv) {
93 cl::ParseCommandLineOptions(argc, argv);
97 ... which actually parses the arguments and fills in the variable declarations.
99 Now that you are ready to support command line arguments, we need to tell the
100 system which ones we want, and what type of arguments they are. The CommandLine
101 library uses a declarative syntax to model command line arguments with the
102 global variable declarations that capture the parsed values. This means that
103 for every command line option that you would like to support, there should be a
104 global variable declaration to capture the result. For example, in a compiler,
105 we would like to support the Unix-standard '``-o <filename>``' option to specify
106 where to put the output. With the CommandLine library, this is represented like
109 .. _scalars arguments:
114 cl::opt<string> OutputFilename("o", cl::desc("Specify output filename"), cl::value_desc("filename"));
116 This declares a global variable "``OutputFilename``" that is used to capture the
117 result of the "``o``" argument (first parameter). We specify that this is a
118 simple scalar option by using the "``cl::opt``" template (as opposed to the
119 "``cl::list``" template), and tell the CommandLine library that the data
120 type that we are parsing is a string.
122 The second and third parameters (which are optional) are used to specify what to
123 output for the "``-help``" option. In this case, we get a line that looks like
128 USAGE: compiler [options]
131 -help - display available options (-help-hidden for more)
132 -o <filename> - Specify output filename
134 Because we specified that the command line option should parse using the
135 ``string`` data type, the variable declared is automatically usable as a real
136 string in all contexts that a normal C++ string object may be used. For
142 std::ofstream Output(OutputFilename.c_str());
143 if (Output.good()) ...
146 There are many different options that you can use to customize the command line
147 option handling library, but the above example shows the general interface to
148 these options. The options can be specified in any order, and are specified
149 with helper functions like `cl::desc(...)`_, so there are no positional
150 dependencies to remember. The available options are discussed in detail in the
153 Continuing the example, we would like to have our compiler take an input
154 filename as well as an output filename, but we do not want the input filename to
155 be specified with a hyphen (ie, not ``-filename.c``). To support this style of
156 argument, the CommandLine library allows for `positional`_ arguments to be
157 specified for the program. These positional arguments are filled with command
158 line parameters that are not in option form. We use this feature like this:
163 cl::opt<string> InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
165 This declaration indicates that the first positional argument should be treated
166 as the input filename. Here we use the `cl::init`_ option to specify an initial
167 value for the command line option, which is used if the option is not specified
168 (if you do not specify a `cl::init`_ modifier for an option, then the default
169 constructor for the data type is used to initialize the value). Command line
170 options default to being optional, so if we would like to require that the user
171 always specify an input filename, we would add the `cl::Required`_ flag, and we
172 could eliminate the `cl::init`_ modifier, like this:
176 cl::opt<string> InputFilename(cl::Positional, cl::desc("<input file>"), cl::Required);
178 Again, the CommandLine library does not require the options to be specified in
179 any particular order, so the above declaration is equivalent to:
183 cl::opt<string> InputFilename(cl::Positional, cl::Required, cl::desc("<input file>"));
185 By simply adding the `cl::Required`_ flag, the CommandLine library will
186 automatically issue an error if the argument is not specified, which shifts all
187 of the command line option verification code out of your application into the
188 library. This is just one example of how using flags can alter the default
189 behaviour of the library, on a per-option basis. By adding one of the
190 declarations above, the ``-help`` option synopsis is now extended to:
194 USAGE: compiler [options] <input file>
197 -help - display available options (-help-hidden for more)
198 -o <filename> - Specify output filename
200 ... indicating that an input filename is expected.
205 In addition to input and output filenames, we would like the compiler example to
206 support three boolean flags: "``-f``" to force writing binary output to a
207 terminal, "``--quiet``" to enable quiet mode, and "``-q``" for backwards
208 compatibility with some of our users. We can support these by declaring options
209 of boolean type like this:
213 cl::opt<bool> Force ("f", cl::desc("Enable binary output on terminals"));
214 cl::opt<bool> Quiet ("quiet", cl::desc("Don't print informational messages"));
215 cl::opt<bool> Quiet2("q", cl::desc("Don't print informational messages"), cl::Hidden);
217 This does what you would expect: it declares three boolean variables
218 ("``Force``", "``Quiet``", and "``Quiet2``") to recognize these options. Note
219 that the "``-q``" option is specified with the "`cl::Hidden`_" flag. This
220 modifier prevents it from being shown by the standard "``-help``" output (note
221 that it is still shown in the "``-help-hidden``" output).
223 The CommandLine library uses a `different parser`_ for different data types.
224 For example, in the string case, the argument passed to the option is copied
225 literally into the content of the string variable... we obviously cannot do that
226 in the boolean case, however, so we must use a smarter parser. In the case of
227 the boolean parser, it allows no options (in which case it assigns the value of
228 true to the variable), or it allows the values "``true``" or "``false``" to be
229 specified, allowing any of the following inputs:
233 compiler -f # No value, 'Force' == true
234 compiler -f=true # Value specified, 'Force' == true
235 compiler -f=TRUE # Value specified, 'Force' == true
236 compiler -f=FALSE # Value specified, 'Force' == false
238 ... you get the idea. The `bool parser`_ just turns the string values into
239 boolean values, and rejects things like '``compiler -f=foo``'. Similarly, the
240 `float`_, `double`_, and `int`_ parsers work like you would expect, using the
241 '``strtol``' and '``strtod``' C library calls to parse the string value into the
244 With the declarations above, "``compiler -help``" emits this:
248 USAGE: compiler [options] <input file>
251 -f - Enable binary output on terminals
252 -o - Override output filename
253 -quiet - Don't print informational messages
254 -help - display available options (-help-hidden for more)
256 and "``compiler -help-hidden``" prints this:
260 USAGE: compiler [options] <input file>
263 -f - Enable binary output on terminals
264 -o - Override output filename
265 -q - Don't print informational messages
266 -quiet - Don't print informational messages
267 -help - display available options (-help-hidden for more)
269 This brief example has shown you how to use the '`cl::opt`_' class to parse
270 simple scalar command line arguments. In addition to simple scalar arguments,
271 the CommandLine library also provides primitives to support CommandLine option
272 `aliases`_, and `lists`_ of options.
279 So far, the example works well, except for the fact that we need to check the
280 quiet condition like this now:
285 if (!Quiet && !Quiet2) printInformationalMessage(...);
288 ... which is a real pain! Instead of defining two values for the same
289 condition, we can use the "`cl::alias`_" class to make the "``-q``" option an
290 **alias** for the "``-quiet``" option, instead of providing a value itself:
294 cl::opt<bool> Force ("f", cl::desc("Overwrite output files"));
295 cl::opt<bool> Quiet ("quiet", cl::desc("Don't print informational messages"));
296 cl::alias QuietA("q", cl::desc("Alias for -quiet"), cl::aliasopt(Quiet));
298 The third line (which is the only one we modified from above) defines a "``-q``"
299 alias that updates the "``Quiet``" variable (as specified by the `cl::aliasopt`_
300 modifier) whenever it is specified. Because aliases do not hold state, the only
301 thing the program has to query is the ``Quiet`` variable now. Another nice
302 feature of aliases is that they automatically hide themselves from the ``-help``
303 output (although, again, they are still visible in the ``-help-hidden output``).
305 Now the application code can simply use:
310 if (!Quiet) printInformationalMessage(...);
313 ... which is much nicer! The "`cl::alias`_" can be used to specify an
314 alternative name for any variable type, and has many uses.
316 .. _unnamed alternatives using the generic parser:
318 Selecting an alternative from a set of possibilities
319 ----------------------------------------------------
321 So far we have seen how the CommandLine library handles builtin types like
322 ``std::string``, ``bool`` and ``int``, but how does it handle things it doesn't
323 know about, like enums or '``int*``'s?
325 The answer is that it uses a table-driven generic parser (unless you specify
326 your own parser, as described in the `Extension Guide`_). This parser maps
327 literal strings to whatever type is required, and requires you to tell it what
328 this mapping should be.
330 Let's say that we would like to add four optimization levels to our optimizer,
331 using the standard flags "``-g``", "``-O0``", "``-O1``", and "``-O2``". We
332 could easily implement this with boolean options like above, but there are
333 several problems with this strategy:
335 #. A user could specify more than one of the options at a time, for example,
336 "``compiler -O3 -O2``". The CommandLine library would not be able to catch
337 this erroneous input for us.
339 #. We would have to test 4 different variables to see which ones are set.
341 #. This doesn't map to the numeric levels that we want... so we cannot easily
342 see if some level >= "``-O1``" is enabled.
344 To cope with these problems, we can use an enum value, and have the CommandLine
345 library fill it in with the appropriate level directly, which is used like this:
353 cl::opt<OptLevel> OptimizationLevel(cl::desc("Choose optimization level:"),
355 clEnumVal(g , "No optimizations, enable debugging"),
356 clEnumVal(O1, "Enable trivial optimizations"),
357 clEnumVal(O2, "Enable default optimizations"),
358 clEnumVal(O3, "Enable expensive optimizations"),
362 if (OptimizationLevel >= O2) doPartialRedundancyElimination(...);
365 This declaration defines a variable "``OptimizationLevel``" of the
366 "``OptLevel``" enum type. This variable can be assigned any of the values that
367 are listed in the declaration (Note that the declaration list must be terminated
368 with the "``clEnumValEnd``" argument!). The CommandLine library enforces that
369 the user can only specify one of the options, and it ensure that only valid enum
370 values can be specified. The "``clEnumVal``" macros ensure that the command
371 line arguments matched the enum values. With this option added, our help output
376 USAGE: compiler [options] <input file>
379 Choose optimization level:
380 -g - No optimizations, enable debugging
381 -O1 - Enable trivial optimizations
382 -O2 - Enable default optimizations
383 -O3 - Enable expensive optimizations
384 -f - Enable binary output on terminals
385 -help - display available options (-help-hidden for more)
386 -o <filename> - Specify output filename
387 -quiet - Don't print informational messages
389 In this case, it is sort of awkward that flag names correspond directly to enum
390 names, because we probably don't want a enum definition named "``g``" in our
391 program. Because of this, we can alternatively write this example like this:
399 cl::opt<OptLevel> OptimizationLevel(cl::desc("Choose optimization level:"),
401 clEnumValN(Debug, "g", "No optimizations, enable debugging"),
402 clEnumVal(O1 , "Enable trivial optimizations"),
403 clEnumVal(O2 , "Enable default optimizations"),
404 clEnumVal(O3 , "Enable expensive optimizations"),
408 if (OptimizationLevel == Debug) outputDebugInfo(...);
411 By using the "``clEnumValN``" macro instead of "``clEnumVal``", we can directly
412 specify the name that the flag should get. In general a direct mapping is nice,
413 but sometimes you can't or don't want to preserve the mapping, which is when you
419 Another useful argument form is a named alternative style. We shall use this
420 style in our compiler to specify different debug levels that can be used.
421 Instead of each debug level being its own switch, we want to support the
422 following options, of which only one can be specified at a time:
423 "``--debug-level=none``", "``--debug-level=quick``",
424 "``--debug-level=detailed``". To do this, we use the exact same format as our
425 optimization level flags, but we also specify an option name. For this case,
426 the code looks like this:
431 nodebuginfo, quick, detailed
434 // Enable Debug Options to be specified on the command line
435 cl::opt<DebugLev> DebugLevel("debug_level", cl::desc("Set the debugging level:"),
437 clEnumValN(nodebuginfo, "none", "disable debug information"),
438 clEnumVal(quick, "enable quick debug information"),
439 clEnumVal(detailed, "enable detailed debug information"),
442 This definition defines an enumerated command line variable of type "``enum
443 DebugLev``", which works exactly the same way as before. The difference here is
444 just the interface exposed to the user of your program and the help output by
445 the "``-help``" option:
449 USAGE: compiler [options] <input file>
452 Choose optimization level:
453 -g - No optimizations, enable debugging
454 -O1 - Enable trivial optimizations
455 -O2 - Enable default optimizations
456 -O3 - Enable expensive optimizations
457 -debug_level - Set the debugging level:
458 =none - disable debug information
459 =quick - enable quick debug information
460 =detailed - enable detailed debug information
461 -f - Enable binary output on terminals
462 -help - display available options (-help-hidden for more)
463 -o <filename> - Specify output filename
464 -quiet - Don't print informational messages
466 Again, the only structural difference between the debug level declaration and
467 the optimization level declaration is that the debug level declaration includes
468 an option name (``"debug_level"``), which automatically changes how the library
469 processes the argument. The CommandLine library supports both forms so that you
470 can choose the form most appropriate for your application.
474 Parsing a list of options
475 -------------------------
477 Now that we have the standard run-of-the-mill argument types out of the way,
478 lets get a little wild and crazy. Lets say that we want our optimizer to accept
479 a **list** of optimizations to perform, allowing duplicates. For example, we
480 might want to run: "``compiler -dce -constprop -inline -dce -strip``". In this
481 case, the order of the arguments and the number of appearances is very
482 important. This is what the "``cl::list``" template is for. First, start by
483 defining an enum of the optimizations that you would like to perform:
488 // 'inline' is a C++ keyword, so name it 'inlining'
489 dce, constprop, inlining, strip
492 Then define your "``cl::list``" variable:
496 cl::list<Opts> OptimizationList(cl::desc("Available Optimizations:"),
498 clEnumVal(dce , "Dead Code Elimination"),
499 clEnumVal(constprop , "Constant Propagation"),
500 clEnumValN(inlining, "inline", "Procedure Integration"),
501 clEnumVal(strip , "Strip Symbols"),
504 This defines a variable that is conceptually of the type
505 "``std::vector<enum Opts>``". Thus, you can access it with standard vector
510 for (unsigned i = 0; i != OptimizationList.size(); ++i)
511 switch (OptimizationList[i])
514 ... to iterate through the list of options specified.
516 Note that the "``cl::list``" template is completely general and may be used with
517 any data types or other arguments that you can use with the "``cl::opt``"
518 template. One especially useful way to use a list is to capture all of the
519 positional arguments together if there may be more than one specified. In the
520 case of a linker, for example, the linker takes several '``.o``' files, and
521 needs to capture them into a list. This is naturally specified as:
526 cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<Input files>"), cl::OneOrMore);
529 This variable works just like a "``vector<string>``" object. As such, accessing
530 the list is simple, just like above. In this example, we used the
531 `cl::OneOrMore`_ modifier to inform the CommandLine library that it is an error
532 if the user does not specify any ``.o`` files on our command line. Again, this
533 just reduces the amount of checking we have to do.
535 Collecting options as a set of flags
536 ------------------------------------
538 Instead of collecting sets of options in a list, it is also possible to gather
539 information for enum values in a **bit vector**. The representation used by the
540 `cl::bits`_ class is an ``unsigned`` integer. An enum value is represented by a
541 0/1 in the enum's ordinal value bit position. 1 indicating that the enum was
542 specified, 0 otherwise. As each specified value is parsed, the resulting enum's
543 bit is set in the option's bit vector:
547 bits |= 1 << (unsigned)enum;
549 Options that are specified multiple times are redundant. Any instances after
550 the first are discarded.
552 Reworking the above list example, we could replace `cl::list`_ with `cl::bits`_:
556 cl::bits<Opts> OptimizationBits(cl::desc("Available Optimizations:"),
558 clEnumVal(dce , "Dead Code Elimination"),
559 clEnumVal(constprop , "Constant Propagation"),
560 clEnumValN(inlining, "inline", "Procedure Integration"),
561 clEnumVal(strip , "Strip Symbols"),
564 To test to see if ``constprop`` was specified, we can use the ``cl:bits::isSet``
569 if (OptimizationBits.isSet(constprop)) {
573 It's also possible to get the raw bit vector using the ``cl::bits::getBits``
578 unsigned bits = OptimizationBits.getBits();
580 Finally, if external storage is used, then the location specified must be of
581 **type** ``unsigned``. In all other ways a `cl::bits`_ option is equivalent to a
584 .. _additional extra text:
586 Adding freeform text to help output
587 -----------------------------------
589 As our program grows and becomes more mature, we may decide to put summary
590 information about what it does into the help output. The help output is styled
591 to look similar to a Unix ``man`` page, providing concise information about a
592 program. Unix ``man`` pages, however often have a description about what the
593 program does. To add this to your CommandLine program, simply pass a third
594 argument to the `cl::ParseCommandLineOptions`_ call in main. This additional
595 argument is then printed as the overview information for your program, allowing
596 you to include any additional information that you want. For example:
600 int main(int argc, char **argv) {
601 cl::ParseCommandLineOptions(argc, argv, " CommandLine compiler example\n\n"
602 " This program blah blah blah...\n");
606 would yield the help output:
610 **OVERVIEW: CommandLine compiler example
612 This program blah blah blah...**
614 USAGE: compiler [options] <input file>
618 -help - display available options (-help-hidden for more)
619 -o <filename> - Specify output filename
621 .. _grouping options into categories:
623 Grouping options into categories
624 --------------------------------
626 If our program has a large number of options it may become difficult for users
627 of our tool to navigate the output of ``-help``. To alleviate this problem we
628 can put our options into categories. This can be done by declaring option
629 categories (`cl::OptionCategory`_ objects) and then placing our options into
630 these categories using the `cl::cat`_ option attribute. For example:
634 cl::OptionCategory StageSelectionCat("Stage Selection Options",
635 "These control which stages are run.");
637 cl::opt<bool> Preprocessor("E",cl::desc("Run preprocessor stage."),
638 cl::cat(StageSelectionCat));
640 cl::opt<bool> NoLink("c",cl::desc("Run all stages except linking."),
641 cl::cat(StageSelectionCat));
643 The output of ``-help`` will become categorized if an option category is
644 declared. The output looks something like ::
646 OVERVIEW: This is a small program to demo the LLVM CommandLine API
647 USAGE: Sample [options]
653 -help - Display available options (-help-hidden for more)
654 -help-list - Display list of available options (-help-list-hidden for more)
657 Stage Selection Options:
658 These control which stages are run.
660 -E - Run preprocessor stage.
661 -c - Run all stages except linking.
663 In addition to the behaviour of ``-help`` changing when an option category is
664 declared, the command line option ``-help-list`` becomes visible which will
665 print the command line options as uncategorized list.
667 Note that Options that are not explicitly categorized will be placed in the
668 ``cl::GeneralCategory`` category.
675 Now that you know the basics of how to use the CommandLine library, this section
676 will give you the detailed information you need to tune how command line options
677 work, as well as information on more "advanced" command line option processing
681 .. _positional argument:
682 .. _Positional Arguments:
683 .. _Positional arguments section:
684 .. _positional options:
689 Positional arguments are those arguments that are not named, and are not
690 specified with a hyphen. Positional arguments should be used when an option is
691 specified by its position alone. For example, the standard Unix ``grep`` tool
692 takes a regular expression argument, and an optional filename to search through
693 (which defaults to standard input if a filename is not specified). Using the
694 CommandLine library, this would be specified as:
698 cl::opt<string> Regex (cl::Positional, cl::desc("<regular expression>"), cl::Required);
699 cl::opt<string> Filename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
701 Given these two option declarations, the ``-help`` output for our grep
702 replacement would look like this:
706 USAGE: spiffygrep [options] <regular expression> <input file>
709 -help - display available options (-help-hidden for more)
711 ... and the resultant program could be used just like the standard ``grep``
714 Positional arguments are sorted by their order of construction. This means that
715 command line options will be ordered according to how they are listed in a .cpp
716 file, but will not have an ordering defined if the positional arguments are
717 defined in multiple .cpp files. The fix for this problem is simply to define
718 all of your positional arguments in one .cpp file.
720 Specifying positional options with hyphens
721 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
723 Sometimes you may want to specify a value to your positional argument that
724 starts with a hyphen (for example, searching for '``-foo``' in a file). At
725 first, you will have trouble doing this, because it will try to find an argument
726 named '``-foo``', and will fail (and single quotes will not save you). Note
727 that the system ``grep`` has the same problem:
731 $ spiffygrep '-foo' test.txt
732 Unknown command line argument '-foo'. Try: spiffygrep -help'
734 $ grep '-foo' test.txt
735 grep: illegal option -- f
736 grep: illegal option -- o
737 grep: illegal option -- o
738 Usage: grep -hblcnsviw pattern file . . .
740 The solution for this problem is the same for both your tool and the system
741 version: use the '``--``' marker. When the user specifies '``--``' on the
742 command line, it is telling the program that all options after the '``--``'
743 should be treated as positional arguments, not options. Thus, we can use it
748 $ spiffygrep -- -foo test.txt
751 Determining absolute position with getPosition()
752 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
754 Sometimes an option can affect or modify the meaning of another option. For
755 example, consider ``gcc``'s ``-x LANG`` option. This tells ``gcc`` to ignore the
756 suffix of subsequent positional arguments and force the file to be interpreted
757 as if it contained source code in language ``LANG``. In order to handle this
758 properly, you need to know the absolute position of each argument, especially
759 those in lists, so their interaction(s) can be applied correctly. This is also
760 useful for options like ``-llibname`` which is actually a positional argument
761 that starts with a dash.
763 So, generally, the problem is that you have two ``cl::list`` variables that
764 interact in some way. To ensure the correct interaction, you can use the
765 ``cl::list::getPosition(optnum)`` method. This method returns the absolute
766 position (as found on the command line) of the ``optnum`` item in the
769 The idiom for usage is like this:
773 static cl::list<std::string> Files(cl::Positional, cl::OneOrMore);
774 static cl::list<std::string> Libraries("l", cl::ZeroOrMore);
776 int main(int argc, char**argv) {
778 std::vector<std::string>::iterator fileIt = Files.begin();
779 std::vector<std::string>::iterator libIt = Libraries.begin();
780 unsigned libPos = 0, filePos = 0;
782 if ( libIt != Libraries.end() )
783 libPos = Libraries.getPosition( libIt - Libraries.begin() );
786 if ( fileIt != Files.end() )
787 filePos = Files.getPosition( fileIt - Files.begin() );
791 if ( filePos != 0 && (libPos == 0 || filePos < libPos) ) {
792 // Source File Is next
795 else if ( libPos != 0 && (filePos == 0 || libPos < filePos) ) {
800 break; // we're done with the list
804 Note that, for compatibility reasons, the ``cl::opt`` also supports an
805 ``unsigned getPosition()`` option that will provide the absolute position of
806 that option. You can apply the same approach as above with a ``cl::opt`` and a
807 ``cl::list`` option as you can with two lists.
809 .. _interpreter style options:
810 .. _cl::ConsumeAfter:
811 .. _this section for more information:
813 The ``cl::ConsumeAfter`` modifier
814 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
816 The ``cl::ConsumeAfter`` `formatting option`_ is used to construct programs that
817 use "interpreter style" option processing. With this style of option
818 processing, all arguments specified after the last positional argument are
819 treated as special interpreter arguments that are not interpreted by the command
822 As a concrete example, lets say we are developing a replacement for the standard
823 Unix Bourne shell (``/bin/sh``). To run ``/bin/sh``, first you specify options
824 to the shell itself (like ``-x`` which turns on trace output), then you specify
825 the name of the script to run, then you specify arguments to the script. These
826 arguments to the script are parsed by the Bourne shell command line option
827 processor, but are not interpreted as options to the shell itself. Using the
828 CommandLine library, we would specify this as:
832 cl::opt<string> Script(cl::Positional, cl::desc("<input script>"), cl::init("-"));
833 cl::list<string> Argv(cl::ConsumeAfter, cl::desc("<program arguments>..."));
834 cl::opt<bool> Trace("x", cl::desc("Enable trace output"));
836 which automatically provides the help output:
840 USAGE: spiffysh [options] <input script> <program arguments>...
843 -help - display available options (-help-hidden for more)
844 -x - Enable trace output
846 At runtime, if we run our new shell replacement as ```spiffysh -x test.sh -a -x
847 -y bar``', the ``Trace`` variable will be set to true, the ``Script`` variable
848 will be set to "``test.sh``", and the ``Argv`` list will contain ``["-a", "-x",
849 "-y", "bar"]``, because they were specified after the last positional argument
850 (which is the script name).
852 There are several limitations to when ``cl::ConsumeAfter`` options can be
853 specified. For example, only one ``cl::ConsumeAfter`` can be specified per
854 program, there must be at least one `positional argument`_ specified, there must
855 not be any `cl::list`_ positional arguments, and the ``cl::ConsumeAfter`` option
856 should be a `cl::list`_ option.
859 .. _Internal vs External Storage:
861 Internal vs External Storage
862 ----------------------------
864 By default, all command line options automatically hold the value that they
865 parse from the command line. This is very convenient in the common case,
866 especially when combined with the ability to define command line options in the
867 files that use them. This is called the internal storage model.
869 Sometimes, however, it is nice to separate the command line option processing
870 code from the storage of the value parsed. For example, lets say that we have a
871 '``-debug``' option that we would like to use to enable debug information across
872 the entire body of our program. In this case, the boolean value controlling the
873 debug code should be globally accessible (in a header file, for example) yet the
874 command line option processing code should not be exposed to all of these
875 clients (requiring lots of .cpp files to ``#include CommandLine.h``).
877 To do this, set up your .h file with your option, like this for example:
881 // DebugFlag.h - Get access to the '-debug' command line option
884 // DebugFlag - This boolean is set to true if the '-debug' command line option
885 // is specified. This should probably not be referenced directly, instead, use
886 // the DEBUG macro below.
888 extern bool DebugFlag;
890 // DEBUG macro - This macro should be used by code to emit debug information.
891 // In the '-debug' option is specified on the command line, and if this is a
892 // debug build, then the code specified as the option to the macro will be
893 // executed. Otherwise it will not be.
897 #define DEBUG(X) do { if (DebugFlag) { X; } } while (0)
900 This allows clients to blissfully use the ``DEBUG()`` macro, or the
901 ``DebugFlag`` explicitly if they want to. Now we just need to be able to set
902 the ``DebugFlag`` boolean when the option is set. To do this, we pass an
903 additional argument to our command line argument processor, and we specify where
904 to fill in with the `cl::location`_ attribute:
908 bool DebugFlag; // the actual value
909 static cl::opt<bool, true> // The parser
910 Debug("debug", cl::desc("Enable debug output"), cl::Hidden, cl::location(DebugFlag));
912 In the above example, we specify "``true``" as the second argument to the
913 `cl::opt`_ template, indicating that the template should not maintain a copy of
914 the value itself. In addition to this, we specify the `cl::location`_
915 attribute, so that ``DebugFlag`` is automatically set.
920 This section describes the basic attributes that you can specify on options.
922 * The option name attribute (which is required for all options, except
923 `positional options`_) specifies what the option name is. This option is
924 specified in simple double quotes:
928 cl::opt<**bool**> Quiet("quiet");
932 * The **cl::desc** attribute specifies a description for the option to be
933 shown in the ``-help`` output for the program.
937 * The **cl::value_desc** attribute specifies a string that can be used to
938 fine tune the ``-help`` output for a command line option. Look `here`_ for an
943 * The **cl::init** attribute specifies an initial value for a `scalar`_
944 option. If this attribute is not specified then the command line option value
945 defaults to the value created by the default constructor for the
950 If you specify both **cl::init** and **cl::location** for an option, you
951 must specify **cl::location** first, so that when the command-line parser
952 sees **cl::init**, it knows where to put the initial value. (You will get an
953 error at runtime if you don't put them in the right order.)
957 * The **cl::location** attribute where to store the value for a parsed command
958 line option if using external storage. See the section on `Internal vs
959 External Storage`_ for more information.
963 * The **cl::aliasopt** attribute specifies which option a `cl::alias`_ option is
968 * The **cl::values** attribute specifies the string-to-value mapping to be used
969 by the generic parser. It takes a **clEnumValEnd terminated** list of
970 (option, value, description) triplets that specify the option name, the value
971 mapped to, and the description shown in the ``-help`` for the tool. Because
972 the generic parser is used most frequently with enum values, two macros are
975 #. The **clEnumVal** macro is used as a nice simple way to specify a triplet
976 for an enum. This macro automatically makes the option name be the same as
977 the enum name. The first option to the macro is the enum, the second is
978 the description for the command line option.
980 #. The **clEnumValN** macro is used to specify macro options where the option
981 name doesn't equal the enum name. For this macro, the first argument is
982 the enum value, the second is the flag name, and the second is the
985 You will get a compile time error if you try to use cl::values with a parser
986 that does not support it.
990 * The **cl::multi_val** attribute specifies that this option takes has multiple
991 values (example: ``-sectalign segname sectname sectvalue``). This attribute
992 takes one unsigned argument - the number of values for the option. This
993 attribute is valid only on ``cl::list`` options (and will fail with compile
994 error if you try to use it with other option types). It is allowed to use all
995 of the usual modifiers on multi-valued options (besides
996 ``cl::ValueDisallowed``, obviously).
1000 * The **cl::cat** attribute specifies the option category that the option
1001 belongs to. The category should be a `cl::OptionCategory`_ object.
1006 Option modifiers are the flags and expressions that you pass into the
1007 constructors for `cl::opt`_ and `cl::list`_. These modifiers give you the
1008 ability to tweak how options are parsed and how ``-help`` output is generated to
1009 fit your application well.
1011 These options fall into five main categories:
1013 #. Hiding an option from ``-help`` output
1015 #. Controlling the number of occurrences required and allowed
1017 #. Controlling whether or not a value must be specified
1019 #. Controlling other formatting options
1021 #. Miscellaneous option modifiers
1023 It is not possible to specify two options from the same category (you'll get a
1024 runtime error) to a single option, except for options in the miscellaneous
1025 category. The CommandLine library specifies defaults for all of these settings
1026 that are the most useful in practice and the most common, which mean that you
1027 usually shouldn't have to worry about these.
1029 Hiding an option from ``-help`` output
1030 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1032 The ``cl::NotHidden``, ``cl::Hidden``, and ``cl::ReallyHidden`` modifiers are
1033 used to control whether or not an option appears in the ``-help`` and
1034 ``-help-hidden`` output for the compiled program:
1038 * The **cl::NotHidden** modifier (which is the default for `cl::opt`_ and
1039 `cl::list`_ options) indicates the option is to appear in both help
1044 * The **cl::Hidden** modifier (which is the default for `cl::alias`_ options)
1045 indicates that the option should not appear in the ``-help`` output, but
1046 should appear in the ``-help-hidden`` output.
1048 .. _cl::ReallyHidden:
1050 * The **cl::ReallyHidden** modifier indicates that the option should not appear
1053 Controlling the number of occurrences required and allowed
1054 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1056 This group of options is used to control how many time an option is allowed (or
1057 required) to be specified on the command line of your program. Specifying a
1058 value for this setting allows the CommandLine library to do error checking for
1061 The allowed values for this option group are:
1065 * The **cl::Optional** modifier (which is the default for the `cl::opt`_ and
1066 `cl::alias`_ classes) indicates that your program will allow either zero or
1067 one occurrence of the option to be specified.
1071 * The **cl::ZeroOrMore** modifier (which is the default for the `cl::list`_
1072 class) indicates that your program will allow the option to be specified zero
1077 * The **cl::Required** modifier indicates that the specified option must be
1078 specified exactly one time.
1082 * The **cl::OneOrMore** modifier indicates that the option must be specified at
1085 * The **cl::ConsumeAfter** modifier is described in the `Positional arguments
1088 If an option is not specified, then the value of the option is equal to the
1089 value specified by the `cl::init`_ attribute. If the ``cl::init`` attribute is
1090 not specified, the option value is initialized with the default constructor for
1093 If an option is specified multiple times for an option of the `cl::opt`_ class,
1094 only the last value will be retained.
1096 Controlling whether or not a value must be specified
1097 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1099 This group of options is used to control whether or not the option allows a
1100 value to be present. In the case of the CommandLine library, a value is either
1101 specified with an equal sign (e.g. '``-index-depth=17``') or as a trailing
1102 string (e.g. '``-o a.out``').
1104 The allowed values for this option group are:
1106 .. _cl::ValueOptional:
1108 * The **cl::ValueOptional** modifier (which is the default for ``bool`` typed
1109 options) specifies that it is acceptable to have a value, or not. A boolean
1110 argument can be enabled just by appearing on the command line, or it can have
1111 an explicit '``-foo=true``'. If an option is specified with this mode, it is
1112 illegal for the value to be provided without the equal sign. Therefore
1113 '``-foo true``' is illegal. To get this behavior, you must use
1114 the `cl::ValueRequired`_ modifier.
1116 .. _cl::ValueRequired:
1118 * The **cl::ValueRequired** modifier (which is the default for all other types
1119 except for `unnamed alternatives using the generic parser`_) specifies that a
1120 value must be provided. This mode informs the command line library that if an
1121 option is not provides with an equal sign, that the next argument provided
1122 must be the value. This allows things like '``-o a.out``' to work.
1124 .. _cl::ValueDisallowed:
1126 * The **cl::ValueDisallowed** modifier (which is the default for `unnamed
1127 alternatives using the generic parser`_) indicates that it is a runtime error
1128 for the user to specify a value. This can be provided to disallow users from
1129 providing options to boolean options (like '``-foo=true``').
1131 In general, the default values for this option group work just like you would
1132 want them to. As mentioned above, you can specify the `cl::ValueDisallowed`_
1133 modifier to a boolean argument to restrict your command line parser. These
1134 options are mostly useful when `extending the library`_.
1136 .. _formatting option:
1138 Controlling other formatting options
1139 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1141 The formatting option group is used to specify that the command line option has
1142 special abilities and is otherwise different from other command line arguments.
1143 As usual, you can only specify one of these arguments at most.
1145 .. _cl::NormalFormatting:
1147 * The **cl::NormalFormatting** modifier (which is the default all options)
1148 specifies that this option is "normal".
1152 * The **cl::Positional** modifier specifies that this is a positional argument
1153 that does not have a command line option associated with it. See the
1154 `Positional Arguments`_ section for more information.
1156 * The **cl::ConsumeAfter** modifier specifies that this option is used to
1157 capture "interpreter style" arguments. See `this section for more
1163 * The **cl::Prefix** modifier specifies that this option prefixes its value.
1164 With 'Prefix' options, the equal sign does not separate the value from the
1165 option name specified. Instead, the value is everything after the prefix,
1166 including any equal sign if present. This is useful for processing odd
1167 arguments like ``-lmalloc`` and ``-L/usr/lib`` in a linker tool or
1168 ``-DNAME=value`` in a compiler tool. Here, the '``l``', '``D``' and '``L``'
1169 options are normal string (or list) options, that have the **cl::Prefix**
1170 modifier added to allow the CommandLine library to recognize them. Note that
1171 **cl::Prefix** options must not have the **cl::ValueDisallowed** modifier
1177 * The **cl::Grouping** modifier is used to implement Unix-style tools (like
1178 ``ls``) that have lots of single letter arguments, but only require a single
1179 dash. For example, the '``ls -labF``' command actually enables four different
1180 options, all of which are single letters. Note that **cl::Grouping** options
1183 The CommandLine library does not restrict how you use the **cl::Prefix** or
1184 **cl::Grouping** modifiers, but it is possible to specify ambiguous argument
1185 settings. Thus, it is possible to have multiple letter options that are prefix
1186 or grouping options, and they will still work as designed.
1188 To do this, the CommandLine library uses a greedy algorithm to parse the input
1189 option into (potentially multiple) prefix and grouping options. The strategy
1190 basically looks like this:
1194 parse(string OrigInput) {
1196 1. string input = OrigInput;
1197 2. if (isOption(input)) return getOption(input).parse(); // Normal option
1198 3. while (!isOption(input) && !input.empty()) input.pop_back(); // Remove the last letter
1199 4. if (input.empty()) return error(); // No matching option
1200 5. if (getOption(input).isPrefix())
1201 return getOption(input).parse(input);
1202 6. while (!input.empty()) { // Must be grouping options
1203 getOption(input).parse();
1204 OrigInput.erase(OrigInput.begin(), OrigInput.begin()+input.length());
1206 while (!isOption(input) && !input.empty()) input.pop_back();
1208 7. if (!OrigInput.empty()) error();
1212 Miscellaneous option modifiers
1213 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1215 The miscellaneous option modifiers are the only flags where you can specify more
1216 than one flag from the set: they are not mutually exclusive. These flags
1217 specify boolean properties that modify the option.
1219 .. _cl::CommaSeparated:
1221 * The **cl::CommaSeparated** modifier indicates that any commas specified for an
1222 option's value should be used to split the value up into multiple values for
1223 the option. For example, these two options are equivalent when
1224 ``cl::CommaSeparated`` is specified: "``-foo=a -foo=b -foo=c``" and
1225 "``-foo=a,b,c``". This option only makes sense to be used in a case where the
1226 option is allowed to accept one or more values (i.e. it is a `cl::list`_
1229 .. _cl::PositionalEatsArgs:
1231 * The **cl::PositionalEatsArgs** modifier (which only applies to positional
1232 arguments, and only makes sense for lists) indicates that positional argument
1233 should consume any strings after it (including strings that start with a "-")
1234 up until another recognized positional argument. For example, if you have two
1235 "eating" positional arguments, "``pos1``" and "``pos2``", the string "``-pos1
1236 -foo -bar baz -pos2 -bork``" would cause the "``-foo -bar -baz``" strings to
1237 be applied to the "``-pos1``" option and the "``-bork``" string to be applied
1238 to the "``-pos2``" option.
1242 * The **cl::Sink** modifier is used to handle unknown options. If there is at
1243 least one option with ``cl::Sink`` modifier specified, the parser passes
1244 unrecognized option strings to it as values instead of signaling an error. As
1245 with ``cl::CommaSeparated``, this modifier only makes sense with a `cl::list`_
1248 So far, these are the only three miscellaneous option modifiers.
1255 Some systems, such as certain variants of Microsoft Windows and some older
1256 Unices have a relatively low limit on command-line length. It is therefore
1257 customary to use the so-called 'response files' to circumvent this
1258 restriction. These files are mentioned on the command-line (using the "@file")
1259 syntax. The program reads these files and inserts the contents into argv,
1260 thereby working around the command-line length limits. Response files are
1261 enabled by an optional fourth argument to `cl::ParseEnvironmentOptions`_ and
1262 `cl::ParseCommandLineOptions`_.
1264 Top-Level Classes and Functions
1265 -------------------------------
1267 Despite all of the built-in flexibility, the CommandLine option library really
1268 only consists of one function `cl::ParseCommandLineOptions`_) and three main
1269 classes: `cl::opt`_, `cl::list`_, and `cl::alias`_. This section describes
1270 these three classes in detail.
1272 .. _cl::getRegisteredOptions:
1274 The ``cl::getRegisteredOptions`` function
1275 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1277 The ``cl::getRegisteredOptions`` function is designed to give a programmer
1278 access to declared non positional command line options so that how they appear
1279 in ``-help`` can be modified prior to calling `cl::ParseCommandLineOptions`_.
1280 Note this method should not be called during any static initialisation because
1281 it cannot be guaranteed that all options will have been initialised. Hence it
1282 should be called from ``main``.
1284 This function can be used to gain access to options declared in libraries that
1285 the tool writter may not have direct access to.
1287 The function retrieves a :ref:`StringMap <dss_stringmap>` that maps the option
1288 string (e.g. ``-help``) to an ``Option*``.
1290 Here is an example of how the function could be used:
1294 using namespace llvm;
1295 int main(int argc, char **argv) {
1296 cl::OptionCategory AnotherCategory("Some options");
1298 StringMap<cl::Option*> Map;
1299 cl::getRegisteredOptions(Map);
1301 //Unhide useful option and put it in a different category
1302 assert(Map.count("print-all-options") > 0);
1303 Map["print-all-options"]->setHiddenFlag(cl::NotHidden);
1304 Map["print-all-options"]->setCategory(AnotherCategory);
1306 //Hide an option we don't want to see
1307 assert(Map.count("enable-no-infs-fp-math") > 0);
1308 Map["enable-no-infs-fp-math"]->setHiddenFlag(cl::Hidden);
1310 //Change --version to --show-version
1311 assert(Map.count("version") > 0);
1312 Map["version"]->setArgStr("show-version");
1314 //Change --help description
1315 assert(Map.count("help") > 0);
1316 Map["help"]->setDescription("Shows help");
1318 cl::ParseCommandLineOptions(argc, argv, "This is a small program to demo the LLVM CommandLine API");
1323 .. _cl::ParseCommandLineOptions:
1325 The ``cl::ParseCommandLineOptions`` function
1326 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1328 The ``cl::ParseCommandLineOptions`` function is designed to be called directly
1329 from ``main``, and is used to fill in the values of all of the command line
1330 option variables once ``argc`` and ``argv`` are available.
1332 The ``cl::ParseCommandLineOptions`` function requires two parameters (``argc``
1333 and ``argv``), but may also take an optional third parameter which holds
1334 `additional extra text`_ to emit when the ``-help`` option is invoked, and a
1335 fourth boolean parameter that enables `response files`_.
1337 .. _cl::ParseEnvironmentOptions:
1339 The ``cl::ParseEnvironmentOptions`` function
1340 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1342 The ``cl::ParseEnvironmentOptions`` function has mostly the same effects as
1343 `cl::ParseCommandLineOptions`_, except that it is designed to take values for
1344 options from an environment variable, for those cases in which reading the
1345 command line is not convenient or desired. It fills in the values of all the
1346 command line option variables just like `cl::ParseCommandLineOptions`_ does.
1348 It takes four parameters: the name of the program (since ``argv`` may not be
1349 available, it can't just look in ``argv[0]``), the name of the environment
1350 variable to examine, the optional `additional extra text`_ to emit when the
1351 ``-help`` option is invoked, and the boolean switch that controls whether
1352 `response files`_ should be read.
1354 ``cl::ParseEnvironmentOptions`` will break the environment variable's value up
1355 into words and then process them using `cl::ParseCommandLineOptions`_.
1356 **Note:** Currently ``cl::ParseEnvironmentOptions`` does not support quoting, so
1357 an environment variable containing ``-option "foo bar"`` will be parsed as three
1358 words, ``-option``, ``"foo``, and ``bar"``, which is different from what you
1359 would get from the shell with the same input.
1361 The ``cl::SetVersionPrinter`` function
1362 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1364 The ``cl::SetVersionPrinter`` function is designed to be called directly from
1365 ``main`` and *before* ``cl::ParseCommandLineOptions``. Its use is optional. It
1366 simply arranges for a function to be called in response to the ``--version``
1367 option instead of having the ``CommandLine`` library print out the usual version
1368 string for LLVM. This is useful for programs that are not part of LLVM but wish
1369 to use the ``CommandLine`` facilities. Such programs should just define a small
1370 function that takes no arguments and returns ``void`` and that prints out
1371 whatever version information is appropriate for the program. Pass the address of
1372 that function to ``cl::SetVersionPrinter`` to arrange for it to be called when
1373 the ``--version`` option is given by the user.
1378 The ``cl::opt`` class
1379 ^^^^^^^^^^^^^^^^^^^^^
1381 The ``cl::opt`` class is the class used to represent scalar command line
1382 options, and is the one used most of the time. It is a templated class which
1383 can take up to three arguments (all except for the first have default values
1389 template <class DataType, bool ExternalStorage = false,
1390 class ParserClass = parser<DataType> >
1394 The first template argument specifies what underlying data type the command line
1395 argument is, and is used to select a default parser implementation. The second
1396 template argument is used to specify whether the option should contain the
1397 storage for the option (the default) or whether external storage should be used
1398 to contain the value parsed for the option (see `Internal vs External Storage`_
1399 for more information).
1401 The third template argument specifies which parser to use. The default value
1402 selects an instantiation of the ``parser`` class based on the underlying data
1403 type of the option. In general, this default works well for most applications,
1404 so this option is only used when using a `custom parser`_.
1406 .. _lists of arguments:
1409 The ``cl::list`` class
1410 ^^^^^^^^^^^^^^^^^^^^^^
1412 The ``cl::list`` class is the class used to represent a list of command line
1413 options. It too is a templated class which can take up to three arguments:
1418 template <class DataType, class Storage = bool,
1419 class ParserClass = parser<DataType> >
1423 This class works the exact same as the `cl::opt`_ class, except that the second
1424 argument is the **type** of the external storage, not a boolean value. For this
1425 class, the marker type '``bool``' is used to indicate that internal storage
1430 The ``cl::bits`` class
1431 ^^^^^^^^^^^^^^^^^^^^^^
1433 The ``cl::bits`` class is the class used to represent a list of command line
1434 options in the form of a bit vector. It is also a templated class which can
1435 take up to three arguments:
1440 template <class DataType, class Storage = bool,
1441 class ParserClass = parser<DataType> >
1445 This class works the exact same as the `cl::list`_ class, except that the second
1446 argument must be of **type** ``unsigned`` if external storage is used.
1450 The ``cl::alias`` class
1451 ^^^^^^^^^^^^^^^^^^^^^^^
1453 The ``cl::alias`` class is a nontemplated class that is used to form aliases for
1462 The `cl::aliasopt`_ attribute should be used to specify which option this is an
1463 alias for. Alias arguments default to being `cl::Hidden`_, and use the aliased
1464 options parser to do the conversion from string to data.
1468 The ``cl::extrahelp`` class
1469 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1471 The ``cl::extrahelp`` class is a nontemplated class that allows extra help text
1472 to be printed out for the ``-help`` option.
1480 To use the extrahelp, simply construct one with a ``const char*`` parameter to
1481 the constructor. The text passed to the constructor will be printed at the
1482 bottom of the help message, verbatim. Note that multiple ``cl::extrahelp``
1483 **can** be used, but this practice is discouraged. If your tool needs to print
1484 additional help information, put all that help into a single ``cl::extrahelp``
1491 cl::extrahelp("\nADDITIONAL HELP:\n\n This is the extra help\n");
1493 .. _cl::OptionCategory:
1495 The ``cl::OptionCategory`` class
1496 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1498 The ``cl::OptionCategory`` class is a simple class for declaring
1504 class OptionCategory;
1507 An option category must have a name and optionally a description which are
1508 passed to the constructor as ``const char*``.
1510 Note that declaring an option category and associating it with an option before
1511 parsing options (e.g. statically) will change the output of ``-help`` from
1512 uncategorized to categorized. If an option category is declared but not
1513 associated with an option then it will be hidden from the output of ``-help``
1514 but will be shown in the output of ``-help-hidden``.
1516 .. _different parser:
1517 .. _discussed previously:
1522 Parsers control how the string value taken from the command line is translated
1523 into a typed value, suitable for use in a C++ program. By default, the
1524 CommandLine library uses an instance of ``parser<type>`` if the command line
1525 option specifies that it uses values of type '``type``'. Because of this,
1526 custom option processing is specified with specializations of the '``parser``'
1529 The CommandLine library provides the following builtin parser specializations,
1530 which are sufficient for most applications. It can, however, also be extended to
1531 work with new data types and new ways of interpreting the same data. See the
1532 `Writing a Custom Parser`_ for more details on this type of library extension.
1537 * The generic ``parser<t>`` parser can be used to map strings values to any data
1538 type, through the use of the `cl::values`_ property, which specifies the
1539 mapping information. The most common use of this parser is for parsing enum
1540 values, which allows you to use the CommandLine library for all of the error
1541 checking to make sure that only valid enum values are specified (as opposed to
1542 accepting arbitrary strings). Despite this, however, the generic parser class
1543 can be used for any data type.
1548 * The **parser<bool> specialization** is used to convert boolean strings to a
1549 boolean value. Currently accepted strings are "``true``", "``TRUE``",
1550 "``True``", "``1``", "``false``", "``FALSE``", "``False``", and "``0``".
1552 * The **parser<boolOrDefault> specialization** is used for cases where the value
1553 is boolean, but we also need to know whether the option was specified at all.
1554 boolOrDefault is an enum with 3 values, BOU_UNSET, BOU_TRUE and BOU_FALSE.
1555 This parser accepts the same strings as **``parser<bool>``**.
1559 * The **parser<string> specialization** simply stores the parsed string into the
1560 string value specified. No conversion or modification of the data is
1566 * The **parser<int> specialization** uses the C ``strtol`` function to parse the
1567 string input. As such, it will accept a decimal number (with an optional '+'
1568 or '-' prefix) which must start with a non-zero digit. It accepts octal
1569 numbers, which are identified with a '``0``' prefix digit, and hexadecimal
1570 numbers with a prefix of '``0x``' or '``0X``'.
1576 * The **parser<double>** and **parser<float> specializations** use the standard
1577 C ``strtod`` function to convert floating point strings into floating point
1578 values. As such, a broad range of string formats is supported, including
1579 exponential notation (ex: ``1.7e15``) and properly supports locales.
1581 .. _Extension Guide:
1582 .. _extending the library:
1587 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.
1594 .. _Writing a Custom Parser:
1596 Writing a custom parser
1597 -----------------------
1599 One of the simplest and most common extensions is the use of a custom parser.
1600 As `discussed previously`_, parsers are the portion of the CommandLine library
1601 that turns string input from the user into a particular parsed data type,
1602 validating the input in the process.
1604 There are two ways to use a new parser:
1606 #. Specialize the `cl::parser`_ template for your custom data type.
1608 This approach has the advantage that users of your custom data type will
1609 automatically use your custom parser whenever they define an option with a
1610 value type of your data type. The disadvantage of this approach is that it
1611 doesn't work if your fundamental data type is something that is already
1614 #. Write an independent class, using it explicitly from options that need it.
1616 This approach works well in situations where you would line to parse an
1617 option using special syntax for a not-very-special data-type. The drawback
1618 of this approach is that users of your parser have to be aware that they are
1619 using your parser instead of the builtin ones.
1621 To guide the discussion, we will discuss a custom parser that accepts file
1622 sizes, specified with an optional unit after the numeric size. For example, we
1623 would like to parse "102kb", "41M", "1G" into the appropriate integer value. In
1624 this case, the underlying data type we want to parse into is '``unsigned``'. We
1625 choose approach #2 above because we don't want to make this the default for all
1626 ``unsigned`` options.
1628 To start out, we declare our new ``FileSizeParser`` class:
1632 struct FileSizeParser : public cl::basic_parser<unsigned> {
1633 // parse - Return true on error.
1634 bool parse(cl::Option &O, const char *ArgName, const std::string &ArgValue,
1638 Our new class inherits from the ``cl::basic_parser`` template class to fill in
1639 the default, boiler plate code for us. We give it the data type that we parse
1640 into, the last argument to the ``parse`` method, so that clients of our custom
1641 parser know what object type to pass in to the parse method. (Here we declare
1642 that we parse into '``unsigned``' variables.)
1644 For most purposes, the only method that must be implemented in a custom parser
1645 is the ``parse`` method. The ``parse`` method is called whenever the option is
1646 invoked, passing in the option itself, the option name, the string to parse, and
1647 a reference to a return value. If the string to parse is not well-formed, the
1648 parser should output an error message and return true. Otherwise it should
1649 return false and set '``Val``' to the parsed value. In our example, we
1650 implement ``parse`` as:
1654 bool FileSizeParser::parse(cl::Option &O, const char *ArgName,
1655 const std::string &Arg, unsigned &Val) {
1656 const char *ArgStart = Arg.c_str();
1659 // Parse integer part, leaving 'End' pointing to the first non-integer char
1660 Val = (unsigned)strtol(ArgStart, &End, 0);
1664 case 0: return false; // No error
1665 case 'i': // Ignore the 'i' in KiB if people use that
1666 case 'b': case 'B': // Ignore B suffix
1669 case 'g': case 'G': Val *= 1024*1024*1024; break;
1670 case 'm': case 'M': Val *= 1024*1024; break;
1671 case 'k': case 'K': Val *= 1024; break;
1674 // Print an error message if unrecognized character!
1675 return O.error("'" + Arg + "' value invalid for file size argument!");
1680 This function implements a very simple parser for the kinds of strings we are
1681 interested in. Although it has some holes (it allows "``123KKK``" for example),
1682 it is good enough for this example. Note that we use the option itself to print
1683 out the error message (the ``error`` method always returns true) in order to get
1684 a nice error message (shown below). Now that we have our parser class, we can
1689 static cl::opt<unsigned, false, FileSizeParser>
1690 MFS("max-file-size", cl::desc("Maximum file size to accept"),
1691 cl::value_desc("size"));
1693 Which adds this to the output of our program:
1698 -help - display available options (-help-hidden for more)
1700 -max-file-size=<size> - Maximum file size to accept
1702 And we can test that our parse works correctly now (the test program just prints
1703 out the max-file-size argument value):
1709 $ ./test -max-file-size=123MB
1711 $ ./test -max-file-size=3G
1713 $ ./test -max-file-size=dog
1714 -max-file-size option: 'dog' value invalid for file size argument!
1716 It looks like it works. The error message that we get is nice and helpful, and
1717 we seem to accept reasonable file sizes. This wraps up the "custom parser"
1720 Exploiting external storage
1721 ---------------------------
1723 Several of the LLVM libraries define static ``cl::opt`` instances that will
1724 automatically be included in any program that links with that library. This is
1725 a feature. However, sometimes it is necessary to know the value of the command
1726 line option outside of the library. In these cases the library does or should
1727 provide an external storage location that is accessible to users of the
1728 library. Examples of this include the ``llvm::DebugFlag`` exported by the
1729 ``lib/Support/Debug.cpp`` file and the ``llvm::TimePassesIsEnabled`` flag
1730 exported by the ``lib/VMCore/PassManager.cpp`` file.
1734 TODO: complete this section
1736 .. _dynamically loaded options:
1738 Dynamically adding command line options
1742 TODO: fill in this section