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/ADT/SmallVector.h"
24 #include "llvm/ADT/StringMap.h"
25 #include "llvm/ADT/Twine.h"
26 #include "llvm/Support/Compiler.h"
27 #include "llvm/Support/type_traits.h"
36 /// cl Namespace - This namespace contains all of the command line option
37 /// processing machinery. It is intentionally a short name to make qualified
41 //===----------------------------------------------------------------------===//
42 // ParseCommandLineOptions - Command line option processing entry point.
44 void ParseCommandLineOptions(int argc, const char * const *argv,
45 const char *Overview = 0);
47 //===----------------------------------------------------------------------===//
48 // ParseEnvironmentOptions - Environment variable option processing alternate
51 void ParseEnvironmentOptions(const char *progName, const char *envvar,
52 const char *Overview = 0);
54 ///===---------------------------------------------------------------------===//
55 /// SetVersionPrinter - Override the default (LLVM specific) version printer
56 /// used to print out the version when --version is given
57 /// on the command line. This allows other systems using the
58 /// CommandLine utilities to print their own version string.
59 void SetVersionPrinter(void (*func)());
61 ///===---------------------------------------------------------------------===//
62 /// AddExtraVersionPrinter - Add an extra printer to use in addition to the
63 /// default one. This can be called multiple times,
64 /// and each time it adds a new function to the list
65 /// which will be called after the basic LLVM version
66 /// printing is complete. Each can then add additional
67 /// information specific to the tool.
68 void AddExtraVersionPrinter(void (*func)());
71 // PrintOptionValues - Print option values.
72 // With -print-options print the difference between option values and defaults.
73 // With -print-all-options print all option values.
74 // (Currently not perfect, but best-effort.)
75 void PrintOptionValues();
77 // MarkOptionsChanged - Internal helper function.
78 void MarkOptionsChanged();
80 //===----------------------------------------------------------------------===//
81 // Flags permitted to be passed to command line arguments
84 enum NumOccurrencesFlag { // Flags for the number of occurrences allowed
85 Optional = 0x00, // Zero or One occurrence
86 ZeroOrMore = 0x01, // Zero or more occurrences allowed
87 Required = 0x02, // One occurrence required
88 OneOrMore = 0x03, // One or more occurrences required
90 // ConsumeAfter - Indicates that this option is fed anything that follows the
91 // last positional argument required by the application (it is an error if
92 // there are zero positional arguments, and a ConsumeAfter option is used).
93 // Thus, for example, all arguments to LLI are processed until a filename is
94 // found. Once a filename is found, all of the succeeding arguments are
95 // passed, unprocessed, to the ConsumeAfter option.
100 enum ValueExpected { // Is a value required for the option?
101 // zero reserved for the unspecified value
102 ValueOptional = 0x01, // The value can appear... or not
103 ValueRequired = 0x02, // The value is required to appear!
104 ValueDisallowed = 0x03 // A value may not be specified (for flags)
107 enum OptionHidden { // Control whether -help shows this option
108 NotHidden = 0x00, // Option included in -help & -help-hidden
109 Hidden = 0x01, // -help doesn't, but -help-hidden does
110 ReallyHidden = 0x02 // Neither -help nor -help-hidden show this arg
113 // Formatting flags - This controls special features that the option might have
114 // that cause it to be parsed differently...
116 // Prefix - This option allows arguments that are otherwise unrecognized to be
117 // matched by options that are a prefix of the actual value. This is useful for
118 // cases like a linker, where options are typically of the form '-lfoo' or
119 // '-L../../include' where -l or -L are the actual flags. When prefix is
120 // enabled, and used, the value for the flag comes from the suffix of the
123 // Grouping - With this option enabled, multiple letter options are allowed to
124 // bunch together with only a single hyphen for the whole group. This allows
125 // emulation of the behavior that ls uses for example: ls -la === ls -l -a
128 enum FormattingFlags {
129 NormalFormatting = 0x00, // Nothing special
130 Positional = 0x01, // Is a positional argument, no '-' required
131 Prefix = 0x02, // Can this option directly prefix its value?
132 Grouping = 0x03 // Can this option group with other options?
135 enum MiscFlags { // Miscellaneous flags to adjust argument
136 CommaSeparated = 0x01, // Should this cl::list split between commas?
137 PositionalEatsArgs = 0x02, // Should this positional cl::list eat -args?
138 Sink = 0x04 // Should this cl::list eat all unknown options?
141 //===----------------------------------------------------------------------===//
142 // Option Category class
144 class OptionCategory {
146 const char *const Name;
147 const char *const Description;
148 void registerCategory();
150 OptionCategory(const char *const Name, const char *const Description = 0)
151 : Name(Name), Description(Description) { registerCategory(); }
152 const char *getName() { return Name; }
153 const char *getDescription() { return Description; }
156 // The general Option Category (used as default category).
157 extern OptionCategory GeneralCategory;
159 //===----------------------------------------------------------------------===//
166 // handleOccurrences - Overriden by subclasses to handle the value passed into
167 // an argument. Should return true if there was an error processing the
168 // argument and the program should exit.
170 virtual bool handleOccurrence(unsigned pos, StringRef ArgName,
173 virtual enum ValueExpected getValueExpectedFlagDefault() const {
174 return ValueOptional;
177 // Out of line virtual function to provide home for the class.
178 virtual void anchor();
180 int NumOccurrences; // The number of times specified
181 // Occurrences, HiddenFlag, and Formatting are all enum types but to avoid
182 // problems with signed enums in bitfields.
183 unsigned Occurrences : 3; // enum NumOccurrencesFlag
184 // not using the enum type for 'Value' because zero is an implementation
185 // detail representing the non-value
187 unsigned HiddenFlag : 2; // enum OptionHidden
188 unsigned Formatting : 2; // enum FormattingFlags
190 unsigned Position; // Position of last occurrence of the option
191 unsigned AdditionalVals;// Greater than 0 for multi-valued option.
192 Option *NextRegistered; // Singly linked list of registered options.
195 const char *ArgStr; // The argument string itself (ex: "help", "o")
196 const char *HelpStr; // The descriptive text message for -help
197 const char *ValueStr; // String describing what the value of this option is
198 OptionCategory *Category; // The Category this option belongs to
200 inline enum NumOccurrencesFlag getNumOccurrencesFlag() const {
201 return (enum NumOccurrencesFlag)Occurrences;
203 inline enum ValueExpected getValueExpectedFlag() const {
204 return Value ? ((enum ValueExpected)Value)
205 : getValueExpectedFlagDefault();
207 inline enum OptionHidden getOptionHiddenFlag() const {
208 return (enum OptionHidden)HiddenFlag;
210 inline enum FormattingFlags getFormattingFlag() const {
211 return (enum FormattingFlags)Formatting;
213 inline unsigned getMiscFlags() const {
216 inline unsigned getPosition() const { return Position; }
217 inline unsigned getNumAdditionalVals() const { return AdditionalVals; }
219 // hasArgStr - Return true if the argstr != ""
220 bool hasArgStr() const { return ArgStr[0] != 0; }
222 //-------------------------------------------------------------------------===
223 // Accessor functions set by OptionModifiers
225 void setArgStr(const char *S) { ArgStr = S; }
226 void setDescription(const char *S) { HelpStr = S; }
227 void setValueStr(const char *S) { ValueStr = S; }
228 void setNumOccurrencesFlag(enum NumOccurrencesFlag Val) {
231 void setValueExpectedFlag(enum ValueExpected Val) { Value = Val; }
232 void setHiddenFlag(enum OptionHidden Val) { HiddenFlag = Val; }
233 void setFormattingFlag(enum FormattingFlags V) { Formatting = V; }
234 void setMiscFlag(enum MiscFlags M) { Misc |= M; }
235 void setPosition(unsigned pos) { Position = pos; }
236 void setCategory(OptionCategory &C) { Category = &C; }
238 explicit Option(enum NumOccurrencesFlag OccurrencesFlag,
239 enum OptionHidden Hidden)
240 : NumOccurrences(0), Occurrences(OccurrencesFlag), Value(0),
241 HiddenFlag(Hidden), Formatting(NormalFormatting), Misc(0),
242 Position(0), AdditionalVals(0), NextRegistered(0),
243 ArgStr(""), HelpStr(""), ValueStr(""), Category(&GeneralCategory) {
246 inline void setNumAdditionalVals(unsigned n) { AdditionalVals = n; }
248 // addArgument - Register this argument with the commandline system.
252 Option *getNextRegisteredOption() const { return NextRegistered; }
254 // Return the width of the option tag for printing...
255 virtual size_t getOptionWidth() const = 0;
257 // printOptionInfo - Print out information about this option. The
258 // to-be-maintained width is specified.
260 virtual void printOptionInfo(size_t GlobalWidth) const = 0;
262 virtual void printOptionValue(size_t GlobalWidth, bool Force) const = 0;
264 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &) {}
266 // addOccurrence - Wrapper around handleOccurrence that enforces Flags.
268 bool addOccurrence(unsigned pos, StringRef ArgName,
269 StringRef Value, bool MultiArg = false);
271 // Prints option name followed by message. Always returns true.
272 bool error(const Twine &Message, StringRef ArgName = StringRef());
275 inline int getNumOccurrences() const { return NumOccurrences; }
280 //===----------------------------------------------------------------------===//
281 // Command line option modifiers that can be used to modify the behavior of
282 // command line option parsers...
285 // desc - Modifier to set the description shown in the -help output...
288 desc(const char *Str) : Desc(Str) {}
289 void apply(Option &O) const { O.setDescription(Desc); }
292 // value_desc - Modifier to set the value description shown in the -help
296 value_desc(const char *Str) : Desc(Str) {}
297 void apply(Option &O) const { O.setValueStr(Desc); }
300 // init - Specify a default (initial) value for the command line argument, if
301 // the default constructor for the argument type does not give you what you
302 // want. This is only valid on "opt" arguments, not on "list" arguments.
307 initializer(const Ty &Val) : Init(Val) {}
310 void apply(Opt &O) const { O.setInitialValue(Init); }
314 initializer<Ty> init(const Ty &Val) {
315 return initializer<Ty>(Val);
319 // location - Allow the user to specify which external variable they want to
320 // store the results of the command line argument processing into, if they don't
321 // want to store it in the option itself.
324 struct LocationClass {
326 LocationClass(Ty &L) : Loc(L) {}
329 void apply(Opt &O) const { O.setLocation(O, Loc); }
333 LocationClass<Ty> location(Ty &L) { return LocationClass<Ty>(L); }
335 // cat - Specifiy the Option category for the command line argument to belong
338 OptionCategory &Category;
339 cat(OptionCategory &c) : Category(c) {}
342 void apply(Opt &O) const { O.setCategory(Category); }
346 //===----------------------------------------------------------------------===//
349 // Support value comparison outside the template.
350 struct GenericOptionValue {
351 virtual ~GenericOptionValue() {}
352 virtual bool compare(const GenericOptionValue &V) const = 0;
355 virtual void anchor();
358 template<class DataType> struct OptionValue;
360 // The default value safely does nothing. Option value printing is only
362 template<class DataType, bool isClass>
363 struct OptionValueBase : public GenericOptionValue {
364 // Temporary storage for argument passing.
365 typedef OptionValue<DataType> WrapperType;
367 bool hasValue() const { return false; }
369 const DataType &getValue() const { llvm_unreachable("no default value"); }
371 // Some options may take their value from a different data type.
373 void setValue(const DT& /*V*/) {}
375 bool compare(const DataType &/*V*/) const { return false; }
377 virtual bool compare(const GenericOptionValue& /*V*/) const { return false; }
380 // Simple copy of the option value.
381 template<class DataType>
382 class OptionValueCopy : public GenericOptionValue {
386 OptionValueCopy() : Valid(false) {}
388 bool hasValue() const { return Valid; }
390 const DataType &getValue() const {
391 assert(Valid && "invalid option value");
395 void setValue(const DataType &V) { Valid = true; Value = V; }
397 bool compare(const DataType &V) const {
398 return Valid && (Value != V);
401 virtual bool compare(const GenericOptionValue &V) const {
402 const OptionValueCopy<DataType> &VC =
403 static_cast< const OptionValueCopy<DataType>& >(V);
404 if (!VC.hasValue()) return false;
405 return compare(VC.getValue());
409 // Non-class option values.
410 template<class DataType>
411 struct OptionValueBase<DataType, false> : OptionValueCopy<DataType> {
412 typedef DataType WrapperType;
415 // Top-level option class.
416 template<class DataType>
417 struct OptionValue : OptionValueBase<DataType, is_class<DataType>::value> {
420 OptionValue(const DataType& V) {
423 // Some options may take their value from a different data type.
425 OptionValue<DataType> &operator=(const DT& V) {
431 // Other safe-to-copy-by-value common option types.
432 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
434 struct OptionValue<cl::boolOrDefault> : OptionValueCopy<cl::boolOrDefault> {
435 typedef cl::boolOrDefault WrapperType;
439 OptionValue(const cl::boolOrDefault& V) {
442 OptionValue<cl::boolOrDefault> &operator=(const cl::boolOrDefault& V) {
447 virtual void anchor();
451 struct OptionValue<std::string> : OptionValueCopy<std::string> {
452 typedef StringRef WrapperType;
456 OptionValue(const std::string& V) {
459 OptionValue<std::string> &operator=(const std::string& V) {
464 virtual void anchor();
467 //===----------------------------------------------------------------------===//
468 // Enum valued command line option
470 #define clEnumVal(ENUMVAL, DESC) #ENUMVAL, int(ENUMVAL), DESC
471 #define clEnumValN(ENUMVAL, FLAGNAME, DESC) FLAGNAME, int(ENUMVAL), DESC
472 #define clEnumValEnd (reinterpret_cast<void*>(0))
474 // values - For custom data types, allow specifying a group of values together
475 // as the values that go into the mapping that the option handler uses. Note
476 // that the values list must always have a 0 at the end of the list to indicate
477 // that the list has ended.
479 template<class DataType>
481 // Use a vector instead of a map, because the lists should be short,
482 // the overhead is less, and most importantly, it keeps them in the order
483 // inserted so we can print our option out nicely.
484 SmallVector<std::pair<const char *, std::pair<int, const char *> >,4> Values;
485 void processValues(va_list Vals);
487 ValuesClass(const char *EnumName, DataType Val, const char *Desc,
489 // Insert the first value, which is required.
490 Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc)));
492 // Process the varargs portion of the values...
493 while (const char *enumName = va_arg(ValueArgs, const char *)) {
494 DataType EnumVal = static_cast<DataType>(va_arg(ValueArgs, int));
495 const char *EnumDesc = va_arg(ValueArgs, const char *);
496 Values.push_back(std::make_pair(enumName, // Add value to value map
497 std::make_pair(EnumVal, EnumDesc)));
502 void apply(Opt &O) const {
503 for (size_t i = 0, e = Values.size(); i != e; ++i)
504 O.getParser().addLiteralOption(Values[i].first, Values[i].second.first,
505 Values[i].second.second);
509 template<class DataType>
510 ValuesClass<DataType> END_WITH_NULL values(const char *Arg, DataType Val,
511 const char *Desc, ...) {
513 va_start(ValueArgs, Desc);
514 ValuesClass<DataType> Vals(Arg, Val, Desc, ValueArgs);
519 //===----------------------------------------------------------------------===//
520 // parser class - Parameterizable parser for different data types. By default,
521 // known data types (string, int, bool) have specialized parsers, that do what
522 // you would expect. The default parser, used for data types that are not
523 // built-in, uses a mapping table to map specific options to values, which is
524 // used, among other things, to handle enum types.
526 //--------------------------------------------------
527 // generic_parser_base - This class holds all the non-generic code that we do
528 // not need replicated for every instance of the generic parser. This also
529 // allows us to put stuff into CommandLine.cpp
531 class generic_parser_base {
533 class GenericOptionInfo {
535 GenericOptionInfo(const char *name, const char *helpStr) :
536 Name(name), HelpStr(helpStr) {}
541 virtual ~generic_parser_base() {} // Base class should have virtual-dtor
543 // getNumOptions - Virtual function implemented by generic subclass to
544 // indicate how many entries are in Values.
546 virtual unsigned getNumOptions() const = 0;
548 // getOption - Return option name N.
549 virtual const char *getOption(unsigned N) const = 0;
551 // getDescription - Return description N
552 virtual const char *getDescription(unsigned N) const = 0;
554 // Return the width of the option tag for printing...
555 virtual size_t getOptionWidth(const Option &O) const;
557 virtual const GenericOptionValue &getOptionValue(unsigned N) const = 0;
559 // printOptionInfo - Print out information about this option. The
560 // to-be-maintained width is specified.
562 virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const;
564 void printGenericOptionDiff(const Option &O, const GenericOptionValue &V,
565 const GenericOptionValue &Default,
566 size_t GlobalWidth) const;
568 // printOptionDiff - print the value of an option and it's default.
570 // Template definition ensures that the option and default have the same
571 // DataType (via the same AnyOptionValue).
572 template<class AnyOptionValue>
573 void printOptionDiff(const Option &O, const AnyOptionValue &V,
574 const AnyOptionValue &Default,
575 size_t GlobalWidth) const {
576 printGenericOptionDiff(O, V, Default, GlobalWidth);
579 void initialize(Option &O) {
580 // All of the modifiers for the option have been processed by now, so the
581 // argstr field should be stable, copy it down now.
583 hasArgStr = O.hasArgStr();
586 void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
587 // If there has been no argstr specified, that means that we need to add an
588 // argument for every possible option. This ensures that our options are
591 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
592 OptionNames.push_back(getOption(i));
596 enum ValueExpected getValueExpectedFlagDefault() const {
597 // If there is an ArgStr specified, then we are of the form:
599 // -opt=O2 or -opt O2 or -optO2
601 // In which case, the value is required. Otherwise if an arg str has not
602 // been specified, we are of the form:
604 // -O2 or O2 or -la (where -l and -a are separate options)
606 // If this is the case, we cannot allow a value.
609 return ValueRequired;
611 return ValueDisallowed;
614 // findOption - Return the option number corresponding to the specified
615 // argument string. If the option is not found, getNumOptions() is returned.
617 unsigned findOption(const char *Name);
623 // Default parser implementation - This implementation depends on having a
624 // mapping of recognized options to values of some sort. In addition to this,
625 // each entry in the mapping also tracks a help message that is printed with the
626 // command line option for -help. Because this is a simple mapping parser, the
627 // data type can be any unsupported type.
629 template <class DataType>
630 class parser : public generic_parser_base {
632 class OptionInfo : public GenericOptionInfo {
634 OptionInfo(const char *name, DataType v, const char *helpStr) :
635 GenericOptionInfo(name, helpStr), V(v) {}
636 OptionValue<DataType> V;
638 SmallVector<OptionInfo, 8> Values;
640 typedef DataType parser_data_type;
642 // Implement virtual functions needed by generic_parser_base
643 unsigned getNumOptions() const { return unsigned(Values.size()); }
644 const char *getOption(unsigned N) const { return Values[N].Name; }
645 const char *getDescription(unsigned N) const {
646 return Values[N].HelpStr;
649 // getOptionValue - Return the value of option name N.
650 virtual const GenericOptionValue &getOptionValue(unsigned N) const {
654 // parse - Return true on error.
655 bool parse(Option &O, StringRef ArgName, StringRef Arg, DataType &V) {
662 for (size_t i = 0, e = Values.size(); i != e; ++i)
663 if (Values[i].Name == ArgVal) {
664 V = Values[i].V.getValue();
668 return O.error("Cannot find option named '" + ArgVal + "'!");
671 /// addLiteralOption - Add an entry to the mapping table.
674 void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) {
675 assert(findOption(Name) == Values.size() && "Option already exists!");
676 OptionInfo X(Name, static_cast<DataType>(V), HelpStr);
678 MarkOptionsChanged();
681 /// removeLiteralOption - Remove the specified option.
683 void removeLiteralOption(const char *Name) {
684 unsigned N = findOption(Name);
685 assert(N != Values.size() && "Option not found!");
686 Values.erase(Values.begin()+N);
690 //--------------------------------------------------
691 // basic_parser - Super class of parsers to provide boilerplate code
693 class basic_parser_impl { // non-template implementation of basic_parser<t>
695 virtual ~basic_parser_impl() {}
697 enum ValueExpected getValueExpectedFlagDefault() const {
698 return ValueRequired;
701 void getExtraOptionNames(SmallVectorImpl<const char*> &) {}
703 void initialize(Option &) {}
705 // Return the width of the option tag for printing...
706 size_t getOptionWidth(const Option &O) const;
708 // printOptionInfo - Print out information about this option. The
709 // to-be-maintained width is specified.
711 void printOptionInfo(const Option &O, size_t GlobalWidth) const;
713 // printOptionNoValue - Print a placeholder for options that don't yet support
714 // printOptionDiff().
715 void printOptionNoValue(const Option &O, size_t GlobalWidth) const;
717 // getValueName - Overload in subclass to provide a better default value.
718 virtual const char *getValueName() const { return "value"; }
720 // An out-of-line virtual method to provide a 'home' for this class.
721 virtual void anchor();
724 // A helper for basic_parser::printOptionDiff.
725 void printOptionName(const Option &O, size_t GlobalWidth) const;
728 // basic_parser - The real basic parser is just a template wrapper that provides
729 // a typedef for the provided data type.
731 template<class DataType>
732 class basic_parser : public basic_parser_impl {
734 typedef DataType parser_data_type;
735 typedef OptionValue<DataType> OptVal;
738 //--------------------------------------------------
742 class parser<bool> : public basic_parser<bool> {
746 // parse - Return true on error.
747 bool parse(Option &O, StringRef ArgName, StringRef Arg, bool &Val);
750 void initialize(Opt &O) {
754 enum ValueExpected getValueExpectedFlagDefault() const {
755 return ValueOptional;
758 // getValueName - Do not print =<value> at all.
759 virtual const char *getValueName() const { return 0; }
761 void printOptionDiff(const Option &O, bool V, OptVal Default,
762 size_t GlobalWidth) const;
764 // An out-of-line virtual method to provide a 'home' for this class.
765 virtual void anchor();
768 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
770 //--------------------------------------------------
771 // parser<boolOrDefault>
773 class parser<boolOrDefault> : public basic_parser<boolOrDefault> {
775 // parse - Return true on error.
776 bool parse(Option &O, StringRef ArgName, StringRef Arg, boolOrDefault &Val);
778 enum ValueExpected getValueExpectedFlagDefault() const {
779 return ValueOptional;
782 // getValueName - Do not print =<value> at all.
783 virtual const char *getValueName() const { return 0; }
785 void printOptionDiff(const Option &O, boolOrDefault V, OptVal Default,
786 size_t GlobalWidth) const;
788 // An out-of-line virtual method to provide a 'home' for this class.
789 virtual void anchor();
792 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
794 //--------------------------------------------------
798 class parser<int> : public basic_parser<int> {
800 // parse - Return true on error.
801 bool parse(Option &O, StringRef ArgName, StringRef Arg, int &Val);
803 // getValueName - Overload in subclass to provide a better default value.
804 virtual const char *getValueName() const { return "int"; }
806 void printOptionDiff(const Option &O, int V, OptVal Default,
807 size_t GlobalWidth) const;
809 // An out-of-line virtual method to provide a 'home' for this class.
810 virtual void anchor();
813 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
816 //--------------------------------------------------
820 class parser<unsigned> : public basic_parser<unsigned> {
822 // parse - Return true on error.
823 bool parse(Option &O, StringRef ArgName, StringRef Arg, unsigned &Val);
825 // getValueName - Overload in subclass to provide a better default value.
826 virtual const char *getValueName() const { return "uint"; }
828 void printOptionDiff(const Option &O, unsigned V, OptVal Default,
829 size_t GlobalWidth) const;
831 // An out-of-line virtual method to provide a 'home' for this class.
832 virtual void anchor();
835 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
837 //--------------------------------------------------
838 // parser<unsigned long long>
841 class parser<unsigned long long> : public basic_parser<unsigned long long> {
843 // parse - Return true on error.
844 bool parse(Option &O, StringRef ArgName, StringRef Arg,
845 unsigned long long &Val);
847 // getValueName - Overload in subclass to provide a better default value.
848 virtual const char *getValueName() const { return "uint"; }
850 void printOptionDiff(const Option &O, unsigned long long V, OptVal Default,
851 size_t GlobalWidth) const;
853 // An out-of-line virtual method to provide a 'home' for this class.
854 virtual void anchor();
857 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
859 //--------------------------------------------------
863 class parser<double> : public basic_parser<double> {
865 // parse - Return true on error.
866 bool parse(Option &O, StringRef ArgName, StringRef Arg, double &Val);
868 // getValueName - Overload in subclass to provide a better default value.
869 virtual const char *getValueName() const { return "number"; }
871 void printOptionDiff(const Option &O, double V, OptVal Default,
872 size_t GlobalWidth) const;
874 // An out-of-line virtual method to provide a 'home' for this class.
875 virtual void anchor();
878 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
880 //--------------------------------------------------
884 class parser<float> : public basic_parser<float> {
886 // parse - Return true on error.
887 bool parse(Option &O, StringRef ArgName, StringRef Arg, float &Val);
889 // getValueName - Overload in subclass to provide a better default value.
890 virtual const char *getValueName() const { return "number"; }
892 void printOptionDiff(const Option &O, float V, OptVal Default,
893 size_t GlobalWidth) const;
895 // An out-of-line virtual method to provide a 'home' for this class.
896 virtual void anchor();
899 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
901 //--------------------------------------------------
902 // parser<std::string>
905 class parser<std::string> : public basic_parser<std::string> {
907 // parse - Return true on error.
908 bool parse(Option &, StringRef, StringRef Arg, std::string &Value) {
913 // getValueName - Overload in subclass to provide a better default value.
914 virtual const char *getValueName() const { return "string"; }
916 void printOptionDiff(const Option &O, StringRef V, OptVal Default,
917 size_t GlobalWidth) const;
919 // An out-of-line virtual method to provide a 'home' for this class.
920 virtual void anchor();
923 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
925 //--------------------------------------------------
929 class parser<char> : public basic_parser<char> {
931 // parse - Return true on error.
932 bool parse(Option &, StringRef, StringRef Arg, char &Value) {
937 // getValueName - Overload in subclass to provide a better default value.
938 virtual const char *getValueName() const { return "char"; }
940 void printOptionDiff(const Option &O, char V, OptVal Default,
941 size_t GlobalWidth) const;
943 // An out-of-line virtual method to provide a 'home' for this class.
944 virtual void anchor();
947 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<char>);
949 //--------------------------------------------------
952 // This collection of wrappers is the intermediary between class opt and class
953 // parser to handle all the template nastiness.
955 // This overloaded function is selected by the generic parser.
956 template<class ParserClass, class DT>
957 void printOptionDiff(const Option &O, const generic_parser_base &P, const DT &V,
958 const OptionValue<DT> &Default, size_t GlobalWidth) {
959 OptionValue<DT> OV = V;
960 P.printOptionDiff(O, OV, Default, GlobalWidth);
963 // This is instantiated for basic parsers when the parsed value has a different
964 // type than the option value. e.g. HelpPrinter.
965 template<class ParserDT, class ValDT>
966 struct OptionDiffPrinter {
967 void print(const Option &O, const parser<ParserDT> P, const ValDT &/*V*/,
968 const OptionValue<ValDT> &/*Default*/, size_t GlobalWidth) {
969 P.printOptionNoValue(O, GlobalWidth);
973 // This is instantiated for basic parsers when the parsed value has the same
974 // type as the option value.
976 struct OptionDiffPrinter<DT, DT> {
977 void print(const Option &O, const parser<DT> P, const DT &V,
978 const OptionValue<DT> &Default, size_t GlobalWidth) {
979 P.printOptionDiff(O, V, Default, GlobalWidth);
983 // This overloaded function is selected by the basic parser, which may parse a
984 // different type than the option type.
985 template<class ParserClass, class ValDT>
986 void printOptionDiff(
988 const basic_parser<typename ParserClass::parser_data_type> &P,
989 const ValDT &V, const OptionValue<ValDT> &Default,
990 size_t GlobalWidth) {
992 OptionDiffPrinter<typename ParserClass::parser_data_type, ValDT> printer;
993 printer.print(O, static_cast<const ParserClass&>(P), V, Default,
997 //===----------------------------------------------------------------------===//
998 // applicator class - This class is used because we must use partial
999 // specialization to handle literal string arguments specially (const char* does
1000 // not correctly respond to the apply method). Because the syntax to use this
1001 // is a pain, we have the 'apply' method below to handle the nastiness...
1003 template<class Mod> struct applicator {
1005 static void opt(const Mod &M, Opt &O) { M.apply(O); }
1008 // Handle const char* as a special case...
1009 template<unsigned n> struct applicator<char[n]> {
1011 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
1013 template<unsigned n> struct applicator<const char[n]> {
1015 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
1017 template<> struct applicator<const char*> {
1019 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
1022 template<> struct applicator<NumOccurrencesFlag> {
1023 static void opt(NumOccurrencesFlag NO, Option &O) {
1024 O.setNumOccurrencesFlag(NO);
1027 template<> struct applicator<ValueExpected> {
1028 static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
1030 template<> struct applicator<OptionHidden> {
1031 static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
1033 template<> struct applicator<FormattingFlags> {
1034 static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
1036 template<> struct applicator<MiscFlags> {
1037 static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
1040 // apply method - Apply a modifier to an option in a type safe way.
1041 template<class Mod, class Opt>
1042 void apply(const Mod &M, Opt *O) {
1043 applicator<Mod>::opt(M, *O);
1046 //===----------------------------------------------------------------------===//
1047 // opt_storage class
1049 // Default storage class definition: external storage. This implementation
1050 // assumes the user will specify a variable to store the data into with the
1051 // cl::location(x) modifier.
1053 template<class DataType, bool ExternalStorage, bool isClass>
1055 DataType *Location; // Where to store the object...
1056 OptionValue<DataType> Default;
1058 void check() const {
1059 assert(Location != 0 && "cl::location(...) not specified for a command "
1060 "line option with external storage, "
1061 "or cl::init specified before cl::location()!!");
1064 opt_storage() : Location(0) {}
1066 bool setLocation(Option &O, DataType &L) {
1068 return O.error("cl::location(x) specified more than once!");
1075 void setValue(const T &V, bool initial = false) {
1082 DataType &getValue() { check(); return *Location; }
1083 const DataType &getValue() const { check(); return *Location; }
1085 operator DataType() const { return this->getValue(); }
1087 const OptionValue<DataType> &getDefault() const { return Default; }
1090 // Define how to hold a class type object, such as a string. Since we can
1091 // inherit from a class, we do so. This makes us exactly compatible with the
1092 // object in all cases that it is used.
1094 template<class DataType>
1095 class opt_storage<DataType,false,true> : public DataType {
1097 OptionValue<DataType> Default;
1100 void setValue(const T &V, bool initial = false) {
1101 DataType::operator=(V);
1106 DataType &getValue() { return *this; }
1107 const DataType &getValue() const { return *this; }
1109 const OptionValue<DataType> &getDefault() const { return Default; }
1112 // Define a partial specialization to handle things we cannot inherit from. In
1113 // this case, we store an instance through containment, and overload operators
1114 // to get at the value.
1116 template<class DataType>
1117 class opt_storage<DataType, false, false> {
1120 OptionValue<DataType> Default;
1122 // Make sure we initialize the value with the default constructor for the
1124 opt_storage() : Value(DataType()), Default(DataType()) {}
1127 void setValue(const T &V, bool initial = false) {
1132 DataType &getValue() { return Value; }
1133 DataType getValue() const { return Value; }
1135 const OptionValue<DataType> &getDefault() const { return Default; }
1137 operator DataType() const { return getValue(); }
1139 // If the datatype is a pointer, support -> on it.
1140 DataType operator->() const { return Value; }
1144 //===----------------------------------------------------------------------===//
1145 // opt - A scalar command line option.
1147 template <class DataType, bool ExternalStorage = false,
1148 class ParserClass = parser<DataType> >
1149 class opt : public Option,
1150 public opt_storage<DataType, ExternalStorage,
1151 is_class<DataType>::value> {
1154 virtual bool handleOccurrence(unsigned pos, StringRef ArgName,
1156 typename ParserClass::parser_data_type Val =
1157 typename ParserClass::parser_data_type();
1158 if (Parser.parse(*this, ArgName, Arg, Val))
1159 return true; // Parse error!
1160 this->setValue(Val);
1161 this->setPosition(pos);
1165 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1166 return Parser.getValueExpectedFlagDefault();
1168 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
1169 return Parser.getExtraOptionNames(OptionNames);
1172 // Forward printing stuff to the parser...
1173 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1174 virtual void printOptionInfo(size_t GlobalWidth) const {
1175 Parser.printOptionInfo(*this, GlobalWidth);
1178 virtual void printOptionValue(size_t GlobalWidth, bool Force) const {
1179 if (Force || this->getDefault().compare(this->getValue())) {
1180 cl::printOptionDiff<ParserClass>(
1181 *this, Parser, this->getValue(), this->getDefault(), GlobalWidth);
1187 Parser.initialize(*this);
1190 // setInitialValue - Used by the cl::init modifier...
1191 void setInitialValue(const DataType &V) { this->setValue(V, true); }
1193 ParserClass &getParser() { return Parser; }
1196 DataType &operator=(const T &Val) {
1197 this->setValue(Val);
1198 return this->getValue();
1203 explicit opt(const M0t &M0) : Option(Optional, NotHidden) {
1209 template<class M0t, class M1t>
1210 opt(const M0t &M0, const M1t &M1) : Option(Optional, NotHidden) {
1211 apply(M0, this); apply(M1, this);
1216 template<class M0t, class M1t, class M2t>
1217 opt(const M0t &M0, const M1t &M1,
1218 const M2t &M2) : Option(Optional, NotHidden) {
1219 apply(M0, this); apply(M1, this); apply(M2, this);
1223 template<class M0t, class M1t, class M2t, class M3t>
1224 opt(const M0t &M0, const M1t &M1, const M2t &M2,
1225 const M3t &M3) : Option(Optional, NotHidden) {
1226 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1230 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1231 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1232 const M4t &M4) : Option(Optional, NotHidden) {
1233 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1238 template<class M0t, class M1t, class M2t, class M3t,
1239 class M4t, class M5t>
1240 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1241 const M4t &M4, const M5t &M5) : Option(Optional, NotHidden) {
1242 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1243 apply(M4, this); apply(M5, this);
1247 template<class M0t, class M1t, class M2t, class M3t,
1248 class M4t, class M5t, class M6t>
1249 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1250 const M4t &M4, const M5t &M5,
1251 const M6t &M6) : Option(Optional, NotHidden) {
1252 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1253 apply(M4, this); apply(M5, this); apply(M6, this);
1257 template<class M0t, class M1t, class M2t, class M3t,
1258 class M4t, class M5t, class M6t, class M7t>
1259 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1260 const M4t &M4, const M5t &M5, const M6t &M6,
1261 const M7t &M7) : Option(Optional, NotHidden) {
1262 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1263 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1268 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
1269 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
1270 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
1271 EXTERN_TEMPLATE_INSTANTIATION(class opt<char>);
1272 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
1274 //===----------------------------------------------------------------------===//
1275 // list_storage class
1277 // Default storage class definition: external storage. This implementation
1278 // assumes the user will specify a variable to store the data into with the
1279 // cl::location(x) modifier.
1281 template<class DataType, class StorageClass>
1282 class list_storage {
1283 StorageClass *Location; // Where to store the object...
1286 list_storage() : Location(0) {}
1288 bool setLocation(Option &O, StorageClass &L) {
1290 return O.error("cl::location(x) specified more than once!");
1296 void addValue(const T &V) {
1297 assert(Location != 0 && "cl::location(...) not specified for a command "
1298 "line option with external storage!");
1299 Location->push_back(V);
1304 // Define how to hold a class type object, such as a string. Since we can
1305 // inherit from a class, we do so. This makes us exactly compatible with the
1306 // object in all cases that it is used.
1308 template<class DataType>
1309 class list_storage<DataType, bool> : public std::vector<DataType> {
1312 void addValue(const T &V) { std::vector<DataType>::push_back(V); }
1316 //===----------------------------------------------------------------------===//
1317 // list - A list of command line options.
1319 template <class DataType, class Storage = bool,
1320 class ParserClass = parser<DataType> >
1321 class list : public Option, public list_storage<DataType, Storage> {
1322 std::vector<unsigned> Positions;
1325 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1326 return Parser.getValueExpectedFlagDefault();
1328 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
1329 return Parser.getExtraOptionNames(OptionNames);
1332 virtual bool handleOccurrence(unsigned pos, StringRef ArgName, StringRef Arg){
1333 typename ParserClass::parser_data_type Val =
1334 typename ParserClass::parser_data_type();
1335 if (Parser.parse(*this, ArgName, Arg, Val))
1336 return true; // Parse Error!
1337 list_storage<DataType, Storage>::addValue(Val);
1339 Positions.push_back(pos);
1343 // Forward printing stuff to the parser...
1344 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1345 virtual void printOptionInfo(size_t GlobalWidth) const {
1346 Parser.printOptionInfo(*this, GlobalWidth);
1349 // Unimplemented: list options don't currently store their default value.
1350 virtual void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const {}
1354 Parser.initialize(*this);
1357 ParserClass &getParser() { return Parser; }
1359 unsigned getPosition(unsigned optnum) const {
1360 assert(optnum < this->size() && "Invalid option index");
1361 return Positions[optnum];
1364 void setNumAdditionalVals(unsigned n) {
1365 Option::setNumAdditionalVals(n);
1370 explicit list(const M0t &M0) : Option(ZeroOrMore, NotHidden) {
1375 template<class M0t, class M1t>
1376 list(const M0t &M0, const M1t &M1) : Option(ZeroOrMore, NotHidden) {
1377 apply(M0, this); apply(M1, this);
1381 template<class M0t, class M1t, class M2t>
1382 list(const M0t &M0, const M1t &M1, const M2t &M2)
1383 : Option(ZeroOrMore, NotHidden) {
1384 apply(M0, this); apply(M1, this); apply(M2, this);
1388 template<class M0t, class M1t, class M2t, class M3t>
1389 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1390 : Option(ZeroOrMore, NotHidden) {
1391 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1395 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1396 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1397 const M4t &M4) : Option(ZeroOrMore, NotHidden) {
1398 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1403 template<class M0t, class M1t, class M2t, class M3t,
1404 class M4t, class M5t>
1405 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1406 const M4t &M4, const M5t &M5) : Option(ZeroOrMore, NotHidden) {
1407 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1408 apply(M4, this); apply(M5, this);
1412 template<class M0t, class M1t, class M2t, class M3t,
1413 class M4t, class M5t, class M6t>
1414 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1415 const M4t &M4, const M5t &M5, const M6t &M6)
1416 : Option(ZeroOrMore, NotHidden) {
1417 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1418 apply(M4, this); apply(M5, this); apply(M6, this);
1422 template<class M0t, class M1t, class M2t, class M3t,
1423 class M4t, class M5t, class M6t, class M7t>
1424 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1425 const M4t &M4, const M5t &M5, const M6t &M6,
1426 const M7t &M7) : Option(ZeroOrMore, NotHidden) {
1427 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1428 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1433 // multi_val - Modifier to set the number of additional values.
1435 unsigned AdditionalVals;
1436 explicit multi_val(unsigned N) : AdditionalVals(N) {}
1438 template <typename D, typename S, typename P>
1439 void apply(list<D, S, P> &L) const { L.setNumAdditionalVals(AdditionalVals); }
1443 //===----------------------------------------------------------------------===//
1444 // bits_storage class
1446 // Default storage class definition: external storage. This implementation
1447 // assumes the user will specify a variable to store the data into with the
1448 // cl::location(x) modifier.
1450 template<class DataType, class StorageClass>
1451 class bits_storage {
1452 unsigned *Location; // Where to store the bits...
1455 static unsigned Bit(const T &V) {
1456 unsigned BitPos = reinterpret_cast<unsigned>(V);
1457 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1458 "enum exceeds width of bit vector!");
1463 bits_storage() : Location(0) {}
1465 bool setLocation(Option &O, unsigned &L) {
1467 return O.error("cl::location(x) specified more than once!");
1473 void addValue(const T &V) {
1474 assert(Location != 0 && "cl::location(...) not specified for a command "
1475 "line option with external storage!");
1476 *Location |= Bit(V);
1479 unsigned getBits() { return *Location; }
1482 bool isSet(const T &V) {
1483 return (*Location & Bit(V)) != 0;
1488 // Define how to hold bits. Since we can inherit from a class, we do so.
1489 // This makes us exactly compatible with the bits in all cases that it is used.
1491 template<class DataType>
1492 class bits_storage<DataType, bool> {
1493 unsigned Bits; // Where to store the bits...
1496 static unsigned Bit(const T &V) {
1497 unsigned BitPos = (unsigned)V;
1498 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1499 "enum exceeds width of bit vector!");
1505 void addValue(const T &V) {
1509 unsigned getBits() { return Bits; }
1512 bool isSet(const T &V) {
1513 return (Bits & Bit(V)) != 0;
1518 //===----------------------------------------------------------------------===//
1519 // bits - A bit vector of command options.
1521 template <class DataType, class Storage = bool,
1522 class ParserClass = parser<DataType> >
1523 class bits : public Option, public bits_storage<DataType, Storage> {
1524 std::vector<unsigned> Positions;
1527 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1528 return Parser.getValueExpectedFlagDefault();
1530 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
1531 return Parser.getExtraOptionNames(OptionNames);
1534 virtual bool handleOccurrence(unsigned pos, StringRef ArgName, StringRef Arg){
1535 typename ParserClass::parser_data_type Val =
1536 typename ParserClass::parser_data_type();
1537 if (Parser.parse(*this, ArgName, Arg, Val))
1538 return true; // Parse Error!
1539 this->addValue(Val);
1541 Positions.push_back(pos);
1545 // Forward printing stuff to the parser...
1546 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1547 virtual void printOptionInfo(size_t GlobalWidth) const {
1548 Parser.printOptionInfo(*this, GlobalWidth);
1551 // Unimplemented: bits options don't currently store their default values.
1552 virtual void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const {}
1556 Parser.initialize(*this);
1559 ParserClass &getParser() { return Parser; }
1561 unsigned getPosition(unsigned optnum) const {
1562 assert(optnum < this->size() && "Invalid option index");
1563 return Positions[optnum];
1568 explicit bits(const M0t &M0) : Option(ZeroOrMore, NotHidden) {
1573 template<class M0t, class M1t>
1574 bits(const M0t &M0, const M1t &M1) : Option(ZeroOrMore, NotHidden) {
1575 apply(M0, this); apply(M1, this);
1579 template<class M0t, class M1t, class M2t>
1580 bits(const M0t &M0, const M1t &M1, const M2t &M2)
1581 : Option(ZeroOrMore, NotHidden) {
1582 apply(M0, this); apply(M1, this); apply(M2, this);
1586 template<class M0t, class M1t, class M2t, class M3t>
1587 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1588 : Option(ZeroOrMore, NotHidden) {
1589 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1593 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1594 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1595 const M4t &M4) : Option(ZeroOrMore, NotHidden) {
1596 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1601 template<class M0t, class M1t, class M2t, class M3t,
1602 class M4t, class M5t>
1603 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1604 const M4t &M4, const M5t &M5) : Option(ZeroOrMore, NotHidden) {
1605 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1606 apply(M4, this); apply(M5, this);
1610 template<class M0t, class M1t, class M2t, class M3t,
1611 class M4t, class M5t, class M6t>
1612 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1613 const M4t &M4, const M5t &M5, const M6t &M6)
1614 : Option(ZeroOrMore, NotHidden) {
1615 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1616 apply(M4, this); apply(M5, this); apply(M6, this);
1620 template<class M0t, class M1t, class M2t, class M3t,
1621 class M4t, class M5t, class M6t, class M7t>
1622 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1623 const M4t &M4, const M5t &M5, const M6t &M6,
1624 const M7t &M7) : Option(ZeroOrMore, NotHidden) {
1625 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1626 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1631 //===----------------------------------------------------------------------===//
1632 // Aliased command line option (alias this name to a preexisting name)
1635 class alias : public Option {
1637 virtual bool handleOccurrence(unsigned pos, StringRef /*ArgName*/,
1638 StringRef Arg) LLVM_OVERRIDE {
1639 return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1641 // Handle printing stuff...
1642 virtual size_t getOptionWidth() const LLVM_OVERRIDE;
1643 virtual void printOptionInfo(size_t GlobalWidth) const LLVM_OVERRIDE;
1645 // Aliases do not need to print their values.
1646 virtual void printOptionValue(size_t /*GlobalWidth*/,
1647 bool /*Force*/) const LLVM_OVERRIDE {}
1651 error("cl::alias must have argument name specified!");
1653 error("cl::alias must have an cl::aliasopt(option) specified!");
1657 void setAliasFor(Option &O) {
1659 error("cl::alias must only have one cl::aliasopt(...) specified!");
1665 explicit alias(const M0t &M0) : Option(Optional, Hidden), AliasFor(0) {
1670 template<class M0t, class M1t>
1671 alias(const M0t &M0, const M1t &M1) : Option(Optional, Hidden), AliasFor(0) {
1672 apply(M0, this); apply(M1, this);
1676 template<class M0t, class M1t, class M2t>
1677 alias(const M0t &M0, const M1t &M1, const M2t &M2)
1678 : Option(Optional, Hidden), AliasFor(0) {
1679 apply(M0, this); apply(M1, this); apply(M2, this);
1683 template<class M0t, class M1t, class M2t, class M3t>
1684 alias(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1685 : Option(Optional, Hidden), AliasFor(0) {
1686 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1691 // aliasfor - Modifier to set the option an alias aliases.
1694 explicit aliasopt(Option &O) : Opt(O) {}
1695 void apply(alias &A) const { A.setAliasFor(Opt); }
1698 // extrahelp - provide additional help at the end of the normal help
1699 // output. All occurrences of cl::extrahelp will be accumulated and
1700 // printed to stderr at the end of the regular help, just before
1703 const char * morehelp;
1704 explicit extrahelp(const char* help);
1707 void PrintVersionMessage();
1709 /// This function just prints the help message, exactly the same way as if the
1710 /// -help or -help-hidden option had been given on the command line.
1712 /// NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1714 /// \param Hidden if true will print hidden options
1715 /// \param Categorized if true print options in categories
1716 void PrintHelpMessage(bool Hidden=false, bool Categorized=false);
1719 //===----------------------------------------------------------------------===//
1720 // Public interface for accessing registered options.
1723 /// \brief Use this to get a StringMap to all registered named options
1724 /// (e.g. -help). Note \p Map Should be an empty StringMap.
1726 /// \param [out] Map will be filled with mappings where the key is the
1727 /// Option argument string (e.g. "help") and value is the corresponding
1730 /// Access to unnamed arguments (i.e. positional) are not provided because
1731 /// it is expected that the client already has access to these.
1735 /// main(int argc,char* argv[]) {
1736 /// StringMap<llvm::cl::Option*> opts;
1737 /// llvm::cl::getRegisteredOptions(opts);
1738 /// assert(opts.count("help") == 1)
1739 /// opts["help"]->setDescription("Show alphabetical help information")
1741 /// llvm::cl::ParseCommandLineOptions(argc,argv);
1746 /// This interface is useful for modifying options in libraries that are out of
1747 /// the control of the client. The options should be modified before calling
1748 /// llvm::cl::ParseCommandLineOptions().
1749 void getRegisteredOptions(StringMap<Option*> &Map);
1751 //===----------------------------------------------------------------------===//
1752 // Standalone command line processing utilities.
1755 /// \brief Saves strings in the inheritor's stable storage and returns a stable
1756 /// raw character pointer.
1758 virtual void anchor();
1760 virtual const char *SaveString(const char *Str) = 0;
1761 virtual ~StringSaver() {}; // Pacify -Wnon-virtual-dtor.
1764 /// \brief Tokenizes a command line that can contain escapes and quotes.
1766 /// The quoting rules match those used by GCC and other tools that use
1767 /// libiberty's buildargv() or expandargv() utilities, and do not match bash.
1768 /// They differ from buildargv() on treatment of backslashes that do not escape
1769 /// a special character to make it possible to accept most Windows file paths.
1771 /// \param [in] Source The string to be split on whitespace with quotes.
1772 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1773 /// \param [out] NewArgv All parsed strings are appended to NewArgv.
1774 void TokenizeGNUCommandLine(StringRef Source, StringSaver &Saver,
1775 SmallVectorImpl<const char *> &NewArgv);
1777 /// \brief Tokenizes a Windows command line which may contain quotes and escaped
1780 /// See MSDN docs for CommandLineToArgvW for information on the quoting rules.
1781 /// http://msdn.microsoft.com/en-us/library/windows/desktop/17w5ykft(v=vs.85).aspx
1783 /// \param [in] Source The string to be split on whitespace with quotes.
1784 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1785 /// \param [out] NewArgv All parsed strings are appended to NewArgv.
1786 void TokenizeWindowsCommandLine(StringRef Source, StringSaver &Saver,
1787 SmallVectorImpl<const char *> &NewArgv);
1789 /// \brief String tokenization function type. Should be compatible with either
1790 /// Windows or Unix command line tokenizers.
1791 typedef void (*TokenizerCallback)(StringRef Source, StringSaver &Saver,
1792 SmallVectorImpl<const char *> &NewArgv);
1794 /// \brief Expand response files on a command line recursively using the given
1795 /// StringSaver and tokenization strategy. Argv should contain the command line
1796 /// before expansion and will be modified in place.
1798 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1799 /// \param [in] Tokenizer Tokenization strategy. Typically Unix or Windows.
1800 /// \param [in,out] Argv Command line into which to expand response files.
1801 /// \return true if all @files were expanded successfully or there were none.
1802 bool ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
1803 SmallVectorImpl<const char *> &Argv);
1805 } // End namespace cl
1807 } // End namespace llvm