1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This class implements a command line argument processor that is useful when
11 // creating a tool. It provides a simple, minimalistic interface that is easily
12 // extensible and supports nonlocal (library) command line options.
14 // Note that rather than trying to figure out what this code does, you could try
15 // reading the library documentation located in docs/CommandLine.html
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/system_error.h"
26 #include "llvm/Target/TargetRegistry.h"
27 #include "llvm/Support/Host.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/ADT/OwningPtr.h"
30 #include "llvm/ADT/SmallPtrSet.h"
31 #include "llvm/ADT/SmallString.h"
32 #include "llvm/ADT/StringMap.h"
33 #include "llvm/ADT/Twine.h"
34 #include "llvm/Config/config.h"
40 //===----------------------------------------------------------------------===//
41 // Template instantiations and anchors.
43 namespace llvm { namespace cl {
44 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
45 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
46 TEMPLATE_INSTANTIATION(class basic_parser<int>);
47 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
48 TEMPLATE_INSTANTIATION(class basic_parser<double>);
49 TEMPLATE_INSTANTIATION(class basic_parser<float>);
50 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
51 TEMPLATE_INSTANTIATION(class basic_parser<char>);
53 TEMPLATE_INSTANTIATION(class opt<unsigned>);
54 TEMPLATE_INSTANTIATION(class opt<int>);
55 TEMPLATE_INSTANTIATION(class opt<std::string>);
56 TEMPLATE_INSTANTIATION(class opt<char>);
57 TEMPLATE_INSTANTIATION(class opt<bool>);
58 } } // end namespace llvm::cl
60 void Option::anchor() {}
61 void basic_parser_impl::anchor() {}
62 void parser<bool>::anchor() {}
63 void parser<boolOrDefault>::anchor() {}
64 void parser<int>::anchor() {}
65 void parser<unsigned>::anchor() {}
66 void parser<double>::anchor() {}
67 void parser<float>::anchor() {}
68 void parser<std::string>::anchor() {}
69 void parser<char>::anchor() {}
71 //===----------------------------------------------------------------------===//
73 // Globals for name and overview of program. Program name is not a string to
74 // avoid static ctor/dtor issues.
75 static char ProgramName[80] = "<premain>";
76 static const char *ProgramOverview = 0;
78 // This collects additional help to be printed.
79 static ManagedStatic<std::vector<const char*> > MoreHelp;
81 extrahelp::extrahelp(const char *Help)
83 MoreHelp->push_back(Help);
86 static bool OptionListChanged = false;
88 // MarkOptionsChanged - Internal helper function.
89 void cl::MarkOptionsChanged() {
90 OptionListChanged = true;
93 /// RegisteredOptionList - This is the list of the command line options that
94 /// have statically constructed themselves.
95 static Option *RegisteredOptionList = 0;
97 void Option::addArgument() {
98 assert(NextRegistered == 0 && "argument multiply registered!");
100 NextRegistered = RegisteredOptionList;
101 RegisteredOptionList = this;
102 MarkOptionsChanged();
106 //===----------------------------------------------------------------------===//
107 // Basic, shared command line option processing machinery.
110 /// GetOptionInfo - Scan the list of registered options, turning them into data
111 /// structures that are easier to handle.
112 static void GetOptionInfo(SmallVectorImpl<Option*> &PositionalOpts,
113 SmallVectorImpl<Option*> &SinkOpts,
114 StringMap<Option*> &OptionsMap) {
115 SmallVector<const char*, 16> OptionNames;
116 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
117 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
118 // If this option wants to handle multiple option names, get the full set.
119 // This handles enum options like "-O1 -O2" etc.
120 O->getExtraOptionNames(OptionNames);
122 OptionNames.push_back(O->ArgStr);
124 // Handle named options.
125 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
126 // Add argument to the argument map!
127 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
128 errs() << ProgramName << ": CommandLine Error: Argument '"
129 << OptionNames[i] << "' defined more than once!\n";
135 // Remember information about positional options.
136 if (O->getFormattingFlag() == cl::Positional)
137 PositionalOpts.push_back(O);
138 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
139 SinkOpts.push_back(O);
140 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
142 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
148 PositionalOpts.push_back(CAOpt);
150 // Make sure that they are in order of registration not backwards.
151 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
155 /// LookupOption - Lookup the option specified by the specified option on the
156 /// command line. If there is a value specified (after an equal sign) return
157 /// that as well. This assumes that leading dashes have already been stripped.
158 static Option *LookupOption(StringRef &Arg, StringRef &Value,
159 const StringMap<Option*> &OptionsMap) {
160 // Reject all dashes.
161 if (Arg.empty()) return 0;
163 size_t EqualPos = Arg.find('=');
165 // If we have an equals sign, remember the value.
166 if (EqualPos == StringRef::npos) {
167 // Look up the option.
168 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
169 return I != OptionsMap.end() ? I->second : 0;
172 // If the argument before the = is a valid option name, we match. If not,
173 // return Arg unmolested.
174 StringMap<Option*>::const_iterator I =
175 OptionsMap.find(Arg.substr(0, EqualPos));
176 if (I == OptionsMap.end()) return 0;
178 Value = Arg.substr(EqualPos+1);
179 Arg = Arg.substr(0, EqualPos);
183 /// LookupNearestOption - Lookup the closest match to the option specified by
184 /// the specified option on the command line. If there is a value specified
185 /// (after an equal sign) return that as well. This assumes that leading dashes
186 /// have already been stripped.
187 static Option *LookupNearestOption(StringRef Arg,
188 const StringMap<Option*> &OptionsMap,
189 const char *&NearestString) {
190 // Reject all dashes.
191 if (Arg.empty()) return 0;
193 // Split on any equal sign.
194 StringRef LHS = Arg.split('=').first;
196 // Find the closest match.
198 unsigned BestDistance = 0;
199 for (StringMap<Option*>::const_iterator it = OptionsMap.begin(),
200 ie = OptionsMap.end(); it != ie; ++it) {
201 Option *O = it->second;
202 SmallVector<const char*, 16> OptionNames;
203 O->getExtraOptionNames(OptionNames);
205 OptionNames.push_back(O->ArgStr);
207 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
208 StringRef Name = OptionNames[i];
209 unsigned Distance = StringRef(Name).edit_distance(
210 Arg, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
211 if (!Best || Distance < BestDistance) {
213 NearestString = OptionNames[i];
214 BestDistance = Distance;
222 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
223 /// does special handling of cl::CommaSeparated options.
224 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
226 StringRef Value, bool MultiArg = false)
228 // Check to see if this option accepts a comma separated list of values. If
229 // it does, we have to split up the value into multiple values.
230 if (Handler->getMiscFlags() & CommaSeparated) {
231 StringRef Val(Value);
232 StringRef::size_type Pos = Val.find(',');
234 while (Pos != StringRef::npos) {
235 // Process the portion before the comma.
236 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
238 // Erase the portion before the comma, AND the comma.
239 Val = Val.substr(Pos+1);
240 Value.substr(Pos+1); // Increment the original value pointer as well.
241 // Check for another comma.
248 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
254 /// ProvideOption - For Value, this differentiates between an empty value ("")
255 /// and a null value (StringRef()). The later is accepted for arguments that
256 /// don't allow a value (-foo) the former is rejected (-foo=).
257 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
258 StringRef Value, int argc, char **argv,
260 // Is this a multi-argument option?
261 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
263 // Enforce value requirements
264 switch (Handler->getValueExpectedFlag()) {
266 if (Value.data() == 0) { // No value specified?
268 return Handler->error("requires a value!");
269 // Steal the next argument, like for '-o filename'
273 case ValueDisallowed:
274 if (NumAdditionalVals > 0)
275 return Handler->error("multi-valued option specified"
276 " with ValueDisallowed modifier!");
279 return Handler->error("does not allow a value! '" +
280 Twine(Value) + "' specified.");
286 errs() << ProgramName
287 << ": Bad ValueMask flag! CommandLine usage error:"
288 << Handler->getValueExpectedFlag() << "\n";
292 // If this isn't a multi-arg option, just run the handler.
293 if (NumAdditionalVals == 0)
294 return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
296 // If it is, run the handle several times.
297 bool MultiArg = false;
300 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
306 while (NumAdditionalVals > 0) {
308 return Handler->error("not enough values!");
311 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
319 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
321 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
325 // Option predicates...
326 static inline bool isGrouping(const Option *O) {
327 return O->getFormattingFlag() == cl::Grouping;
329 static inline bool isPrefixedOrGrouping(const Option *O) {
330 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
333 // getOptionPred - Check to see if there are any options that satisfy the
334 // specified predicate with names that are the prefixes in Name. This is
335 // checked by progressively stripping characters off of the name, checking to
336 // see if there options that satisfy the predicate. If we find one, return it,
337 // otherwise return null.
339 static Option *getOptionPred(StringRef Name, size_t &Length,
340 bool (*Pred)(const Option*),
341 const StringMap<Option*> &OptionsMap) {
343 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
345 // Loop while we haven't found an option and Name still has at least two
346 // characters in it (so that the next iteration will not be the empty
348 while (OMI == OptionsMap.end() && Name.size() > 1) {
349 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
350 OMI = OptionsMap.find(Name);
353 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
354 Length = Name.size();
355 return OMI->second; // Found one!
357 return 0; // No option found!
360 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
361 /// with at least one '-') does not fully match an available option. Check to
362 /// see if this is a prefix or grouped option. If so, split arg into output an
363 /// Arg/Value pair and return the Option to parse it with.
364 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
366 const StringMap<Option*> &OptionsMap) {
367 if (Arg.size() == 1) return 0;
371 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
372 if (PGOpt == 0) return 0;
374 // If the option is a prefixed option, then the value is simply the
375 // rest of the name... so fall through to later processing, by
376 // setting up the argument name flags and value fields.
377 if (PGOpt->getFormattingFlag() == cl::Prefix) {
378 Value = Arg.substr(Length);
379 Arg = Arg.substr(0, Length);
380 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
384 // This must be a grouped option... handle them now. Grouping options can't
386 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
389 // Move current arg name out of Arg into OneArgName.
390 StringRef OneArgName = Arg.substr(0, Length);
391 Arg = Arg.substr(Length);
393 // Because ValueRequired is an invalid flag for grouped arguments,
394 // we don't need to pass argc/argv in.
395 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
396 "Option can not be cl::Grouping AND cl::ValueRequired!");
398 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
399 StringRef(), 0, 0, Dummy);
401 // Get the next grouping option.
402 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
403 } while (PGOpt && Length != Arg.size());
405 // Return the last option with Arg cut down to just the last one.
411 static bool RequiresValue(const Option *O) {
412 return O->getNumOccurrencesFlag() == cl::Required ||
413 O->getNumOccurrencesFlag() == cl::OneOrMore;
416 static bool EatsUnboundedNumberOfValues(const Option *O) {
417 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
418 O->getNumOccurrencesFlag() == cl::OneOrMore;
421 /// ParseCStringVector - Break INPUT up wherever one or more
422 /// whitespace characters are found, and store the resulting tokens in
423 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
424 /// using strdup(), so it is the caller's responsibility to free()
427 static void ParseCStringVector(std::vector<char *> &OutputVector,
429 // Characters which will be treated as token separators:
430 StringRef Delims = " \v\f\t\r\n";
432 StringRef WorkStr(Input);
433 while (!WorkStr.empty()) {
434 // If the first character is a delimiter, strip them off.
435 if (Delims.find(WorkStr[0]) != StringRef::npos) {
436 size_t Pos = WorkStr.find_first_not_of(Delims);
437 if (Pos == StringRef::npos) Pos = WorkStr.size();
438 WorkStr = WorkStr.substr(Pos);
442 // Find position of first delimiter.
443 size_t Pos = WorkStr.find_first_of(Delims);
444 if (Pos == StringRef::npos) Pos = WorkStr.size();
446 // Everything from 0 to Pos is the next word to copy.
447 char *NewStr = (char*)malloc(Pos+1);
448 memcpy(NewStr, WorkStr.data(), Pos);
450 OutputVector.push_back(NewStr);
452 WorkStr = WorkStr.substr(Pos);
456 /// ParseEnvironmentOptions - An alternative entry point to the
457 /// CommandLine library, which allows you to read the program's name
458 /// from the caller (as PROGNAME) and its command-line arguments from
459 /// an environment variable (whose name is given in ENVVAR).
461 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
462 const char *Overview, bool ReadResponseFiles) {
464 assert(progName && "Program name not specified");
465 assert(envVar && "Environment variable name missing");
467 // Get the environment variable they want us to parse options out of.
468 const char *envValue = getenv(envVar);
472 // Get program's "name", which we wouldn't know without the caller
474 std::vector<char*> newArgv;
475 newArgv.push_back(strdup(progName));
477 // Parse the value of the environment variable into a "command line"
478 // and hand it off to ParseCommandLineOptions().
479 ParseCStringVector(newArgv, envValue);
480 int newArgc = static_cast<int>(newArgv.size());
481 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
483 // Free all the strdup()ed strings.
484 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
490 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
491 /// substituting the contents of the response files for the arguments
493 static void ExpandResponseFiles(unsigned argc, char** argv,
494 std::vector<char*>& newArgv) {
495 for (unsigned i = 1; i != argc; ++i) {
499 sys::PathWithStatus respFile(++arg);
501 // Check that the response file is not empty (mmap'ing empty
502 // files can be problematic).
503 const sys::FileStatus *FileStat = respFile.getFileStatus();
504 if (FileStat && FileStat->getSize() != 0) {
506 // If we could open the file, parse its contents, otherwise
507 // pass the @file option verbatim.
509 // TODO: we should also support recursive loading of response files,
510 // since this is how gcc behaves. (From their man page: "The file may
511 // itself contain additional @file options; any such options will be
512 // processed recursively.")
514 // Mmap the response file into memory.
515 OwningPtr<MemoryBuffer> respFilePtr;
516 if (!MemoryBuffer::getFile(respFile.c_str(), respFilePtr)) {
517 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
522 newArgv.push_back(strdup(arg));
526 void cl::ParseCommandLineOptions(int argc, char **argv,
527 const char *Overview, bool ReadResponseFiles) {
528 // Process all registered options.
529 SmallVector<Option*, 4> PositionalOpts;
530 SmallVector<Option*, 4> SinkOpts;
531 StringMap<Option*> Opts;
532 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
534 assert((!Opts.empty() || !PositionalOpts.empty()) &&
535 "No options specified!");
537 // Expand response files.
538 std::vector<char*> newArgv;
539 if (ReadResponseFiles) {
540 newArgv.push_back(strdup(argv[0]));
541 ExpandResponseFiles(argc, argv, newArgv);
543 argc = static_cast<int>(newArgv.size());
546 // Copy the program name into ProgName, making sure not to overflow it.
547 std::string ProgName = sys::path::filename(argv[0]);
548 size_t Len = std::min(ProgName.size(), size_t(79));
549 memcpy(ProgramName, ProgName.data(), Len);
550 ProgramName[Len] = '\0';
552 ProgramOverview = Overview;
553 bool ErrorParsing = false;
555 // Check out the positional arguments to collect information about them.
556 unsigned NumPositionalRequired = 0;
558 // Determine whether or not there are an unlimited number of positionals
559 bool HasUnlimitedPositionals = false;
561 Option *ConsumeAfterOpt = 0;
562 if (!PositionalOpts.empty()) {
563 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
564 assert(PositionalOpts.size() > 1 &&
565 "Cannot specify cl::ConsumeAfter without a positional argument!");
566 ConsumeAfterOpt = PositionalOpts[0];
569 // Calculate how many positional values are _required_.
570 bool UnboundedFound = false;
571 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
573 Option *Opt = PositionalOpts[i];
574 if (RequiresValue(Opt))
575 ++NumPositionalRequired;
576 else if (ConsumeAfterOpt) {
577 // ConsumeAfter cannot be combined with "optional" positional options
578 // unless there is only one positional argument...
579 if (PositionalOpts.size() > 2)
581 Opt->error("error - this positional option will never be matched, "
582 "because it does not Require a value, and a "
583 "cl::ConsumeAfter option is active!");
584 } else if (UnboundedFound && !Opt->ArgStr[0]) {
585 // This option does not "require" a value... Make sure this option is
586 // not specified after an option that eats all extra arguments, or this
587 // one will never get any!
589 ErrorParsing |= Opt->error("error - option can never match, because "
590 "another positional argument will match an "
591 "unbounded number of values, and this option"
592 " does not require a value!");
594 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
596 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
599 // PositionalVals - A vector of "positional" arguments we accumulate into
600 // the process at the end.
602 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
604 // If the program has named positional arguments, and the name has been run
605 // across, keep track of which positional argument was named. Otherwise put
606 // the positional args into the PositionalVals list...
607 Option *ActivePositionalArg = 0;
609 // Loop over all of the arguments... processing them.
610 bool DashDashFound = false; // Have we read '--'?
611 for (int i = 1; i < argc; ++i) {
613 Option *NearestHandler = 0;
614 const char *NearestHandlerString = 0;
616 StringRef ArgName = "";
618 // If the option list changed, this means that some command line
619 // option has just been registered or deregistered. This can occur in
620 // response to things like -load, etc. If this happens, rescan the options.
621 if (OptionListChanged) {
622 PositionalOpts.clear();
625 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
626 OptionListChanged = false;
629 // Check to see if this is a positional argument. This argument is
630 // considered to be positional if it doesn't start with '-', if it is "-"
631 // itself, or if we have seen "--" already.
633 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
634 // Positional argument!
635 if (ActivePositionalArg) {
636 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
637 continue; // We are done!
640 if (!PositionalOpts.empty()) {
641 PositionalVals.push_back(std::make_pair(argv[i],i));
643 // All of the positional arguments have been fulfulled, give the rest to
644 // the consume after option... if it's specified...
646 if (PositionalVals.size() >= NumPositionalRequired &&
647 ConsumeAfterOpt != 0) {
648 for (++i; i < argc; ++i)
649 PositionalVals.push_back(std::make_pair(argv[i],i));
650 break; // Handle outside of the argument processing loop...
653 // Delay processing positional arguments until the end...
656 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
658 DashDashFound = true; // This is the mythical "--"?
659 continue; // Don't try to process it as an argument itself.
660 } else if (ActivePositionalArg &&
661 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
662 // If there is a positional argument eating options, check to see if this
663 // option is another positional argument. If so, treat it as an argument,
664 // otherwise feed it to the eating positional.
666 // Eat leading dashes.
667 while (!ArgName.empty() && ArgName[0] == '-')
668 ArgName = ArgName.substr(1);
670 Handler = LookupOption(ArgName, Value, Opts);
671 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
672 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
673 continue; // We are done!
676 } else { // We start with a '-', must be an argument.
678 // Eat leading dashes.
679 while (!ArgName.empty() && ArgName[0] == '-')
680 ArgName = ArgName.substr(1);
682 Handler = LookupOption(ArgName, Value, Opts);
684 // Check to see if this "option" is really a prefixed or grouped argument.
686 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
689 // Otherwise, look for the closest available option to report to the user
690 // in the upcoming error.
691 if (Handler == 0 && SinkOpts.empty())
692 NearestHandler = LookupNearestOption(ArgName, Opts,
693 NearestHandlerString);
697 if (SinkOpts.empty()) {
698 errs() << ProgramName << ": Unknown command line argument '"
699 << argv[i] << "'. Try: '" << argv[0] << " -help'\n";
701 if (NearestHandler) {
702 // If we know a near match, report it as well.
703 errs() << ProgramName << ": Did you mean '-"
704 << NearestHandlerString << "'?\n";
709 for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
710 E = SinkOpts.end(); I != E ; ++I)
711 (*I)->addOccurrence(i, "", argv[i]);
716 // If this is a named positional argument, just remember that it is the
718 if (Handler->getFormattingFlag() == cl::Positional)
719 ActivePositionalArg = Handler;
721 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
724 // Check and handle positional arguments now...
725 if (NumPositionalRequired > PositionalVals.size()) {
726 errs() << ProgramName
727 << ": Not enough positional command line arguments specified!\n"
728 << "Must specify at least " << NumPositionalRequired
729 << " positional arguments: See: " << argv[0] << " -help\n";
732 } else if (!HasUnlimitedPositionals &&
733 PositionalVals.size() > PositionalOpts.size()) {
734 errs() << ProgramName
735 << ": Too many positional arguments specified!\n"
736 << "Can specify at most " << PositionalOpts.size()
737 << " positional arguments: See: " << argv[0] << " -help\n";
740 } else if (ConsumeAfterOpt == 0) {
741 // Positional args have already been handled if ConsumeAfter is specified.
742 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
743 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
744 if (RequiresValue(PositionalOpts[i])) {
745 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
746 PositionalVals[ValNo].second);
748 --NumPositionalRequired; // We fulfilled our duty...
751 // If we _can_ give this option more arguments, do so now, as long as we
752 // do not give it values that others need. 'Done' controls whether the
753 // option even _WANTS_ any more.
755 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
756 while (NumVals-ValNo > NumPositionalRequired && !Done) {
757 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
759 Done = true; // Optional arguments want _at most_ one value
761 case cl::ZeroOrMore: // Zero or more will take all they can get...
762 case cl::OneOrMore: // One or more will take all they can get...
763 ProvidePositionalOption(PositionalOpts[i],
764 PositionalVals[ValNo].first,
765 PositionalVals[ValNo].second);
769 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
770 "positional argument processing!");
775 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
777 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
778 if (RequiresValue(PositionalOpts[j])) {
779 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
780 PositionalVals[ValNo].first,
781 PositionalVals[ValNo].second);
785 // Handle the case where there is just one positional option, and it's
786 // optional. In this case, we want to give JUST THE FIRST option to the
787 // positional option and keep the rest for the consume after. The above
788 // loop would have assigned no values to positional options in this case.
790 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
791 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
792 PositionalVals[ValNo].first,
793 PositionalVals[ValNo].second);
797 // Handle over all of the rest of the arguments to the
798 // cl::ConsumeAfter command line option...
799 for (; ValNo != PositionalVals.size(); ++ValNo)
800 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
801 PositionalVals[ValNo].first,
802 PositionalVals[ValNo].second);
805 // Loop over args and make sure all required args are specified!
806 for (StringMap<Option*>::iterator I = Opts.begin(),
807 E = Opts.end(); I != E; ++I) {
808 switch (I->second->getNumOccurrencesFlag()) {
811 if (I->second->getNumOccurrences() == 0) {
812 I->second->error("must be specified at least once!");
821 // Now that we know if -debug is specified, we can use it.
822 // Note that if ReadResponseFiles == true, this must be done before the
823 // memory allocated for the expanded command line is free()d below.
824 DEBUG(dbgs() << "Args: ";
825 for (int i = 0; i < argc; ++i)
826 dbgs() << argv[i] << ' ';
830 // Free all of the memory allocated to the map. Command line options may only
831 // be processed once!
833 PositionalOpts.clear();
836 // Free the memory allocated by ExpandResponseFiles.
837 if (ReadResponseFiles) {
838 // Free all the strdup()ed strings.
839 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
844 // If we had an error processing our arguments, don't let the program execute
845 if (ErrorParsing) exit(1);
848 //===----------------------------------------------------------------------===//
849 // Option Base class implementation
852 bool Option::error(const Twine &Message, StringRef ArgName) {
853 if (ArgName.data() == 0) ArgName = ArgStr;
855 errs() << HelpStr; // Be nice for positional arguments
857 errs() << ProgramName << ": for the -" << ArgName;
859 errs() << " option: " << Message << "\n";
863 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
864 StringRef Value, bool MultiArg) {
866 NumOccurrences++; // Increment the number of times we have been seen
868 switch (getNumOccurrencesFlag()) {
870 if (NumOccurrences > 1)
871 return error("may only occur zero or one times!", ArgName);
874 if (NumOccurrences > 1)
875 return error("must occur exactly one time!", ArgName);
879 case ConsumeAfter: break;
880 default: return error("bad num occurrences flag value!");
883 return handleOccurrence(pos, ArgName, Value);
887 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
888 // has been specified yet.
890 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
891 if (O.ValueStr[0] == 0) return DefaultMsg;
895 //===----------------------------------------------------------------------===//
896 // cl::alias class implementation
899 // Return the width of the option tag for printing...
900 size_t alias::getOptionWidth() const {
901 return std::strlen(ArgStr)+6;
904 // Print out the option for the alias.
905 void alias::printOptionInfo(size_t GlobalWidth) const {
906 size_t L = std::strlen(ArgStr);
907 errs() << " -" << ArgStr;
908 errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
913 //===----------------------------------------------------------------------===//
914 // Parser Implementation code...
917 // basic_parser implementation
920 // Return the width of the option tag for printing...
921 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
922 size_t Len = std::strlen(O.ArgStr);
923 if (const char *ValName = getValueName())
924 Len += std::strlen(getValueStr(O, ValName))+3;
929 // printOptionInfo - Print out information about this option. The
930 // to-be-maintained width is specified.
932 void basic_parser_impl::printOptionInfo(const Option &O,
933 size_t GlobalWidth) const {
934 outs() << " -" << O.ArgStr;
936 if (const char *ValName = getValueName())
937 outs() << "=<" << getValueStr(O, ValName) << '>';
939 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
945 // parser<bool> implementation
947 bool parser<bool>::parse(Option &O, StringRef ArgName,
948 StringRef Arg, bool &Value) {
949 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
955 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
959 return O.error("'" + Arg +
960 "' is invalid value for boolean argument! Try 0 or 1");
963 // parser<boolOrDefault> implementation
965 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
966 StringRef Arg, boolOrDefault &Value) {
967 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
972 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
977 return O.error("'" + Arg +
978 "' is invalid value for boolean argument! Try 0 or 1");
981 // parser<int> implementation
983 bool parser<int>::parse(Option &O, StringRef ArgName,
984 StringRef Arg, int &Value) {
985 if (Arg.getAsInteger(0, Value))
986 return O.error("'" + Arg + "' value invalid for integer argument!");
990 // parser<unsigned> implementation
992 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
993 StringRef Arg, unsigned &Value) {
995 if (Arg.getAsInteger(0, Value))
996 return O.error("'" + Arg + "' value invalid for uint argument!");
1000 // parser<double>/parser<float> implementation
1002 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1003 SmallString<32> TmpStr(Arg.begin(), Arg.end());
1004 const char *ArgStart = TmpStr.c_str();
1006 Value = strtod(ArgStart, &End);
1008 return O.error("'" + Arg + "' value invalid for floating point argument!");
1012 bool parser<double>::parse(Option &O, StringRef ArgName,
1013 StringRef Arg, double &Val) {
1014 return parseDouble(O, Arg, Val);
1017 bool parser<float>::parse(Option &O, StringRef ArgName,
1018 StringRef Arg, float &Val) {
1020 if (parseDouble(O, Arg, dVal))
1028 // generic_parser_base implementation
1031 // findOption - Return the option number corresponding to the specified
1032 // argument string. If the option is not found, getNumOptions() is returned.
1034 unsigned generic_parser_base::findOption(const char *Name) {
1035 unsigned e = getNumOptions();
1037 for (unsigned i = 0; i != e; ++i) {
1038 if (strcmp(getOption(i), Name) == 0)
1045 // Return the width of the option tag for printing...
1046 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1047 if (O.hasArgStr()) {
1048 size_t Size = std::strlen(O.ArgStr)+6;
1049 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1050 Size = std::max(Size, std::strlen(getOption(i))+8);
1053 size_t BaseSize = 0;
1054 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1055 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1060 // printOptionInfo - Print out information about this option. The
1061 // to-be-maintained width is specified.
1063 void generic_parser_base::printOptionInfo(const Option &O,
1064 size_t GlobalWidth) const {
1065 if (O.hasArgStr()) {
1066 size_t L = std::strlen(O.ArgStr);
1067 outs() << " -" << O.ArgStr;
1068 outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1070 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1071 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1072 outs() << " =" << getOption(i);
1073 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1077 outs() << " " << O.HelpStr << '\n';
1078 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1079 size_t L = std::strlen(getOption(i));
1080 outs() << " -" << getOption(i);
1081 outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1087 //===----------------------------------------------------------------------===//
1088 // -help and -help-hidden option implementation
1091 static int OptNameCompare(const void *LHS, const void *RHS) {
1092 typedef std::pair<const char *, Option*> pair_ty;
1094 return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1101 const Option *EmptyArg;
1102 const bool ShowHidden;
1105 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1109 void operator=(bool Value) {
1110 if (Value == false) return;
1112 // Get all the options.
1113 SmallVector<Option*, 4> PositionalOpts;
1114 SmallVector<Option*, 4> SinkOpts;
1115 StringMap<Option*> OptMap;
1116 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1118 // Copy Options into a vector so we can sort them as we like.
1119 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1120 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1122 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1124 // Ignore really-hidden options.
1125 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1128 // Unless showhidden is set, ignore hidden flags.
1129 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1132 // If we've already seen this option, don't add it to the list again.
1133 if (!OptionSet.insert(I->second))
1136 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1140 // Sort the options list alphabetically.
1141 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1143 if (ProgramOverview)
1144 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1146 outs() << "USAGE: " << ProgramName << " [options]";
1148 // Print out the positional options.
1149 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1150 if (!PositionalOpts.empty() &&
1151 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1152 CAOpt = PositionalOpts[0];
1154 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1155 if (PositionalOpts[i]->ArgStr[0])
1156 outs() << " --" << PositionalOpts[i]->ArgStr;
1157 outs() << " " << PositionalOpts[i]->HelpStr;
1160 // Print the consume after option info if it exists...
1161 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1165 // Compute the maximum argument length...
1167 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1168 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1170 outs() << "OPTIONS:\n";
1171 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1172 Opts[i].second->printOptionInfo(MaxArgLen);
1174 // Print any extra help the user has declared.
1175 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1176 E = MoreHelp->end(); I != E; ++I)
1180 // Halt the program since help information was printed
1184 } // End anonymous namespace
1186 // Define the two HelpPrinter instances that are used to print out help, or
1189 static HelpPrinter NormalPrinter(false);
1190 static HelpPrinter HiddenPrinter(true);
1192 static cl::opt<HelpPrinter, true, parser<bool> >
1193 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1194 cl::location(NormalPrinter), cl::ValueDisallowed);
1196 static cl::opt<HelpPrinter, true, parser<bool> >
1197 HHOp("help-hidden", cl::desc("Display all available options"),
1198 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1200 static void (*OverrideVersionPrinter)() = 0;
1202 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1203 typedef std::pair<const char *, const Target*> pair_ty;
1204 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1208 class VersionPrinter {
1211 raw_ostream &OS = outs();
1212 OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1213 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1214 #ifdef LLVM_VERSION_INFO
1215 OS << LLVM_VERSION_INFO;
1218 #ifndef __OPTIMIZE__
1219 OS << "DEBUG build";
1221 OS << "Optimized build";
1224 OS << " with assertions";
1226 std::string CPU = sys::getHostCPUName();
1227 if (CPU == "generic") CPU = "(unknown)";
1229 #if (ENABLE_TIMESTAMPS == 1)
1230 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1232 << " Host: " << sys::getHostTriple() << '\n'
1233 << " Host CPU: " << CPU << '\n'
1235 << " Registered Targets:\n";
1237 std::vector<std::pair<const char *, const Target*> > Targets;
1239 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1240 ie = TargetRegistry::end(); it != ie; ++it) {
1241 Targets.push_back(std::make_pair(it->getName(), &*it));
1242 Width = std::max(Width, strlen(Targets.back().first));
1244 if (!Targets.empty())
1245 qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1248 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1249 OS << " " << Targets[i].first;
1250 OS.indent(Width - strlen(Targets[i].first)) << " - "
1251 << Targets[i].second->getShortDescription() << '\n';
1253 if (Targets.empty())
1256 void operator=(bool OptionWasSpecified) {
1257 if (!OptionWasSpecified) return;
1259 if (OverrideVersionPrinter == 0) {
1263 (*OverrideVersionPrinter)();
1267 } // End anonymous namespace
1270 // Define the --version option that prints out the LLVM version for the tool
1271 static VersionPrinter VersionPrinterInstance;
1273 static cl::opt<VersionPrinter, true, parser<bool> >
1274 VersOp("version", cl::desc("Display the version of this program"),
1275 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1277 // Utility function for printing the help message.
1278 void cl::PrintHelpMessage() {
1279 // This looks weird, but it actually prints the help message. The
1280 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1281 // its operator= is invoked. That's because the "normal" usages of the
1282 // help printer is to be assigned true/false depending on whether the
1283 // -help option was given or not. Since we're circumventing that we have
1284 // to make it look like -help was given, so we assign true.
1285 NormalPrinter = true;
1288 /// Utility function for printing version number.
1289 void cl::PrintVersionMessage() {
1290 VersionPrinterInstance.print();
1293 void cl::SetVersionPrinter(void (*func)()) {
1294 OverrideVersionPrinter = func;