xref: /llvm-project/llvm/lib/Support/CommandLine.cpp (revision c15a438a219967135d334a0bee12115d5c5b17b3)
1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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.
13 //
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
16 //
17 //===----------------------------------------------------------------------===//
18 
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm-c/Support.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/Optional.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/ADT/SmallString.h"
26 #include "llvm/ADT/StringExtras.h"
27 #include "llvm/ADT/StringMap.h"
28 #include "llvm/ADT/Twine.h"
29 #include "llvm/Config/config.h"
30 #include "llvm/Support/ConvertUTF.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Support/ErrorHandling.h"
33 #include "llvm/Support/FileSystem.h"
34 #include "llvm/Support/Host.h"
35 #include "llvm/Support/ManagedStatic.h"
36 #include "llvm/Support/MemoryBuffer.h"
37 #include "llvm/Support/Path.h"
38 #include "llvm/Support/Process.h"
39 #include "llvm/Support/StringSaver.h"
40 #include "llvm/Support/raw_ostream.h"
41 #include <cstdlib>
42 #include <map>
43 using namespace llvm;
44 using namespace cl;
45 
46 #define DEBUG_TYPE "commandline"
47 
48 //===----------------------------------------------------------------------===//
49 // Template instantiations and anchors.
50 //
51 namespace llvm {
52 namespace cl {
53 template class basic_parser<bool>;
54 template class basic_parser<boolOrDefault>;
55 template class basic_parser<int>;
56 template class basic_parser<unsigned>;
57 template class basic_parser<unsigned long long>;
58 template class basic_parser<double>;
59 template class basic_parser<float>;
60 template class basic_parser<std::string>;
61 template class basic_parser<char>;
62 
63 template class opt<unsigned>;
64 template class opt<int>;
65 template class opt<std::string>;
66 template class opt<char>;
67 template class opt<bool>;
68 }
69 } // end namespace llvm::cl
70 
71 // Pin the vtables to this file.
72 void GenericOptionValue::anchor() {}
73 void OptionValue<boolOrDefault>::anchor() {}
74 void OptionValue<std::string>::anchor() {}
75 void Option::anchor() {}
76 void basic_parser_impl::anchor() {}
77 void parser<bool>::anchor() {}
78 void parser<boolOrDefault>::anchor() {}
79 void parser<int>::anchor() {}
80 void parser<unsigned>::anchor() {}
81 void parser<unsigned long long>::anchor() {}
82 void parser<double>::anchor() {}
83 void parser<float>::anchor() {}
84 void parser<std::string>::anchor() {}
85 void parser<char>::anchor() {}
86 
87 //===----------------------------------------------------------------------===//
88 
89 namespace {
90 
91 class CommandLineParser {
92 public:
93   // Globals for name and overview of program.  Program name is not a string to
94   // avoid static ctor/dtor issues.
95   std::string ProgramName;
96   StringRef ProgramOverview;
97 
98   // This collects additional help to be printed.
99   std::vector<StringRef> MoreHelp;
100 
101   // This collects the different option categories that have been registered.
102   SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories;
103 
104   // This collects the different subcommands that have been registered.
105   SmallPtrSet<SubCommand *, 4> RegisteredSubCommands;
106 
107   CommandLineParser() : ActiveSubCommand(nullptr) {
108     registerSubCommand(&*TopLevelSubCommand);
109     registerSubCommand(&*AllSubCommands);
110   }
111 
112   void ResetAllOptionOccurrences();
113 
114   bool ParseCommandLineOptions(int argc, const char *const *argv,
115                                StringRef Overview, raw_ostream *Errs = nullptr);
116 
117   void addLiteralOption(Option &Opt, SubCommand *SC, StringRef Name) {
118     if (Opt.hasArgStr())
119       return;
120     if (!SC->OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
121       errs() << ProgramName << ": CommandLine Error: Option '" << Name
122              << "' registered more than once!\n";
123       report_fatal_error("inconsistency in registered CommandLine options");
124     }
125 
126     // If we're adding this to all sub-commands, add it to the ones that have
127     // already been registered.
128     if (SC == &*AllSubCommands) {
129       for (const auto &Sub : RegisteredSubCommands) {
130         if (SC == Sub)
131           continue;
132         addLiteralOption(Opt, Sub, Name);
133       }
134     }
135   }
136 
137   void addLiteralOption(Option &Opt, StringRef Name) {
138     if (Opt.Subs.empty())
139       addLiteralOption(Opt, &*TopLevelSubCommand, Name);
140     else {
141       for (auto SC : Opt.Subs)
142         addLiteralOption(Opt, SC, Name);
143     }
144   }
145 
146   void addOption(Option *O, SubCommand *SC) {
147     bool HadErrors = false;
148     if (O->hasArgStr()) {
149       // Add argument to the argument map!
150       if (!SC->OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) {
151         errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
152                << "' registered more than once!\n";
153         HadErrors = true;
154       }
155     }
156 
157     // Remember information about positional options.
158     if (O->getFormattingFlag() == cl::Positional)
159       SC->PositionalOpts.push_back(O);
160     else if (O->getMiscFlags() & cl::Sink) // Remember sink options
161       SC->SinkOpts.push_back(O);
162     else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
163       if (SC->ConsumeAfterOpt) {
164         O->error("Cannot specify more than one option with cl::ConsumeAfter!");
165         HadErrors = true;
166       }
167       SC->ConsumeAfterOpt = O;
168     }
169 
170     // Fail hard if there were errors. These are strictly unrecoverable and
171     // indicate serious issues such as conflicting option names or an
172     // incorrectly
173     // linked LLVM distribution.
174     if (HadErrors)
175       report_fatal_error("inconsistency in registered CommandLine options");
176 
177     // If we're adding this to all sub-commands, add it to the ones that have
178     // already been registered.
179     if (SC == &*AllSubCommands) {
180       for (const auto &Sub : RegisteredSubCommands) {
181         if (SC == Sub)
182           continue;
183         addOption(O, Sub);
184       }
185     }
186   }
187 
188   void addOption(Option *O) {
189     if (O->Subs.empty()) {
190       addOption(O, &*TopLevelSubCommand);
191     } else {
192       for (auto SC : O->Subs)
193         addOption(O, SC);
194     }
195   }
196 
197   void removeOption(Option *O, SubCommand *SC) {
198     SmallVector<StringRef, 16> OptionNames;
199     O->getExtraOptionNames(OptionNames);
200     if (O->hasArgStr())
201       OptionNames.push_back(O->ArgStr);
202 
203     SubCommand &Sub = *SC;
204     for (auto Name : OptionNames)
205       Sub.OptionsMap.erase(Name);
206 
207     if (O->getFormattingFlag() == cl::Positional)
208       for (auto Opt = Sub.PositionalOpts.begin();
209            Opt != Sub.PositionalOpts.end(); ++Opt) {
210         if (*Opt == O) {
211           Sub.PositionalOpts.erase(Opt);
212           break;
213         }
214       }
215     else if (O->getMiscFlags() & cl::Sink)
216       for (auto Opt = Sub.SinkOpts.begin(); Opt != Sub.SinkOpts.end(); ++Opt) {
217         if (*Opt == O) {
218           Sub.SinkOpts.erase(Opt);
219           break;
220         }
221       }
222     else if (O == Sub.ConsumeAfterOpt)
223       Sub.ConsumeAfterOpt = nullptr;
224   }
225 
226   void removeOption(Option *O) {
227     if (O->Subs.empty())
228       removeOption(O, &*TopLevelSubCommand);
229     else {
230       if (O->isInAllSubCommands()) {
231         for (auto SC : RegisteredSubCommands)
232           removeOption(O, SC);
233       } else {
234         for (auto SC : O->Subs)
235           removeOption(O, SC);
236       }
237     }
238   }
239 
240   bool hasOptions(const SubCommand &Sub) const {
241     return (!Sub.OptionsMap.empty() || !Sub.PositionalOpts.empty() ||
242             nullptr != Sub.ConsumeAfterOpt);
243   }
244 
245   bool hasOptions() const {
246     for (const auto &S : RegisteredSubCommands) {
247       if (hasOptions(*S))
248         return true;
249     }
250     return false;
251   }
252 
253   SubCommand *getActiveSubCommand() { return ActiveSubCommand; }
254 
255   void updateArgStr(Option *O, StringRef NewName, SubCommand *SC) {
256     SubCommand &Sub = *SC;
257     if (!Sub.OptionsMap.insert(std::make_pair(NewName, O)).second) {
258       errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
259              << "' registered more than once!\n";
260       report_fatal_error("inconsistency in registered CommandLine options");
261     }
262     Sub.OptionsMap.erase(O->ArgStr);
263   }
264 
265   void updateArgStr(Option *O, StringRef NewName) {
266     if (O->Subs.empty())
267       updateArgStr(O, NewName, &*TopLevelSubCommand);
268     else {
269       for (auto SC : O->Subs)
270         updateArgStr(O, NewName, SC);
271     }
272   }
273 
274   void printOptionValues();
275 
276   void registerCategory(OptionCategory *cat) {
277     assert(count_if(RegisteredOptionCategories,
278                     [cat](const OptionCategory *Category) {
279              return cat->getName() == Category->getName();
280            }) == 0 &&
281            "Duplicate option categories");
282 
283     RegisteredOptionCategories.insert(cat);
284   }
285 
286   void registerSubCommand(SubCommand *sub) {
287     assert(count_if(RegisteredSubCommands,
288                     [sub](const SubCommand *Sub) {
289                       return (!sub->getName().empty()) &&
290                              (Sub->getName() == sub->getName());
291                     }) == 0 &&
292            "Duplicate subcommands");
293     RegisteredSubCommands.insert(sub);
294 
295     // For all options that have been registered for all subcommands, add the
296     // option to this subcommand now.
297     if (sub != &*AllSubCommands) {
298       for (auto &E : AllSubCommands->OptionsMap) {
299         Option *O = E.second;
300         if ((O->isPositional() || O->isSink() || O->isConsumeAfter()) ||
301             O->hasArgStr())
302           addOption(O, sub);
303         else
304           addLiteralOption(*O, sub, E.first());
305       }
306     }
307   }
308 
309   void unregisterSubCommand(SubCommand *sub) {
310     RegisteredSubCommands.erase(sub);
311   }
312 
313   iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator>
314   getRegisteredSubcommands() {
315     return make_range(RegisteredSubCommands.begin(),
316                       RegisteredSubCommands.end());
317   }
318 
319   void reset() {
320     ActiveSubCommand = nullptr;
321     ProgramName.clear();
322     ProgramOverview = StringRef();
323 
324     MoreHelp.clear();
325     RegisteredOptionCategories.clear();
326 
327     ResetAllOptionOccurrences();
328     RegisteredSubCommands.clear();
329 
330     TopLevelSubCommand->reset();
331     AllSubCommands->reset();
332     registerSubCommand(&*TopLevelSubCommand);
333     registerSubCommand(&*AllSubCommands);
334   }
335 
336 private:
337   SubCommand *ActiveSubCommand;
338 
339   Option *LookupOption(SubCommand &Sub, StringRef &Arg, StringRef &Value);
340   SubCommand *LookupSubCommand(StringRef Name);
341 };
342 
343 } // namespace
344 
345 static ManagedStatic<CommandLineParser> GlobalParser;
346 
347 void cl::AddLiteralOption(Option &O, StringRef Name) {
348   GlobalParser->addLiteralOption(O, Name);
349 }
350 
351 extrahelp::extrahelp(StringRef Help) : morehelp(Help) {
352   GlobalParser->MoreHelp.push_back(Help);
353 }
354 
355 void Option::addArgument() {
356   GlobalParser->addOption(this);
357   FullyInitialized = true;
358 }
359 
360 void Option::removeArgument() { GlobalParser->removeOption(this); }
361 
362 void Option::setArgStr(StringRef S) {
363   if (FullyInitialized)
364     GlobalParser->updateArgStr(this, S);
365   assert((S.empty() || S[0] != '-') && "Option can't start with '-");
366   ArgStr = S;
367 }
368 
369 // Initialise the general option category.
370 OptionCategory llvm::cl::GeneralCategory("General options");
371 
372 void OptionCategory::registerCategory() {
373   GlobalParser->registerCategory(this);
374 }
375 
376 // A special subcommand representing no subcommand
377 ManagedStatic<SubCommand> llvm::cl::TopLevelSubCommand;
378 
379 // A special subcommand that can be used to put an option into all subcommands.
380 ManagedStatic<SubCommand> llvm::cl::AllSubCommands;
381 
382 void SubCommand::registerSubCommand() {
383   GlobalParser->registerSubCommand(this);
384 }
385 
386 void SubCommand::unregisterSubCommand() {
387   GlobalParser->unregisterSubCommand(this);
388 }
389 
390 void SubCommand::reset() {
391   PositionalOpts.clear();
392   SinkOpts.clear();
393   OptionsMap.clear();
394 
395   ConsumeAfterOpt = nullptr;
396 }
397 
398 SubCommand::operator bool() const {
399   return (GlobalParser->getActiveSubCommand() == this);
400 }
401 
402 //===----------------------------------------------------------------------===//
403 // Basic, shared command line option processing machinery.
404 //
405 
406 /// LookupOption - Lookup the option specified by the specified option on the
407 /// command line.  If there is a value specified (after an equal sign) return
408 /// that as well.  This assumes that leading dashes have already been stripped.
409 Option *CommandLineParser::LookupOption(SubCommand &Sub, StringRef &Arg,
410                                         StringRef &Value) {
411   // Reject all dashes.
412   if (Arg.empty())
413     return nullptr;
414   assert(&Sub != &*AllSubCommands);
415 
416   size_t EqualPos = Arg.find('=');
417 
418   // If we have an equals sign, remember the value.
419   if (EqualPos == StringRef::npos) {
420     // Look up the option.
421     auto I = Sub.OptionsMap.find(Arg);
422     if (I == Sub.OptionsMap.end())
423       return nullptr;
424 
425     return I != Sub.OptionsMap.end() ? I->second : nullptr;
426   }
427 
428   // If the argument before the = is a valid option name, we match.  If not,
429   // return Arg unmolested.
430   auto I = Sub.OptionsMap.find(Arg.substr(0, EqualPos));
431   if (I == Sub.OptionsMap.end())
432     return nullptr;
433 
434   Value = Arg.substr(EqualPos + 1);
435   Arg = Arg.substr(0, EqualPos);
436   return I->second;
437 }
438 
439 SubCommand *CommandLineParser::LookupSubCommand(StringRef Name) {
440   if (Name.empty())
441     return &*TopLevelSubCommand;
442   for (auto S : RegisteredSubCommands) {
443     if (S == &*AllSubCommands)
444       continue;
445     if (S->getName().empty())
446       continue;
447 
448     if (StringRef(S->getName()) == StringRef(Name))
449       return S;
450   }
451   return &*TopLevelSubCommand;
452 }
453 
454 /// LookupNearestOption - Lookup the closest match to the option specified by
455 /// the specified option on the command line.  If there is a value specified
456 /// (after an equal sign) return that as well.  This assumes that leading dashes
457 /// have already been stripped.
458 static Option *LookupNearestOption(StringRef Arg,
459                                    const StringMap<Option *> &OptionsMap,
460                                    std::string &NearestString) {
461   // Reject all dashes.
462   if (Arg.empty())
463     return nullptr;
464 
465   // Split on any equal sign.
466   std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
467   StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
468   StringRef &RHS = SplitArg.second;
469 
470   // Find the closest match.
471   Option *Best = nullptr;
472   unsigned BestDistance = 0;
473   for (StringMap<Option *>::const_iterator it = OptionsMap.begin(),
474                                            ie = OptionsMap.end();
475        it != ie; ++it) {
476     Option *O = it->second;
477     SmallVector<StringRef, 16> OptionNames;
478     O->getExtraOptionNames(OptionNames);
479     if (O->hasArgStr())
480       OptionNames.push_back(O->ArgStr);
481 
482     bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
483     StringRef Flag = PermitValue ? LHS : Arg;
484     for (auto Name : OptionNames) {
485       unsigned Distance = StringRef(Name).edit_distance(
486           Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
487       if (!Best || Distance < BestDistance) {
488         Best = O;
489         BestDistance = Distance;
490         if (RHS.empty() || !PermitValue)
491           NearestString = Name;
492         else
493           NearestString = (Twine(Name) + "=" + RHS).str();
494       }
495     }
496   }
497 
498   return Best;
499 }
500 
501 /// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
502 /// that does special handling of cl::CommaSeparated options.
503 static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
504                                           StringRef ArgName, StringRef Value,
505                                           bool MultiArg = false) {
506   // Check to see if this option accepts a comma separated list of values.  If
507   // it does, we have to split up the value into multiple values.
508   if (Handler->getMiscFlags() & CommaSeparated) {
509     StringRef Val(Value);
510     StringRef::size_type Pos = Val.find(',');
511 
512     while (Pos != StringRef::npos) {
513       // Process the portion before the comma.
514       if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
515         return true;
516       // Erase the portion before the comma, AND the comma.
517       Val = Val.substr(Pos + 1);
518       // Check for another comma.
519       Pos = Val.find(',');
520     }
521 
522     Value = Val;
523   }
524 
525   return Handler->addOccurrence(pos, ArgName, Value, MultiArg);
526 }
527 
528 /// ProvideOption - For Value, this differentiates between an empty value ("")
529 /// and a null value (StringRef()).  The later is accepted for arguments that
530 /// don't allow a value (-foo) the former is rejected (-foo=).
531 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
532                                  StringRef Value, int argc,
533                                  const char *const *argv, int &i) {
534   // Is this a multi-argument option?
535   unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
536 
537   // Enforce value requirements
538   switch (Handler->getValueExpectedFlag()) {
539   case ValueRequired:
540     if (!Value.data()) { // No value specified?
541       if (i + 1 >= argc)
542         return Handler->error("requires a value!");
543       // Steal the next argument, like for '-o filename'
544       assert(argv && "null check");
545       Value = StringRef(argv[++i]);
546     }
547     break;
548   case ValueDisallowed:
549     if (NumAdditionalVals > 0)
550       return Handler->error("multi-valued option specified"
551                             " with ValueDisallowed modifier!");
552 
553     if (Value.data())
554       return Handler->error("does not allow a value! '" + Twine(Value) +
555                             "' specified.");
556     break;
557   case ValueOptional:
558     break;
559   }
560 
561   // If this isn't a multi-arg option, just run the handler.
562   if (NumAdditionalVals == 0)
563     return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
564 
565   // If it is, run the handle several times.
566   bool MultiArg = false;
567 
568   if (Value.data()) {
569     if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
570       return true;
571     --NumAdditionalVals;
572     MultiArg = true;
573   }
574 
575   while (NumAdditionalVals > 0) {
576     if (i + 1 >= argc)
577       return Handler->error("not enough values!");
578     assert(argv && "null check");
579     Value = StringRef(argv[++i]);
580 
581     if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
582       return true;
583     MultiArg = true;
584     --NumAdditionalVals;
585   }
586   return false;
587 }
588 
589 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
590   int Dummy = i;
591   return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
592 }
593 
594 // Option predicates...
595 static inline bool isGrouping(const Option *O) {
596   return O->getFormattingFlag() == cl::Grouping;
597 }
598 static inline bool isPrefixedOrGrouping(const Option *O) {
599   return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
600 }
601 
602 // getOptionPred - Check to see if there are any options that satisfy the
603 // specified predicate with names that are the prefixes in Name.  This is
604 // checked by progressively stripping characters off of the name, checking to
605 // see if there options that satisfy the predicate.  If we find one, return it,
606 // otherwise return null.
607 //
608 static Option *getOptionPred(StringRef Name, size_t &Length,
609                              bool (*Pred)(const Option *),
610                              const StringMap<Option *> &OptionsMap) {
611 
612   StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name);
613 
614   // Loop while we haven't found an option and Name still has at least two
615   // characters in it (so that the next iteration will not be the empty
616   // string.
617   while (OMI == OptionsMap.end() && Name.size() > 1) {
618     Name = Name.substr(0, Name.size() - 1); // Chop off the last character.
619     OMI = OptionsMap.find(Name);
620   }
621 
622   if (OMI != OptionsMap.end() && Pred(OMI->second)) {
623     Length = Name.size();
624     return OMI->second; // Found one!
625   }
626   return nullptr; // No option found!
627 }
628 
629 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
630 /// with at least one '-') does not fully match an available option.  Check to
631 /// see if this is a prefix or grouped option.  If so, split arg into output an
632 /// Arg/Value pair and return the Option to parse it with.
633 static Option *
634 HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
635                               bool &ErrorParsing,
636                               const StringMap<Option *> &OptionsMap) {
637   if (Arg.size() == 1)
638     return nullptr;
639 
640   // Do the lookup!
641   size_t Length = 0;
642   Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
643   if (!PGOpt)
644     return nullptr;
645 
646   // If the option is a prefixed option, then the value is simply the
647   // rest of the name...  so fall through to later processing, by
648   // setting up the argument name flags and value fields.
649   if (PGOpt->getFormattingFlag() == cl::Prefix) {
650     Value = Arg.substr(Length);
651     Arg = Arg.substr(0, Length);
652     assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
653     return PGOpt;
654   }
655 
656   // This must be a grouped option... handle them now.  Grouping options can't
657   // have values.
658   assert(isGrouping(PGOpt) && "Broken getOptionPred!");
659 
660   do {
661     // Move current arg name out of Arg into OneArgName.
662     StringRef OneArgName = Arg.substr(0, Length);
663     Arg = Arg.substr(Length);
664 
665     // Because ValueRequired is an invalid flag for grouped arguments,
666     // we don't need to pass argc/argv in.
667     assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
668            "Option can not be cl::Grouping AND cl::ValueRequired!");
669     int Dummy = 0;
670     ErrorParsing |=
671         ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy);
672 
673     // Get the next grouping option.
674     PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
675   } while (PGOpt && Length != Arg.size());
676 
677   // Return the last option with Arg cut down to just the last one.
678   return PGOpt;
679 }
680 
681 static bool RequiresValue(const Option *O) {
682   return O->getNumOccurrencesFlag() == cl::Required ||
683          O->getNumOccurrencesFlag() == cl::OneOrMore;
684 }
685 
686 static bool EatsUnboundedNumberOfValues(const Option *O) {
687   return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
688          O->getNumOccurrencesFlag() == cl::OneOrMore;
689 }
690 
691 static bool isWhitespace(char C) {
692   return C == ' ' || C == '\t' || C == '\r' || C == '\n';
693 }
694 
695 static bool isQuote(char C) { return C == '\"' || C == '\''; }
696 
697 void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
698                                 SmallVectorImpl<const char *> &NewArgv,
699                                 bool MarkEOLs) {
700   SmallString<128> Token;
701   for (size_t I = 0, E = Src.size(); I != E; ++I) {
702     // Consume runs of whitespace.
703     if (Token.empty()) {
704       while (I != E && isWhitespace(Src[I])) {
705         // Mark the end of lines in response files
706         if (MarkEOLs && Src[I] == '\n')
707           NewArgv.push_back(nullptr);
708         ++I;
709       }
710       if (I == E)
711         break;
712     }
713 
714     char C = Src[I];
715 
716     // Backslash escapes the next character.
717     if (I + 1 < E && C == '\\') {
718       ++I; // Skip the escape.
719       Token.push_back(Src[I]);
720       continue;
721     }
722 
723     // Consume a quoted string.
724     if (isQuote(C)) {
725       ++I;
726       while (I != E && Src[I] != C) {
727         // Backslash escapes the next character.
728         if (Src[I] == '\\' && I + 1 != E)
729           ++I;
730         Token.push_back(Src[I]);
731         ++I;
732       }
733       if (I == E)
734         break;
735       continue;
736     }
737 
738     // End the token if this is whitespace.
739     if (isWhitespace(C)) {
740       if (!Token.empty())
741         NewArgv.push_back(Saver.save(StringRef(Token)).data());
742       Token.clear();
743       continue;
744     }
745 
746     // This is a normal character.  Append it.
747     Token.push_back(C);
748   }
749 
750   // Append the last token after hitting EOF with no whitespace.
751   if (!Token.empty())
752     NewArgv.push_back(Saver.save(StringRef(Token)).data());
753   // Mark the end of response files
754   if (MarkEOLs)
755     NewArgv.push_back(nullptr);
756 }
757 
758 /// Backslashes are interpreted in a rather complicated way in the Windows-style
759 /// command line, because backslashes are used both to separate path and to
760 /// escape double quote. This method consumes runs of backslashes as well as the
761 /// following double quote if it's escaped.
762 ///
763 ///  * If an even number of backslashes is followed by a double quote, one
764 ///    backslash is output for every pair of backslashes, and the last double
765 ///    quote remains unconsumed. The double quote will later be interpreted as
766 ///    the start or end of a quoted string in the main loop outside of this
767 ///    function.
768 ///
769 ///  * If an odd number of backslashes is followed by a double quote, one
770 ///    backslash is output for every pair of backslashes, and a double quote is
771 ///    output for the last pair of backslash-double quote. The double quote is
772 ///    consumed in this case.
773 ///
774 ///  * Otherwise, backslashes are interpreted literally.
775 static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
776   size_t E = Src.size();
777   int BackslashCount = 0;
778   // Skip the backslashes.
779   do {
780     ++I;
781     ++BackslashCount;
782   } while (I != E && Src[I] == '\\');
783 
784   bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
785   if (FollowedByDoubleQuote) {
786     Token.append(BackslashCount / 2, '\\');
787     if (BackslashCount % 2 == 0)
788       return I - 1;
789     Token.push_back('"');
790     return I;
791   }
792   Token.append(BackslashCount, '\\');
793   return I - 1;
794 }
795 
796 void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
797                                     SmallVectorImpl<const char *> &NewArgv,
798                                     bool MarkEOLs) {
799   SmallString<128> Token;
800 
801   // This is a small state machine to consume characters until it reaches the
802   // end of the source string.
803   enum { INIT, UNQUOTED, QUOTED } State = INIT;
804   for (size_t I = 0, E = Src.size(); I != E; ++I) {
805     char C = Src[I];
806 
807     // INIT state indicates that the current input index is at the start of
808     // the string or between tokens.
809     if (State == INIT) {
810       if (isWhitespace(C)) {
811         // Mark the end of lines in response files
812         if (MarkEOLs && C == '\n')
813           NewArgv.push_back(nullptr);
814         continue;
815       }
816       if (C == '"') {
817         State = QUOTED;
818         continue;
819       }
820       if (C == '\\') {
821         I = parseBackslash(Src, I, Token);
822         State = UNQUOTED;
823         continue;
824       }
825       Token.push_back(C);
826       State = UNQUOTED;
827       continue;
828     }
829 
830     // UNQUOTED state means that it's reading a token not quoted by double
831     // quotes.
832     if (State == UNQUOTED) {
833       // Whitespace means the end of the token.
834       if (isWhitespace(C)) {
835         NewArgv.push_back(Saver.save(StringRef(Token)).data());
836         Token.clear();
837         State = INIT;
838         // Mark the end of lines in response files
839         if (MarkEOLs && C == '\n')
840           NewArgv.push_back(nullptr);
841         continue;
842       }
843       if (C == '"') {
844         State = QUOTED;
845         continue;
846       }
847       if (C == '\\') {
848         I = parseBackslash(Src, I, Token);
849         continue;
850       }
851       Token.push_back(C);
852       continue;
853     }
854 
855     // QUOTED state means that it's reading a token quoted by double quotes.
856     if (State == QUOTED) {
857       if (C == '"') {
858         State = UNQUOTED;
859         continue;
860       }
861       if (C == '\\') {
862         I = parseBackslash(Src, I, Token);
863         continue;
864       }
865       Token.push_back(C);
866     }
867   }
868   // Append the last token after hitting EOF with no whitespace.
869   if (!Token.empty())
870     NewArgv.push_back(Saver.save(StringRef(Token)).data());
871   // Mark the end of response files
872   if (MarkEOLs)
873     NewArgv.push_back(nullptr);
874 }
875 
876 // It is called byte order marker but the UTF-8 BOM is actually not affected
877 // by the host system's endianness.
878 static bool hasUTF8ByteOrderMark(ArrayRef<char> S) {
879   return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
880 }
881 
882 static bool ExpandResponseFile(StringRef FName, StringSaver &Saver,
883                                TokenizerCallback Tokenizer,
884                                SmallVectorImpl<const char *> &NewArgv,
885                                bool MarkEOLs, bool RelativeNames) {
886   ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
887       MemoryBuffer::getFile(FName);
888   if (!MemBufOrErr)
889     return false;
890   MemoryBuffer &MemBuf = *MemBufOrErr.get();
891   StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
892 
893   // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
894   ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
895   std::string UTF8Buf;
896   if (hasUTF16ByteOrderMark(BufRef)) {
897     if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
898       return false;
899     Str = StringRef(UTF8Buf);
900   }
901   // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
902   // these bytes before parsing.
903   // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
904   else if (hasUTF8ByteOrderMark(BufRef))
905     Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
906 
907   // Tokenize the contents into NewArgv.
908   Tokenizer(Str, Saver, NewArgv, MarkEOLs);
909 
910   // If names of nested response files should be resolved relative to including
911   // file, replace the included response file names with their full paths
912   // obtained by required resolution.
913   if (RelativeNames)
914     for (unsigned I = 0; I < NewArgv.size(); ++I)
915       if (NewArgv[I]) {
916         StringRef Arg = NewArgv[I];
917         if (Arg.front() == '@') {
918           StringRef FileName = Arg.drop_front();
919           if (llvm::sys::path::is_relative(FileName)) {
920             SmallString<128> ResponseFile;
921             ResponseFile.append(1, '@');
922             if (llvm::sys::path::is_relative(FName)) {
923               SmallString<128> curr_dir;
924               llvm::sys::fs::current_path(curr_dir);
925               ResponseFile.append(curr_dir.str());
926             }
927             llvm::sys::path::append(
928                 ResponseFile, llvm::sys::path::parent_path(FName), FileName);
929             NewArgv[I] = Saver.save(ResponseFile.c_str()).data();
930           }
931         }
932       }
933 
934   return true;
935 }
936 
937 /// \brief Expand response files on a command line recursively using the given
938 /// StringSaver and tokenization strategy.
939 bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
940                              SmallVectorImpl<const char *> &Argv,
941                              bool MarkEOLs, bool RelativeNames) {
942   unsigned RspFiles = 0;
943   bool AllExpanded = true;
944 
945   // Don't cache Argv.size() because it can change.
946   for (unsigned I = 0; I != Argv.size();) {
947     const char *Arg = Argv[I];
948     // Check if it is an EOL marker
949     if (Arg == nullptr) {
950       ++I;
951       continue;
952     }
953     if (Arg[0] != '@') {
954       ++I;
955       continue;
956     }
957 
958     // If we have too many response files, leave some unexpanded.  This avoids
959     // crashing on self-referential response files.
960     if (RspFiles++ > 20)
961       return false;
962 
963     // Replace this response file argument with the tokenization of its
964     // contents.  Nested response files are expanded in subsequent iterations.
965     SmallVector<const char *, 0> ExpandedArgv;
966     if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
967                             MarkEOLs, RelativeNames)) {
968       // We couldn't read this file, so we leave it in the argument stream and
969       // move on.
970       AllExpanded = false;
971       ++I;
972       continue;
973     }
974     Argv.erase(Argv.begin() + I);
975     Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
976   }
977   return AllExpanded;
978 }
979 
980 /// ParseEnvironmentOptions - An alternative entry point to the
981 /// CommandLine library, which allows you to read the program's name
982 /// from the caller (as PROGNAME) and its command-line arguments from
983 /// an environment variable (whose name is given in ENVVAR).
984 ///
985 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
986                                  const char *Overview) {
987   // Check args.
988   assert(progName && "Program name not specified");
989   assert(envVar && "Environment variable name missing");
990 
991   // Get the environment variable they want us to parse options out of.
992   llvm::Optional<std::string> envValue = sys::Process::GetEnv(StringRef(envVar));
993   if (!envValue)
994     return;
995 
996   // Get program's "name", which we wouldn't know without the caller
997   // telling us.
998   SmallVector<const char *, 20> newArgv;
999   BumpPtrAllocator A;
1000   StringSaver Saver(A);
1001   newArgv.push_back(Saver.save(progName).data());
1002 
1003   // Parse the value of the environment variable into a "command line"
1004   // and hand it off to ParseCommandLineOptions().
1005   TokenizeGNUCommandLine(*envValue, Saver, newArgv);
1006   int newArgc = static_cast<int>(newArgv.size());
1007   ParseCommandLineOptions(newArgc, &newArgv[0], StringRef(Overview));
1008 }
1009 
1010 bool cl::ParseCommandLineOptions(int argc, const char *const *argv,
1011                                  StringRef Overview, raw_ostream *Errs) {
1012   return GlobalParser->ParseCommandLineOptions(argc, argv, Overview,
1013                                                Errs);
1014 }
1015 
1016 void CommandLineParser::ResetAllOptionOccurrences() {
1017   // So that we can parse different command lines multiple times in succession
1018   // we reset all option values to look like they have never been seen before.
1019   for (auto SC : RegisteredSubCommands) {
1020     for (auto &O : SC->OptionsMap)
1021       O.second->reset();
1022   }
1023 }
1024 
1025 bool CommandLineParser::ParseCommandLineOptions(int argc,
1026                                                 const char *const *argv,
1027                                                 StringRef Overview,
1028                                                 raw_ostream *Errs) {
1029   assert(hasOptions() && "No options specified!");
1030 
1031   // Expand response files.
1032   SmallVector<const char *, 20> newArgv(argv, argv + argc);
1033   BumpPtrAllocator A;
1034   StringSaver Saver(A);
1035   ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
1036   argv = &newArgv[0];
1037   argc = static_cast<int>(newArgv.size());
1038 
1039   // Copy the program name into ProgName, making sure not to overflow it.
1040   ProgramName = sys::path::filename(StringRef(argv[0]));
1041 
1042   ProgramOverview = Overview;
1043   bool IgnoreErrors = Errs;
1044   if (!Errs)
1045     Errs = &errs();
1046   bool ErrorParsing = false;
1047 
1048   // Check out the positional arguments to collect information about them.
1049   unsigned NumPositionalRequired = 0;
1050 
1051   // Determine whether or not there are an unlimited number of positionals
1052   bool HasUnlimitedPositionals = false;
1053 
1054   int FirstArg = 1;
1055   SubCommand *ChosenSubCommand = &*TopLevelSubCommand;
1056   if (argc >= 2 && argv[FirstArg][0] != '-') {
1057     // If the first argument specifies a valid subcommand, start processing
1058     // options from the second argument.
1059     ChosenSubCommand = LookupSubCommand(StringRef(argv[FirstArg]));
1060     if (ChosenSubCommand != &*TopLevelSubCommand)
1061       FirstArg = 2;
1062   }
1063   GlobalParser->ActiveSubCommand = ChosenSubCommand;
1064 
1065   assert(ChosenSubCommand);
1066   auto &ConsumeAfterOpt = ChosenSubCommand->ConsumeAfterOpt;
1067   auto &PositionalOpts = ChosenSubCommand->PositionalOpts;
1068   auto &SinkOpts = ChosenSubCommand->SinkOpts;
1069   auto &OptionsMap = ChosenSubCommand->OptionsMap;
1070 
1071   if (ConsumeAfterOpt) {
1072     assert(PositionalOpts.size() > 0 &&
1073            "Cannot specify cl::ConsumeAfter without a positional argument!");
1074   }
1075   if (!PositionalOpts.empty()) {
1076 
1077     // Calculate how many positional values are _required_.
1078     bool UnboundedFound = false;
1079     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1080       Option *Opt = PositionalOpts[i];
1081       if (RequiresValue(Opt))
1082         ++NumPositionalRequired;
1083       else if (ConsumeAfterOpt) {
1084         // ConsumeAfter cannot be combined with "optional" positional options
1085         // unless there is only one positional argument...
1086         if (PositionalOpts.size() > 1) {
1087           if (!IgnoreErrors)
1088             Opt->error("error - this positional option will never be matched, "
1089                        "because it does not Require a value, and a "
1090                        "cl::ConsumeAfter option is active!");
1091           ErrorParsing = true;
1092         }
1093       } else if (UnboundedFound && !Opt->hasArgStr()) {
1094         // This option does not "require" a value...  Make sure this option is
1095         // not specified after an option that eats all extra arguments, or this
1096         // one will never get any!
1097         //
1098         if (!IgnoreErrors)
1099           Opt->error("error - option can never match, because "
1100                      "another positional argument will match an "
1101                      "unbounded number of values, and this option"
1102                      " does not require a value!");
1103         *Errs << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr
1104               << "' is all messed up!\n";
1105         *Errs << PositionalOpts.size();
1106         ErrorParsing = true;
1107       }
1108       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
1109     }
1110     HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
1111   }
1112 
1113   // PositionalVals - A vector of "positional" arguments we accumulate into
1114   // the process at the end.
1115   //
1116   SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
1117 
1118   // If the program has named positional arguments, and the name has been run
1119   // across, keep track of which positional argument was named.  Otherwise put
1120   // the positional args into the PositionalVals list...
1121   Option *ActivePositionalArg = nullptr;
1122 
1123   // Loop over all of the arguments... processing them.
1124   bool DashDashFound = false; // Have we read '--'?
1125   for (int i = FirstArg; i < argc; ++i) {
1126     Option *Handler = nullptr;
1127     Option *NearestHandler = nullptr;
1128     std::string NearestHandlerString;
1129     StringRef Value;
1130     StringRef ArgName = "";
1131 
1132     // Check to see if this is a positional argument.  This argument is
1133     // considered to be positional if it doesn't start with '-', if it is "-"
1134     // itself, or if we have seen "--" already.
1135     //
1136     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
1137       // Positional argument!
1138       if (ActivePositionalArg) {
1139         ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
1140         continue; // We are done!
1141       }
1142 
1143       if (!PositionalOpts.empty()) {
1144         PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
1145 
1146         // All of the positional arguments have been fulfulled, give the rest to
1147         // the consume after option... if it's specified...
1148         //
1149         if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
1150           for (++i; i < argc; ++i)
1151             PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
1152           break; // Handle outside of the argument processing loop...
1153         }
1154 
1155         // Delay processing positional arguments until the end...
1156         continue;
1157       }
1158     } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
1159                !DashDashFound) {
1160       DashDashFound = true; // This is the mythical "--"?
1161       continue;             // Don't try to process it as an argument itself.
1162     } else if (ActivePositionalArg &&
1163                (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
1164       // If there is a positional argument eating options, check to see if this
1165       // option is another positional argument.  If so, treat it as an argument,
1166       // otherwise feed it to the eating positional.
1167       ArgName = StringRef(argv[i] + 1);
1168       // Eat leading dashes.
1169       while (!ArgName.empty() && ArgName[0] == '-')
1170         ArgName = ArgName.substr(1);
1171 
1172       Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
1173       if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
1174         ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
1175         continue; // We are done!
1176       }
1177 
1178     } else { // We start with a '-', must be an argument.
1179       ArgName = StringRef(argv[i] + 1);
1180       // Eat leading dashes.
1181       while (!ArgName.empty() && ArgName[0] == '-')
1182         ArgName = ArgName.substr(1);
1183 
1184       Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
1185 
1186       // Check to see if this "option" is really a prefixed or grouped argument.
1187       if (!Handler)
1188         Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
1189                                                 OptionsMap);
1190 
1191       // Otherwise, look for the closest available option to report to the user
1192       // in the upcoming error.
1193       if (!Handler && SinkOpts.empty())
1194         NearestHandler =
1195             LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
1196     }
1197 
1198     if (!Handler) {
1199       if (SinkOpts.empty()) {
1200         *Errs << ProgramName << ": Unknown command line argument '" << argv[i]
1201               << "'.  Try: '" << argv[0] << " -help'\n";
1202 
1203         if (NearestHandler) {
1204           // If we know a near match, report it as well.
1205           *Errs << ProgramName << ": Did you mean '-" << NearestHandlerString
1206                  << "'?\n";
1207         }
1208 
1209         ErrorParsing = true;
1210       } else {
1211         for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
1212                                                  E = SinkOpts.end();
1213              I != E; ++I)
1214           (*I)->addOccurrence(i, "", StringRef(argv[i]));
1215       }
1216       continue;
1217     }
1218 
1219     // If this is a named positional argument, just remember that it is the
1220     // active one...
1221     if (Handler->getFormattingFlag() == cl::Positional)
1222       ActivePositionalArg = Handler;
1223     else
1224       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
1225   }
1226 
1227   // Check and handle positional arguments now...
1228   if (NumPositionalRequired > PositionalVals.size()) {
1229       *Errs << ProgramName
1230              << ": Not enough positional command line arguments specified!\n"
1231              << "Must specify at least " << NumPositionalRequired
1232              << " positional argument" << (NumPositionalRequired > 1 ? "s" : "")
1233              << ": See: " << argv[0] << " -help\n";
1234 
1235     ErrorParsing = true;
1236   } else if (!HasUnlimitedPositionals &&
1237              PositionalVals.size() > PositionalOpts.size()) {
1238     *Errs << ProgramName << ": Too many positional arguments specified!\n"
1239           << "Can specify at most " << PositionalOpts.size()
1240           << " positional arguments: See: " << argv[0] << " -help\n";
1241     ErrorParsing = true;
1242 
1243   } else if (!ConsumeAfterOpt) {
1244     // Positional args have already been handled if ConsumeAfter is specified.
1245     unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1246     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1247       if (RequiresValue(PositionalOpts[i])) {
1248         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
1249                                 PositionalVals[ValNo].second);
1250         ValNo++;
1251         --NumPositionalRequired; // We fulfilled our duty...
1252       }
1253 
1254       // If we _can_ give this option more arguments, do so now, as long as we
1255       // do not give it values that others need.  'Done' controls whether the
1256       // option even _WANTS_ any more.
1257       //
1258       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
1259       while (NumVals - ValNo > NumPositionalRequired && !Done) {
1260         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
1261         case cl::Optional:
1262           Done = true; // Optional arguments want _at most_ one value
1263           LLVM_FALLTHROUGH;
1264         case cl::ZeroOrMore: // Zero or more will take all they can get...
1265         case cl::OneOrMore:  // One or more will take all they can get...
1266           ProvidePositionalOption(PositionalOpts[i],
1267                                   PositionalVals[ValNo].first,
1268                                   PositionalVals[ValNo].second);
1269           ValNo++;
1270           break;
1271         default:
1272           llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
1273                            "positional argument processing!");
1274         }
1275       }
1276     }
1277   } else {
1278     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1279     unsigned ValNo = 0;
1280     for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
1281       if (RequiresValue(PositionalOpts[j])) {
1282         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
1283                                                 PositionalVals[ValNo].first,
1284                                                 PositionalVals[ValNo].second);
1285         ValNo++;
1286       }
1287 
1288     // Handle the case where there is just one positional option, and it's
1289     // optional.  In this case, we want to give JUST THE FIRST option to the
1290     // positional option and keep the rest for the consume after.  The above
1291     // loop would have assigned no values to positional options in this case.
1292     //
1293     if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1294       ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
1295                                               PositionalVals[ValNo].first,
1296                                               PositionalVals[ValNo].second);
1297       ValNo++;
1298     }
1299 
1300     // Handle over all of the rest of the arguments to the
1301     // cl::ConsumeAfter command line option...
1302     for (; ValNo != PositionalVals.size(); ++ValNo)
1303       ErrorParsing |=
1304           ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1305                                   PositionalVals[ValNo].second);
1306   }
1307 
1308   // Loop over args and make sure all required args are specified!
1309   for (const auto &Opt : OptionsMap) {
1310     switch (Opt.second->getNumOccurrencesFlag()) {
1311     case Required:
1312     case OneOrMore:
1313       if (Opt.second->getNumOccurrences() == 0) {
1314         Opt.second->error("must be specified at least once!");
1315         ErrorParsing = true;
1316       }
1317       LLVM_FALLTHROUGH;
1318     default:
1319       break;
1320     }
1321   }
1322 
1323   // Now that we know if -debug is specified, we can use it.
1324   // Note that if ReadResponseFiles == true, this must be done before the
1325   // memory allocated for the expanded command line is free()d below.
1326   DEBUG(dbgs() << "Args: ";
1327         for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1328         dbgs() << '\n';);
1329 
1330   // Free all of the memory allocated to the map.  Command line options may only
1331   // be processed once!
1332   MoreHelp.clear();
1333 
1334   // If we had an error processing our arguments, don't let the program execute
1335   if (ErrorParsing) {
1336     if (!IgnoreErrors)
1337       exit(1);
1338     return false;
1339   }
1340   return true;
1341 }
1342 
1343 //===----------------------------------------------------------------------===//
1344 // Option Base class implementation
1345 //
1346 
1347 bool Option::error(const Twine &Message, StringRef ArgName) {
1348   if (!ArgName.data())
1349     ArgName = ArgStr;
1350   if (ArgName.empty())
1351     errs() << HelpStr; // Be nice for positional arguments
1352   else
1353     errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
1354 
1355   errs() << " option: " << Message << "\n";
1356   return true;
1357 }
1358 
1359 bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1360                            bool MultiArg) {
1361   if (!MultiArg)
1362     NumOccurrences++; // Increment the number of times we have been seen
1363 
1364   switch (getNumOccurrencesFlag()) {
1365   case Optional:
1366     if (NumOccurrences > 1)
1367       return error("may only occur zero or one times!", ArgName);
1368     break;
1369   case Required:
1370     if (NumOccurrences > 1)
1371       return error("must occur exactly one time!", ArgName);
1372     LLVM_FALLTHROUGH;
1373   case OneOrMore:
1374   case ZeroOrMore:
1375   case ConsumeAfter:
1376     break;
1377   }
1378 
1379   return handleOccurrence(pos, ArgName, Value);
1380 }
1381 
1382 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
1383 // has been specified yet.
1384 //
1385 static StringRef getValueStr(const Option &O, StringRef DefaultMsg) {
1386   if (O.ValueStr.empty())
1387     return DefaultMsg;
1388   return O.ValueStr;
1389 }
1390 
1391 //===----------------------------------------------------------------------===//
1392 // cl::alias class implementation
1393 //
1394 
1395 // Return the width of the option tag for printing...
1396 size_t alias::getOptionWidth() const { return ArgStr.size() + 6; }
1397 
1398 void Option::printHelpStr(StringRef HelpStr, size_t Indent,
1399                                  size_t FirstLineIndentedBy) {
1400   std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1401   outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1402   while (!Split.second.empty()) {
1403     Split = Split.second.split('\n');
1404     outs().indent(Indent) << Split.first << "\n";
1405   }
1406 }
1407 
1408 // Print out the option for the alias.
1409 void alias::printOptionInfo(size_t GlobalWidth) const {
1410   outs() << "  -" << ArgStr;
1411   printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
1412 }
1413 
1414 //===----------------------------------------------------------------------===//
1415 // Parser Implementation code...
1416 //
1417 
1418 // basic_parser implementation
1419 //
1420 
1421 // Return the width of the option tag for printing...
1422 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
1423   size_t Len = O.ArgStr.size();
1424   auto ValName = getValueName();
1425   if (!ValName.empty())
1426     Len += getValueStr(O, ValName).size() + 3;
1427 
1428   return Len + 6;
1429 }
1430 
1431 // printOptionInfo - Print out information about this option.  The
1432 // to-be-maintained width is specified.
1433 //
1434 void basic_parser_impl::printOptionInfo(const Option &O,
1435                                         size_t GlobalWidth) const {
1436   outs() << "  -" << O.ArgStr;
1437 
1438   auto ValName = getValueName();
1439   if (!ValName.empty())
1440     outs() << "=<" << getValueStr(O, ValName) << '>';
1441 
1442   Option::printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1443 }
1444 
1445 void basic_parser_impl::printOptionName(const Option &O,
1446                                         size_t GlobalWidth) const {
1447   outs() << "  -" << O.ArgStr;
1448   outs().indent(GlobalWidth - O.ArgStr.size());
1449 }
1450 
1451 // parser<bool> implementation
1452 //
1453 bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1454                          bool &Value) {
1455   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1456       Arg == "1") {
1457     Value = true;
1458     return false;
1459   }
1460 
1461   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1462     Value = false;
1463     return false;
1464   }
1465   return O.error("'" + Arg +
1466                  "' is invalid value for boolean argument! Try 0 or 1");
1467 }
1468 
1469 // parser<boolOrDefault> implementation
1470 //
1471 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg,
1472                                   boolOrDefault &Value) {
1473   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1474       Arg == "1") {
1475     Value = BOU_TRUE;
1476     return false;
1477   }
1478   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1479     Value = BOU_FALSE;
1480     return false;
1481   }
1482 
1483   return O.error("'" + Arg +
1484                  "' is invalid value for boolean argument! Try 0 or 1");
1485 }
1486 
1487 // parser<int> implementation
1488 //
1489 bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1490                         int &Value) {
1491   if (Arg.getAsInteger(0, Value))
1492     return O.error("'" + Arg + "' value invalid for integer argument!");
1493   return false;
1494 }
1495 
1496 // parser<unsigned> implementation
1497 //
1498 bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1499                              unsigned &Value) {
1500 
1501   if (Arg.getAsInteger(0, Value))
1502     return O.error("'" + Arg + "' value invalid for uint argument!");
1503   return false;
1504 }
1505 
1506 // parser<unsigned long long> implementation
1507 //
1508 bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
1509                                        StringRef Arg,
1510                                        unsigned long long &Value) {
1511 
1512   if (Arg.getAsInteger(0, Value))
1513     return O.error("'" + Arg + "' value invalid for uint argument!");
1514   return false;
1515 }
1516 
1517 // parser<double>/parser<float> implementation
1518 //
1519 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1520   if (to_float(Arg, Value))
1521     return false;
1522   return O.error("'" + Arg + "' value invalid for floating point argument!");
1523 }
1524 
1525 bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1526                            double &Val) {
1527   return parseDouble(O, Arg, Val);
1528 }
1529 
1530 bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1531                           float &Val) {
1532   double dVal;
1533   if (parseDouble(O, Arg, dVal))
1534     return true;
1535   Val = (float)dVal;
1536   return false;
1537 }
1538 
1539 // generic_parser_base implementation
1540 //
1541 
1542 // findOption - Return the option number corresponding to the specified
1543 // argument string.  If the option is not found, getNumOptions() is returned.
1544 //
1545 unsigned generic_parser_base::findOption(StringRef Name) {
1546   unsigned e = getNumOptions();
1547 
1548   for (unsigned i = 0; i != e; ++i) {
1549     if (getOption(i) == Name)
1550       return i;
1551   }
1552   return e;
1553 }
1554 
1555 // Return the width of the option tag for printing...
1556 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1557   if (O.hasArgStr()) {
1558     size_t Size = O.ArgStr.size() + 6;
1559     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1560       Size = std::max(Size, getOption(i).size() + 8);
1561     return Size;
1562   } else {
1563     size_t BaseSize = 0;
1564     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1565       BaseSize = std::max(BaseSize, getOption(i).size() + 8);
1566     return BaseSize;
1567   }
1568 }
1569 
1570 // printOptionInfo - Print out information about this option.  The
1571 // to-be-maintained width is specified.
1572 //
1573 void generic_parser_base::printOptionInfo(const Option &O,
1574                                           size_t GlobalWidth) const {
1575   if (O.hasArgStr()) {
1576     outs() << "  -" << O.ArgStr;
1577     Option::printHelpStr(O.HelpStr, GlobalWidth, O.ArgStr.size() + 6);
1578 
1579     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1580       size_t NumSpaces = GlobalWidth - getOption(i).size() - 8;
1581       outs() << "    =" << getOption(i);
1582       outs().indent(NumSpaces) << " -   " << getDescription(i) << '\n';
1583     }
1584   } else {
1585     if (!O.HelpStr.empty())
1586       outs() << "  " << O.HelpStr << '\n';
1587     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1588       auto Option = getOption(i);
1589       outs() << "    -" << Option;
1590       Option::printHelpStr(getDescription(i), GlobalWidth, Option.size() + 8);
1591     }
1592   }
1593 }
1594 
1595 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1596 
1597 // printGenericOptionDiff - Print the value of this option and it's default.
1598 //
1599 // "Generic" options have each value mapped to a name.
1600 void generic_parser_base::printGenericOptionDiff(
1601     const Option &O, const GenericOptionValue &Value,
1602     const GenericOptionValue &Default, size_t GlobalWidth) const {
1603   outs() << "  -" << O.ArgStr;
1604   outs().indent(GlobalWidth - O.ArgStr.size());
1605 
1606   unsigned NumOpts = getNumOptions();
1607   for (unsigned i = 0; i != NumOpts; ++i) {
1608     if (Value.compare(getOptionValue(i)))
1609       continue;
1610 
1611     outs() << "= " << getOption(i);
1612     size_t L = getOption(i).size();
1613     size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1614     outs().indent(NumSpaces) << " (default: ";
1615     for (unsigned j = 0; j != NumOpts; ++j) {
1616       if (Default.compare(getOptionValue(j)))
1617         continue;
1618       outs() << getOption(j);
1619       break;
1620     }
1621     outs() << ")\n";
1622     return;
1623   }
1624   outs() << "= *unknown option value*\n";
1625 }
1626 
1627 // printOptionDiff - Specializations for printing basic value types.
1628 //
1629 #define PRINT_OPT_DIFF(T)                                                      \
1630   void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D,      \
1631                                   size_t GlobalWidth) const {                  \
1632     printOptionName(O, GlobalWidth);                                           \
1633     std::string Str;                                                           \
1634     {                                                                          \
1635       raw_string_ostream SS(Str);                                              \
1636       SS << V;                                                                 \
1637     }                                                                          \
1638     outs() << "= " << Str;                                                     \
1639     size_t NumSpaces =                                                         \
1640         MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0;               \
1641     outs().indent(NumSpaces) << " (default: ";                                 \
1642     if (D.hasValue())                                                          \
1643       outs() << D.getValue();                                                  \
1644     else                                                                       \
1645       outs() << "*no default*";                                                \
1646     outs() << ")\n";                                                           \
1647   }
1648 
1649 PRINT_OPT_DIFF(bool)
1650 PRINT_OPT_DIFF(boolOrDefault)
1651 PRINT_OPT_DIFF(int)
1652 PRINT_OPT_DIFF(unsigned)
1653 PRINT_OPT_DIFF(unsigned long long)
1654 PRINT_OPT_DIFF(double)
1655 PRINT_OPT_DIFF(float)
1656 PRINT_OPT_DIFF(char)
1657 
1658 void parser<std::string>::printOptionDiff(const Option &O, StringRef V,
1659                                           const OptionValue<std::string> &D,
1660                                           size_t GlobalWidth) const {
1661   printOptionName(O, GlobalWidth);
1662   outs() << "= " << V;
1663   size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1664   outs().indent(NumSpaces) << " (default: ";
1665   if (D.hasValue())
1666     outs() << D.getValue();
1667   else
1668     outs() << "*no default*";
1669   outs() << ")\n";
1670 }
1671 
1672 // Print a placeholder for options that don't yet support printOptionDiff().
1673 void basic_parser_impl::printOptionNoValue(const Option &O,
1674                                            size_t GlobalWidth) const {
1675   printOptionName(O, GlobalWidth);
1676   outs() << "= *cannot print option value*\n";
1677 }
1678 
1679 //===----------------------------------------------------------------------===//
1680 // -help and -help-hidden option implementation
1681 //
1682 
1683 static int OptNameCompare(const std::pair<const char *, Option *> *LHS,
1684                           const std::pair<const char *, Option *> *RHS) {
1685   return strcmp(LHS->first, RHS->first);
1686 }
1687 
1688 static int SubNameCompare(const std::pair<const char *, SubCommand *> *LHS,
1689                           const std::pair<const char *, SubCommand *> *RHS) {
1690   return strcmp(LHS->first, RHS->first);
1691 }
1692 
1693 // Copy Options into a vector so we can sort them as we like.
1694 static void sortOpts(StringMap<Option *> &OptMap,
1695                      SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1696                      bool ShowHidden) {
1697   SmallPtrSet<Option *, 32> OptionSet; // Duplicate option detection.
1698 
1699   for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
1700        I != E; ++I) {
1701     // Ignore really-hidden options.
1702     if (I->second->getOptionHiddenFlag() == ReallyHidden)
1703       continue;
1704 
1705     // Unless showhidden is set, ignore hidden flags.
1706     if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1707       continue;
1708 
1709     // If we've already seen this option, don't add it to the list again.
1710     if (!OptionSet.insert(I->second).second)
1711       continue;
1712 
1713     Opts.push_back(
1714         std::pair<const char *, Option *>(I->getKey().data(), I->second));
1715   }
1716 
1717   // Sort the options list alphabetically.
1718   array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare);
1719 }
1720 
1721 static void
1722 sortSubCommands(const SmallPtrSetImpl<SubCommand *> &SubMap,
1723                 SmallVectorImpl<std::pair<const char *, SubCommand *>> &Subs) {
1724   for (const auto &S : SubMap) {
1725     if (S->getName().empty())
1726       continue;
1727     Subs.push_back(std::make_pair(S->getName().data(), S));
1728   }
1729   array_pod_sort(Subs.begin(), Subs.end(), SubNameCompare);
1730 }
1731 
1732 namespace {
1733 
1734 class HelpPrinter {
1735 protected:
1736   const bool ShowHidden;
1737   typedef SmallVector<std::pair<const char *, Option *>, 128>
1738       StrOptionPairVector;
1739   typedef SmallVector<std::pair<const char *, SubCommand *>, 128>
1740       StrSubCommandPairVector;
1741   // Print the options. Opts is assumed to be alphabetically sorted.
1742   virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1743     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1744       Opts[i].second->printOptionInfo(MaxArgLen);
1745   }
1746 
1747   void printSubCommands(StrSubCommandPairVector &Subs, size_t MaxSubLen) {
1748     for (const auto &S : Subs) {
1749       outs() << "  " << S.first;
1750       if (!S.second->getDescription().empty()) {
1751         outs().indent(MaxSubLen - strlen(S.first));
1752         outs() << " - " << S.second->getDescription();
1753       }
1754       outs() << "\n";
1755     }
1756   }
1757 
1758 public:
1759   explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
1760   virtual ~HelpPrinter() {}
1761 
1762   // Invoke the printer.
1763   void operator=(bool Value) {
1764     if (!Value)
1765       return;
1766     printHelp();
1767 
1768     // Halt the program since help information was printed
1769     exit(0);
1770   }
1771 
1772   void printHelp() {
1773     SubCommand *Sub = GlobalParser->getActiveSubCommand();
1774     auto &OptionsMap = Sub->OptionsMap;
1775     auto &PositionalOpts = Sub->PositionalOpts;
1776     auto &ConsumeAfterOpt = Sub->ConsumeAfterOpt;
1777 
1778     StrOptionPairVector Opts;
1779     sortOpts(OptionsMap, Opts, ShowHidden);
1780 
1781     StrSubCommandPairVector Subs;
1782     sortSubCommands(GlobalParser->RegisteredSubCommands, Subs);
1783 
1784     if (!GlobalParser->ProgramOverview.empty())
1785       outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
1786 
1787     if (Sub == &*TopLevelSubCommand) {
1788       outs() << "USAGE: " << GlobalParser->ProgramName;
1789       if (Subs.size() > 2)
1790         outs() << " [subcommand]";
1791       outs() << " [options]";
1792     } else {
1793       if (!Sub->getDescription().empty()) {
1794         outs() << "SUBCOMMAND '" << Sub->getName()
1795                << "': " << Sub->getDescription() << "\n\n";
1796       }
1797       outs() << "USAGE: " << GlobalParser->ProgramName << " " << Sub->getName()
1798              << " [options]";
1799     }
1800 
1801     for (auto Opt : PositionalOpts) {
1802       if (Opt->hasArgStr())
1803         outs() << " --" << Opt->ArgStr;
1804       outs() << " " << Opt->HelpStr;
1805     }
1806 
1807     // Print the consume after option info if it exists...
1808     if (ConsumeAfterOpt)
1809       outs() << " " << ConsumeAfterOpt->HelpStr;
1810 
1811     if (Sub == &*TopLevelSubCommand && !Subs.empty()) {
1812       // Compute the maximum subcommand length...
1813       size_t MaxSubLen = 0;
1814       for (size_t i = 0, e = Subs.size(); i != e; ++i)
1815         MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first));
1816 
1817       outs() << "\n\n";
1818       outs() << "SUBCOMMANDS:\n\n";
1819       printSubCommands(Subs, MaxSubLen);
1820       outs() << "\n";
1821       outs() << "  Type \"" << GlobalParser->ProgramName
1822              << " <subcommand> -help\" to get more help on a specific "
1823                 "subcommand";
1824     }
1825 
1826     outs() << "\n\n";
1827 
1828     // Compute the maximum argument length...
1829     size_t MaxArgLen = 0;
1830     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1831       MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1832 
1833     outs() << "OPTIONS:\n";
1834     printOptions(Opts, MaxArgLen);
1835 
1836     // Print any extra help the user has declared.
1837     for (auto I : GlobalParser->MoreHelp)
1838       outs() << I;
1839     GlobalParser->MoreHelp.clear();
1840   }
1841 };
1842 
1843 class CategorizedHelpPrinter : public HelpPrinter {
1844 public:
1845   explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1846 
1847   // Helper function for printOptions().
1848   // It shall return a negative value if A's name should be lexicographically
1849   // ordered before B's name. It returns a value greater than zero if B's name
1850   // should be ordered before A's name, and it returns 0 otherwise.
1851   static int OptionCategoryCompare(OptionCategory *const *A,
1852                                    OptionCategory *const *B) {
1853     return (*A)->getName().compare((*B)->getName());
1854   }
1855 
1856   // Make sure we inherit our base class's operator=()
1857   using HelpPrinter::operator=;
1858 
1859 protected:
1860   void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
1861     std::vector<OptionCategory *> SortedCategories;
1862     std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
1863 
1864     // Collect registered option categories into vector in preparation for
1865     // sorting.
1866     for (auto I = GlobalParser->RegisteredOptionCategories.begin(),
1867               E = GlobalParser->RegisteredOptionCategories.end();
1868          I != E; ++I) {
1869       SortedCategories.push_back(*I);
1870     }
1871 
1872     // Sort the different option categories alphabetically.
1873     assert(SortedCategories.size() > 0 && "No option categories registered!");
1874     array_pod_sort(SortedCategories.begin(), SortedCategories.end(),
1875                    OptionCategoryCompare);
1876 
1877     // Create map to empty vectors.
1878     for (std::vector<OptionCategory *>::const_iterator
1879              I = SortedCategories.begin(),
1880              E = SortedCategories.end();
1881          I != E; ++I)
1882       CategorizedOptions[*I] = std::vector<Option *>();
1883 
1884     // Walk through pre-sorted options and assign into categories.
1885     // Because the options are already alphabetically sorted the
1886     // options within categories will also be alphabetically sorted.
1887     for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1888       Option *Opt = Opts[I].second;
1889       assert(CategorizedOptions.count(Opt->Category) > 0 &&
1890              "Option has an unregistered category");
1891       CategorizedOptions[Opt->Category].push_back(Opt);
1892     }
1893 
1894     // Now do printing.
1895     for (std::vector<OptionCategory *>::const_iterator
1896              Category = SortedCategories.begin(),
1897              E = SortedCategories.end();
1898          Category != E; ++Category) {
1899       // Hide empty categories for -help, but show for -help-hidden.
1900       const auto &CategoryOptions = CategorizedOptions[*Category];
1901       bool IsEmptyCategory = CategoryOptions.empty();
1902       if (!ShowHidden && IsEmptyCategory)
1903         continue;
1904 
1905       // Print category information.
1906       outs() << "\n";
1907       outs() << (*Category)->getName() << ":\n";
1908 
1909       // Check if description is set.
1910       if (!(*Category)->getDescription().empty())
1911         outs() << (*Category)->getDescription() << "\n\n";
1912       else
1913         outs() << "\n";
1914 
1915       // When using -help-hidden explicitly state if the category has no
1916       // options associated with it.
1917       if (IsEmptyCategory) {
1918         outs() << "  This option category has no options.\n";
1919         continue;
1920       }
1921       // Loop over the options in the category and print.
1922       for (const Option *Opt : CategoryOptions)
1923         Opt->printOptionInfo(MaxArgLen);
1924     }
1925   }
1926 };
1927 
1928 // This wraps the Uncategorizing and Categorizing printers and decides
1929 // at run time which should be invoked.
1930 class HelpPrinterWrapper {
1931 private:
1932   HelpPrinter &UncategorizedPrinter;
1933   CategorizedHelpPrinter &CategorizedPrinter;
1934 
1935 public:
1936   explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1937                               CategorizedHelpPrinter &CategorizedPrinter)
1938       : UncategorizedPrinter(UncategorizedPrinter),
1939         CategorizedPrinter(CategorizedPrinter) {}
1940 
1941   // Invoke the printer.
1942   void operator=(bool Value);
1943 };
1944 
1945 } // End anonymous namespace
1946 
1947 // Declare the four HelpPrinter instances that are used to print out help, or
1948 // help-hidden as an uncategorized list or in categories.
1949 static HelpPrinter UncategorizedNormalPrinter(false);
1950 static HelpPrinter UncategorizedHiddenPrinter(true);
1951 static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1952 static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1953 
1954 // Declare HelpPrinter wrappers that will decide whether or not to invoke
1955 // a categorizing help printer
1956 static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1957                                                CategorizedNormalPrinter);
1958 static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1959                                                CategorizedHiddenPrinter);
1960 
1961 // Define a category for generic options that all tools should have.
1962 static cl::OptionCategory GenericCategory("Generic Options");
1963 
1964 // Define uncategorized help printers.
1965 // -help-list is hidden by default because if Option categories are being used
1966 // then -help behaves the same as -help-list.
1967 static cl::opt<HelpPrinter, true, parser<bool>> HLOp(
1968     "help-list",
1969     cl::desc("Display list of available options (-help-list-hidden for more)"),
1970     cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
1971     cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1972 
1973 static cl::opt<HelpPrinter, true, parser<bool>>
1974     HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
1975           cl::location(UncategorizedHiddenPrinter), cl::Hidden,
1976           cl::ValueDisallowed, cl::cat(GenericCategory),
1977           cl::sub(*AllSubCommands));
1978 
1979 // Define uncategorized/categorized help printers. These printers change their
1980 // behaviour at runtime depending on whether one or more Option categories have
1981 // been declared.
1982 static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1983     HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1984         cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
1985         cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1986 
1987 static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1988     HHOp("help-hidden", cl::desc("Display all available options"),
1989          cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
1990          cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1991 
1992 static cl::opt<bool> PrintOptions(
1993     "print-options",
1994     cl::desc("Print non-default options after command line parsing"),
1995     cl::Hidden, cl::init(false), cl::cat(GenericCategory),
1996     cl::sub(*AllSubCommands));
1997 
1998 static cl::opt<bool> PrintAllOptions(
1999     "print-all-options",
2000     cl::desc("Print all option values after command line parsing"), cl::Hidden,
2001     cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands));
2002 
2003 void HelpPrinterWrapper::operator=(bool Value) {
2004   if (!Value)
2005     return;
2006 
2007   // Decide which printer to invoke. If more than one option category is
2008   // registered then it is useful to show the categorized help instead of
2009   // uncategorized help.
2010   if (GlobalParser->RegisteredOptionCategories.size() > 1) {
2011     // unhide -help-list option so user can have uncategorized output if they
2012     // want it.
2013     HLOp.setHiddenFlag(NotHidden);
2014 
2015     CategorizedPrinter = true; // Invoke categorized printer
2016   } else
2017     UncategorizedPrinter = true; // Invoke uncategorized printer
2018 }
2019 
2020 // Print the value of each option.
2021 void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
2022 
2023 void CommandLineParser::printOptionValues() {
2024   if (!PrintOptions && !PrintAllOptions)
2025     return;
2026 
2027   SmallVector<std::pair<const char *, Option *>, 128> Opts;
2028   sortOpts(ActiveSubCommand->OptionsMap, Opts, /*ShowHidden*/ true);
2029 
2030   // Compute the maximum argument length...
2031   size_t MaxArgLen = 0;
2032   for (size_t i = 0, e = Opts.size(); i != e; ++i)
2033     MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2034 
2035   for (size_t i = 0, e = Opts.size(); i != e; ++i)
2036     Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
2037 }
2038 
2039 static VersionPrinterTy OverrideVersionPrinter = nullptr;
2040 
2041 static std::vector<VersionPrinterTy> *ExtraVersionPrinters = nullptr;
2042 
2043 namespace {
2044 class VersionPrinter {
2045 public:
2046   void print() {
2047     raw_ostream &OS = outs();
2048 #ifdef PACKAGE_VENDOR
2049     OS << PACKAGE_VENDOR << " ";
2050 #else
2051     OS << "LLVM (http://llvm.org/):\n  ";
2052 #endif
2053     OS << PACKAGE_NAME << " version " << PACKAGE_VERSION;
2054 #ifdef LLVM_VERSION_INFO
2055     OS << " " << LLVM_VERSION_INFO;
2056 #endif
2057     OS << "\n  ";
2058 #ifndef __OPTIMIZE__
2059     OS << "DEBUG build";
2060 #else
2061     OS << "Optimized build";
2062 #endif
2063 #ifndef NDEBUG
2064     OS << " with assertions";
2065 #endif
2066 #if LLVM_VERSION_PRINTER_SHOW_HOST_TARGET_INFO
2067     std::string CPU = sys::getHostCPUName();
2068     if (CPU == "generic")
2069       CPU = "(unknown)";
2070     OS << ".\n"
2071        << "  Default target: " << sys::getDefaultTargetTriple() << '\n'
2072        << "  Host CPU: " << CPU;
2073 #endif
2074     OS << '\n';
2075   }
2076   void operator=(bool OptionWasSpecified) {
2077     if (!OptionWasSpecified)
2078       return;
2079 
2080     if (OverrideVersionPrinter != nullptr) {
2081       OverrideVersionPrinter(outs());
2082       exit(0);
2083     }
2084     print();
2085 
2086     // Iterate over any registered extra printers and call them to add further
2087     // information.
2088     if (ExtraVersionPrinters != nullptr) {
2089       outs() << '\n';
2090       for (auto I : *ExtraVersionPrinters)
2091         I(outs());
2092     }
2093 
2094     exit(0);
2095   }
2096 };
2097 } // End anonymous namespace
2098 
2099 // Define the --version option that prints out the LLVM version for the tool
2100 static VersionPrinter VersionPrinterInstance;
2101 
2102 static cl::opt<VersionPrinter, true, parser<bool>>
2103     VersOp("version", cl::desc("Display the version of this program"),
2104            cl::location(VersionPrinterInstance), cl::ValueDisallowed,
2105            cl::cat(GenericCategory));
2106 
2107 // Utility function for printing the help message.
2108 void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
2109   if (!Hidden && !Categorized)
2110     UncategorizedNormalPrinter.printHelp();
2111   else if (!Hidden && Categorized)
2112     CategorizedNormalPrinter.printHelp();
2113   else if (Hidden && !Categorized)
2114     UncategorizedHiddenPrinter.printHelp();
2115   else
2116     CategorizedHiddenPrinter.printHelp();
2117 }
2118 
2119 /// Utility function for printing version number.
2120 void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
2121 
2122 void cl::SetVersionPrinter(VersionPrinterTy func) { OverrideVersionPrinter = func; }
2123 
2124 void cl::AddExtraVersionPrinter(VersionPrinterTy func) {
2125   if (!ExtraVersionPrinters)
2126     ExtraVersionPrinters = new std::vector<VersionPrinterTy>;
2127 
2128   ExtraVersionPrinters->push_back(func);
2129 }
2130 
2131 StringMap<Option *> &cl::getRegisteredOptions(SubCommand &Sub) {
2132   auto &Subs = GlobalParser->RegisteredSubCommands;
2133   (void)Subs;
2134   assert(is_contained(Subs, &Sub));
2135   return Sub.OptionsMap;
2136 }
2137 
2138 iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator>
2139 cl::getRegisteredSubcommands() {
2140   return GlobalParser->getRegisteredSubcommands();
2141 }
2142 
2143 void cl::HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub) {
2144   for (auto &I : Sub.OptionsMap) {
2145     if (I.second->Category != &Category &&
2146         I.second->Category != &GenericCategory)
2147       I.second->setHiddenFlag(cl::ReallyHidden);
2148   }
2149 }
2150 
2151 void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories,
2152                               SubCommand &Sub) {
2153   auto CategoriesBegin = Categories.begin();
2154   auto CategoriesEnd = Categories.end();
2155   for (auto &I : Sub.OptionsMap) {
2156     if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
2157             CategoriesEnd &&
2158         I.second->Category != &GenericCategory)
2159       I.second->setHiddenFlag(cl::ReallyHidden);
2160   }
2161 }
2162 
2163 void cl::ResetCommandLineParser() { GlobalParser->reset(); }
2164 void cl::ResetAllOptionOccurrences() {
2165   GlobalParser->ResetAllOptionOccurrences();
2166 }
2167 
2168 void LLVMParseCommandLineOptions(int argc, const char *const *argv,
2169                                  const char *Overview) {
2170   llvm::cl::ParseCommandLineOptions(argc, argv, StringRef(Overview),
2171                                     &llvm::nulls());
2172 }
2173