1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This class implements a command line argument processor that is useful when
11 // creating a tool. It provides a simple, minimalistic interface that is easily
12 // extensible and supports nonlocal (library) command line options.
14 // Note that rather than trying to figure out what this code does, you could try
15 // reading the library documentation located in docs/CommandLine.html
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/MemoryBuffer.h"
22 #include "llvm/Support/ManagedStatic.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/Target/TargetRegistry.h"
25 #include "llvm/System/Host.h"
26 #include "llvm/System/Path.h"
27 #include "llvm/ADT/OwningPtr.h"
28 #include "llvm/ADT/SmallPtrSet.h"
29 #include "llvm/ADT/SmallString.h"
30 #include "llvm/ADT/StringMap.h"
31 #include "llvm/ADT/Twine.h"
32 #include "llvm/Config/config.h"
38 //===----------------------------------------------------------------------===//
39 // Template instantiations and anchors.
41 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
42 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
43 TEMPLATE_INSTANTIATION(class basic_parser<int>);
44 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
45 TEMPLATE_INSTANTIATION(class basic_parser<double>);
46 TEMPLATE_INSTANTIATION(class basic_parser<float>);
47 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
48 TEMPLATE_INSTANTIATION(class basic_parser<char>);
50 TEMPLATE_INSTANTIATION(class opt<unsigned>);
51 TEMPLATE_INSTANTIATION(class opt<int>);
52 TEMPLATE_INSTANTIATION(class opt<std::string>);
53 TEMPLATE_INSTANTIATION(class opt<char>);
54 TEMPLATE_INSTANTIATION(class opt<bool>);
56 void Option::anchor() {}
57 void basic_parser_impl::anchor() {}
58 void parser<bool>::anchor() {}
59 void parser<boolOrDefault>::anchor() {}
60 void parser<int>::anchor() {}
61 void parser<unsigned>::anchor() {}
62 void parser<double>::anchor() {}
63 void parser<float>::anchor() {}
64 void parser<std::string>::anchor() {}
65 void parser<char>::anchor() {}
67 //===----------------------------------------------------------------------===//
69 // Globals for name and overview of program. Program name is not a string to
70 // avoid static ctor/dtor issues.
71 static char ProgramName[80] = "<premain>";
72 static const char *ProgramOverview = 0;
74 // This collects additional help to be printed.
75 static ManagedStatic<std::vector<const char*> > MoreHelp;
77 extrahelp::extrahelp(const char *Help)
79 MoreHelp->push_back(Help);
82 static bool OptionListChanged = false;
84 // MarkOptionsChanged - Internal helper function.
85 void cl::MarkOptionsChanged() {
86 OptionListChanged = true;
89 /// RegisteredOptionList - This is the list of the command line options that
90 /// have statically constructed themselves.
91 static Option *RegisteredOptionList = 0;
93 void Option::addArgument() {
94 assert(NextRegistered == 0 && "argument multiply registered!");
96 NextRegistered = RegisteredOptionList;
97 RegisteredOptionList = this;
102 //===----------------------------------------------------------------------===//
103 // Basic, shared command line option processing machinery.
106 /// GetOptionInfo - Scan the list of registered options, turning them into data
107 /// structures that are easier to handle.
108 static void GetOptionInfo(std::vector<Option*> &PositionalOpts,
109 std::vector<Option*> &SinkOpts,
110 StringMap<Option*> &OptionsMap) {
111 std::vector<const char*> OptionNames;
112 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
113 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
114 // If this option wants to handle multiple option names, get the full set.
115 // This handles enum options like "-O1 -O2" etc.
116 O->getExtraOptionNames(OptionNames);
118 OptionNames.push_back(O->ArgStr);
120 // Handle named options.
121 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
122 // Add argument to the argument map!
123 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
124 errs() << ProgramName << ": CommandLine Error: Argument '"
125 << OptionNames[i] << "' defined more than once!\n";
131 // Remember information about positional options.
132 if (O->getFormattingFlag() == cl::Positional)
133 PositionalOpts.push_back(O);
134 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
135 SinkOpts.push_back(O);
136 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
138 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
144 PositionalOpts.push_back(CAOpt);
146 // Make sure that they are in order of registration not backwards.
147 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
151 /// LookupOption - Lookup the option specified by the specified option on the
152 /// command line. If there is a value specified (after an equal sign) return
153 /// that as well. This assumes that leading dashes have already been stripped.
154 static Option *LookupOption(StringRef &Arg, StringRef &Value,
155 const StringMap<Option*> &OptionsMap) {
156 // Reject all dashes.
157 if (Arg.empty()) return 0;
159 size_t EqualPos = Arg.find('=');
161 // If we have an equals sign, remember the value.
162 if (EqualPos == StringRef::npos) {
163 // Look up the option.
164 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
165 return I != OptionsMap.end() ? I->second : 0;
168 // If the argument before the = is a valid option name, we match. If not,
169 // return Arg unmolested.
170 StringMap<Option*>::const_iterator I =
171 OptionsMap.find(Arg.substr(0, EqualPos));
172 if (I == OptionsMap.end()) return 0;
174 Value = Arg.substr(EqualPos+1);
175 Arg = Arg.substr(0, EqualPos);
181 /// ProvideOption - For Value, this differentiates between an empty value ("")
182 /// and a null value (StringRef()). The later is accepted for arguments that
183 /// don't allow a value (-foo) the former is rejected (-foo=).
184 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
185 StringRef Value, int argc, char **argv,
187 // Is this a multi-argument option?
188 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
190 // Enforce value requirements
191 switch (Handler->getValueExpectedFlag()) {
193 if (Value.data() == 0) { // No value specified?
195 return Handler->error("requires a value!");
196 // Steal the next argument, like for '-o filename'
200 case ValueDisallowed:
201 if (NumAdditionalVals > 0)
202 return Handler->error("multi-valued option specified"
203 " with ValueDisallowed modifier!");
206 return Handler->error("does not allow a value! '" +
207 Twine(Value) + "' specified.");
213 errs() << ProgramName
214 << ": Bad ValueMask flag! CommandLine usage error:"
215 << Handler->getValueExpectedFlag() << "\n";
219 // If this isn't a multi-arg option, just run the handler.
220 if (NumAdditionalVals == 0)
221 return Handler->addOccurrence(i, ArgName, Value);
223 // If it is, run the handle several times.
224 bool MultiArg = false;
227 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
233 while (NumAdditionalVals > 0) {
235 return Handler->error("not enough values!");
238 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
246 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
248 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
252 // Option predicates...
253 static inline bool isGrouping(const Option *O) {
254 return O->getFormattingFlag() == cl::Grouping;
256 static inline bool isPrefixedOrGrouping(const Option *O) {
257 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
260 // getOptionPred - Check to see if there are any options that satisfy the
261 // specified predicate with names that are the prefixes in Name. This is
262 // checked by progressively stripping characters off of the name, checking to
263 // see if there options that satisfy the predicate. If we find one, return it,
264 // otherwise return null.
266 static Option *getOptionPred(StringRef Name, size_t &Length,
267 bool (*Pred)(const Option*),
268 const StringMap<Option*> &OptionsMap) {
270 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
272 // Loop while we haven't found an option and Name still has at least two
273 // characters in it (so that the next iteration will not be the empty
275 while (OMI == OptionsMap.end() && Name.size() > 1) {
276 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
277 OMI = OptionsMap.find(Name);
280 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
281 Length = Name.size();
282 return OMI->second; // Found one!
284 return 0; // No option found!
287 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
288 /// with at least one '-') does not fully match an available option. Check to
289 /// see if this is a prefix or grouped option. If so, split arg into output an
290 /// Arg/Value pair and return the Option to parse it with.
291 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
293 const StringMap<Option*> &OptionsMap) {
294 if (Arg.size() == 1) return 0;
298 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
299 if (PGOpt == 0) return 0;
301 // If the option is a prefixed option, then the value is simply the
302 // rest of the name... so fall through to later processing, by
303 // setting up the argument name flags and value fields.
304 if (PGOpt->getFormattingFlag() == cl::Prefix) {
305 Value = Arg.substr(Length);
306 Arg = Arg.substr(0, Length);
307 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
311 // This must be a grouped option... handle them now. Grouping options can't
313 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
316 // Move current arg name out of Arg into OneArgName.
317 StringRef OneArgName = Arg.substr(0, Length);
318 Arg = Arg.substr(Length);
320 // Because ValueRequired is an invalid flag for grouped arguments,
321 // we don't need to pass argc/argv in.
322 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
323 "Option can not be cl::Grouping AND cl::ValueRequired!");
325 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
326 StringRef(), 0, 0, Dummy);
328 // Get the next grouping option.
329 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
330 } while (PGOpt && Length != Arg.size());
332 // Return the last option with Arg cut down to just the last one.
338 static bool RequiresValue(const Option *O) {
339 return O->getNumOccurrencesFlag() == cl::Required ||
340 O->getNumOccurrencesFlag() == cl::OneOrMore;
343 static bool EatsUnboundedNumberOfValues(const Option *O) {
344 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
345 O->getNumOccurrencesFlag() == cl::OneOrMore;
348 /// ParseCStringVector - Break INPUT up wherever one or more
349 /// whitespace characters are found, and store the resulting tokens in
350 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
351 /// using strdup(), so it is the caller's responsibility to free()
354 static void ParseCStringVector(std::vector<char *> &OutputVector,
356 // Characters which will be treated as token separators:
357 StringRef Delims = " \v\f\t\r\n";
359 StringRef WorkStr(Input);
360 while (!WorkStr.empty()) {
361 // If the first character is a delimiter, strip them off.
362 if (Delims.find(WorkStr[0]) != StringRef::npos) {
363 size_t Pos = WorkStr.find_first_not_of(Delims);
364 if (Pos == StringRef::npos) Pos = WorkStr.size();
365 WorkStr = WorkStr.substr(Pos);
369 // Find position of first delimiter.
370 size_t Pos = WorkStr.find_first_of(Delims);
371 if (Pos == StringRef::npos) Pos = WorkStr.size();
373 // Everything from 0 to Pos is the next word to copy.
374 char *NewStr = (char*)malloc(Pos+1);
375 memcpy(NewStr, WorkStr.data(), Pos);
377 OutputVector.push_back(NewStr);
381 /// ParseEnvironmentOptions - An alternative entry point to the
382 /// CommandLine library, which allows you to read the program's name
383 /// from the caller (as PROGNAME) and its command-line arguments from
384 /// an environment variable (whose name is given in ENVVAR).
386 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
387 const char *Overview, bool ReadResponseFiles) {
389 assert(progName && "Program name not specified");
390 assert(envVar && "Environment variable name missing");
392 // Get the environment variable they want us to parse options out of.
393 const char *envValue = getenv(envVar);
397 // Get program's "name", which we wouldn't know without the caller
399 std::vector<char*> newArgv;
400 newArgv.push_back(strdup(progName));
402 // Parse the value of the environment variable into a "command line"
403 // and hand it off to ParseCommandLineOptions().
404 ParseCStringVector(newArgv, envValue);
405 int newArgc = static_cast<int>(newArgv.size());
406 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
408 // Free all the strdup()ed strings.
409 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
415 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
416 /// substituting the contents of the response files for the arguments
418 static void ExpandResponseFiles(unsigned argc, char** argv,
419 std::vector<char*>& newArgv) {
420 for (unsigned i = 1; i != argc; ++i) {
424 sys::PathWithStatus respFile(++arg);
426 // Check that the response file is not empty (mmap'ing empty
427 // files can be problematic).
428 const sys::FileStatus *FileStat = respFile.getFileStatus();
429 if (FileStat && FileStat->getSize() != 0) {
431 // Mmap the response file into memory.
432 OwningPtr<MemoryBuffer>
433 respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
435 // If we could open the file, parse its contents, otherwise
436 // pass the @file option verbatim.
438 // TODO: we should also support recursive loading of response files,
439 // since this is how gcc behaves. (From their man page: "The file may
440 // itself contain additional @file options; any such options will be
441 // processed recursively.")
443 if (respFilePtr != 0) {
444 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
449 newArgv.push_back(strdup(arg));
453 void cl::ParseCommandLineOptions(int argc, char **argv,
454 const char *Overview, bool ReadResponseFiles) {
455 // Process all registered options.
456 std::vector<Option*> PositionalOpts;
457 std::vector<Option*> SinkOpts;
458 StringMap<Option*> Opts;
459 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
461 assert((!Opts.empty() || !PositionalOpts.empty()) &&
462 "No options specified!");
464 // Expand response files.
465 std::vector<char*> newArgv;
466 if (ReadResponseFiles) {
467 newArgv.push_back(strdup(argv[0]));
468 ExpandResponseFiles(argc, argv, newArgv);
470 argc = static_cast<int>(newArgv.size());
473 // Copy the program name into ProgName, making sure not to overflow it.
474 std::string ProgName = sys::Path(argv[0]).getLast();
475 if (ProgName.size() > 79) ProgName.resize(79);
476 strcpy(ProgramName, ProgName.c_str());
478 ProgramOverview = Overview;
479 bool ErrorParsing = false;
481 // Check out the positional arguments to collect information about them.
482 unsigned NumPositionalRequired = 0;
484 // Determine whether or not there are an unlimited number of positionals
485 bool HasUnlimitedPositionals = false;
487 Option *ConsumeAfterOpt = 0;
488 if (!PositionalOpts.empty()) {
489 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
490 assert(PositionalOpts.size() > 1 &&
491 "Cannot specify cl::ConsumeAfter without a positional argument!");
492 ConsumeAfterOpt = PositionalOpts[0];
495 // Calculate how many positional values are _required_.
496 bool UnboundedFound = false;
497 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
499 Option *Opt = PositionalOpts[i];
500 if (RequiresValue(Opt))
501 ++NumPositionalRequired;
502 else if (ConsumeAfterOpt) {
503 // ConsumeAfter cannot be combined with "optional" positional options
504 // unless there is only one positional argument...
505 if (PositionalOpts.size() > 2)
507 Opt->error("error - this positional option will never be matched, "
508 "because it does not Require a value, and a "
509 "cl::ConsumeAfter option is active!");
510 } else if (UnboundedFound && !Opt->ArgStr[0]) {
511 // This option does not "require" a value... Make sure this option is
512 // not specified after an option that eats all extra arguments, or this
513 // one will never get any!
515 ErrorParsing |= Opt->error("error - option can never match, because "
516 "another positional argument will match an "
517 "unbounded number of values, and this option"
518 " does not require a value!");
520 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
522 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
525 // PositionalVals - A vector of "positional" arguments we accumulate into
526 // the process at the end.
528 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
530 // If the program has named positional arguments, and the name has been run
531 // across, keep track of which positional argument was named. Otherwise put
532 // the positional args into the PositionalVals list...
533 Option *ActivePositionalArg = 0;
535 // Loop over all of the arguments... processing them.
536 bool DashDashFound = false; // Have we read '--'?
537 for (int i = 1; i < argc; ++i) {
540 StringRef ArgName = "";
542 // If the option list changed, this means that some command line
543 // option has just been registered or deregistered. This can occur in
544 // response to things like -load, etc. If this happens, rescan the options.
545 if (OptionListChanged) {
546 PositionalOpts.clear();
549 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
550 OptionListChanged = false;
553 // Check to see if this is a positional argument. This argument is
554 // considered to be positional if it doesn't start with '-', if it is "-"
555 // itself, or if we have seen "--" already.
557 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
558 // Positional argument!
559 if (ActivePositionalArg) {
560 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
561 continue; // We are done!
564 if (!PositionalOpts.empty()) {
565 PositionalVals.push_back(std::make_pair(argv[i],i));
567 // All of the positional arguments have been fulfulled, give the rest to
568 // the consume after option... if it's specified...
570 if (PositionalVals.size() >= NumPositionalRequired &&
571 ConsumeAfterOpt != 0) {
572 for (++i; i < argc; ++i)
573 PositionalVals.push_back(std::make_pair(argv[i],i));
574 break; // Handle outside of the argument processing loop...
577 // Delay processing positional arguments until the end...
580 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
582 DashDashFound = true; // This is the mythical "--"?
583 continue; // Don't try to process it as an argument itself.
584 } else if (ActivePositionalArg &&
585 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
586 // If there is a positional argument eating options, check to see if this
587 // option is another positional argument. If so, treat it as an argument,
588 // otherwise feed it to the eating positional.
590 // Eat leading dashes.
591 while (!ArgName.empty() && ArgName[0] == '-')
592 ArgName = ArgName.substr(1);
594 Handler = LookupOption(ArgName, Value, Opts);
595 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
596 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
597 continue; // We are done!
600 } else { // We start with a '-', must be an argument.
602 // Eat leading dashes.
603 while (!ArgName.empty() && ArgName[0] == '-')
604 ArgName = ArgName.substr(1);
606 Handler = LookupOption(ArgName, Value, Opts);
608 // Check to see if this "option" is really a prefixed or grouped argument.
610 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
615 if (SinkOpts.empty()) {
616 errs() << ProgramName << ": Unknown command line argument '"
617 << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
620 for (std::vector<Option*>::iterator I = SinkOpts.begin(),
621 E = SinkOpts.end(); I != E ; ++I)
622 (*I)->addOccurrence(i, "", argv[i]);
627 // Check to see if this option accepts a comma separated list of values. If
628 // it does, we have to split up the value into multiple values.
629 if (Handler->getMiscFlags() & CommaSeparated) {
630 StringRef Val(Value);
631 StringRef::size_type Pos = Val.find(',');
633 while (Pos != StringRef::npos) {
634 // Process the portion before the comma.
635 ErrorParsing |= ProvideOption(Handler, ArgName, Val.substr(0, Pos),
637 // Erase the portion before the comma, AND the comma.
638 Val = Val.substr(Pos+1);
639 Value.substr(Pos+1); // Increment the original value pointer as well.
641 // Check for another comma.
646 // If this is a named positional argument, just remember that it is the
648 if (Handler->getFormattingFlag() == cl::Positional)
649 ActivePositionalArg = Handler;
651 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
654 // Check and handle positional arguments now...
655 if (NumPositionalRequired > PositionalVals.size()) {
656 errs() << ProgramName
657 << ": Not enough positional command line arguments specified!\n"
658 << "Must specify at least " << NumPositionalRequired
659 << " positional arguments: See: " << argv[0] << " --help\n";
662 } else if (!HasUnlimitedPositionals
663 && PositionalVals.size() > PositionalOpts.size()) {
664 errs() << ProgramName
665 << ": Too many positional arguments specified!\n"
666 << "Can specify at most " << PositionalOpts.size()
667 << " positional arguments: See: " << argv[0] << " --help\n";
670 } else if (ConsumeAfterOpt == 0) {
671 // Positional args have already been handled if ConsumeAfter is specified.
672 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
673 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
674 if (RequiresValue(PositionalOpts[i])) {
675 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
676 PositionalVals[ValNo].second);
678 --NumPositionalRequired; // We fulfilled our duty...
681 // If we _can_ give this option more arguments, do so now, as long as we
682 // do not give it values that others need. 'Done' controls whether the
683 // option even _WANTS_ any more.
685 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
686 while (NumVals-ValNo > NumPositionalRequired && !Done) {
687 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
689 Done = true; // Optional arguments want _at most_ one value
691 case cl::ZeroOrMore: // Zero or more will take all they can get...
692 case cl::OneOrMore: // One or more will take all they can get...
693 ProvidePositionalOption(PositionalOpts[i],
694 PositionalVals[ValNo].first,
695 PositionalVals[ValNo].second);
699 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
700 "positional argument processing!");
705 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
707 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
708 if (RequiresValue(PositionalOpts[j])) {
709 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
710 PositionalVals[ValNo].first,
711 PositionalVals[ValNo].second);
715 // Handle the case where there is just one positional option, and it's
716 // optional. In this case, we want to give JUST THE FIRST option to the
717 // positional option and keep the rest for the consume after. The above
718 // loop would have assigned no values to positional options in this case.
720 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
721 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
722 PositionalVals[ValNo].first,
723 PositionalVals[ValNo].second);
727 // Handle over all of the rest of the arguments to the
728 // cl::ConsumeAfter command line option...
729 for (; ValNo != PositionalVals.size(); ++ValNo)
730 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
731 PositionalVals[ValNo].first,
732 PositionalVals[ValNo].second);
735 // Loop over args and make sure all required args are specified!
736 for (StringMap<Option*>::iterator I = Opts.begin(),
737 E = Opts.end(); I != E; ++I) {
738 switch (I->second->getNumOccurrencesFlag()) {
741 if (I->second->getNumOccurrences() == 0) {
742 I->second->error("must be specified at least once!");
751 // Free all of the memory allocated to the map. Command line options may only
752 // be processed once!
754 PositionalOpts.clear();
757 // Free the memory allocated by ExpandResponseFiles.
758 if (ReadResponseFiles) {
759 // Free all the strdup()ed strings.
760 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
765 // If we had an error processing our arguments, don't let the program execute
766 if (ErrorParsing) exit(1);
769 //===----------------------------------------------------------------------===//
770 // Option Base class implementation
773 bool Option::error(const Twine &Message, StringRef ArgName) {
774 if (ArgName.data() == 0) ArgName = ArgStr;
776 errs() << HelpStr; // Be nice for positional arguments
778 errs() << ProgramName << ": for the -" << ArgName;
780 errs() << " option: " << Message << "\n";
784 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
785 StringRef Value, bool MultiArg) {
787 NumOccurrences++; // Increment the number of times we have been seen
789 switch (getNumOccurrencesFlag()) {
791 if (NumOccurrences > 1)
792 return error("may only occur zero or one times!", ArgName);
795 if (NumOccurrences > 1)
796 return error("must occur exactly one time!", ArgName);
800 case ConsumeAfter: break;
801 default: return error("bad num occurrences flag value!");
804 return handleOccurrence(pos, ArgName, Value);
808 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
809 // has been specified yet.
811 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
812 if (O.ValueStr[0] == 0) return DefaultMsg;
816 //===----------------------------------------------------------------------===//
817 // cl::alias class implementation
820 // Return the width of the option tag for printing...
821 size_t alias::getOptionWidth() const {
822 return std::strlen(ArgStr)+6;
825 // Print out the option for the alias.
826 void alias::printOptionInfo(size_t GlobalWidth) const {
827 size_t L = std::strlen(ArgStr);
828 errs() << " -" << ArgStr;
829 errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
834 //===----------------------------------------------------------------------===//
835 // Parser Implementation code...
838 // basic_parser implementation
841 // Return the width of the option tag for printing...
842 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
843 size_t Len = std::strlen(O.ArgStr);
844 if (const char *ValName = getValueName())
845 Len += std::strlen(getValueStr(O, ValName))+3;
850 // printOptionInfo - Print out information about this option. The
851 // to-be-maintained width is specified.
853 void basic_parser_impl::printOptionInfo(const Option &O,
854 size_t GlobalWidth) const {
855 outs() << " -" << O.ArgStr;
857 if (const char *ValName = getValueName())
858 outs() << "=<" << getValueStr(O, ValName) << '>';
860 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
866 // parser<bool> implementation
868 bool parser<bool>::parse(Option &O, StringRef ArgName,
869 StringRef Arg, bool &Value) {
870 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
876 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
880 return O.error("'" + Arg +
881 "' is invalid value for boolean argument! Try 0 or 1");
884 // parser<boolOrDefault> implementation
886 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
887 StringRef Arg, boolOrDefault &Value) {
888 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
893 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
898 return O.error("'" + Arg +
899 "' is invalid value for boolean argument! Try 0 or 1");
902 // parser<int> implementation
904 bool parser<int>::parse(Option &O, StringRef ArgName,
905 StringRef Arg, int &Value) {
906 if (Arg.getAsInteger(0, Value))
907 return O.error("'" + Arg + "' value invalid for integer argument!");
911 // parser<unsigned> implementation
913 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
914 StringRef Arg, unsigned &Value) {
916 if (Arg.getAsInteger(0, Value))
917 return O.error("'" + Arg + "' value invalid for uint argument!");
921 // parser<double>/parser<float> implementation
923 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
924 SmallString<32> TmpStr(Arg.begin(), Arg.end());
925 const char *ArgStart = TmpStr.c_str();
927 Value = strtod(ArgStart, &End);
929 return O.error("'" + Arg + "' value invalid for floating point argument!");
933 bool parser<double>::parse(Option &O, StringRef ArgName,
934 StringRef Arg, double &Val) {
935 return parseDouble(O, Arg, Val);
938 bool parser<float>::parse(Option &O, StringRef ArgName,
939 StringRef Arg, float &Val) {
941 if (parseDouble(O, Arg, dVal))
949 // generic_parser_base implementation
952 // findOption - Return the option number corresponding to the specified
953 // argument string. If the option is not found, getNumOptions() is returned.
955 unsigned generic_parser_base::findOption(const char *Name) {
956 unsigned e = getNumOptions();
958 for (unsigned i = 0; i != e; ++i) {
959 if (strcmp(getOption(i), Name) == 0)
966 // Return the width of the option tag for printing...
967 size_t generic_parser_base::getOptionWidth(const Option &O) const {
969 size_t Size = std::strlen(O.ArgStr)+6;
970 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
971 Size = std::max(Size, std::strlen(getOption(i))+8);
975 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
976 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
981 // printOptionInfo - Print out information about this option. The
982 // to-be-maintained width is specified.
984 void generic_parser_base::printOptionInfo(const Option &O,
985 size_t GlobalWidth) const {
987 size_t L = std::strlen(O.ArgStr);
988 outs() << " -" << O.ArgStr;
989 outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
991 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
992 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
993 outs() << " =" << getOption(i);
994 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
998 outs() << " " << O.HelpStr << '\n';
999 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1000 size_t L = std::strlen(getOption(i));
1001 outs() << " -" << getOption(i);
1002 outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1008 //===----------------------------------------------------------------------===//
1009 // --help and --help-hidden option implementation
1012 static int OptNameCompare(const void *LHS, const void *RHS) {
1013 typedef std::pair<const char *, Option*> pair_ty;
1015 return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1022 const Option *EmptyArg;
1023 const bool ShowHidden;
1026 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1030 void operator=(bool Value) {
1031 if (Value == false) return;
1033 // Get all the options.
1034 std::vector<Option*> PositionalOpts;
1035 std::vector<Option*> SinkOpts;
1036 StringMap<Option*> OptMap;
1037 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1039 // Copy Options into a vector so we can sort them as we like.
1040 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1041 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1043 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1045 // Ignore really-hidden options.
1046 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1049 // Unless showhidden is set, ignore hidden flags.
1050 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1053 // If we've already seen this option, don't add it to the list again.
1054 if (!OptionSet.insert(I->second))
1057 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1061 // Sort the options list alphabetically.
1062 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1064 if (ProgramOverview)
1065 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1067 outs() << "USAGE: " << ProgramName << " [options]";
1069 // Print out the positional options.
1070 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1071 if (!PositionalOpts.empty() &&
1072 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1073 CAOpt = PositionalOpts[0];
1075 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1076 if (PositionalOpts[i]->ArgStr[0])
1077 outs() << " --" << PositionalOpts[i]->ArgStr;
1078 outs() << " " << PositionalOpts[i]->HelpStr;
1081 // Print the consume after option info if it exists...
1082 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1086 // Compute the maximum argument length...
1088 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1089 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1091 outs() << "OPTIONS:\n";
1092 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1093 Opts[i].second->printOptionInfo(MaxArgLen);
1095 // Print any extra help the user has declared.
1096 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1097 E = MoreHelp->end(); I != E; ++I)
1101 // Halt the program since help information was printed
1105 } // End anonymous namespace
1107 // Define the two HelpPrinter instances that are used to print out help, or
1110 static HelpPrinter NormalPrinter(false);
1111 static HelpPrinter HiddenPrinter(true);
1113 static cl::opt<HelpPrinter, true, parser<bool> >
1114 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1115 cl::location(NormalPrinter), cl::ValueDisallowed);
1117 static cl::opt<HelpPrinter, true, parser<bool> >
1118 HHOp("help-hidden", cl::desc("Display all available options"),
1119 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1121 static void (*OverrideVersionPrinter)() = 0;
1123 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1124 typedef std::pair<const char *, const Target*> pair_ty;
1125 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1129 class VersionPrinter {
1132 outs() << "Low Level Virtual Machine (http://llvm.org/):\n"
1133 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1134 #ifdef LLVM_VERSION_INFO
1135 outs() << LLVM_VERSION_INFO;
1138 #ifndef __OPTIMIZE__
1139 outs() << "DEBUG build";
1141 outs() << "Optimized build";
1144 outs() << " with assertions";
1147 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1148 << " Host: " << sys::getHostTriple() << '\n'
1150 << " Registered Targets:\n";
1152 std::vector<std::pair<const char *, const Target*> > Targets;
1154 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1155 ie = TargetRegistry::end(); it != ie; ++it) {
1156 Targets.push_back(std::make_pair(it->getName(), &*it));
1157 Width = std::max(Width, strlen(Targets.back().first));
1159 if (!Targets.empty())
1160 qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1163 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1164 outs() << " " << Targets[i].first;
1165 outs().indent(Width - strlen(Targets[i].first)) << " - "
1166 << Targets[i].second->getShortDescription() << '\n';
1168 if (Targets.empty())
1169 outs() << " (none)\n";
1171 void operator=(bool OptionWasSpecified) {
1172 if (!OptionWasSpecified) return;
1174 if (OverrideVersionPrinter == 0) {
1178 (*OverrideVersionPrinter)();
1182 } // End anonymous namespace
1185 // Define the --version option that prints out the LLVM version for the tool
1186 static VersionPrinter VersionPrinterInstance;
1188 static cl::opt<VersionPrinter, true, parser<bool> >
1189 VersOp("version", cl::desc("Display the version of this program"),
1190 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1192 // Utility function for printing the help message.
1193 void cl::PrintHelpMessage() {
1194 // This looks weird, but it actually prints the help message. The
1195 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1196 // its operator= is invoked. That's because the "normal" usages of the
1197 // help printer is to be assigned true/false depending on whether the
1198 // --help option was given or not. Since we're circumventing that we have
1199 // to make it look like --help was given, so we assign true.
1200 NormalPrinter = true;
1203 /// Utility function for printing version number.
1204 void cl::PrintVersionMessage() {
1205 VersionPrinterInstance.print();
1208 void cl::SetVersionPrinter(void (*func)()) {
1209 OverrideVersionPrinter = func;