1 //===- OptTable.h - Option Table --------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_OPTION_OPTTABLE_H
11 #define LLVM_OPTION_OPTTABLE_H
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/ADT/StringSet.h"
16 #include "llvm/Option/OptSpecifier.h"
32 /// \brief Provide access to the Option info table.
34 /// The OptTable class provides a layer of indirection which allows Option
35 /// instance to be created lazily. In the common case, only a few options will
36 /// be needed at runtime; the OptTable class maintains enough information to
37 /// parse command lines without instantiating Options, while letting other
38 /// parts of the driver still use Option instances where convenient.
41 /// \brief Entry for a single option instance in the option data table.
43 /// A null terminated array of prefix strings to apply to name while
45 const char *const *Prefixes;
53 unsigned short GroupID;
54 unsigned short AliasID;
55 const char *AliasArgs;
60 /// \brief The option information table.
61 std::vector<Info> OptionInfos;
64 unsigned TheInputOptionID = 0;
65 unsigned TheUnknownOptionID = 0;
67 /// The index of the first option which can be parsed (i.e., is not a
68 /// special option like 'input' or 'unknown', and is not an option group).
69 unsigned FirstSearchableIndex = 0;
71 /// The union of all option prefixes. If an argument does not begin with
72 /// one of these, it is an input.
73 StringSet<> PrefixesUnion;
74 std::string PrefixChars;
77 const Info &getInfo(OptSpecifier Opt) const {
78 unsigned id = Opt.getID();
79 assert(id > 0 && id - 1 < getNumOptions() && "Invalid Option ID.");
80 return OptionInfos[id - 1];
84 OptTable(ArrayRef<Info> OptionInfos, bool IgnoreCase = false);
89 /// \brief Return the total number of option classes.
90 unsigned getNumOptions() const { return OptionInfos.size(); }
92 /// \brief Get the given Opt's Option instance, lazily creating it
95 /// \return The option, or null for the INVALID option id.
96 const Option getOption(OptSpecifier Opt) const;
98 /// \brief Lookup the name of the given option.
99 const char *getOptionName(OptSpecifier id) const {
100 return getInfo(id).Name;
103 /// \brief Get the kind of the given option.
104 unsigned getOptionKind(OptSpecifier id) const {
105 return getInfo(id).Kind;
108 /// \brief Get the group id for the given option.
109 unsigned getOptionGroupID(OptSpecifier id) const {
110 return getInfo(id).GroupID;
113 /// \brief Get the help text to use to describe this option.
114 const char *getOptionHelpText(OptSpecifier id) const {
115 return getInfo(id).HelpText;
118 /// \brief Get the meta-variable name to use when describing
119 /// this options values in the help text.
120 const char *getOptionMetaVar(OptSpecifier id) const {
121 return getInfo(id).MetaVar;
124 /// Find possible value for given flags. This is used for shell
127 /// \param [in] Option - Key flag like "-stdlib=" when "-stdlib=l"
128 /// was passed to clang.
130 /// \param [in] Arg - Value which we want to autocomplete like "l"
131 /// when "-stdlib=l" was passed to clang.
133 /// \return The vector of possible values.
134 std::vector<std::string> suggestValueCompletions(StringRef Option,
135 StringRef Arg) const;
137 /// Find flags from OptTable which starts with Cur.
139 /// \param [in] Cur - String prefix that all returned flags need
142 /// \return The vector of flags which start with Cur.
143 std::vector<std::string> findByPrefix(StringRef Cur,
144 unsigned short DisableFlags) const;
146 /// Add Values to Option's Values class
148 /// \param [in] Option - Prefix + Name of the flag which Values will be
149 /// changed. For example, "-analyzer-checker".
150 /// \param [in] Values - String of Values seperated by ",", such as
151 /// "foo, bar..", where foo and bar is the argument which the Option flag
154 /// \return true in success, and false in fail.
155 bool addValues(const char *Option, const char *Values);
157 /// \brief Parse a single argument; returning the new argument and
160 /// \param [in,out] Index - The current parsing position in the argument
161 /// string list; on return this will be the index of the next argument
163 /// \param [in] FlagsToInclude - Only parse options with any of these flags.
164 /// Zero is the default which includes all flags.
165 /// \param [in] FlagsToExclude - Don't parse options with this flag. Zero
166 /// is the default and means exclude nothing.
168 /// \return The parsed argument, or 0 if the argument is missing values
169 /// (in which case Index still points at the conceptual next argument string
171 Arg *ParseOneArg(const ArgList &Args, unsigned &Index,
172 unsigned FlagsToInclude = 0,
173 unsigned FlagsToExclude = 0) const;
175 /// \brief Parse an list of arguments into an InputArgList.
177 /// The resulting InputArgList will reference the strings in [\p ArgBegin,
178 /// \p ArgEnd), and their lifetime should extend past that of the returned
181 /// The only error that can occur in this routine is if an argument is
182 /// missing values; in this case \p MissingArgCount will be non-zero.
184 /// \param MissingArgIndex - On error, the index of the option which could
186 /// \param MissingArgCount - On error, the number of missing options.
187 /// \param FlagsToInclude - Only parse options with any of these flags.
188 /// Zero is the default which includes all flags.
189 /// \param FlagsToExclude - Don't parse options with this flag. Zero
190 /// is the default and means exclude nothing.
191 /// \return An InputArgList; on error this will contain all the options
192 /// which could be parsed.
193 InputArgList ParseArgs(ArrayRef<const char *> Args, unsigned &MissingArgIndex,
194 unsigned &MissingArgCount, unsigned FlagsToInclude = 0,
195 unsigned FlagsToExclude = 0) const;
197 /// \brief Render the help text for an option table.
199 /// \param OS - The stream to write the help text to.
200 /// \param Name - The name to use in the usage line.
201 /// \param Title - The title to use in the usage line.
202 /// \param FlagsToInclude - If non-zero, only include options with any
203 /// of these flags set.
204 /// \param FlagsToExclude - Exclude options with any of these flags set.
205 /// \param ShowAllAliases - If true, display all options including aliases
206 /// that don't have help texts. By default, we display
207 /// only options that are not hidden and have help
209 void PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
210 unsigned FlagsToInclude, unsigned FlagsToExclude,
211 bool ShowAllAliases) const;
213 void PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
214 bool ShowHidden = false, bool ShowAllAliases = false) const;
217 } // end namespace opt
219 } // end namespace llvm
221 #endif // LLVM_OPTION_OPTTABLE_H