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/Debug.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/system_error.h"
26 #include "llvm/Target/TargetRegistry.h"
27 #include "llvm/Support/Host.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/ADT/OwningPtr.h"
30 #include "llvm/ADT/SmallPtrSet.h"
31 #include "llvm/ADT/SmallString.h"
32 #include "llvm/ADT/StringMap.h"
33 #include "llvm/ADT/Twine.h"
34 #include "llvm/Config/config.h"
40 //===----------------------------------------------------------------------===//
41 // Template instantiations and anchors.
43 namespace llvm { namespace cl {
44 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
45 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
46 TEMPLATE_INSTANTIATION(class basic_parser<int>);
47 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
48 TEMPLATE_INSTANTIATION(class basic_parser<double>);
49 TEMPLATE_INSTANTIATION(class basic_parser<float>);
50 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
51 TEMPLATE_INSTANTIATION(class basic_parser<char>);
53 TEMPLATE_INSTANTIATION(class opt<unsigned>);
54 TEMPLATE_INSTANTIATION(class opt<int>);
55 TEMPLATE_INSTANTIATION(class opt<std::string>);
56 TEMPLATE_INSTANTIATION(class opt<char>);
57 TEMPLATE_INSTANTIATION(class opt<bool>);
58 } } // end namespace llvm::cl
60 void Option::anchor() {}
61 void basic_parser_impl::anchor() {}
62 void parser<bool>::anchor() {}
63 void parser<boolOrDefault>::anchor() {}
64 void parser<int>::anchor() {}
65 void parser<unsigned>::anchor() {}
66 void parser<double>::anchor() {}
67 void parser<float>::anchor() {}
68 void parser<std::string>::anchor() {}
69 void parser<char>::anchor() {}
71 //===----------------------------------------------------------------------===//
73 // Globals for name and overview of program. Program name is not a string to
74 // avoid static ctor/dtor issues.
75 static char ProgramName[80] = "<premain>";
76 static const char *ProgramOverview = 0;
78 // This collects additional help to be printed.
79 static ManagedStatic<std::vector<const char*> > MoreHelp;
81 extrahelp::extrahelp(const char *Help)
83 MoreHelp->push_back(Help);
86 static bool OptionListChanged = false;
88 // MarkOptionsChanged - Internal helper function.
89 void cl::MarkOptionsChanged() {
90 OptionListChanged = true;
93 /// RegisteredOptionList - This is the list of the command line options that
94 /// have statically constructed themselves.
95 static Option *RegisteredOptionList = 0;
97 void Option::addArgument() {
98 assert(NextRegistered == 0 && "argument multiply registered!");
100 NextRegistered = RegisteredOptionList;
101 RegisteredOptionList = this;
102 MarkOptionsChanged();
106 //===----------------------------------------------------------------------===//
107 // Basic, shared command line option processing machinery.
110 /// GetOptionInfo - Scan the list of registered options, turning them into data
111 /// structures that are easier to handle.
112 static void GetOptionInfo(SmallVectorImpl<Option*> &PositionalOpts,
113 SmallVectorImpl<Option*> &SinkOpts,
114 StringMap<Option*> &OptionsMap) {
115 SmallVector<const char*, 16> OptionNames;
116 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
117 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
118 // If this option wants to handle multiple option names, get the full set.
119 // This handles enum options like "-O1 -O2" etc.
120 O->getExtraOptionNames(OptionNames);
122 OptionNames.push_back(O->ArgStr);
124 // Handle named options.
125 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
126 // Add argument to the argument map!
127 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
128 errs() << ProgramName << ": CommandLine Error: Argument '"
129 << OptionNames[i] << "' defined more than once!\n";
135 // Remember information about positional options.
136 if (O->getFormattingFlag() == cl::Positional)
137 PositionalOpts.push_back(O);
138 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
139 SinkOpts.push_back(O);
140 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
142 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
148 PositionalOpts.push_back(CAOpt);
150 // Make sure that they are in order of registration not backwards.
151 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
155 /// LookupOption - Lookup the option specified by the specified option on the
156 /// command line. If there is a value specified (after an equal sign) return
157 /// that as well. This assumes that leading dashes have already been stripped.
158 static Option *LookupOption(StringRef &Arg, StringRef &Value,
159 const StringMap<Option*> &OptionsMap) {
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 // Look up the option.
168 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
169 return I != OptionsMap.end() ? I->second : 0;
172 // If the argument before the = is a valid option name, we match. If not,
173 // return Arg unmolested.
174 StringMap<Option*>::const_iterator I =
175 OptionsMap.find(Arg.substr(0, EqualPos));
176 if (I == OptionsMap.end()) return 0;
178 Value = Arg.substr(EqualPos+1);
179 Arg = Arg.substr(0, EqualPos);
183 /// LookupNearestOption - Lookup the closest match to the option specified by
184 /// the specified option on the command line. If there is a value specified
185 /// (after an equal sign) return that as well. This assumes that leading dashes
186 /// have already been stripped.
187 static Option *LookupNearestOption(StringRef Arg,
188 const StringMap<Option*> &OptionsMap) {
189 // Reject all dashes.
190 if (Arg.empty()) return 0;
192 // Split on any equal sign.
193 StringRef LHS = Arg.split('=').first;
195 // Find the closest match.
197 unsigned BestDistance = 0;
198 for (StringMap<Option*>::const_iterator it = OptionsMap.begin(),
199 ie = OptionsMap.end(); it != ie; ++it) {
200 unsigned Distance = StringRef(it->second->ArgStr).edit_distance(
201 Arg, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
202 if (!Best || Distance < BestDistance) {
204 BestDistance = Distance;
211 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
212 /// does special handling of cl::CommaSeparated options.
213 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
215 StringRef Value, bool MultiArg = false)
217 // Check to see if this option accepts a comma separated list of values. If
218 // it does, we have to split up the value into multiple values.
219 if (Handler->getMiscFlags() & CommaSeparated) {
220 StringRef Val(Value);
221 StringRef::size_type Pos = Val.find(',');
223 while (Pos != StringRef::npos) {
224 // Process the portion before the comma.
225 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
227 // Erase the portion before the comma, AND the comma.
228 Val = Val.substr(Pos+1);
229 Value.substr(Pos+1); // Increment the original value pointer as well.
230 // Check for another comma.
237 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
243 /// ProvideOption - For Value, this differentiates between an empty value ("")
244 /// and a null value (StringRef()). The later is accepted for arguments that
245 /// don't allow a value (-foo) the former is rejected (-foo=).
246 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
247 StringRef Value, int argc, char **argv,
249 // Is this a multi-argument option?
250 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
252 // Enforce value requirements
253 switch (Handler->getValueExpectedFlag()) {
255 if (Value.data() == 0) { // No value specified?
257 return Handler->error("requires a value!");
258 // Steal the next argument, like for '-o filename'
262 case ValueDisallowed:
263 if (NumAdditionalVals > 0)
264 return Handler->error("multi-valued option specified"
265 " with ValueDisallowed modifier!");
268 return Handler->error("does not allow a value! '" +
269 Twine(Value) + "' specified.");
275 errs() << ProgramName
276 << ": Bad ValueMask flag! CommandLine usage error:"
277 << Handler->getValueExpectedFlag() << "\n";
281 // If this isn't a multi-arg option, just run the handler.
282 if (NumAdditionalVals == 0)
283 return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
285 // If it is, run the handle several times.
286 bool MultiArg = false;
289 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
295 while (NumAdditionalVals > 0) {
297 return Handler->error("not enough values!");
300 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
308 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
310 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
314 // Option predicates...
315 static inline bool isGrouping(const Option *O) {
316 return O->getFormattingFlag() == cl::Grouping;
318 static inline bool isPrefixedOrGrouping(const Option *O) {
319 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
322 // getOptionPred - Check to see if there are any options that satisfy the
323 // specified predicate with names that are the prefixes in Name. This is
324 // checked by progressively stripping characters off of the name, checking to
325 // see if there options that satisfy the predicate. If we find one, return it,
326 // otherwise return null.
328 static Option *getOptionPred(StringRef Name, size_t &Length,
329 bool (*Pred)(const Option*),
330 const StringMap<Option*> &OptionsMap) {
332 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
334 // Loop while we haven't found an option and Name still has at least two
335 // characters in it (so that the next iteration will not be the empty
337 while (OMI == OptionsMap.end() && Name.size() > 1) {
338 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
339 OMI = OptionsMap.find(Name);
342 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
343 Length = Name.size();
344 return OMI->second; // Found one!
346 return 0; // No option found!
349 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
350 /// with at least one '-') does not fully match an available option. Check to
351 /// see if this is a prefix or grouped option. If so, split arg into output an
352 /// Arg/Value pair and return the Option to parse it with.
353 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
355 const StringMap<Option*> &OptionsMap) {
356 if (Arg.size() == 1) return 0;
360 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
361 if (PGOpt == 0) return 0;
363 // If the option is a prefixed option, then the value is simply the
364 // rest of the name... so fall through to later processing, by
365 // setting up the argument name flags and value fields.
366 if (PGOpt->getFormattingFlag() == cl::Prefix) {
367 Value = Arg.substr(Length);
368 Arg = Arg.substr(0, Length);
369 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
373 // This must be a grouped option... handle them now. Grouping options can't
375 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
378 // Move current arg name out of Arg into OneArgName.
379 StringRef OneArgName = Arg.substr(0, Length);
380 Arg = Arg.substr(Length);
382 // Because ValueRequired is an invalid flag for grouped arguments,
383 // we don't need to pass argc/argv in.
384 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
385 "Option can not be cl::Grouping AND cl::ValueRequired!");
387 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
388 StringRef(), 0, 0, Dummy);
390 // Get the next grouping option.
391 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
392 } while (PGOpt && Length != Arg.size());
394 // Return the last option with Arg cut down to just the last one.
400 static bool RequiresValue(const Option *O) {
401 return O->getNumOccurrencesFlag() == cl::Required ||
402 O->getNumOccurrencesFlag() == cl::OneOrMore;
405 static bool EatsUnboundedNumberOfValues(const Option *O) {
406 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
407 O->getNumOccurrencesFlag() == cl::OneOrMore;
410 /// ParseCStringVector - Break INPUT up wherever one or more
411 /// whitespace characters are found, and store the resulting tokens in
412 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
413 /// using strdup(), so it is the caller's responsibility to free()
416 static void ParseCStringVector(std::vector<char *> &OutputVector,
418 // Characters which will be treated as token separators:
419 StringRef Delims = " \v\f\t\r\n";
421 StringRef WorkStr(Input);
422 while (!WorkStr.empty()) {
423 // If the first character is a delimiter, strip them off.
424 if (Delims.find(WorkStr[0]) != StringRef::npos) {
425 size_t Pos = WorkStr.find_first_not_of(Delims);
426 if (Pos == StringRef::npos) Pos = WorkStr.size();
427 WorkStr = WorkStr.substr(Pos);
431 // Find position of first delimiter.
432 size_t Pos = WorkStr.find_first_of(Delims);
433 if (Pos == StringRef::npos) Pos = WorkStr.size();
435 // Everything from 0 to Pos is the next word to copy.
436 char *NewStr = (char*)malloc(Pos+1);
437 memcpy(NewStr, WorkStr.data(), Pos);
439 OutputVector.push_back(NewStr);
441 WorkStr = WorkStr.substr(Pos);
445 /// ParseEnvironmentOptions - An alternative entry point to the
446 /// CommandLine library, which allows you to read the program's name
447 /// from the caller (as PROGNAME) and its command-line arguments from
448 /// an environment variable (whose name is given in ENVVAR).
450 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
451 const char *Overview, bool ReadResponseFiles) {
453 assert(progName && "Program name not specified");
454 assert(envVar && "Environment variable name missing");
456 // Get the environment variable they want us to parse options out of.
457 const char *envValue = getenv(envVar);
461 // Get program's "name", which we wouldn't know without the caller
463 std::vector<char*> newArgv;
464 newArgv.push_back(strdup(progName));
466 // Parse the value of the environment variable into a "command line"
467 // and hand it off to ParseCommandLineOptions().
468 ParseCStringVector(newArgv, envValue);
469 int newArgc = static_cast<int>(newArgv.size());
470 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
472 // Free all the strdup()ed strings.
473 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
479 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
480 /// substituting the contents of the response files for the arguments
482 static void ExpandResponseFiles(unsigned argc, char** argv,
483 std::vector<char*>& newArgv) {
484 for (unsigned i = 1; i != argc; ++i) {
488 sys::PathWithStatus respFile(++arg);
490 // Check that the response file is not empty (mmap'ing empty
491 // files can be problematic).
492 const sys::FileStatus *FileStat = respFile.getFileStatus();
493 if (FileStat && FileStat->getSize() != 0) {
495 // If we could open the file, parse its contents, otherwise
496 // pass the @file option verbatim.
498 // TODO: we should also support recursive loading of response files,
499 // since this is how gcc behaves. (From their man page: "The file may
500 // itself contain additional @file options; any such options will be
501 // processed recursively.")
503 // Mmap the response file into memory.
504 OwningPtr<MemoryBuffer> respFilePtr;
505 if (!MemoryBuffer::getFile(respFile.c_str(), respFilePtr)) {
506 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
511 newArgv.push_back(strdup(arg));
515 void cl::ParseCommandLineOptions(int argc, char **argv,
516 const char *Overview, bool ReadResponseFiles) {
517 // Process all registered options.
518 SmallVector<Option*, 4> PositionalOpts;
519 SmallVector<Option*, 4> SinkOpts;
520 StringMap<Option*> Opts;
521 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
523 assert((!Opts.empty() || !PositionalOpts.empty()) &&
524 "No options specified!");
526 // Expand response files.
527 std::vector<char*> newArgv;
528 if (ReadResponseFiles) {
529 newArgv.push_back(strdup(argv[0]));
530 ExpandResponseFiles(argc, argv, newArgv);
532 argc = static_cast<int>(newArgv.size());
535 // Copy the program name into ProgName, making sure not to overflow it.
536 std::string ProgName = sys::path::filename(argv[0]);
537 size_t Len = std::min(ProgName.size(), size_t(79));
538 memcpy(ProgramName, ProgName.data(), Len);
539 ProgramName[Len] = '\0';
541 ProgramOverview = Overview;
542 bool ErrorParsing = false;
544 // Check out the positional arguments to collect information about them.
545 unsigned NumPositionalRequired = 0;
547 // Determine whether or not there are an unlimited number of positionals
548 bool HasUnlimitedPositionals = false;
550 Option *ConsumeAfterOpt = 0;
551 if (!PositionalOpts.empty()) {
552 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
553 assert(PositionalOpts.size() > 1 &&
554 "Cannot specify cl::ConsumeAfter without a positional argument!");
555 ConsumeAfterOpt = PositionalOpts[0];
558 // Calculate how many positional values are _required_.
559 bool UnboundedFound = false;
560 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
562 Option *Opt = PositionalOpts[i];
563 if (RequiresValue(Opt))
564 ++NumPositionalRequired;
565 else if (ConsumeAfterOpt) {
566 // ConsumeAfter cannot be combined with "optional" positional options
567 // unless there is only one positional argument...
568 if (PositionalOpts.size() > 2)
570 Opt->error("error - this positional option will never be matched, "
571 "because it does not Require a value, and a "
572 "cl::ConsumeAfter option is active!");
573 } else if (UnboundedFound && !Opt->ArgStr[0]) {
574 // This option does not "require" a value... Make sure this option is
575 // not specified after an option that eats all extra arguments, or this
576 // one will never get any!
578 ErrorParsing |= Opt->error("error - option can never match, because "
579 "another positional argument will match an "
580 "unbounded number of values, and this option"
581 " does not require a value!");
583 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
585 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
588 // PositionalVals - A vector of "positional" arguments we accumulate into
589 // the process at the end.
591 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
593 // If the program has named positional arguments, and the name has been run
594 // across, keep track of which positional argument was named. Otherwise put
595 // the positional args into the PositionalVals list...
596 Option *ActivePositionalArg = 0;
598 // Loop over all of the arguments... processing them.
599 bool DashDashFound = false; // Have we read '--'?
600 for (int i = 1; i < argc; ++i) {
602 Option *NearestHandler = 0;
604 StringRef ArgName = "";
606 // If the option list changed, this means that some command line
607 // option has just been registered or deregistered. This can occur in
608 // response to things like -load, etc. If this happens, rescan the options.
609 if (OptionListChanged) {
610 PositionalOpts.clear();
613 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
614 OptionListChanged = false;
617 // Check to see if this is a positional argument. This argument is
618 // considered to be positional if it doesn't start with '-', if it is "-"
619 // itself, or if we have seen "--" already.
621 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
622 // Positional argument!
623 if (ActivePositionalArg) {
624 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
625 continue; // We are done!
628 if (!PositionalOpts.empty()) {
629 PositionalVals.push_back(std::make_pair(argv[i],i));
631 // All of the positional arguments have been fulfulled, give the rest to
632 // the consume after option... if it's specified...
634 if (PositionalVals.size() >= NumPositionalRequired &&
635 ConsumeAfterOpt != 0) {
636 for (++i; i < argc; ++i)
637 PositionalVals.push_back(std::make_pair(argv[i],i));
638 break; // Handle outside of the argument processing loop...
641 // Delay processing positional arguments until the end...
644 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
646 DashDashFound = true; // This is the mythical "--"?
647 continue; // Don't try to process it as an argument itself.
648 } else if (ActivePositionalArg &&
649 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
650 // If there is a positional argument eating options, check to see if this
651 // option is another positional argument. If so, treat it as an argument,
652 // otherwise feed it to the eating positional.
654 // Eat leading dashes.
655 while (!ArgName.empty() && ArgName[0] == '-')
656 ArgName = ArgName.substr(1);
658 Handler = LookupOption(ArgName, Value, Opts);
659 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
660 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
661 continue; // We are done!
664 } else { // We start with a '-', must be an argument.
666 // Eat leading dashes.
667 while (!ArgName.empty() && ArgName[0] == '-')
668 ArgName = ArgName.substr(1);
670 Handler = LookupOption(ArgName, Value, Opts);
672 // Check to see if this "option" is really a prefixed or grouped argument.
674 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
677 // Otherwise, look for the closest available option to report to the user
678 // in the upcoming error.
679 if (Handler == 0 && SinkOpts.empty())
680 NearestHandler = LookupNearestOption(ArgName, Opts);
684 if (SinkOpts.empty()) {
685 errs() << ProgramName << ": Unknown command line argument '"
686 << argv[i] << "'. Try: '" << argv[0] << " -help'\n";
688 // If we know a near match, report it as well.
689 errs() << ProgramName << ": Did you mean '-"
690 << NearestHandler->ArgStr << "'?\n";
694 for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
695 E = SinkOpts.end(); I != E ; ++I)
696 (*I)->addOccurrence(i, "", argv[i]);
701 // If this is a named positional argument, just remember that it is the
703 if (Handler->getFormattingFlag() == cl::Positional)
704 ActivePositionalArg = Handler;
706 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
709 // Check and handle positional arguments now...
710 if (NumPositionalRequired > PositionalVals.size()) {
711 errs() << ProgramName
712 << ": Not enough positional command line arguments specified!\n"
713 << "Must specify at least " << NumPositionalRequired
714 << " positional arguments: See: " << argv[0] << " -help\n";
717 } else if (!HasUnlimitedPositionals &&
718 PositionalVals.size() > PositionalOpts.size()) {
719 errs() << ProgramName
720 << ": Too many positional arguments specified!\n"
721 << "Can specify at most " << PositionalOpts.size()
722 << " positional arguments: See: " << argv[0] << " -help\n";
725 } else if (ConsumeAfterOpt == 0) {
726 // Positional args have already been handled if ConsumeAfter is specified.
727 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
728 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
729 if (RequiresValue(PositionalOpts[i])) {
730 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
731 PositionalVals[ValNo].second);
733 --NumPositionalRequired; // We fulfilled our duty...
736 // If we _can_ give this option more arguments, do so now, as long as we
737 // do not give it values that others need. 'Done' controls whether the
738 // option even _WANTS_ any more.
740 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
741 while (NumVals-ValNo > NumPositionalRequired && !Done) {
742 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
744 Done = true; // Optional arguments want _at most_ one value
746 case cl::ZeroOrMore: // Zero or more will take all they can get...
747 case cl::OneOrMore: // One or more will take all they can get...
748 ProvidePositionalOption(PositionalOpts[i],
749 PositionalVals[ValNo].first,
750 PositionalVals[ValNo].second);
754 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
755 "positional argument processing!");
760 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
762 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
763 if (RequiresValue(PositionalOpts[j])) {
764 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
765 PositionalVals[ValNo].first,
766 PositionalVals[ValNo].second);
770 // Handle the case where there is just one positional option, and it's
771 // optional. In this case, we want to give JUST THE FIRST option to the
772 // positional option and keep the rest for the consume after. The above
773 // loop would have assigned no values to positional options in this case.
775 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
776 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
777 PositionalVals[ValNo].first,
778 PositionalVals[ValNo].second);
782 // Handle over all of the rest of the arguments to the
783 // cl::ConsumeAfter command line option...
784 for (; ValNo != PositionalVals.size(); ++ValNo)
785 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
786 PositionalVals[ValNo].first,
787 PositionalVals[ValNo].second);
790 // Loop over args and make sure all required args are specified!
791 for (StringMap<Option*>::iterator I = Opts.begin(),
792 E = Opts.end(); I != E; ++I) {
793 switch (I->second->getNumOccurrencesFlag()) {
796 if (I->second->getNumOccurrences() == 0) {
797 I->second->error("must be specified at least once!");
806 // Now that we know if -debug is specified, we can use it.
807 // Note that if ReadResponseFiles == true, this must be done before the
808 // memory allocated for the expanded command line is free()d below.
809 DEBUG(dbgs() << "Args: ";
810 for (int i = 0; i < argc; ++i)
811 dbgs() << argv[i] << ' ';
815 // Free all of the memory allocated to the map. Command line options may only
816 // be processed once!
818 PositionalOpts.clear();
821 // Free the memory allocated by ExpandResponseFiles.
822 if (ReadResponseFiles) {
823 // Free all the strdup()ed strings.
824 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
829 // If we had an error processing our arguments, don't let the program execute
830 if (ErrorParsing) exit(1);
833 //===----------------------------------------------------------------------===//
834 // Option Base class implementation
837 bool Option::error(const Twine &Message, StringRef ArgName) {
838 if (ArgName.data() == 0) ArgName = ArgStr;
840 errs() << HelpStr; // Be nice for positional arguments
842 errs() << ProgramName << ": for the -" << ArgName;
844 errs() << " option: " << Message << "\n";
848 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
849 StringRef Value, bool MultiArg) {
851 NumOccurrences++; // Increment the number of times we have been seen
853 switch (getNumOccurrencesFlag()) {
855 if (NumOccurrences > 1)
856 return error("may only occur zero or one times!", ArgName);
859 if (NumOccurrences > 1)
860 return error("must occur exactly one time!", ArgName);
864 case ConsumeAfter: break;
865 default: return error("bad num occurrences flag value!");
868 return handleOccurrence(pos, ArgName, Value);
872 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
873 // has been specified yet.
875 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
876 if (O.ValueStr[0] == 0) return DefaultMsg;
880 //===----------------------------------------------------------------------===//
881 // cl::alias class implementation
884 // Return the width of the option tag for printing...
885 size_t alias::getOptionWidth() const {
886 return std::strlen(ArgStr)+6;
889 // Print out the option for the alias.
890 void alias::printOptionInfo(size_t GlobalWidth) const {
891 size_t L = std::strlen(ArgStr);
892 errs() << " -" << ArgStr;
893 errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
898 //===----------------------------------------------------------------------===//
899 // Parser Implementation code...
902 // basic_parser implementation
905 // Return the width of the option tag for printing...
906 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
907 size_t Len = std::strlen(O.ArgStr);
908 if (const char *ValName = getValueName())
909 Len += std::strlen(getValueStr(O, ValName))+3;
914 // printOptionInfo - Print out information about this option. The
915 // to-be-maintained width is specified.
917 void basic_parser_impl::printOptionInfo(const Option &O,
918 size_t GlobalWidth) const {
919 outs() << " -" << O.ArgStr;
921 if (const char *ValName = getValueName())
922 outs() << "=<" << getValueStr(O, ValName) << '>';
924 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
930 // parser<bool> implementation
932 bool parser<bool>::parse(Option &O, StringRef ArgName,
933 StringRef Arg, bool &Value) {
934 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
940 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
944 return O.error("'" + Arg +
945 "' is invalid value for boolean argument! Try 0 or 1");
948 // parser<boolOrDefault> implementation
950 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
951 StringRef Arg, boolOrDefault &Value) {
952 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
957 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
962 return O.error("'" + Arg +
963 "' is invalid value for boolean argument! Try 0 or 1");
966 // parser<int> implementation
968 bool parser<int>::parse(Option &O, StringRef ArgName,
969 StringRef Arg, int &Value) {
970 if (Arg.getAsInteger(0, Value))
971 return O.error("'" + Arg + "' value invalid for integer argument!");
975 // parser<unsigned> implementation
977 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
978 StringRef Arg, unsigned &Value) {
980 if (Arg.getAsInteger(0, Value))
981 return O.error("'" + Arg + "' value invalid for uint argument!");
985 // parser<double>/parser<float> implementation
987 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
988 SmallString<32> TmpStr(Arg.begin(), Arg.end());
989 const char *ArgStart = TmpStr.c_str();
991 Value = strtod(ArgStart, &End);
993 return O.error("'" + Arg + "' value invalid for floating point argument!");
997 bool parser<double>::parse(Option &O, StringRef ArgName,
998 StringRef Arg, double &Val) {
999 return parseDouble(O, Arg, Val);
1002 bool parser<float>::parse(Option &O, StringRef ArgName,
1003 StringRef Arg, float &Val) {
1005 if (parseDouble(O, Arg, dVal))
1013 // generic_parser_base implementation
1016 // findOption - Return the option number corresponding to the specified
1017 // argument string. If the option is not found, getNumOptions() is returned.
1019 unsigned generic_parser_base::findOption(const char *Name) {
1020 unsigned e = getNumOptions();
1022 for (unsigned i = 0; i != e; ++i) {
1023 if (strcmp(getOption(i), Name) == 0)
1030 // Return the width of the option tag for printing...
1031 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1032 if (O.hasArgStr()) {
1033 size_t Size = std::strlen(O.ArgStr)+6;
1034 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1035 Size = std::max(Size, std::strlen(getOption(i))+8);
1038 size_t BaseSize = 0;
1039 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1040 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1045 // printOptionInfo - Print out information about this option. The
1046 // to-be-maintained width is specified.
1048 void generic_parser_base::printOptionInfo(const Option &O,
1049 size_t GlobalWidth) const {
1050 if (O.hasArgStr()) {
1051 size_t L = std::strlen(O.ArgStr);
1052 outs() << " -" << O.ArgStr;
1053 outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1055 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1056 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1057 outs() << " =" << getOption(i);
1058 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1062 outs() << " " << O.HelpStr << '\n';
1063 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1064 size_t L = std::strlen(getOption(i));
1065 outs() << " -" << getOption(i);
1066 outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1072 //===----------------------------------------------------------------------===//
1073 // -help and -help-hidden option implementation
1076 static int OptNameCompare(const void *LHS, const void *RHS) {
1077 typedef std::pair<const char *, Option*> pair_ty;
1079 return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1086 const Option *EmptyArg;
1087 const bool ShowHidden;
1090 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1094 void operator=(bool Value) {
1095 if (Value == false) return;
1097 // Get all the options.
1098 SmallVector<Option*, 4> PositionalOpts;
1099 SmallVector<Option*, 4> SinkOpts;
1100 StringMap<Option*> OptMap;
1101 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1103 // Copy Options into a vector so we can sort them as we like.
1104 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1105 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1107 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1109 // Ignore really-hidden options.
1110 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1113 // Unless showhidden is set, ignore hidden flags.
1114 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1117 // If we've already seen this option, don't add it to the list again.
1118 if (!OptionSet.insert(I->second))
1121 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1125 // Sort the options list alphabetically.
1126 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1128 if (ProgramOverview)
1129 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1131 outs() << "USAGE: " << ProgramName << " [options]";
1133 // Print out the positional options.
1134 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1135 if (!PositionalOpts.empty() &&
1136 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1137 CAOpt = PositionalOpts[0];
1139 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1140 if (PositionalOpts[i]->ArgStr[0])
1141 outs() << " --" << PositionalOpts[i]->ArgStr;
1142 outs() << " " << PositionalOpts[i]->HelpStr;
1145 // Print the consume after option info if it exists...
1146 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1150 // Compute the maximum argument length...
1152 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1153 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1155 outs() << "OPTIONS:\n";
1156 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1157 Opts[i].second->printOptionInfo(MaxArgLen);
1159 // Print any extra help the user has declared.
1160 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1161 E = MoreHelp->end(); I != E; ++I)
1165 // Halt the program since help information was printed
1169 } // End anonymous namespace
1171 // Define the two HelpPrinter instances that are used to print out help, or
1174 static HelpPrinter NormalPrinter(false);
1175 static HelpPrinter HiddenPrinter(true);
1177 static cl::opt<HelpPrinter, true, parser<bool> >
1178 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1179 cl::location(NormalPrinter), cl::ValueDisallowed);
1181 static cl::opt<HelpPrinter, true, parser<bool> >
1182 HHOp("help-hidden", cl::desc("Display all available options"),
1183 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1185 static void (*OverrideVersionPrinter)() = 0;
1187 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1188 typedef std::pair<const char *, const Target*> pair_ty;
1189 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1193 class VersionPrinter {
1196 raw_ostream &OS = outs();
1197 OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1198 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1199 #ifdef LLVM_VERSION_INFO
1200 OS << LLVM_VERSION_INFO;
1203 #ifndef __OPTIMIZE__
1204 OS << "DEBUG build";
1206 OS << "Optimized build";
1209 OS << " with assertions";
1211 std::string CPU = sys::getHostCPUName();
1212 if (CPU == "generic") CPU = "(unknown)";
1214 #if (ENABLE_TIMESTAMPS == 1)
1215 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1217 << " Host: " << sys::getHostTriple() << '\n'
1218 << " Host CPU: " << CPU << '\n'
1220 << " Registered Targets:\n";
1222 std::vector<std::pair<const char *, const Target*> > Targets;
1224 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1225 ie = TargetRegistry::end(); it != ie; ++it) {
1226 Targets.push_back(std::make_pair(it->getName(), &*it));
1227 Width = std::max(Width, strlen(Targets.back().first));
1229 if (!Targets.empty())
1230 qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1233 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1234 OS << " " << Targets[i].first;
1235 OS.indent(Width - strlen(Targets[i].first)) << " - "
1236 << Targets[i].second->getShortDescription() << '\n';
1238 if (Targets.empty())
1241 void operator=(bool OptionWasSpecified) {
1242 if (!OptionWasSpecified) return;
1244 if (OverrideVersionPrinter == 0) {
1248 (*OverrideVersionPrinter)();
1252 } // End anonymous namespace
1255 // Define the --version option that prints out the LLVM version for the tool
1256 static VersionPrinter VersionPrinterInstance;
1258 static cl::opt<VersionPrinter, true, parser<bool> >
1259 VersOp("version", cl::desc("Display the version of this program"),
1260 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1262 // Utility function for printing the help message.
1263 void cl::PrintHelpMessage() {
1264 // This looks weird, but it actually prints the help message. The
1265 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1266 // its operator= is invoked. That's because the "normal" usages of the
1267 // help printer is to be assigned true/false depending on whether the
1268 // -help option was given or not. Since we're circumventing that we have
1269 // to make it look like -help was given, so we assign true.
1270 NormalPrinter = true;
1273 /// Utility function for printing version number.
1274 void cl::PrintVersionMessage() {
1275 VersionPrinterInstance.print();
1278 void cl::SetVersionPrinter(void (*func)()) {
1279 OverrideVersionPrinter = func;