include/llvm/Option/OptTable.h

   1 //===--- OptTable.h - Option Table ------------------------------*- C++ -*-===//
   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 #ifndef LLVM_OPTION_OPTTABLE_H
  11 #define LLVM_OPTION_OPTTABLE_H
  12
  13 #include "llvm/ADT/StringSet.h"
  14 #include "llvm/Option/OptSpecifier.h"
  15
  16 namespace llvm {
  17 class raw_ostream;
  18 namespace opt {
  19 class Arg;
  20 class ArgList;
  21 class InputArgList;
  22 class Option;
  23
  24 /// \brief Provide access to the Option info table.
  25 ///
  26 /// The OptTable class provides a layer of indirection which allows Option
  27 /// instance to be created lazily. In the common case, only a few options will
  28 /// be needed at runtime; the OptTable class maintains enough information to
  29 /// parse command lines without instantiating Options, while letting other
  30 /// parts of the driver still use Option instances where convenient.
  31 class OptTable {
  32 public:
  33   /// \brief Entry for a single option instance in the option data table.
  34   struct Info {
  35     /// A null terminated array of prefix strings to apply to name while
  36     /// matching.
  37     const char *const *Prefixes;
  38     const char *Name;
  39     const char *HelpText;
  40     const char *MetaVar;
  41     unsigned ID;
  42     unsigned char Kind;
  43     unsigned char Param;
  44     unsigned short Flags;
  45     unsigned short GroupID;
  46     unsigned short AliasID;
  47   };
  48
  49 private:
  50   /// \brief The static option information table.
  51   const Info *OptionInfos;
  52   unsigned NumOptionInfos;
  53
  54   unsigned TheInputOptionID;
  55   unsigned TheUnknownOptionID;
  56
  57   /// The index of the first option which can be parsed (i.e., is not a
  58   /// special option like 'input' or 'unknown', and is not an option group).
  59   unsigned FirstSearchableIndex;
  60
  61   /// The union of all option prefixes. If an argument does not begin with
  62   /// one of these, it is an input.
  63   StringSet<> PrefixesUnion;
  64   std::string PrefixChars;
  65
  66 private:
  67   const Info &getInfo(OptSpecifier Opt) const {
  68     unsigned id = Opt.getID();
  69     assert(id > 0 && id - 1 < getNumOptions() && "Invalid Option ID.");
  70     return OptionInfos[id - 1];
  71   }
  72
  73 protected:
  74   OptTable(const Info *_OptionInfos, unsigned _NumOptionInfos);
  75 public:
  76   ~OptTable();
  77
  78   /// \brief Return the total number of option classes.
  79   unsigned getNumOptions() const { return NumOptionInfos; }
  80
  81   /// \brief Get the given Opt's Option instance, lazily creating it
  82   /// if necessary.
  83   ///
  84   /// \return The option, or null for the INVALID option id.
  85   const Option getOption(OptSpecifier Opt) const;
  86
  87   /// \brief Lookup the name of the given option.
  88   const char *getOptionName(OptSpecifier id) const {
  89     return getInfo(id).Name;
  90   }
  91
  92   /// \brief Get the kind of the given option.
  93   unsigned getOptionKind(OptSpecifier id) const {
  94     return getInfo(id).Kind;
  95   }
  96
  97   /// \brief Get the group id for the given option.
  98   unsigned getOptionGroupID(OptSpecifier id) const {
  99     return getInfo(id).GroupID;
 100   }
 101
 102   /// \brief Should the help for the given option be hidden by default.
 103   bool isOptionHelpHidden(OptSpecifier id) const;
 104
 105   /// \brief Get the help text to use to describe this option.
 106   const char *getOptionHelpText(OptSpecifier id) const {
 107     return getInfo(id).HelpText;
 108   }
 109
 110   /// \brief Get the meta-variable name to use when describing
 111   /// this options values in the help text.
 112   const char *getOptionMetaVar(OptSpecifier id) const {
 113     return getInfo(id).MetaVar;
 114   }
 115
 116   /// \brief Parse a single argument; returning the new argument and
 117   /// updating Index.
 118   ///
 119   /// \param [in,out] Index - The current parsing position in the argument
 120   /// string list; on return this will be the index of the next argument
 121   /// string to parse.
 122   ///
 123   /// \return The parsed argument, or 0 if the argument is missing values
 124   /// (in which case Index still points at the conceptual next argument string
 125   /// to parse).
 126   Arg *ParseOneArg(const ArgList &Args, unsigned &Index) const;
 127
 128   /// \brief Parse an list of arguments into an InputArgList.
 129   ///
 130   /// The resulting InputArgList will reference the strings in [\p ArgBegin,
 131   /// \p ArgEnd), and their lifetime should extend past that of the returned
 132   /// InputArgList.
 133   ///
 134   /// The only error that can occur in this routine is if an argument is
 135   /// missing values; in this case \p MissingArgCount will be non-zero.
 136   ///
 137   /// \param ArgBegin - The beginning of the argument vector.
 138   /// \param ArgEnd - The end of the argument vector.
 139   /// \param MissingArgIndex - On error, the index of the option which could
 140   /// not be parsed.
 141   /// \param MissingArgCount - On error, the number of missing options.
 142   /// \return An InputArgList; on error this will contain all the options
 143   /// which could be parsed.
 144   InputArgList *ParseArgs(const char* const *ArgBegin,
 145                           const char* const *ArgEnd,
 146                           unsigned &MissingArgIndex,
 147                           unsigned &MissingArgCount) const;
 148
 149   /// \brief Render the help text for an option table.
 150   ///
 151   /// \param OS - The stream to write the help text to.
 152   /// \param Name - The name to use in the usage line.
 153   /// \param Title - The title to use in the usage line.
 154   /// \param ShowHidden - Whether help-hidden arguments should be shown.
 155   void PrintHelp(raw_ostream &OS, const char *Name,
 156                   const char *Title, bool ShowHidden = false) const;
 157 };
 158 } // end namespace opt
 159 } // end namespace llvm
 160
 161 #endif