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 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
184 /// does special handling of cl::CommaSeparated options.
185 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
187 StringRef Value, bool MultiArg = false)
189 // Check to see if this option accepts a comma separated list of values. If
190 // it does, we have to split up the value into multiple values.
191 if (Handler->getMiscFlags() & CommaSeparated) {
192 StringRef Val(Value);
193 StringRef::size_type Pos = Val.find(',');
195 while (Pos != StringRef::npos) {
196 // Process the portion before the comma.
197 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
199 // Erase the portion before the comma, AND the comma.
200 Val = Val.substr(Pos+1);
201 Value.substr(Pos+1); // Increment the original value pointer as well.
202 // Check for another comma.
209 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
215 /// ProvideOption - For Value, this differentiates between an empty value ("")
216 /// and a null value (StringRef()). The later is accepted for arguments that
217 /// don't allow a value (-foo) the former is rejected (-foo=).
218 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
219 StringRef Value, int argc, char **argv,
221 // Is this a multi-argument option?
222 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
224 // Enforce value requirements
225 switch (Handler->getValueExpectedFlag()) {
227 if (Value.data() == 0) { // No value specified?
229 return Handler->error("requires a value!");
230 // Steal the next argument, like for '-o filename'
234 case ValueDisallowed:
235 if (NumAdditionalVals > 0)
236 return Handler->error("multi-valued option specified"
237 " with ValueDisallowed modifier!");
240 return Handler->error("does not allow a value! '" +
241 Twine(Value) + "' specified.");
247 errs() << ProgramName
248 << ": Bad ValueMask flag! CommandLine usage error:"
249 << Handler->getValueExpectedFlag() << "\n";
253 // If this isn't a multi-arg option, just run the handler.
254 if (NumAdditionalVals == 0)
255 return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
257 // If it is, run the handle several times.
258 bool MultiArg = false;
261 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
267 while (NumAdditionalVals > 0) {
269 return Handler->error("not enough values!");
272 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
280 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
282 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
286 // Option predicates...
287 static inline bool isGrouping(const Option *O) {
288 return O->getFormattingFlag() == cl::Grouping;
290 static inline bool isPrefixedOrGrouping(const Option *O) {
291 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
294 // getOptionPred - Check to see if there are any options that satisfy the
295 // specified predicate with names that are the prefixes in Name. This is
296 // checked by progressively stripping characters off of the name, checking to
297 // see if there options that satisfy the predicate. If we find one, return it,
298 // otherwise return null.
300 static Option *getOptionPred(StringRef Name, size_t &Length,
301 bool (*Pred)(const Option*),
302 const StringMap<Option*> &OptionsMap) {
304 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
306 // Loop while we haven't found an option and Name still has at least two
307 // characters in it (so that the next iteration will not be the empty
309 while (OMI == OptionsMap.end() && Name.size() > 1) {
310 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
311 OMI = OptionsMap.find(Name);
314 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
315 Length = Name.size();
316 return OMI->second; // Found one!
318 return 0; // No option found!
321 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
322 /// with at least one '-') does not fully match an available option. Check to
323 /// see if this is a prefix or grouped option. If so, split arg into output an
324 /// Arg/Value pair and return the Option to parse it with.
325 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
327 const StringMap<Option*> &OptionsMap) {
328 if (Arg.size() == 1) return 0;
332 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
333 if (PGOpt == 0) return 0;
335 // If the option is a prefixed option, then the value is simply the
336 // rest of the name... so fall through to later processing, by
337 // setting up the argument name flags and value fields.
338 if (PGOpt->getFormattingFlag() == cl::Prefix) {
339 Value = Arg.substr(Length);
340 Arg = Arg.substr(0, Length);
341 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
345 // This must be a grouped option... handle them now. Grouping options can't
347 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
350 // Move current arg name out of Arg into OneArgName.
351 StringRef OneArgName = Arg.substr(0, Length);
352 Arg = Arg.substr(Length);
354 // Because ValueRequired is an invalid flag for grouped arguments,
355 // we don't need to pass argc/argv in.
356 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
357 "Option can not be cl::Grouping AND cl::ValueRequired!");
359 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
360 StringRef(), 0, 0, Dummy);
362 // Get the next grouping option.
363 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
364 } while (PGOpt && Length != Arg.size());
366 // Return the last option with Arg cut down to just the last one.
372 static bool RequiresValue(const Option *O) {
373 return O->getNumOccurrencesFlag() == cl::Required ||
374 O->getNumOccurrencesFlag() == cl::OneOrMore;
377 static bool EatsUnboundedNumberOfValues(const Option *O) {
378 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
379 O->getNumOccurrencesFlag() == cl::OneOrMore;
382 /// ParseCStringVector - Break INPUT up wherever one or more
383 /// whitespace characters are found, and store the resulting tokens in
384 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
385 /// using strdup(), so it is the caller's responsibility to free()
388 static void ParseCStringVector(std::vector<char *> &OutputVector,
390 // Characters which will be treated as token separators:
391 StringRef Delims = " \v\f\t\r\n";
393 StringRef WorkStr(Input);
394 while (!WorkStr.empty()) {
395 // If the first character is a delimiter, strip them off.
396 if (Delims.find(WorkStr[0]) != StringRef::npos) {
397 size_t Pos = WorkStr.find_first_not_of(Delims);
398 if (Pos == StringRef::npos) Pos = WorkStr.size();
399 WorkStr = WorkStr.substr(Pos);
403 // Find position of first delimiter.
404 size_t Pos = WorkStr.find_first_of(Delims);
405 if (Pos == StringRef::npos) Pos = WorkStr.size();
407 // Everything from 0 to Pos is the next word to copy.
408 char *NewStr = (char*)malloc(Pos+1);
409 memcpy(NewStr, WorkStr.data(), Pos);
411 OutputVector.push_back(NewStr);
413 WorkStr = WorkStr.substr(Pos);
417 /// ParseEnvironmentOptions - An alternative entry point to the
418 /// CommandLine library, which allows you to read the program's name
419 /// from the caller (as PROGNAME) and its command-line arguments from
420 /// an environment variable (whose name is given in ENVVAR).
422 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
423 const char *Overview, bool ReadResponseFiles) {
425 assert(progName && "Program name not specified");
426 assert(envVar && "Environment variable name missing");
428 // Get the environment variable they want us to parse options out of.
429 const char *envValue = getenv(envVar);
433 // Get program's "name", which we wouldn't know without the caller
435 std::vector<char*> newArgv;
436 newArgv.push_back(strdup(progName));
438 // Parse the value of the environment variable into a "command line"
439 // and hand it off to ParseCommandLineOptions().
440 ParseCStringVector(newArgv, envValue);
441 int newArgc = static_cast<int>(newArgv.size());
442 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
444 // Free all the strdup()ed strings.
445 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
451 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
452 /// substituting the contents of the response files for the arguments
454 static void ExpandResponseFiles(unsigned argc, char** argv,
455 std::vector<char*>& newArgv) {
456 for (unsigned i = 1; i != argc; ++i) {
460 sys::PathWithStatus respFile(++arg);
462 // Check that the response file is not empty (mmap'ing empty
463 // files can be problematic).
464 const sys::FileStatus *FileStat = respFile.getFileStatus();
465 if (FileStat && FileStat->getSize() != 0) {
467 // Mmap the response file into memory.
469 OwningPtr<MemoryBuffer>
470 respFilePtr(MemoryBuffer::getFile(respFile.c_str(), ec));
472 // If we could open the file, parse its contents, otherwise
473 // pass the @file option verbatim.
475 // TODO: we should also support recursive loading of response files,
476 // since this is how gcc behaves. (From their man page: "The file may
477 // itself contain additional @file options; any such options will be
478 // processed recursively.")
480 if (respFilePtr != 0) {
481 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
486 newArgv.push_back(strdup(arg));
490 void cl::ParseCommandLineOptions(int argc, char **argv,
491 const char *Overview, bool ReadResponseFiles) {
492 // Process all registered options.
493 SmallVector<Option*, 4> PositionalOpts;
494 SmallVector<Option*, 4> SinkOpts;
495 StringMap<Option*> Opts;
496 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
498 assert((!Opts.empty() || !PositionalOpts.empty()) &&
499 "No options specified!");
501 // Expand response files.
502 std::vector<char*> newArgv;
503 if (ReadResponseFiles) {
504 newArgv.push_back(strdup(argv[0]));
505 ExpandResponseFiles(argc, argv, newArgv);
507 argc = static_cast<int>(newArgv.size());
510 // Copy the program name into ProgName, making sure not to overflow it.
511 std::string ProgName = sys::Path(argv[0]).getLast();
512 size_t Len = std::min(ProgName.size(), size_t(79));
513 memcpy(ProgramName, ProgName.data(), Len);
514 ProgramName[Len] = '\0';
516 ProgramOverview = Overview;
517 bool ErrorParsing = false;
519 // Check out the positional arguments to collect information about them.
520 unsigned NumPositionalRequired = 0;
522 // Determine whether or not there are an unlimited number of positionals
523 bool HasUnlimitedPositionals = false;
525 Option *ConsumeAfterOpt = 0;
526 if (!PositionalOpts.empty()) {
527 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
528 assert(PositionalOpts.size() > 1 &&
529 "Cannot specify cl::ConsumeAfter without a positional argument!");
530 ConsumeAfterOpt = PositionalOpts[0];
533 // Calculate how many positional values are _required_.
534 bool UnboundedFound = false;
535 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
537 Option *Opt = PositionalOpts[i];
538 if (RequiresValue(Opt))
539 ++NumPositionalRequired;
540 else if (ConsumeAfterOpt) {
541 // ConsumeAfter cannot be combined with "optional" positional options
542 // unless there is only one positional argument...
543 if (PositionalOpts.size() > 2)
545 Opt->error("error - this positional option will never be matched, "
546 "because it does not Require a value, and a "
547 "cl::ConsumeAfter option is active!");
548 } else if (UnboundedFound && !Opt->ArgStr[0]) {
549 // This option does not "require" a value... Make sure this option is
550 // not specified after an option that eats all extra arguments, or this
551 // one will never get any!
553 ErrorParsing |= Opt->error("error - option can never match, because "
554 "another positional argument will match an "
555 "unbounded number of values, and this option"
556 " does not require a value!");
558 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
560 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
563 // PositionalVals - A vector of "positional" arguments we accumulate into
564 // the process at the end.
566 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
568 // If the program has named positional arguments, and the name has been run
569 // across, keep track of which positional argument was named. Otherwise put
570 // the positional args into the PositionalVals list...
571 Option *ActivePositionalArg = 0;
573 // Loop over all of the arguments... processing them.
574 bool DashDashFound = false; // Have we read '--'?
575 for (int i = 1; i < argc; ++i) {
578 StringRef ArgName = "";
580 // If the option list changed, this means that some command line
581 // option has just been registered or deregistered. This can occur in
582 // response to things like -load, etc. If this happens, rescan the options.
583 if (OptionListChanged) {
584 PositionalOpts.clear();
587 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
588 OptionListChanged = false;
591 // Check to see if this is a positional argument. This argument is
592 // considered to be positional if it doesn't start with '-', if it is "-"
593 // itself, or if we have seen "--" already.
595 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
596 // Positional argument!
597 if (ActivePositionalArg) {
598 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
599 continue; // We are done!
602 if (!PositionalOpts.empty()) {
603 PositionalVals.push_back(std::make_pair(argv[i],i));
605 // All of the positional arguments have been fulfulled, give the rest to
606 // the consume after option... if it's specified...
608 if (PositionalVals.size() >= NumPositionalRequired &&
609 ConsumeAfterOpt != 0) {
610 for (++i; i < argc; ++i)
611 PositionalVals.push_back(std::make_pair(argv[i],i));
612 break; // Handle outside of the argument processing loop...
615 // Delay processing positional arguments until the end...
618 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
620 DashDashFound = true; // This is the mythical "--"?
621 continue; // Don't try to process it as an argument itself.
622 } else if (ActivePositionalArg &&
623 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
624 // If there is a positional argument eating options, check to see if this
625 // option is another positional argument. If so, treat it as an argument,
626 // otherwise feed it to the eating positional.
628 // Eat leading dashes.
629 while (!ArgName.empty() && ArgName[0] == '-')
630 ArgName = ArgName.substr(1);
632 Handler = LookupOption(ArgName, Value, Opts);
633 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
634 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
635 continue; // We are done!
638 } else { // We start with a '-', must be an argument.
640 // Eat leading dashes.
641 while (!ArgName.empty() && ArgName[0] == '-')
642 ArgName = ArgName.substr(1);
644 Handler = LookupOption(ArgName, Value, Opts);
646 // Check to see if this "option" is really a prefixed or grouped argument.
648 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
653 if (SinkOpts.empty()) {
654 errs() << ProgramName << ": Unknown command line argument '"
655 << argv[i] << "'. Try: '" << argv[0] << " -help'\n";
658 for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
659 E = SinkOpts.end(); I != E ; ++I)
660 (*I)->addOccurrence(i, "", argv[i]);
665 // If this is a named positional argument, just remember that it is the
667 if (Handler->getFormattingFlag() == cl::Positional)
668 ActivePositionalArg = Handler;
670 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
673 // Check and handle positional arguments now...
674 if (NumPositionalRequired > PositionalVals.size()) {
675 errs() << ProgramName
676 << ": Not enough positional command line arguments specified!\n"
677 << "Must specify at least " << NumPositionalRequired
678 << " positional arguments: See: " << argv[0] << " -help\n";
681 } else if (!HasUnlimitedPositionals &&
682 PositionalVals.size() > PositionalOpts.size()) {
683 errs() << ProgramName
684 << ": Too many positional arguments specified!\n"
685 << "Can specify at most " << PositionalOpts.size()
686 << " positional arguments: See: " << argv[0] << " -help\n";
689 } else if (ConsumeAfterOpt == 0) {
690 // Positional args have already been handled if ConsumeAfter is specified.
691 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
692 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
693 if (RequiresValue(PositionalOpts[i])) {
694 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
695 PositionalVals[ValNo].second);
697 --NumPositionalRequired; // We fulfilled our duty...
700 // If we _can_ give this option more arguments, do so now, as long as we
701 // do not give it values that others need. 'Done' controls whether the
702 // option even _WANTS_ any more.
704 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
705 while (NumVals-ValNo > NumPositionalRequired && !Done) {
706 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
708 Done = true; // Optional arguments want _at most_ one value
710 case cl::ZeroOrMore: // Zero or more will take all they can get...
711 case cl::OneOrMore: // One or more will take all they can get...
712 ProvidePositionalOption(PositionalOpts[i],
713 PositionalVals[ValNo].first,
714 PositionalVals[ValNo].second);
718 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
719 "positional argument processing!");
724 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
726 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
727 if (RequiresValue(PositionalOpts[j])) {
728 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
729 PositionalVals[ValNo].first,
730 PositionalVals[ValNo].second);
734 // Handle the case where there is just one positional option, and it's
735 // optional. In this case, we want to give JUST THE FIRST option to the
736 // positional option and keep the rest for the consume after. The above
737 // loop would have assigned no values to positional options in this case.
739 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
740 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
741 PositionalVals[ValNo].first,
742 PositionalVals[ValNo].second);
746 // Handle over all of the rest of the arguments to the
747 // cl::ConsumeAfter command line option...
748 for (; ValNo != PositionalVals.size(); ++ValNo)
749 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
750 PositionalVals[ValNo].first,
751 PositionalVals[ValNo].second);
754 // Loop over args and make sure all required args are specified!
755 for (StringMap<Option*>::iterator I = Opts.begin(),
756 E = Opts.end(); I != E; ++I) {
757 switch (I->second->getNumOccurrencesFlag()) {
760 if (I->second->getNumOccurrences() == 0) {
761 I->second->error("must be specified at least once!");
770 // Now that we know if -debug is specified, we can use it.
771 // Note that if ReadResponseFiles == true, this must be done before the
772 // memory allocated for the expanded command line is free()d below.
773 DEBUG(dbgs() << "Args: ";
774 for (int i = 0; i < argc; ++i)
775 dbgs() << argv[i] << ' ';
779 // Free all of the memory allocated to the map. Command line options may only
780 // be processed once!
782 PositionalOpts.clear();
785 // Free the memory allocated by ExpandResponseFiles.
786 if (ReadResponseFiles) {
787 // Free all the strdup()ed strings.
788 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
793 // If we had an error processing our arguments, don't let the program execute
794 if (ErrorParsing) exit(1);
797 //===----------------------------------------------------------------------===//
798 // Option Base class implementation
801 bool Option::error(const Twine &Message, StringRef ArgName) {
802 if (ArgName.data() == 0) ArgName = ArgStr;
804 errs() << HelpStr; // Be nice for positional arguments
806 errs() << ProgramName << ": for the -" << ArgName;
808 errs() << " option: " << Message << "\n";
812 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
813 StringRef Value, bool MultiArg) {
815 NumOccurrences++; // Increment the number of times we have been seen
817 switch (getNumOccurrencesFlag()) {
819 if (NumOccurrences > 1)
820 return error("may only occur zero or one times!", ArgName);
823 if (NumOccurrences > 1)
824 return error("must occur exactly one time!", ArgName);
828 case ConsumeAfter: break;
829 default: return error("bad num occurrences flag value!");
832 return handleOccurrence(pos, ArgName, Value);
836 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
837 // has been specified yet.
839 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
840 if (O.ValueStr[0] == 0) return DefaultMsg;
844 //===----------------------------------------------------------------------===//
845 // cl::alias class implementation
848 // Return the width of the option tag for printing...
849 size_t alias::getOptionWidth() const {
850 return std::strlen(ArgStr)+6;
853 // Print out the option for the alias.
854 void alias::printOptionInfo(size_t GlobalWidth) const {
855 size_t L = std::strlen(ArgStr);
856 errs() << " -" << ArgStr;
857 errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
862 //===----------------------------------------------------------------------===//
863 // Parser Implementation code...
866 // basic_parser implementation
869 // Return the width of the option tag for printing...
870 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
871 size_t Len = std::strlen(O.ArgStr);
872 if (const char *ValName = getValueName())
873 Len += std::strlen(getValueStr(O, ValName))+3;
878 // printOptionInfo - Print out information about this option. The
879 // to-be-maintained width is specified.
881 void basic_parser_impl::printOptionInfo(const Option &O,
882 size_t GlobalWidth) const {
883 outs() << " -" << O.ArgStr;
885 if (const char *ValName = getValueName())
886 outs() << "=<" << getValueStr(O, ValName) << '>';
888 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
894 // parser<bool> implementation
896 bool parser<bool>::parse(Option &O, StringRef ArgName,
897 StringRef Arg, bool &Value) {
898 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
904 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
908 return O.error("'" + Arg +
909 "' is invalid value for boolean argument! Try 0 or 1");
912 // parser<boolOrDefault> implementation
914 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
915 StringRef Arg, boolOrDefault &Value) {
916 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
921 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
926 return O.error("'" + Arg +
927 "' is invalid value for boolean argument! Try 0 or 1");
930 // parser<int> implementation
932 bool parser<int>::parse(Option &O, StringRef ArgName,
933 StringRef Arg, int &Value) {
934 if (Arg.getAsInteger(0, Value))
935 return O.error("'" + Arg + "' value invalid for integer argument!");
939 // parser<unsigned> implementation
941 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
942 StringRef Arg, unsigned &Value) {
944 if (Arg.getAsInteger(0, Value))
945 return O.error("'" + Arg + "' value invalid for uint argument!");
949 // parser<double>/parser<float> implementation
951 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
952 SmallString<32> TmpStr(Arg.begin(), Arg.end());
953 const char *ArgStart = TmpStr.c_str();
955 Value = strtod(ArgStart, &End);
957 return O.error("'" + Arg + "' value invalid for floating point argument!");
961 bool parser<double>::parse(Option &O, StringRef ArgName,
962 StringRef Arg, double &Val) {
963 return parseDouble(O, Arg, Val);
966 bool parser<float>::parse(Option &O, StringRef ArgName,
967 StringRef Arg, float &Val) {
969 if (parseDouble(O, Arg, dVal))
977 // generic_parser_base implementation
980 // findOption - Return the option number corresponding to the specified
981 // argument string. If the option is not found, getNumOptions() is returned.
983 unsigned generic_parser_base::findOption(const char *Name) {
984 unsigned e = getNumOptions();
986 for (unsigned i = 0; i != e; ++i) {
987 if (strcmp(getOption(i), Name) == 0)
994 // Return the width of the option tag for printing...
995 size_t generic_parser_base::getOptionWidth(const Option &O) const {
997 size_t Size = std::strlen(O.ArgStr)+6;
998 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
999 Size = std::max(Size, std::strlen(getOption(i))+8);
1002 size_t BaseSize = 0;
1003 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1004 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1009 // printOptionInfo - Print out information about this option. The
1010 // to-be-maintained width is specified.
1012 void generic_parser_base::printOptionInfo(const Option &O,
1013 size_t GlobalWidth) const {
1014 if (O.hasArgStr()) {
1015 size_t L = std::strlen(O.ArgStr);
1016 outs() << " -" << O.ArgStr;
1017 outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1019 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1020 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1021 outs() << " =" << getOption(i);
1022 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1026 outs() << " " << O.HelpStr << '\n';
1027 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1028 size_t L = std::strlen(getOption(i));
1029 outs() << " -" << getOption(i);
1030 outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1036 //===----------------------------------------------------------------------===//
1037 // -help and -help-hidden option implementation
1040 static int OptNameCompare(const void *LHS, const void *RHS) {
1041 typedef std::pair<const char *, Option*> pair_ty;
1043 return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1050 const Option *EmptyArg;
1051 const bool ShowHidden;
1054 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1058 void operator=(bool Value) {
1059 if (Value == false) return;
1061 // Get all the options.
1062 SmallVector<Option*, 4> PositionalOpts;
1063 SmallVector<Option*, 4> SinkOpts;
1064 StringMap<Option*> OptMap;
1065 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1067 // Copy Options into a vector so we can sort them as we like.
1068 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1069 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1071 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1073 // Ignore really-hidden options.
1074 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1077 // Unless showhidden is set, ignore hidden flags.
1078 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1081 // If we've already seen this option, don't add it to the list again.
1082 if (!OptionSet.insert(I->second))
1085 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1089 // Sort the options list alphabetically.
1090 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1092 if (ProgramOverview)
1093 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1095 outs() << "USAGE: " << ProgramName << " [options]";
1097 // Print out the positional options.
1098 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1099 if (!PositionalOpts.empty() &&
1100 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1101 CAOpt = PositionalOpts[0];
1103 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1104 if (PositionalOpts[i]->ArgStr[0])
1105 outs() << " --" << PositionalOpts[i]->ArgStr;
1106 outs() << " " << PositionalOpts[i]->HelpStr;
1109 // Print the consume after option info if it exists...
1110 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1114 // Compute the maximum argument length...
1116 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1117 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1119 outs() << "OPTIONS:\n";
1120 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1121 Opts[i].second->printOptionInfo(MaxArgLen);
1123 // Print any extra help the user has declared.
1124 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1125 E = MoreHelp->end(); I != E; ++I)
1129 // Halt the program since help information was printed
1133 } // End anonymous namespace
1135 // Define the two HelpPrinter instances that are used to print out help, or
1138 static HelpPrinter NormalPrinter(false);
1139 static HelpPrinter HiddenPrinter(true);
1141 static cl::opt<HelpPrinter, true, parser<bool> >
1142 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1143 cl::location(NormalPrinter), cl::ValueDisallowed);
1145 static cl::opt<HelpPrinter, true, parser<bool> >
1146 HHOp("help-hidden", cl::desc("Display all available options"),
1147 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1149 static void (*OverrideVersionPrinter)() = 0;
1151 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1152 typedef std::pair<const char *, const Target*> pair_ty;
1153 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1157 class VersionPrinter {
1160 raw_ostream &OS = outs();
1161 OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1162 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1163 #ifdef LLVM_VERSION_INFO
1164 OS << LLVM_VERSION_INFO;
1167 #ifndef __OPTIMIZE__
1168 OS << "DEBUG build";
1170 OS << "Optimized build";
1173 OS << " with assertions";
1175 std::string CPU = sys::getHostCPUName();
1176 if (CPU == "generic") CPU = "(unknown)";
1178 #if (ENABLE_TIMESTAMPS == 1)
1179 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1181 << " Host: " << sys::getHostTriple() << '\n'
1182 << " Host CPU: " << CPU << '\n'
1184 << " Registered Targets:\n";
1186 std::vector<std::pair<const char *, const Target*> > Targets;
1188 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1189 ie = TargetRegistry::end(); it != ie; ++it) {
1190 Targets.push_back(std::make_pair(it->getName(), &*it));
1191 Width = std::max(Width, strlen(Targets.back().first));
1193 if (!Targets.empty())
1194 qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1197 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1198 OS << " " << Targets[i].first;
1199 OS.indent(Width - strlen(Targets[i].first)) << " - "
1200 << Targets[i].second->getShortDescription() << '\n';
1202 if (Targets.empty())
1205 void operator=(bool OptionWasSpecified) {
1206 if (!OptionWasSpecified) return;
1208 if (OverrideVersionPrinter == 0) {
1212 (*OverrideVersionPrinter)();
1216 } // End anonymous namespace
1219 // Define the --version option that prints out the LLVM version for the tool
1220 static VersionPrinter VersionPrinterInstance;
1222 static cl::opt<VersionPrinter, true, parser<bool> >
1223 VersOp("version", cl::desc("Display the version of this program"),
1224 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1226 // Utility function for printing the help message.
1227 void cl::PrintHelpMessage() {
1228 // This looks weird, but it actually prints the help message. The
1229 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1230 // its operator= is invoked. That's because the "normal" usages of the
1231 // help printer is to be assigned true/false depending on whether the
1232 // -help option was given or not. Since we're circumventing that we have
1233 // to make it look like -help was given, so we assign true.
1234 NormalPrinter = true;
1237 /// Utility function for printing version number.
1238 void cl::PrintVersionMessage() {
1239 VersionPrinterInstance.print();
1242 void cl::SetVersionPrinter(void (*func)()) {
1243 OverrideVersionPrinter = func;