Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1 | //===-- CommandLine.cpp - Command line parser implementation --------------===// |
| 2 | // |
| 3 | // This class implements a command line argument processor that is useful when |
| 4 | // creating a tool. It provides a simple, minimalistic interface that is easily |
| 5 | // extensible and supports nonlocal (library) command line options. |
| 6 | // |
Chris Lattner | 03fe1bd | 2001-07-23 23:04:07 +0000 | [diff] [blame] | 7 | // Note that rather than trying to figure out what this code does, you could try |
| 8 | // reading the library documentation located in docs/CommandLine.html |
| 9 | // |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 10 | //===----------------------------------------------------------------------===// |
| 11 | |
Chris Lattner | cee8f9a | 2001-11-27 00:03:19 +0000 | [diff] [blame] | 12 | #include "Support/CommandLine.h" |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 13 | #include <algorithm> |
| 14 | #include <map> |
| 15 | #include <set> |
Chris Lattner | 697954c | 2002-01-20 22:54:45 +0000 | [diff] [blame] | 16 | #include <iostream> |
Chris Lattner | 7f1576f | 2002-02-24 23:02:12 +0000 | [diff] [blame] | 17 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 18 | using namespace cl; |
| 19 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 20 | //===----------------------------------------------------------------------===// |
| 21 | // Basic, shared command line option processing machinery... |
| 22 | // |
| 23 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 24 | // Return the global command line option vector. Making it a function scoped |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 25 | // static ensures that it will be initialized correctly before its first use. |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 26 | // |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 27 | static std::map<std::string, Option*> *CommandLineOptions = 0; |
| 28 | static std::map<std::string, Option*> &getOpts() { |
| 29 | if (CommandLineOptions == 0) |
| 30 | CommandLineOptions = new std::map<std::string,Option*>(); |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 31 | return *CommandLineOptions; |
| 32 | } |
| 33 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 34 | static Option *getOption(const std::string &Str) { |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 35 | if (CommandLineOptions == 0) return 0; |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 36 | std::map<std::string,Option*>::iterator I = CommandLineOptions->find(Str); |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 37 | return I != CommandLineOptions->end() ? I->second : 0; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 38 | } |
| 39 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 40 | static std::vector<Option*> &getPositionalOpts() { |
| 41 | static std::vector<Option*> Positional; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 42 | return Positional; |
| 43 | } |
| 44 | |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 45 | static void AddArgument(const char *ArgName, Option *Opt) { |
| 46 | if (getOption(ArgName)) { |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 47 | std::cerr << "CommandLine Error: Argument '" << ArgName |
| 48 | << "' defined more than once!\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 49 | } else { |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 50 | // Add argument to the argument map! |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 51 | getOpts()[ArgName] = Opt; |
| 52 | } |
| 53 | } |
| 54 | |
| 55 | // RemoveArgument - It's possible that the argument is no longer in the map if |
| 56 | // options have already been processed and the map has been deleted! |
| 57 | // |
| 58 | static void RemoveArgument(const char *ArgName, Option *Opt) { |
| 59 | if (CommandLineOptions == 0) return; |
| 60 | assert(getOption(ArgName) == Opt && "Arg not in map!"); |
| 61 | CommandLineOptions->erase(ArgName); |
| 62 | if (CommandLineOptions->empty()) { |
| 63 | delete CommandLineOptions; |
| 64 | CommandLineOptions = 0; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 65 | } |
| 66 | } |
| 67 | |
| 68 | static const char *ProgramName = 0; |
| 69 | static const char *ProgramOverview = 0; |
| 70 | |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 71 | static inline bool ProvideOption(Option *Handler, const char *ArgName, |
| 72 | const char *Value, int argc, char **argv, |
| 73 | int &i) { |
| 74 | // Enforce value requirements |
| 75 | switch (Handler->getValueExpectedFlag()) { |
| 76 | case ValueRequired: |
| 77 | if (Value == 0 || *Value == 0) { // No value specified? |
| 78 | if (i+1 < argc) { // Steal the next argument, like for '-o filename' |
| 79 | Value = argv[++i]; |
| 80 | } else { |
| 81 | return Handler->error(" requires a value!"); |
| 82 | } |
| 83 | } |
| 84 | break; |
| 85 | case ValueDisallowed: |
| 86 | if (*Value != 0) |
| 87 | return Handler->error(" does not allow a value! '" + |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 88 | std::string(Value) + "' specified."); |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 89 | break; |
| 90 | case ValueOptional: break; |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 91 | default: std::cerr << "Bad ValueMask flag! CommandLine usage error:" |
| 92 | << Handler->getValueExpectedFlag() << "\n"; abort(); |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | // Run the handler now! |
| 96 | return Handler->addOccurance(ArgName, Value); |
| 97 | } |
| 98 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 99 | static bool ProvidePositionalOption(Option *Handler, std::string &Arg) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 100 | int Dummy; |
| 101 | return ProvideOption(Handler, "", Arg.c_str(), 0, 0, Dummy); |
| 102 | } |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 103 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 104 | |
| 105 | // Option predicates... |
| 106 | static inline bool isGrouping(const Option *O) { |
| 107 | return O->getFormattingFlag() == cl::Grouping; |
| 108 | } |
| 109 | static inline bool isPrefixedOrGrouping(const Option *O) { |
| 110 | return isGrouping(O) || O->getFormattingFlag() == cl::Prefix; |
| 111 | } |
| 112 | |
| 113 | // getOptionPred - Check to see if there are any options that satisfy the |
| 114 | // specified predicate with names that are the prefixes in Name. This is |
| 115 | // checked by progressively stripping characters off of the name, checking to |
| 116 | // see if there options that satisfy the predicate. If we find one, return it, |
| 117 | // otherwise return null. |
| 118 | // |
| 119 | static Option *getOptionPred(std::string Name, unsigned &Length, |
| 120 | bool (*Pred)(const Option*)) { |
| 121 | |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 122 | Option *Op = getOption(Name); |
| 123 | if (Op && Pred(Op)) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 124 | Length = Name.length(); |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 125 | return Op; |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 126 | } |
| 127 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 128 | if (Name.size() == 1) return 0; |
| 129 | do { |
| 130 | Name.erase(Name.end()-1, Name.end()); // Chop off the last character... |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 131 | Op = getOption(Name); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 132 | |
| 133 | // Loop while we haven't found an option and Name still has at least two |
| 134 | // characters in it (so that the next iteration will not be the empty |
| 135 | // string... |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 136 | } while ((Op == 0 || !Pred(Op)) && Name.size() > 1); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 137 | |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 138 | if (Op && Pred(Op)) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 139 | Length = Name.length(); |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 140 | return Op; // Found one! |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 141 | } |
| 142 | return 0; // No option found! |
| 143 | } |
| 144 | |
| 145 | static bool RequiresValue(const Option *O) { |
| 146 | return O->getNumOccurancesFlag() == cl::Required || |
| 147 | O->getNumOccurancesFlag() == cl::OneOrMore; |
| 148 | } |
| 149 | |
| 150 | static bool EatsUnboundedNumberOfValues(const Option *O) { |
| 151 | return O->getNumOccurancesFlag() == cl::ZeroOrMore || |
| 152 | O->getNumOccurancesFlag() == cl::OneOrMore; |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 153 | } |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 154 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 155 | void cl::ParseCommandLineOptions(int &argc, char **argv, |
Chris Lattner | 0c0edf8 | 2002-07-25 06:17:51 +0000 | [diff] [blame] | 156 | const char *Overview) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 157 | assert((!getOpts().empty() || !getPositionalOpts().empty()) && |
| 158 | "No options specified, or ParseCommandLineOptions called more" |
| 159 | " than once!"); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 160 | ProgramName = argv[0]; // Save this away safe and snug |
| 161 | ProgramOverview = Overview; |
| 162 | bool ErrorParsing = false; |
| 163 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 164 | std::map<std::string, Option*> &Opts = getOpts(); |
| 165 | std::vector<Option*> &PositionalOpts = getPositionalOpts(); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 166 | |
| 167 | // Check out the positional arguments to collect information about them. |
| 168 | unsigned NumPositionalRequired = 0; |
| 169 | Option *ConsumeAfterOpt = 0; |
| 170 | if (!PositionalOpts.empty()) { |
| 171 | if (PositionalOpts[0]->getNumOccurancesFlag() == cl::ConsumeAfter) { |
| 172 | assert(PositionalOpts.size() > 1 && |
| 173 | "Cannot specify cl::ConsumeAfter without a positional argument!"); |
| 174 | ConsumeAfterOpt = PositionalOpts[0]; |
| 175 | } |
| 176 | |
| 177 | // Calculate how many positional values are _required_. |
| 178 | bool UnboundedFound = false; |
| 179 | for (unsigned i = ConsumeAfterOpt != 0, e = PositionalOpts.size(); |
| 180 | i != e; ++i) { |
| 181 | Option *Opt = PositionalOpts[i]; |
| 182 | if (RequiresValue(Opt)) |
| 183 | ++NumPositionalRequired; |
| 184 | else if (ConsumeAfterOpt) { |
| 185 | // ConsumeAfter cannot be combined with "optional" positional options |
Chris Lattner | 54ec7ae | 2002-07-22 02:21:57 +0000 | [diff] [blame] | 186 | // unless there is only one positional argument... |
| 187 | if (PositionalOpts.size() > 2) |
| 188 | ErrorParsing |= |
| 189 | Opt->error(" error - this positional option will never be matched, " |
| 190 | "because it does not Require a value, and a " |
| 191 | "cl::ConsumeAfter option is active!"); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 192 | } else if (UnboundedFound) { // This option does not "require" a value... |
| 193 | // Make sure this option is not specified after an option that eats all |
| 194 | // extra arguments, or this one will never get any! |
| 195 | // |
| 196 | ErrorParsing |= Opt->error(" error - option can never match, because " |
| 197 | "another positional argument will match an " |
| 198 | "unbounded number of values, and this option" |
| 199 | " does not require a value!"); |
| 200 | } |
| 201 | UnboundedFound |= EatsUnboundedNumberOfValues(Opt); |
| 202 | } |
| 203 | } |
| 204 | |
| 205 | // PositionalVals - A vector of "positional" arguments we accumulate into to |
| 206 | // processes at the end... |
| 207 | // |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 208 | std::vector<std::string> PositionalVals; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 209 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 210 | // Loop over all of the arguments... processing them. |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 211 | bool DashDashFound = false; // Have we read '--'? |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 212 | for (int i = 1; i < argc; ++i) { |
| 213 | Option *Handler = 0; |
| 214 | const char *Value = ""; |
| 215 | const char *ArgName = ""; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 216 | |
| 217 | // Check to see if this is a positional argument. This argument is |
| 218 | // considered to be positional if it doesn't start with '-', if it is "-" |
| 219 | // itself, or if we have see "--" already. |
| 220 | // |
| 221 | if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) { |
| 222 | // Positional argument! |
| 223 | if (!PositionalOpts.empty()) { |
| 224 | PositionalVals.push_back(argv[i]); |
| 225 | |
| 226 | // All of the positional arguments have been fulfulled, give the rest to |
| 227 | // the consume after option... if it's specified... |
| 228 | // |
Chris Lattner | d16714b | 2002-07-31 16:29:43 +0000 | [diff] [blame] | 229 | if (PositionalVals.size() >= NumPositionalRequired && |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 230 | ConsumeAfterOpt != 0) { |
| 231 | for (++i; i < argc; ++i) |
| 232 | PositionalVals.push_back(argv[i]); |
| 233 | break; // Handle outside of the argument processing loop... |
| 234 | } |
| 235 | |
| 236 | // Delay processing positional arguments until the end... |
| 237 | continue; |
| 238 | } |
| 239 | } else { // We start with a '-', must be an argument... |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 240 | ArgName = argv[i]+1; |
| 241 | while (*ArgName == '-') ++ArgName; // Eat leading dashes |
| 242 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 243 | if (*ArgName == 0 && !DashDashFound) { // Is this the mythical "--"? |
| 244 | DashDashFound = true; // Yup, take note of that fact... |
| 245 | continue; // Don't try to process it as an argument iself. |
| 246 | } |
| 247 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 248 | const char *ArgNameEnd = ArgName; |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 249 | while (*ArgNameEnd && *ArgNameEnd != '=') |
| 250 | ++ArgNameEnd; // Scan till end of argument name... |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 251 | |
| 252 | Value = ArgNameEnd; |
| 253 | if (*Value) // If we have an equals sign... |
| 254 | ++Value; // Advance to value... |
| 255 | |
| 256 | if (*ArgName != 0) { |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 257 | std::string RealName(ArgName, ArgNameEnd); |
Chris Lattner | 3805e4c | 2001-07-25 18:40:49 +0000 | [diff] [blame] | 258 | // Extract arg name part |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 259 | std::map<std::string, Option*>::iterator I = Opts.find(RealName); |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 260 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 261 | if (I == Opts.end() && !*Value && RealName.size() > 1) { |
| 262 | // Check to see if this "option" is really a prefixed or grouped |
| 263 | // argument... |
| 264 | // |
| 265 | unsigned Length = 0; |
| 266 | Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping); |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 267 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 268 | // If the option is a prefixed option, then the value is simply the |
| 269 | // rest of the name... so fall through to later processing, by |
| 270 | // setting up the argument name flags and value fields. |
| 271 | // |
| 272 | if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) { |
| 273 | ArgNameEnd = ArgName+Length; |
| 274 | Value = ArgNameEnd; |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 275 | I = Opts.find(std::string(ArgName, ArgNameEnd)); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 276 | assert(I->second == PGOpt); |
| 277 | } else if (PGOpt) { |
| 278 | // This must be a grouped option... handle all of them now... |
| 279 | assert(isGrouping(PGOpt) && "Broken getOptionPred!"); |
| 280 | |
| 281 | do { |
| 282 | // Move current arg name out of RealName into RealArgName... |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 283 | std::string RealArgName(RealName.begin(),RealName.begin()+Length); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 284 | RealName.erase(RealName.begin(), RealName.begin()+Length); |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 285 | |
| 286 | // Because ValueRequired is an invalid flag for grouped arguments, |
| 287 | // we don't need to pass argc/argv in... |
| 288 | // |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 289 | assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired && |
| 290 | "Option can not be cl::Grouping AND cl::ValueRequired!"); |
| 291 | int Dummy; |
| 292 | ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(), "", |
| 293 | 0, 0, Dummy); |
| 294 | |
| 295 | // Get the next grouping option... |
| 296 | if (!RealName.empty()) |
| 297 | PGOpt = getOptionPred(RealName, Length, isGrouping); |
| 298 | } while (!RealName.empty() && PGOpt); |
| 299 | |
| 300 | if (RealName.empty()) // Processed all of the options, move on |
| 301 | continue; // to the next argv[] value... |
| 302 | |
| 303 | // If RealName is not empty, that means we did not match one of the |
| 304 | // options! This is an error. |
| 305 | // |
| 306 | I = Opts.end(); |
| 307 | } |
Chris Lattner | f78032f | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 308 | } |
| 309 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 310 | Handler = I != Opts.end() ? I->second : 0; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 311 | } |
| 312 | } |
| 313 | |
| 314 | if (Handler == 0) { |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 315 | std::cerr << "Unknown command line argument '" << argv[i] << "'. Try: " |
| 316 | << argv[0] << " --help'\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 317 | ErrorParsing = true; |
| 318 | continue; |
| 319 | } |
| 320 | |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 321 | ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 322 | } |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 323 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 324 | // Check and handle positional arguments now... |
| 325 | if (NumPositionalRequired > PositionalVals.size()) { |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 326 | std::cerr << "Not enough positional command line arguments specified!\n" |
| 327 | << "Must specify at least " << NumPositionalRequired |
| 328 | << " positional arguments: See: " << argv[0] << " --help\n"; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 329 | ErrorParsing = true; |
| 330 | |
| 331 | |
| 332 | } else if (ConsumeAfterOpt == 0) { |
| 333 | // Positional args have already been handled if ConsumeAfter is specified... |
| 334 | unsigned ValNo = 0, NumVals = PositionalVals.size(); |
| 335 | for (unsigned i = 0, e = PositionalOpts.size(); i != e; ++i) { |
| 336 | if (RequiresValue(PositionalOpts[i])) { |
| 337 | ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo++]); |
| 338 | --NumPositionalRequired; // We fulfilled our duty... |
| 339 | } |
| 340 | |
| 341 | // If we _can_ give this option more arguments, do so now, as long as we |
| 342 | // do not give it values that others need. 'Done' controls whether the |
| 343 | // option even _WANTS_ any more. |
| 344 | // |
| 345 | bool Done = PositionalOpts[i]->getNumOccurancesFlag() == cl::Required; |
| 346 | while (NumVals-ValNo > NumPositionalRequired && !Done) { |
| 347 | switch (PositionalOpts[i]->getNumOccurancesFlag()) { |
| 348 | case cl::Optional: |
| 349 | Done = true; // Optional arguments want _at most_ one value |
| 350 | // FALL THROUGH |
| 351 | case cl::ZeroOrMore: // Zero or more will take all they can get... |
| 352 | case cl::OneOrMore: // One or more will take all they can get... |
| 353 | ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo++]); |
| 354 | break; |
| 355 | default: |
| 356 | assert(0 && "Internal error, unexpected NumOccurances flag in " |
| 357 | "positional argument processing!"); |
| 358 | } |
| 359 | } |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 360 | } |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 361 | } else { |
| 362 | assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size()); |
| 363 | unsigned ValNo = 0; |
| 364 | for (unsigned j = 1, e = PositionalOpts.size(); j != e; ++j) |
| 365 | if (RequiresValue(PositionalOpts[j])) |
Chris Lattner | faba809 | 2002-07-24 20:15:13 +0000 | [diff] [blame] | 366 | ErrorParsing |= ProvidePositionalOption(PositionalOpts[j], |
| 367 | PositionalVals[ValNo++]); |
| 368 | |
| 369 | // Handle the case where there is just one positional option, and it's |
| 370 | // optional. In this case, we want to give JUST THE FIRST option to the |
| 371 | // positional option and keep the rest for the consume after. The above |
| 372 | // loop would have assigned no values to positional options in this case. |
| 373 | // |
Chris Lattner | b490c20 | 2002-08-02 21:51:29 +0000 | [diff] [blame] | 374 | if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) |
Chris Lattner | faba809 | 2002-07-24 20:15:13 +0000 | [diff] [blame] | 375 | ErrorParsing |= ProvidePositionalOption(PositionalOpts[1], |
| 376 | PositionalVals[ValNo++]); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 377 | |
| 378 | // Handle over all of the rest of the arguments to the |
| 379 | // cl::ConsumeAfter command line option... |
| 380 | for (; ValNo != PositionalVals.size(); ++ValNo) |
| 381 | ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt, |
| 382 | PositionalVals[ValNo]); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 383 | } |
| 384 | |
Chris Lattner | dc4693d | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 385 | // Loop over args and make sure all required args are specified! |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 386 | for (std::map<std::string, Option*>::iterator I = Opts.begin(), |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 387 | E = Opts.end(); I != E; ++I) { |
Chris Lattner | dc4693d | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 388 | switch (I->second->getNumOccurancesFlag()) { |
| 389 | case Required: |
| 390 | case OneOrMore: |
Chris Lattner | f038acb | 2001-10-24 06:21:56 +0000 | [diff] [blame] | 391 | if (I->second->getNumOccurances() == 0) { |
Chris Lattner | dc4693d | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 392 | I->second->error(" must be specified at least once!"); |
Chris Lattner | f038acb | 2001-10-24 06:21:56 +0000 | [diff] [blame] | 393 | ErrorParsing = true; |
| 394 | } |
Chris Lattner | dc4693d | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 395 | // Fall through |
| 396 | default: |
| 397 | break; |
| 398 | } |
| 399 | } |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 400 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 401 | // Free all of the memory allocated to the map. Command line options may only |
| 402 | // be processed once! |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 403 | delete CommandLineOptions; |
| 404 | CommandLineOptions = 0; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 405 | PositionalOpts.clear(); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 406 | |
| 407 | // If we had an error processing our arguments, don't let the program execute |
| 408 | if (ErrorParsing) exit(1); |
| 409 | } |
| 410 | |
| 411 | //===----------------------------------------------------------------------===// |
| 412 | // Option Base class implementation |
| 413 | // |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 414 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 415 | bool Option::error(std::string Message, const char *ArgName) { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 416 | if (ArgName == 0) ArgName = ArgStr; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 417 | if (ArgName[0] == 0) |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 418 | std::cerr << HelpStr; // Be nice for positional arguments |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 419 | else |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 420 | std::cerr << "-" << ArgName; |
| 421 | std::cerr << " option" << Message << "\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 422 | return true; |
| 423 | } |
| 424 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 425 | bool Option::addOccurance(const char *ArgName, const std::string &Value) { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 426 | NumOccurances++; // Increment the number of times we have been seen |
| 427 | |
Chris Lattner | dc4693d | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 428 | switch (getNumOccurancesFlag()) { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 429 | case Optional: |
| 430 | if (NumOccurances > 1) |
| 431 | return error(": may only occur zero or one times!", ArgName); |
| 432 | break; |
| 433 | case Required: |
| 434 | if (NumOccurances > 1) |
| 435 | return error(": must occur exactly one time!", ArgName); |
| 436 | // Fall through |
| 437 | case OneOrMore: |
Chris Lattner | caccd76 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 438 | case ZeroOrMore: |
| 439 | case ConsumeAfter: break; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 440 | default: return error(": bad num occurances flag value!"); |
| 441 | } |
| 442 | |
| 443 | return handleOccurance(ArgName, Value); |
| 444 | } |
| 445 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 446 | // addArgument - Tell the system that this Option subclass will handle all |
| 447 | // occurances of -ArgStr on the command line. |
| 448 | // |
| 449 | void Option::addArgument(const char *ArgStr) { |
| 450 | if (ArgStr[0]) |
| 451 | AddArgument(ArgStr, this); |
| 452 | else if (getFormattingFlag() == Positional) |
| 453 | getPositionalOpts().push_back(this); |
| 454 | else if (getNumOccurancesFlag() == ConsumeAfter) { |
| 455 | assert((getPositionalOpts().empty() || |
| 456 | getPositionalOpts().front()->getNumOccurancesFlag() != ConsumeAfter) |
| 457 | && "Cannot specify more than one option with cl::ConsumeAfter " |
| 458 | "specified!"); |
| 459 | getPositionalOpts().insert(getPositionalOpts().begin(), this); |
| 460 | } |
| 461 | } |
| 462 | |
Chris Lattner | aa852bb | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 463 | void Option::removeArgument(const char *ArgStr) { |
| 464 | if (ArgStr[0]) { |
Chris Lattner | e8e258b | 2002-07-29 20:58:42 +0000 | [diff] [blame] | 465 | RemoveArgument(ArgStr, this); |
Chris Lattner | aa852bb | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 466 | } else if (getFormattingFlag() == Positional) { |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 467 | std::vector<Option*>::iterator I = |
Chris Lattner | aa852bb | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 468 | std::find(getPositionalOpts().begin(), getPositionalOpts().end(), this); |
| 469 | assert(I != getPositionalOpts().end() && "Arg not registered!"); |
| 470 | getPositionalOpts().erase(I); |
| 471 | } else if (getNumOccurancesFlag() == ConsumeAfter) { |
| 472 | assert(!getPositionalOpts().empty() && getPositionalOpts()[0] == this && |
| 473 | "Arg not registered correctly!"); |
| 474 | getPositionalOpts().erase(getPositionalOpts().begin()); |
| 475 | } |
| 476 | } |
| 477 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 478 | |
| 479 | // getValueStr - Get the value description string, using "DefaultMsg" if nothing |
| 480 | // has been specified yet. |
| 481 | // |
| 482 | static const char *getValueStr(const Option &O, const char *DefaultMsg) { |
| 483 | if (O.ValueStr[0] == 0) return DefaultMsg; |
| 484 | return O.ValueStr; |
| 485 | } |
| 486 | |
| 487 | //===----------------------------------------------------------------------===// |
| 488 | // cl::alias class implementation |
| 489 | // |
| 490 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 491 | // Return the width of the option tag for printing... |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 492 | unsigned alias::getOptionWidth() const { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 493 | return std::strlen(ArgStr)+6; |
| 494 | } |
| 495 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 496 | // Print out the option for the alias... |
| 497 | void alias::printOptionInfo(unsigned GlobalWidth) const { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 498 | unsigned L = std::strlen(ArgStr); |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 499 | std::cerr << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - " |
| 500 | << HelpStr << "\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 501 | } |
| 502 | |
| 503 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 504 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 505 | //===----------------------------------------------------------------------===// |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 506 | // Parser Implementation code... |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 507 | // |
| 508 | |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 509 | // basic_parser implementation |
| 510 | // |
| 511 | |
| 512 | // Return the width of the option tag for printing... |
| 513 | unsigned basic_parser_impl::getOptionWidth(const Option &O) const { |
| 514 | unsigned Len = std::strlen(O.ArgStr); |
| 515 | if (const char *ValName = getValueName()) |
| 516 | Len += std::strlen(getValueStr(O, ValName))+3; |
| 517 | |
| 518 | return Len + 6; |
| 519 | } |
| 520 | |
| 521 | // printOptionInfo - Print out information about this option. The |
| 522 | // to-be-maintained width is specified. |
| 523 | // |
| 524 | void basic_parser_impl::printOptionInfo(const Option &O, |
| 525 | unsigned GlobalWidth) const { |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 526 | std::cerr << " -" << O.ArgStr; |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 527 | |
| 528 | if (const char *ValName = getValueName()) |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 529 | std::cerr << "=<" << getValueStr(O, ValName) << ">"; |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 530 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 531 | std::cerr << std::string(GlobalWidth-getOptionWidth(O), ' ') << " - " |
| 532 | << O.HelpStr << "\n"; |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 533 | } |
| 534 | |
| 535 | |
| 536 | |
| 537 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 538 | // parser<bool> implementation |
| 539 | // |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 540 | bool parser<bool>::parse(Option &O, const char *ArgName, |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 541 | const std::string &Arg, bool &Value) { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 542 | if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" || |
| 543 | Arg == "1") { |
| 544 | Value = true; |
| 545 | } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") { |
| 546 | Value = false; |
| 547 | } else { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 548 | return O.error(": '" + Arg + |
| 549 | "' is invalid value for boolean argument! Try 0 or 1"); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 550 | } |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 551 | return false; |
| 552 | } |
| 553 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 554 | // parser<int> implementation |
| 555 | // |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 556 | bool parser<int>::parse(Option &O, const char *ArgName, |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 557 | const std::string &Arg, int &Value) { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 558 | const char *ArgStart = Arg.c_str(); |
| 559 | char *End; |
| 560 | Value = (int)strtol(ArgStart, &End, 0); |
| 561 | if (*End != 0) |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 562 | return O.error(": '" + Arg + "' value invalid for integer argument!"); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 563 | return false; |
| 564 | } |
| 565 | |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 566 | // parser<double>/parser<float> implementation |
Chris Lattner | d215fd1 | 2001-10-13 06:53:19 +0000 | [diff] [blame] | 567 | // |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 568 | static bool parseDouble(Option &O, const std::string &Arg, double &Value) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 569 | const char *ArgStart = Arg.c_str(); |
| 570 | char *End; |
| 571 | Value = strtod(ArgStart, &End); |
| 572 | if (*End != 0) |
| 573 | return O.error(": '" +Arg+ "' value invalid for floating point argument!"); |
Chris Lattner | d215fd1 | 2001-10-13 06:53:19 +0000 | [diff] [blame] | 574 | return false; |
| 575 | } |
| 576 | |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 577 | bool parser<double>::parse(Option &O, const char *AN, |
| 578 | const std::string &Arg, double &Val) { |
| 579 | return parseDouble(O, Arg, Val); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 580 | } |
| 581 | |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 582 | bool parser<float>::parse(Option &O, const char *AN, |
| 583 | const std::string &Arg, float &Val) { |
| 584 | double dVal; |
| 585 | if (parseDouble(O, Arg, dVal)) |
| 586 | return true; |
| 587 | Val = (float)dVal; |
| 588 | return false; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 589 | } |
| 590 | |
| 591 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 592 | |
| 593 | // generic_parser_base implementation |
| 594 | // |
| 595 | |
Chris Lattner | aa852bb | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 596 | // findOption - Return the option number corresponding to the specified |
| 597 | // argument string. If the option is not found, getNumOptions() is returned. |
| 598 | // |
| 599 | unsigned generic_parser_base::findOption(const char *Name) { |
| 600 | unsigned i = 0, e = getNumOptions(); |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 601 | std::string N(Name); |
Chris Lattner | aa852bb | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 602 | |
| 603 | while (i != e) |
| 604 | if (getOption(i) == N) |
| 605 | return i; |
| 606 | else |
| 607 | ++i; |
| 608 | return e; |
| 609 | } |
| 610 | |
| 611 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 612 | // Return the width of the option tag for printing... |
| 613 | unsigned generic_parser_base::getOptionWidth(const Option &O) const { |
| 614 | if (O.hasArgStr()) { |
| 615 | unsigned Size = std::strlen(O.ArgStr)+6; |
| 616 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) |
| 617 | Size = std::max(Size, (unsigned)std::strlen(getOption(i))+8); |
| 618 | return Size; |
| 619 | } else { |
| 620 | unsigned BaseSize = 0; |
| 621 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) |
| 622 | BaseSize = std::max(BaseSize, (unsigned)std::strlen(getOption(i))+8); |
| 623 | return BaseSize; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 624 | } |
| 625 | } |
| 626 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 627 | // printOptionInfo - Print out information about this option. The |
| 628 | // to-be-maintained width is specified. |
| 629 | // |
| 630 | void generic_parser_base::printOptionInfo(const Option &O, |
| 631 | unsigned GlobalWidth) const { |
| 632 | if (O.hasArgStr()) { |
| 633 | unsigned L = std::strlen(O.ArgStr); |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 634 | std::cerr << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ') |
| 635 | << " - " << O.HelpStr << "\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 636 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 637 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) { |
| 638 | unsigned NumSpaces = GlobalWidth-strlen(getOption(i))-8; |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 639 | std::cerr << " =" << getOption(i) << std::string(NumSpaces, ' ') |
| 640 | << " - " << getDescription(i) << "\n"; |
Chris Lattner | 9c9be48 | 2002-01-31 00:42:56 +0000 | [diff] [blame] | 641 | } |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 642 | } else { |
| 643 | if (O.HelpStr[0]) |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 644 | std::cerr << " " << O.HelpStr << "\n"; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 645 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) { |
| 646 | unsigned L = std::strlen(getOption(i)); |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 647 | std::cerr << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ') |
| 648 | << " - " << getDescription(i) << "\n"; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 649 | } |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 650 | } |
| 651 | } |
| 652 | |
| 653 | |
| 654 | //===----------------------------------------------------------------------===// |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 655 | // --help and --help-hidden option implementation |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 656 | // |
| 657 | namespace { |
| 658 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 659 | class HelpPrinter { |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 660 | unsigned MaxArgLen; |
| 661 | const Option *EmptyArg; |
| 662 | const bool ShowHidden; |
| 663 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 664 | // isHidden/isReallyHidden - Predicates to be used to filter down arg lists. |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 665 | inline static bool isHidden(std::pair<std::string, Option *> &OptPair) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 666 | return OptPair.second->getOptionHiddenFlag() >= Hidden; |
| 667 | } |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 668 | inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) { |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 669 | return OptPair.second->getOptionHiddenFlag() == ReallyHidden; |
| 670 | } |
| 671 | |
| 672 | public: |
| 673 | HelpPrinter(bool showHidden) : ShowHidden(showHidden) { |
| 674 | EmptyArg = 0; |
| 675 | } |
| 676 | |
| 677 | void operator=(bool Value) { |
| 678 | if (Value == false) return; |
| 679 | |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 680 | // Copy Options into a vector so we can sort them as we like... |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 681 | std::vector<std::pair<std::string, Option*> > Options; |
Chris Lattner | 697954c | 2002-01-20 22:54:45 +0000 | [diff] [blame] | 682 | copy(getOpts().begin(), getOpts().end(), std::back_inserter(Options)); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 683 | |
| 684 | // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 685 | Options.erase(std::remove_if(Options.begin(), Options.end(), |
| 686 | std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)), |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 687 | Options.end()); |
| 688 | |
| 689 | // Eliminate duplicate entries in table (from enum flags options, f.e.) |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 690 | { // Give OptionSet a scope |
| 691 | std::set<Option*> OptionSet; |
| 692 | for (unsigned i = 0; i != Options.size(); ++i) |
| 693 | if (OptionSet.count(Options[i].second) == 0) |
| 694 | OptionSet.insert(Options[i].second); // Add new entry to set |
| 695 | else |
| 696 | Options.erase(Options.begin()+i--); // Erase duplicate |
| 697 | } |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 698 | |
| 699 | if (ProgramOverview) |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 700 | std::cerr << "OVERVIEW:" << ProgramOverview << "\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 701 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 702 | std::cerr << "USAGE: " << ProgramName << " [options]"; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 703 | |
| 704 | // Print out the positional options... |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 705 | std::vector<Option*> &PosOpts = getPositionalOpts(); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 706 | Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists... |
| 707 | if (!PosOpts.empty() && PosOpts[0]->getNumOccurancesFlag() == ConsumeAfter) |
| 708 | CAOpt = PosOpts[0]; |
| 709 | |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 710 | for (unsigned i = CAOpt != 0, e = PosOpts.size(); i != e; ++i) |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 711 | std::cerr << " " << PosOpts[i]->HelpStr; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 712 | |
| 713 | // Print the consume after option info if it exists... |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 714 | if (CAOpt) std::cerr << " " << CAOpt->HelpStr; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 715 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 716 | std::cerr << "\n\n"; |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 717 | |
| 718 | // Compute the maximum argument length... |
| 719 | MaxArgLen = 0; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 720 | for (unsigned i = 0, e = Options.size(); i != e; ++i) |
| 721 | MaxArgLen = std::max(MaxArgLen, Options[i].second->getOptionWidth()); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 722 | |
Chris Lattner | ca6433f | 2003-05-22 20:06:43 +0000 | [diff] [blame^] | 723 | std::cerr << "OPTIONS:\n"; |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 724 | for (unsigned i = 0, e = Options.size(); i != e; ++i) |
| 725 | Options[i].second->printOptionInfo(MaxArgLen); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 726 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 727 | // Halt the program if help information is printed |
| 728 | exit(1); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 729 | } |
| 730 | }; |
| 731 | |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 732 | |
| 733 | |
| 734 | // Define the two HelpPrinter instances that are used to print out help, or |
| 735 | // help-hidden... |
| 736 | // |
| 737 | HelpPrinter NormalPrinter(false); |
| 738 | HelpPrinter HiddenPrinter(true); |
| 739 | |
| 740 | cl::opt<HelpPrinter, true, parser<bool> > |
| 741 | HOp("help", cl::desc("display available options (--help-hidden for more)"), |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 742 | cl::location(NormalPrinter), cl::ValueDisallowed); |
Chris Lattner | 331de23 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 743 | |
| 744 | cl::opt<HelpPrinter, true, parser<bool> > |
| 745 | HHOp("help-hidden", cl::desc("display all available options"), |
Chris Lattner | 9b14eb5 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 746 | cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed); |
Chris Lattner | dbab15a | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 747 | |
| 748 | } // End anonymous namespace |