1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
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 could try
15 // reading the library documentation located in docs/CommandLine.html
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Config/config.h"
20 #include "llvm/ADT/OwningPtr.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/Streams.h"
25 #include "llvm/System/Path.h"
38 //===----------------------------------------------------------------------===//
39 // Template instantiations and anchors.
41 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
42 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
43 TEMPLATE_INSTANTIATION(class basic_parser<int>);
44 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
45 TEMPLATE_INSTANTIATION(class basic_parser<double>);
46 TEMPLATE_INSTANTIATION(class basic_parser<float>);
47 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
49 TEMPLATE_INSTANTIATION(class opt<unsigned>);
50 TEMPLATE_INSTANTIATION(class opt<int>);
51 TEMPLATE_INSTANTIATION(class opt<std::string>);
52 TEMPLATE_INSTANTIATION(class opt<bool>);
54 void Option::anchor() {}
55 void basic_parser_impl::anchor() {}
56 void parser<bool>::anchor() {}
57 void parser<boolOrDefault>::anchor() {}
58 void parser<int>::anchor() {}
59 void parser<unsigned>::anchor() {}
60 void parser<double>::anchor() {}
61 void parser<float>::anchor() {}
62 void parser<std::string>::anchor() {}
64 //===----------------------------------------------------------------------===//
66 // Globals for name and overview of program. Program name is not a string to
67 // avoid static ctor/dtor issues.
68 static char ProgramName[80] = "<premain>";
69 static const char *ProgramOverview = 0;
71 // This collects additional help to be printed.
72 static ManagedStatic<std::vector<const char*> > MoreHelp;
74 extrahelp::extrahelp(const char *Help)
76 MoreHelp->push_back(Help);
79 static bool OptionListChanged = false;
81 // MarkOptionsChanged - Internal helper function.
82 void cl::MarkOptionsChanged() {
83 OptionListChanged = true;
86 /// RegisteredOptionList - This is the list of the command line options that
87 /// have statically constructed themselves.
88 static Option *RegisteredOptionList = 0;
90 void Option::addArgument() {
91 assert(NextRegistered == 0 && "argument multiply registered!");
93 NextRegistered = RegisteredOptionList;
94 RegisteredOptionList = this;
99 //===----------------------------------------------------------------------===//
100 // Basic, shared command line option processing machinery.
103 /// GetOptionInfo - Scan the list of registered options, turning them into data
104 /// structures that are easier to handle.
105 static void GetOptionInfo(std::vector<Option*> &PositionalOpts,
106 std::vector<Option*> &SinkOpts,
107 std::map<std::string, Option*> &OptionsMap) {
108 std::vector<const char*> OptionNames;
109 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
110 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
111 // If this option wants to handle multiple option names, get the full set.
112 // This handles enum options like "-O1 -O2" etc.
113 O->getExtraOptionNames(OptionNames);
115 OptionNames.push_back(O->ArgStr);
117 // Handle named options.
118 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
119 // Add argument to the argument map!
120 if (!OptionsMap.insert(std::pair<std::string,Option*>(OptionNames[i],
122 cerr << ProgramName << ": CommandLine Error: Argument '"
123 << OptionNames[i] << "' defined more than once!\n";
129 // Remember information about positional options.
130 if (O->getFormattingFlag() == cl::Positional)
131 PositionalOpts.push_back(O);
132 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
133 SinkOpts.push_back(O);
134 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
136 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
142 PositionalOpts.push_back(CAOpt);
144 // Make sure that they are in order of registration not backwards.
145 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
149 /// LookupOption - Lookup the option specified by the specified option on the
150 /// command line. If there is a value specified (after an equal sign) return
152 static Option *LookupOption(const char *&Arg, const char *&Value,
153 std::map<std::string, Option*> &OptionsMap) {
154 while (*Arg == '-') ++Arg; // Eat leading dashes
156 const char *ArgEnd = Arg;
157 while (*ArgEnd && *ArgEnd != '=')
158 ++ArgEnd; // Scan till end of argument name.
160 if (*ArgEnd == '=') // If we have an equals sign...
161 Value = ArgEnd+1; // Get the value, not the equals
164 if (*Arg == 0) return 0;
166 // Look up the option.
167 std::map<std::string, Option*>::iterator I =
168 OptionsMap.find(std::string(Arg, ArgEnd));
169 return I != OptionsMap.end() ? I->second : 0;
172 static inline bool ProvideOption(Option *Handler, const char *ArgName,
173 const char *Value, int argc, char **argv,
175 // Is this a multi-argument option?
176 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
178 // Enforce value requirements
179 switch (Handler->getValueExpectedFlag()) {
181 if (Value == 0) { // No value specified?
182 if (i+1 < argc) { // Steal the next argument, like for '-o filename'
185 return Handler->error(" requires a value!");
189 case ValueDisallowed:
190 if (NumAdditionalVals > 0)
191 return Handler->error(": multi-valued option specified"
192 " with ValueDisallowed modifier!");
195 return Handler->error(" does not allow a value! '" +
196 std::string(Value) + "' specified.");
202 << ": Bad ValueMask flag! CommandLine usage error:"
203 << Handler->getValueExpectedFlag() << "\n";
208 // If this isn't a multi-arg option, just run the handler.
209 if (NumAdditionalVals == 0) {
210 return Handler->addOccurrence(i, ArgName, Value ? Value : "");
212 // If it is, run the handle several times.
214 bool MultiArg = false;
217 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
223 while (NumAdditionalVals > 0) {
228 return Handler->error(": not enough values!");
230 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
239 static bool ProvidePositionalOption(Option *Handler, const std::string &Arg,
242 return ProvideOption(Handler, Handler->ArgStr, Arg.c_str(), 0, 0, Dummy);
246 // Option predicates...
247 static inline bool isGrouping(const Option *O) {
248 return O->getFormattingFlag() == cl::Grouping;
250 static inline bool isPrefixedOrGrouping(const Option *O) {
251 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
254 // getOptionPred - Check to see if there are any options that satisfy the
255 // specified predicate with names that are the prefixes in Name. This is
256 // checked by progressively stripping characters off of the name, checking to
257 // see if there options that satisfy the predicate. If we find one, return it,
258 // otherwise return null.
260 static Option *getOptionPred(std::string Name, size_t &Length,
261 bool (*Pred)(const Option*),
262 std::map<std::string, Option*> &OptionsMap) {
264 std::map<std::string, Option*>::iterator OMI = OptionsMap.find(Name);
265 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
266 Length = Name.length();
270 if (Name.size() == 1) return 0;
272 Name.erase(Name.end()-1, Name.end()); // Chop off the last character...
273 OMI = OptionsMap.find(Name);
275 // Loop while we haven't found an option and Name still has at least two
276 // characters in it (so that the next iteration will not be the empty
278 } while ((OMI == OptionsMap.end() || !Pred(OMI->second)) && Name.size() > 1);
280 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
281 Length = Name.length();
282 return OMI->second; // Found one!
284 return 0; // No option found!
287 static bool RequiresValue(const Option *O) {
288 return O->getNumOccurrencesFlag() == cl::Required ||
289 O->getNumOccurrencesFlag() == cl::OneOrMore;
292 static bool EatsUnboundedNumberOfValues(const Option *O) {
293 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
294 O->getNumOccurrencesFlag() == cl::OneOrMore;
297 /// ParseCStringVector - Break INPUT up wherever one or more
298 /// whitespace characters are found, and store the resulting tokens in
299 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
300 /// using strdup (), so it is the caller's responsibility to free ()
303 static void ParseCStringVector(std::vector<char *> &output,
305 // Characters which will be treated as token separators:
306 static const char *const delims = " \v\f\t\r\n";
308 std::string work (input);
309 // Skip past any delims at head of input string.
310 size_t pos = work.find_first_not_of (delims);
311 // If the string consists entirely of delims, then exit early.
312 if (pos == std::string::npos) return;
313 // Otherwise, jump forward to beginning of first word.
314 work = work.substr (pos);
315 // Find position of first delimiter.
316 pos = work.find_first_of (delims);
318 while (!work.empty() && pos != std::string::npos) {
319 // Everything from 0 to POS is the next word to copy.
320 output.push_back (strdup (work.substr (0,pos).c_str ()));
321 // Is there another word in the string?
322 size_t nextpos = work.find_first_not_of (delims, pos + 1);
323 if (nextpos != std::string::npos) {
324 // Yes? Then remove delims from beginning ...
325 work = work.substr (work.find_first_not_of (delims, pos + 1));
326 // and find the end of the word.
327 pos = work.find_first_of (delims);
329 // No? (Remainder of string is delims.) End the loop.
331 pos = std::string::npos;
335 // If `input' ended with non-delim char, then we'll get here with
336 // the last word of `input' in `work'; copy it now.
337 if (!work.empty ()) {
338 output.push_back (strdup (work.c_str ()));
342 /// ParseEnvironmentOptions - An alternative entry point to the
343 /// CommandLine library, which allows you to read the program's name
344 /// from the caller (as PROGNAME) and its command-line arguments from
345 /// an environment variable (whose name is given in ENVVAR).
347 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
348 const char *Overview, bool ReadResponseFiles) {
350 assert(progName && "Program name not specified");
351 assert(envVar && "Environment variable name missing");
353 // Get the environment variable they want us to parse options out of.
354 const char *envValue = getenv(envVar);
358 // Get program's "name", which we wouldn't know without the caller
360 std::vector<char*> newArgv;
361 newArgv.push_back(strdup(progName));
363 // Parse the value of the environment variable into a "command line"
364 // and hand it off to ParseCommandLineOptions().
365 ParseCStringVector(newArgv, envValue);
366 int newArgc = static_cast<int>(newArgv.size());
367 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
369 // Free all the strdup()ed strings.
370 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
376 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
377 /// substituting the contents of the response files for the arguments
379 static void ExpandResponseFiles(int argc, char** argv,
380 std::vector<char*>& newArgv) {
381 for (int i = 1; i != argc; ++i) {
386 sys::PathWithStatus respFile(++arg);
388 // Check that the response file is not empty (mmap'ing empty
389 // files can be problematic).
390 const sys::FileStatus *FileStat = respFile.getFileStatus();
391 if (FileStat && FileStat->getSize() != 0) {
393 // Mmap the response file into memory.
394 OwningPtr<MemoryBuffer>
395 respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
397 // If we could open the file, parse its contents, otherwise
398 // pass the @file option verbatim.
400 // TODO: we should also support recursive loading of response files,
401 // since this is how gcc behaves. (From their man page: "The file may
402 // itself contain additional @file options; any such options will be
403 // processed recursively.")
405 if (respFilePtr != 0) {
406 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
411 newArgv.push_back(strdup(arg));
415 void cl::ParseCommandLineOptions(int argc, char **argv,
416 const char *Overview, bool ReadResponseFiles) {
417 // Process all registered options.
418 std::vector<Option*> PositionalOpts;
419 std::vector<Option*> SinkOpts;
420 std::map<std::string, Option*> Opts;
421 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
423 assert((!Opts.empty() || !PositionalOpts.empty()) &&
424 "No options specified!");
426 // Expand response files.
427 std::vector<char*> newArgv;
428 if (ReadResponseFiles) {
429 newArgv.push_back(strdup(argv[0]));
430 ExpandResponseFiles(argc, argv, newArgv);
432 argc = static_cast<int>(newArgv.size());
435 // Copy the program name into ProgName, making sure not to overflow it.
436 std::string ProgName = sys::Path(argv[0]).getLast();
437 if (ProgName.size() > 79) ProgName.resize(79);
438 strcpy(ProgramName, ProgName.c_str());
440 ProgramOverview = Overview;
441 bool ErrorParsing = false;
443 // Check out the positional arguments to collect information about them.
444 unsigned NumPositionalRequired = 0;
446 // Determine whether or not there are an unlimited number of positionals
447 bool HasUnlimitedPositionals = false;
449 Option *ConsumeAfterOpt = 0;
450 if (!PositionalOpts.empty()) {
451 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
452 assert(PositionalOpts.size() > 1 &&
453 "Cannot specify cl::ConsumeAfter without a positional argument!");
454 ConsumeAfterOpt = PositionalOpts[0];
457 // Calculate how many positional values are _required_.
458 bool UnboundedFound = false;
459 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
461 Option *Opt = PositionalOpts[i];
462 if (RequiresValue(Opt))
463 ++NumPositionalRequired;
464 else if (ConsumeAfterOpt) {
465 // ConsumeAfter cannot be combined with "optional" positional options
466 // unless there is only one positional argument...
467 if (PositionalOpts.size() > 2)
469 Opt->error(" error - this positional option will never be matched, "
470 "because it does not Require a value, and a "
471 "cl::ConsumeAfter option is active!");
472 } else if (UnboundedFound && !Opt->ArgStr[0]) {
473 // This option does not "require" a value... Make sure this option is
474 // not specified after an option that eats all extra arguments, or this
475 // one will never get any!
477 ErrorParsing |= Opt->error(" error - option can never match, because "
478 "another positional argument will match an "
479 "unbounded number of values, and this option"
480 " does not require a value!");
482 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
484 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
487 // PositionalVals - A vector of "positional" arguments we accumulate into
488 // the process at the end...
490 std::vector<std::pair<std::string,unsigned> > PositionalVals;
492 // If the program has named positional arguments, and the name has been run
493 // across, keep track of which positional argument was named. Otherwise put
494 // the positional args into the PositionalVals list...
495 Option *ActivePositionalArg = 0;
497 // Loop over all of the arguments... processing them.
498 bool DashDashFound = false; // Have we read '--'?
499 for (int i = 1; i < argc; ++i) {
501 const char *Value = 0;
502 const char *ArgName = "";
504 // If the option list changed, this means that some command line
505 // option has just been registered or deregistered. This can occur in
506 // response to things like -load, etc. If this happens, rescan the options.
507 if (OptionListChanged) {
508 PositionalOpts.clear();
511 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
512 OptionListChanged = false;
515 // Check to see if this is a positional argument. This argument is
516 // considered to be positional if it doesn't start with '-', if it is "-"
517 // itself, or if we have seen "--" already.
519 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
520 // Positional argument!
521 if (ActivePositionalArg) {
522 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
523 continue; // We are done!
524 } else if (!PositionalOpts.empty()) {
525 PositionalVals.push_back(std::make_pair(argv[i],i));
527 // All of the positional arguments have been fulfulled, give the rest to
528 // the consume after option... if it's specified...
530 if (PositionalVals.size() >= NumPositionalRequired &&
531 ConsumeAfterOpt != 0) {
532 for (++i; i < argc; ++i)
533 PositionalVals.push_back(std::make_pair(argv[i],i));
534 break; // Handle outside of the argument processing loop...
537 // Delay processing positional arguments until the end...
540 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
542 DashDashFound = true; // This is the mythical "--"?
543 continue; // Don't try to process it as an argument itself.
544 } else if (ActivePositionalArg &&
545 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
546 // If there is a positional argument eating options, check to see if this
547 // option is another positional argument. If so, treat it as an argument,
548 // otherwise feed it to the eating positional.
550 Handler = LookupOption(ArgName, Value, Opts);
551 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
552 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
553 continue; // We are done!
556 } else { // We start with a '-', must be an argument...
558 Handler = LookupOption(ArgName, Value, Opts);
560 // Check to see if this "option" is really a prefixed or grouped argument.
562 std::string RealName(ArgName);
563 if (RealName.size() > 1) {
565 Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping,
568 // If the option is a prefixed option, then the value is simply the
569 // rest of the name... so fall through to later processing, by
570 // setting up the argument name flags and value fields.
572 if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
573 Value = ArgName+Length;
574 assert(Opts.find(std::string(ArgName, Value)) != Opts.end() &&
575 Opts.find(std::string(ArgName, Value))->second == PGOpt);
578 // This must be a grouped option... handle them now.
579 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
582 // Move current arg name out of RealName into RealArgName...
583 std::string RealArgName(RealName.begin(),
584 RealName.begin() + Length);
585 RealName.erase(RealName.begin(), RealName.begin() + Length);
587 // Because ValueRequired is an invalid flag for grouped arguments,
588 // we don't need to pass argc/argv in...
590 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
591 "Option can not be cl::Grouping AND cl::ValueRequired!");
593 ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(),
596 // Get the next grouping option...
597 PGOpt = getOptionPred(RealName, Length, isGrouping, Opts);
598 } while (PGOpt && Length != RealName.size());
600 Handler = PGOpt; // Ate all of the options.
607 if (SinkOpts.empty()) {
608 cerr << ProgramName << ": Unknown command line argument '"
609 << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
612 for (std::vector<Option*>::iterator I = SinkOpts.begin(),
613 E = SinkOpts.end(); I != E ; ++I)
614 (*I)->addOccurrence(i, "", argv[i]);
619 // Check to see if this option accepts a comma separated list of values. If
620 // it does, we have to split up the value into multiple values...
621 if (Value && Handler->getMiscFlags() & CommaSeparated) {
622 std::string Val(Value);
623 std::string::size_type Pos = Val.find(',');
625 while (Pos != std::string::npos) {
626 // Process the portion before the comma...
627 ErrorParsing |= ProvideOption(Handler, ArgName,
628 std::string(Val.begin(),
629 Val.begin()+Pos).c_str(),
631 // Erase the portion before the comma, AND the comma...
632 Val.erase(Val.begin(), Val.begin()+Pos+1);
633 Value += Pos+1; // Increment the original value pointer as well...
635 // Check for another comma...
640 // If this is a named positional argument, just remember that it is the
642 if (Handler->getFormattingFlag() == cl::Positional)
643 ActivePositionalArg = Handler;
645 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
648 // Check and handle positional arguments now...
649 if (NumPositionalRequired > PositionalVals.size()) {
651 << ": Not enough positional command line arguments specified!\n"
652 << "Must specify at least " << NumPositionalRequired
653 << " positional arguments: See: " << argv[0] << " --help\n";
656 } else if (!HasUnlimitedPositionals
657 && PositionalVals.size() > PositionalOpts.size()) {
659 << ": Too many positional arguments specified!\n"
660 << "Can specify at most " << PositionalOpts.size()
661 << " positional arguments: See: " << argv[0] << " --help\n";
664 } else if (ConsumeAfterOpt == 0) {
665 // Positional args have already been handled if ConsumeAfter is specified...
666 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
667 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
668 if (RequiresValue(PositionalOpts[i])) {
669 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
670 PositionalVals[ValNo].second);
672 --NumPositionalRequired; // We fulfilled our duty...
675 // If we _can_ give this option more arguments, do so now, as long as we
676 // do not give it values that others need. 'Done' controls whether the
677 // option even _WANTS_ any more.
679 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
680 while (NumVals-ValNo > NumPositionalRequired && !Done) {
681 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
683 Done = true; // Optional arguments want _at most_ one value
685 case cl::ZeroOrMore: // Zero or more will take all they can get...
686 case cl::OneOrMore: // One or more will take all they can get...
687 ProvidePositionalOption(PositionalOpts[i],
688 PositionalVals[ValNo].first,
689 PositionalVals[ValNo].second);
693 assert(0 && "Internal error, unexpected NumOccurrences flag in "
694 "positional argument processing!");
699 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
701 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
702 if (RequiresValue(PositionalOpts[j])) {
703 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
704 PositionalVals[ValNo].first,
705 PositionalVals[ValNo].second);
709 // Handle the case where there is just one positional option, and it's
710 // optional. In this case, we want to give JUST THE FIRST option to the
711 // positional option and keep the rest for the consume after. The above
712 // loop would have assigned no values to positional options in this case.
714 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
715 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
716 PositionalVals[ValNo].first,
717 PositionalVals[ValNo].second);
721 // Handle over all of the rest of the arguments to the
722 // cl::ConsumeAfter command line option...
723 for (; ValNo != PositionalVals.size(); ++ValNo)
724 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
725 PositionalVals[ValNo].first,
726 PositionalVals[ValNo].second);
729 // Loop over args and make sure all required args are specified!
730 for (std::map<std::string, Option*>::iterator I = Opts.begin(),
731 E = Opts.end(); I != E; ++I) {
732 switch (I->second->getNumOccurrencesFlag()) {
735 if (I->second->getNumOccurrences() == 0) {
736 I->second->error(" must be specified at least once!");
745 // Free all of the memory allocated to the map. Command line options may only
746 // be processed once!
748 PositionalOpts.clear();
751 // Free the memory allocated by ExpandResponseFiles.
752 if (ReadResponseFiles) {
753 // Free all the strdup()ed strings.
754 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
759 // If we had an error processing our arguments, don't let the program execute
760 if (ErrorParsing) exit(1);
763 //===----------------------------------------------------------------------===//
764 // Option Base class implementation
767 bool Option::error(std::string Message, const char *ArgName) {
768 if (ArgName == 0) ArgName = ArgStr;
770 cerr << HelpStr; // Be nice for positional arguments
772 cerr << ProgramName << ": for the -" << ArgName;
774 cerr << " option: " << Message << "\n";
778 bool Option::addOccurrence(unsigned pos, const char *ArgName,
779 const std::string &Value,
782 NumOccurrences++; // Increment the number of times we have been seen
784 switch (getNumOccurrencesFlag()) {
786 if (NumOccurrences > 1)
787 return error(": may only occur zero or one times!", ArgName);
790 if (NumOccurrences > 1)
791 return error(": must occur exactly one time!", ArgName);
795 case ConsumeAfter: break;
796 default: return error(": bad num occurrences flag value!");
799 return handleOccurrence(pos, ArgName, Value);
803 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
804 // has been specified yet.
806 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
807 if (O.ValueStr[0] == 0) return DefaultMsg;
811 //===----------------------------------------------------------------------===//
812 // cl::alias class implementation
815 // Return the width of the option tag for printing...
816 size_t alias::getOptionWidth() const {
817 return std::strlen(ArgStr)+6;
820 // Print out the option for the alias.
821 void alias::printOptionInfo(size_t GlobalWidth) const {
822 size_t L = std::strlen(ArgStr);
823 cout << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
829 //===----------------------------------------------------------------------===//
830 // Parser Implementation code...
833 // basic_parser implementation
836 // Return the width of the option tag for printing...
837 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
838 size_t Len = std::strlen(O.ArgStr);
839 if (const char *ValName = getValueName())
840 Len += std::strlen(getValueStr(O, ValName))+3;
845 // printOptionInfo - Print out information about this option. The
846 // to-be-maintained width is specified.
848 void basic_parser_impl::printOptionInfo(const Option &O,
849 size_t GlobalWidth) const {
850 cout << " -" << O.ArgStr;
852 if (const char *ValName = getValueName())
853 cout << "=<" << getValueStr(O, ValName) << ">";
855 cout << std::string(GlobalWidth-getOptionWidth(O), ' ') << " - "
856 << O.HelpStr << "\n";
862 // parser<bool> implementation
864 bool parser<bool>::parse(Option &O, const char *ArgName,
865 const std::string &Arg, bool &Value) {
866 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
869 } else if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
872 return O.error(": '" + Arg +
873 "' is invalid value for boolean argument! Try 0 or 1");
878 // parser<boolOrDefault> implementation
880 bool parser<boolOrDefault>::parse(Option &O, const char *ArgName,
881 const std::string &Arg, boolOrDefault &Value) {
882 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
885 } else if (Arg == "false" || Arg == "FALSE"
886 || Arg == "False" || Arg == "0") {
889 return O.error(": '" + Arg +
890 "' is invalid value for boolean argument! Try 0 or 1");
895 // parser<int> implementation
897 bool parser<int>::parse(Option &O, const char *ArgName,
898 const std::string &Arg, int &Value) {
900 Value = (int)strtol(Arg.c_str(), &End, 0);
902 return O.error(": '" + Arg + "' value invalid for integer argument!");
906 // parser<unsigned> implementation
908 bool parser<unsigned>::parse(Option &O, const char *ArgName,
909 const std::string &Arg, unsigned &Value) {
912 unsigned long V = strtoul(Arg.c_str(), &End, 0);
914 if (((V == ULONG_MAX) && (errno == ERANGE))
917 return O.error(": '" + Arg + "' value invalid for uint argument!");
921 // parser<double>/parser<float> implementation
923 static bool parseDouble(Option &O, const std::string &Arg, double &Value) {
924 const char *ArgStart = Arg.c_str();
926 Value = strtod(ArgStart, &End);
928 return O.error(": '" +Arg+ "' value invalid for floating point argument!");
932 bool parser<double>::parse(Option &O, const char *AN,
933 const std::string &Arg, double &Val) {
934 return parseDouble(O, Arg, Val);
937 bool parser<float>::parse(Option &O, const char *AN,
938 const std::string &Arg, float &Val) {
940 if (parseDouble(O, Arg, dVal))
948 // generic_parser_base implementation
951 // findOption - Return the option number corresponding to the specified
952 // argument string. If the option is not found, getNumOptions() is returned.
954 unsigned generic_parser_base::findOption(const char *Name) {
955 unsigned i = 0, e = getNumOptions();
959 if (getOption(i) == N)
967 // Return the width of the option tag for printing...
968 size_t generic_parser_base::getOptionWidth(const Option &O) const {
970 size_t Size = std::strlen(O.ArgStr)+6;
971 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
972 Size = std::max(Size, std::strlen(getOption(i))+8);
976 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
977 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
982 // printOptionInfo - Print out information about this option. The
983 // to-be-maintained width is specified.
985 void generic_parser_base::printOptionInfo(const Option &O,
986 size_t GlobalWidth) const {
988 size_t L = std::strlen(O.ArgStr);
989 cout << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
990 << " - " << O.HelpStr << "\n";
992 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
993 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
994 cout << " =" << getOption(i) << std::string(NumSpaces, ' ')
995 << " - " << getDescription(i) << "\n";
999 cout << " " << O.HelpStr << "\n";
1000 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1001 size_t L = std::strlen(getOption(i));
1002 cout << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
1003 << " - " << getDescription(i) << "\n";
1009 //===----------------------------------------------------------------------===//
1010 // --help and --help-hidden option implementation
1017 const Option *EmptyArg;
1018 const bool ShowHidden;
1020 // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
1021 inline static bool isHidden(std::pair<std::string, Option *> &OptPair) {
1022 return OptPair.second->getOptionHiddenFlag() >= Hidden;
1024 inline static bool isReallyHidden(std::pair<std::string, Option *> &OptPair) {
1025 return OptPair.second->getOptionHiddenFlag() == ReallyHidden;
1029 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1033 void operator=(bool Value) {
1034 if (Value == false) return;
1036 // Get all the options.
1037 std::vector<Option*> PositionalOpts;
1038 std::vector<Option*> SinkOpts;
1039 std::map<std::string, Option*> OptMap;
1040 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1042 // Copy Options into a vector so we can sort them as we like...
1043 std::vector<std::pair<std::string, Option*> > Opts;
1044 copy(OptMap.begin(), OptMap.end(), std::back_inserter(Opts));
1046 // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
1047 Opts.erase(std::remove_if(Opts.begin(), Opts.end(),
1048 std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
1051 // Eliminate duplicate entries in table (from enum flags options, f.e.)
1052 { // Give OptionSet a scope
1053 std::set<Option*> OptionSet;
1054 for (unsigned i = 0; i != Opts.size(); ++i)
1055 if (OptionSet.count(Opts[i].second) == 0)
1056 OptionSet.insert(Opts[i].second); // Add new entry to set
1058 Opts.erase(Opts.begin()+i--); // Erase duplicate
1061 if (ProgramOverview)
1062 cout << "OVERVIEW: " << ProgramOverview << "\n";
1064 cout << "USAGE: " << ProgramName << " [options]";
1066 // Print out the positional options.
1067 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1068 if (!PositionalOpts.empty() &&
1069 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1070 CAOpt = PositionalOpts[0];
1072 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1073 if (PositionalOpts[i]->ArgStr[0])
1074 cout << " --" << PositionalOpts[i]->ArgStr;
1075 cout << " " << PositionalOpts[i]->HelpStr;
1078 // Print the consume after option info if it exists...
1079 if (CAOpt) cout << " " << CAOpt->HelpStr;
1083 // Compute the maximum argument length...
1085 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1086 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1088 cout << "OPTIONS:\n";
1089 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1090 Opts[i].second->printOptionInfo(MaxArgLen);
1092 // Print any extra help the user has declared.
1093 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1094 E = MoreHelp->end(); I != E; ++I)
1098 // Halt the program since help information was printed
1102 } // End anonymous namespace
1104 // Define the two HelpPrinter instances that are used to print out help, or
1107 static HelpPrinter NormalPrinter(false);
1108 static HelpPrinter HiddenPrinter(true);
1110 static cl::opt<HelpPrinter, true, parser<bool> >
1111 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1112 cl::location(NormalPrinter), cl::ValueDisallowed);
1114 static cl::opt<HelpPrinter, true, parser<bool> >
1115 HHOp("help-hidden", cl::desc("Display all available options"),
1116 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1118 static void (*OverrideVersionPrinter)() = 0;
1121 class VersionPrinter {
1124 cout << "Low Level Virtual Machine (http://llvm.org/):\n";
1125 cout << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1126 #ifdef LLVM_VERSION_INFO
1127 cout << LLVM_VERSION_INFO;
1130 #ifndef __OPTIMIZE__
1131 cout << "DEBUG build";
1133 cout << "Optimized build";
1136 cout << " with assertions";
1139 cout << " Built " << __DATE__ << "(" << __TIME__ << ").\n";
1141 void operator=(bool OptionWasSpecified) {
1142 if (OptionWasSpecified) {
1143 if (OverrideVersionPrinter == 0) {
1147 (*OverrideVersionPrinter)();
1153 } // End anonymous namespace
1156 // Define the --version option that prints out the LLVM version for the tool
1157 static VersionPrinter VersionPrinterInstance;
1159 static cl::opt<VersionPrinter, true, parser<bool> >
1160 VersOp("version", cl::desc("Display the version of this program"),
1161 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1163 // Utility function for printing the help message.
1164 void cl::PrintHelpMessage() {
1165 // This looks weird, but it actually prints the help message. The
1166 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1167 // its operator= is invoked. That's because the "normal" usages of the
1168 // help printer is to be assigned true/false depending on whether the
1169 // --help option was given or not. Since we're circumventing that we have
1170 // to make it look like --help was given, so we assign true.
1171 NormalPrinter = true;
1174 /// Utility function for printing version number.
1175 void cl::PrintVersionMessage() {
1176 VersionPrinterInstance.print();
1179 void cl::SetVersionPrinter(void (*func)()) {
1180 OverrideVersionPrinter = func;