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(StringRef &Arg, StringRef &Value,
155 const StringMap<Option*> &OptionsMap) {
156 // Eat leading dashes.
157 while (!Arg.empty() && Arg[0] == '-')
160 // Reject all dashes.
161 if (Arg.empty()) return 0;
163 size_t EqualPos = Arg.find('=');
165 // If we have an equals sign, remember the value.
166 if (EqualPos != StringRef::npos) {
167 Value = Arg.substr(EqualPos+1);
168 Arg = Arg.substr(0, EqualPos);
171 // Look up the option.
172 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
173 return I != OptionsMap.end() ? I->second : 0;
176 /// ProvideOption - For Value, this differentiates between an empty value ("")
177 /// and a null value (StringRef()). The later is accepted for arguments that
178 /// don't allow a value (-foo) the former is rejected (-foo=).
179 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
180 StringRef Value, int argc, char **argv,
182 // Is this a multi-argument option?
183 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
185 // Enforce value requirements
186 switch (Handler->getValueExpectedFlag()) {
188 if (Value.data() == 0) { // No value specified?
190 return Handler->error("requires a value!");
191 // Steal the next argument, like for '-o filename'
195 case ValueDisallowed:
196 if (NumAdditionalVals > 0)
197 return Handler->error("multi-valued option specified"
198 " with ValueDisallowed modifier!");
201 return Handler->error("does not allow a value! '" +
202 Twine(Value) + "' specified.");
208 errs() << ProgramName
209 << ": Bad ValueMask flag! CommandLine usage error:"
210 << Handler->getValueExpectedFlag() << "\n";
214 // If this isn't a multi-arg option, just run the handler.
215 if (NumAdditionalVals == 0)
216 return Handler->addOccurrence(i, ArgName, Value);
218 // If it is, run the handle several times.
219 bool MultiArg = false;
222 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
228 while (NumAdditionalVals > 0) {
230 return Handler->error("not enough values!");
233 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
241 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
243 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
247 // Option predicates...
248 static inline bool isGrouping(const Option *O) {
249 return O->getFormattingFlag() == cl::Grouping;
251 static inline bool isPrefixedOrGrouping(const Option *O) {
252 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
255 // getOptionPred - Check to see if there are any options that satisfy the
256 // specified predicate with names that are the prefixes in Name. This is
257 // checked by progressively stripping characters off of the name, checking to
258 // see if there options that satisfy the predicate. If we find one, return it,
259 // otherwise return null.
261 static Option *getOptionPred(StringRef Name, size_t &Length,
262 bool (*Pred)(const Option*),
263 StringMap<Option*> &OptionsMap) {
265 StringMap<Option*>::iterator OMI = OptionsMap.find(Name);
266 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
267 Length = Name.size();
271 if (Name.size() == 1) return 0;
273 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
274 OMI = OptionsMap.find(Name);
276 // Loop while we haven't found an option and Name still has at least two
277 // characters in it (so that the next iteration will not be the empty
279 } while ((OMI == OptionsMap.end() || !Pred(OMI->second)) && Name.size() > 1);
281 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
282 Length = Name.size();
283 return OMI->second; // Found one!
285 return 0; // No option found!
288 static bool RequiresValue(const Option *O) {
289 return O->getNumOccurrencesFlag() == cl::Required ||
290 O->getNumOccurrencesFlag() == cl::OneOrMore;
293 static bool EatsUnboundedNumberOfValues(const Option *O) {
294 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
295 O->getNumOccurrencesFlag() == cl::OneOrMore;
298 /// ParseCStringVector - Break INPUT up wherever one or more
299 /// whitespace characters are found, and store the resulting tokens in
300 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
301 /// using strdup(), so it is the caller's responsibility to free()
304 static void ParseCStringVector(std::vector<char *> &OutputVector,
306 // Characters which will be treated as token separators:
307 StringRef Delims = " \v\f\t\r\n";
309 StringRef WorkStr(Input);
310 while (!WorkStr.empty()) {
311 // If the first character is a delimiter, strip them off.
312 if (Delims.find(WorkStr[0]) != StringRef::npos) {
313 size_t Pos = WorkStr.find_first_not_of(Delims);
314 if (Pos == StringRef::npos) Pos = WorkStr.size();
315 WorkStr = WorkStr.substr(Pos);
319 // Find position of first delimiter.
320 size_t Pos = WorkStr.find_first_of(Delims);
321 if (Pos == StringRef::npos) Pos = WorkStr.size();
323 // Everything from 0 to Pos is the next word to copy.
324 char *NewStr = (char*)malloc(Pos+1);
325 memcpy(NewStr, WorkStr.data(), Pos);
327 OutputVector.push_back(NewStr);
331 /// ParseEnvironmentOptions - An alternative entry point to the
332 /// CommandLine library, which allows you to read the program's name
333 /// from the caller (as PROGNAME) and its command-line arguments from
334 /// an environment variable (whose name is given in ENVVAR).
336 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
337 const char *Overview, bool ReadResponseFiles) {
339 assert(progName && "Program name not specified");
340 assert(envVar && "Environment variable name missing");
342 // Get the environment variable they want us to parse options out of.
343 const char *envValue = getenv(envVar);
347 // Get program's "name", which we wouldn't know without the caller
349 std::vector<char*> newArgv;
350 newArgv.push_back(strdup(progName));
352 // Parse the value of the environment variable into a "command line"
353 // and hand it off to ParseCommandLineOptions().
354 ParseCStringVector(newArgv, envValue);
355 int newArgc = static_cast<int>(newArgv.size());
356 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
358 // Free all the strdup()ed strings.
359 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
365 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
366 /// substituting the contents of the response files for the arguments
368 static void ExpandResponseFiles(int argc, char** argv,
369 std::vector<char*>& newArgv) {
370 for (int i = 1; i != argc; ++i) {
375 sys::PathWithStatus respFile(++arg);
377 // Check that the response file is not empty (mmap'ing empty
378 // files can be problematic).
379 const sys::FileStatus *FileStat = respFile.getFileStatus();
380 if (FileStat && FileStat->getSize() != 0) {
382 // Mmap the response file into memory.
383 OwningPtr<MemoryBuffer>
384 respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
386 // If we could open the file, parse its contents, otherwise
387 // pass the @file option verbatim.
389 // TODO: we should also support recursive loading of response files,
390 // since this is how gcc behaves. (From their man page: "The file may
391 // itself contain additional @file options; any such options will be
392 // processed recursively.")
394 if (respFilePtr != 0) {
395 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
400 newArgv.push_back(strdup(arg));
404 void cl::ParseCommandLineOptions(int argc, char **argv,
405 const char *Overview, bool ReadResponseFiles) {
406 // Process all registered options.
407 std::vector<Option*> PositionalOpts;
408 std::vector<Option*> SinkOpts;
409 StringMap<Option*> Opts;
410 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
412 assert((!Opts.empty() || !PositionalOpts.empty()) &&
413 "No options specified!");
415 // Expand response files.
416 std::vector<char*> newArgv;
417 if (ReadResponseFiles) {
418 newArgv.push_back(strdup(argv[0]));
419 ExpandResponseFiles(argc, argv, newArgv);
421 argc = static_cast<int>(newArgv.size());
424 // Copy the program name into ProgName, making sure not to overflow it.
425 std::string ProgName = sys::Path(argv[0]).getLast();
426 if (ProgName.size() > 79) ProgName.resize(79);
427 strcpy(ProgramName, ProgName.c_str());
429 ProgramOverview = Overview;
430 bool ErrorParsing = false;
432 // Check out the positional arguments to collect information about them.
433 unsigned NumPositionalRequired = 0;
435 // Determine whether or not there are an unlimited number of positionals
436 bool HasUnlimitedPositionals = false;
438 Option *ConsumeAfterOpt = 0;
439 if (!PositionalOpts.empty()) {
440 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
441 assert(PositionalOpts.size() > 1 &&
442 "Cannot specify cl::ConsumeAfter without a positional argument!");
443 ConsumeAfterOpt = PositionalOpts[0];
446 // Calculate how many positional values are _required_.
447 bool UnboundedFound = false;
448 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
450 Option *Opt = PositionalOpts[i];
451 if (RequiresValue(Opt))
452 ++NumPositionalRequired;
453 else if (ConsumeAfterOpt) {
454 // ConsumeAfter cannot be combined with "optional" positional options
455 // unless there is only one positional argument...
456 if (PositionalOpts.size() > 2)
458 Opt->error("error - this positional option will never be matched, "
459 "because it does not Require a value, and a "
460 "cl::ConsumeAfter option is active!");
461 } else if (UnboundedFound && !Opt->ArgStr[0]) {
462 // This option does not "require" a value... Make sure this option is
463 // not specified after an option that eats all extra arguments, or this
464 // one will never get any!
466 ErrorParsing |= Opt->error("error - option can never match, because "
467 "another positional argument will match an "
468 "unbounded number of values, and this option"
469 " does not require a value!");
471 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
473 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
476 // PositionalVals - A vector of "positional" arguments we accumulate into
477 // the process at the end.
479 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
481 // If the program has named positional arguments, and the name has been run
482 // across, keep track of which positional argument was named. Otherwise put
483 // the positional args into the PositionalVals list...
484 Option *ActivePositionalArg = 0;
486 // Loop over all of the arguments... processing them.
487 bool DashDashFound = false; // Have we read '--'?
488 for (int i = 1; i < argc; ++i) {
491 StringRef ArgName = "";
493 // If the option list changed, this means that some command line
494 // option has just been registered or deregistered. This can occur in
495 // response to things like -load, etc. If this happens, rescan the options.
496 if (OptionListChanged) {
497 PositionalOpts.clear();
500 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
501 OptionListChanged = false;
504 // Check to see if this is a positional argument. This argument is
505 // considered to be positional if it doesn't start with '-', if it is "-"
506 // itself, or if we have seen "--" already.
508 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
509 // Positional argument!
510 if (ActivePositionalArg) {
511 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
512 continue; // We are done!
515 if (!PositionalOpts.empty()) {
516 PositionalVals.push_back(std::make_pair(argv[i],i));
518 // All of the positional arguments have been fulfulled, give the rest to
519 // the consume after option... if it's specified...
521 if (PositionalVals.size() >= NumPositionalRequired &&
522 ConsumeAfterOpt != 0) {
523 for (++i; i < argc; ++i)
524 PositionalVals.push_back(std::make_pair(argv[i],i));
525 break; // Handle outside of the argument processing loop...
528 // Delay processing positional arguments until the end...
531 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
533 DashDashFound = true; // This is the mythical "--"?
534 continue; // Don't try to process it as an argument itself.
535 } else if (ActivePositionalArg &&
536 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
537 // If there is a positional argument eating options, check to see if this
538 // option is another positional argument. If so, treat it as an argument,
539 // otherwise feed it to the eating positional.
541 Handler = LookupOption(ArgName, Value, Opts);
542 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
543 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
544 continue; // We are done!
547 } else { // We start with a '-', must be an argument.
549 Handler = LookupOption(ArgName, Value, Opts);
551 // Check to see if this "option" is really a prefixed or grouped argument.
553 StringRef RealName(ArgName);
554 if (RealName.size() > 1) {
557 getOptionPred(RealName, Length, isPrefixedOrGrouping, Opts);
559 // If the option is a prefixed option, then the value is simply the
560 // rest of the name... so fall through to later processing, by
561 // setting up the argument name flags and value fields.
562 if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
563 Value = ArgName.substr(Length);
564 assert(Opts.count(ArgName.substr(0, Length)) &&
565 Opts[ArgName.substr(0, Length)] == PGOpt);
568 // This must be a grouped option... handle them now.
569 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
572 // Move current arg name out of RealName into RealArgName.
573 StringRef RealArgName = RealName.substr(0, Length);
574 RealName = RealName.substr(Length);
576 // Because ValueRequired is an invalid flag for grouped arguments,
577 // we don't need to pass argc/argv in.
579 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
580 "Option can not be cl::Grouping AND cl::ValueRequired!");
582 ErrorParsing |= ProvideOption(PGOpt, RealArgName,
583 StringRef(), 0, 0, Dummy);
585 // Get the next grouping option.
586 PGOpt = getOptionPred(RealName, Length, isGrouping, Opts);
587 } while (PGOpt && Length != RealName.size());
589 Handler = PGOpt; // Ate all of the options.
596 if (SinkOpts.empty()) {
597 errs() << ProgramName << ": Unknown command line argument '"
598 << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
601 for (std::vector<Option*>::iterator I = SinkOpts.begin(),
602 E = SinkOpts.end(); I != E ; ++I)
603 (*I)->addOccurrence(i, "", argv[i]);
608 // Check to see if this option accepts a comma separated list of values. If
609 // it does, we have to split up the value into multiple values.
610 if (Handler->getMiscFlags() & CommaSeparated) {
611 StringRef Val(Value);
612 StringRef::size_type Pos = Val.find(',');
614 while (Pos != StringRef::npos) {
615 // Process the portion before the comma.
616 ErrorParsing |= ProvideOption(Handler, ArgName, Val.substr(0, Pos),
618 // Erase the portion before the comma, AND the comma.
619 Val = Val.substr(Pos+1);
620 Value.substr(Pos+1); // Increment the original value pointer as well.
622 // Check for another comma.
627 // If this is a named positional argument, just remember that it is the
629 if (Handler->getFormattingFlag() == cl::Positional)
630 ActivePositionalArg = Handler;
632 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
635 // Check and handle positional arguments now...
636 if (NumPositionalRequired > PositionalVals.size()) {
637 errs() << ProgramName
638 << ": Not enough positional command line arguments specified!\n"
639 << "Must specify at least " << NumPositionalRequired
640 << " positional arguments: See: " << argv[0] << " --help\n";
643 } else if (!HasUnlimitedPositionals
644 && PositionalVals.size() > PositionalOpts.size()) {
645 errs() << ProgramName
646 << ": Too many positional arguments specified!\n"
647 << "Can specify at most " << PositionalOpts.size()
648 << " positional arguments: See: " << argv[0] << " --help\n";
651 } else if (ConsumeAfterOpt == 0) {
652 // Positional args have already been handled if ConsumeAfter is specified...
653 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
654 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
655 if (RequiresValue(PositionalOpts[i])) {
656 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
657 PositionalVals[ValNo].second);
659 --NumPositionalRequired; // We fulfilled our duty...
662 // If we _can_ give this option more arguments, do so now, as long as we
663 // do not give it values that others need. 'Done' controls whether the
664 // option even _WANTS_ any more.
666 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
667 while (NumVals-ValNo > NumPositionalRequired && !Done) {
668 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
670 Done = true; // Optional arguments want _at most_ one value
672 case cl::ZeroOrMore: // Zero or more will take all they can get...
673 case cl::OneOrMore: // One or more will take all they can get...
674 ProvidePositionalOption(PositionalOpts[i],
675 PositionalVals[ValNo].first,
676 PositionalVals[ValNo].second);
680 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
681 "positional argument processing!");
686 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
688 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
689 if (RequiresValue(PositionalOpts[j])) {
690 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
691 PositionalVals[ValNo].first,
692 PositionalVals[ValNo].second);
696 // Handle the case where there is just one positional option, and it's
697 // optional. In this case, we want to give JUST THE FIRST option to the
698 // positional option and keep the rest for the consume after. The above
699 // loop would have assigned no values to positional options in this case.
701 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
702 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
703 PositionalVals[ValNo].first,
704 PositionalVals[ValNo].second);
708 // Handle over all of the rest of the arguments to the
709 // cl::ConsumeAfter command line option...
710 for (; ValNo != PositionalVals.size(); ++ValNo)
711 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
712 PositionalVals[ValNo].first,
713 PositionalVals[ValNo].second);
716 // Loop over args and make sure all required args are specified!
717 for (StringMap<Option*>::iterator I = Opts.begin(),
718 E = Opts.end(); I != E; ++I) {
719 switch (I->second->getNumOccurrencesFlag()) {
722 if (I->second->getNumOccurrences() == 0) {
723 I->second->error("must be specified at least once!");
732 // Free all of the memory allocated to the map. Command line options may only
733 // be processed once!
735 PositionalOpts.clear();
738 // Free the memory allocated by ExpandResponseFiles.
739 if (ReadResponseFiles) {
740 // Free all the strdup()ed strings.
741 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
746 // If we had an error processing our arguments, don't let the program execute
747 if (ErrorParsing) exit(1);
750 //===----------------------------------------------------------------------===//
751 // Option Base class implementation
754 bool Option::error(const Twine &Message, StringRef ArgName) {
755 if (ArgName.data() == 0) ArgName = ArgStr;
757 errs() << HelpStr; // Be nice for positional arguments
759 errs() << ProgramName << ": for the -" << ArgName;
761 errs() << " option: " << Message << "\n";
765 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
766 StringRef Value, bool MultiArg) {
768 NumOccurrences++; // Increment the number of times we have been seen
770 switch (getNumOccurrencesFlag()) {
772 if (NumOccurrences > 1)
773 return error("may only occur zero or one times!", ArgName);
776 if (NumOccurrences > 1)
777 return error("must occur exactly one time!", ArgName);
781 case ConsumeAfter: break;
782 default: return error("bad num occurrences flag value!");
785 return handleOccurrence(pos, ArgName, Value);
789 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
790 // has been specified yet.
792 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
793 if (O.ValueStr[0] == 0) return DefaultMsg;
797 //===----------------------------------------------------------------------===//
798 // cl::alias class implementation
801 // Return the width of the option tag for printing...
802 size_t alias::getOptionWidth() const {
803 return std::strlen(ArgStr)+6;
806 // Print out the option for the alias.
807 void alias::printOptionInfo(size_t GlobalWidth) const {
808 size_t L = std::strlen(ArgStr);
809 errs() << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
815 //===----------------------------------------------------------------------===//
816 // Parser Implementation code...
819 // basic_parser implementation
822 // Return the width of the option tag for printing...
823 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
824 size_t Len = std::strlen(O.ArgStr);
825 if (const char *ValName = getValueName())
826 Len += std::strlen(getValueStr(O, ValName))+3;
831 // printOptionInfo - Print out information about this option. The
832 // to-be-maintained width is specified.
834 void basic_parser_impl::printOptionInfo(const Option &O,
835 size_t GlobalWidth) const {
836 outs() << " -" << O.ArgStr;
838 if (const char *ValName = getValueName())
839 outs() << "=<" << getValueStr(O, ValName) << '>';
841 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
847 // parser<bool> implementation
849 bool parser<bool>::parse(Option &O, StringRef ArgName,
850 StringRef Arg, bool &Value) {
851 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
857 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
861 return O.error("'" + Arg +
862 "' is invalid value for boolean argument! Try 0 or 1");
865 // parser<boolOrDefault> implementation
867 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
868 StringRef Arg, boolOrDefault &Value) {
869 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
874 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
879 return O.error("'" + Arg +
880 "' is invalid value for boolean argument! Try 0 or 1");
883 // parser<int> implementation
885 bool parser<int>::parse(Option &O, StringRef ArgName,
886 StringRef Arg, int &Value) {
887 if (Arg.getAsInteger(0, Value))
888 return O.error("'" + Arg + "' value invalid for integer argument!");
892 // parser<unsigned> implementation
894 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
895 StringRef Arg, unsigned &Value) {
897 if (Arg.getAsInteger(0, Value))
898 return O.error("'" + Arg + "' value invalid for uint argument!");
902 // parser<double>/parser<float> implementation
904 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
905 SmallString<32> TmpStr(Arg.begin(), Arg.end());
906 const char *ArgStart = TmpStr.c_str();
908 Value = strtod(ArgStart, &End);
910 return O.error("'" + Arg + "' value invalid for floating point argument!");
914 bool parser<double>::parse(Option &O, StringRef ArgName,
915 StringRef Arg, double &Val) {
916 return parseDouble(O, Arg, Val);
919 bool parser<float>::parse(Option &O, StringRef ArgName,
920 StringRef Arg, float &Val) {
922 if (parseDouble(O, Arg, dVal))
930 // generic_parser_base implementation
933 // findOption - Return the option number corresponding to the specified
934 // argument string. If the option is not found, getNumOptions() is returned.
936 unsigned generic_parser_base::findOption(const char *Name) {
937 unsigned e = getNumOptions();
939 for (unsigned i = 0; i != e; ++i) {
940 if (strcmp(getOption(i), Name) == 0)
947 // Return the width of the option tag for printing...
948 size_t generic_parser_base::getOptionWidth(const Option &O) const {
950 size_t Size = std::strlen(O.ArgStr)+6;
951 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
952 Size = std::max(Size, std::strlen(getOption(i))+8);
956 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
957 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
962 // printOptionInfo - Print out information about this option. The
963 // to-be-maintained width is specified.
965 void generic_parser_base::printOptionInfo(const Option &O,
966 size_t GlobalWidth) const {
968 size_t L = std::strlen(O.ArgStr);
969 outs() << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
970 << " - " << O.HelpStr << '\n';
972 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
973 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
974 outs() << " =" << getOption(i) << std::string(NumSpaces, ' ')
975 << " - " << getDescription(i) << '\n';
979 outs() << " " << O.HelpStr << "\n";
980 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
981 size_t L = std::strlen(getOption(i));
982 outs() << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
983 << " - " << getDescription(i) << "\n";
989 //===----------------------------------------------------------------------===//
990 // --help and --help-hidden option implementation
997 const Option *EmptyArg;
998 const bool ShowHidden;
1000 // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
1001 inline static bool isHidden(Option *Opt) {
1002 return Opt->getOptionHiddenFlag() >= Hidden;
1004 inline static bool isReallyHidden(Option *Opt) {
1005 return Opt->getOptionHiddenFlag() == ReallyHidden;
1009 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1013 void operator=(bool Value) {
1014 if (Value == false) return;
1016 // Get all the options.
1017 std::vector<Option*> PositionalOpts;
1018 std::vector<Option*> SinkOpts;
1019 StringMap<Option*> OptMap;
1020 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1022 // Copy Options into a vector so we can sort them as we like...
1023 std::vector<Option*> Opts;
1024 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1026 Opts.push_back(I->second);
1029 // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
1030 Opts.erase(std::remove_if(Opts.begin(), Opts.end(),
1031 std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
1034 // Eliminate duplicate entries in table (from enum flags options, f.e.)
1035 { // Give OptionSet a scope
1036 std::set<Option*> OptionSet;
1037 for (unsigned i = 0; i != Opts.size(); ++i)
1038 if (OptionSet.count(Opts[i]) == 0)
1039 OptionSet.insert(Opts[i]); // Add new entry to set
1041 Opts.erase(Opts.begin()+i--); // Erase duplicate
1044 if (ProgramOverview)
1045 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1047 outs() << "USAGE: " << ProgramName << " [options]";
1049 // Print out the positional options.
1050 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1051 if (!PositionalOpts.empty() &&
1052 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1053 CAOpt = PositionalOpts[0];
1055 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1056 if (PositionalOpts[i]->ArgStr[0])
1057 outs() << " --" << PositionalOpts[i]->ArgStr;
1058 outs() << " " << PositionalOpts[i]->HelpStr;
1061 // Print the consume after option info if it exists...
1062 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1066 // Compute the maximum argument length...
1068 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1069 MaxArgLen = std::max(MaxArgLen, Opts[i]->getOptionWidth());
1071 outs() << "OPTIONS:\n";
1072 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1073 Opts[i]->printOptionInfo(MaxArgLen);
1075 // Print any extra help the user has declared.
1076 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1077 E = MoreHelp->end(); I != E; ++I)
1081 // Halt the program since help information was printed
1085 } // End anonymous namespace
1087 // Define the two HelpPrinter instances that are used to print out help, or
1090 static HelpPrinter NormalPrinter(false);
1091 static HelpPrinter HiddenPrinter(true);
1093 static cl::opt<HelpPrinter, true, parser<bool> >
1094 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1095 cl::location(NormalPrinter), cl::ValueDisallowed);
1097 static cl::opt<HelpPrinter, true, parser<bool> >
1098 HHOp("help-hidden", cl::desc("Display all available options"),
1099 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1101 static void (*OverrideVersionPrinter)() = 0;
1104 class VersionPrinter {
1107 outs() << "Low Level Virtual Machine (http://llvm.org/):\n"
1108 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1109 #ifdef LLVM_VERSION_INFO
1110 outs() << LLVM_VERSION_INFO;
1113 #ifndef __OPTIMIZE__
1114 outs() << "DEBUG build";
1116 outs() << "Optimized build";
1119 outs() << " with assertions";
1122 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1123 << " Host: " << sys::getHostTriple() << "\n"
1125 << " Registered Targets:\n";
1127 std::vector<std::pair<std::string, const Target*> > Targets;
1129 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1130 ie = TargetRegistry::end(); it != ie; ++it) {
1131 Targets.push_back(std::make_pair(it->getName(), &*it));
1132 Width = std::max(Width, Targets.back().first.length());
1134 std::sort(Targets.begin(), Targets.end());
1136 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1137 outs() << " " << Targets[i].first
1138 << std::string(Width - Targets[i].first.length(), ' ') << " - "
1139 << Targets[i].second->getShortDescription() << "\n";
1141 if (Targets.empty())
1142 outs() << " (none)\n";
1144 void operator=(bool OptionWasSpecified) {
1145 if (OptionWasSpecified) {
1146 if (OverrideVersionPrinter == 0) {
1150 (*OverrideVersionPrinter)();
1156 } // End anonymous namespace
1159 // Define the --version option that prints out the LLVM version for the tool
1160 static VersionPrinter VersionPrinterInstance;
1162 static cl::opt<VersionPrinter, true, parser<bool> >
1163 VersOp("version", cl::desc("Display the version of this program"),
1164 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1166 // Utility function for printing the help message.
1167 void cl::PrintHelpMessage() {
1168 // This looks weird, but it actually prints the help message. The
1169 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1170 // its operator= is invoked. That's because the "normal" usages of the
1171 // help printer is to be assigned true/false depending on whether the
1172 // --help option was given or not. Since we're circumventing that we have
1173 // to make it look like --help was given, so we assign true.
1174 NormalPrinter = true;
1177 /// Utility function for printing version number.
1178 void cl::PrintVersionMessage() {
1179 VersionPrinterInstance.print();
1182 void cl::SetVersionPrinter(void (*func)()) {
1183 OverrideVersionPrinter = func;