xref: /llvm-project/clang/lib/ASTMatchers/Dynamic/Registry.cpp (revision 5553d0d4cadc35733a910e7af5f8911105ff529d)
1 //===--- Registry.cpp - Matcher registry -------------------------===//
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 /// \file
11 /// \brief Registry map populated at static initialization time.
12 ///
13 //===------------------------------------------------------------===//
14 
15 #include "clang/ASTMatchers/Dynamic/Registry.h"
16 #include "Marshallers.h"
17 #include "clang/ASTMatchers/ASTMatchers.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Support/ManagedStatic.h"
21 #include <utility>
22 
23 namespace clang {
24 namespace ast_matchers {
25 namespace dynamic {
26 namespace {
27 
28 using internal::MatcherDescriptor;
29 
30 typedef llvm::StringMap<const MatcherDescriptor *> ConstructorMap;
31 class RegistryMaps {
32 public:
33   RegistryMaps();
34   ~RegistryMaps();
35 
36   const ConstructorMap &constructors() const { return Constructors; }
37 
38 private:
39   void registerMatcher(StringRef MatcherName, MatcherDescriptor *Callback);
40   ConstructorMap Constructors;
41 };
42 
43 void RegistryMaps::registerMatcher(StringRef MatcherName,
44                                    MatcherDescriptor *Callback) {
45   assert(Constructors.find(MatcherName) == Constructors.end());
46   Constructors[MatcherName] = Callback;
47 }
48 
49 #define REGISTER_MATCHER(name)                                                 \
50   registerMatcher(#name, internal::makeMatcherAutoMarshall(                    \
51                              ::clang::ast_matchers::name, #name));
52 
53 #define SPECIFIC_MATCHER_OVERLOAD(name, Id)                                    \
54   static_cast< ::clang::ast_matchers::name##_Type##Id>(                        \
55       ::clang::ast_matchers::name)
56 
57 #define REGISTER_OVERLOADED_2(name)                                            \
58   do {                                                                         \
59     MatcherDescriptor *Callbacks[] = {                                         \
60       internal::makeMatcherAutoMarshall(SPECIFIC_MATCHER_OVERLOAD(name, 0),    \
61                                         #name),                                \
62       internal::makeMatcherAutoMarshall(SPECIFIC_MATCHER_OVERLOAD(name, 1),    \
63                                         #name)                                 \
64     };                                                                         \
65     registerMatcher(#name,                                                     \
66                     new internal::OverloadedMatcherDescriptor(Callbacks));     \
67   } while (0)
68 
69 /// \brief Generate a registry map with all the known matchers.
70 RegistryMaps::RegistryMaps() {
71   // TODO: Here is the list of the missing matchers, grouped by reason.
72   //
73   // Need Variant/Parser fixes:
74   // ofKind
75   //
76   // Polymorphic + argument overload:
77   // findAll
78   //
79   // Other:
80   // loc
81   // equals
82   // equalsNode
83 
84   REGISTER_OVERLOADED_2(callee);
85   REGISTER_OVERLOADED_2(hasPrefix);
86   REGISTER_OVERLOADED_2(hasType);
87   REGISTER_OVERLOADED_2(isDerivedFrom);
88   REGISTER_OVERLOADED_2(isSameOrDerivedFrom);
89   REGISTER_OVERLOADED_2(pointsTo);
90   REGISTER_OVERLOADED_2(references);
91   REGISTER_OVERLOADED_2(thisPointerType);
92 
93   REGISTER_MATCHER(accessSpecDecl);
94   REGISTER_MATCHER(alignOfExpr);
95   REGISTER_MATCHER(allOf);
96   REGISTER_MATCHER(anyOf);
97   REGISTER_MATCHER(anything);
98   REGISTER_MATCHER(argumentCountIs);
99   REGISTER_MATCHER(arraySubscriptExpr);
100   REGISTER_MATCHER(arrayType);
101   REGISTER_MATCHER(asString);
102   REGISTER_MATCHER(asmStmt);
103   REGISTER_MATCHER(atomicType);
104   REGISTER_MATCHER(autoType);
105   REGISTER_MATCHER(binaryOperator);
106   REGISTER_MATCHER(bindTemporaryExpr);
107   REGISTER_MATCHER(blockPointerType);
108   REGISTER_MATCHER(boolLiteral);
109   REGISTER_MATCHER(breakStmt);
110   REGISTER_MATCHER(builtinType);
111   REGISTER_MATCHER(cStyleCastExpr);
112   REGISTER_MATCHER(callExpr);
113   REGISTER_MATCHER(caseStmt);
114   REGISTER_MATCHER(castExpr);
115   REGISTER_MATCHER(catchStmt);
116   REGISTER_MATCHER(characterLiteral);
117   REGISTER_MATCHER(classTemplateDecl);
118   REGISTER_MATCHER(classTemplateSpecializationDecl);
119   REGISTER_MATCHER(complexType);
120   REGISTER_MATCHER(compoundLiteralExpr);
121   REGISTER_MATCHER(compoundStmt);
122   REGISTER_MATCHER(conditionalOperator);
123   REGISTER_MATCHER(constCastExpr);
124   REGISTER_MATCHER(constantArrayType);
125   REGISTER_MATCHER(constructExpr);
126   REGISTER_MATCHER(constructorDecl);
127   REGISTER_MATCHER(containsDeclaration);
128   REGISTER_MATCHER(continueStmt);
129   REGISTER_MATCHER(ctorInitializer);
130   REGISTER_MATCHER(decl);
131   REGISTER_MATCHER(declCountIs);
132   REGISTER_MATCHER(declRefExpr);
133   REGISTER_MATCHER(declStmt);
134   REGISTER_MATCHER(declaratorDecl);
135   REGISTER_MATCHER(defaultArgExpr);
136   REGISTER_MATCHER(defaultStmt);
137   REGISTER_MATCHER(deleteExpr);
138   REGISTER_MATCHER(dependentSizedArrayType);
139   REGISTER_MATCHER(destructorDecl);
140   REGISTER_MATCHER(doStmt);
141   REGISTER_MATCHER(dynamicCastExpr);
142   REGISTER_MATCHER(eachOf);
143   REGISTER_MATCHER(elaboratedType);
144   REGISTER_MATCHER(enumConstantDecl);
145   REGISTER_MATCHER(enumDecl);
146   REGISTER_MATCHER(equalsBoundNode);
147   REGISTER_MATCHER(explicitCastExpr);
148   REGISTER_MATCHER(expr);
149   REGISTER_MATCHER(fieldDecl);
150   REGISTER_MATCHER(floatLiteral);
151   REGISTER_MATCHER(forEach);
152   REGISTER_MATCHER(forEachConstructorInitializer);
153   REGISTER_MATCHER(forEachDescendant);
154   REGISTER_MATCHER(forEachSwitchCase);
155   REGISTER_MATCHER(forField);
156   REGISTER_MATCHER(forRangeStmt);
157   REGISTER_MATCHER(forStmt);
158   REGISTER_MATCHER(friendDecl);
159   REGISTER_MATCHER(functionDecl);
160   REGISTER_MATCHER(functionTemplateDecl);
161   REGISTER_MATCHER(functionType);
162   REGISTER_MATCHER(functionalCastExpr);
163   REGISTER_MATCHER(gotoStmt);
164   REGISTER_MATCHER(has);
165   REGISTER_MATCHER(hasAncestor);
166   REGISTER_MATCHER(hasAnyArgument);
167   REGISTER_MATCHER(hasAnyConstructorInitializer);
168   REGISTER_MATCHER(hasAnyParameter);
169   REGISTER_MATCHER(hasAnySubstatement);
170   REGISTER_MATCHER(hasAnyTemplateArgument);
171   REGISTER_MATCHER(hasAnyUsingShadowDecl);
172   REGISTER_MATCHER(hasArgument);
173   REGISTER_MATCHER(hasArgumentOfType);
174   REGISTER_MATCHER(hasBase);
175   REGISTER_MATCHER(hasBody);
176   REGISTER_MATCHER(hasCanonicalType);
177   REGISTER_MATCHER(hasCaseConstant);
178   REGISTER_MATCHER(hasCondition);
179   REGISTER_MATCHER(hasConditionVariableStatement);
180   REGISTER_MATCHER(hasDeclContext);
181   REGISTER_MATCHER(hasDeclaration);
182   REGISTER_MATCHER(hasDeducedType);
183   REGISTER_MATCHER(hasDescendant);
184   REGISTER_MATCHER(hasDestinationType);
185   REGISTER_MATCHER(hasEitherOperand);
186   REGISTER_MATCHER(hasElementType);
187   REGISTER_MATCHER(hasFalseExpression);
188   REGISTER_MATCHER(hasImplicitDestinationType);
189   REGISTER_MATCHER(hasIncrement);
190   REGISTER_MATCHER(hasIndex);
191   REGISTER_MATCHER(hasInitializer);
192   REGISTER_MATCHER(hasLHS);
193   REGISTER_MATCHER(hasLocalQualifiers);
194   REGISTER_MATCHER(hasLoopInit);
195   REGISTER_MATCHER(hasMethod);
196   REGISTER_MATCHER(hasName);
197   REGISTER_MATCHER(hasObjectExpression);
198   REGISTER_MATCHER(hasOperatorName);
199   REGISTER_MATCHER(hasOverloadedOperatorName);
200   REGISTER_MATCHER(hasParameter);
201   REGISTER_MATCHER(hasParent);
202   REGISTER_MATCHER(hasQualifier);
203   REGISTER_MATCHER(hasRHS);
204   REGISTER_MATCHER(hasSingleDecl);
205   REGISTER_MATCHER(hasSize);
206   REGISTER_MATCHER(hasSizeExpr);
207   REGISTER_MATCHER(hasSourceExpression);
208   REGISTER_MATCHER(hasTargetDecl);
209   REGISTER_MATCHER(hasTemplateArgument);
210   REGISTER_MATCHER(hasTrueExpression);
211   REGISTER_MATCHER(hasTypeLoc);
212   REGISTER_MATCHER(hasUnaryOperand);
213   REGISTER_MATCHER(hasValueType);
214   REGISTER_MATCHER(ifStmt);
215   REGISTER_MATCHER(ignoringImpCasts);
216   REGISTER_MATCHER(ignoringParenCasts);
217   REGISTER_MATCHER(ignoringParenImpCasts);
218   REGISTER_MATCHER(implicitCastExpr);
219   REGISTER_MATCHER(incompleteArrayType);
220   REGISTER_MATCHER(initListExpr);
221   REGISTER_MATCHER(innerType);
222   REGISTER_MATCHER(integerLiteral);
223   REGISTER_MATCHER(isArrow);
224   REGISTER_MATCHER(isConst);
225   REGISTER_MATCHER(isConstQualified);
226   REGISTER_MATCHER(isDefinition);
227   REGISTER_MATCHER(isExplicitTemplateSpecialization);
228   REGISTER_MATCHER(isExternC);
229   REGISTER_MATCHER(isImplicit);
230   REGISTER_MATCHER(isInteger);
231   REGISTER_MATCHER(isOverride);
232   REGISTER_MATCHER(isPrivate);
233   REGISTER_MATCHER(isProtected);
234   REGISTER_MATCHER(isPublic);
235   REGISTER_MATCHER(isTemplateInstantiation);
236   REGISTER_MATCHER(isVirtual);
237   REGISTER_MATCHER(isWritten);
238   REGISTER_MATCHER(lValueReferenceType);
239   REGISTER_MATCHER(labelStmt);
240   REGISTER_MATCHER(lambdaExpr);
241   REGISTER_MATCHER(matchesName);
242   REGISTER_MATCHER(materializeTemporaryExpr);
243   REGISTER_MATCHER(member);
244   REGISTER_MATCHER(memberCallExpr);
245   REGISTER_MATCHER(memberExpr);
246   REGISTER_MATCHER(memberPointerType);
247   REGISTER_MATCHER(methodDecl);
248   REGISTER_MATCHER(namedDecl);
249   REGISTER_MATCHER(namesType);
250   REGISTER_MATCHER(namespaceDecl);
251   REGISTER_MATCHER(nestedNameSpecifier);
252   REGISTER_MATCHER(nestedNameSpecifierLoc);
253   REGISTER_MATCHER(newExpr);
254   REGISTER_MATCHER(nullPtrLiteralExpr);
255   REGISTER_MATCHER(nullStmt);
256   REGISTER_MATCHER(ofClass);
257   REGISTER_MATCHER(on);
258   REGISTER_MATCHER(onImplicitObjectArgument);
259   REGISTER_MATCHER(operatorCallExpr);
260   REGISTER_MATCHER(parameterCountIs);
261   REGISTER_MATCHER(parenType);
262   REGISTER_MATCHER(parmVarDecl);
263   REGISTER_MATCHER(pointee);
264   REGISTER_MATCHER(pointerType);
265   REGISTER_MATCHER(qualType);
266   REGISTER_MATCHER(rValueReferenceType);
267   REGISTER_MATCHER(recordDecl);
268   REGISTER_MATCHER(recordType);
269   REGISTER_MATCHER(referenceType);
270   REGISTER_MATCHER(refersToDeclaration);
271   REGISTER_MATCHER(refersToType);
272   REGISTER_MATCHER(reinterpretCastExpr);
273   REGISTER_MATCHER(returnStmt);
274   REGISTER_MATCHER(returns);
275   REGISTER_MATCHER(sizeOfExpr);
276   REGISTER_MATCHER(specifiesNamespace);
277   REGISTER_MATCHER(specifiesType);
278   REGISTER_MATCHER(specifiesTypeLoc);
279   REGISTER_MATCHER(statementCountIs);
280   REGISTER_MATCHER(staticCastExpr);
281   REGISTER_MATCHER(stmt);
282   REGISTER_MATCHER(stringLiteral);
283   REGISTER_MATCHER(switchCase);
284   REGISTER_MATCHER(switchStmt);
285   REGISTER_MATCHER(templateSpecializationType);
286   REGISTER_MATCHER(temporaryObjectExpr);
287   REGISTER_MATCHER(thisExpr);
288   REGISTER_MATCHER(throughUsingDecl);
289   REGISTER_MATCHER(throwExpr);
290   REGISTER_MATCHER(to);
291   REGISTER_MATCHER(tryStmt);
292   REGISTER_MATCHER(type);
293   REGISTER_MATCHER(typeLoc);
294   REGISTER_MATCHER(typedefType);
295   REGISTER_MATCHER(unaryExprOrTypeTraitExpr);
296   REGISTER_MATCHER(unaryOperator);
297   REGISTER_MATCHER(unaryTransformType);
298   REGISTER_MATCHER(unless);
299   REGISTER_MATCHER(unresolvedConstructExpr);
300   REGISTER_MATCHER(unresolvedUsingValueDecl);
301   REGISTER_MATCHER(userDefinedLiteral);
302   REGISTER_MATCHER(usingDecl);
303   REGISTER_MATCHER(varDecl);
304   REGISTER_MATCHER(variableArrayType);
305   REGISTER_MATCHER(whileStmt);
306   REGISTER_MATCHER(withInitializer);
307 }
308 
309 RegistryMaps::~RegistryMaps() {
310   for (ConstructorMap::iterator it = Constructors.begin(),
311                                 end = Constructors.end();
312        it != end; ++it) {
313     delete it->second;
314   }
315 }
316 
317 static llvm::ManagedStatic<RegistryMaps> RegistryData;
318 
319 } // anonymous namespace
320 
321 // static
322 llvm::Optional<MatcherCtor>
323 Registry::lookupMatcherCtor(StringRef MatcherName, const SourceRange &NameRange,
324                             Diagnostics *Error) {
325   ConstructorMap::const_iterator it =
326       RegistryData->constructors().find(MatcherName);
327   if (it == RegistryData->constructors().end()) {
328     Error->addError(NameRange, Error->ET_RegistryNotFound) << MatcherName;
329     return llvm::Optional<MatcherCtor>();
330   }
331 
332   return it->second;
333 }
334 
335 // static
336 VariantMatcher Registry::constructMatcher(MatcherCtor Ctor,
337                                           const SourceRange &NameRange,
338                                           ArrayRef<ParserValue> Args,
339                                           Diagnostics *Error) {
340   return Ctor->create(NameRange, Args, Error);
341 }
342 
343 // static
344 VariantMatcher Registry::constructBoundMatcher(MatcherCtor Ctor,
345                                                const SourceRange &NameRange,
346                                                StringRef BindID,
347                                                ArrayRef<ParserValue> Args,
348                                                Diagnostics *Error) {
349   VariantMatcher Out = constructMatcher(Ctor, NameRange, Args, Error);
350   if (Out.isNull()) return Out;
351 
352   llvm::Optional<DynTypedMatcher> Result = Out.getSingleMatcher();
353   if (Result.hasValue()) {
354     llvm::Optional<DynTypedMatcher> Bound = Result->tryBind(BindID);
355     if (Bound.hasValue()) {
356       return VariantMatcher::SingleMatcher(*Bound);
357     }
358   }
359   Error->addError(NameRange, Error->ET_RegistryNotBindable);
360   return VariantMatcher();
361 }
362 
363 }  // namespace dynamic
364 }  // namespace ast_matchers
365 }  // namespace clang
366