1 //===- OptTable.cpp - Option Table Implementation -------------------------===//
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 #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"
31 using namespace llvm::opt;
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);
50 if (a == '\0') // A is a prefix of B.
52 if (b == '\0') // B is a prefix of A.
55 // Otherwise lexicographic.
56 return (a < b) ? -1 : 1;
60 static int StrCmpOptionName(const char *A, const char *B) {
61 if (int N = StrCmpOptionNameIgnoreCase(A, B))
66 static inline bool operator<(const OptTable::Info &A, const OptTable::Info &B) {
70 if (int N = StrCmpOptionName(A.Name, B.Name))
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))
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;
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;
93 } // end namespace opt
94 } // end namespace llvm
96 OptSpecifier::OptSpecifier(const Option *Opt) : ID(Opt->getID()) {}
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.
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;
117 assert(FirstSearchableIndex != 0 && "No searchable options?");
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!");
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))) {
133 getOption(i + 1).dump();
134 llvm_unreachable("Options are not in order!");
140 for (unsigned i = FirstSearchableIndex + 1, e = getNumOptions() + 1;
142 if (const char *const *P = getInfo(i).Prefixes) {
143 for (; *P != nullptr; ++P) {
144 PrefixesUnion.insert(*P);
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();
155 if (!is_contained(PrefixChars, *C))
156 PrefixChars.push_back(*C);
160 OptTable::~OptTable() = default;
162 const Option OptTable::getOption(OptSpecifier Opt) const {
163 unsigned id = Opt.getID();
165 return Option(nullptr, nullptr);
166 assert((unsigned) (id - 1) < getNumOptions() && "Invalid ID.");
167 return Option(&getInfo(id), this);
170 static bool isInput(const StringSet<> &Prefixes, StringRef Arg) {
173 for (StringSet<>::const_iterator I = Prefixes.begin(),
174 E = Prefixes.end(); I != E; ++I)
175 if (Arg.startswith(I->getKey()))
180 /// \returns Matched size. 0 means no match.
181 static unsigned matchOption(const OptTable::Info *I, StringRef Str,
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);
191 return Prefix.size() + StringRef(I->Name).size();
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)
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))
216 SmallVector<StringRef, 8> Candidates;
217 StringRef(In.Values).split(Candidates, ",", -1, false);
219 std::vector<std::string> Result;
220 for (StringRef Val : Candidates)
221 if (Val.startswith(Arg))
222 Result.push_back(Val);
228 std::vector<std::string>
229 OptTable::findByPrefix(StringRef Cur, unsigned short DisableFlags) const {
230 std::vector<std::string> Ret;
231 for (const Info &In : OptionInfos.slice(FirstSearchableIndex)) {
232 if (!In.Prefixes || (!In.HelpText && !In.GroupID))
234 if (In.Flags & DisableFlags)
237 for (int I = 0; In.Prefixes[I]; I++) {
238 std::string S = std::string(In.Prefixes[I]) + std::string(In.Name);
239 if (StringRef(S).startswith(Cur))
246 Arg *OptTable::ParseOneArg(const ArgList &Args, unsigned &Index,
247 unsigned FlagsToInclude,
248 unsigned FlagsToExclude) const {
249 unsigned Prev = Index;
250 const char *Str = Args.getArgString(Index);
252 // Anything that doesn't start with PrefixesUnion is an input, as is '-'
254 if (isInput(PrefixesUnion, Str))
255 return new Arg(getOption(TheInputOptionID), Str, Index++, Str);
257 const Info *Start = OptionInfos.begin() + FirstSearchableIndex;
258 const Info *End = OptionInfos.end();
259 StringRef Name = StringRef(Str).ltrim(PrefixChars);
261 // Search for the first next option which could be a prefix.
262 Start = std::lower_bound(Start, End, Name.data());
264 // Options are stored in sorted order, with '\0' at the end of the
265 // alphabet. Since the only options which can accept a string must
266 // prefix it, we iteratively search for the next option which could
269 // FIXME: This is searching much more than necessary, but I am
270 // blanking on the simplest way to make it fast. We can solve this
271 // problem when we move to TableGen.
272 for (; Start != End; ++Start) {
273 unsigned ArgSize = 0;
274 // Scan for first option which is a proper prefix.
275 for (; Start != End; ++Start)
276 if ((ArgSize = matchOption(Start, Str, IgnoreCase)))
281 Option Opt(Start, this);
283 if (FlagsToInclude && !Opt.hasFlag(FlagsToInclude))
285 if (Opt.hasFlag(FlagsToExclude))
288 // See if this option matches.
289 if (Arg *A = Opt.accept(Args, Index, ArgSize))
292 // Otherwise, see if this argument was missing values.
297 // If we failed to find an option and this arg started with /, then it's
298 // probably an input path.
300 return new Arg(getOption(TheInputOptionID), Str, Index++, Str);
302 return new Arg(getOption(TheUnknownOptionID), Str, Index++, Str);
305 InputArgList OptTable::ParseArgs(ArrayRef<const char *> ArgArr,
306 unsigned &MissingArgIndex,
307 unsigned &MissingArgCount,
308 unsigned FlagsToInclude,
309 unsigned FlagsToExclude) const {
310 InputArgList Args(ArgArr.begin(), ArgArr.end());
312 // FIXME: Handle '@' args (or at least error on them).
314 MissingArgIndex = MissingArgCount = 0;
315 unsigned Index = 0, End = ArgArr.size();
316 while (Index < End) {
317 // Ingore nullptrs, they are response file's EOL markers
318 if (Args.getArgString(Index) == nullptr) {
322 // Ignore empty arguments (other things may still take them as arguments).
323 StringRef Str = Args.getArgString(Index);
329 unsigned Prev = Index;
330 Arg *A = ParseOneArg(Args, Index, FlagsToInclude, FlagsToExclude);
331 assert(Index > Prev && "Parser failed to consume argument.");
333 // Check for missing argument error.
335 assert(Index >= End && "Unexpected parser error.");
336 assert(Index - Prev - 1 && "No missing arguments!");
337 MissingArgIndex = Prev;
338 MissingArgCount = Index - Prev - 1;
348 static std::string getOptionHelpName(const OptTable &Opts, OptSpecifier Id) {
349 const Option O = Opts.getOption(Id);
350 std::string Name = O.getPrefixedName();
352 // Add metavar, if used.
353 switch (O.getKind()) {
354 case Option::GroupClass: case Option::InputClass: case Option::UnknownClass:
355 llvm_unreachable("Invalid option with help text.");
357 case Option::MultiArgClass:
358 if (const char *MetaVarName = Opts.getOptionMetaVar(Id)) {
359 // For MultiArgs, metavar is full list of all argument names.
364 // For MultiArgs<N>, if metavar not supplied, print <value> N times.
365 for (unsigned i=0, e=O.getNumArgs(); i< e; ++i) {
371 case Option::FlagClass:
374 case Option::ValuesClass:
377 case Option::SeparateClass: case Option::JoinedOrSeparateClass:
378 case Option::RemainingArgsClass: case Option::RemainingArgsJoinedClass:
381 case Option::JoinedClass: case Option::CommaJoinedClass:
382 case Option::JoinedAndSeparateClass:
383 if (const char *MetaVarName = Opts.getOptionMetaVar(Id))
400 static void PrintHelpOptionList(raw_ostream &OS, StringRef Title,
401 std::vector<OptionInfo> &OptionHelp) {
402 OS << Title << ":\n";
404 // Find the maximum option length.
405 unsigned OptionFieldWidth = 0;
406 for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
407 // Limit the amount of padding we are willing to give up for alignment.
408 unsigned Length = OptionHelp[i].Name.size();
410 OptionFieldWidth = std::max(OptionFieldWidth, Length);
413 const unsigned InitialPad = 2;
414 for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
415 const std::string &Option = OptionHelp[i].Name;
416 int Pad = OptionFieldWidth - int(Option.size());
417 OS.indent(InitialPad) << Option;
419 // Break on long option names.
422 Pad = OptionFieldWidth + InitialPad;
424 OS.indent(Pad + 1) << OptionHelp[i].HelpText << '\n';
428 static const char *getOptionHelpGroup(const OptTable &Opts, OptSpecifier Id) {
429 unsigned GroupID = Opts.getOptionGroupID(Id);
431 // If not in a group, return the default help group.
435 // Abuse the help text of the option groups to store the "help group"
438 // FIXME: Split out option groups.
439 if (const char *GroupHelp = Opts.getOptionHelpText(GroupID))
442 // Otherwise keep looking.
443 return getOptionHelpGroup(Opts, GroupID);
446 void OptTable::PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
447 bool ShowHidden) const {
448 PrintHelp(OS, Name, Title, /*Include*/ 0, /*Exclude*/
449 (ShowHidden ? 0 : HelpHidden));
453 void OptTable::PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
454 unsigned FlagsToInclude,
455 unsigned FlagsToExclude) const {
456 OS << "OVERVIEW: " << Title << "\n";
458 OS << "USAGE: " << Name << " [options] <inputs>\n";
461 // Render help text into a map of group-name to a list of (option, help)
463 using helpmap_ty = std::map<std::string, std::vector<OptionInfo>>;
464 helpmap_ty GroupedOptionHelp;
466 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
469 // FIXME: Split out option groups.
470 if (getOptionKind(Id) == Option::GroupClass)
473 unsigned Flags = getInfo(Id).Flags;
474 if (FlagsToInclude && !(Flags & FlagsToInclude))
476 if (Flags & FlagsToExclude)
479 if (const char *Text = getOptionHelpText(Id)) {
480 const char *HelpGroup = getOptionHelpGroup(*this, Id);
481 const std::string &OptName = getOptionHelpName(*this, Id);
482 GroupedOptionHelp[HelpGroup].push_back({OptName, Text});
486 for (helpmap_ty::iterator it = GroupedOptionHelp .begin(),
487 ie = GroupedOptionHelp.end(); it != ie; ++it) {
488 if (it != GroupedOptionHelp .begin())
490 PrintHelpOptionList(OS, it->first, it->second);