LLVM  7.0.0svn
CommandLine.cpp
Go to the documentation of this file.
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 
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"
31 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/Host.h"
37 #include "llvm/Support/Path.h"
38 #include "llvm/Support/Process.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>;
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() {}
75 void Option::anchor() {}
77 void parser<bool>::anchor() {}
79 void parser<int>::anchor() {}
82 void parser<double>::anchor() {}
83 void parser<float>::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 
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 
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 
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 
346 
348  GlobalParser->addLiteralOption(O, Name);
349 }
350 
352  GlobalParser->MoreHelp.push_back(Help);
353 }
354 
356  GlobalParser->addOption(this);
357  FullyInitialized = true;
358 }
359 
360 void Option::removeArgument() { GlobalParser->removeOption(this); }
361 
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
378 
379 // A special subcommand that can be used to put an option into all subcommands.
381 
383  GlobalParser->registerSubCommand(this);
384 }
385 
387  GlobalParser->unregisterSubCommand(this);
388 }
389 
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.
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 *
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.
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 ||
684 }
685 
686 static bool EatsUnboundedNumberOfValues(const Option *O) {
687  return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
689 }
690 
691 static inline 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 
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 
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 
878  bool MarkEOLs) {
879  for (const char *Cur = Source.begin(); Cur != Source.end();) {
880  SmallString<128> Line;
881  // Check for comment line.
882  if (isWhitespace(*Cur)) {
883  while (Cur != Source.end() && isWhitespace(*Cur))
884  ++Cur;
885  continue;
886  }
887  if (*Cur == '#') {
888  while (Cur != Source.end() && *Cur != '\n')
889  ++Cur;
890  continue;
891  }
892  // Find end of the current line.
893  const char *Start = Cur;
894  for (const char *End = Source.end(); Cur != End; ++Cur) {
895  if (*Cur == '\\') {
896  if (Cur + 1 != End) {
897  ++Cur;
898  if (*Cur == '\n' ||
899  (*Cur == '\r' && (Cur + 1 != End) && Cur[1] == '\n')) {
900  Line.append(Start, Cur - 1);
901  if (*Cur == '\r')
902  ++Cur;
903  Start = Cur + 1;
904  }
905  }
906  } else if (*Cur == '\n')
907  break;
908  }
909  // Tokenize line.
910  Line.append(Start, Cur);
911  cl::TokenizeGNUCommandLine(Line, Saver, NewArgv, MarkEOLs);
912  }
913 }
914 
915 // It is called byte order marker but the UTF-8 BOM is actually not affected
916 // by the host system's endianness.
918  return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
919 }
920 
921 static bool ExpandResponseFile(StringRef FName, StringSaver &Saver,
922  TokenizerCallback Tokenizer,
924  bool MarkEOLs, bool RelativeNames) {
926  MemoryBuffer::getFile(FName);
927  if (!MemBufOrErr)
928  return false;
929  MemoryBuffer &MemBuf = *MemBufOrErr.get();
930  StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
931 
932  // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
933  ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
934  std::string UTF8Buf;
935  if (hasUTF16ByteOrderMark(BufRef)) {
936  if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
937  return false;
938  Str = StringRef(UTF8Buf);
939  }
940  // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
941  // these bytes before parsing.
942  // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
943  else if (hasUTF8ByteOrderMark(BufRef))
944  Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
945 
946  // Tokenize the contents into NewArgv.
947  Tokenizer(Str, Saver, NewArgv, MarkEOLs);
948 
949  // If names of nested response files should be resolved relative to including
950  // file, replace the included response file names with their full paths
951  // obtained by required resolution.
952  if (RelativeNames)
953  for (unsigned I = 0; I < NewArgv.size(); ++I)
954  if (NewArgv[I]) {
955  StringRef Arg = NewArgv[I];
956  if (Arg.front() == '@') {
957  StringRef FileName = Arg.drop_front();
958  if (llvm::sys::path::is_relative(FileName)) {
959  SmallString<128> ResponseFile;
960  ResponseFile.append(1, '@');
961  if (llvm::sys::path::is_relative(FName)) {
962  SmallString<128> curr_dir;
963  llvm::sys::fs::current_path(curr_dir);
964  ResponseFile.append(curr_dir.str());
965  }
967  ResponseFile, llvm::sys::path::parent_path(FName), FileName);
968  NewArgv[I] = Saver.save(ResponseFile.c_str()).data();
969  }
970  }
971  }
972 
973  return true;
974 }
975 
976 /// \brief Expand response files on a command line recursively using the given
977 /// StringSaver and tokenization strategy.
980  bool MarkEOLs, bool RelativeNames) {
981  unsigned RspFiles = 0;
982  bool AllExpanded = true;
983 
984  // Don't cache Argv.size() because it can change.
985  for (unsigned I = 0; I != Argv.size();) {
986  const char *Arg = Argv[I];
987  // Check if it is an EOL marker
988  if (Arg == nullptr) {
989  ++I;
990  continue;
991  }
992  if (Arg[0] != '@') {
993  ++I;
994  continue;
995  }
996 
997  // If we have too many response files, leave some unexpanded. This avoids
998  // crashing on self-referential response files.
999  if (RspFiles++ > 20)
1000  return false;
1001 
1002  // Replace this response file argument with the tokenization of its
1003  // contents. Nested response files are expanded in subsequent iterations.
1004  SmallVector<const char *, 0> ExpandedArgv;
1005  if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
1006  MarkEOLs, RelativeNames)) {
1007  // We couldn't read this file, so we leave it in the argument stream and
1008  // move on.
1009  AllExpanded = false;
1010  ++I;
1011  continue;
1012  }
1013  Argv.erase(Argv.begin() + I);
1014  Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
1015  }
1016  return AllExpanded;
1017 }
1018 
1021  if (!ExpandResponseFile(CfgFile, Saver, cl::tokenizeConfigFile, Argv,
1022  /*MarkEOLs*/ false, /*RelativeNames*/ true))
1023  return false;
1024  return ExpandResponseFiles(Saver, cl::tokenizeConfigFile, Argv,
1025  /*MarkEOLs*/ false, /*RelativeNames*/ true);
1026 }
1027 
1028 /// ParseEnvironmentOptions - An alternative entry point to the
1029 /// CommandLine library, which allows you to read the program's name
1030 /// from the caller (as PROGNAME) and its command-line arguments from
1031 /// an environment variable (whose name is given in ENVVAR).
1032 ///
1033 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
1034  const char *Overview) {
1035  // Check args.
1036  assert(progName && "Program name not specified");
1037  assert(envVar && "Environment variable name missing");
1038 
1039  // Get the environment variable they want us to parse options out of.
1041  if (!envValue)
1042  return;
1043 
1044  // Get program's "name", which we wouldn't know without the caller
1045  // telling us.
1047  BumpPtrAllocator A;
1048  StringSaver Saver(A);
1049  newArgv.push_back(Saver.save(progName).data());
1050 
1051  // Parse the value of the environment variable into a "command line"
1052  // and hand it off to ParseCommandLineOptions().
1053  TokenizeGNUCommandLine(*envValue, Saver, newArgv);
1054  int newArgc = static_cast<int>(newArgv.size());
1055  ParseCommandLineOptions(newArgc, &newArgv[0], StringRef(Overview));
1056 }
1057 
1058 bool cl::ParseCommandLineOptions(int argc, const char *const *argv,
1059  StringRef Overview, raw_ostream *Errs) {
1060  return GlobalParser->ParseCommandLineOptions(argc, argv, Overview,
1061  Errs);
1062 }
1063 
1065  // So that we can parse different command lines multiple times in succession
1066  // we reset all option values to look like they have never been seen before.
1067  for (auto SC : RegisteredSubCommands) {
1068  for (auto &O : SC->OptionsMap)
1069  O.second->reset();
1070  }
1071 }
1072 
1074  const char *const *argv,
1075  StringRef Overview,
1076  raw_ostream *Errs) {
1077  assert(hasOptions() && "No options specified!");
1078 
1079  // Expand response files.
1080  SmallVector<const char *, 20> newArgv(argv, argv + argc);
1081  BumpPtrAllocator A;
1082  StringSaver Saver(A);
1084  argv = &newArgv[0];
1085  argc = static_cast<int>(newArgv.size());
1086 
1087  // Copy the program name into ProgName, making sure not to overflow it.
1088  ProgramName = sys::path::filename(StringRef(argv[0]));
1089 
1090  ProgramOverview = Overview;
1091  bool IgnoreErrors = Errs;
1092  if (!Errs)
1093  Errs = &errs();
1094  bool ErrorParsing = false;
1095 
1096  // Check out the positional arguments to collect information about them.
1097  unsigned NumPositionalRequired = 0;
1098 
1099  // Determine whether or not there are an unlimited number of positionals
1100  bool HasUnlimitedPositionals = false;
1101 
1102  int FirstArg = 1;
1103  SubCommand *ChosenSubCommand = &*TopLevelSubCommand;
1104  if (argc >= 2 && argv[FirstArg][0] != '-') {
1105  // If the first argument specifies a valid subcommand, start processing
1106  // options from the second argument.
1107  ChosenSubCommand = LookupSubCommand(StringRef(argv[FirstArg]));
1108  if (ChosenSubCommand != &*TopLevelSubCommand)
1109  FirstArg = 2;
1110  }
1111  GlobalParser->ActiveSubCommand = ChosenSubCommand;
1112 
1113  assert(ChosenSubCommand);
1114  auto &ConsumeAfterOpt = ChosenSubCommand->ConsumeAfterOpt;
1115  auto &PositionalOpts = ChosenSubCommand->PositionalOpts;
1116  auto &SinkOpts = ChosenSubCommand->SinkOpts;
1117  auto &OptionsMap = ChosenSubCommand->OptionsMap;
1118 
1119  if (ConsumeAfterOpt) {
1120  assert(PositionalOpts.size() > 0 &&
1121  "Cannot specify cl::ConsumeAfter without a positional argument!");
1122  }
1123  if (!PositionalOpts.empty()) {
1124 
1125  // Calculate how many positional values are _required_.
1126  bool UnboundedFound = false;
1127  for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1128  Option *Opt = PositionalOpts[i];
1129  if (RequiresValue(Opt))
1130  ++NumPositionalRequired;
1131  else if (ConsumeAfterOpt) {
1132  // ConsumeAfter cannot be combined with "optional" positional options
1133  // unless there is only one positional argument...
1134  if (PositionalOpts.size() > 1) {
1135  if (!IgnoreErrors)
1136  Opt->error("error - this positional option will never be matched, "
1137  "because it does not Require a value, and a "
1138  "cl::ConsumeAfter option is active!");
1139  ErrorParsing = true;
1140  }
1141  } else if (UnboundedFound && !Opt->hasArgStr()) {
1142  // This option does not "require" a value... Make sure this option is
1143  // not specified after an option that eats all extra arguments, or this
1144  // one will never get any!
1145  //
1146  if (!IgnoreErrors)
1147  Opt->error("error - option can never match, because "
1148  "another positional argument will match an "
1149  "unbounded number of values, and this option"
1150  " does not require a value!");
1151  *Errs << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr
1152  << "' is all messed up!\n";
1153  *Errs << PositionalOpts.size();
1154  ErrorParsing = true;
1155  }
1156  UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
1157  }
1158  HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
1159  }
1160 
1161  // PositionalVals - A vector of "positional" arguments we accumulate into
1162  // the process at the end.
1163  //
1164  SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
1165 
1166  // If the program has named positional arguments, and the name has been run
1167  // across, keep track of which positional argument was named. Otherwise put
1168  // the positional args into the PositionalVals list...
1169  Option *ActivePositionalArg = nullptr;
1170 
1171  // Loop over all of the arguments... processing them.
1172  bool DashDashFound = false; // Have we read '--'?
1173  for (int i = FirstArg; i < argc; ++i) {
1174  Option *Handler = nullptr;
1175  Option *NearestHandler = nullptr;
1176  std::string NearestHandlerString;
1177  StringRef Value;
1178  StringRef ArgName = "";
1179 
1180  // Check to see if this is a positional argument. This argument is
1181  // considered to be positional if it doesn't start with '-', if it is "-"
1182  // itself, or if we have seen "--" already.
1183  //
1184  if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
1185  // Positional argument!
1186  if (ActivePositionalArg) {
1187  ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
1188  continue; // We are done!
1189  }
1190 
1191  if (!PositionalOpts.empty()) {
1192  PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
1193 
1194  // All of the positional arguments have been fulfulled, give the rest to
1195  // the consume after option... if it's specified...
1196  //
1197  if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
1198  for (++i; i < argc; ++i)
1199  PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
1200  break; // Handle outside of the argument processing loop...
1201  }
1202 
1203  // Delay processing positional arguments until the end...
1204  continue;
1205  }
1206  } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
1207  !DashDashFound) {
1208  DashDashFound = true; // This is the mythical "--"?
1209  continue; // Don't try to process it as an argument itself.
1210  } else if (ActivePositionalArg &&
1211  (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
1212  // If there is a positional argument eating options, check to see if this
1213  // option is another positional argument. If so, treat it as an argument,
1214  // otherwise feed it to the eating positional.
1215  ArgName = StringRef(argv[i] + 1);
1216  // Eat leading dashes.
1217  while (!ArgName.empty() && ArgName[0] == '-')
1218  ArgName = ArgName.substr(1);
1219 
1220  Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
1221  if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
1222  ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
1223  continue; // We are done!
1224  }
1225 
1226  } else { // We start with a '-', must be an argument.
1227  ArgName = StringRef(argv[i] + 1);
1228  // Eat leading dashes.
1229  while (!ArgName.empty() && ArgName[0] == '-')
1230  ArgName = ArgName.substr(1);
1231 
1232  Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
1233 
1234  // Check to see if this "option" is really a prefixed or grouped argument.
1235  if (!Handler)
1236  Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
1237  OptionsMap);
1238 
1239  // Otherwise, look for the closest available option to report to the user
1240  // in the upcoming error.
1241  if (!Handler && SinkOpts.empty())
1242  NearestHandler =
1243  LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
1244  }
1245 
1246  if (!Handler) {
1247  if (SinkOpts.empty()) {
1248  *Errs << ProgramName << ": Unknown command line argument '" << argv[i]
1249  << "'. Try: '" << argv[0] << " -help'\n";
1250 
1251  if (NearestHandler) {
1252  // If we know a near match, report it as well.
1253  *Errs << ProgramName << ": Did you mean '-" << NearestHandlerString
1254  << "'?\n";
1255  }
1256 
1257  ErrorParsing = true;
1258  } else {
1259  for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
1260  E = SinkOpts.end();
1261  I != E; ++I)
1262  (*I)->addOccurrence(i, "", StringRef(argv[i]));
1263  }
1264  continue;
1265  }
1266 
1267  // If this is a named positional argument, just remember that it is the
1268  // active one...
1269  if (Handler->getFormattingFlag() == cl::Positional)
1270  ActivePositionalArg = Handler;
1271  else
1272  ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
1273  }
1274 
1275  // Check and handle positional arguments now...
1276  if (NumPositionalRequired > PositionalVals.size()) {
1277  *Errs << ProgramName
1278  << ": Not enough positional command line arguments specified!\n"
1279  << "Must specify at least " << NumPositionalRequired
1280  << " positional argument" << (NumPositionalRequired > 1 ? "s" : "")
1281  << ": See: " << argv[0] << " -help\n";
1282 
1283  ErrorParsing = true;
1284  } else if (!HasUnlimitedPositionals &&
1285  PositionalVals.size() > PositionalOpts.size()) {
1286  *Errs << ProgramName << ": Too many positional arguments specified!\n"
1287  << "Can specify at most " << PositionalOpts.size()
1288  << " positional arguments: See: " << argv[0] << " -help\n";
1289  ErrorParsing = true;
1290 
1291  } else if (!ConsumeAfterOpt) {
1292  // Positional args have already been handled if ConsumeAfter is specified.
1293  unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1294  for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1295  if (RequiresValue(PositionalOpts[i])) {
1296  ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
1297  PositionalVals[ValNo].second);
1298  ValNo++;
1299  --NumPositionalRequired; // We fulfilled our duty...
1300  }
1301 
1302  // If we _can_ give this option more arguments, do so now, as long as we
1303  // do not give it values that others need. 'Done' controls whether the
1304  // option even _WANTS_ any more.
1305  //
1306  bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
1307  while (NumVals - ValNo > NumPositionalRequired && !Done) {
1308  switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
1309  case cl::Optional:
1310  Done = true; // Optional arguments want _at most_ one value
1312  case cl::ZeroOrMore: // Zero or more will take all they can get...
1313  case cl::OneOrMore: // One or more will take all they can get...
1314  ProvidePositionalOption(PositionalOpts[i],
1315  PositionalVals[ValNo].first,
1316  PositionalVals[ValNo].second);
1317  ValNo++;
1318  break;
1319  default:
1320  llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
1321  "positional argument processing!");
1322  }
1323  }
1324  }
1325  } else {
1326  assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1327  unsigned ValNo = 0;
1328  for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
1329  if (RequiresValue(PositionalOpts[j])) {
1330  ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
1331  PositionalVals[ValNo].first,
1332  PositionalVals[ValNo].second);
1333  ValNo++;
1334  }
1335 
1336  // Handle the case where there is just one positional option, and it's
1337  // optional. In this case, we want to give JUST THE FIRST option to the
1338  // positional option and keep the rest for the consume after. The above
1339  // loop would have assigned no values to positional options in this case.
1340  //
1341  if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1342  ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
1343  PositionalVals[ValNo].first,
1344  PositionalVals[ValNo].second);
1345  ValNo++;
1346  }
1347 
1348  // Handle over all of the rest of the arguments to the
1349  // cl::ConsumeAfter command line option...
1350  for (; ValNo != PositionalVals.size(); ++ValNo)
1351  ErrorParsing |=
1352  ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1353  PositionalVals[ValNo].second);
1354  }
1355 
1356  // Loop over args and make sure all required args are specified!
1357  for (const auto &Opt : OptionsMap) {
1358  switch (Opt.second->getNumOccurrencesFlag()) {
1359  case Required:
1360  case OneOrMore:
1361  if (Opt.second->getNumOccurrences() == 0) {
1362  Opt.second->error("must be specified at least once!");
1363  ErrorParsing = true;
1364  }
1366  default:
1367  break;
1368  }
1369  }
1370 
1371  // Now that we know if -debug is specified, we can use it.
1372  // Note that if ReadResponseFiles == true, this must be done before the
1373  // memory allocated for the expanded command line is free()d below.
1374  DEBUG(dbgs() << "Args: ";
1375  for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1376  dbgs() << '\n';);
1377 
1378  // Free all of the memory allocated to the map. Command line options may only
1379  // be processed once!
1380  MoreHelp.clear();
1381 
1382  // If we had an error processing our arguments, don't let the program execute
1383  if (ErrorParsing) {
1384  if (!IgnoreErrors)
1385  exit(1);
1386  return false;
1387  }
1388  return true;
1389 }
1390 
1391 //===----------------------------------------------------------------------===//
1392 // Option Base class implementation
1393 //
1394 
1395 bool Option::error(const Twine &Message, StringRef ArgName) {
1396  if (!ArgName.data())
1397  ArgName = ArgStr;
1398  if (ArgName.empty())
1399  errs() << HelpStr; // Be nice for positional arguments
1400  else
1401  errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
1402 
1403  errs() << " option: " << Message << "\n";
1404  return true;
1405 }
1406 
1407 bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1408  bool MultiArg) {
1409  if (!MultiArg)
1410  NumOccurrences++; // Increment the number of times we have been seen
1411 
1412  switch (getNumOccurrencesFlag()) {
1413  case Optional:
1414  if (NumOccurrences > 1)
1415  return error("may only occur zero or one times!", ArgName);
1416  break;
1417  case Required:
1418  if (NumOccurrences > 1)
1419  return error("must occur exactly one time!", ArgName);
1421  case OneOrMore:
1422  case ZeroOrMore:
1423  case ConsumeAfter:
1424  break;
1425  }
1426 
1427  return handleOccurrence(pos, ArgName, Value);
1428 }
1429 
1430 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
1431 // has been specified yet.
1432 //
1433 static StringRef getValueStr(const Option &O, StringRef DefaultMsg) {
1434  if (O.ValueStr.empty())
1435  return DefaultMsg;
1436  return O.ValueStr;
1437 }
1438 
1439 //===----------------------------------------------------------------------===//
1440 // cl::alias class implementation
1441 //
1442 
1443 // Return the width of the option tag for printing...
1444 size_t alias::getOptionWidth() const { return ArgStr.size() + 6; }
1445 
1446 void Option::printHelpStr(StringRef HelpStr, size_t Indent,
1447  size_t FirstLineIndentedBy) {
1448  std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1449  outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1450  while (!Split.second.empty()) {
1451  Split = Split.second.split('\n');
1452  outs().indent(Indent) << Split.first << "\n";
1453  }
1454 }
1455 
1456 // Print out the option for the alias.
1457 void alias::printOptionInfo(size_t GlobalWidth) const {
1458  outs() << " -" << ArgStr;
1459  printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
1460 }
1461 
1462 //===----------------------------------------------------------------------===//
1463 // Parser Implementation code...
1464 //
1465 
1466 // basic_parser implementation
1467 //
1468 
1469 // Return the width of the option tag for printing...
1471  size_t Len = O.ArgStr.size();
1472  auto ValName = getValueName();
1473  if (!ValName.empty())
1474  Len += getValueStr(O, ValName).size() + 3;
1475 
1476  return Len + 6;
1477 }
1478 
1479 // printOptionInfo - Print out information about this option. The
1480 // to-be-maintained width is specified.
1481 //
1483  size_t GlobalWidth) const {
1484  outs() << " -" << O.ArgStr;
1485 
1486  auto ValName = getValueName();
1487  if (!ValName.empty())
1488  outs() << "=<" << getValueStr(O, ValName) << '>';
1489 
1490  Option::printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1491 }
1492 
1494  size_t GlobalWidth) const {
1495  outs() << " -" << O.ArgStr;
1496  outs().indent(GlobalWidth - O.ArgStr.size());
1497 }
1498 
1499 // parser<bool> implementation
1500 //
1501 bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1502  bool &Value) {
1503  if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1504  Arg == "1") {
1505  Value = true;
1506  return false;
1507  }
1508 
1509  if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1510  Value = false;
1511  return false;
1512  }
1513  return O.error("'" + Arg +
1514  "' is invalid value for boolean argument! Try 0 or 1");
1515 }
1516 
1517 // parser<boolOrDefault> implementation
1518 //
1520  boolOrDefault &Value) {
1521  if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1522  Arg == "1") {
1523  Value = BOU_TRUE;
1524  return false;
1525  }
1526  if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1527  Value = BOU_FALSE;
1528  return false;
1529  }
1530 
1531  return O.error("'" + Arg +
1532  "' is invalid value for boolean argument! Try 0 or 1");
1533 }
1534 
1535 // parser<int> implementation
1536 //
1537 bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1538  int &Value) {
1539  if (Arg.getAsInteger(0, Value))
1540  return O.error("'" + Arg + "' value invalid for integer argument!");
1541  return false;
1542 }
1543 
1544 // parser<unsigned> implementation
1545 //
1546 bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1547  unsigned &Value) {
1548 
1549  if (Arg.getAsInteger(0, Value))
1550  return O.error("'" + Arg + "' value invalid for uint argument!");
1551  return false;
1552 }
1553 
1554 // parser<unsigned long long> implementation
1555 //
1557  StringRef Arg,
1558  unsigned long long &Value) {
1559 
1560  if (Arg.getAsInteger(0, Value))
1561  return O.error("'" + Arg + "' value invalid for uint argument!");
1562  return false;
1563 }
1564 
1565 // parser<double>/parser<float> implementation
1566 //
1567 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1568  if (to_float(Arg, Value))
1569  return false;
1570  return O.error("'" + Arg + "' value invalid for floating point argument!");
1571 }
1572 
1573 bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1574  double &Val) {
1575  return parseDouble(O, Arg, Val);
1576 }
1577 
1578 bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1579  float &Val) {
1580  double dVal;
1581  if (parseDouble(O, Arg, dVal))
1582  return true;
1583  Val = (float)dVal;
1584  return false;
1585 }
1586 
1587 // generic_parser_base implementation
1588 //
1589 
1590 // findOption - Return the option number corresponding to the specified
1591 // argument string. If the option is not found, getNumOptions() is returned.
1592 //
1594  unsigned e = getNumOptions();
1595 
1596  for (unsigned i = 0; i != e; ++i) {
1597  if (getOption(i) == Name)
1598  return i;
1599  }
1600  return e;
1601 }
1602 
1603 // Return the width of the option tag for printing...
1605  if (O.hasArgStr()) {
1606  size_t Size = O.ArgStr.size() + 6;
1607  for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1608  Size = std::max(Size, getOption(i).size() + 8);
1609  return Size;
1610  } else {
1611  size_t BaseSize = 0;
1612  for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1613  BaseSize = std::max(BaseSize, getOption(i).size() + 8);
1614  return BaseSize;
1615  }
1616 }
1617 
1618 // printOptionInfo - Print out information about this option. The
1619 // to-be-maintained width is specified.
1620 //
1622  size_t GlobalWidth) const {
1623  if (O.hasArgStr()) {
1624  outs() << " -" << O.ArgStr;
1625  Option::printHelpStr(O.HelpStr, GlobalWidth, O.ArgStr.size() + 6);
1626 
1627  for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1628  size_t NumSpaces = GlobalWidth - getOption(i).size() - 8;
1629  outs() << " =" << getOption(i);
1630  outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1631  }
1632  } else {
1633  if (!O.HelpStr.empty())
1634  outs() << " " << O.HelpStr << '\n';
1635  for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1636  auto Option = getOption(i);
1637  outs() << " -" << Option;
1638  Option::printHelpStr(getDescription(i), GlobalWidth, Option.size() + 8);
1639  }
1640  }
1641 }
1642 
1643 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1644 
1645 // printGenericOptionDiff - Print the value of this option and it's default.
1646 //
1647 // "Generic" options have each value mapped to a name.
1649  const Option &O, const GenericOptionValue &Value,
1650  const GenericOptionValue &Default, size_t GlobalWidth) const {
1651  outs() << " -" << O.ArgStr;
1652  outs().indent(GlobalWidth - O.ArgStr.size());
1653 
1654  unsigned NumOpts = getNumOptions();
1655  for (unsigned i = 0; i != NumOpts; ++i) {
1656  if (Value.compare(getOptionValue(i)))
1657  continue;
1658 
1659  outs() << "= " << getOption(i);
1660  size_t L = getOption(i).size();
1661  size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1662  outs().indent(NumSpaces) << " (default: ";
1663  for (unsigned j = 0; j != NumOpts; ++j) {
1664  if (Default.compare(getOptionValue(j)))
1665  continue;
1666  outs() << getOption(j);
1667  break;
1668  }
1669  outs() << ")\n";
1670  return;
1671  }
1672  outs() << "= *unknown option value*\n";
1673 }
1674 
1675 // printOptionDiff - Specializations for printing basic value types.
1676 //
1677 #define PRINT_OPT_DIFF(T) \
1678  void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1679  size_t GlobalWidth) const { \
1680  printOptionName(O, GlobalWidth); \
1681  std::string Str; \
1682  { \
1683  raw_string_ostream SS(Str); \
1684  SS << V; \
1685  } \
1686  outs() << "= " << Str; \
1687  size_t NumSpaces = \
1688  MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
1689  outs().indent(NumSpaces) << " (default: "; \
1690  if (D.hasValue()) \
1691  outs() << D.getValue(); \
1692  else \
1693  outs() << "*no default*"; \
1694  outs() << ")\n"; \
1695  }
1696 
1697 PRINT_OPT_DIFF(bool)
1699 PRINT_OPT_DIFF(int)
1700 PRINT_OPT_DIFF(unsigned)
1701 PRINT_OPT_DIFF(unsigned long long)
1702 PRINT_OPT_DIFF(double)
1703 PRINT_OPT_DIFF(float)
1704 PRINT_OPT_DIFF(char)
1705 
1707  const OptionValue<std::string> &D,
1708  size_t GlobalWidth) const {
1709  printOptionName(O, GlobalWidth);
1710  outs() << "= " << V;
1711  size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1712  outs().indent(NumSpaces) << " (default: ";
1713  if (D.hasValue())
1714  outs() << D.getValue();
1715  else
1716  outs() << "*no default*";
1717  outs() << ")\n";
1718 }
1719 
1720 // Print a placeholder for options that don't yet support printOptionDiff().
1722  size_t GlobalWidth) const {
1723  printOptionName(O, GlobalWidth);
1724  outs() << "= *cannot print option value*\n";
1725 }
1726 
1727 //===----------------------------------------------------------------------===//
1728 // -help and -help-hidden option implementation
1729 //
1730 
1731 static int OptNameCompare(const std::pair<const char *, Option *> *LHS,
1732  const std::pair<const char *, Option *> *RHS) {
1733  return strcmp(LHS->first, RHS->first);
1734 }
1735 
1736 static int SubNameCompare(const std::pair<const char *, SubCommand *> *LHS,
1737  const std::pair<const char *, SubCommand *> *RHS) {
1738  return strcmp(LHS->first, RHS->first);
1739 }
1740 
1741 // Copy Options into a vector so we can sort them as we like.
1742 static void sortOpts(StringMap<Option *> &OptMap,
1743  SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1744  bool ShowHidden) {
1745  SmallPtrSet<Option *, 32> OptionSet; // Duplicate option detection.
1746 
1747  for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
1748  I != E; ++I) {
1749  // Ignore really-hidden options.
1750  if (I->second->getOptionHiddenFlag() == ReallyHidden)
1751  continue;
1752 
1753  // Unless showhidden is set, ignore hidden flags.
1754  if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1755  continue;
1756 
1757  // If we've already seen this option, don't add it to the list again.
1758  if (!OptionSet.insert(I->second).second)
1759  continue;
1760 
1761  Opts.push_back(
1762  std::pair<const char *, Option *>(I->getKey().data(), I->second));
1763  }
1764 
1765  // Sort the options list alphabetically.
1766  array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare);
1767 }
1768 
1769 static void
1771  SmallVectorImpl<std::pair<const char *, SubCommand *>> &Subs) {
1772  for (const auto &S : SubMap) {
1773  if (S->getName().empty())
1774  continue;
1775  Subs.push_back(std::make_pair(S->getName().data(), S));
1776  }
1777  array_pod_sort(Subs.begin(), Subs.end(), SubNameCompare);
1778 }
1779 
1780 namespace {
1781 
1782 class HelpPrinter {
1783 protected:
1784  const bool ShowHidden;
1786  StrOptionPairVector;
1788  StrSubCommandPairVector;
1789  // Print the options. Opts is assumed to be alphabetically sorted.
1790  virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1791  for (size_t i = 0, e = Opts.size(); i != e; ++i)
1792  Opts[i].second->printOptionInfo(MaxArgLen);
1793  }
1794 
1795  void printSubCommands(StrSubCommandPairVector &Subs, size_t MaxSubLen) {
1796  for (const auto &S : Subs) {
1797  outs() << " " << S.first;
1798  if (!S.second->getDescription().empty()) {
1799  outs().indent(MaxSubLen - strlen(S.first));
1800  outs() << " - " << S.second->getDescription();
1801  }
1802  outs() << "\n";
1803  }
1804  }
1805 
1806 public:
1807  explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
1808  virtual ~HelpPrinter() {}
1809 
1810  // Invoke the printer.
1811  void operator=(bool Value) {
1812  if (!Value)
1813  return;
1814  printHelp();
1815 
1816  // Halt the program since help information was printed
1817  exit(0);
1818  }
1819 
1820  void printHelp() {
1821  SubCommand *Sub = GlobalParser->getActiveSubCommand();
1822  auto &OptionsMap = Sub->OptionsMap;
1823  auto &PositionalOpts = Sub->PositionalOpts;
1824  auto &ConsumeAfterOpt = Sub->ConsumeAfterOpt;
1825 
1826  StrOptionPairVector Opts;
1827  sortOpts(OptionsMap, Opts, ShowHidden);
1828 
1829  StrSubCommandPairVector Subs;
1830  sortSubCommands(GlobalParser->RegisteredSubCommands, Subs);
1831 
1832  if (!GlobalParser->ProgramOverview.empty())
1833  outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
1834 
1835  if (Sub == &*TopLevelSubCommand) {
1836  outs() << "USAGE: " << GlobalParser->ProgramName;
1837  if (Subs.size() > 2)
1838  outs() << " [subcommand]";
1839  outs() << " [options]";
1840  } else {
1841  if (!Sub->getDescription().empty()) {
1842  outs() << "SUBCOMMAND '" << Sub->getName()
1843  << "': " << Sub->getDescription() << "\n\n";
1844  }
1845  outs() << "USAGE: " << GlobalParser->ProgramName << " " << Sub->getName()
1846  << " [options]";
1847  }
1848 
1849  for (auto Opt : PositionalOpts) {
1850  if (Opt->hasArgStr())
1851  outs() << " --" << Opt->ArgStr;
1852  outs() << " " << Opt->HelpStr;
1853  }
1854 
1855  // Print the consume after option info if it exists...
1856  if (ConsumeAfterOpt)
1857  outs() << " " << ConsumeAfterOpt->HelpStr;
1858 
1859  if (Sub == &*TopLevelSubCommand && !Subs.empty()) {
1860  // Compute the maximum subcommand length...
1861  size_t MaxSubLen = 0;
1862  for (size_t i = 0, e = Subs.size(); i != e; ++i)
1863  MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first));
1864 
1865  outs() << "\n\n";
1866  outs() << "SUBCOMMANDS:\n\n";
1867  printSubCommands(Subs, MaxSubLen);
1868  outs() << "\n";
1869  outs() << " Type \"" << GlobalParser->ProgramName
1870  << " <subcommand> -help\" to get more help on a specific "
1871  "subcommand";
1872  }
1873 
1874  outs() << "\n\n";
1875 
1876  // Compute the maximum argument length...
1877  size_t MaxArgLen = 0;
1878  for (size_t i = 0, e = Opts.size(); i != e; ++i)
1879  MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1880 
1881  outs() << "OPTIONS:\n";
1882  printOptions(Opts, MaxArgLen);
1883 
1884  // Print any extra help the user has declared.
1885  for (auto I : GlobalParser->MoreHelp)
1886  outs() << I;
1887  GlobalParser->MoreHelp.clear();
1888  }
1889 };
1890 
1891 class CategorizedHelpPrinter : public HelpPrinter {
1892 public:
1893  explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1894 
1895  // Helper function for printOptions().
1896  // It shall return a negative value if A's name should be lexicographically
1897  // ordered before B's name. It returns a value greater than zero if B's name
1898  // should be ordered before A's name, and it returns 0 otherwise.
1899  static int OptionCategoryCompare(OptionCategory *const *A,
1900  OptionCategory *const *B) {
1901  return (*A)->getName().compare((*B)->getName());
1902  }
1903 
1904  // Make sure we inherit our base class's operator=()
1905  using HelpPrinter::operator=;
1906 
1907 protected:
1908  void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
1909  std::vector<OptionCategory *> SortedCategories;
1910  std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
1911 
1912  // Collect registered option categories into vector in preparation for
1913  // sorting.
1914  for (auto I = GlobalParser->RegisteredOptionCategories.begin(),
1915  E = GlobalParser->RegisteredOptionCategories.end();
1916  I != E; ++I) {
1917  SortedCategories.push_back(*I);
1918  }
1919 
1920  // Sort the different option categories alphabetically.
1921  assert(SortedCategories.size() > 0 && "No option categories registered!");
1922  array_pod_sort(SortedCategories.begin(), SortedCategories.end(),
1923  OptionCategoryCompare);
1924 
1925  // Create map to empty vectors.
1926  for (std::vector<OptionCategory *>::const_iterator
1927  I = SortedCategories.begin(),
1928  E = SortedCategories.end();
1929  I != E; ++I)
1930  CategorizedOptions[*I] = std::vector<Option *>();
1931 
1932  // Walk through pre-sorted options and assign into categories.
1933  // Because the options are already alphabetically sorted the
1934  // options within categories will also be alphabetically sorted.
1935  for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1936  Option *Opt = Opts[I].second;
1937  assert(CategorizedOptions.count(Opt->Category) > 0 &&
1938  "Option has an unregistered category");
1939  CategorizedOptions[Opt->Category].push_back(Opt);
1940  }
1941 
1942  // Now do printing.
1943  for (std::vector<OptionCategory *>::const_iterator
1944  Category = SortedCategories.begin(),
1945  E = SortedCategories.end();
1946  Category != E; ++Category) {
1947  // Hide empty categories for -help, but show for -help-hidden.
1948  const auto &CategoryOptions = CategorizedOptions[*Category];
1949  bool IsEmptyCategory = CategoryOptions.empty();
1950  if (!ShowHidden && IsEmptyCategory)
1951  continue;
1952 
1953  // Print category information.
1954  outs() << "\n";
1955  outs() << (*Category)->getName() << ":\n";
1956 
1957  // Check if description is set.
1958  if (!(*Category)->getDescription().empty())
1959  outs() << (*Category)->getDescription() << "\n\n";
1960  else
1961  outs() << "\n";
1962 
1963  // When using -help-hidden explicitly state if the category has no
1964  // options associated with it.
1965  if (IsEmptyCategory) {
1966  outs() << " This option category has no options.\n";
1967  continue;
1968  }
1969  // Loop over the options in the category and print.
1970  for (const Option *Opt : CategoryOptions)
1971  Opt->printOptionInfo(MaxArgLen);
1972  }
1973  }
1974 };
1975 
1976 // This wraps the Uncategorizing and Categorizing printers and decides
1977 // at run time which should be invoked.
1978 class HelpPrinterWrapper {
1979 private:
1980  HelpPrinter &UncategorizedPrinter;
1981  CategorizedHelpPrinter &CategorizedPrinter;
1982 
1983 public:
1984  explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1985  CategorizedHelpPrinter &CategorizedPrinter)
1986  : UncategorizedPrinter(UncategorizedPrinter),
1987  CategorizedPrinter(CategorizedPrinter) {}
1988 
1989  // Invoke the printer.
1990  void operator=(bool Value);
1991 };
1992 
1993 } // End anonymous namespace
1994 
1995 // Declare the four HelpPrinter instances that are used to print out help, or
1996 // help-hidden as an uncategorized list or in categories.
1997 static HelpPrinter UncategorizedNormalPrinter(false);
1998 static HelpPrinter UncategorizedHiddenPrinter(true);
1999 static CategorizedHelpPrinter CategorizedNormalPrinter(false);
2000 static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
2001 
2002 // Declare HelpPrinter wrappers that will decide whether or not to invoke
2003 // a categorizing help printer
2004 static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
2005  CategorizedNormalPrinter);
2006 static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
2007  CategorizedHiddenPrinter);
2008 
2009 // Define a category for generic options that all tools should have.
2010 static cl::OptionCategory GenericCategory("Generic Options");
2011 
2012 // Define uncategorized help printers.
2013 // -help-list is hidden by default because if Option categories are being used
2014 // then -help behaves the same as -help-list.
2016  "help-list",
2017  cl::desc("Display list of available options (-help-list-hidden for more)"),
2018  cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
2019  cl::cat(GenericCategory), cl::sub(*AllSubCommands));
2020 
2022  HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
2023  cl::location(UncategorizedHiddenPrinter), cl::Hidden,
2024  cl::ValueDisallowed, cl::cat(GenericCategory),
2026 
2027 // Define uncategorized/categorized help printers. These printers change their
2028 // behaviour at runtime depending on whether one or more Option categories have
2029 // been declared.
2031  HOp("help", cl::desc("Display available options (-help-hidden for more)"),
2032  cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
2033  cl::cat(GenericCategory), cl::sub(*AllSubCommands));
2034 
2036  HHOp("help-hidden", cl::desc("Display all available options"),
2037  cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
2038  cl::cat(GenericCategory), cl::sub(*AllSubCommands));
2039 
2041  "print-options",
2042  cl::desc("Print non-default options after command line parsing"),
2043  cl::Hidden, cl::init(false), cl::cat(GenericCategory),
2045 
2047  "print-all-options",
2048  cl::desc("Print all option values after command line parsing"), cl::Hidden,
2049  cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands));
2050 
2051 void HelpPrinterWrapper::operator=(bool Value) {
2052  if (!Value)
2053  return;
2054 
2055  // Decide which printer to invoke. If more than one option category is
2056  // registered then it is useful to show the categorized help instead of
2057  // uncategorized help.
2058  if (GlobalParser->RegisteredOptionCategories.size() > 1) {
2059  // unhide -help-list option so user can have uncategorized output if they
2060  // want it.
2061  HLOp.setHiddenFlag(NotHidden);
2062 
2063  CategorizedPrinter = true; // Invoke categorized printer
2064  } else
2065  UncategorizedPrinter = true; // Invoke uncategorized printer
2066 }
2067 
2068 // Print the value of each option.
2069 void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
2070 
2071 void CommandLineParser::printOptionValues() {
2072  if (!PrintOptions && !PrintAllOptions)
2073  return;
2074 
2076  sortOpts(ActiveSubCommand->OptionsMap, Opts, /*ShowHidden*/ true);
2077 
2078  // Compute the maximum argument length...
2079  size_t MaxArgLen = 0;
2080  for (size_t i = 0, e = Opts.size(); i != e; ++i)
2081  MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2082 
2083  for (size_t i = 0, e = Opts.size(); i != e; ++i)
2084  Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
2085 }
2086 
2088 
2089 static std::vector<VersionPrinterTy> *ExtraVersionPrinters = nullptr;
2090 
2091 namespace {
2092 class VersionPrinter {
2093 public:
2094  void print() {
2095  raw_ostream &OS = outs();
2096 #ifdef PACKAGE_VENDOR
2097  OS << PACKAGE_VENDOR << " ";
2098 #else
2099  OS << "LLVM (http://llvm.org/):\n ";
2100 #endif
2101  OS << PACKAGE_NAME << " version " << PACKAGE_VERSION;
2102 #ifdef LLVM_VERSION_INFO
2103  OS << " " << LLVM_VERSION_INFO;
2104 #endif
2105  OS << "\n ";
2106 #ifndef __OPTIMIZE__
2107  OS << "DEBUG build";
2108 #else
2109  OS << "Optimized build";
2110 #endif
2111 #ifndef NDEBUG
2112  OS << " with assertions";
2113 #endif
2114 #if LLVM_VERSION_PRINTER_SHOW_HOST_TARGET_INFO
2115  std::string CPU = sys::getHostCPUName();
2116  if (CPU == "generic")
2117  CPU = "(unknown)";
2118  OS << ".\n"
2119  << " Default target: " << sys::getDefaultTargetTriple() << '\n'
2120  << " Host CPU: " << CPU;
2121 #endif
2122  OS << '\n';
2123  }
2124  void operator=(bool OptionWasSpecified) {
2125  if (!OptionWasSpecified)
2126  return;
2127 
2128  if (OverrideVersionPrinter != nullptr) {
2130  exit(0);
2131  }
2132  print();
2133 
2134  // Iterate over any registered extra printers and call them to add further
2135  // information.
2136  if (ExtraVersionPrinters != nullptr) {
2137  outs() << '\n';
2138  for (auto I : *ExtraVersionPrinters)
2139  I(outs());
2140  }
2141 
2142  exit(0);
2143  }
2144 };
2145 } // End anonymous namespace
2146 
2147 // Define the --version option that prints out the LLVM version for the tool
2148 static VersionPrinter VersionPrinterInstance;
2149 
2151  VersOp("version", cl::desc("Display the version of this program"),
2152  cl::location(VersionPrinterInstance), cl::ValueDisallowed,
2153  cl::cat(GenericCategory));
2154 
2155 // Utility function for printing the help message.
2156 void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
2157  if (!Hidden && !Categorized)
2158  UncategorizedNormalPrinter.printHelp();
2159  else if (!Hidden && Categorized)
2160  CategorizedNormalPrinter.printHelp();
2161  else if (Hidden && !Categorized)
2162  UncategorizedHiddenPrinter.printHelp();
2163  else
2164  CategorizedHiddenPrinter.printHelp();
2165 }
2166 
2167 /// Utility function for printing version number.
2168 void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
2169 
2170 void cl::SetVersionPrinter(VersionPrinterTy func) { OverrideVersionPrinter = func; }
2171 
2173  if (!ExtraVersionPrinters)
2174  ExtraVersionPrinters = new std::vector<VersionPrinterTy>;
2175 
2176  ExtraVersionPrinters->push_back(func);
2177 }
2178 
2180  auto &Subs = GlobalParser->RegisteredSubCommands;
2181  (void)Subs;
2182  assert(is_contained(Subs, &Sub));
2183  return Sub.OptionsMap;
2184 }
2185 
2188  return GlobalParser->getRegisteredSubcommands();
2189 }
2190 
2192  for (auto &I : Sub.OptionsMap) {
2193  if (I.second->Category != &Category &&
2194  I.second->Category != &GenericCategory)
2195  I.second->setHiddenFlag(cl::ReallyHidden);
2196  }
2197 }
2198 
2200  SubCommand &Sub) {
2201  auto CategoriesBegin = Categories.begin();
2202  auto CategoriesEnd = Categories.end();
2203  for (auto &I : Sub.OptionsMap) {
2204  if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
2205  CategoriesEnd &&
2206  I.second->Category != &GenericCategory)
2207  I.second->setHiddenFlag(cl::ReallyHidden);
2208  }
2209 }
2210 
2211 void cl::ResetCommandLineParser() { GlobalParser->reset(); }
2213  GlobalParser->ResetAllOptionOccurrences();
2214 }
2215 
2216 void LLVMParseCommandLineOptions(int argc, const char *const *argv,
2217  const char *Overview) {
2218  llvm::cl::ParseCommandLineOptions(argc, argv, StringRef(Overview),
2219  &llvm::nulls());
2220 }
uint64_t CallInst * C
bool hasUTF16ByteOrderMark(ArrayRef< char > SrcBytes)
Returns true if a blob of text starts with a UTF-16 big or little endian byte order mark...
bool isPositional() const
Definition: CommandLine.h:293
void ResetCommandLineParser()
Reset the command line parser back to its initial state.
Represents either an error or a value T.
Definition: ErrorOr.h:69
static bool isQuote(char C)
enum ValueExpected getValueExpectedFlag() const
Definition: CommandLine.h:275
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
OptionCategory GeneralCategory
static void sortOpts(StringMap< Option *> &OptMap, SmallVectorImpl< std::pair< const char *, Option *>> &Opts, bool ShowHidden)
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
static void Help(ArrayRef< SubtargetFeatureKV > CPUTable, ArrayRef< SubtargetFeatureKV > FeatTable)
Display help for feature choices.
static bool isPrefixedOrGrouping(const Option *O)
static bool parseDouble(Option &O, StringRef Arg, double &Value)
LLVM_ATTRIBUTE_NORETURN void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
Definition: Error.cpp:115
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
static int OptNameCompare(const std::pair< const char *, Option *> *LHS, const std::pair< const char *, Option *> *RHS)
static bool isGrouping(const Option *O)
static cl::opt< bool > PrintAllOptions("print-all-options", cl::desc("Print all option values after command line parsing"), cl::Hidden, cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands))
static void printHelpStr(StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
iterator begin() const
Definition: ArrayRef.h:138
LLVM_ATTRIBUTE_ALWAYS_INLINE size_type size() const
Definition: SmallVector.h:136
bool isConsumeAfter() const
Definition: CommandLine.h:296
void setArgStr(StringRef S)
void PrintVersionMessage()
Utility function for printing version number.
static cl::opt< VersionPrinter, true, parser< bool > > VersOp("version", cl::desc("Display the version of this program"), cl::location(VersionPrinterInstance), cl::ValueDisallowed, cl::cat(GenericCategory))
extrahelp(StringRef help)
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE size_t size() const
size - Get the string size.
Definition: StringRef.h:138
std::string getDefaultTargetTriple()
getDefaultTargetTriple() - Return the default target triple the compiler has been configured to produ...
raw_ostream & indent(unsigned NumSpaces)
indent - Insert &#39;NumSpaces&#39; spaces.
#define PRINT_OPT_DIFF(T)
void ResetAllOptionOccurrences()
Reset all command line options to a state that looks as if they have never appeared on the command li...
size_t getOptionWidth(const Option &O) const
iterator find(StringRef Key)
Definition: StringMap.h:335
enum NumOccurrencesFlag getNumOccurrencesFlag() const
Definition: CommandLine.h:271
void tokenizeConfigFile(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char *> &NewArgv, bool MarkEOLs=false)
Tokenizes content of configuration file.
std::error_code current_path(SmallVectorImpl< char > &result)
Get the current path.
auto count_if(R &&Range, UnaryPredicate P) -> typename std::iterator_traits< decltype(adl_begin(Range))>::difference_type
Wrapper function around std::count_if to count the number of times an element satisfying a given pred...
Definition: STLExtras.h:888
unsigned second
#define error(X)
void ParseEnvironmentOptions(const char *progName, const char *envvar, const char *Overview="")
ParseEnvironmentOptions - An alternative entry point to the CommandLine library, which allows you to ...
size_t getBufferSize() const
Definition: MemoryBuffer.h:61
SmallVector< Option *, 4 > SinkOpts
Definition: CommandLine.h:218
static HelpPrinter UncategorizedHiddenPrinter(true)
LLVM_NODISCARD unsigned edit_distance(StringRef Other, bool AllowReplacements=true, unsigned MaxEditDistance=0) const
Determine the edit distance between this string and another string.
Definition: StringRef.cpp:95
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:128
static cl::opt< HelpPrinter, true, parser< bool > > HLHOp("help-list-hidden", cl::desc("Display list of all available options"), cl::location(UncategorizedHiddenPrinter), cl::Hidden, cl::ValueDisallowed, cl::cat(GenericCategory), cl::sub(*AllSubCommands))
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:344
void printOptionInfo(const Option &O, size_t GlobalWidth) const
StringMap< Option * > & getRegisteredOptions(SubCommand &Sub= *TopLevelSubCommand)
Use this to get a StringMap to all registered named options (e.g.
bool readConfigFile(StringRef CfgFileName, StringSaver &Saver, SmallVectorImpl< const char *> &Argv)
Reads command line options from the given configuration file.
static StringRef getValueStr(const Option &O, StringRef DefaultMsg)
static cl::opt< HelpPrinter, true, parser< bool > > HLOp("help-list", cl::desc("Display list of available options (-help-list-hidden for more)"), cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed, cl::cat(GenericCategory), cl::sub(*AllSubCommands))
void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
Definition: Path.cpp:466
void LLVMParseCommandLineOptions(int argc, const char *const *argv, const char *Overview)
This function parses the given arguments using the LLVM command line parser.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const
static const size_t MaxOptWidth
static VersionPrinter VersionPrinterInstance
static cl::OptionCategory GenericCategory("Generic Options")
void TokenizeWindowsCommandLine(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char *> &NewArgv, bool MarkEOLs=false)
Tokenizes a Windows command line which may contain quotes and escaped quotes.
virtual bool compare(const GenericOptionValue &V) const =0
static Option * LookupNearestOption(StringRef Arg, const StringMap< Option *> &OptionsMap, std::string &NearestString)
LookupNearestOption - Lookup the closest match to the option specified by the specified option on the...
virtual bool addOccurrence(unsigned pos, StringRef ArgName, StringRef Value, bool MultiArg=false)
StringRef str() const
Explicit conversion to StringRef.
Definition: SmallString.h:267
static cl::opt< bool > PrintOptions("print-options", cl::desc("Print non-default options after command line parsing"), cl::Hidden, cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands))
std::function< void(raw_ostream &)> VersionPrinterTy
Definition: CommandLine.h:70
static size_t parseBackslash(StringRef Src, size_t I, SmallString< 128 > &Token)
Backslashes are interpreted in a rather complicated way in the Windows-style command line...
static HelpPrinter UncategorizedNormalPrinter(false)
SmallVector< Option *, 4 > PositionalOpts
Definition: CommandLine.h:217
static ManagedStatic< CommandLineParser > GlobalParser
void printOptionNoValue(const Option &O, size_t GlobalWidth) const
void PrintOptionValues()
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
bool to_float(const Twine &T, float &Num)
Definition: StringExtras.h:181
static bool ExpandResponseFile(StringRef FName, StringSaver &Saver, TokenizerCallback Tokenizer, SmallVectorImpl< const char *> &NewArgv, bool MarkEOLs, bool RelativeNames)
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:33
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:598
void printGenericOptionDiff(const Option &O, const GenericOptionValue &V, const GenericOptionValue &Default, size_t GlobalWidth) const
StringRef getName() const
Definition: CommandLine.h:214
ManagedStatic< SubCommand > AllSubCommands
static std::vector< VersionPrinterTy > * ExtraVersionPrinters
static bool hasUTF8ByteOrderMark(ArrayRef< char > S)
Flag
These should be considered private to the implementation of the MCInstrDesc class.
Definition: MCInstrDesc.h:121
StringMap< Option * > OptionsMap
Definition: CommandLine.h:219
ManagedStatic< SubCommand > TopLevelSubCommand
static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i)
void append(in_iter S, in_iter E)
Append from an iterator pair.
Definition: SmallString.h:75
void HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub= *TopLevelSubCommand)
Mark all options not part of this category as cl::ReallyHidden.
raw_ostream & outs()
This returns a reference to a raw_ostream for standard output.
const DataType & getValue() const
Definition: CommandLine.h:503
static int SubNameCompare(const std::pair< const char *, SubCommand *> *LHS, const std::pair< const char *, SubCommand *> *RHS)
Option * ConsumeAfterOpt
Definition: CommandLine.h:221
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:406
void array_pod_sort(IteratorTy Start, IteratorTy End)
array_pod_sort - This sorts an array with the specified start and end extent.
Definition: STLExtras.h:760
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
size_type count(StringRef Key) const
count - Return 1 if the element is in the map, 0 otherwise.
Definition: StringMap.h:361
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:138
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:150
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
bool parse(Option &O, StringRef ArgName, StringRef Arg, DataType &V)
Definition: CommandLine.h:767
LLVM_ATTRIBUTE_ALWAYS_INLINE iterator begin()
Definition: SmallVector.h:116
unsigned getNumAdditionalVals() const
Definition: CommandLine.h:289
void PrintHelpMessage(bool Hidden=false, bool Categorized=false)
This function just prints the help message, exactly the same way as if the -help or -help-hidden opti...
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:371
StringRef ValueStr
Definition: CommandLine.h:266
static Option * HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value, bool &ErrorParsing, const StringMap< Option *> &OptionsMap)
HandlePrefixedOrGroupedOption - The specified argument string (which started with at least one &#39;-&#39;) d...
void setHiddenFlag(enum OptionHidden Val)
Definition: CommandLine.h:314
static void sortSubCommands(const SmallPtrSetImpl< SubCommand *> &SubMap, SmallVectorImpl< std::pair< const char *, SubCommand *>> &Subs)
OptionCategory * Category
Definition: CommandLine.h:267
static const unsigned End
static bool EatsUnboundedNumberOfValues(const Option *O)
void SetVersionPrinter(VersionPrinterTy func)
===------------------------------------------------------------------—===// SetVersionPrinter - Over...
StringRef getDescription() const
Definition: CommandLine.h:215
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
StringRef parent_path(StringRef path, Style style=Style::native)
Get parent path.
Definition: Path.cpp:477
#define INIT(o, n)
Definition: regexec.c:120
bool isInAllSubCommands() const
Definition: CommandLine.h:300
bool ParseCommandLineOptions(int argc, const char *const *argv, StringRef Overview="", raw_ostream *Errs=nullptr)
static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos, StringRef ArgName, StringRef Value, bool MultiArg=false)
CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence() that does special handling ...
iterator erase(const_iterator CI)
Definition: SmallVector.h:447
auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range))
Provide wrappers to std::find which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:835
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
unsigned first
std::enable_if< std::numeric_limits< T >::is_signed, bool >::type getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
Definition: StringRef.h:497
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE StringRef drop_front(size_t N=1) const
Return a StringRef equal to &#39;this&#39; but with the first N elements dropped.
Definition: StringRef.h:645
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements...
Definition: SmallPtrSet.h:418
bool erase(PtrType Ptr)
erase - If the set contains the specified pointer, remove it and return true, otherwise return false...
Definition: SmallPtrSet.h:378
static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter, CategorizedNormalPrinter)
void TokenizeGNUCommandLine(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char *> &NewArgv, bool MarkEOLs=false)
Tokenizes a command line that can contain escapes and quotes.
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:862
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:727
static ManagedStatic< CodeViewErrorCategory > Category
iterator end() const
Definition: ArrayRef.h:139
CHAIN = SC CHAIN, Imm128 - System call.
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static VersionPrinterTy OverrideVersionPrinter
static bool ProvideOption(Option *Handler, StringRef ArgName, StringRef Value, int argc, const char *const *argv, int &i)
ProvideOption - For Value, this differentiates between an empty value ("") and a null value (StringRe...
void printOptionDiff(const Option &O, const AnyOptionValue &V, const AnyOptionValue &Default, size_t GlobalWidth) const
Definition: CommandLine.h:688
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Definition: MemoryBuffer.h:41
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
StringRef ArgStr
Definition: CommandLine.h:264
A range adaptor for a pair of iterators.
StringMap - This is an unconventional map that is specialized for handling keys that are "strings"...
Definition: StringMap.h:222
static bool isWhitespace(char C)
StringRef save(const char *S)
Definition: StringSaver.h:26
static std::string getDescription(const Module &M)
Definition: OptBisect.cpp:50
enum FormattingFlags getFormattingFlag() const
Definition: CommandLine.h:283
typename SuperClass::iterator iterator
Definition: SmallVector.h:328
void AddLiteralOption(Option &O, StringRef Name)
Adds a new option for parsing and provides the option it refers to.
static bool RequiresValue(const Option *O)
iterator insert(iterator I, T &&Elt)
Definition: SmallVector.h:480
iterator begin() const
Definition: StringRef.h:106
bool convertUTF16ToUTF8String(ArrayRef< char > SrcBytes, std::string &Out)
Converts a stream of raw bytes assumed to be UTF16 into a UTF8 std::string.
amdgpu Simplify well known AMD library false Value Value * Arg
Saves strings in the inheritor&#39;s stable storage and returns a StringRef with a stable character point...
Definition: StringSaver.h:21
StringRef HelpStr
Definition: CommandLine.h:265
LLVM_ATTRIBUTE_ALWAYS_INLINE iterator end()
Definition: SmallVector.h:120
const char * getBufferEnd() const
Definition: MemoryBuffer.h:60
Provides a library for accessing information about this process and other processes on the operating ...
StringRef getHostCPUName()
getHostCPUName - Get the LLVM name for the host CPU.
Definition: Host.cpp:1081
static const size_t npos
Definition: StringRef.h:51
iterator begin() const
Definition: SmallPtrSet.h:397
static CategorizedHelpPrinter CategorizedNormalPrinter(false)
iterator begin()
Definition: StringMap.h:317
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:576
static cl::opt< HelpPrinterWrapper, true, parser< bool > > HOp("help", cl::desc("Display available options (-help-hidden for more)"), cl::location(WrappedNormalPrinter), cl::ValueDisallowed, cl::cat(GenericCategory), cl::sub(*AllSubCommands))
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:61
void(*)(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs) TokenizerCallback
String tokenization function type.
Definition: CommandLine.h:1863
virtual void getExtraOptionNames(SmallVectorImpl< StringRef > &)
Definition: CommandLine.h:357
void removeArgument()
Unregisters this option from the CommandLine system.
const char * c_str()
Definition: SmallString.h:270
static Option * getOptionPred(StringRef Name, size_t &Length, bool(*Pred)(const Option *), const StringMap< Option *> &OptionsMap)
#define I(x, y, z)
Definition: MD5.cpp:58
bool is_relative(const Twine &path, Style style=Style::native)
Is path relative?
Definition: Path.cpp:685
SmallPtrSet< SubCommand *, 4 > Subs
Definition: CommandLine.h:268
const char * getBufferStart() const
Definition: MemoryBuffer.h:59
iterator end() const
Definition: SmallPtrSet.h:402
bool hasArgStr() const
Definition: CommandLine.h:292
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile(const Twine &Filename, int64_t FileSize=-1, bool RequiresNullTerminator=true, bool IsVolatile=false)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful, otherwise returning null.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
void printOptionName(const Option &O, size_t GlobalWidth) const
LLVM_NODISCARD char front() const
front - Get the first character in the string.
Definition: StringRef.h:142
static cl::opt< HelpPrinterWrapper, true, parser< bool > > HHOp("help-hidden", cl::desc("Display all available options"), cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed, cl::cat(GenericCategory), cl::sub(*AllSubCommands))
LLVM Value Representation.
Definition: Value.h:73
void AddExtraVersionPrinter(VersionPrinterTy func)
===------------------------------------------------------------------—===// AddExtraVersionPrinter -...
constexpr char Size[]
Key for Kernel::Arg::Metadata::mSize.
#define LLVM_FALLTHROUGH
LLVM_FALLTHROUGH - Mark fallthrough cases in switch statements.
Definition: Compiler.h:235
raw_ostream & nulls()
This returns a reference to a raw_ostream which simply discards output.
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:44
#define DEBUG(X)
Definition: Debug.h:118
static CategorizedHelpPrinter CategorizedHiddenPrinter(true)
bool ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer, SmallVectorImpl< const char *> &Argv, bool MarkEOLs=false, bool RelativeNames=false)
Expand response files on a command line recursively using the given StringSaver and tokenization stra...
bool error(const Twine &Message, StringRef ArgName=StringRef())
unsigned getMiscFlags() const
Definition: CommandLine.h:287
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
ManagedStatic - This transparently changes the behavior of global statics to be lazily constructed on...
Definition: ManagedStatic.h:61
static void Split(std::vector< std::string > &V, StringRef S)
Splits a string of comma separated items in to a vector of strings.
virtual size_t getOptionWidth(const Option &O) const
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE size_t find(char C, size_t From=0) const
Search for the first character C in the string.
Definition: StringRef.h:298
unsigned findOption(StringRef Name)
iterator end() const
Definition: StringRef.h:108
iterator_range< typename SmallPtrSet< SubCommand *, 4 >::iterator > getRegisteredSubcommands()
Use this to get all registered SubCommands from the provided parser.
static Optional< std::string > GetEnv(StringRef name)
bool isSink() const
Definition: CommandLine.h:294
static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter, CategorizedHiddenPrinter)
LocationClass< Ty > location(Ty &L)
Definition: CommandLine.h:422
iterator end()
Definition: StringMap.h:320
reference get()
Definition: ErrorOr.h:169
StringRef getName() const
Definition: CommandLine.h:184
bool is_contained(R &&Range, const E &Element)
Wrapper function around std::find to detect if an element exists in a container.
Definition: STLExtras.h:873