annotate llvm/lib/Option/ArgList.cpp @ 236:c4bab56944e8 llvm-original

LLVM 16
author kono
date Wed, 09 Nov 2022 17:45:10 +0900
parents 1d019706d866
children 1f2b6ac9f198
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===- ArgList.cpp - Argument List Management -----------------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #include "llvm/ADT/ArrayRef.h"
anatofuz
parents:
diff changeset
10 #include "llvm/ADT/None.h"
anatofuz
parents:
diff changeset
11 #include "llvm/ADT/SmallVector.h"
anatofuz
parents:
diff changeset
12 #include "llvm/ADT/STLExtras.h"
anatofuz
parents:
diff changeset
13 #include "llvm/ADT/StringRef.h"
anatofuz
parents:
diff changeset
14 #include "llvm/ADT/Twine.h"
anatofuz
parents:
diff changeset
15 #include "llvm/Config/llvm-config.h"
anatofuz
parents:
diff changeset
16 #include "llvm/Option/Arg.h"
anatofuz
parents:
diff changeset
17 #include "llvm/Option/ArgList.h"
anatofuz
parents:
diff changeset
18 #include "llvm/Option/Option.h"
anatofuz
parents:
diff changeset
19 #include "llvm/Option/OptSpecifier.h"
anatofuz
parents:
diff changeset
20 #include "llvm/Support/Compiler.h"
anatofuz
parents:
diff changeset
21 #include "llvm/Support/Debug.h"
anatofuz
parents:
diff changeset
22 #include "llvm/Support/raw_ostream.h"
anatofuz
parents:
diff changeset
23 #include <algorithm>
anatofuz
parents:
diff changeset
24 #include <cassert>
anatofuz
parents:
diff changeset
25 #include <memory>
anatofuz
parents:
diff changeset
26 #include <string>
anatofuz
parents:
diff changeset
27 #include <utility>
anatofuz
parents:
diff changeset
28 #include <vector>
anatofuz
parents:
diff changeset
29
anatofuz
parents:
diff changeset
30 using namespace llvm;
anatofuz
parents:
diff changeset
31 using namespace llvm::opt;
anatofuz
parents:
diff changeset
32
anatofuz
parents:
diff changeset
33 void ArgList::append(Arg *A) {
anatofuz
parents:
diff changeset
34 Args.push_back(A);
anatofuz
parents:
diff changeset
35
anatofuz
parents:
diff changeset
36 // Update ranges for the option and all of its groups.
anatofuz
parents:
diff changeset
37 for (Option O = A->getOption().getUnaliasedOption(); O.isValid();
anatofuz
parents:
diff changeset
38 O = O.getGroup()) {
anatofuz
parents:
diff changeset
39 auto &R =
anatofuz
parents:
diff changeset
40 OptRanges.insert(std::make_pair(O.getID(), emptyRange())).first->second;
anatofuz
parents:
diff changeset
41 R.first = std::min<unsigned>(R.first, Args.size() - 1);
anatofuz
parents:
diff changeset
42 R.second = Args.size();
anatofuz
parents:
diff changeset
43 }
anatofuz
parents:
diff changeset
44 }
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 void ArgList::eraseArg(OptSpecifier Id) {
anatofuz
parents:
diff changeset
47 // Zero out the removed entries but keep them around so that we don't
anatofuz
parents:
diff changeset
48 // need to invalidate OptRanges.
anatofuz
parents:
diff changeset
49 for (Arg *const &A : filtered(Id)) {
anatofuz
parents:
diff changeset
50 // Avoid the need for a non-const filtered iterator variant.
anatofuz
parents:
diff changeset
51 Arg **ArgsBegin = Args.data();
anatofuz
parents:
diff changeset
52 ArgsBegin[&A - ArgsBegin] = nullptr;
anatofuz
parents:
diff changeset
53 }
anatofuz
parents:
diff changeset
54 OptRanges.erase(Id.getID());
anatofuz
parents:
diff changeset
55 }
anatofuz
parents:
diff changeset
56
anatofuz
parents:
diff changeset
57 ArgList::OptRange
anatofuz
parents:
diff changeset
58 ArgList::getRange(std::initializer_list<OptSpecifier> Ids) const {
anatofuz
parents:
diff changeset
59 OptRange R = emptyRange();
anatofuz
parents:
diff changeset
60 for (auto Id : Ids) {
anatofuz
parents:
diff changeset
61 auto I = OptRanges.find(Id.getID());
anatofuz
parents:
diff changeset
62 if (I != OptRanges.end()) {
anatofuz
parents:
diff changeset
63 R.first = std::min(R.first, I->second.first);
anatofuz
parents:
diff changeset
64 R.second = std::max(R.second, I->second.second);
anatofuz
parents:
diff changeset
65 }
anatofuz
parents:
diff changeset
66 }
anatofuz
parents:
diff changeset
67 // Map an empty {-1, 0} range to {0, 0} so it can be used to form iterators.
anatofuz
parents:
diff changeset
68 if (R.first == -1u)
anatofuz
parents:
diff changeset
69 R.first = 0;
anatofuz
parents:
diff changeset
70 return R;
anatofuz
parents:
diff changeset
71 }
anatofuz
parents:
diff changeset
72
anatofuz
parents:
diff changeset
73 bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default) const {
anatofuz
parents:
diff changeset
74 if (Arg *A = getLastArg(Pos, Neg))
anatofuz
parents:
diff changeset
75 return A->getOption().matches(Pos);
anatofuz
parents:
diff changeset
76 return Default;
anatofuz
parents:
diff changeset
77 }
anatofuz
parents:
diff changeset
78
anatofuz
parents:
diff changeset
79 bool ArgList::hasFlag(OptSpecifier Pos, OptSpecifier PosAlias, OptSpecifier Neg,
anatofuz
parents:
diff changeset
80 bool Default) const {
anatofuz
parents:
diff changeset
81 if (Arg *A = getLastArg(Pos, PosAlias, Neg))
anatofuz
parents:
diff changeset
82 return A->getOption().matches(Pos) || A->getOption().matches(PosAlias);
anatofuz
parents:
diff changeset
83 return Default;
anatofuz
parents:
diff changeset
84 }
anatofuz
parents:
diff changeset
85
anatofuz
parents:
diff changeset
86 StringRef ArgList::getLastArgValue(OptSpecifier Id, StringRef Default) const {
anatofuz
parents:
diff changeset
87 if (Arg *A = getLastArg(Id))
anatofuz
parents:
diff changeset
88 return A->getValue();
anatofuz
parents:
diff changeset
89 return Default;
anatofuz
parents:
diff changeset
90 }
anatofuz
parents:
diff changeset
91
anatofuz
parents:
diff changeset
92 std::vector<std::string> ArgList::getAllArgValues(OptSpecifier Id) const {
anatofuz
parents:
diff changeset
93 SmallVector<const char *, 16> Values;
anatofuz
parents:
diff changeset
94 AddAllArgValues(Values, Id);
anatofuz
parents:
diff changeset
95 return std::vector<std::string>(Values.begin(), Values.end());
anatofuz
parents:
diff changeset
96 }
anatofuz
parents:
diff changeset
97
236
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
98 void ArgList::addOptInFlag(ArgStringList &Output, OptSpecifier Pos,
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
99 OptSpecifier Neg) const {
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
100 if (Arg *A = getLastArg(Pos, Neg))
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
101 if (A->getOption().matches(Pos))
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
102 A->render(*this, Output);
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
103 }
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
104
150
anatofuz
parents:
diff changeset
105 void ArgList::AddAllArgsExcept(ArgStringList &Output,
anatofuz
parents:
diff changeset
106 ArrayRef<OptSpecifier> Ids,
anatofuz
parents:
diff changeset
107 ArrayRef<OptSpecifier> ExcludeIds) const {
anatofuz
parents:
diff changeset
108 for (const Arg *Arg : *this) {
anatofuz
parents:
diff changeset
109 bool Excluded = false;
anatofuz
parents:
diff changeset
110 for (OptSpecifier Id : ExcludeIds) {
anatofuz
parents:
diff changeset
111 if (Arg->getOption().matches(Id)) {
anatofuz
parents:
diff changeset
112 Excluded = true;
anatofuz
parents:
diff changeset
113 break;
anatofuz
parents:
diff changeset
114 }
anatofuz
parents:
diff changeset
115 }
anatofuz
parents:
diff changeset
116 if (!Excluded) {
anatofuz
parents:
diff changeset
117 for (OptSpecifier Id : Ids) {
anatofuz
parents:
diff changeset
118 if (Arg->getOption().matches(Id)) {
anatofuz
parents:
diff changeset
119 Arg->claim();
anatofuz
parents:
diff changeset
120 Arg->render(*this, Output);
anatofuz
parents:
diff changeset
121 break;
anatofuz
parents:
diff changeset
122 }
anatofuz
parents:
diff changeset
123 }
anatofuz
parents:
diff changeset
124 }
anatofuz
parents:
diff changeset
125 }
anatofuz
parents:
diff changeset
126 }
anatofuz
parents:
diff changeset
127
anatofuz
parents:
diff changeset
128 /// This is a nicer interface when you don't have a list of Ids to exclude.
anatofuz
parents:
diff changeset
129 void ArgList::AddAllArgs(ArgStringList &Output,
anatofuz
parents:
diff changeset
130 ArrayRef<OptSpecifier> Ids) const {
anatofuz
parents:
diff changeset
131 ArrayRef<OptSpecifier> Exclude = None;
anatofuz
parents:
diff changeset
132 AddAllArgsExcept(Output, Ids, Exclude);
anatofuz
parents:
diff changeset
133 }
anatofuz
parents:
diff changeset
134
anatofuz
parents:
diff changeset
135 /// This 3-opt variant of AddAllArgs could be eliminated in favor of one
anatofuz
parents:
diff changeset
136 /// that accepts a single specifier, given the above which accepts any number.
anatofuz
parents:
diff changeset
137 void ArgList::AddAllArgs(ArgStringList &Output, OptSpecifier Id0,
anatofuz
parents:
diff changeset
138 OptSpecifier Id1, OptSpecifier Id2) const {
236
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
139 for (auto *Arg : filtered(Id0, Id1, Id2)) {
150
anatofuz
parents:
diff changeset
140 Arg->claim();
anatofuz
parents:
diff changeset
141 Arg->render(*this, Output);
anatofuz
parents:
diff changeset
142 }
anatofuz
parents:
diff changeset
143 }
anatofuz
parents:
diff changeset
144
anatofuz
parents:
diff changeset
145 void ArgList::AddAllArgValues(ArgStringList &Output, OptSpecifier Id0,
anatofuz
parents:
diff changeset
146 OptSpecifier Id1, OptSpecifier Id2) const {
236
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
147 for (auto *Arg : filtered(Id0, Id1, Id2)) {
150
anatofuz
parents:
diff changeset
148 Arg->claim();
anatofuz
parents:
diff changeset
149 const auto &Values = Arg->getValues();
anatofuz
parents:
diff changeset
150 Output.append(Values.begin(), Values.end());
anatofuz
parents:
diff changeset
151 }
anatofuz
parents:
diff changeset
152 }
anatofuz
parents:
diff changeset
153
anatofuz
parents:
diff changeset
154 void ArgList::AddAllArgsTranslated(ArgStringList &Output, OptSpecifier Id0,
anatofuz
parents:
diff changeset
155 const char *Translation,
anatofuz
parents:
diff changeset
156 bool Joined) const {
236
c4bab56944e8 LLVM 16
kono
parents: 150
diff changeset
157 for (auto *Arg : filtered(Id0)) {
150
anatofuz
parents:
diff changeset
158 Arg->claim();
anatofuz
parents:
diff changeset
159
anatofuz
parents:
diff changeset
160 if (Joined) {
anatofuz
parents:
diff changeset
161 Output.push_back(MakeArgString(StringRef(Translation) +
anatofuz
parents:
diff changeset
162 Arg->getValue(0)));
anatofuz
parents:
diff changeset
163 } else {
anatofuz
parents:
diff changeset
164 Output.push_back(Translation);
anatofuz
parents:
diff changeset
165 Output.push_back(Arg->getValue(0));
anatofuz
parents:
diff changeset
166 }
anatofuz
parents:
diff changeset
167 }
anatofuz
parents:
diff changeset
168 }
anatofuz
parents:
diff changeset
169
anatofuz
parents:
diff changeset
170 void ArgList::ClaimAllArgs(OptSpecifier Id0) const {
anatofuz
parents:
diff changeset
171 for (auto *Arg : filtered(Id0))
anatofuz
parents:
diff changeset
172 Arg->claim();
anatofuz
parents:
diff changeset
173 }
anatofuz
parents:
diff changeset
174
anatofuz
parents:
diff changeset
175 void ArgList::ClaimAllArgs() const {
anatofuz
parents:
diff changeset
176 for (auto *Arg : *this)
anatofuz
parents:
diff changeset
177 if (!Arg->isClaimed())
anatofuz
parents:
diff changeset
178 Arg->claim();
anatofuz
parents:
diff changeset
179 }
anatofuz
parents:
diff changeset
180
anatofuz
parents:
diff changeset
181 const char *ArgList::GetOrMakeJoinedArgString(unsigned Index,
anatofuz
parents:
diff changeset
182 StringRef LHS,
anatofuz
parents:
diff changeset
183 StringRef RHS) const {
anatofuz
parents:
diff changeset
184 StringRef Cur = getArgString(Index);
anatofuz
parents:
diff changeset
185 if (Cur.size() == LHS.size() + RHS.size() &&
anatofuz
parents:
diff changeset
186 Cur.startswith(LHS) && Cur.endswith(RHS))
anatofuz
parents:
diff changeset
187 return Cur.data();
anatofuz
parents:
diff changeset
188
anatofuz
parents:
diff changeset
189 return MakeArgString(LHS + RHS);
anatofuz
parents:
diff changeset
190 }
anatofuz
parents:
diff changeset
191
anatofuz
parents:
diff changeset
192 void ArgList::print(raw_ostream &O) const {
anatofuz
parents:
diff changeset
193 for (Arg *A : *this) {
anatofuz
parents:
diff changeset
194 O << "* ";
anatofuz
parents:
diff changeset
195 A->print(O);
anatofuz
parents:
diff changeset
196 }
anatofuz
parents:
diff changeset
197 }
anatofuz
parents:
diff changeset
198
anatofuz
parents:
diff changeset
199 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
anatofuz
parents:
diff changeset
200 LLVM_DUMP_METHOD void ArgList::dump() const { print(dbgs()); }
anatofuz
parents:
diff changeset
201 #endif
anatofuz
parents:
diff changeset
202
anatofuz
parents:
diff changeset
203 void InputArgList::releaseMemory() {
anatofuz
parents:
diff changeset
204 // An InputArgList always owns its arguments.
anatofuz
parents:
diff changeset
205 for (Arg *A : *this)
anatofuz
parents:
diff changeset
206 delete A;
anatofuz
parents:
diff changeset
207 }
anatofuz
parents:
diff changeset
208
anatofuz
parents:
diff changeset
209 InputArgList::InputArgList(const char* const *ArgBegin,
anatofuz
parents:
diff changeset
210 const char* const *ArgEnd)
anatofuz
parents:
diff changeset
211 : NumInputArgStrings(ArgEnd - ArgBegin) {
anatofuz
parents:
diff changeset
212 ArgStrings.append(ArgBegin, ArgEnd);
anatofuz
parents:
diff changeset
213 }
anatofuz
parents:
diff changeset
214
anatofuz
parents:
diff changeset
215 unsigned InputArgList::MakeIndex(StringRef String0) const {
anatofuz
parents:
diff changeset
216 unsigned Index = ArgStrings.size();
anatofuz
parents:
diff changeset
217
anatofuz
parents:
diff changeset
218 // Tuck away so we have a reliable const char *.
anatofuz
parents:
diff changeset
219 SynthesizedStrings.push_back(std::string(String0));
anatofuz
parents:
diff changeset
220 ArgStrings.push_back(SynthesizedStrings.back().c_str());
anatofuz
parents:
diff changeset
221
anatofuz
parents:
diff changeset
222 return Index;
anatofuz
parents:
diff changeset
223 }
anatofuz
parents:
diff changeset
224
anatofuz
parents:
diff changeset
225 unsigned InputArgList::MakeIndex(StringRef String0,
anatofuz
parents:
diff changeset
226 StringRef String1) const {
anatofuz
parents:
diff changeset
227 unsigned Index0 = MakeIndex(String0);
anatofuz
parents:
diff changeset
228 unsigned Index1 = MakeIndex(String1);
anatofuz
parents:
diff changeset
229 assert(Index0 + 1 == Index1 && "Unexpected non-consecutive indices!");
anatofuz
parents:
diff changeset
230 (void) Index1;
anatofuz
parents:
diff changeset
231 return Index0;
anatofuz
parents:
diff changeset
232 }
anatofuz
parents:
diff changeset
233
anatofuz
parents:
diff changeset
234 const char *InputArgList::MakeArgStringRef(StringRef Str) const {
anatofuz
parents:
diff changeset
235 return getArgString(MakeIndex(Str));
anatofuz
parents:
diff changeset
236 }
anatofuz
parents:
diff changeset
237
anatofuz
parents:
diff changeset
238 DerivedArgList::DerivedArgList(const InputArgList &BaseArgs)
anatofuz
parents:
diff changeset
239 : BaseArgs(BaseArgs) {}
anatofuz
parents:
diff changeset
240
anatofuz
parents:
diff changeset
241 const char *DerivedArgList::MakeArgStringRef(StringRef Str) const {
anatofuz
parents:
diff changeset
242 return BaseArgs.MakeArgString(Str);
anatofuz
parents:
diff changeset
243 }
anatofuz
parents:
diff changeset
244
anatofuz
parents:
diff changeset
245 void DerivedArgList::AddSynthesizedArg(Arg *A) {
anatofuz
parents:
diff changeset
246 SynthesizedArgs.push_back(std::unique_ptr<Arg>(A));
anatofuz
parents:
diff changeset
247 }
anatofuz
parents:
diff changeset
248
anatofuz
parents:
diff changeset
249 Arg *DerivedArgList::MakeFlagArg(const Arg *BaseArg, const Option Opt) const {
anatofuz
parents:
diff changeset
250 SynthesizedArgs.push_back(
anatofuz
parents:
diff changeset
251 std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
anatofuz
parents:
diff changeset
252 BaseArgs.MakeIndex(Opt.getName()), BaseArg));
anatofuz
parents:
diff changeset
253 return SynthesizedArgs.back().get();
anatofuz
parents:
diff changeset
254 }
anatofuz
parents:
diff changeset
255
anatofuz
parents:
diff changeset
256 Arg *DerivedArgList::MakePositionalArg(const Arg *BaseArg, const Option Opt,
anatofuz
parents:
diff changeset
257 StringRef Value) const {
anatofuz
parents:
diff changeset
258 unsigned Index = BaseArgs.MakeIndex(Value);
anatofuz
parents:
diff changeset
259 SynthesizedArgs.push_back(
anatofuz
parents:
diff changeset
260 std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
anatofuz
parents:
diff changeset
261 Index, BaseArgs.getArgString(Index), BaseArg));
anatofuz
parents:
diff changeset
262 return SynthesizedArgs.back().get();
anatofuz
parents:
diff changeset
263 }
anatofuz
parents:
diff changeset
264
anatofuz
parents:
diff changeset
265 Arg *DerivedArgList::MakeSeparateArg(const Arg *BaseArg, const Option Opt,
anatofuz
parents:
diff changeset
266 StringRef Value) const {
anatofuz
parents:
diff changeset
267 unsigned Index = BaseArgs.MakeIndex(Opt.getName(), Value);
anatofuz
parents:
diff changeset
268 SynthesizedArgs.push_back(
anatofuz
parents:
diff changeset
269 std::make_unique<Arg>(Opt, MakeArgString(Opt.getPrefix() + Opt.getName()),
anatofuz
parents:
diff changeset
270 Index, BaseArgs.getArgString(Index + 1), BaseArg));
anatofuz
parents:
diff changeset
271 return SynthesizedArgs.back().get();
anatofuz
parents:
diff changeset
272 }
anatofuz
parents:
diff changeset
273
anatofuz
parents:
diff changeset
274 Arg *DerivedArgList::MakeJoinedArg(const Arg *BaseArg, const Option Opt,
anatofuz
parents:
diff changeset
275 StringRef Value) const {
anatofuz
parents:
diff changeset
276 unsigned Index = BaseArgs.MakeIndex((Opt.getName() + Value).str());
anatofuz
parents:
diff changeset
277 SynthesizedArgs.push_back(std::make_unique<Arg>(
anatofuz
parents:
diff changeset
278 Opt, MakeArgString(Opt.getPrefix() + Opt.getName()), Index,
anatofuz
parents:
diff changeset
279 BaseArgs.getArgString(Index) + Opt.getName().size(), BaseArg));
anatofuz
parents:
diff changeset
280 return SynthesizedArgs.back().get();
anatofuz
parents:
diff changeset
281 }