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/Target/TargetRegistry.h"
26 #include "llvm/System/Host.h"
27 #include "llvm/System/Path.h"
28 #include "llvm/ADT/OwningPtr.h"
29 #include "llvm/ADT/SmallPtrSet.h"
30 #include "llvm/ADT/SmallString.h"
31 #include "llvm/ADT/StringMap.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/Config/config.h"
39 //===----------------------------------------------------------------------===//
40 // Template instantiations and anchors.
42 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
43 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
44 TEMPLATE_INSTANTIATION(class basic_parser<int>);
45 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
46 TEMPLATE_INSTANTIATION(class basic_parser<double>);
47 TEMPLATE_INSTANTIATION(class basic_parser<float>);
48 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
49 TEMPLATE_INSTANTIATION(class basic_parser<char>);
51 TEMPLATE_INSTANTIATION(class opt<unsigned>);
52 TEMPLATE_INSTANTIATION(class opt<int>);
53 TEMPLATE_INSTANTIATION(class opt<std::string>);
54 TEMPLATE_INSTANTIATION(class opt<char>);
55 TEMPLATE_INSTANTIATION(class opt<bool>);
57 void Option::anchor() {}
58 void basic_parser_impl::anchor() {}
59 void parser<bool>::anchor() {}
60 void parser<boolOrDefault>::anchor() {}
61 void parser<int>::anchor() {}
62 void parser<unsigned>::anchor() {}
63 void parser<double>::anchor() {}
64 void parser<float>::anchor() {}
65 void parser<std::string>::anchor() {}
66 void parser<char>::anchor() {}
68 //===----------------------------------------------------------------------===//
70 // Globals for name and overview of program. Program name is not a string to
71 // avoid static ctor/dtor issues.
72 static char ProgramName[80] = "<premain>";
73 static const char *ProgramOverview = 0;
75 // This collects additional help to be printed.
76 static ManagedStatic<std::vector<const char*> > MoreHelp;
78 extrahelp::extrahelp(const char *Help)
80 MoreHelp->push_back(Help);
83 static bool OptionListChanged = false;
85 // MarkOptionsChanged - Internal helper function.
86 void cl::MarkOptionsChanged() {
87 OptionListChanged = true;
90 /// RegisteredOptionList - This is the list of the command line options that
91 /// have statically constructed themselves.
92 static Option *RegisteredOptionList = 0;
94 void Option::addArgument() {
95 assert(NextRegistered == 0 && "argument multiply registered!");
97 NextRegistered = RegisteredOptionList;
98 RegisteredOptionList = this;
103 //===----------------------------------------------------------------------===//
104 // Basic, shared command line option processing machinery.
107 /// GetOptionInfo - Scan the list of registered options, turning them into data
108 /// structures that are easier to handle.
109 static void GetOptionInfo(SmallVectorImpl<Option*> &PositionalOpts,
110 SmallVectorImpl<Option*> &SinkOpts,
111 StringMap<Option*> &OptionsMap) {
112 SmallVector<const char*, 16> OptionNames;
113 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
114 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
115 // If this option wants to handle multiple option names, get the full set.
116 // This handles enum options like "-O1 -O2" etc.
117 O->getExtraOptionNames(OptionNames);
119 OptionNames.push_back(O->ArgStr);
121 // Handle named options.
122 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
123 // Add argument to the argument map!
124 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
125 errs() << ProgramName << ": CommandLine Error: Argument '"
126 << OptionNames[i] << "' defined more than once!\n";
132 // Remember information about positional options.
133 if (O->getFormattingFlag() == cl::Positional)
134 PositionalOpts.push_back(O);
135 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
136 SinkOpts.push_back(O);
137 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
139 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
145 PositionalOpts.push_back(CAOpt);
147 // Make sure that they are in order of registration not backwards.
148 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
152 /// LookupOption - Lookup the option specified by the specified option on the
153 /// command line. If there is a value specified (after an equal sign) return
154 /// that as well. This assumes that leading dashes have already been stripped.
155 static Option *LookupOption(StringRef &Arg, StringRef &Value,
156 const StringMap<Option*> &OptionsMap) {
157 // Reject all dashes.
158 if (Arg.empty()) return 0;
160 size_t EqualPos = Arg.find('=');
162 // If we have an equals sign, remember the value.
163 if (EqualPos == StringRef::npos) {
164 // Look up the option.
165 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
166 return I != OptionsMap.end() ? I->second : 0;
169 // If the argument before the = is a valid option name, we match. If not,
170 // return Arg unmolested.
171 StringMap<Option*>::const_iterator I =
172 OptionsMap.find(Arg.substr(0, EqualPos));
173 if (I == OptionsMap.end()) return 0;
175 Value = Arg.substr(EqualPos+1);
176 Arg = Arg.substr(0, EqualPos);
180 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
181 /// does special handling of cl::CommaSeparated options.
182 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
184 StringRef Value, bool MultiArg = false)
186 // Check to see if this option accepts a comma separated list of values. If
187 // it does, we have to split up the value into multiple values.
188 if (Handler->getMiscFlags() & CommaSeparated) {
189 StringRef Val(Value);
190 StringRef::size_type Pos = Val.find(',');
192 while (Pos != StringRef::npos) {
193 // Process the portion before the comma.
194 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
196 // Erase the portion before the comma, AND the comma.
197 Val = Val.substr(Pos+1);
198 Value.substr(Pos+1); // Increment the original value pointer as well.
199 // Check for another comma.
206 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
212 /// ProvideOption - For Value, this differentiates between an empty value ("")
213 /// and a null value (StringRef()). The later is accepted for arguments that
214 /// don't allow a value (-foo) the former is rejected (-foo=).
215 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
216 StringRef Value, int argc, char **argv,
218 // Is this a multi-argument option?
219 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
221 // Enforce value requirements
222 switch (Handler->getValueExpectedFlag()) {
224 if (Value.data() == 0) { // No value specified?
226 return Handler->error("requires a value!");
227 // Steal the next argument, like for '-o filename'
231 case ValueDisallowed:
232 if (NumAdditionalVals > 0)
233 return Handler->error("multi-valued option specified"
234 " with ValueDisallowed modifier!");
237 return Handler->error("does not allow a value! '" +
238 Twine(Value) + "' specified.");
244 errs() << ProgramName
245 << ": Bad ValueMask flag! CommandLine usage error:"
246 << Handler->getValueExpectedFlag() << "\n";
250 // If this isn't a multi-arg option, just run the handler.
251 if (NumAdditionalVals == 0)
252 return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
254 // If it is, run the handle several times.
255 bool MultiArg = false;
258 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
264 while (NumAdditionalVals > 0) {
266 return Handler->error("not enough values!");
269 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
277 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
279 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
283 // Option predicates...
284 static inline bool isGrouping(const Option *O) {
285 return O->getFormattingFlag() == cl::Grouping;
287 static inline bool isPrefixedOrGrouping(const Option *O) {
288 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
291 // getOptionPred - Check to see if there are any options that satisfy the
292 // specified predicate with names that are the prefixes in Name. This is
293 // checked by progressively stripping characters off of the name, checking to
294 // see if there options that satisfy the predicate. If we find one, return it,
295 // otherwise return null.
297 static Option *getOptionPred(StringRef Name, size_t &Length,
298 bool (*Pred)(const Option*),
299 const StringMap<Option*> &OptionsMap) {
301 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
303 // Loop while we haven't found an option and Name still has at least two
304 // characters in it (so that the next iteration will not be the empty
306 while (OMI == OptionsMap.end() && Name.size() > 1) {
307 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
308 OMI = OptionsMap.find(Name);
311 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
312 Length = Name.size();
313 return OMI->second; // Found one!
315 return 0; // No option found!
318 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
319 /// with at least one '-') does not fully match an available option. Check to
320 /// see if this is a prefix or grouped option. If so, split arg into output an
321 /// Arg/Value pair and return the Option to parse it with.
322 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
324 const StringMap<Option*> &OptionsMap) {
325 if (Arg.size() == 1) return 0;
329 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
330 if (PGOpt == 0) return 0;
332 // If the option is a prefixed option, then the value is simply the
333 // rest of the name... so fall through to later processing, by
334 // setting up the argument name flags and value fields.
335 if (PGOpt->getFormattingFlag() == cl::Prefix) {
336 Value = Arg.substr(Length);
337 Arg = Arg.substr(0, Length);
338 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
342 // This must be a grouped option... handle them now. Grouping options can't
344 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
347 // Move current arg name out of Arg into OneArgName.
348 StringRef OneArgName = Arg.substr(0, Length);
349 Arg = Arg.substr(Length);
351 // Because ValueRequired is an invalid flag for grouped arguments,
352 // we don't need to pass argc/argv in.
353 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
354 "Option can not be cl::Grouping AND cl::ValueRequired!");
356 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
357 StringRef(), 0, 0, Dummy);
359 // Get the next grouping option.
360 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
361 } while (PGOpt && Length != Arg.size());
363 // Return the last option with Arg cut down to just the last one.
369 static bool RequiresValue(const Option *O) {
370 return O->getNumOccurrencesFlag() == cl::Required ||
371 O->getNumOccurrencesFlag() == cl::OneOrMore;
374 static bool EatsUnboundedNumberOfValues(const Option *O) {
375 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
376 O->getNumOccurrencesFlag() == cl::OneOrMore;
379 /// ParseCStringVector - Break INPUT up wherever one or more
380 /// whitespace characters are found, and store the resulting tokens in
381 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
382 /// using strdup(), so it is the caller's responsibility to free()
385 static void ParseCStringVector(std::vector<char *> &OutputVector,
387 // Characters which will be treated as token separators:
388 StringRef Delims = " \v\f\t\r\n";
390 StringRef WorkStr(Input);
391 while (!WorkStr.empty()) {
392 // If the first character is a delimiter, strip them off.
393 if (Delims.find(WorkStr[0]) != StringRef::npos) {
394 size_t Pos = WorkStr.find_first_not_of(Delims);
395 if (Pos == StringRef::npos) Pos = WorkStr.size();
396 WorkStr = WorkStr.substr(Pos);
400 // Find position of first delimiter.
401 size_t Pos = WorkStr.find_first_of(Delims);
402 if (Pos == StringRef::npos) Pos = WorkStr.size();
404 // Everything from 0 to Pos is the next word to copy.
405 char *NewStr = (char*)malloc(Pos+1);
406 memcpy(NewStr, WorkStr.data(), Pos);
408 OutputVector.push_back(NewStr);
410 WorkStr = WorkStr.substr(Pos);
414 /// ParseEnvironmentOptions - An alternative entry point to the
415 /// CommandLine library, which allows you to read the program's name
416 /// from the caller (as PROGNAME) and its command-line arguments from
417 /// an environment variable (whose name is given in ENVVAR).
419 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
420 const char *Overview, bool ReadResponseFiles) {
422 assert(progName && "Program name not specified");
423 assert(envVar && "Environment variable name missing");
425 // Get the environment variable they want us to parse options out of.
426 const char *envValue = getenv(envVar);
430 // Get program's "name", which we wouldn't know without the caller
432 std::vector<char*> newArgv;
433 newArgv.push_back(strdup(progName));
435 // Parse the value of the environment variable into a "command line"
436 // and hand it off to ParseCommandLineOptions().
437 ParseCStringVector(newArgv, envValue);
438 int newArgc = static_cast<int>(newArgv.size());
439 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
441 // Free all the strdup()ed strings.
442 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
448 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
449 /// substituting the contents of the response files for the arguments
451 static void ExpandResponseFiles(unsigned argc, char** argv,
452 std::vector<char*>& newArgv) {
453 for (unsigned i = 1; i != argc; ++i) {
457 sys::PathWithStatus respFile(++arg);
459 // Check that the response file is not empty (mmap'ing empty
460 // files can be problematic).
461 const sys::FileStatus *FileStat = respFile.getFileStatus();
462 if (FileStat && FileStat->getSize() != 0) {
464 // Mmap the response file into memory.
465 OwningPtr<MemoryBuffer>
466 respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
468 // If we could open the file, parse its contents, otherwise
469 // pass the @file option verbatim.
471 // TODO: we should also support recursive loading of response files,
472 // since this is how gcc behaves. (From their man page: "The file may
473 // itself contain additional @file options; any such options will be
474 // processed recursively.")
476 if (respFilePtr != 0) {
477 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
482 newArgv.push_back(strdup(arg));
486 void cl::ParseCommandLineOptions(int argc, char **argv,
487 const char *Overview, bool ReadResponseFiles) {
488 // Process all registered options.
489 SmallVector<Option*, 4> PositionalOpts;
490 SmallVector<Option*, 4> SinkOpts;
491 StringMap<Option*> Opts;
492 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
494 assert((!Opts.empty() || !PositionalOpts.empty()) &&
495 "No options specified!");
497 // Expand response files.
498 std::vector<char*> newArgv;
499 if (ReadResponseFiles) {
500 newArgv.push_back(strdup(argv[0]));
501 ExpandResponseFiles(argc, argv, newArgv);
503 argc = static_cast<int>(newArgv.size());
506 // Copy the program name into ProgName, making sure not to overflow it.
507 std::string ProgName = sys::Path(argv[0]).getLast();
508 if (ProgName.size() > 79) ProgName.resize(79);
509 strcpy(ProgramName, ProgName.c_str());
511 ProgramOverview = Overview;
512 bool ErrorParsing = false;
514 // Check out the positional arguments to collect information about them.
515 unsigned NumPositionalRequired = 0;
517 // Determine whether or not there are an unlimited number of positionals
518 bool HasUnlimitedPositionals = false;
520 Option *ConsumeAfterOpt = 0;
521 if (!PositionalOpts.empty()) {
522 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
523 assert(PositionalOpts.size() > 1 &&
524 "Cannot specify cl::ConsumeAfter without a positional argument!");
525 ConsumeAfterOpt = PositionalOpts[0];
528 // Calculate how many positional values are _required_.
529 bool UnboundedFound = false;
530 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
532 Option *Opt = PositionalOpts[i];
533 if (RequiresValue(Opt))
534 ++NumPositionalRequired;
535 else if (ConsumeAfterOpt) {
536 // ConsumeAfter cannot be combined with "optional" positional options
537 // unless there is only one positional argument...
538 if (PositionalOpts.size() > 2)
540 Opt->error("error - this positional option will never be matched, "
541 "because it does not Require a value, and a "
542 "cl::ConsumeAfter option is active!");
543 } else if (UnboundedFound && !Opt->ArgStr[0]) {
544 // This option does not "require" a value... Make sure this option is
545 // not specified after an option that eats all extra arguments, or this
546 // one will never get any!
548 ErrorParsing |= Opt->error("error - option can never match, because "
549 "another positional argument will match an "
550 "unbounded number of values, and this option"
551 " does not require a value!");
553 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
555 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
558 // PositionalVals - A vector of "positional" arguments we accumulate into
559 // the process at the end.
561 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
563 // If the program has named positional arguments, and the name has been run
564 // across, keep track of which positional argument was named. Otherwise put
565 // the positional args into the PositionalVals list...
566 Option *ActivePositionalArg = 0;
568 // Loop over all of the arguments... processing them.
569 bool DashDashFound = false; // Have we read '--'?
570 for (int i = 1; i < argc; ++i) {
573 StringRef ArgName = "";
575 // If the option list changed, this means that some command line
576 // option has just been registered or deregistered. This can occur in
577 // response to things like -load, etc. If this happens, rescan the options.
578 if (OptionListChanged) {
579 PositionalOpts.clear();
582 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
583 OptionListChanged = false;
586 // Check to see if this is a positional argument. This argument is
587 // considered to be positional if it doesn't start with '-', if it is "-"
588 // itself, or if we have seen "--" already.
590 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
591 // Positional argument!
592 if (ActivePositionalArg) {
593 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
594 continue; // We are done!
597 if (!PositionalOpts.empty()) {
598 PositionalVals.push_back(std::make_pair(argv[i],i));
600 // All of the positional arguments have been fulfulled, give the rest to
601 // the consume after option... if it's specified...
603 if (PositionalVals.size() >= NumPositionalRequired &&
604 ConsumeAfterOpt != 0) {
605 for (++i; i < argc; ++i)
606 PositionalVals.push_back(std::make_pair(argv[i],i));
607 break; // Handle outside of the argument processing loop...
610 // Delay processing positional arguments until the end...
613 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
615 DashDashFound = true; // This is the mythical "--"?
616 continue; // Don't try to process it as an argument itself.
617 } else if (ActivePositionalArg &&
618 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
619 // If there is a positional argument eating options, check to see if this
620 // option is another positional argument. If so, treat it as an argument,
621 // otherwise feed it to the eating positional.
623 // Eat leading dashes.
624 while (!ArgName.empty() && ArgName[0] == '-')
625 ArgName = ArgName.substr(1);
627 Handler = LookupOption(ArgName, Value, Opts);
628 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
629 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
630 continue; // We are done!
633 } else { // We start with a '-', must be an argument.
635 // Eat leading dashes.
636 while (!ArgName.empty() && ArgName[0] == '-')
637 ArgName = ArgName.substr(1);
639 Handler = LookupOption(ArgName, Value, Opts);
641 // Check to see if this "option" is really a prefixed or grouped argument.
643 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
648 if (SinkOpts.empty()) {
649 errs() << ProgramName << ": Unknown command line argument '"
650 << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
653 for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
654 E = SinkOpts.end(); I != E ; ++I)
655 (*I)->addOccurrence(i, "", argv[i]);
660 // If this is a named positional argument, just remember that it is the
662 if (Handler->getFormattingFlag() == cl::Positional)
663 ActivePositionalArg = Handler;
665 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
668 // Check and handle positional arguments now...
669 if (NumPositionalRequired > PositionalVals.size()) {
670 errs() << ProgramName
671 << ": Not enough positional command line arguments specified!\n"
672 << "Must specify at least " << NumPositionalRequired
673 << " positional arguments: See: " << argv[0] << " --help\n";
676 } else if (!HasUnlimitedPositionals
677 && PositionalVals.size() > PositionalOpts.size()) {
678 errs() << ProgramName
679 << ": Too many positional arguments specified!\n"
680 << "Can specify at most " << PositionalOpts.size()
681 << " positional arguments: See: " << argv[0] << " --help\n";
684 } else if (ConsumeAfterOpt == 0) {
685 // Positional args have already been handled if ConsumeAfter is specified.
686 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
687 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
688 if (RequiresValue(PositionalOpts[i])) {
689 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
690 PositionalVals[ValNo].second);
692 --NumPositionalRequired; // We fulfilled our duty...
695 // If we _can_ give this option more arguments, do so now, as long as we
696 // do not give it values that others need. 'Done' controls whether the
697 // option even _WANTS_ any more.
699 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
700 while (NumVals-ValNo > NumPositionalRequired && !Done) {
701 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
703 Done = true; // Optional arguments want _at most_ one value
705 case cl::ZeroOrMore: // Zero or more will take all they can get...
706 case cl::OneOrMore: // One or more will take all they can get...
707 ProvidePositionalOption(PositionalOpts[i],
708 PositionalVals[ValNo].first,
709 PositionalVals[ValNo].second);
713 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
714 "positional argument processing!");
719 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
721 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
722 if (RequiresValue(PositionalOpts[j])) {
723 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
724 PositionalVals[ValNo].first,
725 PositionalVals[ValNo].second);
729 // Handle the case where there is just one positional option, and it's
730 // optional. In this case, we want to give JUST THE FIRST option to the
731 // positional option and keep the rest for the consume after. The above
732 // loop would have assigned no values to positional options in this case.
734 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
735 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
736 PositionalVals[ValNo].first,
737 PositionalVals[ValNo].second);
741 // Handle over all of the rest of the arguments to the
742 // cl::ConsumeAfter command line option...
743 for (; ValNo != PositionalVals.size(); ++ValNo)
744 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
745 PositionalVals[ValNo].first,
746 PositionalVals[ValNo].second);
749 // Loop over args and make sure all required args are specified!
750 for (StringMap<Option*>::iterator I = Opts.begin(),
751 E = Opts.end(); I != E; ++I) {
752 switch (I->second->getNumOccurrencesFlag()) {
755 if (I->second->getNumOccurrences() == 0) {
756 I->second->error("must be specified at least once!");
765 // Free all of the memory allocated to the map. Command line options may only
766 // be processed once!
768 PositionalOpts.clear();
771 // Free the memory allocated by ExpandResponseFiles.
772 if (ReadResponseFiles) {
773 // Free all the strdup()ed strings.
774 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
779 DEBUG(errs() << "\nArgs: ";
780 for (int i = 0; i < argc; ++i)
781 errs() << argv[i] << ' ';
784 // If we had an error processing our arguments, don't let the program execute
785 if (ErrorParsing) exit(1);
788 //===----------------------------------------------------------------------===//
789 // Option Base class implementation
792 bool Option::error(const Twine &Message, StringRef ArgName) {
793 if (ArgName.data() == 0) ArgName = ArgStr;
795 errs() << HelpStr; // Be nice for positional arguments
797 errs() << ProgramName << ": for the -" << ArgName;
799 errs() << " option: " << Message << "\n";
803 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
804 StringRef Value, bool MultiArg) {
806 NumOccurrences++; // Increment the number of times we have been seen
808 switch (getNumOccurrencesFlag()) {
810 if (NumOccurrences > 1)
811 return error("may only occur zero or one times!", ArgName);
814 if (NumOccurrences > 1)
815 return error("must occur exactly one time!", ArgName);
819 case ConsumeAfter: break;
820 default: return error("bad num occurrences flag value!");
823 return handleOccurrence(pos, ArgName, Value);
827 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
828 // has been specified yet.
830 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
831 if (O.ValueStr[0] == 0) return DefaultMsg;
835 //===----------------------------------------------------------------------===//
836 // cl::alias class implementation
839 // Return the width of the option tag for printing...
840 size_t alias::getOptionWidth() const {
841 return std::strlen(ArgStr)+6;
844 // Print out the option for the alias.
845 void alias::printOptionInfo(size_t GlobalWidth) const {
846 size_t L = std::strlen(ArgStr);
847 errs() << " -" << ArgStr;
848 errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
853 //===----------------------------------------------------------------------===//
854 // Parser Implementation code...
857 // basic_parser implementation
860 // Return the width of the option tag for printing...
861 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
862 size_t Len = std::strlen(O.ArgStr);
863 if (const char *ValName = getValueName())
864 Len += std::strlen(getValueStr(O, ValName))+3;
869 // printOptionInfo - Print out information about this option. The
870 // to-be-maintained width is specified.
872 void basic_parser_impl::printOptionInfo(const Option &O,
873 size_t GlobalWidth) const {
874 outs() << " -" << O.ArgStr;
876 if (const char *ValName = getValueName())
877 outs() << "=<" << getValueStr(O, ValName) << '>';
879 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
885 // parser<bool> implementation
887 bool parser<bool>::parse(Option &O, StringRef ArgName,
888 StringRef Arg, bool &Value) {
889 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
895 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
899 return O.error("'" + Arg +
900 "' is invalid value for boolean argument! Try 0 or 1");
903 // parser<boolOrDefault> implementation
905 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
906 StringRef Arg, boolOrDefault &Value) {
907 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
912 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
917 return O.error("'" + Arg +
918 "' is invalid value for boolean argument! Try 0 or 1");
921 // parser<int> implementation
923 bool parser<int>::parse(Option &O, StringRef ArgName,
924 StringRef Arg, int &Value) {
925 if (Arg.getAsInteger(0, Value))
926 return O.error("'" + Arg + "' value invalid for integer argument!");
930 // parser<unsigned> implementation
932 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
933 StringRef Arg, unsigned &Value) {
935 if (Arg.getAsInteger(0, Value))
936 return O.error("'" + Arg + "' value invalid for uint argument!");
940 // parser<double>/parser<float> implementation
942 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
943 SmallString<32> TmpStr(Arg.begin(), Arg.end());
944 const char *ArgStart = TmpStr.c_str();
946 Value = strtod(ArgStart, &End);
948 return O.error("'" + Arg + "' value invalid for floating point argument!");
952 bool parser<double>::parse(Option &O, StringRef ArgName,
953 StringRef Arg, double &Val) {
954 return parseDouble(O, Arg, Val);
957 bool parser<float>::parse(Option &O, StringRef ArgName,
958 StringRef Arg, float &Val) {
960 if (parseDouble(O, Arg, dVal))
968 // generic_parser_base implementation
971 // findOption - Return the option number corresponding to the specified
972 // argument string. If the option is not found, getNumOptions() is returned.
974 unsigned generic_parser_base::findOption(const char *Name) {
975 unsigned e = getNumOptions();
977 for (unsigned i = 0; i != e; ++i) {
978 if (strcmp(getOption(i), Name) == 0)
985 // Return the width of the option tag for printing...
986 size_t generic_parser_base::getOptionWidth(const Option &O) const {
988 size_t Size = std::strlen(O.ArgStr)+6;
989 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
990 Size = std::max(Size, std::strlen(getOption(i))+8);
994 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
995 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1000 // printOptionInfo - Print out information about this option. The
1001 // to-be-maintained width is specified.
1003 void generic_parser_base::printOptionInfo(const Option &O,
1004 size_t GlobalWidth) const {
1005 if (O.hasArgStr()) {
1006 size_t L = std::strlen(O.ArgStr);
1007 outs() << " -" << O.ArgStr;
1008 outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1010 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1011 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1012 outs() << " =" << getOption(i);
1013 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1017 outs() << " " << O.HelpStr << '\n';
1018 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1019 size_t L = std::strlen(getOption(i));
1020 outs() << " -" << getOption(i);
1021 outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1027 //===----------------------------------------------------------------------===//
1028 // --help and --help-hidden option implementation
1031 static int OptNameCompare(const void *LHS, const void *RHS) {
1032 typedef std::pair<const char *, Option*> pair_ty;
1034 return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1041 const Option *EmptyArg;
1042 const bool ShowHidden;
1045 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1049 void operator=(bool Value) {
1050 if (Value == false) return;
1052 // Get all the options.
1053 SmallVector<Option*, 4> PositionalOpts;
1054 SmallVector<Option*, 4> SinkOpts;
1055 StringMap<Option*> OptMap;
1056 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1058 // Copy Options into a vector so we can sort them as we like.
1059 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1060 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1062 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1064 // Ignore really-hidden options.
1065 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1068 // Unless showhidden is set, ignore hidden flags.
1069 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1072 // If we've already seen this option, don't add it to the list again.
1073 if (!OptionSet.insert(I->second))
1076 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1080 // Sort the options list alphabetically.
1081 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1083 if (ProgramOverview)
1084 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1086 outs() << "USAGE: " << ProgramName << " [options]";
1088 // Print out the positional options.
1089 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1090 if (!PositionalOpts.empty() &&
1091 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1092 CAOpt = PositionalOpts[0];
1094 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1095 if (PositionalOpts[i]->ArgStr[0])
1096 outs() << " --" << PositionalOpts[i]->ArgStr;
1097 outs() << " " << PositionalOpts[i]->HelpStr;
1100 // Print the consume after option info if it exists...
1101 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1105 // Compute the maximum argument length...
1107 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1108 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1110 outs() << "OPTIONS:\n";
1111 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1112 Opts[i].second->printOptionInfo(MaxArgLen);
1114 // Print any extra help the user has declared.
1115 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1116 E = MoreHelp->end(); I != E; ++I)
1120 // Halt the program since help information was printed
1124 } // End anonymous namespace
1126 // Define the two HelpPrinter instances that are used to print out help, or
1129 static HelpPrinter NormalPrinter(false);
1130 static HelpPrinter HiddenPrinter(true);
1132 static cl::opt<HelpPrinter, true, parser<bool> >
1133 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1134 cl::location(NormalPrinter), cl::ValueDisallowed);
1136 static cl::opt<HelpPrinter, true, parser<bool> >
1137 HHOp("help-hidden", cl::desc("Display all available options"),
1138 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1140 static void (*OverrideVersionPrinter)() = 0;
1142 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1143 typedef std::pair<const char *, const Target*> pair_ty;
1144 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1148 class VersionPrinter {
1151 raw_ostream &OS = outs();
1152 OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1153 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1154 #ifdef LLVM_VERSION_INFO
1155 OS << LLVM_VERSION_INFO;
1158 #ifndef __OPTIMIZE__
1159 OS << "DEBUG build";
1161 OS << "Optimized build";
1164 OS << " with assertions";
1166 std::string CPU = sys::getHostCPUName();
1167 if (CPU == "generic") CPU = "(unknown)";
1169 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1170 << " Host: " << sys::getHostTriple() << '\n'
1171 << " Host CPU: " << CPU << '\n'
1173 << " Registered Targets:\n";
1175 std::vector<std::pair<const char *, const Target*> > Targets;
1177 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1178 ie = TargetRegistry::end(); it != ie; ++it) {
1179 Targets.push_back(std::make_pair(it->getName(), &*it));
1180 Width = std::max(Width, strlen(Targets.back().first));
1182 if (!Targets.empty())
1183 qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1186 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1187 OS << " " << Targets[i].first;
1188 OS.indent(Width - strlen(Targets[i].first)) << " - "
1189 << Targets[i].second->getShortDescription() << '\n';
1191 if (Targets.empty())
1194 void operator=(bool OptionWasSpecified) {
1195 if (!OptionWasSpecified) return;
1197 if (OverrideVersionPrinter == 0) {
1201 (*OverrideVersionPrinter)();
1205 } // End anonymous namespace
1208 // Define the --version option that prints out the LLVM version for the tool
1209 static VersionPrinter VersionPrinterInstance;
1211 static cl::opt<VersionPrinter, true, parser<bool> >
1212 VersOp("version", cl::desc("Display the version of this program"),
1213 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1215 // Utility function for printing the help message.
1216 void cl::PrintHelpMessage() {
1217 // This looks weird, but it actually prints the help message. The
1218 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1219 // its operator= is invoked. That's because the "normal" usages of the
1220 // help printer is to be assigned true/false depending on whether the
1221 // --help option was given or not. Since we're circumventing that we have
1222 // to make it look like --help was given, so we assign true.
1223 NormalPrinter = true;
1226 /// Utility function for printing version number.
1227 void cl::PrintVersionMessage() {
1228 VersionPrinterInstance.print();
1231 void cl::SetVersionPrinter(void (*func)()) {
1232 OverrideVersionPrinter = func;