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/ADT/ArrayRef.h"
21 #include "llvm/ADT/SmallPtrSet.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/ADT/StringMap.h"
24 #include "llvm/ADT/Twine.h"
25 #include "llvm/Config/config.h"
26 #include "llvm/Support/ConvertUTF.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/Host.h"
30 #include "llvm/Support/ManagedStatic.h"
31 #include "llvm/Support/MemoryBuffer.h"
32 #include "llvm/Support/Path.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include "llvm/Support/system_error.h"
41 #define DEBUG_TYPE "commandline"
43 //===----------------------------------------------------------------------===//
44 // Template instantiations and anchors.
46 namespace llvm { namespace cl {
47 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
48 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
49 TEMPLATE_INSTANTIATION(class basic_parser<int>);
50 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
51 TEMPLATE_INSTANTIATION(class basic_parser<unsigned long long>);
52 TEMPLATE_INSTANTIATION(class basic_parser<double>);
53 TEMPLATE_INSTANTIATION(class basic_parser<float>);
54 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
55 TEMPLATE_INSTANTIATION(class basic_parser<char>);
57 TEMPLATE_INSTANTIATION(class opt<unsigned>);
58 TEMPLATE_INSTANTIATION(class opt<int>);
59 TEMPLATE_INSTANTIATION(class opt<std::string>);
60 TEMPLATE_INSTANTIATION(class opt<char>);
61 TEMPLATE_INSTANTIATION(class opt<bool>);
62 } } // end namespace llvm::cl
64 // Pin the vtables to this file.
65 void GenericOptionValue::anchor() {}
66 void OptionValue<boolOrDefault>::anchor() {}
67 void OptionValue<std::string>::anchor() {}
68 void Option::anchor() {}
69 void basic_parser_impl::anchor() {}
70 void parser<bool>::anchor() {}
71 void parser<boolOrDefault>::anchor() {}
72 void parser<int>::anchor() {}
73 void parser<unsigned>::anchor() {}
74 void parser<unsigned long long>::anchor() {}
75 void parser<double>::anchor() {}
76 void parser<float>::anchor() {}
77 void parser<std::string>::anchor() {}
78 void parser<char>::anchor() {}
79 void StringSaver::anchor() {}
81 //===----------------------------------------------------------------------===//
83 // Globals for name and overview of program. Program name is not a string to
84 // avoid static ctor/dtor issues.
85 static char ProgramName[80] = "<premain>";
86 static const char *ProgramOverview = nullptr;
88 // This collects additional help to be printed.
89 static ManagedStatic<std::vector<const char*> > MoreHelp;
91 extrahelp::extrahelp(const char *Help)
93 MoreHelp->push_back(Help);
96 static bool OptionListChanged = false;
98 // MarkOptionsChanged - Internal helper function.
99 void cl::MarkOptionsChanged() {
100 OptionListChanged = true;
103 /// RegisteredOptionList - This is the list of the command line options that
104 /// have statically constructed themselves.
105 static Option *RegisteredOptionList = nullptr;
107 void Option::addArgument() {
108 assert(!NextRegistered && "argument multiply registered!");
110 NextRegistered = RegisteredOptionList;
111 RegisteredOptionList = this;
112 MarkOptionsChanged();
115 void Option::removeArgument() {
116 assert(NextRegistered && "argument never registered");
117 assert(RegisteredOptionList == this && "argument is not the last registered");
118 RegisteredOptionList = NextRegistered;
119 MarkOptionsChanged();
122 // This collects the different option categories that have been registered.
123 typedef SmallPtrSet<OptionCategory*,16> OptionCatSet;
124 static ManagedStatic<OptionCatSet> RegisteredOptionCategories;
126 // Initialise the general option category.
127 OptionCategory llvm::cl::GeneralCategory("General options");
129 void OptionCategory::registerCategory() {
130 assert(std::count_if(RegisteredOptionCategories->begin(),
131 RegisteredOptionCategories->end(),
132 [this](const OptionCategory *Category) {
133 return getName() == Category->getName();
134 }) == 0 && "Duplicate option categories");
136 RegisteredOptionCategories->insert(this);
139 //===----------------------------------------------------------------------===//
140 // Basic, shared command line option processing machinery.
143 /// GetOptionInfo - Scan the list of registered options, turning them into data
144 /// structures that are easier to handle.
145 static void GetOptionInfo(SmallVectorImpl<Option*> &PositionalOpts,
146 SmallVectorImpl<Option*> &SinkOpts,
147 StringMap<Option*> &OptionsMap) {
148 SmallVector<const char*, 16> OptionNames;
149 Option *CAOpt = nullptr; // The ConsumeAfter option if it exists.
150 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
151 // If this option wants to handle multiple option names, get the full set.
152 // This handles enum options like "-O1 -O2" etc.
153 O->getExtraOptionNames(OptionNames);
155 OptionNames.push_back(O->ArgStr);
157 // Handle named options.
158 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
159 // Add argument to the argument map!
160 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
161 errs() << ProgramName << ": CommandLine Error: Argument '"
162 << OptionNames[i] << "' defined more than once!\n";
168 // Remember information about positional options.
169 if (O->getFormattingFlag() == cl::Positional)
170 PositionalOpts.push_back(O);
171 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
172 SinkOpts.push_back(O);
173 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
175 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
181 PositionalOpts.push_back(CAOpt);
183 // Make sure that they are in order of registration not backwards.
184 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
188 /// LookupOption - Lookup the option specified by the specified option on the
189 /// command line. If there is a value specified (after an equal sign) return
190 /// that as well. This assumes that leading dashes have already been stripped.
191 static Option *LookupOption(StringRef &Arg, StringRef &Value,
192 const StringMap<Option*> &OptionsMap) {
193 // Reject all dashes.
194 if (Arg.empty()) return nullptr;
196 size_t EqualPos = Arg.find('=');
198 // If we have an equals sign, remember the value.
199 if (EqualPos == StringRef::npos) {
200 // Look up the option.
201 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
202 return I != OptionsMap.end() ? I->second : nullptr;
205 // If the argument before the = is a valid option name, we match. If not,
206 // return Arg unmolested.
207 StringMap<Option*>::const_iterator I =
208 OptionsMap.find(Arg.substr(0, EqualPos));
209 if (I == OptionsMap.end()) return nullptr;
211 Value = Arg.substr(EqualPos+1);
212 Arg = Arg.substr(0, EqualPos);
216 /// LookupNearestOption - Lookup the closest match to the option specified by
217 /// the specified option on the command line. If there is a value specified
218 /// (after an equal sign) return that as well. This assumes that leading dashes
219 /// have already been stripped.
220 static Option *LookupNearestOption(StringRef Arg,
221 const StringMap<Option*> &OptionsMap,
222 std::string &NearestString) {
223 // Reject all dashes.
224 if (Arg.empty()) return nullptr;
226 // Split on any equal sign.
227 std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
228 StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
229 StringRef &RHS = SplitArg.second;
231 // Find the closest match.
232 Option *Best = nullptr;
233 unsigned BestDistance = 0;
234 for (StringMap<Option*>::const_iterator it = OptionsMap.begin(),
235 ie = OptionsMap.end(); it != ie; ++it) {
236 Option *O = it->second;
237 SmallVector<const char*, 16> OptionNames;
238 O->getExtraOptionNames(OptionNames);
240 OptionNames.push_back(O->ArgStr);
242 bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
243 StringRef Flag = PermitValue ? LHS : Arg;
244 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
245 StringRef Name = OptionNames[i];
246 unsigned Distance = StringRef(Name).edit_distance(
247 Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
248 if (!Best || Distance < BestDistance) {
250 BestDistance = Distance;
251 if (RHS.empty() || !PermitValue)
252 NearestString = OptionNames[i];
254 NearestString = std::string(OptionNames[i]) + "=" + RHS.str();
262 /// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
263 /// that does special handling of cl::CommaSeparated options.
264 static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
265 StringRef ArgName, StringRef Value,
266 bool MultiArg = false) {
267 // Check to see if this option accepts a comma separated list of values. If
268 // it does, we have to split up the value into multiple values.
269 if (Handler->getMiscFlags() & CommaSeparated) {
270 StringRef Val(Value);
271 StringRef::size_type Pos = Val.find(',');
273 while (Pos != StringRef::npos) {
274 // Process the portion before the comma.
275 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
277 // Erase the portion before the comma, AND the comma.
278 Val = Val.substr(Pos+1);
279 Value.substr(Pos+1); // Increment the original value pointer as well.
280 // Check for another comma.
287 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
293 /// ProvideOption - For Value, this differentiates between an empty value ("")
294 /// and a null value (StringRef()). The later is accepted for arguments that
295 /// don't allow a value (-foo) the former is rejected (-foo=).
296 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
297 StringRef Value, int argc,
298 const char *const *argv, int &i) {
299 // Is this a multi-argument option?
300 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
302 // Enforce value requirements
303 switch (Handler->getValueExpectedFlag()) {
305 if (!Value.data()) { // No value specified?
307 return Handler->error("requires a value!");
308 // Steal the next argument, like for '-o filename'
312 case ValueDisallowed:
313 if (NumAdditionalVals > 0)
314 return Handler->error("multi-valued option specified"
315 " with ValueDisallowed modifier!");
318 return Handler->error("does not allow a value! '" +
319 Twine(Value) + "' specified.");
325 // If this isn't a multi-arg option, just run the handler.
326 if (NumAdditionalVals == 0)
327 return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
329 // If it is, run the handle several times.
330 bool MultiArg = false;
333 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
339 while (NumAdditionalVals > 0) {
341 return Handler->error("not enough values!");
344 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
352 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
354 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
358 // Option predicates...
359 static inline bool isGrouping(const Option *O) {
360 return O->getFormattingFlag() == cl::Grouping;
362 static inline bool isPrefixedOrGrouping(const Option *O) {
363 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
366 // getOptionPred - Check to see if there are any options that satisfy the
367 // specified predicate with names that are the prefixes in Name. This is
368 // checked by progressively stripping characters off of the name, checking to
369 // see if there options that satisfy the predicate. If we find one, return it,
370 // otherwise return null.
372 static Option *getOptionPred(StringRef Name, size_t &Length,
373 bool (*Pred)(const Option*),
374 const StringMap<Option*> &OptionsMap) {
376 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
378 // Loop while we haven't found an option and Name still has at least two
379 // characters in it (so that the next iteration will not be the empty
381 while (OMI == OptionsMap.end() && Name.size() > 1) {
382 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
383 OMI = OptionsMap.find(Name);
386 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
387 Length = Name.size();
388 return OMI->second; // Found one!
390 return nullptr; // No option found!
393 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
394 /// with at least one '-') does not fully match an available option. Check to
395 /// see if this is a prefix or grouped option. If so, split arg into output an
396 /// Arg/Value pair and return the Option to parse it with.
397 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
399 const StringMap<Option*> &OptionsMap) {
400 if (Arg.size() == 1) return nullptr;
404 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
405 if (!PGOpt) return nullptr;
407 // If the option is a prefixed option, then the value is simply the
408 // rest of the name... so fall through to later processing, by
409 // setting up the argument name flags and value fields.
410 if (PGOpt->getFormattingFlag() == cl::Prefix) {
411 Value = Arg.substr(Length);
412 Arg = Arg.substr(0, Length);
413 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
417 // This must be a grouped option... handle them now. Grouping options can't
419 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
422 // Move current arg name out of Arg into OneArgName.
423 StringRef OneArgName = Arg.substr(0, Length);
424 Arg = Arg.substr(Length);
426 // Because ValueRequired is an invalid flag for grouped arguments,
427 // we don't need to pass argc/argv in.
428 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
429 "Option can not be cl::Grouping AND cl::ValueRequired!");
431 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
432 StringRef(), 0, nullptr, Dummy);
434 // Get the next grouping option.
435 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
436 } while (PGOpt && Length != Arg.size());
438 // Return the last option with Arg cut down to just the last one.
444 static bool RequiresValue(const Option *O) {
445 return O->getNumOccurrencesFlag() == cl::Required ||
446 O->getNumOccurrencesFlag() == cl::OneOrMore;
449 static bool EatsUnboundedNumberOfValues(const Option *O) {
450 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
451 O->getNumOccurrencesFlag() == cl::OneOrMore;
454 static bool isWhitespace(char C) {
455 return strchr(" \t\n\r\f\v", C);
458 static bool isQuote(char C) {
459 return C == '\"' || C == '\'';
462 static bool isGNUSpecial(char C) {
463 return strchr("\\\"\' ", C);
466 void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
467 SmallVectorImpl<const char *> &NewArgv) {
468 SmallString<128> Token;
469 for (size_t I = 0, E = Src.size(); I != E; ++I) {
470 // Consume runs of whitespace.
472 while (I != E && isWhitespace(Src[I]))
477 // Backslashes can escape backslashes, spaces, and other quotes. Otherwise
478 // they are literal. This makes it much easier to read Windows file paths.
479 if (I + 1 < E && Src[I] == '\\' && isGNUSpecial(Src[I + 1])) {
480 ++I; // Skip the escape.
481 Token.push_back(Src[I]);
485 // Consume a quoted string.
486 if (isQuote(Src[I])) {
487 char Quote = Src[I++];
488 while (I != E && Src[I] != Quote) {
489 // Backslashes are literal, unless they escape a special character.
490 if (Src[I] == '\\' && I + 1 != E && isGNUSpecial(Src[I + 1]))
492 Token.push_back(Src[I]);
499 // End the token if this is whitespace.
500 if (isWhitespace(Src[I])) {
502 NewArgv.push_back(Saver.SaveString(Token.c_str()));
507 // This is a normal character. Append it.
508 Token.push_back(Src[I]);
511 // Append the last token after hitting EOF with no whitespace.
513 NewArgv.push_back(Saver.SaveString(Token.c_str()));
516 /// Backslashes are interpreted in a rather complicated way in the Windows-style
517 /// command line, because backslashes are used both to separate path and to
518 /// escape double quote. This method consumes runs of backslashes as well as the
519 /// following double quote if it's escaped.
521 /// * If an even number of backslashes is followed by a double quote, one
522 /// backslash is output for every pair of backslashes, and the last double
523 /// quote remains unconsumed. The double quote will later be interpreted as
524 /// the start or end of a quoted string in the main loop outside of this
527 /// * If an odd number of backslashes is followed by a double quote, one
528 /// backslash is output for every pair of backslashes, and a double quote is
529 /// output for the last pair of backslash-double quote. The double quote is
530 /// consumed in this case.
532 /// * Otherwise, backslashes are interpreted literally.
533 static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
534 size_t E = Src.size();
535 int BackslashCount = 0;
536 // Skip the backslashes.
540 } while (I != E && Src[I] == '\\');
542 bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
543 if (FollowedByDoubleQuote) {
544 Token.append(BackslashCount / 2, '\\');
545 if (BackslashCount % 2 == 0)
547 Token.push_back('"');
550 Token.append(BackslashCount, '\\');
554 void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
555 SmallVectorImpl<const char *> &NewArgv) {
556 SmallString<128> Token;
558 // This is a small state machine to consume characters until it reaches the
559 // end of the source string.
560 enum { INIT, UNQUOTED, QUOTED } State = INIT;
561 for (size_t I = 0, E = Src.size(); I != E; ++I) {
562 // INIT state indicates that the current input index is at the start of
563 // the string or between tokens.
565 if (isWhitespace(Src[I]))
571 if (Src[I] == '\\') {
572 I = parseBackslash(Src, I, Token);
576 Token.push_back(Src[I]);
581 // UNQUOTED state means that it's reading a token not quoted by double
583 if (State == UNQUOTED) {
584 // Whitespace means the end of the token.
585 if (isWhitespace(Src[I])) {
586 NewArgv.push_back(Saver.SaveString(Token.c_str()));
595 if (Src[I] == '\\') {
596 I = parseBackslash(Src, I, Token);
599 Token.push_back(Src[I]);
603 // QUOTED state means that it's reading a token quoted by double quotes.
604 if (State == QUOTED) {
609 if (Src[I] == '\\') {
610 I = parseBackslash(Src, I, Token);
613 Token.push_back(Src[I]);
616 // Append the last token after hitting EOF with no whitespace.
618 NewArgv.push_back(Saver.SaveString(Token.c_str()));
621 static bool ExpandResponseFile(const char *FName, StringSaver &Saver,
622 TokenizerCallback Tokenizer,
623 SmallVectorImpl<const char *> &NewArgv) {
624 std::unique_ptr<MemoryBuffer> MemBuf;
625 if (MemoryBuffer::getFile(FName, MemBuf))
627 StringRef Str(MemBuf->getBufferStart(), MemBuf->getBufferSize());
629 // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
630 ArrayRef<char> BufRef(MemBuf->getBufferStart(), MemBuf->getBufferEnd());
632 if (hasUTF16ByteOrderMark(BufRef)) {
633 if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
635 Str = StringRef(UTF8Buf);
638 // Tokenize the contents into NewArgv.
639 Tokenizer(Str, Saver, NewArgv);
644 /// \brief Expand response files on a command line recursively using the given
645 /// StringSaver and tokenization strategy.
646 bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
647 SmallVectorImpl<const char *> &Argv) {
648 unsigned RspFiles = 0;
649 bool AllExpanded = true;
651 // Don't cache Argv.size() because it can change.
652 for (unsigned I = 0; I != Argv.size(); ) {
653 const char *Arg = Argv[I];
659 // If we have too many response files, leave some unexpanded. This avoids
660 // crashing on self-referential response files.
664 // Replace this response file argument with the tokenization of its
665 // contents. Nested response files are expanded in subsequent iterations.
666 // FIXME: If a nested response file uses a relative path, is it relative to
667 // the cwd of the process or the response file?
668 SmallVector<const char *, 0> ExpandedArgv;
669 if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv)) {
670 // We couldn't read this file, so we leave it in the argument stream and
676 Argv.erase(Argv.begin() + I);
677 Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
683 class StrDupSaver : public StringSaver {
684 std::vector<char*> Dups;
687 for (std::vector<char *>::iterator I = Dups.begin(), E = Dups.end();
693 const char *SaveString(const char *Str) override {
694 char *Dup = strdup(Str);
701 /// ParseEnvironmentOptions - An alternative entry point to the
702 /// CommandLine library, which allows you to read the program's name
703 /// from the caller (as PROGNAME) and its command-line arguments from
704 /// an environment variable (whose name is given in ENVVAR).
706 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
707 const char *Overview) {
709 assert(progName && "Program name not specified");
710 assert(envVar && "Environment variable name missing");
712 // Get the environment variable they want us to parse options out of.
713 const char *envValue = getenv(envVar);
717 // Get program's "name", which we wouldn't know without the caller
719 SmallVector<const char *, 20> newArgv;
721 newArgv.push_back(Saver.SaveString(progName));
723 // Parse the value of the environment variable into a "command line"
724 // and hand it off to ParseCommandLineOptions().
725 TokenizeGNUCommandLine(envValue, Saver, newArgv);
726 int newArgc = static_cast<int>(newArgv.size());
727 ParseCommandLineOptions(newArgc, &newArgv[0], Overview);
730 void cl::ParseCommandLineOptions(int argc, const char * const *argv,
731 const char *Overview) {
732 // Process all registered options.
733 SmallVector<Option*, 4> PositionalOpts;
734 SmallVector<Option*, 4> SinkOpts;
735 StringMap<Option*> Opts;
736 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
738 assert((!Opts.empty() || !PositionalOpts.empty()) &&
739 "No options specified!");
741 // Expand response files.
742 SmallVector<const char *, 20> newArgv;
743 for (int i = 0; i != argc; ++i)
744 newArgv.push_back(argv[i]);
746 ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
748 argc = static_cast<int>(newArgv.size());
750 // Copy the program name into ProgName, making sure not to overflow it.
751 StringRef ProgName = sys::path::filename(argv[0]);
752 size_t Len = std::min(ProgName.size(), size_t(79));
753 memcpy(ProgramName, ProgName.data(), Len);
754 ProgramName[Len] = '\0';
756 ProgramOverview = Overview;
757 bool ErrorParsing = false;
759 // Check out the positional arguments to collect information about them.
760 unsigned NumPositionalRequired = 0;
762 // Determine whether or not there are an unlimited number of positionals
763 bool HasUnlimitedPositionals = false;
765 Option *ConsumeAfterOpt = nullptr;
766 if (!PositionalOpts.empty()) {
767 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
768 assert(PositionalOpts.size() > 1 &&
769 "Cannot specify cl::ConsumeAfter without a positional argument!");
770 ConsumeAfterOpt = PositionalOpts[0];
773 // Calculate how many positional values are _required_.
774 bool UnboundedFound = false;
775 for (size_t i = ConsumeAfterOpt ? 1 : 0, e = PositionalOpts.size();
777 Option *Opt = PositionalOpts[i];
778 if (RequiresValue(Opt))
779 ++NumPositionalRequired;
780 else if (ConsumeAfterOpt) {
781 // ConsumeAfter cannot be combined with "optional" positional options
782 // unless there is only one positional argument...
783 if (PositionalOpts.size() > 2)
785 Opt->error("error - this positional option will never be matched, "
786 "because it does not Require a value, and a "
787 "cl::ConsumeAfter option is active!");
788 } else if (UnboundedFound && !Opt->ArgStr[0]) {
789 // This option does not "require" a value... Make sure this option is
790 // not specified after an option that eats all extra arguments, or this
791 // one will never get any!
793 ErrorParsing |= Opt->error("error - option can never match, because "
794 "another positional argument will match an "
795 "unbounded number of values, and this option"
796 " does not require a value!");
798 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
800 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
803 // PositionalVals - A vector of "positional" arguments we accumulate into
804 // the process at the end.
806 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
808 // If the program has named positional arguments, and the name has been run
809 // across, keep track of which positional argument was named. Otherwise put
810 // the positional args into the PositionalVals list...
811 Option *ActivePositionalArg = nullptr;
813 // Loop over all of the arguments... processing them.
814 bool DashDashFound = false; // Have we read '--'?
815 for (int i = 1; i < argc; ++i) {
816 Option *Handler = nullptr;
817 Option *NearestHandler = nullptr;
818 std::string NearestHandlerString;
820 StringRef ArgName = "";
822 // If the option list changed, this means that some command line
823 // option has just been registered or deregistered. This can occur in
824 // response to things like -load, etc. If this happens, rescan the options.
825 if (OptionListChanged) {
826 PositionalOpts.clear();
829 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
830 OptionListChanged = false;
833 // Check to see if this is a positional argument. This argument is
834 // considered to be positional if it doesn't start with '-', if it is "-"
835 // itself, or if we have seen "--" already.
837 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
838 // Positional argument!
839 if (ActivePositionalArg) {
840 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
841 continue; // We are done!
844 if (!PositionalOpts.empty()) {
845 PositionalVals.push_back(std::make_pair(argv[i],i));
847 // All of the positional arguments have been fulfulled, give the rest to
848 // the consume after option... if it's specified...
850 if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
851 for (++i; i < argc; ++i)
852 PositionalVals.push_back(std::make_pair(argv[i],i));
853 break; // Handle outside of the argument processing loop...
856 // Delay processing positional arguments until the end...
859 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
861 DashDashFound = true; // This is the mythical "--"?
862 continue; // Don't try to process it as an argument itself.
863 } else if (ActivePositionalArg &&
864 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
865 // If there is a positional argument eating options, check to see if this
866 // option is another positional argument. If so, treat it as an argument,
867 // otherwise feed it to the eating positional.
869 // Eat leading dashes.
870 while (!ArgName.empty() && ArgName[0] == '-')
871 ArgName = ArgName.substr(1);
873 Handler = LookupOption(ArgName, Value, Opts);
874 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
875 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
876 continue; // We are done!
879 } else { // We start with a '-', must be an argument.
881 // Eat leading dashes.
882 while (!ArgName.empty() && ArgName[0] == '-')
883 ArgName = ArgName.substr(1);
885 Handler = LookupOption(ArgName, Value, Opts);
887 // Check to see if this "option" is really a prefixed or grouped argument.
889 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
892 // Otherwise, look for the closest available option to report to the user
893 // in the upcoming error.
894 if (!Handler && SinkOpts.empty())
895 NearestHandler = LookupNearestOption(ArgName, Opts,
896 NearestHandlerString);
900 if (SinkOpts.empty()) {
901 errs() << ProgramName << ": Unknown command line argument '"
902 << argv[i] << "'. Try: '" << argv[0] << " -help'\n";
904 if (NearestHandler) {
905 // If we know a near match, report it as well.
906 errs() << ProgramName << ": Did you mean '-"
907 << NearestHandlerString << "'?\n";
912 for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
913 E = SinkOpts.end(); I != E ; ++I)
914 (*I)->addOccurrence(i, "", argv[i]);
919 // If this is a named positional argument, just remember that it is the
921 if (Handler->getFormattingFlag() == cl::Positional)
922 ActivePositionalArg = Handler;
924 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
927 // Check and handle positional arguments now...
928 if (NumPositionalRequired > PositionalVals.size()) {
929 errs() << ProgramName
930 << ": Not enough positional command line arguments specified!\n"
931 << "Must specify at least " << NumPositionalRequired
932 << " positional arguments: See: " << argv[0] << " -help\n";
935 } else if (!HasUnlimitedPositionals &&
936 PositionalVals.size() > PositionalOpts.size()) {
937 errs() << ProgramName
938 << ": Too many positional arguments specified!\n"
939 << "Can specify at most " << PositionalOpts.size()
940 << " positional arguments: See: " << argv[0] << " -help\n";
943 } else if (!ConsumeAfterOpt) {
944 // Positional args have already been handled if ConsumeAfter is specified.
945 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
946 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
947 if (RequiresValue(PositionalOpts[i])) {
948 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
949 PositionalVals[ValNo].second);
951 --NumPositionalRequired; // We fulfilled our duty...
954 // If we _can_ give this option more arguments, do so now, as long as we
955 // do not give it values that others need. 'Done' controls whether the
956 // option even _WANTS_ any more.
958 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
959 while (NumVals-ValNo > NumPositionalRequired && !Done) {
960 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
962 Done = true; // Optional arguments want _at most_ one value
964 case cl::ZeroOrMore: // Zero or more will take all they can get...
965 case cl::OneOrMore: // One or more will take all they can get...
966 ProvidePositionalOption(PositionalOpts[i],
967 PositionalVals[ValNo].first,
968 PositionalVals[ValNo].second);
972 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
973 "positional argument processing!");
978 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
980 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
981 if (RequiresValue(PositionalOpts[j])) {
982 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
983 PositionalVals[ValNo].first,
984 PositionalVals[ValNo].second);
988 // Handle the case where there is just one positional option, and it's
989 // optional. In this case, we want to give JUST THE FIRST option to the
990 // positional option and keep the rest for the consume after. The above
991 // loop would have assigned no values to positional options in this case.
993 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
994 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
995 PositionalVals[ValNo].first,
996 PositionalVals[ValNo].second);
1000 // Handle over all of the rest of the arguments to the
1001 // cl::ConsumeAfter command line option...
1002 for (; ValNo != PositionalVals.size(); ++ValNo)
1003 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
1004 PositionalVals[ValNo].first,
1005 PositionalVals[ValNo].second);
1008 // Loop over args and make sure all required args are specified!
1009 for (StringMap<Option*>::iterator I = Opts.begin(),
1010 E = Opts.end(); I != E; ++I) {
1011 switch (I->second->getNumOccurrencesFlag()) {
1014 if (I->second->getNumOccurrences() == 0) {
1015 I->second->error("must be specified at least once!");
1016 ErrorParsing = true;
1024 // Now that we know if -debug is specified, we can use it.
1025 // Note that if ReadResponseFiles == true, this must be done before the
1026 // memory allocated for the expanded command line is free()d below.
1027 DEBUG(dbgs() << "Args: ";
1028 for (int i = 0; i < argc; ++i)
1029 dbgs() << argv[i] << ' ';
1033 // Free all of the memory allocated to the map. Command line options may only
1034 // be processed once!
1036 PositionalOpts.clear();
1039 // If we had an error processing our arguments, don't let the program execute
1040 if (ErrorParsing) exit(1);
1043 //===----------------------------------------------------------------------===//
1044 // Option Base class implementation
1047 bool Option::error(const Twine &Message, StringRef ArgName) {
1048 if (!ArgName.data()) ArgName = ArgStr;
1049 if (ArgName.empty())
1050 errs() << HelpStr; // Be nice for positional arguments
1052 errs() << ProgramName << ": for the -" << ArgName;
1054 errs() << " option: " << Message << "\n";
1058 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
1059 StringRef Value, bool MultiArg) {
1061 NumOccurrences++; // Increment the number of times we have been seen
1063 switch (getNumOccurrencesFlag()) {
1065 if (NumOccurrences > 1)
1066 return error("may only occur zero or one times!", ArgName);
1069 if (NumOccurrences > 1)
1070 return error("must occur exactly one time!", ArgName);
1074 case ConsumeAfter: break;
1077 return handleOccurrence(pos, ArgName, Value);
1081 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
1082 // has been specified yet.
1084 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
1085 if (O.ValueStr[0] == 0) return DefaultMsg;
1089 //===----------------------------------------------------------------------===//
1090 // cl::alias class implementation
1093 // Return the width of the option tag for printing...
1094 size_t alias::getOptionWidth() const {
1095 return std::strlen(ArgStr)+6;
1098 static void printHelpStr(StringRef HelpStr, size_t Indent,
1099 size_t FirstLineIndentedBy) {
1100 std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1101 outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1102 while (!Split.second.empty()) {
1103 Split = Split.second.split('\n');
1104 outs().indent(Indent) << Split.first << "\n";
1108 // Print out the option for the alias.
1109 void alias::printOptionInfo(size_t GlobalWidth) const {
1110 outs() << " -" << ArgStr;
1111 printHelpStr(HelpStr, GlobalWidth, std::strlen(ArgStr) + 6);
1114 //===----------------------------------------------------------------------===//
1115 // Parser Implementation code...
1118 // basic_parser implementation
1121 // Return the width of the option tag for printing...
1122 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
1123 size_t Len = std::strlen(O.ArgStr);
1124 if (const char *ValName = getValueName())
1125 Len += std::strlen(getValueStr(O, ValName))+3;
1130 // printOptionInfo - Print out information about this option. The
1131 // to-be-maintained width is specified.
1133 void basic_parser_impl::printOptionInfo(const Option &O,
1134 size_t GlobalWidth) const {
1135 outs() << " -" << O.ArgStr;
1137 if (const char *ValName = getValueName())
1138 outs() << "=<" << getValueStr(O, ValName) << '>';
1140 printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1143 void basic_parser_impl::printOptionName(const Option &O,
1144 size_t GlobalWidth) const {
1145 outs() << " -" << O.ArgStr;
1146 outs().indent(GlobalWidth-std::strlen(O.ArgStr));
1150 // parser<bool> implementation
1152 bool parser<bool>::parse(Option &O, StringRef ArgName,
1153 StringRef Arg, bool &Value) {
1154 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1160 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1164 return O.error("'" + Arg +
1165 "' is invalid value for boolean argument! Try 0 or 1");
1168 // parser<boolOrDefault> implementation
1170 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
1171 StringRef Arg, boolOrDefault &Value) {
1172 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1177 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1182 return O.error("'" + Arg +
1183 "' is invalid value for boolean argument! Try 0 or 1");
1186 // parser<int> implementation
1188 bool parser<int>::parse(Option &O, StringRef ArgName,
1189 StringRef Arg, int &Value) {
1190 if (Arg.getAsInteger(0, Value))
1191 return O.error("'" + Arg + "' value invalid for integer argument!");
1195 // parser<unsigned> implementation
1197 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
1198 StringRef Arg, unsigned &Value) {
1200 if (Arg.getAsInteger(0, Value))
1201 return O.error("'" + Arg + "' value invalid for uint argument!");
1205 // parser<unsigned long long> implementation
1207 bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
1208 StringRef Arg, unsigned long long &Value){
1210 if (Arg.getAsInteger(0, Value))
1211 return O.error("'" + Arg + "' value invalid for uint argument!");
1215 // parser<double>/parser<float> implementation
1217 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1218 SmallString<32> TmpStr(Arg.begin(), Arg.end());
1219 const char *ArgStart = TmpStr.c_str();
1221 Value = strtod(ArgStart, &End);
1223 return O.error("'" + Arg + "' value invalid for floating point argument!");
1227 bool parser<double>::parse(Option &O, StringRef ArgName,
1228 StringRef Arg, double &Val) {
1229 return parseDouble(O, Arg, Val);
1232 bool parser<float>::parse(Option &O, StringRef ArgName,
1233 StringRef Arg, float &Val) {
1235 if (parseDouble(O, Arg, dVal))
1243 // generic_parser_base implementation
1246 // findOption - Return the option number corresponding to the specified
1247 // argument string. If the option is not found, getNumOptions() is returned.
1249 unsigned generic_parser_base::findOption(const char *Name) {
1250 unsigned e = getNumOptions();
1252 for (unsigned i = 0; i != e; ++i) {
1253 if (strcmp(getOption(i), Name) == 0)
1260 // Return the width of the option tag for printing...
1261 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1262 if (O.hasArgStr()) {
1263 size_t Size = std::strlen(O.ArgStr)+6;
1264 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1265 Size = std::max(Size, std::strlen(getOption(i))+8);
1268 size_t BaseSize = 0;
1269 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1270 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1275 // printOptionInfo - Print out information about this option. The
1276 // to-be-maintained width is specified.
1278 void generic_parser_base::printOptionInfo(const Option &O,
1279 size_t GlobalWidth) const {
1280 if (O.hasArgStr()) {
1281 outs() << " -" << O.ArgStr;
1282 printHelpStr(O.HelpStr, GlobalWidth, std::strlen(O.ArgStr) + 6);
1284 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1285 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1286 outs() << " =" << getOption(i);
1287 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1291 outs() << " " << O.HelpStr << '\n';
1292 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1293 const char *Option = getOption(i);
1294 outs() << " -" << Option;
1295 printHelpStr(getDescription(i), GlobalWidth, std::strlen(Option) + 8);
1300 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1302 // printGenericOptionDiff - Print the value of this option and it's default.
1304 // "Generic" options have each value mapped to a name.
1305 void generic_parser_base::
1306 printGenericOptionDiff(const Option &O, const GenericOptionValue &Value,
1307 const GenericOptionValue &Default,
1308 size_t GlobalWidth) const {
1309 outs() << " -" << O.ArgStr;
1310 outs().indent(GlobalWidth-std::strlen(O.ArgStr));
1312 unsigned NumOpts = getNumOptions();
1313 for (unsigned i = 0; i != NumOpts; ++i) {
1314 if (Value.compare(getOptionValue(i)))
1317 outs() << "= " << getOption(i);
1318 size_t L = std::strlen(getOption(i));
1319 size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1320 outs().indent(NumSpaces) << " (default: ";
1321 for (unsigned j = 0; j != NumOpts; ++j) {
1322 if (Default.compare(getOptionValue(j)))
1324 outs() << getOption(j);
1330 outs() << "= *unknown option value*\n";
1333 // printOptionDiff - Specializations for printing basic value types.
1335 #define PRINT_OPT_DIFF(T) \
1337 printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1338 size_t GlobalWidth) const { \
1339 printOptionName(O, GlobalWidth); \
1342 raw_string_ostream SS(Str); \
1345 outs() << "= " << Str; \
1346 size_t NumSpaces = MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0;\
1347 outs().indent(NumSpaces) << " (default: "; \
1349 outs() << D.getValue(); \
1351 outs() << "*no default*"; \
1355 PRINT_OPT_DIFF(bool)
1356 PRINT_OPT_DIFF(boolOrDefault)
1358 PRINT_OPT_DIFF(unsigned)
1359 PRINT_OPT_DIFF(unsigned long long)
1360 PRINT_OPT_DIFF(double)
1361 PRINT_OPT_DIFF(float)
1362 PRINT_OPT_DIFF(char)
1364 void parser<std::string>::
1365 printOptionDiff(const Option &O, StringRef V, OptionValue<std::string> D,
1366 size_t GlobalWidth) const {
1367 printOptionName(O, GlobalWidth);
1368 outs() << "= " << V;
1369 size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1370 outs().indent(NumSpaces) << " (default: ";
1372 outs() << D.getValue();
1374 outs() << "*no default*";
1378 // Print a placeholder for options that don't yet support printOptionDiff().
1379 void basic_parser_impl::
1380 printOptionNoValue(const Option &O, size_t GlobalWidth) const {
1381 printOptionName(O, GlobalWidth);
1382 outs() << "= *cannot print option value*\n";
1385 //===----------------------------------------------------------------------===//
1386 // -help and -help-hidden option implementation
1389 static int OptNameCompare(const void *LHS, const void *RHS) {
1390 typedef std::pair<const char *, Option*> pair_ty;
1392 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1395 // Copy Options into a vector so we can sort them as we like.
1397 sortOpts(StringMap<Option*> &OptMap,
1398 SmallVectorImpl< std::pair<const char *, Option*> > &Opts,
1400 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1402 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1404 // Ignore really-hidden options.
1405 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1408 // Unless showhidden is set, ignore hidden flags.
1409 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1412 // If we've already seen this option, don't add it to the list again.
1413 if (!OptionSet.insert(I->second))
1416 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1420 // Sort the options list alphabetically.
1421 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1428 const bool ShowHidden;
1429 typedef SmallVector<std::pair<const char *, Option*>,128> StrOptionPairVector;
1430 // Print the options. Opts is assumed to be alphabetically sorted.
1431 virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1432 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1433 Opts[i].second->printOptionInfo(MaxArgLen);
1437 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
1438 virtual ~HelpPrinter() {}
1440 // Invoke the printer.
1441 void operator=(bool Value) {
1442 if (Value == false) return;
1444 // Get all the options.
1445 SmallVector<Option*, 4> PositionalOpts;
1446 SmallVector<Option*, 4> SinkOpts;
1447 StringMap<Option*> OptMap;
1448 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1450 StrOptionPairVector Opts;
1451 sortOpts(OptMap, Opts, ShowHidden);
1453 if (ProgramOverview)
1454 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1456 outs() << "USAGE: " << ProgramName << " [options]";
1458 // Print out the positional options.
1459 Option *CAOpt = nullptr; // The cl::ConsumeAfter option, if it exists...
1460 if (!PositionalOpts.empty() &&
1461 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1462 CAOpt = PositionalOpts[0];
1464 for (size_t i = CAOpt != nullptr, e = PositionalOpts.size(); i != e; ++i) {
1465 if (PositionalOpts[i]->ArgStr[0])
1466 outs() << " --" << PositionalOpts[i]->ArgStr;
1467 outs() << " " << PositionalOpts[i]->HelpStr;
1470 // Print the consume after option info if it exists...
1471 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1475 // Compute the maximum argument length...
1476 size_t MaxArgLen = 0;
1477 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1478 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1480 outs() << "OPTIONS:\n";
1481 printOptions(Opts, MaxArgLen);
1483 // Print any extra help the user has declared.
1484 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1485 E = MoreHelp->end();
1490 // Halt the program since help information was printed
1495 class CategorizedHelpPrinter : public HelpPrinter {
1497 explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1499 // Helper function for printOptions().
1500 // It shall return true if A's name should be lexographically
1501 // ordered before B's name. It returns false otherwise.
1502 static bool OptionCategoryCompare(OptionCategory *A, OptionCategory *B) {
1503 return strcmp(A->getName(), B->getName()) < 0;
1506 // Make sure we inherit our base class's operator=()
1507 using HelpPrinter::operator= ;
1510 void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
1511 std::vector<OptionCategory *> SortedCategories;
1512 std::map<OptionCategory *, std::vector<Option *> > CategorizedOptions;
1514 // Collect registered option categories into vector in preparation for
1516 for (OptionCatSet::const_iterator I = RegisteredOptionCategories->begin(),
1517 E = RegisteredOptionCategories->end();
1519 SortedCategories.push_back(*I);
1522 // Sort the different option categories alphabetically.
1523 assert(SortedCategories.size() > 0 && "No option categories registered!");
1524 std::sort(SortedCategories.begin(), SortedCategories.end(),
1525 OptionCategoryCompare);
1527 // Create map to empty vectors.
1528 for (std::vector<OptionCategory *>::const_iterator
1529 I = SortedCategories.begin(),
1530 E = SortedCategories.end();
1532 CategorizedOptions[*I] = std::vector<Option *>();
1534 // Walk through pre-sorted options and assign into categories.
1535 // Because the options are already alphabetically sorted the
1536 // options within categories will also be alphabetically sorted.
1537 for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1538 Option *Opt = Opts[I].second;
1539 assert(CategorizedOptions.count(Opt->Category) > 0 &&
1540 "Option has an unregistered category");
1541 CategorizedOptions[Opt->Category].push_back(Opt);
1545 for (std::vector<OptionCategory *>::const_iterator
1546 Category = SortedCategories.begin(),
1547 E = SortedCategories.end();
1548 Category != E; ++Category) {
1549 // Hide empty categories for -help, but show for -help-hidden.
1550 bool IsEmptyCategory = CategorizedOptions[*Category].size() == 0;
1551 if (!ShowHidden && IsEmptyCategory)
1554 // Print category information.
1556 outs() << (*Category)->getName() << ":\n";
1558 // Check if description is set.
1559 if ((*Category)->getDescription() != nullptr)
1560 outs() << (*Category)->getDescription() << "\n\n";
1564 // When using -help-hidden explicitly state if the category has no
1565 // options associated with it.
1566 if (IsEmptyCategory) {
1567 outs() << " This option category has no options.\n";
1570 // Loop over the options in the category and print.
1571 for (std::vector<Option *>::const_iterator
1572 Opt = CategorizedOptions[*Category].begin(),
1573 E = CategorizedOptions[*Category].end();
1575 (*Opt)->printOptionInfo(MaxArgLen);
1580 // This wraps the Uncategorizing and Categorizing printers and decides
1581 // at run time which should be invoked.
1582 class HelpPrinterWrapper {
1584 HelpPrinter &UncategorizedPrinter;
1585 CategorizedHelpPrinter &CategorizedPrinter;
1588 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1589 CategorizedHelpPrinter &CategorizedPrinter) :
1590 UncategorizedPrinter(UncategorizedPrinter),
1591 CategorizedPrinter(CategorizedPrinter) { }
1593 // Invoke the printer.
1594 void operator=(bool Value);
1597 } // End anonymous namespace
1599 // Declare the four HelpPrinter instances that are used to print out help, or
1600 // help-hidden as an uncategorized list or in categories.
1601 static HelpPrinter UncategorizedNormalPrinter(false);
1602 static HelpPrinter UncategorizedHiddenPrinter(true);
1603 static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1604 static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1607 // Declare HelpPrinter wrappers that will decide whether or not to invoke
1608 // a categorizing help printer
1609 static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1610 CategorizedNormalPrinter);
1611 static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1612 CategorizedHiddenPrinter);
1614 // Define uncategorized help printers.
1615 // -help-list is hidden by default because if Option categories are being used
1616 // then -help behaves the same as -help-list.
1617 static cl::opt<HelpPrinter, true, parser<bool> >
1619 cl::desc("Display list of available options (-help-list-hidden for more)"),
1620 cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed);
1622 static cl::opt<HelpPrinter, true, parser<bool> >
1623 HLHOp("help-list-hidden",
1624 cl::desc("Display list of all available options"),
1625 cl::location(UncategorizedHiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1627 // Define uncategorized/categorized help printers. These printers change their
1628 // behaviour at runtime depending on whether one or more Option categories have
1630 static cl::opt<HelpPrinterWrapper, true, parser<bool> >
1631 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1632 cl::location(WrappedNormalPrinter), cl::ValueDisallowed);
1634 static cl::opt<HelpPrinterWrapper, true, parser<bool> >
1635 HHOp("help-hidden", cl::desc("Display all available options"),
1636 cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1640 static cl::opt<bool>
1641 PrintOptions("print-options",
1642 cl::desc("Print non-default options after command line parsing"),
1643 cl::Hidden, cl::init(false));
1645 static cl::opt<bool>
1646 PrintAllOptions("print-all-options",
1647 cl::desc("Print all option values after command line parsing"),
1648 cl::Hidden, cl::init(false));
1650 void HelpPrinterWrapper::operator=(bool Value) {
1654 // Decide which printer to invoke. If more than one option category is
1655 // registered then it is useful to show the categorized help instead of
1656 // uncategorized help.
1657 if (RegisteredOptionCategories->size() > 1) {
1658 // unhide -help-list option so user can have uncategorized output if they
1660 HLOp.setHiddenFlag(NotHidden);
1662 CategorizedPrinter = true; // Invoke categorized printer
1665 UncategorizedPrinter = true; // Invoke uncategorized printer
1668 // Print the value of each option.
1669 void cl::PrintOptionValues() {
1670 if (!PrintOptions && !PrintAllOptions) return;
1672 // Get all the options.
1673 SmallVector<Option*, 4> PositionalOpts;
1674 SmallVector<Option*, 4> SinkOpts;
1675 StringMap<Option*> OptMap;
1676 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1678 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1679 sortOpts(OptMap, Opts, /*ShowHidden*/true);
1681 // Compute the maximum argument length...
1682 size_t MaxArgLen = 0;
1683 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1684 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1686 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1687 Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
1690 static void (*OverrideVersionPrinter)() = nullptr;
1692 static std::vector<void (*)()>* ExtraVersionPrinters = nullptr;
1695 class VersionPrinter {
1698 raw_ostream &OS = outs();
1699 OS << "LLVM (http://llvm.org/):\n"
1700 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1701 #ifdef LLVM_VERSION_INFO
1702 OS << LLVM_VERSION_INFO;
1705 #ifndef __OPTIMIZE__
1706 OS << "DEBUG build";
1708 OS << "Optimized build";
1711 OS << " with assertions";
1713 std::string CPU = sys::getHostCPUName();
1714 if (CPU == "generic") CPU = "(unknown)";
1716 #if (ENABLE_TIMESTAMPS == 1)
1717 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1719 << " Default target: " << sys::getDefaultTargetTriple() << '\n'
1720 << " Host CPU: " << CPU << '\n';
1722 void operator=(bool OptionWasSpecified) {
1723 if (!OptionWasSpecified) return;
1725 if (OverrideVersionPrinter != nullptr) {
1726 (*OverrideVersionPrinter)();
1731 // Iterate over any registered extra printers and call them to add further
1733 if (ExtraVersionPrinters != nullptr) {
1735 for (std::vector<void (*)()>::iterator I = ExtraVersionPrinters->begin(),
1736 E = ExtraVersionPrinters->end();
1744 } // End anonymous namespace
1747 // Define the --version option that prints out the LLVM version for the tool
1748 static VersionPrinter VersionPrinterInstance;
1750 static cl::opt<VersionPrinter, true, parser<bool> >
1751 VersOp("version", cl::desc("Display the version of this program"),
1752 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1754 // Utility function for printing the help message.
1755 void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
1756 // This looks weird, but it actually prints the help message. The Printers are
1757 // types of HelpPrinter and the help gets printed when its operator= is
1758 // invoked. That's because the "normal" usages of the help printer is to be
1759 // assigned true/false depending on whether -help or -help-hidden was given or
1760 // not. Since we're circumventing that we have to make it look like -help or
1761 // -help-hidden were given, so we assign true.
1763 if (!Hidden && !Categorized)
1764 UncategorizedNormalPrinter = true;
1765 else if (!Hidden && Categorized)
1766 CategorizedNormalPrinter = true;
1767 else if (Hidden && !Categorized)
1768 UncategorizedHiddenPrinter = true;
1770 CategorizedHiddenPrinter = true;
1773 /// Utility function for printing version number.
1774 void cl::PrintVersionMessage() {
1775 VersionPrinterInstance.print();
1778 void cl::SetVersionPrinter(void (*func)()) {
1779 OverrideVersionPrinter = func;
1782 void cl::AddExtraVersionPrinter(void (*func)()) {
1783 if (!ExtraVersionPrinters)
1784 ExtraVersionPrinters = new std::vector<void (*)()>;
1786 ExtraVersionPrinters->push_back(func);
1789 void cl::getRegisteredOptions(StringMap<Option*> &Map)
1791 // Get all the options.
1792 SmallVector<Option*, 4> PositionalOpts; //NOT USED
1793 SmallVector<Option*, 4> SinkOpts; //NOT USED
1794 assert(Map.size() == 0 && "StringMap must be empty");
1795 GetOptionInfo(PositionalOpts, SinkOpts, Map);