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-c/Support.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/SmallPtrSet.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/ADT/StringMap.h"
25 #include "llvm/ADT/Twine.h"
26 #include "llvm/Config/config.h"
27 #include "llvm/Support/ConvertUTF.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/Host.h"
31 #include "llvm/Support/ManagedStatic.h"
32 #include "llvm/Support/MemoryBuffer.h"
33 #include "llvm/Support/Path.h"
34 #include "llvm/Support/raw_ostream.h"
38 #include <system_error>
42 #define DEBUG_TYPE "commandline"
44 //===----------------------------------------------------------------------===//
45 // Template instantiations and anchors.
49 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
50 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
51 TEMPLATE_INSTANTIATION(class basic_parser<int>);
52 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
53 TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
54 TEMPLATE_INSTANTIATION(class basic_parser<double>);
55 TEMPLATE_INSTANTIATION(class basic_parser<float>);
56 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
57 TEMPLATE_INSTANTIATION(class basic_parser<char>);
59 TEMPLATE_INSTANTIATION(class opt<unsigned>);
60 TEMPLATE_INSTANTIATION(class opt<int>);
61 TEMPLATE_INSTANTIATION(class opt<std::string>);
62 TEMPLATE_INSTANTIATION(class opt<char>);
63 TEMPLATE_INSTANTIATION(class opt<bool>);
65 } // end namespace llvm::cl
67 // Pin the vtables to this file.
68 void GenericOptionValue::anchor() {}
69 void OptionValue<boolOrDefault>::anchor() {}
70 void OptionValue<std::string>::anchor() {}
71 void Option::anchor() {}
72 void basic_parser_impl::anchor() {}
73 void parser<bool>::anchor() {}
74 void parser<boolOrDefault>::anchor() {}
75 void parser<int>::anchor() {}
76 void parser<unsigned>::anchor() {}
77 void parser<unsigned long long>::anchor() {}
78 void parser<double>::anchor() {}
79 void parser<float>::anchor() {}
80 void parser<std::string>::anchor() {}
81 void parser<char>::anchor() {}
82 void StringSaver::anchor() {}
84 //===----------------------------------------------------------------------===//
88 class CommandLineParser {
90 // Globals for name and overview of program. Program name is not a string to
91 // avoid static ctor/dtor issues.
92 std::string ProgramName;
93 const char *ProgramOverview;
95 // This collects additional help to be printed.
96 std::vector<const char *> MoreHelp;
98 SmallVector<Option *, 4> PositionalOpts;
99 SmallVector<Option *, 4> SinkOpts;
100 StringMap<Option *> OptionsMap;
102 Option *ConsumeAfterOpt; // The ConsumeAfter option if it exists.
104 CommandLineParser() : ProgramOverview(nullptr), ConsumeAfterOpt(nullptr) {}
106 void ParseCommandLineOptions(int argc, const char *const *argv,
107 const char *Overview);
109 void addLiteralOption(Option &Opt, const char *Name) {
110 if (!Opt.hasArgStr()) {
111 if (!OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
112 errs() << ProgramName << ": CommandLine Error: Option '" << Name
113 << "' registered more than once!\n";
114 report_fatal_error("inconsistency in registered CommandLine options");
119 void addOption(Option *O) {
120 bool HadErrors = false;
122 // Add argument to the argument map!
123 if (!OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) {
124 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
125 << "' registered 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) {
136 if (ConsumeAfterOpt) {
137 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
143 // Fail hard if there were errors. These are strictly unrecoverable and
144 // indicate serious issues such as conflicting option names or an
146 // linked LLVM distribution.
148 report_fatal_error("inconsistency in registered CommandLine options");
151 void removeOption(Option *O) {
152 SmallVector<const char *, 16> OptionNames;
153 O->getExtraOptionNames(OptionNames);
155 OptionNames.push_back(O->ArgStr);
156 for (auto Name : OptionNames)
157 OptionsMap.erase(StringRef(Name));
159 if (O->getFormattingFlag() == cl::Positional)
160 for (auto Opt = PositionalOpts.begin(); Opt != PositionalOpts.end();
163 PositionalOpts.erase(Opt);
167 else if (O->getMiscFlags() & cl::Sink)
168 for (auto Opt = SinkOpts.begin(); Opt != SinkOpts.end(); ++Opt) {
174 else if (O == ConsumeAfterOpt)
175 ConsumeAfterOpt = nullptr;
179 return (!OptionsMap.empty() || !PositionalOpts.empty() ||
180 nullptr != ConsumeAfterOpt);
183 void updateArgStr(Option *O, const char *NewName) {
184 if (!OptionsMap.insert(std::make_pair(NewName, O)).second) {
185 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
186 << "' registered more than once!\n";
187 report_fatal_error("inconsistency in registered CommandLine options");
189 OptionsMap.erase(StringRef(O->ArgStr));
192 void printOptionValues();
197 static ManagedStatic<CommandLineParser> GlobalParser;
199 void cl::AddLiteralOption(Option &O, const char *Name) {
200 GlobalParser->addLiteralOption(O, Name);
203 extrahelp::extrahelp(const char *Help) : morehelp(Help) {
204 GlobalParser->MoreHelp.push_back(Help);
207 void Option::addArgument() {
208 GlobalParser->addOption(this);
209 FullyInitialized = true;
212 void Option::removeArgument() { GlobalParser->removeOption(this); }
214 void Option::setArgStr(const char *S) {
215 if (FullyInitialized)
216 GlobalParser->updateArgStr(this, S);
220 // This collects the different option categories that have been registered.
221 typedef SmallPtrSet<OptionCategory *, 16> OptionCatSet;
222 static ManagedStatic<OptionCatSet> RegisteredOptionCategories;
224 // Initialise the general option category.
225 OptionCategory llvm::cl::GeneralCategory("General options");
227 void OptionCategory::registerCategory() {
228 assert(std::count_if(RegisteredOptionCategories->begin(),
229 RegisteredOptionCategories->end(),
230 [this](const OptionCategory *Category) {
231 return getName() == Category->getName();
233 "Duplicate option categories");
235 RegisteredOptionCategories->insert(this);
238 //===----------------------------------------------------------------------===//
239 // Basic, shared command line option processing machinery.
242 /// LookupOption - Lookup the option specified by the specified option on the
243 /// command line. If there is a value specified (after an equal sign) return
244 /// that as well. This assumes that leading dashes have already been stripped.
245 static Option *LookupOption(StringRef &Arg, StringRef &Value,
246 const StringMap<Option *> &OptionsMap) {
247 // Reject all dashes.
251 size_t EqualPos = Arg.find('=');
253 // If we have an equals sign, remember the value.
254 if (EqualPos == StringRef::npos) {
255 // Look up the option.
256 StringMap<Option *>::const_iterator I = OptionsMap.find(Arg);
257 return I != OptionsMap.end() ? I->second : nullptr;
260 // If the argument before the = is a valid option name, we match. If not,
261 // return Arg unmolested.
262 StringMap<Option *>::const_iterator I =
263 OptionsMap.find(Arg.substr(0, EqualPos));
264 if (I == OptionsMap.end())
267 Value = Arg.substr(EqualPos + 1);
268 Arg = Arg.substr(0, EqualPos);
272 /// LookupNearestOption - Lookup the closest match to the option specified by
273 /// the specified option on the command line. If there is a value specified
274 /// (after an equal sign) return that as well. This assumes that leading dashes
275 /// have already been stripped.
276 static Option *LookupNearestOption(StringRef Arg,
277 const StringMap<Option *> &OptionsMap,
278 std::string &NearestString) {
279 // Reject all dashes.
283 // Split on any equal sign.
284 std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
285 StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
286 StringRef &RHS = SplitArg.second;
288 // Find the closest match.
289 Option *Best = nullptr;
290 unsigned BestDistance = 0;
291 for (StringMap<Option *>::const_iterator it = OptionsMap.begin(),
292 ie = OptionsMap.end();
294 Option *O = it->second;
295 SmallVector<const char *, 16> OptionNames;
296 O->getExtraOptionNames(OptionNames);
298 OptionNames.push_back(O->ArgStr);
300 bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
301 StringRef Flag = PermitValue ? LHS : Arg;
302 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
303 StringRef Name = OptionNames[i];
304 unsigned Distance = StringRef(Name).edit_distance(
305 Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
306 if (!Best || Distance < BestDistance) {
308 BestDistance = Distance;
309 if (RHS.empty() || !PermitValue)
310 NearestString = OptionNames[i];
312 NearestString = std::string(OptionNames[i]) + "=" + RHS.str();
320 /// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
321 /// that does special handling of cl::CommaSeparated options.
322 static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
323 StringRef ArgName, StringRef Value,
324 bool MultiArg = false) {
325 // Check to see if this option accepts a comma separated list of values. If
326 // it does, we have to split up the value into multiple values.
327 if (Handler->getMiscFlags() & CommaSeparated) {
328 StringRef Val(Value);
329 StringRef::size_type Pos = Val.find(',');
331 while (Pos != StringRef::npos) {
332 // Process the portion before the comma.
333 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
335 // Erase the portion before the comma, AND the comma.
336 Val = Val.substr(Pos + 1);
337 Value.substr(Pos + 1); // Increment the original value pointer as well.
338 // Check for another comma.
345 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
351 /// ProvideOption - For Value, this differentiates between an empty value ("")
352 /// and a null value (StringRef()). The later is accepted for arguments that
353 /// don't allow a value (-foo) the former is rejected (-foo=).
354 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
355 StringRef Value, int argc,
356 const char *const *argv, int &i) {
357 // Is this a multi-argument option?
358 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
360 // Enforce value requirements
361 switch (Handler->getValueExpectedFlag()) {
363 if (!Value.data()) { // No value specified?
365 return Handler->error("requires a value!");
366 // Steal the next argument, like for '-o filename'
367 assert(argv && "null check");
371 case ValueDisallowed:
372 if (NumAdditionalVals > 0)
373 return Handler->error("multi-valued option specified"
374 " with ValueDisallowed modifier!");
377 return Handler->error("does not allow a value! '" + Twine(Value) +
384 // If this isn't a multi-arg option, just run the handler.
385 if (NumAdditionalVals == 0)
386 return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
388 // If it is, run the handle several times.
389 bool MultiArg = false;
392 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
398 while (NumAdditionalVals > 0) {
400 return Handler->error("not enough values!");
401 assert(argv && "null check");
404 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
412 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
414 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
417 // Option predicates...
418 static inline bool isGrouping(const Option *O) {
419 return O->getFormattingFlag() == cl::Grouping;
421 static inline bool isPrefixedOrGrouping(const Option *O) {
422 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
425 // getOptionPred - Check to see if there are any options that satisfy the
426 // specified predicate with names that are the prefixes in Name. This is
427 // checked by progressively stripping characters off of the name, checking to
428 // see if there options that satisfy the predicate. If we find one, return it,
429 // otherwise return null.
431 static Option *getOptionPred(StringRef Name, size_t &Length,
432 bool (*Pred)(const Option *),
433 const StringMap<Option *> &OptionsMap) {
435 StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name);
437 // Loop while we haven't found an option and Name still has at least two
438 // characters in it (so that the next iteration will not be the empty
440 while (OMI == OptionsMap.end() && Name.size() > 1) {
441 Name = Name.substr(0, Name.size() - 1); // Chop off the last character.
442 OMI = OptionsMap.find(Name);
445 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
446 Length = Name.size();
447 return OMI->second; // Found one!
449 return nullptr; // No option found!
452 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
453 /// with at least one '-') does not fully match an available option. Check to
454 /// see if this is a prefix or grouped option. If so, split arg into output an
455 /// Arg/Value pair and return the Option to parse it with.
457 HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
459 const StringMap<Option *> &OptionsMap) {
465 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
469 // If the option is a prefixed option, then the value is simply the
470 // rest of the name... so fall through to later processing, by
471 // setting up the argument name flags and value fields.
472 if (PGOpt->getFormattingFlag() == cl::Prefix) {
473 Value = Arg.substr(Length);
474 Arg = Arg.substr(0, Length);
475 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
479 // This must be a grouped option... handle them now. Grouping options can't
481 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
484 // Move current arg name out of Arg into OneArgName.
485 StringRef OneArgName = Arg.substr(0, Length);
486 Arg = Arg.substr(Length);
488 // Because ValueRequired is an invalid flag for grouped arguments,
489 // we don't need to pass argc/argv in.
490 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
491 "Option can not be cl::Grouping AND cl::ValueRequired!");
494 ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy);
496 // Get the next grouping option.
497 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
498 } while (PGOpt && Length != Arg.size());
500 // Return the last option with Arg cut down to just the last one.
504 static bool RequiresValue(const Option *O) {
505 return O->getNumOccurrencesFlag() == cl::Required ||
506 O->getNumOccurrencesFlag() == cl::OneOrMore;
509 static bool EatsUnboundedNumberOfValues(const Option *O) {
510 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
511 O->getNumOccurrencesFlag() == cl::OneOrMore;
514 static bool isWhitespace(char C) { return strchr(" \t\n\r\f\v", C); }
516 static bool isQuote(char C) { return C == '\"' || C == '\''; }
518 static bool isGNUSpecial(char C) { return strchr("\\\"\' ", C); }
520 void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
521 SmallVectorImpl<const char *> &NewArgv,
523 SmallString<128> Token;
524 for (size_t I = 0, E = Src.size(); I != E; ++I) {
525 // Consume runs of whitespace.
527 while (I != E && isWhitespace(Src[I])) {
528 // Mark the end of lines in response files
529 if (MarkEOLs && Src[I] == '\n')
530 NewArgv.push_back(nullptr);
537 // Backslashes can escape backslashes, spaces, and other quotes. Otherwise
538 // they are literal. This makes it much easier to read Windows file paths.
539 if (I + 1 < E && Src[I] == '\\' && isGNUSpecial(Src[I + 1])) {
540 ++I; // Skip the escape.
541 Token.push_back(Src[I]);
545 // Consume a quoted string.
546 if (isQuote(Src[I])) {
547 char Quote = Src[I++];
548 while (I != E && Src[I] != Quote) {
549 // Backslashes are literal, unless they escape a special character.
550 if (Src[I] == '\\' && I + 1 != E && isGNUSpecial(Src[I + 1]))
552 Token.push_back(Src[I]);
560 // End the token if this is whitespace.
561 if (isWhitespace(Src[I])) {
563 NewArgv.push_back(Saver.SaveString(Token.c_str()));
568 // This is a normal character. Append it.
569 Token.push_back(Src[I]);
572 // Append the last token after hitting EOF with no whitespace.
574 NewArgv.push_back(Saver.SaveString(Token.c_str()));
575 // Mark the end of response files
577 NewArgv.push_back(nullptr);
580 /// Backslashes are interpreted in a rather complicated way in the Windows-style
581 /// command line, because backslashes are used both to separate path and to
582 /// escape double quote. This method consumes runs of backslashes as well as the
583 /// following double quote if it's escaped.
585 /// * If an even number of backslashes is followed by a double quote, one
586 /// backslash is output for every pair of backslashes, and the last double
587 /// quote remains unconsumed. The double quote will later be interpreted as
588 /// the start or end of a quoted string in the main loop outside of this
591 /// * If an odd number of backslashes is followed by a double quote, one
592 /// backslash is output for every pair of backslashes, and a double quote is
593 /// output for the last pair of backslash-double quote. The double quote is
594 /// consumed in this case.
596 /// * Otherwise, backslashes are interpreted literally.
597 static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
598 size_t E = Src.size();
599 int BackslashCount = 0;
600 // Skip the backslashes.
604 } while (I != E && Src[I] == '\\');
606 bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
607 if (FollowedByDoubleQuote) {
608 Token.append(BackslashCount / 2, '\\');
609 if (BackslashCount % 2 == 0)
611 Token.push_back('"');
614 Token.append(BackslashCount, '\\');
618 void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
619 SmallVectorImpl<const char *> &NewArgv,
621 SmallString<128> Token;
623 // This is a small state machine to consume characters until it reaches the
624 // end of the source string.
625 enum { INIT, UNQUOTED, QUOTED } State = INIT;
626 for (size_t I = 0, E = Src.size(); I != E; ++I) {
627 // INIT state indicates that the current input index is at the start of
628 // the string or between tokens.
630 if (isWhitespace(Src[I])) {
631 // Mark the end of lines in response files
632 if (MarkEOLs && Src[I] == '\n')
633 NewArgv.push_back(nullptr);
640 if (Src[I] == '\\') {
641 I = parseBackslash(Src, I, Token);
645 Token.push_back(Src[I]);
650 // UNQUOTED state means that it's reading a token not quoted by double
652 if (State == UNQUOTED) {
653 // Whitespace means the end of the token.
654 if (isWhitespace(Src[I])) {
655 NewArgv.push_back(Saver.SaveString(Token.c_str()));
658 // Mark the end of lines in response files
659 if (MarkEOLs && Src[I] == '\n')
660 NewArgv.push_back(nullptr);
667 if (Src[I] == '\\') {
668 I = parseBackslash(Src, I, Token);
671 Token.push_back(Src[I]);
675 // QUOTED state means that it's reading a token quoted by double quotes.
676 if (State == QUOTED) {
681 if (Src[I] == '\\') {
682 I = parseBackslash(Src, I, Token);
685 Token.push_back(Src[I]);
688 // Append the last token after hitting EOF with no whitespace.
690 NewArgv.push_back(Saver.SaveString(Token.c_str()));
691 // Mark the end of response files
693 NewArgv.push_back(nullptr);
696 // It is called byte order marker but the UTF-8 BOM is actually not affected
697 // by the host system's endianness.
698 static bool hasUTF8ByteOrderMark(ArrayRef<char> S) {
699 return (S.size() >= 3 &&
700 S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
703 static bool ExpandResponseFile(const char *FName, StringSaver &Saver,
704 TokenizerCallback Tokenizer,
705 SmallVectorImpl<const char *> &NewArgv,
706 bool MarkEOLs = false) {
707 ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
708 MemoryBuffer::getFile(FName);
711 MemoryBuffer &MemBuf = *MemBufOrErr.get();
712 StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
714 // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
715 ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
717 if (hasUTF16ByteOrderMark(BufRef)) {
718 if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
720 Str = StringRef(UTF8Buf);
722 // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
723 // these bytes before parsing.
724 // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
725 else if (hasUTF8ByteOrderMark(BufRef))
726 Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
728 // Tokenize the contents into NewArgv.
729 Tokenizer(Str, Saver, NewArgv, MarkEOLs);
734 /// \brief Expand response files on a command line recursively using the given
735 /// StringSaver and tokenization strategy.
736 bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
737 SmallVectorImpl<const char *> &Argv,
739 unsigned RspFiles = 0;
740 bool AllExpanded = true;
742 // Don't cache Argv.size() because it can change.
743 for (unsigned I = 0; I != Argv.size();) {
744 const char *Arg = Argv[I];
745 // Check if it is an EOL marker
746 if (Arg == nullptr) {
755 // If we have too many response files, leave some unexpanded. This avoids
756 // crashing on self-referential response files.
760 // Replace this response file argument with the tokenization of its
761 // contents. Nested response files are expanded in subsequent iterations.
762 // FIXME: If a nested response file uses a relative path, is it relative to
763 // the cwd of the process or the response file?
764 SmallVector<const char *, 0> ExpandedArgv;
765 if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
767 // We couldn't read this file, so we leave it in the argument stream and
773 Argv.erase(Argv.begin() + I);
774 Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
780 class StrDupSaver : public StringSaver {
781 std::vector<char *> Dups;
785 for (std::vector<char *>::iterator I = Dups.begin(), E = Dups.end(); I != E;
791 const char *SaveString(const char *Str) override {
792 char *Dup = strdup(Str);
799 /// ParseEnvironmentOptions - An alternative entry point to the
800 /// CommandLine library, which allows you to read the program's name
801 /// from the caller (as PROGNAME) and its command-line arguments from
802 /// an environment variable (whose name is given in ENVVAR).
804 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
805 const char *Overview) {
807 assert(progName && "Program name not specified");
808 assert(envVar && "Environment variable name missing");
810 // Get the environment variable they want us to parse options out of.
811 const char *envValue = getenv(envVar);
815 // Get program's "name", which we wouldn't know without the caller
817 SmallVector<const char *, 20> newArgv;
819 newArgv.push_back(Saver.SaveString(progName));
821 // Parse the value of the environment variable into a "command line"
822 // and hand it off to ParseCommandLineOptions().
823 TokenizeGNUCommandLine(envValue, Saver, newArgv);
824 int newArgc = static_cast<int>(newArgv.size());
825 ParseCommandLineOptions(newArgc, &newArgv[0], Overview);
828 void cl::ParseCommandLineOptions(int argc, const char *const *argv,
829 const char *Overview) {
830 GlobalParser->ParseCommandLineOptions(argc, argv, Overview);
833 void CommandLineParser::ParseCommandLineOptions(int argc,
834 const char *const *argv,
835 const char *Overview) {
836 assert(hasOptions() && "No options specified!");
838 // Expand response files.
839 SmallVector<const char *, 20> newArgv;
840 for (int i = 0; i != argc; ++i)
841 newArgv.push_back(argv[i]);
843 ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
845 argc = static_cast<int>(newArgv.size());
847 // Copy the program name into ProgName, making sure not to overflow it.
848 ProgramName = sys::path::filename(argv[0]);
850 ProgramOverview = Overview;
851 bool ErrorParsing = false;
853 // Check out the positional arguments to collect information about them.
854 unsigned NumPositionalRequired = 0;
856 // Determine whether or not there are an unlimited number of positionals
857 bool HasUnlimitedPositionals = false;
859 if (ConsumeAfterOpt) {
860 assert(PositionalOpts.size() > 0 &&
861 "Cannot specify cl::ConsumeAfter without a positional argument!");
863 if (!PositionalOpts.empty()) {
865 // Calculate how many positional values are _required_.
866 bool UnboundedFound = false;
867 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
868 Option *Opt = PositionalOpts[i];
869 if (RequiresValue(Opt))
870 ++NumPositionalRequired;
871 else if (ConsumeAfterOpt) {
872 // ConsumeAfter cannot be combined with "optional" positional options
873 // unless there is only one positional argument...
874 if (PositionalOpts.size() > 1)
875 ErrorParsing |= Opt->error(
876 "error - this positional option will never be matched, "
877 "because it does not Require a value, and a "
878 "cl::ConsumeAfter option is active!");
879 } else if (UnboundedFound && !Opt->ArgStr[0]) {
880 // This option does not "require" a value... Make sure this option is
881 // not specified after an option that eats all extra arguments, or this
882 // one will never get any!
884 ErrorParsing |= Opt->error("error - option can never match, because "
885 "another positional argument will match an "
886 "unbounded number of values, and this option"
887 " does not require a value!");
888 errs() << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr
889 << "' is all messed up!\n";
890 errs() << PositionalOpts.size();
892 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
894 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
897 // PositionalVals - A vector of "positional" arguments we accumulate into
898 // the process at the end.
900 SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
902 // If the program has named positional arguments, and the name has been run
903 // across, keep track of which positional argument was named. Otherwise put
904 // the positional args into the PositionalVals list...
905 Option *ActivePositionalArg = nullptr;
907 // Loop over all of the arguments... processing them.
908 bool DashDashFound = false; // Have we read '--'?
909 for (int i = 1; i < argc; ++i) {
910 Option *Handler = nullptr;
911 Option *NearestHandler = nullptr;
912 std::string NearestHandlerString;
914 StringRef ArgName = "";
916 // Check to see if this is a positional argument. This argument is
917 // considered to be positional if it doesn't start with '-', if it is "-"
918 // itself, or if we have seen "--" already.
920 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
921 // Positional argument!
922 if (ActivePositionalArg) {
923 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
924 continue; // We are done!
927 if (!PositionalOpts.empty()) {
928 PositionalVals.push_back(std::make_pair(argv[i], i));
930 // All of the positional arguments have been fulfulled, give the rest to
931 // the consume after option... if it's specified...
933 if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
934 for (++i; i < argc; ++i)
935 PositionalVals.push_back(std::make_pair(argv[i], i));
936 break; // Handle outside of the argument processing loop...
939 // Delay processing positional arguments until the end...
942 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
944 DashDashFound = true; // This is the mythical "--"?
945 continue; // Don't try to process it as an argument itself.
946 } else if (ActivePositionalArg &&
947 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
948 // If there is a positional argument eating options, check to see if this
949 // option is another positional argument. If so, treat it as an argument,
950 // otherwise feed it to the eating positional.
951 ArgName = argv[i] + 1;
952 // Eat leading dashes.
953 while (!ArgName.empty() && ArgName[0] == '-')
954 ArgName = ArgName.substr(1);
956 Handler = LookupOption(ArgName, Value, OptionsMap);
957 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
958 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
959 continue; // We are done!
962 } else { // We start with a '-', must be an argument.
963 ArgName = argv[i] + 1;
964 // Eat leading dashes.
965 while (!ArgName.empty() && ArgName[0] == '-')
966 ArgName = ArgName.substr(1);
968 Handler = LookupOption(ArgName, Value, OptionsMap);
970 // Check to see if this "option" is really a prefixed or grouped argument.
972 Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
975 // Otherwise, look for the closest available option to report to the user
976 // in the upcoming error.
977 if (!Handler && SinkOpts.empty())
979 LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
983 if (SinkOpts.empty()) {
984 errs() << ProgramName << ": Unknown command line argument '" << argv[i]
985 << "'. Try: '" << argv[0] << " -help'\n";
987 if (NearestHandler) {
988 // If we know a near match, report it as well.
989 errs() << ProgramName << ": Did you mean '-" << NearestHandlerString
995 for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
998 (*I)->addOccurrence(i, "", argv[i]);
1003 // If this is a named positional argument, just remember that it is the
1005 if (Handler->getFormattingFlag() == cl::Positional)
1006 ActivePositionalArg = Handler;
1008 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
1011 // Check and handle positional arguments now...
1012 if (NumPositionalRequired > PositionalVals.size()) {
1013 errs() << ProgramName
1014 << ": Not enough positional command line arguments specified!\n"
1015 << "Must specify at least " << NumPositionalRequired
1016 << " positional arguments: See: " << argv[0] << " -help\n";
1018 ErrorParsing = true;
1019 } else if (!HasUnlimitedPositionals &&
1020 PositionalVals.size() > PositionalOpts.size()) {
1021 errs() << ProgramName << ": Too many positional arguments specified!\n"
1022 << "Can specify at most " << PositionalOpts.size()
1023 << " positional arguments: See: " << argv[0] << " -help\n";
1024 ErrorParsing = true;
1026 } else if (!ConsumeAfterOpt) {
1027 // Positional args have already been handled if ConsumeAfter is specified.
1028 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1029 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1030 if (RequiresValue(PositionalOpts[i])) {
1031 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
1032 PositionalVals[ValNo].second);
1034 --NumPositionalRequired; // We fulfilled our duty...
1037 // If we _can_ give this option more arguments, do so now, as long as we
1038 // do not give it values that others need. 'Done' controls whether the
1039 // option even _WANTS_ any more.
1041 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
1042 while (NumVals - ValNo > NumPositionalRequired && !Done) {
1043 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
1045 Done = true; // Optional arguments want _at most_ one value
1047 case cl::ZeroOrMore: // Zero or more will take all they can get...
1048 case cl::OneOrMore: // One or more will take all they can get...
1049 ProvidePositionalOption(PositionalOpts[i],
1050 PositionalVals[ValNo].first,
1051 PositionalVals[ValNo].second);
1055 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
1056 "positional argument processing!");
1061 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1063 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
1064 if (RequiresValue(PositionalOpts[j])) {
1065 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
1066 PositionalVals[ValNo].first,
1067 PositionalVals[ValNo].second);
1071 // Handle the case where there is just one positional option, and it's
1072 // optional. In this case, we want to give JUST THE FIRST option to the
1073 // positional option and keep the rest for the consume after. The above
1074 // loop would have assigned no values to positional options in this case.
1076 if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1077 ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
1078 PositionalVals[ValNo].first,
1079 PositionalVals[ValNo].second);
1083 // Handle over all of the rest of the arguments to the
1084 // cl::ConsumeAfter command line option...
1085 for (; ValNo != PositionalVals.size(); ++ValNo)
1087 ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1088 PositionalVals[ValNo].second);
1091 // Loop over args and make sure all required args are specified!
1092 for (const auto &Opt : OptionsMap) {
1093 switch (Opt.second->getNumOccurrencesFlag()) {
1096 if (Opt.second->getNumOccurrences() == 0) {
1097 Opt.second->error("must be specified at least once!");
1098 ErrorParsing = true;
1106 // Now that we know if -debug is specified, we can use it.
1107 // Note that if ReadResponseFiles == true, this must be done before the
1108 // memory allocated for the expanded command line is free()d below.
1109 DEBUG(dbgs() << "Args: ";
1110 for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1113 // Free all of the memory allocated to the map. Command line options may only
1114 // be processed once!
1117 // If we had an error processing our arguments, don't let the program execute
1122 //===----------------------------------------------------------------------===//
1123 // Option Base class implementation
1126 bool Option::error(const Twine &Message, StringRef ArgName) {
1127 if (!ArgName.data())
1129 if (ArgName.empty())
1130 errs() << HelpStr; // Be nice for positional arguments
1132 errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
1134 errs() << " option: " << Message << "\n";
1138 bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1141 NumOccurrences++; // Increment the number of times we have been seen
1143 switch (getNumOccurrencesFlag()) {
1145 if (NumOccurrences > 1)
1146 return error("may only occur zero or one times!", ArgName);
1149 if (NumOccurrences > 1)
1150 return error("must occur exactly one time!", ArgName);
1158 return handleOccurrence(pos, ArgName, Value);
1161 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
1162 // has been specified yet.
1164 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
1165 if (O.ValueStr[0] == 0)
1170 //===----------------------------------------------------------------------===//
1171 // cl::alias class implementation
1174 // Return the width of the option tag for printing...
1175 size_t alias::getOptionWidth() const { return std::strlen(ArgStr) + 6; }
1177 static void printHelpStr(StringRef HelpStr, size_t Indent,
1178 size_t FirstLineIndentedBy) {
1179 std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1180 outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1181 while (!Split.second.empty()) {
1182 Split = Split.second.split('\n');
1183 outs().indent(Indent) << Split.first << "\n";
1187 // Print out the option for the alias.
1188 void alias::printOptionInfo(size_t GlobalWidth) const {
1189 outs() << " -" << ArgStr;
1190 printHelpStr(HelpStr, GlobalWidth, std::strlen(ArgStr) + 6);
1193 //===----------------------------------------------------------------------===//
1194 // Parser Implementation code...
1197 // basic_parser implementation
1200 // Return the width of the option tag for printing...
1201 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
1202 size_t Len = std::strlen(O.ArgStr);
1203 if (const char *ValName = getValueName())
1204 Len += std::strlen(getValueStr(O, ValName)) + 3;
1209 // printOptionInfo - Print out information about this option. The
1210 // to-be-maintained width is specified.
1212 void basic_parser_impl::printOptionInfo(const Option &O,
1213 size_t GlobalWidth) const {
1214 outs() << " -" << O.ArgStr;
1216 if (const char *ValName = getValueName())
1217 outs() << "=<" << getValueStr(O, ValName) << '>';
1219 printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1222 void basic_parser_impl::printOptionName(const Option &O,
1223 size_t GlobalWidth) const {
1224 outs() << " -" << O.ArgStr;
1225 outs().indent(GlobalWidth - std::strlen(O.ArgStr));
1228 // parser<bool> implementation
1230 bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1232 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1238 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1242 return O.error("'" + Arg +
1243 "' is invalid value for boolean argument! Try 0 or 1");
1246 // parser<boolOrDefault> implementation
1248 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg,
1249 boolOrDefault &Value) {
1250 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1255 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1260 return O.error("'" + Arg +
1261 "' is invalid value for boolean argument! Try 0 or 1");
1264 // parser<int> implementation
1266 bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1268 if (Arg.getAsInteger(0, Value))
1269 return O.error("'" + Arg + "' value invalid for integer argument!");
1273 // parser<unsigned> implementation
1275 bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1278 if (Arg.getAsInteger(0, Value))
1279 return O.error("'" + Arg + "' value invalid for uint argument!");
1283 // parser<unsigned long long> implementation
1285 bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
1287 unsigned long long &Value) {
1289 if (Arg.getAsInteger(0, Value))
1290 return O.error("'" + Arg + "' value invalid for uint argument!");
1294 // parser<double>/parser<float> implementation
1296 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1297 SmallString<32> TmpStr(Arg.begin(), Arg.end());
1298 const char *ArgStart = TmpStr.c_str();
1300 Value = strtod(ArgStart, &End);
1302 return O.error("'" + Arg + "' value invalid for floating point argument!");
1306 bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1308 return parseDouble(O, Arg, Val);
1311 bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1314 if (parseDouble(O, Arg, dVal))
1320 // generic_parser_base implementation
1323 // findOption - Return the option number corresponding to the specified
1324 // argument string. If the option is not found, getNumOptions() is returned.
1326 unsigned generic_parser_base::findOption(const char *Name) {
1327 unsigned e = getNumOptions();
1329 for (unsigned i = 0; i != e; ++i) {
1330 if (strcmp(getOption(i), Name) == 0)
1336 // Return the width of the option tag for printing...
1337 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1338 if (O.hasArgStr()) {
1339 size_t Size = std::strlen(O.ArgStr) + 6;
1340 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1341 Size = std::max(Size, std::strlen(getOption(i)) + 8);
1344 size_t BaseSize = 0;
1345 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1346 BaseSize = std::max(BaseSize, std::strlen(getOption(i)) + 8);
1351 // printOptionInfo - Print out information about this option. The
1352 // to-be-maintained width is specified.
1354 void generic_parser_base::printOptionInfo(const Option &O,
1355 size_t GlobalWidth) const {
1356 if (O.hasArgStr()) {
1357 outs() << " -" << O.ArgStr;
1358 printHelpStr(O.HelpStr, GlobalWidth, std::strlen(O.ArgStr) + 6);
1360 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1361 size_t NumSpaces = GlobalWidth - strlen(getOption(i)) - 8;
1362 outs() << " =" << getOption(i);
1363 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1367 outs() << " " << O.HelpStr << '\n';
1368 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1369 const char *Option = getOption(i);
1370 outs() << " -" << Option;
1371 printHelpStr(getDescription(i), GlobalWidth, std::strlen(Option) + 8);
1376 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1378 // printGenericOptionDiff - Print the value of this option and it's default.
1380 // "Generic" options have each value mapped to a name.
1381 void generic_parser_base::printGenericOptionDiff(
1382 const Option &O, const GenericOptionValue &Value,
1383 const GenericOptionValue &Default, size_t GlobalWidth) const {
1384 outs() << " -" << O.ArgStr;
1385 outs().indent(GlobalWidth - std::strlen(O.ArgStr));
1387 unsigned NumOpts = getNumOptions();
1388 for (unsigned i = 0; i != NumOpts; ++i) {
1389 if (Value.compare(getOptionValue(i)))
1392 outs() << "= " << getOption(i);
1393 size_t L = std::strlen(getOption(i));
1394 size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1395 outs().indent(NumSpaces) << " (default: ";
1396 for (unsigned j = 0; j != NumOpts; ++j) {
1397 if (Default.compare(getOptionValue(j)))
1399 outs() << getOption(j);
1405 outs() << "= *unknown option value*\n";
1408 // printOptionDiff - Specializations for printing basic value types.
1410 #define PRINT_OPT_DIFF(T) \
1411 void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1412 size_t GlobalWidth) const { \
1413 printOptionName(O, GlobalWidth); \
1416 raw_string_ostream SS(Str); \
1419 outs() << "= " << Str; \
1420 size_t NumSpaces = \
1421 MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
1422 outs().indent(NumSpaces) << " (default: "; \
1424 outs() << D.getValue(); \
1426 outs() << "*no default*"; \
1430 PRINT_OPT_DIFF(bool)
1431 PRINT_OPT_DIFF(boolOrDefault)
1433 PRINT_OPT_DIFF(unsigned)
1434 PRINT_OPT_DIFF(unsigned long long)
1435 PRINT_OPT_DIFF(double)
1436 PRINT_OPT_DIFF(float)
1437 PRINT_OPT_DIFF(char)
1439 void parser<std::string>::printOptionDiff(const Option &O, StringRef V,
1440 OptionValue<std::string> D,
1441 size_t GlobalWidth) const {
1442 printOptionName(O, GlobalWidth);
1443 outs() << "= " << V;
1444 size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1445 outs().indent(NumSpaces) << " (default: ";
1447 outs() << D.getValue();
1449 outs() << "*no default*";
1453 // Print a placeholder for options that don't yet support printOptionDiff().
1454 void basic_parser_impl::printOptionNoValue(const Option &O,
1455 size_t GlobalWidth) const {
1456 printOptionName(O, GlobalWidth);
1457 outs() << "= *cannot print option value*\n";
1460 //===----------------------------------------------------------------------===//
1461 // -help and -help-hidden option implementation
1464 static int OptNameCompare(const void *LHS, const void *RHS) {
1465 typedef std::pair<const char *, Option *> pair_ty;
1467 return strcmp(((const pair_ty *)LHS)->first, ((const pair_ty *)RHS)->first);
1470 // Copy Options into a vector so we can sort them as we like.
1471 static void sortOpts(StringMap<Option *> &OptMap,
1472 SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1474 SmallPtrSet<Option *, 128> OptionSet; // Duplicate option detection.
1476 for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
1478 // Ignore really-hidden options.
1479 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1482 // Unless showhidden is set, ignore hidden flags.
1483 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1486 // If we've already seen this option, don't add it to the list again.
1487 if (!OptionSet.insert(I->second).second)
1491 std::pair<const char *, Option *>(I->getKey().data(), I->second));
1494 // Sort the options list alphabetically.
1495 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1502 const bool ShowHidden;
1503 typedef SmallVector<std::pair<const char *, Option *>, 128>
1504 StrOptionPairVector;
1505 // Print the options. Opts is assumed to be alphabetically sorted.
1506 virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1507 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1508 Opts[i].second->printOptionInfo(MaxArgLen);
1512 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
1513 virtual ~HelpPrinter() {}
1515 // Invoke the printer.
1516 void operator=(bool Value) {
1520 StrOptionPairVector Opts;
1521 sortOpts(GlobalParser->OptionsMap, Opts, ShowHidden);
1523 if (GlobalParser->ProgramOverview)
1524 outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
1526 outs() << "USAGE: " << GlobalParser->ProgramName << " [options]";
1528 for (auto Opt : GlobalParser->PositionalOpts) {
1530 outs() << " --" << Opt->ArgStr;
1531 outs() << " " << Opt->HelpStr;
1534 // Print the consume after option info if it exists...
1535 if (GlobalParser->ConsumeAfterOpt)
1536 outs() << " " << GlobalParser->ConsumeAfterOpt->HelpStr;
1540 // Compute the maximum argument length...
1541 size_t MaxArgLen = 0;
1542 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1543 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1545 outs() << "OPTIONS:\n";
1546 printOptions(Opts, MaxArgLen);
1548 // Print any extra help the user has declared.
1549 for (auto I : GlobalParser->MoreHelp)
1551 GlobalParser->MoreHelp.clear();
1553 // Halt the program since help information was printed
1558 class CategorizedHelpPrinter : public HelpPrinter {
1560 explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1562 // Helper function for printOptions().
1563 // It shall return true if A's name should be lexographically
1564 // ordered before B's name. It returns false otherwise.
1565 static bool OptionCategoryCompare(OptionCategory *A, OptionCategory *B) {
1566 return strcmp(A->getName(), B->getName()) < 0;
1569 // Make sure we inherit our base class's operator=()
1570 using HelpPrinter::operator=;
1573 void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
1574 std::vector<OptionCategory *> SortedCategories;
1575 std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
1577 // Collect registered option categories into vector in preparation for
1579 for (OptionCatSet::const_iterator I = RegisteredOptionCategories->begin(),
1580 E = RegisteredOptionCategories->end();
1582 SortedCategories.push_back(*I);
1585 // Sort the different option categories alphabetically.
1586 assert(SortedCategories.size() > 0 && "No option categories registered!");
1587 std::sort(SortedCategories.begin(), SortedCategories.end(),
1588 OptionCategoryCompare);
1590 // Create map to empty vectors.
1591 for (std::vector<OptionCategory *>::const_iterator
1592 I = SortedCategories.begin(),
1593 E = SortedCategories.end();
1595 CategorizedOptions[*I] = std::vector<Option *>();
1597 // Walk through pre-sorted options and assign into categories.
1598 // Because the options are already alphabetically sorted the
1599 // options within categories will also be alphabetically sorted.
1600 for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1601 Option *Opt = Opts[I].second;
1602 assert(CategorizedOptions.count(Opt->Category) > 0 &&
1603 "Option has an unregistered category");
1604 CategorizedOptions[Opt->Category].push_back(Opt);
1608 for (std::vector<OptionCategory *>::const_iterator
1609 Category = SortedCategories.begin(),
1610 E = SortedCategories.end();
1611 Category != E; ++Category) {
1612 // Hide empty categories for -help, but show for -help-hidden.
1613 bool IsEmptyCategory = CategorizedOptions[*Category].size() == 0;
1614 if (!ShowHidden && IsEmptyCategory)
1617 // Print category information.
1619 outs() << (*Category)->getName() << ":\n";
1621 // Check if description is set.
1622 if ((*Category)->getDescription() != nullptr)
1623 outs() << (*Category)->getDescription() << "\n\n";
1627 // When using -help-hidden explicitly state if the category has no
1628 // options associated with it.
1629 if (IsEmptyCategory) {
1630 outs() << " This option category has no options.\n";
1633 // Loop over the options in the category and print.
1634 for (std::vector<Option *>::const_iterator
1635 Opt = CategorizedOptions[*Category].begin(),
1636 E = CategorizedOptions[*Category].end();
1638 (*Opt)->printOptionInfo(MaxArgLen);
1643 // This wraps the Uncategorizing and Categorizing printers and decides
1644 // at run time which should be invoked.
1645 class HelpPrinterWrapper {
1647 HelpPrinter &UncategorizedPrinter;
1648 CategorizedHelpPrinter &CategorizedPrinter;
1651 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1652 CategorizedHelpPrinter &CategorizedPrinter)
1653 : UncategorizedPrinter(UncategorizedPrinter),
1654 CategorizedPrinter(CategorizedPrinter) {}
1656 // Invoke the printer.
1657 void operator=(bool Value);
1660 } // End anonymous namespace
1662 // Declare the four HelpPrinter instances that are used to print out help, or
1663 // help-hidden as an uncategorized list or in categories.
1664 static HelpPrinter UncategorizedNormalPrinter(false);
1665 static HelpPrinter UncategorizedHiddenPrinter(true);
1666 static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1667 static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1669 // Declare HelpPrinter wrappers that will decide whether or not to invoke
1670 // a categorizing help printer
1671 static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1672 CategorizedNormalPrinter);
1673 static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1674 CategorizedHiddenPrinter);
1676 // Define a category for generic options that all tools should have.
1677 static cl::OptionCategory GenericCategory("Generic Options");
1679 // Define uncategorized help printers.
1680 // -help-list is hidden by default because if Option categories are being used
1681 // then -help behaves the same as -help-list.
1682 static cl::opt<HelpPrinter, true, parser<bool>> HLOp(
1684 cl::desc("Display list of available options (-help-list-hidden for more)"),
1685 cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
1686 cl::cat(GenericCategory));
1688 static cl::opt<HelpPrinter, true, parser<bool>>
1689 HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
1690 cl::location(UncategorizedHiddenPrinter), cl::Hidden,
1691 cl::ValueDisallowed, cl::cat(GenericCategory));
1693 // Define uncategorized/categorized help printers. These printers change their
1694 // behaviour at runtime depending on whether one or more Option categories have
1696 static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1697 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1698 cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
1699 cl::cat(GenericCategory));
1701 static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1702 HHOp("help-hidden", cl::desc("Display all available options"),
1703 cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
1704 cl::cat(GenericCategory));
1706 static cl::opt<bool> PrintOptions(
1708 cl::desc("Print non-default options after command line parsing"),
1709 cl::Hidden, cl::init(false), cl::cat(GenericCategory));
1711 static cl::opt<bool> PrintAllOptions(
1712 "print-all-options",
1713 cl::desc("Print all option values after command line parsing"), cl::Hidden,
1714 cl::init(false), cl::cat(GenericCategory));
1716 void HelpPrinterWrapper::operator=(bool Value) {
1720 // Decide which printer to invoke. If more than one option category is
1721 // registered then it is useful to show the categorized help instead of
1722 // uncategorized help.
1723 if (RegisteredOptionCategories->size() > 1) {
1724 // unhide -help-list option so user can have uncategorized output if they
1726 HLOp.setHiddenFlag(NotHidden);
1728 CategorizedPrinter = true; // Invoke categorized printer
1730 UncategorizedPrinter = true; // Invoke uncategorized printer
1733 // Print the value of each option.
1734 void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
1736 void CommandLineParser::printOptionValues() {
1737 if (!PrintOptions && !PrintAllOptions)
1740 SmallVector<std::pair<const char *, Option *>, 128> Opts;
1741 sortOpts(OptionsMap, Opts, /*ShowHidden*/ true);
1743 // Compute the maximum argument length...
1744 size_t MaxArgLen = 0;
1745 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1746 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1748 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1749 Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
1752 static void (*OverrideVersionPrinter)() = nullptr;
1754 static std::vector<void (*)()> *ExtraVersionPrinters = nullptr;
1757 class VersionPrinter {
1760 raw_ostream &OS = outs();
1761 OS << "LLVM (http://llvm.org/):\n"
1762 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1763 #ifdef LLVM_VERSION_INFO
1764 OS << " " << LLVM_VERSION_INFO;
1767 #ifndef __OPTIMIZE__
1768 OS << "DEBUG build";
1770 OS << "Optimized build";
1773 OS << " with assertions";
1775 std::string CPU = sys::getHostCPUName();
1776 if (CPU == "generic")
1779 #if (ENABLE_TIMESTAMPS == 1)
1780 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1782 << " Default target: " << sys::getDefaultTargetTriple() << '\n'
1783 << " Host CPU: " << CPU << '\n';
1785 void operator=(bool OptionWasSpecified) {
1786 if (!OptionWasSpecified)
1789 if (OverrideVersionPrinter != nullptr) {
1790 (*OverrideVersionPrinter)();
1795 // Iterate over any registered extra printers and call them to add further
1797 if (ExtraVersionPrinters != nullptr) {
1799 for (std::vector<void (*)()>::iterator I = ExtraVersionPrinters->begin(),
1800 E = ExtraVersionPrinters->end();
1808 } // End anonymous namespace
1810 // Define the --version option that prints out the LLVM version for the tool
1811 static VersionPrinter VersionPrinterInstance;
1813 static cl::opt<VersionPrinter, true, parser<bool>>
1814 VersOp("version", cl::desc("Display the version of this program"),
1815 cl::location(VersionPrinterInstance), cl::ValueDisallowed,
1816 cl::cat(GenericCategory));
1818 // Utility function for printing the help message.
1819 void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
1820 // This looks weird, but it actually prints the help message. The Printers are
1821 // types of HelpPrinter and the help gets printed when its operator= is
1822 // invoked. That's because the "normal" usages of the help printer is to be
1823 // assigned true/false depending on whether -help or -help-hidden was given or
1824 // not. Since we're circumventing that we have to make it look like -help or
1825 // -help-hidden were given, so we assign true.
1827 if (!Hidden && !Categorized)
1828 UncategorizedNormalPrinter = true;
1829 else if (!Hidden && Categorized)
1830 CategorizedNormalPrinter = true;
1831 else if (Hidden && !Categorized)
1832 UncategorizedHiddenPrinter = true;
1834 CategorizedHiddenPrinter = true;
1837 /// Utility function for printing version number.
1838 void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
1840 void cl::SetVersionPrinter(void (*func)()) { OverrideVersionPrinter = func; }
1842 void cl::AddExtraVersionPrinter(void (*func)()) {
1843 if (!ExtraVersionPrinters)
1844 ExtraVersionPrinters = new std::vector<void (*)()>;
1846 ExtraVersionPrinters->push_back(func);
1849 StringMap<Option *> &cl::getRegisteredOptions() {
1850 return GlobalParser->OptionsMap;
1853 void cl::HideUnrelatedOptions(cl::OptionCategory &Category) {
1854 for (auto &I : GlobalParser->OptionsMap) {
1855 if (I.second->Category != &Category &&
1856 I.second->Category != &GenericCategory)
1857 I.second->setHiddenFlag(cl::ReallyHidden);
1861 void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories) {
1862 auto CategoriesBegin = Categories.begin();
1863 auto CategoriesEnd = Categories.end();
1864 for (auto &I : GlobalParser->OptionsMap) {
1865 if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
1867 I.second->Category != &GenericCategory)
1868 I.second->setHiddenFlag(cl::ReallyHidden);
1872 void LLVMParseCommandLineOptions(int argc, const char *const *argv,
1873 const char *Overview) {
1874 llvm::cl::ParseCommandLineOptions(argc, argv, Overview);