contrib/llvm/lib/Option/OptTable.cpp

   1 //===- OptTable.cpp - Option Table 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 #include "llvm/ADT/STLExtras.h"
  11 #include "llvm/ADT/StringRef.h"
  12 #include "llvm/ADT/StringSet.h"
  13 #include "llvm/Option/Arg.h"
  14 #include "llvm/Option/ArgList.h"
  15 #include "llvm/Option/Option.h"
  16 #include "llvm/Option/OptSpecifier.h"
  17 #include "llvm/Option/OptTable.h"
  18 #include "llvm/Support/Compiler.h"
  19 #include "llvm/Support/ErrorHandling.h"
  20 #include "llvm/Support/raw_ostream.h"
  21 #include <algorithm>
  22 #include <cassert>
  23 #include <cctype>
  24 #include <cstring>
  25 #include <map>
  26 #include <string>
  27 #include <utility>
  28 #include <vector>
  29
  30 using namespace llvm;
  31 using namespace llvm::opt;
  32
  33 namespace llvm {
  34 namespace opt {
  35
  36 // Ordering on Info. The ordering is *almost* case-insensitive lexicographic,
  37 // with an exceptions. '\0' comes at the end of the alphabet instead of the
  38 // beginning (thus options precede any other options which prefix them).
  39 static int StrCmpOptionNameIgnoreCase(const char *A, const char *B) {
  40   const char *X = A, *Y = B;
  41   char a = tolower(*A), b = tolower(*B);
  42   while (a == b) {
  43     if (a == '\0')
  44       return 0;
  45
  46     a = tolower(*++X);
  47     b = tolower(*++Y);
  48   }
  49
  50   if (a == '\0') // A is a prefix of B.
  51     return 1;
  52   if (b == '\0') // B is a prefix of A.
  53     return -1;
  54
  55   // Otherwise lexicographic.
  56   return (a < b) ? -1 : 1;
  57 }
  58
  59 #ifndef NDEBUG
  60 static int StrCmpOptionName(const char *A, const char *B) {
  61   if (int N = StrCmpOptionNameIgnoreCase(A, B))
  62     return N;
  63   return strcmp(A, B);
  64 }
  65
  66 static inline bool operator<(const OptTable::Info &A, const OptTable::Info &B) {
  67   if (&A == &B)
  68     return false;
  69
  70   if (int N = StrCmpOptionName(A.Name, B.Name))
  71     return N < 0;
  72
  73   for (const char * const *APre = A.Prefixes,
  74                   * const *BPre = B.Prefixes;
  75                           *APre != nullptr && *BPre != nullptr; ++APre, ++BPre){
  76     if (int N = StrCmpOptionName(*APre, *BPre))
  77       return N < 0;
  78   }
  79
  80   // Names are the same, check that classes are in order; exactly one
  81   // should be joined, and it should succeed the other.
  82   assert(((A.Kind == Option::JoinedClass) ^ (B.Kind == Option::JoinedClass)) &&
  83          "Unexpected classes for options with same name.");
  84   return B.Kind == Option::JoinedClass;
  85 }
  86 #endif
  87
  88 // Support lower_bound between info and an option name.
  89 static inline bool operator<(const OptTable::Info &I, const char *Name) {
  90   return StrCmpOptionNameIgnoreCase(I.Name, Name) < 0;
  91 }
  92
  93 } // end namespace opt
  94 } // end namespace llvm
  95
  96 OptSpecifier::OptSpecifier(const Option *Opt) : ID(Opt->getID()) {}
  97
  98 OptTable::OptTable(ArrayRef<Info> OptionInfos, bool IgnoreCase)
  99     : OptionInfos(OptionInfos), IgnoreCase(IgnoreCase) {
 100   // Explicitly zero initialize the error to work around a bug in array
 101   // value-initialization on MinGW with gcc 4.3.5.
 102
 103   // Find start of normal options.
 104   for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
 105     unsigned Kind = getInfo(i + 1).Kind;
 106     if (Kind == Option::InputClass) {
 107       assert(!TheInputOptionID && "Cannot have multiple input options!");
 108       TheInputOptionID = getInfo(i + 1).ID;
 109     } else if (Kind == Option::UnknownClass) {
 110       assert(!TheUnknownOptionID && "Cannot have multiple unknown options!");
 111       TheUnknownOptionID = getInfo(i + 1).ID;
 112     } else if (Kind != Option::GroupClass) {
 113       FirstSearchableIndex = i;
 114       break;
 115     }
 116   }
 117   assert(FirstSearchableIndex != 0 && "No searchable options?");
 118
 119 #ifndef NDEBUG
 120   // Check that everything after the first searchable option is a
 121   // regular option class.
 122   for (unsigned i = FirstSearchableIndex, e = getNumOptions(); i != e; ++i) {
 123     Option::OptionClass Kind = (Option::OptionClass) getInfo(i + 1).Kind;
 124     assert((Kind != Option::InputClass && Kind != Option::UnknownClass &&
 125             Kind != Option::GroupClass) &&
 126            "Special options should be defined first!");
 127   }
 128
 129   // Check that options are in order.
 130   for (unsigned i = FirstSearchableIndex + 1, e = getNumOptions(); i != e; ++i){
 131     if (!(getInfo(i) < getInfo(i + 1))) {
 132       getOption(i).dump();
 133       getOption(i + 1).dump();
 134       llvm_unreachable("Options are not in order!");
 135     }
 136   }
 137 #endif
 138
 139   // Build prefixes.
 140   for (unsigned i = FirstSearchableIndex + 1, e = getNumOptions() + 1;
 141                 i != e; ++i) {
 142     if (const char *const *P = getInfo(i).Prefixes) {
 143       for (; *P != nullptr; ++P) {
 144         PrefixesUnion.insert(*P);
 145       }
 146     }
 147   }
 148
 149   // Build prefix chars.
 150   for (StringSet<>::const_iterator I = PrefixesUnion.begin(),
 151                                    E = PrefixesUnion.end(); I != E; ++I) {
 152     StringRef Prefix = I->getKey();
 153     for (StringRef::const_iterator C = Prefix.begin(), CE = Prefix.end();
 154                                    C != CE; ++C)
 155       if (!is_contained(PrefixChars, *C))
 156         PrefixChars.push_back(*C);
 157   }
 158 }
 159
 160 OptTable::~OptTable() = default;
 161
 162 const Option OptTable::getOption(OptSpecifier Opt) const {
 163   unsigned id = Opt.getID();
 164   if (id == 0)
 165     return Option(nullptr, nullptr);
 166   assert((unsigned) (id - 1) < getNumOptions() && "Invalid ID.");
 167   return Option(&getInfo(id), this);
 168 }
 169
 170 static bool isInput(const StringSet<> &Prefixes, StringRef Arg) {
 171   if (Arg == "-")
 172     return true;
 173   for (StringSet<>::const_iterator I = Prefixes.begin(),
 174                                    E = Prefixes.end(); I != E; ++I)
 175     if (Arg.startswith(I->getKey()))
 176       return false;
 177   return true;
 178 }
 179
 180 /// \returns Matched size. 0 means no match.
 181 static unsigned matchOption(const OptTable::Info *I, StringRef Str,
 182                             bool IgnoreCase) {
 183   for (const char * const *Pre = I->Prefixes; *Pre != nullptr; ++Pre) {
 184     StringRef Prefix(*Pre);
 185     if (Str.startswith(Prefix)) {
 186       StringRef Rest = Str.substr(Prefix.size());
 187       bool Matched = IgnoreCase
 188           ? Rest.startswith_lower(I->Name)
 189           : Rest.startswith(I->Name);
 190       if (Matched)
 191         return Prefix.size() + StringRef(I->Name).size();
 192     }
 193   }
 194   return 0;
 195 }
 196
 197 // Returns true if one of the Prefixes + In.Names matches Option
 198 static bool optionMatches(const OptTable::Info &In, StringRef Option) {
 199   if (In.Values && In.Prefixes)
 200     for (size_t I = 0; In.Prefixes[I]; I++)
 201       if (Option == std::string(In.Prefixes[I]) + In.Name)
 202         return true;
 203   return false;
 204 }
 205
 206 // This function is for flag value completion.
 207 // Eg. When "-stdlib=" and "l" was passed to this function, it will return
 208 // appropiriate values for stdlib, which starts with l.
 209 std::vector<std::string>
 210 OptTable::suggestValueCompletions(StringRef Option, StringRef Arg) const {
 211   // Search all options and return possible values.
 212   for (const Info &In : OptionInfos.slice(FirstSearchableIndex)) {
 213     if (!optionMatches(In, Option))
 214       continue;
 215
 216     SmallVector<StringRef, 8> Candidates;
 217     StringRef(In.Values).split(Candidates, ",", -1, false);
 218
 219     std::vector<std::string> Result;
 220     for (StringRef Val : Candidates)
 221       if (Val.startswith(Arg))
 222         Result.push_back(Val);
 223     return Result;
 224   }
 225   return {};
 226 }
 227
 228 std::vector<std::string> OptTable::findByPrefix(StringRef Cur) const {
 229   std::vector<std::string> Ret;
 230   for (const Info &In : OptionInfos.slice(FirstSearchableIndex)) {
 231     if (!In.Prefixes)
 232       continue;
 233     for (int I = 0; In.Prefixes[I]; I++) {
 234       std::string S = std::string(In.Prefixes[I]) + std::string(In.Name);
 235       if (StringRef(S).startswith(Cur))
 236         Ret.push_back(S);
 237     }
 238   }
 239   return Ret;
 240 }
 241
 242 Arg *OptTable::ParseOneArg(const ArgList &Args, unsigned &Index,
 243                            unsigned FlagsToInclude,
 244                            unsigned FlagsToExclude) const {
 245   unsigned Prev = Index;
 246   const char *Str = Args.getArgString(Index);
 247
 248   // Anything that doesn't start with PrefixesUnion is an input, as is '-'
 249   // itself.
 250   if (isInput(PrefixesUnion, Str))
 251     return new Arg(getOption(TheInputOptionID), Str, Index++, Str);
 252
 253   const Info *Start = OptionInfos.begin() + FirstSearchableIndex;
 254   const Info *End = OptionInfos.end();
 255   StringRef Name = StringRef(Str).ltrim(PrefixChars);
 256
 257   // Search for the first next option which could be a prefix.
 258   Start = std::lower_bound(Start, End, Name.data());
 259
 260   // Options are stored in sorted order, with '\0' at the end of the
 261   // alphabet. Since the only options which can accept a string must
 262   // prefix it, we iteratively search for the next option which could
 263   // be a prefix.
 264   //
 265   // FIXME: This is searching much more than necessary, but I am
 266   // blanking on the simplest way to make it fast. We can solve this
 267   // problem when we move to TableGen.
 268   for (; Start != End; ++Start) {
 269     unsigned ArgSize = 0;
 270     // Scan for first option which is a proper prefix.
 271     for (; Start != End; ++Start)
 272       if ((ArgSize = matchOption(Start, Str, IgnoreCase)))
 273         break;
 274     if (Start == End)
 275       break;
 276
 277     Option Opt(Start, this);
 278
 279     if (FlagsToInclude && !Opt.hasFlag(FlagsToInclude))
 280       continue;
 281     if (Opt.hasFlag(FlagsToExclude))
 282       continue;
 283
 284     // See if this option matches.
 285     if (Arg *A = Opt.accept(Args, Index, ArgSize))
 286       return A;
 287
 288     // Otherwise, see if this argument was missing values.
 289     if (Prev != Index)
 290       return nullptr;
 291   }
 292
 293   // If we failed to find an option and this arg started with /, then it's
 294   // probably an input path.
 295   if (Str[0] == '/')
 296     return new Arg(getOption(TheInputOptionID), Str, Index++, Str);
 297
 298   return new Arg(getOption(TheUnknownOptionID), Str, Index++, Str);
 299 }
 300
 301 InputArgList OptTable::ParseArgs(ArrayRef<const char *> ArgArr,
 302                                  unsigned &MissingArgIndex,
 303                                  unsigned &MissingArgCount,
 304                                  unsigned FlagsToInclude,
 305                                  unsigned FlagsToExclude) const {
 306   InputArgList Args(ArgArr.begin(), ArgArr.end());
 307
 308   // FIXME: Handle '@' args (or at least error on them).
 309
 310   MissingArgIndex = MissingArgCount = 0;
 311   unsigned Index = 0, End = ArgArr.size();
 312   while (Index < End) {
 313     // Ingore nullptrs, they are response file's EOL markers
 314     if (Args.getArgString(Index) == nullptr) {
 315       ++Index;
 316       continue;
 317     }
 318     // Ignore empty arguments (other things may still take them as arguments).
 319     StringRef Str = Args.getArgString(Index);
 320     if (Str == "") {
 321       ++Index;
 322       continue;
 323     }
 324
 325     unsigned Prev = Index;
 326     Arg *A = ParseOneArg(Args, Index, FlagsToInclude, FlagsToExclude);
 327     assert(Index > Prev && "Parser failed to consume argument.");
 328
 329     // Check for missing argument error.
 330     if (!A) {
 331       assert(Index >= End && "Unexpected parser error.");
 332       assert(Index - Prev - 1 && "No missing arguments!");
 333       MissingArgIndex = Prev;
 334       MissingArgCount = Index - Prev - 1;
 335       break;
 336     }
 337
 338     Args.append(A);
 339   }
 340
 341   return Args;
 342 }
 343
 344 static std::string getOptionHelpName(const OptTable &Opts, OptSpecifier Id) {
 345   const Option O = Opts.getOption(Id);
 346   std::string Name = O.getPrefixedName();
 347
 348   // Add metavar, if used.
 349   switch (O.getKind()) {
 350   case Option::GroupClass: case Option::InputClass: case Option::UnknownClass:
 351     llvm_unreachable("Invalid option with help text.");
 352
 353   case Option::MultiArgClass:
 354     if (const char *MetaVarName = Opts.getOptionMetaVar(Id)) {
 355       // For MultiArgs, metavar is full list of all argument names.
 356       Name += ' ';
 357       Name += MetaVarName;
 358     }
 359     else {
 360       // For MultiArgs<N>, if metavar not supplied, print <value> N times.
 361       for (unsigned i=0, e=O.getNumArgs(); i< e; ++i) {
 362         Name += " <value>";
 363       }
 364     }
 365     break;
 366
 367   case Option::FlagClass:
 368     break;
 369
 370   case Option::ValuesClass:
 371     break;
 372
 373   case Option::SeparateClass: case Option::JoinedOrSeparateClass:
 374   case Option::RemainingArgsClass: case Option::RemainingArgsJoinedClass:
 375     Name += ' ';
 376     LLVM_FALLTHROUGH;
 377   case Option::JoinedClass: case Option::CommaJoinedClass:
 378   case Option::JoinedAndSeparateClass:
 379     if (const char *MetaVarName = Opts.getOptionMetaVar(Id))
 380       Name += MetaVarName;
 381     else
 382       Name += "<value>";
 383     break;
 384   }
 385
 386   return Name;
 387 }
 388
 389 static void PrintHelpOptionList(raw_ostream &OS, StringRef Title,
 390                                 std::vector<std::pair<std::string,
 391                                 const char*>> &OptionHelp) {
 392   OS << Title << ":\n";
 393
 394   // Find the maximum option length.
 395   unsigned OptionFieldWidth = 0;
 396   for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
 397     // Skip titles.
 398     if (!OptionHelp[i].second)
 399       continue;
 400
 401     // Limit the amount of padding we are willing to give up for alignment.
 402     unsigned Length = OptionHelp[i].first.size();
 403     if (Length <= 23)
 404       OptionFieldWidth = std::max(OptionFieldWidth, Length);
 405   }
 406
 407   const unsigned InitialPad = 2;
 408   for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
 409     const std::string &Option = OptionHelp[i].first;
 410     int Pad = OptionFieldWidth - int(Option.size());
 411     OS.indent(InitialPad) << Option;
 412
 413     // Break on long option names.
 414     if (Pad < 0) {
 415       OS << "\n";
 416       Pad = OptionFieldWidth + InitialPad;
 417     }
 418     OS.indent(Pad + 1) << OptionHelp[i].second << '\n';
 419   }
 420 }
 421
 422 static const char *getOptionHelpGroup(const OptTable &Opts, OptSpecifier Id) {
 423   unsigned GroupID = Opts.getOptionGroupID(Id);
 424
 425   // If not in a group, return the default help group.
 426   if (!GroupID)
 427     return "OPTIONS";
 428
 429   // Abuse the help text of the option groups to store the "help group"
 430   // name.
 431   //
 432   // FIXME: Split out option groups.
 433   if (const char *GroupHelp = Opts.getOptionHelpText(GroupID))
 434     return GroupHelp;
 435
 436   // Otherwise keep looking.
 437   return getOptionHelpGroup(Opts, GroupID);
 438 }
 439
 440 void OptTable::PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
 441                          bool ShowHidden) const {
 442   PrintHelp(OS, Name, Title, /*Include*/ 0, /*Exclude*/
 443             (ShowHidden ? 0 : HelpHidden));
 444 }
 445
 446
 447 void OptTable::PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
 448                          unsigned FlagsToInclude,
 449                          unsigned FlagsToExclude) const {
 450   OS << "OVERVIEW: " << Title << "\n";
 451   OS << '\n';
 452   OS << "USAGE: " << Name << " [options] <inputs>\n";
 453   OS << '\n';
 454
 455   // Render help text into a map of group-name to a list of (option, help)
 456   // pairs.
 457   using helpmap_ty =
 458       std::map<std::string, std::vector<std::pair<std::string, const char*>>>;
 459   helpmap_ty GroupedOptionHelp;
 460
 461   for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
 462     unsigned Id = i + 1;
 463
 464     // FIXME: Split out option groups.
 465     if (getOptionKind(Id) == Option::GroupClass)
 466       continue;
 467
 468     unsigned Flags = getInfo(Id).Flags;
 469     if (FlagsToInclude && !(Flags & FlagsToInclude))
 470       continue;
 471     if (Flags & FlagsToExclude)
 472       continue;
 473
 474     if (const char *Text = getOptionHelpText(Id)) {
 475       const char *HelpGroup = getOptionHelpGroup(*this, Id);
 476       const std::string &OptName = getOptionHelpName(*this, Id);
 477       GroupedOptionHelp[HelpGroup].push_back(std::make_pair(OptName, Text));
 478     }
 479   }
 480
 481   for (helpmap_ty::iterator it = GroupedOptionHelp .begin(),
 482          ie = GroupedOptionHelp.end(); it != ie; ++it) {
 483     if (it != GroupedOptionHelp .begin())
 484       OS << "\n";
 485     PrintHelpOptionList(OS, it->first, it->second);
 486   }
 487
 488   OS.flush();
 489 }