X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FSupport%2FCommandLine.h;h=3ae50136e4a9d38ae2d0b87c3a4351d98463ffde;hb=0eac0164c259fb4a9d824361029f175e3eeede5c;hp=69a3d6c5921a6d13996f9ff0bac6cd0867feab38;hpb=f6143ef556ed01311d2043d38421302479f7866c;p=oota-llvm.git diff --git a/include/llvm/Support/CommandLine.h b/include/llvm/Support/CommandLine.h index 69a3d6c5921..3ae50136e4a 100644 --- a/include/llvm/Support/CommandLine.h +++ b/include/llvm/Support/CommandLine.h @@ -2,8 +2,8 @@ // // The LLVM Compiler Infrastructure // -// This file was developed by the LLVM research group and is distributed under -// the University of Illinois Open Source License. See LICENSE.TXT for details. +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // @@ -23,11 +23,13 @@ #include "llvm/Support/type_traits.h" #include "llvm/Support/DataTypes.h" #include "llvm/Support/Compiler.h" +#include "llvm/ADT/SmallVector.h" +#include +#include +#include #include -#include #include -#include -#include +#include namespace llvm { @@ -39,23 +41,29 @@ namespace cl { //===----------------------------------------------------------------------===// // ParseCommandLineOptions - Command line option processing entry point. // -void ParseCommandLineOptions(int &argc, char **argv, - const char *Overview = 0); +void ParseCommandLineOptions(int argc, char **argv, + const char *Overview = 0, + bool ReadResponseFiles = false); //===----------------------------------------------------------------------===// // ParseEnvironmentOptions - Environment variable option processing alternate // entry point. // void ParseEnvironmentOptions(const char *progName, const char *envvar, - const char *Overview = 0); + const char *Overview = 0, + bool ReadResponseFiles = false); ///===---------------------------------------------------------------------===// /// SetVersionPrinter - Override the default (LLVM specific) version printer /// used to print out the version when --version is given -/// on the command line. This gives other systems using the +/// on the command line. This allows other systems using the /// CommandLine utilities to print their own version string. void SetVersionPrinter(void (*func)()); + +// MarkOptionsChanged - Internal helper function. +void MarkOptionsChanged(); + //===----------------------------------------------------------------------===// // Flags permitted to be passed to command line arguments // @@ -118,7 +126,8 @@ enum FormattingFlags { enum MiscFlags { // Miscellaneous flags to adjust argument CommaSeparated = 0x200, // Should this cl::list split between commas? PositionalEatsArgs = 0x400, // Should this positional cl::list eat -args? - MiscMask = 0x600 // Union of the above flags. + Sink = 0x800, // Should this cl::list eat all unknown options? + MiscMask = 0xE00 // Union of the above flags. }; @@ -128,7 +137,6 @@ enum MiscFlags { // Miscellaneous flags to adjust argument // class alias; class Option { - friend void cl::ParseCommandLineOptions(int &, char **, const char *); friend class alias; // handleOccurrences - Overriden by subclasses to handle the value passed into @@ -141,16 +149,19 @@ class Option { virtual enum ValueExpected getValueExpectedFlagDefault() const { return ValueOptional; } + // Out of line virtual function to provide home for the class. virtual void anchor(); - - int NumOccurrences; // The number of times specified - int Flags; // Flags for the argument - unsigned Position; // Position of last occurrence of the option + + int NumOccurrences; // The number of times specified + int Flags; // Flags for the argument + unsigned Position; // Position of last occurrence of the option + unsigned AdditionalVals;// Greater than 0 for multi-valued option. + Option *NextRegistered; // Singly linked list of registered options. public: - const char *ArgStr; // The argument string itself (ex: "help", "o") - const char *HelpStr; // The descriptive text message for --help - const char *ValueStr; // String describing what the value of this option is + const char *ArgStr; // The argument string itself (ex: "help", "o") + const char *HelpStr; // The descriptive text message for --help + const char *ValueStr; // String describing what the value of this option is inline enum NumOccurrences getNumOccurrencesFlag() const { return static_cast(Flags & OccurrencesMask); @@ -170,6 +181,7 @@ public: return Flags & MiscMask; } inline unsigned getPosition() const { return Position; } + inline unsigned getNumAdditionalVals() const { return AdditionalVals; } // hasArgStr - Return true if the argstr != "" bool hasArgStr() const { return ArgStr[0] != 0; } @@ -195,31 +207,37 @@ public: void setMiscFlag(enum MiscFlags M) { setFlag(M, M); } void setPosition(unsigned pos) { Position = pos; } protected: - Option(unsigned DefaultFlags) + explicit Option(unsigned DefaultFlags) : NumOccurrences(0), Flags(DefaultFlags | NormalFormatting), Position(0), + AdditionalVals(0), NextRegistered(0), ArgStr(""), HelpStr(""), ValueStr("") { assert(getNumOccurrencesFlag() != 0 && getOptionHiddenFlag() != 0 && "Not all default flags specified!"); } + inline void setNumAdditionalVals(unsigned n) + { AdditionalVals = n; } public: - // addArgument - Tell the system that this Option subclass will handle all - // occurrences of -ArgStr on the command line. + // addArgument - Register this argument with the commandline system. // - void addArgument(const char *ArgStr); + void addArgument(); + + Option *getNextRegisteredOption() const { return NextRegistered; } // Return the width of the option tag for printing... - virtual unsigned getOptionWidth() const = 0; + virtual size_t getOptionWidth() const = 0; // printOptionInfo - Print out information about this option. The // to-be-maintained width is specified. // - virtual void printOptionInfo(unsigned GlobalWidth) const = 0; + virtual void printOptionInfo(size_t GlobalWidth) const = 0; + + virtual void getExtraOptionNames(std::vector &) {} // addOccurrence - Wrapper around handleOccurrence that enforces Flags // bool addOccurrence(unsigned pos, const char *ArgName, - const std::string &Value); + const std::string &Value, bool MultiArg = false); // Prints option name followed by message. Always returns true. bool error(std::string Message, const char *ArgName = 0); @@ -303,7 +321,7 @@ class ValuesClass { // Use a vector instead of a map, because the lists should be short, // the overhead is less, and most importantly, it keeps them in the order // inserted so we can print our option out nicely. - std::vector > > Values; + SmallVector >,4> Values; void processValues(va_list Vals); public: ValuesClass(const char *EnumName, DataType Val, const char *Desc, @@ -312,24 +330,25 @@ public: Values.push_back(std::make_pair(EnumName, std::make_pair(Val, Desc))); // Process the varargs portion of the values... - while (const char *EnumName = va_arg(ValueArgs, const char *)) { + while (const char *enumName = va_arg(ValueArgs, const char *)) { DataType EnumVal = static_cast(va_arg(ValueArgs, int)); const char *EnumDesc = va_arg(ValueArgs, const char *); - Values.push_back(std::make_pair(EnumName, // Add value to value map + Values.push_back(std::make_pair(enumName, // Add value to value map std::make_pair(EnumVal, EnumDesc))); } } template void apply(Opt &O) const { - for (unsigned i = 0, e = Values.size(); i != e; ++i) + for (unsigned i = 0, e = static_cast(Values.size()); + i != e; ++i) O.getParser().addLiteralOption(Values[i].first, Values[i].second.first, Values[i].second.second); } }; template -ValuesClass END_WITH_NULL values(const char *Arg, DataType Val, +ValuesClass END_WITH_NULL values(const char *Arg, DataType Val, const char *Desc, ...) { va_list ValueArgs; va_start(ValueArgs, Desc); @@ -366,28 +385,30 @@ struct generic_parser_base { virtual const char *getDescription(unsigned N) const = 0; // Return the width of the option tag for printing... - virtual unsigned getOptionWidth(const Option &O) const; + virtual size_t getOptionWidth(const Option &O) const; // printOptionInfo - Print out information about this option. The // to-be-maintained width is specified. // - virtual void printOptionInfo(const Option &O, unsigned GlobalWidth) const; + virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const; void initialize(Option &O) { // All of the modifiers for the option have been processed by now, so the // argstr field should be stable, copy it down now. // hasArgStr = O.hasArgStr(); + } + void getExtraOptionNames(std::vector &OptionNames) { // If there has been no argstr specified, that means that we need to add an // argument for every possible option. This ensures that our options are // vectored to us. - // if (!hasArgStr) for (unsigned i = 0, e = getNumOptions(); i != e; ++i) - O.addArgument(getOption(i)); + OptionNames.push_back(getOption(i)); } + enum ValueExpected getValueExpectedFlagDefault() const { // If there is an ArgStr specified, then we are of the form: // @@ -424,8 +445,8 @@ protected: template class parser : public generic_parser_base { protected: - std::vector > > Values; + SmallVector >, 8> Values; public: typedef DataType parser_data_type; @@ -445,7 +466,8 @@ public: else ArgVal = ArgName; - for (unsigned i = 0, e = Values.size(); i != e; ++i) + for (unsigned i = 0, e = static_cast(Values.size()); + i != e; ++i) if (ArgVal == Values[i].first) { V = Values[i].second.first; return false; @@ -454,16 +476,18 @@ public: return O.error(": Cannot find option named '" + ArgVal + "'!"); } - // addLiteralOption - Add an entry to the mapping table... + /// addLiteralOption - Add an entry to the mapping table. + /// template void addLiteralOption(const char *Name, const DT &V, const char *HelpStr) { assert(findOption(Name) == Values.size() && "Option already exists!"); Values.push_back(std::make_pair(Name, std::make_pair(static_cast(V),HelpStr))); + MarkOptionsChanged(); } - // removeLiteralOption - Remove the specified option. - // + /// removeLiteralOption - Remove the specified option. + /// void removeLiteralOption(const char *Name) { unsigned N = findOption(Name); assert(N != Values.size() && "Option not found!"); @@ -481,15 +505,17 @@ struct basic_parser_impl { // non-template implementation of basic_parser return ValueRequired; } - void initialize(Option &O) {} + void getExtraOptionNames(std::vector &) {} + + void initialize(Option &) {} // Return the width of the option tag for printing... - unsigned getOptionWidth(const Option &O) const; + size_t getOptionWidth(const Option &O) const; // printOptionInfo - Print out information about this option. The // to-be-maintained width is specified. // - void printOptionInfo(const Option &O, unsigned GlobalWidth) const; + void printOptionInfo(const Option &O, size_t GlobalWidth) const; // getValueName - Overload in subclass to provide a better default value. virtual const char *getValueName() const { return "value"; } @@ -511,23 +537,52 @@ struct basic_parser : public basic_parser_impl { // template<> class parser : public basic_parser { + const char *ArgStr; public: + // parse - Return true on error. bool parse(Option &O, const char *ArgName, const std::string &Arg, bool &Val); + template + void initialize(Opt &O) { + ArgStr = O.ArgStr; + } + enum ValueExpected getValueExpectedFlagDefault() const { return ValueOptional; } // getValueName - Do not print = at all. virtual const char *getValueName() const { return 0; } - + // An out-of-line virtual method to provide a 'home' for this class. virtual void anchor(); }; EXTERN_TEMPLATE_INSTANTIATION(class basic_parser); +//-------------------------------------------------- +// parser +enum boolOrDefault { BOU_UNSET, BOU_TRUE, BOU_FALSE }; +template<> +class parser : public basic_parser { +public: + // parse - Return true on error. + bool parse(Option &O, const char *ArgName, const std::string &Arg, + boolOrDefault &Val); + + enum ValueExpected getValueExpectedFlagDefault() const { + return ValueOptional; + } + + // getValueName - Do not print = at all. + virtual const char *getValueName() const { return 0; } + + // An out-of-line virtual method to provide a 'home' for this class. + virtual void anchor(); +}; + +EXTERN_TEMPLATE_INSTANTIATION(class basic_parser); //-------------------------------------------------- // parser @@ -609,7 +664,7 @@ template<> class parser : public basic_parser { public: // parse - Return true on error. - bool parse(Option &O, const char *AN, const std::string &Arg, + bool parse(Option &, const char *, const std::string &Arg, std::string &Value) { Value = Arg; return false; @@ -624,6 +679,28 @@ public: EXTERN_TEMPLATE_INSTANTIATION(class basic_parser); +//-------------------------------------------------- +// parser +// +template<> +class parser : public basic_parser { +public: + // parse - Return true on error. + bool parse(Option &, const char *, const std::string &Arg, + char &Value) { + Value = Arg[0]; + return false; + } + + // getValueName - Overload in subclass to provide a better default value. + virtual const char *getValueName() const { return "char"; } + + // An out-of-line virtual method to provide a 'home' for this class. + virtual void anchor(); +}; + +EXTERN_TEMPLATE_INSTANTIATION(class basic_parser); + //===----------------------------------------------------------------------===// // applicator class - This class is used because we must use partial // specialization to handle literal string arguments specially (const char* does @@ -683,7 +760,7 @@ template class opt_storage { DataType *Location; // Where to store the object... - void check() { + void check() const { assert(Location != 0 && "cl::location(...) not specified for a command " "line option with external storage, " "or cl::init specified before cl::location()!!"); @@ -762,23 +839,26 @@ class opt : public Option, typename ParserClass::parser_data_type(); if (Parser.parse(*this, ArgName, Arg, Val)) return true; // Parse error! - setValue(Val); - setPosition(pos); + this->setValue(Val); + this->setPosition(pos); return false; } virtual enum ValueExpected getValueExpectedFlagDefault() const { return Parser.getValueExpectedFlagDefault(); } + virtual void getExtraOptionNames(std::vector &OptionNames) { + return Parser.getExtraOptionNames(OptionNames); + } // Forward printing stuff to the parser... - virtual unsigned getOptionWidth() const {return Parser.getOptionWidth(*this);} - virtual void printOptionInfo(unsigned GlobalWidth) const { + virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);} + virtual void printOptionInfo(size_t GlobalWidth) const { Parser.printOptionInfo(*this, GlobalWidth); } void done() { - addArgument(ArgStr); + addArgument(); Parser.initialize(*this); } public: @@ -797,7 +877,7 @@ public: // One option... template - opt(const M0t &M0) : Option(Optional | NotHidden) { + explicit opt(const M0t &M0) : Option(Optional | NotHidden) { apply(M0, this); done(); } @@ -865,6 +945,7 @@ public: EXTERN_TEMPLATE_INSTANTIATION(class opt); EXTERN_TEMPLATE_INSTANTIATION(class opt); EXTERN_TEMPLATE_INSTANTIATION(class opt); +EXTERN_TEMPLATE_INSTANTIATION(class opt); EXTERN_TEMPLATE_INSTANTIATION(class opt); //===----------------------------------------------------------------------===// @@ -921,6 +1002,9 @@ class list : public Option, public list_storage { virtual enum ValueExpected getValueExpectedFlagDefault() const { return Parser.getValueExpectedFlagDefault(); } + virtual void getExtraOptionNames(std::vector &OptionNames) { + return Parser.getExtraOptionNames(OptionNames); + } virtual bool handleOccurrence(unsigned pos, const char *ArgName, const std::string &Arg) { @@ -935,13 +1019,13 @@ class list : public Option, public list_storage { } // Forward printing stuff to the parser... - virtual unsigned getOptionWidth() const {return Parser.getOptionWidth(*this);} - virtual void printOptionInfo(unsigned GlobalWidth) const { + virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);} + virtual void printOptionInfo(size_t GlobalWidth) const { Parser.printOptionInfo(*this, GlobalWidth); } void done() { - addArgument(ArgStr); + addArgument(); Parser.initialize(*this); } public: @@ -952,9 +1036,13 @@ public: return Positions[optnum]; } + void setNumAdditionalVals(unsigned n) { + Option::setNumAdditionalVals(n); + } + // One option... template - list(const M0t &M0) : Option(ZeroOrMore | NotHidden) { + explicit list(const M0t &M0) : Option(ZeroOrMore | NotHidden) { apply(M0, this); done(); } @@ -1017,6 +1105,16 @@ public: } }; +// multi_val - Modifier to set the number of additional values. +struct multi_val { + unsigned AdditionalVals; + explicit multi_val(unsigned N) : AdditionalVals(N) {} + + template + void apply(list &L) const { L.setNumAdditionalVals(AdditionalVals); } +}; + + //===----------------------------------------------------------------------===// // bits_storage class @@ -1027,11 +1125,11 @@ public: template class bits_storage { unsigned *Location; // Where to store the bits... - + template static unsigned Bit(const T &V) { unsigned BitPos = reinterpret_cast(V); - assert(BitPos < sizeof(unsigned) * 8 && + assert(BitPos < sizeof(unsigned) * CHAR_BIT && "enum exceeds width of bit vector!"); return 1 << BitPos; } @@ -1052,9 +1150,9 @@ public: "line option with external storage!"); *Location |= Bit(V); } - + unsigned getBits() { return *Location; } - + template bool isSet(const T &V) { return (*Location & Bit(V)) != 0; @@ -1062,29 +1160,29 @@ public: }; -// Define how to hold bits. Since we can inherit from a class, we do so. +// Define how to hold bits. Since we can inherit from a class, we do so. // This makes us exactly compatible with the bits in all cases that it is used. // template class bits_storage { unsigned Bits; // Where to store the bits... - + template static unsigned Bit(const T &V) { unsigned BitPos = reinterpret_cast(V); - assert(BitPos < sizeof(unsigned) * 8 && + assert(BitPos < sizeof(unsigned) * CHAR_BIT && "enum exceeds width of bit vector!"); return 1 << BitPos; } - + public: template void addValue(const T &V) { Bits |= Bit(V); } - + unsigned getBits() { return Bits; } - + template bool isSet(const T &V) { return (Bits & Bit(V)) != 0; @@ -1104,6 +1202,9 @@ class bits : public Option, public bits_storage { virtual enum ValueExpected getValueExpectedFlagDefault() const { return Parser.getValueExpectedFlagDefault(); } + virtual void getExtraOptionNames(std::vector &OptionNames) { + return Parser.getExtraOptionNames(OptionNames); + } virtual bool handleOccurrence(unsigned pos, const char *ArgName, const std::string &Arg) { @@ -1118,13 +1219,13 @@ class bits : public Option, public bits_storage { } // Forward printing stuff to the parser... - virtual unsigned getOptionWidth() const {return Parser.getOptionWidth(*this);} - virtual void printOptionInfo(unsigned GlobalWidth) const { + virtual size_t getOptionWidth() const {return Parser.getOptionWidth(*this);} + virtual void printOptionInfo(size_t GlobalWidth) const { Parser.printOptionInfo(*this, GlobalWidth); } void done() { - addArgument(ArgStr); + addArgument(); Parser.initialize(*this); } public: @@ -1137,7 +1238,7 @@ public: // One option... template - bits(const M0t &M0) : Option(ZeroOrMore | NotHidden) { + explicit bits(const M0t &M0) : Option(ZeroOrMore | NotHidden) { apply(M0, this); done(); } @@ -1206,20 +1307,20 @@ public: class alias : public Option { Option *AliasFor; - virtual bool handleOccurrence(unsigned pos, const char *ArgName, + virtual bool handleOccurrence(unsigned pos, const char * /*ArgName*/, const std::string &Arg) { return AliasFor->handleOccurrence(pos, AliasFor->ArgStr, Arg); } // Handle printing stuff... - virtual unsigned getOptionWidth() const; - virtual void printOptionInfo(unsigned GlobalWidth) const; + virtual size_t getOptionWidth() const; + virtual void printOptionInfo(size_t GlobalWidth) const; void done() { if (!hasArgStr()) error(": cl::alias must have argument name specified!"); if (AliasFor == 0) error(": cl::alias must have an cl::aliasopt(option) specified!"); - addArgument(ArgStr); + addArgument(); } public: void setAliasFor(Option &O) { @@ -1230,7 +1331,7 @@ public: // One option... template - alias(const M0t &M0) : Option(Optional | Hidden), AliasFor(0) { + explicit alias(const M0t &M0) : Option(Optional | Hidden), AliasFor(0) { apply(M0, this); done(); } @@ -1259,7 +1360,7 @@ public: // aliasfor - Modifier to set the option an alias aliases. struct aliasopt { Option &Opt; - aliasopt(Option &O) : Opt(O) {} + explicit aliasopt(Option &O) : Opt(O) {} void apply(alias &A) const { A.setAliasFor(Opt); } }; @@ -1269,7 +1370,7 @@ struct aliasopt { // exit is called. struct extrahelp { const char * morehelp; - extrahelp(const char* help); + explicit extrahelp(const char* help); }; void PrintVersionMessage();