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/ArrayRef.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/ADT/StringMap.h"
26 #include "llvm/ADT/Twine.h"
27 #include "llvm/Support/Compiler.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)());
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 // Forward declaration - AddLiteralOption needs to be up here to make gcc happy.
79 /// \brief Adds a new option for parsing and provides the option it refers to.
81 /// \param O pointer to the option
82 /// \param Name the string name for the option to handle during parsing
84 /// Literal options are used by some parsers to register special option values.
85 /// This is how the PassNameParser registers pass names for opt.
86 void AddLiteralOption(Option &O, const char *Name);
88 //===----------------------------------------------------------------------===//
89 // Flags permitted to be passed to command line arguments
92 enum NumOccurrencesFlag { // Flags for the number of occurrences allowed
93 Optional = 0x00, // Zero or One occurrence
94 ZeroOrMore = 0x01, // Zero or more occurrences allowed
95 Required = 0x02, // One occurrence required
96 OneOrMore = 0x03, // One or more occurrences required
98 // ConsumeAfter - Indicates that this option is fed anything that follows the
99 // last positional argument required by the application (it is an error if
100 // there are zero positional arguments, and a ConsumeAfter option is used).
101 // Thus, for example, all arguments to LLI are processed until a filename is
102 // found. Once a filename is found, all of the succeeding arguments are
103 // passed, unprocessed, to the ConsumeAfter option.
108 enum ValueExpected { // Is a value required for the option?
109 // zero reserved for the unspecified value
110 ValueOptional = 0x01, // The value can appear... or not
111 ValueRequired = 0x02, // The value is required to appear!
112 ValueDisallowed = 0x03 // A value may not be specified (for flags)
115 enum OptionHidden { // Control whether -help shows this option
116 NotHidden = 0x00, // Option included in -help & -help-hidden
117 Hidden = 0x01, // -help doesn't, but -help-hidden does
118 ReallyHidden = 0x02 // Neither -help nor -help-hidden show this arg
121 // Formatting flags - This controls special features that the option might have
122 // that cause it to be parsed differently...
124 // Prefix - This option allows arguments that are otherwise unrecognized to be
125 // matched by options that are a prefix of the actual value. This is useful for
126 // cases like a linker, where options are typically of the form '-lfoo' or
127 // '-L../../include' where -l or -L are the actual flags. When prefix is
128 // enabled, and used, the value for the flag comes from the suffix of the
131 // Grouping - With this option enabled, multiple letter options are allowed to
132 // bunch together with only a single hyphen for the whole group. This allows
133 // emulation of the behavior that ls uses for example: ls -la === ls -l -a
136 enum FormattingFlags {
137 NormalFormatting = 0x00, // Nothing special
138 Positional = 0x01, // Is a positional argument, no '-' required
139 Prefix = 0x02, // Can this option directly prefix its value?
140 Grouping = 0x03 // Can this option group with other options?
143 enum MiscFlags { // Miscellaneous flags to adjust argument
144 CommaSeparated = 0x01, // Should this cl::list split between commas?
145 PositionalEatsArgs = 0x02, // Should this positional cl::list eat -args?
146 Sink = 0x04 // Should this cl::list eat all unknown options?
149 //===----------------------------------------------------------------------===//
150 // Option Category class
152 class OptionCategory {
154 const char *const Name;
155 const char *const Description;
156 void registerCategory();
159 OptionCategory(const char *const Name,
160 const char *const Description = nullptr)
161 : Name(Name), Description(Description) {
164 const char *getName() const { return Name; }
165 const char *getDescription() const { return Description; }
168 // The general Option Category (used as default category).
169 extern OptionCategory GeneralCategory;
171 //===----------------------------------------------------------------------===//
178 // handleOccurrences - Overriden by subclasses to handle the value passed into
179 // an argument. Should return true if there was an error processing the
180 // argument and the program should exit.
182 virtual bool handleOccurrence(unsigned pos, StringRef ArgName,
185 virtual enum ValueExpected getValueExpectedFlagDefault() const {
186 return ValueOptional;
189 // Out of line virtual function to provide home for the class.
190 virtual void anchor();
192 int NumOccurrences; // The number of times specified
193 // Occurrences, HiddenFlag, and Formatting are all enum types but to avoid
194 // problems with signed enums in bitfields.
195 unsigned Occurrences : 3; // enum NumOccurrencesFlag
196 // not using the enum type for 'Value' because zero is an implementation
197 // detail representing the non-value
199 unsigned HiddenFlag : 2; // enum OptionHidden
200 unsigned Formatting : 2; // enum FormattingFlags
202 unsigned Position; // Position of last occurrence of the option
203 unsigned AdditionalVals; // Greater than 0 for multi-valued option.
206 const char *ArgStr; // The argument string itself (ex: "help", "o")
207 const char *HelpStr; // The descriptive text message for -help
208 const char *ValueStr; // String describing what the value of this option is
209 OptionCategory *Category; // The Category this option belongs to
210 bool FullyInitialized; // Has addArguemnt been called?
212 inline enum NumOccurrencesFlag getNumOccurrencesFlag() const {
213 return (enum NumOccurrencesFlag)Occurrences;
215 inline enum ValueExpected getValueExpectedFlag() const {
216 return Value ? ((enum ValueExpected)Value) : getValueExpectedFlagDefault();
218 inline enum OptionHidden getOptionHiddenFlag() const {
219 return (enum OptionHidden)HiddenFlag;
221 inline enum FormattingFlags getFormattingFlag() const {
222 return (enum FormattingFlags)Formatting;
224 inline unsigned getMiscFlags() const { return Misc; }
225 inline unsigned getPosition() const { return Position; }
226 inline unsigned getNumAdditionalVals() const { return AdditionalVals; }
228 // hasArgStr - Return true if the argstr != ""
229 bool hasArgStr() const { return ArgStr[0] != 0; }
231 //-------------------------------------------------------------------------===
232 // Accessor functions set by OptionModifiers
234 void setArgStr(const char *S);
235 void setDescription(const char *S) { HelpStr = S; }
236 void setValueStr(const char *S) { ValueStr = S; }
237 void setNumOccurrencesFlag(enum NumOccurrencesFlag Val) { Occurrences = Val; }
238 void setValueExpectedFlag(enum ValueExpected Val) { Value = Val; }
239 void setHiddenFlag(enum OptionHidden Val) { HiddenFlag = Val; }
240 void setFormattingFlag(enum FormattingFlags V) { Formatting = V; }
241 void setMiscFlag(enum MiscFlags M) { Misc |= M; }
242 void setPosition(unsigned pos) { Position = pos; }
243 void setCategory(OptionCategory &C) { Category = &C; }
246 explicit Option(enum NumOccurrencesFlag OccurrencesFlag,
247 enum OptionHidden Hidden)
248 : NumOccurrences(0), Occurrences(OccurrencesFlag), Value(0),
249 HiddenFlag(Hidden), Formatting(NormalFormatting), Misc(0), Position(0),
250 AdditionalVals(0), ArgStr(""), HelpStr(""), ValueStr(""),
251 Category(&GeneralCategory), FullyInitialized(false) {}
253 inline void setNumAdditionalVals(unsigned n) { AdditionalVals = n; }
256 // addArgument - Register this argument with the commandline system.
260 /// Unregisters this option from the CommandLine system.
262 /// This option must have been the last option registered.
263 /// For testing purposes only.
264 void removeArgument();
266 // Return the width of the option tag for printing...
267 virtual size_t getOptionWidth() const = 0;
269 // printOptionInfo - Print out information about this option. The
270 // to-be-maintained width is specified.
272 virtual void printOptionInfo(size_t GlobalWidth) const = 0;
274 virtual void printOptionValue(size_t GlobalWidth, bool Force) const = 0;
276 virtual void getExtraOptionNames(SmallVectorImpl<const char *> &) {}
278 // addOccurrence - Wrapper around handleOccurrence that enforces Flags.
280 virtual bool addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
281 bool MultiArg = false);
283 // Prints option name followed by message. Always returns true.
284 bool error(const Twine &Message, StringRef ArgName = StringRef());
287 inline int getNumOccurrences() const { return NumOccurrences; }
291 //===----------------------------------------------------------------------===//
292 // Command line option modifiers that can be used to modify the behavior of
293 // command line option parsers...
296 // desc - Modifier to set the description shown in the -help output...
299 desc(const char *Str) : Desc(Str) {}
300 void apply(Option &O) const { O.setDescription(Desc); }
303 // value_desc - Modifier to set the value description shown in the -help
307 value_desc(const char *Str) : Desc(Str) {}
308 void apply(Option &O) const { O.setValueStr(Desc); }
311 // init - Specify a default (initial) value for the command line argument, if
312 // the default constructor for the argument type does not give you what you
313 // want. This is only valid on "opt" arguments, not on "list" arguments.
315 template <class Ty> struct initializer {
317 initializer(const Ty &Val) : Init(Val) {}
319 template <class Opt> void apply(Opt &O) const { O.setInitialValue(Init); }
322 template <class Ty> initializer<Ty> init(const Ty &Val) {
323 return initializer<Ty>(Val);
326 // location - Allow the user to specify which external variable they want to
327 // store the results of the command line argument processing into, if they don't
328 // want to store it in the option itself.
330 template <class Ty> struct LocationClass {
332 LocationClass(Ty &L) : Loc(L) {}
334 template <class Opt> void apply(Opt &O) const { O.setLocation(O, Loc); }
337 template <class Ty> LocationClass<Ty> location(Ty &L) {
338 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) {}
347 template <class Opt> void apply(Opt &O) const { O.setCategory(Category); }
350 //===----------------------------------------------------------------------===//
353 // Support value comparison outside the template.
354 struct GenericOptionValue {
355 virtual bool compare(const GenericOptionValue &V) const = 0;
358 ~GenericOptionValue() = default;
359 GenericOptionValue() = default;
360 GenericOptionValue(const GenericOptionValue&) = default;
361 GenericOptionValue &operator=(const GenericOptionValue &) = default;
364 virtual void anchor();
367 template <class DataType> struct OptionValue;
369 // The default value safely does nothing. Option value printing is only
371 template <class DataType, bool isClass>
372 struct OptionValueBase : public GenericOptionValue {
373 // Temporary storage for argument passing.
374 typedef OptionValue<DataType> WrapperType;
376 bool hasValue() const { return false; }
378 const DataType &getValue() const { llvm_unreachable("no default value"); }
380 // Some options may take their value from a different data type.
381 template <class DT> void setValue(const DT & /*V*/) {}
383 bool compare(const DataType & /*V*/) const { return false; }
385 bool compare(const GenericOptionValue & /*V*/) const override {
390 ~OptionValueBase() = default;
393 // Simple copy of the option value.
394 template <class DataType> class OptionValueCopy : public GenericOptionValue {
399 ~OptionValueCopy() = default;
400 OptionValueCopy(const OptionValueCopy&) = default;
401 OptionValueCopy &operator=(const OptionValueCopy&) = default;
404 OptionValueCopy() : Valid(false) {}
406 bool hasValue() const { return Valid; }
408 const DataType &getValue() const {
409 assert(Valid && "invalid option value");
413 void setValue(const DataType &V) {
418 bool compare(const DataType &V) const { return Valid && (Value != V); }
420 bool compare(const GenericOptionValue &V) const override {
421 const OptionValueCopy<DataType> &VC =
422 static_cast<const OptionValueCopy<DataType> &>(V);
425 return compare(VC.getValue());
429 // Non-class option values.
430 template <class DataType>
431 struct OptionValueBase<DataType, false> : OptionValueCopy<DataType> {
432 typedef DataType WrapperType;
435 ~OptionValueBase() = default;
436 OptionValueBase() = default;
437 OptionValueBase(const OptionValueBase&) = default;
438 OptionValueBase &operator=(const OptionValueBase&) = default;
441 // Top-level option class.
442 template <class DataType>
443 struct OptionValue final
444 : OptionValueBase<DataType, std::is_class<DataType>::value> {
445 OptionValue() = default;
447 OptionValue(const DataType &V) { this->setValue(V); }
448 // Some options may take their value from a different data type.
449 template <class DT> OptionValue<DataType> &operator=(const DT &V) {
455 // Other safe-to-copy-by-value common option types.
456 enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE };
458 struct OptionValue<cl::boolOrDefault> final
459 : OptionValueCopy<cl::boolOrDefault> {
460 typedef cl::boolOrDefault WrapperType;
464 OptionValue(const cl::boolOrDefault &V) { this->setValue(V); }
465 OptionValue<cl::boolOrDefault> &operator=(const cl::boolOrDefault &V) {
471 void anchor() override;
475 struct OptionValue<std::string> final : OptionValueCopy<std::string> {
476 typedef StringRef WrapperType;
480 OptionValue(const std::string &V) { this->setValue(V); }
481 OptionValue<std::string> &operator=(const std::string &V) {
487 void anchor() override;
490 //===----------------------------------------------------------------------===//
491 // Enum valued command line option
493 #define clEnumVal(ENUMVAL, DESC) #ENUMVAL, int(ENUMVAL), DESC
494 #define clEnumValN(ENUMVAL, FLAGNAME, DESC) FLAGNAME, int(ENUMVAL), DESC
495 #define clEnumValEnd (reinterpret_cast<void *>(0))
497 // values - For custom data types, allow specifying a group of values together
498 // as the values that go into the mapping that the option handler uses. Note
499 // that the values list must always have a 0 at the end of the list to indicate
500 // that the list has ended.
502 template <class DataType> class ValuesClass {
503 // Use a vector instead of a map, because the lists should be short,
504 // the overhead is less, and most importantly, it keeps them in the order
505 // inserted so we can print our option out nicely.
506 SmallVector<std::pair<const char *, std::pair<int, const char *>>, 4> Values;
507 void processValues(va_list Vals);
510 ValuesClass(const char *EnumName, DataType Val, const char *Desc,
512 // Insert the first value, which is required.
513 Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc)));
515 // Process the varargs portion of the values...
516 while (const char *enumName = va_arg(ValueArgs, const char *)) {
517 DataType EnumVal = static_cast<DataType>(va_arg(ValueArgs, int));
518 const char *EnumDesc = va_arg(ValueArgs, const char *);
519 Values.push_back(std::make_pair(enumName, // Add value to value map
520 std::make_pair(EnumVal, EnumDesc)));
524 template <class Opt> void apply(Opt &O) const {
525 for (size_t i = 0, e = Values.size(); i != e; ++i)
526 O.getParser().addLiteralOption(Values[i].first, Values[i].second.first,
527 Values[i].second.second);
531 template <class DataType>
532 ValuesClass<DataType> LLVM_END_WITH_NULL
533 values(const char *Arg, DataType Val, const char *Desc, ...) {
535 va_start(ValueArgs, Desc);
536 ValuesClass<DataType> Vals(Arg, Val, Desc, ValueArgs);
541 //===----------------------------------------------------------------------===//
542 // parser class - Parameterizable parser for different data types. By default,
543 // known data types (string, int, bool) have specialized parsers, that do what
544 // you would expect. The default parser, used for data types that are not
545 // built-in, uses a mapping table to map specific options to values, which is
546 // used, among other things, to handle enum types.
548 //--------------------------------------------------
549 // generic_parser_base - This class holds all the non-generic code that we do
550 // not need replicated for every instance of the generic parser. This also
551 // allows us to put stuff into CommandLine.cpp
553 class generic_parser_base {
555 class GenericOptionInfo {
557 GenericOptionInfo(const char *name, const char *helpStr)
558 : Name(name), HelpStr(helpStr) {}
564 generic_parser_base(Option &O) : Owner(O) {}
566 virtual ~generic_parser_base() {} // Base class should have virtual-dtor
568 // getNumOptions - Virtual function implemented by generic subclass to
569 // indicate how many entries are in Values.
571 virtual unsigned getNumOptions() const = 0;
573 // getOption - Return option name N.
574 virtual const char *getOption(unsigned N) const = 0;
576 // getDescription - Return description N
577 virtual const char *getDescription(unsigned N) const = 0;
579 // Return the width of the option tag for printing...
580 virtual size_t getOptionWidth(const Option &O) const;
582 virtual const GenericOptionValue &getOptionValue(unsigned N) const = 0;
584 // printOptionInfo - Print out information about this option. The
585 // to-be-maintained width is specified.
587 virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const;
589 void printGenericOptionDiff(const Option &O, const GenericOptionValue &V,
590 const GenericOptionValue &Default,
591 size_t GlobalWidth) const;
593 // printOptionDiff - print the value of an option and it's default.
595 // Template definition ensures that the option and default have the same
596 // DataType (via the same AnyOptionValue).
597 template <class AnyOptionValue>
598 void printOptionDiff(const Option &O, const AnyOptionValue &V,
599 const AnyOptionValue &Default,
600 size_t GlobalWidth) const {
601 printGenericOptionDiff(O, V, Default, GlobalWidth);
606 void getExtraOptionNames(SmallVectorImpl<const char *> &OptionNames) {
607 // If there has been no argstr specified, that means that we need to add an
608 // argument for every possible option. This ensures that our options are
610 if (!Owner.hasArgStr())
611 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
612 OptionNames.push_back(getOption(i));
615 enum ValueExpected getValueExpectedFlagDefault() const {
616 // If there is an ArgStr specified, then we are of the form:
618 // -opt=O2 or -opt O2 or -optO2
620 // In which case, the value is required. Otherwise if an arg str has not
621 // been specified, we are of the form:
623 // -O2 or O2 or -la (where -l and -a are separate options)
625 // If this is the case, we cannot allow a value.
627 if (Owner.hasArgStr())
628 return ValueRequired;
630 return ValueDisallowed;
633 // findOption - Return the option number corresponding to the specified
634 // argument string. If the option is not found, getNumOptions() is returned.
636 unsigned findOption(const char *Name);
642 // Default parser implementation - This implementation depends on having a
643 // mapping of recognized options to values of some sort. In addition to this,
644 // each entry in the mapping also tracks a help message that is printed with the
645 // command line option for -help. Because this is a simple mapping parser, the
646 // data type can be any unsupported type.
648 template <class DataType> class parser : public generic_parser_base {
650 class OptionInfo : public GenericOptionInfo {
652 OptionInfo(const char *name, DataType v, const char *helpStr)
653 : GenericOptionInfo(name, helpStr), V(v) {}
654 OptionValue<DataType> V;
656 SmallVector<OptionInfo, 8> Values;
659 parser(Option &O) : generic_parser_base(O) {}
660 typedef DataType parser_data_type;
662 // Implement virtual functions needed by generic_parser_base
663 unsigned getNumOptions() const override { return unsigned(Values.size()); }
664 const char *getOption(unsigned N) const override { return Values[N].Name; }
665 const char *getDescription(unsigned N) const override {
666 return Values[N].HelpStr;
669 // getOptionValue - Return the value of option name N.
670 const GenericOptionValue &getOptionValue(unsigned N) const override {
674 // parse - Return true on error.
675 bool parse(Option &O, StringRef ArgName, StringRef Arg, DataType &V) {
677 if (Owner.hasArgStr())
682 for (size_t i = 0, e = Values.size(); i != e; ++i)
683 if (Values[i].Name == ArgVal) {
684 V = Values[i].V.getValue();
688 return O.error("Cannot find option named '" + ArgVal + "'!");
691 /// addLiteralOption - Add an entry to the mapping table.
694 void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) {
695 assert(findOption(Name) == Values.size() && "Option already exists!");
696 OptionInfo X(Name, static_cast<DataType>(V), HelpStr);
698 AddLiteralOption(Owner, Name);
701 /// removeLiteralOption - Remove the specified option.
703 void removeLiteralOption(const char *Name) {
704 unsigned N = findOption(Name);
705 assert(N != Values.size() && "Option not found!");
706 Values.erase(Values.begin() + N);
710 //--------------------------------------------------
711 // basic_parser - Super class of parsers to provide boilerplate code
713 class basic_parser_impl { // non-template implementation of basic_parser<t>
715 basic_parser_impl(Option &O) {}
718 enum ValueExpected getValueExpectedFlagDefault() const {
719 return ValueRequired;
722 void getExtraOptionNames(SmallVectorImpl<const char *> &) {}
726 // Return the width of the option tag for printing...
727 size_t getOptionWidth(const Option &O) const;
729 // printOptionInfo - Print out information about this option. The
730 // to-be-maintained width is specified.
732 void printOptionInfo(const Option &O, size_t GlobalWidth) const;
734 // printOptionNoValue - Print a placeholder for options that don't yet support
735 // printOptionDiff().
736 void printOptionNoValue(const Option &O, size_t GlobalWidth) const;
738 // getValueName - Overload in subclass to provide a better default value.
739 virtual const char *getValueName() const { return "value"; }
741 // An out-of-line virtual method to provide a 'home' for this class.
742 virtual void anchor();
745 ~basic_parser_impl() = default;
746 // A helper for basic_parser::printOptionDiff.
747 void printOptionName(const Option &O, size_t GlobalWidth) const;
750 // basic_parser - The real basic parser is just a template wrapper that provides
751 // a typedef for the provided data type.
753 template <class DataType> class basic_parser : public basic_parser_impl {
755 basic_parser(Option &O) : basic_parser_impl(O) {}
756 typedef DataType parser_data_type;
757 typedef OptionValue<DataType> OptVal;
760 ~basic_parser() = default;
763 //--------------------------------------------------
766 template <> class parser<bool> final : public basic_parser<bool> {
768 parser(Option &O) : basic_parser(O) {}
770 // parse - Return true on error.
771 bool parse(Option &O, StringRef ArgName, StringRef Arg, bool &Val);
775 enum ValueExpected getValueExpectedFlagDefault() const {
776 return ValueOptional;
779 // getValueName - Do not print =<value> at all.
780 const char *getValueName() const override { return nullptr; }
782 void printOptionDiff(const Option &O, bool V, OptVal Default,
783 size_t GlobalWidth) const;
785 // An out-of-line virtual method to provide a 'home' for this class.
786 void anchor() override;
789 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<bool>);
791 //--------------------------------------------------
792 // parser<boolOrDefault>
794 class parser<boolOrDefault> final : public basic_parser<boolOrDefault> {
796 parser(Option &O) : basic_parser(O) {}
798 // parse - Return true on error.
799 bool parse(Option &O, StringRef ArgName, StringRef Arg, boolOrDefault &Val);
801 enum ValueExpected getValueExpectedFlagDefault() const {
802 return ValueOptional;
805 // getValueName - Do not print =<value> at all.
806 const char *getValueName() const override { return nullptr; }
808 void printOptionDiff(const Option &O, boolOrDefault V, OptVal Default,
809 size_t GlobalWidth) const;
811 // An out-of-line virtual method to provide a 'home' for this class.
812 void anchor() override;
815 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
817 //--------------------------------------------------
820 template <> class parser<int> final : public basic_parser<int> {
822 parser(Option &O) : basic_parser(O) {}
824 // parse - Return true on error.
825 bool parse(Option &O, StringRef ArgName, StringRef Arg, int &Val);
827 // getValueName - Overload in subclass to provide a better default value.
828 const char *getValueName() const override { return "int"; }
830 void printOptionDiff(const Option &O, int V, OptVal Default,
831 size_t GlobalWidth) const;
833 // An out-of-line virtual method to provide a 'home' for this class.
834 void anchor() override;
837 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<int>);
839 //--------------------------------------------------
842 template <> class parser<unsigned> final : public basic_parser<unsigned> {
844 parser(Option &O) : basic_parser(O) {}
846 // parse - Return true on error.
847 bool parse(Option &O, StringRef ArgName, StringRef Arg, unsigned &Val);
849 // getValueName - Overload in subclass to provide a better default value.
850 const char *getValueName() const override { return "uint"; }
852 void printOptionDiff(const Option &O, unsigned V, OptVal Default,
853 size_t GlobalWidth) const;
855 // An out-of-line virtual method to provide a 'home' for this class.
856 void anchor() override;
859 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
861 //--------------------------------------------------
862 // parser<unsigned long long>
865 class parser<unsigned long long> final
866 : public basic_parser<unsigned long long> {
868 parser(Option &O) : basic_parser(O) {}
870 // parse - Return true on error.
871 bool parse(Option &O, StringRef ArgName, StringRef Arg,
872 unsigned long long &Val);
874 // getValueName - Overload in subclass to provide a better default value.
875 const char *getValueName() const override { return "uint"; }
877 void printOptionDiff(const Option &O, unsigned long long V, OptVal Default,
878 size_t GlobalWidth) const;
880 // An out-of-line virtual method to provide a 'home' for this class.
881 void anchor() override;
884 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
886 //--------------------------------------------------
889 template <> class parser<double> final : public basic_parser<double> {
891 parser(Option &O) : basic_parser(O) {}
893 // parse - Return true on error.
894 bool parse(Option &O, StringRef ArgName, StringRef Arg, double &Val);
896 // getValueName - Overload in subclass to provide a better default value.
897 const char *getValueName() const override { return "number"; }
899 void printOptionDiff(const Option &O, double V, OptVal Default,
900 size_t GlobalWidth) const;
902 // An out-of-line virtual method to provide a 'home' for this class.
903 void anchor() override;
906 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<double>);
908 //--------------------------------------------------
911 template <> class parser<float> final : public basic_parser<float> {
913 parser(Option &O) : basic_parser(O) {}
915 // parse - Return true on error.
916 bool parse(Option &O, StringRef ArgName, StringRef Arg, float &Val);
918 // getValueName - Overload in subclass to provide a better default value.
919 const char *getValueName() const override { return "number"; }
921 void printOptionDiff(const Option &O, float V, OptVal Default,
922 size_t GlobalWidth) const;
924 // An out-of-line virtual method to provide a 'home' for this class.
925 void anchor() override;
928 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<float>);
930 //--------------------------------------------------
931 // parser<std::string>
933 template <> class parser<std::string> final : public basic_parser<std::string> {
935 parser(Option &O) : basic_parser(O) {}
937 // parse - Return true on error.
938 bool parse(Option &, StringRef, StringRef Arg, std::string &Value) {
943 // getValueName - Overload in subclass to provide a better default value.
944 const char *getValueName() const override { return "string"; }
946 void printOptionDiff(const Option &O, StringRef V, OptVal Default,
947 size_t GlobalWidth) const;
949 // An out-of-line virtual method to provide a 'home' for this class.
950 void anchor() override;
953 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
955 //--------------------------------------------------
958 template <> class parser<char> final : public basic_parser<char> {
960 parser(Option &O) : basic_parser(O) {}
962 // parse - Return true on error.
963 bool parse(Option &, StringRef, StringRef Arg, char &Value) {
968 // getValueName - Overload in subclass to provide a better default value.
969 const char *getValueName() const override { return "char"; }
971 void printOptionDiff(const Option &O, char V, OptVal Default,
972 size_t GlobalWidth) const;
974 // An out-of-line virtual method to provide a 'home' for this class.
975 void anchor() override;
978 EXTERN_TEMPLATE_INSTANTIATION(class basic_parser<char>);
980 //--------------------------------------------------
983 // This collection of wrappers is the intermediary between class opt and class
984 // parser to handle all the template nastiness.
986 // This overloaded function is selected by the generic parser.
987 template <class ParserClass, class DT>
988 void printOptionDiff(const Option &O, const generic_parser_base &P, const DT &V,
989 const OptionValue<DT> &Default, size_t GlobalWidth) {
990 OptionValue<DT> OV = V;
991 P.printOptionDiff(O, OV, Default, GlobalWidth);
994 // This is instantiated for basic parsers when the parsed value has a different
995 // type than the option value. e.g. HelpPrinter.
996 template <class ParserDT, class ValDT> struct OptionDiffPrinter {
997 void print(const Option &O, const parser<ParserDT> &P, const ValDT & /*V*/,
998 const OptionValue<ValDT> & /*Default*/, size_t GlobalWidth) {
999 P.printOptionNoValue(O, GlobalWidth);
1003 // This is instantiated for basic parsers when the parsed value has the same
1004 // type as the option value.
1005 template <class DT> struct OptionDiffPrinter<DT, DT> {
1006 void print(const Option &O, const parser<DT> &P, const DT &V,
1007 const OptionValue<DT> &Default, size_t GlobalWidth) {
1008 P.printOptionDiff(O, V, Default, GlobalWidth);
1012 // This overloaded function is selected by the basic parser, which may parse a
1013 // different type than the option type.
1014 template <class ParserClass, class ValDT>
1015 void printOptionDiff(
1017 const basic_parser<typename ParserClass::parser_data_type> &P,
1018 const ValDT &V, const OptionValue<ValDT> &Default, size_t GlobalWidth) {
1020 OptionDiffPrinter<typename ParserClass::parser_data_type, ValDT> printer;
1021 printer.print(O, static_cast<const ParserClass &>(P), V, Default,
1025 //===----------------------------------------------------------------------===//
1026 // applicator class - This class is used because we must use partial
1027 // specialization to handle literal string arguments specially (const char* does
1028 // not correctly respond to the apply method). Because the syntax to use this
1029 // is a pain, we have the 'apply' method below to handle the nastiness...
1031 template <class Mod> struct applicator {
1032 template <class Opt> static void opt(const Mod &M, Opt &O) { M.apply(O); }
1035 // Handle const char* as a special case...
1036 template <unsigned n> struct applicator<char[n]> {
1037 template <class Opt> static void opt(const char *Str, Opt &O) {
1041 template <unsigned n> struct applicator<const char[n]> {
1042 template <class Opt> static void opt(const char *Str, Opt &O) {
1046 template <> struct applicator<const char *> {
1047 template <class Opt> static void opt(const char *Str, Opt &O) {
1052 template <> struct applicator<NumOccurrencesFlag> {
1053 static void opt(NumOccurrencesFlag N, Option &O) {
1054 O.setNumOccurrencesFlag(N);
1057 template <> struct applicator<ValueExpected> {
1058 static void opt(ValueExpected VE, Option &O) { O.setValueExpectedFlag(VE); }
1060 template <> struct applicator<OptionHidden> {
1061 static void opt(OptionHidden OH, Option &O) { O.setHiddenFlag(OH); }
1063 template <> struct applicator<FormattingFlags> {
1064 static void opt(FormattingFlags FF, Option &O) { O.setFormattingFlag(FF); }
1066 template <> struct applicator<MiscFlags> {
1067 static void opt(MiscFlags MF, Option &O) { O.setMiscFlag(MF); }
1070 // apply method - Apply modifiers to an option in a type safe way.
1071 template <class Opt, class Mod, class... Mods>
1072 void apply(Opt *O, const Mod &M, const Mods &... Ms) {
1073 applicator<Mod>::opt(M, *O);
1077 template <class Opt, class Mod> void apply(Opt *O, const Mod &M) {
1078 applicator<Mod>::opt(M, *O);
1081 //===----------------------------------------------------------------------===//
1082 // opt_storage class
1084 // Default storage class definition: external storage. This implementation
1085 // assumes the user will specify a variable to store the data into with the
1086 // cl::location(x) modifier.
1088 template <class DataType, bool ExternalStorage, bool isClass>
1090 DataType *Location; // Where to store the object...
1091 OptionValue<DataType> Default;
1093 void check_location() const {
1094 assert(Location && "cl::location(...) not specified for a command "
1095 "line option with external storage, "
1096 "or cl::init specified before cl::location()!!");
1100 opt_storage() : Location(nullptr) {}
1102 bool setLocation(Option &O, DataType &L) {
1104 return O.error("cl::location(x) specified more than once!");
1110 template <class T> void setValue(const T &V, bool initial = false) {
1117 DataType &getValue() {
1121 const DataType &getValue() const {
1126 operator DataType() const { return this->getValue(); }
1128 const OptionValue<DataType> &getDefault() const { return Default; }
1131 // Define how to hold a class type object, such as a string. Since we can
1132 // inherit from a class, we do so. This makes us exactly compatible with the
1133 // object in all cases that it is used.
1135 template <class DataType>
1136 class opt_storage<DataType, false, true> : public DataType {
1138 OptionValue<DataType> Default;
1140 template <class T> void setValue(const T &V, bool initial = false) {
1141 DataType::operator=(V);
1146 DataType &getValue() { return *this; }
1147 const DataType &getValue() const { return *this; }
1149 const OptionValue<DataType> &getDefault() const { return Default; }
1152 // Define a partial specialization to handle things we cannot inherit from. In
1153 // this case, we store an instance through containment, and overload operators
1154 // to get at the value.
1156 template <class DataType> class opt_storage<DataType, false, false> {
1159 OptionValue<DataType> Default;
1161 // Make sure we initialize the value with the default constructor for the
1163 opt_storage() : Value(DataType()), Default(DataType()) {}
1165 template <class T> void setValue(const T &V, bool initial = false) {
1170 DataType &getValue() { return Value; }
1171 DataType getValue() const { return Value; }
1173 const OptionValue<DataType> &getDefault() const { return Default; }
1175 operator DataType() const { return getValue(); }
1177 // If the datatype is a pointer, support -> on it.
1178 DataType operator->() const { return Value; }
1181 //===----------------------------------------------------------------------===//
1182 // opt - A scalar command line option.
1184 template <class DataType, bool ExternalStorage = false,
1185 class ParserClass = parser<DataType>>
1186 class opt : public Option,
1187 public opt_storage<DataType, ExternalStorage,
1188 std::is_class<DataType>::value> {
1191 bool handleOccurrence(unsigned pos, StringRef ArgName,
1192 StringRef Arg) override {
1193 typename ParserClass::parser_data_type Val =
1194 typename ParserClass::parser_data_type();
1195 if (Parser.parse(*this, ArgName, Arg, Val))
1196 return true; // Parse error!
1197 this->setValue(Val);
1198 this->setPosition(pos);
1202 enum ValueExpected getValueExpectedFlagDefault() const override {
1203 return Parser.getValueExpectedFlagDefault();
1206 getExtraOptionNames(SmallVectorImpl<const char *> &OptionNames) override {
1207 return Parser.getExtraOptionNames(OptionNames);
1210 // Forward printing stuff to the parser...
1211 size_t getOptionWidth() const override {
1212 return Parser.getOptionWidth(*this);
1214 void printOptionInfo(size_t GlobalWidth) const override {
1215 Parser.printOptionInfo(*this, GlobalWidth);
1218 void printOptionValue(size_t GlobalWidth, bool Force) const override {
1219 if (Force || this->getDefault().compare(this->getValue())) {
1220 cl::printOptionDiff<ParserClass>(*this, Parser, this->getValue(),
1221 this->getDefault(), GlobalWidth);
1227 Parser.initialize();
1230 // Command line options should not be copyable
1231 opt(const opt &) = delete;
1232 opt &operator=(const opt &) = delete;
1235 // setInitialValue - Used by the cl::init modifier...
1236 void setInitialValue(const DataType &V) { this->setValue(V, true); }
1238 ParserClass &getParser() { return Parser; }
1240 template <class T> DataType &operator=(const T &Val) {
1241 this->setValue(Val);
1242 return this->getValue();
1245 template <class... Mods>
1246 explicit opt(const Mods &... Ms)
1247 : Option(Optional, NotHidden), Parser(*this) {
1253 EXTERN_TEMPLATE_INSTANTIATION(class opt<unsigned>);
1254 EXTERN_TEMPLATE_INSTANTIATION(class opt<int>);
1255 EXTERN_TEMPLATE_INSTANTIATION(class opt<std::string>);
1256 EXTERN_TEMPLATE_INSTANTIATION(class opt<char>);
1257 EXTERN_TEMPLATE_INSTANTIATION(class opt<bool>);
1259 //===----------------------------------------------------------------------===//
1260 // list_storage class
1262 // Default storage class definition: external storage. This implementation
1263 // assumes the user will specify a variable to store the data into with the
1264 // cl::location(x) modifier.
1266 template <class DataType, class StorageClass> class list_storage {
1267 StorageClass *Location; // Where to store the object...
1270 list_storage() : Location(0) {}
1272 bool setLocation(Option &O, StorageClass &L) {
1274 return O.error("cl::location(x) specified more than once!");
1279 template <class T> void addValue(const T &V) {
1280 assert(Location != 0 && "cl::location(...) not specified for a command "
1281 "line option with external storage!");
1282 Location->push_back(V);
1286 // Define how to hold a class type object, such as a string. Since we can
1287 // inherit from a class, we do so. This makes us exactly compatible with the
1288 // object in all cases that it is used.
1290 template <class DataType>
1291 class list_storage<DataType, bool> : public std::vector<DataType> {
1293 template <class T> void addValue(const T &V) {
1294 std::vector<DataType>::push_back(V);
1298 //===----------------------------------------------------------------------===//
1299 // list - A list of command line options.
1301 template <class DataType, class Storage = bool,
1302 class ParserClass = parser<DataType>>
1303 class list : public Option, public list_storage<DataType, Storage> {
1304 std::vector<unsigned> Positions;
1307 enum ValueExpected getValueExpectedFlagDefault() const override {
1308 return Parser.getValueExpectedFlagDefault();
1311 getExtraOptionNames(SmallVectorImpl<const char *> &OptionNames) override {
1312 return Parser.getExtraOptionNames(OptionNames);
1315 bool handleOccurrence(unsigned pos, StringRef ArgName,
1316 StringRef Arg) override {
1317 typename ParserClass::parser_data_type Val =
1318 typename ParserClass::parser_data_type();
1319 if (Parser.parse(*this, ArgName, Arg, Val))
1320 return true; // Parse Error!
1321 list_storage<DataType, Storage>::addValue(Val);
1323 Positions.push_back(pos);
1327 // Forward printing stuff to the parser...
1328 size_t getOptionWidth() const override {
1329 return Parser.getOptionWidth(*this);
1331 void printOptionInfo(size_t GlobalWidth) const override {
1332 Parser.printOptionInfo(*this, GlobalWidth);
1335 // Unimplemented: list options don't currently store their default value.
1336 void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const override {
1341 Parser.initialize();
1344 // Command line options should not be copyable
1345 list(const list &) = delete;
1346 list &operator=(const list &) = delete;
1349 ParserClass &getParser() { return Parser; }
1351 unsigned getPosition(unsigned optnum) const {
1352 assert(optnum < this->size() && "Invalid option index");
1353 return Positions[optnum];
1356 void setNumAdditionalVals(unsigned n) { Option::setNumAdditionalVals(n); }
1358 template <class... Mods>
1359 explicit list(const Mods &... Ms)
1360 : Option(ZeroOrMore, NotHidden), Parser(*this) {
1366 // multi_val - Modifier to set the number of additional values.
1368 unsigned AdditionalVals;
1369 explicit multi_val(unsigned N) : AdditionalVals(N) {}
1371 template <typename D, typename S, typename P>
1372 void apply(list<D, S, P> &L) const {
1373 L.setNumAdditionalVals(AdditionalVals);
1377 //===----------------------------------------------------------------------===//
1378 // bits_storage class
1380 // Default storage class definition: external storage. This implementation
1381 // assumes the user will specify a variable to store the data into with the
1382 // cl::location(x) modifier.
1384 template <class DataType, class StorageClass> class bits_storage {
1385 unsigned *Location; // Where to store the bits...
1387 template <class T> static unsigned Bit(const T &V) {
1388 unsigned BitPos = reinterpret_cast<unsigned>(V);
1389 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1390 "enum exceeds width of bit vector!");
1395 bits_storage() : Location(nullptr) {}
1397 bool setLocation(Option &O, unsigned &L) {
1399 return O.error("cl::location(x) specified more than once!");
1404 template <class T> void addValue(const T &V) {
1405 assert(Location != 0 && "cl::location(...) not specified for a command "
1406 "line option with external storage!");
1407 *Location |= Bit(V);
1410 unsigned getBits() { return *Location; }
1412 template <class T> bool isSet(const T &V) {
1413 return (*Location & Bit(V)) != 0;
1417 // Define how to hold bits. Since we can inherit from a class, we do so.
1418 // This makes us exactly compatible with the bits in all cases that it is used.
1420 template <class DataType> class bits_storage<DataType, bool> {
1421 unsigned Bits; // Where to store the bits...
1423 template <class T> static unsigned Bit(const T &V) {
1424 unsigned BitPos = (unsigned)V;
1425 assert(BitPos < sizeof(unsigned) * CHAR_BIT &&
1426 "enum exceeds width of bit vector!");
1431 template <class T> void addValue(const T &V) { Bits |= Bit(V); }
1433 unsigned getBits() { return Bits; }
1435 template <class T> bool isSet(const T &V) { return (Bits & Bit(V)) != 0; }
1438 //===----------------------------------------------------------------------===//
1439 // bits - A bit vector of command options.
1441 template <class DataType, class Storage = bool,
1442 class ParserClass = parser<DataType>>
1443 class bits : public Option, public bits_storage<DataType, Storage> {
1444 std::vector<unsigned> Positions;
1447 enum ValueExpected getValueExpectedFlagDefault() const override {
1448 return Parser.getValueExpectedFlagDefault();
1451 getExtraOptionNames(SmallVectorImpl<const char *> &OptionNames) override {
1452 return Parser.getExtraOptionNames(OptionNames);
1455 bool handleOccurrence(unsigned pos, StringRef ArgName,
1456 StringRef Arg) override {
1457 typename ParserClass::parser_data_type Val =
1458 typename ParserClass::parser_data_type();
1459 if (Parser.parse(*this, ArgName, Arg, Val))
1460 return true; // Parse Error!
1461 this->addValue(Val);
1463 Positions.push_back(pos);
1467 // Forward printing stuff to the parser...
1468 size_t getOptionWidth() const override {
1469 return Parser.getOptionWidth(*this);
1471 void printOptionInfo(size_t GlobalWidth) const override {
1472 Parser.printOptionInfo(*this, GlobalWidth);
1475 // Unimplemented: bits options don't currently store their default values.
1476 void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const override {
1481 Parser.initialize();
1484 // Command line options should not be copyable
1485 bits(const bits &) = delete;
1486 bits &operator=(const bits &) = delete;
1489 ParserClass &getParser() { return Parser; }
1491 unsigned getPosition(unsigned optnum) const {
1492 assert(optnum < this->size() && "Invalid option index");
1493 return Positions[optnum];
1496 template <class... Mods>
1497 explicit bits(const Mods &... Ms)
1498 : Option(ZeroOrMore, NotHidden), Parser(*this) {
1504 //===----------------------------------------------------------------------===//
1505 // Aliased command line option (alias this name to a preexisting name)
1508 class alias : public Option {
1510 bool handleOccurrence(unsigned pos, StringRef /*ArgName*/,
1511 StringRef Arg) override {
1512 return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg);
1514 bool addOccurrence(unsigned pos, StringRef /*ArgName*/, StringRef Value,
1515 bool MultiArg = false) override {
1516 return AliasFor->addOccurrence(pos, AliasFor->ArgStr, Value, MultiArg);
1518 // Handle printing stuff...
1519 size_t getOptionWidth() const override;
1520 void printOptionInfo(size_t GlobalWidth) const override;
1522 // Aliases do not need to print their values.
1523 void printOptionValue(size_t /*GlobalWidth*/, bool /*Force*/) const override {
1526 ValueExpected getValueExpectedFlagDefault() const override {
1527 return AliasFor->getValueExpectedFlag();
1532 error("cl::alias must have argument name specified!");
1534 error("cl::alias must have an cl::aliasopt(option) specified!");
1538 // Command line options should not be copyable
1539 alias(const alias &) = delete;
1540 alias &operator=(const alias &) = delete;
1543 void setAliasFor(Option &O) {
1545 error("cl::alias must only have one cl::aliasopt(...) specified!");
1549 template <class... Mods>
1550 explicit alias(const Mods &... Ms)
1551 : Option(Optional, Hidden), AliasFor(nullptr) {
1557 // aliasfor - Modifier to set the option an alias aliases.
1560 explicit aliasopt(Option &O) : Opt(O) {}
1561 void apply(alias &A) const { A.setAliasFor(Opt); }
1564 // extrahelp - provide additional help at the end of the normal help
1565 // output. All occurrences of cl::extrahelp will be accumulated and
1566 // printed to stderr at the end of the regular help, just before
1569 const char *morehelp;
1570 explicit extrahelp(const char *help);
1573 void PrintVersionMessage();
1575 /// This function just prints the help message, exactly the same way as if the
1576 /// -help or -help-hidden option had been given on the command line.
1578 /// NOTE: THIS FUNCTION TERMINATES THE PROGRAM!
1580 /// \param Hidden if true will print hidden options
1581 /// \param Categorized if true print options in categories
1582 void PrintHelpMessage(bool Hidden = false, bool Categorized = false);
1584 //===----------------------------------------------------------------------===//
1585 // Public interface for accessing registered options.
1588 /// \brief Use this to get a StringMap to all registered named options
1589 /// (e.g. -help). Note \p Map Should be an empty StringMap.
1591 /// \return A reference to the StringMap used by the cl APIs to parse options.
1593 /// Access to unnamed arguments (i.e. positional) are not provided because
1594 /// it is expected that the client already has access to these.
1598 /// main(int argc,char* argv[]) {
1599 /// StringMap<llvm::cl::Option*> &opts = llvm::cl::getRegisteredOptions();
1600 /// assert(opts.count("help") == 1)
1601 /// opts["help"]->setDescription("Show alphabetical help information")
1603 /// llvm::cl::ParseCommandLineOptions(argc,argv);
1608 /// This interface is useful for modifying options in libraries that are out of
1609 /// the control of the client. The options should be modified before calling
1610 /// llvm::cl::ParseCommandLineOptions().
1612 /// Hopefully this API can be depricated soon. Any situation where options need
1613 /// to be modified by tools or libraries should be handled by sane APIs rather
1614 /// than just handing around a global list.
1615 StringMap<Option *> &getRegisteredOptions();
1617 //===----------------------------------------------------------------------===//
1618 // Standalone command line processing utilities.
1621 /// \brief Saves strings in the inheritor's stable storage and returns a stable
1622 /// raw character pointer.
1624 virtual void anchor();
1627 virtual const char *SaveString(const char *Str) = 0;
1628 virtual ~StringSaver(){}; // Pacify -Wnon-virtual-dtor.
1631 /// \brief Tokenizes a command line that can contain escapes and quotes.
1633 /// The quoting rules match those used by GCC and other tools that use
1634 /// libiberty's buildargv() or expandargv() utilities, and do not match bash.
1635 /// They differ from buildargv() on treatment of backslashes that do not escape
1636 /// a special character to make it possible to accept most Windows file paths.
1638 /// \param [in] Source The string to be split on whitespace with quotes.
1639 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1640 /// \param [in] MarkEOLs true if tokenizing a response file and you want end of
1641 /// lines and end of the response file to be marked with a nullptr string.
1642 /// \param [out] NewArgv All parsed strings are appended to NewArgv.
1643 void TokenizeGNUCommandLine(StringRef Source, StringSaver &Saver,
1644 SmallVectorImpl<const char *> &NewArgv,
1645 bool MarkEOLs = false);
1647 /// \brief Tokenizes a Windows command line which may contain quotes and escaped
1650 /// See MSDN docs for CommandLineToArgvW for information on the quoting rules.
1651 /// http://msdn.microsoft.com/en-us/library/windows/desktop/17w5ykft(v=vs.85).aspx
1653 /// \param [in] Source The string to be split on whitespace with quotes.
1654 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1655 /// \param [in] MarkEOLs true if tokenizing a response file and you want end of
1656 /// lines and end of the response file to be marked with a nullptr string.
1657 /// \param [out] NewArgv All parsed strings are appended to NewArgv.
1658 void TokenizeWindowsCommandLine(StringRef Source, StringSaver &Saver,
1659 SmallVectorImpl<const char *> &NewArgv,
1660 bool MarkEOLs = false);
1662 /// \brief String tokenization function type. Should be compatible with either
1663 /// Windows or Unix command line tokenizers.
1664 typedef void (*TokenizerCallback)(StringRef Source, StringSaver &Saver,
1665 SmallVectorImpl<const char *> &NewArgv,
1668 /// \brief Expand response files on a command line recursively using the given
1669 /// StringSaver and tokenization strategy. Argv should contain the command line
1670 /// before expansion and will be modified in place. If requested, Argv will
1671 /// also be populated with nullptrs indicating where each response file line
1672 /// ends, which is useful for the "/link" argument that needs to consume all
1673 /// remaining arguments only until the next end of line, when in a response
1676 /// \param [in] Saver Delegates back to the caller for saving parsed strings.
1677 /// \param [in] Tokenizer Tokenization strategy. Typically Unix or Windows.
1678 /// \param [in,out] Argv Command line into which to expand response files.
1679 /// \param [in] MarkEOLs Mark end of lines and the end of the response file
1680 /// with nullptrs in the Argv vector.
1681 /// \return true if all @files were expanded successfully or there were none.
1682 bool ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
1683 SmallVectorImpl<const char *> &Argv,
1684 bool MarkEOLs = false);
1686 /// \brief Mark all options not part of this category as cl::ReallyHidden.
1688 /// \param Category the category of options to keep displaying
1690 /// Some tools (like clang-format) like to be able to hide all options that are
1691 /// not specific to the tool. This function allows a tool to specify a single
1692 /// option category to display in the -help output.
1693 void HideUnrelatedOptions(cl::OptionCategory &Category);
1695 /// \brief Mark all options not part of the categories as cl::ReallyHidden.
1697 /// \param Categories the categories of options to keep displaying.
1699 /// Some tools (like clang-format) like to be able to hide all options that are
1700 /// not specific to the tool. This function allows a tool to specify a single
1701 /// option category to display in the -help output.
1702 void HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories);
1704 } // End namespace cl
1706 } // End namespace llvm