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 "clang/Driver/OptTable.h"
11 #include "clang/Driver/Arg.h"
12 #include "clang/Driver/ArgList.h"
13 #include "clang/Driver/Option.h"
14 #include "llvm/Support/raw_ostream.h"
18 using namespace clang::driver;
19 using namespace clang::driver::options;
21 // Ordering on Info. The ordering is *almost* lexicographic, with two
22 // exceptions. First, '\0' comes at the end of the alphabet instead of
23 // the beginning (thus options preceed any other options which prefix
24 // them). Second, for options with the same name, the less permissive
25 // version should come first; a Flag option should preceed a Joined
26 // option, for example.
28 static int StrCmpOptionName(const char *A, const char *B) {
38 if (a == '\0') // A is a prefix of B.
40 if (b == '\0') // B is a prefix of A.
43 // Otherwise lexicographic.
44 return (a < b) ? -1 : 1;
49 static inline bool operator<(const OptTable::Info &A, const OptTable::Info &B) {
53 if (int N = StrCmpOptionName(A.Name, B.Name))
56 // Names are the same, check that classes are in order; exactly one
57 // should be joined, and it should succeed the other.
58 assert(((A.Kind == Option::JoinedClass) ^ (B.Kind == Option::JoinedClass)) &&
59 "Unexpected classes for options with same name.");
60 return B.Kind == Option::JoinedClass;
63 // Support lower_bound between info and an option name.
64 static inline bool operator<(const OptTable::Info &I, const char *Name) {
65 return StrCmpOptionName(I.Name, Name) == -1;
67 static inline bool operator<(const char *Name, const OptTable::Info &I) {
68 return StrCmpOptionName(Name, I.Name) == -1;
75 OptSpecifier::OptSpecifier(const Option *Opt) : ID(Opt->getID()) {}
79 OptTable::OptTable(const Info *_OptionInfos, unsigned _NumOptionInfos)
80 : OptionInfos(_OptionInfos), NumOptionInfos(_NumOptionInfos),
81 Options(new Option*[NumOptionInfos]),
82 TheInputOption(0), TheUnknownOption(0), FirstSearchableIndex(0)
84 // Explicitly zero initialize the error to work around a bug in array
85 // value-initialization on MinGW with gcc 4.3.5.
86 memset(Options, 0, sizeof(*Options) * NumOptionInfos);
88 // Find start of normal options.
89 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
90 unsigned Kind = getInfo(i + 1).Kind;
91 if (Kind == Option::InputClass) {
92 assert(!TheInputOption && "Cannot have multiple input options!");
93 TheInputOption = getOption(i + 1);
94 } else if (Kind == Option::UnknownClass) {
95 assert(!TheUnknownOption && "Cannot have multiple input options!");
96 TheUnknownOption = getOption(i + 1);
97 } else if (Kind != Option::GroupClass) {
98 FirstSearchableIndex = i;
102 assert(FirstSearchableIndex != 0 && "No searchable options?");
105 // Check that everything after the first searchable option is a
106 // regular option class.
107 for (unsigned i = FirstSearchableIndex, e = getNumOptions(); i != e; ++i) {
108 Option::OptionClass Kind = (Option::OptionClass) getInfo(i + 1).Kind;
109 assert((Kind != Option::InputClass && Kind != Option::UnknownClass &&
110 Kind != Option::GroupClass) &&
111 "Special options should be defined first!");
114 // Check that options are in order.
115 for (unsigned i = FirstSearchableIndex+1, e = getNumOptions(); i != e; ++i) {
116 if (!(getInfo(i) < getInfo(i + 1))) {
117 getOption(i)->dump();
118 getOption(i + 1)->dump();
119 assert(0 && "Options are not in order!");
125 OptTable::~OptTable() {
126 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
131 Option *OptTable::CreateOption(unsigned id) const {
132 const Info &info = getInfo(id);
133 const OptionGroup *Group =
134 cast_or_null<OptionGroup>(getOption(info.GroupID));
135 const Option *Alias = getOption(info.AliasID);
139 case Option::InputClass:
140 Opt = new InputOption(id); break;
141 case Option::UnknownClass:
142 Opt = new UnknownOption(id); break;
143 case Option::GroupClass:
144 Opt = new OptionGroup(id, info.Name, Group); break;
145 case Option::FlagClass:
146 Opt = new FlagOption(id, info.Name, Group, Alias); break;
147 case Option::JoinedClass:
148 Opt = new JoinedOption(id, info.Name, Group, Alias); break;
149 case Option::SeparateClass:
150 Opt = new SeparateOption(id, info.Name, Group, Alias); break;
151 case Option::CommaJoinedClass:
152 Opt = new CommaJoinedOption(id, info.Name, Group, Alias); break;
153 case Option::MultiArgClass:
154 Opt = new MultiArgOption(id, info.Name, Group, Alias, info.Param); break;
155 case Option::JoinedOrSeparateClass:
156 Opt = new JoinedOrSeparateOption(id, info.Name, Group, Alias); break;
157 case Option::JoinedAndSeparateClass:
158 Opt = new JoinedAndSeparateOption(id, info.Name, Group, Alias); break;
161 if (info.Flags & DriverOption)
162 Opt->setDriverOption(true);
163 if (info.Flags & LinkerInput)
164 Opt->setLinkerInput(true);
165 if (info.Flags & NoArgumentUnused)
166 Opt->setNoArgumentUnused(true);
167 if (info.Flags & RenderAsInput)
168 Opt->setNoOptAsInput(true);
169 if (info.Flags & RenderJoined) {
170 assert((info.Kind == Option::JoinedOrSeparateClass ||
171 info.Kind == Option::SeparateClass) && "Invalid option.");
172 Opt->setForceJoinedRender(true);
174 if (info.Flags & RenderSeparate) {
175 assert((info.Kind == Option::JoinedOrSeparateClass ||
176 info.Kind == Option::JoinedClass) && "Invalid option.");
177 Opt->setForceSeparateRender(true);
179 if (info.Flags & Unsupported)
180 Opt->setUnsupported(true);
185 Arg *OptTable::ParseOneArg(const InputArgList &Args, unsigned &Index) const {
186 unsigned Prev = Index;
187 const char *Str = Args.getArgString(Index);
189 // Anything that doesn't start with '-' is an input, as is '-' itself.
190 if (Str[0] != '-' || Str[1] == '\0')
191 return new PositionalArg(TheInputOption, Index++);
193 const Info *Start = OptionInfos + FirstSearchableIndex;
194 const Info *End = OptionInfos + getNumOptions();
196 // Search for the first next option which could be a prefix.
197 Start = std::lower_bound(Start, End, Str);
199 // Options are stored in sorted order, with '\0' at the end of the
200 // alphabet. Since the only options which can accept a string must
201 // prefix it, we iteratively search for the next option which could
204 // FIXME: This is searching much more than necessary, but I am
205 // blanking on the simplest way to make it fast. We can solve this
206 // problem when we move to TableGen.
207 for (; Start != End; ++Start) {
208 // Scan for first option which is a proper prefix.
209 for (; Start != End; ++Start)
210 if (memcmp(Str, Start->Name, strlen(Start->Name)) == 0)
215 // See if this option matches.
216 if (Arg *A = getOption(Start - OptionInfos + 1)->accept(Args, Index))
219 // Otherwise, see if this argument was missing values.
224 return new PositionalArg(TheUnknownOption, Index++);
227 InputArgList *OptTable::ParseArgs(const char **ArgBegin, const char **ArgEnd,
228 unsigned &MissingArgIndex,
229 unsigned &MissingArgCount) const {
230 InputArgList *Args = new InputArgList(ArgBegin, ArgEnd);
232 // FIXME: Handle '@' args (or at least error on them).
234 MissingArgIndex = MissingArgCount = 0;
235 unsigned Index = 0, End = ArgEnd - ArgBegin;
236 while (Index < End) {
237 // Ignore empty arguments (other things may still take them as arguments).
238 if (Args->getArgString(Index)[0] == '\0') {
243 unsigned Prev = Index;
244 Arg *A = ParseOneArg(*Args, Index);
245 assert(Index > Prev && "Parser failed to consume argument.");
247 // Check for missing argument error.
249 assert(Index >= End && "Unexpected parser error.");
250 assert(Index - Prev - 1 && "No missing arguments!");
251 MissingArgIndex = Prev;
252 MissingArgCount = Index - Prev - 1;
262 static std::string getOptionHelpName(const OptTable &Opts, OptSpecifier Id) {
263 std::string Name = Opts.getOptionName(Id);
265 // Add metavar, if used.
266 switch (Opts.getOptionKind(Id)) {
267 case Option::GroupClass: case Option::InputClass: case Option::UnknownClass:
268 assert(0 && "Invalid option with help text.");
270 case Option::MultiArgClass: case Option::JoinedAndSeparateClass:
271 assert(0 && "Cannot print metavar for this kind of option.");
273 case Option::FlagClass:
276 case Option::SeparateClass: case Option::JoinedOrSeparateClass:
279 case Option::JoinedClass: case Option::CommaJoinedClass:
280 if (const char *MetaVarName = Opts.getOptionMetaVar(Id))
290 static void PrintHelpOptionList(llvm::raw_ostream &OS, llvm::StringRef Title,
291 std::vector<std::pair<std::string,
292 const char*> > &OptionHelp) {
293 OS << Title << ":\n";
295 // Find the maximum option length.
296 unsigned OptionFieldWidth = 0;
297 for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
299 if (!OptionHelp[i].second)
302 // Limit the amount of padding we are willing to give up for alignment.
303 unsigned Length = OptionHelp[i].first.size();
305 OptionFieldWidth = std::max(OptionFieldWidth, Length);
308 const unsigned InitialPad = 2;
309 for (unsigned i = 0, e = OptionHelp.size(); i != e; ++i) {
310 const std::string &Option = OptionHelp[i].first;
311 int Pad = OptionFieldWidth - int(Option.size());
312 OS.indent(InitialPad) << Option;
314 // Break on long option names.
317 Pad = OptionFieldWidth + InitialPad;
319 OS.indent(Pad + 1) << OptionHelp[i].second << '\n';
323 static const char *getOptionHelpGroup(const OptTable &Opts, OptSpecifier Id) {
324 unsigned GroupID = Opts.getOptionGroupID(Id);
326 // If not in a group, return the default help group.
330 // Abuse the help text of the option groups to store the "help group"
333 // FIXME: Split out option groups.
334 if (const char *GroupHelp = Opts.getOptionHelpText(GroupID))
337 // Otherwise keep looking.
338 return getOptionHelpGroup(Opts, GroupID);
341 void OptTable::PrintHelp(llvm::raw_ostream &OS, const char *Name,
342 const char *Title, bool ShowHidden) const {
343 OS << "OVERVIEW: " << Title << "\n";
345 OS << "USAGE: " << Name << " [options] <inputs>\n";
348 // Render help text into a map of group-name to a list of (option, help)
350 typedef std::map<std::string,
351 std::vector<std::pair<std::string, const char*> > > helpmap_ty;
352 helpmap_ty GroupedOptionHelp;
354 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
357 // FIXME: Split out option groups.
358 if (getOptionKind(Id) == Option::GroupClass)
361 if (!ShowHidden && isOptionHelpHidden(Id))
364 if (const char *Text = getOptionHelpText(Id)) {
365 const char *HelpGroup = getOptionHelpGroup(*this, Id);
366 const std::string &OptName = getOptionHelpName(*this, Id);
367 GroupedOptionHelp[HelpGroup].push_back(std::make_pair(OptName, Text));
371 for (helpmap_ty::iterator it = GroupedOptionHelp .begin(),
372 ie = GroupedOptionHelp.end(); it != ie; ++it) {
373 if (it != GroupedOptionHelp .begin())
375 PrintHelpOptionList(OS, it->first, it->second);