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/StringMap.h"
29 #include "llvm/ADT/Twine.h"
30 #include "llvm/Config/config.h"
37 //===----------------------------------------------------------------------===//
38 // Template instantiations and anchors.
40 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
41 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
42 TEMPLATE_INSTANTIATION(class basic_parser<int>);
43 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
44 TEMPLATE_INSTANTIATION(class basic_parser<double>);
45 TEMPLATE_INSTANTIATION(class basic_parser<float>);
46 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
47 TEMPLATE_INSTANTIATION(class basic_parser<char>);
49 TEMPLATE_INSTANTIATION(class opt<unsigned>);
50 TEMPLATE_INSTANTIATION(class opt<int>);
51 TEMPLATE_INSTANTIATION(class opt<std::string>);
52 TEMPLATE_INSTANTIATION(class opt<char>);
53 TEMPLATE_INSTANTIATION(class opt<bool>);
55 void Option::anchor() {}
56 void basic_parser_impl::anchor() {}
57 void parser<bool>::anchor() {}
58 void parser<boolOrDefault>::anchor() {}
59 void parser<int>::anchor() {}
60 void parser<unsigned>::anchor() {}
61 void parser<double>::anchor() {}
62 void parser<float>::anchor() {}
63 void parser<std::string>::anchor() {}
64 void parser<char>::anchor() {}
66 //===----------------------------------------------------------------------===//
68 // Globals for name and overview of program. Program name is not a string to
69 // avoid static ctor/dtor issues.
70 static char ProgramName[80] = "<premain>";
71 static const char *ProgramOverview = 0;
73 // This collects additional help to be printed.
74 static ManagedStatic<std::vector<const char*> > MoreHelp;
76 extrahelp::extrahelp(const char *Help)
78 MoreHelp->push_back(Help);
81 static bool OptionListChanged = false;
83 // MarkOptionsChanged - Internal helper function.
84 void cl::MarkOptionsChanged() {
85 OptionListChanged = true;
88 /// RegisteredOptionList - This is the list of the command line options that
89 /// have statically constructed themselves.
90 static Option *RegisteredOptionList = 0;
92 void Option::addArgument() {
93 assert(NextRegistered == 0 && "argument multiply registered!");
95 NextRegistered = RegisteredOptionList;
96 RegisteredOptionList = this;
101 //===----------------------------------------------------------------------===//
102 // Basic, shared command line option processing machinery.
105 /// GetOptionInfo - Scan the list of registered options, turning them into data
106 /// structures that are easier to handle.
107 static void GetOptionInfo(std::vector<Option*> &PositionalOpts,
108 std::vector<Option*> &SinkOpts,
109 StringMap<Option*> &OptionsMap) {
110 std::vector<const char*> OptionNames;
111 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
112 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
113 // If this option wants to handle multiple option names, get the full set.
114 // This handles enum options like "-O1 -O2" etc.
115 O->getExtraOptionNames(OptionNames);
117 OptionNames.push_back(O->ArgStr);
119 // Handle named options.
120 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
121 // Add argument to the argument map!
122 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
123 errs() << ProgramName << ": CommandLine Error: Argument '"
124 << OptionNames[i] << "' defined more than once!\n";
130 // Remember information about positional options.
131 if (O->getFormattingFlag() == cl::Positional)
132 PositionalOpts.push_back(O);
133 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
134 SinkOpts.push_back(O);
135 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
137 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
143 PositionalOpts.push_back(CAOpt);
145 // Make sure that they are in order of registration not backwards.
146 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
150 /// LookupOption - Lookup the option specified by the specified option on the
151 /// command line. If there is a value specified (after an equal sign) return
153 static Option *LookupOption(const char *&Arg, const char *&Value,
154 StringMap<Option*> &OptionsMap) {
155 while (*Arg == '-') ++Arg; // Eat leading dashes
157 const char *ArgEnd = Arg;
158 while (*ArgEnd && *ArgEnd != '=')
159 ++ArgEnd; // Scan till end of argument name.
161 if (*ArgEnd == '=') // If we have an equals sign...
162 Value = ArgEnd+1; // Get the value, not the equals
165 if (*Arg == 0) return 0;
167 // Look up the option.
168 StringMap<Option*>::iterator I =
169 OptionsMap.find(llvm::StringRef(Arg, ArgEnd-Arg));
170 return I != OptionsMap.end() ? I->second : 0;
173 static inline bool ProvideOption(Option *Handler, const char *ArgName,
174 const char *Value, int argc, char **argv,
176 // Is this a multi-argument option?
177 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
179 // Enforce value requirements
180 switch (Handler->getValueExpectedFlag()) {
182 if (Value == 0) { // No value specified?
183 if (i+1 < argc) { // Steal the next argument, like for '-o filename'
186 return Handler->error("requires a value!");
190 case ValueDisallowed:
191 if (NumAdditionalVals > 0)
192 return Handler->error("multi-valued option specified"
193 " with ValueDisallowed modifier!");
196 return Handler->error("does not allow a value! '" +
197 Twine(Value) + "' specified.");
202 errs() << ProgramName
203 << ": Bad ValueMask flag! CommandLine usage error:"
204 << Handler->getValueExpectedFlag() << "\n";
208 // If this isn't a multi-arg option, just run the handler.
209 if (NumAdditionalVals == 0)
210 return Handler->addOccurrence(i, ArgName, Value ? Value : "");
212 // If it is, run the handle several times.
213 bool MultiArg = false;
216 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
222 while (NumAdditionalVals > 0) {
225 return Handler->error("not enough values!");
228 if (Handler->addOccurrence(i, ArgName, Value, MultiArg))
236 static bool ProvidePositionalOption(Option *Handler, const std::string &Arg,
239 return ProvideOption(Handler, Handler->ArgStr, Arg.c_str(), 0, 0, Dummy);
243 // Option predicates...
244 static inline bool isGrouping(const Option *O) {
245 return O->getFormattingFlag() == cl::Grouping;
247 static inline bool isPrefixedOrGrouping(const Option *O) {
248 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
251 // getOptionPred - Check to see if there are any options that satisfy the
252 // specified predicate with names that are the prefixes in Name. This is
253 // checked by progressively stripping characters off of the name, checking to
254 // see if there options that satisfy the predicate. If we find one, return it,
255 // otherwise return null.
257 static Option *getOptionPred(std::string Name, size_t &Length,
258 bool (*Pred)(const Option*),
259 StringMap<Option*> &OptionsMap) {
261 StringMap<Option*>::iterator OMI = OptionsMap.find(Name);
262 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
263 Length = Name.length();
267 if (Name.size() == 1) return 0;
269 Name.erase(Name.end()-1, Name.end()); // Chop off the last character...
270 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() || !Pred(OMI->second)) && Name.size() > 1);
277 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
278 Length = Name.length();
279 return OMI->second; // Found one!
281 return 0; // No option found!
284 static bool RequiresValue(const Option *O) {
285 return O->getNumOccurrencesFlag() == cl::Required ||
286 O->getNumOccurrencesFlag() == cl::OneOrMore;
289 static bool EatsUnboundedNumberOfValues(const Option *O) {
290 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
291 O->getNumOccurrencesFlag() == cl::OneOrMore;
294 /// ParseCStringVector - Break INPUT up wherever one or more
295 /// whitespace characters are found, and store the resulting tokens in
296 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
297 /// using strdup (), so it is the caller's responsibility to free ()
300 static void ParseCStringVector(std::vector<char *> &output,
302 // Characters which will be treated as token separators:
303 static const char *const delims = " \v\f\t\r\n";
305 std::string work (input);
306 // Skip past any delims at head of input string.
307 size_t pos = work.find_first_not_of (delims);
308 // If the string consists entirely of delims, then exit early.
309 if (pos == std::string::npos) return;
310 // Otherwise, jump forward to beginning of first word.
311 work = work.substr (pos);
312 // Find position of first delimiter.
313 pos = work.find_first_of (delims);
315 while (!work.empty() && pos != std::string::npos) {
316 // Everything from 0 to POS is the next word to copy.
317 output.push_back (strdup (work.substr (0,pos).c_str ()));
318 // Is there another word in the string?
319 size_t nextpos = work.find_first_not_of (delims, pos + 1);
320 if (nextpos != std::string::npos) {
321 // Yes? Then remove delims from beginning ...
322 work = work.substr (work.find_first_not_of (delims, pos + 1));
323 // and find the end of the word.
324 pos = work.find_first_of (delims);
326 // No? (Remainder of string is delims.) End the loop.
328 pos = std::string::npos;
332 // If `input' ended with non-delim char, then we'll get here with
333 // the last word of `input' in `work'; copy it now.
334 if (!work.empty ()) {
335 output.push_back (strdup (work.c_str ()));
339 /// ParseEnvironmentOptions - An alternative entry point to the
340 /// CommandLine library, which allows you to read the program's name
341 /// from the caller (as PROGNAME) and its command-line arguments from
342 /// an environment variable (whose name is given in ENVVAR).
344 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
345 const char *Overview, bool ReadResponseFiles) {
347 assert(progName && "Program name not specified");
348 assert(envVar && "Environment variable name missing");
350 // Get the environment variable they want us to parse options out of.
351 const char *envValue = getenv(envVar);
355 // Get program's "name", which we wouldn't know without the caller
357 std::vector<char*> newArgv;
358 newArgv.push_back(strdup(progName));
360 // Parse the value of the environment variable into a "command line"
361 // and hand it off to ParseCommandLineOptions().
362 ParseCStringVector(newArgv, envValue);
363 int newArgc = static_cast<int>(newArgv.size());
364 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
366 // Free all the strdup()ed strings.
367 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
373 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
374 /// substituting the contents of the response files for the arguments
376 static void ExpandResponseFiles(int argc, char** argv,
377 std::vector<char*>& newArgv) {
378 for (int i = 1; i != argc; ++i) {
383 sys::PathWithStatus respFile(++arg);
385 // Check that the response file is not empty (mmap'ing empty
386 // files can be problematic).
387 const sys::FileStatus *FileStat = respFile.getFileStatus();
388 if (FileStat && FileStat->getSize() != 0) {
390 // Mmap the response file into memory.
391 OwningPtr<MemoryBuffer>
392 respFilePtr(MemoryBuffer::getFile(respFile.c_str()));
394 // If we could open the file, parse its contents, otherwise
395 // pass the @file option verbatim.
397 // TODO: we should also support recursive loading of response files,
398 // since this is how gcc behaves. (From their man page: "The file may
399 // itself contain additional @file options; any such options will be
400 // processed recursively.")
402 if (respFilePtr != 0) {
403 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
408 newArgv.push_back(strdup(arg));
412 void cl::ParseCommandLineOptions(int argc, char **argv,
413 const char *Overview, bool ReadResponseFiles) {
414 // Process all registered options.
415 std::vector<Option*> PositionalOpts;
416 std::vector<Option*> SinkOpts;
417 StringMap<Option*> Opts;
418 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
420 assert((!Opts.empty() || !PositionalOpts.empty()) &&
421 "No options specified!");
423 // Expand response files.
424 std::vector<char*> newArgv;
425 if (ReadResponseFiles) {
426 newArgv.push_back(strdup(argv[0]));
427 ExpandResponseFiles(argc, argv, newArgv);
429 argc = static_cast<int>(newArgv.size());
432 // Copy the program name into ProgName, making sure not to overflow it.
433 std::string ProgName = sys::Path(argv[0]).getLast();
434 if (ProgName.size() > 79) ProgName.resize(79);
435 strcpy(ProgramName, ProgName.c_str());
437 ProgramOverview = Overview;
438 bool ErrorParsing = false;
440 // Check out the positional arguments to collect information about them.
441 unsigned NumPositionalRequired = 0;
443 // Determine whether or not there are an unlimited number of positionals
444 bool HasUnlimitedPositionals = false;
446 Option *ConsumeAfterOpt = 0;
447 if (!PositionalOpts.empty()) {
448 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
449 assert(PositionalOpts.size() > 1 &&
450 "Cannot specify cl::ConsumeAfter without a positional argument!");
451 ConsumeAfterOpt = PositionalOpts[0];
454 // Calculate how many positional values are _required_.
455 bool UnboundedFound = false;
456 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
458 Option *Opt = PositionalOpts[i];
459 if (RequiresValue(Opt))
460 ++NumPositionalRequired;
461 else if (ConsumeAfterOpt) {
462 // ConsumeAfter cannot be combined with "optional" positional options
463 // unless there is only one positional argument...
464 if (PositionalOpts.size() > 2)
466 Opt->error("error - this positional option will never be matched, "
467 "because it does not Require a value, and a "
468 "cl::ConsumeAfter option is active!");
469 } else if (UnboundedFound && !Opt->ArgStr[0]) {
470 // This option does not "require" a value... Make sure this option is
471 // not specified after an option that eats all extra arguments, or this
472 // one will never get any!
474 ErrorParsing |= Opt->error("error - option can never match, because "
475 "another positional argument will match an "
476 "unbounded number of values, and this option"
477 " does not require a value!");
479 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
481 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
484 // PositionalVals - A vector of "positional" arguments we accumulate into
485 // the process at the end...
487 std::vector<std::pair<std::string,unsigned> > PositionalVals;
489 // If the program has named positional arguments, and the name has been run
490 // across, keep track of which positional argument was named. Otherwise put
491 // the positional args into the PositionalVals list...
492 Option *ActivePositionalArg = 0;
494 // Loop over all of the arguments... processing them.
495 bool DashDashFound = false; // Have we read '--'?
496 for (int i = 1; i < argc; ++i) {
498 const char *Value = 0;
499 const char *ArgName = "";
501 // If the option list changed, this means that some command line
502 // option has just been registered or deregistered. This can occur in
503 // response to things like -load, etc. If this happens, rescan the options.
504 if (OptionListChanged) {
505 PositionalOpts.clear();
508 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
509 OptionListChanged = false;
512 // Check to see if this is a positional argument. This argument is
513 // considered to be positional if it doesn't start with '-', if it is "-"
514 // itself, or if we have seen "--" already.
516 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
517 // Positional argument!
518 if (ActivePositionalArg) {
519 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
520 continue; // We are done!
521 } else if (!PositionalOpts.empty()) {
522 PositionalVals.push_back(std::make_pair(argv[i],i));
524 // All of the positional arguments have been fulfulled, give the rest to
525 // the consume after option... if it's specified...
527 if (PositionalVals.size() >= NumPositionalRequired &&
528 ConsumeAfterOpt != 0) {
529 for (++i; i < argc; ++i)
530 PositionalVals.push_back(std::make_pair(argv[i],i));
531 break; // Handle outside of the argument processing loop...
534 // Delay processing positional arguments until the end...
537 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
539 DashDashFound = true; // This is the mythical "--"?
540 continue; // Don't try to process it as an argument itself.
541 } else if (ActivePositionalArg &&
542 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
543 // If there is a positional argument eating options, check to see if this
544 // option is another positional argument. If so, treat it as an argument,
545 // otherwise feed it to the eating positional.
547 Handler = LookupOption(ArgName, Value, Opts);
548 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
549 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
550 continue; // We are done!
553 } else { // We start with a '-', must be an argument...
555 Handler = LookupOption(ArgName, Value, Opts);
557 // Check to see if this "option" is really a prefixed or grouped argument.
559 std::string RealName(ArgName);
560 if (RealName.size() > 1) {
562 Option *PGOpt = getOptionPred(RealName, Length, isPrefixedOrGrouping,
565 // If the option is a prefixed option, then the value is simply the
566 // rest of the name... so fall through to later processing, by
567 // setting up the argument name flags and value fields.
569 if (PGOpt && PGOpt->getFormattingFlag() == cl::Prefix) {
570 Value = ArgName+Length;
571 assert(Opts.find(std::string(ArgName, Value)) != Opts.end() &&
572 Opts.find(std::string(ArgName, Value))->second == PGOpt);
575 // This must be a grouped option... handle them now.
576 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
579 // Move current arg name out of RealName into RealArgName...
580 std::string RealArgName(RealName.begin(),
581 RealName.begin() + Length);
582 RealName.erase(RealName.begin(), RealName.begin() + Length);
584 // Because ValueRequired is an invalid flag for grouped arguments,
585 // we don't need to pass argc/argv in...
587 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
588 "Option can not be cl::Grouping AND cl::ValueRequired!");
590 ErrorParsing |= ProvideOption(PGOpt, RealArgName.c_str(),
593 // Get the next grouping option...
594 PGOpt = getOptionPred(RealName, Length, isGrouping, Opts);
595 } while (PGOpt && Length != RealName.size());
597 Handler = PGOpt; // Ate all of the options.
604 if (SinkOpts.empty()) {
605 errs() << ProgramName << ": Unknown command line argument '"
606 << argv[i] << "'. Try: '" << argv[0] << " --help'\n";
609 for (std::vector<Option*>::iterator I = SinkOpts.begin(),
610 E = SinkOpts.end(); I != E ; ++I)
611 (*I)->addOccurrence(i, "", argv[i]);
616 // Check to see if this option accepts a comma separated list of values. If
617 // it does, we have to split up the value into multiple values...
618 if (Value && Handler->getMiscFlags() & CommaSeparated) {
619 std::string Val(Value);
620 std::string::size_type Pos = Val.find(',');
622 while (Pos != std::string::npos) {
623 // Process the portion before the comma...
624 ErrorParsing |= ProvideOption(Handler, ArgName,
625 std::string(Val.begin(),
626 Val.begin()+Pos).c_str(),
628 // Erase the portion before the comma, AND the comma...
629 Val.erase(Val.begin(), Val.begin()+Pos+1);
630 Value += Pos+1; // Increment the original value pointer as well...
632 // Check for another comma...
637 // If this is a named positional argument, just remember that it is the
639 if (Handler->getFormattingFlag() == cl::Positional)
640 ActivePositionalArg = Handler;
642 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
645 // Check and handle positional arguments now...
646 if (NumPositionalRequired > PositionalVals.size()) {
647 errs() << ProgramName
648 << ": Not enough positional command line arguments specified!\n"
649 << "Must specify at least " << NumPositionalRequired
650 << " positional arguments: See: " << argv[0] << " --help\n";
653 } else if (!HasUnlimitedPositionals
654 && PositionalVals.size() > PositionalOpts.size()) {
655 errs() << ProgramName
656 << ": Too many positional arguments specified!\n"
657 << "Can specify at most " << PositionalOpts.size()
658 << " positional arguments: See: " << argv[0] << " --help\n";
661 } else if (ConsumeAfterOpt == 0) {
662 // Positional args have already been handled if ConsumeAfter is specified...
663 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
664 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
665 if (RequiresValue(PositionalOpts[i])) {
666 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
667 PositionalVals[ValNo].second);
669 --NumPositionalRequired; // We fulfilled our duty...
672 // If we _can_ give this option more arguments, do so now, as long as we
673 // do not give it values that others need. 'Done' controls whether the
674 // option even _WANTS_ any more.
676 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
677 while (NumVals-ValNo > NumPositionalRequired && !Done) {
678 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
680 Done = true; // Optional arguments want _at most_ one value
682 case cl::ZeroOrMore: // Zero or more will take all they can get...
683 case cl::OneOrMore: // One or more will take all they can get...
684 ProvidePositionalOption(PositionalOpts[i],
685 PositionalVals[ValNo].first,
686 PositionalVals[ValNo].second);
690 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
691 "positional argument processing!");
696 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
698 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
699 if (RequiresValue(PositionalOpts[j])) {
700 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
701 PositionalVals[ValNo].first,
702 PositionalVals[ValNo].second);
706 // Handle the case where there is just one positional option, and it's
707 // optional. In this case, we want to give JUST THE FIRST option to the
708 // positional option and keep the rest for the consume after. The above
709 // loop would have assigned no values to positional options in this case.
711 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
712 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
713 PositionalVals[ValNo].first,
714 PositionalVals[ValNo].second);
718 // Handle over all of the rest of the arguments to the
719 // cl::ConsumeAfter command line option...
720 for (; ValNo != PositionalVals.size(); ++ValNo)
721 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
722 PositionalVals[ValNo].first,
723 PositionalVals[ValNo].second);
726 // Loop over args and make sure all required args are specified!
727 for (StringMap<Option*>::iterator I = Opts.begin(),
728 E = Opts.end(); I != E; ++I) {
729 switch (I->second->getNumOccurrencesFlag()) {
732 if (I->second->getNumOccurrences() == 0) {
733 I->second->error("must be specified at least once!");
742 // Free all of the memory allocated to the map. Command line options may only
743 // be processed once!
745 PositionalOpts.clear();
748 // Free the memory allocated by ExpandResponseFiles.
749 if (ReadResponseFiles) {
750 // Free all the strdup()ed strings.
751 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
756 // If we had an error processing our arguments, don't let the program execute
757 if (ErrorParsing) exit(1);
760 //===----------------------------------------------------------------------===//
761 // Option Base class implementation
764 bool Option::error(const Twine &Message, const char *ArgName) {
765 if (ArgName == 0) ArgName = ArgStr;
767 errs() << HelpStr; // Be nice for positional arguments
769 errs() << ProgramName << ": for the -" << ArgName;
771 errs() << " option: " << Message << "\n";
775 bool Option::addOccurrence(unsigned pos, const char *ArgName,
776 StringRef Value, bool MultiArg) {
778 NumOccurrences++; // Increment the number of times we have been seen
780 switch (getNumOccurrencesFlag()) {
782 if (NumOccurrences > 1)
783 return error("may only occur zero or one times!", ArgName);
786 if (NumOccurrences > 1)
787 return error("must occur exactly one time!", ArgName);
791 case ConsumeAfter: break;
792 default: return error("bad num occurrences flag value!");
795 return handleOccurrence(pos, ArgName, Value);
799 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
800 // has been specified yet.
802 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
803 if (O.ValueStr[0] == 0) return DefaultMsg;
807 //===----------------------------------------------------------------------===//
808 // cl::alias class implementation
811 // Return the width of the option tag for printing...
812 size_t alias::getOptionWidth() const {
813 return std::strlen(ArgStr)+6;
816 // Print out the option for the alias.
817 void alias::printOptionInfo(size_t GlobalWidth) const {
818 size_t L = std::strlen(ArgStr);
819 errs() << " -" << ArgStr << std::string(GlobalWidth-L-6, ' ') << " - "
825 //===----------------------------------------------------------------------===//
826 // Parser Implementation code...
829 // basic_parser implementation
832 // Return the width of the option tag for printing...
833 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
834 size_t Len = std::strlen(O.ArgStr);
835 if (const char *ValName = getValueName())
836 Len += std::strlen(getValueStr(O, ValName))+3;
841 // printOptionInfo - Print out information about this option. The
842 // to-be-maintained width is specified.
844 void basic_parser_impl::printOptionInfo(const Option &O,
845 size_t GlobalWidth) const {
846 outs() << " -" << O.ArgStr;
848 if (const char *ValName = getValueName())
849 outs() << "=<" << getValueStr(O, ValName) << '>';
851 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
857 // parser<bool> implementation
859 bool parser<bool>::parse(Option &O, const char *ArgName,
860 StringRef Arg, bool &Value) {
861 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
867 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
871 return O.error("'" + Arg +
872 "' is invalid value for boolean argument! Try 0 or 1");
875 // parser<boolOrDefault> implementation
877 bool parser<boolOrDefault>::parse(Option &O, const char *ArgName,
878 StringRef Arg, boolOrDefault &Value) {
879 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
884 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
889 return O.error("'" + Arg +
890 "' is invalid value for boolean argument! Try 0 or 1");
893 // parser<int> implementation
895 bool parser<int>::parse(Option &O, const char *ArgName,
896 StringRef Arg, int &Value) {
899 std::string TMP = Arg.str();
900 Value = (int)strtol(TMP.c_str(), &End, 0);
902 return O.error("'" + Arg + "' value invalid for integer argument!");
906 // parser<unsigned> implementation
908 bool parser<unsigned>::parse(Option &O, const char *ArgName,
909 StringRef Arg, unsigned &Value) {
914 std::string TMP = Arg.str();
915 unsigned long V = strtoul(TMP.c_str(), &End, 0);
917 if (((V == ULONG_MAX) && (errno == ERANGE))
920 return O.error("'" + Arg + "' value invalid for uint argument!");
924 // parser<double>/parser<float> implementation
926 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
928 std::string TMP = Arg.str();
930 const char *ArgStart = TMP.c_str();
932 Value = strtod(ArgStart, &End);
934 return O.error("'" + Arg + "' value invalid for floating point argument!");
938 bool parser<double>::parse(Option &O, const char *AN,
939 StringRef Arg, double &Val) {
940 return parseDouble(O, Arg, Val);
943 bool parser<float>::parse(Option &O, const char *AN,
944 StringRef Arg, float &Val) {
946 if (parseDouble(O, Arg, dVal))
954 // generic_parser_base implementation
957 // findOption - Return the option number corresponding to the specified
958 // argument string. If the option is not found, getNumOptions() is returned.
960 unsigned generic_parser_base::findOption(const char *Name) {
961 unsigned e = getNumOptions();
963 for (unsigned i = 0; i != e; ++i) {
964 if (strcmp(getOption(i), Name) == 0)
971 // Return the width of the option tag for printing...
972 size_t generic_parser_base::getOptionWidth(const Option &O) const {
974 size_t Size = std::strlen(O.ArgStr)+6;
975 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
976 Size = std::max(Size, std::strlen(getOption(i))+8);
980 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
981 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
986 // printOptionInfo - Print out information about this option. The
987 // to-be-maintained width is specified.
989 void generic_parser_base::printOptionInfo(const Option &O,
990 size_t GlobalWidth) const {
992 size_t L = std::strlen(O.ArgStr);
993 outs() << " -" << O.ArgStr << std::string(GlobalWidth-L-6, ' ')
994 << " - " << O.HelpStr << '\n';
996 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
997 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
998 outs() << " =" << getOption(i) << std::string(NumSpaces, ' ')
999 << " - " << getDescription(i) << '\n';
1003 outs() << " " << O.HelpStr << "\n";
1004 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1005 size_t L = std::strlen(getOption(i));
1006 outs() << " -" << getOption(i) << std::string(GlobalWidth-L-8, ' ')
1007 << " - " << getDescription(i) << "\n";
1013 //===----------------------------------------------------------------------===//
1014 // --help and --help-hidden option implementation
1021 const Option *EmptyArg;
1022 const bool ShowHidden;
1024 // isHidden/isReallyHidden - Predicates to be used to filter down arg lists.
1025 inline static bool isHidden(Option *Opt) {
1026 return Opt->getOptionHiddenFlag() >= Hidden;
1028 inline static bool isReallyHidden(Option *Opt) {
1029 return Opt->getOptionHiddenFlag() == ReallyHidden;
1033 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1037 void operator=(bool Value) {
1038 if (Value == false) return;
1040 // Get all the options.
1041 std::vector<Option*> PositionalOpts;
1042 std::vector<Option*> SinkOpts;
1043 StringMap<Option*> OptMap;
1044 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1046 // Copy Options into a vector so we can sort them as we like...
1047 std::vector<Option*> Opts;
1048 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1050 Opts.push_back(I->second);
1053 // Eliminate Hidden or ReallyHidden arguments, depending on ShowHidden
1054 Opts.erase(std::remove_if(Opts.begin(), Opts.end(),
1055 std::ptr_fun(ShowHidden ? isReallyHidden : isHidden)),
1058 // Eliminate duplicate entries in table (from enum flags options, f.e.)
1059 { // Give OptionSet a scope
1060 std::set<Option*> OptionSet;
1061 for (unsigned i = 0; i != Opts.size(); ++i)
1062 if (OptionSet.count(Opts[i]) == 0)
1063 OptionSet.insert(Opts[i]); // Add new entry to set
1065 Opts.erase(Opts.begin()+i--); // Erase duplicate
1068 if (ProgramOverview)
1069 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1071 outs() << "USAGE: " << ProgramName << " [options]";
1073 // Print out the positional options.
1074 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1075 if (!PositionalOpts.empty() &&
1076 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1077 CAOpt = PositionalOpts[0];
1079 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1080 if (PositionalOpts[i]->ArgStr[0])
1081 outs() << " --" << PositionalOpts[i]->ArgStr;
1082 outs() << " " << PositionalOpts[i]->HelpStr;
1085 // Print the consume after option info if it exists...
1086 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1090 // Compute the maximum argument length...
1092 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1093 MaxArgLen = std::max(MaxArgLen, Opts[i]->getOptionWidth());
1095 outs() << "OPTIONS:\n";
1096 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1097 Opts[i]->printOptionInfo(MaxArgLen);
1099 // Print any extra help the user has declared.
1100 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1101 E = MoreHelp->end(); I != E; ++I)
1105 // Halt the program since help information was printed
1109 } // End anonymous namespace
1111 // Define the two HelpPrinter instances that are used to print out help, or
1114 static HelpPrinter NormalPrinter(false);
1115 static HelpPrinter HiddenPrinter(true);
1117 static cl::opt<HelpPrinter, true, parser<bool> >
1118 HOp("help", cl::desc("Display available options (--help-hidden for more)"),
1119 cl::location(NormalPrinter), cl::ValueDisallowed);
1121 static cl::opt<HelpPrinter, true, parser<bool> >
1122 HHOp("help-hidden", cl::desc("Display all available options"),
1123 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1125 static void (*OverrideVersionPrinter)() = 0;
1128 class VersionPrinter {
1131 outs() << "Low Level Virtual Machine (http://llvm.org/):\n"
1132 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1133 #ifdef LLVM_VERSION_INFO
1134 outs() << LLVM_VERSION_INFO;
1137 #ifndef __OPTIMIZE__
1138 outs() << "DEBUG build";
1140 outs() << "Optimized build";
1143 outs() << " with assertions";
1146 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1147 << " Host: " << sys::getHostTriple() << "\n"
1149 << " Registered Targets:\n";
1151 std::vector<std::pair<std::string, const Target*> > Targets;
1153 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1154 ie = TargetRegistry::end(); it != ie; ++it) {
1155 Targets.push_back(std::make_pair(it->getName(), &*it));
1156 Width = std::max(Width, Targets.back().first.length());
1158 std::sort(Targets.begin(), Targets.end());
1160 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1161 outs() << " " << Targets[i].first
1162 << std::string(Width - Targets[i].first.length(), ' ') << " - "
1163 << Targets[i].second->getShortDescription() << "\n";
1165 if (Targets.empty())
1166 outs() << " (none)\n";
1168 void operator=(bool OptionWasSpecified) {
1169 if (OptionWasSpecified) {
1170 if (OverrideVersionPrinter == 0) {
1174 (*OverrideVersionPrinter)();
1180 } // End anonymous namespace
1183 // Define the --version option that prints out the LLVM version for the tool
1184 static VersionPrinter VersionPrinterInstance;
1186 static cl::opt<VersionPrinter, true, parser<bool> >
1187 VersOp("version", cl::desc("Display the version of this program"),
1188 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1190 // Utility function for printing the help message.
1191 void cl::PrintHelpMessage() {
1192 // This looks weird, but it actually prints the help message. The
1193 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1194 // its operator= is invoked. That's because the "normal" usages of the
1195 // help printer is to be assigned true/false depending on whether the
1196 // --help option was given or not. Since we're circumventing that we have
1197 // to make it look like --help was given, so we assign true.
1198 NormalPrinter = true;
1201 /// Utility function for printing version number.
1202 void cl::PrintVersionMessage() {
1203 VersionPrinterInstance.print();
1206 void cl::SetVersionPrinter(void (*func)()) {
1207 OverrideVersionPrinter = func;