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/STLExtras.h"
23 #include "llvm/ADT/SmallPtrSet.h"
24 #include "llvm/ADT/SmallString.h"
25 #include "llvm/ADT/StringMap.h"
26 #include "llvm/ADT/Twine.h"
27 #include "llvm/Config/config.h"
28 #include "llvm/Support/ConvertUTF.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/ErrorHandling.h"
31 #include "llvm/Support/Host.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/MemoryBuffer.h"
34 #include "llvm/Support/Path.h"
35 #include "llvm/Support/StringSaver.h"
36 #include "llvm/Support/raw_ostream.h"
42 #define DEBUG_TYPE "commandline"
44 //===----------------------------------------------------------------------===//
45 // Template instantiations and anchors.
49 template class basic_parser<bool>;
50 template class basic_parser<boolOrDefault>;
51 template class basic_parser<int>;
52 template class basic_parser<unsigned>;
53 template class basic_parser<unsigned long long>;
54 template class basic_parser<double>;
55 template class basic_parser<float>;
56 template class basic_parser<std::string>;
57 template class basic_parser<char>;
59 template class opt<unsigned>;
60 template class opt<int>;
61 template class opt<std::string>;
62 template class opt<char>;
63 template 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() {}
83 //===----------------------------------------------------------------------===//
87 class CommandLineParser {
89 // Globals for name and overview of program. Program name is not a string to
90 // avoid static ctor/dtor issues.
91 std::string ProgramName;
92 const char *ProgramOverview;
94 // This collects additional help to be printed.
95 std::vector<const char *> MoreHelp;
97 SmallVector<Option *, 4> PositionalOpts;
98 SmallVector<Option *, 4> SinkOpts;
99 StringMap<Option *> OptionsMap;
101 Option *ConsumeAfterOpt; // The ConsumeAfter option if it exists.
103 // This collects the different option categories that have been registered.
104 SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories;
106 CommandLineParser() : ProgramOverview(nullptr), ConsumeAfterOpt(nullptr) {}
108 void ParseCommandLineOptions(int argc, const char *const *argv,
109 const char *Overview);
111 void addLiteralOption(Option &Opt, const char *Name) {
112 if (!Opt.hasArgStr()) {
113 if (!OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
114 errs() << ProgramName << ": CommandLine Error: Option '" << Name
115 << "' registered more than once!\n";
116 report_fatal_error("inconsistency in registered CommandLine options");
121 void addOption(Option *O) {
122 bool HadErrors = false;
124 // Add argument to the argument map!
125 if (!OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) {
126 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
127 << "' registered more than once!\n";
132 // Remember information about positional options.
133 if (O->getFormattingFlag() == cl::Positional)
134 PositionalOpts.push_back(O);
135 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
136 SinkOpts.push_back(O);
137 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
138 if (ConsumeAfterOpt) {
139 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
145 // Fail hard if there were errors. These are strictly unrecoverable and
146 // indicate serious issues such as conflicting option names or an
148 // linked LLVM distribution.
150 report_fatal_error("inconsistency in registered CommandLine options");
153 void removeOption(Option *O) {
154 SmallVector<const char *, 16> OptionNames;
155 O->getExtraOptionNames(OptionNames);
157 OptionNames.push_back(O->ArgStr);
158 for (auto Name : OptionNames)
159 OptionsMap.erase(StringRef(Name));
161 if (O->getFormattingFlag() == cl::Positional)
162 for (auto Opt = PositionalOpts.begin(); Opt != PositionalOpts.end();
165 PositionalOpts.erase(Opt);
169 else if (O->getMiscFlags() & cl::Sink)
170 for (auto Opt = SinkOpts.begin(); Opt != SinkOpts.end(); ++Opt) {
176 else if (O == ConsumeAfterOpt)
177 ConsumeAfterOpt = nullptr;
181 return (!OptionsMap.empty() || !PositionalOpts.empty() ||
182 nullptr != ConsumeAfterOpt);
185 void updateArgStr(Option *O, const char *NewName) {
186 if (!OptionsMap.insert(std::make_pair(NewName, O)).second) {
187 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
188 << "' registered more than once!\n";
189 report_fatal_error("inconsistency in registered CommandLine options");
191 OptionsMap.erase(StringRef(O->ArgStr));
194 void printOptionValues();
196 void registerCategory(OptionCategory *cat) {
197 assert(std::count_if(RegisteredOptionCategories.begin(),
198 RegisteredOptionCategories.end(),
199 [cat](const OptionCategory *Category) {
200 return cat->getName() == Category->getName();
202 "Duplicate option categories");
204 RegisteredOptionCategories.insert(cat);
208 Option *LookupOption(StringRef &Arg, StringRef &Value);
213 static ManagedStatic<CommandLineParser> GlobalParser;
215 void cl::AddLiteralOption(Option &O, const char *Name) {
216 GlobalParser->addLiteralOption(O, Name);
219 extrahelp::extrahelp(const char *Help) : morehelp(Help) {
220 GlobalParser->MoreHelp.push_back(Help);
223 void Option::addArgument() {
224 GlobalParser->addOption(this);
225 FullyInitialized = true;
228 void Option::removeArgument() { GlobalParser->removeOption(this); }
230 void Option::setArgStr(const char *S) {
231 if (FullyInitialized)
232 GlobalParser->updateArgStr(this, S);
236 // Initialise the general option category.
237 OptionCategory llvm::cl::GeneralCategory("General options");
239 void OptionCategory::registerCategory() {
240 GlobalParser->registerCategory(this);
243 //===----------------------------------------------------------------------===//
244 // Basic, shared command line option processing machinery.
247 /// LookupOption - Lookup the option specified by the specified option on the
248 /// command line. If there is a value specified (after an equal sign) return
249 /// that as well. This assumes that leading dashes have already been stripped.
250 Option *CommandLineParser::LookupOption(StringRef &Arg, StringRef &Value) {
251 // Reject all dashes.
255 size_t EqualPos = Arg.find('=');
257 // If we have an equals sign, remember the value.
258 if (EqualPos == StringRef::npos) {
259 // Look up the option.
260 StringMap<Option *>::const_iterator I = OptionsMap.find(Arg);
261 return I != OptionsMap.end() ? I->second : nullptr;
264 // If the argument before the = is a valid option name, we match. If not,
265 // return Arg unmolested.
266 StringMap<Option *>::const_iterator I =
267 OptionsMap.find(Arg.substr(0, EqualPos));
268 if (I == OptionsMap.end())
271 Value = Arg.substr(EqualPos + 1);
272 Arg = Arg.substr(0, EqualPos);
276 /// LookupNearestOption - Lookup the closest match to the option specified by
277 /// the specified option on the command line. If there is a value specified
278 /// (after an equal sign) return that as well. This assumes that leading dashes
279 /// have already been stripped.
280 static Option *LookupNearestOption(StringRef Arg,
281 const StringMap<Option *> &OptionsMap,
282 std::string &NearestString) {
283 // Reject all dashes.
287 // Split on any equal sign.
288 std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
289 StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
290 StringRef &RHS = SplitArg.second;
292 // Find the closest match.
293 Option *Best = nullptr;
294 unsigned BestDistance = 0;
295 for (StringMap<Option *>::const_iterator it = OptionsMap.begin(),
296 ie = OptionsMap.end();
298 Option *O = it->second;
299 SmallVector<const char *, 16> OptionNames;
300 O->getExtraOptionNames(OptionNames);
302 OptionNames.push_back(O->ArgStr);
304 bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
305 StringRef Flag = PermitValue ? LHS : Arg;
306 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
307 StringRef Name = OptionNames[i];
308 unsigned Distance = StringRef(Name).edit_distance(
309 Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
310 if (!Best || Distance < BestDistance) {
312 BestDistance = Distance;
313 if (RHS.empty() || !PermitValue)
314 NearestString = OptionNames[i];
316 NearestString = (Twine(OptionNames[i]) + "=" + RHS).str();
324 /// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
325 /// that does special handling of cl::CommaSeparated options.
326 static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
327 StringRef ArgName, StringRef Value,
328 bool MultiArg = false) {
329 // Check to see if this option accepts a comma separated list of values. If
330 // it does, we have to split up the value into multiple values.
331 if (Handler->getMiscFlags() & CommaSeparated) {
332 StringRef Val(Value);
333 StringRef::size_type Pos = Val.find(',');
335 while (Pos != StringRef::npos) {
336 // Process the portion before the comma.
337 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
339 // Erase the portion before the comma, AND the comma.
340 Val = Val.substr(Pos + 1);
341 Value.substr(Pos + 1); // Increment the original value pointer as well.
342 // Check for another comma.
349 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
355 /// ProvideOption - For Value, this differentiates between an empty value ("")
356 /// and a null value (StringRef()). The later is accepted for arguments that
357 /// don't allow a value (-foo) the former is rejected (-foo=).
358 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
359 StringRef Value, int argc,
360 const char *const *argv, int &i) {
361 // Is this a multi-argument option?
362 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
364 // Enforce value requirements
365 switch (Handler->getValueExpectedFlag()) {
367 if (!Value.data()) { // No value specified?
369 return Handler->error("requires a value!");
370 // Steal the next argument, like for '-o filename'
371 assert(argv && "null check");
375 case ValueDisallowed:
376 if (NumAdditionalVals > 0)
377 return Handler->error("multi-valued option specified"
378 " with ValueDisallowed modifier!");
381 return Handler->error("does not allow a value! '" + Twine(Value) +
388 // If this isn't a multi-arg option, just run the handler.
389 if (NumAdditionalVals == 0)
390 return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
392 // If it is, run the handle several times.
393 bool MultiArg = false;
396 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
402 while (NumAdditionalVals > 0) {
404 return Handler->error("not enough values!");
405 assert(argv && "null check");
408 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
416 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
418 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
421 // Option predicates...
422 static inline bool isGrouping(const Option *O) {
423 return O->getFormattingFlag() == cl::Grouping;
425 static inline bool isPrefixedOrGrouping(const Option *O) {
426 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
429 // getOptionPred - Check to see if there are any options that satisfy the
430 // specified predicate with names that are the prefixes in Name. This is
431 // checked by progressively stripping characters off of the name, checking to
432 // see if there options that satisfy the predicate. If we find one, return it,
433 // otherwise return null.
435 static Option *getOptionPred(StringRef Name, size_t &Length,
436 bool (*Pred)(const Option *),
437 const StringMap<Option *> &OptionsMap) {
439 StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name);
441 // Loop while we haven't found an option and Name still has at least two
442 // characters in it (so that the next iteration will not be the empty
444 while (OMI == OptionsMap.end() && Name.size() > 1) {
445 Name = Name.substr(0, Name.size() - 1); // Chop off the last character.
446 OMI = OptionsMap.find(Name);
449 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
450 Length = Name.size();
451 return OMI->second; // Found one!
453 return nullptr; // No option found!
456 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
457 /// with at least one '-') does not fully match an available option. Check to
458 /// see if this is a prefix or grouped option. If so, split arg into output an
459 /// Arg/Value pair and return the Option to parse it with.
461 HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
463 const StringMap<Option *> &OptionsMap) {
469 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
473 // If the option is a prefixed option, then the value is simply the
474 // rest of the name... so fall through to later processing, by
475 // setting up the argument name flags and value fields.
476 if (PGOpt->getFormattingFlag() == cl::Prefix) {
477 Value = Arg.substr(Length);
478 Arg = Arg.substr(0, Length);
479 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
483 // This must be a grouped option... handle them now. Grouping options can't
485 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
488 // Move current arg name out of Arg into OneArgName.
489 StringRef OneArgName = Arg.substr(0, Length);
490 Arg = Arg.substr(Length);
492 // Because ValueRequired is an invalid flag for grouped arguments,
493 // we don't need to pass argc/argv in.
494 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
495 "Option can not be cl::Grouping AND cl::ValueRequired!");
498 ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy);
500 // Get the next grouping option.
501 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
502 } while (PGOpt && Length != Arg.size());
504 // Return the last option with Arg cut down to just the last one.
508 static bool RequiresValue(const Option *O) {
509 return O->getNumOccurrencesFlag() == cl::Required ||
510 O->getNumOccurrencesFlag() == cl::OneOrMore;
513 static bool EatsUnboundedNumberOfValues(const Option *O) {
514 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
515 O->getNumOccurrencesFlag() == cl::OneOrMore;
518 static bool isWhitespace(char C) { return strchr(" \t\n\r\f\v", C); }
520 static bool isQuote(char C) { return C == '\"' || C == '\''; }
522 static bool isGNUSpecial(char C) { return strchr("\\\"\' ", C); }
524 void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
525 SmallVectorImpl<const char *> &NewArgv,
527 SmallString<128> Token;
528 for (size_t I = 0, E = Src.size(); I != E; ++I) {
529 // Consume runs of whitespace.
531 while (I != E && isWhitespace(Src[I])) {
532 // Mark the end of lines in response files
533 if (MarkEOLs && Src[I] == '\n')
534 NewArgv.push_back(nullptr);
541 // Backslashes can escape backslashes, spaces, and other quotes. Otherwise
542 // they are literal. This makes it much easier to read Windows file paths.
543 if (I + 1 < E && Src[I] == '\\' && isGNUSpecial(Src[I + 1])) {
544 ++I; // Skip the escape.
545 Token.push_back(Src[I]);
549 // Consume a quoted string.
550 if (isQuote(Src[I])) {
551 char Quote = Src[I++];
552 while (I != E && Src[I] != Quote) {
553 // Backslashes are literal, unless they escape a special character.
554 if (Src[I] == '\\' && I + 1 != E && isGNUSpecial(Src[I + 1]))
556 Token.push_back(Src[I]);
564 // End the token if this is whitespace.
565 if (isWhitespace(Src[I])) {
567 NewArgv.push_back(Saver.save(Token.c_str()));
572 // This is a normal character. Append it.
573 Token.push_back(Src[I]);
576 // Append the last token after hitting EOF with no whitespace.
578 NewArgv.push_back(Saver.save(Token.c_str()));
579 // Mark the end of response files
581 NewArgv.push_back(nullptr);
584 /// Backslashes are interpreted in a rather complicated way in the Windows-style
585 /// command line, because backslashes are used both to separate path and to
586 /// escape double quote. This method consumes runs of backslashes as well as the
587 /// following double quote if it's escaped.
589 /// * If an even number of backslashes is followed by a double quote, one
590 /// backslash is output for every pair of backslashes, and the last double
591 /// quote remains unconsumed. The double quote will later be interpreted as
592 /// the start or end of a quoted string in the main loop outside of this
595 /// * If an odd number of backslashes is followed by a double quote, one
596 /// backslash is output for every pair of backslashes, and a double quote is
597 /// output for the last pair of backslash-double quote. The double quote is
598 /// consumed in this case.
600 /// * Otherwise, backslashes are interpreted literally.
601 static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
602 size_t E = Src.size();
603 int BackslashCount = 0;
604 // Skip the backslashes.
608 } while (I != E && Src[I] == '\\');
610 bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
611 if (FollowedByDoubleQuote) {
612 Token.append(BackslashCount / 2, '\\');
613 if (BackslashCount % 2 == 0)
615 Token.push_back('"');
618 Token.append(BackslashCount, '\\');
622 void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
623 SmallVectorImpl<const char *> &NewArgv,
625 SmallString<128> Token;
627 // This is a small state machine to consume characters until it reaches the
628 // end of the source string.
629 enum { INIT, UNQUOTED, QUOTED } State = INIT;
630 for (size_t I = 0, E = Src.size(); I != E; ++I) {
631 // INIT state indicates that the current input index is at the start of
632 // the string or between tokens.
634 if (isWhitespace(Src[I])) {
635 // Mark the end of lines in response files
636 if (MarkEOLs && Src[I] == '\n')
637 NewArgv.push_back(nullptr);
644 if (Src[I] == '\\') {
645 I = parseBackslash(Src, I, Token);
649 Token.push_back(Src[I]);
654 // UNQUOTED state means that it's reading a token not quoted by double
656 if (State == UNQUOTED) {
657 // Whitespace means the end of the token.
658 if (isWhitespace(Src[I])) {
659 NewArgv.push_back(Saver.save(Token.c_str()));
662 // Mark the end of lines in response files
663 if (MarkEOLs && Src[I] == '\n')
664 NewArgv.push_back(nullptr);
671 if (Src[I] == '\\') {
672 I = parseBackslash(Src, I, Token);
675 Token.push_back(Src[I]);
679 // QUOTED state means that it's reading a token quoted by double quotes.
680 if (State == QUOTED) {
685 if (Src[I] == '\\') {
686 I = parseBackslash(Src, I, Token);
689 Token.push_back(Src[I]);
692 // Append the last token after hitting EOF with no whitespace.
694 NewArgv.push_back(Saver.save(Token.c_str()));
695 // Mark the end of response files
697 NewArgv.push_back(nullptr);
700 // It is called byte order marker but the UTF-8 BOM is actually not affected
701 // by the host system's endianness.
702 static bool hasUTF8ByteOrderMark(ArrayRef<char> S) {
703 return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
706 static bool ExpandResponseFile(const char *FName, StringSaver &Saver,
707 TokenizerCallback Tokenizer,
708 SmallVectorImpl<const char *> &NewArgv,
709 bool MarkEOLs = false) {
710 ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
711 MemoryBuffer::getFile(FName);
714 MemoryBuffer &MemBuf = *MemBufOrErr.get();
715 StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
717 // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
718 ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
720 if (hasUTF16ByteOrderMark(BufRef)) {
721 if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
723 Str = StringRef(UTF8Buf);
725 // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
726 // these bytes before parsing.
727 // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
728 else if (hasUTF8ByteOrderMark(BufRef))
729 Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
731 // Tokenize the contents into NewArgv.
732 Tokenizer(Str, Saver, NewArgv, MarkEOLs);
737 /// \brief Expand response files on a command line recursively using the given
738 /// StringSaver and tokenization strategy.
739 bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
740 SmallVectorImpl<const char *> &Argv,
742 unsigned RspFiles = 0;
743 bool AllExpanded = true;
745 // Don't cache Argv.size() because it can change.
746 for (unsigned I = 0; I != Argv.size();) {
747 const char *Arg = Argv[I];
748 // Check if it is an EOL marker
749 if (Arg == nullptr) {
758 // If we have too many response files, leave some unexpanded. This avoids
759 // crashing on self-referential response files.
763 // Replace this response file argument with the tokenization of its
764 // contents. Nested response files are expanded in subsequent iterations.
765 // FIXME: If a nested response file uses a relative path, is it relative to
766 // the cwd of the process or the response file?
767 SmallVector<const char *, 0> ExpandedArgv;
768 if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
770 // We couldn't read this file, so we leave it in the argument stream and
776 Argv.erase(Argv.begin() + I);
777 Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
782 /// ParseEnvironmentOptions - An alternative entry point to the
783 /// CommandLine library, which allows you to read the program's name
784 /// from the caller (as PROGNAME) and its command-line arguments from
785 /// an environment variable (whose name is given in ENVVAR).
787 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
788 const char *Overview) {
790 assert(progName && "Program name not specified");
791 assert(envVar && "Environment variable name missing");
793 // Get the environment variable they want us to parse options out of.
794 const char *envValue = getenv(envVar);
798 // Get program's "name", which we wouldn't know without the caller
800 SmallVector<const char *, 20> newArgv;
802 StringSaver Saver(A);
803 newArgv.push_back(Saver.save(progName));
805 // Parse the value of the environment variable into a "command line"
806 // and hand it off to ParseCommandLineOptions().
807 TokenizeGNUCommandLine(envValue, Saver, newArgv);
808 int newArgc = static_cast<int>(newArgv.size());
809 ParseCommandLineOptions(newArgc, &newArgv[0], Overview);
812 void cl::ParseCommandLineOptions(int argc, const char *const *argv,
813 const char *Overview) {
814 GlobalParser->ParseCommandLineOptions(argc, argv, Overview);
817 void CommandLineParser::ParseCommandLineOptions(int argc,
818 const char *const *argv,
819 const char *Overview) {
820 assert(hasOptions() && "No options specified!");
822 // Expand response files.
823 SmallVector<const char *, 20> newArgv(argv, argv + argc);
825 StringSaver Saver(A);
826 ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
828 argc = static_cast<int>(newArgv.size());
830 // Copy the program name into ProgName, making sure not to overflow it.
831 ProgramName = sys::path::filename(argv[0]);
833 ProgramOverview = Overview;
834 bool ErrorParsing = false;
836 // Check out the positional arguments to collect information about them.
837 unsigned NumPositionalRequired = 0;
839 // Determine whether or not there are an unlimited number of positionals
840 bool HasUnlimitedPositionals = false;
842 if (ConsumeAfterOpt) {
843 assert(PositionalOpts.size() > 0 &&
844 "Cannot specify cl::ConsumeAfter without a positional argument!");
846 if (!PositionalOpts.empty()) {
848 // Calculate how many positional values are _required_.
849 bool UnboundedFound = false;
850 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
851 Option *Opt = PositionalOpts[i];
852 if (RequiresValue(Opt))
853 ++NumPositionalRequired;
854 else if (ConsumeAfterOpt) {
855 // ConsumeAfter cannot be combined with "optional" positional options
856 // unless there is only one positional argument...
857 if (PositionalOpts.size() > 1)
858 ErrorParsing |= Opt->error(
859 "error - this positional option will never be matched, "
860 "because it does not Require a value, and a "
861 "cl::ConsumeAfter option is active!");
862 } else if (UnboundedFound && !Opt->ArgStr[0]) {
863 // This option does not "require" a value... Make sure this option is
864 // not specified after an option that eats all extra arguments, or this
865 // one will never get any!
867 ErrorParsing |= Opt->error("error - option can never match, because "
868 "another positional argument will match an "
869 "unbounded number of values, and this option"
870 " does not require a value!");
871 errs() << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr
872 << "' is all messed up!\n";
873 errs() << PositionalOpts.size();
875 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
877 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
880 // PositionalVals - A vector of "positional" arguments we accumulate into
881 // the process at the end.
883 SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
885 // If the program has named positional arguments, and the name has been run
886 // across, keep track of which positional argument was named. Otherwise put
887 // the positional args into the PositionalVals list...
888 Option *ActivePositionalArg = nullptr;
890 // Loop over all of the arguments... processing them.
891 bool DashDashFound = false; // Have we read '--'?
892 for (int i = 1; i < argc; ++i) {
893 Option *Handler = nullptr;
894 Option *NearestHandler = nullptr;
895 std::string NearestHandlerString;
897 StringRef ArgName = "";
899 // Check to see if this is a positional argument. This argument is
900 // considered to be positional if it doesn't start with '-', if it is "-"
901 // itself, or if we have seen "--" already.
903 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
904 // Positional argument!
905 if (ActivePositionalArg) {
906 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
907 continue; // We are done!
910 if (!PositionalOpts.empty()) {
911 PositionalVals.push_back(std::make_pair(argv[i], i));
913 // All of the positional arguments have been fulfulled, give the rest to
914 // the consume after option... if it's specified...
916 if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
917 for (++i; i < argc; ++i)
918 PositionalVals.push_back(std::make_pair(argv[i], i));
919 break; // Handle outside of the argument processing loop...
922 // Delay processing positional arguments until the end...
925 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
927 DashDashFound = true; // This is the mythical "--"?
928 continue; // Don't try to process it as an argument itself.
929 } else if (ActivePositionalArg &&
930 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
931 // If there is a positional argument eating options, check to see if this
932 // option is another positional argument. If so, treat it as an argument,
933 // otherwise feed it to the eating positional.
934 ArgName = argv[i] + 1;
935 // Eat leading dashes.
936 while (!ArgName.empty() && ArgName[0] == '-')
937 ArgName = ArgName.substr(1);
939 Handler = LookupOption(ArgName, Value);
940 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
941 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
942 continue; // We are done!
945 } else { // We start with a '-', must be an argument.
946 ArgName = argv[i] + 1;
947 // Eat leading dashes.
948 while (!ArgName.empty() && ArgName[0] == '-')
949 ArgName = ArgName.substr(1);
951 Handler = LookupOption(ArgName, Value);
953 // Check to see if this "option" is really a prefixed or grouped argument.
955 Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
958 // Otherwise, look for the closest available option to report to the user
959 // in the upcoming error.
960 if (!Handler && SinkOpts.empty())
962 LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
966 if (SinkOpts.empty()) {
967 errs() << ProgramName << ": Unknown command line argument '" << argv[i]
968 << "'. Try: '" << argv[0] << " -help'\n";
970 if (NearestHandler) {
971 // If we know a near match, report it as well.
972 errs() << ProgramName << ": Did you mean '-" << NearestHandlerString
978 for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
981 (*I)->addOccurrence(i, "", argv[i]);
986 // If this is a named positional argument, just remember that it is the
988 if (Handler->getFormattingFlag() == cl::Positional)
989 ActivePositionalArg = Handler;
991 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
994 // Check and handle positional arguments now...
995 if (NumPositionalRequired > PositionalVals.size()) {
996 errs() << ProgramName
997 << ": Not enough positional command line arguments specified!\n"
998 << "Must specify at least " << NumPositionalRequired
999 << " positional arguments: See: " << argv[0] << " -help\n";
1001 ErrorParsing = true;
1002 } else if (!HasUnlimitedPositionals &&
1003 PositionalVals.size() > PositionalOpts.size()) {
1004 errs() << ProgramName << ": Too many positional arguments specified!\n"
1005 << "Can specify at most " << PositionalOpts.size()
1006 << " positional arguments: See: " << argv[0] << " -help\n";
1007 ErrorParsing = true;
1009 } else if (!ConsumeAfterOpt) {
1010 // Positional args have already been handled if ConsumeAfter is specified.
1011 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1012 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1013 if (RequiresValue(PositionalOpts[i])) {
1014 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
1015 PositionalVals[ValNo].second);
1017 --NumPositionalRequired; // We fulfilled our duty...
1020 // If we _can_ give this option more arguments, do so now, as long as we
1021 // do not give it values that others need. 'Done' controls whether the
1022 // option even _WANTS_ any more.
1024 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
1025 while (NumVals - ValNo > NumPositionalRequired && !Done) {
1026 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
1028 Done = true; // Optional arguments want _at most_ one value
1030 case cl::ZeroOrMore: // Zero or more will take all they can get...
1031 case cl::OneOrMore: // One or more will take all they can get...
1032 ProvidePositionalOption(PositionalOpts[i],
1033 PositionalVals[ValNo].first,
1034 PositionalVals[ValNo].second);
1038 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
1039 "positional argument processing!");
1044 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1046 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
1047 if (RequiresValue(PositionalOpts[j])) {
1048 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
1049 PositionalVals[ValNo].first,
1050 PositionalVals[ValNo].second);
1054 // Handle the case where there is just one positional option, and it's
1055 // optional. In this case, we want to give JUST THE FIRST option to the
1056 // positional option and keep the rest for the consume after. The above
1057 // loop would have assigned no values to positional options in this case.
1059 if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1060 ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
1061 PositionalVals[ValNo].first,
1062 PositionalVals[ValNo].second);
1066 // Handle over all of the rest of the arguments to the
1067 // cl::ConsumeAfter command line option...
1068 for (; ValNo != PositionalVals.size(); ++ValNo)
1070 ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1071 PositionalVals[ValNo].second);
1074 // Loop over args and make sure all required args are specified!
1075 for (const auto &Opt : OptionsMap) {
1076 switch (Opt.second->getNumOccurrencesFlag()) {
1079 if (Opt.second->getNumOccurrences() == 0) {
1080 Opt.second->error("must be specified at least once!");
1081 ErrorParsing = true;
1089 // Now that we know if -debug is specified, we can use it.
1090 // Note that if ReadResponseFiles == true, this must be done before the
1091 // memory allocated for the expanded command line is free()d below.
1092 DEBUG(dbgs() << "Args: ";
1093 for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1096 // Free all of the memory allocated to the map. Command line options may only
1097 // be processed once!
1100 // If we had an error processing our arguments, don't let the program execute
1105 //===----------------------------------------------------------------------===//
1106 // Option Base class implementation
1109 bool Option::error(const Twine &Message, StringRef ArgName) {
1110 if (!ArgName.data())
1112 if (ArgName.empty())
1113 errs() << HelpStr; // Be nice for positional arguments
1115 errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
1117 errs() << " option: " << Message << "\n";
1121 bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1124 NumOccurrences++; // Increment the number of times we have been seen
1126 switch (getNumOccurrencesFlag()) {
1128 if (NumOccurrences > 1)
1129 return error("may only occur zero or one times!", ArgName);
1132 if (NumOccurrences > 1)
1133 return error("must occur exactly one time!", ArgName);
1141 return handleOccurrence(pos, ArgName, Value);
1144 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
1145 // has been specified yet.
1147 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
1148 if (O.ValueStr[0] == 0)
1153 //===----------------------------------------------------------------------===//
1154 // cl::alias class implementation
1157 // Return the width of the option tag for printing...
1158 size_t alias::getOptionWidth() const { return std::strlen(ArgStr) + 6; }
1160 static void printHelpStr(StringRef HelpStr, size_t Indent,
1161 size_t FirstLineIndentedBy) {
1162 std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1163 outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1164 while (!Split.second.empty()) {
1165 Split = Split.second.split('\n');
1166 outs().indent(Indent) << Split.first << "\n";
1170 // Print out the option for the alias.
1171 void alias::printOptionInfo(size_t GlobalWidth) const {
1172 outs() << " -" << ArgStr;
1173 printHelpStr(HelpStr, GlobalWidth, std::strlen(ArgStr) + 6);
1176 //===----------------------------------------------------------------------===//
1177 // Parser Implementation code...
1180 // basic_parser implementation
1183 // Return the width of the option tag for printing...
1184 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
1185 size_t Len = std::strlen(O.ArgStr);
1186 if (const char *ValName = getValueName())
1187 Len += std::strlen(getValueStr(O, ValName)) + 3;
1192 // printOptionInfo - Print out information about this option. The
1193 // to-be-maintained width is specified.
1195 void basic_parser_impl::printOptionInfo(const Option &O,
1196 size_t GlobalWidth) const {
1197 outs() << " -" << O.ArgStr;
1199 if (const char *ValName = getValueName())
1200 outs() << "=<" << getValueStr(O, ValName) << '>';
1202 printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1205 void basic_parser_impl::printOptionName(const Option &O,
1206 size_t GlobalWidth) const {
1207 outs() << " -" << O.ArgStr;
1208 outs().indent(GlobalWidth - std::strlen(O.ArgStr));
1211 // parser<bool> implementation
1213 bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1215 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1221 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1225 return O.error("'" + Arg +
1226 "' is invalid value for boolean argument! Try 0 or 1");
1229 // parser<boolOrDefault> implementation
1231 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg,
1232 boolOrDefault &Value) {
1233 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1238 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1243 return O.error("'" + Arg +
1244 "' is invalid value for boolean argument! Try 0 or 1");
1247 // parser<int> implementation
1249 bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1251 if (Arg.getAsInteger(0, Value))
1252 return O.error("'" + Arg + "' value invalid for integer argument!");
1256 // parser<unsigned> implementation
1258 bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1261 if (Arg.getAsInteger(0, Value))
1262 return O.error("'" + Arg + "' value invalid for uint argument!");
1266 // parser<unsigned long long> implementation
1268 bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
1270 unsigned long long &Value) {
1272 if (Arg.getAsInteger(0, Value))
1273 return O.error("'" + Arg + "' value invalid for uint argument!");
1277 // parser<double>/parser<float> implementation
1279 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1280 SmallString<32> TmpStr(Arg.begin(), Arg.end());
1281 const char *ArgStart = TmpStr.c_str();
1283 Value = strtod(ArgStart, &End);
1285 return O.error("'" + Arg + "' value invalid for floating point argument!");
1289 bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1291 return parseDouble(O, Arg, Val);
1294 bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1297 if (parseDouble(O, Arg, dVal))
1303 // generic_parser_base implementation
1306 // findOption - Return the option number corresponding to the specified
1307 // argument string. If the option is not found, getNumOptions() is returned.
1309 unsigned generic_parser_base::findOption(const char *Name) {
1310 unsigned e = getNumOptions();
1312 for (unsigned i = 0; i != e; ++i) {
1313 if (strcmp(getOption(i), Name) == 0)
1319 // Return the width of the option tag for printing...
1320 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1321 if (O.hasArgStr()) {
1322 size_t Size = std::strlen(O.ArgStr) + 6;
1323 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1324 Size = std::max(Size, std::strlen(getOption(i)) + 8);
1327 size_t BaseSize = 0;
1328 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1329 BaseSize = std::max(BaseSize, std::strlen(getOption(i)) + 8);
1334 // printOptionInfo - Print out information about this option. The
1335 // to-be-maintained width is specified.
1337 void generic_parser_base::printOptionInfo(const Option &O,
1338 size_t GlobalWidth) const {
1339 if (O.hasArgStr()) {
1340 outs() << " -" << O.ArgStr;
1341 printHelpStr(O.HelpStr, GlobalWidth, std::strlen(O.ArgStr) + 6);
1343 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1344 size_t NumSpaces = GlobalWidth - strlen(getOption(i)) - 8;
1345 outs() << " =" << getOption(i);
1346 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1350 outs() << " " << O.HelpStr << '\n';
1351 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1352 const char *Option = getOption(i);
1353 outs() << " -" << Option;
1354 printHelpStr(getDescription(i), GlobalWidth, std::strlen(Option) + 8);
1359 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1361 // printGenericOptionDiff - Print the value of this option and it's default.
1363 // "Generic" options have each value mapped to a name.
1364 void generic_parser_base::printGenericOptionDiff(
1365 const Option &O, const GenericOptionValue &Value,
1366 const GenericOptionValue &Default, size_t GlobalWidth) const {
1367 outs() << " -" << O.ArgStr;
1368 outs().indent(GlobalWidth - std::strlen(O.ArgStr));
1370 unsigned NumOpts = getNumOptions();
1371 for (unsigned i = 0; i != NumOpts; ++i) {
1372 if (Value.compare(getOptionValue(i)))
1375 outs() << "= " << getOption(i);
1376 size_t L = std::strlen(getOption(i));
1377 size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1378 outs().indent(NumSpaces) << " (default: ";
1379 for (unsigned j = 0; j != NumOpts; ++j) {
1380 if (Default.compare(getOptionValue(j)))
1382 outs() << getOption(j);
1388 outs() << "= *unknown option value*\n";
1391 // printOptionDiff - Specializations for printing basic value types.
1393 #define PRINT_OPT_DIFF(T) \
1394 void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1395 size_t GlobalWidth) const { \
1396 printOptionName(O, GlobalWidth); \
1399 raw_string_ostream SS(Str); \
1402 outs() << "= " << Str; \
1403 size_t NumSpaces = \
1404 MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
1405 outs().indent(NumSpaces) << " (default: "; \
1407 outs() << D.getValue(); \
1409 outs() << "*no default*"; \
1413 PRINT_OPT_DIFF(bool)
1414 PRINT_OPT_DIFF(boolOrDefault)
1416 PRINT_OPT_DIFF(unsigned)
1417 PRINT_OPT_DIFF(unsigned long long)
1418 PRINT_OPT_DIFF(double)
1419 PRINT_OPT_DIFF(float)
1420 PRINT_OPT_DIFF(char)
1422 void parser<std::string>::printOptionDiff(const Option &O, StringRef V,
1423 OptionValue<std::string> D,
1424 size_t GlobalWidth) const {
1425 printOptionName(O, GlobalWidth);
1426 outs() << "= " << V;
1427 size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1428 outs().indent(NumSpaces) << " (default: ";
1430 outs() << D.getValue();
1432 outs() << "*no default*";
1436 // Print a placeholder for options that don't yet support printOptionDiff().
1437 void basic_parser_impl::printOptionNoValue(const Option &O,
1438 size_t GlobalWidth) const {
1439 printOptionName(O, GlobalWidth);
1440 outs() << "= *cannot print option value*\n";
1443 //===----------------------------------------------------------------------===//
1444 // -help and -help-hidden option implementation
1447 static int OptNameCompare(const std::pair<const char *, Option *> *LHS,
1448 const std::pair<const char *, Option *> *RHS) {
1449 return strcmp(LHS->first, RHS->first);
1452 // Copy Options into a vector so we can sort them as we like.
1453 static void sortOpts(StringMap<Option *> &OptMap,
1454 SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1456 SmallPtrSet<Option *, 128> OptionSet; // Duplicate option detection.
1458 for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
1460 // Ignore really-hidden options.
1461 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1464 // Unless showhidden is set, ignore hidden flags.
1465 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1468 // If we've already seen this option, don't add it to the list again.
1469 if (!OptionSet.insert(I->second).second)
1473 std::pair<const char *, Option *>(I->getKey().data(), I->second));
1476 // Sort the options list alphabetically.
1477 array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare);
1484 const bool ShowHidden;
1485 typedef SmallVector<std::pair<const char *, Option *>, 128>
1486 StrOptionPairVector;
1487 // Print the options. Opts is assumed to be alphabetically sorted.
1488 virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1489 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1490 Opts[i].second->printOptionInfo(MaxArgLen);
1494 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
1495 virtual ~HelpPrinter() {}
1497 // Invoke the printer.
1498 void operator=(bool Value) {
1502 StrOptionPairVector Opts;
1503 sortOpts(GlobalParser->OptionsMap, Opts, ShowHidden);
1505 if (GlobalParser->ProgramOverview)
1506 outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
1508 outs() << "USAGE: " << GlobalParser->ProgramName << " [options]";
1510 for (auto Opt : GlobalParser->PositionalOpts) {
1512 outs() << " --" << Opt->ArgStr;
1513 outs() << " " << Opt->HelpStr;
1516 // Print the consume after option info if it exists...
1517 if (GlobalParser->ConsumeAfterOpt)
1518 outs() << " " << GlobalParser->ConsumeAfterOpt->HelpStr;
1522 // Compute the maximum argument length...
1523 size_t MaxArgLen = 0;
1524 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1525 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1527 outs() << "OPTIONS:\n";
1528 printOptions(Opts, MaxArgLen);
1530 // Print any extra help the user has declared.
1531 for (auto I : GlobalParser->MoreHelp)
1533 GlobalParser->MoreHelp.clear();
1535 // Halt the program since help information was printed
1540 class CategorizedHelpPrinter : public HelpPrinter {
1542 explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1544 // Helper function for printOptions().
1545 // It shall return a negative value if A's name should be lexicographically
1546 // ordered before B's name. It returns a value greater equal zero otherwise.
1547 static int OptionCategoryCompare(OptionCategory *const *A,
1548 OptionCategory *const *B) {
1549 return strcmp((*A)->getName(), (*B)->getName());
1552 // Make sure we inherit our base class's operator=()
1553 using HelpPrinter::operator=;
1556 void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
1557 std::vector<OptionCategory *> SortedCategories;
1558 std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
1560 // Collect registered option categories into vector in preparation for
1562 for (auto I = GlobalParser->RegisteredOptionCategories.begin(),
1563 E = GlobalParser->RegisteredOptionCategories.end();
1565 SortedCategories.push_back(*I);
1568 // Sort the different option categories alphabetically.
1569 assert(SortedCategories.size() > 0 && "No option categories registered!");
1570 array_pod_sort(SortedCategories.begin(), SortedCategories.end(),
1571 OptionCategoryCompare);
1573 // Create map to empty vectors.
1574 for (std::vector<OptionCategory *>::const_iterator
1575 I = SortedCategories.begin(),
1576 E = SortedCategories.end();
1578 CategorizedOptions[*I] = std::vector<Option *>();
1580 // Walk through pre-sorted options and assign into categories.
1581 // Because the options are already alphabetically sorted the
1582 // options within categories will also be alphabetically sorted.
1583 for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1584 Option *Opt = Opts[I].second;
1585 assert(CategorizedOptions.count(Opt->Category) > 0 &&
1586 "Option has an unregistered category");
1587 CategorizedOptions[Opt->Category].push_back(Opt);
1591 for (std::vector<OptionCategory *>::const_iterator
1592 Category = SortedCategories.begin(),
1593 E = SortedCategories.end();
1594 Category != E; ++Category) {
1595 // Hide empty categories for -help, but show for -help-hidden.
1596 bool IsEmptyCategory = CategorizedOptions[*Category].size() == 0;
1597 if (!ShowHidden && IsEmptyCategory)
1600 // Print category information.
1602 outs() << (*Category)->getName() << ":\n";
1604 // Check if description is set.
1605 if ((*Category)->getDescription() != nullptr)
1606 outs() << (*Category)->getDescription() << "\n\n";
1610 // When using -help-hidden explicitly state if the category has no
1611 // options associated with it.
1612 if (IsEmptyCategory) {
1613 outs() << " This option category has no options.\n";
1616 // Loop over the options in the category and print.
1617 for (std::vector<Option *>::const_iterator
1618 Opt = CategorizedOptions[*Category].begin(),
1619 E = CategorizedOptions[*Category].end();
1621 (*Opt)->printOptionInfo(MaxArgLen);
1626 // This wraps the Uncategorizing and Categorizing printers and decides
1627 // at run time which should be invoked.
1628 class HelpPrinterWrapper {
1630 HelpPrinter &UncategorizedPrinter;
1631 CategorizedHelpPrinter &CategorizedPrinter;
1634 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1635 CategorizedHelpPrinter &CategorizedPrinter)
1636 : UncategorizedPrinter(UncategorizedPrinter),
1637 CategorizedPrinter(CategorizedPrinter) {}
1639 // Invoke the printer.
1640 void operator=(bool Value);
1643 } // End anonymous namespace
1645 // Declare the four HelpPrinter instances that are used to print out help, or
1646 // help-hidden as an uncategorized list or in categories.
1647 static HelpPrinter UncategorizedNormalPrinter(false);
1648 static HelpPrinter UncategorizedHiddenPrinter(true);
1649 static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1650 static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1652 // Declare HelpPrinter wrappers that will decide whether or not to invoke
1653 // a categorizing help printer
1654 static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1655 CategorizedNormalPrinter);
1656 static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1657 CategorizedHiddenPrinter);
1659 // Define a category for generic options that all tools should have.
1660 static cl::OptionCategory GenericCategory("Generic Options");
1662 // Define uncategorized help printers.
1663 // -help-list is hidden by default because if Option categories are being used
1664 // then -help behaves the same as -help-list.
1665 static cl::opt<HelpPrinter, true, parser<bool>> HLOp(
1667 cl::desc("Display list of available options (-help-list-hidden for more)"),
1668 cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
1669 cl::cat(GenericCategory));
1671 static cl::opt<HelpPrinter, true, parser<bool>>
1672 HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
1673 cl::location(UncategorizedHiddenPrinter), cl::Hidden,
1674 cl::ValueDisallowed, cl::cat(GenericCategory));
1676 // Define uncategorized/categorized help printers. These printers change their
1677 // behaviour at runtime depending on whether one or more Option categories have
1679 static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1680 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1681 cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
1682 cl::cat(GenericCategory));
1684 static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1685 HHOp("help-hidden", cl::desc("Display all available options"),
1686 cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
1687 cl::cat(GenericCategory));
1689 static cl::opt<bool> PrintOptions(
1691 cl::desc("Print non-default options after command line parsing"),
1692 cl::Hidden, cl::init(false), cl::cat(GenericCategory));
1694 static cl::opt<bool> PrintAllOptions(
1695 "print-all-options",
1696 cl::desc("Print all option values after command line parsing"), cl::Hidden,
1697 cl::init(false), cl::cat(GenericCategory));
1699 void HelpPrinterWrapper::operator=(bool Value) {
1703 // Decide which printer to invoke. If more than one option category is
1704 // registered then it is useful to show the categorized help instead of
1705 // uncategorized help.
1706 if (GlobalParser->RegisteredOptionCategories.size() > 1) {
1707 // unhide -help-list option so user can have uncategorized output if they
1709 HLOp.setHiddenFlag(NotHidden);
1711 CategorizedPrinter = true; // Invoke categorized printer
1713 UncategorizedPrinter = true; // Invoke uncategorized printer
1716 // Print the value of each option.
1717 void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
1719 void CommandLineParser::printOptionValues() {
1720 if (!PrintOptions && !PrintAllOptions)
1723 SmallVector<std::pair<const char *, Option *>, 128> Opts;
1724 sortOpts(OptionsMap, Opts, /*ShowHidden*/ true);
1726 // Compute the maximum argument length...
1727 size_t MaxArgLen = 0;
1728 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1729 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1731 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1732 Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
1735 static void (*OverrideVersionPrinter)() = nullptr;
1737 static std::vector<void (*)()> *ExtraVersionPrinters = nullptr;
1740 class VersionPrinter {
1743 raw_ostream &OS = outs();
1744 OS << "LLVM (http://llvm.org/):\n"
1745 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1746 #ifdef LLVM_VERSION_INFO
1747 OS << " " << LLVM_VERSION_INFO;
1750 #ifndef __OPTIMIZE__
1751 OS << "DEBUG build";
1753 OS << "Optimized build";
1756 OS << " with assertions";
1758 std::string CPU = sys::getHostCPUName();
1759 if (CPU == "generic")
1762 #if (ENABLE_TIMESTAMPS == 1)
1763 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1765 << " Default target: " << sys::getDefaultTargetTriple() << '\n'
1766 << " Host CPU: " << CPU << '\n';
1768 void operator=(bool OptionWasSpecified) {
1769 if (!OptionWasSpecified)
1772 if (OverrideVersionPrinter != nullptr) {
1773 (*OverrideVersionPrinter)();
1778 // Iterate over any registered extra printers and call them to add further
1780 if (ExtraVersionPrinters != nullptr) {
1782 for (std::vector<void (*)()>::iterator I = ExtraVersionPrinters->begin(),
1783 E = ExtraVersionPrinters->end();
1791 } // End anonymous namespace
1793 // Define the --version option that prints out the LLVM version for the tool
1794 static VersionPrinter VersionPrinterInstance;
1796 static cl::opt<VersionPrinter, true, parser<bool>>
1797 VersOp("version", cl::desc("Display the version of this program"),
1798 cl::location(VersionPrinterInstance), cl::ValueDisallowed,
1799 cl::cat(GenericCategory));
1801 // Utility function for printing the help message.
1802 void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
1803 // This looks weird, but it actually prints the help message. The Printers are
1804 // types of HelpPrinter and the help gets printed when its operator= is
1805 // invoked. That's because the "normal" usages of the help printer is to be
1806 // assigned true/false depending on whether -help or -help-hidden was given or
1807 // not. Since we're circumventing that we have to make it look like -help or
1808 // -help-hidden were given, so we assign true.
1810 if (!Hidden && !Categorized)
1811 UncategorizedNormalPrinter = true;
1812 else if (!Hidden && Categorized)
1813 CategorizedNormalPrinter = true;
1814 else if (Hidden && !Categorized)
1815 UncategorizedHiddenPrinter = true;
1817 CategorizedHiddenPrinter = true;
1820 /// Utility function for printing version number.
1821 void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
1823 void cl::SetVersionPrinter(void (*func)()) { OverrideVersionPrinter = func; }
1825 void cl::AddExtraVersionPrinter(void (*func)()) {
1826 if (!ExtraVersionPrinters)
1827 ExtraVersionPrinters = new std::vector<void (*)()>;
1829 ExtraVersionPrinters->push_back(func);
1832 StringMap<Option *> &cl::getRegisteredOptions() {
1833 return GlobalParser->OptionsMap;
1836 void cl::HideUnrelatedOptions(cl::OptionCategory &Category) {
1837 for (auto &I : GlobalParser->OptionsMap) {
1838 if (I.second->Category != &Category &&
1839 I.second->Category != &GenericCategory)
1840 I.second->setHiddenFlag(cl::ReallyHidden);
1844 void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories) {
1845 auto CategoriesBegin = Categories.begin();
1846 auto CategoriesEnd = Categories.end();
1847 for (auto &I : GlobalParser->OptionsMap) {
1848 if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
1850 I.second->Category != &GenericCategory)
1851 I.second->setHiddenFlag(cl::ReallyHidden);
1855 void LLVMParseCommandLineOptions(int argc, const char *const *argv,
1856 const char *Overview) {
1857 llvm::cl::ParseCommandLineOptions(argc, argv, Overview);