blob: 8fb01211e9797405a444cbf622c84d1dc28aef4e [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
Chris Lattner3e5d60f2006-08-27 12:45:47 +000049//===----------------------------------------------------------------------===//
50// Template instantiations and anchors.
51//
Chris Bieneman5d232242015-01-13 19:14:20 +000052namespace llvm {
53namespace cl {
Benjamin Kramera667d1a2015-07-13 17:21:31 +000054template class basic_parser<bool>;
55template class basic_parser<boolOrDefault>;
56template class basic_parser<int>;
57template class basic_parser<unsigned>;
58template class basic_parser<unsigned long long>;
59template class basic_parser<double>;
60template class basic_parser<float>;
61template class basic_parser<std::string>;
62template class basic_parser<char>;
Chris Lattner3e5d60f2006-08-27 12:45:47 +000063
Benjamin Kramera667d1a2015-07-13 17:21:31 +000064template class opt<unsigned>;
65template class opt<int>;
66template class opt<std::string>;
67template class opt<char>;
68template class opt<bool>;
Alexander Kornienkof00654e2015-06-23 09:49:53 +000069}
70} // end namespace llvm::cl
Chris Lattner3e5d60f2006-08-27 12:45:47 +000071
Juergen Ributzkad12ccbd2013-11-19 00:57:56 +000072// Pin the vtables to this file.
73void GenericOptionValue::anchor() {}
David Blaikie3a15e142011-12-01 08:00:17 +000074void OptionValue<boolOrDefault>::anchor() {}
75void OptionValue<std::string>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000076void Option::anchor() {}
77void basic_parser_impl::anchor() {}
78void parser<bool>::anchor() {}
Dale Johannesen82810c82007-05-22 17:14:46 +000079void parser<boolOrDefault>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000080void parser<int>::anchor() {}
81void parser<unsigned>::anchor() {}
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +000082void parser<unsigned long long>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000083void parser<double>::anchor() {}
84void parser<float>::anchor() {}
85void parser<std::string>::anchor() {}
Bill Wendlingdb59fda2009-04-29 23:26:16 +000086void parser<char>::anchor() {}
Chris Lattner3e5d60f2006-08-27 12:45:47 +000087
88//===----------------------------------------------------------------------===//
89
Benjamin Kramer970eac42015-02-06 17:51:54 +000090namespace {
91
Chris Bienemand1d94302015-01-28 19:00:25 +000092class CommandLineParser {
93public:
94 // Globals for name and overview of program. Program name is not a string to
95 // avoid static ctor/dtor issues.
Chris Bienemanb6866422015-01-28 22:25:00 +000096 std::string ProgramName;
Mehdi Aminie11b7452016-10-01 03:43:20 +000097 StringRef ProgramOverview;
Reid Spencer9501b9b2004-09-01 04:41:28 +000098
Chris Bienemand1d94302015-01-28 19:00:25 +000099 // This collects additional help to be printed.
Mehdi Aminie11b7452016-10-01 03:43:20 +0000100 std::vector<StringRef> MoreHelp;
Chris Bienemand1d94302015-01-28 19:00:25 +0000101
Chris Bieneman67e426a2015-02-13 22:54:32 +0000102 // This collects the different option categories that have been registered.
103 SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories;
104
Zachary Turner07670b32016-06-29 21:48:26 +0000105 // This collects the different subcommands that have been registered.
106 SmallPtrSet<SubCommand *, 4> RegisteredSubCommands;
Chris Bienemand1d94302015-01-28 19:00:25 +0000107
Mehdi Aminie11b7452016-10-01 03:43:20 +0000108 CommandLineParser() : ActiveSubCommand(nullptr) {
Zachary Turner07670b32016-06-29 21:48:26 +0000109 registerSubCommand(&*TopLevelSubCommand);
110 registerSubCommand(&*AllSubCommands);
111 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000112
Zachary Turner07670b32016-06-29 21:48:26 +0000113 void ResetAllOptionOccurrences();
114
115 bool ParseCommandLineOptions(int argc, const char *const *argv,
Eric Liue51ee062017-03-15 08:41:00 +0000116 StringRef Overview, raw_ostream *Errs = nullptr);
Zachary Turner07670b32016-06-29 21:48:26 +0000117
Mehdi Aminie11b7452016-10-01 03:43:20 +0000118 void addLiteralOption(Option &Opt, SubCommand *SC, StringRef Name) {
Zachary Turner07670b32016-06-29 21:48:26 +0000119 if (Opt.hasArgStr())
120 return;
121 if (!SC->OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
122 errs() << ProgramName << ": CommandLine Error: Option '" << Name
123 << "' registered more than once!\n";
124 report_fatal_error("inconsistency in registered CommandLine options");
125 }
126
127 // If we're adding this to all sub-commands, add it to the ones that have
128 // already been registered.
129 if (SC == &*AllSubCommands) {
130 for (const auto &Sub : RegisteredSubCommands) {
131 if (SC == Sub)
132 continue;
133 addLiteralOption(Opt, Sub, Name);
Chris Bienemand1d94302015-01-28 19:00:25 +0000134 }
135 }
136 }
137
Mehdi Aminie11b7452016-10-01 03:43:20 +0000138 void addLiteralOption(Option &Opt, StringRef Name) {
Zachary Turner07670b32016-06-29 21:48:26 +0000139 if (Opt.Subs.empty())
140 addLiteralOption(Opt, &*TopLevelSubCommand, Name);
141 else {
142 for (auto SC : Opt.Subs)
143 addLiteralOption(Opt, SC, Name);
144 }
145 }
146
147 void addOption(Option *O, SubCommand *SC) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000148 bool HadErrors = false;
David Blaikieff43d692015-11-17 19:00:52 +0000149 if (O->hasArgStr()) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000150 // Add argument to the argument map!
Zachary Turner07670b32016-06-29 21:48:26 +0000151 if (!SC->OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000152 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
153 << "' registered more than once!\n";
154 HadErrors = true;
155 }
156 }
157
158 // Remember information about positional options.
159 if (O->getFormattingFlag() == cl::Positional)
Zachary Turner07670b32016-06-29 21:48:26 +0000160 SC->PositionalOpts.push_back(O);
Chris Bienemand1d94302015-01-28 19:00:25 +0000161 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
Zachary Turner07670b32016-06-29 21:48:26 +0000162 SC->SinkOpts.push_back(O);
Chris Bienemand1d94302015-01-28 19:00:25 +0000163 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
Zachary Turner07670b32016-06-29 21:48:26 +0000164 if (SC->ConsumeAfterOpt) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000165 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
166 HadErrors = true;
167 }
Zachary Turner07670b32016-06-29 21:48:26 +0000168 SC->ConsumeAfterOpt = O;
Chris Bienemand1d94302015-01-28 19:00:25 +0000169 }
170
171 // Fail hard if there were errors. These are strictly unrecoverable and
172 // indicate serious issues such as conflicting option names or an
173 // incorrectly
174 // linked LLVM distribution.
175 if (HadErrors)
176 report_fatal_error("inconsistency in registered CommandLine options");
Zachary Turner07670b32016-06-29 21:48:26 +0000177
178 // If we're adding this to all sub-commands, add it to the ones that have
179 // already been registered.
180 if (SC == &*AllSubCommands) {
181 for (const auto &Sub : RegisteredSubCommands) {
182 if (SC == Sub)
183 continue;
184 addOption(O, Sub);
185 }
186 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000187 }
188
Zachary Turner07670b32016-06-29 21:48:26 +0000189 void addOption(Option *O) {
190 if (O->Subs.empty()) {
191 addOption(O, &*TopLevelSubCommand);
192 } else {
193 for (auto SC : O->Subs)
194 addOption(O, SC);
195 }
196 }
197
198 void removeOption(Option *O, SubCommand *SC) {
David Blaikieff43d692015-11-17 19:00:52 +0000199 SmallVector<StringRef, 16> OptionNames;
Chris Bienemand1d94302015-01-28 19:00:25 +0000200 O->getExtraOptionNames(OptionNames);
David Blaikieff43d692015-11-17 19:00:52 +0000201 if (O->hasArgStr())
Chris Bienemand1d94302015-01-28 19:00:25 +0000202 OptionNames.push_back(O->ArgStr);
Zachary Turner07670b32016-06-29 21:48:26 +0000203
204 SubCommand &Sub = *SC;
Chris Bienemand1d94302015-01-28 19:00:25 +0000205 for (auto Name : OptionNames)
Zachary Turner07670b32016-06-29 21:48:26 +0000206 Sub.OptionsMap.erase(Name);
Chris Bienemand1d94302015-01-28 19:00:25 +0000207
208 if (O->getFormattingFlag() == cl::Positional)
Zachary Turner07670b32016-06-29 21:48:26 +0000209 for (auto Opt = Sub.PositionalOpts.begin();
210 Opt != Sub.PositionalOpts.end(); ++Opt) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000211 if (*Opt == O) {
Zachary Turner07670b32016-06-29 21:48:26 +0000212 Sub.PositionalOpts.erase(Opt);
Chris Bienemand1d94302015-01-28 19:00:25 +0000213 break;
214 }
215 }
216 else if (O->getMiscFlags() & cl::Sink)
Zachary Turner07670b32016-06-29 21:48:26 +0000217 for (auto Opt = Sub.SinkOpts.begin(); Opt != Sub.SinkOpts.end(); ++Opt) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000218 if (*Opt == O) {
Zachary Turner07670b32016-06-29 21:48:26 +0000219 Sub.SinkOpts.erase(Opt);
Chris Bienemand1d94302015-01-28 19:00:25 +0000220 break;
221 }
222 }
Zachary Turner07670b32016-06-29 21:48:26 +0000223 else if (O == Sub.ConsumeAfterOpt)
224 Sub.ConsumeAfterOpt = nullptr;
Chris Bienemand1d94302015-01-28 19:00:25 +0000225 }
226
Zachary Turner07670b32016-06-29 21:48:26 +0000227 void removeOption(Option *O) {
228 if (O->Subs.empty())
229 removeOption(O, &*TopLevelSubCommand);
230 else {
231 if (O->isInAllSubCommands()) {
232 for (auto SC : RegisteredSubCommands)
233 removeOption(O, SC);
234 } else {
235 for (auto SC : O->Subs)
236 removeOption(O, SC);
237 }
238 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000239 }
240
Zachary Turner07670b32016-06-29 21:48:26 +0000241 bool hasOptions(const SubCommand &Sub) const {
242 return (!Sub.OptionsMap.empty() || !Sub.PositionalOpts.empty() ||
243 nullptr != Sub.ConsumeAfterOpt);
244 }
245
246 bool hasOptions() const {
247 for (const auto &S : RegisteredSubCommands) {
248 if (hasOptions(*S))
249 return true;
250 }
251 return false;
252 }
253
254 SubCommand *getActiveSubCommand() { return ActiveSubCommand; }
255
256 void updateArgStr(Option *O, StringRef NewName, SubCommand *SC) {
257 SubCommand &Sub = *SC;
258 if (!Sub.OptionsMap.insert(std::make_pair(NewName, O)).second) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000259 errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
260 << "' registered more than once!\n";
261 report_fatal_error("inconsistency in registered CommandLine options");
262 }
Zachary Turner07670b32016-06-29 21:48:26 +0000263 Sub.OptionsMap.erase(O->ArgStr);
264 }
265
266 void updateArgStr(Option *O, StringRef NewName) {
267 if (O->Subs.empty())
268 updateArgStr(O, NewName, &*TopLevelSubCommand);
269 else {
270 for (auto SC : O->Subs)
271 updateArgStr(O, NewName, SC);
272 }
Chris Bienemand1d94302015-01-28 19:00:25 +0000273 }
Chris Bienemand77bbab2015-01-30 22:16:01 +0000274
275 void printOptionValues();
Chris Bieneman542f56a2015-02-13 22:54:27 +0000276
Chris Bieneman67e426a2015-02-13 22:54:32 +0000277 void registerCategory(OptionCategory *cat) {
Sanjoy Das39c226f2016-06-10 21:18:39 +0000278 assert(count_if(RegisteredOptionCategories,
279 [cat](const OptionCategory *Category) {
280 return cat->getName() == Category->getName();
281 }) == 0 &&
Chris Bieneman67e426a2015-02-13 22:54:32 +0000282 "Duplicate option categories");
283
284 RegisteredOptionCategories.insert(cat);
285 }
286
Zachary Turner07670b32016-06-29 21:48:26 +0000287 void registerSubCommand(SubCommand *sub) {
288 assert(count_if(RegisteredSubCommands,
289 [sub](const SubCommand *Sub) {
Mehdi Aminie11b7452016-10-01 03:43:20 +0000290 return (!sub->getName().empty()) &&
Zachary Turner07670b32016-06-29 21:48:26 +0000291 (Sub->getName() == sub->getName());
292 }) == 0 &&
293 "Duplicate subcommands");
294 RegisteredSubCommands.insert(sub);
295
296 // For all options that have been registered for all subcommands, add the
297 // option to this subcommand now.
298 if (sub != &*AllSubCommands) {
299 for (auto &E : AllSubCommands->OptionsMap) {
300 Option *O = E.second;
301 if ((O->isPositional() || O->isSink() || O->isConsumeAfter()) ||
302 O->hasArgStr())
303 addOption(O, sub);
304 else
Mehdi Aminie11b7452016-10-01 03:43:20 +0000305 addLiteralOption(*O, sub, E.first());
Zachary Turner07670b32016-06-29 21:48:26 +0000306 }
307 }
308 }
309
310 void unregisterSubCommand(SubCommand *sub) {
311 RegisteredSubCommands.erase(sub);
312 }
313
Dean Michael Berris27358cf2016-10-05 05:20:08 +0000314 iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator>
315 getRegisteredSubcommands() {
316 return make_range(RegisteredSubCommands.begin(),
317 RegisteredSubCommands.end());
318 }
319
Zachary Turner07670b32016-06-29 21:48:26 +0000320 void reset() {
321 ActiveSubCommand = nullptr;
322 ProgramName.clear();
Mehdi Aminie11b7452016-10-01 03:43:20 +0000323 ProgramOverview = StringRef();
Zachary Turner07670b32016-06-29 21:48:26 +0000324
325 MoreHelp.clear();
326 RegisteredOptionCategories.clear();
327
328 ResetAllOptionOccurrences();
329 RegisteredSubCommands.clear();
330
331 TopLevelSubCommand->reset();
332 AllSubCommands->reset();
333 registerSubCommand(&*TopLevelSubCommand);
334 registerSubCommand(&*AllSubCommands);
335 }
336
Chris Bieneman542f56a2015-02-13 22:54:27 +0000337private:
Zachary Turner07670b32016-06-29 21:48:26 +0000338 SubCommand *ActiveSubCommand;
339
340 Option *LookupOption(SubCommand &Sub, StringRef &Arg, StringRef &Value);
Mehdi Aminie11b7452016-10-01 03:43:20 +0000341 SubCommand *LookupSubCommand(StringRef Name);
Chris Bienemand1d94302015-01-28 19:00:25 +0000342};
343
Benjamin Kramer970eac42015-02-06 17:51:54 +0000344} // namespace
345
Chris Bienemand1d94302015-01-28 19:00:25 +0000346static ManagedStatic<CommandLineParser> GlobalParser;
347
Mehdi Aminie11b7452016-10-01 03:43:20 +0000348void cl::AddLiteralOption(Option &O, StringRef Name) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000349 GlobalParser->addLiteralOption(O, Name);
350}
Chris Lattner37bcd992004-11-19 17:08:15 +0000351
Mehdi Aminie11b7452016-10-01 03:43:20 +0000352extrahelp::extrahelp(StringRef Help) : morehelp(Help) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000353 GlobalParser->MoreHelp.push_back(Help);
Chris Lattner37bcd992004-11-19 17:08:15 +0000354}
355
Chris Lattner5247f602007-04-06 21:06:55 +0000356void Option::addArgument() {
Chris Bienemand1d94302015-01-28 19:00:25 +0000357 GlobalParser->addOption(this);
358 FullyInitialized = true;
Chris Lattner5247f602007-04-06 21:06:55 +0000359}
360
Chris Bienemand1d94302015-01-28 19:00:25 +0000361void Option::removeArgument() { GlobalParser->removeOption(this); }
362
David Blaikieff43d692015-11-17 19:00:52 +0000363void Option::setArgStr(StringRef S) {
Chris Bienemand1d94302015-01-28 19:00:25 +0000364 if (FullyInitialized)
365 GlobalParser->updateArgStr(this, S);
Mehdi Aminie4c7f122017-01-08 22:30:43 +0000366 assert((S.empty() || S[0] != '-') && "Option can't start with '-");
Chris Bienemand1d94302015-01-28 19:00:25 +0000367 ArgStr = S;
Jordan Rosec25b0c72014-01-29 18:54:17 +0000368}
369
Andrew Trick0537a982013-05-06 21:56:23 +0000370// Initialise the general option category.
371OptionCategory llvm::cl::GeneralCategory("General options");
372
Benjamin Kramer3a377bc2014-03-01 11:47:00 +0000373void OptionCategory::registerCategory() {
Chris Bieneman67e426a2015-02-13 22:54:32 +0000374 GlobalParser->registerCategory(this);
Andrew Trick0537a982013-05-06 21:56:23 +0000375}
Chris Lattneraf039c52007-04-12 00:36:29 +0000376
Zachary Turner07670b32016-06-29 21:48:26 +0000377// A special subcommand representing no subcommand
378ManagedStatic<SubCommand> llvm::cl::TopLevelSubCommand;
379
380// A special subcommand that can be used to put an option into all subcommands.
381ManagedStatic<SubCommand> llvm::cl::AllSubCommands;
382
383void SubCommand::registerSubCommand() {
384 GlobalParser->registerSubCommand(this);
385}
386
387void SubCommand::unregisterSubCommand() {
388 GlobalParser->unregisterSubCommand(this);
389}
390
391void SubCommand::reset() {
392 PositionalOpts.clear();
393 SinkOpts.clear();
394 OptionsMap.clear();
395
396 ConsumeAfterOpt = nullptr;
397}
398
399SubCommand::operator bool() const {
400 return (GlobalParser->getActiveSubCommand() == this);
401}
402
Chris Lattner5df56c42002-07-22 02:07:59 +0000403//===----------------------------------------------------------------------===//
Chris Lattner3e5d60f2006-08-27 12:45:47 +0000404// Basic, shared command line option processing machinery.
Chris Lattner5df56c42002-07-22 02:07:59 +0000405//
406
Chris Lattner2031b022007-04-05 21:58:17 +0000407/// LookupOption - Lookup the option specified by the specified option on the
408/// command line. If there is a value specified (after an equal sign) return
Chris Lattnere7c1e212009-09-20 05:03:30 +0000409/// that as well. This assumes that leading dashes have already been stripped.
Zachary Turner07670b32016-06-29 21:48:26 +0000410Option *CommandLineParser::LookupOption(SubCommand &Sub, StringRef &Arg,
411 StringRef &Value) {
Chris Lattner5a3fa4e2009-09-20 02:02:24 +0000412 // Reject all dashes.
Chris Bieneman5d232242015-01-13 19:14:20 +0000413 if (Arg.empty())
414 return nullptr;
Zachary Turner07670b32016-06-29 21:48:26 +0000415 assert(&Sub != &*AllSubCommands);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000416
Chris Lattner5a3fa4e2009-09-20 02:02:24 +0000417 size_t EqualPos = Arg.find('=');
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000418
Chris Lattner0a40a972009-09-20 01:53:12 +0000419 // If we have an equals sign, remember the value.
Chris Lattnere7c1e212009-09-20 05:03:30 +0000420 if (EqualPos == StringRef::npos) {
421 // Look up the option.
Zachary Turner07670b32016-06-29 21:48:26 +0000422 auto I = Sub.OptionsMap.find(Arg);
423 if (I == Sub.OptionsMap.end())
424 return nullptr;
425
426 return I != Sub.OptionsMap.end() ? I->second : nullptr;
Chris Lattner5a3fa4e2009-09-20 02:02:24 +0000427 }
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +0000428
Chris Lattnere7c1e212009-09-20 05:03:30 +0000429 // If the argument before the = is a valid option name, we match. If not,
430 // return Arg unmolested.
Zachary Turner07670b32016-06-29 21:48:26 +0000431 auto I = Sub.OptionsMap.find(Arg.substr(0, EqualPos));
432 if (I == Sub.OptionsMap.end())
Chris Bieneman5d232242015-01-13 19:14:20 +0000433 return nullptr;
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000434
Chris Bieneman5d232242015-01-13 19:14:20 +0000435 Value = Arg.substr(EqualPos + 1);
Chris Lattnere7c1e212009-09-20 05:03:30 +0000436 Arg = Arg.substr(0, EqualPos);
437 return I->second;
Chris Lattner36a57d32001-07-23 17:17:47 +0000438}
439
Mehdi Aminie11b7452016-10-01 03:43:20 +0000440SubCommand *CommandLineParser::LookupSubCommand(StringRef Name) {
441 if (Name.empty())
Zachary Turner07670b32016-06-29 21:48:26 +0000442 return &*TopLevelSubCommand;
443 for (auto S : RegisteredSubCommands) {
444 if (S == &*AllSubCommands)
445 continue;
Mehdi Aminie11b7452016-10-01 03:43:20 +0000446 if (S->getName().empty())
Zachary Turner07670b32016-06-29 21:48:26 +0000447 continue;
448
449 if (StringRef(S->getName()) == StringRef(Name))
450 return S;
451 }
452 return &*TopLevelSubCommand;
453}
454
Daniel Dunbarf4132132011-01-18 01:59:24 +0000455/// LookupNearestOption - Lookup the closest match to the option specified by
456/// the specified option on the command line. If there is a value specified
457/// (after an equal sign) return that as well. This assumes that leading dashes
458/// have already been stripped.
459static Option *LookupNearestOption(StringRef Arg,
Chris Bieneman5d232242015-01-13 19:14:20 +0000460 const StringMap<Option *> &OptionsMap,
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000461 std::string &NearestString) {
Daniel Dunbarf4132132011-01-18 01:59:24 +0000462 // Reject all dashes.
Chris Bieneman5d232242015-01-13 19:14:20 +0000463 if (Arg.empty())
464 return nullptr;
Daniel Dunbarf4132132011-01-18 01:59:24 +0000465
466 // Split on any equal sign.
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000467 std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
Chris Bieneman5d232242015-01-13 19:14:20 +0000468 StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000469 StringRef &RHS = SplitArg.second;
Daniel Dunbarf4132132011-01-18 01:59:24 +0000470
471 // Find the closest match.
Craig Topperc10719f2014-04-07 04:17:22 +0000472 Option *Best = nullptr;
Daniel Dunbarf4132132011-01-18 01:59:24 +0000473 unsigned BestDistance = 0;
Chris Bieneman5d232242015-01-13 19:14:20 +0000474 for (StringMap<Option *>::const_iterator it = OptionsMap.begin(),
475 ie = OptionsMap.end();
476 it != ie; ++it) {
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000477 Option *O = it->second;
David Blaikieff43d692015-11-17 19:00:52 +0000478 SmallVector<StringRef, 16> OptionNames;
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000479 O->getExtraOptionNames(OptionNames);
David Blaikieff43d692015-11-17 19:00:52 +0000480 if (O->hasArgStr())
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000481 OptionNames.push_back(O->ArgStr);
482
Nick Lewyckye75ffa12011-05-02 05:24:47 +0000483 bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
484 StringRef Flag = PermitValue ? LHS : Arg;
David Blaikieff43d692015-11-17 19:00:52 +0000485 for (auto Name : OptionNames) {
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000486 unsigned Distance = StringRef(Name).edit_distance(
Chris Bieneman5d232242015-01-13 19:14:20 +0000487 Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000488 if (!Best || Distance < BestDistance) {
489 Best = O;
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000490 BestDistance = Distance;
Bill Wendling318f03f2012-07-19 00:15:11 +0000491 if (RHS.empty() || !PermitValue)
David Blaikieff43d692015-11-17 19:00:52 +0000492 NearestString = Name;
Bill Wendling318f03f2012-07-19 00:15:11 +0000493 else
David Blaikieff43d692015-11-17 19:00:52 +0000494 NearestString = (Twine(Name) + "=" + RHS).str();
Daniel Dunbar72d523b2011-01-24 17:27:17 +0000495 }
Daniel Dunbarf4132132011-01-18 01:59:24 +0000496 }
497 }
498
499 return Best;
500}
501
Alp Tokercb402912014-01-24 17:20:08 +0000502/// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
503/// that does special handling of cl::CommaSeparated options.
504static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
505 StringRef ArgName, StringRef Value,
506 bool MultiArg = false) {
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000507 // Check to see if this option accepts a comma separated list of values. If
508 // it does, we have to split up the value into multiple values.
509 if (Handler->getMiscFlags() & CommaSeparated) {
510 StringRef Val(Value);
511 StringRef::size_type Pos = Val.find(',');
Chris Lattnere7c1e212009-09-20 05:03:30 +0000512
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000513 while (Pos != StringRef::npos) {
514 // Process the portion before the comma.
515 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
516 return true;
517 // Erase the portion before the comma, AND the comma.
Chris Bieneman5d232242015-01-13 19:14:20 +0000518 Val = Val.substr(Pos + 1);
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000519 // Check for another comma.
520 Pos = Val.find(',');
521 }
522
523 Value = Val;
524 }
525
Alexander Kornienko66da20a2015-12-28 15:46:15 +0000526 return Handler->addOccurrence(pos, ArgName, Value, MultiArg);
Mikhail Glushenkov5551c202009-11-20 17:23:17 +0000527}
Chris Lattnere7c1e212009-09-20 05:03:30 +0000528
Chris Lattner40fef802009-09-20 01:49:31 +0000529/// ProvideOption - For Value, this differentiates between an empty value ("")
530/// and a null value (StringRef()). The later is accepted for arguments that
531/// don't allow a value (-foo) the former is rejected (-foo=).
Chris Lattner3b8adaf2009-09-20 00:40:49 +0000532static inline bool ProvideOption(Option *Handler, StringRef ArgName,
David Blaikie0210e972012-02-07 19:36:01 +0000533 StringRef Value, int argc,
534 const char *const *argv, int &i) {
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000535 // Is this a multi-argument option?
536 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
537
Chris Lattnere81c4092001-10-27 05:54:17 +0000538 // Enforce value requirements
539 switch (Handler->getValueExpectedFlag()) {
540 case ValueRequired:
Craig Topper8d399f82014-04-09 04:20:00 +0000541 if (!Value.data()) { // No value specified?
Chris Bieneman5d232242015-01-13 19:14:20 +0000542 if (i + 1 >= argc)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +0000543 return Handler->error("requires a value!");
Chris Lattnerca2552d2009-09-20 00:07:40 +0000544 // Steal the next argument, like for '-o filename'
Michael Ilseman4e654cd2014-12-11 19:46:38 +0000545 assert(argv && "null check");
Mehdi Aminie11b7452016-10-01 03:43:20 +0000546 Value = StringRef(argv[++i]);
Chris Lattnere81c4092001-10-27 05:54:17 +0000547 }
548 break;
549 case ValueDisallowed:
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000550 if (NumAdditionalVals > 0)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +0000551 return Handler->error("multi-valued option specified"
Chris Lattnerca2552d2009-09-20 00:07:40 +0000552 " with ValueDisallowed modifier!");
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000553
Chris Lattner40fef802009-09-20 01:49:31 +0000554 if (Value.data())
Chris Bieneman5d232242015-01-13 19:14:20 +0000555 return Handler->error("does not allow a value! '" + Twine(Value) +
556 "' specified.");
Chris Lattnere81c4092001-10-27 05:54:17 +0000557 break;
Misha Brukman10468d82005-04-21 22:55:34 +0000558 case ValueOptional:
Reid Spencer9501b9b2004-09-01 04:41:28 +0000559 break;
Chris Lattnere81c4092001-10-27 05:54:17 +0000560 }
561
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000562 // If this isn't a multi-arg option, just run the handler.
Chris Lattneraecd74d2009-09-19 18:55:05 +0000563 if (NumAdditionalVals == 0)
Alp Tokercb402912014-01-24 17:20:08 +0000564 return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
Chris Lattneraecd74d2009-09-19 18:55:05 +0000565
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000566 // If it is, run the handle several times.
Chris Lattneraecd74d2009-09-19 18:55:05 +0000567 bool MultiArg = false;
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000568
Chris Lattner40fef802009-09-20 01:49:31 +0000569 if (Value.data()) {
Alp Tokercb402912014-01-24 17:20:08 +0000570 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
Chris Lattneraecd74d2009-09-19 18:55:05 +0000571 return true;
572 --NumAdditionalVals;
573 MultiArg = true;
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +0000574 }
Chris Lattneraecd74d2009-09-19 18:55:05 +0000575
576 while (NumAdditionalVals > 0) {
Chris Bieneman5d232242015-01-13 19:14:20 +0000577 if (i + 1 >= argc)
Chris Lattneraecd74d2009-09-19 18:55:05 +0000578 return Handler->error("not enough values!");
Michael Ilseman4e654cd2014-12-11 19:46:38 +0000579 assert(argv && "null check");
Mehdi Aminie11b7452016-10-01 03:43:20 +0000580 Value = StringRef(argv[++i]);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000581
Alp Tokercb402912014-01-24 17:20:08 +0000582 if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
Chris Lattneraecd74d2009-09-19 18:55:05 +0000583 return true;
584 MultiArg = true;
585 --NumAdditionalVals;
586 }
587 return false;
Chris Lattnere81c4092001-10-27 05:54:17 +0000588}
589
Chris Lattnerca2552d2009-09-20 00:07:40 +0000590static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
Reid Spencer2027a6f2004-08-13 19:47:30 +0000591 int Dummy = i;
Craig Topperc10719f2014-04-07 04:17:22 +0000592 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
Chris Lattner5df56c42002-07-22 02:07:59 +0000593}
Chris Lattnerf0f91052001-11-26 18:58:34 +0000594
Chris Lattner5df56c42002-07-22 02:07:59 +0000595// Option predicates...
596static inline bool isGrouping(const Option *O) {
597 return O->getFormattingFlag() == cl::Grouping;
598}
599static inline bool isPrefixedOrGrouping(const Option *O) {
600 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
601}
602
603// getOptionPred - Check to see if there are any options that satisfy the
604// specified predicate with names that are the prefixes in Name. This is
605// checked by progressively stripping characters off of the name, checking to
606// see if there options that satisfy the predicate. If we find one, return it,
607// otherwise return null.
608//
Chris Lattner3b8adaf2009-09-20 00:40:49 +0000609static Option *getOptionPred(StringRef Name, size_t &Length,
Chris Bieneman5d232242015-01-13 19:14:20 +0000610 bool (*Pred)(const Option *),
611 const StringMap<Option *> &OptionsMap) {
Misha Brukman10468d82005-04-21 22:55:34 +0000612
Chris Bieneman5d232242015-01-13 19:14:20 +0000613 StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name);
Chris Lattnerf0f91052001-11-26 18:58:34 +0000614
Chris Lattnere7c1e212009-09-20 05:03:30 +0000615 // Loop while we haven't found an option and Name still has at least two
616 // characters in it (so that the next iteration will not be the empty
617 // string.
618 while (OMI == OptionsMap.end() && Name.size() > 1) {
Chris Bieneman5d232242015-01-13 19:14:20 +0000619 Name = Name.substr(0, Name.size() - 1); // Chop off the last character.
Chris Lattner5247f602007-04-06 21:06:55 +0000620 OMI = OptionsMap.find(Name);
Chris Lattnere7c1e212009-09-20 05:03:30 +0000621 }
Chris Lattner5df56c42002-07-22 02:07:59 +0000622
Chris Lattner5247f602007-04-06 21:06:55 +0000623 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
Chris Lattner3b8adaf2009-09-20 00:40:49 +0000624 Length = Name.size();
Chris Bieneman5d232242015-01-13 19:14:20 +0000625 return OMI->second; // Found one!
Chris Lattner5df56c42002-07-22 02:07:59 +0000626 }
Chris Bieneman5d232242015-01-13 19:14:20 +0000627 return nullptr; // No option found!
Chris Lattner5df56c42002-07-22 02:07:59 +0000628}
629
Chris Lattnere7c1e212009-09-20 05:03:30 +0000630/// HandlePrefixedOrGroupedOption - The specified argument string (which started
631/// with at least one '-') does not fully match an available option. Check to
632/// see if this is a prefix or grouped option. If so, split arg into output an
633/// Arg/Value pair and return the Option to parse it with.
Chris Bieneman5d232242015-01-13 19:14:20 +0000634static Option *
635HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
636 bool &ErrorParsing,
637 const StringMap<Option *> &OptionsMap) {
638 if (Arg.size() == 1)
639 return nullptr;
Chris Lattnere7c1e212009-09-20 05:03:30 +0000640
641 // Do the lookup!
642 size_t Length = 0;
643 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
Chris Bieneman5d232242015-01-13 19:14:20 +0000644 if (!PGOpt)
645 return nullptr;
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000646
Chris Lattnere7c1e212009-09-20 05:03:30 +0000647 // If the option is a prefixed option, then the value is simply the
648 // rest of the name... so fall through to later processing, by
649 // setting up the argument name flags and value fields.
650 if (PGOpt->getFormattingFlag() == cl::Prefix) {
651 Value = Arg.substr(Length);
652 Arg = Arg.substr(0, Length);
653 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
654 return PGOpt;
655 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000656
Chris Lattnere7c1e212009-09-20 05:03:30 +0000657 // This must be a grouped option... handle them now. Grouping options can't
658 // have values.
659 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000660
Chris Lattnere7c1e212009-09-20 05:03:30 +0000661 do {
662 // Move current arg name out of Arg into OneArgName.
663 StringRef OneArgName = Arg.substr(0, Length);
664 Arg = Arg.substr(Length);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000665
Chris Lattnere7c1e212009-09-20 05:03:30 +0000666 // Because ValueRequired is an invalid flag for grouped arguments,
667 // we don't need to pass argc/argv in.
668 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
669 "Option can not be cl::Grouping AND cl::ValueRequired!");
Duncan Sandsa2305522010-01-09 08:30:33 +0000670 int Dummy = 0;
Chris Bieneman5d232242015-01-13 19:14:20 +0000671 ErrorParsing |=
672 ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000673
Chris Lattnere7c1e212009-09-20 05:03:30 +0000674 // Get the next grouping option.
675 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
676 } while (PGOpt && Length != Arg.size());
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000677
Chris Lattnere7c1e212009-09-20 05:03:30 +0000678 // Return the last option with Arg cut down to just the last one.
679 return PGOpt;
680}
681
Chris Lattner5df56c42002-07-22 02:07:59 +0000682static bool RequiresValue(const Option *O) {
Misha Brukman069e6b52003-07-10 16:49:51 +0000683 return O->getNumOccurrencesFlag() == cl::Required ||
684 O->getNumOccurrencesFlag() == cl::OneOrMore;
Chris Lattner5df56c42002-07-22 02:07:59 +0000685}
686
687static bool EatsUnboundedNumberOfValues(const Option *O) {
Misha Brukman069e6b52003-07-10 16:49:51 +0000688 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
689 O->getNumOccurrencesFlag() == cl::OneOrMore;
Chris Lattnerf0f91052001-11-26 18:58:34 +0000690}
Chris Lattnere81c4092001-10-27 05:54:17 +0000691
Chris Bieneman5d232242015-01-13 19:14:20 +0000692static bool isWhitespace(char C) { return strchr(" \t\n\r\f\v", C); }
Brian Gaeke497216d2003-08-15 21:05:57 +0000693
Chris Bieneman5d232242015-01-13 19:14:20 +0000694static bool isQuote(char C) { return C == '\"' || C == '\''; }
Reid Klecknera73c7782013-07-18 16:52:05 +0000695
Reid Klecknera73c7782013-07-18 16:52:05 +0000696void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000697 SmallVectorImpl<const char *> &NewArgv,
698 bool MarkEOLs) {
Reid Klecknera73c7782013-07-18 16:52:05 +0000699 SmallString<128> Token;
700 for (size_t I = 0, E = Src.size(); I != E; ++I) {
701 // Consume runs of whitespace.
702 if (Token.empty()) {
Reid Klecknere3f146d2014-08-22 19:29:17 +0000703 while (I != E && isWhitespace(Src[I])) {
704 // Mark the end of lines in response files
705 if (MarkEOLs && Src[I] == '\n')
706 NewArgv.push_back(nullptr);
Reid Klecknera73c7782013-07-18 16:52:05 +0000707 ++I;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000708 }
Chris Bieneman5d232242015-01-13 19:14:20 +0000709 if (I == E)
710 break;
Reid Klecknera73c7782013-07-18 16:52:05 +0000711 }
712
Nico Weberfa7f4892016-04-26 13:53:56 +0000713 // Backslash escapes the next character.
714 if (I + 1 < E && Src[I] == '\\') {
Chris Bieneman5d232242015-01-13 19:14:20 +0000715 ++I; // Skip the escape.
Reid Klecknera73c7782013-07-18 16:52:05 +0000716 Token.push_back(Src[I]);
Chris Lattner4e37f872009-09-24 05:38:36 +0000717 continue;
Brian Gaeke497216d2003-08-15 21:05:57 +0000718 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000719
Reid Klecknera73c7782013-07-18 16:52:05 +0000720 // Consume a quoted string.
721 if (isQuote(Src[I])) {
722 char Quote = Src[I++];
723 while (I != E && Src[I] != Quote) {
Nico Weberfa7f4892016-04-26 13:53:56 +0000724 // Backslash escapes the next character.
725 if (Src[I] == '\\' && I + 1 != E)
Reid Klecknera73c7782013-07-18 16:52:05 +0000726 ++I;
727 Token.push_back(Src[I]);
728 ++I;
729 }
Chris Bieneman5d232242015-01-13 19:14:20 +0000730 if (I == E)
731 break;
Reid Klecknera73c7782013-07-18 16:52:05 +0000732 continue;
733 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000734
Reid Klecknera73c7782013-07-18 16:52:05 +0000735 // End the token if this is whitespace.
736 if (isWhitespace(Src[I])) {
737 if (!Token.empty())
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000738 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Reid Klecknera73c7782013-07-18 16:52:05 +0000739 Token.clear();
740 continue;
741 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +0000742
Reid Klecknera73c7782013-07-18 16:52:05 +0000743 // This is a normal character. Append it.
744 Token.push_back(Src[I]);
Brian Gaeke497216d2003-08-15 21:05:57 +0000745 }
Reid Klecknera73c7782013-07-18 16:52:05 +0000746
747 // Append the last token after hitting EOF with no whitespace.
748 if (!Token.empty())
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000749 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Reid Klecknere3f146d2014-08-22 19:29:17 +0000750 // Mark the end of response files
751 if (MarkEOLs)
752 NewArgv.push_back(nullptr);
Reid Klecknera73c7782013-07-18 16:52:05 +0000753}
754
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000755/// Backslashes are interpreted in a rather complicated way in the Windows-style
756/// command line, because backslashes are used both to separate path and to
757/// escape double quote. This method consumes runs of backslashes as well as the
758/// following double quote if it's escaped.
759///
760/// * If an even number of backslashes is followed by a double quote, one
761/// backslash is output for every pair of backslashes, and the last double
762/// quote remains unconsumed. The double quote will later be interpreted as
763/// the start or end of a quoted string in the main loop outside of this
764/// function.
765///
766/// * If an odd number of backslashes is followed by a double quote, one
767/// backslash is output for every pair of backslashes, and a double quote is
768/// output for the last pair of backslash-double quote. The double quote is
769/// consumed in this case.
770///
771/// * Otherwise, backslashes are interpreted literally.
772static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
773 size_t E = Src.size();
774 int BackslashCount = 0;
775 // Skip the backslashes.
776 do {
777 ++I;
778 ++BackslashCount;
779 } while (I != E && Src[I] == '\\');
780
781 bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
782 if (FollowedByDoubleQuote) {
783 Token.append(BackslashCount / 2, '\\');
784 if (BackslashCount % 2 == 0)
785 return I - 1;
786 Token.push_back('"');
787 return I;
788 }
789 Token.append(BackslashCount, '\\');
790 return I - 1;
791}
792
Reid Klecknera73c7782013-07-18 16:52:05 +0000793void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000794 SmallVectorImpl<const char *> &NewArgv,
795 bool MarkEOLs) {
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000796 SmallString<128> Token;
797
798 // This is a small state machine to consume characters until it reaches the
799 // end of the source string.
800 enum { INIT, UNQUOTED, QUOTED } State = INIT;
801 for (size_t I = 0, E = Src.size(); I != E; ++I) {
802 // INIT state indicates that the current input index is at the start of
803 // the string or between tokens.
804 if (State == INIT) {
Reid Klecknere3f146d2014-08-22 19:29:17 +0000805 if (isWhitespace(Src[I])) {
806 // Mark the end of lines in response files
807 if (MarkEOLs && Src[I] == '\n')
808 NewArgv.push_back(nullptr);
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000809 continue;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000810 }
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000811 if (Src[I] == '"') {
812 State = QUOTED;
813 continue;
814 }
815 if (Src[I] == '\\') {
816 I = parseBackslash(Src, I, Token);
817 State = UNQUOTED;
818 continue;
819 }
820 Token.push_back(Src[I]);
821 State = UNQUOTED;
822 continue;
823 }
824
825 // UNQUOTED state means that it's reading a token not quoted by double
826 // quotes.
827 if (State == UNQUOTED) {
828 // Whitespace means the end of the token.
829 if (isWhitespace(Src[I])) {
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000830 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000831 Token.clear();
832 State = INIT;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000833 // Mark the end of lines in response files
834 if (MarkEOLs && Src[I] == '\n')
835 NewArgv.push_back(nullptr);
Rui Ueyamaa2222b52013-07-30 19:03:20 +0000836 continue;
837 }
838 if (Src[I] == '"') {
839 State = QUOTED;
840 continue;
841 }
842 if (Src[I] == '\\') {
843 I = parseBackslash(Src, I, Token);
844 continue;
845 }
846 Token.push_back(Src[I]);
847 continue;
848 }
849
850 // QUOTED state means that it's reading a token quoted by double quotes.
851 if (State == QUOTED) {
852 if (Src[I] == '"') {
853 State = UNQUOTED;
854 continue;
855 }
856 if (Src[I] == '\\') {
857 I = parseBackslash(Src, I, Token);
858 continue;
859 }
860 Token.push_back(Src[I]);
861 }
862 }
863 // Append the last token after hitting EOF with no whitespace.
864 if (!Token.empty())
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000865 NewArgv.push_back(Saver.save(StringRef(Token)).data());
Reid Klecknere3f146d2014-08-22 19:29:17 +0000866 // Mark the end of response files
867 if (MarkEOLs)
868 NewArgv.push_back(nullptr);
Reid Klecknera73c7782013-07-18 16:52:05 +0000869}
870
Yunzhong Gaoa8cf4952015-01-24 04:23:08 +0000871// It is called byte order marker but the UTF-8 BOM is actually not affected
872// by the host system's endianness.
873static bool hasUTF8ByteOrderMark(ArrayRef<char> S) {
Chris Bienemanceaf5f62015-02-13 22:54:29 +0000874 return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
Yunzhong Gaoa8cf4952015-01-24 04:23:08 +0000875}
876
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000877static bool ExpandResponseFile(StringRef FName, StringSaver &Saver,
Reid Klecknera73c7782013-07-18 16:52:05 +0000878 TokenizerCallback Tokenizer,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000879 SmallVectorImpl<const char *> &NewArgv,
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000880 bool MarkEOLs, bool RelativeNames) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +0000881 ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
882 MemoryBuffer::getFile(FName);
883 if (!MemBufOrErr)
Reid Klecknera73c7782013-07-18 16:52:05 +0000884 return false;
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000885 MemoryBuffer &MemBuf = *MemBufOrErr.get();
886 StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
Reid Klecknera73c7782013-07-18 16:52:05 +0000887
888 // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000889 ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
Reid Klecknera73c7782013-07-18 16:52:05 +0000890 std::string UTF8Buf;
891 if (hasUTF16ByteOrderMark(BufRef)) {
892 if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
893 return false;
894 Str = StringRef(UTF8Buf);
895 }
Yunzhong Gaoa8cf4952015-01-24 04:23:08 +0000896 // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
897 // these bytes before parsing.
898 // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
899 else if (hasUTF8ByteOrderMark(BufRef))
900 Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
Reid Klecknera73c7782013-07-18 16:52:05 +0000901
902 // Tokenize the contents into NewArgv.
Reid Klecknere3f146d2014-08-22 19:29:17 +0000903 Tokenizer(Str, Saver, NewArgv, MarkEOLs);
Reid Klecknera73c7782013-07-18 16:52:05 +0000904
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000905 // If names of nested response files should be resolved relative to including
906 // file, replace the included response file names with their full paths
907 // obtained by required resolution.
908 if (RelativeNames)
909 for (unsigned I = 0; I < NewArgv.size(); ++I)
910 if (NewArgv[I]) {
911 StringRef Arg = NewArgv[I];
912 if (Arg.front() == '@') {
913 StringRef FileName = Arg.drop_front();
914 if (llvm::sys::path::is_relative(FileName)) {
915 SmallString<128> ResponseFile;
916 ResponseFile.append(1, '@');
Serge Pavlovf258ff12016-11-20 06:25:07 +0000917 if (llvm::sys::path::is_relative(FName)) {
918 SmallString<128> curr_dir;
919 llvm::sys::fs::current_path(curr_dir);
920 ResponseFile.append(curr_dir.str());
921 }
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000922 llvm::sys::path::append(
923 ResponseFile, llvm::sys::path::parent_path(FName), FileName);
924 NewArgv[I] = Saver.save(ResponseFile.c_str()).data();
925 }
926 }
927 }
928
Reid Klecknera73c7782013-07-18 16:52:05 +0000929 return true;
930}
931
932/// \brief Expand response files on a command line recursively using the given
933/// StringSaver and tokenization strategy.
934bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
Reid Klecknere3f146d2014-08-22 19:29:17 +0000935 SmallVectorImpl<const char *> &Argv,
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000936 bool MarkEOLs, bool RelativeNames) {
Reid Klecknera73c7782013-07-18 16:52:05 +0000937 unsigned RspFiles = 0;
Reid Kleckner7c5fdaf2013-12-03 19:13:18 +0000938 bool AllExpanded = true;
Reid Klecknera73c7782013-07-18 16:52:05 +0000939
940 // Don't cache Argv.size() because it can change.
Chris Bieneman5d232242015-01-13 19:14:20 +0000941 for (unsigned I = 0; I != Argv.size();) {
Reid Klecknera73c7782013-07-18 16:52:05 +0000942 const char *Arg = Argv[I];
Reid Klecknere3f146d2014-08-22 19:29:17 +0000943 // Check if it is an EOL marker
944 if (Arg == nullptr) {
945 ++I;
946 continue;
947 }
Reid Klecknera73c7782013-07-18 16:52:05 +0000948 if (Arg[0] != '@') {
949 ++I;
950 continue;
951 }
952
953 // If we have too many response files, leave some unexpanded. This avoids
954 // crashing on self-referential response files.
955 if (RspFiles++ > 20)
956 return false;
957
958 // Replace this response file argument with the tokenization of its
959 // contents. Nested response files are expanded in subsequent iterations.
Reid Klecknera73c7782013-07-18 16:52:05 +0000960 SmallVector<const char *, 0> ExpandedArgv;
Reid Klecknere3f146d2014-08-22 19:29:17 +0000961 if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
Serge Pavlov6ac8e032016-11-01 06:53:29 +0000962 MarkEOLs, RelativeNames)) {
Justin Bogner67ae9912013-12-06 22:56:19 +0000963 // We couldn't read this file, so we leave it in the argument stream and
964 // move on.
Reid Klecknera73c7782013-07-18 16:52:05 +0000965 AllExpanded = false;
Justin Bogner67ae9912013-12-06 22:56:19 +0000966 ++I;
Reid Klecknera73c7782013-07-18 16:52:05 +0000967 continue;
968 }
969 Argv.erase(Argv.begin() + I);
970 Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
971 }
972 return AllExpanded;
973}
974
Brian Gaekeca782d92003-08-14 22:00:59 +0000975/// ParseEnvironmentOptions - An alternative entry point to the
976/// CommandLine library, which allows you to read the program's name
977/// from the caller (as PROGNAME) and its command-line arguments from
978/// an environment variable (whose name is given in ENVVAR).
979///
Chris Lattnera60f3552004-05-06 22:04:31 +0000980void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
Rafael Espindolabe5613c2012-10-09 19:52:10 +0000981 const char *Overview) {
Brian Gaeke497216d2003-08-15 21:05:57 +0000982 // Check args.
Chris Lattnera60f3552004-05-06 22:04:31 +0000983 assert(progName && "Program name not specified");
984 assert(envVar && "Environment variable name missing");
Misha Brukman10468d82005-04-21 22:55:34 +0000985
Brian Gaeke497216d2003-08-15 21:05:57 +0000986 // Get the environment variable they want us to parse options out of.
Mehdi Aminie11b7452016-10-01 03:43:20 +0000987 llvm::Optional<std::string> envValue = sys::Process::GetEnv(StringRef(envVar));
Brian Gaeke497216d2003-08-15 21:05:57 +0000988 if (!envValue)
989 return;
990
Brian Gaekeca782d92003-08-14 22:00:59 +0000991 // Get program's "name", which we wouldn't know without the caller
992 // telling us.
Reid Klecknera73c7782013-07-18 16:52:05 +0000993 SmallVector<const char *, 20> newArgv;
Rafael Espindola454adf62015-06-13 12:49:52 +0000994 BumpPtrAllocator A;
Rafael Espindolab82455d2015-08-13 01:07:02 +0000995 StringSaver Saver(A);
Mehdi Aminiec4fb5b2016-10-05 01:32:41 +0000996 newArgv.push_back(Saver.save(progName).data());
Brian Gaekeca782d92003-08-14 22:00:59 +0000997
998 // Parse the value of the environment variable into a "command line"
999 // and hand it off to ParseCommandLineOptions().
David Majnemerafb38af2016-07-24 17:19:59 +00001000 TokenizeGNUCommandLine(*envValue, Saver, newArgv);
Evan Cheng86cb3182008-05-05 18:30:58 +00001001 int newArgc = static_cast<int>(newArgv.size());
Mehdi Aminie11b7452016-10-01 03:43:20 +00001002 ParseCommandLineOptions(newArgc, &newArgv[0], StringRef(Overview));
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001003}
1004
Zachary Turner07670b32016-06-29 21:48:26 +00001005bool cl::ParseCommandLineOptions(int argc, const char *const *argv,
Eric Liue51ee062017-03-15 08:41:00 +00001006 StringRef Overview, raw_ostream *Errs) {
Zachary Turner07670b32016-06-29 21:48:26 +00001007 return GlobalParser->ParseCommandLineOptions(argc, argv, Overview,
Eric Liue51ee062017-03-15 08:41:00 +00001008 Errs);
Chris Bienemand1d94302015-01-28 19:00:25 +00001009}
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001010
Zachary Turner07670b32016-06-29 21:48:26 +00001011void CommandLineParser::ResetAllOptionOccurrences() {
1012 // So that we can parse different command lines multiple times in succession
1013 // we reset all option values to look like they have never been seen before.
1014 for (auto SC : RegisteredSubCommands) {
1015 for (auto &O : SC->OptionsMap)
1016 O.second->reset();
1017 }
1018}
1019
1020bool CommandLineParser::ParseCommandLineOptions(int argc,
Chris Bienemand1d94302015-01-28 19:00:25 +00001021 const char *const *argv,
Mehdi Aminie11b7452016-10-01 03:43:20 +00001022 StringRef Overview,
Eric Liue51ee062017-03-15 08:41:00 +00001023 raw_ostream *Errs) {
Chris Bienemand1d94302015-01-28 19:00:25 +00001024 assert(hasOptions() && "No options specified!");
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001025
1026 // Expand response files.
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001027 SmallVector<const char *, 20> newArgv(argv, argv + argc);
Rafael Espindola454adf62015-06-13 12:49:52 +00001028 BumpPtrAllocator A;
Rafael Espindolab82455d2015-08-13 01:07:02 +00001029 StringSaver Saver(A);
Reid Klecknera73c7782013-07-18 16:52:05 +00001030 ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
Rafael Espindolabe5613c2012-10-09 19:52:10 +00001031 argv = &newArgv[0];
1032 argc = static_cast<int>(newArgv.size());
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001033
Chris Lattner5af1cbc2006-10-13 00:06:24 +00001034 // Copy the program name into ProgName, making sure not to overflow it.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001035 ProgramName = sys::path::filename(StringRef(argv[0]));
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001036
Chris Lattner36a57d32001-07-23 17:17:47 +00001037 ProgramOverview = Overview;
Eric Liue51ee062017-03-15 08:41:00 +00001038 bool IgnoreErrors = Errs;
1039 if (!Errs)
1040 Errs = &errs();
Chris Lattner36a57d32001-07-23 17:17:47 +00001041 bool ErrorParsing = false;
1042
Chris Lattner5df56c42002-07-22 02:07:59 +00001043 // Check out the positional arguments to collect information about them.
1044 unsigned NumPositionalRequired = 0;
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001045
Chris Lattnerd380d842005-08-08 17:25:38 +00001046 // Determine whether or not there are an unlimited number of positionals
1047 bool HasUnlimitedPositionals = false;
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001048
Zachary Turner07670b32016-06-29 21:48:26 +00001049 int FirstArg = 1;
1050 SubCommand *ChosenSubCommand = &*TopLevelSubCommand;
1051 if (argc >= 2 && argv[FirstArg][0] != '-') {
1052 // If the first argument specifies a valid subcommand, start processing
1053 // options from the second argument.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001054 ChosenSubCommand = LookupSubCommand(StringRef(argv[FirstArg]));
Zachary Turner07670b32016-06-29 21:48:26 +00001055 if (ChosenSubCommand != &*TopLevelSubCommand)
1056 FirstArg = 2;
1057 }
1058 GlobalParser->ActiveSubCommand = ChosenSubCommand;
1059
1060 assert(ChosenSubCommand);
1061 auto &ConsumeAfterOpt = ChosenSubCommand->ConsumeAfterOpt;
1062 auto &PositionalOpts = ChosenSubCommand->PositionalOpts;
1063 auto &SinkOpts = ChosenSubCommand->SinkOpts;
1064 auto &OptionsMap = ChosenSubCommand->OptionsMap;
1065
Chris Bienemand1d94302015-01-28 19:00:25 +00001066 if (ConsumeAfterOpt) {
1067 assert(PositionalOpts.size() > 0 &&
1068 "Cannot specify cl::ConsumeAfter without a positional argument!");
1069 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001070 if (!PositionalOpts.empty()) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001071
1072 // Calculate how many positional values are _required_.
1073 bool UnboundedFound = false;
Chris Bienemand1d94302015-01-28 19:00:25 +00001074 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001075 Option *Opt = PositionalOpts[i];
1076 if (RequiresValue(Opt))
1077 ++NumPositionalRequired;
1078 else if (ConsumeAfterOpt) {
1079 // ConsumeAfter cannot be combined with "optional" positional options
Chris Lattnerd49ea882002-07-22 02:21:57 +00001080 // unless there is only one positional argument...
Zachary Turner07670b32016-06-29 21:48:26 +00001081 if (PositionalOpts.size() > 1) {
1082 if (!IgnoreErrors)
1083 Opt->error("error - this positional option will never be matched, "
1084 "because it does not Require a value, and a "
1085 "cl::ConsumeAfter option is active!");
1086 ErrorParsing = true;
1087 }
David Blaikieff43d692015-11-17 19:00:52 +00001088 } else if (UnboundedFound && !Opt->hasArgStr()) {
Chris Lattner2da046f2003-07-30 17:34:02 +00001089 // This option does not "require" a value... Make sure this option is
1090 // not specified after an option that eats all extra arguments, or this
1091 // one will never get any!
Chris Lattner5df56c42002-07-22 02:07:59 +00001092 //
Eric Liue51ee062017-03-15 08:41:00 +00001093 if (!IgnoreErrors)
Zachary Turner07670b32016-06-29 21:48:26 +00001094 Opt->error("error - option can never match, because "
1095 "another positional argument will match an "
1096 "unbounded number of values, and this option"
1097 " does not require a value!");
Eric Liue51ee062017-03-15 08:41:00 +00001098 *Errs << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr
1099 << "' is all messed up!\n";
1100 *Errs << PositionalOpts.size();
Zachary Turner07670b32016-06-29 21:48:26 +00001101 ErrorParsing = true;
Chris Lattner5df56c42002-07-22 02:07:59 +00001102 }
1103 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
1104 }
Chris Lattnerd09a9a72005-08-08 21:57:27 +00001105 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
Chris Lattner5df56c42002-07-22 02:07:59 +00001106 }
1107
Reid Spencer2027a6f2004-08-13 19:47:30 +00001108 // PositionalVals - A vector of "positional" arguments we accumulate into
Chris Lattnerca2552d2009-09-20 00:07:40 +00001109 // the process at the end.
Chris Lattner5df56c42002-07-22 02:07:59 +00001110 //
Chris Bieneman5d232242015-01-13 19:14:20 +00001111 SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
Chris Lattner5df56c42002-07-22 02:07:59 +00001112
Chris Lattner2da046f2003-07-30 17:34:02 +00001113 // If the program has named positional arguments, and the name has been run
1114 // across, keep track of which positional argument was named. Otherwise put
1115 // the positional args into the PositionalVals list...
Craig Topperc10719f2014-04-07 04:17:22 +00001116 Option *ActivePositionalArg = nullptr;
Chris Lattner2da046f2003-07-30 17:34:02 +00001117
Chris Lattner36a57d32001-07-23 17:17:47 +00001118 // Loop over all of the arguments... processing them.
Chris Bieneman5d232242015-01-13 19:14:20 +00001119 bool DashDashFound = false; // Have we read '--'?
Zachary Turner07670b32016-06-29 21:48:26 +00001120 for (int i = FirstArg; i < argc; ++i) {
Craig Topperc10719f2014-04-07 04:17:22 +00001121 Option *Handler = nullptr;
1122 Option *NearestHandler = nullptr;
Nick Lewyckye75ffa12011-05-02 05:24:47 +00001123 std::string NearestHandlerString;
Chris Lattner0a40a972009-09-20 01:53:12 +00001124 StringRef Value;
Chris Lattner5a3fa4e2009-09-20 02:02:24 +00001125 StringRef ArgName = "";
Chris Lattner5df56c42002-07-22 02:07:59 +00001126
1127 // Check to see if this is a positional argument. This argument is
1128 // considered to be positional if it doesn't start with '-', if it is "-"
Misha Brukman5258e592003-07-10 21:38:28 +00001129 // itself, or if we have seen "--" already.
Chris Lattner5df56c42002-07-22 02:07:59 +00001130 //
1131 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
1132 // Positional argument!
Chris Lattner2da046f2003-07-30 17:34:02 +00001133 if (ActivePositionalArg) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001134 ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
Chris Bieneman5d232242015-01-13 19:14:20 +00001135 continue; // We are done!
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001136 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001137
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001138 if (!PositionalOpts.empty()) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001139 PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
Chris Lattner5df56c42002-07-22 02:07:59 +00001140
1141 // All of the positional arguments have been fulfulled, give the rest to
1142 // the consume after option... if it's specified...
1143 //
Craig Topper8d399f82014-04-09 04:20:00 +00001144 if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001145 for (++i; i < argc; ++i)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001146 PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i));
Chris Bieneman5d232242015-01-13 19:14:20 +00001147 break; // Handle outside of the argument processing loop...
Chris Lattner5df56c42002-07-22 02:07:59 +00001148 }
1149
1150 // Delay processing positional arguments until the end...
1151 continue;
1152 }
Chris Lattnera60f3552004-05-06 22:04:31 +00001153 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
1154 !DashDashFound) {
Chris Bieneman5d232242015-01-13 19:14:20 +00001155 DashDashFound = true; // This is the mythical "--"?
1156 continue; // Don't try to process it as an argument itself.
Chris Lattnera60f3552004-05-06 22:04:31 +00001157 } else if (ActivePositionalArg &&
1158 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
1159 // If there is a positional argument eating options, check to see if this
1160 // option is another positional argument. If so, treat it as an argument,
1161 // otherwise feed it to the eating positional.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001162 ArgName = StringRef(argv[i] + 1);
Chris Lattnere7c1e212009-09-20 05:03:30 +00001163 // Eat leading dashes.
1164 while (!ArgName.empty() && ArgName[0] == '-')
1165 ArgName = ArgName.substr(1);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001166
Zachary Turner07670b32016-06-29 21:48:26 +00001167 Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
Chris Lattnera60f3552004-05-06 22:04:31 +00001168 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001169 ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i);
Chris Bieneman5d232242015-01-13 19:14:20 +00001170 continue; // We are done!
Chris Lattner5df56c42002-07-22 02:07:59 +00001171 }
1172
Chris Bieneman5d232242015-01-13 19:14:20 +00001173 } else { // We start with a '-', must be an argument.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001174 ArgName = StringRef(argv[i] + 1);
Chris Lattnere7c1e212009-09-20 05:03:30 +00001175 // Eat leading dashes.
1176 while (!ArgName.empty() && ArgName[0] == '-')
1177 ArgName = ArgName.substr(1);
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001178
Zachary Turner07670b32016-06-29 21:48:26 +00001179 Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
Chris Lattner36a57d32001-07-23 17:17:47 +00001180
Chris Lattnera60f3552004-05-06 22:04:31 +00001181 // Check to see if this "option" is really a prefixed or grouped argument.
Craig Topper8d399f82014-04-09 04:20:00 +00001182 if (!Handler)
Chris Bienemand1d94302015-01-28 19:00:25 +00001183 Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
1184 OptionsMap);
Daniel Dunbarf4132132011-01-18 01:59:24 +00001185
1186 // Otherwise, look for the closest available option to report to the user
1187 // in the upcoming error.
Craig Topper8d399f82014-04-09 04:20:00 +00001188 if (!Handler && SinkOpts.empty())
Chris Bieneman5d232242015-01-13 19:14:20 +00001189 NearestHandler =
Chris Bienemand1d94302015-01-28 19:00:25 +00001190 LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
Chris Lattner36a57d32001-07-23 17:17:47 +00001191 }
1192
Craig Topper8d399f82014-04-09 04:20:00 +00001193 if (!Handler) {
Anton Korobeynikovf275a492008-02-20 12:38:07 +00001194 if (SinkOpts.empty()) {
Eric Liue51ee062017-03-15 08:41:00 +00001195 *Errs << ProgramName << ": Unknown command line argument '" << argv[i]
1196 << "'. Try: '" << argv[0] << " -help'\n";
Daniel Dunbarf4132132011-01-18 01:59:24 +00001197
Eric Liue51ee062017-03-15 08:41:00 +00001198 if (NearestHandler) {
1199 // If we know a near match, report it as well.
1200 *Errs << ProgramName << ": Did you mean '-" << NearestHandlerString
1201 << "'?\n";
Daniel Dunbar72d523b2011-01-24 17:27:17 +00001202 }
Daniel Dunbarf4132132011-01-18 01:59:24 +00001203
Anton Korobeynikovf275a492008-02-20 12:38:07 +00001204 ErrorParsing = true;
1205 } else {
Chris Bieneman5d232242015-01-13 19:14:20 +00001206 for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
1207 E = SinkOpts.end();
1208 I != E; ++I)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001209 (*I)->addOccurrence(i, "", StringRef(argv[i]));
Anton Korobeynikovf275a492008-02-20 12:38:07 +00001210 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001211 continue;
1212 }
1213
Chris Lattner2da046f2003-07-30 17:34:02 +00001214 // If this is a named positional argument, just remember that it is the
1215 // active one...
1216 if (Handler->getFormattingFlag() == cl::Positional)
1217 ActivePositionalArg = Handler;
Chris Lattner40fef802009-09-20 01:49:31 +00001218 else
Chris Lattner0a40a972009-09-20 01:53:12 +00001219 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
Chris Lattner5df56c42002-07-22 02:07:59 +00001220 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001221
Chris Lattner5df56c42002-07-22 02:07:59 +00001222 // Check and handle positional arguments now...
1223 if (NumPositionalRequired > PositionalVals.size()) {
Eric Liue51ee062017-03-15 08:41:00 +00001224 *Errs << ProgramName
Zachary Turner07670b32016-06-29 21:48:26 +00001225 << ": Not enough positional command line arguments specified!\n"
1226 << "Must specify at least " << NumPositionalRequired
Ying Yi60a3da32016-07-22 10:52:21 +00001227 << " positional argument" << (NumPositionalRequired > 1 ? "s" : "")
Don Hintone15fa332017-07-12 01:15:46 +00001228 << ": See: " << argv[0] << " -help\n";
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001229
Chris Lattner5df56c42002-07-22 02:07:59 +00001230 ErrorParsing = true;
Dan Gohmanb452d4e2010-03-24 19:38:02 +00001231 } else if (!HasUnlimitedPositionals &&
1232 PositionalVals.size() > PositionalOpts.size()) {
Eric Liue51ee062017-03-15 08:41:00 +00001233 *Errs << ProgramName << ": Too many positional arguments specified!\n"
1234 << "Can specify at most " << PositionalOpts.size()
1235 << " positional arguments: See: " << argv[0] << " -help\n";
Chris Lattnerd380d842005-08-08 17:25:38 +00001236 ErrorParsing = true;
Chris Lattner5df56c42002-07-22 02:07:59 +00001237
Craig Topper8d399f82014-04-09 04:20:00 +00001238 } else if (!ConsumeAfterOpt) {
Chris Lattnere7c1e212009-09-20 05:03:30 +00001239 // Positional args have already been handled if ConsumeAfter is specified.
Evan Cheng86cb3182008-05-05 18:30:58 +00001240 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1241 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001242 if (RequiresValue(PositionalOpts[i])) {
Misha Brukman10468d82005-04-21 22:55:34 +00001243 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
Reid Spencer2027a6f2004-08-13 19:47:30 +00001244 PositionalVals[ValNo].second);
1245 ValNo++;
Chris Bieneman5d232242015-01-13 19:14:20 +00001246 --NumPositionalRequired; // We fulfilled our duty...
Chris Lattner5df56c42002-07-22 02:07:59 +00001247 }
1248
1249 // If we _can_ give this option more arguments, do so now, as long as we
1250 // do not give it values that others need. 'Done' controls whether the
1251 // option even _WANTS_ any more.
1252 //
Misha Brukman069e6b52003-07-10 16:49:51 +00001253 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
Chris Bieneman5d232242015-01-13 19:14:20 +00001254 while (NumVals - ValNo > NumPositionalRequired && !Done) {
Misha Brukman069e6b52003-07-10 16:49:51 +00001255 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
Chris Lattner5df56c42002-07-22 02:07:59 +00001256 case cl::Optional:
Chris Bieneman5d232242015-01-13 19:14:20 +00001257 Done = true; // Optional arguments want _at most_ one value
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001258 LLVM_FALLTHROUGH;
Chris Bieneman5d232242015-01-13 19:14:20 +00001259 case cl::ZeroOrMore: // Zero or more will take all they can get...
1260 case cl::OneOrMore: // One or more will take all they can get...
Reid Spencer2027a6f2004-08-13 19:47:30 +00001261 ProvidePositionalOption(PositionalOpts[i],
1262 PositionalVals[ValNo].first,
1263 PositionalVals[ValNo].second);
1264 ValNo++;
Chris Lattner5df56c42002-07-22 02:07:59 +00001265 break;
1266 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00001267 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
Chris Bieneman5d232242015-01-13 19:14:20 +00001268 "positional argument processing!");
Chris Lattner5df56c42002-07-22 02:07:59 +00001269 }
1270 }
Chris Lattnere81c4092001-10-27 05:54:17 +00001271 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001272 } else {
1273 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1274 unsigned ValNo = 0;
Evan Cheng86cb3182008-05-05 18:30:58 +00001275 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
Reid Spencer2027a6f2004-08-13 19:47:30 +00001276 if (RequiresValue(PositionalOpts[j])) {
Chris Lattnerca0e79e2002-07-24 20:15:13 +00001277 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
Reid Spencer2027a6f2004-08-13 19:47:30 +00001278 PositionalVals[ValNo].first,
1279 PositionalVals[ValNo].second);
1280 ValNo++;
1281 }
Chris Lattnerca0e79e2002-07-24 20:15:13 +00001282
1283 // Handle the case where there is just one positional option, and it's
1284 // optional. In this case, we want to give JUST THE FIRST option to the
1285 // positional option and keep the rest for the consume after. The above
1286 // loop would have assigned no values to positional options in this case.
1287 //
Chris Bienemand1d94302015-01-28 19:00:25 +00001288 if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1289 ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
Reid Spencer2027a6f2004-08-13 19:47:30 +00001290 PositionalVals[ValNo].first,
1291 PositionalVals[ValNo].second);
1292 ValNo++;
1293 }
Misha Brukman10468d82005-04-21 22:55:34 +00001294
Chris Lattner5df56c42002-07-22 02:07:59 +00001295 // Handle over all of the rest of the arguments to the
1296 // cl::ConsumeAfter command line option...
1297 for (; ValNo != PositionalVals.size(); ++ValNo)
Chris Bieneman5d232242015-01-13 19:14:20 +00001298 ErrorParsing |=
1299 ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1300 PositionalVals[ValNo].second);
Chris Lattner36a57d32001-07-23 17:17:47 +00001301 }
1302
Chris Lattner4fdde2c2001-07-23 23:02:45 +00001303 // Loop over args and make sure all required args are specified!
Chris Bienemand1d94302015-01-28 19:00:25 +00001304 for (const auto &Opt : OptionsMap) {
Justin Bogner973b2ff2014-07-14 19:24:13 +00001305 switch (Opt.second->getNumOccurrencesFlag()) {
Chris Lattner4fdde2c2001-07-23 23:02:45 +00001306 case Required:
1307 case OneOrMore:
Justin Bogner973b2ff2014-07-14 19:24:13 +00001308 if (Opt.second->getNumOccurrences() == 0) {
1309 Opt.second->error("must be specified at least once!");
Chris Lattnerd4617cd2001-10-24 06:21:56 +00001310 ErrorParsing = true;
1311 }
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001312 LLVM_FALLTHROUGH;
Chris Lattner4fdde2c2001-07-23 23:02:45 +00001313 default:
1314 break;
1315 }
1316 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001317
Rafael Espindolacf14a382010-11-19 21:14:29 +00001318 // Now that we know if -debug is specified, we can use it.
1319 // Note that if ReadResponseFiles == true, this must be done before the
1320 // memory allocated for the expanded command line is free()d below.
1321 DEBUG(dbgs() << "Args: ";
Chris Bieneman5d232242015-01-13 19:14:20 +00001322 for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1323 dbgs() << '\n';);
Rafael Espindolacf14a382010-11-19 21:14:29 +00001324
Chris Lattner5df56c42002-07-22 02:07:59 +00001325 // Free all of the memory allocated to the map. Command line options may only
1326 // be processed once!
Chris Bienemand1d94302015-01-28 19:00:25 +00001327 MoreHelp.clear();
Chris Lattner36a57d32001-07-23 17:17:47 +00001328
1329 // If we had an error processing our arguments, don't let the program execute
Zachary Turner07670b32016-06-29 21:48:26 +00001330 if (ErrorParsing) {
1331 if (!IgnoreErrors)
1332 exit(1);
1333 return false;
1334 }
1335 return true;
Chris Lattner36a57d32001-07-23 17:17:47 +00001336}
1337
1338//===----------------------------------------------------------------------===//
1339// Option Base class implementation
1340//
Chris Lattner36a57d32001-07-23 17:17:47 +00001341
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001342bool Option::error(const Twine &Message, StringRef ArgName) {
Chris Bieneman5d232242015-01-13 19:14:20 +00001343 if (!ArgName.data())
1344 ArgName = ArgStr;
Chris Lattner3b8adaf2009-09-20 00:40:49 +00001345 if (ArgName.empty())
Chris Bieneman5d232242015-01-13 19:14:20 +00001346 errs() << HelpStr; // Be nice for positional arguments
Chris Lattner5df56c42002-07-22 02:07:59 +00001347 else
Chris Bienemand1d94302015-01-28 19:00:25 +00001348 errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
Mikhail Glushenkov5653d3b2008-04-28 16:44:25 +00001349
Benjamin Kramerc9aa4802009-08-23 10:01:13 +00001350 errs() << " option: " << Message << "\n";
Chris Lattner36a57d32001-07-23 17:17:47 +00001351 return true;
1352}
1353
Chris Bieneman5d232242015-01-13 19:14:20 +00001354bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1355 bool MultiArg) {
Mikhail Glushenkovcbc26fd2009-01-16 22:54:19 +00001356 if (!MultiArg)
Chris Bieneman5d232242015-01-13 19:14:20 +00001357 NumOccurrences++; // Increment the number of times we have been seen
Chris Lattner36a57d32001-07-23 17:17:47 +00001358
Misha Brukman069e6b52003-07-10 16:49:51 +00001359 switch (getNumOccurrencesFlag()) {
Chris Lattner36a57d32001-07-23 17:17:47 +00001360 case Optional:
Misha Brukman069e6b52003-07-10 16:49:51 +00001361 if (NumOccurrences > 1)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001362 return error("may only occur zero or one times!", ArgName);
Chris Lattner36a57d32001-07-23 17:17:47 +00001363 break;
1364 case Required:
Misha Brukman069e6b52003-07-10 16:49:51 +00001365 if (NumOccurrences > 1)
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001366 return error("must occur exactly one time!", ArgName);
Justin Bognercd1d5aa2016-08-17 20:30:52 +00001367 LLVM_FALLTHROUGH;
Chris Lattner36a57d32001-07-23 17:17:47 +00001368 case OneOrMore:
Chris Lattnere81c4092001-10-27 05:54:17 +00001369 case ZeroOrMore:
Chris Bieneman5d232242015-01-13 19:14:20 +00001370 case ConsumeAfter:
1371 break;
Chris Lattner36a57d32001-07-23 17:17:47 +00001372 }
1373
Reid Spencer2027a6f2004-08-13 19:47:30 +00001374 return handleOccurrence(pos, ArgName, Value);
Chris Lattner36a57d32001-07-23 17:17:47 +00001375}
1376
Chris Lattner5df56c42002-07-22 02:07:59 +00001377// getValueStr - Get the value description string, using "DefaultMsg" if nothing
1378// has been specified yet.
1379//
David Blaikieff43d692015-11-17 19:00:52 +00001380static StringRef getValueStr(const Option &O, StringRef DefaultMsg) {
1381 if (O.ValueStr.empty())
Chris Bieneman5d232242015-01-13 19:14:20 +00001382 return DefaultMsg;
Chris Lattner5df56c42002-07-22 02:07:59 +00001383 return O.ValueStr;
1384}
1385
1386//===----------------------------------------------------------------------===//
1387// cl::alias class implementation
1388//
1389
Chris Lattner36a57d32001-07-23 17:17:47 +00001390// Return the width of the option tag for printing...
David Blaikieff43d692015-11-17 19:00:52 +00001391size_t alias::getOptionWidth() const { return ArgStr.size() + 6; }
Chris Lattner36a57d32001-07-23 17:17:47 +00001392
Daniel Berlin25f1db12017-02-19 04:28:56 +00001393void Option::printHelpStr(StringRef HelpStr, size_t Indent,
1394 size_t FirstLineIndentedBy) {
Alexander Kornienko72a196a2013-05-10 17:15:51 +00001395 std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1396 outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1397 while (!Split.second.empty()) {
1398 Split = Split.second.split('\n');
1399 outs().indent(Indent) << Split.first << "\n";
1400 }
1401}
1402
Chris Lattner1b7a5152006-04-28 05:36:25 +00001403// Print out the option for the alias.
Evan Cheng86cb3182008-05-05 18:30:58 +00001404void alias::printOptionInfo(size_t GlobalWidth) const {
Evan Cheng871b7122011-06-13 20:45:54 +00001405 outs() << " -" << ArgStr;
David Blaikieff43d692015-11-17 19:00:52 +00001406 printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
Chris Lattner36a57d32001-07-23 17:17:47 +00001407}
1408
Chris Lattner36a57d32001-07-23 17:17:47 +00001409//===----------------------------------------------------------------------===//
Chris Lattner5df56c42002-07-22 02:07:59 +00001410// Parser Implementation code...
Chris Lattner36a57d32001-07-23 17:17:47 +00001411//
1412
Chris Lattnerb4101b12002-08-07 18:36:37 +00001413// basic_parser implementation
1414//
1415
1416// Return the width of the option tag for printing...
Evan Cheng86cb3182008-05-05 18:30:58 +00001417size_t basic_parser_impl::getOptionWidth(const Option &O) const {
David Blaikieff43d692015-11-17 19:00:52 +00001418 size_t Len = O.ArgStr.size();
Mehdi Aminie11b7452016-10-01 03:43:20 +00001419 auto ValName = getValueName();
1420 if (!ValName.empty())
David Blaikieff43d692015-11-17 19:00:52 +00001421 Len += getValueStr(O, ValName).size() + 3;
Chris Lattnerb4101b12002-08-07 18:36:37 +00001422
1423 return Len + 6;
1424}
1425
Misha Brukman10468d82005-04-21 22:55:34 +00001426// printOptionInfo - Print out information about this option. The
Chris Lattnerb4101b12002-08-07 18:36:37 +00001427// to-be-maintained width is specified.
1428//
1429void basic_parser_impl::printOptionInfo(const Option &O,
Evan Cheng86cb3182008-05-05 18:30:58 +00001430 size_t GlobalWidth) const {
Chris Lattner471ba482009-08-23 08:43:55 +00001431 outs() << " -" << O.ArgStr;
Chris Lattnerb4101b12002-08-07 18:36:37 +00001432
Mehdi Aminie11b7452016-10-01 03:43:20 +00001433 auto ValName = getValueName();
1434 if (!ValName.empty())
Chris Lattner471ba482009-08-23 08:43:55 +00001435 outs() << "=<" << getValueStr(O, ValName) << '>';
Chris Lattnerb4101b12002-08-07 18:36:37 +00001436
Daniel Berlin25f1db12017-02-19 04:28:56 +00001437 Option::printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
Chris Lattnerb4101b12002-08-07 18:36:37 +00001438}
1439
Andrew Trick12004012011-04-05 18:54:36 +00001440void basic_parser_impl::printOptionName(const Option &O,
1441 size_t GlobalWidth) const {
1442 outs() << " -" << O.ArgStr;
David Blaikieff43d692015-11-17 19:00:52 +00001443 outs().indent(GlobalWidth - O.ArgStr.size());
Andrew Trick12004012011-04-05 18:54:36 +00001444}
Chris Lattnerb4101b12002-08-07 18:36:37 +00001445
Chris Lattner5df56c42002-07-22 02:07:59 +00001446// parser<bool> implementation
1447//
Chris Bieneman5d232242015-01-13 19:14:20 +00001448bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1449 bool &Value) {
Misha Brukman10468d82005-04-21 22:55:34 +00001450 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
Chris Lattner36a57d32001-07-23 17:17:47 +00001451 Arg == "1") {
1452 Value = true;
Chris Lattneraecd74d2009-09-19 18:55:05 +00001453 return false;
Chris Lattner36a57d32001-07-23 17:17:47 +00001454 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001455
Chris Lattneraecd74d2009-09-19 18:55:05 +00001456 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1457 Value = false;
1458 return false;
1459 }
1460 return O.error("'" + Arg +
1461 "' is invalid value for boolean argument! Try 0 or 1");
Chris Lattner36a57d32001-07-23 17:17:47 +00001462}
1463
Dale Johannesen82810c82007-05-22 17:14:46 +00001464// parser<boolOrDefault> implementation
1465//
Chris Bieneman5d232242015-01-13 19:14:20 +00001466bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg,
1467 boolOrDefault &Value) {
Dale Johannesen82810c82007-05-22 17:14:46 +00001468 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1469 Arg == "1") {
1470 Value = BOU_TRUE;
Chris Lattneraecd74d2009-09-19 18:55:05 +00001471 return false;
Dale Johannesen82810c82007-05-22 17:14:46 +00001472 }
Chris Lattneraecd74d2009-09-19 18:55:05 +00001473 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1474 Value = BOU_FALSE;
1475 return false;
1476 }
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00001477
Chris Lattneraecd74d2009-09-19 18:55:05 +00001478 return O.error("'" + Arg +
1479 "' is invalid value for boolean argument! Try 0 or 1");
Dale Johannesen82810c82007-05-22 17:14:46 +00001480}
1481
Chris Lattner5df56c42002-07-22 02:07:59 +00001482// parser<int> implementation
1483//
Chris Bieneman5d232242015-01-13 19:14:20 +00001484bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1485 int &Value) {
Chris Lattnerfa9c6f42009-09-19 23:59:02 +00001486 if (Arg.getAsInteger(0, Value))
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001487 return O.error("'" + Arg + "' value invalid for integer argument!");
Chris Lattner36a57d32001-07-23 17:17:47 +00001488 return false;
1489}
1490
Chris Lattner719c7152003-06-28 15:47:20 +00001491// parser<unsigned> implementation
1492//
Chris Bieneman5d232242015-01-13 19:14:20 +00001493bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1494 unsigned &Value) {
Chris Lattnerfa9c6f42009-09-19 23:59:02 +00001495
1496 if (Arg.getAsInteger(0, Value))
Benjamin Kramer666cf9d2009-08-02 12:13:02 +00001497 return O.error("'" + Arg + "' value invalid for uint argument!");
Chris Lattner719c7152003-06-28 15:47:20 +00001498 return false;
1499}
1500
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +00001501// parser<unsigned long long> implementation
1502//
1503bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
Chris Bieneman5d232242015-01-13 19:14:20 +00001504 StringRef Arg,
1505 unsigned long long &Value) {
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +00001506
1507 if (Arg.getAsInteger(0, Value))
1508 return O.error("'" + Arg + "' value invalid for uint argument!");
1509 return false;
1510}
1511
Chris Lattnerb4101b12002-08-07 18:36:37 +00001512// parser<double>/parser<float> implementation
Chris Lattner675db8d2001-10-13 06:53:19 +00001513//
Chris Lattneraecd74d2009-09-19 18:55:05 +00001514static bool parseDouble(Option &O, StringRef Arg, double &Value) {
Pavel Labathec000f42017-06-23 12:55:02 +00001515 if (to_float(Arg, Value))
1516 return false;
1517 return O.error("'" + Arg + "' value invalid for floating point argument!");
Chris Lattner675db8d2001-10-13 06:53:19 +00001518}
1519
Chris Bieneman5d232242015-01-13 19:14:20 +00001520bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1521 double &Val) {
Chris Lattnerb4101b12002-08-07 18:36:37 +00001522 return parseDouble(O, Arg, Val);
Chris Lattner5df56c42002-07-22 02:07:59 +00001523}
1524
Chris Bieneman5d232242015-01-13 19:14:20 +00001525bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1526 float &Val) {
Chris Lattnerb4101b12002-08-07 18:36:37 +00001527 double dVal;
1528 if (parseDouble(O, Arg, dVal))
1529 return true;
1530 Val = (float)dVal;
1531 return false;
Chris Lattner5df56c42002-07-22 02:07:59 +00001532}
1533
Chris Lattner5df56c42002-07-22 02:07:59 +00001534// generic_parser_base implementation
1535//
1536
Chris Lattner494c0b02002-07-23 17:15:12 +00001537// findOption - Return the option number corresponding to the specified
1538// argument string. If the option is not found, getNumOptions() is returned.
1539//
Mehdi Aminie11b7452016-10-01 03:43:20 +00001540unsigned generic_parser_base::findOption(StringRef Name) {
Benjamin Kramer543d9b22009-09-19 10:01:45 +00001541 unsigned e = getNumOptions();
Chris Lattner494c0b02002-07-23 17:15:12 +00001542
Benjamin Kramer543d9b22009-09-19 10:01:45 +00001543 for (unsigned i = 0; i != e; ++i) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001544 if (getOption(i) == Name)
Chris Lattner494c0b02002-07-23 17:15:12 +00001545 return i;
Benjamin Kramer543d9b22009-09-19 10:01:45 +00001546 }
Chris Lattner494c0b02002-07-23 17:15:12 +00001547 return e;
1548}
1549
Chris Lattner5df56c42002-07-22 02:07:59 +00001550// Return the width of the option tag for printing...
Evan Cheng86cb3182008-05-05 18:30:58 +00001551size_t generic_parser_base::getOptionWidth(const Option &O) const {
Chris Lattner5df56c42002-07-22 02:07:59 +00001552 if (O.hasArgStr()) {
David Blaikieff43d692015-11-17 19:00:52 +00001553 size_t Size = O.ArgStr.size() + 6;
Chris Lattner5df56c42002-07-22 02:07:59 +00001554 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001555 Size = std::max(Size, getOption(i).size() + 8);
Chris Lattner5df56c42002-07-22 02:07:59 +00001556 return Size;
1557 } else {
Evan Cheng86cb3182008-05-05 18:30:58 +00001558 size_t BaseSize = 0;
Chris Lattner5df56c42002-07-22 02:07:59 +00001559 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
Mehdi Aminie11b7452016-10-01 03:43:20 +00001560 BaseSize = std::max(BaseSize, getOption(i).size() + 8);
Chris Lattner5df56c42002-07-22 02:07:59 +00001561 return BaseSize;
Chris Lattner36a57d32001-07-23 17:17:47 +00001562 }
1563}
1564
Misha Brukman10468d82005-04-21 22:55:34 +00001565// printOptionInfo - Print out information about this option. The
Chris Lattner5df56c42002-07-22 02:07:59 +00001566// to-be-maintained width is specified.
1567//
1568void generic_parser_base::printOptionInfo(const Option &O,
Evan Cheng86cb3182008-05-05 18:30:58 +00001569 size_t GlobalWidth) const {
Chris Lattner5df56c42002-07-22 02:07:59 +00001570 if (O.hasArgStr()) {
Chris Lattnere7c1e212009-09-20 05:03:30 +00001571 outs() << " -" << O.ArgStr;
Daniel Berlin25f1db12017-02-19 04:28:56 +00001572 Option::printHelpStr(O.HelpStr, GlobalWidth, O.ArgStr.size() + 6);
Chris Lattner36a57d32001-07-23 17:17:47 +00001573
Chris Lattner5df56c42002-07-22 02:07:59 +00001574 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001575 size_t NumSpaces = GlobalWidth - getOption(i).size() - 8;
Chris Lattnere7c1e212009-09-20 05:03:30 +00001576 outs() << " =" << getOption(i);
1577 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
Chris Lattnerc2ef08c2002-01-31 00:42:56 +00001578 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001579 } else {
David Blaikieff43d692015-11-17 19:00:52 +00001580 if (!O.HelpStr.empty())
Chris Lattnere7c1e212009-09-20 05:03:30 +00001581 outs() << " " << O.HelpStr << '\n';
Chris Lattner5df56c42002-07-22 02:07:59 +00001582 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001583 auto Option = getOption(i);
Alexander Kornienko72a196a2013-05-10 17:15:51 +00001584 outs() << " -" << Option;
Daniel Berlin25f1db12017-02-19 04:28:56 +00001585 Option::printHelpStr(getDescription(i), GlobalWidth, Option.size() + 8);
Chris Lattner5df56c42002-07-22 02:07:59 +00001586 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001587 }
1588}
1589
Andrew Trick12004012011-04-05 18:54:36 +00001590static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1591
1592// printGenericOptionDiff - Print the value of this option and it's default.
1593//
1594// "Generic" options have each value mapped to a name.
Chris Bieneman5d232242015-01-13 19:14:20 +00001595void generic_parser_base::printGenericOptionDiff(
1596 const Option &O, const GenericOptionValue &Value,
1597 const GenericOptionValue &Default, size_t GlobalWidth) const {
Andrew Trick12004012011-04-05 18:54:36 +00001598 outs() << " -" << O.ArgStr;
David Blaikieff43d692015-11-17 19:00:52 +00001599 outs().indent(GlobalWidth - O.ArgStr.size());
Andrew Trick12004012011-04-05 18:54:36 +00001600
1601 unsigned NumOpts = getNumOptions();
1602 for (unsigned i = 0; i != NumOpts; ++i) {
1603 if (Value.compare(getOptionValue(i)))
1604 continue;
1605
1606 outs() << "= " << getOption(i);
Mehdi Aminie11b7452016-10-01 03:43:20 +00001607 size_t L = getOption(i).size();
Andrew Trick12004012011-04-05 18:54:36 +00001608 size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1609 outs().indent(NumSpaces) << " (default: ";
1610 for (unsigned j = 0; j != NumOpts; ++j) {
1611 if (Default.compare(getOptionValue(j)))
1612 continue;
1613 outs() << getOption(j);
1614 break;
1615 }
1616 outs() << ")\n";
1617 return;
1618 }
1619 outs() << "= *unknown option value*\n";
1620}
1621
1622// printOptionDiff - Specializations for printing basic value types.
1623//
Chris Bieneman5d232242015-01-13 19:14:20 +00001624#define PRINT_OPT_DIFF(T) \
1625 void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1626 size_t GlobalWidth) const { \
1627 printOptionName(O, GlobalWidth); \
1628 std::string Str; \
1629 { \
1630 raw_string_ostream SS(Str); \
1631 SS << V; \
1632 } \
1633 outs() << "= " << Str; \
1634 size_t NumSpaces = \
1635 MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
1636 outs().indent(NumSpaces) << " (default: "; \
1637 if (D.hasValue()) \
1638 outs() << D.getValue(); \
1639 else \
1640 outs() << "*no default*"; \
1641 outs() << ")\n"; \
1642 }
Andrew Trick12004012011-04-05 18:54:36 +00001643
Frits van Bommel87e33672011-04-06 12:29:56 +00001644PRINT_OPT_DIFF(bool)
1645PRINT_OPT_DIFF(boolOrDefault)
1646PRINT_OPT_DIFF(int)
1647PRINT_OPT_DIFF(unsigned)
Benjamin Kramer49fc9dd2011-09-15 21:17:37 +00001648PRINT_OPT_DIFF(unsigned long long)
Frits van Bommel87e33672011-04-06 12:29:56 +00001649PRINT_OPT_DIFF(double)
1650PRINT_OPT_DIFF(float)
1651PRINT_OPT_DIFF(char)
Andrew Trick12004012011-04-05 18:54:36 +00001652
Chris Bieneman5d232242015-01-13 19:14:20 +00001653void parser<std::string>::printOptionDiff(const Option &O, StringRef V,
Benjamin Kramerc321e532016-06-08 19:09:22 +00001654 const OptionValue<std::string> &D,
Chris Bieneman5d232242015-01-13 19:14:20 +00001655 size_t GlobalWidth) const {
Andrew Trick12004012011-04-05 18:54:36 +00001656 printOptionName(O, GlobalWidth);
1657 outs() << "= " << V;
1658 size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1659 outs().indent(NumSpaces) << " (default: ";
1660 if (D.hasValue())
1661 outs() << D.getValue();
1662 else
1663 outs() << "*no default*";
1664 outs() << ")\n";
1665}
1666
1667// Print a placeholder for options that don't yet support printOptionDiff().
Chris Bieneman5d232242015-01-13 19:14:20 +00001668void basic_parser_impl::printOptionNoValue(const Option &O,
1669 size_t GlobalWidth) const {
Andrew Trick12004012011-04-05 18:54:36 +00001670 printOptionName(O, GlobalWidth);
1671 outs() << "= *cannot print option value*\n";
1672}
Chris Lattner36a57d32001-07-23 17:17:47 +00001673
1674//===----------------------------------------------------------------------===//
Duncan Sands142b9ed2010-02-18 14:08:13 +00001675// -help and -help-hidden option implementation
Chris Lattner36a57d32001-07-23 17:17:47 +00001676//
Reid Spencer1f4ab8b2004-11-14 22:04:00 +00001677
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001678static int OptNameCompare(const std::pair<const char *, Option *> *LHS,
1679 const std::pair<const char *, Option *> *RHS) {
1680 return strcmp(LHS->first, RHS->first);
Chris Lattner6ec8caf2009-09-20 05:37:24 +00001681}
1682
Zachary Turner07670b32016-06-29 21:48:26 +00001683static int SubNameCompare(const std::pair<const char *, SubCommand *> *LHS,
1684 const std::pair<const char *, SubCommand *> *RHS) {
1685 return strcmp(LHS->first, RHS->first);
1686}
1687
Andrew Trick12004012011-04-05 18:54:36 +00001688// Copy Options into a vector so we can sort them as we like.
Chris Bieneman5d232242015-01-13 19:14:20 +00001689static void sortOpts(StringMap<Option *> &OptMap,
1690 SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1691 bool ShowHidden) {
Matthias Braunb30f2f512016-01-30 01:24:31 +00001692 SmallPtrSet<Option *, 32> OptionSet; // Duplicate option detection.
Andrew Trick12004012011-04-05 18:54:36 +00001693
Chris Bieneman5d232242015-01-13 19:14:20 +00001694 for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
Andrew Trick12004012011-04-05 18:54:36 +00001695 I != E; ++I) {
1696 // Ignore really-hidden options.
1697 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1698 continue;
1699
1700 // Unless showhidden is set, ignore hidden flags.
1701 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1702 continue;
1703
1704 // If we've already seen this option, don't add it to the list again.
David Blaikie70573dc2014-11-19 07:49:26 +00001705 if (!OptionSet.insert(I->second).second)
Andrew Trick12004012011-04-05 18:54:36 +00001706 continue;
1707
Chris Bieneman5d232242015-01-13 19:14:20 +00001708 Opts.push_back(
1709 std::pair<const char *, Option *>(I->getKey().data(), I->second));
Andrew Trick12004012011-04-05 18:54:36 +00001710 }
1711
1712 // Sort the options list alphabetically.
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001713 array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare);
Andrew Trick12004012011-04-05 18:54:36 +00001714}
1715
Zachary Turner07670b32016-06-29 21:48:26 +00001716static void
1717sortSubCommands(const SmallPtrSetImpl<SubCommand *> &SubMap,
1718 SmallVectorImpl<std::pair<const char *, SubCommand *>> &Subs) {
1719 for (const auto &S : SubMap) {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001720 if (S->getName().empty())
Zachary Turner07670b32016-06-29 21:48:26 +00001721 continue;
Mehdi Aminie11b7452016-10-01 03:43:20 +00001722 Subs.push_back(std::make_pair(S->getName().data(), S));
Zachary Turner07670b32016-06-29 21:48:26 +00001723 }
1724 array_pod_sort(Subs.begin(), Subs.end(), SubNameCompare);
1725}
1726
Chris Lattner36a57d32001-07-23 17:17:47 +00001727namespace {
1728
Chris Lattner5df56c42002-07-22 02:07:59 +00001729class HelpPrinter {
Andrew Trick0537a982013-05-06 21:56:23 +00001730protected:
Chris Lattner36a57d32001-07-23 17:17:47 +00001731 const bool ShowHidden;
Chris Bieneman5d232242015-01-13 19:14:20 +00001732 typedef SmallVector<std::pair<const char *, Option *>, 128>
1733 StrOptionPairVector;
Zachary Turner07670b32016-06-29 21:48:26 +00001734 typedef SmallVector<std::pair<const char *, SubCommand *>, 128>
1735 StrSubCommandPairVector;
Andrew Trick0537a982013-05-06 21:56:23 +00001736 // Print the options. Opts is assumed to be alphabetically sorted.
1737 virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1738 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1739 Opts[i].second->printOptionInfo(MaxArgLen);
1740 }
Chris Lattner36a57d32001-07-23 17:17:47 +00001741
Zachary Turner07670b32016-06-29 21:48:26 +00001742 void printSubCommands(StrSubCommandPairVector &Subs, size_t MaxSubLen) {
1743 for (const auto &S : Subs) {
1744 outs() << " " << S.first;
Mehdi Aminie11b7452016-10-01 03:43:20 +00001745 if (!S.second->getDescription().empty()) {
Zachary Turner07670b32016-06-29 21:48:26 +00001746 outs().indent(MaxSubLen - strlen(S.first));
1747 outs() << " - " << S.second->getDescription();
1748 }
1749 outs() << "\n";
1750 }
1751 }
1752
Chris Lattner5df56c42002-07-22 02:07:59 +00001753public:
Craig Topperfa9888f2013-03-09 23:29:37 +00001754 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
Andrew Trick0537a982013-05-06 21:56:23 +00001755 virtual ~HelpPrinter() {}
Chris Lattner5df56c42002-07-22 02:07:59 +00001756
Andrew Trick0537a982013-05-06 21:56:23 +00001757 // Invoke the printer.
Chris Lattner5df56c42002-07-22 02:07:59 +00001758 void operator=(bool Value) {
David Blaikiedc3f01e2015-03-09 01:57:13 +00001759 if (!Value)
Chris Bieneman5d232242015-01-13 19:14:20 +00001760 return;
Chris Lattner5df56c42002-07-22 02:07:59 +00001761
Zachary Turner07670b32016-06-29 21:48:26 +00001762 SubCommand *Sub = GlobalParser->getActiveSubCommand();
1763 auto &OptionsMap = Sub->OptionsMap;
1764 auto &PositionalOpts = Sub->PositionalOpts;
1765 auto &ConsumeAfterOpt = Sub->ConsumeAfterOpt;
1766
Andrew Trick0537a982013-05-06 21:56:23 +00001767 StrOptionPairVector Opts;
Zachary Turner07670b32016-06-29 21:48:26 +00001768 sortOpts(OptionsMap, Opts, ShowHidden);
1769
1770 StrSubCommandPairVector Subs;
1771 sortSubCommands(GlobalParser->RegisteredSubCommands, Subs);
Chris Lattner36a57d32001-07-23 17:17:47 +00001772
Mehdi Aminie11b7452016-10-01 03:43:20 +00001773 if (!GlobalParser->ProgramOverview.empty())
Chris Bienemand1d94302015-01-28 19:00:25 +00001774 outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
Chris Lattner36a57d32001-07-23 17:17:47 +00001775
Zachary Turner79f33332016-10-11 15:58:48 +00001776 if (Sub == &*TopLevelSubCommand) {
1777 outs() << "USAGE: " << GlobalParser->ProgramName;
1778 if (Subs.size() > 2)
1779 outs() << " [subcommand]";
1780 outs() << " [options]";
1781 } else {
Mehdi Aminie11b7452016-10-01 03:43:20 +00001782 if (!Sub->getDescription().empty()) {
Zachary Turner07670b32016-06-29 21:48:26 +00001783 outs() << "SUBCOMMAND '" << Sub->getName()
1784 << "': " << Sub->getDescription() << "\n\n";
1785 }
1786 outs() << "USAGE: " << GlobalParser->ProgramName << " " << Sub->getName()
1787 << " [options]";
1788 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001789
Zachary Turner07670b32016-06-29 21:48:26 +00001790 for (auto Opt : PositionalOpts) {
David Blaikieff43d692015-11-17 19:00:52 +00001791 if (Opt->hasArgStr())
Chris Bienemand1d94302015-01-28 19:00:25 +00001792 outs() << " --" << Opt->ArgStr;
1793 outs() << " " << Opt->HelpStr;
Chris Lattner2da046f2003-07-30 17:34:02 +00001794 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001795
1796 // Print the consume after option info if it exists...
Zachary Turner07670b32016-06-29 21:48:26 +00001797 if (ConsumeAfterOpt)
1798 outs() << " " << ConsumeAfterOpt->HelpStr;
1799
Alex Lorenzd6802872016-10-12 10:04:35 +00001800 if (Sub == &*TopLevelSubCommand && !Subs.empty()) {
Zachary Turner07670b32016-06-29 21:48:26 +00001801 // Compute the maximum subcommand length...
1802 size_t MaxSubLen = 0;
1803 for (size_t i = 0, e = Subs.size(); i != e; ++i)
1804 MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first));
1805
1806 outs() << "\n\n";
1807 outs() << "SUBCOMMANDS:\n\n";
1808 printSubCommands(Subs, MaxSubLen);
1809 outs() << "\n";
1810 outs() << " Type \"" << GlobalParser->ProgramName
1811 << " <subcommand> -help\" to get more help on a specific "
1812 "subcommand";
1813 }
Chris Lattner5df56c42002-07-22 02:07:59 +00001814
Chris Lattner471ba482009-08-23 08:43:55 +00001815 outs() << "\n\n";
Chris Lattner36a57d32001-07-23 17:17:47 +00001816
1817 // Compute the maximum argument length...
Craig Topperfa9888f2013-03-09 23:29:37 +00001818 size_t MaxArgLen = 0;
Evan Cheng86cb3182008-05-05 18:30:58 +00001819 for (size_t i = 0, e = Opts.size(); i != e; ++i)
Chris Lattner6ec8caf2009-09-20 05:37:24 +00001820 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
Chris Lattner36a57d32001-07-23 17:17:47 +00001821
Chris Lattner471ba482009-08-23 08:43:55 +00001822 outs() << "OPTIONS:\n";
Andrew Trick0537a982013-05-06 21:56:23 +00001823 printOptions(Opts, MaxArgLen);
Chris Lattner36a57d32001-07-23 17:17:47 +00001824
Chris Lattner37bcd992004-11-19 17:08:15 +00001825 // Print any extra help the user has declared.
Chris Bienemand1d94302015-01-28 19:00:25 +00001826 for (auto I : GlobalParser->MoreHelp)
1827 outs() << I;
1828 GlobalParser->MoreHelp.clear();
Reid Spencer1f4ab8b2004-11-14 22:04:00 +00001829
Reid Spencer5e554702004-11-16 06:11:52 +00001830 // Halt the program since help information was printed
Justin Bogner02b95842014-02-28 19:08:01 +00001831 exit(0);
Chris Lattner36a57d32001-07-23 17:17:47 +00001832 }
1833};
Andrew Trick0537a982013-05-06 21:56:23 +00001834
1835class CategorizedHelpPrinter : public HelpPrinter {
1836public:
1837 explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1838
1839 // Helper function for printOptions().
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001840 // It shall return a negative value if A's name should be lexicographically
Daniel Sanders513c3e42017-03-27 13:43:24 +00001841 // ordered before B's name. It returns a value greater than zero if B's name
1842 // should be ordered before A's name, and it returns 0 otherwise.
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001843 static int OptionCategoryCompare(OptionCategory *const *A,
1844 OptionCategory *const *B) {
Daniel Sanders513c3e42017-03-27 13:43:24 +00001845 return (*A)->getName().compare((*B)->getName());
Andrew Trick0537a982013-05-06 21:56:23 +00001846 }
1847
1848 // Make sure we inherit our base class's operator=()
Chris Bieneman5d232242015-01-13 19:14:20 +00001849 using HelpPrinter::operator=;
Andrew Trick0537a982013-05-06 21:56:23 +00001850
1851protected:
Craig Topper32ea8262014-03-04 06:24:11 +00001852 void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
Andrew Trick0537a982013-05-06 21:56:23 +00001853 std::vector<OptionCategory *> SortedCategories;
Chris Bieneman5d232242015-01-13 19:14:20 +00001854 std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
Andrew Trick0537a982013-05-06 21:56:23 +00001855
Alp Tokercb402912014-01-24 17:20:08 +00001856 // Collect registered option categories into vector in preparation for
Andrew Trick0537a982013-05-06 21:56:23 +00001857 // sorting.
Chris Bieneman67e426a2015-02-13 22:54:32 +00001858 for (auto I = GlobalParser->RegisteredOptionCategories.begin(),
1859 E = GlobalParser->RegisteredOptionCategories.end();
Alexander Kornienkod772d722014-02-07 17:42:30 +00001860 I != E; ++I) {
Andrew Trick0537a982013-05-06 21:56:23 +00001861 SortedCategories.push_back(*I);
Alexander Kornienkod772d722014-02-07 17:42:30 +00001862 }
Andrew Trick0537a982013-05-06 21:56:23 +00001863
1864 // Sort the different option categories alphabetically.
1865 assert(SortedCategories.size() > 0 && "No option categories registered!");
Benjamin Kramerbd5ee502015-03-14 00:20:13 +00001866 array_pod_sort(SortedCategories.begin(), SortedCategories.end(),
1867 OptionCategoryCompare);
Andrew Trick0537a982013-05-06 21:56:23 +00001868
1869 // Create map to empty vectors.
1870 for (std::vector<OptionCategory *>::const_iterator
1871 I = SortedCategories.begin(),
1872 E = SortedCategories.end();
1873 I != E; ++I)
1874 CategorizedOptions[*I] = std::vector<Option *>();
1875
1876 // Walk through pre-sorted options and assign into categories.
1877 // Because the options are already alphabetically sorted the
1878 // options within categories will also be alphabetically sorted.
1879 for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1880 Option *Opt = Opts[I].second;
1881 assert(CategorizedOptions.count(Opt->Category) > 0 &&
1882 "Option has an unregistered category");
1883 CategorizedOptions[Opt->Category].push_back(Opt);
1884 }
1885
1886 // Now do printing.
1887 for (std::vector<OptionCategory *>::const_iterator
1888 Category = SortedCategories.begin(),
1889 E = SortedCategories.end();
1890 Category != E; ++Category) {
1891 // Hide empty categories for -help, but show for -help-hidden.
Benjamin Kramer4dea8f52016-06-17 18:59:41 +00001892 const auto &CategoryOptions = CategorizedOptions[*Category];
1893 bool IsEmptyCategory = CategoryOptions.empty();
Andrew Trick0537a982013-05-06 21:56:23 +00001894 if (!ShowHidden && IsEmptyCategory)
1895 continue;
1896
1897 // Print category information.
1898 outs() << "\n";
1899 outs() << (*Category)->getName() << ":\n";
1900
1901 // Check if description is set.
Mehdi Aminie11b7452016-10-01 03:43:20 +00001902 if (!(*Category)->getDescription().empty())
Andrew Trick0537a982013-05-06 21:56:23 +00001903 outs() << (*Category)->getDescription() << "\n\n";
1904 else
1905 outs() << "\n";
1906
1907 // When using -help-hidden explicitly state if the category has no
1908 // options associated with it.
1909 if (IsEmptyCategory) {
1910 outs() << " This option category has no options.\n";
1911 continue;
1912 }
1913 // Loop over the options in the category and print.
Benjamin Kramer4dea8f52016-06-17 18:59:41 +00001914 for (const Option *Opt : CategoryOptions)
1915 Opt->printOptionInfo(MaxArgLen);
Andrew Trick0537a982013-05-06 21:56:23 +00001916 }
1917 }
1918};
1919
1920// This wraps the Uncategorizing and Categorizing printers and decides
1921// at run time which should be invoked.
1922class HelpPrinterWrapper {
1923private:
1924 HelpPrinter &UncategorizedPrinter;
1925 CategorizedHelpPrinter &CategorizedPrinter;
1926
1927public:
1928 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
Chris Bieneman5d232242015-01-13 19:14:20 +00001929 CategorizedHelpPrinter &CategorizedPrinter)
1930 : UncategorizedPrinter(UncategorizedPrinter),
1931 CategorizedPrinter(CategorizedPrinter) {}
Andrew Trick0537a982013-05-06 21:56:23 +00001932
1933 // Invoke the printer.
1934 void operator=(bool Value);
1935};
1936
Chris Lattneradb19d62006-10-12 22:09:17 +00001937} // End anonymous namespace
Chris Lattner36a57d32001-07-23 17:17:47 +00001938
Andrew Trick0537a982013-05-06 21:56:23 +00001939// Declare the four HelpPrinter instances that are used to print out help, or
1940// help-hidden as an uncategorized list or in categories.
1941static HelpPrinter UncategorizedNormalPrinter(false);
1942static HelpPrinter UncategorizedHiddenPrinter(true);
1943static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1944static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1945
Andrew Trick0537a982013-05-06 21:56:23 +00001946// Declare HelpPrinter wrappers that will decide whether or not to invoke
1947// a categorizing help printer
1948static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1949 CategorizedNormalPrinter);
1950static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1951 CategorizedHiddenPrinter);
1952
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001953// Define a category for generic options that all tools should have.
1954static cl::OptionCategory GenericCategory("Generic Options");
1955
Andrew Trick0537a982013-05-06 21:56:23 +00001956// Define uncategorized help printers.
1957// -help-list is hidden by default because if Option categories are being used
1958// then -help behaves the same as -help-list.
Chris Bieneman5d232242015-01-13 19:14:20 +00001959static cl::opt<HelpPrinter, true, parser<bool>> HLOp(
1960 "help-list",
1961 cl::desc("Display list of available options (-help-list-hidden for more)"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001962 cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
Zachary Turner07670b32016-06-29 21:48:26 +00001963 cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Chris Lattner5df56c42002-07-22 02:07:59 +00001964
Chris Bieneman5d232242015-01-13 19:14:20 +00001965static cl::opt<HelpPrinter, true, parser<bool>>
1966 HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
1967 cl::location(UncategorizedHiddenPrinter), cl::Hidden,
Zachary Turner07670b32016-06-29 21:48:26 +00001968 cl::ValueDisallowed, cl::cat(GenericCategory),
1969 cl::sub(*AllSubCommands));
Andrew Trick0537a982013-05-06 21:56:23 +00001970
1971// Define uncategorized/categorized help printers. These printers change their
1972// behaviour at runtime depending on whether one or more Option categories have
1973// been declared.
Chris Bieneman5d232242015-01-13 19:14:20 +00001974static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1975 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001976 cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
Zachary Turner07670b32016-06-29 21:48:26 +00001977 cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Chris Lattner5df56c42002-07-22 02:07:59 +00001978
Chris Bieneman5d232242015-01-13 19:14:20 +00001979static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1980 HHOp("help-hidden", cl::desc("Display all available options"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00001981 cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
Zachary Turner07670b32016-06-29 21:48:26 +00001982 cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Andrew Trick0537a982013-05-06 21:56:23 +00001983
Chris Bieneman5d232242015-01-13 19:14:20 +00001984static cl::opt<bool> PrintOptions(
1985 "print-options",
1986 cl::desc("Print non-default options after command line parsing"),
Zachary Turner07670b32016-06-29 21:48:26 +00001987 cl::Hidden, cl::init(false), cl::cat(GenericCategory),
1988 cl::sub(*AllSubCommands));
Andrew Trick0537a982013-05-06 21:56:23 +00001989
Chris Bieneman5d232242015-01-13 19:14:20 +00001990static cl::opt<bool> PrintAllOptions(
1991 "print-all-options",
1992 cl::desc("Print all option values after command line parsing"), cl::Hidden,
Zachary Turner07670b32016-06-29 21:48:26 +00001993 cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands));
Andrew Trick12004012011-04-05 18:54:36 +00001994
Andrew Trick0537a982013-05-06 21:56:23 +00001995void HelpPrinterWrapper::operator=(bool Value) {
David Blaikiedc3f01e2015-03-09 01:57:13 +00001996 if (!Value)
Andrew Trick0537a982013-05-06 21:56:23 +00001997 return;
1998
1999 // Decide which printer to invoke. If more than one option category is
2000 // registered then it is useful to show the categorized help instead of
2001 // uncategorized help.
Chris Bieneman67e426a2015-02-13 22:54:32 +00002002 if (GlobalParser->RegisteredOptionCategories.size() > 1) {
Andrew Trick0537a982013-05-06 21:56:23 +00002003 // unhide -help-list option so user can have uncategorized output if they
2004 // want it.
2005 HLOp.setHiddenFlag(NotHidden);
2006
2007 CategorizedPrinter = true; // Invoke categorized printer
Chris Bieneman5d232242015-01-13 19:14:20 +00002008 } else
Andrew Trick0537a982013-05-06 21:56:23 +00002009 UncategorizedPrinter = true; // Invoke uncategorized printer
2010}
2011
Andrew Trick12004012011-04-05 18:54:36 +00002012// Print the value of each option.
Chris Bienemand77bbab2015-01-30 22:16:01 +00002013void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
2014
2015void CommandLineParser::printOptionValues() {
Chris Bieneman5d232242015-01-13 19:14:20 +00002016 if (!PrintOptions && !PrintAllOptions)
2017 return;
Andrew Trick12004012011-04-05 18:54:36 +00002018
Chris Bieneman5d232242015-01-13 19:14:20 +00002019 SmallVector<std::pair<const char *, Option *>, 128> Opts;
Zachary Turner07670b32016-06-29 21:48:26 +00002020 sortOpts(ActiveSubCommand->OptionsMap, Opts, /*ShowHidden*/ true);
Andrew Trick12004012011-04-05 18:54:36 +00002021
2022 // Compute the maximum argument length...
2023 size_t MaxArgLen = 0;
2024 for (size_t i = 0, e = Opts.size(); i != e; ++i)
2025 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2026
2027 for (size_t i = 0, e = Opts.size(); i != e; ++i)
2028 Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
2029}
2030
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002031static VersionPrinterTy OverrideVersionPrinter = nullptr;
Reid Spencerb3171672006-06-05 16:22:56 +00002032
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002033static std::vector<VersionPrinterTy> *ExtraVersionPrinters = nullptr;
Chandler Carruthea7e5522011-07-22 07:50:40 +00002034
Chris Lattneradb19d62006-10-12 22:09:17 +00002035namespace {
Reid Spencerb3171672006-06-05 16:22:56 +00002036class VersionPrinter {
2037public:
Devang Patel9eb2caae2007-02-01 01:43:37 +00002038 void print() {
Chris Lattner131dca92009-09-20 06:18:38 +00002039 raw_ostream &OS = outs();
Chris Bienemanef43d442016-03-15 18:07:46 +00002040#ifdef PACKAGE_VENDOR
2041 OS << PACKAGE_VENDOR << " ";
2042#else
2043 OS << "LLVM (http://llvm.org/):\n ";
2044#endif
2045 OS << PACKAGE_NAME << " version " << PACKAGE_VERSION;
Chris Lattner8ac22e72006-07-06 18:33:03 +00002046#ifdef LLVM_VERSION_INFO
Justin Bogner581b5922014-06-17 06:52:41 +00002047 OS << " " << LLVM_VERSION_INFO;
Reid Spencerb3171672006-06-05 16:22:56 +00002048#endif
Chris Lattner131dca92009-09-20 06:18:38 +00002049 OS << "\n ";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002050#ifndef __OPTIMIZE__
Chris Lattner131dca92009-09-20 06:18:38 +00002051 OS << "DEBUG build";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002052#else
Chris Lattner131dca92009-09-20 06:18:38 +00002053 OS << "Optimized build";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002054#endif
2055#ifndef NDEBUG
Chris Lattner131dca92009-09-20 06:18:38 +00002056 OS << " with assertions";
Chris Lattner8ac22e72006-07-06 18:33:03 +00002057#endif
Xin Tong59cb7782017-04-19 00:03:36 +00002058#if LLVM_VERSION_PRINTER_SHOW_HOST_TARGET_INFO
Daniel Dunbard90a9a02009-11-14 21:36:07 +00002059 std::string CPU = sys::getHostCPUName();
Chris Bieneman5d232242015-01-13 19:14:20 +00002060 if (CPU == "generic")
2061 CPU = "(unknown)";
Chris Lattner131dca92009-09-20 06:18:38 +00002062 OS << ".\n"
Sebastian Pop94441fb2011-11-01 21:32:20 +00002063 << " Default target: " << sys::getDefaultTargetTriple() << '\n'
Xin Tong59cb7782017-04-19 00:03:36 +00002064 << " Host CPU: " << CPU;
2065#endif
2066 OS << '\n';
Devang Patel9eb2caae2007-02-01 01:43:37 +00002067 }
2068 void operator=(bool OptionWasSpecified) {
Chris Bieneman5d232242015-01-13 19:14:20 +00002069 if (!OptionWasSpecified)
2070 return;
Mikhail Glushenkov1d9f1fe2009-11-19 17:29:36 +00002071
Craig Topperc10719f2014-04-07 04:17:22 +00002072 if (OverrideVersionPrinter != nullptr) {
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002073 OverrideVersionPrinter(outs());
Justin Bogner02b95842014-02-28 19:08:01 +00002074 exit(0);
Reid Spencerb3171672006-06-05 16:22:56 +00002075 }
Chandler Carruthea7e5522011-07-22 07:50:40 +00002076 print();
2077
2078 // Iterate over any registered extra printers and call them to add further
2079 // information.
Craig Topperc10719f2014-04-07 04:17:22 +00002080 if (ExtraVersionPrinters != nullptr) {
Chandler Carruth2d71c422011-07-22 07:50:48 +00002081 outs() << '\n';
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002082 for (auto I : *ExtraVersionPrinters)
2083 I(outs());
Chandler Carruthea7e5522011-07-22 07:50:40 +00002084 }
2085
Justin Bogner02b95842014-02-28 19:08:01 +00002086 exit(0);
Reid Spencerb3171672006-06-05 16:22:56 +00002087 }
2088};
Chris Lattneradb19d62006-10-12 22:09:17 +00002089} // End anonymous namespace
Reid Spencerb3171672006-06-05 16:22:56 +00002090
Reid Spencerff6cc122004-08-04 00:36:06 +00002091// Define the --version option that prints out the LLVM version for the tool
Chris Lattneradb19d62006-10-12 22:09:17 +00002092static VersionPrinter VersionPrinterInstance;
2093
Chris Bieneman5d232242015-01-13 19:14:20 +00002094static cl::opt<VersionPrinter, true, parser<bool>>
2095 VersOp("version", cl::desc("Display the version of this program"),
Chris Bieneman831fc5e2015-01-26 16:56:00 +00002096 cl::location(VersionPrinterInstance), cl::ValueDisallowed,
2097 cl::cat(GenericCategory));
Reid Spencerff6cc122004-08-04 00:36:06 +00002098
Reid Spencer5e554702004-11-16 06:11:52 +00002099// Utility function for printing the help message.
Andrew Trick0537a982013-05-06 21:56:23 +00002100void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
2101 // This looks weird, but it actually prints the help message. The Printers are
2102 // types of HelpPrinter and the help gets printed when its operator= is
2103 // invoked. That's because the "normal" usages of the help printer is to be
2104 // assigned true/false depending on whether -help or -help-hidden was given or
2105 // not. Since we're circumventing that we have to make it look like -help or
2106 // -help-hidden were given, so we assign true.
2107
2108 if (!Hidden && !Categorized)
2109 UncategorizedNormalPrinter = true;
2110 else if (!Hidden && Categorized)
2111 CategorizedNormalPrinter = true;
2112 else if (Hidden && !Categorized)
2113 UncategorizedHiddenPrinter = true;
2114 else
2115 CategorizedHiddenPrinter = true;
Reid Spencer5e554702004-11-16 06:11:52 +00002116}
Reid Spencerb3171672006-06-05 16:22:56 +00002117
Devang Patel9eb2caae2007-02-01 01:43:37 +00002118/// Utility function for printing version number.
Chris Bieneman5d232242015-01-13 19:14:20 +00002119void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
Devang Patel9eb2caae2007-02-01 01:43:37 +00002120
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002121void cl::SetVersionPrinter(VersionPrinterTy func) { OverrideVersionPrinter = func; }
Chandler Carruthea7e5522011-07-22 07:50:40 +00002122
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002123void cl::AddExtraVersionPrinter(VersionPrinterTy func) {
Craig Topper8d399f82014-04-09 04:20:00 +00002124 if (!ExtraVersionPrinters)
Dimitry Andricbc3feaa2017-06-06 21:54:04 +00002125 ExtraVersionPrinters = new std::vector<VersionPrinterTy>;
Chandler Carruthea7e5522011-07-22 07:50:40 +00002126
2127 ExtraVersionPrinters->push_back(func);
2128}
Andrew Trick7cb710d2013-05-06 21:56:35 +00002129
Zachary Turner07670b32016-06-29 21:48:26 +00002130StringMap<Option *> &cl::getRegisteredOptions(SubCommand &Sub) {
2131 auto &Subs = GlobalParser->RegisteredSubCommands;
2132 (void)Subs;
David Majnemer0d955d02016-08-11 22:21:41 +00002133 assert(is_contained(Subs, &Sub));
Zachary Turner07670b32016-06-29 21:48:26 +00002134 return Sub.OptionsMap;
Andrew Trick7cb710d2013-05-06 21:56:35 +00002135}
Peter Collingbournee1863192014-10-16 22:47:52 +00002136
Dean Michael Berris27358cf2016-10-05 05:20:08 +00002137iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator>
2138cl::getRegisteredSubcommands() {
2139 return GlobalParser->getRegisteredSubcommands();
2140}
2141
Zachary Turner07670b32016-06-29 21:48:26 +00002142void cl::HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub) {
2143 for (auto &I : Sub.OptionsMap) {
Chris Bieneman831fc5e2015-01-26 16:56:00 +00002144 if (I.second->Category != &Category &&
2145 I.second->Category != &GenericCategory)
Chris Bieneman9e13af72015-01-21 22:45:52 +00002146 I.second->setHiddenFlag(cl::ReallyHidden);
2147 }
2148}
2149
Zachary Turner07670b32016-06-29 21:48:26 +00002150void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories,
2151 SubCommand &Sub) {
Chris Bieneman01043252015-01-26 21:57:29 +00002152 auto CategoriesBegin = Categories.begin();
2153 auto CategoriesEnd = Categories.end();
Zachary Turner07670b32016-06-29 21:48:26 +00002154 for (auto &I : Sub.OptionsMap) {
Chris Bieneman01043252015-01-26 21:57:29 +00002155 if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
2156 CategoriesEnd &&
2157 I.second->Category != &GenericCategory)
2158 I.second->setHiddenFlag(cl::ReallyHidden);
2159 }
2160}
2161
Zachary Turner07670b32016-06-29 21:48:26 +00002162void cl::ResetCommandLineParser() { GlobalParser->reset(); }
2163void cl::ResetAllOptionOccurrences() {
2164 GlobalParser->ResetAllOptionOccurrences();
2165}
2166
Peter Collingbournee1863192014-10-16 22:47:52 +00002167void LLVMParseCommandLineOptions(int argc, const char *const *argv,
2168 const char *Overview) {
Eric Liue51ee062017-03-15 08:41:00 +00002169 llvm::cl::ParseCommandLineOptions(argc, argv, StringRef(Overview),
2170 &llvm::nulls());
Peter Collingbournee1863192014-10-16 22:47:52 +00002171}