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/Twine.h"
25 #include "llvm/Support/Compiler.h"
26 #include "llvm/Support/type_traits.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, const char * const *argv,
44 const char *Overview = 0);
46 //===----------------------------------------------------------------------===//
47 // ParseEnvironmentOptions - Environment variable option processing alternate
50 void ParseEnvironmentOptions(const char *progName, const char *envvar,
51 const char *Overview = 0);
53 ///===---------------------------------------------------------------------===//
54 /// SetVersionPrinter - Override the default (LLVM specific) version printer
55 /// used to print out the version when --version is given
56 /// on the command line. This allows other systems using the
57 /// CommandLine utilities to print their own version string.
58 void SetVersionPrinter(void (*func)());
60 ///===---------------------------------------------------------------------===//
61 /// AddExtraVersionPrinter - Add an extra printer to use in addition to the
62 /// default one. This can be called multiple times,
63 /// and each time it adds a new function to the list
64 /// which will be called after the basic LLVM version
65 /// printing is complete. Each can then add additional
66 /// information specific to the tool.
67 void AddExtraVersionPrinter(void (*func)());
70 // PrintOptionValues - Print option values.
71 // With -print-options print the difference between option values and defaults.
72 // With -print-all-options print all option values.
73 // (Currently not perfect, but best-effort.)
74 void PrintOptionValues();
76 // MarkOptionsChanged - Internal helper function.
77 void MarkOptionsChanged();
79 //===----------------------------------------------------------------------===//
80 // Flags permitted to be passed to command line arguments
83 enum NumOccurrencesFlag { // Flags for the number of occurrences allowed
84 Optional = 0x00, // Zero or One occurrence
85 ZeroOrMore = 0x01, // Zero or more occurrences allowed
86 Required = 0x02, // One occurrence required
87 OneOrMore = 0x03, // One or more occurrences required
89 // ConsumeAfter - Indicates that this option is fed anything that follows the
90 // last positional argument required by the application (it is an error if
91 // there are zero positional arguments, and a ConsumeAfter option is used).
92 // Thus, for example, all arguments to LLI are processed until a filename is
93 // found. Once a filename is found, all of the succeeding arguments are
94 // passed, unprocessed, to the ConsumeAfter option.
99 enum ValueExpected { // Is a value required for the option?
100 // zero reserved for the unspecified value
101 ValueOptional = 0x01, // The value can appear... or not
102 ValueRequired = 0x02, // The value is required to appear!
103 ValueDisallowed = 0x03 // A value may not be specified (for flags)
106 enum OptionHidden { // Control whether -help shows this option
107 NotHidden = 0x00, // Option included in -help & -help-hidden
108 Hidden = 0x01, // -help doesn't, but -help-hidden does
109 ReallyHidden = 0x02 // Neither -help nor -help-hidden show this arg
112 // Formatting flags - This controls special features that the option might have
113 // that cause it to be parsed differently...
115 // Prefix - This option allows arguments that are otherwise unrecognized to be
116 // matched by options that are a prefix of the actual value. This is useful for
117 // cases like a linker, where options are typically of the form '-lfoo' or
118 // '-L../../include' where -l or -L are the actual flags. When prefix is
119 // enabled, and used, the value for the flag comes from the suffix of the
122 // Grouping - With this option enabled, multiple letter options are allowed to
123 // bunch together with only a single hyphen for the whole group. This allows
124 // emulation of the behavior that ls uses for example: ls -la === ls -l -a
127 enum FormattingFlags {
128 NormalFormatting = 0x00, // Nothing special
129 Positional = 0x01, // Is a positional argument, no '-' required
130 Prefix = 0x02, // Can this option directly prefix its value?
131 Grouping = 0x03 // Can this option group with other options?
134 enum MiscFlags { // Miscellaneous flags to adjust argument
135 CommaSeparated = 0x01, // Should this cl::list split between commas?
136 PositionalEatsArgs = 0x02, // Should this positional cl::list eat -args?
137 Sink = 0x04 // Should this cl::list eat all unknown options?
142 //===----------------------------------------------------------------------===//
149 // handleOccurrences - Overriden by subclasses to handle the value passed into
150 // an argument. Should return true if there was an error processing the
151 // argument and the program should exit.
153 virtual bool handleOccurrence(unsigned pos, StringRef ArgName,
156 virtual enum ValueExpected getValueExpectedFlagDefault() const {
157 return ValueOptional;
160 // Out of line virtual function to provide home for the class.
161 virtual void anchor();
163 int NumOccurrences; // The number of times specified
164 // Occurrences, HiddenFlag, and Formatting are all enum types but to avoid
165 // problems with signed enums in bitfields.
166 unsigned Occurrences : 3; // enum NumOccurrencesFlag
167 // not using the enum type for 'Value' because zero is an implementation
168 // detail representing the non-value
170 unsigned HiddenFlag : 2; // enum OptionHidden
171 unsigned Formatting : 2; // enum FormattingFlags
173 unsigned Position; // Position of last occurrence of the option
174 unsigned AdditionalVals;// Greater than 0 for multi-valued option.
175 Option *NextRegistered; // Singly linked list of registered options.
177 const char *ArgStr; // The argument string itself (ex: "help", "o")
178 const char *HelpStr; // The descriptive text message for -help
179 const char *ValueStr; // String describing what the value of this option is
181 inline enum NumOccurrencesFlag getNumOccurrencesFlag() const {
182 return (enum NumOccurrencesFlag)Occurrences;
184 inline enum ValueExpected getValueExpectedFlag() const {
185 return Value ? ((enum ValueExpected)Value)
186 : getValueExpectedFlagDefault();
188 inline enum OptionHidden getOptionHiddenFlag() const {
189 return (enum OptionHidden)HiddenFlag;
191 inline enum FormattingFlags getFormattingFlag() const {
192 return (enum FormattingFlags)Formatting;
194 inline unsigned getMiscFlags() const {
197 inline unsigned getPosition() const { return Position; }
198 inline unsigned getNumAdditionalVals() const { return AdditionalVals; }
200 // hasArgStr - Return true if the argstr != ""
201 bool hasArgStr() const { return ArgStr[0] != 0; }
203 //-------------------------------------------------------------------------===
204 // Accessor functions set by OptionModifiers
206 void setArgStr(const char *S) { ArgStr = S; }
207 void setDescription(const char *S) { HelpStr = S; }
208 void setValueStr(const char *S) { ValueStr = S; }
209 void setNumOccurrencesFlag(enum NumOccurrencesFlag Val) {
212 void setValueExpectedFlag(enum ValueExpected Val) { Value = Val; }
213 void setHiddenFlag(enum OptionHidden Val) { HiddenFlag = Val; }
214 void setFormattingFlag(enum FormattingFlags V) { Formatting = V; }
215 void setMiscFlag(enum MiscFlags M) { Misc |= M; }
216 void setPosition(unsigned pos) { Position = pos; }
218 explicit Option(enum NumOccurrencesFlag OccurrencesFlag,
219 enum OptionHidden Hidden)
220 : NumOccurrences(0), Occurrences(OccurrencesFlag), Value(0),
221 HiddenFlag(Hidden), Formatting(NormalFormatting), Misc(0),
222 Position(0), AdditionalVals(0), NextRegistered(0),
223 ArgStr(""), HelpStr(""), ValueStr("") {
226 inline void setNumAdditionalVals(unsigned n) { AdditionalVals = n; }
228 // addArgument - Register this argument with the commandline system.
232 Option *getNextRegisteredOption() const { return NextRegistered; }
234 // Return the width of the option tag for printing...
235 virtual size_t getOptionWidth() const = 0;
237 // printOptionInfo - Print out information about this option. The
238 // to-be-maintained width is specified.
240 virtual void printOptionInfo(size_t GlobalWidth) const = 0;
242 virtual void printOptionValue(size_t GlobalWidth, bool Force) const = 0;
244 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &) {}
246 // addOccurrence - Wrapper around handleOccurrence that enforces Flags.
248 bool addOccurrence(unsigned pos, StringRef ArgName,
249 StringRef Value, bool MultiArg = false);
251 // Prints option name followed by message. Always returns true.
252 bool error(const Twine &Message, StringRef ArgName = StringRef());
255 inline int getNumOccurrences() const { return NumOccurrences; }
260 //===----------------------------------------------------------------------===//
261 // Command line option modifiers that can be used to modify the behavior of
262 // command line option parsers...
265 // desc - Modifier to set the description shown in the -help output...
268 desc(const char *Str) : Desc(Str) {}
269 void apply(Option &O) const { O.setDescription(Desc); }
272 // value_desc - Modifier to set the value description shown in the -help
276 value_desc(const char *Str) : Desc(Str) {}
277 void apply(Option &O) const { O.setValueStr(Desc); }
280 // init - Specify a default (initial) value for the command line argument, if
281 // the default constructor for the argument type does not give you what you
282 // want. This is only valid on "opt" arguments, not on "list" arguments.
287 initializer(const Ty &Val) : Init(Val) {}
290 void apply(Opt &O) const { O.setInitialValue(Init); }
294 initializer<Ty> init(const Ty &Val) {
295 return initializer<Ty>(Val);
299 // location - Allow the user to specify which external variable they want to
300 // store the results of the command line argument processing into, if they don't
301 // want to store it in the option itself.
304 struct LocationClass {
306 LocationClass(Ty &L) : Loc(L) {}
309 void apply(Opt &O) const { O.setLocation(O, Loc); }
313 LocationClass<Ty> location(Ty &L) { return LocationClass<Ty>(L); }
316 //===----------------------------------------------------------------------===//
319 // Support value comparison outside the template.
320 struct GenericOptionValue {
321 virtual ~GenericOptionValue() {}
322 virtual bool compare(const GenericOptionValue &V) const = 0;
324 virtual void anchor();
327 template<class DataType> struct OptionValue;
329 // The default value safely does nothing. Option value printing is only
331 template<class DataType, bool isClass>
332 struct OptionValueBase : public GenericOptionValue {
333 // Temporary storage for argument passing.
334 typedef OptionValue<DataType> WrapperType;
336 bool hasValue() const { return false; }
338 const DataType &getValue() const { llvm_unreachable("no default value"); }
340 // Some options may take their value from a different data type.
342 void setValue(const DT& /*V*/) {}
344 bool compare(const DataType &/*V*/) const { return false; }
346 virtual bool compare(const GenericOptionValue& /*V*/) const { return false; }
349 // Simple copy of the option value.
350 template<class DataType>
351 class OptionValueCopy : public GenericOptionValue {
355 OptionValueCopy() : Valid(false) {}
357 bool hasValue() const { return Valid; }
359 const DataType &getValue() const {
360 assert(Valid && "invalid option value");
364 void setValue(const DataType &V) { Valid = true; Value = V; }
366 bool compare(const DataType &V) const {
367 return Valid && (Value != V);
370 virtual bool compare(const GenericOptionValue &V) const {
371 const OptionValueCopy<DataType> &VC =
372 static_cast< const OptionValueCopy<DataType>& >(V);
373 if (!VC.hasValue()) return false;
374 return compare(VC.getValue());
378 // Non-class option values.
379 template<class DataType>
380 struct OptionValueBase<DataType, false> : OptionValueCopy<DataType> {
381 typedef DataType WrapperType;
384 // Top-level option class.
385 template<class DataType>
386 struct OptionValue : OptionValueBase<DataType, is_class<DataType>::value> {
389 OptionValue(const DataType& V) {
392 // Some options may take their value from a different data type.
394 OptionValue<DataType> &operator=(const DT& V) {
400 // Other safe-to-copy-by-value common option types.
401 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
403 struct OptionValue<cl::boolOrDefault> : OptionValueCopy<cl::boolOrDefault> {
404 typedef cl::boolOrDefault WrapperType;
408 OptionValue(const cl::boolOrDefault& V) {
411 OptionValue<cl::boolOrDefault> &operator=(const cl::boolOrDefault& V) {
416 virtual void anchor();
420 struct OptionValue<std::string> : OptionValueCopy<std::string> {
421 typedef StringRef WrapperType;
425 OptionValue(const std::string& V) {
428 OptionValue<std::string> &operator=(const std::string& V) {
433 virtual void anchor();
436 //===----------------------------------------------------------------------===//
437 // Enum valued command line option
439 #define clEnumVal(ENUMVAL, DESC) #ENUMVAL, int(ENUMVAL), DESC
440 #define clEnumValN(ENUMVAL, FLAGNAME, DESC) FLAGNAME, int(ENUMVAL), DESC
441 #define clEnumValEnd (reinterpret_cast<void*>(0))
443 // values - For custom data types, allow specifying a group of values together
444 // as the values that go into the mapping that the option handler uses. Note
445 // that the values list must always have a 0 at the end of the list to indicate
446 // that the list has ended.
448 template<class DataType>
450 // Use a vector instead of a map, because the lists should be short,
451 // the overhead is less, and most importantly, it keeps them in the order
452 // inserted so we can print our option out nicely.
453 SmallVector<std::pair<const char *, std::pair<int, const char *> >,4> Values;
454 void processValues(va_list Vals);
456 ValuesClass(const char *EnumName, DataType Val, const char *Desc,
458 // Insert the first value, which is required.
459 Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc)));
461 // Process the varargs portion of the values...
462 while (const char *enumName = va_arg(ValueArgs, const char *)) {
463 DataType EnumVal = static_cast<DataType>(va_arg(ValueArgs, int));
464 const char *EnumDesc = va_arg(ValueArgs, const char *);
465 Values.push_back(std::make_pair(enumName, // Add value to value map
466 std::make_pair(EnumVal, EnumDesc)));
471 void apply(Opt &O) const {
472 for (size_t i = 0, e = Values.size(); i != e; ++i)
473 O.getParser().addLiteralOption(Values[i].first, Values[i].second.first,
474 Values[i].second.second);
478 template<class DataType>
479 ValuesClass<DataType> END_WITH_NULL values(const char *Arg, DataType Val,
480 const char *Desc, ...) {
482 va_start(ValueArgs, Desc);
483 ValuesClass<DataType> Vals(Arg, Val, Desc, ValueArgs);
488 //===----------------------------------------------------------------------===//
489 // parser class - Parameterizable parser for different data types. By default,
490 // known data types (string, int, bool) have specialized parsers, that do what
491 // you would expect. The default parser, used for data types that are not
492 // built-in, uses a mapping table to map specific options to values, which is
493 // used, among other things, to handle enum types.
495 //--------------------------------------------------
496 // generic_parser_base - This class holds all the non-generic code that we do
497 // not need replicated for every instance of the generic parser. This also
498 // allows us to put stuff into CommandLine.cpp
500 class generic_parser_base {
502 class GenericOptionInfo {
504 GenericOptionInfo(const char *name, const char *helpStr) :
505 Name(name), HelpStr(helpStr) {}
510 virtual ~generic_parser_base() {} // Base class should have virtual-dtor
512 // getNumOptions - Virtual function implemented by generic subclass to
513 // indicate how many entries are in Values.
515 virtual unsigned getNumOptions() const = 0;
517 // getOption - Return option name N.
518 virtual const char *getOption(unsigned N) const = 0;
520 // getDescription - Return description N
521 virtual const char *getDescription(unsigned N) const = 0;
523 // Return the width of the option tag for printing...
524 virtual size_t getOptionWidth(const Option &O) const;
526 virtual const GenericOptionValue &getOptionValue(unsigned N) const = 0;
528 // printOptionInfo - Print out information about this option. The
529 // to-be-maintained width is specified.
531 virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const;
533 void printGenericOptionDiff(const Option &O, const GenericOptionValue &V,
534 const GenericOptionValue &Default,
535 size_t GlobalWidth) const;
537 // printOptionDiff - print the value of an option and it's default.
539 // Template definition ensures that the option and default have the same
540 // DataType (via the same AnyOptionValue).
541 template<class AnyOptionValue>
542 void printOptionDiff(const Option &O, const AnyOptionValue &V,
543 const AnyOptionValue &Default,
544 size_t GlobalWidth) const {
545 printGenericOptionDiff(O, V, Default, GlobalWidth);
548 void initialize(Option &O) {
549 // All of the modifiers for the option have been processed by now, so the
550 // argstr field should be stable, copy it down now.
552 hasArgStr = O.hasArgStr();
555 void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
556 // If there has been no argstr specified, that means that we need to add an
557 // argument for every possible option. This ensures that our options are
560 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
561 OptionNames.push_back(getOption(i));
565 enum ValueExpected getValueExpectedFlagDefault() const {
566 // If there is an ArgStr specified, then we are of the form:
568 // -opt=O2 or -opt O2 or -optO2
570 // In which case, the value is required. Otherwise if an arg str has not
571 // been specified, we are of the form:
573 // -O2 or O2 or -la (where -l and -a are separate options)
575 // If this is the case, we cannot allow a value.
578 return ValueRequired;
580 return ValueDisallowed;
583 // findOption - Return the option number corresponding to the specified
584 // argument string. If the option is not found, getNumOptions() is returned.
586 unsigned findOption(const char *Name);
592 // Default parser implementation - This implementation depends on having a
593 // mapping of recognized options to values of some sort. In addition to this,
594 // each entry in the mapping also tracks a help message that is printed with the
595 // command line option for -help. Because this is a simple mapping parser, the
596 // data type can be any unsupported type.
598 template <class DataType>
599 class parser : public generic_parser_base {
601 class OptionInfo : public GenericOptionInfo {
603 OptionInfo(const char *name, DataType v, const char *helpStr) :
604 GenericOptionInfo(name, helpStr), V(v) {}
605 OptionValue<DataType> V;
607 SmallVector<OptionInfo, 8> Values;
609 typedef DataType parser_data_type;
611 // Implement virtual functions needed by generic_parser_base
612 unsigned getNumOptions() const { return unsigned(Values.size()); }
613 const char *getOption(unsigned N) const { return Values[N].Name; }
614 const char *getDescription(unsigned N) const {
615 return Values[N].HelpStr;
618 // getOptionValue - Return the value of option name N.
619 virtual const GenericOptionValue &getOptionValue(unsigned N) const {
623 // parse - Return true on error.
624 bool parse(Option &O, StringRef ArgName, StringRef Arg, DataType &V) {
631 for (size_t i = 0, e = Values.size(); i != e; ++i)
632 if (Values[i].Name == ArgVal) {
633 V = Values[i].V.getValue();
637 return O.error("Cannot find option named '" + ArgVal + "'!");
640 /// addLiteralOption - Add an entry to the mapping table.
643 void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) {
644 assert(findOption(Name) == Values.size() && "Option already exists!");
645 OptionInfo X(Name, static_cast<DataType>(V), HelpStr);
647 MarkOptionsChanged();
650 /// removeLiteralOption - Remove the specified option.
652 void removeLiteralOption(const char *Name) {
653 unsigned N = findOption(Name);
654 assert(N != Values.size() && "Option not found!");
655 Values.erase(Values.begin()+N);
659 //--------------------------------------------------
660 // basic_parser - Super class of parsers to provide boilerplate code
662 class basic_parser_impl { // non-template implementation of basic_parser<t>
664 virtual ~basic_parser_impl() {}
666 enum ValueExpected getValueExpectedFlagDefault() const {
667 return ValueRequired;
670 void getExtraOptionNames(SmallVectorImpl<const char*> &) {}
672 void initialize(Option &) {}
674 // Return the width of the option tag for printing...
675 size_t getOptionWidth(const Option &O) const;
677 // printOptionInfo - Print out information about this option. The
678 // to-be-maintained width is specified.
680 void printOptionInfo(const Option &O, size_t GlobalWidth) const;
682 // printOptionNoValue - Print a placeholder for options that don't yet support
683 // printOptionDiff().
684 void printOptionNoValue(const Option &O, size_t GlobalWidth) const;
686 // getValueName - Overload in subclass to provide a better default value.
687 virtual const char *getValueName() const { return "value"; }
689 // An out-of-line virtual method to provide a 'home' for this class.
690 virtual void anchor();
693 // A helper for basic_parser::printOptionDiff.
694 void printOptionName(const Option &O, size_t GlobalWidth) const;
697 // basic_parser - The real basic parser is just a template wrapper that provides
698 // a typedef for the provided data type.
700 template<class DataType>
701 class basic_parser : public basic_parser_impl {
703 typedef DataType parser_data_type;
704 typedef OptionValue<DataType> OptVal;
707 //--------------------------------------------------
711 class parser<bool> : public basic_parser<bool> {
715 // parse - Return true on error.
716 bool parse(Option &O, StringRef ArgName, StringRef Arg, bool &Val);
719 void initialize(Opt &O) {
723 enum ValueExpected getValueExpectedFlagDefault() const {
724 return ValueOptional;
727 // getValueName - Do not print =<value> at all.
728 virtual const char *getValueName() const { return 0; }
730 void printOptionDiff(const Option &O, bool V, OptVal Default,
731 size_t GlobalWidth) const;
733 // An out-of-line virtual method to provide a 'home' for this class.
734 virtual void anchor();
737 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
739 //--------------------------------------------------
740 // parser<boolOrDefault>
742 class parser<boolOrDefault> : public basic_parser<boolOrDefault> {
744 // parse - Return true on error.
745 bool parse(Option &O, StringRef ArgName, StringRef Arg, boolOrDefault &Val);
747 enum ValueExpected getValueExpectedFlagDefault() const {
748 return ValueOptional;
751 // getValueName - Do not print =<value> at all.
752 virtual const char *getValueName() const { return 0; }
754 void printOptionDiff(const Option &O, boolOrDefault V, OptVal Default,
755 size_t GlobalWidth) const;
757 // An out-of-line virtual method to provide a 'home' for this class.
758 virtual void anchor();
761 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
763 //--------------------------------------------------
767 class parser<int> : public basic_parser<int> {
769 // parse - Return true on error.
770 bool parse(Option &O, StringRef ArgName, StringRef Arg, int &Val);
772 // getValueName - Overload in subclass to provide a better default value.
773 virtual const char *getValueName() const { return "int"; }
775 void printOptionDiff(const Option &O, int V, OptVal Default,
776 size_t GlobalWidth) const;
778 // An out-of-line virtual method to provide a 'home' for this class.
779 virtual void anchor();
782 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
785 //--------------------------------------------------
789 class parser<unsigned> : public basic_parser<unsigned> {
791 // parse - Return true on error.
792 bool parse(Option &O, StringRef ArgName, StringRef Arg, unsigned &Val);
794 // getValueName - Overload in subclass to provide a better default value.
795 virtual const char *getValueName() const { return "uint"; }
797 void printOptionDiff(const Option &O, unsigned V, OptVal Default,
798 size_t GlobalWidth) const;
800 // An out-of-line virtual method to provide a 'home' for this class.
801 virtual void anchor();
804 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
806 //--------------------------------------------------
807 // parser<unsigned long long>
810 class parser<unsigned long long> : public basic_parser<unsigned long long> {
812 // parse - Return true on error.
813 bool parse(Option &O, StringRef ArgName, StringRef Arg,
814 unsigned long long &Val);
816 // getValueName - Overload in subclass to provide a better default value.
817 virtual const char *getValueName() const { return "uint"; }
819 void printOptionDiff(const Option &O, unsigned long long V, OptVal Default,
820 size_t GlobalWidth) const;
822 // An out-of-line virtual method to provide a 'home' for this class.
823 virtual void anchor();
826 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
828 //--------------------------------------------------
832 class parser<double> : public basic_parser<double> {
834 // parse - Return true on error.
835 bool parse(Option &O, StringRef ArgName, StringRef Arg, double &Val);
837 // getValueName - Overload in subclass to provide a better default value.
838 virtual const char *getValueName() const { return "number"; }
840 void printOptionDiff(const Option &O, double V, OptVal Default,
841 size_t GlobalWidth) const;
843 // An out-of-line virtual method to provide a 'home' for this class.
844 virtual void anchor();
847 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
849 //--------------------------------------------------
853 class parser<float> : public basic_parser<float> {
855 // parse - Return true on error.
856 bool parse(Option &O, StringRef ArgName, StringRef Arg, float &Val);
858 // getValueName - Overload in subclass to provide a better default value.
859 virtual const char *getValueName() const { return "number"; }
861 void printOptionDiff(const Option &O, float V, OptVal Default,
862 size_t GlobalWidth) const;
864 // An out-of-line virtual method to provide a 'home' for this class.
865 virtual void anchor();
868 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
870 //--------------------------------------------------
871 // parser<std::string>
874 class parser<std::string> : public basic_parser<std::string> {
876 // parse - Return true on error.
877 bool parse(Option &, StringRef, StringRef Arg, std::string &Value) {
882 // getValueName - Overload in subclass to provide a better default value.
883 virtual const char *getValueName() const { return "string"; }
885 void printOptionDiff(const Option &O, StringRef V, OptVal Default,
886 size_t GlobalWidth) const;
888 // An out-of-line virtual method to provide a 'home' for this class.
889 virtual void anchor();
892 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
894 //--------------------------------------------------
898 class parser<char> : public basic_parser<char> {
900 // parse - Return true on error.
901 bool parse(Option &, StringRef, StringRef Arg, char &Value) {
906 // getValueName - Overload in subclass to provide a better default value.
907 virtual const char *getValueName() const { return "char"; }
909 void printOptionDiff(const Option &O, char V, OptVal Default,
910 size_t GlobalWidth) const;
912 // An out-of-line virtual method to provide a 'home' for this class.
913 virtual void anchor();
916 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<char>);
918 //--------------------------------------------------
921 // This collection of wrappers is the intermediary between class opt and class
922 // parser to handle all the template nastiness.
924 // This overloaded function is selected by the generic parser.
925 template<class ParserClass, class DT>
926 void printOptionDiff(const Option &O, const generic_parser_base &P, const DT &V,
927 const OptionValue<DT> &Default, size_t GlobalWidth) {
928 OptionValue<DT> OV = V;
929 P.printOptionDiff(O, OV, Default, GlobalWidth);
932 // This is instantiated for basic parsers when the parsed value has a different
933 // type than the option value. e.g. HelpPrinter.
934 template<class ParserDT, class ValDT>
935 struct OptionDiffPrinter {
936 void print(const Option &O, const parser<ParserDT> P, const ValDT &/*V*/,
937 const OptionValue<ValDT> &/*Default*/, size_t GlobalWidth) {
938 P.printOptionNoValue(O, GlobalWidth);
942 // This is instantiated for basic parsers when the parsed value has the same
943 // type as the option value.
945 struct OptionDiffPrinter<DT, DT> {
946 void print(const Option &O, const parser<DT> P, const DT &V,
947 const OptionValue<DT> &Default, size_t GlobalWidth) {
948 P.printOptionDiff(O, V, Default, GlobalWidth);
952 // This overloaded function is selected by the basic parser, which may parse a
953 // different type than the option type.
954 template<class ParserClass, class ValDT>
955 void printOptionDiff(
957 const basic_parser<typename ParserClass::parser_data_type> &P,
958 const ValDT &V, const OptionValue<ValDT> &Default,
959 size_t GlobalWidth) {
961 OptionDiffPrinter<typename ParserClass::parser_data_type, ValDT> printer;
962 printer.print(O, static_cast<const ParserClass&>(P), V, Default,
966 //===----------------------------------------------------------------------===//
967 // applicator class - This class is used because we must use partial
968 // specialization to handle literal string arguments specially (const char* does
969 // not correctly respond to the apply method). Because the syntax to use this
970 // is a pain, we have the 'apply' method below to handle the nastiness...
972 template<class Mod> struct applicator {
974 static void opt(const Mod &M, Opt &O) { M.apply(O); }
977 // Handle const char* as a special case...
978 template<unsigned n> struct applicator<char[n]> {
980 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
982 template<unsigned n> struct applicator<const char[n]> {
984 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
986 template<> struct applicator<const char*> {
988 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
991 template<> struct applicator<NumOccurrencesFlag> {
992 static void opt(NumOccurrencesFlag NO, Option &O) {
993 O.setNumOccurrencesFlag(NO);
996 template<> struct applicator<ValueExpected> {
997 static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
999 template<> struct applicator<OptionHidden> {
1000 static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
1002 template<> struct applicator<FormattingFlags> {
1003 static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
1005 template<> struct applicator<MiscFlags> {
1006 static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
1009 // apply method - Apply a modifier to an option in a type safe way.
1010 template<class Mod, class Opt>
1011 void apply(const Mod &M, Opt *O) {
1012 applicator<Mod>::opt(M, *O);
1015 //===----------------------------------------------------------------------===//
1016 // opt_storage class
1018 // Default storage class definition: external storage. This implementation
1019 // assumes the user will specify a variable to store the data into with the
1020 // cl::location(x) modifier.
1022 template<class DataType, bool ExternalStorage, bool isClass>
1024 DataType *Location; // Where to store the object...
1025 OptionValue<DataType> Default;
1027 void check() const {
1028 assert(Location != 0 && "cl::location(...) not specified for a command "
1029 "line option with external storage, "
1030 "or cl::init specified before cl::location()!!");
1033 opt_storage() : Location(0) {}
1035 bool setLocation(Option &O, DataType &L) {
1037 return O.error("cl::location(x) specified more than once!");
1044 void setValue(const T &V, bool initial = false) {
1051 DataType &getValue() { check(); return *Location; }
1052 const DataType &getValue() const { check(); return *Location; }
1054 operator DataType() const { return this->getValue(); }
1056 const OptionValue<DataType> &getDefault() const { return Default; }
1059 // Define how to hold a class type object, such as a string. Since we can
1060 // inherit from a class, we do so. This makes us exactly compatible with the
1061 // object in all cases that it is used.
1063 template<class DataType>
1064 class opt_storage<DataType,false,true> : public DataType {
1066 OptionValue<DataType> Default;
1069 void setValue(const T &V, bool initial = false) {
1070 DataType::operator=(V);
1075 DataType &getValue() { return *this; }
1076 const DataType &getValue() const { return *this; }
1078 const OptionValue<DataType> &getDefault() const { return Default; }
1081 // Define a partial specialization to handle things we cannot inherit from. In
1082 // this case, we store an instance through containment, and overload operators
1083 // to get at the value.
1085 template<class DataType>
1086 class opt_storage<DataType, false, false> {
1089 OptionValue<DataType> Default;
1091 // Make sure we initialize the value with the default constructor for the
1093 opt_storage() : Value(DataType()), Default(DataType()) {}
1096 void setValue(const T &V, bool initial = false) {
1101 DataType &getValue() { return Value; }
1102 DataType getValue() const { return Value; }
1104 const OptionValue<DataType> &getDefault() const { return Default; }
1106 operator DataType() const { return getValue(); }
1108 // If the datatype is a pointer, support -> on it.
1109 DataType operator->() const { return Value; }
1113 //===----------------------------------------------------------------------===//
1114 // opt - A scalar command line option.
1116 template <class DataType, bool ExternalStorage = false,
1117 class ParserClass = parser<DataType> >
1118 class opt : public Option,
1119 public opt_storage<DataType, ExternalStorage,
1120 is_class<DataType>::value> {
1123 virtual bool handleOccurrence(unsigned pos, StringRef ArgName,
1125 typename ParserClass::parser_data_type Val =
1126 typename ParserClass::parser_data_type();
1127 if (Parser.parse(*this, ArgName, Arg, Val))
1128 return true; // Parse error!
1129 this->setValue(Val);
1130 this->setPosition(pos);
1134 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1135 return Parser.getValueExpectedFlagDefault();
1137 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
1138 return Parser.getExtraOptionNames(OptionNames);
1141 // Forward printing stuff to the parser...
1142 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1143 virtual void printOptionInfo(size_t GlobalWidth) const {
1144 Parser.printOptionInfo(*this, GlobalWidth);
1147 virtual void printOptionValue(size_t GlobalWidth, bool Force) const {
1148 if (Force || this->getDefault().compare(this->getValue())) {
1149 cl::printOptionDiff<ParserClass>(
1150 *this, Parser, this->getValue(), this->getDefault(), GlobalWidth);
1156 Parser.initialize(*this);
1159 // setInitialValue - Used by the cl::init modifier...
1160 void setInitialValue(const DataType &V) { this->setValue(V, true); }
1162 ParserClass &getParser() { return Parser; }
1165 DataType &operator=(const T &Val) {
1166 this->setValue(Val);
1167 return this->getValue();
1172 explicit opt(const M0t &M0) : Option(Optional, NotHidden) {
1178 template<class M0t, class M1t>
1179 opt(const M0t &M0, const M1t &M1) : Option(Optional, NotHidden) {
1180 apply(M0, this); apply(M1, this);
1185 template<class M0t, class M1t, class M2t>
1186 opt(const M0t &M0, const M1t &M1,
1187 const M2t &M2) : Option(Optional, NotHidden) {
1188 apply(M0, this); apply(M1, this); apply(M2, this);
1192 template<class M0t, class M1t, class M2t, class M3t>
1193 opt(const M0t &M0, const M1t &M1, const M2t &M2,
1194 const M3t &M3) : Option(Optional, NotHidden) {
1195 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1199 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1200 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1201 const M4t &M4) : Option(Optional, NotHidden) {
1202 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1207 template<class M0t, class M1t, class M2t, class M3t,
1208 class M4t, class M5t>
1209 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1210 const M4t &M4, const M5t &M5) : Option(Optional, NotHidden) {
1211 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1212 apply(M4, this); apply(M5, this);
1216 template<class M0t, class M1t, class M2t, class M3t,
1217 class M4t, class M5t, class M6t>
1218 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1219 const M4t &M4, const M5t &M5,
1220 const M6t &M6) : Option(Optional, NotHidden) {
1221 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1222 apply(M4, this); apply(M5, this); apply(M6, this);
1226 template<class M0t, class M1t, class M2t, class M3t,
1227 class M4t, class M5t, class M6t, class M7t>
1228 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1229 const M4t &M4, const M5t &M5, const M6t &M6,
1230 const M7t &M7) : Option(Optional, NotHidden) {
1231 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1232 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1237 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
1238 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
1239 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
1240 EXTERN_TEMPLATE_INSTANTIATION(class opt<char>);
1241 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
1243 //===----------------------------------------------------------------------===//
1244 // list_storage class
1246 // Default storage class definition: external storage. This implementation
1247 // assumes the user will specify a variable to store the data into with the
1248 // cl::location(x) modifier.
1250 template<class DataType, class StorageClass>
1251 class list_storage {
1252 StorageClass *Location; // Where to store the object...
1255 list_storage() : Location(0) {}
1257 bool setLocation(Option &O, StorageClass &L) {
1259 return O.error("cl::location(x) specified more than once!");
1265 void addValue(const T &V) {
1266 assert(Location != 0 && "cl::location(...) not specified for a command "
1267 "line option with external storage!");
1268 Location->push_back(V);
1273 // Define how to hold a class type object, such as a string. Since we can
1274 // inherit from a class, we do so. This makes us exactly compatible with the
1275 // object in all cases that it is used.
1277 template<class DataType>
1278 class list_storage<DataType, bool> : public std::vector<DataType> {
1281 void addValue(const T &V) { std::vector<DataType>::push_back(V); }
1285 //===----------------------------------------------------------------------===//
1286 // list - A list of command line options.
1288 template <class DataType, class Storage = bool,
1289 class ParserClass = parser<DataType> >
1290 class list : public Option, public list_storage<DataType, Storage> {
1291 std::vector<unsigned> Positions;
1294 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1295 return Parser.getValueExpectedFlagDefault();
1297 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
1298 return Parser.getExtraOptionNames(OptionNames);
1301 virtual bool handleOccurrence(unsigned pos, StringRef ArgName, StringRef Arg){
1302 typename ParserClass::parser_data_type Val =
1303 typename ParserClass::parser_data_type();
1304 if (Parser.parse(*this, ArgName, Arg, Val))
1305 return true; // Parse Error!
1306 list_storage<DataType, Storage>::addValue(Val);
1308 Positions.push_back(pos);
1312 // Forward printing stuff to the parser...
1313 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1314 virtual void printOptionInfo(size_t GlobalWidth) const {
1315 Parser.printOptionInfo(*this, GlobalWidth);
1318 // Unimplemented: list options don't currently store their default value.
1319 virtual void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const {}
1323 Parser.initialize(*this);
1326 ParserClass &getParser() { return Parser; }
1328 unsigned getPosition(unsigned optnum) const {
1329 assert(optnum < this->size() && "Invalid option index");
1330 return Positions[optnum];
1333 void setNumAdditionalVals(unsigned n) {
1334 Option::setNumAdditionalVals(n);
1339 explicit list(const M0t &M0) : Option(ZeroOrMore, NotHidden) {
1344 template<class M0t, class M1t>
1345 list(const M0t &M0, const M1t &M1) : Option(ZeroOrMore, NotHidden) {
1346 apply(M0, this); apply(M1, this);
1350 template<class M0t, class M1t, class M2t>
1351 list(const M0t &M0, const M1t &M1, const M2t &M2)
1352 : Option(ZeroOrMore, NotHidden) {
1353 apply(M0, this); apply(M1, this); apply(M2, this);
1357 template<class M0t, class M1t, class M2t, class M3t>
1358 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1359 : Option(ZeroOrMore, NotHidden) {
1360 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1364 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1365 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1366 const M4t &M4) : Option(ZeroOrMore, NotHidden) {
1367 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1372 template<class M0t, class M1t, class M2t, class M3t,
1373 class M4t, class M5t>
1374 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1375 const M4t &M4, const M5t &M5) : Option(ZeroOrMore, NotHidden) {
1376 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1377 apply(M4, this); apply(M5, this);
1381 template<class M0t, class M1t, class M2t, class M3t,
1382 class M4t, class M5t, class M6t>
1383 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1384 const M4t &M4, const M5t &M5, const M6t &M6)
1385 : Option(ZeroOrMore, NotHidden) {
1386 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1387 apply(M4, this); apply(M5, this); apply(M6, this);
1391 template<class M0t, class M1t, class M2t, class M3t,
1392 class M4t, class M5t, class M6t, class M7t>
1393 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1394 const M4t &M4, const M5t &M5, const M6t &M6,
1395 const M7t &M7) : Option(ZeroOrMore, NotHidden) {
1396 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1397 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1402 // multi_val - Modifier to set the number of additional values.
1404 unsigned AdditionalVals;
1405 explicit multi_val(unsigned N) : AdditionalVals(N) {}
1407 template <typename D, typename S, typename P>
1408 void apply(list<D, S, P> &L) const { L.setNumAdditionalVals(AdditionalVals); }
1412 //===----------------------------------------------------------------------===//
1413 // bits_storage class
1415 // Default storage class definition: external storage. This implementation
1416 // assumes the user will specify a variable to store the data into with the
1417 // cl::location(x) modifier.
1419 template<class DataType, class StorageClass>
1420 class bits_storage {
1421 unsigned *Location; // Where to store the bits...
1424 static unsigned Bit(const T &V) {
1425 unsigned BitPos = reinterpret_cast<unsigned>(V);
1426 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1427 "enum exceeds width of bit vector!");
1432 bits_storage() : Location(0) {}
1434 bool setLocation(Option &O, unsigned &L) {
1436 return O.error("cl::location(x) specified more than once!");
1442 void addValue(const T &V) {
1443 assert(Location != 0 && "cl::location(...) not specified for a command "
1444 "line option with external storage!");
1445 *Location |= Bit(V);
1448 unsigned getBits() { return *Location; }
1451 bool isSet(const T &V) {
1452 return (*Location & Bit(V)) != 0;
1457 // Define how to hold bits. Since we can inherit from a class, we do so.
1458 // This makes us exactly compatible with the bits in all cases that it is used.
1460 template<class DataType>
1461 class bits_storage<DataType, bool> {
1462 unsigned Bits; // Where to store the bits...
1465 static unsigned Bit(const T &V) {
1466 unsigned BitPos = (unsigned)V;
1467 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1468 "enum exceeds width of bit vector!");
1474 void addValue(const T &V) {
1478 unsigned getBits() { return Bits; }
1481 bool isSet(const T &V) {
1482 return (Bits & Bit(V)) != 0;
1487 //===----------------------------------------------------------------------===//
1488 // bits - A bit vector of command options.
1490 template <class DataType, class Storage = bool,
1491 class ParserClass = parser<DataType> >
1492 class bits : public Option, public bits_storage<DataType, Storage> {
1493 std::vector<unsigned> Positions;
1496 virtual enum ValueExpected getValueExpectedFlagDefault() const {
1497 return Parser.getValueExpectedFlagDefault();
1499 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
1500 return Parser.getExtraOptionNames(OptionNames);
1503 virtual bool handleOccurrence(unsigned pos, StringRef ArgName, StringRef Arg){
1504 typename ParserClass::parser_data_type Val =
1505 typename ParserClass::parser_data_type();
1506 if (Parser.parse(*this, ArgName, Arg, Val))
1507 return true; // Parse Error!
1508 this->addValue(Val);
1510 Positions.push_back(pos);
1514 // Forward printing stuff to the parser...
1515 virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);}
1516 virtual void printOptionInfo(size_t GlobalWidth) const {
1517 Parser.printOptionInfo(*this, GlobalWidth);
1520 // Unimplemented: bits options don't currently store their default values.
1521 virtual void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const {}
1525 Parser.initialize(*this);
1528 ParserClass &getParser() { return Parser; }
1530 unsigned getPosition(unsigned optnum) const {
1531 assert(optnum < this->size() && "Invalid option index");
1532 return Positions[optnum];
1537 explicit bits(const M0t &M0) : Option(ZeroOrMore, NotHidden) {
1542 template<class M0t, class M1t>
1543 bits(const M0t &M0, const M1t &M1) : Option(ZeroOrMore, NotHidden) {
1544 apply(M0, this); apply(M1, this);
1548 template<class M0t, class M1t, class M2t>
1549 bits(const M0t &M0, const M1t &M1, const M2t &M2)
1550 : Option(ZeroOrMore, NotHidden) {
1551 apply(M0, this); apply(M1, this); apply(M2, this);
1555 template<class M0t, class M1t, class M2t, class M3t>
1556 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1557 : Option(ZeroOrMore, NotHidden) {
1558 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1562 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1563 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1564 const M4t &M4) : Option(ZeroOrMore, NotHidden) {
1565 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1570 template<class M0t, class M1t, class M2t, class M3t,
1571 class M4t, class M5t>
1572 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1573 const M4t &M4, const M5t &M5) : Option(ZeroOrMore, NotHidden) {
1574 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1575 apply(M4, this); apply(M5, this);
1579 template<class M0t, class M1t, class M2t, class M3t,
1580 class M4t, class M5t, class M6t>
1581 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1582 const M4t &M4, const M5t &M5, const M6t &M6)
1583 : Option(ZeroOrMore, NotHidden) {
1584 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1585 apply(M4, this); apply(M5, this); apply(M6, this);
1589 template<class M0t, class M1t, class M2t, class M3t,
1590 class M4t, class M5t, class M6t, class M7t>
1591 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1592 const M4t &M4, const M5t &M5, const M6t &M6,
1593 const M7t &M7) : Option(ZeroOrMore, NotHidden) {
1594 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1595 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1600 //===----------------------------------------------------------------------===//
1601 // Aliased command line option (alias this name to a preexisting name)
1604 class alias : public Option {
1606 virtual bool handleOccurrence(unsigned pos, StringRef /*ArgName*/,
1607 StringRef Arg) LLVM_OVERRIDE {
1608 return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1610 // Handle printing stuff...
1611 virtual size_t getOptionWidth() const LLVM_OVERRIDE;
1612 virtual void printOptionInfo(size_t GlobalWidth) const LLVM_OVERRIDE;
1614 // Aliases do not need to print their values.
1615 virtual void printOptionValue(size_t /*GlobalWidth*/,
1616 bool /*Force*/) const LLVM_OVERRIDE {}
1620 error("cl::alias must have argument name specified!");
1622 error("cl::alias must have an cl::aliasopt(option) specified!");
1626 void setAliasFor(Option &O) {
1628 error("cl::alias must only have one cl::aliasopt(...) specified!");
1634 explicit alias(const M0t &M0) : Option(Optional, Hidden), AliasFor(0) {
1639 template<class M0t, class M1t>
1640 alias(const M0t &M0, const M1t &M1) : Option(Optional, Hidden), AliasFor(0) {
1641 apply(M0, this); apply(M1, this);
1645 template<class M0t, class M1t, class M2t>
1646 alias(const M0t &M0, const M1t &M1, const M2t &M2)
1647 : Option(Optional, Hidden), AliasFor(0) {
1648 apply(M0, this); apply(M1, this); apply(M2, this);
1652 template<class M0t, class M1t, class M2t, class M3t>
1653 alias(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1654 : Option(Optional, Hidden), AliasFor(0) {
1655 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1660 // aliasfor - Modifier to set the option an alias aliases.
1663 explicit aliasopt(Option &O) : Opt(O) {}
1664 void apply(alias &A) const { A.setAliasFor(Opt); }
1667 // extrahelp - provide additional help at the end of the normal help
1668 // output. All occurrences of cl::extrahelp will be accumulated and
1669 // printed to stderr at the end of the regular help, just before
1672 const char * morehelp;
1673 explicit extrahelp(const char* help);
1676 void PrintVersionMessage();
1677 // This function just prints the help message, exactly the same way as if the
1678 // -help option had been given on the command line.
1679 // NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1680 void PrintHelpMessage();
1682 } // End namespace cl
1684 } // End namespace llvm