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/StringSaver.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 = nullptr);
47 //===----------------------------------------------------------------------===//
48 // ParseEnvironmentOptions - Environment variable option processing alternate
51 void ParseEnvironmentOptions(const char *progName, const char *envvar,
52 const char *Overview = nullptr);
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 = nullptr)
151 : Name(Name), Description(Description) { registerCategory(); }
152 const char *getName() const { return Name; }
153 const char *getDescription() const { 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(nullptr),
243 ArgStr(""), HelpStr(""), ValueStr(""), Category(&GeneralCategory) {
246 inline void setNumAdditionalVals(unsigned n) { AdditionalVals = n; }
248 // addArgument - Register this argument with the commandline system.
252 /// Unregisters this option from the CommandLine system.
254 /// This option must have been the last option registered.
255 /// For testing purposes only.
256 void removeArgument();
258 Option *getNextRegisteredOption() const { return NextRegistered; }
260 // Return the width of the option tag for printing...
261 virtual size_t getOptionWidth() const = 0;
263 // printOptionInfo - Print out information about this option. The
264 // to-be-maintained width is specified.
266 virtual void printOptionInfo(size_t GlobalWidth) const = 0;
268 virtual void printOptionValue(size_t GlobalWidth, bool Force) const = 0;
270 virtual void getExtraOptionNames(SmallVectorImpl<const char*> &) {}
272 // addOccurrence - Wrapper around handleOccurrence that enforces Flags.
274 virtual bool addOccurrence(unsigned pos, StringRef ArgName,
275 StringRef Value, bool MultiArg = false);
277 // Prints option name followed by message. Always returns true.
278 bool error(const Twine &Message, StringRef ArgName = StringRef());
281 inline int getNumOccurrences() const { return NumOccurrences; }
286 //===----------------------------------------------------------------------===//
287 // Command line option modifiers that can be used to modify the behavior of
288 // command line option parsers...
291 // desc - Modifier to set the description shown in the -help output...
294 desc(const char *Str) : Desc(Str) {}
295 void apply(Option &O) const { O.setDescription(Desc); }
298 // value_desc - Modifier to set the value description shown in the -help
302 value_desc(const char *Str) : Desc(Str) {}
303 void apply(Option &O) const { O.setValueStr(Desc); }
306 // init - Specify a default (initial) value for the command line argument, if
307 // the default constructor for the argument type does not give you what you
308 // want. This is only valid on "opt" arguments, not on "list" arguments.
313 initializer(const Ty &Val) : Init(Val) {}
316 void apply(Opt &O) const { O.setInitialValue(Init); }
320 initializer<Ty> init(const Ty &Val) {
321 return initializer<Ty>(Val);
325 // location - Allow the user to specify which external variable they want to
326 // store the results of the command line argument processing into, if they don't
327 // want to store it in the option itself.
330 struct LocationClass {
332 LocationClass(Ty &L) : Loc(L) {}
335 void apply(Opt &O) const { O.setLocation(O, Loc); }
339 LocationClass<Ty> location(Ty &L) { return LocationClass<Ty>(L); }
341 // cat - Specifiy the Option category for the command line argument to belong
344 OptionCategory &Category;
345 cat(OptionCategory &c) : Category(c) {}
348 void apply(Opt &O) const { O.setCategory(Category); }
352 //===----------------------------------------------------------------------===//
355 // Support value comparison outside the template.
356 struct GenericOptionValue {
357 virtual ~GenericOptionValue() {}
358 virtual bool compare(const GenericOptionValue &V) const = 0;
361 virtual void anchor();
364 template<class DataType> struct OptionValue;
366 // The default value safely does nothing. Option value printing is only
368 template<class DataType, bool isClass>
369 struct OptionValueBase : public GenericOptionValue {
370 // Temporary storage for argument passing.
371 typedef OptionValue<DataType> WrapperType;
373 bool hasValue() const { return false; }
375 const DataType &getValue() const { llvm_unreachable("no default value"); }
377 // Some options may take their value from a different data type.
379 void setValue(const DT& /*V*/) {}
381 bool compare(const DataType &/*V*/) const { return false; }
383 bool compare(const GenericOptionValue& /*V*/) const override {
388 // Simple copy of the option value.
389 template<class DataType>
390 class OptionValueCopy : public GenericOptionValue {
394 OptionValueCopy() : Valid(false) {}
396 bool hasValue() const { return Valid; }
398 const DataType &getValue() const {
399 assert(Valid && "invalid option value");
403 void setValue(const DataType &V) { Valid = true; Value = V; }
405 bool compare(const DataType &V) const {
406 return Valid && (Value != V);
409 bool compare(const GenericOptionValue &V) const override {
410 const OptionValueCopy<DataType> &VC =
411 static_cast< const OptionValueCopy<DataType>& >(V);
412 if (!VC.hasValue()) return false;
413 return compare(VC.getValue());
417 // Non-class option values.
418 template<class DataType>
419 struct OptionValueBase<DataType, false> : OptionValueCopy<DataType> {
420 typedef DataType WrapperType;
423 // Top-level option class.
424 template<class DataType>
425 struct OptionValue : OptionValueBase<DataType, std::is_class<DataType>::value> {
428 OptionValue(const DataType& V) {
431 // Some options may take their value from a different data type.
433 OptionValue<DataType> &operator=(const DT& V) {
439 // Other safe-to-copy-by-value common option types.
440 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
442 struct OptionValue<cl::boolOrDefault> : OptionValueCopy<cl::boolOrDefault> {
443 typedef cl::boolOrDefault WrapperType;
447 OptionValue(const cl::boolOrDefault& V) {
450 OptionValue<cl::boolOrDefault> &operator=(const cl::boolOrDefault& V) {
455 void anchor() override;
459 struct OptionValue<std::string> : OptionValueCopy<std::string> {
460 typedef StringRef WrapperType;
464 OptionValue(const std::string& V) {
467 OptionValue<std::string> &operator=(const std::string& V) {
472 void anchor() override;
475 //===----------------------------------------------------------------------===//
476 // Enum valued command line option
478 #define clEnumVal(ENUMVAL, DESC) #ENUMVAL, int(ENUMVAL), DESC
479 #define clEnumValN(ENUMVAL, FLAGNAME, DESC) FLAGNAME, int(ENUMVAL), DESC
480 #define clEnumValEnd (reinterpret_cast<void*>(0))
482 // values - For custom data types, allow specifying a group of values together
483 // as the values that go into the mapping that the option handler uses. Note
484 // that the values list must always have a 0 at the end of the list to indicate
485 // that the list has ended.
487 template<class DataType>
489 // Use a vector instead of a map, because the lists should be short,
490 // the overhead is less, and most importantly, it keeps them in the order
491 // inserted so we can print our option out nicely.
492 SmallVector<std::pair<const char *, std::pair<int, const char *> >,4> Values;
493 void processValues(va_list Vals);
495 ValuesClass(const char *EnumName, DataType Val, const char *Desc,
497 // Insert the first value, which is required.
498 Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc)));
500 // Process the varargs portion of the values...
501 while (const char *enumName = va_arg(ValueArgs, const char *)) {
502 DataType EnumVal = static_cast<DataType>(va_arg(ValueArgs, int));
503 const char *EnumDesc = va_arg(ValueArgs, const char *);
504 Values.push_back(std::make_pair(enumName, // Add value to value map
505 std::make_pair(EnumVal, EnumDesc)));
510 void apply(Opt &O) const {
511 for (size_t i = 0, e = Values.size(); i != e; ++i)
512 O.getParser().addLiteralOption(Values[i].first, Values[i].second.first,
513 Values[i].second.second);
517 template<class DataType>
518 ValuesClass<DataType> END_WITH_NULL values(const char *Arg, DataType Val,
519 const char *Desc, ...) {
521 va_start(ValueArgs, Desc);
522 ValuesClass<DataType> Vals(Arg, Val, Desc, ValueArgs);
527 //===----------------------------------------------------------------------===//
528 // parser class - Parameterizable parser for different data types. By default,
529 // known data types (string, int, bool) have specialized parsers, that do what
530 // you would expect. The default parser, used for data types that are not
531 // built-in, uses a mapping table to map specific options to values, which is
532 // used, among other things, to handle enum types.
534 //--------------------------------------------------
535 // generic_parser_base - This class holds all the non-generic code that we do
536 // not need replicated for every instance of the generic parser. This also
537 // allows us to put stuff into CommandLine.cpp
539 class generic_parser_base {
541 class GenericOptionInfo {
543 GenericOptionInfo(const char *name, const char *helpStr) :
544 Name(name), HelpStr(helpStr) {}
549 virtual ~generic_parser_base() {} // Base class should have virtual-dtor
551 // getNumOptions - Virtual function implemented by generic subclass to
552 // indicate how many entries are in Values.
554 virtual unsigned getNumOptions() const = 0;
556 // getOption - Return option name N.
557 virtual const char *getOption(unsigned N) const = 0;
559 // getDescription - Return description N
560 virtual const char *getDescription(unsigned N) const = 0;
562 // Return the width of the option tag for printing...
563 virtual size_t getOptionWidth(const Option &O) const;
565 virtual const GenericOptionValue &getOptionValue(unsigned N) const = 0;
567 // printOptionInfo - Print out information about this option. The
568 // to-be-maintained width is specified.
570 virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const;
572 void printGenericOptionDiff(const Option &O, const GenericOptionValue &V,
573 const GenericOptionValue &Default,
574 size_t GlobalWidth) const;
576 // printOptionDiff - print the value of an option and it's default.
578 // Template definition ensures that the option and default have the same
579 // DataType (via the same AnyOptionValue).
580 template<class AnyOptionValue>
581 void printOptionDiff(const Option &O, const AnyOptionValue &V,
582 const AnyOptionValue &Default,
583 size_t GlobalWidth) const {
584 printGenericOptionDiff(O, V, Default, GlobalWidth);
587 void initialize(Option &O) {
588 // All of the modifiers for the option have been processed by now, so the
589 // argstr field should be stable, copy it down now.
591 hasArgStr = O.hasArgStr();
594 void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) {
595 // If there has been no argstr specified, that means that we need to add an
596 // argument for every possible option. This ensures that our options are
599 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
600 OptionNames.push_back(getOption(i));
604 enum ValueExpected getValueExpectedFlagDefault() const {
605 // If there is an ArgStr specified, then we are of the form:
607 // -opt=O2 or -opt O2 or -optO2
609 // In which case, the value is required. Otherwise if an arg str has not
610 // been specified, we are of the form:
612 // -O2 or O2 or -la (where -l and -a are separate options)
614 // If this is the case, we cannot allow a value.
617 return ValueRequired;
619 return ValueDisallowed;
622 // findOption - Return the option number corresponding to the specified
623 // argument string. If the option is not found, getNumOptions() is returned.
625 unsigned findOption(const char *Name);
631 // Default parser implementation - This implementation depends on having a
632 // mapping of recognized options to values of some sort. In addition to this,
633 // each entry in the mapping also tracks a help message that is printed with the
634 // command line option for -help. Because this is a simple mapping parser, the
635 // data type can be any unsupported type.
637 template <class DataType>
638 class parser : public generic_parser_base {
640 class OptionInfo : public GenericOptionInfo {
642 OptionInfo(const char *name, DataType v, const char *helpStr) :
643 GenericOptionInfo(name, helpStr), V(v) {}
644 OptionValue<DataType> V;
646 SmallVector<OptionInfo, 8> Values;
648 typedef DataType parser_data_type;
650 // Implement virtual functions needed by generic_parser_base
651 unsigned getNumOptions() const override { return unsigned(Values.size()); }
652 const char *getOption(unsigned N) const override { return Values[N].Name; }
653 const char *getDescription(unsigned N) const override {
654 return Values[N].HelpStr;
657 // getOptionValue - Return the value of option name N.
658 const GenericOptionValue &getOptionValue(unsigned N) const override {
662 // parse - Return true on error.
663 bool parse(Option &O, StringRef ArgName, StringRef Arg, DataType &V) {
670 for (size_t i = 0, e = Values.size(); i != e; ++i)
671 if (Values[i].Name == ArgVal) {
672 V = Values[i].V.getValue();
676 return O.error("Cannot find option named '" + ArgVal + "'!");
679 /// addLiteralOption - Add an entry to the mapping table.
682 void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) {
683 assert(findOption(Name) == Values.size() && "Option already exists!");
684 OptionInfo X(Name, static_cast<DataType>(V), HelpStr);
686 MarkOptionsChanged();
689 /// removeLiteralOption - Remove the specified option.
691 void removeLiteralOption(const char *Name) {
692 unsigned N = findOption(Name);
693 assert(N != Values.size() && "Option not found!");
694 Values.erase(Values.begin()+N);
698 //--------------------------------------------------
699 // basic_parser - Super class of parsers to provide boilerplate code
701 class basic_parser_impl { // non-template implementation of basic_parser<t>
703 virtual ~basic_parser_impl() {}
705 enum ValueExpected getValueExpectedFlagDefault() const {
706 return ValueRequired;
709 void getExtraOptionNames(SmallVectorImpl<const char*> &) {}
711 void initialize(Option &) {}
713 // Return the width of the option tag for printing...
714 size_t getOptionWidth(const Option &O) const;
716 // printOptionInfo - Print out information about this option. The
717 // to-be-maintained width is specified.
719 void printOptionInfo(const Option &O, size_t GlobalWidth) const;
721 // printOptionNoValue - Print a placeholder for options that don't yet support
722 // printOptionDiff().
723 void printOptionNoValue(const Option &O, size_t GlobalWidth) const;
725 // getValueName - Overload in subclass to provide a better default value.
726 virtual const char *getValueName() const { return "value"; }
728 // An out-of-line virtual method to provide a 'home' for this class.
729 virtual void anchor();
732 // A helper for basic_parser::printOptionDiff.
733 void printOptionName(const Option &O, size_t GlobalWidth) const;
736 // basic_parser - The real basic parser is just a template wrapper that provides
737 // a typedef for the provided data type.
739 template<class DataType>
740 class basic_parser : public basic_parser_impl {
742 typedef DataType parser_data_type;
743 typedef OptionValue<DataType> OptVal;
746 //--------------------------------------------------
750 class parser<bool> : public basic_parser<bool> {
754 // parse - Return true on error.
755 bool parse(Option &O, StringRef ArgName, StringRef Arg, bool &Val);
758 void initialize(Opt &O) {
762 enum ValueExpected getValueExpectedFlagDefault() const {
763 return ValueOptional;
766 // getValueName - Do not print =<value> at all.
767 const char *getValueName() const override { return nullptr; }
769 void printOptionDiff(const Option &O, bool V, OptVal Default,
770 size_t GlobalWidth) const;
772 // An out-of-line virtual method to provide a 'home' for this class.
773 void anchor() override;
776 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
778 //--------------------------------------------------
779 // parser<boolOrDefault>
781 class parser<boolOrDefault> : public basic_parser<boolOrDefault> {
783 // parse - Return true on error.
784 bool parse(Option &O, StringRef ArgName, StringRef Arg, boolOrDefault &Val);
786 enum ValueExpected getValueExpectedFlagDefault() const {
787 return ValueOptional;
790 // getValueName - Do not print =<value> at all.
791 const char *getValueName() const override { return nullptr; }
793 void printOptionDiff(const Option &O, boolOrDefault V, OptVal Default,
794 size_t GlobalWidth) const;
796 // An out-of-line virtual method to provide a 'home' for this class.
797 void anchor() override;
800 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
802 //--------------------------------------------------
806 class parser<int> : public basic_parser<int> {
808 // parse - Return true on error.
809 bool parse(Option &O, StringRef ArgName, StringRef Arg, int &Val);
811 // getValueName - Overload in subclass to provide a better default value.
812 const char *getValueName() const override { return "int"; }
814 void printOptionDiff(const Option &O, int V, OptVal Default,
815 size_t GlobalWidth) const;
817 // An out-of-line virtual method to provide a 'home' for this class.
818 void anchor() override;
821 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
824 //--------------------------------------------------
828 class parser<unsigned> : public basic_parser<unsigned> {
830 // parse - Return true on error.
831 bool parse(Option &O, StringRef ArgName, StringRef Arg, unsigned &Val);
833 // getValueName - Overload in subclass to provide a better default value.
834 const char *getValueName() const override { return "uint"; }
836 void printOptionDiff(const Option &O, unsigned V, OptVal Default,
837 size_t GlobalWidth) const;
839 // An out-of-line virtual method to provide a 'home' for this class.
840 void anchor() override;
843 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
845 //--------------------------------------------------
846 // parser<unsigned long long>
849 class parser<unsigned long long> : public basic_parser<unsigned long long> {
851 // parse - Return true on error.
852 bool parse(Option &O, StringRef ArgName, StringRef Arg,
853 unsigned long long &Val);
855 // getValueName - Overload in subclass to provide a better default value.
856 const char *getValueName() const override { return "uint"; }
858 void printOptionDiff(const Option &O, unsigned long long V, OptVal Default,
859 size_t GlobalWidth) const;
861 // An out-of-line virtual method to provide a 'home' for this class.
862 void anchor() override;
865 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
867 //--------------------------------------------------
871 class parser<double> : public basic_parser<double> {
873 // parse - Return true on error.
874 bool parse(Option &O, StringRef ArgName, StringRef Arg, double &Val);
876 // getValueName - Overload in subclass to provide a better default value.
877 const char *getValueName() const override { return "number"; }
879 void printOptionDiff(const Option &O, double V, OptVal Default,
880 size_t GlobalWidth) const;
882 // An out-of-line virtual method to provide a 'home' for this class.
883 void anchor() override;
886 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
888 //--------------------------------------------------
892 class parser<float> : public basic_parser<float> {
894 // parse - Return true on error.
895 bool parse(Option &O, StringRef ArgName, StringRef Arg, float &Val);
897 // getValueName - Overload in subclass to provide a better default value.
898 const char *getValueName() const override { return "number"; }
900 void printOptionDiff(const Option &O, float V, OptVal Default,
901 size_t GlobalWidth) const;
903 // An out-of-line virtual method to provide a 'home' for this class.
904 void anchor() override;
907 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
909 //--------------------------------------------------
910 // parser<std::string>
913 class parser<std::string> : public basic_parser<std::string> {
915 // parse - Return true on error.
916 bool parse(Option &, StringRef, StringRef Arg, std::string &Value) {
921 // getValueName - Overload in subclass to provide a better default value.
922 const char *getValueName() const override { return "string"; }
924 void printOptionDiff(const Option &O, StringRef V, OptVal Default,
925 size_t GlobalWidth) const;
927 // An out-of-line virtual method to provide a 'home' for this class.
928 void anchor() override;
931 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
933 //--------------------------------------------------
937 class parser<char> : public basic_parser<char> {
939 // parse - Return true on error.
940 bool parse(Option &, StringRef, StringRef Arg, char &Value) {
945 // getValueName - Overload in subclass to provide a better default value.
946 const char *getValueName() const override { return "char"; }
948 void printOptionDiff(const Option &O, char V, OptVal Default,
949 size_t GlobalWidth) const;
951 // An out-of-line virtual method to provide a 'home' for this class.
952 void anchor() override;
955 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<char>);
957 //--------------------------------------------------
960 // This collection of wrappers is the intermediary between class opt and class
961 // parser to handle all the template nastiness.
963 // This overloaded function is selected by the generic parser.
964 template<class ParserClass, class DT>
965 void printOptionDiff(const Option &O, const generic_parser_base &P, const DT &V,
966 const OptionValue<DT> &Default, size_t GlobalWidth) {
967 OptionValue<DT> OV = V;
968 P.printOptionDiff(O, OV, Default, GlobalWidth);
971 // This is instantiated for basic parsers when the parsed value has a different
972 // type than the option value. e.g. HelpPrinter.
973 template<class ParserDT, class ValDT>
974 struct OptionDiffPrinter {
975 void print(const Option &O, const parser<ParserDT> P, const ValDT &/*V*/,
976 const OptionValue<ValDT> &/*Default*/, size_t GlobalWidth) {
977 P.printOptionNoValue(O, GlobalWidth);
981 // This is instantiated for basic parsers when the parsed value has the same
982 // type as the option value.
984 struct OptionDiffPrinter<DT, DT> {
985 void print(const Option &O, const parser<DT> P, const DT &V,
986 const OptionValue<DT> &Default, size_t GlobalWidth) {
987 P.printOptionDiff(O, V, Default, GlobalWidth);
991 // This overloaded function is selected by the basic parser, which may parse a
992 // different type than the option type.
993 template<class ParserClass, class ValDT>
994 void printOptionDiff(
996 const basic_parser<typename ParserClass::parser_data_type> &P,
997 const ValDT &V, const OptionValue<ValDT> &Default,
998 size_t GlobalWidth) {
1000 OptionDiffPrinter<typename ParserClass::parser_data_type, ValDT> printer;
1001 printer.print(O, static_cast<const ParserClass&>(P), V, Default,
1005 //===----------------------------------------------------------------------===//
1006 // applicator class - This class is used because we must use partial
1007 // specialization to handle literal string arguments specially (const char* does
1008 // not correctly respond to the apply method). Because the syntax to use this
1009 // is a pain, we have the 'apply' method below to handle the nastiness...
1011 template<class Mod> struct applicator {
1013 static void opt(const Mod &M, Opt &O) { M.apply(O); }
1016 // Handle const char* as a special case...
1017 template<unsigned n> struct applicator<char[n]> {
1019 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
1021 template<unsigned n> struct applicator<const char[n]> {
1023 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
1025 template<> struct applicator<const char*> {
1027 static void opt(const char *Str, Opt &O) { O.setArgStr(Str); }
1030 template<> struct applicator<NumOccurrencesFlag> {
1031 static void opt(NumOccurrencesFlag N, Option &O) {
1032 O.setNumOccurrencesFlag(N);
1035 template<> struct applicator<ValueExpected> {
1036 static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
1038 template<> struct applicator<OptionHidden> {
1039 static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
1041 template<> struct applicator<FormattingFlags> {
1042 static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
1044 template<> struct applicator<MiscFlags> {
1045 static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
1048 // apply method - Apply a modifier to an option in a type safe way.
1049 template<class Mod, class Opt>
1050 void apply(const Mod &M, Opt *O) {
1051 applicator<Mod>::opt(M, *O);
1054 //===----------------------------------------------------------------------===//
1055 // opt_storage class
1057 // Default storage class definition: external storage. This implementation
1058 // assumes the user will specify a variable to store the data into with the
1059 // cl::location(x) modifier.
1061 template<class DataType, bool ExternalStorage, bool isClass>
1063 DataType *Location; // Where to store the object...
1064 OptionValue<DataType> Default;
1066 void check_location() const {
1067 assert(Location && "cl::location(...) not specified for a command "
1068 "line option with external storage, "
1069 "or cl::init specified before cl::location()!!");
1072 opt_storage() : Location(nullptr) {}
1074 bool setLocation(Option &O, DataType &L) {
1076 return O.error("cl::location(x) specified more than once!");
1083 void setValue(const T &V, bool initial = false) {
1090 DataType &getValue() { check_location(); return *Location; }
1091 const DataType &getValue() const { check_location(); return *Location; }
1093 operator DataType() const { return this->getValue(); }
1095 const OptionValue<DataType> &getDefault() const { return Default; }
1098 // Define how to hold a class type object, such as a string. Since we can
1099 // inherit from a class, we do so. This makes us exactly compatible with the
1100 // object in all cases that it is used.
1102 template<class DataType>
1103 class opt_storage<DataType,false,true> : public DataType {
1105 OptionValue<DataType> Default;
1108 void setValue(const T &V, bool initial = false) {
1109 DataType::operator=(V);
1114 DataType &getValue() { return *this; }
1115 const DataType &getValue() const { return *this; }
1117 const OptionValue<DataType> &getDefault() const { return Default; }
1120 // Define a partial specialization to handle things we cannot inherit from. In
1121 // this case, we store an instance through containment, and overload operators
1122 // to get at the value.
1124 template<class DataType>
1125 class opt_storage<DataType, false, false> {
1128 OptionValue<DataType> Default;
1130 // Make sure we initialize the value with the default constructor for the
1132 opt_storage() : Value(DataType()), Default(DataType()) {}
1135 void setValue(const T &V, bool initial = false) {
1140 DataType &getValue() { return Value; }
1141 DataType getValue() const { return Value; }
1143 const OptionValue<DataType> &getDefault() const { return Default; }
1145 operator DataType() const { return getValue(); }
1147 // If the datatype is a pointer, support -> on it.
1148 DataType operator->() const { return Value; }
1152 //===----------------------------------------------------------------------===//
1153 // opt - A scalar command line option.
1155 template <class DataType, bool ExternalStorage = false,
1156 class ParserClass = parser<DataType> >
1157 class opt : public Option,
1158 public opt_storage<DataType, ExternalStorage,
1159 std::is_class<DataType>::value> {
1162 bool handleOccurrence(unsigned pos, StringRef ArgName,
1163 StringRef Arg) override {
1164 typename ParserClass::parser_data_type Val =
1165 typename ParserClass::parser_data_type();
1166 if (Parser.parse(*this, ArgName, Arg, Val))
1167 return true; // Parse error!
1168 this->setValue(Val);
1169 this->setPosition(pos);
1173 enum ValueExpected getValueExpectedFlagDefault() const override {
1174 return Parser.getValueExpectedFlagDefault();
1176 void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) override {
1177 return Parser.getExtraOptionNames(OptionNames);
1180 // Forward printing stuff to the parser...
1181 size_t getOptionWidth() const override {return Parser.getOptionWidth(*this);}
1182 void printOptionInfo(size_t GlobalWidth) const override {
1183 Parser.printOptionInfo(*this, GlobalWidth);
1186 void printOptionValue(size_t GlobalWidth, bool Force) const override {
1187 if (Force || this->getDefault().compare(this->getValue())) {
1188 cl::printOptionDiff<ParserClass>(
1189 *this, Parser, this->getValue(), this->getDefault(), GlobalWidth);
1195 Parser.initialize(*this);
1198 // setInitialValue - Used by the cl::init modifier...
1199 void setInitialValue(const DataType &V) { this->setValue(V, true); }
1201 ParserClass &getParser() { return Parser; }
1204 DataType &operator=(const T &Val) {
1205 this->setValue(Val);
1206 return this->getValue();
1211 explicit opt(const M0t &M0) : Option(Optional, NotHidden) {
1217 template<class M0t, class M1t>
1218 opt(const M0t &M0, const M1t &M1) : Option(Optional, NotHidden) {
1219 apply(M0, this); apply(M1, this);
1224 template<class M0t, class M1t, class M2t>
1225 opt(const M0t &M0, const M1t &M1,
1226 const M2t &M2) : Option(Optional, NotHidden) {
1227 apply(M0, this); apply(M1, this); apply(M2, this);
1231 template<class M0t, class M1t, class M2t, class M3t>
1232 opt(const M0t &M0, const M1t &M1, const M2t &M2,
1233 const M3t &M3) : Option(Optional, NotHidden) {
1234 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1238 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1239 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1240 const M4t &M4) : Option(Optional, NotHidden) {
1241 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1246 template<class M0t, class M1t, class M2t, class M3t,
1247 class M4t, class M5t>
1248 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1249 const M4t &M4, const M5t &M5) : Option(Optional, NotHidden) {
1250 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1251 apply(M4, this); apply(M5, this);
1255 template<class M0t, class M1t, class M2t, class M3t,
1256 class M4t, class M5t, class M6t>
1257 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1258 const M4t &M4, const M5t &M5,
1259 const M6t &M6) : Option(Optional, NotHidden) {
1260 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1261 apply(M4, this); apply(M5, this); apply(M6, this);
1265 template<class M0t, class M1t, class M2t, class M3t,
1266 class M4t, class M5t, class M6t, class M7t>
1267 opt(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1268 const M4t &M4, const M5t &M5, const M6t &M6,
1269 const M7t &M7) : Option(Optional, NotHidden) {
1270 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1271 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1276 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
1277 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
1278 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
1279 EXTERN_TEMPLATE_INSTANTIATION(class opt<char>);
1280 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
1282 //===----------------------------------------------------------------------===//
1283 // list_storage class
1285 // Default storage class definition: external storage. This implementation
1286 // assumes the user will specify a variable to store the data into with the
1287 // cl::location(x) modifier.
1289 template<class DataType, class StorageClass>
1290 class list_storage {
1291 StorageClass *Location; // Where to store the object...
1294 list_storage() : Location(0) {}
1296 bool setLocation(Option &O, StorageClass &L) {
1298 return O.error("cl::location(x) specified more than once!");
1304 void addValue(const T &V) {
1305 assert(Location != 0 && "cl::location(...) not specified for a command "
1306 "line option with external storage!");
1307 Location->push_back(V);
1312 // Define how to hold a class type object, such as a string. Since we can
1313 // inherit from a class, we do so. This makes us exactly compatible with the
1314 // object in all cases that it is used.
1316 template<class DataType>
1317 class list_storage<DataType, bool> : public std::vector<DataType> {
1320 void addValue(const T &V) { std::vector<DataType>::push_back(V); }
1324 //===----------------------------------------------------------------------===//
1325 // list - A list of command line options.
1327 template <class DataType, class Storage = bool,
1328 class ParserClass = parser<DataType> >
1329 class list : public Option, public list_storage<DataType, Storage> {
1330 std::vector<unsigned> Positions;
1333 enum ValueExpected getValueExpectedFlagDefault() const override {
1334 return Parser.getValueExpectedFlagDefault();
1336 void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) override {
1337 return Parser.getExtraOptionNames(OptionNames);
1340 bool handleOccurrence(unsigned pos, StringRef ArgName,
1341 StringRef Arg) override {
1342 typename ParserClass::parser_data_type Val =
1343 typename ParserClass::parser_data_type();
1344 if (Parser.parse(*this, ArgName, Arg, Val))
1345 return true; // Parse Error!
1346 list_storage<DataType, Storage>::addValue(Val);
1348 Positions.push_back(pos);
1352 // Forward printing stuff to the parser...
1353 size_t getOptionWidth() const override {return Parser.getOptionWidth(*this);}
1354 void printOptionInfo(size_t GlobalWidth) const override {
1355 Parser.printOptionInfo(*this, GlobalWidth);
1358 // Unimplemented: list options don't currently store their default value.
1359 void printOptionValue(size_t /*GlobalWidth*/,
1360 bool /*Force*/) const override {}
1364 Parser.initialize(*this);
1367 ParserClass &getParser() { return Parser; }
1369 unsigned getPosition(unsigned optnum) const {
1370 assert(optnum < this->size() && "Invalid option index");
1371 return Positions[optnum];
1374 void setNumAdditionalVals(unsigned n) {
1375 Option::setNumAdditionalVals(n);
1380 explicit list(const M0t &M0) : Option(ZeroOrMore, NotHidden) {
1385 template<class M0t, class M1t>
1386 list(const M0t &M0, const M1t &M1) : Option(ZeroOrMore, NotHidden) {
1387 apply(M0, this); apply(M1, this);
1391 template<class M0t, class M1t, class M2t>
1392 list(const M0t &M0, const M1t &M1, const M2t &M2)
1393 : Option(ZeroOrMore, NotHidden) {
1394 apply(M0, this); apply(M1, this); apply(M2, this);
1398 template<class M0t, class M1t, class M2t, class M3t>
1399 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1400 : Option(ZeroOrMore, NotHidden) {
1401 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1405 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1406 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1407 const M4t &M4) : Option(ZeroOrMore, NotHidden) {
1408 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1413 template<class M0t, class M1t, class M2t, class M3t,
1414 class M4t, class M5t>
1415 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1416 const M4t &M4, const M5t &M5) : Option(ZeroOrMore, NotHidden) {
1417 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1418 apply(M4, this); apply(M5, this);
1422 template<class M0t, class M1t, class M2t, class M3t,
1423 class M4t, class M5t, class M6t>
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 : 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);
1432 template<class M0t, class M1t, class M2t, class M3t,
1433 class M4t, class M5t, class M6t, class M7t>
1434 list(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1435 const M4t &M4, const M5t &M5, const M6t &M6,
1436 const M7t &M7) : Option(ZeroOrMore, NotHidden) {
1437 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1438 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1443 // multi_val - Modifier to set the number of additional values.
1445 unsigned AdditionalVals;
1446 explicit multi_val(unsigned N) : AdditionalVals(N) {}
1448 template <typename D, typename S, typename P>
1449 void apply(list<D, S, P> &L) const { L.setNumAdditionalVals(AdditionalVals); }
1453 //===----------------------------------------------------------------------===//
1454 // bits_storage class
1456 // Default storage class definition: external storage. This implementation
1457 // assumes the user will specify a variable to store the data into with the
1458 // cl::location(x) modifier.
1460 template<class DataType, class StorageClass>
1461 class bits_storage {
1462 unsigned *Location; // Where to store the bits...
1465 static unsigned Bit(const T &V) {
1466 unsigned BitPos = reinterpret_cast<unsigned>(V);
1467 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1468 "enum exceeds width of bit vector!");
1473 bits_storage() : Location(nullptr) {}
1475 bool setLocation(Option &O, unsigned &L) {
1477 return O.error("cl::location(x) specified more than once!");
1483 void addValue(const T &V) {
1484 assert(Location != 0 && "cl::location(...) not specified for a command "
1485 "line option with external storage!");
1486 *Location |= Bit(V);
1489 unsigned getBits() { return *Location; }
1492 bool isSet(const T &V) {
1493 return (*Location & Bit(V)) != 0;
1498 // Define how to hold bits. Since we can inherit from a class, we do so.
1499 // This makes us exactly compatible with the bits in all cases that it is used.
1501 template<class DataType>
1502 class bits_storage<DataType, bool> {
1503 unsigned Bits; // Where to store the bits...
1506 static unsigned Bit(const T &V) {
1507 unsigned BitPos = (unsigned)V;
1508 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1509 "enum exceeds width of bit vector!");
1515 void addValue(const T &V) {
1519 unsigned getBits() { return Bits; }
1522 bool isSet(const T &V) {
1523 return (Bits & Bit(V)) != 0;
1528 //===----------------------------------------------------------------------===//
1529 // bits - A bit vector of command options.
1531 template <class DataType, class Storage = bool,
1532 class ParserClass = parser<DataType> >
1533 class bits : public Option, public bits_storage<DataType, Storage> {
1534 std::vector<unsigned> Positions;
1537 enum ValueExpected getValueExpectedFlagDefault() const override {
1538 return Parser.getValueExpectedFlagDefault();
1540 void getExtraOptionNames(SmallVectorImpl<const char*> &OptionNames) override {
1541 return Parser.getExtraOptionNames(OptionNames);
1544 bool handleOccurrence(unsigned pos, StringRef ArgName,
1545 StringRef Arg) override {
1546 typename ParserClass::parser_data_type Val =
1547 typename ParserClass::parser_data_type();
1548 if (Parser.parse(*this, ArgName, Arg, Val))
1549 return true; // Parse Error!
1550 this->addValue(Val);
1552 Positions.push_back(pos);
1556 // Forward printing stuff to the parser...
1557 size_t getOptionWidth() const override {return Parser.getOptionWidth(*this);}
1558 void printOptionInfo(size_t GlobalWidth) const override {
1559 Parser.printOptionInfo(*this, GlobalWidth);
1562 // Unimplemented: bits options don't currently store their default values.
1563 void printOptionValue(size_t /*GlobalWidth*/,
1564 bool /*Force*/) const override {}
1568 Parser.initialize(*this);
1571 ParserClass &getParser() { return Parser; }
1573 unsigned getPosition(unsigned optnum) const {
1574 assert(optnum < this->size() && "Invalid option index");
1575 return Positions[optnum];
1580 explicit bits(const M0t &M0) : Option(ZeroOrMore, NotHidden) {
1585 template<class M0t, class M1t>
1586 bits(const M0t &M0, const M1t &M1) : Option(ZeroOrMore, NotHidden) {
1587 apply(M0, this); apply(M1, this);
1591 template<class M0t, class M1t, class M2t>
1592 bits(const M0t &M0, const M1t &M1, const M2t &M2)
1593 : Option(ZeroOrMore, NotHidden) {
1594 apply(M0, this); apply(M1, this); apply(M2, this);
1598 template<class M0t, class M1t, class M2t, class M3t>
1599 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1600 : Option(ZeroOrMore, NotHidden) {
1601 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1605 template<class M0t, class M1t, class M2t, class M3t, class M4t>
1606 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1607 const M4t &M4) : Option(ZeroOrMore, NotHidden) {
1608 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1613 template<class M0t, class M1t, class M2t, class M3t,
1614 class M4t, class M5t>
1615 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1616 const M4t &M4, const M5t &M5) : Option(ZeroOrMore, NotHidden) {
1617 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1618 apply(M4, this); apply(M5, this);
1622 template<class M0t, class M1t, class M2t, class M3t,
1623 class M4t, class M5t, class M6t>
1624 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1625 const M4t &M4, const M5t &M5, const M6t &M6)
1626 : Option(ZeroOrMore, NotHidden) {
1627 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1628 apply(M4, this); apply(M5, this); apply(M6, this);
1632 template<class M0t, class M1t, class M2t, class M3t,
1633 class M4t, class M5t, class M6t, class M7t>
1634 bits(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3,
1635 const M4t &M4, const M5t &M5, const M6t &M6,
1636 const M7t &M7) : Option(ZeroOrMore, NotHidden) {
1637 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1638 apply(M4, this); apply(M5, this); apply(M6, this); apply(M7, this);
1643 //===----------------------------------------------------------------------===//
1644 // Aliased command line option (alias this name to a preexisting name)
1647 class alias : public Option {
1649 bool handleOccurrence(unsigned pos, StringRef /*ArgName*/,
1650 StringRef Arg) override {
1651 return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1653 bool addOccurrence(unsigned pos, StringRef /*ArgName*/,
1654 StringRef Value, bool MultiArg = false) override {
1655 return AliasFor->addOccurrence(pos, AliasFor->ArgStr, Value, MultiArg);
1657 // Handle printing stuff...
1658 size_t getOptionWidth() const override;
1659 void printOptionInfo(size_t GlobalWidth) const override;
1661 // Aliases do not need to print their values.
1662 void printOptionValue(size_t /*GlobalWidth*/,
1663 bool /*Force*/) const override {}
1665 ValueExpected getValueExpectedFlagDefault() const override {
1666 return AliasFor->getValueExpectedFlag();
1671 error("cl::alias must have argument name specified!");
1673 error("cl::alias must have an cl::aliasopt(option) specified!");
1677 void setAliasFor(Option &O) {
1679 error("cl::alias must only have one cl::aliasopt(...) specified!");
1685 explicit alias(const M0t &M0) : Option(Optional, Hidden), AliasFor(nullptr) {
1690 template<class M0t, class M1t>
1691 alias(const M0t &M0, const M1t &M1)
1692 : Option(Optional, Hidden), AliasFor(nullptr) {
1693 apply(M0, this); apply(M1, this);
1697 template<class M0t, class M1t, class M2t>
1698 alias(const M0t &M0, const M1t &M1, const M2t &M2)
1699 : Option(Optional, Hidden), AliasFor(nullptr) {
1700 apply(M0, this); apply(M1, this); apply(M2, this);
1704 template<class M0t, class M1t, class M2t, class M3t>
1705 alias(const M0t &M0, const M1t &M1, const M2t &M2, const M3t &M3)
1706 : Option(Optional, Hidden), AliasFor(nullptr) {
1707 apply(M0, this); apply(M1, this); apply(M2, this); apply(M3, this);
1712 // aliasfor - Modifier to set the option an alias aliases.
1715 explicit aliasopt(Option &O) : Opt(O) {}
1716 void apply(alias &A) const { A.setAliasFor(Opt); }
1719 // extrahelp - provide additional help at the end of the normal help
1720 // output. All occurrences of cl::extrahelp will be accumulated and
1721 // printed to stderr at the end of the regular help, just before
1724 const char * morehelp;
1725 explicit extrahelp(const char* help);
1728 void PrintVersionMessage();
1730 /// This function just prints the help message, exactly the same way as if the
1731 /// -help or -help-hidden option had been given on the command line.
1733 /// NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1735 /// \param Hidden if true will print hidden options
1736 /// \param Categorized if true print options in categories
1737 void PrintHelpMessage(bool Hidden=false, bool Categorized=false);
1740 //===----------------------------------------------------------------------===//
1741 // Public interface for accessing registered options.
1744 /// \brief Use this to get a StringMap to all registered named options
1745 /// (e.g. -help). Note \p Map Should be an empty StringMap.
1747 /// \param [out] Map will be filled with mappings where the key is the
1748 /// Option argument string (e.g. "help") and value is the corresponding
1751 /// Access to unnamed arguments (i.e. positional) are not provided because
1752 /// it is expected that the client already has access to these.
1756 /// main(int argc,char* argv[]) {
1757 /// StringMap<llvm::cl::Option*> opts;
1758 /// llvm::cl::getRegisteredOptions(opts);
1759 /// assert(opts.count("help") == 1)
1760 /// opts["help"]->setDescription("Show alphabetical help information")
1762 /// llvm::cl::ParseCommandLineOptions(argc,argv);
1767 /// This interface is useful for modifying options in libraries that are out of
1768 /// the control of the client. The options should be modified before calling
1769 /// llvm::cl::ParseCommandLineOptions().
1770 void getRegisteredOptions(StringMap<Option*> &Map);
1772 //===----------------------------------------------------------------------===//
1773 // Standalone command line processing utilities.
1776 /// \brief Tokenizes a command line that can contain escapes and quotes.
1778 /// The quoting rules match those used by GCC and other tools that use
1779 /// libiberty's buildargv() or expandargv() utilities, and do not match bash.
1780 /// They differ from buildargv() on treatment of backslashes that do not escape
1781 /// a special character to make it possible to accept most Windows file paths.
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 TokenizeGNUCommandLine(StringRef Source, StringSaver &Saver,
1787 SmallVectorImpl<const char *> &NewArgv);
1789 /// \brief Tokenizes a Windows command line which may contain quotes and escaped
1792 /// See MSDN docs for CommandLineToArgvW for information on the quoting rules.
1793 /// http://msdn.microsoft.com/en-us/library/windows/desktop/17w5ykft(v=vs.85).aspx
1795 /// \param [in] Source The string to be split on whitespace with quotes.
1796 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1797 /// \param [out] NewArgv All parsed strings are appended to NewArgv.
1798 void TokenizeWindowsCommandLine(StringRef Source, StringSaver &Saver,
1799 SmallVectorImpl<const char *> &NewArgv);
1801 /// \brief String tokenization function type. Should be compatible with either
1802 /// Windows or Unix command line tokenizers.
1803 typedef void (*TokenizerCallback)(StringRef Source, StringSaver &Saver,
1804 SmallVectorImpl<const char *> &NewArgv);
1806 /// \brief Expand response files on a command line recursively using the given
1807 /// StringSaver and tokenization strategy. Argv should contain the command line
1808 /// before expansion and will be modified in place.
1810 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1811 /// \param [in] Tokenizer Tokenization strategy. Typically Unix or Windows.
1812 /// \param [in,out] Argv Command line into which to expand response files.
1813 /// \return true if all @files were expanded successfully or there were none.
1814 bool ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
1815 SmallVectorImpl<const char *> &Argv);
1817 } // End namespace cl
1819 } // End namespace llvm