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/Support/CommandLine.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/MemoryBuffer.h"
22 #include "llvm/Support/ManagedStatic.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/Target/TargetRegistry.h"
25 #include "llvm/System/Host.h"
26 #include "llvm/System/Path.h"
27 #include "llvm/ADT/OwningPtr.h"
28 #include "llvm/ADT/StringMap.h"
29 #include "llvm/ADT/SmallString.h"
30 #include "llvm/ADT/Twine.h"
31 #include "llvm/Config/config.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>);
48 TEMPLATE_INSTANTIATION(class basic_parser<char>);
50 TEMPLATE_INSTANTIATION(class opt<unsigned>);
51 TEMPLATE_INSTANTIATION(class opt<int>);
52 TEMPLATE_INSTANTIATION(class opt<std::string>);
53 TEMPLATE_INSTANTIATION(class opt<char>);
54 TEMPLATE_INSTANTIATION(class opt<bool>);
56 void Option::anchor() {}
57 void basic_parser_impl::anchor() {}
58 void parser<bool>::anchor() {}
59 void parser<boolOrDefault>::anchor() {}
60 void parser<int>::anchor() {}
61 void parser<unsigned>::anchor() {}
62 void parser<double>::anchor() {}
63 void parser<float>::anchor() {}
64 void parser<std::string>::anchor() {}
65 void parser<char>::anchor() {}
67 //===----------------------------------------------------------------------===//
69 // Globals for name and overview of program. Program name is not a string to
70 // avoid static ctor/dtor issues.
71 static char ProgramName[80] = "<premain>";
72 static const char *ProgramOverview = 0;
74 // This collects additional help to be printed.
75 static ManagedStatic<std::vector<const char*> > MoreHelp;
77 extrahelp::extrahelp(const char *Help)
79 MoreHelp->push_back(Help);
82 static bool OptionListChanged = false;
84 // MarkOptionsChanged - Internal helper function.
85 void cl::MarkOptionsChanged() {
86 OptionListChanged = true;
89 /// RegisteredOptionList - This is the list of the command line options that
90 /// have statically constructed themselves.
91 static Option *RegisteredOptionList = 0;
93 void Option::addArgument() {
94 assert(NextRegistered == 0 && "argument multiply registered!");
96 NextRegistered = RegisteredOptionList;
97 RegisteredOptionList = this;
102 //===----------------------------------------------------------------------===//
103 // Basic, shared command line option processing machinery.
106 /// GetOptionInfo - Scan the list of registered options, turning them into data
107 /// structures that are easier to handle.
108 static void GetOptionInfo(std::vector<Option*> &PositionalOpts,
109 std::vector<Option*> &SinkOpts,
110 StringMap<Option*> &OptionsMap) {
111 std::vector<const char*> OptionNames;
112 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
113 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
114 // If this option wants to handle multiple option names, get the full set.
115 // This handles enum options like "-O1 -O2" etc.
116 O->getExtraOptionNames(OptionNames);
118 OptionNames.push_back(O->ArgStr);
120 // Handle named options.
121 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
122 // Add argument to the argument map!
123 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
124 errs() << ProgramName << ": CommandLine Error: Argument '"
125 << OptionNames[i] << "' defined more than once!\n";
131 // Remember information about positional options.
132 if (O->getFormattingFlag() == cl::Positional)
133 PositionalOpts.push_back(O);
134 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
135 SinkOpts.push_back(O);
136 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
138 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
144 PositionalOpts.push_back(CAOpt);
146 // Make sure that they are in order of registration not backwards.
147 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
151 /// LookupOption - Lookup the option specified by the specified option on the
152 /// command line. If there is a value specified (after an equal sign) return
154 static Option *LookupOption(const char *&Arg, StringRef &Value,
155 StringMap<Option*> &OptionsMap) {
156 while (*Arg == '-') ++Arg; // Eat leading dashes
158 const char *ArgEnd = Arg;
159 while (*ArgEnd && *ArgEnd != '=')
160 ++ArgEnd; // Scan till end of argument name.
162 // If we have an equals sign, remember the value.
166 if (*Arg == 0) return 0;
168 // Look up the option.
169 StringMap<Option*>::iterator I =
170 OptionsMap.find(llvm::StringRef(Arg, ArgEnd-Arg));
171 return I != OptionsMap.end() ? I->second : 0;
174 /// ProvideOption - For Value, this differentiates between an empty value ("")
175 /// and a null value (StringRef()). The later is accepted for arguments that
176 /// don't allow a value (-foo) the former is rejected (-foo=).
177 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
178 StringRef Value, int argc, char **argv,
180 // Is this a multi-argument option?
181 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
183 // Enforce value requirements
184 switch (Handler->getValueExpectedFlag()) {
186 if (Value.data() == 0) { // No value specified?
188 return Handler->error("requires a value!");
189 // Steal the next argument, like for '-o filename'
193 case ValueDisallowed:
194 if (NumAdditionalVals > 0)
195 return Handler->error("multi-valued option specified"
196 " with ValueDisallowed modifier!");
199 return Handler->error("does not allow a value! '" +
200 Twine(Value) + "' specified.");
206 errs() << ProgramName
207 << ": Bad ValueMask flag! CommandLine usage error:"
208 << Handler->getValueExpectedFlag() << "\n";
212 // If this isn't a multi-arg option, just run the handler.
213 if (NumAdditionalVals == 0)
214 return Handler->addOccurrence(i, ArgName, Value);
216 // If it is, run the handle several times.
217 bool MultiArg = false;
220 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
226 while (NumAdditionalVals > 0) {
228 return Handler->error("not enough values!");
231 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
239 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
241 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
245 // Option predicates...
246 static inline bool isGrouping(const Option *O) {
247 return O->getFormattingFlag() == cl::Grouping;
249 static inline bool isPrefixedOrGrouping(const Option *O) {
250 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
253 // getOptionPred - Check to see if there are any options that satisfy the
254 // specified predicate with names that are the prefixes in Name. This is
255 // checked by progressively stripping characters off of the name, checking to
256 // see if there options that satisfy the predicate. If we find one, return it,
257 // otherwise return null.
259 static Option *getOptionPred(StringRef Name, size_t &Length,
260 bool (*Pred)(const Option*),
261 StringMap<Option*> &OptionsMap) {
263 StringMap<Option*>::iterator OMI = OptionsMap.find(Name);
264 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
265 Length = Name.size();
269 if (Name.size() == 1) return 0;
271 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
272 OMI = OptionsMap.find(Name);
274 // Loop while we haven't found an option and Name still has at least two
275 // characters in it (so that the next iteration will not be the empty
277 } while ((OMI == OptionsMap.end() || !Pred(OMI->second)) && Name.size() > 1);
279 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
280 Length = Name.size();
281 return OMI->second; // Found one!
283 return 0; // No option found!
286 static bool RequiresValue(const Option *O) {
287 return O->getNumOccurrencesFlag() == cl::Required ||
288 O->getNumOccurrencesFlag() == cl::OneOrMore;
291 static bool EatsUnboundedNumberOfValues(const Option *O) {
292 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
293 O->getNumOccurrencesFlag() == cl::OneOrMore;
296 /// ParseCStringVector - Break INPUT up wherever one or more
297 /// whitespace characters are found, and store the resulting tokens in
298 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
299 /// using strdup(), so it is the caller's responsibility to free()
302 static void ParseCStringVector(std::vector<char *> &OutputVector,
304 // Characters which will be treated as token separators:
305 StringRef Delims = " \v\f\t\r\n";
307 StringRef WorkStr(Input);
308 while (!WorkStr.empty()) {
309 // If the first character is a delimiter, strip them off.
310 if (Delims.find(WorkStr[0]) != StringRef::npos) {
311 size_t Pos = WorkStr.find_first_not_of(Delims);
312 if (Pos == StringRef::npos) Pos = WorkStr.size();
313 WorkStr = WorkStr.substr(Pos);
317 // Find position of first delimiter.
318 size_t Pos = WorkStr.find_first_of(Delims);
319 if (Pos == StringRef::npos) Pos = WorkStr.size();
321 // Everything from 0 to Pos is the next word to copy.
322 char *NewStr = (char*)malloc(Pos+1);
323 memcpy(NewStr, WorkStr.data(), Pos);
325 OutputVector.push_back(NewStr);
329 /// ParseEnvironmentOptions - An alternative entry point to the
330 /// CommandLine library, which allows you to read the program's name
331 /// from the caller (as PROGNAME) and its command-line arguments from
332 /// an environment variable (whose name is given in ENVVAR).
334 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
335 const char *Overview, bool ReadResponseFiles) {
337 assert(progName && "Program name not specified");
338 assert(envVar && "Environment variable name missing");
340 // Get the environment variable they want us to parse options out of.
341 const char *envValue = getenv(envVar);
345 // Get program's "name", which we wouldn't know without the caller
347 std::vector<char*> newArgv;
348 newArgv.push_back(strdup(progName));
350 // Parse the value of the environment variable into a "command line"
351 // and hand it off to ParseCommandLineOptions().
352 ParseCStringVector(newArgv, envValue);
353 int newArgc = static_cast<int>(newArgv.size());
354 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
356 // Free all the strdup()ed strings.
357 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
363 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
364 /// substituting the contents of the response files for the arguments
366 static void ExpandResponseFiles(int argc, char** argv,
367 std::vector<char*>& newArgv) {
368 for (int i = 1; i != argc; ++i) {
373 sys::PathWithStatus respFile(++arg);
375 // Check that the response file is not empty (mmap'ing empty
376 // files can be problematic).
377 const sys::FileStatus *FileStat = respFile.getFileStatus();
378 if (FileStat && FileStat->getSize() != 0) {
380 // Mmap the response file into memory.
381 OwningPtr<MemoryBuffer>
382 respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
384 // If we could open the file, parse its contents, otherwise
385 // pass the @file option verbatim.
387 // TODO: we should also support recursive loading of response files,
388 // since this is how gcc behaves. (From their man page: "The file may
389 // itself contain additional @file options; any such options will be
390 // processed recursively.")
392 if (respFilePtr != 0) {
393 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
398 newArgv.push_back(strdup(arg));
402 void cl::ParseCommandLineOptions(int argc, char **argv,
403 const char *Overview, bool ReadResponseFiles) {
404 // Process all registered options.
405 std::vector<Option*> PositionalOpts;
406 std::vector<Option*> SinkOpts;
407 StringMap<Option*> Opts;
408 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
410 assert((!Opts.empty() || !PositionalOpts.empty()) &&
411 "No options specified!");
413 // Expand response files.
414 std::vector<char*> newArgv;
415 if (ReadResponseFiles) {
416 newArgv.push_back(strdup(argv[0]));
417 ExpandResponseFiles(argc, argv, newArgv);
419 argc = static_cast<int>(newArgv.size());
422 // Copy the program name into ProgName, making sure not to overflow it.
423 std::string ProgName = sys::Path(argv[0]).getLast();
424 if (ProgName.size() > 79) ProgName.resize(79);
425 strcpy(ProgramName, ProgName.c_str());
427 ProgramOverview = Overview;
428 bool ErrorParsing = false;
430 // Check out the positional arguments to collect information about them.
431 unsigned NumPositionalRequired = 0;
433 // Determine whether or not there are an unlimited number of positionals
434 bool HasUnlimitedPositionals = false;
436 Option *ConsumeAfterOpt = 0;
437 if (!PositionalOpts.empty()) {
438 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
439 assert(PositionalOpts.size() > 1 &&
440 "Cannot specify cl::ConsumeAfter without a positional argument!");
441 ConsumeAfterOpt = PositionalOpts[0];
444 // Calculate how many positional values are _required_.
445 bool UnboundedFound = false;
446 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
448 Option *Opt = PositionalOpts[i];
449 if (RequiresValue(Opt))
450 ++NumPositionalRequired;
451 else if (ConsumeAfterOpt) {
452 // ConsumeAfter cannot be combined with "optional" positional options
453 // unless there is only one positional argument...
454 if (PositionalOpts.size() > 2)
456 Opt->error("error - this positional option will never be matched, "
457 "because it does not Require a value, and a "
458 "cl::ConsumeAfter option is active!");
459 } else if (UnboundedFound && !Opt->ArgStr[0]) {
460 // This option does not "require" a value... Make sure this option is
461 // not specified after an option that eats all extra arguments, or this
462 // one will never get any!
464 ErrorParsing |= Opt->error("error - option can never match, because "
465 "another positional argument will match an "
466 "unbounded number of values, and this option"
467 " does not require a value!");
469 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
471 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
474 // PositionalVals - A vector of "positional" arguments we accumulate into
475 // the process at the end.
477 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
479 // If the program has named positional arguments, and the name has been run
480 // across, keep track of which positional argument was named. Otherwise put
481 // the positional args into the PositionalVals list...
482 Option *ActivePositionalArg = 0;
484 // Loop over all of the arguments... processing them.
485 bool DashDashFound = false; // Have we read '--'?
486 for (int i = 1; i < argc; ++i) {
489 const char *ArgName = "";
491 // If the option list changed, this means that some command line
492 // option has just been registered or deregistered. This can occur in
493 // response to things like -load, etc. If this happens, rescan the options.
494 if (OptionListChanged) {
495 PositionalOpts.clear();
498 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
499 OptionListChanged = false;
502 // Check to see if this is a positional argument. This argument is
503 // considered to be positional if it doesn't start with '-', if it is "-"
504 // itself, or if we have seen "--" already.
506 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
507 // Positional argument!
508 if (ActivePositionalArg) {
509 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
510 continue; // We are done!
513 if (!PositionalOpts.empty()) {
514 PositionalVals.push_back(std::make_pair(argv[i],i));
516 // All of the positional arguments have been fulfulled, give the rest to
517 // the consume after option... if it's specified...
519 if (PositionalVals.size() >= NumPositionalRequired &&
520 ConsumeAfterOpt != 0) {
521 for (++i; i < argc; ++i)
522 PositionalVals.push_back(std::make_pair(argv[i],i));
523 break; // Handle outside of the argument processing loop...
526 // Delay processing positional arguments until the end...
529 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
531 DashDashFound = true; // This is the mythical "--"?
532 continue; // Don't try to process it as an argument itself.
533 } else if (ActivePositionalArg &&
534 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
535 // If there is a positional argument eating options, check to see if this
536 // option is another positional argument. If so, treat it as an argument,
537 // otherwise feed it to the eating positional.
539 Handler = LookupOption(ArgName, Value, Opts);
540 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
541 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
542 continue; // We are done!
545 } else { // We start with a '-', must be an argument.
547 Handler = LookupOption(ArgName, Value, Opts);
549 // Check to see if this "option" is really a prefixed or grouped argument.
551 StringRef RealName(ArgName);
552 if (RealName.size() > 1) {
554 Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping,
557 // If the option is a prefixed option, then the value is simply the
558 // rest of the name... so fall through to later processing, by
559 // setting up the argument name flags and value fields.
561 if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
562 Value = ArgName+Length;
563 assert(Opts.count(StringRef(ArgName, Length)) &&
564 Opts[StringRef(ArgName, Length)] == PGOpt);
567 // This must be a grouped option... handle them now.
568 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
571 // Move current arg name out of RealName into RealArgName.
572 StringRef RealArgName = RealName.substr(0, Length);
573 RealName = RealName.substr(Length);
575 // Because ValueRequired is an invalid flag for grouped arguments,
576 // we don't need to pass argc/argv in.
578 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
579 "Option can not be cl::Grouping AND cl::ValueRequired!");
581 ErrorParsing |= ProvideOption(PGOpt, RealArgName,
582 StringRef(), 0, 0, Dummy);
584 // Get the next grouping option.
585 PGOpt = getOptionPred(RealName, Length, isGrouping, Opts);
586 } while (PGOpt && Length != RealName.size());
588 Handler = PGOpt; // Ate all of the options.
595 if (SinkOpts.empty()) {
596 errs() << ProgramName << ": Unknown command line argument '"
597 << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
600 for (std::vector<Option*>::iterator I = SinkOpts.begin(),
601 E = SinkOpts.end(); I != E ; ++I)
602 (*I)->addOccurrence(i, "", argv[i]);
607 // Check to see if this option accepts a comma separated list of values. If
608 // it does, we have to split up the value into multiple values.
609 if (Handler->getMiscFlags() & CommaSeparated) {
610 StringRef Val(Value);
611 StringRef::size_type Pos = Val.find(',');
613 while (Pos != StringRef::npos) {
614 // Process the portion before the comma.
615 ErrorParsing |= ProvideOption(Handler, ArgName, Val.substr(0, Pos),
617 // Erase the portion before the comma, AND the comma.
618 Val = Val.substr(Pos+1);
619 Value.substr(Pos+1); // Increment the original value pointer as well.
621 // Check for another comma.
626 // If this is a named positional argument, just remember that it is the
628 if (Handler->getFormattingFlag() == cl::Positional)
629 ActivePositionalArg = Handler;
631 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
634 // Check and handle positional arguments now...
635 if (NumPositionalRequired > PositionalVals.size()) {
636 errs() << ProgramName
637 << ": Not enough positional command line arguments specified!\n"
638 << "Must specify at least " << NumPositionalRequired
639 << " positional arguments: See: " << argv[0] << " --help\n";
642 } else if (!HasUnlimitedPositionals
643 && PositionalVals.size() > PositionalOpts.size()) {
644 errs() << ProgramName
645 << ": Too many positional arguments specified!\n"
646 << "Can specify at most " << PositionalOpts.size()
647 << " positional arguments: See: " << argv[0] << " --help\n";
650 } else if (ConsumeAfterOpt == 0) {
651 // Positional args have already been handled if ConsumeAfter is specified...
652 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
653 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
654 if (RequiresValue(PositionalOpts[i])) {
655 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
656 PositionalVals[ValNo].second);
658 --NumPositionalRequired; // We fulfilled our duty...
661 // If we _can_ give this option more arguments, do so now, as long as we
662 // do not give it values that others need. 'Done' controls whether the
663 // option even _WANTS_ any more.
665 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
666 while (NumVals-ValNo > NumPositionalRequired && !Done) {
667 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
669 Done = true; // Optional arguments want _at most_ one value
671 case cl::ZeroOrMore: // Zero or more will take all they can get...
672 case cl::OneOrMore: // One or more will take all they can get...
673 ProvidePositionalOption(PositionalOpts[i],
674 PositionalVals[ValNo].first,
675 PositionalVals[ValNo].second);
679 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
680 "positional argument processing!");
685 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
687 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
688 if (RequiresValue(PositionalOpts[j])) {
689 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
690 PositionalVals[ValNo].first,
691 PositionalVals[ValNo].second);
695 // Handle the case where there is just one positional option, and it's
696 // optional. In this case, we want to give JUST THE FIRST option to the
697 // positional option and keep the rest for the consume after. The above
698 // loop would have assigned no values to positional options in this case.
700 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
701 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
702 PositionalVals[ValNo].first,
703 PositionalVals[ValNo].second);
707 // Handle over all of the rest of the arguments to the
708 // cl::ConsumeAfter command line option...
709 for (; ValNo != PositionalVals.size(); ++ValNo)
710 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
711 PositionalVals[ValNo].first,
712 PositionalVals[ValNo].second);
715 // Loop over args and make sure all required args are specified!
716 for (StringMap<Option*>::iterator I = Opts.begin(),
717 E = Opts.end(); I != E; ++I) {
718 switch (I->second->getNumOccurrencesFlag()) {
721 if (I->second->getNumOccurrences() == 0) {
722 I->second->error("must be specified at least once!");
731 // Free all of the memory allocated to the map. Command line options may only
732 // be processed once!
734 PositionalOpts.clear();
737 // Free the memory allocated by ExpandResponseFiles.
738 if (ReadResponseFiles) {
739 // Free all the strdup()ed strings.
740 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
745 // If we had an error processing our arguments, don't let the program execute
746 if (ErrorParsing) exit(1);
749 //===----------------------------------------------------------------------===//
750 // Option Base class implementation
753 bool Option::error(const Twine &Message, StringRef ArgName) {
754 if (ArgName.data() == 0) ArgName = ArgStr;
756 errs() << HelpStr; // Be nice for positional arguments
758 errs() << ProgramName << ": for the -" << ArgName;
760 errs() << " option: " << Message << "\n";
764 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
765 StringRef Value, bool MultiArg) {
767 NumOccurrences++; // Increment the number of times we have been seen
769 switch (getNumOccurrencesFlag()) {
771 if (NumOccurrences > 1)
772 return error("may only occur zero or one times!", ArgName);
775 if (NumOccurrences > 1)
776 return error("must occur exactly one time!", ArgName);
780 case ConsumeAfter: break;
781 default: return error("bad num occurrences flag value!");
784 return handleOccurrence(pos, ArgName, Value);
788 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
789 // has been specified yet.
791 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
792 if (O.ValueStr[0] == 0) return DefaultMsg;
796 //===----------------------------------------------------------------------===//
797 // cl::alias class implementation
800 // Return the width of the option tag for printing...
801 size_t alias::getOptionWidth() const {
802 return std::strlen(ArgStr)+6;
805 // Print out the option for the alias.
806 void alias::printOptionInfo(size_t GlobalWidth) const {
807 size_t L = std::strlen(ArgStr);
808 errs() << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
814 //===----------------------------------------------------------------------===//
815 // Parser Implementation code...
818 // basic_parser implementation
821 // Return the width of the option tag for printing...
822 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
823 size_t Len = std::strlen(O.ArgStr);
824 if (const char *ValName = getValueName())
825 Len += std::strlen(getValueStr(O, ValName))+3;
830 // printOptionInfo - Print out information about this option. The
831 // to-be-maintained width is specified.
833 void basic_parser_impl::printOptionInfo(const Option &O,
834 size_t GlobalWidth) const {
835 outs() << " -" << O.ArgStr;
837 if (const char *ValName = getValueName())
838 outs() << "=<" << getValueStr(O, ValName) << '>';
840 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
846 // parser<bool> implementation
848 bool parser<bool>::parse(Option &O, StringRef ArgName,
849 StringRef Arg, bool &Value) {
850 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
856 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
860 return O.error("'" + Arg +
861 "' is invalid value for boolean argument! Try 0 or 1");
864 // parser<boolOrDefault> implementation
866 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
867 StringRef Arg, boolOrDefault &Value) {
868 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
873 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
878 return O.error("'" + Arg +
879 "' is invalid value for boolean argument! Try 0 or 1");
882 // parser<int> implementation
884 bool parser<int>::parse(Option &O, StringRef ArgName,
885 StringRef Arg, int &Value) {
886 if (Arg.getAsInteger(0, Value))
887 return O.error("'" + Arg + "' value invalid for integer argument!");
891 // parser<unsigned> implementation
893 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
894 StringRef Arg, unsigned &Value) {
896 if (Arg.getAsInteger(0, Value))
897 return O.error("'" + Arg + "' value invalid for uint argument!");
901 // parser<double>/parser<float> implementation
903 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
904 SmallString<32> TmpStr(Arg.begin(), Arg.end());
905 const char *ArgStart = TmpStr.c_str();
907 Value = strtod(ArgStart, &End);
909 return O.error("'" + Arg + "' value invalid for floating point argument!");
913 bool parser<double>::parse(Option &O, StringRef ArgName,
914 StringRef Arg, double &Val) {
915 return parseDouble(O, Arg, Val);
918 bool parser<float>::parse(Option &O, StringRef ArgName,
919 StringRef Arg, float &Val) {
921 if (parseDouble(O, Arg, dVal))
929 // generic_parser_base implementation
932 // findOption - Return the option number corresponding to the specified
933 // argument string. If the option is not found, getNumOptions() is returned.
935 unsigned generic_parser_base::findOption(const char *Name) {
936 unsigned e = getNumOptions();
938 for (unsigned i = 0; i != e; ++i) {
939 if (strcmp(getOption(i), Name) == 0)
946 // Return the width of the option tag for printing...
947 size_t generic_parser_base::getOptionWidth(const Option &O) const {
949 size_t Size = std::strlen(O.ArgStr)+6;
950 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
951 Size = std::max(Size, std::strlen(getOption(i))+8);
955 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
956 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
961 // printOptionInfo - Print out information about this option. The
962 // to-be-maintained width is specified.
964 void generic_parser_base::printOptionInfo(const Option &O,
965 size_t GlobalWidth) const {
967 size_t L = std::strlen(O.ArgStr);
968 outs() << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
969 << " - " << O.HelpStr << '\n';
971 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
972 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
973 outs() << " =" << getOption(i) << std::string(NumSpaces, ' ')
974 << " - " << getDescription(i) << '\n';
978 outs() << " " << O.HelpStr << "\n";
979 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
980 size_t L = std::strlen(getOption(i));
981 outs() << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
982 << " - " << getDescription(i) << "\n";
988 //===----------------------------------------------------------------------===//
989 // --help and --help-hidden option implementation
996 const Option *EmptyArg;
997 const bool ShowHidden;
999 // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
1000 inline static bool isHidden(Option *Opt) {
1001 return Opt->getOptionHiddenFlag() >= Hidden;
1003 inline static bool isReallyHidden(Option *Opt) {
1004 return Opt->getOptionHiddenFlag() == ReallyHidden;
1008 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1012 void operator=(bool Value) {
1013 if (Value == false) return;
1015 // Get all the options.
1016 std::vector<Option*> PositionalOpts;
1017 std::vector<Option*> SinkOpts;
1018 StringMap<Option*> OptMap;
1019 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1021 // Copy Options into a vector so we can sort them as we like...
1022 std::vector<Option*> Opts;
1023 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1025 Opts.push_back(I->second);
1028 // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
1029 Opts.erase(std::remove_if(Opts.begin(), Opts.end(),
1030 std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
1033 // Eliminate duplicate entries in table (from enum flags options, f.e.)
1034 { // Give OptionSet a scope
1035 std::set<Option*> OptionSet;
1036 for (unsigned i = 0; i != Opts.size(); ++i)
1037 if (OptionSet.count(Opts[i]) == 0)
1038 OptionSet.insert(Opts[i]); // Add new entry to set
1040 Opts.erase(Opts.begin()+i--); // Erase duplicate
1043 if (ProgramOverview)
1044 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1046 outs() << "USAGE: " << ProgramName << " [options]";
1048 // Print out the positional options.
1049 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1050 if (!PositionalOpts.empty() &&
1051 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1052 CAOpt = PositionalOpts[0];
1054 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1055 if (PositionalOpts[i]->ArgStr[0])
1056 outs() << " --" << PositionalOpts[i]->ArgStr;
1057 outs() << " " << PositionalOpts[i]->HelpStr;
1060 // Print the consume after option info if it exists...
1061 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1065 // Compute the maximum argument length...
1067 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1068 MaxArgLen = std::max(MaxArgLen, Opts[i]->getOptionWidth());
1070 outs() << "OPTIONS:\n";
1071 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1072 Opts[i]->printOptionInfo(MaxArgLen);
1074 // Print any extra help the user has declared.
1075 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1076 E = MoreHelp->end(); I != E; ++I)
1080 // Halt the program since help information was printed
1084 } // End anonymous namespace
1086 // Define the two HelpPrinter instances that are used to print out help, or
1089 static HelpPrinter NormalPrinter(false);
1090 static HelpPrinter HiddenPrinter(true);
1092 static cl::opt<HelpPrinter, true, parser<bool> >
1093 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1094 cl::location(NormalPrinter), cl::ValueDisallowed);
1096 static cl::opt<HelpPrinter, true, parser<bool> >
1097 HHOp("help-hidden", cl::desc("Display all available options"),
1098 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1100 static void (*OverrideVersionPrinter)() = 0;
1103 class VersionPrinter {
1106 outs() << "Low Level Virtual Machine (http://llvm.org/):\n"
1107 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1108 #ifdef LLVM_VERSION_INFO
1109 outs() << LLVM_VERSION_INFO;
1112 #ifndef __OPTIMIZE__
1113 outs() << "DEBUG build";
1115 outs() << "Optimized build";
1118 outs() << " with assertions";
1121 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1122 << " Host: " << sys::getHostTriple() << "\n"
1124 << " Registered Targets:\n";
1126 std::vector<std::pair<std::string, const Target*> > Targets;
1128 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1129 ie = TargetRegistry::end(); it != ie; ++it) {
1130 Targets.push_back(std::make_pair(it->getName(), &*it));
1131 Width = std::max(Width, Targets.back().first.length());
1133 std::sort(Targets.begin(), Targets.end());
1135 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1136 outs() << " " << Targets[i].first
1137 << std::string(Width - Targets[i].first.length(), ' ') << " - "
1138 << Targets[i].second->getShortDescription() << "\n";
1140 if (Targets.empty())
1141 outs() << " (none)\n";
1143 void operator=(bool OptionWasSpecified) {
1144 if (OptionWasSpecified) {
1145 if (OverrideVersionPrinter == 0) {
1149 (*OverrideVersionPrinter)();
1155 } // End anonymous namespace
1158 // Define the --version option that prints out the LLVM version for the tool
1159 static VersionPrinter VersionPrinterInstance;
1161 static cl::opt<VersionPrinter, true, parser<bool> >
1162 VersOp("version", cl::desc("Display the version of this program"),
1163 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1165 // Utility function for printing the help message.
1166 void cl::PrintHelpMessage() {
1167 // This looks weird, but it actually prints the help message. The
1168 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1169 // its operator= is invoked. That's because the "normal" usages of the
1170 // help printer is to be assigned true/false depending on whether the
1171 // --help option was given or not. Since we're circumventing that we have
1172 // to make it look like --help was given, so we assign true.
1173 NormalPrinter = true;
1176 /// Utility function for printing version number.
1177 void cl::PrintVersionMessage() {
1178 VersionPrinterInstance.print();
1181 void cl::SetVersionPrinter(void (*func)()) {
1182 OverrideVersionPrinter = func;