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