1 //===- llvm/Support/CommandLine.h - Command line handler --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This class implements a command line argument processor that is useful when
11 // creating a tool. It provides a simple, minimalistic interface that is easily
12 // extensible and supports nonlocal (library) command line options.
14 // Note that rather than trying to figure out what this code does, you should
15 // read the library documentation located in docs/CommandLine.html or looks at
16 // the many example usages in tools/*/*.cpp
18 //===----------------------------------------------------------------------===//
20 #ifndef LLVM_SUPPORT_COMMANDLINE_H
21 #define LLVM_SUPPORT_COMMANDLINE_H
23 #include "llvm/Support/type_traits.h"
24 #include "llvm/Support/DataTypes.h"
25 #include "llvm/Support/Compiler.h"
26 #include "llvm/ADT/SmallVector.h"
35 /// cl Namespace - This namespace contains all of the command line option
36 /// processing machinery. It is intentionally a short name to make qualified
40 //===----------------------------------------------------------------------===//
41 // ParseCommandLineOptions - Command line option processing entry point.
43 void ParseCommandLineOptions(int argc, char **argv,
44 const char *Overview = 0,
45 bool ReadResponseFiles = false);
47 //===----------------------------------------------------------------------===//
48 // ParseEnvironmentOptions - Environment variable option processing alternate
51 void ParseEnvironmentOptions(const char *progName, const char *envvar,
52 const char *Overview = 0,
53 bool ReadResponseFiles = false);
55 ///===---------------------------------------------------------------------===//
56 /// SetVersionPrinter - Override the default (LLVM specific) version printer
57 /// used to print out the version when --version is given
58 /// on the command line. This allows other systems using the
59 /// CommandLine utilities to print their own version string.
60 void SetVersionPrinter(void (*func)());
63 // MarkOptionsChanged - Internal helper function.
64 void MarkOptionsChanged();
66 //===----------------------------------------------------------------------===//
67 // Flags permitted to be passed to command line arguments
70 enum NumOccurrences { // Flags for the number of occurrences allowed
71 Optional = 0x01, // Zero or One occurrence
72 ZeroOrMore = 0x02, // Zero or more occurrences allowed
73 Required = 0x03, // One occurrence required
74 OneOrMore = 0x04, // One or more occurrences required
76 // ConsumeAfter - Indicates that this option is fed anything that follows the
77 // last positional argument required by the application (it is an error if
78 // there are zero positional arguments, and a ConsumeAfter option is used).
79 // Thus, for example, all arguments to LLI are processed until a filename is
80 // found. Once a filename is found, all of the succeeding arguments are
81 // passed, unprocessed, to the ConsumeAfter option.
85 OccurrencesMask = 0x07
88 enum ValueExpected { // Is a value required for the option?
89 ValueOptional = 0x08, // The value can appear... or not
90 ValueRequired = 0x10, // The value is required to appear!
91 ValueDisallowed = 0x18, // A value may not be specified (for flags)
95 enum OptionHidden { // Control whether -help shows this option
96 NotHidden = 0x20, // Option included in --help & --help-hidden
97 Hidden = 0x40, // -help doesn't, but --help-hidden does
98 ReallyHidden = 0x60, // Neither --help nor --help-hidden show this arg
102 // Formatting flags - This controls special features that the option might have
103 // that cause it to be parsed differently...
105 // Prefix - This option allows arguments that are otherwise unrecognized to be
106 // matched by options that are a prefix of the actual value. This is useful for
107 // cases like a linker, where options are typically of the form '-lfoo' or
108 // '-L../../include' where -l or -L are the actual flags. When prefix is
109 // enabled, and used, the value for the flag comes from the suffix of the
112 // Grouping - With this option enabled, multiple letter options are allowed to
113 // bunch together with only a single hyphen for the whole group. This allows
114 // emulation of the behavior that ls uses for example: ls -la === ls -l -a
117 enum FormattingFlags {
118 NormalFormatting = 0x000, // Nothing special
119 Positional = 0x080, // Is a positional argument, no '-' required
120 Prefix = 0x100, // Can this option directly prefix its value?
121 Grouping = 0x180, // Can this option group with other options?
122 FormattingMask = 0x180 // Union of the above flags.
125 enum MiscFlags { // Miscellaneous flags to adjust argument
126 CommaSeparated = 0x200, // Should this cl::list split between commas?
127 PositionalEatsArgs = 0x400, // Should this positional cl::list eat -args?
128 Sink = 0x800, // Should this cl::list eat all unknown options?
129 AllowInverse = 0x1000, // Can this option take a -Xno- form?
130 MiscMask = 0x1E00 // Union of the above flags.
135 //===----------------------------------------------------------------------===//
142 // handleOccurrences - Overriden by subclasses to handle the value passed into
143 // an argument. Should return true if there was an error processing the
144 // argument and the program should exit.
146 virtual bool handleOccurrence(unsigned pos, const char *ArgName,
147 const std::string &Arg) = 0;
149 virtual enum ValueExpected getValueExpectedFlagDefault() const {
150 return ValueOptional;
153 // Out of line virtual function to provide home for the class.
154 virtual void anchor();
156 int NumOccurrences; // The number of times specified
157 int Flags; // Flags for the argument
158 unsigned Position; // Position of last occurrence of the option
159 unsigned AdditionalVals;// Greater than 0 for multi-valued option.
160 Option *NextRegistered; // Singly linked list of registered options.
162 const char *ArgStr; // The argument string itself (ex: "help", "o")
163 const char *HelpStr; // The descriptive text message for --help
164 const char *ValueStr; // String describing what the value of this option is
166 inline enum NumOccurrences getNumOccurrencesFlag() const {
167 return static_cast<enum NumOccurrences>(Flags & OccurrencesMask);
169 inline enum ValueExpected getValueExpectedFlag() const {
170 int VE = Flags & ValueMask;
171 return VE ? static_cast<enum ValueExpected>(VE)
172 : getValueExpectedFlagDefault();
174 inline enum OptionHidden getOptionHiddenFlag() const {
175 return static_cast<enum OptionHidden>(Flags & HiddenMask);
177 inline enum FormattingFlags getFormattingFlag() const {
178 return static_cast<enum FormattingFlags>(Flags & FormattingMask);
180 inline unsigned getMiscFlags() const {
181 return Flags & MiscMask;
183 inline unsigned getPosition() const { return Position; }
184 inline unsigned getNumAdditionalVals() const { return AdditionalVals; }
186 // hasArgStr - Return true if the argstr != ""
187 bool hasArgStr() const { return ArgStr[0] != 0; }
189 //-------------------------------------------------------------------------===
190 // Accessor functions set by OptionModifiers
192 void setArgStr(const char *S) { ArgStr = S; }
193 void setDescription(const char *S) { HelpStr = S; }
194 void setValueStr(const char *S) { ValueStr = S; }
196 void setFlag(unsigned Flag, unsigned FlagMask) {
201 void setNumOccurrencesFlag(enum NumOccurrences Val) {
202 setFlag(Val, OccurrencesMask);
204 void setValueExpectedFlag(enum ValueExpected Val) { setFlag(Val, ValueMask); }
205 void setHiddenFlag(enum OptionHidden Val) { setFlag(Val, HiddenMask); }
206 void setFormattingFlag(enum FormattingFlags V) { setFlag(V, FormattingMask); }
207 void setMiscFlag(enum MiscFlags M) { setFlag(M, M); }
208 void setPosition(unsigned pos) { Position = pos; }
210 explicit Option(unsigned DefaultFlags)
211 : NumOccurrences(0), Flags(DefaultFlags | NormalFormatting), Position(0),
212 AdditionalVals(0), NextRegistered(0),
213 ArgStr(""), HelpStr(""), ValueStr("") {
214 assert(getNumOccurrencesFlag() != 0 &&
215 getOptionHiddenFlag() != 0 && "Not all default flags specified!");
218 inline void setNumAdditionalVals(unsigned n)
219 { AdditionalVals = n; }
221 // addArgument - Register this argument with the commandline system.
225 Option *getNextRegisteredOption() const { return NextRegistered; }
227 // Return the width of the option tag for printing...
228 virtual size_t getOptionWidth() const = 0;
230 // printOptionInfo - Print out information about this option. The
231 // to-be-maintained width is specified.
233 virtual void printOptionInfo(size_t GlobalWidth) const = 0;
235 virtual void getExtraOptionNames(std::vector<const char*> &) {}
237 // addOccurrence - Wrapper around handleOccurrence that enforces Flags
239 bool addOccurrence(unsigned pos, const char *ArgName,
240 const std::string &Value, bool MultiArg = false);
242 // Prints option name followed by message. Always returns true.
243 bool error(std::string Message, const char *ArgName = 0);
246 inline int getNumOccurrences() const { return NumOccurrences; }
251 //===----------------------------------------------------------------------===//
252 // Command line option modifiers that can be used to modify the behavior of
253 // command line option parsers...
256 // desc - Modifier to set the description shown in the --help output...
259 desc(const char *Str) : Desc(Str) {}
260 void apply(Option &O) const { O.setDescription(Desc); }
263 // value_desc - Modifier to set the value description shown in the --help
267 value_desc(const char *Str) : Desc(Str) {}
268 void apply(Option &O) const { O.setValueStr(Desc); }
271 // init - Specify a default (initial) value for the command line argument, if
272 // the default constructor for the argument type does not give you what you
273 // want. This is only valid on "opt" arguments, not on "list" arguments.
278 initializer(const Ty &Val) : Init(Val) {}
281 void apply(Opt &O) const { O.setInitialValue(Init); }
285 initializer<Ty> init(const Ty &Val) {
286 return initializer<Ty>(Val);
290 // location - Allow the user to specify which external variable they want to
291 // store the results of the command line argument processing into, if they don't
292 // want to store it in the option itself.
295 struct LocationClass {
297 LocationClass(Ty &L) : Loc(L) {}
300 void apply(Opt &O) const { O.setLocation(O, Loc); }
304 LocationClass<Ty> location(Ty &L) { return LocationClass<Ty>(L); }
307 //===----------------------------------------------------------------------===//
308 // Enum valued command line option
310 #define clEnumVal(ENUMVAL, DESC) #ENUMVAL, int(ENUMVAL), DESC
311 #define clEnumValN(ENUMVAL, FLAGNAME, DESC) FLAGNAME, int(ENUMVAL), DESC
312 #define clEnumValEnd (reinterpret_cast<void*>(0))
314 // values - For custom data types, allow specifying a group of values together
315 // as the values that go into the mapping that the option handler uses. Note
316 // that the values list must always have a 0 at the end of the list to indicate
317 // that the list has ended.
319 template<class DataType>
321 // Use a vector instead of a map, because the lists should be short,
322 // the overhead is less, and most importantly, it keeps them in the order
323 // inserted so we can print our option out nicely.
324 SmallVector<std::pair<const char *, std::pair<int, const char *> >,4> Values;
325 void processValues(va_list Vals);
327 ValuesClass(const char *EnumName, DataType Val, const char *Desc,
329 // Insert the first value, which is required.
330 Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc)));
332 // Process the varargs portion of the values...
333 while (const char *enumName = va_arg(ValueArgs, const char *)) {
334 DataType EnumVal = static_cast<DataType>(va_arg(ValueArgs, int));
335 const char *EnumDesc = va_arg(ValueArgs, const char *);
336 Values.push_back(std::make_pair(enumName, // Add value to value map
337 std::make_pair(EnumVal, EnumDesc)));
342 void apply(Opt &O) const {
343 for (unsigned i = 0, e = static_cast<unsigned>(Values.size());
345 O.getParser().addLiteralOption(Values[i].first, Values[i].second.first,
346 Values[i].second.second);
350 template<class DataType>
351 ValuesClass<DataType> END_WITH_NULL values(const char *Arg, DataType Val,
352 const char *Desc, ...) {
354 va_start(ValueArgs, Desc);
355 ValuesClass<DataType> Vals(Arg, Val, Desc, ValueArgs);
361 //===----------------------------------------------------------------------===//
362 // parser class - Parameterizable parser for different data types. By default,
363 // known data types (string, int, bool) have specialized parsers, that do what
364 // you would expect. The default parser, used for data types that are not
365 // built-in, uses a mapping table to map specific options to values, which is
366 // used, among other things, to handle enum types.
368 //--------------------------------------------------
369 // generic_parser_base - This class holds all the non-generic code that we do
370 // not need replicated for every instance of the generic parser. This also
371 // allows us to put stuff into CommandLine.cpp
373 struct generic_parser_base {
374 virtual ~generic_parser_base() {} // Base class should have virtual-dtor
376 // getNumOptions - Virtual function implemented by generic subclass to
377 // indicate how many entries are in Values.
379 virtual unsigned getNumOptions() const = 0;
381 // getOption - Return option name N.
382 virtual const char *getOption(unsigned N) const = 0;
384 // getDescription - Return description N
385 virtual const char *getDescription(unsigned N) const = 0;
387 // Return the width of the option tag for printing...
388 virtual size_t getOptionWidth(const Option &O) const;
390 // printOptionInfo - Print out information about this option. The
391 // to-be-maintained width is specified.
393 virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const;
395 void initialize(Option &O) {
396 // All of the modifiers for the option have been processed by now, so the
397 // argstr field should be stable, copy it down now.
399 hasArgStr = O.hasArgStr();
402 void getExtraOptionNames(std::vector<const char*> &OptionNames) {
403 // If there has been no argstr specified, that means that we need to add an
404 // argument for every possible option. This ensures that our options are
407 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
408 OptionNames.push_back(getOption(i));
412 enum ValueExpected getValueExpectedFlagDefault() const {
413 // If there is an ArgStr specified, then we are of the form:
415 // -opt=O2 or -opt O2 or -optO2
417 // In which case, the value is required. Otherwise if an arg str has not
418 // been specified, we are of the form:
420 // -O2 or O2 or -la (where -l and -a are separate options)
422 // If this is the case, we cannot allow a value.
425 return ValueRequired;
427 return ValueDisallowed;
430 // findOption - Return the option number corresponding to the specified
431 // argument string. If the option is not found, getNumOptions() is returned.
433 unsigned findOption(const char *Name);
439 // Default parser implementation - This implementation depends on having a
440 // mapping of recognized options to values of some sort. In addition to this,
441 // each entry in the mapping also tracks a help message that is printed with the
442 // command line option for --help. Because this is a simple mapping parser, the
443 // data type can be any unsupported type.
445 template <class DataType>
446 class parser : public generic_parser_base {
448 SmallVector<std::pair<const char *,
449 std::pair<DataType, const char *> >, 8> Values;
451 typedef DataType parser_data_type;
453 // Implement virtual functions needed by generic_parser_base
454 unsigned getNumOptions() const { return unsigned(Values.size()); }
455 const char *getOption(unsigned N) const { return Values[N].first; }
456 const char *getDescription(unsigned N) const {
457 return Values[N].second.second;
460 // parse - Return true on error.
461 bool parse(Option &O, const char *ArgName, const std::string &Arg,
469 for (unsigned i = 0, e = static_cast<unsigned>(Values.size());
471 if (ArgVal == Values[i].first) {
472 V = Values[i].second.first;
476 return O.error(": Cannot find option named '" + ArgVal + "'!");
479 /// addLiteralOption - Add an entry to the mapping table.
482 void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) {
483 assert(findOption(Name) == Values.size() && "Option already exists!");
484 Values.push_back(std::make_pair(Name,
485 std::make_pair(static_cast<DataType>(V),HelpStr)));
486 MarkOptionsChanged();
489 /// removeLiteralOption - Remove the specified option.
491 void removeLiteralOption(const char *Name) {
492 unsigned N = findOption(Name);
493 assert(N != Values.size() && "Option not found!");
494 Values.erase(Values.begin()+N);
498 //--------------------------------------------------
499 // basic_parser - Super class of parsers to provide boilerplate code
501 struct basic_parser_impl { // non-template implementation of basic_parser<t>
502 virtual ~basic_parser_impl() {}
504 enum ValueExpected getValueExpectedFlagDefault() const {
505 return ValueRequired;
508 void getExtraOptionNames(std::vector<const char*> &) {}
510 void initialize(Option &) {}
512 // Return the width of the option tag for printing...
513 size_t getOptionWidth(const Option &O) const;
515 // printOptionInfo - Print out information about this option. The
516 // to-be-maintained width is specified.
518 void printOptionInfo(const Option &O, size_t GlobalWidth) const;
520 // getValueName - Overload in subclass to provide a better default value.
521 virtual const char *getValueName() const { return "value"; }
523 // An out-of-line virtual method to provide a 'home' for this class.
524 virtual void anchor();
527 // basic_parser - The real basic parser is just a template wrapper that provides
528 // a typedef for the provided data type.
530 template<class DataType>
531 struct basic_parser : public basic_parser_impl {
532 typedef DataType parser_data_type;
535 //--------------------------------------------------
539 class parser<bool> : public basic_parser<bool> {
540 bool IsInvertable; // Should we synthezise a -xno- style option?
543 void getExtraOptionNames(std::vector<const char*> &OptionNames) {
545 char *s = new char [strlen(ArgStr) + 3 + 1];
550 strcpy(&s[4], ArgStr+1);
551 OptionNames.push_back(s);
555 // parse - Return true on error.
556 bool parse(Option &O, const char *ArgName, const std::string &Arg, bool &Val);
559 void initialize(Opt &O) {
560 if (O.getMiscFlags() & llvm::cl::AllowInverse)
563 IsInvertable = false;
567 enum ValueExpected getValueExpectedFlagDefault() const {
568 return ValueOptional;
571 // getValueName - Do not print =<value> at all.
572 virtual const char *getValueName() const { return 0; }
574 // An out-of-line virtual method to provide a 'home' for this class.
575 virtual void anchor();
578 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
580 //--------------------------------------------------
581 // parser<boolOrDefault>
582 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
584 class parser<boolOrDefault> : public basic_parser<boolOrDefault> {
586 // parse - Return true on error.
587 bool parse(Option &O, const char *ArgName, const std::string &Arg,
590 enum ValueExpected getValueExpectedFlagDefault() const {
591 return ValueOptional;
594 // getValueName - Do not print =<value> at all.
595 virtual const char *getValueName() const { return 0; }
597 // An out-of-line virtual method to provide a 'home' for this class.
598 virtual void anchor();
601 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
603 //--------------------------------------------------
607 class parser<int> : public basic_parser<int> {
609 // parse - Return true on error.
610 bool parse(Option &O, const char *ArgName, const std::string &Arg, int &Val);
612 // getValueName - Overload in subclass to provide a better default value.
613 virtual const char *getValueName() const { return "int"; }
615 // An out-of-line virtual method to provide a 'home' for this class.
616 virtual void anchor();
619 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
622 //--------------------------------------------------
626 class parser<unsigned> : public basic_parser<unsigned> {
628 // parse - Return true on error.
629 bool parse(Option &O, const char *AN, const std::string &Arg, unsigned &Val);
631 // getValueName - Overload in subclass to provide a better default value.
632 virtual const char *getValueName() const { return "uint"; }
634 // An out-of-line virtual method to provide a 'home' for this class.
635 virtual void anchor();
638 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
640 //--------------------------------------------------
644 class parser<double> : public basic_parser<double> {
646 // parse - Return true on error.
647 bool parse(Option &O, const char *AN, const std::string &Arg, double &Val);
649 // getValueName - Overload in subclass to provide a better default value.
650 virtual const char *getValueName() const { return "number"; }
652 // An out-of-line virtual method to provide a 'home' for this class.
653 virtual void anchor();
656 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
658 //--------------------------------------------------
662 class parser<float> : public basic_parser<float> {
664 // parse - Return true on error.
665 bool parse(Option &O, const char *AN, const std::string &Arg, float &Val);
667 // getValueName - Overload in subclass to provide a better default value.
668 virtual const char *getValueName() const { return "number"; }
670 // An out-of-line virtual method to provide a 'home' for this class.
671 virtual void anchor();
674 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
676 //--------------------------------------------------
677 // parser<std::string>
680 class parser<std::string> : public basic_parser<std::string> {
682 // parse - Return true on error.
683 bool parse(Option &, const char *, const std::string &Arg,
684 std::string &Value) {
689 // getValueName - Overload in subclass to provide a better default value.
690 virtual const char *getValueName() const { return "string"; }
692 // An out-of-line virtual method to provide a 'home' for this class.
693 virtual void anchor();
696 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
698 //===----------------------------------------------------------------------===//
699 // applicator class - This class is used because we must use partial
700 // specialization to handle literal string arguments specially (const char* does
701 // not correctly respond to the apply method). Because the syntax to use this
702 // is a pain, we have the 'apply' method below to handle the nastiness...
704 template<class Mod> struct applicator {
706 static void opt(const Mod &M, Opt &O) { M.apply(O); }
709 // Handle const char* as a special case...
710 template<unsigned n> struct applicator<char[n]> {
712 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
714 template<unsigned n> struct applicator<const char[n]> {
716 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
718 template<> struct applicator<const char*> {
720 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
723 template<> struct applicator<NumOccurrences> {
724 static void opt(NumOccurrences NO, Option &O) { O.setNumOccurrencesFlag(NO); }
726 template<> struct applicator<ValueExpected> {
727 static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
729 template<> struct applicator<OptionHidden> {
730 static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
732 template<> struct applicator<FormattingFlags> {
733 static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
735 template<> struct applicator<MiscFlags> {
736 static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
739 // apply method - Apply a modifier to an option in a type safe way.
740 template<class Mod, class Opt>
741 void apply(const Mod &M, Opt *O) {
742 applicator<Mod>::opt(M, *O);
746 //===----------------------------------------------------------------------===//
749 // Default storage class definition: external storage. This implementation
750 // assumes the user will specify a variable to store the data into with the
751 // cl::location(x) modifier.
753 template<class DataType, bool ExternalStorage, bool isClass>
755 DataType *Location; // Where to store the object...
758 assert(Location != 0 && "cl::location(...) not specified for a command "
759 "line option with external storage, "
760 "or cl::init specified before cl::location()!!");
763 opt_storage() : Location(0) {}
765 bool setLocation(Option &O, DataType &L) {
767 return O.error(": cl::location(x) specified more than once!");
773 void setValue(const T &V) {
778 DataType &getValue() { check(); return *Location; }
779 const DataType &getValue() const { check(); return *Location; }
783 // Define how to hold a class type object, such as a string. Since we can
784 // inherit from a class, we do so. This makes us exactly compatible with the
785 // object in all cases that it is used.
787 template<class DataType>
788 class opt_storage<DataType,false,true> : public DataType {
791 void setValue(const T &V) { DataType::operator=(V); }
793 DataType &getValue() { return *this; }
794 const DataType &getValue() const { return *this; }
797 // Define a partial specialization to handle things we cannot inherit from. In
798 // this case, we store an instance through containment, and overload operators
799 // to get at the value.
801 template<class DataType>
802 class opt_storage<DataType, false, false> {
806 // Make sure we initialize the value with the default constructor for the
808 opt_storage() : Value(DataType()) {}
811 void setValue(const T &V) { Value = V; }
812 DataType &getValue() { return Value; }
813 DataType getValue() const { return Value; }
815 // If the datatype is a pointer, support -> on it.
816 DataType operator->() const { return Value; }
820 //===----------------------------------------------------------------------===//
821 // opt - A scalar command line option.
823 template <class DataType, bool ExternalStorage = false,
824 class ParserClass = parser<DataType> >
825 class opt : public Option,
826 public opt_storage<DataType, ExternalStorage,
827 is_class<DataType>::value> {
830 virtual bool handleOccurrence(unsigned pos, const char *ArgName,
831 const std::string &Arg) {
832 typename ParserClass::parser_data_type Val =
833 typename ParserClass::parser_data_type();
834 if (Parser.parse(*this, ArgName, Arg, Val))
835 return true; // Parse error!
841 virtual enum ValueExpected getValueExpectedFlagDefault() const {
842 return Parser.getValueExpectedFlagDefault();
844 virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
845 return Parser.getExtraOptionNames(OptionNames);
848 // Forward printing stuff to the parser...
849 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
850 virtual void printOptionInfo(size_t GlobalWidth) const {
851 Parser.printOptionInfo(*this, GlobalWidth);
856 Parser.initialize(*this);
859 // setInitialValue - Used by the cl::init modifier...
860 void setInitialValue(const DataType &V) { this->setValue(V); }
862 ParserClass &getParser() { return Parser; }
864 operator DataType() const { return this->getValue(); }
867 DataType &operator=(const T &Val) {
869 return this->getValue();
874 explicit opt(const M0t &M0) : Option(Optional | NotHidden) {
880 template<class M0t, class M1t>
881 opt(const M0t &M0, const M1t &M1) : Option(Optional | NotHidden) {
882 apply(M0, this); apply(M1, this);
887 template<class M0t, class M1t, class M2t>
888 opt(const M0t &M0, const M1t &M1,
889 const M2t &M2) : Option(Optional | NotHidden) {
890 apply(M0, this); apply(M1, this); apply(M2, this);
894 template<class M0t, class M1t, class M2t, class M3t>
895 opt(const M0t &M0, const M1t &M1, const M2t &M2,
896 const M3t &M3) : Option(Optional | NotHidden) {
897 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
901 template<class M0t, class M1t, class M2t, class M3t, class M4t>
902 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
903 const M4t &M4) : Option(Optional | NotHidden) {
904 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
909 template<class M0t, class M1t, class M2t, class M3t,
910 class M4t, class M5t>
911 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
912 const M4t &M4, const M5t &M5) : Option(Optional | NotHidden) {
913 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
914 apply(M4, this); apply(M5, this);
918 template<class M0t, class M1t, class M2t, class M3t,
919 class M4t, class M5t, class M6t>
920 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
921 const M4t &M4, const M5t &M5,
922 const M6t &M6) : Option(Optional | NotHidden) {
923 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
924 apply(M4, this); apply(M5, this); apply(M6, this);
928 template<class M0t, class M1t, class M2t, class M3t,
929 class M4t, class M5t, class M6t, class M7t>
930 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
931 const M4t &M4, const M5t &M5, const M6t &M6,
932 const M7t &M7) : Option(Optional | NotHidden) {
933 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
934 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
939 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
940 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
941 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
942 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
944 //===----------------------------------------------------------------------===//
945 // list_storage class
947 // Default storage class definition: external storage. This implementation
948 // assumes the user will specify a variable to store the data into with the
949 // cl::location(x) modifier.
951 template<class DataType, class StorageClass>
953 StorageClass *Location; // Where to store the object...
956 list_storage() : Location(0) {}
958 bool setLocation(Option &O, StorageClass &L) {
960 return O.error(": cl::location(x) specified more than once!");
966 void addValue(const T &V) {
967 assert(Location != 0 && "cl::location(...) not specified for a command "
968 "line option with external storage!");
969 Location->push_back(V);
974 // Define how to hold a class type object, such as a string. Since we can
975 // inherit from a class, we do so. This makes us exactly compatible with the
976 // object in all cases that it is used.
978 template<class DataType>
979 class list_storage<DataType, bool> : public std::vector<DataType> {
982 void addValue(const T &V) { push_back(V); }
986 //===----------------------------------------------------------------------===//
987 // list - A list of command line options.
989 template <class DataType, class Storage = bool,
990 class ParserClass = parser<DataType> >
991 class list : public Option, public list_storage<DataType, Storage> {
992 std::vector<unsigned> Positions;
995 virtual enum ValueExpected getValueExpectedFlagDefault() const {
996 return Parser.getValueExpectedFlagDefault();
998 virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
999 return Parser.getExtraOptionNames(OptionNames);
1002 virtual bool handleOccurrence(unsigned pos, const char *ArgName,
1003 const std::string &Arg) {
1004 typename ParserClass::parser_data_type Val =
1005 typename ParserClass::parser_data_type();
1006 if (Parser.parse(*this, ArgName, Arg, Val))
1007 return true; // Parse Error!
1010 Positions.push_back(pos);
1014 // Forward printing stuff to the parser...
1015 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1016 virtual void printOptionInfo(size_t GlobalWidth) const {
1017 Parser.printOptionInfo(*this, GlobalWidth);
1022 Parser.initialize(*this);
1025 ParserClass &getParser() { return Parser; }
1027 unsigned getPosition(unsigned optnum) const {
1028 assert(optnum < this->size() && "Invalid option index");
1029 return Positions[optnum];
1032 void setNumAdditionalVals(unsigned n) {
1033 Option::setNumAdditionalVals(n);
1038 explicit list(const M0t &M0) : Option(ZeroOrMore | NotHidden) {
1043 template<class M0t, class M1t>
1044 list(const M0t &M0, const M1t &M1) : Option(ZeroOrMore | NotHidden) {
1045 apply(M0, this); apply(M1, this);
1049 template<class M0t, class M1t, class M2t>
1050 list(const M0t &M0, const M1t &M1, const M2t &M2)
1051 : Option(ZeroOrMore | NotHidden) {
1052 apply(M0, this); apply(M1, this); apply(M2, this);
1056 template<class M0t, class M1t, class M2t, class M3t>
1057 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1058 : Option(ZeroOrMore | NotHidden) {
1059 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1063 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1064 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1065 const M4t &M4) : Option(ZeroOrMore | NotHidden) {
1066 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1071 template<class M0t, class M1t, class M2t, class M3t,
1072 class M4t, class M5t>
1073 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1074 const M4t &M4, const M5t &M5) : Option(ZeroOrMore | NotHidden) {
1075 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1076 apply(M4, this); apply(M5, this);
1080 template<class M0t, class M1t, class M2t, class M3t,
1081 class M4t, class M5t, class M6t>
1082 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1083 const M4t &M4, const M5t &M5, const M6t &M6)
1084 : Option(ZeroOrMore | NotHidden) {
1085 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1086 apply(M4, this); apply(M5, this); apply(M6, this);
1090 template<class M0t, class M1t, class M2t, class M3t,
1091 class M4t, class M5t, class M6t, class M7t>
1092 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1093 const M4t &M4, const M5t &M5, const M6t &M6,
1094 const M7t &M7) : Option(ZeroOrMore | NotHidden) {
1095 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1096 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1101 // multi_arg - Modifier to set the number of additional values.
1103 unsigned AdditionalVals;
1104 explicit multi_val(unsigned N) : AdditionalVals(N) {}
1106 template <typename D, typename S, typename P>
1107 void apply(list<D, S, P> &L) const { L.setNumAdditionalVals(AdditionalVals); }
1111 //===----------------------------------------------------------------------===//
1112 // bits_storage class
1114 // Default storage class definition: external storage. This implementation
1115 // assumes the user will specify a variable to store the data into with the
1116 // cl::location(x) modifier.
1118 template<class DataType, class StorageClass>
1119 class bits_storage {
1120 unsigned *Location; // Where to store the bits...
1123 static unsigned Bit(const T &V) {
1124 unsigned BitPos = reinterpret_cast<unsigned>(V);
1125 assert(BitPos < sizeof(unsigned) * 8 &&
1126 "enum exceeds width of bit vector!");
1131 bits_storage() : Location(0) {}
1133 bool setLocation(Option &O, unsigned &L) {
1135 return O.error(": cl::location(x) specified more than once!");
1141 void addValue(const T &V) {
1142 assert(Location != 0 && "cl::location(...) not specified for a command "
1143 "line option with external storage!");
1144 *Location |= Bit(V);
1147 unsigned getBits() { return *Location; }
1150 bool isSet(const T &V) {
1151 return (*Location & Bit(V)) != 0;
1156 // Define how to hold bits. Since we can inherit from a class, we do so.
1157 // This makes us exactly compatible with the bits in all cases that it is used.
1159 template<class DataType>
1160 class bits_storage<DataType, bool> {
1161 unsigned Bits; // Where to store the bits...
1164 static unsigned Bit(const T &V) {
1165 unsigned BitPos = reinterpret_cast<unsigned>(V);
1166 assert(BitPos < sizeof(unsigned) * 8 &&
1167 "enum exceeds width of bit vector!");
1173 void addValue(const T &V) {
1177 unsigned getBits() { return Bits; }
1180 bool isSet(const T &V) {
1181 return (Bits & Bit(V)) != 0;
1186 //===----------------------------------------------------------------------===//
1187 // bits - A bit vector of command options.
1189 template <class DataType, class Storage = bool,
1190 class ParserClass = parser<DataType> >
1191 class bits : public Option, public bits_storage<DataType, Storage> {
1192 std::vector<unsigned> Positions;
1195 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1196 return Parser.getValueExpectedFlagDefault();
1198 virtual void getExtraOptionNames(std::vector<const char*> &OptionNames) {
1199 return Parser.getExtraOptionNames(OptionNames);
1202 virtual bool handleOccurrence(unsigned pos, const char *ArgName,
1203 const std::string &Arg) {
1204 typename ParserClass::parser_data_type Val =
1205 typename ParserClass::parser_data_type();
1206 if (Parser.parse(*this, ArgName, Arg, Val))
1207 return true; // Parse Error!
1210 Positions.push_back(pos);
1214 // Forward printing stuff to the parser...
1215 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1216 virtual void printOptionInfo(size_t GlobalWidth) const {
1217 Parser.printOptionInfo(*this, GlobalWidth);
1222 Parser.initialize(*this);
1225 ParserClass &getParser() { return Parser; }
1227 unsigned getPosition(unsigned optnum) const {
1228 assert(optnum < this->size() && "Invalid option index");
1229 return Positions[optnum];
1234 explicit bits(const M0t &M0) : Option(ZeroOrMore | NotHidden) {
1239 template<class M0t, class M1t>
1240 bits(const M0t &M0, const M1t &M1) : Option(ZeroOrMore | NotHidden) {
1241 apply(M0, this); apply(M1, this);
1245 template<class M0t, class M1t, class M2t>
1246 bits(const M0t &M0, const M1t &M1, const M2t &M2)
1247 : Option(ZeroOrMore | NotHidden) {
1248 apply(M0, this); apply(M1, this); apply(M2, this);
1252 template<class M0t, class M1t, class M2t, class M3t>
1253 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1254 : Option(ZeroOrMore | NotHidden) {
1255 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1259 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1260 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1261 const M4t &M4) : Option(ZeroOrMore | NotHidden) {
1262 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1267 template<class M0t, class M1t, class M2t, class M3t,
1268 class M4t, class M5t>
1269 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1270 const M4t &M4, const M5t &M5) : Option(ZeroOrMore | NotHidden) {
1271 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1272 apply(M4, this); apply(M5, this);
1276 template<class M0t, class M1t, class M2t, class M3t,
1277 class M4t, class M5t, class M6t>
1278 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1279 const M4t &M4, const M5t &M5, const M6t &M6)
1280 : Option(ZeroOrMore | NotHidden) {
1281 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1282 apply(M4, this); apply(M5, this); apply(M6, this);
1286 template<class M0t, class M1t, class M2t, class M3t,
1287 class M4t, class M5t, class M6t, class M7t>
1288 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1289 const M4t &M4, const M5t &M5, const M6t &M6,
1290 const M7t &M7) : Option(ZeroOrMore | NotHidden) {
1291 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1292 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1297 //===----------------------------------------------------------------------===//
1298 // Aliased command line option (alias this name to a preexisting name)
1301 class alias : public Option {
1303 virtual bool handleOccurrence(unsigned pos, const char * /*ArgName*/,
1304 const std::string &Arg) {
1305 return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1307 // Handle printing stuff...
1308 virtual size_t getOptionWidth() const;
1309 virtual void printOptionInfo(size_t GlobalWidth) const;
1313 error(": cl::alias must have argument name specified!");
1315 error(": cl::alias must have an cl::aliasopt(option) specified!");
1319 void setAliasFor(Option &O) {
1321 error(": cl::alias must only have one cl::aliasopt(...) specified!");
1327 explicit alias(const M0t &M0) : Option(Optional | Hidden), AliasFor(0) {
1332 template<class M0t, class M1t>
1333 alias(const M0t &M0, const M1t &M1) : Option(Optional | Hidden), AliasFor(0) {
1334 apply(M0, this); apply(M1, this);
1338 template<class M0t, class M1t, class M2t>
1339 alias(const M0t &M0, const M1t &M1, const M2t &M2)
1340 : Option(Optional | Hidden), AliasFor(0) {
1341 apply(M0, this); apply(M1, this); apply(M2, this);
1345 template<class M0t, class M1t, class M2t, class M3t>
1346 alias(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1347 : Option(Optional | Hidden), AliasFor(0) {
1348 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1353 // aliasfor - Modifier to set the option an alias aliases.
1356 explicit aliasopt(Option &O) : Opt(O) {}
1357 void apply(alias &A) const { A.setAliasFor(Opt); }
1360 // extrahelp - provide additional help at the end of the normal help
1361 // output. All occurrences of cl::extrahelp will be accumulated and
1362 // printed to std::cerr at the end of the regular help, just before
1365 const char * morehelp;
1366 explicit extrahelp(const char* help);
1369 void PrintVersionMessage();
1370 // This function just prints the help message, exactly the same way as if the
1371 // --help option had been given on the command line.
1372 // NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1373 void PrintHelpMessage();
1375 } // End namespace cl
1377 } // End namespace llvm