blob: 50173f5256bffeebf61832bccae3108aa2da3b29 [file] [log] [blame]
Chris Lattner36a57d32001-07-23 17:17:47 +00001//===-- CommandLine.cpp - Command line parser implementation --------------===//
Misha Brukman10468d82005-04-21 22:55:34 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman10468d82005-04-21 22:55:34 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner36a57d32001-07-23 17:17:47 +00009//
10// This class implements a command line argument processor that is useful when
11// creating a tool. It provides a simple, minimalistic interface that is easily
12// extensible and supports nonlocal (library) command line options.
13//
Chris Lattner81cc83d2001-07-23 23:04:07 +000014// Note that rather than trying to figure out what this code does, you could try
15// reading the library documentation located in docs/CommandLine.html
16//
Chris Lattner36a57d32001-07-23 17:17:47 +000017//===----------------------------------------------------------------------===//
18
Reid Spencer7c16caa2004-09-01 22:55:40 +000019#include "llvm/Support/CommandLine.h"
Peter Collingbournee1863192014-10-16 22:47:52 +000020#include "llvm-c/Support.h"
Reid Klecknera73c7782013-07-18 16:52:05 +000021#include "llvm/ADT/ArrayRef.h"
Zachary Turner07670b32016-06-29 21:48:26 +000022#include "llvm/ADT/DenseMap.h"
David Majnemerafb38af2016-07-24 17:19:59 +000023#include "llvm/ADT/Optional.h"
Benjamin Kramerbd5ee502015-03-14 00:20:13 +000024#include "llvm/ADT/STLExtras.h"
Chris Lattner41f8b0b2009-09-20 05:12:14 +000025#include "llvm/ADT/SmallPtrSet.h"
Chris Lattnerfa9c6f42009-09-19 23:59:02 +000026#include "llvm/ADT/SmallString.h"
Pavel Labathec000f42017-06-23 12:55:02 +000027#include "llvm/ADT/StringExtras.h"
Chris Lattner41f8b0b2009-09-20 05:12:14 +000028#include "llvm/ADT/StringMap.h"
Chris Lattneraecd74d2009-09-19 18:55:05 +000029#include "llvm/ADT/Twine.h"
Chris Lattner36b3caf2009-08-23 18:09:02 +000030#include "llvm/Config/config.h"
Reid Klecknera73c7782013-07-18 16:52:05 +000031#include "llvm/Support/ConvertUTF.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000032#include "llvm/Support/Debug.h"
33#include "llvm/Support/ErrorHandling.h"
Serge Pavlovf258ff12016-11-20 06:25:07 +000034#include "llvm/Support/FileSystem.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000035#include "llvm/Support/Host.h"
36#include "llvm/Support/ManagedStatic.h"
37#include "llvm/Support/MemoryBuffer.h"
38#include "llvm/Support/Path.h"
David Majnemerafb38af2016-07-24 17:19:59 +000039#include "llvm/Support/Process.h"
Rafael Espindola454adf62015-06-13 12:49:52 +000040#include "llvm/Support/StringSaver.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000041#include "llvm/Support/raw_ostream.h"
Chris Lattner36b3caf2009-08-23 18:09:02 +000042#include <cstdlib>
Andrew Trick0537a982013-05-06 21:56:23 +000043#include <map>
Chris Lattnerc9499b62003-12-14 21:35:53 +000044using namespace llvm;
Chris Lattner36a57d32001-07-23 17:17:47 +000045using namespace cl;
46
Chandler Carruthe96dd892014-04-21 22:55:11 +000047#define DEBUG_TYPE "commandline"
48
Mandeep Singh Grangf6b069c2016-12-14 00:15:57 +000049#if LLVM_ENABLE_ABI_BREAKING_CHECKS
50namespace llvm {
51// If LLVM_ENABLE_ABI_BREAKING_CHECKS is set the flag -mllvm -reverse-iterate
52// can be used to toggle forward/reverse iteration of unordered containers.
53// This will help uncover differences in codegen caused due to undefined
54// iteration order.
55static cl::opt<bool, true> ReverseIteration("reverse-iterate",
Mehdi Amini76a00b52016-12-14 02:35:32 +000056 cl::location(ReverseIterate<bool>::value));
Mandeep Singh Grangf6b069c2016-12-14 00:15:57 +000057}
58#endif
59
Chris Lattner3e5d60f2006-08-27 12:45:47 +000060//===----------------------------------------------------------------------===//
61// Template instantiations and anchors.
62//
Chris Bieneman5d232242015-01-13 19:14:20 +000063namespace llvm {
64namespace cl {
Benjamin Kramera667d1a2015-07-13 17:21:31 +000065template class basic_parser<bool>;
66template class basic_parser<boolOrDefault>;
67template class basic_parser<int>;
68template class basic_parser<unsigned>;
69template class basic_parser<unsigned long long>;
70template class basic_parser<double>;
71template class basic_parser<float>;
72template class basic_parser<std::string>;
73template class basic_parser<char>;
Chris Lattner3e5d60f2006-08-27 12:45:47 +000074
Benjamin Kramera667d1a2015-07-13 17:21:31 +000075template class opt<unsigned>;
76template class opt<int>;
77template class opt<std::string>;
78template class opt<char>;
79template class opt<bool>;
Alexander Kornienkof00654e2015-06-23 09:49:53 +000080}
81} // end namespace llvm::cl
Chris Lattner3e5d60f2006-08-27 12:45:47 +000082
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +000083// Pin the vtables to this file.
84void GenericOptionValue::anchor() {}
David Blaikie3a15e142011-12-01 08:00:17 +000085void OptionValue<boolOrDefault>::anchor() {}
86void OptionValue<std::string>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000087void Option::anchor() {}
88void basic_parser_impl::anchor() {}
89void parser<bool>::anchor() {}
Dale Johannesen82810c82007-05-22 17:14:46 +000090void parser<boolOrDefault>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000091void parser<int>::anchor() {}
92void parser<unsigned>::anchor() {}
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +000093void parser<unsigned long long>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000094void parser<double>::anchor() {}
95void parser<float>::anchor() {}
96void parser<std::string>::anchor() {}
Bill Wendlingdb59fda2009-04-29 23:26:16 +000097void parser<char>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000098
99//===----------------------------------------------------------------------===//
100
Benjamin Kramer970eac42015-02-06 17:51:54 +0000101namespace {
102
Chris Bienemand1d94302015-01-28 19:00:25 +0000103class CommandLineParser {
104public:
105 // Globals for name and overview of program. Program name is not a string to
106 // avoid static ctor/dtor issues.
Chris Bienemanb6866422015-01-28 22:25:00 +0000107 std::string ProgramName;
Mehdi Aminie11b7452016-10-01 03:43:20 +0000108 StringRef ProgramOverview;
Reid Spencer9501b9b2004-09-01 04:41:28 +0000109
Chris Bienemand1d94302015-01-28 19:00:25 +0000110 // This collects additional help to be printed.
Mehdi Aminie11b7452016-10-01 03:43:20 +0000111 std::vector<StringRef> MoreHelp;
Chris Bienemand1d94302015-01-28 19:00:25 +0000112
Chris Bieneman67e426a2015-02-13 22:54:32 +0000113 // This collects the different option categories that have been registered.
114 SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories;
115
Zachary Turner07670b32016-06-29 21:48:26 +0000116 // This collects the different subcommands that have been registered.
117 SmallPtrSet<SubCommand *, 4> RegisteredSubCommands;
Chris Bienemand1d94302015-01-28 19:00:25 +0000118
Mehdi Aminie11b7452016-10-01 03:43:20 +0000119 CommandLineParser() : ActiveSubCommand(nullptr) {
Zachary Turner07670b32016-06-29 21:48:26 +0000120 registerSubCommand(&*TopLevelSubCommand);
121 registerSubCommand(&*AllSubCommands);
122 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000123
Zachary Turner07670b32016-06-29 21:48:26 +0000124 void ResetAllOptionOccurrences();
125
126 bool ParseCommandLineOptions(int argc, const char *const *argv,
Eric Liue51ee062017-03-15 08:41:00 +0000127 StringRef Overview, raw_ostream *Errs = nullptr);
Zachary Turner07670b32016-06-29 21:48:26 +0000128
Mehdi Aminie11b7452016-10-01 03:43:20 +0000129 void addLiteralOption(Option &Opt, SubCommand *SC, StringRef Name) {
Zachary Turner07670b32016-06-29 21:48:26 +0000130 if (Opt.hasArgStr())
131 return;
132 if (!SC->OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
133 errs() << ProgramName << ": CommandLine Error: Option '" << Name
134 << "' registered more than once!\n";
135 report_fatal_error("inconsistency in registered CommandLine options");
136 }
137
138 // If we're adding this to all sub-commands, add it to the ones that have
139 // already been registered.
140 if (SC == &*AllSubCommands) {
141 for (const auto &Sub : RegisteredSubCommands) {
142 if (SC == Sub)
143 continue;
144 addLiteralOption(Opt, Sub, Name);
Chris Bienemand1d94302015-01-28 19:00:25 +0000145 }
146 }
147 }
148
Mehdi Aminie11b7452016-10-01 03:43:20 +0000149 void addLiteralOption(Option &Opt, StringRef Name) {
Zachary Turner07670b32016-06-29 21:48:26 +0000150 if (Opt.Subs.empty())
151 addLiteralOption(Opt, &*TopLevelSubCommand, Name);
152 else {
153 for (auto SC : Opt.Subs)
154 addLiteralOption(Opt, SC, Name);
155 }
156 }
157
158 void addOption(Option *O, SubCommand *SC) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000159 bool HadErrors = false;
David Blaikieff43d692015-11-17 19:00:52 +0000160 if (O->hasArgStr()) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000161 // Add argument to the argument map!
Zachary Turner07670b32016-06-29 21:48:26 +0000162 if (!SC->OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000163 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
164 << "' registered more than once!\n";
165 HadErrors = true;
166 }
167 }
168
169 // Remember information about positional options.
170 if (O->getFormattingFlag() == cl::Positional)
Zachary Turner07670b32016-06-29 21:48:26 +0000171 SC->PositionalOpts.push_back(O);
Chris Bienemand1d94302015-01-28 19:00:25 +0000172 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
Zachary Turner07670b32016-06-29 21:48:26 +0000173 SC->SinkOpts.push_back(O);
Chris Bienemand1d94302015-01-28 19:00:25 +0000174 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
Zachary Turner07670b32016-06-29 21:48:26 +0000175 if (SC->ConsumeAfterOpt) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000176 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
177 HadErrors = true;
178 }
Zachary Turner07670b32016-06-29 21:48:26 +0000179 SC->ConsumeAfterOpt = O;
Chris Bienemand1d94302015-01-28 19:00:25 +0000180 }
181
182 // Fail hard if there were errors. These are strictly unrecoverable and
183 // indicate serious issues such as conflicting option names or an
184 // incorrectly
185 // linked LLVM distribution.
186 if (HadErrors)
187 report_fatal_error("inconsistency in registered CommandLine options");
Zachary Turner07670b32016-06-29 21:48:26 +0000188
189 // If we're adding this to all sub-commands, add it to the ones that have
190 // already been registered.
191 if (SC == &*AllSubCommands) {
192 for (const auto &Sub : RegisteredSubCommands) {
193 if (SC == Sub)
194 continue;
195 addOption(O, Sub);
196 }
197 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000198 }
199
Zachary Turner07670b32016-06-29 21:48:26 +0000200 void addOption(Option *O) {
201 if (O->Subs.empty()) {
202 addOption(O, &*TopLevelSubCommand);
203 } else {
204 for (auto SC : O->Subs)
205 addOption(O, SC);
206 }
207 }
208
209 void removeOption(Option *O, SubCommand *SC) {
David Blaikieff43d692015-11-17 19:00:52 +0000210 SmallVector<StringRef, 16> OptionNames;
Chris Bienemand1d94302015-01-28 19:00:25 +0000211 O->getExtraOptionNames(OptionNames);
David Blaikieff43d692015-11-17 19:00:52 +0000212 if (O->hasArgStr())
Chris Bienemand1d94302015-01-28 19:00:25 +0000213 OptionNames.push_back(O->ArgStr);
Zachary Turner07670b32016-06-29 21:48:26 +0000214
215 SubCommand &Sub = *SC;
Chris Bienemand1d94302015-01-28 19:00:25 +0000216 for (auto Name : OptionNames)
Zachary Turner07670b32016-06-29 21:48:26 +0000217 Sub.OptionsMap.erase(Name);
Chris Bienemand1d94302015-01-28 19:00:25 +0000218
219 if (O->getFormattingFlag() == cl::Positional)
Zachary Turner07670b32016-06-29 21:48:26 +0000220 for (auto Opt = Sub.PositionalOpts.begin();
221 Opt != Sub.PositionalOpts.end(); ++Opt) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000222 if (*Opt == O) {
Zachary Turner07670b32016-06-29 21:48:26 +0000223 Sub.PositionalOpts.erase(Opt);
Chris Bienemand1d94302015-01-28 19:00:25 +0000224 break;
225 }
226 }
227 else if (O->getMiscFlags() & cl::Sink)
Zachary Turner07670b32016-06-29 21:48:26 +0000228 for (auto Opt = Sub.SinkOpts.begin(); Opt != Sub.SinkOpts.end(); ++Opt) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000229 if (*Opt == O) {
Zachary Turner07670b32016-06-29 21:48:26 +0000230 Sub.SinkOpts.erase(Opt);
Chris Bienemand1d94302015-01-28 19:00:25 +0000231 break;
232 }
233 }
Zachary Turner07670b32016-06-29 21:48:26 +0000234 else if (O == Sub.ConsumeAfterOpt)
235 Sub.ConsumeAfterOpt = nullptr;
Chris Bienemand1d94302015-01-28 19:00:25 +0000236 }
237
Zachary Turner07670b32016-06-29 21:48:26 +0000238 void removeOption(Option *O) {
239 if (O->Subs.empty())
240 removeOption(O, &*TopLevelSubCommand);
241 else {
242 if (O->isInAllSubCommands()) {
243 for (auto SC : RegisteredSubCommands)
244 removeOption(O, SC);
245 } else {
246 for (auto SC : O->Subs)
247 removeOption(O, SC);
248 }
249 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000250 }
251
Zachary Turner07670b32016-06-29 21:48:26 +0000252 bool hasOptions(const SubCommand &Sub) const {
253 return (!Sub.OptionsMap.empty() || !Sub.PositionalOpts.empty() ||
254 nullptr != Sub.ConsumeAfterOpt);
255 }
256
257 bool hasOptions() const {
258 for (const auto &S : RegisteredSubCommands) {
259 if (hasOptions(*S))
260 return true;
261 }
262 return false;
263 }
264
265 SubCommand *getActiveSubCommand() { return ActiveSubCommand; }
266
267 void updateArgStr(Option *O, StringRef NewName, SubCommand *SC) {
268 SubCommand &Sub = *SC;
269 if (!Sub.OptionsMap.insert(std::make_pair(NewName, O)).second) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000270 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
271 << "' registered more than once!\n";
272 report_fatal_error("inconsistency in registered CommandLine options");
273 }
Zachary Turner07670b32016-06-29 21:48:26 +0000274 Sub.OptionsMap.erase(O->ArgStr);
275 }
276
277 void updateArgStr(Option *O, StringRef NewName) {
278 if (O->Subs.empty())
279 updateArgStr(O, NewName, &*TopLevelSubCommand);
280 else {
281 for (auto SC : O->Subs)
282 updateArgStr(O, NewName, SC);
283 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000284 }
Chris Bienemand77bbab2015-01-30 22:16:01 +0000285
286 void printOptionValues();
Chris Bieneman542f56a2015-02-13 22:54:27 +0000287
Chris Bieneman67e426a2015-02-13 22:54:32 +0000288 void registerCategory(OptionCategory *cat) {
Sanjoy Das39c226f2016-06-10 21:18:39 +0000289 assert(count_if(RegisteredOptionCategories,
290 [cat](const OptionCategory *Category) {
291 return cat->getName() == Category->getName();
292 }) == 0 &&
Chris Bieneman67e426a2015-02-13 22:54:32 +0000293 "Duplicate option categories");
294
295 RegisteredOptionCategories.insert(cat);
296 }
297
Zachary Turner07670b32016-06-29 21:48:26 +0000298 void registerSubCommand(SubCommand *sub) {
299 assert(count_if(RegisteredSubCommands,
300 [sub](const SubCommand *Sub) {
Mehdi Aminie11b7452016-10-01 03:43:20 +0000301 return (!sub->getName().empty()) &&
Zachary Turner07670b32016-06-29 21:48:26 +0000302 (Sub->getName() == sub->getName());
303 }) == 0 &&
304 "Duplicate subcommands");
305 RegisteredSubCommands.insert(sub);
306
307 // For all options that have been registered for all subcommands, add the
308 // option to this subcommand now.
309 if (sub != &*AllSubCommands) {
310 for (auto &E : AllSubCommands->OptionsMap) {
311 Option *O = E.second;
312 if ((O->isPositional() || O->isSink() || O->isConsumeAfter()) ||
313 O->hasArgStr())
314 addOption(O, sub);
315 else
Mehdi Aminie11b7452016-10-01 03:43:20 +0000316 addLiteralOption(*O, sub, E.first());
Zachary Turner07670b32016-06-29 21:48:26 +0000317 }
318 }
319 }
320
321 void unregisterSubCommand(SubCommand *sub) {
322 RegisteredSubCommands.erase(sub);
323 }
324
Dean Michael Berris27358cf2016-10-05 05:20:08 +0000325 iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator>
326 getRegisteredSubcommands() {
327 return make_range(RegisteredSubCommands.begin(),
328 RegisteredSubCommands.end());
329 }
330
Zachary Turner07670b32016-06-29 21:48:26 +0000331 void reset() {
332 ActiveSubCommand = nullptr;
333 ProgramName.clear();
Mehdi Aminie11b7452016-10-01 03:43:20 +0000334 ProgramOverview = StringRef();
Zachary Turner07670b32016-06-29 21:48:26 +0000335
336 MoreHelp.clear();
337 RegisteredOptionCategories.clear();
338
339 ResetAllOptionOccurrences();
340 RegisteredSubCommands.clear();
341
342 TopLevelSubCommand->reset();
343 AllSubCommands->reset();
344 registerSubCommand(&*TopLevelSubCommand);
345 registerSubCommand(&*AllSubCommands);
346 }
347
Chris Bieneman542f56a2015-02-13 22:54:27 +0000348private:
Zachary Turner07670b32016-06-29 21:48:26 +0000349 SubCommand *ActiveSubCommand;
350
351 Option *LookupOption(SubCommand &Sub, StringRef &Arg, StringRef &Value);
Mehdi Aminie11b7452016-10-01 03:43:20 +0000352 SubCommand *LookupSubCommand(StringRef Name);
Chris Bienemand1d94302015-01-28 19:00:25 +0000353};
354
Benjamin Kramer970eac42015-02-06 17:51:54 +0000355} // namespace
356
Chris Bienemand1d94302015-01-28 19:00:25 +0000357static ManagedStatic<CommandLineParser> GlobalParser;
358
Mehdi Aminie11b7452016-10-01 03:43:20 +0000359void cl::AddLiteralOption(Option &O, StringRef Name) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000360 GlobalParser->addLiteralOption(O, Name);
361}
Chris Lattner37bcd992004-11-19 17:08:15 +0000362
Mehdi Aminie11b7452016-10-01 03:43:20 +0000363extrahelp::extrahelp(StringRef Help) : morehelp(Help) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000364 GlobalParser->MoreHelp.push_back(Help);
Chris Lattner37bcd992004-11-19 17:08:15 +0000365}
366
Chris Lattner5247f602007-04-06 21:06:55 +0000367void Option::addArgument() {
Chris Bienemand1d94302015-01-28 19:00:25 +0000368 GlobalParser->addOption(this);
369 FullyInitialized = true;
Chris Lattner5247f602007-04-06 21:06:55 +0000370}
371
Chris Bienemand1d94302015-01-28 19:00:25 +0000372void Option::removeArgument() { GlobalParser->removeOption(this); }
373
David Blaikieff43d692015-11-17 19:00:52 +0000374void Option::setArgStr(StringRef S) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000375 if (FullyInitialized)
376 GlobalParser->updateArgStr(this, S);
Mehdi Aminie4c7f122017-01-08 22:30:43 +0000377 assert((S.empty() || S[0] != '-') && "Option can't start with '-");
Chris Bienemand1d94302015-01-28 19:00:25 +0000378 ArgStr = S;
Jordan Rosec25b0c72014-01-29 18:54:17 +0000379}
380
Andrew Trick0537a982013-05-06 21:56:23 +0000381// Initialise the general option category.
382OptionCategory llvm::cl::GeneralCategory("General options");
383
Benjamin Kramer3a377bc2014-03-01 11:47:00 +0000384void OptionCategory::registerCategory() {
Chris Bieneman67e426a2015-02-13 22:54:32 +0000385 GlobalParser->registerCategory(this);
Andrew Trick0537a982013-05-06 21:56:23 +0000386}
Chris Lattneraf039c52007-04-12 00:36:29 +0000387
Zachary Turner07670b32016-06-29 21:48:26 +0000388// A special subcommand representing no subcommand
389ManagedStatic<SubCommand> llvm::cl::TopLevelSubCommand;
390
391// A special subcommand that can be used to put an option into all subcommands.
392ManagedStatic<SubCommand> llvm::cl::AllSubCommands;
393
394void SubCommand::registerSubCommand() {
395 GlobalParser->registerSubCommand(this);
396}
397
398void SubCommand::unregisterSubCommand() {
399 GlobalParser->unregisterSubCommand(this);
400}
401
402void SubCommand::reset() {
403 PositionalOpts.clear();
404 SinkOpts.clear();
405 OptionsMap.clear();
406
407 ConsumeAfterOpt = nullptr;
408}
409
410SubCommand::operator bool() const {
411 return (GlobalParser->getActiveSubCommand() == this);
412}
413
Chris Lattner5df56c42002-07-22 02:07:59 +0000414//===----------------------------------------------------------------------===//
Chris Lattner3e5d60f2006-08-27 12:45:47 +0000415// Basic, shared command line option processing machinery.
Chris Lattner5df56c42002-07-22 02:07:59 +0000416//
417
Chris Lattner2031b022007-04-05 21:58:17 +0000418/// LookupOption - Lookup the option specified by the specified option on the
419/// command line. If there is a value specified (after an equal sign) return
Chris Lattnere7c1e212009-09-20 05:03:30 +0000420/// that as well. This assumes that leading dashes have already been stripped.
Zachary Turner07670b32016-06-29 21:48:26 +0000421Option *CommandLineParser::LookupOption(SubCommand &Sub, StringRef &Arg,
422 StringRef &Value) {
Chris Lattner5a3fa4e2009-09-20 02:02:24 +0000423 // Reject all dashes.
Chris Bieneman5d232242015-01-13 19:14:20 +0000424 if (Arg.empty())
425 return nullptr;
Zachary Turner07670b32016-06-29 21:48:26 +0000426 assert(&Sub != &*AllSubCommands);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000427
Chris Lattner5a3fa4e2009-09-20 02:02:24 +0000428 size_t EqualPos = Arg.find('=');
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000429
Chris Lattner0a40a972009-09-20 01:53:12 +0000430 // If we have an equals sign, remember the value.
Chris Lattnere7c1e212009-09-20 05:03:30 +0000431 if (EqualPos == StringRef::npos) {
432 // Look up the option.
Zachary Turner07670b32016-06-29 21:48:26 +0000433 auto I = Sub.OptionsMap.find(Arg);
434 if (I == Sub.OptionsMap.end())
435 return nullptr;
436
437 return I != Sub.OptionsMap.end() ? I->second : nullptr;
Chris Lattner5a3fa4e2009-09-20 02:02:24 +0000438 }
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000439
Chris Lattnere7c1e212009-09-20 05:03:30 +0000440 // If the argument before the = is a valid option name, we match. If not,
441 // return Arg unmolested.
Zachary Turner07670b32016-06-29 21:48:26 +0000442 auto I = Sub.OptionsMap.find(Arg.substr(0, EqualPos));
443 if (I == Sub.OptionsMap.end())
Chris Bieneman5d232242015-01-13 19:14:20 +0000444 return nullptr;
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000445
Chris Bieneman5d232242015-01-13 19:14:20 +0000446 Value = Arg.substr(EqualPos + 1);
Chris Lattnere7c1e212009-09-20 05:03:30 +0000447 Arg = Arg.substr(0, EqualPos);
448 return I->second;
Chris Lattner36a57d32001-07-23 17:17:47 +0000449}
450
Mehdi Aminie11b7452016-10-01 03:43:20 +0000451SubCommand *CommandLineParser::LookupSubCommand(StringRef Name) {
452 if (Name.empty())
Zachary Turner07670b32016-06-29 21:48:26 +0000453 return &*TopLevelSubCommand;
454 for (auto S : RegisteredSubCommands) {
455 if (S == &*AllSubCommands)
456 continue;
Mehdi Aminie11b7452016-10-01 03:43:20 +0000457 if (S->getName().empty())
Zachary Turner07670b32016-06-29 21:48:26 +0000458 continue;
459
460 if (StringRef(S->getName()) == StringRef(Name))
461 return S;
462 }
463 return &*TopLevelSubCommand;
464}
465
Daniel Dunbarf4132132011-01-18 01:59:24 +0000466/// LookupNearestOption - Lookup the closest match to the option specified by
467/// the specified option on the command line. If there is a value specified
468/// (after an equal sign) return that as well. This assumes that leading dashes
469/// have already been stripped.
470static Option *LookupNearestOption(StringRef Arg,
Chris Bieneman5d232242015-01-13 19:14:20 +0000471 const StringMap<Option *> &OptionsMap,
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000472 std::string &NearestString) {
Daniel Dunbarf4132132011-01-18 01:59:24 +0000473 // Reject all dashes.
Chris Bieneman5d232242015-01-13 19:14:20 +0000474 if (Arg.empty())
475 return nullptr;
Daniel Dunbarf4132132011-01-18 01:59:24 +0000476
477 // Split on any equal sign.
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000478 std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
Chris Bieneman5d232242015-01-13 19:14:20 +0000479 StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000480 StringRef &RHS = SplitArg.second;
Daniel Dunbarf4132132011-01-18 01:59:24 +0000481
482 // Find the closest match.
Craig Topperc10719f2014-04-07 04:17:22 +0000483 Option *Best = nullptr;
Daniel Dunbarf4132132011-01-18 01:59:24 +0000484 unsigned BestDistance = 0;
Chris Bieneman5d232242015-01-13 19:14:20 +0000485 for (StringMap<Option *>::const_iterator it = OptionsMap.begin(),
486 ie = OptionsMap.end();
487 it != ie; ++it) {
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000488 Option *O = it->second;
David Blaikieff43d692015-11-17 19:00:52 +0000489 SmallVector<StringRef, 16> OptionNames;
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000490 O->getExtraOptionNames(OptionNames);
David Blaikieff43d692015-11-17 19:00:52 +0000491 if (O->hasArgStr())
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000492 OptionNames.push_back(O->ArgStr);
493
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000494 bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
495 StringRef Flag = PermitValue ? LHS : Arg;
David Blaikieff43d692015-11-17 19:00:52 +0000496 for (auto Name : OptionNames) {
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000497 unsigned Distance = StringRef(Name).edit_distance(
Chris Bieneman5d232242015-01-13 19:14:20 +0000498 Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000499 if (!Best || Distance < BestDistance) {
500 Best = O;
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000501 BestDistance = Distance;
Bill Wendling318f03f2012-07-19 00:15:11 +0000502 if (RHS.empty() || !PermitValue)
David Blaikieff43d692015-11-17 19:00:52 +0000503 NearestString = Name;
Bill Wendling318f03f2012-07-19 00:15:11 +0000504 else
David Blaikieff43d692015-11-17 19:00:52 +0000505 NearestString = (Twine(Name) + "=" + RHS).str();
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000506 }
Daniel Dunbarf4132132011-01-18 01:59:24 +0000507 }
508 }
509
510 return Best;
511}
512
Alp Tokercb402912014-01-24 17:20:08 +0000513/// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
514/// that does special handling of cl::CommaSeparated options.
515static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
516 StringRef ArgName, StringRef Value,
517 bool MultiArg = false) {
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000518 // Check to see if this option accepts a comma separated list of values. If
519 // it does, we have to split up the value into multiple values.
520 if (Handler->getMiscFlags() & CommaSeparated) {
521 StringRef Val(Value);
522 StringRef::size_type Pos = Val.find(',');
Chris Lattnere7c1e212009-09-20 05:03:30 +0000523
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000524 while (Pos != StringRef::npos) {
525 // Process the portion before the comma.
526 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
527 return true;
528 // Erase the portion before the comma, AND the comma.
Chris Bieneman5d232242015-01-13 19:14:20 +0000529 Val = Val.substr(Pos + 1);
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000530 // Check for another comma.
531 Pos = Val.find(',');
532 }
533
534 Value = Val;
535 }
536
Alexander Kornienko66da20a2015-12-28 15:46:15 +0000537 return Handler->addOccurrence(pos, ArgName, Value, MultiArg);
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000538}
Chris Lattnere7c1e212009-09-20 05:03:30 +0000539
Chris Lattner40fef802009-09-20 01:49:31 +0000540/// ProvideOption - For Value, this differentiates between an empty value ("")
541/// and a null value (StringRef()). The later is accepted for arguments that
542/// don't allow a value (-foo) the former is rejected (-foo=).
Chris Lattner3b8adaf2009-09-20 00:40:49 +0000543static inline bool ProvideOption(Option *Handler, StringRef ArgName,
David Blaikie0210e972012-02-07 19:36:01 +0000544 StringRef Value, int argc,
545 const char *const *argv, int &i) {
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000546 // Is this a multi-argument option?
547 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
548
Chris Lattnere81c4092001-10-27 05:54:17 +0000549 // Enforce value requirements
550 switch (Handler->getValueExpectedFlag()) {
551 case ValueRequired:
Craig Topper8d399f82014-04-09 04:20:00 +0000552 if (!Value.data()) { // No value specified?
Chris Bieneman5d232242015-01-13 19:14:20 +0000553 if (i + 1 >= argc)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +0000554 return Handler->error("requires a value!");
Chris Lattnerca2552d2009-09-20 00:07:40 +0000555 // Steal the next argument, like for '-o filename'
Michael Ilseman4e654cd2014-12-11 19:46:38 +0000556 assert(argv && "null check");
Mehdi Aminie11b7452016-10-01 03:43:20 +0000557 Value = StringRef(argv[++i]);
Chris Lattnere81c4092001-10-27 05:54:17 +0000558 }
559 break;
560 case ValueDisallowed:
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000561 if (NumAdditionalVals > 0)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +0000562 return Handler->error("multi-valued option specified"
Chris Lattnerca2552d2009-09-20 00:07:40 +0000563 " with ValueDisallowed modifier!");
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000564
Chris Lattner40fef802009-09-20 01:49:31 +0000565 if (Value.data())
Chris Bieneman5d232242015-01-13 19:14:20 +0000566 return Handler->error("does not allow a value! '" + Twine(Value) +
567 "' specified.");
Chris Lattnere81c4092001-10-27 05:54:17 +0000568 break;
Misha Brukman10468d82005-04-21 22:55:34 +0000569 case ValueOptional:
Reid Spencer9501b9b2004-09-01 04:41:28 +0000570 break;
Chris Lattnere81c4092001-10-27 05:54:17 +0000571 }
572
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000573 // If this isn't a multi-arg option, just run the handler.
Chris Lattneraecd74d2009-09-19 18:55:05 +0000574 if (NumAdditionalVals == 0)
Alp Tokercb402912014-01-24 17:20:08 +0000575 return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
Chris Lattneraecd74d2009-09-19 18:55:05 +0000576
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000577 // If it is, run the handle several times.
Chris Lattneraecd74d2009-09-19 18:55:05 +0000578 bool MultiArg = false;
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000579
Chris Lattner40fef802009-09-20 01:49:31 +0000580 if (Value.data()) {
Alp Tokercb402912014-01-24 17:20:08 +0000581 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
Chris Lattneraecd74d2009-09-19 18:55:05 +0000582 return true;
583 --NumAdditionalVals;
584 MultiArg = true;
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000585 }
Chris Lattneraecd74d2009-09-19 18:55:05 +0000586
587 while (NumAdditionalVals > 0) {
Chris Bieneman5d232242015-01-13 19:14:20 +0000588 if (i + 1 >= argc)
Chris Lattneraecd74d2009-09-19 18:55:05 +0000589 return Handler->error("not enough values!");
Michael Ilseman4e654cd2014-12-11 19:46:38 +0000590 assert(argv && "null check");
Mehdi Aminie11b7452016-10-01 03:43:20 +0000591 Value = StringRef(argv[++i]);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000592
Alp Tokercb402912014-01-24 17:20:08 +0000593 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
Chris Lattneraecd74d2009-09-19 18:55:05 +0000594 return true;
595 MultiArg = true;
596 --NumAdditionalVals;
597 }
598 return false;
Chris Lattnere81c4092001-10-27 05:54:17 +0000599}
600
Chris Lattnerca2552d2009-09-20 00:07:40 +0000601static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
Reid Spencer2027a6f2004-08-13 19:47:30 +0000602 int Dummy = i;
Craig Topperc10719f2014-04-07 04:17:22 +0000603 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
Chris Lattner5df56c42002-07-22 02:07:59 +0000604}
Chris Lattnerf0f91052001-11-26 18:58:34 +0000605
Chris Lattner5df56c42002-07-22 02:07:59 +0000606// Option predicates...
607static inline bool isGrouping(const Option *O) {
608 return O->getFormattingFlag() == cl::Grouping;
609}
610static inline bool isPrefixedOrGrouping(const Option *O) {
611 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
612}
613
614// getOptionPred - Check to see if there are any options that satisfy the
615// specified predicate with names that are the prefixes in Name. This is
616// checked by progressively stripping characters off of the name, checking to
617// see if there options that satisfy the predicate. If we find one, return it,
618// otherwise return null.
619//
Chris Lattner3b8adaf2009-09-20 00:40:49 +0000620static Option *getOptionPred(StringRef Name, size_t &Length,
Chris Bieneman5d232242015-01-13 19:14:20 +0000621 bool (*Pred)(const Option *),
622 const StringMap<Option *> &OptionsMap) {
Misha Brukman10468d82005-04-21 22:55:34 +0000623
Chris Bieneman5d232242015-01-13 19:14:20 +0000624 StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name);
Chris Lattnerf0f91052001-11-26 18:58:34 +0000625
Chris Lattnere7c1e212009-09-20 05:03:30 +0000626 // Loop while we haven't found an option and Name still has at least two
627 // characters in it (so that the next iteration will not be the empty
628 // string.
629 while (OMI == OptionsMap.end() && Name.size() > 1) {
Chris Bieneman5d232242015-01-13 19:14:20 +0000630 Name = Name.substr(0, Name.size() - 1); // Chop off the last character.
Chris Lattner5247f602007-04-06 21:06:55 +0000631 OMI = OptionsMap.find(Name);
Chris Lattnere7c1e212009-09-20 05:03:30 +0000632 }
Chris Lattner5df56c42002-07-22 02:07:59 +0000633
Chris Lattner5247f602007-04-06 21:06:55 +0000634 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
Chris Lattner3b8adaf2009-09-20 00:40:49 +0000635 Length = Name.size();
Chris Bieneman5d232242015-01-13 19:14:20 +0000636 return OMI->second; // Found one!
Chris Lattner5df56c42002-07-22 02:07:59 +0000637 }
Chris Bieneman5d232242015-01-13 19:14:20 +0000638 return nullptr; // No option found!
Chris Lattner5df56c42002-07-22 02:07:59 +0000639}
640
Chris Lattnere7c1e212009-09-20 05:03:30 +0000641/// HandlePrefixedOrGroupedOption - The specified argument string (which started
642/// with at least one '-') does not fully match an available option. Check to
643/// see if this is a prefix or grouped option. If so, split arg into output an
644/// Arg/Value pair and return the Option to parse it with.
Chris Bieneman5d232242015-01-13 19:14:20 +0000645static Option *
646HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
647 bool &ErrorParsing,
648 const StringMap<Option *> &OptionsMap) {
649 if (Arg.size() == 1)
650 return nullptr;
Chris Lattnere7c1e212009-09-20 05:03:30 +0000651
652 // Do the lookup!
653 size_t Length = 0;
654 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
Chris Bieneman5d232242015-01-13 19:14:20 +0000655 if (!PGOpt)
656 return nullptr;
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000657
Chris Lattnere7c1e212009-09-20 05:03:30 +0000658 // If the option is a prefixed option, then the value is simply the
659 // rest of the name... so fall through to later processing, by
660 // setting up the argument name flags and value fields.
661 if (PGOpt->getFormattingFlag() == cl::Prefix) {
662 Value = Arg.substr(Length);
663 Arg = Arg.substr(0, Length);
664 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
665 return PGOpt;
666 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000667
Chris Lattnere7c1e212009-09-20 05:03:30 +0000668 // This must be a grouped option... handle them now. Grouping options can't
669 // have values.
670 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000671
Chris Lattnere7c1e212009-09-20 05:03:30 +0000672 do {
673 // Move current arg name out of Arg into OneArgName.
674 StringRef OneArgName = Arg.substr(0, Length);
675 Arg = Arg.substr(Length);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000676
Chris Lattnere7c1e212009-09-20 05:03:30 +0000677 // Because ValueRequired is an invalid flag for grouped arguments,
678 // we don't need to pass argc/argv in.
679 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
680 "Option can not be cl::Grouping AND cl::ValueRequired!");
Duncan Sandsa2305522010-01-09 08:30:33 +0000681 int Dummy = 0;
Chris Bieneman5d232242015-01-13 19:14:20 +0000682 ErrorParsing |=
683 ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000684
Chris Lattnere7c1e212009-09-20 05:03:30 +0000685 // Get the next grouping option.
686 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
687 } while (PGOpt && Length != Arg.size());
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000688
Chris Lattnere7c1e212009-09-20 05:03:30 +0000689 // Return the last option with Arg cut down to just the last one.
690 return PGOpt;
691}
692
Chris Lattner5df56c42002-07-22 02:07:59 +0000693static bool RequiresValue(const Option *O) {
Misha Brukman069e6b52003-07-10 16:49:51 +0000694 return O->getNumOccurrencesFlag() == cl::Required ||
695 O->getNumOccurrencesFlag() == cl::OneOrMore;
Chris Lattner5df56c42002-07-22 02:07:59 +0000696}
697
698static bool EatsUnboundedNumberOfValues(const Option *O) {
Misha Brukman069e6b52003-07-10 16:49:51 +0000699 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
700 O->getNumOccurrencesFlag() == cl::OneOrMore;
Chris Lattnerf0f91052001-11-26 18:58:34 +0000701}
Chris Lattnere81c4092001-10-27 05:54:17 +0000702
Chris Bieneman5d232242015-01-13 19:14:20 +0000703static bool isWhitespace(char C) { return strchr(" \t\n\r\f\v", C); }
Brian Gaeke497216d2003-08-15 21:05:57 +0000704
Chris Bieneman5d232242015-01-13 19:14:20 +0000705static bool isQuote(char C) { return C == '\"' || C == '\''; }
Reid Klecknera73c7782013-07-18 16:52:05 +0000706
Reid Klecknera73c7782013-07-18 16:52:05 +0000707void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000708 SmallVectorImpl<const char *> &NewArgv,
709 bool MarkEOLs) {
Reid Klecknera73c7782013-07-18 16:52:05 +0000710 SmallString<128> Token;
711 for (size_t I = 0, E = Src.size(); I != E; ++I) {
712 // Consume runs of whitespace.
713 if (Token.empty()) {
Reid Klecknere3f146d2014-08-22 19:29:17 +0000714 while (I != E && isWhitespace(Src[I])) {
715 // Mark the end of lines in response files
716 if (MarkEOLs && Src[I] == '\n')
717 NewArgv.push_back(nullptr);
Reid Klecknera73c7782013-07-18 16:52:05 +0000718 ++I;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000719 }
Chris Bieneman5d232242015-01-13 19:14:20 +0000720 if (I == E)
721 break;
Reid Klecknera73c7782013-07-18 16:52:05 +0000722 }
723
Nico Weberfa7f4892016-04-26 13:53:56 +0000724 // Backslash escapes the next character.
725 if (I + 1 < E && Src[I] == '\\') {
Chris Bieneman5d232242015-01-13 19:14:20 +0000726 ++I; // Skip the escape.
Reid Klecknera73c7782013-07-18 16:52:05 +0000727 Token.push_back(Src[I]);
Chris Lattner4e37f872009-09-24 05:38:36 +0000728 continue;
Brian Gaeke497216d2003-08-15 21:05:57 +0000729 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000730
Reid Klecknera73c7782013-07-18 16:52:05 +0000731 // Consume a quoted string.
732 if (isQuote(Src[I])) {
733 char Quote = Src[I++];
734 while (I != E && Src[I] != Quote) {
Nico Weberfa7f4892016-04-26 13:53:56 +0000735 // Backslash escapes the next character.
736 if (Src[I] == '\\' && I + 1 != E)
Reid Klecknera73c7782013-07-18 16:52:05 +0000737 ++I;
738 Token.push_back(Src[I]);
739 ++I;
740 }
Chris Bieneman5d232242015-01-13 19:14:20 +0000741 if (I == E)
742 break;
Reid Klecknera73c7782013-07-18 16:52:05 +0000743 continue;
744 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000745
Reid Klecknera73c7782013-07-18 16:52:05 +0000746 // End the token if this is whitespace.
747 if (isWhitespace(Src[I])) {
748 if (!Token.empty())
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000749 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Reid Klecknera73c7782013-07-18 16:52:05 +0000750 Token.clear();
751 continue;
752 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000753
Reid Klecknera73c7782013-07-18 16:52:05 +0000754 // This is a normal character. Append it.
755 Token.push_back(Src[I]);
Brian Gaeke497216d2003-08-15 21:05:57 +0000756 }
Reid Klecknera73c7782013-07-18 16:52:05 +0000757
758 // Append the last token after hitting EOF with no whitespace.
759 if (!Token.empty())
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000760 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Reid Klecknere3f146d2014-08-22 19:29:17 +0000761 // Mark the end of response files
762 if (MarkEOLs)
763 NewArgv.push_back(nullptr);
Reid Klecknera73c7782013-07-18 16:52:05 +0000764}
765
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000766/// Backslashes are interpreted in a rather complicated way in the Windows-style
767/// command line, because backslashes are used both to separate path and to
768/// escape double quote. This method consumes runs of backslashes as well as the
769/// following double quote if it's escaped.
770///
771/// * If an even number of backslashes is followed by a double quote, one
772/// backslash is output for every pair of backslashes, and the last double
773/// quote remains unconsumed. The double quote will later be interpreted as
774/// the start or end of a quoted string in the main loop outside of this
775/// function.
776///
777/// * If an odd number of backslashes is followed by a double quote, one
778/// backslash is output for every pair of backslashes, and a double quote is
779/// output for the last pair of backslash-double quote. The double quote is
780/// consumed in this case.
781///
782/// * Otherwise, backslashes are interpreted literally.
783static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
784 size_t E = Src.size();
785 int BackslashCount = 0;
786 // Skip the backslashes.
787 do {
788 ++I;
789 ++BackslashCount;
790 } while (I != E && Src[I] == '\\');
791
792 bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
793 if (FollowedByDoubleQuote) {
794 Token.append(BackslashCount / 2, '\\');
795 if (BackslashCount % 2 == 0)
796 return I - 1;
797 Token.push_back('"');
798 return I;
799 }
800 Token.append(BackslashCount, '\\');
801 return I - 1;
802}
803
Reid Klecknera73c7782013-07-18 16:52:05 +0000804void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000805 SmallVectorImpl<const char *> &NewArgv,
806 bool MarkEOLs) {
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000807 SmallString<128> Token;
808
809 // This is a small state machine to consume characters until it reaches the
810 // end of the source string.
811 enum { INIT, UNQUOTED, QUOTED } State = INIT;
812 for (size_t I = 0, E = Src.size(); I != E; ++I) {
813 // INIT state indicates that the current input index is at the start of
814 // the string or between tokens.
815 if (State == INIT) {
Reid Klecknere3f146d2014-08-22 19:29:17 +0000816 if (isWhitespace(Src[I])) {
817 // Mark the end of lines in response files
818 if (MarkEOLs && Src[I] == '\n')
819 NewArgv.push_back(nullptr);
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000820 continue;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000821 }
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000822 if (Src[I] == '"') {
823 State = QUOTED;
824 continue;
825 }
826 if (Src[I] == '\\') {
827 I = parseBackslash(Src, I, Token);
828 State = UNQUOTED;
829 continue;
830 }
831 Token.push_back(Src[I]);
832 State = UNQUOTED;
833 continue;
834 }
835
836 // UNQUOTED state means that it's reading a token not quoted by double
837 // quotes.
838 if (State == UNQUOTED) {
839 // Whitespace means the end of the token.
840 if (isWhitespace(Src[I])) {
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000841 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000842 Token.clear();
843 State = INIT;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000844 // Mark the end of lines in response files
845 if (MarkEOLs && Src[I] == '\n')
846 NewArgv.push_back(nullptr);
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000847 continue;
848 }
849 if (Src[I] == '"') {
850 State = QUOTED;
851 continue;
852 }
853 if (Src[I] == '\\') {
854 I = parseBackslash(Src, I, Token);
855 continue;
856 }
857 Token.push_back(Src[I]);
858 continue;
859 }
860
861 // QUOTED state means that it's reading a token quoted by double quotes.
862 if (State == QUOTED) {
863 if (Src[I] == '"') {
864 State = UNQUOTED;
865 continue;
866 }
867 if (Src[I] == '\\') {
868 I = parseBackslash(Src, I, Token);
869 continue;
870 }
871 Token.push_back(Src[I]);
872 }
873 }
874 // Append the last token after hitting EOF with no whitespace.
875 if (!Token.empty())
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000876 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Reid Klecknere3f146d2014-08-22 19:29:17 +0000877 // Mark the end of response files
878 if (MarkEOLs)
879 NewArgv.push_back(nullptr);
Reid Klecknera73c7782013-07-18 16:52:05 +0000880}
881
Yunzhong Gaoa8cf4952015-01-24 04:23:08 +0000882// It is called byte order marker but the UTF-8 BOM is actually not affected
883// by the host system's endianness.
884static bool hasUTF8ByteOrderMark(ArrayRef<char> S) {
Chris Bienemanceaf5f62015-02-13 22:54:29 +0000885 return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
Yunzhong Gaoa8cf4952015-01-24 04:23:08 +0000886}
887
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000888static bool ExpandResponseFile(StringRef FName, StringSaver &Saver,
Reid Klecknera73c7782013-07-18 16:52:05 +0000889 TokenizerCallback Tokenizer,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000890 SmallVectorImpl<const char *> &NewArgv,
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000891 bool MarkEOLs, bool RelativeNames) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000892 ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
893 MemoryBuffer::getFile(FName);
894 if (!MemBufOrErr)
Reid Klecknera73c7782013-07-18 16:52:05 +0000895 return false;
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000896 MemoryBuffer &MemBuf = *MemBufOrErr.get();
897 StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
Reid Klecknera73c7782013-07-18 16:52:05 +0000898
899 // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000900 ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
Reid Klecknera73c7782013-07-18 16:52:05 +0000901 std::string UTF8Buf;
902 if (hasUTF16ByteOrderMark(BufRef)) {
903 if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
904 return false;
905 Str = StringRef(UTF8Buf);
906 }
Yunzhong Gaoa8cf4952015-01-24 04:23:08 +0000907 // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
908 // these bytes before parsing.
909 // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
910 else if (hasUTF8ByteOrderMark(BufRef))
911 Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
Reid Klecknera73c7782013-07-18 16:52:05 +0000912
913 // Tokenize the contents into NewArgv.
Reid Klecknere3f146d2014-08-22 19:29:17 +0000914 Tokenizer(Str, Saver, NewArgv, MarkEOLs);
Reid Klecknera73c7782013-07-18 16:52:05 +0000915
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000916 // If names of nested response files should be resolved relative to including
917 // file, replace the included response file names with their full paths
918 // obtained by required resolution.
919 if (RelativeNames)
920 for (unsigned I = 0; I < NewArgv.size(); ++I)
921 if (NewArgv[I]) {
922 StringRef Arg = NewArgv[I];
923 if (Arg.front() == '@') {
924 StringRef FileName = Arg.drop_front();
925 if (llvm::sys::path::is_relative(FileName)) {
926 SmallString<128> ResponseFile;
927 ResponseFile.append(1, '@');
Serge Pavlovf258ff12016-11-20 06:25:07 +0000928 if (llvm::sys::path::is_relative(FName)) {
929 SmallString<128> curr_dir;
930 llvm::sys::fs::current_path(curr_dir);
931 ResponseFile.append(curr_dir.str());
932 }
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000933 llvm::sys::path::append(
934 ResponseFile, llvm::sys::path::parent_path(FName), FileName);
935 NewArgv[I] = Saver.save(ResponseFile.c_str()).data();
936 }
937 }
938 }
939
Reid Klecknera73c7782013-07-18 16:52:05 +0000940 return true;
941}
942
943/// \brief Expand response files on a command line recursively using the given
944/// StringSaver and tokenization strategy.
945bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000946 SmallVectorImpl<const char *> &Argv,
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000947 bool MarkEOLs, bool RelativeNames) {
Reid Klecknera73c7782013-07-18 16:52:05 +0000948 unsigned RspFiles = 0;
Reid Kleckner7c5fdaf2013-12-03 19:13:18 +0000949 bool AllExpanded = true;
Reid Klecknera73c7782013-07-18 16:52:05 +0000950
951 // Don't cache Argv.size() because it can change.
Chris Bieneman5d232242015-01-13 19:14:20 +0000952 for (unsigned I = 0; I != Argv.size();) {
Reid Klecknera73c7782013-07-18 16:52:05 +0000953 const char *Arg = Argv[I];
Reid Klecknere3f146d2014-08-22 19:29:17 +0000954 // Check if it is an EOL marker
955 if (Arg == nullptr) {
956 ++I;
957 continue;
958 }
Reid Klecknera73c7782013-07-18 16:52:05 +0000959 if (Arg[0] != '@') {
960 ++I;
961 continue;
962 }
963
964 // If we have too many response files, leave some unexpanded. This avoids
965 // crashing on self-referential response files.
966 if (RspFiles++ > 20)
967 return false;
968
969 // Replace this response file argument with the tokenization of its
970 // contents. Nested response files are expanded in subsequent iterations.
Reid Klecknera73c7782013-07-18 16:52:05 +0000971 SmallVector<const char *, 0> ExpandedArgv;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000972 if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000973 MarkEOLs, RelativeNames)) {
Justin Bogner67ae9912013-12-06 22:56:19 +0000974 // We couldn't read this file, so we leave it in the argument stream and
975 // move on.
Reid Klecknera73c7782013-07-18 16:52:05 +0000976 AllExpanded = false;
Justin Bogner67ae9912013-12-06 22:56:19 +0000977 ++I;
Reid Klecknera73c7782013-07-18 16:52:05 +0000978 continue;
979 }
980 Argv.erase(Argv.begin() + I);
981 Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
982 }
983 return AllExpanded;
984}
985
Brian Gaekeca782d92003-08-14 22:00:59 +0000986/// ParseEnvironmentOptions - An alternative entry point to the
987/// CommandLine library, which allows you to read the program's name
988/// from the caller (as PROGNAME) and its command-line arguments from
989/// an environment variable (whose name is given in ENVVAR).
990///
Chris Lattnera60f3552004-05-06 22:04:31 +0000991void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
Rafael Espindolabe5613c2012-10-09 19:52:10 +0000992 const char *Overview) {
Brian Gaeke497216d2003-08-15 21:05:57 +0000993 // Check args.
Chris Lattnera60f3552004-05-06 22:04:31 +0000994 assert(progName && "Program name not specified");
995 assert(envVar && "Environment variable name missing");
Misha Brukman10468d82005-04-21 22:55:34 +0000996
Brian Gaeke497216d2003-08-15 21:05:57 +0000997 // Get the environment variable they want us to parse options out of.
Mehdi Aminie11b7452016-10-01 03:43:20 +0000998 llvm::Optional<std::string> envValue = sys::Process::GetEnv(StringRef(envVar));
Brian Gaeke497216d2003-08-15 21:05:57 +0000999 if (!envValue)
1000 return;
1001
Brian Gaekeca782d92003-08-14 22:00:59 +00001002 // Get program's "name", which we wouldn't know without the caller
1003 // telling us.
Reid Klecknera73c7782013-07-18 16:52:05 +00001004 SmallVector<const char *, 20> newArgv;
Rafael Espindola454adf62015-06-13 12:49:52 +00001005 BumpPtrAllocator A;
Rafael Espindolab82455d2015-08-13 01:07:02 +00001006 StringSaver Saver(A);
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +00001007 newArgv.push_back(Saver.save(progName).data());
Brian Gaekeca782d92003-08-14 22:00:59 +00001008
1009 // Parse the value of the environment variable into a "command line"
1010 // and hand it off to ParseCommandLineOptions().
David Majnemerafb38af2016-07-24 17:19:59 +00001011 TokenizeGNUCommandLine(*envValue, Saver, newArgv);
Evan Cheng86cb3182008-05-05 18:30:58 +00001012 int newArgc = static_cast<int>(newArgv.size());
Mehdi Aminie11b7452016-10-01 03:43:20 +00001013 ParseCommandLineOptions(newArgc, &newArgv[0], StringRef(Overview));
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001014}
1015
Zachary Turner07670b32016-06-29 21:48:26 +00001016bool cl::ParseCommandLineOptions(int argc, const char *const *argv,
Eric Liue51ee062017-03-15 08:41:00 +00001017 StringRef Overview, raw_ostream *Errs) {
Zachary Turner07670b32016-06-29 21:48:26 +00001018 return GlobalParser->ParseCommandLineOptions(argc, argv, Overview,
Eric Liue51ee062017-03-15 08:41:00 +00001019 Errs);
Chris Bienemand1d94302015-01-28 19:00:25 +00001020}
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001021
Zachary Turner07670b32016-06-29 21:48:26 +00001022void CommandLineParser::ResetAllOptionOccurrences() {
1023 // So that we can parse different command lines multiple times in succession
1024 // we reset all option values to look like they have never been seen before.
1025 for (auto SC : RegisteredSubCommands) {
1026 for (auto &O : SC->OptionsMap)
1027 O.second->reset();
1028 }
1029}
1030
1031bool CommandLineParser::ParseCommandLineOptions(int argc,
Chris Bienemand1d94302015-01-28 19:00:25 +00001032 const char *const *argv,
Mehdi Aminie11b7452016-10-01 03:43:20 +00001033 StringRef Overview,
Eric Liue51ee062017-03-15 08:41:00 +00001034 raw_ostream *Errs) {
Chris Bienemand1d94302015-01-28 19:00:25 +00001035 assert(hasOptions() && "No options specified!");
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001036
1037 // Expand response files.
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001038 SmallVector<const char *, 20> newArgv(argv, argv + argc);
Rafael Espindola454adf62015-06-13 12:49:52 +00001039 BumpPtrAllocator A;
Rafael Espindolab82455d2015-08-13 01:07:02 +00001040 StringSaver Saver(A);
Reid Klecknera73c7782013-07-18 16:52:05 +00001041 ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
Rafael Espindolabe5613c2012-10-09 19:52:10 +00001042 argv = &newArgv[0];
1043 argc = static_cast<int>(newArgv.size());
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001044
Chris Lattner5af1cbc2006-10-13 00:06:24 +00001045 // Copy the program name into ProgName, making sure not to overflow it.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001046 ProgramName = sys::path::filename(StringRef(argv[0]));
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001047
Chris Lattner36a57d32001-07-23 17:17:47 +00001048 ProgramOverview = Overview;
Eric Liue51ee062017-03-15 08:41:00 +00001049 bool IgnoreErrors = Errs;
1050 if (!Errs)
1051 Errs = &errs();
Chris Lattner36a57d32001-07-23 17:17:47 +00001052 bool ErrorParsing = false;
1053
Chris Lattner5df56c42002-07-22 02:07:59 +00001054 // Check out the positional arguments to collect information about them.
1055 unsigned NumPositionalRequired = 0;
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001056
Chris Lattnerd380d842005-08-08 17:25:38 +00001057 // Determine whether or not there are an unlimited number of positionals
1058 bool HasUnlimitedPositionals = false;
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001059
Zachary Turner07670b32016-06-29 21:48:26 +00001060 int FirstArg = 1;
1061 SubCommand *ChosenSubCommand = &*TopLevelSubCommand;
1062 if (argc >= 2 && argv[FirstArg][0] != '-') {
1063 // If the first argument specifies a valid subcommand, start processing
1064 // options from the second argument.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001065 ChosenSubCommand = LookupSubCommand(StringRef(argv[FirstArg]));
Zachary Turner07670b32016-06-29 21:48:26 +00001066 if (ChosenSubCommand != &*TopLevelSubCommand)
1067 FirstArg = 2;
1068 }
1069 GlobalParser->ActiveSubCommand = ChosenSubCommand;
1070
1071 assert(ChosenSubCommand);
1072 auto &ConsumeAfterOpt = ChosenSubCommand->ConsumeAfterOpt;
1073 auto &PositionalOpts = ChosenSubCommand->PositionalOpts;
1074 auto &SinkOpts = ChosenSubCommand->SinkOpts;
1075 auto &OptionsMap = ChosenSubCommand->OptionsMap;
1076
Chris Bienemand1d94302015-01-28 19:00:25 +00001077 if (ConsumeAfterOpt) {
1078 assert(PositionalOpts.size() > 0 &&
1079 "Cannot specify cl::ConsumeAfter without a positional argument!");
1080 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001081 if (!PositionalOpts.empty()) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001082
1083 // Calculate how many positional values are _required_.
1084 bool UnboundedFound = false;
Chris Bienemand1d94302015-01-28 19:00:25 +00001085 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001086 Option *Opt = PositionalOpts[i];
1087 if (RequiresValue(Opt))
1088 ++NumPositionalRequired;
1089 else if (ConsumeAfterOpt) {
1090 // ConsumeAfter cannot be combined with "optional" positional options
Chris Lattnerd49ea882002-07-22 02:21:57 +00001091 // unless there is only one positional argument...
Zachary Turner07670b32016-06-29 21:48:26 +00001092 if (PositionalOpts.size() > 1) {
1093 if (!IgnoreErrors)
1094 Opt->error("error - this positional option will never be matched, "
1095 "because it does not Require a value, and a "
1096 "cl::ConsumeAfter option is active!");
1097 ErrorParsing = true;
1098 }
David Blaikieff43d692015-11-17 19:00:52 +00001099 } else if (UnboundedFound && !Opt->hasArgStr()) {
Chris Lattner2da046f2003-07-30 17:34:02 +00001100 // This option does not "require" a value... Make sure this option is
1101 // not specified after an option that eats all extra arguments, or this
1102 // one will never get any!
Chris Lattner5df56c42002-07-22 02:07:59 +00001103 //
Eric Liue51ee062017-03-15 08:41:00 +00001104 if (!IgnoreErrors)
Zachary Turner07670b32016-06-29 21:48:26 +00001105 Opt->error("error - option can never match, because "
1106 "another positional argument will match an "
1107 "unbounded number of values, and this option"
1108 " does not require a value!");
Eric Liue51ee062017-03-15 08:41:00 +00001109 *Errs << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr
1110 << "' is all messed up!\n";
1111 *Errs << PositionalOpts.size();
Zachary Turner07670b32016-06-29 21:48:26 +00001112 ErrorParsing = true;
Chris Lattner5df56c42002-07-22 02:07:59 +00001113 }
1114 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
1115 }
Chris Lattnerd09a9a72005-08-08 21:57:27 +00001116 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
Chris Lattner5df56c42002-07-22 02:07:59 +00001117 }
1118
Reid Spencer2027a6f2004-08-13 19:47:30 +00001119 // PositionalVals - A vector of "positional" arguments we accumulate into
Chris Lattnerca2552d2009-09-20 00:07:40 +00001120 // the process at the end.
Chris Lattner5df56c42002-07-22 02:07:59 +00001121 //
Chris Bieneman5d232242015-01-13 19:14:20 +00001122 SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
Chris Lattner5df56c42002-07-22 02:07:59 +00001123
Chris Lattner2da046f2003-07-30 17:34:02 +00001124 // If the program has named positional arguments, and the name has been run
1125 // across, keep track of which positional argument was named. Otherwise put
1126 // the positional args into the PositionalVals list...
Craig Topperc10719f2014-04-07 04:17:22 +00001127 Option *ActivePositionalArg = nullptr;
Chris Lattner2da046f2003-07-30 17:34:02 +00001128
Chris Lattner36a57d32001-07-23 17:17:47 +00001129 // Loop over all of the arguments... processing them.
Chris Bieneman5d232242015-01-13 19:14:20 +00001130 bool DashDashFound = false; // Have we read '--'?
Zachary Turner07670b32016-06-29 21:48:26 +00001131 for (int i = FirstArg; i < argc; ++i) {
Craig Topperc10719f2014-04-07 04:17:22 +00001132 Option *Handler = nullptr;
1133 Option *NearestHandler = nullptr;
Nick Lewyckye75ffa12011-05-02 05:24:47 +00001134 std::string NearestHandlerString;
Chris Lattner0a40a972009-09-20 01:53:12 +00001135 StringRef Value;
Chris Lattner5a3fa4e2009-09-20 02:02:24 +00001136 StringRef ArgName = "";
Chris Lattner5df56c42002-07-22 02:07:59 +00001137
1138 // Check to see if this is a positional argument. This argument is
1139 // considered to be positional if it doesn't start with '-', if it is "-"
Misha Brukman5258e592003-07-10 21:38:28 +00001140 // itself, or if we have seen "--" already.
Chris Lattner5df56c42002-07-22 02:07:59 +00001141 //
1142 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
1143 // Positional argument!
Chris Lattner2da046f2003-07-30 17:34:02 +00001144 if (ActivePositionalArg) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001145 ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
Chris Bieneman5d232242015-01-13 19:14:20 +00001146 continue; // We are done!
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001147 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001148
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001149 if (!PositionalOpts.empty()) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001150 PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
Chris Lattner5df56c42002-07-22 02:07:59 +00001151
1152 // All of the positional arguments have been fulfulled, give the rest to
1153 // the consume after option... if it's specified...
1154 //
Craig Topper8d399f82014-04-09 04:20:00 +00001155 if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001156 for (++i; i < argc; ++i)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001157 PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
Chris Bieneman5d232242015-01-13 19:14:20 +00001158 break; // Handle outside of the argument processing loop...
Chris Lattner5df56c42002-07-22 02:07:59 +00001159 }
1160
1161 // Delay processing positional arguments until the end...
1162 continue;
1163 }
Chris Lattnera60f3552004-05-06 22:04:31 +00001164 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
1165 !DashDashFound) {
Chris Bieneman5d232242015-01-13 19:14:20 +00001166 DashDashFound = true; // This is the mythical "--"?
1167 continue; // Don't try to process it as an argument itself.
Chris Lattnera60f3552004-05-06 22:04:31 +00001168 } else if (ActivePositionalArg &&
1169 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
1170 // If there is a positional argument eating options, check to see if this
1171 // option is another positional argument. If so, treat it as an argument,
1172 // otherwise feed it to the eating positional.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001173 ArgName = StringRef(argv[i] + 1);
Chris Lattnere7c1e212009-09-20 05:03:30 +00001174 // Eat leading dashes.
1175 while (!ArgName.empty() && ArgName[0] == '-')
1176 ArgName = ArgName.substr(1);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001177
Zachary Turner07670b32016-06-29 21:48:26 +00001178 Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
Chris Lattnera60f3552004-05-06 22:04:31 +00001179 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001180 ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
Chris Bieneman5d232242015-01-13 19:14:20 +00001181 continue; // We are done!
Chris Lattner5df56c42002-07-22 02:07:59 +00001182 }
1183
Chris Bieneman5d232242015-01-13 19:14:20 +00001184 } else { // We start with a '-', must be an argument.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001185 ArgName = StringRef(argv[i] + 1);
Chris Lattnere7c1e212009-09-20 05:03:30 +00001186 // Eat leading dashes.
1187 while (!ArgName.empty() && ArgName[0] == '-')
1188 ArgName = ArgName.substr(1);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001189
Zachary Turner07670b32016-06-29 21:48:26 +00001190 Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
Chris Lattner36a57d32001-07-23 17:17:47 +00001191
Chris Lattnera60f3552004-05-06 22:04:31 +00001192 // Check to see if this "option" is really a prefixed or grouped argument.
Craig Topper8d399f82014-04-09 04:20:00 +00001193 if (!Handler)
Chris Bienemand1d94302015-01-28 19:00:25 +00001194 Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
1195 OptionsMap);
Daniel Dunbarf4132132011-01-18 01:59:24 +00001196
1197 // Otherwise, look for the closest available option to report to the user
1198 // in the upcoming error.
Craig Topper8d399f82014-04-09 04:20:00 +00001199 if (!Handler && SinkOpts.empty())
Chris Bieneman5d232242015-01-13 19:14:20 +00001200 NearestHandler =
Chris Bienemand1d94302015-01-28 19:00:25 +00001201 LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
Chris Lattner36a57d32001-07-23 17:17:47 +00001202 }
1203
Craig Topper8d399f82014-04-09 04:20:00 +00001204 if (!Handler) {
Anton Korobeynikovf275a492008-02-20 12:38:07 +00001205 if (SinkOpts.empty()) {
Eric Liue51ee062017-03-15 08:41:00 +00001206 *Errs << ProgramName << ": Unknown command line argument '" << argv[i]
1207 << "'. Try: '" << argv[0] << " -help'\n";
Daniel Dunbarf4132132011-01-18 01:59:24 +00001208
Eric Liue51ee062017-03-15 08:41:00 +00001209 if (NearestHandler) {
1210 // If we know a near match, report it as well.
1211 *Errs << ProgramName << ": Did you mean '-" << NearestHandlerString
1212 << "'?\n";
Daniel Dunbar72d523b2011-01-24 17:27:17 +00001213 }
Daniel Dunbarf4132132011-01-18 01:59:24 +00001214
Anton Korobeynikovf275a492008-02-20 12:38:07 +00001215 ErrorParsing = true;
1216 } else {
Chris Bieneman5d232242015-01-13 19:14:20 +00001217 for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
1218 E = SinkOpts.end();
1219 I != E; ++I)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001220 (*I)->addOccurrence(i, "", StringRef(argv[i]));
Anton Korobeynikovf275a492008-02-20 12:38:07 +00001221 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001222 continue;
1223 }
1224
Chris Lattner2da046f2003-07-30 17:34:02 +00001225 // If this is a named positional argument, just remember that it is the
1226 // active one...
1227 if (Handler->getFormattingFlag() == cl::Positional)
1228 ActivePositionalArg = Handler;
Chris Lattner40fef802009-09-20 01:49:31 +00001229 else
Chris Lattner0a40a972009-09-20 01:53:12 +00001230 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
Chris Lattner5df56c42002-07-22 02:07:59 +00001231 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001232
Chris Lattner5df56c42002-07-22 02:07:59 +00001233 // Check and handle positional arguments now...
1234 if (NumPositionalRequired > PositionalVals.size()) {
Eric Liue51ee062017-03-15 08:41:00 +00001235 *Errs << ProgramName
Zachary Turner07670b32016-06-29 21:48:26 +00001236 << ": Not enough positional command line arguments specified!\n"
1237 << "Must specify at least " << NumPositionalRequired
Ying Yi60a3da32016-07-22 10:52:21 +00001238 << " positional argument" << (NumPositionalRequired > 1 ? "s" : "")
Don Hintone15fa332017-07-12 01:15:46 +00001239 << ": See: " << argv[0] << " -help\n";
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001240
Chris Lattner5df56c42002-07-22 02:07:59 +00001241 ErrorParsing = true;
Dan Gohmanb452d4e2010-03-24 19:38:02 +00001242 } else if (!HasUnlimitedPositionals &&
1243 PositionalVals.size() > PositionalOpts.size()) {
Eric Liue51ee062017-03-15 08:41:00 +00001244 *Errs << ProgramName << ": Too many positional arguments specified!\n"
1245 << "Can specify at most " << PositionalOpts.size()
1246 << " positional arguments: See: " << argv[0] << " -help\n";
Chris Lattnerd380d842005-08-08 17:25:38 +00001247 ErrorParsing = true;
Chris Lattner5df56c42002-07-22 02:07:59 +00001248
Craig Topper8d399f82014-04-09 04:20:00 +00001249 } else if (!ConsumeAfterOpt) {
Chris Lattnere7c1e212009-09-20 05:03:30 +00001250 // Positional args have already been handled if ConsumeAfter is specified.
Evan Cheng86cb3182008-05-05 18:30:58 +00001251 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1252 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001253 if (RequiresValue(PositionalOpts[i])) {
Misha Brukman10468d82005-04-21 22:55:34 +00001254 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
Reid Spencer2027a6f2004-08-13 19:47:30 +00001255 PositionalVals[ValNo].second);
1256 ValNo++;
Chris Bieneman5d232242015-01-13 19:14:20 +00001257 --NumPositionalRequired; // We fulfilled our duty...
Chris Lattner5df56c42002-07-22 02:07:59 +00001258 }
1259
1260 // If we _can_ give this option more arguments, do so now, as long as we
1261 // do not give it values that others need. 'Done' controls whether the
1262 // option even _WANTS_ any more.
1263 //
Misha Brukman069e6b52003-07-10 16:49:51 +00001264 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
Chris Bieneman5d232242015-01-13 19:14:20 +00001265 while (NumVals - ValNo > NumPositionalRequired && !Done) {
Misha Brukman069e6b52003-07-10 16:49:51 +00001266 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001267 case cl::Optional:
Chris Bieneman5d232242015-01-13 19:14:20 +00001268 Done = true; // Optional arguments want _at most_ one value
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001269 LLVM_FALLTHROUGH;
Chris Bieneman5d232242015-01-13 19:14:20 +00001270 case cl::ZeroOrMore: // Zero or more will take all they can get...
1271 case cl::OneOrMore: // One or more will take all they can get...
Reid Spencer2027a6f2004-08-13 19:47:30 +00001272 ProvidePositionalOption(PositionalOpts[i],
1273 PositionalVals[ValNo].first,
1274 PositionalVals[ValNo].second);
1275 ValNo++;
Chris Lattner5df56c42002-07-22 02:07:59 +00001276 break;
1277 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00001278 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
Chris Bieneman5d232242015-01-13 19:14:20 +00001279 "positional argument processing!");
Chris Lattner5df56c42002-07-22 02:07:59 +00001280 }
1281 }
Chris Lattnere81c4092001-10-27 05:54:17 +00001282 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001283 } else {
1284 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1285 unsigned ValNo = 0;
Evan Cheng86cb3182008-05-05 18:30:58 +00001286 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
Reid Spencer2027a6f2004-08-13 19:47:30 +00001287 if (RequiresValue(PositionalOpts[j])) {
Chris Lattnerca0e79e2002-07-24 20:15:13 +00001288 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
Reid Spencer2027a6f2004-08-13 19:47:30 +00001289 PositionalVals[ValNo].first,
1290 PositionalVals[ValNo].second);
1291 ValNo++;
1292 }
Chris Lattnerca0e79e2002-07-24 20:15:13 +00001293
1294 // Handle the case where there is just one positional option, and it's
1295 // optional. In this case, we want to give JUST THE FIRST option to the
1296 // positional option and keep the rest for the consume after. The above
1297 // loop would have assigned no values to positional options in this case.
1298 //
Chris Bienemand1d94302015-01-28 19:00:25 +00001299 if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1300 ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
Reid Spencer2027a6f2004-08-13 19:47:30 +00001301 PositionalVals[ValNo].first,
1302 PositionalVals[ValNo].second);
1303 ValNo++;
1304 }
Misha Brukman10468d82005-04-21 22:55:34 +00001305
Chris Lattner5df56c42002-07-22 02:07:59 +00001306 // Handle over all of the rest of the arguments to the
1307 // cl::ConsumeAfter command line option...
1308 for (; ValNo != PositionalVals.size(); ++ValNo)
Chris Bieneman5d232242015-01-13 19:14:20 +00001309 ErrorParsing |=
1310 ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1311 PositionalVals[ValNo].second);
Chris Lattner36a57d32001-07-23 17:17:47 +00001312 }
1313
Chris Lattner4fdde2c2001-07-23 23:02:45 +00001314 // Loop over args and make sure all required args are specified!
Chris Bienemand1d94302015-01-28 19:00:25 +00001315 for (const auto &Opt : OptionsMap) {
Justin Bogner973b2ff2014-07-14 19:24:13 +00001316 switch (Opt.second->getNumOccurrencesFlag()) {
Chris Lattner4fdde2c2001-07-23 23:02:45 +00001317 case Required:
1318 case OneOrMore:
Justin Bogner973b2ff2014-07-14 19:24:13 +00001319 if (Opt.second->getNumOccurrences() == 0) {
1320 Opt.second->error("must be specified at least once!");
Chris Lattnerd4617cd2001-10-24 06:21:56 +00001321 ErrorParsing = true;
1322 }
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001323 LLVM_FALLTHROUGH;
Chris Lattner4fdde2c2001-07-23 23:02:45 +00001324 default:
1325 break;
1326 }
1327 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001328
Rafael Espindolacf14a382010-11-19 21:14:29 +00001329 // Now that we know if -debug is specified, we can use it.
1330 // Note that if ReadResponseFiles == true, this must be done before the
1331 // memory allocated for the expanded command line is free()d below.
1332 DEBUG(dbgs() << "Args: ";
Chris Bieneman5d232242015-01-13 19:14:20 +00001333 for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1334 dbgs() << '\n';);
Rafael Espindolacf14a382010-11-19 21:14:29 +00001335
Chris Lattner5df56c42002-07-22 02:07:59 +00001336 // Free all of the memory allocated to the map. Command line options may only
1337 // be processed once!
Chris Bienemand1d94302015-01-28 19:00:25 +00001338 MoreHelp.clear();
Chris Lattner36a57d32001-07-23 17:17:47 +00001339
1340 // If we had an error processing our arguments, don't let the program execute
Zachary Turner07670b32016-06-29 21:48:26 +00001341 if (ErrorParsing) {
1342 if (!IgnoreErrors)
1343 exit(1);
1344 return false;
1345 }
1346 return true;
Chris Lattner36a57d32001-07-23 17:17:47 +00001347}
1348
1349//===----------------------------------------------------------------------===//
1350// Option Base class implementation
1351//
Chris Lattner36a57d32001-07-23 17:17:47 +00001352
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001353bool Option::error(const Twine &Message, StringRef ArgName) {
Chris Bieneman5d232242015-01-13 19:14:20 +00001354 if (!ArgName.data())
1355 ArgName = ArgStr;
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001356 if (ArgName.empty())
Chris Bieneman5d232242015-01-13 19:14:20 +00001357 errs() << HelpStr; // Be nice for positional arguments
Chris Lattner5df56c42002-07-22 02:07:59 +00001358 else
Chris Bienemand1d94302015-01-28 19:00:25 +00001359 errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001360
Benjamin Kramerc9aa4802009-08-23 10:01:13 +00001361 errs() << " option: " << Message << "\n";
Chris Lattner36a57d32001-07-23 17:17:47 +00001362 return true;
1363}
1364
Chris Bieneman5d232242015-01-13 19:14:20 +00001365bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1366 bool MultiArg) {
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +00001367 if (!MultiArg)
Chris Bieneman5d232242015-01-13 19:14:20 +00001368 NumOccurrences++; // Increment the number of times we have been seen
Chris Lattner36a57d32001-07-23 17:17:47 +00001369
Misha Brukman069e6b52003-07-10 16:49:51 +00001370 switch (getNumOccurrencesFlag()) {
Chris Lattner36a57d32001-07-23 17:17:47 +00001371 case Optional:
Misha Brukman069e6b52003-07-10 16:49:51 +00001372 if (NumOccurrences > 1)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001373 return error("may only occur zero or one times!", ArgName);
Chris Lattner36a57d32001-07-23 17:17:47 +00001374 break;
1375 case Required:
Misha Brukman069e6b52003-07-10 16:49:51 +00001376 if (NumOccurrences > 1)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001377 return error("must occur exactly one time!", ArgName);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001378 LLVM_FALLTHROUGH;
Chris Lattner36a57d32001-07-23 17:17:47 +00001379 case OneOrMore:
Chris Lattnere81c4092001-10-27 05:54:17 +00001380 case ZeroOrMore:
Chris Bieneman5d232242015-01-13 19:14:20 +00001381 case ConsumeAfter:
1382 break;
Chris Lattner36a57d32001-07-23 17:17:47 +00001383 }
1384
Reid Spencer2027a6f2004-08-13 19:47:30 +00001385 return handleOccurrence(pos, ArgName, Value);
Chris Lattner36a57d32001-07-23 17:17:47 +00001386}
1387
Chris Lattner5df56c42002-07-22 02:07:59 +00001388// getValueStr - Get the value description string, using "DefaultMsg" if nothing
1389// has been specified yet.
1390//
David Blaikieff43d692015-11-17 19:00:52 +00001391static StringRef getValueStr(const Option &O, StringRef DefaultMsg) {
1392 if (O.ValueStr.empty())
Chris Bieneman5d232242015-01-13 19:14:20 +00001393 return DefaultMsg;
Chris Lattner5df56c42002-07-22 02:07:59 +00001394 return O.ValueStr;
1395}
1396
1397//===----------------------------------------------------------------------===//
1398// cl::alias class implementation
1399//
1400
Chris Lattner36a57d32001-07-23 17:17:47 +00001401// Return the width of the option tag for printing...
David Blaikieff43d692015-11-17 19:00:52 +00001402size_t alias::getOptionWidth() const { return ArgStr.size() + 6; }
Chris Lattner36a57d32001-07-23 17:17:47 +00001403
Daniel Berlin25f1db12017-02-19 04:28:56 +00001404void Option::printHelpStr(StringRef HelpStr, size_t Indent,
1405 size_t FirstLineIndentedBy) {
Alexander Kornienko72a196a2013-05-10 17:15:51 +00001406 std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1407 outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1408 while (!Split.second.empty()) {
1409 Split = Split.second.split('\n');
1410 outs().indent(Indent) << Split.first << "\n";
1411 }
1412}
1413
Chris Lattner1b7a5152006-04-28 05:36:25 +00001414// Print out the option for the alias.
Evan Cheng86cb3182008-05-05 18:30:58 +00001415void alias::printOptionInfo(size_t GlobalWidth) const {
Evan Cheng871b7122011-06-13 20:45:54 +00001416 outs() << " -" << ArgStr;
David Blaikieff43d692015-11-17 19:00:52 +00001417 printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
Chris Lattner36a57d32001-07-23 17:17:47 +00001418}
1419
Chris Lattner36a57d32001-07-23 17:17:47 +00001420//===----------------------------------------------------------------------===//
Chris Lattner5df56c42002-07-22 02:07:59 +00001421// Parser Implementation code...
Chris Lattner36a57d32001-07-23 17:17:47 +00001422//
1423
Chris Lattnerb4101b12002-08-07 18:36:37 +00001424// basic_parser implementation
1425//
1426
1427// Return the width of the option tag for printing...
Evan Cheng86cb3182008-05-05 18:30:58 +00001428size_t basic_parser_impl::getOptionWidth(const Option &O) const {
David Blaikieff43d692015-11-17 19:00:52 +00001429 size_t Len = O.ArgStr.size();
Mehdi Aminie11b7452016-10-01 03:43:20 +00001430 auto ValName = getValueName();
1431 if (!ValName.empty())
David Blaikieff43d692015-11-17 19:00:52 +00001432 Len += getValueStr(O, ValName).size() + 3;
Chris Lattnerb4101b12002-08-07 18:36:37 +00001433
1434 return Len + 6;
1435}
1436
Misha Brukman10468d82005-04-21 22:55:34 +00001437// printOptionInfo - Print out information about this option. The
Chris Lattnerb4101b12002-08-07 18:36:37 +00001438// to-be-maintained width is specified.
1439//
1440void basic_parser_impl::printOptionInfo(const Option &O,
Evan Cheng86cb3182008-05-05 18:30:58 +00001441 size_t GlobalWidth) const {
Chris Lattner471ba482009-08-23 08:43:55 +00001442 outs() << " -" << O.ArgStr;
Chris Lattnerb4101b12002-08-07 18:36:37 +00001443
Mehdi Aminie11b7452016-10-01 03:43:20 +00001444 auto ValName = getValueName();
1445 if (!ValName.empty())
Chris Lattner471ba482009-08-23 08:43:55 +00001446 outs() << "=<" << getValueStr(O, ValName) << '>';
Chris Lattnerb4101b12002-08-07 18:36:37 +00001447
Daniel Berlin25f1db12017-02-19 04:28:56 +00001448 Option::printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
Chris Lattnerb4101b12002-08-07 18:36:37 +00001449}
1450
Andrew Trick12004012011-04-05 18:54:36 +00001451void basic_parser_impl::printOptionName(const Option &O,
1452 size_t GlobalWidth) const {
1453 outs() << " -" << O.ArgStr;
David Blaikieff43d692015-11-17 19:00:52 +00001454 outs().indent(GlobalWidth - O.ArgStr.size());
Andrew Trick12004012011-04-05 18:54:36 +00001455}
Chris Lattnerb4101b12002-08-07 18:36:37 +00001456
Chris Lattner5df56c42002-07-22 02:07:59 +00001457// parser<bool> implementation
1458//
Chris Bieneman5d232242015-01-13 19:14:20 +00001459bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1460 bool &Value) {
Misha Brukman10468d82005-04-21 22:55:34 +00001461 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
Chris Lattner36a57d32001-07-23 17:17:47 +00001462 Arg == "1") {
1463 Value = true;
Chris Lattneraecd74d2009-09-19 18:55:05 +00001464 return false;
Chris Lattner36a57d32001-07-23 17:17:47 +00001465 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001466
Chris Lattneraecd74d2009-09-19 18:55:05 +00001467 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1468 Value = false;
1469 return false;
1470 }
1471 return O.error("'" + Arg +
1472 "' is invalid value for boolean argument! Try 0 or 1");
Chris Lattner36a57d32001-07-23 17:17:47 +00001473}
1474
Dale Johannesen82810c82007-05-22 17:14:46 +00001475// parser<boolOrDefault> implementation
1476//
Chris Bieneman5d232242015-01-13 19:14:20 +00001477bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg,
1478 boolOrDefault &Value) {
Dale Johannesen82810c82007-05-22 17:14:46 +00001479 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1480 Arg == "1") {
1481 Value = BOU_TRUE;
Chris Lattneraecd74d2009-09-19 18:55:05 +00001482 return false;
Dale Johannesen82810c82007-05-22 17:14:46 +00001483 }
Chris Lattneraecd74d2009-09-19 18:55:05 +00001484 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1485 Value = BOU_FALSE;
1486 return false;
1487 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001488
Chris Lattneraecd74d2009-09-19 18:55:05 +00001489 return O.error("'" + Arg +
1490 "' is invalid value for boolean argument! Try 0 or 1");
Dale Johannesen82810c82007-05-22 17:14:46 +00001491}
1492
Chris Lattner5df56c42002-07-22 02:07:59 +00001493// parser<int> implementation
1494//
Chris Bieneman5d232242015-01-13 19:14:20 +00001495bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1496 int &Value) {
Chris Lattnerfa9c6f42009-09-19 23:59:02 +00001497 if (Arg.getAsInteger(0, Value))
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001498 return O.error("'" + Arg + "' value invalid for integer argument!");
Chris Lattner36a57d32001-07-23 17:17:47 +00001499 return false;
1500}
1501
Chris Lattner719c7152003-06-28 15:47:20 +00001502// parser<unsigned> implementation
1503//
Chris Bieneman5d232242015-01-13 19:14:20 +00001504bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1505 unsigned &Value) {
Chris Lattnerfa9c6f42009-09-19 23:59:02 +00001506
1507 if (Arg.getAsInteger(0, Value))
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001508 return O.error("'" + Arg + "' value invalid for uint argument!");
Chris Lattner719c7152003-06-28 15:47:20 +00001509 return false;
1510}
1511
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +00001512// parser<unsigned long long> implementation
1513//
1514bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
Chris Bieneman5d232242015-01-13 19:14:20 +00001515 StringRef Arg,
1516 unsigned long long &Value) {
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +00001517
1518 if (Arg.getAsInteger(0, Value))
1519 return O.error("'" + Arg + "' value invalid for uint argument!");
1520 return false;
1521}
1522
Chris Lattnerb4101b12002-08-07 18:36:37 +00001523// parser<double>/parser<float> implementation
Chris Lattner675db8d2001-10-13 06:53:19 +00001524//
Chris Lattneraecd74d2009-09-19 18:55:05 +00001525static bool parseDouble(Option &O, StringRef Arg, double &Value) {
Pavel Labathec000f42017-06-23 12:55:02 +00001526 if (to_float(Arg, Value))
1527 return false;
1528 return O.error("'" + Arg + "' value invalid for floating point argument!");
Chris Lattner675db8d2001-10-13 06:53:19 +00001529}
1530
Chris Bieneman5d232242015-01-13 19:14:20 +00001531bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1532 double &Val) {
Chris Lattnerb4101b12002-08-07 18:36:37 +00001533 return parseDouble(O, Arg, Val);
Chris Lattner5df56c42002-07-22 02:07:59 +00001534}
1535
Chris Bieneman5d232242015-01-13 19:14:20 +00001536bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1537 float &Val) {
Chris Lattnerb4101b12002-08-07 18:36:37 +00001538 double dVal;
1539 if (parseDouble(O, Arg, dVal))
1540 return true;
1541 Val = (float)dVal;
1542 return false;
Chris Lattner5df56c42002-07-22 02:07:59 +00001543}
1544
Chris Lattner5df56c42002-07-22 02:07:59 +00001545// generic_parser_base implementation
1546//
1547
Chris Lattner494c0b02002-07-23 17:15:12 +00001548// findOption - Return the option number corresponding to the specified
1549// argument string. If the option is not found, getNumOptions() is returned.
1550//
Mehdi Aminie11b7452016-10-01 03:43:20 +00001551unsigned generic_parser_base::findOption(StringRef Name) {
Benjamin Kramer543d9b22009-09-19 10:01:45 +00001552 unsigned e = getNumOptions();
Chris Lattner494c0b02002-07-23 17:15:12 +00001553
Benjamin Kramer543d9b22009-09-19 10:01:45 +00001554 for (unsigned i = 0; i != e; ++i) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001555 if (getOption(i) == Name)
Chris Lattner494c0b02002-07-23 17:15:12 +00001556 return i;
Benjamin Kramer543d9b22009-09-19 10:01:45 +00001557 }
Chris Lattner494c0b02002-07-23 17:15:12 +00001558 return e;
1559}
1560
Chris Lattner5df56c42002-07-22 02:07:59 +00001561// Return the width of the option tag for printing...
Evan Cheng86cb3182008-05-05 18:30:58 +00001562size_t generic_parser_base::getOptionWidth(const Option &O) const {
Chris Lattner5df56c42002-07-22 02:07:59 +00001563 if (O.hasArgStr()) {
David Blaikieff43d692015-11-17 19:00:52 +00001564 size_t Size = O.ArgStr.size() + 6;
Chris Lattner5df56c42002-07-22 02:07:59 +00001565 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001566 Size = std::max(Size, getOption(i).size() + 8);
Chris Lattner5df56c42002-07-22 02:07:59 +00001567 return Size;
1568 } else {
Evan Cheng86cb3182008-05-05 18:30:58 +00001569 size_t BaseSize = 0;
Chris Lattner5df56c42002-07-22 02:07:59 +00001570 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001571 BaseSize = std::max(BaseSize, getOption(i).size() + 8);
Chris Lattner5df56c42002-07-22 02:07:59 +00001572 return BaseSize;
Chris Lattner36a57d32001-07-23 17:17:47 +00001573 }
1574}
1575
Misha Brukman10468d82005-04-21 22:55:34 +00001576// printOptionInfo - Print out information about this option. The
Chris Lattner5df56c42002-07-22 02:07:59 +00001577// to-be-maintained width is specified.
1578//
1579void generic_parser_base::printOptionInfo(const Option &O,
Evan Cheng86cb3182008-05-05 18:30:58 +00001580 size_t GlobalWidth) const {
Chris Lattner5df56c42002-07-22 02:07:59 +00001581 if (O.hasArgStr()) {
Chris Lattnere7c1e212009-09-20 05:03:30 +00001582 outs() << " -" << O.ArgStr;
Daniel Berlin25f1db12017-02-19 04:28:56 +00001583 Option::printHelpStr(O.HelpStr, GlobalWidth, O.ArgStr.size() + 6);
Chris Lattner36a57d32001-07-23 17:17:47 +00001584
Chris Lattner5df56c42002-07-22 02:07:59 +00001585 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001586 size_t NumSpaces = GlobalWidth - getOption(i).size() - 8;
Chris Lattnere7c1e212009-09-20 05:03:30 +00001587 outs() << " =" << getOption(i);
1588 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
Chris Lattnerc2ef08c2002-01-31 00:42:56 +00001589 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001590 } else {
David Blaikieff43d692015-11-17 19:00:52 +00001591 if (!O.HelpStr.empty())
Chris Lattnere7c1e212009-09-20 05:03:30 +00001592 outs() << " " << O.HelpStr << '\n';
Chris Lattner5df56c42002-07-22 02:07:59 +00001593 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001594 auto Option = getOption(i);
Alexander Kornienko72a196a2013-05-10 17:15:51 +00001595 outs() << " -" << Option;
Daniel Berlin25f1db12017-02-19 04:28:56 +00001596 Option::printHelpStr(getDescription(i), GlobalWidth, Option.size() + 8);
Chris Lattner5df56c42002-07-22 02:07:59 +00001597 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001598 }
1599}
1600
Andrew Trick12004012011-04-05 18:54:36 +00001601static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1602
1603// printGenericOptionDiff - Print the value of this option and it's default.
1604//
1605// "Generic" options have each value mapped to a name.
Chris Bieneman5d232242015-01-13 19:14:20 +00001606void generic_parser_base::printGenericOptionDiff(
1607 const Option &O, const GenericOptionValue &Value,
1608 const GenericOptionValue &Default, size_t GlobalWidth) const {
Andrew Trick12004012011-04-05 18:54:36 +00001609 outs() << " -" << O.ArgStr;
David Blaikieff43d692015-11-17 19:00:52 +00001610 outs().indent(GlobalWidth - O.ArgStr.size());
Andrew Trick12004012011-04-05 18:54:36 +00001611
1612 unsigned NumOpts = getNumOptions();
1613 for (unsigned i = 0; i != NumOpts; ++i) {
1614 if (Value.compare(getOptionValue(i)))
1615 continue;
1616
1617 outs() << "= " << getOption(i);
Mehdi Aminie11b7452016-10-01 03:43:20 +00001618 size_t L = getOption(i).size();
Andrew Trick12004012011-04-05 18:54:36 +00001619 size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1620 outs().indent(NumSpaces) << " (default: ";
1621 for (unsigned j = 0; j != NumOpts; ++j) {
1622 if (Default.compare(getOptionValue(j)))
1623 continue;
1624 outs() << getOption(j);
1625 break;
1626 }
1627 outs() << ")\n";
1628 return;
1629 }
1630 outs() << "= *unknown option value*\n";
1631}
1632
1633// printOptionDiff - Specializations for printing basic value types.
1634//
Chris Bieneman5d232242015-01-13 19:14:20 +00001635#define PRINT_OPT_DIFF(T) \
1636 void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1637 size_t GlobalWidth) const { \
1638 printOptionName(O, GlobalWidth); \
1639 std::string Str; \
1640 { \
1641 raw_string_ostream SS(Str); \
1642 SS << V; \
1643 } \
1644 outs() << "= " << Str; \
1645 size_t NumSpaces = \
1646 MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
1647 outs().indent(NumSpaces) << " (default: "; \
1648 if (D.hasValue()) \
1649 outs() << D.getValue(); \
1650 else \
1651 outs() << "*no default*"; \
1652 outs() << ")\n"; \
1653 }
Andrew Trick12004012011-04-05 18:54:36 +00001654
Frits van Bommel87e33672011-04-06 12:29:56 +00001655PRINT_OPT_DIFF(bool)
1656PRINT_OPT_DIFF(boolOrDefault)
1657PRINT_OPT_DIFF(int)
1658PRINT_OPT_DIFF(unsigned)
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +00001659PRINT_OPT_DIFF(unsigned long long)
Frits van Bommel87e33672011-04-06 12:29:56 +00001660PRINT_OPT_DIFF(double)
1661PRINT_OPT_DIFF(float)
1662PRINT_OPT_DIFF(char)
Andrew Trick12004012011-04-05 18:54:36 +00001663
Chris Bieneman5d232242015-01-13 19:14:20 +00001664void parser<std::string>::printOptionDiff(const Option &O, StringRef V,
Benjamin Kramerc321e532016-06-08 19:09:22 +00001665 const OptionValue<std::string> &D,
Chris Bieneman5d232242015-01-13 19:14:20 +00001666 size_t GlobalWidth) const {
Andrew Trick12004012011-04-05 18:54:36 +00001667 printOptionName(O, GlobalWidth);
1668 outs() << "= " << V;
1669 size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1670 outs().indent(NumSpaces) << " (default: ";
1671 if (D.hasValue())
1672 outs() << D.getValue();
1673 else
1674 outs() << "*no default*";
1675 outs() << ")\n";
1676}
1677
1678// Print a placeholder for options that don't yet support printOptionDiff().
Chris Bieneman5d232242015-01-13 19:14:20 +00001679void basic_parser_impl::printOptionNoValue(const Option &O,
1680 size_t GlobalWidth) const {
Andrew Trick12004012011-04-05 18:54:36 +00001681 printOptionName(O, GlobalWidth);
1682 outs() << "= *cannot print option value*\n";
1683}
Chris Lattner36a57d32001-07-23 17:17:47 +00001684
1685//===----------------------------------------------------------------------===//
Duncan Sands142b9ed2010-02-18 14:08:13 +00001686// -help and -help-hidden option implementation
Chris Lattner36a57d32001-07-23 17:17:47 +00001687//
Reid Spencer1f4ab8b2004-11-14 22:04:00 +00001688
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001689static int OptNameCompare(const std::pair<const char *, Option *> *LHS,
1690 const std::pair<const char *, Option *> *RHS) {
1691 return strcmp(LHS->first, RHS->first);
Chris Lattner6ec8caf2009-09-20 05:37:24 +00001692}
1693
Zachary Turner07670b32016-06-29 21:48:26 +00001694static int SubNameCompare(const std::pair<const char *, SubCommand *> *LHS,
1695 const std::pair<const char *, SubCommand *> *RHS) {
1696 return strcmp(LHS->first, RHS->first);
1697}
1698
Andrew Trick12004012011-04-05 18:54:36 +00001699// Copy Options into a vector so we can sort them as we like.
Chris Bieneman5d232242015-01-13 19:14:20 +00001700static void sortOpts(StringMap<Option *> &OptMap,
1701 SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1702 bool ShowHidden) {
Matthias Braunb30f2f512016-01-30 01:24:31 +00001703 SmallPtrSet<Option *, 32> OptionSet; // Duplicate option detection.
Andrew Trick12004012011-04-05 18:54:36 +00001704
Chris Bieneman5d232242015-01-13 19:14:20 +00001705 for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
Andrew Trick12004012011-04-05 18:54:36 +00001706 I != E; ++I) {
1707 // Ignore really-hidden options.
1708 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1709 continue;
1710
1711 // Unless showhidden is set, ignore hidden flags.
1712 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1713 continue;
1714
1715 // If we've already seen this option, don't add it to the list again.
David Blaikie70573dc2014-11-19 07:49:26 +00001716 if (!OptionSet.insert(I->second).second)
Andrew Trick12004012011-04-05 18:54:36 +00001717 continue;
1718
Chris Bieneman5d232242015-01-13 19:14:20 +00001719 Opts.push_back(
1720 std::pair<const char *, Option *>(I->getKey().data(), I->second));
Andrew Trick12004012011-04-05 18:54:36 +00001721 }
1722
1723 // Sort the options list alphabetically.
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001724 array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare);
Andrew Trick12004012011-04-05 18:54:36 +00001725}
1726
Zachary Turner07670b32016-06-29 21:48:26 +00001727static void
1728sortSubCommands(const SmallPtrSetImpl<SubCommand *> &SubMap,
1729 SmallVectorImpl<std::pair<const char *, SubCommand *>> &Subs) {
1730 for (const auto &S : SubMap) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001731 if (S->getName().empty())
Zachary Turner07670b32016-06-29 21:48:26 +00001732 continue;
Mehdi Aminie11b7452016-10-01 03:43:20 +00001733 Subs.push_back(std::make_pair(S->getName().data(), S));
Zachary Turner07670b32016-06-29 21:48:26 +00001734 }
1735 array_pod_sort(Subs.begin(), Subs.end(), SubNameCompare);
1736}
1737
Chris Lattner36a57d32001-07-23 17:17:47 +00001738namespace {
1739
Chris Lattner5df56c42002-07-22 02:07:59 +00001740class HelpPrinter {
Andrew Trick0537a982013-05-06 21:56:23 +00001741protected:
Chris Lattner36a57d32001-07-23 17:17:47 +00001742 const bool ShowHidden;
Chris Bieneman5d232242015-01-13 19:14:20 +00001743 typedef SmallVector<std::pair<const char *, Option *>, 128>
1744 StrOptionPairVector;
Zachary Turner07670b32016-06-29 21:48:26 +00001745 typedef SmallVector<std::pair<const char *, SubCommand *>, 128>
1746 StrSubCommandPairVector;
Andrew Trick0537a982013-05-06 21:56:23 +00001747 // Print the options. Opts is assumed to be alphabetically sorted.
1748 virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1749 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1750 Opts[i].second->printOptionInfo(MaxArgLen);
1751 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001752
Zachary Turner07670b32016-06-29 21:48:26 +00001753 void printSubCommands(StrSubCommandPairVector &Subs, size_t MaxSubLen) {
1754 for (const auto &S : Subs) {
1755 outs() << " " << S.first;
Mehdi Aminie11b7452016-10-01 03:43:20 +00001756 if (!S.second->getDescription().empty()) {
Zachary Turner07670b32016-06-29 21:48:26 +00001757 outs().indent(MaxSubLen - strlen(S.first));
1758 outs() << " - " << S.second->getDescription();
1759 }
1760 outs() << "\n";
1761 }
1762 }
1763
Chris Lattner5df56c42002-07-22 02:07:59 +00001764public:
Craig Topperfa9888f2013-03-09 23:29:37 +00001765 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
Andrew Trick0537a982013-05-06 21:56:23 +00001766 virtual ~HelpPrinter() {}
Chris Lattner5df56c42002-07-22 02:07:59 +00001767
Andrew Trick0537a982013-05-06 21:56:23 +00001768 // Invoke the printer.
Chris Lattner5df56c42002-07-22 02:07:59 +00001769 void operator=(bool Value) {
David Blaikiedc3f01e2015-03-09 01:57:13 +00001770 if (!Value)
Chris Bieneman5d232242015-01-13 19:14:20 +00001771 return;
Chris Lattner5df56c42002-07-22 02:07:59 +00001772
Zachary Turner07670b32016-06-29 21:48:26 +00001773 SubCommand *Sub = GlobalParser->getActiveSubCommand();
1774 auto &OptionsMap = Sub->OptionsMap;
1775 auto &PositionalOpts = Sub->PositionalOpts;
1776 auto &ConsumeAfterOpt = Sub->ConsumeAfterOpt;
1777
Andrew Trick0537a982013-05-06 21:56:23 +00001778 StrOptionPairVector Opts;
Zachary Turner07670b32016-06-29 21:48:26 +00001779 sortOpts(OptionsMap, Opts, ShowHidden);
1780
1781 StrSubCommandPairVector Subs;
1782 sortSubCommands(GlobalParser->RegisteredSubCommands, Subs);
Chris Lattner36a57d32001-07-23 17:17:47 +00001783
Mehdi Aminie11b7452016-10-01 03:43:20 +00001784 if (!GlobalParser->ProgramOverview.empty())
Chris Bienemand1d94302015-01-28 19:00:25 +00001785 outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
Chris Lattner36a57d32001-07-23 17:17:47 +00001786
Zachary Turner79f33332016-10-11 15:58:48 +00001787 if (Sub == &*TopLevelSubCommand) {
1788 outs() << "USAGE: " << GlobalParser->ProgramName;
1789 if (Subs.size() > 2)
1790 outs() << " [subcommand]";
1791 outs() << " [options]";
1792 } else {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001793 if (!Sub->getDescription().empty()) {
Zachary Turner07670b32016-06-29 21:48:26 +00001794 outs() << "SUBCOMMAND '" << Sub->getName()
1795 << "': " << Sub->getDescription() << "\n\n";
1796 }
1797 outs() << "USAGE: " << GlobalParser->ProgramName << " " << Sub->getName()
1798 << " [options]";
1799 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001800
Zachary Turner07670b32016-06-29 21:48:26 +00001801 for (auto Opt : PositionalOpts) {
David Blaikieff43d692015-11-17 19:00:52 +00001802 if (Opt->hasArgStr())
Chris Bienemand1d94302015-01-28 19:00:25 +00001803 outs() << " --" << Opt->ArgStr;
1804 outs() << " " << Opt->HelpStr;
Chris Lattner2da046f2003-07-30 17:34:02 +00001805 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001806
1807 // Print the consume after option info if it exists...
Zachary Turner07670b32016-06-29 21:48:26 +00001808 if (ConsumeAfterOpt)
1809 outs() << " " << ConsumeAfterOpt->HelpStr;
1810
Alex Lorenzd6802872016-10-12 10:04:35 +00001811 if (Sub == &*TopLevelSubCommand && !Subs.empty()) {
Zachary Turner07670b32016-06-29 21:48:26 +00001812 // Compute the maximum subcommand length...
1813 size_t MaxSubLen = 0;
1814 for (size_t i = 0, e = Subs.size(); i != e; ++i)
1815 MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first));
1816
1817 outs() << "\n\n";
1818 outs() << "SUBCOMMANDS:\n\n";
1819 printSubCommands(Subs, MaxSubLen);
1820 outs() << "\n";
1821 outs() << " Type \"" << GlobalParser->ProgramName
1822 << " <subcommand> -help\" to get more help on a specific "
1823 "subcommand";
1824 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001825
Chris Lattner471ba482009-08-23 08:43:55 +00001826 outs() << "\n\n";
Chris Lattner36a57d32001-07-23 17:17:47 +00001827
1828 // Compute the maximum argument length...
Craig Topperfa9888f2013-03-09 23:29:37 +00001829 size_t MaxArgLen = 0;
Evan Cheng86cb3182008-05-05 18:30:58 +00001830 for (size_t i = 0, e = Opts.size(); i != e; ++i)
Chris Lattner6ec8caf2009-09-20 05:37:24 +00001831 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
Chris Lattner36a57d32001-07-23 17:17:47 +00001832
Chris Lattner471ba482009-08-23 08:43:55 +00001833 outs() << "OPTIONS:\n";
Andrew Trick0537a982013-05-06 21:56:23 +00001834 printOptions(Opts, MaxArgLen);
Chris Lattner36a57d32001-07-23 17:17:47 +00001835
Chris Lattner37bcd992004-11-19 17:08:15 +00001836 // Print any extra help the user has declared.
Chris Bienemand1d94302015-01-28 19:00:25 +00001837 for (auto I : GlobalParser->MoreHelp)
1838 outs() << I;
1839 GlobalParser->MoreHelp.clear();
Reid Spencer1f4ab8b2004-11-14 22:04:00 +00001840
Reid Spencer5e554702004-11-16 06:11:52 +00001841 // Halt the program since help information was printed
Justin Bogner02b95842014-02-28 19:08:01 +00001842 exit(0);
Chris Lattner36a57d32001-07-23 17:17:47 +00001843 }
1844};
Andrew Trick0537a982013-05-06 21:56:23 +00001845
1846class CategorizedHelpPrinter : public HelpPrinter {
1847public:
1848 explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1849
1850 // Helper function for printOptions().
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001851 // It shall return a negative value if A's name should be lexicographically
Daniel Sanders513c3e42017-03-27 13:43:24 +00001852 // ordered before B's name. It returns a value greater than zero if B's name
1853 // should be ordered before A's name, and it returns 0 otherwise.
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001854 static int OptionCategoryCompare(OptionCategory *const *A,
1855 OptionCategory *const *B) {
Daniel Sanders513c3e42017-03-27 13:43:24 +00001856 return (*A)->getName().compare((*B)->getName());
Andrew Trick0537a982013-05-06 21:56:23 +00001857 }
1858
1859 // Make sure we inherit our base class's operator=()
Chris Bieneman5d232242015-01-13 19:14:20 +00001860 using HelpPrinter::operator=;
Andrew Trick0537a982013-05-06 21:56:23 +00001861
1862protected:
Craig Topper32ea8262014-03-04 06:24:11 +00001863 void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
Andrew Trick0537a982013-05-06 21:56:23 +00001864 std::vector<OptionCategory *> SortedCategories;
Chris Bieneman5d232242015-01-13 19:14:20 +00001865 std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
Andrew Trick0537a982013-05-06 21:56:23 +00001866
Alp Tokercb402912014-01-24 17:20:08 +00001867 // Collect registered option categories into vector in preparation for
Andrew Trick0537a982013-05-06 21:56:23 +00001868 // sorting.
Chris Bieneman67e426a2015-02-13 22:54:32 +00001869 for (auto I = GlobalParser->RegisteredOptionCategories.begin(),
1870 E = GlobalParser->RegisteredOptionCategories.end();
Alexander Kornienkod772d722014-02-07 17:42:30 +00001871 I != E; ++I) {
Andrew Trick0537a982013-05-06 21:56:23 +00001872 SortedCategories.push_back(*I);
Alexander Kornienkod772d722014-02-07 17:42:30 +00001873 }
Andrew Trick0537a982013-05-06 21:56:23 +00001874
1875 // Sort the different option categories alphabetically.
1876 assert(SortedCategories.size() > 0 && "No option categories registered!");
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001877 array_pod_sort(SortedCategories.begin(), SortedCategories.end(),
1878 OptionCategoryCompare);
Andrew Trick0537a982013-05-06 21:56:23 +00001879
1880 // Create map to empty vectors.
1881 for (std::vector<OptionCategory *>::const_iterator
1882 I = SortedCategories.begin(),
1883 E = SortedCategories.end();
1884 I != E; ++I)
1885 CategorizedOptions[*I] = std::vector<Option *>();
1886
1887 // Walk through pre-sorted options and assign into categories.
1888 // Because the options are already alphabetically sorted the
1889 // options within categories will also be alphabetically sorted.
1890 for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1891 Option *Opt = Opts[I].second;
1892 assert(CategorizedOptions.count(Opt->Category) > 0 &&
1893 "Option has an unregistered category");
1894 CategorizedOptions[Opt->Category].push_back(Opt);
1895 }
1896
1897 // Now do printing.
1898 for (std::vector<OptionCategory *>::const_iterator
1899 Category = SortedCategories.begin(),
1900 E = SortedCategories.end();
1901 Category != E; ++Category) {
1902 // Hide empty categories for -help, but show for -help-hidden.
Benjamin Kramer4dea8f52016-06-17 18:59:41 +00001903 const auto &CategoryOptions = CategorizedOptions[*Category];
1904 bool IsEmptyCategory = CategoryOptions.empty();
Andrew Trick0537a982013-05-06 21:56:23 +00001905 if (!ShowHidden && IsEmptyCategory)
1906 continue;
1907
1908 // Print category information.
1909 outs() << "\n";
1910 outs() << (*Category)->getName() << ":\n";
1911
1912 // Check if description is set.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001913 if (!(*Category)->getDescription().empty())
Andrew Trick0537a982013-05-06 21:56:23 +00001914 outs() << (*Category)->getDescription() << "\n\n";
1915 else
1916 outs() << "\n";
1917
1918 // When using -help-hidden explicitly state if the category has no
1919 // options associated with it.
1920 if (IsEmptyCategory) {
1921 outs() << " This option category has no options.\n";
1922 continue;
1923 }
1924 // Loop over the options in the category and print.
Benjamin Kramer4dea8f52016-06-17 18:59:41 +00001925 for (const Option *Opt : CategoryOptions)
1926 Opt->printOptionInfo(MaxArgLen);
Andrew Trick0537a982013-05-06 21:56:23 +00001927 }
1928 }
1929};
1930
1931// This wraps the Uncategorizing and Categorizing printers and decides
1932// at run time which should be invoked.
1933class HelpPrinterWrapper {
1934private:
1935 HelpPrinter &UncategorizedPrinter;
1936 CategorizedHelpPrinter &CategorizedPrinter;
1937
1938public:
1939 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
Chris Bieneman5d232242015-01-13 19:14:20 +00001940 CategorizedHelpPrinter &CategorizedPrinter)
1941 : UncategorizedPrinter(UncategorizedPrinter),
1942 CategorizedPrinter(CategorizedPrinter) {}
Andrew Trick0537a982013-05-06 21:56:23 +00001943
1944 // Invoke the printer.
1945 void operator=(bool Value);
1946};
1947
Chris Lattneradb19d62006-10-12 22:09:17 +00001948} // End anonymous namespace
Chris Lattner36a57d32001-07-23 17:17:47 +00001949
Andrew Trick0537a982013-05-06 21:56:23 +00001950// Declare the four HelpPrinter instances that are used to print out help, or
1951// help-hidden as an uncategorized list or in categories.
1952static HelpPrinter UncategorizedNormalPrinter(false);
1953static HelpPrinter UncategorizedHiddenPrinter(true);
1954static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1955static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1956
Andrew Trick0537a982013-05-06 21:56:23 +00001957// Declare HelpPrinter wrappers that will decide whether or not to invoke
1958// a categorizing help printer
1959static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1960 CategorizedNormalPrinter);
1961static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1962 CategorizedHiddenPrinter);
1963
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001964// Define a category for generic options that all tools should have.
1965static cl::OptionCategory GenericCategory("Generic Options");
1966
Andrew Trick0537a982013-05-06 21:56:23 +00001967// Define uncategorized help printers.
1968// -help-list is hidden by default because if Option categories are being used
1969// then -help behaves the same as -help-list.
Chris Bieneman5d232242015-01-13 19:14:20 +00001970static cl::opt<HelpPrinter, true, parser<bool>> HLOp(
1971 "help-list",
1972 cl::desc("Display list of available options (-help-list-hidden for more)"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001973 cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
Zachary Turner07670b32016-06-29 21:48:26 +00001974 cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Chris Lattner5df56c42002-07-22 02:07:59 +00001975
Chris Bieneman5d232242015-01-13 19:14:20 +00001976static cl::opt<HelpPrinter, true, parser<bool>>
1977 HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
1978 cl::location(UncategorizedHiddenPrinter), cl::Hidden,
Zachary Turner07670b32016-06-29 21:48:26 +00001979 cl::ValueDisallowed, cl::cat(GenericCategory),
1980 cl::sub(*AllSubCommands));
Andrew Trick0537a982013-05-06 21:56:23 +00001981
1982// Define uncategorized/categorized help printers. These printers change their
1983// behaviour at runtime depending on whether one or more Option categories have
1984// been declared.
Chris Bieneman5d232242015-01-13 19:14:20 +00001985static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1986 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001987 cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
Zachary Turner07670b32016-06-29 21:48:26 +00001988 cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Chris Lattner5df56c42002-07-22 02:07:59 +00001989
Chris Bieneman5d232242015-01-13 19:14:20 +00001990static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1991 HHOp("help-hidden", cl::desc("Display all available options"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001992 cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
Zachary Turner07670b32016-06-29 21:48:26 +00001993 cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Andrew Trick0537a982013-05-06 21:56:23 +00001994
Chris Bieneman5d232242015-01-13 19:14:20 +00001995static cl::opt<bool> PrintOptions(
1996 "print-options",
1997 cl::desc("Print non-default options after command line parsing"),
Zachary Turner07670b32016-06-29 21:48:26 +00001998 cl::Hidden, cl::init(false), cl::cat(GenericCategory),
1999 cl::sub(*AllSubCommands));
Andrew Trick0537a982013-05-06 21:56:23 +00002000
Chris Bieneman5d232242015-01-13 19:14:20 +00002001static cl::opt<bool> PrintAllOptions(
2002 "print-all-options",
2003 cl::desc("Print all option values after command line parsing"), cl::Hidden,
Zachary Turner07670b32016-06-29 21:48:26 +00002004 cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Andrew Trick12004012011-04-05 18:54:36 +00002005
Andrew Trick0537a982013-05-06 21:56:23 +00002006void HelpPrinterWrapper::operator=(bool Value) {
David Blaikiedc3f01e2015-03-09 01:57:13 +00002007 if (!Value)
Andrew Trick0537a982013-05-06 21:56:23 +00002008 return;
2009
2010 // Decide which printer to invoke. If more than one option category is
2011 // registered then it is useful to show the categorized help instead of
2012 // uncategorized help.
Chris Bieneman67e426a2015-02-13 22:54:32 +00002013 if (GlobalParser->RegisteredOptionCategories.size() > 1) {
Andrew Trick0537a982013-05-06 21:56:23 +00002014 // unhide -help-list option so user can have uncategorized output if they
2015 // want it.
2016 HLOp.setHiddenFlag(NotHidden);
2017
2018 CategorizedPrinter = true; // Invoke categorized printer
Chris Bieneman5d232242015-01-13 19:14:20 +00002019 } else
Andrew Trick0537a982013-05-06 21:56:23 +00002020 UncategorizedPrinter = true; // Invoke uncategorized printer
2021}
2022
Andrew Trick12004012011-04-05 18:54:36 +00002023// Print the value of each option.
Chris Bienemand77bbab2015-01-30 22:16:01 +00002024void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
2025
2026void CommandLineParser::printOptionValues() {
Chris Bieneman5d232242015-01-13 19:14:20 +00002027 if (!PrintOptions && !PrintAllOptions)
2028 return;
Andrew Trick12004012011-04-05 18:54:36 +00002029
Chris Bieneman5d232242015-01-13 19:14:20 +00002030 SmallVector<std::pair<const char *, Option *>, 128> Opts;
Zachary Turner07670b32016-06-29 21:48:26 +00002031 sortOpts(ActiveSubCommand->OptionsMap, Opts, /*ShowHidden*/ true);
Andrew Trick12004012011-04-05 18:54:36 +00002032
2033 // Compute the maximum argument length...
2034 size_t MaxArgLen = 0;
2035 for (size_t i = 0, e = Opts.size(); i != e; ++i)
2036 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2037
2038 for (size_t i = 0, e = Opts.size(); i != e; ++i)
2039 Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
2040}
2041
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002042static VersionPrinterTy OverrideVersionPrinter = nullptr;
Reid Spencerb3171672006-06-05 16:22:56 +00002043
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002044static std::vector<VersionPrinterTy> *ExtraVersionPrinters = nullptr;
Chandler Carruthea7e5522011-07-22 07:50:40 +00002045
Chris Lattneradb19d62006-10-12 22:09:17 +00002046namespace {
Reid Spencerb3171672006-06-05 16:22:56 +00002047class VersionPrinter {
2048public:
Devang Patel9eb2caae2007-02-01 01:43:37 +00002049 void print() {
Chris Lattner131dca92009-09-20 06:18:38 +00002050 raw_ostream &OS = outs();
Chris Bienemanef43d442016-03-15 18:07:46 +00002051#ifdef PACKAGE_VENDOR
2052 OS << PACKAGE_VENDOR << " ";
2053#else
2054 OS << "LLVM (http://llvm.org/):\n ";
2055#endif
2056 OS << PACKAGE_NAME << " version " << PACKAGE_VERSION;
Chris Lattner8ac22e72006-07-06 18:33:03 +00002057#ifdef LLVM_VERSION_INFO
Justin Bogner581b5922014-06-17 06:52:41 +00002058 OS << " " << LLVM_VERSION_INFO;
Reid Spencerb3171672006-06-05 16:22:56 +00002059#endif
Chris Lattner131dca92009-09-20 06:18:38 +00002060 OS << "\n ";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002061#ifndef __OPTIMIZE__
Chris Lattner131dca92009-09-20 06:18:38 +00002062 OS << "DEBUG build";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002063#else
Chris Lattner131dca92009-09-20 06:18:38 +00002064 OS << "Optimized build";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002065#endif
2066#ifndef NDEBUG
Chris Lattner131dca92009-09-20 06:18:38 +00002067 OS << " with assertions";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002068#endif
Xin Tong59cb7782017-04-19 00:03:36 +00002069#if LLVM_VERSION_PRINTER_SHOW_HOST_TARGET_INFO
Daniel Dunbard90a9a02009-11-14 21:36:07 +00002070 std::string CPU = sys::getHostCPUName();
Chris Bieneman5d232242015-01-13 19:14:20 +00002071 if (CPU == "generic")
2072 CPU = "(unknown)";
Chris Lattner131dca92009-09-20 06:18:38 +00002073 OS << ".\n"
Sebastian Pop94441fb2011-11-01 21:32:20 +00002074 << " Default target: " << sys::getDefaultTargetTriple() << '\n'
Xin Tong59cb7782017-04-19 00:03:36 +00002075 << " Host CPU: " << CPU;
2076#endif
2077 OS << '\n';
Devang Patel9eb2caae2007-02-01 01:43:37 +00002078 }
2079 void operator=(bool OptionWasSpecified) {
Chris Bieneman5d232242015-01-13 19:14:20 +00002080 if (!OptionWasSpecified)
2081 return;
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00002082
Craig Topperc10719f2014-04-07 04:17:22 +00002083 if (OverrideVersionPrinter != nullptr) {
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002084 OverrideVersionPrinter(outs());
Justin Bogner02b95842014-02-28 19:08:01 +00002085 exit(0);
Reid Spencerb3171672006-06-05 16:22:56 +00002086 }
Chandler Carruthea7e5522011-07-22 07:50:40 +00002087 print();
2088
2089 // Iterate over any registered extra printers and call them to add further
2090 // information.
Craig Topperc10719f2014-04-07 04:17:22 +00002091 if (ExtraVersionPrinters != nullptr) {
Chandler Carruth2d71c422011-07-22 07:50:48 +00002092 outs() << '\n';
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002093 for (auto I : *ExtraVersionPrinters)
2094 I(outs());
Chandler Carruthea7e5522011-07-22 07:50:40 +00002095 }
2096
Justin Bogner02b95842014-02-28 19:08:01 +00002097 exit(0);
Reid Spencerb3171672006-06-05 16:22:56 +00002098 }
2099};
Chris Lattneradb19d62006-10-12 22:09:17 +00002100} // End anonymous namespace
Reid Spencerb3171672006-06-05 16:22:56 +00002101
Reid Spencerff6cc122004-08-04 00:36:06 +00002102// Define the --version option that prints out the LLVM version for the tool
Chris Lattneradb19d62006-10-12 22:09:17 +00002103static VersionPrinter VersionPrinterInstance;
2104
Chris Bieneman5d232242015-01-13 19:14:20 +00002105static cl::opt<VersionPrinter, true, parser<bool>>
2106 VersOp("version", cl::desc("Display the version of this program"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00002107 cl::location(VersionPrinterInstance), cl::ValueDisallowed,
2108 cl::cat(GenericCategory));
Reid Spencerff6cc122004-08-04 00:36:06 +00002109
Reid Spencer5e554702004-11-16 06:11:52 +00002110// Utility function for printing the help message.
Andrew Trick0537a982013-05-06 21:56:23 +00002111void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
2112 // This looks weird, but it actually prints the help message. The Printers are
2113 // types of HelpPrinter and the help gets printed when its operator= is
2114 // invoked. That's because the "normal" usages of the help printer is to be
2115 // assigned true/false depending on whether -help or -help-hidden was given or
2116 // not. Since we're circumventing that we have to make it look like -help or
2117 // -help-hidden were given, so we assign true.
2118
2119 if (!Hidden && !Categorized)
2120 UncategorizedNormalPrinter = true;
2121 else if (!Hidden && Categorized)
2122 CategorizedNormalPrinter = true;
2123 else if (Hidden && !Categorized)
2124 UncategorizedHiddenPrinter = true;
2125 else
2126 CategorizedHiddenPrinter = true;
Reid Spencer5e554702004-11-16 06:11:52 +00002127}
Reid Spencerb3171672006-06-05 16:22:56 +00002128
Devang Patel9eb2caae2007-02-01 01:43:37 +00002129/// Utility function for printing version number.
Chris Bieneman5d232242015-01-13 19:14:20 +00002130void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
Devang Patel9eb2caae2007-02-01 01:43:37 +00002131
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002132void cl::SetVersionPrinter(VersionPrinterTy func) { OverrideVersionPrinter = func; }
Chandler Carruthea7e5522011-07-22 07:50:40 +00002133
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002134void cl::AddExtraVersionPrinter(VersionPrinterTy func) {
Craig Topper8d399f82014-04-09 04:20:00 +00002135 if (!ExtraVersionPrinters)
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002136 ExtraVersionPrinters = new std::vector<VersionPrinterTy>;
Chandler Carruthea7e5522011-07-22 07:50:40 +00002137
2138 ExtraVersionPrinters->push_back(func);
2139}
Andrew Trick7cb710d2013-05-06 21:56:35 +00002140
Zachary Turner07670b32016-06-29 21:48:26 +00002141StringMap<Option *> &cl::getRegisteredOptions(SubCommand &Sub) {
2142 auto &Subs = GlobalParser->RegisteredSubCommands;
2143 (void)Subs;
David Majnemer0d955d02016-08-11 22:21:41 +00002144 assert(is_contained(Subs, &Sub));
Zachary Turner07670b32016-06-29 21:48:26 +00002145 return Sub.OptionsMap;
Andrew Trick7cb710d2013-05-06 21:56:35 +00002146}
Peter Collingbournee1863192014-10-16 22:47:52 +00002147
Dean Michael Berris27358cf2016-10-05 05:20:08 +00002148iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator>
2149cl::getRegisteredSubcommands() {
2150 return GlobalParser->getRegisteredSubcommands();
2151}
2152
Zachary Turner07670b32016-06-29 21:48:26 +00002153void cl::HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub) {
2154 for (auto &I : Sub.OptionsMap) {
Chris Bieneman831fc5e2015-01-26 16:56:00 +00002155 if (I.second->Category != &Category &&
2156 I.second->Category != &GenericCategory)
Chris Bieneman9e13af72015-01-21 22:45:52 +00002157 I.second->setHiddenFlag(cl::ReallyHidden);
2158 }
2159}
2160
Zachary Turner07670b32016-06-29 21:48:26 +00002161void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories,
2162 SubCommand &Sub) {
Chris Bieneman01043252015-01-26 21:57:29 +00002163 auto CategoriesBegin = Categories.begin();
2164 auto CategoriesEnd = Categories.end();
Zachary Turner07670b32016-06-29 21:48:26 +00002165 for (auto &I : Sub.OptionsMap) {
Chris Bieneman01043252015-01-26 21:57:29 +00002166 if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
2167 CategoriesEnd &&
2168 I.second->Category != &GenericCategory)
2169 I.second->setHiddenFlag(cl::ReallyHidden);
2170 }
2171}
2172
Zachary Turner07670b32016-06-29 21:48:26 +00002173void cl::ResetCommandLineParser() { GlobalParser->reset(); }
2174void cl::ResetAllOptionOccurrences() {
2175 GlobalParser->ResetAllOptionOccurrences();
2176}
2177
Peter Collingbournee1863192014-10-16 22:47:52 +00002178void LLVMParseCommandLineOptions(int argc, const char *const *argv,
2179 const char *Overview) {
Eric Liue51ee062017-03-15 08:41:00 +00002180 llvm::cl::ParseCommandLineOptions(argc, argv, StringRef(Overview),
2181 &llvm::nulls());
Peter Collingbournee1863192014-10-16 22:47:52 +00002182}