1 //===--- ArgList.cpp - Argument List Management ---------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/Option/ArgList.h"
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/Twine.h"
14 #include "llvm/Option/Arg.h"
15 #include "llvm/Option/Option.h"
16 #include "llvm/Support/Debug.h"
17 #include "llvm/Support/raw_ostream.h"
18 
19 using namespace llvm;
20 using namespace llvm::opt;
21 
22 void arg_iterator::SkipToNextArg() {
23   for (; Current != Args.end(); ++Current) {
24     // Done if there are no filters.
25     if (!Id0.isValid())
26       break;
27 
28     // Otherwise require a match.
29     const Option &O = (*Current)->getOption();
30     if (O.matches(Id0) ||
31         (Id1.isValid() && O.matches(Id1)) ||
32         (Id2.isValid() && O.matches(Id2)))
33       break;
34   }
35 }
36 
37 void ArgList::append(Arg *A) {
38   Args.push_back(A);
39 }
40 
41 void ArgList::eraseArg(OptSpecifier Id) {
42   Args.erase(
43       remove_if(*this, [=](Arg *A) { return A->getOption().matches(Id); }),
44       end());
45 }
46 
47 Arg *ArgList::getLastArgNoClaim(OptSpecifier Id) const {
48   // FIXME: Make search efficient?
49   for (const_reverse_iterator it = rbegin(), ie = rend(); it != ie; ++it)
50     if ((*it)->getOption().matches(Id))
51       return *it;
52   return nullptr;
53 }
54 
55 Arg *ArgList::getLastArgNoClaim(OptSpecifier Id0, OptSpecifier Id1) const {
56   // FIXME: Make search efficient?
57   for (const_reverse_iterator it = rbegin(), ie = rend(); it != ie; ++it)
58     if ((*it)->getOption().matches(Id0) ||
59         (*it)->getOption().matches(Id1))
60       return *it;
61   return nullptr;
62 }
63 
64 Arg *ArgList::getLastArgNoClaim(OptSpecifier Id0, OptSpecifier Id1,
65                                 OptSpecifier Id2) const {
66   // FIXME: Make search efficient?
67   for (const_reverse_iterator it = rbegin(), ie = rend(); it != ie; ++it)
68     if ((*it)->getOption().matches(Id0) || (*it)->getOption().matches(Id1) ||
69         (*it)->getOption().matches(Id2))
70       return *it;
71   return nullptr;
72 }
73 
74 Arg *ArgList::getLastArgNoClaim(OptSpecifier Id0, OptSpecifier Id1,
75                                 OptSpecifier Id2, OptSpecifier Id3) const {
76   // FIXME: Make search efficient?
77   for (const_reverse_iterator it = rbegin(), ie = rend(); it != ie; ++it)
78     if ((*it)->getOption().matches(Id0) || (*it)->getOption().matches(Id1) ||
79         (*it)->getOption().matches(Id2) || (*it)->getOption().matches(Id3))
80       return *it;
81   return nullptr;
82 }
83 
84 Arg *ArgList::getLastArg(OptSpecifier Id) const {
85   Arg *Res = nullptr;
86   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
87     if ((*it)->getOption().matches(Id)) {
88       Res = *it;
89       Res->claim();
90     }
91   }
92 
93   return Res;
94 }
95 
96 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1) const {
97   Arg *Res = nullptr;
98   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
99     if ((*it)->getOption().matches(Id0) ||
100         (*it)->getOption().matches(Id1)) {
101       Res = *it;
102       Res->claim();
103 
104     }
105   }
106 
107   return Res;
108 }
109 
110 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1,
111                          OptSpecifier Id2) const {
112   Arg *Res = nullptr;
113   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
114     if ((*it)->getOption().matches(Id0) ||
115         (*it)->getOption().matches(Id1) ||
116         (*it)->getOption().matches(Id2)) {
117       Res = *it;
118       Res->claim();
119     }
120   }
121 
122   return Res;
123 }
124 
125 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1,
126                          OptSpecifier Id2, OptSpecifier Id3) const {
127   Arg *Res = nullptr;
128   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
129     if ((*it)->getOption().matches(Id0) ||
130         (*it)->getOption().matches(Id1) ||
131         (*it)->getOption().matches(Id2) ||
132         (*it)->getOption().matches(Id3)) {
133       Res = *it;
134       Res->claim();
135     }
136   }
137 
138   return Res;
139 }
140 
141 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1,
142                          OptSpecifier Id2, OptSpecifier Id3,
143                          OptSpecifier Id4) const {
144   Arg *Res = nullptr;
145   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
146     if ((*it)->getOption().matches(Id0) ||
147         (*it)->getOption().matches(Id1) ||
148         (*it)->getOption().matches(Id2) ||
149         (*it)->getOption().matches(Id3) ||
150         (*it)->getOption().matches(Id4)) {
151       Res = *it;
152       Res->claim();
153     }
154   }
155 
156   return Res;
157 }
158 
159 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1,
160                          OptSpecifier Id2, OptSpecifier Id3,
161                          OptSpecifier Id4, OptSpecifier Id5) const {
162   Arg *Res = nullptr;
163   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
164     if ((*it)->getOption().matches(Id0) ||
165         (*it)->getOption().matches(Id1) ||
166         (*it)->getOption().matches(Id2) ||
167         (*it)->getOption().matches(Id3) ||
168         (*it)->getOption().matches(Id4) ||
169         (*it)->getOption().matches(Id5)) {
170       Res = *it;
171       Res->claim();
172     }
173   }
174 
175   return Res;
176 }
177 
178 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1,
179                          OptSpecifier Id2, OptSpecifier Id3,
180                          OptSpecifier Id4, OptSpecifier Id5,
181                          OptSpecifier Id6) const {
182   Arg *Res = nullptr;
183   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
184     if ((*it)->getOption().matches(Id0) ||
185         (*it)->getOption().matches(Id1) ||
186         (*it)->getOption().matches(Id2) ||
187         (*it)->getOption().matches(Id3) ||
188         (*it)->getOption().matches(Id4) ||
189         (*it)->getOption().matches(Id5) ||
190         (*it)->getOption().matches(Id6)) {
191       Res = *it;
192       Res->claim();
193     }
194   }
195 
196   return Res;
197 }
198 
199 Arg *ArgList::getLastArg(OptSpecifier Id0, OptSpecifier Id1,
200                          OptSpecifier Id2, OptSpecifier Id3,
201                          OptSpecifier Id4, OptSpecifier Id5,
202                          OptSpecifier Id6, OptSpecifier Id7) const {
203   Arg *Res = nullptr;
204   for (const_iterator it = begin(), ie = end(); it != ie; ++it) {
205     if ((*it)->getOption().matches(Id0) ||
206         (*it)->getOption().matches(Id1) ||
207         (*it)->getOption().matches(Id2) ||
208         (*it)->getOption().matches(Id3) ||
209         (*it)->getOption().matches(Id4) ||
210         (*it)->getOption().matches(Id5) ||
211         (*it)->getOption().matches(Id6) ||
212         (*it)->getOption().matches(Id7)) {
213       Res = *it;
214       Res->claim();
215     }
216   }
217 
218   return Res;
219 }
220 
221 bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default) const {
222   if (Arg *A = getLastArg(Pos, Neg))
223     return A->getOption().matches(Pos);
224   return Default;
225 }
226 
227 bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg,
228                       bool Default) const {
229   if (Arg *A = getLastArg(Pos, PosAlias, Neg))
230     return A->getOption().matches(Pos) || A->getOption().matches(PosAlias);
231   return Default;
232 }
233 
234 StringRef ArgList::getLastArgValue(OptSpecifier Id,
235                                          StringRef Default) const {
236   if (Arg *A = getLastArg(Id))
237     return A->getValue();
238   return Default;
239 }
240 
241 std::vector<std::string> ArgList::getAllArgValues(OptSpecifier Id) const {
242   SmallVector<const char *, 16> Values;
243   AddAllArgValues(Values, Id);
244   return std::vector<std::string>(Values.begin(), Values.end());
245 }
246 
247 void ArgList::AddLastArg(ArgStringList &Output, OptSpecifier Id) const {
248   if (Arg *A = getLastArg(Id)) {
249     A->claim();
250     A->render(*this, Output);
251   }
252 }
253 
254 void ArgList::AddLastArg(ArgStringList &Output, OptSpecifier Id0,
255                          OptSpecifier Id1) const {
256   if (Arg *A = getLastArg(Id0, Id1)) {
257     A->claim();
258     A->render(*this, Output);
259   }
260 }
261 
262 void ArgList::AddAllArgsExcept(ArgStringList &Output,
263                                ArrayRef<OptSpecifier> Ids,
264                                ArrayRef<OptSpecifier> ExcludeIds) const {
265   for (const Arg *Arg : Args) {
266     bool Excluded = false;
267     for (OptSpecifier Id : ExcludeIds) {
268       if (Arg->getOption().matches(Id)) {
269         Excluded = true;
270         break;
271       }
272     }
273     if (!Excluded) {
274       for (OptSpecifier Id : Ids) {
275         if (Arg->getOption().matches(Id)) {
276           Arg->claim();
277           Arg->render(*this, Output);
278           break;
279         }
280       }
281     }
282   }
283 }
284 
285 /// This is a nicer interface when you don't have a list of Ids to exclude.
286 void ArgList::AddAllArgs(ArgStringList &Output,
287                          ArrayRef<OptSpecifier> Ids) const {
288   ArrayRef<OptSpecifier> Exclude = None;
289   AddAllArgsExcept(Output, Ids, Exclude);
290 }
291 
292 /// This 3-opt variant of AddAllArgs could be eliminated in favor of one
293 /// that accepts a single specifier, given the above which accepts any number.
294 void ArgList::AddAllArgs(ArgStringList &Output, OptSpecifier Id0,
295                          OptSpecifier Id1, OptSpecifier Id2) const {
296   for (auto Arg: filtered(Id0, Id1, Id2)) {
297     Arg->claim();
298     Arg->render(*this, Output);
299   }
300 }
301 
302 void ArgList::AddAllArgValues(ArgStringList &Output, OptSpecifier Id0,
303                               OptSpecifier Id1, OptSpecifier Id2) const {
304   for (auto Arg : filtered(Id0, Id1, Id2)) {
305     Arg->claim();
306     const auto &Values = Arg->getValues();
307     Output.append(Values.begin(), Values.end());
308   }
309 }
310 
311 void ArgList::AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0,
312                                    const char *Translation,
313                                    bool Joined) const {
314   for (auto Arg: filtered(Id0)) {
315     Arg->claim();
316 
317     if (Joined) {
318       Output.push_back(MakeArgString(StringRef(Translation) +
319                                      Arg->getValue(0)));
320     } else {
321       Output.push_back(Translation);
322       Output.push_back(Arg->getValue(0));
323     }
324   }
325 }
326 
327 void ArgList::ClaimAllArgs(OptSpecifier Id0) const {
328   for (auto Arg : filtered(Id0))
329     Arg->claim();
330 }
331 
332 void ArgList::ClaimAllArgs() const {
333   for (const_iterator it = begin(), ie = end(); it != ie; ++it)
334     if (!(*it)->isClaimed())
335       (*it)->claim();
336 }
337 
338 const char *ArgList::GetOrMakeJoinedArgString(unsigned Index,
339                                               StringRef LHS,
340                                               StringRef RHS) const {
341   StringRef Cur = getArgString(Index);
342   if (Cur.size() == LHS.size() + RHS.size() &&
343       Cur.startswith(LHS) && Cur.endswith(RHS))
344     return Cur.data();
345 
346   return MakeArgString(LHS + RHS);
347 }
348 
349 void ArgList::print(raw_ostream &O) const {
350   for (Arg *A : *this) {
351     O << "* ";
352     A->print(O);
353   }
354 }
355 
356 LLVM_DUMP_METHOD void ArgList::dump() const { print(dbgs()); }
357 
358 //
359 
360 void InputArgList::releaseMemory() {
361   // An InputArgList always owns its arguments.
362   for (Arg *A : *this)
363     delete A;
364 }
365 
366 InputArgList::InputArgList(const char* const *ArgBegin,
367                            const char* const *ArgEnd)
368   : NumInputArgStrings(ArgEnd - ArgBegin) {
369   ArgStrings.append(ArgBegin, ArgEnd);
370 }
371 
372 unsigned InputArgList::MakeIndex(StringRef String0) const {
373   unsigned Index = ArgStrings.size();
374 
375   // Tuck away so we have a reliable const char *.
376   SynthesizedStrings.push_back(String0);
377   ArgStrings.push_back(SynthesizedStrings.back().c_str());
378 
379   return Index;
380 }
381 
382 unsigned InputArgList::MakeIndex(StringRef String0,
383                                  StringRef String1) const {
384   unsigned Index0 = MakeIndex(String0);
385   unsigned Index1 = MakeIndex(String1);
386   assert(Index0 + 1 == Index1 && "Unexpected non-consecutive indices!");
387   (void) Index1;
388   return Index0;
389 }
390 
391 const char *InputArgList::MakeArgStringRef(StringRef Str) const {
392   return getArgString(MakeIndex(Str));
393 }
394 
395 //
396 
397 DerivedArgList::DerivedArgList(const InputArgList &BaseArgs)
398     : BaseArgs(BaseArgs) {}
399 
400 const char *DerivedArgList::MakeArgStringRef(StringRef Str) const {
401   return BaseArgs.MakeArgString(Str);
402 }
403 
404 void DerivedArgList::AddSynthesizedArg(Arg *A) {
405   SynthesizedArgs.push_back(std::unique_ptr<Arg>(A));
406 }
407 
408 Arg *DerivedArgList::MakeFlagArg(const Arg *BaseArg, const Option Opt) const {
409   SynthesizedArgs.push_back(
410       make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
411                        BaseArgs.MakeIndex(Opt.getName()), BaseArg));
412   return SynthesizedArgs.back().get();
413 }
414 
415 Arg *DerivedArgList::MakePositionalArg(const Arg *BaseArg, const Option Opt,
416                                        StringRef Value) const {
417   unsigned Index = BaseArgs.MakeIndex(Value);
418   SynthesizedArgs.push_back(
419       make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
420                        Index, BaseArgs.getArgString(Index), BaseArg));
421   return SynthesizedArgs.back().get();
422 }
423 
424 Arg *DerivedArgList::MakeSeparateArg(const Arg *BaseArg, const Option Opt,
425                                      StringRef Value) const {
426   unsigned Index = BaseArgs.MakeIndex(Opt.getName(), Value);
427   SynthesizedArgs.push_back(
428       make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
429                        Index, BaseArgs.getArgString(Index + 1), BaseArg));
430   return SynthesizedArgs.back().get();
431 }
432 
433 Arg *DerivedArgList::MakeJoinedArg(const Arg *BaseArg, const Option Opt,
434                                    StringRef Value) const {
435   unsigned Index = BaseArgs.MakeIndex((Opt.getName() + Value).str());
436   SynthesizedArgs.push_back(make_unique<Arg>(
437       Opt, MakeArgString(Opt.getPrefix() + Opt.getName()), Index,
438       BaseArgs.getArgString(Index) + Opt.getName().size(), BaseArg));
439   return SynthesizedArgs.back().get();
440 }
441