xref: /llvm-project/clang/lib/ASTMatchers/Dynamic/Registry.cpp (revision 31d68804fd4612f0ba1c99ca6686c3825044b46d)
1 //===- Registry.cpp - Matcher registry ------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// Registry map populated at static initialization time.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/ASTMatchers/Dynamic/Registry.h"
15 #include "Marshallers.h"
16 #include "clang/AST/ASTTypeTraits.h"
17 #include "clang/ASTMatchers/ASTMatchers.h"
18 #include "clang/ASTMatchers/Dynamic/Diagnostics.h"
19 #include "clang/ASTMatchers/Dynamic/VariantValue.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/ADT/StringRef.h"
24 #include "llvm/Support/ManagedStatic.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include <cassert>
27 #include <iterator>
28 #include <memory>
29 #include <set>
30 #include <string>
31 #include <utility>
32 #include <vector>
33 
34 using namespace clang::ast_type_traits;
35 
36 namespace clang {
37 namespace ast_matchers {
38 namespace dynamic {
39 
40 namespace {
41 
42 using internal::MatcherDescriptor;
43 
44 using ConstructorMap = llvm::StringMap<std::unique_ptr<const MatcherDescriptor>>;
45 
46 class RegistryMaps {
47 public:
48   RegistryMaps();
49   ~RegistryMaps();
50 
51   const ConstructorMap &constructors() const { return Constructors; }
52 
53 private:
54   void registerMatcher(StringRef MatcherName,
55                        std::unique_ptr<MatcherDescriptor> Callback);
56 
57   ConstructorMap Constructors;
58 };
59 
60 } // namespace
61 
62 void RegistryMaps::registerMatcher(
63     StringRef MatcherName, std::unique_ptr<MatcherDescriptor> Callback) {
64   assert(Constructors.find(MatcherName) == Constructors.end());
65   Constructors[MatcherName] = std::move(Callback);
66 }
67 
68 #define REGISTER_MATCHER(name)                                                 \
69   registerMatcher(#name, internal::makeMatcherAutoMarshall(                    \
70                              ::clang::ast_matchers::name, #name));
71 
72 #define REGISTER_MATCHER_OVERLOAD(name)                                        \
73   registerMatcher(#name,                                                       \
74       llvm::make_unique<internal::OverloadedMatcherDescriptor>(name##Callbacks))
75 
76 #define SPECIFIC_MATCHER_OVERLOAD(name, Id)                                    \
77   static_cast<::clang::ast_matchers::name##_Type##Id>(                         \
78       ::clang::ast_matchers::name)
79 
80 #define MATCHER_OVERLOAD_ENTRY(name, Id)                                       \
81         internal::makeMatcherAutoMarshall(SPECIFIC_MATCHER_OVERLOAD(name, Id), \
82                                           #name)
83 
84 #define REGISTER_OVERLOADED_2(name)                                            \
85   do {                                                                         \
86     std::unique_ptr<MatcherDescriptor> name##Callbacks[] = {                   \
87         MATCHER_OVERLOAD_ENTRY(name, 0),                                       \
88         MATCHER_OVERLOAD_ENTRY(name, 1)};                                      \
89     REGISTER_MATCHER_OVERLOAD(name);                                           \
90   } while (false)
91 
92 /// Generate a registry map with all the known matchers.
93 /// Please keep sorted alphabetically!
94 RegistryMaps::RegistryMaps() {
95   // TODO: Here is the list of the missing matchers, grouped by reason.
96   //
97   // Need Variant/Parser fixes:
98   // ofKind
99   //
100   // Polymorphic + argument overload:
101   // findAll
102   //
103   // Other:
104   // equalsNode
105 
106   REGISTER_OVERLOADED_2(callee);
107   REGISTER_OVERLOADED_2(hasPrefix);
108   REGISTER_OVERLOADED_2(hasType);
109   REGISTER_OVERLOADED_2(ignoringParens);
110   REGISTER_OVERLOADED_2(isDerivedFrom);
111   REGISTER_OVERLOADED_2(isSameOrDerivedFrom);
112   REGISTER_OVERLOADED_2(loc);
113   REGISTER_OVERLOADED_2(pointsTo);
114   REGISTER_OVERLOADED_2(references);
115   REGISTER_OVERLOADED_2(thisPointerType);
116 
117   std::unique_ptr<MatcherDescriptor> equalsCallbacks[] = {
118       MATCHER_OVERLOAD_ENTRY(equals, 0),
119       MATCHER_OVERLOAD_ENTRY(equals, 1),
120       MATCHER_OVERLOAD_ENTRY(equals, 2),
121   };
122   REGISTER_MATCHER_OVERLOAD(equals);
123 
124   REGISTER_MATCHER(accessSpecDecl);
125   REGISTER_MATCHER(addrLabelExpr);
126   REGISTER_MATCHER(alignOfExpr);
127   REGISTER_MATCHER(allOf);
128   REGISTER_MATCHER(anyOf);
129   REGISTER_MATCHER(anything);
130   REGISTER_MATCHER(argumentCountIs);
131   REGISTER_MATCHER(arraySubscriptExpr);
132   REGISTER_MATCHER(arrayType);
133   REGISTER_MATCHER(asString);
134   REGISTER_MATCHER(asmStmt);
135   REGISTER_MATCHER(atomicExpr);
136   REGISTER_MATCHER(atomicType);
137   REGISTER_MATCHER(autoType);
138   REGISTER_MATCHER(autoreleasePoolStmt)
139   REGISTER_MATCHER(binaryConditionalOperator);
140   REGISTER_MATCHER(binaryOperator);
141   REGISTER_MATCHER(blockDecl);
142   REGISTER_MATCHER(blockExpr);
143   REGISTER_MATCHER(blockPointerType);
144   REGISTER_MATCHER(booleanType);
145   REGISTER_MATCHER(breakStmt);
146   REGISTER_MATCHER(builtinType);
147   REGISTER_MATCHER(cStyleCastExpr);
148   REGISTER_MATCHER(callExpr);
149   REGISTER_MATCHER(caseStmt);
150   REGISTER_MATCHER(castExpr);
151   REGISTER_MATCHER(characterLiteral);
152   REGISTER_MATCHER(chooseExpr);
153   REGISTER_MATCHER(classTemplateDecl);
154   REGISTER_MATCHER(classTemplateSpecializationDecl);
155   REGISTER_MATCHER(complexType);
156   REGISTER_MATCHER(compoundLiteralExpr);
157   REGISTER_MATCHER(compoundStmt);
158   REGISTER_MATCHER(conditionalOperator);
159   REGISTER_MATCHER(constantArrayType);
160   REGISTER_MATCHER(constantExpr);
161   REGISTER_MATCHER(containsDeclaration);
162   REGISTER_MATCHER(continueStmt);
163   REGISTER_MATCHER(cudaKernelCallExpr);
164   REGISTER_MATCHER(cxxBindTemporaryExpr);
165   REGISTER_MATCHER(cxxBoolLiteral);
166   REGISTER_MATCHER(cxxCatchStmt);
167   REGISTER_MATCHER(cxxConstCastExpr);
168   REGISTER_MATCHER(cxxConstructExpr);
169   REGISTER_MATCHER(cxxConstructorDecl);
170   REGISTER_MATCHER(cxxConversionDecl);
171   REGISTER_MATCHER(cxxCtorInitializer);
172   REGISTER_MATCHER(cxxDefaultArgExpr);
173   REGISTER_MATCHER(cxxDeleteExpr);
174   REGISTER_MATCHER(cxxDependentScopeMemberExpr);
175   REGISTER_MATCHER(cxxDestructorDecl);
176   REGISTER_MATCHER(cxxDynamicCastExpr);
177   REGISTER_MATCHER(cxxForRangeStmt);
178   REGISTER_MATCHER(cxxFunctionalCastExpr);
179   REGISTER_MATCHER(cxxMemberCallExpr);
180   REGISTER_MATCHER(cxxMethodDecl);
181   REGISTER_MATCHER(cxxNewExpr);
182   REGISTER_MATCHER(cxxNullPtrLiteralExpr);
183   REGISTER_MATCHER(cxxOperatorCallExpr);
184   REGISTER_MATCHER(cxxRecordDecl);
185   REGISTER_MATCHER(cxxReinterpretCastExpr);
186   REGISTER_MATCHER(cxxStaticCastExpr);
187   REGISTER_MATCHER(cxxStdInitializerListExpr);
188   REGISTER_MATCHER(cxxTemporaryObjectExpr);
189   REGISTER_MATCHER(cxxThisExpr);
190   REGISTER_MATCHER(cxxThrowExpr);
191   REGISTER_MATCHER(cxxTryStmt);
192   REGISTER_MATCHER(cxxUnresolvedConstructExpr);
193   REGISTER_MATCHER(decayedType);
194   REGISTER_MATCHER(decl);
195   REGISTER_MATCHER(declCountIs);
196   REGISTER_MATCHER(declRefExpr);
197   REGISTER_MATCHER(declStmt);
198   REGISTER_MATCHER(declaratorDecl);
199   REGISTER_MATCHER(decltypeType);
200   REGISTER_MATCHER(defaultStmt);
201   REGISTER_MATCHER(dependentSizedArrayType);
202   REGISTER_MATCHER(designatedInitExpr);
203   REGISTER_MATCHER(designatorCountIs);
204   REGISTER_MATCHER(doStmt);
205   REGISTER_MATCHER(eachOf);
206   REGISTER_MATCHER(elaboratedType);
207   REGISTER_MATCHER(enumConstantDecl);
208   REGISTER_MATCHER(enumDecl);
209   REGISTER_MATCHER(enumType);
210   REGISTER_MATCHER(equalsBoundNode);
211   REGISTER_MATCHER(equalsIntegralValue);
212   REGISTER_MATCHER(explicitCastExpr);
213   REGISTER_MATCHER(expr);
214   REGISTER_MATCHER(exprWithCleanups);
215   REGISTER_MATCHER(fieldDecl);
216   REGISTER_MATCHER(floatLiteral);
217   REGISTER_MATCHER(forEach);
218   REGISTER_MATCHER(forEachArgumentWithParam);
219   REGISTER_MATCHER(forEachConstructorInitializer);
220   REGISTER_MATCHER(forEachDescendant);
221   REGISTER_MATCHER(forEachOverridden);
222   REGISTER_MATCHER(forEachSwitchCase);
223   REGISTER_MATCHER(forField);
224   REGISTER_MATCHER(forFunction);
225   REGISTER_MATCHER(forStmt);
226   REGISTER_MATCHER(friendDecl);
227   REGISTER_MATCHER(functionDecl);
228   REGISTER_MATCHER(functionProtoType);
229   REGISTER_MATCHER(functionTemplateDecl);
230   REGISTER_MATCHER(functionType);
231   REGISTER_MATCHER(gnuNullExpr);
232   REGISTER_MATCHER(gotoStmt);
233   REGISTER_MATCHER(has);
234   REGISTER_MATCHER(hasAncestor);
235   REGISTER_MATCHER(hasAnyArgument);
236   REGISTER_MATCHER(hasAnyClause);
237   REGISTER_MATCHER(hasAnyConstructorInitializer);
238   REGISTER_MATCHER(hasAnyDeclaration);
239   REGISTER_MATCHER(hasAnyName);
240   REGISTER_MATCHER(hasAnyParameter);
241   REGISTER_MATCHER(hasAnySelector);
242   REGISTER_MATCHER(hasAnySubstatement);
243   REGISTER_MATCHER(hasAnyTemplateArgument);
244   REGISTER_MATCHER(hasAnyUsingShadowDecl);
245   REGISTER_MATCHER(hasArgument);
246   REGISTER_MATCHER(hasArgumentOfType);
247   REGISTER_MATCHER(hasArraySize);
248   REGISTER_MATCHER(hasAttr);
249   REGISTER_MATCHER(hasAutomaticStorageDuration);
250   REGISTER_MATCHER(hasBase);
251   REGISTER_MATCHER(hasBitWidth);
252   REGISTER_MATCHER(hasBody);
253   REGISTER_MATCHER(hasCanonicalType);
254   REGISTER_MATCHER(hasCaseConstant);
255   REGISTER_MATCHER(hasCastKind);
256   REGISTER_MATCHER(hasCondition);
257   REGISTER_MATCHER(hasConditionVariableStatement);
258   REGISTER_MATCHER(hasDecayedType);
259   REGISTER_MATCHER(hasDeclContext);
260   REGISTER_MATCHER(hasDeclaration);
261   REGISTER_MATCHER(hasDeducedType);
262   REGISTER_MATCHER(hasDefaultArgument);
263   REGISTER_MATCHER(hasDefinition);
264   REGISTER_MATCHER(hasDescendant);
265   REGISTER_MATCHER(hasDestinationType);
266   REGISTER_MATCHER(hasDynamicExceptionSpec);
267   REGISTER_MATCHER(hasEitherOperand);
268   REGISTER_MATCHER(hasElementType);
269   REGISTER_MATCHER(hasElse);
270   REGISTER_MATCHER(hasExternalFormalLinkage);
271   REGISTER_MATCHER(hasFalseExpression);
272   REGISTER_MATCHER(hasGlobalStorage);
273   REGISTER_MATCHER(hasImplicitDestinationType);
274   REGISTER_MATCHER(hasInClassInitializer);
275   REGISTER_MATCHER(hasIncrement);
276   REGISTER_MATCHER(hasIndex);
277   REGISTER_MATCHER(hasInit);
278   REGISTER_MATCHER(hasInitializer);
279   REGISTER_MATCHER(hasKeywordSelector);
280   REGISTER_MATCHER(hasLHS);
281   REGISTER_MATCHER(hasLocalQualifiers);
282   REGISTER_MATCHER(hasLocalStorage);
283   REGISTER_MATCHER(hasLoopInit);
284   REGISTER_MATCHER(hasLoopVariable);
285   REGISTER_MATCHER(hasMethod);
286   REGISTER_MATCHER(hasName);
287   REGISTER_MATCHER(hasNullSelector);
288   REGISTER_MATCHER(hasObjectExpression);
289   REGISTER_MATCHER(hasOperatorName);
290   REGISTER_MATCHER(hasOverloadedOperatorName);
291   REGISTER_MATCHER(hasParameter);
292   REGISTER_MATCHER(hasParent);
293   REGISTER_MATCHER(hasQualifier);
294   REGISTER_MATCHER(hasRHS);
295   REGISTER_MATCHER(hasRangeInit);
296   REGISTER_MATCHER(hasReceiver);
297   REGISTER_MATCHER(hasReceiverType);
298   REGISTER_MATCHER(hasReplacementType);
299   REGISTER_MATCHER(hasReturnValue);
300   REGISTER_MATCHER(hasSelector);
301   REGISTER_MATCHER(hasSingleDecl);
302   REGISTER_MATCHER(hasSize);
303   REGISTER_MATCHER(hasSizeExpr);
304   REGISTER_MATCHER(hasSourceExpression);
305   REGISTER_MATCHER(hasSpecializedTemplate);
306   REGISTER_MATCHER(hasStaticStorageDuration);
307   REGISTER_MATCHER(hasStructuredBlock);
308   REGISTER_MATCHER(hasSyntacticForm);
309   REGISTER_MATCHER(hasTargetDecl);
310   REGISTER_MATCHER(hasTemplateArgument);
311   REGISTER_MATCHER(hasThen);
312   REGISTER_MATCHER(hasThreadStorageDuration);
313   REGISTER_MATCHER(hasTrailingReturn);
314   REGISTER_MATCHER(hasTrueExpression);
315   REGISTER_MATCHER(hasTypeLoc);
316   REGISTER_MATCHER(hasUnaryOperand);
317   REGISTER_MATCHER(hasUnarySelector);
318   REGISTER_MATCHER(hasUnderlyingDecl);
319   REGISTER_MATCHER(hasUnderlyingType);
320   REGISTER_MATCHER(hasUnqualifiedDesugaredType);
321   REGISTER_MATCHER(hasValueType);
322   REGISTER_MATCHER(ifStmt);
323   REGISTER_MATCHER(ignoringElidableConstructorCall);
324   REGISTER_MATCHER(ignoringImpCasts);
325   REGISTER_MATCHER(ignoringImplicit);
326   REGISTER_MATCHER(ignoringParenCasts);
327   REGISTER_MATCHER(ignoringParenImpCasts);
328   REGISTER_MATCHER(imaginaryLiteral);
329   REGISTER_MATCHER(implicitCastExpr);
330   REGISTER_MATCHER(implicitValueInitExpr);
331   REGISTER_MATCHER(incompleteArrayType);
332   REGISTER_MATCHER(indirectFieldDecl);
333   REGISTER_MATCHER(initListExpr);
334   REGISTER_MATCHER(injectedClassNameType);
335   REGISTER_MATCHER(innerType);
336   REGISTER_MATCHER(integerLiteral);
337   REGISTER_MATCHER(isAllowedToContainClauseKind);
338   REGISTER_MATCHER(isAnonymous);
339   REGISTER_MATCHER(isAnyCharacter);
340   REGISTER_MATCHER(isAnyPointer);
341   REGISTER_MATCHER(isArray);
342   REGISTER_MATCHER(isArrow);
343   REGISTER_MATCHER(isAssignmentOperator);
344   REGISTER_MATCHER(isBaseInitializer);
345   REGISTER_MATCHER(isBitField);
346   REGISTER_MATCHER(isCatchAll);
347   REGISTER_MATCHER(isClass);
348   REGISTER_MATCHER(isClassMessage);
349   REGISTER_MATCHER(isClassMethod);
350   REGISTER_MATCHER(isConst);
351   REGISTER_MATCHER(isConstQualified);
352   REGISTER_MATCHER(isConstexpr);
353   REGISTER_MATCHER(isCopyAssignmentOperator);
354   REGISTER_MATCHER(isCopyConstructor);
355   REGISTER_MATCHER(isDefaultConstructor);
356   REGISTER_MATCHER(isDefaulted);
357   REGISTER_MATCHER(isDefinition);
358   REGISTER_MATCHER(isDelegatingConstructor);
359   REGISTER_MATCHER(isDeleted);
360   REGISTER_MATCHER(isExceptionVariable);
361   REGISTER_MATCHER(isExpansionInFileMatching);
362   REGISTER_MATCHER(isExpansionInMainFile);
363   REGISTER_MATCHER(isExpansionInSystemHeader);
364   REGISTER_MATCHER(isExplicit);
365   REGISTER_MATCHER(isExplicitTemplateSpecialization);
366   REGISTER_MATCHER(isExpr);
367   REGISTER_MATCHER(isExternC);
368   REGISTER_MATCHER(isFinal);
369   REGISTER_MATCHER(isImplicit);
370   REGISTER_MATCHER(isInStdNamespace);
371   REGISTER_MATCHER(isInTemplateInstantiation);
372   REGISTER_MATCHER(isInline);
373   REGISTER_MATCHER(isInstanceMessage);
374   REGISTER_MATCHER(isInstanceMethod);
375   REGISTER_MATCHER(isInstantiated);
376   REGISTER_MATCHER(isInstantiationDependent);
377   REGISTER_MATCHER(isInteger);
378   REGISTER_MATCHER(isIntegral);
379   REGISTER_MATCHER(isLambda);
380   REGISTER_MATCHER(isListInitialization);
381   REGISTER_MATCHER(isMain);
382   REGISTER_MATCHER(isMemberInitializer);
383   REGISTER_MATCHER(isMoveAssignmentOperator);
384   REGISTER_MATCHER(isMoveConstructor);
385   REGISTER_MATCHER(isNoReturn);
386   REGISTER_MATCHER(isNoThrow);
387   REGISTER_MATCHER(isNoneKind);
388   REGISTER_MATCHER(isOMPStructuredBlock);
389   REGISTER_MATCHER(isOverride);
390   REGISTER_MATCHER(isPrivate);
391   REGISTER_MATCHER(isProtected);
392   REGISTER_MATCHER(isPublic);
393   REGISTER_MATCHER(isPure);
394   REGISTER_MATCHER(isScoped);
395   REGISTER_MATCHER(isSharedKind);
396   REGISTER_MATCHER(isSignedInteger);
397   REGISTER_MATCHER(isStandaloneDirective);
398   REGISTER_MATCHER(isStaticLocal);
399   REGISTER_MATCHER(isStaticStorageClass);
400   REGISTER_MATCHER(isStruct);
401   REGISTER_MATCHER(isTemplateInstantiation);
402   REGISTER_MATCHER(isTypeDependent);
403   REGISTER_MATCHER(isUnion);
404   REGISTER_MATCHER(isUnsignedInteger);
405   REGISTER_MATCHER(isUserProvided);
406   REGISTER_MATCHER(isValueDependent);
407   REGISTER_MATCHER(isVariadic);
408   REGISTER_MATCHER(isVirtual);
409   REGISTER_MATCHER(isVirtualAsWritten);
410   REGISTER_MATCHER(isVolatileQualified);
411   REGISTER_MATCHER(isWritten);
412   REGISTER_MATCHER(lValueReferenceType);
413   REGISTER_MATCHER(labelDecl);
414   REGISTER_MATCHER(labelStmt);
415   REGISTER_MATCHER(lambdaExpr);
416   REGISTER_MATCHER(linkageSpecDecl);
417   REGISTER_MATCHER(matchesName);
418   REGISTER_MATCHER(matchesSelector);
419   REGISTER_MATCHER(materializeTemporaryExpr);
420   REGISTER_MATCHER(member);
421   REGISTER_MATCHER(memberExpr);
422   REGISTER_MATCHER(memberPointerType);
423   REGISTER_MATCHER(namedDecl);
424   REGISTER_MATCHER(namesType);
425   REGISTER_MATCHER(namespaceAliasDecl);
426   REGISTER_MATCHER(namespaceDecl);
427   REGISTER_MATCHER(nestedNameSpecifier);
428   REGISTER_MATCHER(nestedNameSpecifierLoc);
429   REGISTER_MATCHER(nonTypeTemplateParmDecl);
430   REGISTER_MATCHER(nullPointerConstant);
431   REGISTER_MATCHER(nullStmt);
432   REGISTER_MATCHER(numSelectorArgs);
433   REGISTER_MATCHER(objcCatchStmt);
434   REGISTER_MATCHER(objcCategoryDecl);
435   REGISTER_MATCHER(objcCategoryImplDecl);
436   REGISTER_MATCHER(objcFinallyStmt);
437   REGISTER_MATCHER(objcImplementationDecl);
438   REGISTER_MATCHER(objcInterfaceDecl);
439   REGISTER_MATCHER(objcIvarDecl);
440   REGISTER_MATCHER(objcIvarRefExpr);
441   REGISTER_MATCHER(objcMessageExpr);
442   REGISTER_MATCHER(objcMethodDecl);
443   REGISTER_MATCHER(objcObjectPointerType);
444   REGISTER_MATCHER(objcPropertyDecl);
445   REGISTER_MATCHER(objcProtocolDecl);
446   REGISTER_MATCHER(objcThrowStmt);
447   REGISTER_MATCHER(objcTryStmt);
448   REGISTER_MATCHER(ofClass);
449   REGISTER_MATCHER(ompDefaultClause);
450   REGISTER_MATCHER(ompExecutableDirective);
451   REGISTER_MATCHER(on);
452   REGISTER_MATCHER(onImplicitObjectArgument);
453   REGISTER_MATCHER(opaqueValueExpr);
454   REGISTER_MATCHER(parameterCountIs);
455   REGISTER_MATCHER(parenExpr);
456   REGISTER_MATCHER(parenListExpr);
457   REGISTER_MATCHER(parenType);
458   REGISTER_MATCHER(parmVarDecl);
459   REGISTER_MATCHER(pointee);
460   REGISTER_MATCHER(pointerType);
461   REGISTER_MATCHER(predefinedExpr);
462   REGISTER_MATCHER(qualType);
463   REGISTER_MATCHER(rValueReferenceType);
464   REGISTER_MATCHER(realFloatingPointType);
465   REGISTER_MATCHER(recordDecl);
466   REGISTER_MATCHER(recordType);
467   REGISTER_MATCHER(referenceType);
468   REGISTER_MATCHER(refersToDeclaration);
469   REGISTER_MATCHER(refersToIntegralType);
470   REGISTER_MATCHER(refersToTemplate);
471   REGISTER_MATCHER(refersToType);
472   REGISTER_MATCHER(requiresZeroInitialization);
473   REGISTER_MATCHER(returnStmt);
474   REGISTER_MATCHER(returns);
475   REGISTER_MATCHER(sizeOfExpr);
476   REGISTER_MATCHER(specifiesNamespace);
477   REGISTER_MATCHER(specifiesType);
478   REGISTER_MATCHER(specifiesTypeLoc);
479   REGISTER_MATCHER(statementCountIs);
480   REGISTER_MATCHER(staticAssertDecl);
481   REGISTER_MATCHER(stmt);
482   REGISTER_MATCHER(stmtExpr);
483   REGISTER_MATCHER(stringLiteral);
484   REGISTER_MATCHER(substNonTypeTemplateParmExpr);
485   REGISTER_MATCHER(substTemplateTypeParmType);
486   REGISTER_MATCHER(switchCase);
487   REGISTER_MATCHER(switchStmt);
488   REGISTER_MATCHER(tagType);
489   REGISTER_MATCHER(templateArgument);
490   REGISTER_MATCHER(templateArgumentCountIs);
491   REGISTER_MATCHER(templateName);
492   REGISTER_MATCHER(templateSpecializationType);
493   REGISTER_MATCHER(templateTypeParmDecl);
494   REGISTER_MATCHER(templateTypeParmType);
495   REGISTER_MATCHER(throughUsingDecl);
496   REGISTER_MATCHER(to);
497   REGISTER_MATCHER(translationUnitDecl);
498   REGISTER_MATCHER(type);
499   REGISTER_MATCHER(typeAliasDecl);
500   REGISTER_MATCHER(typeAliasTemplateDecl);
501   REGISTER_MATCHER(typeLoc);
502   REGISTER_MATCHER(typedefDecl);
503   REGISTER_MATCHER(typedefNameDecl);
504   REGISTER_MATCHER(typedefType);
505   REGISTER_MATCHER(unaryExprOrTypeTraitExpr);
506   REGISTER_MATCHER(unaryOperator);
507   REGISTER_MATCHER(unaryTransformType);
508   REGISTER_MATCHER(unless);
509   REGISTER_MATCHER(unresolvedLookupExpr);
510   REGISTER_MATCHER(unresolvedMemberExpr);
511   REGISTER_MATCHER(unresolvedUsingTypenameDecl);
512   REGISTER_MATCHER(unresolvedUsingValueDecl);
513   REGISTER_MATCHER(userDefinedLiteral);
514   REGISTER_MATCHER(usesADL);
515   REGISTER_MATCHER(usingDecl);
516   REGISTER_MATCHER(usingDirectiveDecl);
517   REGISTER_MATCHER(valueDecl);
518   REGISTER_MATCHER(varDecl);
519   REGISTER_MATCHER(variableArrayType);
520   REGISTER_MATCHER(voidType);
521   REGISTER_MATCHER(whileStmt);
522   REGISTER_MATCHER(withInitializer);
523 }
524 
525 RegistryMaps::~RegistryMaps() = default;
526 
527 static llvm::ManagedStatic<RegistryMaps> RegistryData;
528 
529 // static
530 llvm::Optional<MatcherCtor> Registry::lookupMatcherCtor(StringRef MatcherName) {
531   auto it = RegistryData->constructors().find(MatcherName);
532   return it == RegistryData->constructors().end()
533              ? llvm::Optional<MatcherCtor>()
534              : it->second.get();
535 }
536 
537 static llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
538                                      const std::set<ASTNodeKind> &KS) {
539   unsigned Count = 0;
540   for (std::set<ASTNodeKind>::const_iterator I = KS.begin(), E = KS.end();
541        I != E; ++I) {
542     if (I != KS.begin())
543       OS << "|";
544     if (Count++ == 3) {
545       OS << "...";
546       break;
547     }
548     OS << *I;
549   }
550   return OS;
551 }
552 
553 std::vector<ArgKind> Registry::getAcceptedCompletionTypes(
554     ArrayRef<std::pair<MatcherCtor, unsigned>> Context) {
555   ASTNodeKind InitialTypes[] = {
556       ASTNodeKind::getFromNodeKind<Decl>(),
557       ASTNodeKind::getFromNodeKind<QualType>(),
558       ASTNodeKind::getFromNodeKind<Type>(),
559       ASTNodeKind::getFromNodeKind<Stmt>(),
560       ASTNodeKind::getFromNodeKind<NestedNameSpecifier>(),
561       ASTNodeKind::getFromNodeKind<NestedNameSpecifierLoc>(),
562       ASTNodeKind::getFromNodeKind<TypeLoc>()};
563 
564   // Starting with the above seed of acceptable top-level matcher types, compute
565   // the acceptable type set for the argument indicated by each context element.
566   std::set<ArgKind> TypeSet(std::begin(InitialTypes), std::end(InitialTypes));
567   for (const auto &CtxEntry : Context) {
568     MatcherCtor Ctor = CtxEntry.first;
569     unsigned ArgNumber = CtxEntry.second;
570     std::vector<ArgKind> NextTypeSet;
571     for (const ArgKind &Kind : TypeSet) {
572       if (Kind.getArgKind() == Kind.AK_Matcher &&
573           Ctor->isConvertibleTo(Kind.getMatcherKind()) &&
574           (Ctor->isVariadic() || ArgNumber < Ctor->getNumArgs()))
575         Ctor->getArgKinds(Kind.getMatcherKind(), ArgNumber, NextTypeSet);
576     }
577     TypeSet.clear();
578     TypeSet.insert(NextTypeSet.begin(), NextTypeSet.end());
579   }
580   return std::vector<ArgKind>(TypeSet.begin(), TypeSet.end());
581 }
582 
583 std::vector<MatcherCompletion>
584 Registry::getMatcherCompletions(ArrayRef<ArgKind> AcceptedTypes) {
585   std::vector<MatcherCompletion> Completions;
586 
587   // Search the registry for acceptable matchers.
588   for (const auto &M : RegistryData->constructors()) {
589     const MatcherDescriptor& Matcher = *M.getValue();
590     StringRef Name = M.getKey();
591 
592     std::set<ASTNodeKind> RetKinds;
593     unsigned NumArgs = Matcher.isVariadic() ? 1 : Matcher.getNumArgs();
594     bool IsPolymorphic = Matcher.isPolymorphic();
595     std::vector<std::vector<ArgKind>> ArgsKinds(NumArgs);
596     unsigned MaxSpecificity = 0;
597     for (const ArgKind& Kind : AcceptedTypes) {
598       if (Kind.getArgKind() != Kind.AK_Matcher)
599         continue;
600       unsigned Specificity;
601       ASTNodeKind LeastDerivedKind;
602       if (Matcher.isConvertibleTo(Kind.getMatcherKind(), &Specificity,
603                                   &LeastDerivedKind)) {
604         if (MaxSpecificity < Specificity)
605           MaxSpecificity = Specificity;
606         RetKinds.insert(LeastDerivedKind);
607         for (unsigned Arg = 0; Arg != NumArgs; ++Arg)
608           Matcher.getArgKinds(Kind.getMatcherKind(), Arg, ArgsKinds[Arg]);
609         if (IsPolymorphic)
610           break;
611       }
612     }
613 
614     if (!RetKinds.empty() && MaxSpecificity > 0) {
615       std::string Decl;
616       llvm::raw_string_ostream OS(Decl);
617 
618       if (IsPolymorphic) {
619         OS << "Matcher<T> " << Name << "(Matcher<T>";
620       } else {
621         OS << "Matcher<" << RetKinds << "> " << Name << "(";
622         for (const std::vector<ArgKind> &Arg : ArgsKinds) {
623           if (&Arg != &ArgsKinds[0])
624             OS << ", ";
625 
626           bool FirstArgKind = true;
627           std::set<ASTNodeKind> MatcherKinds;
628           // Two steps. First all non-matchers, then matchers only.
629           for (const ArgKind &AK : Arg) {
630             if (AK.getArgKind() == ArgKind::AK_Matcher) {
631               MatcherKinds.insert(AK.getMatcherKind());
632             } else {
633               if (!FirstArgKind) OS << "|";
634               FirstArgKind = false;
635               OS << AK.asString();
636             }
637           }
638           if (!MatcherKinds.empty()) {
639             if (!FirstArgKind) OS << "|";
640             OS << "Matcher<" << MatcherKinds << ">";
641           }
642         }
643       }
644       if (Matcher.isVariadic())
645         OS << "...";
646       OS << ")";
647 
648       std::string TypedText = Name;
649       TypedText += "(";
650       if (ArgsKinds.empty())
651         TypedText += ")";
652       else if (ArgsKinds[0][0].getArgKind() == ArgKind::AK_String)
653         TypedText += "\"";
654 
655       Completions.emplace_back(TypedText, OS.str(), MaxSpecificity);
656     }
657   }
658 
659   return Completions;
660 }
661 
662 VariantMatcher Registry::constructMatcher(MatcherCtor Ctor,
663                                           SourceRange NameRange,
664                                           ArrayRef<ParserValue> Args,
665                                           Diagnostics *Error) {
666   return Ctor->create(NameRange, Args, Error);
667 }
668 
669 VariantMatcher Registry::constructBoundMatcher(MatcherCtor Ctor,
670                                                SourceRange NameRange,
671                                                StringRef BindID,
672                                                ArrayRef<ParserValue> Args,
673                                                Diagnostics *Error) {
674   VariantMatcher Out = constructMatcher(Ctor, NameRange, Args, Error);
675   if (Out.isNull()) return Out;
676 
677   llvm::Optional<DynTypedMatcher> Result = Out.getSingleMatcher();
678   if (Result.hasValue()) {
679     llvm::Optional<DynTypedMatcher> Bound = Result->tryBind(BindID);
680     if (Bound.hasValue()) {
681       return VariantMatcher::SingleMatcher(*Bound);
682     }
683   }
684   Error->addError(NameRange, Error->ET_RegistryNotBindable);
685   return VariantMatcher();
686 }
687 
688 } // namespace dynamic
689 } // namespace ast_matchers
690 } // namespace clang
691