xref: /aosp_15_r20/external/llvm/lib/Support/CommandLine.cpp (revision 9880d6810fe72a1726cb53787c6711e909410d58)
1*9880d681SAndroid Build Coastguard Worker //===-- CommandLine.cpp - Command line parser implementation --------------===//
2*9880d681SAndroid Build Coastguard Worker //
3*9880d681SAndroid Build Coastguard Worker //                     The LLVM Compiler Infrastructure
4*9880d681SAndroid Build Coastguard Worker //
5*9880d681SAndroid Build Coastguard Worker // This file is distributed under the University of Illinois Open Source
6*9880d681SAndroid Build Coastguard Worker // License. See LICENSE.TXT for details.
7*9880d681SAndroid Build Coastguard Worker //
8*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
9*9880d681SAndroid Build Coastguard Worker //
10*9880d681SAndroid Build Coastguard Worker // This class implements a command line argument processor that is useful when
11*9880d681SAndroid Build Coastguard Worker // creating a tool.  It provides a simple, minimalistic interface that is easily
12*9880d681SAndroid Build Coastguard Worker // extensible and supports nonlocal (library) command line options.
13*9880d681SAndroid Build Coastguard Worker //
14*9880d681SAndroid Build Coastguard Worker // Note that rather than trying to figure out what this code does, you could try
15*9880d681SAndroid Build Coastguard Worker // reading the library documentation located in docs/CommandLine.html
16*9880d681SAndroid Build Coastguard Worker //
17*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
18*9880d681SAndroid Build Coastguard Worker 
19*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/CommandLine.h"
20*9880d681SAndroid Build Coastguard Worker #include "llvm-c/Support.h"
21*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/ArrayRef.h"
22*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/DenseMap.h"
23*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/STLExtras.h"
24*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/SmallPtrSet.h"
25*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/SmallString.h"
26*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/StringMap.h"
27*9880d681SAndroid Build Coastguard Worker #include "llvm/ADT/Twine.h"
28*9880d681SAndroid Build Coastguard Worker #include "llvm/Config/config.h"
29*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/ConvertUTF.h"
30*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/Debug.h"
31*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/ErrorHandling.h"
32*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/Host.h"
33*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/ManagedStatic.h"
34*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/MemoryBuffer.h"
35*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/Path.h"
36*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/StringSaver.h"
37*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/raw_ostream.h"
38*9880d681SAndroid Build Coastguard Worker #include <cstdlib>
39*9880d681SAndroid Build Coastguard Worker #include <map>
40*9880d681SAndroid Build Coastguard Worker using namespace llvm;
41*9880d681SAndroid Build Coastguard Worker using namespace cl;
42*9880d681SAndroid Build Coastguard Worker 
43*9880d681SAndroid Build Coastguard Worker #define DEBUG_TYPE "commandline"
44*9880d681SAndroid Build Coastguard Worker 
45*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
46*9880d681SAndroid Build Coastguard Worker // Template instantiations and anchors.
47*9880d681SAndroid Build Coastguard Worker //
48*9880d681SAndroid Build Coastguard Worker namespace llvm {
49*9880d681SAndroid Build Coastguard Worker namespace cl {
50*9880d681SAndroid Build Coastguard Worker template class basic_parser<bool>;
51*9880d681SAndroid Build Coastguard Worker template class basic_parser<boolOrDefault>;
52*9880d681SAndroid Build Coastguard Worker template class basic_parser<int>;
53*9880d681SAndroid Build Coastguard Worker template class basic_parser<unsigned>;
54*9880d681SAndroid Build Coastguard Worker template class basic_parser<unsigned long long>;
55*9880d681SAndroid Build Coastguard Worker template class basic_parser<double>;
56*9880d681SAndroid Build Coastguard Worker template class basic_parser<float>;
57*9880d681SAndroid Build Coastguard Worker template class basic_parser<std::string>;
58*9880d681SAndroid Build Coastguard Worker template class basic_parser<char>;
59*9880d681SAndroid Build Coastguard Worker 
60*9880d681SAndroid Build Coastguard Worker template class opt<unsigned>;
61*9880d681SAndroid Build Coastguard Worker template class opt<int>;
62*9880d681SAndroid Build Coastguard Worker template class opt<std::string>;
63*9880d681SAndroid Build Coastguard Worker template class opt<char>;
64*9880d681SAndroid Build Coastguard Worker template class opt<bool>;
65*9880d681SAndroid Build Coastguard Worker }
66*9880d681SAndroid Build Coastguard Worker } // end namespace llvm::cl
67*9880d681SAndroid Build Coastguard Worker 
68*9880d681SAndroid Build Coastguard Worker // Pin the vtables to this file.
anchor()69*9880d681SAndroid Build Coastguard Worker void GenericOptionValue::anchor() {}
anchor()70*9880d681SAndroid Build Coastguard Worker void OptionValue<boolOrDefault>::anchor() {}
anchor()71*9880d681SAndroid Build Coastguard Worker void OptionValue<std::string>::anchor() {}
anchor()72*9880d681SAndroid Build Coastguard Worker void Option::anchor() {}
anchor()73*9880d681SAndroid Build Coastguard Worker void basic_parser_impl::anchor() {}
anchor()74*9880d681SAndroid Build Coastguard Worker void parser<bool>::anchor() {}
anchor()75*9880d681SAndroid Build Coastguard Worker void parser<boolOrDefault>::anchor() {}
anchor()76*9880d681SAndroid Build Coastguard Worker void parser<int>::anchor() {}
anchor()77*9880d681SAndroid Build Coastguard Worker void parser<unsigned>::anchor() {}
anchor()78*9880d681SAndroid Build Coastguard Worker void parser<unsigned long long>::anchor() {}
anchor()79*9880d681SAndroid Build Coastguard Worker void parser<double>::anchor() {}
anchor()80*9880d681SAndroid Build Coastguard Worker void parser<float>::anchor() {}
anchor()81*9880d681SAndroid Build Coastguard Worker void parser<std::string>::anchor() {}
anchor()82*9880d681SAndroid Build Coastguard Worker void parser<char>::anchor() {}
83*9880d681SAndroid Build Coastguard Worker 
84*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
85*9880d681SAndroid Build Coastguard Worker 
86*9880d681SAndroid Build Coastguard Worker namespace {
87*9880d681SAndroid Build Coastguard Worker 
88*9880d681SAndroid Build Coastguard Worker class CommandLineParser {
89*9880d681SAndroid Build Coastguard Worker public:
90*9880d681SAndroid Build Coastguard Worker   // Globals for name and overview of program.  Program name is not a string to
91*9880d681SAndroid Build Coastguard Worker   // avoid static ctor/dtor issues.
92*9880d681SAndroid Build Coastguard Worker   std::string ProgramName;
93*9880d681SAndroid Build Coastguard Worker   const char *ProgramOverview;
94*9880d681SAndroid Build Coastguard Worker 
95*9880d681SAndroid Build Coastguard Worker   // This collects additional help to be printed.
96*9880d681SAndroid Build Coastguard Worker   std::vector<const char *> MoreHelp;
97*9880d681SAndroid Build Coastguard Worker 
98*9880d681SAndroid Build Coastguard Worker   // This collects the different option categories that have been registered.
99*9880d681SAndroid Build Coastguard Worker   SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories;
100*9880d681SAndroid Build Coastguard Worker 
101*9880d681SAndroid Build Coastguard Worker   // This collects the different subcommands that have been registered.
102*9880d681SAndroid Build Coastguard Worker   SmallPtrSet<SubCommand *, 4> RegisteredSubCommands;
103*9880d681SAndroid Build Coastguard Worker 
CommandLineParser()104*9880d681SAndroid Build Coastguard Worker   CommandLineParser() : ProgramOverview(nullptr), ActiveSubCommand(nullptr) {
105*9880d681SAndroid Build Coastguard Worker     registerSubCommand(&*TopLevelSubCommand);
106*9880d681SAndroid Build Coastguard Worker     registerSubCommand(&*AllSubCommands);
107*9880d681SAndroid Build Coastguard Worker   }
108*9880d681SAndroid Build Coastguard Worker 
109*9880d681SAndroid Build Coastguard Worker   void ResetAllOptionOccurrences();
110*9880d681SAndroid Build Coastguard Worker 
111*9880d681SAndroid Build Coastguard Worker   bool ParseCommandLineOptions(int argc, const char *const *argv,
112*9880d681SAndroid Build Coastguard Worker                                const char *Overview, bool IgnoreErrors);
113*9880d681SAndroid Build Coastguard Worker 
addLiteralOption(Option & Opt,SubCommand * SC,const char * Name)114*9880d681SAndroid Build Coastguard Worker   void addLiteralOption(Option &Opt, SubCommand *SC, const char *Name) {
115*9880d681SAndroid Build Coastguard Worker     if (Opt.hasArgStr())
116*9880d681SAndroid Build Coastguard Worker       return;
117*9880d681SAndroid Build Coastguard Worker     if (!SC->OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
118*9880d681SAndroid Build Coastguard Worker       errs() << ProgramName << ": CommandLine Error: Option '" << Name
119*9880d681SAndroid Build Coastguard Worker              << "' registered more than once!\n";
120*9880d681SAndroid Build Coastguard Worker       report_fatal_error("inconsistency in registered CommandLine options");
121*9880d681SAndroid Build Coastguard Worker     }
122*9880d681SAndroid Build Coastguard Worker 
123*9880d681SAndroid Build Coastguard Worker     // If we're adding this to all sub-commands, add it to the ones that have
124*9880d681SAndroid Build Coastguard Worker     // already been registered.
125*9880d681SAndroid Build Coastguard Worker     if (SC == &*AllSubCommands) {
126*9880d681SAndroid Build Coastguard Worker       for (const auto &Sub : RegisteredSubCommands) {
127*9880d681SAndroid Build Coastguard Worker         if (SC == Sub)
128*9880d681SAndroid Build Coastguard Worker           continue;
129*9880d681SAndroid Build Coastguard Worker         addLiteralOption(Opt, Sub, Name);
130*9880d681SAndroid Build Coastguard Worker       }
131*9880d681SAndroid Build Coastguard Worker     }
132*9880d681SAndroid Build Coastguard Worker   }
133*9880d681SAndroid Build Coastguard Worker 
addLiteralOption(Option & Opt,const char * Name)134*9880d681SAndroid Build Coastguard Worker   void addLiteralOption(Option &Opt, const char *Name) {
135*9880d681SAndroid Build Coastguard Worker     if (Opt.Subs.empty())
136*9880d681SAndroid Build Coastguard Worker       addLiteralOption(Opt, &*TopLevelSubCommand, Name);
137*9880d681SAndroid Build Coastguard Worker     else {
138*9880d681SAndroid Build Coastguard Worker       for (auto SC : Opt.Subs)
139*9880d681SAndroid Build Coastguard Worker         addLiteralOption(Opt, SC, Name);
140*9880d681SAndroid Build Coastguard Worker     }
141*9880d681SAndroid Build Coastguard Worker   }
142*9880d681SAndroid Build Coastguard Worker 
addOption(Option * O,SubCommand * SC)143*9880d681SAndroid Build Coastguard Worker   void addOption(Option *O, SubCommand *SC) {
144*9880d681SAndroid Build Coastguard Worker     bool HadErrors = false;
145*9880d681SAndroid Build Coastguard Worker     if (O->hasArgStr()) {
146*9880d681SAndroid Build Coastguard Worker       // Add argument to the argument map!
147*9880d681SAndroid Build Coastguard Worker       if (!SC->OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) {
148*9880d681SAndroid Build Coastguard Worker         errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
149*9880d681SAndroid Build Coastguard Worker                << "' registered more than once!\n";
150*9880d681SAndroid Build Coastguard Worker         HadErrors = true;
151*9880d681SAndroid Build Coastguard Worker       }
152*9880d681SAndroid Build Coastguard Worker     }
153*9880d681SAndroid Build Coastguard Worker 
154*9880d681SAndroid Build Coastguard Worker     // Remember information about positional options.
155*9880d681SAndroid Build Coastguard Worker     if (O->getFormattingFlag() == cl::Positional)
156*9880d681SAndroid Build Coastguard Worker       SC->PositionalOpts.push_back(O);
157*9880d681SAndroid Build Coastguard Worker     else if (O->getMiscFlags() & cl::Sink) // Remember sink options
158*9880d681SAndroid Build Coastguard Worker       SC->SinkOpts.push_back(O);
159*9880d681SAndroid Build Coastguard Worker     else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
160*9880d681SAndroid Build Coastguard Worker       if (SC->ConsumeAfterOpt) {
161*9880d681SAndroid Build Coastguard Worker         O->error("Cannot specify more than one option with cl::ConsumeAfter!");
162*9880d681SAndroid Build Coastguard Worker         HadErrors = true;
163*9880d681SAndroid Build Coastguard Worker       }
164*9880d681SAndroid Build Coastguard Worker       SC->ConsumeAfterOpt = O;
165*9880d681SAndroid Build Coastguard Worker     }
166*9880d681SAndroid Build Coastguard Worker 
167*9880d681SAndroid Build Coastguard Worker     // Fail hard if there were errors. These are strictly unrecoverable and
168*9880d681SAndroid Build Coastguard Worker     // indicate serious issues such as conflicting option names or an
169*9880d681SAndroid Build Coastguard Worker     // incorrectly
170*9880d681SAndroid Build Coastguard Worker     // linked LLVM distribution.
171*9880d681SAndroid Build Coastguard Worker     if (HadErrors)
172*9880d681SAndroid Build Coastguard Worker       report_fatal_error("inconsistency in registered CommandLine options");
173*9880d681SAndroid Build Coastguard Worker 
174*9880d681SAndroid Build Coastguard Worker     // If we're adding this to all sub-commands, add it to the ones that have
175*9880d681SAndroid Build Coastguard Worker     // already been registered.
176*9880d681SAndroid Build Coastguard Worker     if (SC == &*AllSubCommands) {
177*9880d681SAndroid Build Coastguard Worker       for (const auto &Sub : RegisteredSubCommands) {
178*9880d681SAndroid Build Coastguard Worker         if (SC == Sub)
179*9880d681SAndroid Build Coastguard Worker           continue;
180*9880d681SAndroid Build Coastguard Worker         addOption(O, Sub);
181*9880d681SAndroid Build Coastguard Worker       }
182*9880d681SAndroid Build Coastguard Worker     }
183*9880d681SAndroid Build Coastguard Worker   }
184*9880d681SAndroid Build Coastguard Worker 
addOption(Option * O)185*9880d681SAndroid Build Coastguard Worker   void addOption(Option *O) {
186*9880d681SAndroid Build Coastguard Worker     if (O->Subs.empty()) {
187*9880d681SAndroid Build Coastguard Worker       addOption(O, &*TopLevelSubCommand);
188*9880d681SAndroid Build Coastguard Worker     } else {
189*9880d681SAndroid Build Coastguard Worker       for (auto SC : O->Subs)
190*9880d681SAndroid Build Coastguard Worker         addOption(O, SC);
191*9880d681SAndroid Build Coastguard Worker     }
192*9880d681SAndroid Build Coastguard Worker   }
193*9880d681SAndroid Build Coastguard Worker 
removeOption(Option * O,SubCommand * SC)194*9880d681SAndroid Build Coastguard Worker   void removeOption(Option *O, SubCommand *SC) {
195*9880d681SAndroid Build Coastguard Worker     SmallVector<StringRef, 16> OptionNames;
196*9880d681SAndroid Build Coastguard Worker     O->getExtraOptionNames(OptionNames);
197*9880d681SAndroid Build Coastguard Worker     if (O->hasArgStr())
198*9880d681SAndroid Build Coastguard Worker       OptionNames.push_back(O->ArgStr);
199*9880d681SAndroid Build Coastguard Worker 
200*9880d681SAndroid Build Coastguard Worker     SubCommand &Sub = *SC;
201*9880d681SAndroid Build Coastguard Worker     for (auto Name : OptionNames)
202*9880d681SAndroid Build Coastguard Worker       Sub.OptionsMap.erase(Name);
203*9880d681SAndroid Build Coastguard Worker 
204*9880d681SAndroid Build Coastguard Worker     if (O->getFormattingFlag() == cl::Positional)
205*9880d681SAndroid Build Coastguard Worker       for (auto Opt = Sub.PositionalOpts.begin();
206*9880d681SAndroid Build Coastguard Worker            Opt != Sub.PositionalOpts.end(); ++Opt) {
207*9880d681SAndroid Build Coastguard Worker         if (*Opt == O) {
208*9880d681SAndroid Build Coastguard Worker           Sub.PositionalOpts.erase(Opt);
209*9880d681SAndroid Build Coastguard Worker           break;
210*9880d681SAndroid Build Coastguard Worker         }
211*9880d681SAndroid Build Coastguard Worker       }
212*9880d681SAndroid Build Coastguard Worker     else if (O->getMiscFlags() & cl::Sink)
213*9880d681SAndroid Build Coastguard Worker       for (auto Opt = Sub.SinkOpts.begin(); Opt != Sub.SinkOpts.end(); ++Opt) {
214*9880d681SAndroid Build Coastguard Worker         if (*Opt == O) {
215*9880d681SAndroid Build Coastguard Worker           Sub.SinkOpts.erase(Opt);
216*9880d681SAndroid Build Coastguard Worker           break;
217*9880d681SAndroid Build Coastguard Worker         }
218*9880d681SAndroid Build Coastguard Worker       }
219*9880d681SAndroid Build Coastguard Worker     else if (O == Sub.ConsumeAfterOpt)
220*9880d681SAndroid Build Coastguard Worker       Sub.ConsumeAfterOpt = nullptr;
221*9880d681SAndroid Build Coastguard Worker   }
222*9880d681SAndroid Build Coastguard Worker 
removeOption(Option * O)223*9880d681SAndroid Build Coastguard Worker   void removeOption(Option *O) {
224*9880d681SAndroid Build Coastguard Worker     if (O->Subs.empty())
225*9880d681SAndroid Build Coastguard Worker       removeOption(O, &*TopLevelSubCommand);
226*9880d681SAndroid Build Coastguard Worker     else {
227*9880d681SAndroid Build Coastguard Worker       if (O->isInAllSubCommands()) {
228*9880d681SAndroid Build Coastguard Worker         for (auto SC : RegisteredSubCommands)
229*9880d681SAndroid Build Coastguard Worker           removeOption(O, SC);
230*9880d681SAndroid Build Coastguard Worker       } else {
231*9880d681SAndroid Build Coastguard Worker         for (auto SC : O->Subs)
232*9880d681SAndroid Build Coastguard Worker           removeOption(O, SC);
233*9880d681SAndroid Build Coastguard Worker       }
234*9880d681SAndroid Build Coastguard Worker     }
235*9880d681SAndroid Build Coastguard Worker   }
236*9880d681SAndroid Build Coastguard Worker 
hasOptions(const SubCommand & Sub) const237*9880d681SAndroid Build Coastguard Worker   bool hasOptions(const SubCommand &Sub) const {
238*9880d681SAndroid Build Coastguard Worker     return (!Sub.OptionsMap.empty() || !Sub.PositionalOpts.empty() ||
239*9880d681SAndroid Build Coastguard Worker             nullptr != Sub.ConsumeAfterOpt);
240*9880d681SAndroid Build Coastguard Worker   }
241*9880d681SAndroid Build Coastguard Worker 
hasOptions() const242*9880d681SAndroid Build Coastguard Worker   bool hasOptions() const {
243*9880d681SAndroid Build Coastguard Worker     for (const auto &S : RegisteredSubCommands) {
244*9880d681SAndroid Build Coastguard Worker       if (hasOptions(*S))
245*9880d681SAndroid Build Coastguard Worker         return true;
246*9880d681SAndroid Build Coastguard Worker     }
247*9880d681SAndroid Build Coastguard Worker     return false;
248*9880d681SAndroid Build Coastguard Worker   }
249*9880d681SAndroid Build Coastguard Worker 
getActiveSubCommand()250*9880d681SAndroid Build Coastguard Worker   SubCommand *getActiveSubCommand() { return ActiveSubCommand; }
251*9880d681SAndroid Build Coastguard Worker 
updateArgStr(Option * O,StringRef NewName,SubCommand * SC)252*9880d681SAndroid Build Coastguard Worker   void updateArgStr(Option *O, StringRef NewName, SubCommand *SC) {
253*9880d681SAndroid Build Coastguard Worker     SubCommand &Sub = *SC;
254*9880d681SAndroid Build Coastguard Worker     if (!Sub.OptionsMap.insert(std::make_pair(NewName, O)).second) {
255*9880d681SAndroid Build Coastguard Worker       errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr
256*9880d681SAndroid Build Coastguard Worker              << "' registered more than once!\n";
257*9880d681SAndroid Build Coastguard Worker       report_fatal_error("inconsistency in registered CommandLine options");
258*9880d681SAndroid Build Coastguard Worker     }
259*9880d681SAndroid Build Coastguard Worker     Sub.OptionsMap.erase(O->ArgStr);
260*9880d681SAndroid Build Coastguard Worker   }
261*9880d681SAndroid Build Coastguard Worker 
updateArgStr(Option * O,StringRef NewName)262*9880d681SAndroid Build Coastguard Worker   void updateArgStr(Option *O, StringRef NewName) {
263*9880d681SAndroid Build Coastguard Worker     if (O->Subs.empty())
264*9880d681SAndroid Build Coastguard Worker       updateArgStr(O, NewName, &*TopLevelSubCommand);
265*9880d681SAndroid Build Coastguard Worker     else {
266*9880d681SAndroid Build Coastguard Worker       for (auto SC : O->Subs)
267*9880d681SAndroid Build Coastguard Worker         updateArgStr(O, NewName, SC);
268*9880d681SAndroid Build Coastguard Worker     }
269*9880d681SAndroid Build Coastguard Worker   }
270*9880d681SAndroid Build Coastguard Worker 
271*9880d681SAndroid Build Coastguard Worker   void printOptionValues();
272*9880d681SAndroid Build Coastguard Worker 
registerCategory(OptionCategory * cat)273*9880d681SAndroid Build Coastguard Worker   void registerCategory(OptionCategory *cat) {
274*9880d681SAndroid Build Coastguard Worker     assert(count_if(RegisteredOptionCategories,
275*9880d681SAndroid Build Coastguard Worker                     [cat](const OptionCategory *Category) {
276*9880d681SAndroid Build Coastguard Worker              return cat->getName() == Category->getName();
277*9880d681SAndroid Build Coastguard Worker            }) == 0 &&
278*9880d681SAndroid Build Coastguard Worker            "Duplicate option categories");
279*9880d681SAndroid Build Coastguard Worker 
280*9880d681SAndroid Build Coastguard Worker     RegisteredOptionCategories.insert(cat);
281*9880d681SAndroid Build Coastguard Worker   }
282*9880d681SAndroid Build Coastguard Worker 
registerSubCommand(SubCommand * sub)283*9880d681SAndroid Build Coastguard Worker   void registerSubCommand(SubCommand *sub) {
284*9880d681SAndroid Build Coastguard Worker     assert(count_if(RegisteredSubCommands,
285*9880d681SAndroid Build Coastguard Worker                     [sub](const SubCommand *Sub) {
286*9880d681SAndroid Build Coastguard Worker                       return (sub->getName() != nullptr) &&
287*9880d681SAndroid Build Coastguard Worker                              (Sub->getName() == sub->getName());
288*9880d681SAndroid Build Coastguard Worker                     }) == 0 &&
289*9880d681SAndroid Build Coastguard Worker            "Duplicate subcommands");
290*9880d681SAndroid Build Coastguard Worker     RegisteredSubCommands.insert(sub);
291*9880d681SAndroid Build Coastguard Worker 
292*9880d681SAndroid Build Coastguard Worker     // For all options that have been registered for all subcommands, add the
293*9880d681SAndroid Build Coastguard Worker     // option to this subcommand now.
294*9880d681SAndroid Build Coastguard Worker     if (sub != &*AllSubCommands) {
295*9880d681SAndroid Build Coastguard Worker       for (auto &E : AllSubCommands->OptionsMap) {
296*9880d681SAndroid Build Coastguard Worker         Option *O = E.second;
297*9880d681SAndroid Build Coastguard Worker         if ((O->isPositional() || O->isSink() || O->isConsumeAfter()) ||
298*9880d681SAndroid Build Coastguard Worker             O->hasArgStr())
299*9880d681SAndroid Build Coastguard Worker           addOption(O, sub);
300*9880d681SAndroid Build Coastguard Worker         else
301*9880d681SAndroid Build Coastguard Worker           addLiteralOption(*O, sub, E.first().str().c_str());
302*9880d681SAndroid Build Coastguard Worker       }
303*9880d681SAndroid Build Coastguard Worker     }
304*9880d681SAndroid Build Coastguard Worker   }
305*9880d681SAndroid Build Coastguard Worker 
unregisterSubCommand(SubCommand * sub)306*9880d681SAndroid Build Coastguard Worker   void unregisterSubCommand(SubCommand *sub) {
307*9880d681SAndroid Build Coastguard Worker     RegisteredSubCommands.erase(sub);
308*9880d681SAndroid Build Coastguard Worker   }
309*9880d681SAndroid Build Coastguard Worker 
reset()310*9880d681SAndroid Build Coastguard Worker   void reset() {
311*9880d681SAndroid Build Coastguard Worker     ActiveSubCommand = nullptr;
312*9880d681SAndroid Build Coastguard Worker     ProgramName.clear();
313*9880d681SAndroid Build Coastguard Worker     ProgramOverview = nullptr;
314*9880d681SAndroid Build Coastguard Worker 
315*9880d681SAndroid Build Coastguard Worker     MoreHelp.clear();
316*9880d681SAndroid Build Coastguard Worker     RegisteredOptionCategories.clear();
317*9880d681SAndroid Build Coastguard Worker 
318*9880d681SAndroid Build Coastguard Worker     ResetAllOptionOccurrences();
319*9880d681SAndroid Build Coastguard Worker     RegisteredSubCommands.clear();
320*9880d681SAndroid Build Coastguard Worker 
321*9880d681SAndroid Build Coastguard Worker     TopLevelSubCommand->reset();
322*9880d681SAndroid Build Coastguard Worker     AllSubCommands->reset();
323*9880d681SAndroid Build Coastguard Worker     registerSubCommand(&*TopLevelSubCommand);
324*9880d681SAndroid Build Coastguard Worker     registerSubCommand(&*AllSubCommands);
325*9880d681SAndroid Build Coastguard Worker   }
326*9880d681SAndroid Build Coastguard Worker 
327*9880d681SAndroid Build Coastguard Worker private:
328*9880d681SAndroid Build Coastguard Worker   SubCommand *ActiveSubCommand;
329*9880d681SAndroid Build Coastguard Worker 
330*9880d681SAndroid Build Coastguard Worker   Option *LookupOption(SubCommand &Sub, StringRef &Arg, StringRef &Value);
331*9880d681SAndroid Build Coastguard Worker   SubCommand *LookupSubCommand(const char *Name);
332*9880d681SAndroid Build Coastguard Worker };
333*9880d681SAndroid Build Coastguard Worker 
334*9880d681SAndroid Build Coastguard Worker } // namespace
335*9880d681SAndroid Build Coastguard Worker 
336*9880d681SAndroid Build Coastguard Worker static ManagedStatic<CommandLineParser> GlobalParser;
337*9880d681SAndroid Build Coastguard Worker 
AddLiteralOption(Option & O,const char * Name)338*9880d681SAndroid Build Coastguard Worker void cl::AddLiteralOption(Option &O, const char *Name) {
339*9880d681SAndroid Build Coastguard Worker   GlobalParser->addLiteralOption(O, Name);
340*9880d681SAndroid Build Coastguard Worker }
341*9880d681SAndroid Build Coastguard Worker 
extrahelp(const char * Help)342*9880d681SAndroid Build Coastguard Worker extrahelp::extrahelp(const char *Help) : morehelp(Help) {
343*9880d681SAndroid Build Coastguard Worker   GlobalParser->MoreHelp.push_back(Help);
344*9880d681SAndroid Build Coastguard Worker }
345*9880d681SAndroid Build Coastguard Worker 
addArgument()346*9880d681SAndroid Build Coastguard Worker void Option::addArgument() {
347*9880d681SAndroid Build Coastguard Worker   GlobalParser->addOption(this);
348*9880d681SAndroid Build Coastguard Worker   FullyInitialized = true;
349*9880d681SAndroid Build Coastguard Worker }
350*9880d681SAndroid Build Coastguard Worker 
removeArgument()351*9880d681SAndroid Build Coastguard Worker void Option::removeArgument() { GlobalParser->removeOption(this); }
352*9880d681SAndroid Build Coastguard Worker 
setArgStr(StringRef S)353*9880d681SAndroid Build Coastguard Worker void Option::setArgStr(StringRef S) {
354*9880d681SAndroid Build Coastguard Worker   if (FullyInitialized)
355*9880d681SAndroid Build Coastguard Worker     GlobalParser->updateArgStr(this, S);
356*9880d681SAndroid Build Coastguard Worker   ArgStr = S;
357*9880d681SAndroid Build Coastguard Worker }
358*9880d681SAndroid Build Coastguard Worker 
359*9880d681SAndroid Build Coastguard Worker // Initialise the general option category.
360*9880d681SAndroid Build Coastguard Worker OptionCategory llvm::cl::GeneralCategory("General options");
361*9880d681SAndroid Build Coastguard Worker 
registerCategory()362*9880d681SAndroid Build Coastguard Worker void OptionCategory::registerCategory() {
363*9880d681SAndroid Build Coastguard Worker   GlobalParser->registerCategory(this);
364*9880d681SAndroid Build Coastguard Worker }
365*9880d681SAndroid Build Coastguard Worker 
366*9880d681SAndroid Build Coastguard Worker // A special subcommand representing no subcommand
367*9880d681SAndroid Build Coastguard Worker ManagedStatic<SubCommand> llvm::cl::TopLevelSubCommand;
368*9880d681SAndroid Build Coastguard Worker 
369*9880d681SAndroid Build Coastguard Worker // A special subcommand that can be used to put an option into all subcommands.
370*9880d681SAndroid Build Coastguard Worker ManagedStatic<SubCommand> llvm::cl::AllSubCommands;
371*9880d681SAndroid Build Coastguard Worker 
registerSubCommand()372*9880d681SAndroid Build Coastguard Worker void SubCommand::registerSubCommand() {
373*9880d681SAndroid Build Coastguard Worker   GlobalParser->registerSubCommand(this);
374*9880d681SAndroid Build Coastguard Worker }
375*9880d681SAndroid Build Coastguard Worker 
unregisterSubCommand()376*9880d681SAndroid Build Coastguard Worker void SubCommand::unregisterSubCommand() {
377*9880d681SAndroid Build Coastguard Worker   GlobalParser->unregisterSubCommand(this);
378*9880d681SAndroid Build Coastguard Worker }
379*9880d681SAndroid Build Coastguard Worker 
reset()380*9880d681SAndroid Build Coastguard Worker void SubCommand::reset() {
381*9880d681SAndroid Build Coastguard Worker   PositionalOpts.clear();
382*9880d681SAndroid Build Coastguard Worker   SinkOpts.clear();
383*9880d681SAndroid Build Coastguard Worker   OptionsMap.clear();
384*9880d681SAndroid Build Coastguard Worker 
385*9880d681SAndroid Build Coastguard Worker   ConsumeAfterOpt = nullptr;
386*9880d681SAndroid Build Coastguard Worker }
387*9880d681SAndroid Build Coastguard Worker 
operator bool() const388*9880d681SAndroid Build Coastguard Worker SubCommand::operator bool() const {
389*9880d681SAndroid Build Coastguard Worker   return (GlobalParser->getActiveSubCommand() == this);
390*9880d681SAndroid Build Coastguard Worker }
391*9880d681SAndroid Build Coastguard Worker 
392*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
393*9880d681SAndroid Build Coastguard Worker // Basic, shared command line option processing machinery.
394*9880d681SAndroid Build Coastguard Worker //
395*9880d681SAndroid Build Coastguard Worker 
396*9880d681SAndroid Build Coastguard Worker /// LookupOption - Lookup the option specified by the specified option on the
397*9880d681SAndroid Build Coastguard Worker /// command line.  If there is a value specified (after an equal sign) return
398*9880d681SAndroid Build Coastguard Worker /// that as well.  This assumes that leading dashes have already been stripped.
LookupOption(SubCommand & Sub,StringRef & Arg,StringRef & Value)399*9880d681SAndroid Build Coastguard Worker Option *CommandLineParser::LookupOption(SubCommand &Sub, StringRef &Arg,
400*9880d681SAndroid Build Coastguard Worker                                         StringRef &Value) {
401*9880d681SAndroid Build Coastguard Worker   // Reject all dashes.
402*9880d681SAndroid Build Coastguard Worker   if (Arg.empty())
403*9880d681SAndroid Build Coastguard Worker     return nullptr;
404*9880d681SAndroid Build Coastguard Worker   assert(&Sub != &*AllSubCommands);
405*9880d681SAndroid Build Coastguard Worker 
406*9880d681SAndroid Build Coastguard Worker   size_t EqualPos = Arg.find('=');
407*9880d681SAndroid Build Coastguard Worker 
408*9880d681SAndroid Build Coastguard Worker   // If we have an equals sign, remember the value.
409*9880d681SAndroid Build Coastguard Worker   if (EqualPos == StringRef::npos) {
410*9880d681SAndroid Build Coastguard Worker     // Look up the option.
411*9880d681SAndroid Build Coastguard Worker     auto I = Sub.OptionsMap.find(Arg);
412*9880d681SAndroid Build Coastguard Worker     if (I == Sub.OptionsMap.end())
413*9880d681SAndroid Build Coastguard Worker       return nullptr;
414*9880d681SAndroid Build Coastguard Worker 
415*9880d681SAndroid Build Coastguard Worker     return I != Sub.OptionsMap.end() ? I->second : nullptr;
416*9880d681SAndroid Build Coastguard Worker   }
417*9880d681SAndroid Build Coastguard Worker 
418*9880d681SAndroid Build Coastguard Worker   // If the argument before the = is a valid option name, we match.  If not,
419*9880d681SAndroid Build Coastguard Worker   // return Arg unmolested.
420*9880d681SAndroid Build Coastguard Worker   auto I = Sub.OptionsMap.find(Arg.substr(0, EqualPos));
421*9880d681SAndroid Build Coastguard Worker   if (I == Sub.OptionsMap.end())
422*9880d681SAndroid Build Coastguard Worker     return nullptr;
423*9880d681SAndroid Build Coastguard Worker 
424*9880d681SAndroid Build Coastguard Worker   Value = Arg.substr(EqualPos + 1);
425*9880d681SAndroid Build Coastguard Worker   Arg = Arg.substr(0, EqualPos);
426*9880d681SAndroid Build Coastguard Worker   return I->second;
427*9880d681SAndroid Build Coastguard Worker }
428*9880d681SAndroid Build Coastguard Worker 
LookupSubCommand(const char * Name)429*9880d681SAndroid Build Coastguard Worker SubCommand *CommandLineParser::LookupSubCommand(const char *Name) {
430*9880d681SAndroid Build Coastguard Worker   if (Name == nullptr)
431*9880d681SAndroid Build Coastguard Worker     return &*TopLevelSubCommand;
432*9880d681SAndroid Build Coastguard Worker   for (auto S : RegisteredSubCommands) {
433*9880d681SAndroid Build Coastguard Worker     if (S == &*AllSubCommands)
434*9880d681SAndroid Build Coastguard Worker       continue;
435*9880d681SAndroid Build Coastguard Worker     if (S->getName() == nullptr)
436*9880d681SAndroid Build Coastguard Worker       continue;
437*9880d681SAndroid Build Coastguard Worker 
438*9880d681SAndroid Build Coastguard Worker     if (StringRef(S->getName()) == StringRef(Name))
439*9880d681SAndroid Build Coastguard Worker       return S;
440*9880d681SAndroid Build Coastguard Worker   }
441*9880d681SAndroid Build Coastguard Worker   return &*TopLevelSubCommand;
442*9880d681SAndroid Build Coastguard Worker }
443*9880d681SAndroid Build Coastguard Worker 
444*9880d681SAndroid Build Coastguard Worker /// LookupNearestOption - Lookup the closest match to the option specified by
445*9880d681SAndroid Build Coastguard Worker /// the specified option on the command line.  If there is a value specified
446*9880d681SAndroid Build Coastguard Worker /// (after an equal sign) return that as well.  This assumes that leading dashes
447*9880d681SAndroid Build Coastguard Worker /// have already been stripped.
LookupNearestOption(StringRef Arg,const StringMap<Option * > & OptionsMap,std::string & NearestString)448*9880d681SAndroid Build Coastguard Worker static Option *LookupNearestOption(StringRef Arg,
449*9880d681SAndroid Build Coastguard Worker                                    const StringMap<Option *> &OptionsMap,
450*9880d681SAndroid Build Coastguard Worker                                    std::string &NearestString) {
451*9880d681SAndroid Build Coastguard Worker   // Reject all dashes.
452*9880d681SAndroid Build Coastguard Worker   if (Arg.empty())
453*9880d681SAndroid Build Coastguard Worker     return nullptr;
454*9880d681SAndroid Build Coastguard Worker 
455*9880d681SAndroid Build Coastguard Worker   // Split on any equal sign.
456*9880d681SAndroid Build Coastguard Worker   std::pair<StringRef, StringRef> SplitArg = Arg.split('=');
457*9880d681SAndroid Build Coastguard Worker   StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present.
458*9880d681SAndroid Build Coastguard Worker   StringRef &RHS = SplitArg.second;
459*9880d681SAndroid Build Coastguard Worker 
460*9880d681SAndroid Build Coastguard Worker   // Find the closest match.
461*9880d681SAndroid Build Coastguard Worker   Option *Best = nullptr;
462*9880d681SAndroid Build Coastguard Worker   unsigned BestDistance = 0;
463*9880d681SAndroid Build Coastguard Worker   for (StringMap<Option *>::const_iterator it = OptionsMap.begin(),
464*9880d681SAndroid Build Coastguard Worker                                            ie = OptionsMap.end();
465*9880d681SAndroid Build Coastguard Worker        it != ie; ++it) {
466*9880d681SAndroid Build Coastguard Worker     Option *O = it->second;
467*9880d681SAndroid Build Coastguard Worker     SmallVector<StringRef, 16> OptionNames;
468*9880d681SAndroid Build Coastguard Worker     O->getExtraOptionNames(OptionNames);
469*9880d681SAndroid Build Coastguard Worker     if (O->hasArgStr())
470*9880d681SAndroid Build Coastguard Worker       OptionNames.push_back(O->ArgStr);
471*9880d681SAndroid Build Coastguard Worker 
472*9880d681SAndroid Build Coastguard Worker     bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed;
473*9880d681SAndroid Build Coastguard Worker     StringRef Flag = PermitValue ? LHS : Arg;
474*9880d681SAndroid Build Coastguard Worker     for (auto Name : OptionNames) {
475*9880d681SAndroid Build Coastguard Worker       unsigned Distance = StringRef(Name).edit_distance(
476*9880d681SAndroid Build Coastguard Worker           Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
477*9880d681SAndroid Build Coastguard Worker       if (!Best || Distance < BestDistance) {
478*9880d681SAndroid Build Coastguard Worker         Best = O;
479*9880d681SAndroid Build Coastguard Worker         BestDistance = Distance;
480*9880d681SAndroid Build Coastguard Worker         if (RHS.empty() || !PermitValue)
481*9880d681SAndroid Build Coastguard Worker           NearestString = Name;
482*9880d681SAndroid Build Coastguard Worker         else
483*9880d681SAndroid Build Coastguard Worker           NearestString = (Twine(Name) + "=" + RHS).str();
484*9880d681SAndroid Build Coastguard Worker       }
485*9880d681SAndroid Build Coastguard Worker     }
486*9880d681SAndroid Build Coastguard Worker   }
487*9880d681SAndroid Build Coastguard Worker 
488*9880d681SAndroid Build Coastguard Worker   return Best;
489*9880d681SAndroid Build Coastguard Worker }
490*9880d681SAndroid Build Coastguard Worker 
491*9880d681SAndroid Build Coastguard Worker /// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence()
492*9880d681SAndroid Build Coastguard Worker /// that does special handling of cl::CommaSeparated options.
CommaSeparateAndAddOccurrence(Option * Handler,unsigned pos,StringRef ArgName,StringRef Value,bool MultiArg=false)493*9880d681SAndroid Build Coastguard Worker static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos,
494*9880d681SAndroid Build Coastguard Worker                                           StringRef ArgName, StringRef Value,
495*9880d681SAndroid Build Coastguard Worker                                           bool MultiArg = false) {
496*9880d681SAndroid Build Coastguard Worker   // Check to see if this option accepts a comma separated list of values.  If
497*9880d681SAndroid Build Coastguard Worker   // it does, we have to split up the value into multiple values.
498*9880d681SAndroid Build Coastguard Worker   if (Handler->getMiscFlags() & CommaSeparated) {
499*9880d681SAndroid Build Coastguard Worker     StringRef Val(Value);
500*9880d681SAndroid Build Coastguard Worker     StringRef::size_type Pos = Val.find(',');
501*9880d681SAndroid Build Coastguard Worker 
502*9880d681SAndroid Build Coastguard Worker     while (Pos != StringRef::npos) {
503*9880d681SAndroid Build Coastguard Worker       // Process the portion before the comma.
504*9880d681SAndroid Build Coastguard Worker       if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
505*9880d681SAndroid Build Coastguard Worker         return true;
506*9880d681SAndroid Build Coastguard Worker       // Erase the portion before the comma, AND the comma.
507*9880d681SAndroid Build Coastguard Worker       Val = Val.substr(Pos + 1);
508*9880d681SAndroid Build Coastguard Worker       Value.substr(Pos + 1); // Increment the original value pointer as well.
509*9880d681SAndroid Build Coastguard Worker       // Check for another comma.
510*9880d681SAndroid Build Coastguard Worker       Pos = Val.find(',');
511*9880d681SAndroid Build Coastguard Worker     }
512*9880d681SAndroid Build Coastguard Worker 
513*9880d681SAndroid Build Coastguard Worker     Value = Val;
514*9880d681SAndroid Build Coastguard Worker   }
515*9880d681SAndroid Build Coastguard Worker 
516*9880d681SAndroid Build Coastguard Worker   return Handler->addOccurrence(pos, ArgName, Value, MultiArg);
517*9880d681SAndroid Build Coastguard Worker }
518*9880d681SAndroid Build Coastguard Worker 
519*9880d681SAndroid Build Coastguard Worker /// ProvideOption - For Value, this differentiates between an empty value ("")
520*9880d681SAndroid Build Coastguard Worker /// and a null value (StringRef()).  The later is accepted for arguments that
521*9880d681SAndroid Build Coastguard Worker /// don't allow a value (-foo) the former is rejected (-foo=).
ProvideOption(Option * Handler,StringRef ArgName,StringRef Value,int argc,const char * const * argv,int & i)522*9880d681SAndroid Build Coastguard Worker static inline bool ProvideOption(Option *Handler, StringRef ArgName,
523*9880d681SAndroid Build Coastguard Worker                                  StringRef Value, int argc,
524*9880d681SAndroid Build Coastguard Worker                                  const char *const *argv, int &i) {
525*9880d681SAndroid Build Coastguard Worker   // Is this a multi-argument option?
526*9880d681SAndroid Build Coastguard Worker   unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
527*9880d681SAndroid Build Coastguard Worker 
528*9880d681SAndroid Build Coastguard Worker   // Enforce value requirements
529*9880d681SAndroid Build Coastguard Worker   switch (Handler->getValueExpectedFlag()) {
530*9880d681SAndroid Build Coastguard Worker   case ValueRequired:
531*9880d681SAndroid Build Coastguard Worker     if (!Value.data()) { // No value specified?
532*9880d681SAndroid Build Coastguard Worker       if (i + 1 >= argc)
533*9880d681SAndroid Build Coastguard Worker         return Handler->error("requires a value!");
534*9880d681SAndroid Build Coastguard Worker       // Steal the next argument, like for '-o filename'
535*9880d681SAndroid Build Coastguard Worker       assert(argv && "null check");
536*9880d681SAndroid Build Coastguard Worker       Value = argv[++i];
537*9880d681SAndroid Build Coastguard Worker     }
538*9880d681SAndroid Build Coastguard Worker     break;
539*9880d681SAndroid Build Coastguard Worker   case ValueDisallowed:
540*9880d681SAndroid Build Coastguard Worker     if (NumAdditionalVals > 0)
541*9880d681SAndroid Build Coastguard Worker       return Handler->error("multi-valued option specified"
542*9880d681SAndroid Build Coastguard Worker                             " with ValueDisallowed modifier!");
543*9880d681SAndroid Build Coastguard Worker 
544*9880d681SAndroid Build Coastguard Worker     if (Value.data())
545*9880d681SAndroid Build Coastguard Worker       return Handler->error("does not allow a value! '" + Twine(Value) +
546*9880d681SAndroid Build Coastguard Worker                             "' specified.");
547*9880d681SAndroid Build Coastguard Worker     break;
548*9880d681SAndroid Build Coastguard Worker   case ValueOptional:
549*9880d681SAndroid Build Coastguard Worker     break;
550*9880d681SAndroid Build Coastguard Worker   }
551*9880d681SAndroid Build Coastguard Worker 
552*9880d681SAndroid Build Coastguard Worker   // If this isn't a multi-arg option, just run the handler.
553*9880d681SAndroid Build Coastguard Worker   if (NumAdditionalVals == 0)
554*9880d681SAndroid Build Coastguard Worker     return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value);
555*9880d681SAndroid Build Coastguard Worker 
556*9880d681SAndroid Build Coastguard Worker   // If it is, run the handle several times.
557*9880d681SAndroid Build Coastguard Worker   bool MultiArg = false;
558*9880d681SAndroid Build Coastguard Worker 
559*9880d681SAndroid Build Coastguard Worker   if (Value.data()) {
560*9880d681SAndroid Build Coastguard Worker     if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
561*9880d681SAndroid Build Coastguard Worker       return true;
562*9880d681SAndroid Build Coastguard Worker     --NumAdditionalVals;
563*9880d681SAndroid Build Coastguard Worker     MultiArg = true;
564*9880d681SAndroid Build Coastguard Worker   }
565*9880d681SAndroid Build Coastguard Worker 
566*9880d681SAndroid Build Coastguard Worker   while (NumAdditionalVals > 0) {
567*9880d681SAndroid Build Coastguard Worker     if (i + 1 >= argc)
568*9880d681SAndroid Build Coastguard Worker       return Handler->error("not enough values!");
569*9880d681SAndroid Build Coastguard Worker     assert(argv && "null check");
570*9880d681SAndroid Build Coastguard Worker     Value = argv[++i];
571*9880d681SAndroid Build Coastguard Worker 
572*9880d681SAndroid Build Coastguard Worker     if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg))
573*9880d681SAndroid Build Coastguard Worker       return true;
574*9880d681SAndroid Build Coastguard Worker     MultiArg = true;
575*9880d681SAndroid Build Coastguard Worker     --NumAdditionalVals;
576*9880d681SAndroid Build Coastguard Worker   }
577*9880d681SAndroid Build Coastguard Worker   return false;
578*9880d681SAndroid Build Coastguard Worker }
579*9880d681SAndroid Build Coastguard Worker 
ProvidePositionalOption(Option * Handler,StringRef Arg,int i)580*9880d681SAndroid Build Coastguard Worker static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
581*9880d681SAndroid Build Coastguard Worker   int Dummy = i;
582*9880d681SAndroid Build Coastguard Worker   return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy);
583*9880d681SAndroid Build Coastguard Worker }
584*9880d681SAndroid Build Coastguard Worker 
585*9880d681SAndroid Build Coastguard Worker // Option predicates...
isGrouping(const Option * O)586*9880d681SAndroid Build Coastguard Worker static inline bool isGrouping(const Option *O) {
587*9880d681SAndroid Build Coastguard Worker   return O->getFormattingFlag() == cl::Grouping;
588*9880d681SAndroid Build Coastguard Worker }
isPrefixedOrGrouping(const Option * O)589*9880d681SAndroid Build Coastguard Worker static inline bool isPrefixedOrGrouping(const Option *O) {
590*9880d681SAndroid Build Coastguard Worker   return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
591*9880d681SAndroid Build Coastguard Worker }
592*9880d681SAndroid Build Coastguard Worker 
593*9880d681SAndroid Build Coastguard Worker // getOptionPred - Check to see if there are any options that satisfy the
594*9880d681SAndroid Build Coastguard Worker // specified predicate with names that are the prefixes in Name.  This is
595*9880d681SAndroid Build Coastguard Worker // checked by progressively stripping characters off of the name, checking to
596*9880d681SAndroid Build Coastguard Worker // see if there options that satisfy the predicate.  If we find one, return it,
597*9880d681SAndroid Build Coastguard Worker // otherwise return null.
598*9880d681SAndroid Build Coastguard Worker //
getOptionPred(StringRef Name,size_t & Length,bool (* Pred)(const Option *),const StringMap<Option * > & OptionsMap)599*9880d681SAndroid Build Coastguard Worker static Option *getOptionPred(StringRef Name, size_t &Length,
600*9880d681SAndroid Build Coastguard Worker                              bool (*Pred)(const Option *),
601*9880d681SAndroid Build Coastguard Worker                              const StringMap<Option *> &OptionsMap) {
602*9880d681SAndroid Build Coastguard Worker 
603*9880d681SAndroid Build Coastguard Worker   StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name);
604*9880d681SAndroid Build Coastguard Worker 
605*9880d681SAndroid Build Coastguard Worker   // Loop while we haven't found an option and Name still has at least two
606*9880d681SAndroid Build Coastguard Worker   // characters in it (so that the next iteration will not be the empty
607*9880d681SAndroid Build Coastguard Worker   // string.
608*9880d681SAndroid Build Coastguard Worker   while (OMI == OptionsMap.end() && Name.size() > 1) {
609*9880d681SAndroid Build Coastguard Worker     Name = Name.substr(0, Name.size() - 1); // Chop off the last character.
610*9880d681SAndroid Build Coastguard Worker     OMI = OptionsMap.find(Name);
611*9880d681SAndroid Build Coastguard Worker   }
612*9880d681SAndroid Build Coastguard Worker 
613*9880d681SAndroid Build Coastguard Worker   if (OMI != OptionsMap.end() && Pred(OMI->second)) {
614*9880d681SAndroid Build Coastguard Worker     Length = Name.size();
615*9880d681SAndroid Build Coastguard Worker     return OMI->second; // Found one!
616*9880d681SAndroid Build Coastguard Worker   }
617*9880d681SAndroid Build Coastguard Worker   return nullptr; // No option found!
618*9880d681SAndroid Build Coastguard Worker }
619*9880d681SAndroid Build Coastguard Worker 
620*9880d681SAndroid Build Coastguard Worker /// HandlePrefixedOrGroupedOption - The specified argument string (which started
621*9880d681SAndroid Build Coastguard Worker /// with at least one '-') does not fully match an available option.  Check to
622*9880d681SAndroid Build Coastguard Worker /// see if this is a prefix or grouped option.  If so, split arg into output an
623*9880d681SAndroid Build Coastguard Worker /// Arg/Value pair and return the Option to parse it with.
624*9880d681SAndroid Build Coastguard Worker static Option *
HandlePrefixedOrGroupedOption(StringRef & Arg,StringRef & Value,bool & ErrorParsing,const StringMap<Option * > & OptionsMap)625*9880d681SAndroid Build Coastguard Worker HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
626*9880d681SAndroid Build Coastguard Worker                               bool &ErrorParsing,
627*9880d681SAndroid Build Coastguard Worker                               const StringMap<Option *> &OptionsMap) {
628*9880d681SAndroid Build Coastguard Worker   if (Arg.size() == 1)
629*9880d681SAndroid Build Coastguard Worker     return nullptr;
630*9880d681SAndroid Build Coastguard Worker 
631*9880d681SAndroid Build Coastguard Worker   // Do the lookup!
632*9880d681SAndroid Build Coastguard Worker   size_t Length = 0;
633*9880d681SAndroid Build Coastguard Worker   Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
634*9880d681SAndroid Build Coastguard Worker   if (!PGOpt)
635*9880d681SAndroid Build Coastguard Worker     return nullptr;
636*9880d681SAndroid Build Coastguard Worker 
637*9880d681SAndroid Build Coastguard Worker   // If the option is a prefixed option, then the value is simply the
638*9880d681SAndroid Build Coastguard Worker   // rest of the name...  so fall through to later processing, by
639*9880d681SAndroid Build Coastguard Worker   // setting up the argument name flags and value fields.
640*9880d681SAndroid Build Coastguard Worker   if (PGOpt->getFormattingFlag() == cl::Prefix) {
641*9880d681SAndroid Build Coastguard Worker     Value = Arg.substr(Length);
642*9880d681SAndroid Build Coastguard Worker     Arg = Arg.substr(0, Length);
643*9880d681SAndroid Build Coastguard Worker     assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
644*9880d681SAndroid Build Coastguard Worker     return PGOpt;
645*9880d681SAndroid Build Coastguard Worker   }
646*9880d681SAndroid Build Coastguard Worker 
647*9880d681SAndroid Build Coastguard Worker   // This must be a grouped option... handle them now.  Grouping options can't
648*9880d681SAndroid Build Coastguard Worker   // have values.
649*9880d681SAndroid Build Coastguard Worker   assert(isGrouping(PGOpt) && "Broken getOptionPred!");
650*9880d681SAndroid Build Coastguard Worker 
651*9880d681SAndroid Build Coastguard Worker   do {
652*9880d681SAndroid Build Coastguard Worker     // Move current arg name out of Arg into OneArgName.
653*9880d681SAndroid Build Coastguard Worker     StringRef OneArgName = Arg.substr(0, Length);
654*9880d681SAndroid Build Coastguard Worker     Arg = Arg.substr(Length);
655*9880d681SAndroid Build Coastguard Worker 
656*9880d681SAndroid Build Coastguard Worker     // Because ValueRequired is an invalid flag for grouped arguments,
657*9880d681SAndroid Build Coastguard Worker     // we don't need to pass argc/argv in.
658*9880d681SAndroid Build Coastguard Worker     assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
659*9880d681SAndroid Build Coastguard Worker            "Option can not be cl::Grouping AND cl::ValueRequired!");
660*9880d681SAndroid Build Coastguard Worker     int Dummy = 0;
661*9880d681SAndroid Build Coastguard Worker     ErrorParsing |=
662*9880d681SAndroid Build Coastguard Worker         ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy);
663*9880d681SAndroid Build Coastguard Worker 
664*9880d681SAndroid Build Coastguard Worker     // Get the next grouping option.
665*9880d681SAndroid Build Coastguard Worker     PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
666*9880d681SAndroid Build Coastguard Worker   } while (PGOpt && Length != Arg.size());
667*9880d681SAndroid Build Coastguard Worker 
668*9880d681SAndroid Build Coastguard Worker   // Return the last option with Arg cut down to just the last one.
669*9880d681SAndroid Build Coastguard Worker   return PGOpt;
670*9880d681SAndroid Build Coastguard Worker }
671*9880d681SAndroid Build Coastguard Worker 
RequiresValue(const Option * O)672*9880d681SAndroid Build Coastguard Worker static bool RequiresValue(const Option *O) {
673*9880d681SAndroid Build Coastguard Worker   return O->getNumOccurrencesFlag() == cl::Required ||
674*9880d681SAndroid Build Coastguard Worker          O->getNumOccurrencesFlag() == cl::OneOrMore;
675*9880d681SAndroid Build Coastguard Worker }
676*9880d681SAndroid Build Coastguard Worker 
EatsUnboundedNumberOfValues(const Option * O)677*9880d681SAndroid Build Coastguard Worker static bool EatsUnboundedNumberOfValues(const Option *O) {
678*9880d681SAndroid Build Coastguard Worker   return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
679*9880d681SAndroid Build Coastguard Worker          O->getNumOccurrencesFlag() == cl::OneOrMore;
680*9880d681SAndroid Build Coastguard Worker }
681*9880d681SAndroid Build Coastguard Worker 
isWhitespace(char C)682*9880d681SAndroid Build Coastguard Worker static bool isWhitespace(char C) { return strchr(" \t\n\r\f\v", C); }
683*9880d681SAndroid Build Coastguard Worker 
isQuote(char C)684*9880d681SAndroid Build Coastguard Worker static bool isQuote(char C) { return C == '\"' || C == '\''; }
685*9880d681SAndroid Build Coastguard Worker 
TokenizeGNUCommandLine(StringRef Src,StringSaver & Saver,SmallVectorImpl<const char * > & NewArgv,bool MarkEOLs)686*9880d681SAndroid Build Coastguard Worker void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver,
687*9880d681SAndroid Build Coastguard Worker                                 SmallVectorImpl<const char *> &NewArgv,
688*9880d681SAndroid Build Coastguard Worker                                 bool MarkEOLs) {
689*9880d681SAndroid Build Coastguard Worker   SmallString<128> Token;
690*9880d681SAndroid Build Coastguard Worker   for (size_t I = 0, E = Src.size(); I != E; ++I) {
691*9880d681SAndroid Build Coastguard Worker     // Consume runs of whitespace.
692*9880d681SAndroid Build Coastguard Worker     if (Token.empty()) {
693*9880d681SAndroid Build Coastguard Worker       while (I != E && isWhitespace(Src[I])) {
694*9880d681SAndroid Build Coastguard Worker         // Mark the end of lines in response files
695*9880d681SAndroid Build Coastguard Worker         if (MarkEOLs && Src[I] == '\n')
696*9880d681SAndroid Build Coastguard Worker           NewArgv.push_back(nullptr);
697*9880d681SAndroid Build Coastguard Worker         ++I;
698*9880d681SAndroid Build Coastguard Worker       }
699*9880d681SAndroid Build Coastguard Worker       if (I == E)
700*9880d681SAndroid Build Coastguard Worker         break;
701*9880d681SAndroid Build Coastguard Worker     }
702*9880d681SAndroid Build Coastguard Worker 
703*9880d681SAndroid Build Coastguard Worker     // Backslash escapes the next character.
704*9880d681SAndroid Build Coastguard Worker     if (I + 1 < E && Src[I] == '\\') {
705*9880d681SAndroid Build Coastguard Worker       ++I; // Skip the escape.
706*9880d681SAndroid Build Coastguard Worker       Token.push_back(Src[I]);
707*9880d681SAndroid Build Coastguard Worker       continue;
708*9880d681SAndroid Build Coastguard Worker     }
709*9880d681SAndroid Build Coastguard Worker 
710*9880d681SAndroid Build Coastguard Worker     // Consume a quoted string.
711*9880d681SAndroid Build Coastguard Worker     if (isQuote(Src[I])) {
712*9880d681SAndroid Build Coastguard Worker       char Quote = Src[I++];
713*9880d681SAndroid Build Coastguard Worker       while (I != E && Src[I] != Quote) {
714*9880d681SAndroid Build Coastguard Worker         // Backslash escapes the next character.
715*9880d681SAndroid Build Coastguard Worker         if (Src[I] == '\\' && I + 1 != E)
716*9880d681SAndroid Build Coastguard Worker           ++I;
717*9880d681SAndroid Build Coastguard Worker         Token.push_back(Src[I]);
718*9880d681SAndroid Build Coastguard Worker         ++I;
719*9880d681SAndroid Build Coastguard Worker       }
720*9880d681SAndroid Build Coastguard Worker       if (I == E)
721*9880d681SAndroid Build Coastguard Worker         break;
722*9880d681SAndroid Build Coastguard Worker       continue;
723*9880d681SAndroid Build Coastguard Worker     }
724*9880d681SAndroid Build Coastguard Worker 
725*9880d681SAndroid Build Coastguard Worker     // End the token if this is whitespace.
726*9880d681SAndroid Build Coastguard Worker     if (isWhitespace(Src[I])) {
727*9880d681SAndroid Build Coastguard Worker       if (!Token.empty())
728*9880d681SAndroid Build Coastguard Worker         NewArgv.push_back(Saver.save(Token.c_str()));
729*9880d681SAndroid Build Coastguard Worker       Token.clear();
730*9880d681SAndroid Build Coastguard Worker       continue;
731*9880d681SAndroid Build Coastguard Worker     }
732*9880d681SAndroid Build Coastguard Worker 
733*9880d681SAndroid Build Coastguard Worker     // This is a normal character.  Append it.
734*9880d681SAndroid Build Coastguard Worker     Token.push_back(Src[I]);
735*9880d681SAndroid Build Coastguard Worker   }
736*9880d681SAndroid Build Coastguard Worker 
737*9880d681SAndroid Build Coastguard Worker   // Append the last token after hitting EOF with no whitespace.
738*9880d681SAndroid Build Coastguard Worker   if (!Token.empty())
739*9880d681SAndroid Build Coastguard Worker     NewArgv.push_back(Saver.save(Token.c_str()));
740*9880d681SAndroid Build Coastguard Worker   // Mark the end of response files
741*9880d681SAndroid Build Coastguard Worker   if (MarkEOLs)
742*9880d681SAndroid Build Coastguard Worker     NewArgv.push_back(nullptr);
743*9880d681SAndroid Build Coastguard Worker }
744*9880d681SAndroid Build Coastguard Worker 
745*9880d681SAndroid Build Coastguard Worker /// Backslashes are interpreted in a rather complicated way in the Windows-style
746*9880d681SAndroid Build Coastguard Worker /// command line, because backslashes are used both to separate path and to
747*9880d681SAndroid Build Coastguard Worker /// escape double quote. This method consumes runs of backslashes as well as the
748*9880d681SAndroid Build Coastguard Worker /// following double quote if it's escaped.
749*9880d681SAndroid Build Coastguard Worker ///
750*9880d681SAndroid Build Coastguard Worker ///  * If an even number of backslashes is followed by a double quote, one
751*9880d681SAndroid Build Coastguard Worker ///    backslash is output for every pair of backslashes, and the last double
752*9880d681SAndroid Build Coastguard Worker ///    quote remains unconsumed. The double quote will later be interpreted as
753*9880d681SAndroid Build Coastguard Worker ///    the start or end of a quoted string in the main loop outside of this
754*9880d681SAndroid Build Coastguard Worker ///    function.
755*9880d681SAndroid Build Coastguard Worker ///
756*9880d681SAndroid Build Coastguard Worker ///  * If an odd number of backslashes is followed by a double quote, one
757*9880d681SAndroid Build Coastguard Worker ///    backslash is output for every pair of backslashes, and a double quote is
758*9880d681SAndroid Build Coastguard Worker ///    output for the last pair of backslash-double quote. The double quote is
759*9880d681SAndroid Build Coastguard Worker ///    consumed in this case.
760*9880d681SAndroid Build Coastguard Worker ///
761*9880d681SAndroid Build Coastguard Worker ///  * Otherwise, backslashes are interpreted literally.
parseBackslash(StringRef Src,size_t I,SmallString<128> & Token)762*9880d681SAndroid Build Coastguard Worker static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) {
763*9880d681SAndroid Build Coastguard Worker   size_t E = Src.size();
764*9880d681SAndroid Build Coastguard Worker   int BackslashCount = 0;
765*9880d681SAndroid Build Coastguard Worker   // Skip the backslashes.
766*9880d681SAndroid Build Coastguard Worker   do {
767*9880d681SAndroid Build Coastguard Worker     ++I;
768*9880d681SAndroid Build Coastguard Worker     ++BackslashCount;
769*9880d681SAndroid Build Coastguard Worker   } while (I != E && Src[I] == '\\');
770*9880d681SAndroid Build Coastguard Worker 
771*9880d681SAndroid Build Coastguard Worker   bool FollowedByDoubleQuote = (I != E && Src[I] == '"');
772*9880d681SAndroid Build Coastguard Worker   if (FollowedByDoubleQuote) {
773*9880d681SAndroid Build Coastguard Worker     Token.append(BackslashCount / 2, '\\');
774*9880d681SAndroid Build Coastguard Worker     if (BackslashCount % 2 == 0)
775*9880d681SAndroid Build Coastguard Worker       return I - 1;
776*9880d681SAndroid Build Coastguard Worker     Token.push_back('"');
777*9880d681SAndroid Build Coastguard Worker     return I;
778*9880d681SAndroid Build Coastguard Worker   }
779*9880d681SAndroid Build Coastguard Worker   Token.append(BackslashCount, '\\');
780*9880d681SAndroid Build Coastguard Worker   return I - 1;
781*9880d681SAndroid Build Coastguard Worker }
782*9880d681SAndroid Build Coastguard Worker 
TokenizeWindowsCommandLine(StringRef Src,StringSaver & Saver,SmallVectorImpl<const char * > & NewArgv,bool MarkEOLs)783*9880d681SAndroid Build Coastguard Worker void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver,
784*9880d681SAndroid Build Coastguard Worker                                     SmallVectorImpl<const char *> &NewArgv,
785*9880d681SAndroid Build Coastguard Worker                                     bool MarkEOLs) {
786*9880d681SAndroid Build Coastguard Worker   SmallString<128> Token;
787*9880d681SAndroid Build Coastguard Worker 
788*9880d681SAndroid Build Coastguard Worker   // This is a small state machine to consume characters until it reaches the
789*9880d681SAndroid Build Coastguard Worker   // end of the source string.
790*9880d681SAndroid Build Coastguard Worker   enum { INIT, UNQUOTED, QUOTED } State = INIT;
791*9880d681SAndroid Build Coastguard Worker   for (size_t I = 0, E = Src.size(); I != E; ++I) {
792*9880d681SAndroid Build Coastguard Worker     // INIT state indicates that the current input index is at the start of
793*9880d681SAndroid Build Coastguard Worker     // the string or between tokens.
794*9880d681SAndroid Build Coastguard Worker     if (State == INIT) {
795*9880d681SAndroid Build Coastguard Worker       if (isWhitespace(Src[I])) {
796*9880d681SAndroid Build Coastguard Worker         // Mark the end of lines in response files
797*9880d681SAndroid Build Coastguard Worker         if (MarkEOLs && Src[I] == '\n')
798*9880d681SAndroid Build Coastguard Worker           NewArgv.push_back(nullptr);
799*9880d681SAndroid Build Coastguard Worker         continue;
800*9880d681SAndroid Build Coastguard Worker       }
801*9880d681SAndroid Build Coastguard Worker       if (Src[I] == '"') {
802*9880d681SAndroid Build Coastguard Worker         State = QUOTED;
803*9880d681SAndroid Build Coastguard Worker         continue;
804*9880d681SAndroid Build Coastguard Worker       }
805*9880d681SAndroid Build Coastguard Worker       if (Src[I] == '\\') {
806*9880d681SAndroid Build Coastguard Worker         I = parseBackslash(Src, I, Token);
807*9880d681SAndroid Build Coastguard Worker         State = UNQUOTED;
808*9880d681SAndroid Build Coastguard Worker         continue;
809*9880d681SAndroid Build Coastguard Worker       }
810*9880d681SAndroid Build Coastguard Worker       Token.push_back(Src[I]);
811*9880d681SAndroid Build Coastguard Worker       State = UNQUOTED;
812*9880d681SAndroid Build Coastguard Worker       continue;
813*9880d681SAndroid Build Coastguard Worker     }
814*9880d681SAndroid Build Coastguard Worker 
815*9880d681SAndroid Build Coastguard Worker     // UNQUOTED state means that it's reading a token not quoted by double
816*9880d681SAndroid Build Coastguard Worker     // quotes.
817*9880d681SAndroid Build Coastguard Worker     if (State == UNQUOTED) {
818*9880d681SAndroid Build Coastguard Worker       // Whitespace means the end of the token.
819*9880d681SAndroid Build Coastguard Worker       if (isWhitespace(Src[I])) {
820*9880d681SAndroid Build Coastguard Worker         NewArgv.push_back(Saver.save(Token.c_str()));
821*9880d681SAndroid Build Coastguard Worker         Token.clear();
822*9880d681SAndroid Build Coastguard Worker         State = INIT;
823*9880d681SAndroid Build Coastguard Worker         // Mark the end of lines in response files
824*9880d681SAndroid Build Coastguard Worker         if (MarkEOLs && Src[I] == '\n')
825*9880d681SAndroid Build Coastguard Worker           NewArgv.push_back(nullptr);
826*9880d681SAndroid Build Coastguard Worker         continue;
827*9880d681SAndroid Build Coastguard Worker       }
828*9880d681SAndroid Build Coastguard Worker       if (Src[I] == '"') {
829*9880d681SAndroid Build Coastguard Worker         State = QUOTED;
830*9880d681SAndroid Build Coastguard Worker         continue;
831*9880d681SAndroid Build Coastguard Worker       }
832*9880d681SAndroid Build Coastguard Worker       if (Src[I] == '\\') {
833*9880d681SAndroid Build Coastguard Worker         I = parseBackslash(Src, I, Token);
834*9880d681SAndroid Build Coastguard Worker         continue;
835*9880d681SAndroid Build Coastguard Worker       }
836*9880d681SAndroid Build Coastguard Worker       Token.push_back(Src[I]);
837*9880d681SAndroid Build Coastguard Worker       continue;
838*9880d681SAndroid Build Coastguard Worker     }
839*9880d681SAndroid Build Coastguard Worker 
840*9880d681SAndroid Build Coastguard Worker     // QUOTED state means that it's reading a token quoted by double quotes.
841*9880d681SAndroid Build Coastguard Worker     if (State == QUOTED) {
842*9880d681SAndroid Build Coastguard Worker       if (Src[I] == '"') {
843*9880d681SAndroid Build Coastguard Worker         State = UNQUOTED;
844*9880d681SAndroid Build Coastguard Worker         continue;
845*9880d681SAndroid Build Coastguard Worker       }
846*9880d681SAndroid Build Coastguard Worker       if (Src[I] == '\\') {
847*9880d681SAndroid Build Coastguard Worker         I = parseBackslash(Src, I, Token);
848*9880d681SAndroid Build Coastguard Worker         continue;
849*9880d681SAndroid Build Coastguard Worker       }
850*9880d681SAndroid Build Coastguard Worker       Token.push_back(Src[I]);
851*9880d681SAndroid Build Coastguard Worker     }
852*9880d681SAndroid Build Coastguard Worker   }
853*9880d681SAndroid Build Coastguard Worker   // Append the last token after hitting EOF with no whitespace.
854*9880d681SAndroid Build Coastguard Worker   if (!Token.empty())
855*9880d681SAndroid Build Coastguard Worker     NewArgv.push_back(Saver.save(Token.c_str()));
856*9880d681SAndroid Build Coastguard Worker   // Mark the end of response files
857*9880d681SAndroid Build Coastguard Worker   if (MarkEOLs)
858*9880d681SAndroid Build Coastguard Worker     NewArgv.push_back(nullptr);
859*9880d681SAndroid Build Coastguard Worker }
860*9880d681SAndroid Build Coastguard Worker 
861*9880d681SAndroid Build Coastguard Worker // It is called byte order marker but the UTF-8 BOM is actually not affected
862*9880d681SAndroid Build Coastguard Worker // by the host system's endianness.
hasUTF8ByteOrderMark(ArrayRef<char> S)863*9880d681SAndroid Build Coastguard Worker static bool hasUTF8ByteOrderMark(ArrayRef<char> S) {
864*9880d681SAndroid Build Coastguard Worker   return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf');
865*9880d681SAndroid Build Coastguard Worker }
866*9880d681SAndroid Build Coastguard Worker 
ExpandResponseFile(const char * FName,StringSaver & Saver,TokenizerCallback Tokenizer,SmallVectorImpl<const char * > & NewArgv,bool MarkEOLs=false)867*9880d681SAndroid Build Coastguard Worker static bool ExpandResponseFile(const char *FName, StringSaver &Saver,
868*9880d681SAndroid Build Coastguard Worker                                TokenizerCallback Tokenizer,
869*9880d681SAndroid Build Coastguard Worker                                SmallVectorImpl<const char *> &NewArgv,
870*9880d681SAndroid Build Coastguard Worker                                bool MarkEOLs = false) {
871*9880d681SAndroid Build Coastguard Worker   ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
872*9880d681SAndroid Build Coastguard Worker       MemoryBuffer::getFile(FName);
873*9880d681SAndroid Build Coastguard Worker   if (!MemBufOrErr)
874*9880d681SAndroid Build Coastguard Worker     return false;
875*9880d681SAndroid Build Coastguard Worker   MemoryBuffer &MemBuf = *MemBufOrErr.get();
876*9880d681SAndroid Build Coastguard Worker   StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize());
877*9880d681SAndroid Build Coastguard Worker 
878*9880d681SAndroid Build Coastguard Worker   // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing.
879*9880d681SAndroid Build Coastguard Worker   ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd());
880*9880d681SAndroid Build Coastguard Worker   std::string UTF8Buf;
881*9880d681SAndroid Build Coastguard Worker   if (hasUTF16ByteOrderMark(BufRef)) {
882*9880d681SAndroid Build Coastguard Worker     if (!convertUTF16ToUTF8String(BufRef, UTF8Buf))
883*9880d681SAndroid Build Coastguard Worker       return false;
884*9880d681SAndroid Build Coastguard Worker     Str = StringRef(UTF8Buf);
885*9880d681SAndroid Build Coastguard Worker   }
886*9880d681SAndroid Build Coastguard Worker   // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove
887*9880d681SAndroid Build Coastguard Worker   // these bytes before parsing.
888*9880d681SAndroid Build Coastguard Worker   // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark
889*9880d681SAndroid Build Coastguard Worker   else if (hasUTF8ByteOrderMark(BufRef))
890*9880d681SAndroid Build Coastguard Worker     Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
891*9880d681SAndroid Build Coastguard Worker 
892*9880d681SAndroid Build Coastguard Worker   // Tokenize the contents into NewArgv.
893*9880d681SAndroid Build Coastguard Worker   Tokenizer(Str, Saver, NewArgv, MarkEOLs);
894*9880d681SAndroid Build Coastguard Worker 
895*9880d681SAndroid Build Coastguard Worker   return true;
896*9880d681SAndroid Build Coastguard Worker }
897*9880d681SAndroid Build Coastguard Worker 
898*9880d681SAndroid Build Coastguard Worker /// \brief Expand response files on a command line recursively using the given
899*9880d681SAndroid Build Coastguard Worker /// StringSaver and tokenization strategy.
ExpandResponseFiles(StringSaver & Saver,TokenizerCallback Tokenizer,SmallVectorImpl<const char * > & Argv,bool MarkEOLs)900*9880d681SAndroid Build Coastguard Worker bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer,
901*9880d681SAndroid Build Coastguard Worker                              SmallVectorImpl<const char *> &Argv,
902*9880d681SAndroid Build Coastguard Worker                              bool MarkEOLs) {
903*9880d681SAndroid Build Coastguard Worker   unsigned RspFiles = 0;
904*9880d681SAndroid Build Coastguard Worker   bool AllExpanded = true;
905*9880d681SAndroid Build Coastguard Worker 
906*9880d681SAndroid Build Coastguard Worker   // Don't cache Argv.size() because it can change.
907*9880d681SAndroid Build Coastguard Worker   for (unsigned I = 0; I != Argv.size();) {
908*9880d681SAndroid Build Coastguard Worker     const char *Arg = Argv[I];
909*9880d681SAndroid Build Coastguard Worker     // Check if it is an EOL marker
910*9880d681SAndroid Build Coastguard Worker     if (Arg == nullptr) {
911*9880d681SAndroid Build Coastguard Worker       ++I;
912*9880d681SAndroid Build Coastguard Worker       continue;
913*9880d681SAndroid Build Coastguard Worker     }
914*9880d681SAndroid Build Coastguard Worker     if (Arg[0] != '@') {
915*9880d681SAndroid Build Coastguard Worker       ++I;
916*9880d681SAndroid Build Coastguard Worker       continue;
917*9880d681SAndroid Build Coastguard Worker     }
918*9880d681SAndroid Build Coastguard Worker 
919*9880d681SAndroid Build Coastguard Worker     // If we have too many response files, leave some unexpanded.  This avoids
920*9880d681SAndroid Build Coastguard Worker     // crashing on self-referential response files.
921*9880d681SAndroid Build Coastguard Worker     if (RspFiles++ > 20)
922*9880d681SAndroid Build Coastguard Worker       return false;
923*9880d681SAndroid Build Coastguard Worker 
924*9880d681SAndroid Build Coastguard Worker     // Replace this response file argument with the tokenization of its
925*9880d681SAndroid Build Coastguard Worker     // contents.  Nested response files are expanded in subsequent iterations.
926*9880d681SAndroid Build Coastguard Worker     // FIXME: If a nested response file uses a relative path, is it relative to
927*9880d681SAndroid Build Coastguard Worker     // the cwd of the process or the response file?
928*9880d681SAndroid Build Coastguard Worker     SmallVector<const char *, 0> ExpandedArgv;
929*9880d681SAndroid Build Coastguard Worker     if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv,
930*9880d681SAndroid Build Coastguard Worker                             MarkEOLs)) {
931*9880d681SAndroid Build Coastguard Worker       // We couldn't read this file, so we leave it in the argument stream and
932*9880d681SAndroid Build Coastguard Worker       // move on.
933*9880d681SAndroid Build Coastguard Worker       AllExpanded = false;
934*9880d681SAndroid Build Coastguard Worker       ++I;
935*9880d681SAndroid Build Coastguard Worker       continue;
936*9880d681SAndroid Build Coastguard Worker     }
937*9880d681SAndroid Build Coastguard Worker     Argv.erase(Argv.begin() + I);
938*9880d681SAndroid Build Coastguard Worker     Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end());
939*9880d681SAndroid Build Coastguard Worker   }
940*9880d681SAndroid Build Coastguard Worker   return AllExpanded;
941*9880d681SAndroid Build Coastguard Worker }
942*9880d681SAndroid Build Coastguard Worker 
943*9880d681SAndroid Build Coastguard Worker /// ParseEnvironmentOptions - An alternative entry point to the
944*9880d681SAndroid Build Coastguard Worker /// CommandLine library, which allows you to read the program's name
945*9880d681SAndroid Build Coastguard Worker /// from the caller (as PROGNAME) and its command-line arguments from
946*9880d681SAndroid Build Coastguard Worker /// an environment variable (whose name is given in ENVVAR).
947*9880d681SAndroid Build Coastguard Worker ///
ParseEnvironmentOptions(const char * progName,const char * envVar,const char * Overview)948*9880d681SAndroid Build Coastguard Worker void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
949*9880d681SAndroid Build Coastguard Worker                                  const char *Overview) {
950*9880d681SAndroid Build Coastguard Worker   // Check args.
951*9880d681SAndroid Build Coastguard Worker   assert(progName && "Program name not specified");
952*9880d681SAndroid Build Coastguard Worker   assert(envVar && "Environment variable name missing");
953*9880d681SAndroid Build Coastguard Worker 
954*9880d681SAndroid Build Coastguard Worker   // Get the environment variable they want us to parse options out of.
955*9880d681SAndroid Build Coastguard Worker #ifdef _WIN32
956*9880d681SAndroid Build Coastguard Worker   std::wstring wenvVar;
957*9880d681SAndroid Build Coastguard Worker   if (!llvm::ConvertUTF8toWide(envVar, wenvVar)) {
958*9880d681SAndroid Build Coastguard Worker     assert(false &&
959*9880d681SAndroid Build Coastguard Worker            "Unicode conversion of environment variable name failed");
960*9880d681SAndroid Build Coastguard Worker     return;
961*9880d681SAndroid Build Coastguard Worker   }
962*9880d681SAndroid Build Coastguard Worker   const wchar_t *wenvValue = _wgetenv(wenvVar.c_str());
963*9880d681SAndroid Build Coastguard Worker   if (!wenvValue)
964*9880d681SAndroid Build Coastguard Worker     return;
965*9880d681SAndroid Build Coastguard Worker   std::string envValueBuffer;
966*9880d681SAndroid Build Coastguard Worker   if (!llvm::convertWideToUTF8(wenvValue, envValueBuffer)) {
967*9880d681SAndroid Build Coastguard Worker     assert(false &&
968*9880d681SAndroid Build Coastguard Worker            "Unicode conversion of environment variable value failed");
969*9880d681SAndroid Build Coastguard Worker     return;
970*9880d681SAndroid Build Coastguard Worker   }
971*9880d681SAndroid Build Coastguard Worker   const char *envValue = envValueBuffer.c_str();
972*9880d681SAndroid Build Coastguard Worker #else
973*9880d681SAndroid Build Coastguard Worker   const char *envValue = getenv(envVar);
974*9880d681SAndroid Build Coastguard Worker   if (!envValue)
975*9880d681SAndroid Build Coastguard Worker     return;
976*9880d681SAndroid Build Coastguard Worker #endif
977*9880d681SAndroid Build Coastguard Worker 
978*9880d681SAndroid Build Coastguard Worker   // Get program's "name", which we wouldn't know without the caller
979*9880d681SAndroid Build Coastguard Worker   // telling us.
980*9880d681SAndroid Build Coastguard Worker   SmallVector<const char *, 20> newArgv;
981*9880d681SAndroid Build Coastguard Worker   BumpPtrAllocator A;
982*9880d681SAndroid Build Coastguard Worker   StringSaver Saver(A);
983*9880d681SAndroid Build Coastguard Worker   newArgv.push_back(Saver.save(progName));
984*9880d681SAndroid Build Coastguard Worker 
985*9880d681SAndroid Build Coastguard Worker   // Parse the value of the environment variable into a "command line"
986*9880d681SAndroid Build Coastguard Worker   // and hand it off to ParseCommandLineOptions().
987*9880d681SAndroid Build Coastguard Worker   TokenizeGNUCommandLine(envValue, Saver, newArgv);
988*9880d681SAndroid Build Coastguard Worker   int newArgc = static_cast<int>(newArgv.size());
989*9880d681SAndroid Build Coastguard Worker   ParseCommandLineOptions(newArgc, &newArgv[0], Overview);
990*9880d681SAndroid Build Coastguard Worker }
991*9880d681SAndroid Build Coastguard Worker 
ParseCommandLineOptions(int argc,const char * const * argv,const char * Overview,bool IgnoreErrors)992*9880d681SAndroid Build Coastguard Worker bool cl::ParseCommandLineOptions(int argc, const char *const *argv,
993*9880d681SAndroid Build Coastguard Worker                                  const char *Overview, bool IgnoreErrors) {
994*9880d681SAndroid Build Coastguard Worker   return GlobalParser->ParseCommandLineOptions(argc, argv, Overview,
995*9880d681SAndroid Build Coastguard Worker                                                IgnoreErrors);
996*9880d681SAndroid Build Coastguard Worker }
997*9880d681SAndroid Build Coastguard Worker 
ResetAllOptionOccurrences()998*9880d681SAndroid Build Coastguard Worker void CommandLineParser::ResetAllOptionOccurrences() {
999*9880d681SAndroid Build Coastguard Worker   // So that we can parse different command lines multiple times in succession
1000*9880d681SAndroid Build Coastguard Worker   // we reset all option values to look like they have never been seen before.
1001*9880d681SAndroid Build Coastguard Worker   for (auto SC : RegisteredSubCommands) {
1002*9880d681SAndroid Build Coastguard Worker     for (auto &O : SC->OptionsMap)
1003*9880d681SAndroid Build Coastguard Worker       O.second->reset();
1004*9880d681SAndroid Build Coastguard Worker   }
1005*9880d681SAndroid Build Coastguard Worker }
1006*9880d681SAndroid Build Coastguard Worker 
ParseCommandLineOptions(int argc,const char * const * argv,const char * Overview,bool IgnoreErrors)1007*9880d681SAndroid Build Coastguard Worker bool CommandLineParser::ParseCommandLineOptions(int argc,
1008*9880d681SAndroid Build Coastguard Worker                                                 const char *const *argv,
1009*9880d681SAndroid Build Coastguard Worker                                                 const char *Overview,
1010*9880d681SAndroid Build Coastguard Worker                                                 bool IgnoreErrors) {
1011*9880d681SAndroid Build Coastguard Worker   assert(hasOptions() && "No options specified!");
1012*9880d681SAndroid Build Coastguard Worker 
1013*9880d681SAndroid Build Coastguard Worker   // Expand response files.
1014*9880d681SAndroid Build Coastguard Worker   SmallVector<const char *, 20> newArgv(argv, argv + argc);
1015*9880d681SAndroid Build Coastguard Worker   BumpPtrAllocator A;
1016*9880d681SAndroid Build Coastguard Worker   StringSaver Saver(A);
1017*9880d681SAndroid Build Coastguard Worker   ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv);
1018*9880d681SAndroid Build Coastguard Worker   argv = &newArgv[0];
1019*9880d681SAndroid Build Coastguard Worker   argc = static_cast<int>(newArgv.size());
1020*9880d681SAndroid Build Coastguard Worker 
1021*9880d681SAndroid Build Coastguard Worker   // Copy the program name into ProgName, making sure not to overflow it.
1022*9880d681SAndroid Build Coastguard Worker   ProgramName = sys::path::filename(argv[0]);
1023*9880d681SAndroid Build Coastguard Worker 
1024*9880d681SAndroid Build Coastguard Worker   ProgramOverview = Overview;
1025*9880d681SAndroid Build Coastguard Worker   bool ErrorParsing = false;
1026*9880d681SAndroid Build Coastguard Worker 
1027*9880d681SAndroid Build Coastguard Worker   // Check out the positional arguments to collect information about them.
1028*9880d681SAndroid Build Coastguard Worker   unsigned NumPositionalRequired = 0;
1029*9880d681SAndroid Build Coastguard Worker 
1030*9880d681SAndroid Build Coastguard Worker   // Determine whether or not there are an unlimited number of positionals
1031*9880d681SAndroid Build Coastguard Worker   bool HasUnlimitedPositionals = false;
1032*9880d681SAndroid Build Coastguard Worker 
1033*9880d681SAndroid Build Coastguard Worker   int FirstArg = 1;
1034*9880d681SAndroid Build Coastguard Worker   SubCommand *ChosenSubCommand = &*TopLevelSubCommand;
1035*9880d681SAndroid Build Coastguard Worker   if (argc >= 2 && argv[FirstArg][0] != '-') {
1036*9880d681SAndroid Build Coastguard Worker     // If the first argument specifies a valid subcommand, start processing
1037*9880d681SAndroid Build Coastguard Worker     // options from the second argument.
1038*9880d681SAndroid Build Coastguard Worker     ChosenSubCommand = LookupSubCommand(argv[FirstArg]);
1039*9880d681SAndroid Build Coastguard Worker     if (ChosenSubCommand != &*TopLevelSubCommand)
1040*9880d681SAndroid Build Coastguard Worker       FirstArg = 2;
1041*9880d681SAndroid Build Coastguard Worker   }
1042*9880d681SAndroid Build Coastguard Worker   GlobalParser->ActiveSubCommand = ChosenSubCommand;
1043*9880d681SAndroid Build Coastguard Worker 
1044*9880d681SAndroid Build Coastguard Worker   assert(ChosenSubCommand);
1045*9880d681SAndroid Build Coastguard Worker   auto &ConsumeAfterOpt = ChosenSubCommand->ConsumeAfterOpt;
1046*9880d681SAndroid Build Coastguard Worker   auto &PositionalOpts = ChosenSubCommand->PositionalOpts;
1047*9880d681SAndroid Build Coastguard Worker   auto &SinkOpts = ChosenSubCommand->SinkOpts;
1048*9880d681SAndroid Build Coastguard Worker   auto &OptionsMap = ChosenSubCommand->OptionsMap;
1049*9880d681SAndroid Build Coastguard Worker 
1050*9880d681SAndroid Build Coastguard Worker   if (ConsumeAfterOpt) {
1051*9880d681SAndroid Build Coastguard Worker     assert(PositionalOpts.size() > 0 &&
1052*9880d681SAndroid Build Coastguard Worker            "Cannot specify cl::ConsumeAfter without a positional argument!");
1053*9880d681SAndroid Build Coastguard Worker   }
1054*9880d681SAndroid Build Coastguard Worker   if (!PositionalOpts.empty()) {
1055*9880d681SAndroid Build Coastguard Worker 
1056*9880d681SAndroid Build Coastguard Worker     // Calculate how many positional values are _required_.
1057*9880d681SAndroid Build Coastguard Worker     bool UnboundedFound = false;
1058*9880d681SAndroid Build Coastguard Worker     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1059*9880d681SAndroid Build Coastguard Worker       Option *Opt = PositionalOpts[i];
1060*9880d681SAndroid Build Coastguard Worker       if (RequiresValue(Opt))
1061*9880d681SAndroid Build Coastguard Worker         ++NumPositionalRequired;
1062*9880d681SAndroid Build Coastguard Worker       else if (ConsumeAfterOpt) {
1063*9880d681SAndroid Build Coastguard Worker         // ConsumeAfter cannot be combined with "optional" positional options
1064*9880d681SAndroid Build Coastguard Worker         // unless there is only one positional argument...
1065*9880d681SAndroid Build Coastguard Worker         if (PositionalOpts.size() > 1) {
1066*9880d681SAndroid Build Coastguard Worker           if (!IgnoreErrors)
1067*9880d681SAndroid Build Coastguard Worker             Opt->error("error - this positional option will never be matched, "
1068*9880d681SAndroid Build Coastguard Worker                        "because it does not Require a value, and a "
1069*9880d681SAndroid Build Coastguard Worker                        "cl::ConsumeAfter option is active!");
1070*9880d681SAndroid Build Coastguard Worker           ErrorParsing = true;
1071*9880d681SAndroid Build Coastguard Worker         }
1072*9880d681SAndroid Build Coastguard Worker       } else if (UnboundedFound && !Opt->hasArgStr()) {
1073*9880d681SAndroid Build Coastguard Worker         // This option does not "require" a value...  Make sure this option is
1074*9880d681SAndroid Build Coastguard Worker         // not specified after an option that eats all extra arguments, or this
1075*9880d681SAndroid Build Coastguard Worker         // one will never get any!
1076*9880d681SAndroid Build Coastguard Worker         //
1077*9880d681SAndroid Build Coastguard Worker         if (!IgnoreErrors) {
1078*9880d681SAndroid Build Coastguard Worker           Opt->error("error - option can never match, because "
1079*9880d681SAndroid Build Coastguard Worker                      "another positional argument will match an "
1080*9880d681SAndroid Build Coastguard Worker                      "unbounded number of values, and this option"
1081*9880d681SAndroid Build Coastguard Worker                      " does not require a value!");
1082*9880d681SAndroid Build Coastguard Worker           errs() << ProgramName << ": CommandLine Error: Option '"
1083*9880d681SAndroid Build Coastguard Worker                  << Opt->ArgStr << "' is all messed up!\n";
1084*9880d681SAndroid Build Coastguard Worker           errs() << PositionalOpts.size();
1085*9880d681SAndroid Build Coastguard Worker         }
1086*9880d681SAndroid Build Coastguard Worker         ErrorParsing = true;
1087*9880d681SAndroid Build Coastguard Worker       }
1088*9880d681SAndroid Build Coastguard Worker       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
1089*9880d681SAndroid Build Coastguard Worker     }
1090*9880d681SAndroid Build Coastguard Worker     HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
1091*9880d681SAndroid Build Coastguard Worker   }
1092*9880d681SAndroid Build Coastguard Worker 
1093*9880d681SAndroid Build Coastguard Worker   // PositionalVals - A vector of "positional" arguments we accumulate into
1094*9880d681SAndroid Build Coastguard Worker   // the process at the end.
1095*9880d681SAndroid Build Coastguard Worker   //
1096*9880d681SAndroid Build Coastguard Worker   SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals;
1097*9880d681SAndroid Build Coastguard Worker 
1098*9880d681SAndroid Build Coastguard Worker   // If the program has named positional arguments, and the name has been run
1099*9880d681SAndroid Build Coastguard Worker   // across, keep track of which positional argument was named.  Otherwise put
1100*9880d681SAndroid Build Coastguard Worker   // the positional args into the PositionalVals list...
1101*9880d681SAndroid Build Coastguard Worker   Option *ActivePositionalArg = nullptr;
1102*9880d681SAndroid Build Coastguard Worker 
1103*9880d681SAndroid Build Coastguard Worker   // Loop over all of the arguments... processing them.
1104*9880d681SAndroid Build Coastguard Worker   bool DashDashFound = false; // Have we read '--'?
1105*9880d681SAndroid Build Coastguard Worker   for (int i = FirstArg; i < argc; ++i) {
1106*9880d681SAndroid Build Coastguard Worker     Option *Handler = nullptr;
1107*9880d681SAndroid Build Coastguard Worker     Option *NearestHandler = nullptr;
1108*9880d681SAndroid Build Coastguard Worker     std::string NearestHandlerString;
1109*9880d681SAndroid Build Coastguard Worker     StringRef Value;
1110*9880d681SAndroid Build Coastguard Worker     StringRef ArgName = "";
1111*9880d681SAndroid Build Coastguard Worker 
1112*9880d681SAndroid Build Coastguard Worker     // Check to see if this is a positional argument.  This argument is
1113*9880d681SAndroid Build Coastguard Worker     // considered to be positional if it doesn't start with '-', if it is "-"
1114*9880d681SAndroid Build Coastguard Worker     // itself, or if we have seen "--" already.
1115*9880d681SAndroid Build Coastguard Worker     //
1116*9880d681SAndroid Build Coastguard Worker     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
1117*9880d681SAndroid Build Coastguard Worker       // Positional argument!
1118*9880d681SAndroid Build Coastguard Worker       if (ActivePositionalArg) {
1119*9880d681SAndroid Build Coastguard Worker         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
1120*9880d681SAndroid Build Coastguard Worker         continue; // We are done!
1121*9880d681SAndroid Build Coastguard Worker       }
1122*9880d681SAndroid Build Coastguard Worker 
1123*9880d681SAndroid Build Coastguard Worker       if (!PositionalOpts.empty()) {
1124*9880d681SAndroid Build Coastguard Worker         PositionalVals.push_back(std::make_pair(argv[i], i));
1125*9880d681SAndroid Build Coastguard Worker 
1126*9880d681SAndroid Build Coastguard Worker         // All of the positional arguments have been fulfulled, give the rest to
1127*9880d681SAndroid Build Coastguard Worker         // the consume after option... if it's specified...
1128*9880d681SAndroid Build Coastguard Worker         //
1129*9880d681SAndroid Build Coastguard Worker         if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) {
1130*9880d681SAndroid Build Coastguard Worker           for (++i; i < argc; ++i)
1131*9880d681SAndroid Build Coastguard Worker             PositionalVals.push_back(std::make_pair(argv[i], i));
1132*9880d681SAndroid Build Coastguard Worker           break; // Handle outside of the argument processing loop...
1133*9880d681SAndroid Build Coastguard Worker         }
1134*9880d681SAndroid Build Coastguard Worker 
1135*9880d681SAndroid Build Coastguard Worker         // Delay processing positional arguments until the end...
1136*9880d681SAndroid Build Coastguard Worker         continue;
1137*9880d681SAndroid Build Coastguard Worker       }
1138*9880d681SAndroid Build Coastguard Worker     } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
1139*9880d681SAndroid Build Coastguard Worker                !DashDashFound) {
1140*9880d681SAndroid Build Coastguard Worker       DashDashFound = true; // This is the mythical "--"?
1141*9880d681SAndroid Build Coastguard Worker       continue;             // Don't try to process it as an argument itself.
1142*9880d681SAndroid Build Coastguard Worker     } else if (ActivePositionalArg &&
1143*9880d681SAndroid Build Coastguard Worker                (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
1144*9880d681SAndroid Build Coastguard Worker       // If there is a positional argument eating options, check to see if this
1145*9880d681SAndroid Build Coastguard Worker       // option is another positional argument.  If so, treat it as an argument,
1146*9880d681SAndroid Build Coastguard Worker       // otherwise feed it to the eating positional.
1147*9880d681SAndroid Build Coastguard Worker       ArgName = argv[i] + 1;
1148*9880d681SAndroid Build Coastguard Worker       // Eat leading dashes.
1149*9880d681SAndroid Build Coastguard Worker       while (!ArgName.empty() && ArgName[0] == '-')
1150*9880d681SAndroid Build Coastguard Worker         ArgName = ArgName.substr(1);
1151*9880d681SAndroid Build Coastguard Worker 
1152*9880d681SAndroid Build Coastguard Worker       Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
1153*9880d681SAndroid Build Coastguard Worker       if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
1154*9880d681SAndroid Build Coastguard Worker         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
1155*9880d681SAndroid Build Coastguard Worker         continue; // We are done!
1156*9880d681SAndroid Build Coastguard Worker       }
1157*9880d681SAndroid Build Coastguard Worker 
1158*9880d681SAndroid Build Coastguard Worker     } else { // We start with a '-', must be an argument.
1159*9880d681SAndroid Build Coastguard Worker       ArgName = argv[i] + 1;
1160*9880d681SAndroid Build Coastguard Worker       // Eat leading dashes.
1161*9880d681SAndroid Build Coastguard Worker       while (!ArgName.empty() && ArgName[0] == '-')
1162*9880d681SAndroid Build Coastguard Worker         ArgName = ArgName.substr(1);
1163*9880d681SAndroid Build Coastguard Worker 
1164*9880d681SAndroid Build Coastguard Worker       Handler = LookupOption(*ChosenSubCommand, ArgName, Value);
1165*9880d681SAndroid Build Coastguard Worker 
1166*9880d681SAndroid Build Coastguard Worker       // Check to see if this "option" is really a prefixed or grouped argument.
1167*9880d681SAndroid Build Coastguard Worker       if (!Handler)
1168*9880d681SAndroid Build Coastguard Worker         Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing,
1169*9880d681SAndroid Build Coastguard Worker                                                 OptionsMap);
1170*9880d681SAndroid Build Coastguard Worker 
1171*9880d681SAndroid Build Coastguard Worker       // Otherwise, look for the closest available option to report to the user
1172*9880d681SAndroid Build Coastguard Worker       // in the upcoming error.
1173*9880d681SAndroid Build Coastguard Worker       if (!Handler && SinkOpts.empty())
1174*9880d681SAndroid Build Coastguard Worker         NearestHandler =
1175*9880d681SAndroid Build Coastguard Worker             LookupNearestOption(ArgName, OptionsMap, NearestHandlerString);
1176*9880d681SAndroid Build Coastguard Worker     }
1177*9880d681SAndroid Build Coastguard Worker 
1178*9880d681SAndroid Build Coastguard Worker     if (!Handler) {
1179*9880d681SAndroid Build Coastguard Worker       if (SinkOpts.empty()) {
1180*9880d681SAndroid Build Coastguard Worker         if (!IgnoreErrors) {
1181*9880d681SAndroid Build Coastguard Worker           errs() << ProgramName << ": Unknown command line argument '"
1182*9880d681SAndroid Build Coastguard Worker                  << argv[i] << "'.  Try: '" << argv[0] << " -help'\n";
1183*9880d681SAndroid Build Coastguard Worker 
1184*9880d681SAndroid Build Coastguard Worker           if (NearestHandler) {
1185*9880d681SAndroid Build Coastguard Worker             // If we know a near match, report it as well.
1186*9880d681SAndroid Build Coastguard Worker             errs() << ProgramName << ": Did you mean '-" << NearestHandlerString
1187*9880d681SAndroid Build Coastguard Worker                    << "'?\n";
1188*9880d681SAndroid Build Coastguard Worker           }
1189*9880d681SAndroid Build Coastguard Worker         }
1190*9880d681SAndroid Build Coastguard Worker 
1191*9880d681SAndroid Build Coastguard Worker         ErrorParsing = true;
1192*9880d681SAndroid Build Coastguard Worker       } else {
1193*9880d681SAndroid Build Coastguard Worker         for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(),
1194*9880d681SAndroid Build Coastguard Worker                                                  E = SinkOpts.end();
1195*9880d681SAndroid Build Coastguard Worker              I != E; ++I)
1196*9880d681SAndroid Build Coastguard Worker           (*I)->addOccurrence(i, "", argv[i]);
1197*9880d681SAndroid Build Coastguard Worker       }
1198*9880d681SAndroid Build Coastguard Worker       continue;
1199*9880d681SAndroid Build Coastguard Worker     }
1200*9880d681SAndroid Build Coastguard Worker 
1201*9880d681SAndroid Build Coastguard Worker     // If this is a named positional argument, just remember that it is the
1202*9880d681SAndroid Build Coastguard Worker     // active one...
1203*9880d681SAndroid Build Coastguard Worker     if (Handler->getFormattingFlag() == cl::Positional)
1204*9880d681SAndroid Build Coastguard Worker       ActivePositionalArg = Handler;
1205*9880d681SAndroid Build Coastguard Worker     else
1206*9880d681SAndroid Build Coastguard Worker       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
1207*9880d681SAndroid Build Coastguard Worker   }
1208*9880d681SAndroid Build Coastguard Worker 
1209*9880d681SAndroid Build Coastguard Worker   // Check and handle positional arguments now...
1210*9880d681SAndroid Build Coastguard Worker   if (NumPositionalRequired > PositionalVals.size()) {
1211*9880d681SAndroid Build Coastguard Worker     if (!IgnoreErrors) {
1212*9880d681SAndroid Build Coastguard Worker       errs() << ProgramName
1213*9880d681SAndroid Build Coastguard Worker              << ": Not enough positional command line arguments specified!\n"
1214*9880d681SAndroid Build Coastguard Worker              << "Must specify at least " << NumPositionalRequired
1215*9880d681SAndroid Build Coastguard Worker              << " positional arguments: See: " << argv[0] << " -help\n";
1216*9880d681SAndroid Build Coastguard Worker     }
1217*9880d681SAndroid Build Coastguard Worker 
1218*9880d681SAndroid Build Coastguard Worker     ErrorParsing = true;
1219*9880d681SAndroid Build Coastguard Worker   } else if (!HasUnlimitedPositionals &&
1220*9880d681SAndroid Build Coastguard Worker              PositionalVals.size() > PositionalOpts.size()) {
1221*9880d681SAndroid Build Coastguard Worker     if (!IgnoreErrors) {
1222*9880d681SAndroid Build Coastguard Worker       errs() << ProgramName << ": Too many positional arguments specified!\n"
1223*9880d681SAndroid Build Coastguard Worker              << "Can specify at most " << PositionalOpts.size()
1224*9880d681SAndroid Build Coastguard Worker              << " positional arguments: See: " << argv[0] << " -help\n";
1225*9880d681SAndroid Build Coastguard Worker     }
1226*9880d681SAndroid Build Coastguard Worker     ErrorParsing = true;
1227*9880d681SAndroid Build Coastguard Worker 
1228*9880d681SAndroid Build Coastguard Worker   } else if (!ConsumeAfterOpt) {
1229*9880d681SAndroid Build Coastguard Worker     // Positional args have already been handled if ConsumeAfter is specified.
1230*9880d681SAndroid Build Coastguard Worker     unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
1231*9880d681SAndroid Build Coastguard Worker     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1232*9880d681SAndroid Build Coastguard Worker       if (RequiresValue(PositionalOpts[i])) {
1233*9880d681SAndroid Build Coastguard Worker         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
1234*9880d681SAndroid Build Coastguard Worker                                 PositionalVals[ValNo].second);
1235*9880d681SAndroid Build Coastguard Worker         ValNo++;
1236*9880d681SAndroid Build Coastguard Worker         --NumPositionalRequired; // We fulfilled our duty...
1237*9880d681SAndroid Build Coastguard Worker       }
1238*9880d681SAndroid Build Coastguard Worker 
1239*9880d681SAndroid Build Coastguard Worker       // If we _can_ give this option more arguments, do so now, as long as we
1240*9880d681SAndroid Build Coastguard Worker       // do not give it values that others need.  'Done' controls whether the
1241*9880d681SAndroid Build Coastguard Worker       // option even _WANTS_ any more.
1242*9880d681SAndroid Build Coastguard Worker       //
1243*9880d681SAndroid Build Coastguard Worker       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
1244*9880d681SAndroid Build Coastguard Worker       while (NumVals - ValNo > NumPositionalRequired && !Done) {
1245*9880d681SAndroid Build Coastguard Worker         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
1246*9880d681SAndroid Build Coastguard Worker         case cl::Optional:
1247*9880d681SAndroid Build Coastguard Worker           Done = true; // Optional arguments want _at most_ one value
1248*9880d681SAndroid Build Coastguard Worker         // FALL THROUGH
1249*9880d681SAndroid Build Coastguard Worker         case cl::ZeroOrMore: // Zero or more will take all they can get...
1250*9880d681SAndroid Build Coastguard Worker         case cl::OneOrMore:  // One or more will take all they can get...
1251*9880d681SAndroid Build Coastguard Worker           ProvidePositionalOption(PositionalOpts[i],
1252*9880d681SAndroid Build Coastguard Worker                                   PositionalVals[ValNo].first,
1253*9880d681SAndroid Build Coastguard Worker                                   PositionalVals[ValNo].second);
1254*9880d681SAndroid Build Coastguard Worker           ValNo++;
1255*9880d681SAndroid Build Coastguard Worker           break;
1256*9880d681SAndroid Build Coastguard Worker         default:
1257*9880d681SAndroid Build Coastguard Worker           llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
1258*9880d681SAndroid Build Coastguard Worker                            "positional argument processing!");
1259*9880d681SAndroid Build Coastguard Worker         }
1260*9880d681SAndroid Build Coastguard Worker       }
1261*9880d681SAndroid Build Coastguard Worker     }
1262*9880d681SAndroid Build Coastguard Worker   } else {
1263*9880d681SAndroid Build Coastguard Worker     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
1264*9880d681SAndroid Build Coastguard Worker     unsigned ValNo = 0;
1265*9880d681SAndroid Build Coastguard Worker     for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
1266*9880d681SAndroid Build Coastguard Worker       if (RequiresValue(PositionalOpts[j])) {
1267*9880d681SAndroid Build Coastguard Worker         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
1268*9880d681SAndroid Build Coastguard Worker                                                 PositionalVals[ValNo].first,
1269*9880d681SAndroid Build Coastguard Worker                                                 PositionalVals[ValNo].second);
1270*9880d681SAndroid Build Coastguard Worker         ValNo++;
1271*9880d681SAndroid Build Coastguard Worker       }
1272*9880d681SAndroid Build Coastguard Worker 
1273*9880d681SAndroid Build Coastguard Worker     // Handle the case where there is just one positional option, and it's
1274*9880d681SAndroid Build Coastguard Worker     // optional.  In this case, we want to give JUST THE FIRST option to the
1275*9880d681SAndroid Build Coastguard Worker     // positional option and keep the rest for the consume after.  The above
1276*9880d681SAndroid Build Coastguard Worker     // loop would have assigned no values to positional options in this case.
1277*9880d681SAndroid Build Coastguard Worker     //
1278*9880d681SAndroid Build Coastguard Worker     if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) {
1279*9880d681SAndroid Build Coastguard Worker       ErrorParsing |= ProvidePositionalOption(PositionalOpts[0],
1280*9880d681SAndroid Build Coastguard Worker                                               PositionalVals[ValNo].first,
1281*9880d681SAndroid Build Coastguard Worker                                               PositionalVals[ValNo].second);
1282*9880d681SAndroid Build Coastguard Worker       ValNo++;
1283*9880d681SAndroid Build Coastguard Worker     }
1284*9880d681SAndroid Build Coastguard Worker 
1285*9880d681SAndroid Build Coastguard Worker     // Handle over all of the rest of the arguments to the
1286*9880d681SAndroid Build Coastguard Worker     // cl::ConsumeAfter command line option...
1287*9880d681SAndroid Build Coastguard Worker     for (; ValNo != PositionalVals.size(); ++ValNo)
1288*9880d681SAndroid Build Coastguard Worker       ErrorParsing |=
1289*9880d681SAndroid Build Coastguard Worker           ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first,
1290*9880d681SAndroid Build Coastguard Worker                                   PositionalVals[ValNo].second);
1291*9880d681SAndroid Build Coastguard Worker   }
1292*9880d681SAndroid Build Coastguard Worker 
1293*9880d681SAndroid Build Coastguard Worker   // Loop over args and make sure all required args are specified!
1294*9880d681SAndroid Build Coastguard Worker   for (const auto &Opt : OptionsMap) {
1295*9880d681SAndroid Build Coastguard Worker     switch (Opt.second->getNumOccurrencesFlag()) {
1296*9880d681SAndroid Build Coastguard Worker     case Required:
1297*9880d681SAndroid Build Coastguard Worker     case OneOrMore:
1298*9880d681SAndroid Build Coastguard Worker       if (Opt.second->getNumOccurrences() == 0) {
1299*9880d681SAndroid Build Coastguard Worker         Opt.second->error("must be specified at least once!");
1300*9880d681SAndroid Build Coastguard Worker         ErrorParsing = true;
1301*9880d681SAndroid Build Coastguard Worker       }
1302*9880d681SAndroid Build Coastguard Worker     // Fall through
1303*9880d681SAndroid Build Coastguard Worker     default:
1304*9880d681SAndroid Build Coastguard Worker       break;
1305*9880d681SAndroid Build Coastguard Worker     }
1306*9880d681SAndroid Build Coastguard Worker   }
1307*9880d681SAndroid Build Coastguard Worker 
1308*9880d681SAndroid Build Coastguard Worker   // Now that we know if -debug is specified, we can use it.
1309*9880d681SAndroid Build Coastguard Worker   // Note that if ReadResponseFiles == true, this must be done before the
1310*9880d681SAndroid Build Coastguard Worker   // memory allocated for the expanded command line is free()d below.
1311*9880d681SAndroid Build Coastguard Worker   DEBUG(dbgs() << "Args: ";
1312*9880d681SAndroid Build Coastguard Worker         for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' ';
1313*9880d681SAndroid Build Coastguard Worker         dbgs() << '\n';);
1314*9880d681SAndroid Build Coastguard Worker 
1315*9880d681SAndroid Build Coastguard Worker   // Free all of the memory allocated to the map.  Command line options may only
1316*9880d681SAndroid Build Coastguard Worker   // be processed once!
1317*9880d681SAndroid Build Coastguard Worker   MoreHelp.clear();
1318*9880d681SAndroid Build Coastguard Worker 
1319*9880d681SAndroid Build Coastguard Worker   // If we had an error processing our arguments, don't let the program execute
1320*9880d681SAndroid Build Coastguard Worker   if (ErrorParsing) {
1321*9880d681SAndroid Build Coastguard Worker     if (!IgnoreErrors)
1322*9880d681SAndroid Build Coastguard Worker       exit(1);
1323*9880d681SAndroid Build Coastguard Worker     return false;
1324*9880d681SAndroid Build Coastguard Worker   }
1325*9880d681SAndroid Build Coastguard Worker   return true;
1326*9880d681SAndroid Build Coastguard Worker }
1327*9880d681SAndroid Build Coastguard Worker 
1328*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
1329*9880d681SAndroid Build Coastguard Worker // Option Base class implementation
1330*9880d681SAndroid Build Coastguard Worker //
1331*9880d681SAndroid Build Coastguard Worker 
error(const Twine & Message,StringRef ArgName)1332*9880d681SAndroid Build Coastguard Worker bool Option::error(const Twine &Message, StringRef ArgName) {
1333*9880d681SAndroid Build Coastguard Worker   if (!ArgName.data())
1334*9880d681SAndroid Build Coastguard Worker     ArgName = ArgStr;
1335*9880d681SAndroid Build Coastguard Worker   if (ArgName.empty())
1336*9880d681SAndroid Build Coastguard Worker     errs() << HelpStr; // Be nice for positional arguments
1337*9880d681SAndroid Build Coastguard Worker   else
1338*9880d681SAndroid Build Coastguard Worker     errs() << GlobalParser->ProgramName << ": for the -" << ArgName;
1339*9880d681SAndroid Build Coastguard Worker 
1340*9880d681SAndroid Build Coastguard Worker   errs() << " option: " << Message << "\n";
1341*9880d681SAndroid Build Coastguard Worker   return true;
1342*9880d681SAndroid Build Coastguard Worker }
1343*9880d681SAndroid Build Coastguard Worker 
addOccurrence(unsigned pos,StringRef ArgName,StringRef Value,bool MultiArg)1344*9880d681SAndroid Build Coastguard Worker bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value,
1345*9880d681SAndroid Build Coastguard Worker                            bool MultiArg) {
1346*9880d681SAndroid Build Coastguard Worker   if (!MultiArg)
1347*9880d681SAndroid Build Coastguard Worker     NumOccurrences++; // Increment the number of times we have been seen
1348*9880d681SAndroid Build Coastguard Worker 
1349*9880d681SAndroid Build Coastguard Worker   switch (getNumOccurrencesFlag()) {
1350*9880d681SAndroid Build Coastguard Worker   case Optional:
1351*9880d681SAndroid Build Coastguard Worker     if (NumOccurrences > 1)
1352*9880d681SAndroid Build Coastguard Worker       return error("may only occur zero or one times!", ArgName);
1353*9880d681SAndroid Build Coastguard Worker     break;
1354*9880d681SAndroid Build Coastguard Worker   case Required:
1355*9880d681SAndroid Build Coastguard Worker     if (NumOccurrences > 1)
1356*9880d681SAndroid Build Coastguard Worker       return error("must occur exactly one time!", ArgName);
1357*9880d681SAndroid Build Coastguard Worker   // Fall through
1358*9880d681SAndroid Build Coastguard Worker   case OneOrMore:
1359*9880d681SAndroid Build Coastguard Worker   case ZeroOrMore:
1360*9880d681SAndroid Build Coastguard Worker   case ConsumeAfter:
1361*9880d681SAndroid Build Coastguard Worker     break;
1362*9880d681SAndroid Build Coastguard Worker   }
1363*9880d681SAndroid Build Coastguard Worker 
1364*9880d681SAndroid Build Coastguard Worker   return handleOccurrence(pos, ArgName, Value);
1365*9880d681SAndroid Build Coastguard Worker }
1366*9880d681SAndroid Build Coastguard Worker 
1367*9880d681SAndroid Build Coastguard Worker // getValueStr - Get the value description string, using "DefaultMsg" if nothing
1368*9880d681SAndroid Build Coastguard Worker // has been specified yet.
1369*9880d681SAndroid Build Coastguard Worker //
getValueStr(const Option & O,StringRef DefaultMsg)1370*9880d681SAndroid Build Coastguard Worker static StringRef getValueStr(const Option &O, StringRef DefaultMsg) {
1371*9880d681SAndroid Build Coastguard Worker   if (O.ValueStr.empty())
1372*9880d681SAndroid Build Coastguard Worker     return DefaultMsg;
1373*9880d681SAndroid Build Coastguard Worker   return O.ValueStr;
1374*9880d681SAndroid Build Coastguard Worker }
1375*9880d681SAndroid Build Coastguard Worker 
1376*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
1377*9880d681SAndroid Build Coastguard Worker // cl::alias class implementation
1378*9880d681SAndroid Build Coastguard Worker //
1379*9880d681SAndroid Build Coastguard Worker 
1380*9880d681SAndroid Build Coastguard Worker // Return the width of the option tag for printing...
getOptionWidth() const1381*9880d681SAndroid Build Coastguard Worker size_t alias::getOptionWidth() const { return ArgStr.size() + 6; }
1382*9880d681SAndroid Build Coastguard Worker 
printHelpStr(StringRef HelpStr,size_t Indent,size_t FirstLineIndentedBy)1383*9880d681SAndroid Build Coastguard Worker static void printHelpStr(StringRef HelpStr, size_t Indent,
1384*9880d681SAndroid Build Coastguard Worker                          size_t FirstLineIndentedBy) {
1385*9880d681SAndroid Build Coastguard Worker   std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
1386*9880d681SAndroid Build Coastguard Worker   outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
1387*9880d681SAndroid Build Coastguard Worker   while (!Split.second.empty()) {
1388*9880d681SAndroid Build Coastguard Worker     Split = Split.second.split('\n');
1389*9880d681SAndroid Build Coastguard Worker     outs().indent(Indent) << Split.first << "\n";
1390*9880d681SAndroid Build Coastguard Worker   }
1391*9880d681SAndroid Build Coastguard Worker }
1392*9880d681SAndroid Build Coastguard Worker 
1393*9880d681SAndroid Build Coastguard Worker // Print out the option for the alias.
printOptionInfo(size_t GlobalWidth) const1394*9880d681SAndroid Build Coastguard Worker void alias::printOptionInfo(size_t GlobalWidth) const {
1395*9880d681SAndroid Build Coastguard Worker   outs() << "  -" << ArgStr;
1396*9880d681SAndroid Build Coastguard Worker   printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6);
1397*9880d681SAndroid Build Coastguard Worker }
1398*9880d681SAndroid Build Coastguard Worker 
1399*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
1400*9880d681SAndroid Build Coastguard Worker // Parser Implementation code...
1401*9880d681SAndroid Build Coastguard Worker //
1402*9880d681SAndroid Build Coastguard Worker 
1403*9880d681SAndroid Build Coastguard Worker // basic_parser implementation
1404*9880d681SAndroid Build Coastguard Worker //
1405*9880d681SAndroid Build Coastguard Worker 
1406*9880d681SAndroid Build Coastguard Worker // Return the width of the option tag for printing...
getOptionWidth(const Option & O) const1407*9880d681SAndroid Build Coastguard Worker size_t basic_parser_impl::getOptionWidth(const Option &O) const {
1408*9880d681SAndroid Build Coastguard Worker   size_t Len = O.ArgStr.size();
1409*9880d681SAndroid Build Coastguard Worker   if (const char *ValName = getValueName())
1410*9880d681SAndroid Build Coastguard Worker     Len += getValueStr(O, ValName).size() + 3;
1411*9880d681SAndroid Build Coastguard Worker 
1412*9880d681SAndroid Build Coastguard Worker   return Len + 6;
1413*9880d681SAndroid Build Coastguard Worker }
1414*9880d681SAndroid Build Coastguard Worker 
1415*9880d681SAndroid Build Coastguard Worker // printOptionInfo - Print out information about this option.  The
1416*9880d681SAndroid Build Coastguard Worker // to-be-maintained width is specified.
1417*9880d681SAndroid Build Coastguard Worker //
printOptionInfo(const Option & O,size_t GlobalWidth) const1418*9880d681SAndroid Build Coastguard Worker void basic_parser_impl::printOptionInfo(const Option &O,
1419*9880d681SAndroid Build Coastguard Worker                                         size_t GlobalWidth) const {
1420*9880d681SAndroid Build Coastguard Worker   outs() << "  -" << O.ArgStr;
1421*9880d681SAndroid Build Coastguard Worker 
1422*9880d681SAndroid Build Coastguard Worker   if (const char *ValName = getValueName())
1423*9880d681SAndroid Build Coastguard Worker     outs() << "=<" << getValueStr(O, ValName) << '>';
1424*9880d681SAndroid Build Coastguard Worker 
1425*9880d681SAndroid Build Coastguard Worker   printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
1426*9880d681SAndroid Build Coastguard Worker }
1427*9880d681SAndroid Build Coastguard Worker 
printOptionName(const Option & O,size_t GlobalWidth) const1428*9880d681SAndroid Build Coastguard Worker void basic_parser_impl::printOptionName(const Option &O,
1429*9880d681SAndroid Build Coastguard Worker                                         size_t GlobalWidth) const {
1430*9880d681SAndroid Build Coastguard Worker   outs() << "  -" << O.ArgStr;
1431*9880d681SAndroid Build Coastguard Worker   outs().indent(GlobalWidth - O.ArgStr.size());
1432*9880d681SAndroid Build Coastguard Worker }
1433*9880d681SAndroid Build Coastguard Worker 
1434*9880d681SAndroid Build Coastguard Worker // parser<bool> implementation
1435*9880d681SAndroid Build Coastguard Worker //
parse(Option & O,StringRef ArgName,StringRef Arg,bool & Value)1436*9880d681SAndroid Build Coastguard Worker bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg,
1437*9880d681SAndroid Build Coastguard Worker                          bool &Value) {
1438*9880d681SAndroid Build Coastguard Worker   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1439*9880d681SAndroid Build Coastguard Worker       Arg == "1") {
1440*9880d681SAndroid Build Coastguard Worker     Value = true;
1441*9880d681SAndroid Build Coastguard Worker     return false;
1442*9880d681SAndroid Build Coastguard Worker   }
1443*9880d681SAndroid Build Coastguard Worker 
1444*9880d681SAndroid Build Coastguard Worker   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1445*9880d681SAndroid Build Coastguard Worker     Value = false;
1446*9880d681SAndroid Build Coastguard Worker     return false;
1447*9880d681SAndroid Build Coastguard Worker   }
1448*9880d681SAndroid Build Coastguard Worker   return O.error("'" + Arg +
1449*9880d681SAndroid Build Coastguard Worker                  "' is invalid value for boolean argument! Try 0 or 1");
1450*9880d681SAndroid Build Coastguard Worker }
1451*9880d681SAndroid Build Coastguard Worker 
1452*9880d681SAndroid Build Coastguard Worker // parser<boolOrDefault> implementation
1453*9880d681SAndroid Build Coastguard Worker //
parse(Option & O,StringRef ArgName,StringRef Arg,boolOrDefault & Value)1454*9880d681SAndroid Build Coastguard Worker bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg,
1455*9880d681SAndroid Build Coastguard Worker                                   boolOrDefault &Value) {
1456*9880d681SAndroid Build Coastguard Worker   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
1457*9880d681SAndroid Build Coastguard Worker       Arg == "1") {
1458*9880d681SAndroid Build Coastguard Worker     Value = BOU_TRUE;
1459*9880d681SAndroid Build Coastguard Worker     return false;
1460*9880d681SAndroid Build Coastguard Worker   }
1461*9880d681SAndroid Build Coastguard Worker   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
1462*9880d681SAndroid Build Coastguard Worker     Value = BOU_FALSE;
1463*9880d681SAndroid Build Coastguard Worker     return false;
1464*9880d681SAndroid Build Coastguard Worker   }
1465*9880d681SAndroid Build Coastguard Worker 
1466*9880d681SAndroid Build Coastguard Worker   return O.error("'" + Arg +
1467*9880d681SAndroid Build Coastguard Worker                  "' is invalid value for boolean argument! Try 0 or 1");
1468*9880d681SAndroid Build Coastguard Worker }
1469*9880d681SAndroid Build Coastguard Worker 
1470*9880d681SAndroid Build Coastguard Worker // parser<int> implementation
1471*9880d681SAndroid Build Coastguard Worker //
parse(Option & O,StringRef ArgName,StringRef Arg,int & Value)1472*9880d681SAndroid Build Coastguard Worker bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg,
1473*9880d681SAndroid Build Coastguard Worker                         int &Value) {
1474*9880d681SAndroid Build Coastguard Worker   if (Arg.getAsInteger(0, Value))
1475*9880d681SAndroid Build Coastguard Worker     return O.error("'" + Arg + "' value invalid for integer argument!");
1476*9880d681SAndroid Build Coastguard Worker   return false;
1477*9880d681SAndroid Build Coastguard Worker }
1478*9880d681SAndroid Build Coastguard Worker 
1479*9880d681SAndroid Build Coastguard Worker // parser<unsigned> implementation
1480*9880d681SAndroid Build Coastguard Worker //
parse(Option & O,StringRef ArgName,StringRef Arg,unsigned & Value)1481*9880d681SAndroid Build Coastguard Worker bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg,
1482*9880d681SAndroid Build Coastguard Worker                              unsigned &Value) {
1483*9880d681SAndroid Build Coastguard Worker 
1484*9880d681SAndroid Build Coastguard Worker   if (Arg.getAsInteger(0, Value))
1485*9880d681SAndroid Build Coastguard Worker     return O.error("'" + Arg + "' value invalid for uint argument!");
1486*9880d681SAndroid Build Coastguard Worker   return false;
1487*9880d681SAndroid Build Coastguard Worker }
1488*9880d681SAndroid Build Coastguard Worker 
1489*9880d681SAndroid Build Coastguard Worker // parser<unsigned long long> implementation
1490*9880d681SAndroid Build Coastguard Worker //
parse(Option & O,StringRef ArgName,StringRef Arg,unsigned long long & Value)1491*9880d681SAndroid Build Coastguard Worker bool parser<unsigned long long>::parse(Option &O, StringRef ArgName,
1492*9880d681SAndroid Build Coastguard Worker                                        StringRef Arg,
1493*9880d681SAndroid Build Coastguard Worker                                        unsigned long long &Value) {
1494*9880d681SAndroid Build Coastguard Worker 
1495*9880d681SAndroid Build Coastguard Worker   if (Arg.getAsInteger(0, Value))
1496*9880d681SAndroid Build Coastguard Worker     return O.error("'" + Arg + "' value invalid for uint argument!");
1497*9880d681SAndroid Build Coastguard Worker   return false;
1498*9880d681SAndroid Build Coastguard Worker }
1499*9880d681SAndroid Build Coastguard Worker 
1500*9880d681SAndroid Build Coastguard Worker // parser<double>/parser<float> implementation
1501*9880d681SAndroid Build Coastguard Worker //
parseDouble(Option & O,StringRef Arg,double & Value)1502*9880d681SAndroid Build Coastguard Worker static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1503*9880d681SAndroid Build Coastguard Worker   SmallString<32> TmpStr(Arg.begin(), Arg.end());
1504*9880d681SAndroid Build Coastguard Worker   const char *ArgStart = TmpStr.c_str();
1505*9880d681SAndroid Build Coastguard Worker   char *End;
1506*9880d681SAndroid Build Coastguard Worker   Value = strtod(ArgStart, &End);
1507*9880d681SAndroid Build Coastguard Worker   if (*End != 0)
1508*9880d681SAndroid Build Coastguard Worker     return O.error("'" + Arg + "' value invalid for floating point argument!");
1509*9880d681SAndroid Build Coastguard Worker   return false;
1510*9880d681SAndroid Build Coastguard Worker }
1511*9880d681SAndroid Build Coastguard Worker 
parse(Option & O,StringRef ArgName,StringRef Arg,double & Val)1512*9880d681SAndroid Build Coastguard Worker bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg,
1513*9880d681SAndroid Build Coastguard Worker                            double &Val) {
1514*9880d681SAndroid Build Coastguard Worker   return parseDouble(O, Arg, Val);
1515*9880d681SAndroid Build Coastguard Worker }
1516*9880d681SAndroid Build Coastguard Worker 
parse(Option & O,StringRef ArgName,StringRef Arg,float & Val)1517*9880d681SAndroid Build Coastguard Worker bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg,
1518*9880d681SAndroid Build Coastguard Worker                           float &Val) {
1519*9880d681SAndroid Build Coastguard Worker   double dVal;
1520*9880d681SAndroid Build Coastguard Worker   if (parseDouble(O, Arg, dVal))
1521*9880d681SAndroid Build Coastguard Worker     return true;
1522*9880d681SAndroid Build Coastguard Worker   Val = (float)dVal;
1523*9880d681SAndroid Build Coastguard Worker   return false;
1524*9880d681SAndroid Build Coastguard Worker }
1525*9880d681SAndroid Build Coastguard Worker 
1526*9880d681SAndroid Build Coastguard Worker // generic_parser_base implementation
1527*9880d681SAndroid Build Coastguard Worker //
1528*9880d681SAndroid Build Coastguard Worker 
1529*9880d681SAndroid Build Coastguard Worker // findOption - Return the option number corresponding to the specified
1530*9880d681SAndroid Build Coastguard Worker // argument string.  If the option is not found, getNumOptions() is returned.
1531*9880d681SAndroid Build Coastguard Worker //
findOption(const char * Name)1532*9880d681SAndroid Build Coastguard Worker unsigned generic_parser_base::findOption(const char *Name) {
1533*9880d681SAndroid Build Coastguard Worker   unsigned e = getNumOptions();
1534*9880d681SAndroid Build Coastguard Worker 
1535*9880d681SAndroid Build Coastguard Worker   for (unsigned i = 0; i != e; ++i) {
1536*9880d681SAndroid Build Coastguard Worker     if (strcmp(getOption(i), Name) == 0)
1537*9880d681SAndroid Build Coastguard Worker       return i;
1538*9880d681SAndroid Build Coastguard Worker   }
1539*9880d681SAndroid Build Coastguard Worker   return e;
1540*9880d681SAndroid Build Coastguard Worker }
1541*9880d681SAndroid Build Coastguard Worker 
1542*9880d681SAndroid Build Coastguard Worker // Return the width of the option tag for printing...
getOptionWidth(const Option & O) const1543*9880d681SAndroid Build Coastguard Worker size_t generic_parser_base::getOptionWidth(const Option &O) const {
1544*9880d681SAndroid Build Coastguard Worker   if (O.hasArgStr()) {
1545*9880d681SAndroid Build Coastguard Worker     size_t Size = O.ArgStr.size() + 6;
1546*9880d681SAndroid Build Coastguard Worker     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1547*9880d681SAndroid Build Coastguard Worker       Size = std::max(Size, std::strlen(getOption(i)) + 8);
1548*9880d681SAndroid Build Coastguard Worker     return Size;
1549*9880d681SAndroid Build Coastguard Worker   } else {
1550*9880d681SAndroid Build Coastguard Worker     size_t BaseSize = 0;
1551*9880d681SAndroid Build Coastguard Worker     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1552*9880d681SAndroid Build Coastguard Worker       BaseSize = std::max(BaseSize, std::strlen(getOption(i)) + 8);
1553*9880d681SAndroid Build Coastguard Worker     return BaseSize;
1554*9880d681SAndroid Build Coastguard Worker   }
1555*9880d681SAndroid Build Coastguard Worker }
1556*9880d681SAndroid Build Coastguard Worker 
1557*9880d681SAndroid Build Coastguard Worker // printOptionInfo - Print out information about this option.  The
1558*9880d681SAndroid Build Coastguard Worker // to-be-maintained width is specified.
1559*9880d681SAndroid Build Coastguard Worker //
printOptionInfo(const Option & O,size_t GlobalWidth) const1560*9880d681SAndroid Build Coastguard Worker void generic_parser_base::printOptionInfo(const Option &O,
1561*9880d681SAndroid Build Coastguard Worker                                           size_t GlobalWidth) const {
1562*9880d681SAndroid Build Coastguard Worker   if (O.hasArgStr()) {
1563*9880d681SAndroid Build Coastguard Worker     outs() << "  -" << O.ArgStr;
1564*9880d681SAndroid Build Coastguard Worker     printHelpStr(O.HelpStr, GlobalWidth, O.ArgStr.size() + 6);
1565*9880d681SAndroid Build Coastguard Worker 
1566*9880d681SAndroid Build Coastguard Worker     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1567*9880d681SAndroid Build Coastguard Worker       size_t NumSpaces = GlobalWidth - strlen(getOption(i)) - 8;
1568*9880d681SAndroid Build Coastguard Worker       outs() << "    =" << getOption(i);
1569*9880d681SAndroid Build Coastguard Worker       outs().indent(NumSpaces) << " -   " << getDescription(i) << '\n';
1570*9880d681SAndroid Build Coastguard Worker     }
1571*9880d681SAndroid Build Coastguard Worker   } else {
1572*9880d681SAndroid Build Coastguard Worker     if (!O.HelpStr.empty())
1573*9880d681SAndroid Build Coastguard Worker       outs() << "  " << O.HelpStr << '\n';
1574*9880d681SAndroid Build Coastguard Worker     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1575*9880d681SAndroid Build Coastguard Worker       const char *Option = getOption(i);
1576*9880d681SAndroid Build Coastguard Worker       outs() << "    -" << Option;
1577*9880d681SAndroid Build Coastguard Worker       printHelpStr(getDescription(i), GlobalWidth, std::strlen(Option) + 8);
1578*9880d681SAndroid Build Coastguard Worker     }
1579*9880d681SAndroid Build Coastguard Worker   }
1580*9880d681SAndroid Build Coastguard Worker }
1581*9880d681SAndroid Build Coastguard Worker 
1582*9880d681SAndroid Build Coastguard Worker static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1583*9880d681SAndroid Build Coastguard Worker 
1584*9880d681SAndroid Build Coastguard Worker // printGenericOptionDiff - Print the value of this option and it's default.
1585*9880d681SAndroid Build Coastguard Worker //
1586*9880d681SAndroid Build Coastguard Worker // "Generic" options have each value mapped to a name.
printGenericOptionDiff(const Option & O,const GenericOptionValue & Value,const GenericOptionValue & Default,size_t GlobalWidth) const1587*9880d681SAndroid Build Coastguard Worker void generic_parser_base::printGenericOptionDiff(
1588*9880d681SAndroid Build Coastguard Worker     const Option &O, const GenericOptionValue &Value,
1589*9880d681SAndroid Build Coastguard Worker     const GenericOptionValue &Default, size_t GlobalWidth) const {
1590*9880d681SAndroid Build Coastguard Worker   outs() << "  -" << O.ArgStr;
1591*9880d681SAndroid Build Coastguard Worker   outs().indent(GlobalWidth - O.ArgStr.size());
1592*9880d681SAndroid Build Coastguard Worker 
1593*9880d681SAndroid Build Coastguard Worker   unsigned NumOpts = getNumOptions();
1594*9880d681SAndroid Build Coastguard Worker   for (unsigned i = 0; i != NumOpts; ++i) {
1595*9880d681SAndroid Build Coastguard Worker     if (Value.compare(getOptionValue(i)))
1596*9880d681SAndroid Build Coastguard Worker       continue;
1597*9880d681SAndroid Build Coastguard Worker 
1598*9880d681SAndroid Build Coastguard Worker     outs() << "= " << getOption(i);
1599*9880d681SAndroid Build Coastguard Worker     size_t L = std::strlen(getOption(i));
1600*9880d681SAndroid Build Coastguard Worker     size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1601*9880d681SAndroid Build Coastguard Worker     outs().indent(NumSpaces) << " (default: ";
1602*9880d681SAndroid Build Coastguard Worker     for (unsigned j = 0; j != NumOpts; ++j) {
1603*9880d681SAndroid Build Coastguard Worker       if (Default.compare(getOptionValue(j)))
1604*9880d681SAndroid Build Coastguard Worker         continue;
1605*9880d681SAndroid Build Coastguard Worker       outs() << getOption(j);
1606*9880d681SAndroid Build Coastguard Worker       break;
1607*9880d681SAndroid Build Coastguard Worker     }
1608*9880d681SAndroid Build Coastguard Worker     outs() << ")\n";
1609*9880d681SAndroid Build Coastguard Worker     return;
1610*9880d681SAndroid Build Coastguard Worker   }
1611*9880d681SAndroid Build Coastguard Worker   outs() << "= *unknown option value*\n";
1612*9880d681SAndroid Build Coastguard Worker }
1613*9880d681SAndroid Build Coastguard Worker 
1614*9880d681SAndroid Build Coastguard Worker // printOptionDiff - Specializations for printing basic value types.
1615*9880d681SAndroid Build Coastguard Worker //
1616*9880d681SAndroid Build Coastguard Worker #define PRINT_OPT_DIFF(T)                                                      \
1617*9880d681SAndroid Build Coastguard Worker   void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D,      \
1618*9880d681SAndroid Build Coastguard Worker                                   size_t GlobalWidth) const {                  \
1619*9880d681SAndroid Build Coastguard Worker     printOptionName(O, GlobalWidth);                                           \
1620*9880d681SAndroid Build Coastguard Worker     std::string Str;                                                           \
1621*9880d681SAndroid Build Coastguard Worker     {                                                                          \
1622*9880d681SAndroid Build Coastguard Worker       raw_string_ostream SS(Str);                                              \
1623*9880d681SAndroid Build Coastguard Worker       SS << V;                                                                 \
1624*9880d681SAndroid Build Coastguard Worker     }                                                                          \
1625*9880d681SAndroid Build Coastguard Worker     outs() << "= " << Str;                                                     \
1626*9880d681SAndroid Build Coastguard Worker     size_t NumSpaces =                                                         \
1627*9880d681SAndroid Build Coastguard Worker         MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0;               \
1628*9880d681SAndroid Build Coastguard Worker     outs().indent(NumSpaces) << " (default: ";                                 \
1629*9880d681SAndroid Build Coastguard Worker     if (D.hasValue())                                                          \
1630*9880d681SAndroid Build Coastguard Worker       outs() << D.getValue();                                                  \
1631*9880d681SAndroid Build Coastguard Worker     else                                                                       \
1632*9880d681SAndroid Build Coastguard Worker       outs() << "*no default*";                                                \
1633*9880d681SAndroid Build Coastguard Worker     outs() << ")\n";                                                           \
1634*9880d681SAndroid Build Coastguard Worker   }
1635*9880d681SAndroid Build Coastguard Worker 
1636*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(bool)
PRINT_OPT_DIFF(boolOrDefault)1637*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(boolOrDefault)
1638*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(int)
1639*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(unsigned)
1640*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(unsigned long long)
1641*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(double)
1642*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(float)
1643*9880d681SAndroid Build Coastguard Worker PRINT_OPT_DIFF(char)
1644*9880d681SAndroid Build Coastguard Worker 
1645*9880d681SAndroid Build Coastguard Worker void parser<std::string>::printOptionDiff(const Option &O, StringRef V,
1646*9880d681SAndroid Build Coastguard Worker                                           const OptionValue<std::string> &D,
1647*9880d681SAndroid Build Coastguard Worker                                           size_t GlobalWidth) const {
1648*9880d681SAndroid Build Coastguard Worker   printOptionName(O, GlobalWidth);
1649*9880d681SAndroid Build Coastguard Worker   outs() << "= " << V;
1650*9880d681SAndroid Build Coastguard Worker   size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1651*9880d681SAndroid Build Coastguard Worker   outs().indent(NumSpaces) << " (default: ";
1652*9880d681SAndroid Build Coastguard Worker   if (D.hasValue())
1653*9880d681SAndroid Build Coastguard Worker     outs() << D.getValue();
1654*9880d681SAndroid Build Coastguard Worker   else
1655*9880d681SAndroid Build Coastguard Worker     outs() << "*no default*";
1656*9880d681SAndroid Build Coastguard Worker   outs() << ")\n";
1657*9880d681SAndroid Build Coastguard Worker }
1658*9880d681SAndroid Build Coastguard Worker 
1659*9880d681SAndroid Build Coastguard Worker // Print a placeholder for options that don't yet support printOptionDiff().
printOptionNoValue(const Option & O,size_t GlobalWidth) const1660*9880d681SAndroid Build Coastguard Worker void basic_parser_impl::printOptionNoValue(const Option &O,
1661*9880d681SAndroid Build Coastguard Worker                                            size_t GlobalWidth) const {
1662*9880d681SAndroid Build Coastguard Worker   printOptionName(O, GlobalWidth);
1663*9880d681SAndroid Build Coastguard Worker   outs() << "= *cannot print option value*\n";
1664*9880d681SAndroid Build Coastguard Worker }
1665*9880d681SAndroid Build Coastguard Worker 
1666*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
1667*9880d681SAndroid Build Coastguard Worker // -help and -help-hidden option implementation
1668*9880d681SAndroid Build Coastguard Worker //
1669*9880d681SAndroid Build Coastguard Worker 
OptNameCompare(const std::pair<const char *,Option * > * LHS,const std::pair<const char *,Option * > * RHS)1670*9880d681SAndroid Build Coastguard Worker static int OptNameCompare(const std::pair<const char *, Option *> *LHS,
1671*9880d681SAndroid Build Coastguard Worker                           const std::pair<const char *, Option *> *RHS) {
1672*9880d681SAndroid Build Coastguard Worker   return strcmp(LHS->first, RHS->first);
1673*9880d681SAndroid Build Coastguard Worker }
1674*9880d681SAndroid Build Coastguard Worker 
SubNameCompare(const std::pair<const char *,SubCommand * > * LHS,const std::pair<const char *,SubCommand * > * RHS)1675*9880d681SAndroid Build Coastguard Worker static int SubNameCompare(const std::pair<const char *, SubCommand *> *LHS,
1676*9880d681SAndroid Build Coastguard Worker                           const std::pair<const char *, SubCommand *> *RHS) {
1677*9880d681SAndroid Build Coastguard Worker   return strcmp(LHS->first, RHS->first);
1678*9880d681SAndroid Build Coastguard Worker }
1679*9880d681SAndroid Build Coastguard Worker 
1680*9880d681SAndroid Build Coastguard Worker // Copy Options into a vector so we can sort them as we like.
sortOpts(StringMap<Option * > & OptMap,SmallVectorImpl<std::pair<const char *,Option * >> & Opts,bool ShowHidden)1681*9880d681SAndroid Build Coastguard Worker static void sortOpts(StringMap<Option *> &OptMap,
1682*9880d681SAndroid Build Coastguard Worker                      SmallVectorImpl<std::pair<const char *, Option *>> &Opts,
1683*9880d681SAndroid Build Coastguard Worker                      bool ShowHidden) {
1684*9880d681SAndroid Build Coastguard Worker   SmallPtrSet<Option *, 32> OptionSet; // Duplicate option detection.
1685*9880d681SAndroid Build Coastguard Worker 
1686*9880d681SAndroid Build Coastguard Worker   for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end();
1687*9880d681SAndroid Build Coastguard Worker        I != E; ++I) {
1688*9880d681SAndroid Build Coastguard Worker     // Ignore really-hidden options.
1689*9880d681SAndroid Build Coastguard Worker     if (I->second->getOptionHiddenFlag() == ReallyHidden)
1690*9880d681SAndroid Build Coastguard Worker       continue;
1691*9880d681SAndroid Build Coastguard Worker 
1692*9880d681SAndroid Build Coastguard Worker     // Unless showhidden is set, ignore hidden flags.
1693*9880d681SAndroid Build Coastguard Worker     if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1694*9880d681SAndroid Build Coastguard Worker       continue;
1695*9880d681SAndroid Build Coastguard Worker 
1696*9880d681SAndroid Build Coastguard Worker     // If we've already seen this option, don't add it to the list again.
1697*9880d681SAndroid Build Coastguard Worker     if (!OptionSet.insert(I->second).second)
1698*9880d681SAndroid Build Coastguard Worker       continue;
1699*9880d681SAndroid Build Coastguard Worker 
1700*9880d681SAndroid Build Coastguard Worker     Opts.push_back(
1701*9880d681SAndroid Build Coastguard Worker         std::pair<const char *, Option *>(I->getKey().data(), I->second));
1702*9880d681SAndroid Build Coastguard Worker   }
1703*9880d681SAndroid Build Coastguard Worker 
1704*9880d681SAndroid Build Coastguard Worker   // Sort the options list alphabetically.
1705*9880d681SAndroid Build Coastguard Worker   array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare);
1706*9880d681SAndroid Build Coastguard Worker }
1707*9880d681SAndroid Build Coastguard Worker 
1708*9880d681SAndroid Build Coastguard Worker static void
sortSubCommands(const SmallPtrSetImpl<SubCommand * > & SubMap,SmallVectorImpl<std::pair<const char *,SubCommand * >> & Subs)1709*9880d681SAndroid Build Coastguard Worker sortSubCommands(const SmallPtrSetImpl<SubCommand *> &SubMap,
1710*9880d681SAndroid Build Coastguard Worker                 SmallVectorImpl<std::pair<const char *, SubCommand *>> &Subs) {
1711*9880d681SAndroid Build Coastguard Worker   for (const auto &S : SubMap) {
1712*9880d681SAndroid Build Coastguard Worker     if (S->getName() == nullptr)
1713*9880d681SAndroid Build Coastguard Worker       continue;
1714*9880d681SAndroid Build Coastguard Worker     Subs.push_back(std::make_pair(S->getName(), S));
1715*9880d681SAndroid Build Coastguard Worker   }
1716*9880d681SAndroid Build Coastguard Worker   array_pod_sort(Subs.begin(), Subs.end(), SubNameCompare);
1717*9880d681SAndroid Build Coastguard Worker }
1718*9880d681SAndroid Build Coastguard Worker 
1719*9880d681SAndroid Build Coastguard Worker namespace {
1720*9880d681SAndroid Build Coastguard Worker 
1721*9880d681SAndroid Build Coastguard Worker class HelpPrinter {
1722*9880d681SAndroid Build Coastguard Worker protected:
1723*9880d681SAndroid Build Coastguard Worker   const bool ShowHidden;
1724*9880d681SAndroid Build Coastguard Worker   typedef SmallVector<std::pair<const char *, Option *>, 128>
1725*9880d681SAndroid Build Coastguard Worker       StrOptionPairVector;
1726*9880d681SAndroid Build Coastguard Worker   typedef SmallVector<std::pair<const char *, SubCommand *>, 128>
1727*9880d681SAndroid Build Coastguard Worker       StrSubCommandPairVector;
1728*9880d681SAndroid Build Coastguard Worker   // Print the options. Opts is assumed to be alphabetically sorted.
printOptions(StrOptionPairVector & Opts,size_t MaxArgLen)1729*9880d681SAndroid Build Coastguard Worker   virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) {
1730*9880d681SAndroid Build Coastguard Worker     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1731*9880d681SAndroid Build Coastguard Worker       Opts[i].second->printOptionInfo(MaxArgLen);
1732*9880d681SAndroid Build Coastguard Worker   }
1733*9880d681SAndroid Build Coastguard Worker 
printSubCommands(StrSubCommandPairVector & Subs,size_t MaxSubLen)1734*9880d681SAndroid Build Coastguard Worker   void printSubCommands(StrSubCommandPairVector &Subs, size_t MaxSubLen) {
1735*9880d681SAndroid Build Coastguard Worker     for (const auto &S : Subs) {
1736*9880d681SAndroid Build Coastguard Worker       outs() << "  " << S.first;
1737*9880d681SAndroid Build Coastguard Worker       if (S.second->getDescription()) {
1738*9880d681SAndroid Build Coastguard Worker         outs().indent(MaxSubLen - strlen(S.first));
1739*9880d681SAndroid Build Coastguard Worker         outs() << " - " << S.second->getDescription();
1740*9880d681SAndroid Build Coastguard Worker       }
1741*9880d681SAndroid Build Coastguard Worker       outs() << "\n";
1742*9880d681SAndroid Build Coastguard Worker     }
1743*9880d681SAndroid Build Coastguard Worker   }
1744*9880d681SAndroid Build Coastguard Worker 
1745*9880d681SAndroid Build Coastguard Worker public:
HelpPrinter(bool showHidden)1746*9880d681SAndroid Build Coastguard Worker   explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {}
~HelpPrinter()1747*9880d681SAndroid Build Coastguard Worker   virtual ~HelpPrinter() {}
1748*9880d681SAndroid Build Coastguard Worker 
1749*9880d681SAndroid Build Coastguard Worker   // Invoke the printer.
operator =(bool Value)1750*9880d681SAndroid Build Coastguard Worker   void operator=(bool Value) {
1751*9880d681SAndroid Build Coastguard Worker     if (!Value)
1752*9880d681SAndroid Build Coastguard Worker       return;
1753*9880d681SAndroid Build Coastguard Worker 
1754*9880d681SAndroid Build Coastguard Worker     SubCommand *Sub = GlobalParser->getActiveSubCommand();
1755*9880d681SAndroid Build Coastguard Worker     auto &OptionsMap = Sub->OptionsMap;
1756*9880d681SAndroid Build Coastguard Worker     auto &PositionalOpts = Sub->PositionalOpts;
1757*9880d681SAndroid Build Coastguard Worker     auto &ConsumeAfterOpt = Sub->ConsumeAfterOpt;
1758*9880d681SAndroid Build Coastguard Worker 
1759*9880d681SAndroid Build Coastguard Worker     StrOptionPairVector Opts;
1760*9880d681SAndroid Build Coastguard Worker     sortOpts(OptionsMap, Opts, ShowHidden);
1761*9880d681SAndroid Build Coastguard Worker 
1762*9880d681SAndroid Build Coastguard Worker     StrSubCommandPairVector Subs;
1763*9880d681SAndroid Build Coastguard Worker     sortSubCommands(GlobalParser->RegisteredSubCommands, Subs);
1764*9880d681SAndroid Build Coastguard Worker 
1765*9880d681SAndroid Build Coastguard Worker     if (GlobalParser->ProgramOverview)
1766*9880d681SAndroid Build Coastguard Worker       outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n";
1767*9880d681SAndroid Build Coastguard Worker 
1768*9880d681SAndroid Build Coastguard Worker     if (Sub == &*TopLevelSubCommand)
1769*9880d681SAndroid Build Coastguard Worker       outs() << "USAGE: " << GlobalParser->ProgramName
1770*9880d681SAndroid Build Coastguard Worker              << " [subcommand] [options]";
1771*9880d681SAndroid Build Coastguard Worker     else {
1772*9880d681SAndroid Build Coastguard Worker       if (Sub->getDescription() != nullptr) {
1773*9880d681SAndroid Build Coastguard Worker         outs() << "SUBCOMMAND '" << Sub->getName()
1774*9880d681SAndroid Build Coastguard Worker                << "': " << Sub->getDescription() << "\n\n";
1775*9880d681SAndroid Build Coastguard Worker       }
1776*9880d681SAndroid Build Coastguard Worker       outs() << "USAGE: " << GlobalParser->ProgramName << " " << Sub->getName()
1777*9880d681SAndroid Build Coastguard Worker              << " [options]";
1778*9880d681SAndroid Build Coastguard Worker     }
1779*9880d681SAndroid Build Coastguard Worker 
1780*9880d681SAndroid Build Coastguard Worker     for (auto Opt : PositionalOpts) {
1781*9880d681SAndroid Build Coastguard Worker       if (Opt->hasArgStr())
1782*9880d681SAndroid Build Coastguard Worker         outs() << " --" << Opt->ArgStr;
1783*9880d681SAndroid Build Coastguard Worker       outs() << " " << Opt->HelpStr;
1784*9880d681SAndroid Build Coastguard Worker     }
1785*9880d681SAndroid Build Coastguard Worker 
1786*9880d681SAndroid Build Coastguard Worker     // Print the consume after option info if it exists...
1787*9880d681SAndroid Build Coastguard Worker     if (ConsumeAfterOpt)
1788*9880d681SAndroid Build Coastguard Worker       outs() << " " << ConsumeAfterOpt->HelpStr;
1789*9880d681SAndroid Build Coastguard Worker 
1790*9880d681SAndroid Build Coastguard Worker     if (Sub == &*TopLevelSubCommand && Subs.size() > 2) {
1791*9880d681SAndroid Build Coastguard Worker       // Compute the maximum subcommand length...
1792*9880d681SAndroid Build Coastguard Worker       size_t MaxSubLen = 0;
1793*9880d681SAndroid Build Coastguard Worker       for (size_t i = 0, e = Subs.size(); i != e; ++i)
1794*9880d681SAndroid Build Coastguard Worker         MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first));
1795*9880d681SAndroid Build Coastguard Worker 
1796*9880d681SAndroid Build Coastguard Worker       outs() << "\n\n";
1797*9880d681SAndroid Build Coastguard Worker       outs() << "SUBCOMMANDS:\n\n";
1798*9880d681SAndroid Build Coastguard Worker       printSubCommands(Subs, MaxSubLen);
1799*9880d681SAndroid Build Coastguard Worker       outs() << "\n";
1800*9880d681SAndroid Build Coastguard Worker       outs() << "  Type \"" << GlobalParser->ProgramName
1801*9880d681SAndroid Build Coastguard Worker              << " <subcommand> -help\" to get more help on a specific "
1802*9880d681SAndroid Build Coastguard Worker                 "subcommand";
1803*9880d681SAndroid Build Coastguard Worker     }
1804*9880d681SAndroid Build Coastguard Worker 
1805*9880d681SAndroid Build Coastguard Worker     outs() << "\n\n";
1806*9880d681SAndroid Build Coastguard Worker 
1807*9880d681SAndroid Build Coastguard Worker     // Compute the maximum argument length...
1808*9880d681SAndroid Build Coastguard Worker     size_t MaxArgLen = 0;
1809*9880d681SAndroid Build Coastguard Worker     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1810*9880d681SAndroid Build Coastguard Worker       MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1811*9880d681SAndroid Build Coastguard Worker 
1812*9880d681SAndroid Build Coastguard Worker     outs() << "OPTIONS:\n";
1813*9880d681SAndroid Build Coastguard Worker     printOptions(Opts, MaxArgLen);
1814*9880d681SAndroid Build Coastguard Worker 
1815*9880d681SAndroid Build Coastguard Worker     // Print any extra help the user has declared.
1816*9880d681SAndroid Build Coastguard Worker     for (auto I : GlobalParser->MoreHelp)
1817*9880d681SAndroid Build Coastguard Worker       outs() << I;
1818*9880d681SAndroid Build Coastguard Worker     GlobalParser->MoreHelp.clear();
1819*9880d681SAndroid Build Coastguard Worker 
1820*9880d681SAndroid Build Coastguard Worker     // Halt the program since help information was printed
1821*9880d681SAndroid Build Coastguard Worker     exit(0);
1822*9880d681SAndroid Build Coastguard Worker   }
1823*9880d681SAndroid Build Coastguard Worker };
1824*9880d681SAndroid Build Coastguard Worker 
1825*9880d681SAndroid Build Coastguard Worker class CategorizedHelpPrinter : public HelpPrinter {
1826*9880d681SAndroid Build Coastguard Worker public:
CategorizedHelpPrinter(bool showHidden)1827*9880d681SAndroid Build Coastguard Worker   explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {}
1828*9880d681SAndroid Build Coastguard Worker 
1829*9880d681SAndroid Build Coastguard Worker   // Helper function for printOptions().
1830*9880d681SAndroid Build Coastguard Worker   // It shall return a negative value if A's name should be lexicographically
1831*9880d681SAndroid Build Coastguard Worker   // ordered before B's name. It returns a value greater equal zero otherwise.
OptionCategoryCompare(OptionCategory * const * A,OptionCategory * const * B)1832*9880d681SAndroid Build Coastguard Worker   static int OptionCategoryCompare(OptionCategory *const *A,
1833*9880d681SAndroid Build Coastguard Worker                                    OptionCategory *const *B) {
1834*9880d681SAndroid Build Coastguard Worker     return strcmp((*A)->getName(), (*B)->getName());
1835*9880d681SAndroid Build Coastguard Worker   }
1836*9880d681SAndroid Build Coastguard Worker 
1837*9880d681SAndroid Build Coastguard Worker   // Make sure we inherit our base class's operator=()
1838*9880d681SAndroid Build Coastguard Worker   using HelpPrinter::operator=;
1839*9880d681SAndroid Build Coastguard Worker 
1840*9880d681SAndroid Build Coastguard Worker protected:
printOptions(StrOptionPairVector & Opts,size_t MaxArgLen)1841*9880d681SAndroid Build Coastguard Worker   void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override {
1842*9880d681SAndroid Build Coastguard Worker     std::vector<OptionCategory *> SortedCategories;
1843*9880d681SAndroid Build Coastguard Worker     std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions;
1844*9880d681SAndroid Build Coastguard Worker 
1845*9880d681SAndroid Build Coastguard Worker     // Collect registered option categories into vector in preparation for
1846*9880d681SAndroid Build Coastguard Worker     // sorting.
1847*9880d681SAndroid Build Coastguard Worker     for (auto I = GlobalParser->RegisteredOptionCategories.begin(),
1848*9880d681SAndroid Build Coastguard Worker               E = GlobalParser->RegisteredOptionCategories.end();
1849*9880d681SAndroid Build Coastguard Worker          I != E; ++I) {
1850*9880d681SAndroid Build Coastguard Worker       SortedCategories.push_back(*I);
1851*9880d681SAndroid Build Coastguard Worker     }
1852*9880d681SAndroid Build Coastguard Worker 
1853*9880d681SAndroid Build Coastguard Worker     // Sort the different option categories alphabetically.
1854*9880d681SAndroid Build Coastguard Worker     assert(SortedCategories.size() > 0 && "No option categories registered!");
1855*9880d681SAndroid Build Coastguard Worker     array_pod_sort(SortedCategories.begin(), SortedCategories.end(),
1856*9880d681SAndroid Build Coastguard Worker                    OptionCategoryCompare);
1857*9880d681SAndroid Build Coastguard Worker 
1858*9880d681SAndroid Build Coastguard Worker     // Create map to empty vectors.
1859*9880d681SAndroid Build Coastguard Worker     for (std::vector<OptionCategory *>::const_iterator
1860*9880d681SAndroid Build Coastguard Worker              I = SortedCategories.begin(),
1861*9880d681SAndroid Build Coastguard Worker              E = SortedCategories.end();
1862*9880d681SAndroid Build Coastguard Worker          I != E; ++I)
1863*9880d681SAndroid Build Coastguard Worker       CategorizedOptions[*I] = std::vector<Option *>();
1864*9880d681SAndroid Build Coastguard Worker 
1865*9880d681SAndroid Build Coastguard Worker     // Walk through pre-sorted options and assign into categories.
1866*9880d681SAndroid Build Coastguard Worker     // Because the options are already alphabetically sorted the
1867*9880d681SAndroid Build Coastguard Worker     // options within categories will also be alphabetically sorted.
1868*9880d681SAndroid Build Coastguard Worker     for (size_t I = 0, E = Opts.size(); I != E; ++I) {
1869*9880d681SAndroid Build Coastguard Worker       Option *Opt = Opts[I].second;
1870*9880d681SAndroid Build Coastguard Worker       assert(CategorizedOptions.count(Opt->Category) > 0 &&
1871*9880d681SAndroid Build Coastguard Worker              "Option has an unregistered category");
1872*9880d681SAndroid Build Coastguard Worker       CategorizedOptions[Opt->Category].push_back(Opt);
1873*9880d681SAndroid Build Coastguard Worker     }
1874*9880d681SAndroid Build Coastguard Worker 
1875*9880d681SAndroid Build Coastguard Worker     // Now do printing.
1876*9880d681SAndroid Build Coastguard Worker     for (std::vector<OptionCategory *>::const_iterator
1877*9880d681SAndroid Build Coastguard Worker              Category = SortedCategories.begin(),
1878*9880d681SAndroid Build Coastguard Worker              E = SortedCategories.end();
1879*9880d681SAndroid Build Coastguard Worker          Category != E; ++Category) {
1880*9880d681SAndroid Build Coastguard Worker       // Hide empty categories for -help, but show for -help-hidden.
1881*9880d681SAndroid Build Coastguard Worker       const auto &CategoryOptions = CategorizedOptions[*Category];
1882*9880d681SAndroid Build Coastguard Worker       bool IsEmptyCategory = CategoryOptions.empty();
1883*9880d681SAndroid Build Coastguard Worker       if (!ShowHidden && IsEmptyCategory)
1884*9880d681SAndroid Build Coastguard Worker         continue;
1885*9880d681SAndroid Build Coastguard Worker 
1886*9880d681SAndroid Build Coastguard Worker       // Print category information.
1887*9880d681SAndroid Build Coastguard Worker       outs() << "\n";
1888*9880d681SAndroid Build Coastguard Worker       outs() << (*Category)->getName() << ":\n";
1889*9880d681SAndroid Build Coastguard Worker 
1890*9880d681SAndroid Build Coastguard Worker       // Check if description is set.
1891*9880d681SAndroid Build Coastguard Worker       if ((*Category)->getDescription() != nullptr)
1892*9880d681SAndroid Build Coastguard Worker         outs() << (*Category)->getDescription() << "\n\n";
1893*9880d681SAndroid Build Coastguard Worker       else
1894*9880d681SAndroid Build Coastguard Worker         outs() << "\n";
1895*9880d681SAndroid Build Coastguard Worker 
1896*9880d681SAndroid Build Coastguard Worker       // When using -help-hidden explicitly state if the category has no
1897*9880d681SAndroid Build Coastguard Worker       // options associated with it.
1898*9880d681SAndroid Build Coastguard Worker       if (IsEmptyCategory) {
1899*9880d681SAndroid Build Coastguard Worker         outs() << "  This option category has no options.\n";
1900*9880d681SAndroid Build Coastguard Worker         continue;
1901*9880d681SAndroid Build Coastguard Worker       }
1902*9880d681SAndroid Build Coastguard Worker       // Loop over the options in the category and print.
1903*9880d681SAndroid Build Coastguard Worker       for (const Option *Opt : CategoryOptions)
1904*9880d681SAndroid Build Coastguard Worker         Opt->printOptionInfo(MaxArgLen);
1905*9880d681SAndroid Build Coastguard Worker     }
1906*9880d681SAndroid Build Coastguard Worker   }
1907*9880d681SAndroid Build Coastguard Worker };
1908*9880d681SAndroid Build Coastguard Worker 
1909*9880d681SAndroid Build Coastguard Worker // This wraps the Uncategorizing and Categorizing printers and decides
1910*9880d681SAndroid Build Coastguard Worker // at run time which should be invoked.
1911*9880d681SAndroid Build Coastguard Worker class HelpPrinterWrapper {
1912*9880d681SAndroid Build Coastguard Worker private:
1913*9880d681SAndroid Build Coastguard Worker   HelpPrinter &UncategorizedPrinter;
1914*9880d681SAndroid Build Coastguard Worker   CategorizedHelpPrinter &CategorizedPrinter;
1915*9880d681SAndroid Build Coastguard Worker 
1916*9880d681SAndroid Build Coastguard Worker public:
HelpPrinterWrapper(HelpPrinter & UncategorizedPrinter,CategorizedHelpPrinter & CategorizedPrinter)1917*9880d681SAndroid Build Coastguard Worker   explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
1918*9880d681SAndroid Build Coastguard Worker                               CategorizedHelpPrinter &CategorizedPrinter)
1919*9880d681SAndroid Build Coastguard Worker       : UncategorizedPrinter(UncategorizedPrinter),
1920*9880d681SAndroid Build Coastguard Worker         CategorizedPrinter(CategorizedPrinter) {}
1921*9880d681SAndroid Build Coastguard Worker 
1922*9880d681SAndroid Build Coastguard Worker   // Invoke the printer.
1923*9880d681SAndroid Build Coastguard Worker   void operator=(bool Value);
1924*9880d681SAndroid Build Coastguard Worker };
1925*9880d681SAndroid Build Coastguard Worker 
1926*9880d681SAndroid Build Coastguard Worker } // End anonymous namespace
1927*9880d681SAndroid Build Coastguard Worker 
1928*9880d681SAndroid Build Coastguard Worker // Declare the four HelpPrinter instances that are used to print out help, or
1929*9880d681SAndroid Build Coastguard Worker // help-hidden as an uncategorized list or in categories.
1930*9880d681SAndroid Build Coastguard Worker static HelpPrinter UncategorizedNormalPrinter(false);
1931*9880d681SAndroid Build Coastguard Worker static HelpPrinter UncategorizedHiddenPrinter(true);
1932*9880d681SAndroid Build Coastguard Worker static CategorizedHelpPrinter CategorizedNormalPrinter(false);
1933*9880d681SAndroid Build Coastguard Worker static CategorizedHelpPrinter CategorizedHiddenPrinter(true);
1934*9880d681SAndroid Build Coastguard Worker 
1935*9880d681SAndroid Build Coastguard Worker // Declare HelpPrinter wrappers that will decide whether or not to invoke
1936*9880d681SAndroid Build Coastguard Worker // a categorizing help printer
1937*9880d681SAndroid Build Coastguard Worker static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter,
1938*9880d681SAndroid Build Coastguard Worker                                                CategorizedNormalPrinter);
1939*9880d681SAndroid Build Coastguard Worker static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter,
1940*9880d681SAndroid Build Coastguard Worker                                                CategorizedHiddenPrinter);
1941*9880d681SAndroid Build Coastguard Worker 
1942*9880d681SAndroid Build Coastguard Worker // Define a category for generic options that all tools should have.
1943*9880d681SAndroid Build Coastguard Worker static cl::OptionCategory GenericCategory("Generic Options");
1944*9880d681SAndroid Build Coastguard Worker 
1945*9880d681SAndroid Build Coastguard Worker // Define uncategorized help printers.
1946*9880d681SAndroid Build Coastguard Worker // -help-list is hidden by default because if Option categories are being used
1947*9880d681SAndroid Build Coastguard Worker // then -help behaves the same as -help-list.
1948*9880d681SAndroid Build Coastguard Worker static cl::opt<HelpPrinter, true, parser<bool>> HLOp(
1949*9880d681SAndroid Build Coastguard Worker     "help-list",
1950*9880d681SAndroid Build Coastguard Worker     cl::desc("Display list of available options (-help-list-hidden for more)"),
1951*9880d681SAndroid Build Coastguard Worker     cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed,
1952*9880d681SAndroid Build Coastguard Worker     cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1953*9880d681SAndroid Build Coastguard Worker 
1954*9880d681SAndroid Build Coastguard Worker static cl::opt<HelpPrinter, true, parser<bool>>
1955*9880d681SAndroid Build Coastguard Worker     HLHOp("help-list-hidden", cl::desc("Display list of all available options"),
1956*9880d681SAndroid Build Coastguard Worker           cl::location(UncategorizedHiddenPrinter), cl::Hidden,
1957*9880d681SAndroid Build Coastguard Worker           cl::ValueDisallowed, cl::cat(GenericCategory),
1958*9880d681SAndroid Build Coastguard Worker           cl::sub(*AllSubCommands));
1959*9880d681SAndroid Build Coastguard Worker 
1960*9880d681SAndroid Build Coastguard Worker // Define uncategorized/categorized help printers. These printers change their
1961*9880d681SAndroid Build Coastguard Worker // behaviour at runtime depending on whether one or more Option categories have
1962*9880d681SAndroid Build Coastguard Worker // been declared.
1963*9880d681SAndroid Build Coastguard Worker static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1964*9880d681SAndroid Build Coastguard Worker     HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1965*9880d681SAndroid Build Coastguard Worker         cl::location(WrappedNormalPrinter), cl::ValueDisallowed,
1966*9880d681SAndroid Build Coastguard Worker         cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1967*9880d681SAndroid Build Coastguard Worker 
1968*9880d681SAndroid Build Coastguard Worker static cl::opt<HelpPrinterWrapper, true, parser<bool>>
1969*9880d681SAndroid Build Coastguard Worker     HHOp("help-hidden", cl::desc("Display all available options"),
1970*9880d681SAndroid Build Coastguard Worker          cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed,
1971*9880d681SAndroid Build Coastguard Worker          cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1972*9880d681SAndroid Build Coastguard Worker 
1973*9880d681SAndroid Build Coastguard Worker static cl::opt<bool> PrintOptions(
1974*9880d681SAndroid Build Coastguard Worker     "print-options",
1975*9880d681SAndroid Build Coastguard Worker     cl::desc("Print non-default options after command line parsing"),
1976*9880d681SAndroid Build Coastguard Worker     cl::Hidden, cl::init(false), cl::cat(GenericCategory),
1977*9880d681SAndroid Build Coastguard Worker     cl::sub(*AllSubCommands));
1978*9880d681SAndroid Build Coastguard Worker 
1979*9880d681SAndroid Build Coastguard Worker static cl::opt<bool> PrintAllOptions(
1980*9880d681SAndroid Build Coastguard Worker     "print-all-options",
1981*9880d681SAndroid Build Coastguard Worker     cl::desc("Print all option values after command line parsing"), cl::Hidden,
1982*9880d681SAndroid Build Coastguard Worker     cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands));
1983*9880d681SAndroid Build Coastguard Worker 
operator =(bool Value)1984*9880d681SAndroid Build Coastguard Worker void HelpPrinterWrapper::operator=(bool Value) {
1985*9880d681SAndroid Build Coastguard Worker   if (!Value)
1986*9880d681SAndroid Build Coastguard Worker     return;
1987*9880d681SAndroid Build Coastguard Worker 
1988*9880d681SAndroid Build Coastguard Worker   // Decide which printer to invoke. If more than one option category is
1989*9880d681SAndroid Build Coastguard Worker   // registered then it is useful to show the categorized help instead of
1990*9880d681SAndroid Build Coastguard Worker   // uncategorized help.
1991*9880d681SAndroid Build Coastguard Worker   if (GlobalParser->RegisteredOptionCategories.size() > 1) {
1992*9880d681SAndroid Build Coastguard Worker     // unhide -help-list option so user can have uncategorized output if they
1993*9880d681SAndroid Build Coastguard Worker     // want it.
1994*9880d681SAndroid Build Coastguard Worker     HLOp.setHiddenFlag(NotHidden);
1995*9880d681SAndroid Build Coastguard Worker 
1996*9880d681SAndroid Build Coastguard Worker     CategorizedPrinter = true; // Invoke categorized printer
1997*9880d681SAndroid Build Coastguard Worker   } else
1998*9880d681SAndroid Build Coastguard Worker     UncategorizedPrinter = true; // Invoke uncategorized printer
1999*9880d681SAndroid Build Coastguard Worker }
2000*9880d681SAndroid Build Coastguard Worker 
2001*9880d681SAndroid Build Coastguard Worker // Print the value of each option.
PrintOptionValues()2002*9880d681SAndroid Build Coastguard Worker void cl::PrintOptionValues() { GlobalParser->printOptionValues(); }
2003*9880d681SAndroid Build Coastguard Worker 
printOptionValues()2004*9880d681SAndroid Build Coastguard Worker void CommandLineParser::printOptionValues() {
2005*9880d681SAndroid Build Coastguard Worker   if (!PrintOptions && !PrintAllOptions)
2006*9880d681SAndroid Build Coastguard Worker     return;
2007*9880d681SAndroid Build Coastguard Worker 
2008*9880d681SAndroid Build Coastguard Worker   SmallVector<std::pair<const char *, Option *>, 128> Opts;
2009*9880d681SAndroid Build Coastguard Worker   sortOpts(ActiveSubCommand->OptionsMap, Opts, /*ShowHidden*/ true);
2010*9880d681SAndroid Build Coastguard Worker 
2011*9880d681SAndroid Build Coastguard Worker   // Compute the maximum argument length...
2012*9880d681SAndroid Build Coastguard Worker   size_t MaxArgLen = 0;
2013*9880d681SAndroid Build Coastguard Worker   for (size_t i = 0, e = Opts.size(); i != e; ++i)
2014*9880d681SAndroid Build Coastguard Worker     MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2015*9880d681SAndroid Build Coastguard Worker 
2016*9880d681SAndroid Build Coastguard Worker   for (size_t i = 0, e = Opts.size(); i != e; ++i)
2017*9880d681SAndroid Build Coastguard Worker     Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
2018*9880d681SAndroid Build Coastguard Worker }
2019*9880d681SAndroid Build Coastguard Worker 
2020*9880d681SAndroid Build Coastguard Worker static void (*OverrideVersionPrinter)() = nullptr;
2021*9880d681SAndroid Build Coastguard Worker 
2022*9880d681SAndroid Build Coastguard Worker static std::vector<void (*)()> *ExtraVersionPrinters = nullptr;
2023*9880d681SAndroid Build Coastguard Worker 
2024*9880d681SAndroid Build Coastguard Worker namespace {
2025*9880d681SAndroid Build Coastguard Worker class VersionPrinter {
2026*9880d681SAndroid Build Coastguard Worker public:
print()2027*9880d681SAndroid Build Coastguard Worker   void print() {
2028*9880d681SAndroid Build Coastguard Worker     raw_ostream &OS = outs();
2029*9880d681SAndroid Build Coastguard Worker #ifdef PACKAGE_VENDOR
2030*9880d681SAndroid Build Coastguard Worker     OS << PACKAGE_VENDOR << " ";
2031*9880d681SAndroid Build Coastguard Worker #else
2032*9880d681SAndroid Build Coastguard Worker     OS << "LLVM (http://llvm.org/):\n  ";
2033*9880d681SAndroid Build Coastguard Worker #endif
2034*9880d681SAndroid Build Coastguard Worker     OS << PACKAGE_NAME << " version " << PACKAGE_VERSION;
2035*9880d681SAndroid Build Coastguard Worker #ifdef LLVM_VERSION_INFO
2036*9880d681SAndroid Build Coastguard Worker     OS << " " << LLVM_VERSION_INFO;
2037*9880d681SAndroid Build Coastguard Worker #endif
2038*9880d681SAndroid Build Coastguard Worker     OS << "\n  ";
2039*9880d681SAndroid Build Coastguard Worker #ifndef __OPTIMIZE__
2040*9880d681SAndroid Build Coastguard Worker     OS << "DEBUG build";
2041*9880d681SAndroid Build Coastguard Worker #else
2042*9880d681SAndroid Build Coastguard Worker     OS << "Optimized build";
2043*9880d681SAndroid Build Coastguard Worker #endif
2044*9880d681SAndroid Build Coastguard Worker #ifndef NDEBUG
2045*9880d681SAndroid Build Coastguard Worker     OS << " with assertions";
2046*9880d681SAndroid Build Coastguard Worker #endif
2047*9880d681SAndroid Build Coastguard Worker     std::string CPU = sys::getHostCPUName();
2048*9880d681SAndroid Build Coastguard Worker     if (CPU == "generic")
2049*9880d681SAndroid Build Coastguard Worker       CPU = "(unknown)";
2050*9880d681SAndroid Build Coastguard Worker     OS << ".\n"
2051*9880d681SAndroid Build Coastguard Worker        << "  Default target: " << sys::getDefaultTargetTriple() << '\n'
2052*9880d681SAndroid Build Coastguard Worker        << "  Host CPU: " << CPU << '\n';
2053*9880d681SAndroid Build Coastguard Worker   }
operator =(bool OptionWasSpecified)2054*9880d681SAndroid Build Coastguard Worker   void operator=(bool OptionWasSpecified) {
2055*9880d681SAndroid Build Coastguard Worker     if (!OptionWasSpecified)
2056*9880d681SAndroid Build Coastguard Worker       return;
2057*9880d681SAndroid Build Coastguard Worker 
2058*9880d681SAndroid Build Coastguard Worker     if (OverrideVersionPrinter != nullptr) {
2059*9880d681SAndroid Build Coastguard Worker       (*OverrideVersionPrinter)();
2060*9880d681SAndroid Build Coastguard Worker       exit(0);
2061*9880d681SAndroid Build Coastguard Worker     }
2062*9880d681SAndroid Build Coastguard Worker     print();
2063*9880d681SAndroid Build Coastguard Worker 
2064*9880d681SAndroid Build Coastguard Worker     // Iterate over any registered extra printers and call them to add further
2065*9880d681SAndroid Build Coastguard Worker     // information.
2066*9880d681SAndroid Build Coastguard Worker     if (ExtraVersionPrinters != nullptr) {
2067*9880d681SAndroid Build Coastguard Worker       outs() << '\n';
2068*9880d681SAndroid Build Coastguard Worker       for (std::vector<void (*)()>::iterator I = ExtraVersionPrinters->begin(),
2069*9880d681SAndroid Build Coastguard Worker                                              E = ExtraVersionPrinters->end();
2070*9880d681SAndroid Build Coastguard Worker            I != E; ++I)
2071*9880d681SAndroid Build Coastguard Worker         (*I)();
2072*9880d681SAndroid Build Coastguard Worker     }
2073*9880d681SAndroid Build Coastguard Worker 
2074*9880d681SAndroid Build Coastguard Worker     exit(0);
2075*9880d681SAndroid Build Coastguard Worker   }
2076*9880d681SAndroid Build Coastguard Worker };
2077*9880d681SAndroid Build Coastguard Worker } // End anonymous namespace
2078*9880d681SAndroid Build Coastguard Worker 
2079*9880d681SAndroid Build Coastguard Worker // Define the --version option that prints out the LLVM version for the tool
2080*9880d681SAndroid Build Coastguard Worker static VersionPrinter VersionPrinterInstance;
2081*9880d681SAndroid Build Coastguard Worker 
2082*9880d681SAndroid Build Coastguard Worker static cl::opt<VersionPrinter, true, parser<bool>>
2083*9880d681SAndroid Build Coastguard Worker     VersOp("version", cl::desc("Display the version of this program"),
2084*9880d681SAndroid Build Coastguard Worker            cl::location(VersionPrinterInstance), cl::ValueDisallowed,
2085*9880d681SAndroid Build Coastguard Worker            cl::cat(GenericCategory));
2086*9880d681SAndroid Build Coastguard Worker 
2087*9880d681SAndroid Build Coastguard Worker // Utility function for printing the help message.
PrintHelpMessage(bool Hidden,bool Categorized)2088*9880d681SAndroid Build Coastguard Worker void cl::PrintHelpMessage(bool Hidden, bool Categorized) {
2089*9880d681SAndroid Build Coastguard Worker   // This looks weird, but it actually prints the help message. The Printers are
2090*9880d681SAndroid Build Coastguard Worker   // types of HelpPrinter and the help gets printed when its operator= is
2091*9880d681SAndroid Build Coastguard Worker   // invoked. That's because the "normal" usages of the help printer is to be
2092*9880d681SAndroid Build Coastguard Worker   // assigned true/false depending on whether -help or -help-hidden was given or
2093*9880d681SAndroid Build Coastguard Worker   // not.  Since we're circumventing that we have to make it look like -help or
2094*9880d681SAndroid Build Coastguard Worker   // -help-hidden were given, so we assign true.
2095*9880d681SAndroid Build Coastguard Worker 
2096*9880d681SAndroid Build Coastguard Worker   if (!Hidden && !Categorized)
2097*9880d681SAndroid Build Coastguard Worker     UncategorizedNormalPrinter = true;
2098*9880d681SAndroid Build Coastguard Worker   else if (!Hidden && Categorized)
2099*9880d681SAndroid Build Coastguard Worker     CategorizedNormalPrinter = true;
2100*9880d681SAndroid Build Coastguard Worker   else if (Hidden && !Categorized)
2101*9880d681SAndroid Build Coastguard Worker     UncategorizedHiddenPrinter = true;
2102*9880d681SAndroid Build Coastguard Worker   else
2103*9880d681SAndroid Build Coastguard Worker     CategorizedHiddenPrinter = true;
2104*9880d681SAndroid Build Coastguard Worker }
2105*9880d681SAndroid Build Coastguard Worker 
2106*9880d681SAndroid Build Coastguard Worker /// Utility function for printing version number.
PrintVersionMessage()2107*9880d681SAndroid Build Coastguard Worker void cl::PrintVersionMessage() { VersionPrinterInstance.print(); }
2108*9880d681SAndroid Build Coastguard Worker 
SetVersionPrinter(void (* func)())2109*9880d681SAndroid Build Coastguard Worker void cl::SetVersionPrinter(void (*func)()) { OverrideVersionPrinter = func; }
2110*9880d681SAndroid Build Coastguard Worker 
AddExtraVersionPrinter(void (* func)())2111*9880d681SAndroid Build Coastguard Worker void cl::AddExtraVersionPrinter(void (*func)()) {
2112*9880d681SAndroid Build Coastguard Worker   if (!ExtraVersionPrinters)
2113*9880d681SAndroid Build Coastguard Worker     ExtraVersionPrinters = new std::vector<void (*)()>;
2114*9880d681SAndroid Build Coastguard Worker 
2115*9880d681SAndroid Build Coastguard Worker   ExtraVersionPrinters->push_back(func);
2116*9880d681SAndroid Build Coastguard Worker }
2117*9880d681SAndroid Build Coastguard Worker 
getRegisteredOptions(SubCommand & Sub)2118*9880d681SAndroid Build Coastguard Worker StringMap<Option *> &cl::getRegisteredOptions(SubCommand &Sub) {
2119*9880d681SAndroid Build Coastguard Worker   auto &Subs = GlobalParser->RegisteredSubCommands;
2120*9880d681SAndroid Build Coastguard Worker   (void)Subs;
2121*9880d681SAndroid Build Coastguard Worker   assert(std::find(Subs.begin(), Subs.end(), &Sub) != Subs.end());
2122*9880d681SAndroid Build Coastguard Worker   return Sub.OptionsMap;
2123*9880d681SAndroid Build Coastguard Worker }
2124*9880d681SAndroid Build Coastguard Worker 
HideUnrelatedOptions(cl::OptionCategory & Category,SubCommand & Sub)2125*9880d681SAndroid Build Coastguard Worker void cl::HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub) {
2126*9880d681SAndroid Build Coastguard Worker   for (auto &I : Sub.OptionsMap) {
2127*9880d681SAndroid Build Coastguard Worker     if (I.second->Category != &Category &&
2128*9880d681SAndroid Build Coastguard Worker         I.second->Category != &GenericCategory)
2129*9880d681SAndroid Build Coastguard Worker       I.second->setHiddenFlag(cl::ReallyHidden);
2130*9880d681SAndroid Build Coastguard Worker   }
2131*9880d681SAndroid Build Coastguard Worker }
2132*9880d681SAndroid Build Coastguard Worker 
HideUnrelatedOptions(ArrayRef<const cl::OptionCategory * > Categories,SubCommand & Sub)2133*9880d681SAndroid Build Coastguard Worker void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories,
2134*9880d681SAndroid Build Coastguard Worker                               SubCommand &Sub) {
2135*9880d681SAndroid Build Coastguard Worker   auto CategoriesBegin = Categories.begin();
2136*9880d681SAndroid Build Coastguard Worker   auto CategoriesEnd = Categories.end();
2137*9880d681SAndroid Build Coastguard Worker   for (auto &I : Sub.OptionsMap) {
2138*9880d681SAndroid Build Coastguard Worker     if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) ==
2139*9880d681SAndroid Build Coastguard Worker             CategoriesEnd &&
2140*9880d681SAndroid Build Coastguard Worker         I.second->Category != &GenericCategory)
2141*9880d681SAndroid Build Coastguard Worker       I.second->setHiddenFlag(cl::ReallyHidden);
2142*9880d681SAndroid Build Coastguard Worker   }
2143*9880d681SAndroid Build Coastguard Worker }
2144*9880d681SAndroid Build Coastguard Worker 
ResetCommandLineParser()2145*9880d681SAndroid Build Coastguard Worker void cl::ResetCommandLineParser() { GlobalParser->reset(); }
ResetAllOptionOccurrences()2146*9880d681SAndroid Build Coastguard Worker void cl::ResetAllOptionOccurrences() {
2147*9880d681SAndroid Build Coastguard Worker   GlobalParser->ResetAllOptionOccurrences();
2148*9880d681SAndroid Build Coastguard Worker }
2149*9880d681SAndroid Build Coastguard Worker 
LLVMParseCommandLineOptions(int argc,const char * const * argv,const char * Overview)2150*9880d681SAndroid Build Coastguard Worker void LLVMParseCommandLineOptions(int argc, const char *const *argv,
2151*9880d681SAndroid Build Coastguard Worker                                  const char *Overview) {
2152*9880d681SAndroid Build Coastguard Worker   llvm::cl::ParseCommandLineOptions(argc, argv, Overview, true);
2153*9880d681SAndroid Build Coastguard Worker }
2154