| //===--- OptTable.h - Option Table ------------------------------*- C++ -*-===// |
| // |
| // The LLVM Compiler Infrastructure |
| // |
| // This file is distributed under the University of Illinois Open Source |
| // License. See LICENSE.TXT for details. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef CLANG_DRIVER_OPTTABLE_H |
| #define CLANG_DRIVER_OPTTABLE_H |
| |
| #include "clang/Basic/LLVM.h" |
| #include "clang/Driver/OptSpecifier.h" |
| |
| namespace clang { |
| namespace driver { |
| namespace options { |
| enum DriverFlag { |
| DriverOption = (1 << 0), |
| HelpHidden = (1 << 1), |
| LinkerInput = (1 << 2), |
| NoArgumentUnused = (1 << 3), |
| NoForward = (1 << 4), |
| RenderAsInput = (1 << 5), |
| RenderJoined = (1 << 6), |
| RenderSeparate = (1 << 7), |
| Unsupported = (1 << 8) |
| }; |
| } |
| |
| class Arg; |
| class ArgList; |
| class InputArgList; |
| class Option; |
| |
| /// OptTable - Provide access to the Option info table. |
| /// |
| /// The OptTable class provides a layer of indirection which allows Option |
| /// instance to be created lazily. In the common case, only a few options will |
| /// be needed at runtime; the OptTable class maintains enough information to |
| /// parse command lines without instantiating Options, while letting other |
| /// parts of the driver still use Option instances where convenient. |
| class OptTable { |
| public: |
| /// Info - Entry for a single option instance in the option data table. |
| struct Info { |
| const char *Name; |
| const char *HelpText; |
| const char *MetaVar; |
| unsigned char Kind; |
| unsigned char Param; |
| unsigned short Flags; |
| unsigned short GroupID; |
| unsigned short AliasID; |
| }; |
| |
| private: |
| /// The static option information table. |
| const Info *OptionInfos; |
| unsigned NumOptionInfos; |
| |
| /// The lazily constructed options table, indexed by option::ID - 1. |
| mutable Option **Options; |
| |
| /// Prebound input option instance. |
| const Option *TheInputOption; |
| |
| /// Prebound unknown option instance. |
| const Option *TheUnknownOption; |
| |
| /// The index of the first option which can be parsed (i.e., is not a |
| /// special option like 'input' or 'unknown', and is not an option group). |
| unsigned FirstSearchableIndex; |
| |
| private: |
| const Info &getInfo(OptSpecifier Opt) const { |
| unsigned id = Opt.getID(); |
| assert(id > 0 && id - 1 < getNumOptions() && "Invalid Option ID."); |
| return OptionInfos[id - 1]; |
| } |
| |
| Option *CreateOption(unsigned id) const; |
| |
| protected: |
| OptTable(const Info *_OptionInfos, unsigned _NumOptionInfos); |
| public: |
| ~OptTable(); |
| |
| /// getNumOptions - Return the total number of option classes. |
| unsigned getNumOptions() const { return NumOptionInfos; } |
| |
| /// getOption - Get the given \arg id's Option instance, lazily creating it |
| /// if necessary. |
| /// |
| /// \return The option, or null for the INVALID option id. |
| const Option *getOption(OptSpecifier Opt) const { |
| unsigned id = Opt.getID(); |
| if (id == 0) |
| return 0; |
| |
| assert((unsigned) (id - 1) < getNumOptions() && "Invalid ID."); |
| Option *&Entry = Options[id - 1]; |
| if (!Entry) |
| Entry = CreateOption(id); |
| return Entry; |
| } |
| |
| /// getOptionName - Lookup the name of the given option. |
| const char *getOptionName(OptSpecifier id) const { |
| return getInfo(id).Name; |
| } |
| |
| /// getOptionKind - Get the kind of the given option. |
| unsigned getOptionKind(OptSpecifier id) const { |
| return getInfo(id).Kind; |
| } |
| |
| /// getOptionGroupID - Get the group id for the given option. |
| unsigned getOptionGroupID(OptSpecifier id) const { |
| return getInfo(id).GroupID; |
| } |
| |
| /// isOptionHelpHidden - Should the help for the given option be hidden by |
| /// default. |
| bool isOptionHelpHidden(OptSpecifier id) const { |
| return getInfo(id).Flags & options::HelpHidden; |
| } |
| |
| /// getOptionHelpText - Get the help text to use to describe this option. |
| const char *getOptionHelpText(OptSpecifier id) const { |
| return getInfo(id).HelpText; |
| } |
| |
| /// getOptionMetaVar - Get the meta-variable name to use when describing |
| /// this options values in the help text. |
| const char *getOptionMetaVar(OptSpecifier id) const { |
| return getInfo(id).MetaVar; |
| } |
| |
| /// ParseOneArg - Parse a single argument; returning the new argument and |
| /// updating Index. |
| /// |
| /// \param [in] [out] Index - The current parsing position in the argument |
| /// string list; on return this will be the index of the next argument |
| /// string to parse. |
| /// |
| /// \return - The parsed argument, or 0 if the argument is missing values |
| /// (in which case Index still points at the conceptual next argument string |
| /// to parse). |
| Arg *ParseOneArg(const ArgList &Args, unsigned &Index) const; |
| |
| /// ParseArgs - Parse an list of arguments into an InputArgList. |
| /// |
| /// The resulting InputArgList will reference the strings in [ArgBegin, |
| /// ArgEnd), and their lifetime should extend past that of the returned |
| /// InputArgList. |
| /// |
| /// The only error that can occur in this routine is if an argument is |
| /// missing values; in this case \arg MissingArgCount will be non-zero. |
| /// |
| /// \param ArgBegin - The beginning of the argument vector. |
| /// \param ArgEnd - The end of the argument vector. |
| /// \param MissingArgIndex - On error, the index of the option which could |
| /// not be parsed. |
| /// \param MissingArgCount - On error, the number of missing options. |
| /// \return - An InputArgList; on error this will contain all the options |
| /// which could be parsed. |
| InputArgList *ParseArgs(const char* const *ArgBegin, |
| const char* const *ArgEnd, |
| unsigned &MissingArgIndex, |
| unsigned &MissingArgCount) const; |
| |
| /// PrintHelp - Render the help text for an option table. |
| /// |
| /// \param OS - The stream to write the help text to. |
| /// \param Name - The name to use in the usage line. |
| /// \param Title - The title to use in the usage line. |
| /// \param ShowHidden - Whether help-hidden arguments should be shown. |
| void PrintHelp(raw_ostream &OS, const char *Name, |
| const char *Title, bool ShowHidden = false) const; |
| }; |
| } |
| } |
| |
| #endif |