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/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"
20 using namespace llvm::opt;
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.
29 static int StrCmpOptionName(const char *A, const char *B) {
39 if (a == '\0') // A is a prefix of B.
41 if (b == '\0') // B is a prefix of A.
44 // Otherwise lexicographic.
45 return (a < b) ? -1 : 1;
51 static inline bool operator<(const OptTable::Info &A, const OptTable::Info &B) {
55 if (int N = StrCmpOptionName(A.Name, B.Name))
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))
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;
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;
76 static inline bool operator<(const char *Name, const OptTable::Info &I) {
77 return StrCmpOptionName(Name, I.Name) == -1;
82 OptSpecifier::OptSpecifier(const Option *Opt) : ID(Opt->getID()) {}
84 OptTable::OptTable(const Info *_OptionInfos, unsigned _NumOptionInfos)
85 : OptionInfos(_OptionInfos),
86 NumOptionInfos(_NumOptionInfos),
88 TheUnknownOptionID(0),
89 FirstSearchableIndex(0)
91 // Explicitly zero initialize the error to work around a bug in array
92 // value-initialization on MinGW with gcc 4.3.5.
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;
108 assert(FirstSearchableIndex != 0 && "No searchable options?");
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!");
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))) {
124 getOption(i + 1).dump();
125 llvm_unreachable("Options are not in order!");
131 for (unsigned i = FirstSearchableIndex + 1, e = getNumOptions() + 1;
133 if (const char *const *P = getInfo(i).Prefixes) {
134 for (; *P != 0; ++P) {
135 PrefixesUnion.insert(*P);
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();
146 if (std::find(PrefixChars.begin(), PrefixChars.end(), *C)
147 == PrefixChars.end())
148 PrefixChars.push_back(*C);
152 OptTable::~OptTable() {
155 const Option OptTable::getOption(OptSpecifier Opt) const {
156 unsigned id = Opt.getID();
159 assert((unsigned) (id - 1) < getNumOptions() && "Invalid ID.");
160 return Option(&getInfo(id), this);
163 static bool isInput(const llvm::StringSet<> &Prefixes, StringRef Arg) {
166 for (llvm::StringSet<>::const_iterator I = Prefixes.begin(),
167 E = Prefixes.end(); I != E; ++I)
168 if (Arg.startswith(I->getKey()))
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();
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);
189 // Anything that doesn't start with PrefixesUnion is an input, as is '-'
191 if (isInput(PrefixesUnion, Str))
192 return new Arg(getOption(TheInputOptionID), Str, Index++, Str);
194 const Info *Start = OptionInfos + FirstSearchableIndex;
195 const Info *End = OptionInfos + getNumOptions();
196 StringRef Name = StringRef(Str).ltrim(PrefixChars);
198 // Search for the first next option which could be a prefix.
199 Start = std::lower_bound(Start, End, Name.data());
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
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)))
218 Option Opt(Start, this);
220 if (FlagsToInclude && !Opt.hasFlag(FlagsToInclude))
222 if (Opt.hasFlag(FlagsToExclude))
225 // See if this option matches.
226 if (Arg *A = Opt.accept(Args, Index, ArgSize))
229 // Otherwise, see if this argument was missing values.
234 // If we failed to find an option and this arg started with /, then it's
235 // probably an input path.
237 return new Arg(getOption(TheInputOptionID), Str, Index++, Str);
239 return new Arg(getOption(TheUnknownOptionID), Str, Index++, Str);
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);
250 // FIXME: Handle '@' args (or at least error on them).
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 if (Args->getArgString(Index)[0] == '\0') {
261 unsigned Prev = Index;
262 Arg *A = ParseOneArg(*Args, Index, FlagsToInclude, FlagsToExclude);
263 assert(Index > Prev && "Parser failed to consume argument.");
265 // Check for missing argument error.
267 assert(Index >= End && "Unexpected parser error.");
268 assert(Index - Prev - 1 && "No missing arguments!");
269 MissingArgIndex = Prev;
270 MissingArgCount = Index - Prev - 1;
280 static std::string getOptionHelpName(const OptTable &Opts, OptSpecifier Id) {
281 const Option O = Opts.getOption(Id);
282 std::string Name = O.getPrefixedName();
284 // Add metavar, if used.
285 switch (O.getKind()) {
286 case Option::GroupClass: case Option::InputClass: case Option::UnknownClass:
287 llvm_unreachable("Invalid option with help text.");
289 case Option::MultiArgClass:
290 llvm_unreachable("Cannot print metavar for this kind of option.");
292 case Option::FlagClass:
295 case Option::SeparateClass: case Option::JoinedOrSeparateClass:
298 case Option::JoinedClass: case Option::CommaJoinedClass:
299 case Option::JoinedAndSeparateClass:
300 if (const char *MetaVarName = Opts.getOptionMetaVar(Id))
310 static void PrintHelpOptionList(raw_ostream &OS, StringRef Title,
311 std::vector<std::pair<std::string,
312 const char*> > &OptionHelp) {
313 OS << Title << ":\n";
315 // Find the maximum option length.
316 unsigned OptionFieldWidth = 0;
317 for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
319 if (!OptionHelp[i].second)
322 // Limit the amount of padding we are willing to give up for alignment.
323 unsigned Length = OptionHelp[i].first.size();
325 OptionFieldWidth = std::max(OptionFieldWidth, Length);
328 const unsigned InitialPad = 2;
329 for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
330 const std::string &Option = OptionHelp[i].first;
331 int Pad = OptionFieldWidth - int(Option.size());
332 OS.indent(InitialPad) << Option;
334 // Break on long option names.
337 Pad = OptionFieldWidth + InitialPad;
339 OS.indent(Pad + 1) << OptionHelp[i].second << '\n';
343 static const char *getOptionHelpGroup(const OptTable &Opts, OptSpecifier Id) {
344 unsigned GroupID = Opts.getOptionGroupID(Id);
346 // If not in a group, return the default help group.
350 // Abuse the help text of the option groups to store the "help group"
353 // FIXME: Split out option groups.
354 if (const char *GroupHelp = Opts.getOptionHelpText(GroupID))
357 // Otherwise keep looking.
358 return getOptionHelpGroup(Opts, GroupID);
361 void OptTable::PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
362 bool ShowHidden) const {
363 PrintHelp(OS, Name, Title, /*Include*/ 0, /*Exclude*/
364 (ShowHidden ? 0 : HelpHidden));
368 void OptTable::PrintHelp(raw_ostream &OS, const char *Name, const char *Title,
369 unsigned FlagsToInclude,
370 unsigned FlagsToExclude) const {
371 OS << "OVERVIEW: " << Title << "\n";
373 OS << "USAGE: " << Name << " [options] <inputs>\n";
376 // Render help text into a map of group-name to a list of (option, help)
378 typedef std::map<std::string,
379 std::vector<std::pair<std::string, const char*> > > helpmap_ty;
380 helpmap_ty GroupedOptionHelp;
382 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
385 // FIXME: Split out option groups.
386 if (getOptionKind(Id) == Option::GroupClass)
389 unsigned Flags = getInfo(Id).Flags;
390 if (FlagsToInclude && !(Flags & FlagsToInclude))
392 if (Flags & FlagsToExclude)
395 if (const char *Text = getOptionHelpText(Id)) {
396 const char *HelpGroup = getOptionHelpGroup(*this, Id);
397 const std::string &OptName = getOptionHelpName(*this, Id);
398 GroupedOptionHelp[HelpGroup].push_back(std::make_pair(OptName, Text));
402 for (helpmap_ty::iterator it = GroupedOptionHelp .begin(),
403 ie = GroupedOptionHelp.end(); it != ie; ++it) {
404 if (it != GroupedOptionHelp .begin())
406 PrintHelpOptionList(OS, it->first, it->second);