xref: /llvm-project/clang/lib/ASTMatchers/Dynamic/Registry.cpp (revision a1580d7b59b65b17f2ce7fdb95f46379e7df4089)
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 <optional>
30 #include <set>
31 #include <string>
32 #include <utility>
33 #include <vector>
34 
35 namespace clang {
36 namespace ast_matchers {
37 namespace dynamic {
38 
39 namespace {
40 
41 using internal::MatcherDescriptor;
42 
43 using ConstructorMap =
44     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       std::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 #define REGISTER_REGEX_MATCHER(name)                                           \
93   registerMatcher(#name, internal::makeMatcherRegexMarshall(name, name))
94 
95 /// Generate a registry map with all the known matchers.
96 /// Please keep sorted alphabetically!
97 RegistryMaps::RegistryMaps() {
98   // TODO: Here is the list of the missing matchers, grouped by reason.
99   //
100   // Polymorphic + argument overload:
101   // findAll
102   //
103   // Other:
104   // equalsNode
105 
106   registerMatcher("mapAnyOf",
107                   std::make_unique<internal::MapAnyOfBuilderDescriptor>());
108 
109   REGISTER_OVERLOADED_2(callee);
110   REGISTER_OVERLOADED_2(hasPrefix);
111   REGISTER_OVERLOADED_2(hasType);
112   REGISTER_OVERLOADED_2(ignoringParens);
113   REGISTER_OVERLOADED_2(isDerivedFrom);
114   REGISTER_OVERLOADED_2(isDirectlyDerivedFrom);
115   REGISTER_OVERLOADED_2(isSameOrDerivedFrom);
116   REGISTER_OVERLOADED_2(loc);
117   REGISTER_OVERLOADED_2(pointsTo);
118   REGISTER_OVERLOADED_2(references);
119   REGISTER_OVERLOADED_2(thisPointerType);
120 
121   std::unique_ptr<MatcherDescriptor> equalsCallbacks[] = {
122       MATCHER_OVERLOAD_ENTRY(equals, 0),
123       MATCHER_OVERLOAD_ENTRY(equals, 1),
124       MATCHER_OVERLOAD_ENTRY(equals, 2),
125   };
126   REGISTER_MATCHER_OVERLOAD(equals);
127 
128   REGISTER_REGEX_MATCHER(isExpansionInFileMatching);
129   REGISTER_REGEX_MATCHER(matchesName);
130   REGISTER_REGEX_MATCHER(matchesSelector);
131 
132   REGISTER_MATCHER(accessSpecDecl);
133   REGISTER_MATCHER(addrLabelExpr);
134   REGISTER_MATCHER(alignOfExpr);
135   REGISTER_MATCHER(allOf);
136   REGISTER_MATCHER(anyOf);
137   REGISTER_MATCHER(anything);
138   REGISTER_MATCHER(argumentCountIs);
139   REGISTER_MATCHER(arraySubscriptExpr);
140   REGISTER_MATCHER(arrayType);
141   REGISTER_MATCHER(asString);
142   REGISTER_MATCHER(asmStmt);
143   REGISTER_MATCHER(atomicExpr);
144   REGISTER_MATCHER(atomicType);
145   REGISTER_MATCHER(attr);
146   REGISTER_MATCHER(autoType);
147   REGISTER_MATCHER(autoreleasePoolStmt)
148   REGISTER_MATCHER(binaryConditionalOperator);
149   REGISTER_MATCHER(binaryOperator);
150   REGISTER_MATCHER(binaryOperation);
151   REGISTER_MATCHER(bindingDecl);
152   REGISTER_MATCHER(blockDecl);
153   REGISTER_MATCHER(blockExpr);
154   REGISTER_MATCHER(blockPointerType);
155   REGISTER_MATCHER(booleanType);
156   REGISTER_MATCHER(breakStmt);
157   REGISTER_MATCHER(builtinType);
158   REGISTER_MATCHER(cStyleCastExpr);
159   REGISTER_MATCHER(callExpr);
160   REGISTER_MATCHER(capturesThis);
161   REGISTER_MATCHER(capturesVar);
162   REGISTER_MATCHER(caseStmt);
163   REGISTER_MATCHER(castExpr);
164   REGISTER_MATCHER(characterLiteral);
165   REGISTER_MATCHER(chooseExpr);
166   REGISTER_MATCHER(classTemplateDecl);
167   REGISTER_MATCHER(classTemplatePartialSpecializationDecl);
168   REGISTER_MATCHER(classTemplateSpecializationDecl);
169   REGISTER_MATCHER(complexType);
170   REGISTER_MATCHER(compoundLiteralExpr);
171   REGISTER_MATCHER(compoundStmt);
172   REGISTER_MATCHER(coawaitExpr);
173   REGISTER_MATCHER(conditionalOperator);
174   REGISTER_MATCHER(constantArrayType);
175   REGISTER_MATCHER(constantExpr);
176   REGISTER_MATCHER(containsDeclaration);
177   REGISTER_MATCHER(continueStmt);
178   REGISTER_MATCHER(coreturnStmt);
179   REGISTER_MATCHER(coyieldExpr);
180   REGISTER_MATCHER(cudaKernelCallExpr);
181   REGISTER_MATCHER(cxxBaseSpecifier);
182   REGISTER_MATCHER(cxxBindTemporaryExpr);
183   REGISTER_MATCHER(cxxBoolLiteral);
184   REGISTER_MATCHER(cxxCatchStmt);
185   REGISTER_MATCHER(cxxConstCastExpr);
186   REGISTER_MATCHER(cxxConstructExpr);
187   REGISTER_MATCHER(cxxConstructorDecl);
188   REGISTER_MATCHER(cxxConversionDecl);
189   REGISTER_MATCHER(cxxCtorInitializer);
190   REGISTER_MATCHER(cxxDeductionGuideDecl);
191   REGISTER_MATCHER(cxxDefaultArgExpr);
192   REGISTER_MATCHER(cxxDeleteExpr);
193   REGISTER_MATCHER(cxxDependentScopeMemberExpr);
194   REGISTER_MATCHER(cxxDestructorDecl);
195   REGISTER_MATCHER(cxxDynamicCastExpr);
196   REGISTER_MATCHER(cxxForRangeStmt);
197   REGISTER_MATCHER(cxxFunctionalCastExpr);
198   REGISTER_MATCHER(cxxMemberCallExpr);
199   REGISTER_MATCHER(cxxMethodDecl);
200   REGISTER_MATCHER(cxxNewExpr);
201   REGISTER_MATCHER(cxxNoexceptExpr);
202   REGISTER_MATCHER(cxxNullPtrLiteralExpr);
203   REGISTER_MATCHER(cxxOperatorCallExpr);
204   REGISTER_MATCHER(cxxRecordDecl);
205   REGISTER_MATCHER(cxxReinterpretCastExpr);
206   REGISTER_MATCHER(cxxRewrittenBinaryOperator);
207   REGISTER_MATCHER(cxxStaticCastExpr);
208   REGISTER_MATCHER(cxxStdInitializerListExpr);
209   REGISTER_MATCHER(cxxTemporaryObjectExpr);
210   REGISTER_MATCHER(cxxThisExpr);
211   REGISTER_MATCHER(cxxThrowExpr);
212   REGISTER_MATCHER(cxxTryStmt);
213   REGISTER_MATCHER(cxxUnresolvedConstructExpr);
214   REGISTER_MATCHER(decayedType);
215   REGISTER_MATCHER(decl);
216   REGISTER_MATCHER(decompositionDecl);
217   REGISTER_MATCHER(declCountIs);
218   REGISTER_MATCHER(declRefExpr);
219   REGISTER_MATCHER(declStmt);
220   REGISTER_MATCHER(declaratorDecl);
221   REGISTER_MATCHER(decltypeType);
222   REGISTER_MATCHER(deducedTemplateSpecializationType);
223   REGISTER_MATCHER(defaultStmt);
224   REGISTER_MATCHER(dependentCoawaitExpr);
225   REGISTER_MATCHER(dependentSizedArrayType);
226   REGISTER_MATCHER(designatedInitExpr);
227   REGISTER_MATCHER(designatorCountIs);
228   REGISTER_MATCHER(doStmt);
229   REGISTER_MATCHER(eachOf);
230   REGISTER_MATCHER(elaboratedType);
231   REGISTER_MATCHER(elaboratedTypeLoc);
232   REGISTER_MATCHER(usingType);
233   REGISTER_MATCHER(enumConstantDecl);
234   REGISTER_MATCHER(enumDecl);
235   REGISTER_MATCHER(enumType);
236   REGISTER_MATCHER(equalsBoundNode);
237   REGISTER_MATCHER(equalsIntegralValue);
238   REGISTER_MATCHER(explicitCastExpr);
239   REGISTER_MATCHER(expr);
240   REGISTER_MATCHER(exprWithCleanups);
241   REGISTER_MATCHER(fieldDecl);
242   REGISTER_MATCHER(fixedPointLiteral);
243   REGISTER_MATCHER(floatLiteral);
244   REGISTER_MATCHER(forCallable);
245   REGISTER_MATCHER(forDecomposition);
246   REGISTER_MATCHER(forEach);
247   REGISTER_MATCHER(forEachArgumentWithParam);
248   REGISTER_MATCHER(forEachArgumentWithParamType);
249   REGISTER_MATCHER(forEachConstructorInitializer);
250   REGISTER_MATCHER(forEachDescendant);
251   REGISTER_MATCHER(forEachLambdaCapture);
252   REGISTER_MATCHER(forEachOverridden);
253   REGISTER_MATCHER(forEachSwitchCase);
254   REGISTER_MATCHER(forEachTemplateArgument);
255   REGISTER_MATCHER(forField);
256   REGISTER_MATCHER(forFunction);
257   REGISTER_MATCHER(forStmt);
258   REGISTER_MATCHER(friendDecl);
259   REGISTER_MATCHER(functionDecl);
260   REGISTER_MATCHER(functionProtoType);
261   REGISTER_MATCHER(functionTemplateDecl);
262   REGISTER_MATCHER(functionType);
263   REGISTER_MATCHER(genericSelectionExpr);
264   REGISTER_MATCHER(gnuNullExpr);
265   REGISTER_MATCHER(gotoStmt);
266   REGISTER_MATCHER(has);
267   REGISTER_MATCHER(hasAncestor);
268   REGISTER_MATCHER(hasAnyArgument);
269   REGISTER_MATCHER(hasAnyBase);
270   REGISTER_MATCHER(hasAnyBinding);
271   REGISTER_MATCHER(hasAnyBody);
272   REGISTER_MATCHER(hasAnyCapture);
273   REGISTER_MATCHER(hasAnyClause);
274   REGISTER_MATCHER(hasAnyConstructorInitializer);
275   REGISTER_MATCHER(hasAnyDeclaration);
276   REGISTER_MATCHER(hasAnyName);
277   REGISTER_MATCHER(hasAnyOperatorName);
278   REGISTER_MATCHER(hasAnyOverloadedOperatorName);
279   REGISTER_MATCHER(hasAnyParameter);
280   REGISTER_MATCHER(hasAnyPlacementArg);
281   REGISTER_MATCHER(hasAnySelector);
282   REGISTER_MATCHER(hasAnySubstatement);
283   REGISTER_MATCHER(hasAnyTemplateArgument);
284   REGISTER_MATCHER(hasAnyTemplateArgumentLoc);
285   REGISTER_MATCHER(hasAnyUsingShadowDecl);
286   REGISTER_MATCHER(hasArgument);
287   REGISTER_MATCHER(hasArgumentOfType);
288   REGISTER_MATCHER(hasArraySize);
289   REGISTER_MATCHER(hasAttr);
290   REGISTER_MATCHER(hasAutomaticStorageDuration);
291   REGISTER_MATCHER(hasBase);
292   REGISTER_MATCHER(hasBinding);
293   REGISTER_MATCHER(hasBitWidth);
294   REGISTER_MATCHER(hasBody);
295   REGISTER_MATCHER(hasCanonicalType);
296   REGISTER_MATCHER(hasCaseConstant);
297   REGISTER_MATCHER(hasCastKind);
298   REGISTER_MATCHER(hasCondition);
299   REGISTER_MATCHER(hasConditionVariableStatement);
300   REGISTER_MATCHER(hasDecayedType);
301   REGISTER_MATCHER(hasDeclContext);
302   REGISTER_MATCHER(hasDeclaration);
303   REGISTER_MATCHER(hasDeducedType);
304   REGISTER_MATCHER(hasDefaultArgument);
305   REGISTER_MATCHER(hasDefinition);
306   REGISTER_MATCHER(hasDescendant);
307   REGISTER_MATCHER(hasDestinationType);
308   REGISTER_MATCHER(hasDirectBase);
309   REGISTER_MATCHER(hasDynamicExceptionSpec);
310   REGISTER_MATCHER(hasEitherOperand);
311   REGISTER_MATCHER(hasElementType);
312   REGISTER_MATCHER(hasElse);
313   REGISTER_MATCHER(hasExplicitSpecifier);
314   REGISTER_MATCHER(hasExternalFormalLinkage);
315   REGISTER_MATCHER(hasFalseExpression);
316   REGISTER_MATCHER(hasGlobalStorage);
317   REGISTER_MATCHER(hasImplicitDestinationType);
318   REGISTER_MATCHER(hasInClassInitializer);
319   REGISTER_MATCHER(hasIncrement);
320   REGISTER_MATCHER(hasIndex);
321   REGISTER_MATCHER(hasInit);
322   REGISTER_MATCHER(hasInitializer);
323   REGISTER_MATCHER(hasInitStatement);
324   REGISTER_MATCHER(hasKeywordSelector);
325   REGISTER_MATCHER(hasLHS);
326   REGISTER_MATCHER(hasLocalQualifiers);
327   REGISTER_MATCHER(hasLocalStorage);
328   REGISTER_MATCHER(hasLoopInit);
329   REGISTER_MATCHER(hasLoopVariable);
330   REGISTER_MATCHER(hasMemberName);
331   REGISTER_MATCHER(hasMethod);
332   REGISTER_MATCHER(hasName);
333   REGISTER_MATCHER(hasNamedTypeLoc);
334   REGISTER_MATCHER(hasNullSelector);
335   REGISTER_MATCHER(hasObjectExpression);
336   REGISTER_MATCHER(hasOperands);
337   REGISTER_MATCHER(hasOperatorName);
338   REGISTER_MATCHER(hasOverloadedOperatorName);
339   REGISTER_MATCHER(hasParameter);
340   REGISTER_MATCHER(hasParent);
341   REGISTER_MATCHER(hasPointeeLoc);
342   REGISTER_MATCHER(hasQualifier);
343   REGISTER_MATCHER(hasRHS);
344   REGISTER_MATCHER(hasRangeInit);
345   REGISTER_MATCHER(hasReceiver);
346   REGISTER_MATCHER(hasReceiverType);
347   REGISTER_MATCHER(hasReferentLoc);
348   REGISTER_MATCHER(hasReplacementType);
349   REGISTER_MATCHER(hasReturnTypeLoc);
350   REGISTER_MATCHER(hasReturnValue);
351   REGISTER_MATCHER(hasPlacementArg);
352   REGISTER_MATCHER(hasSelector);
353   REGISTER_MATCHER(hasSingleDecl);
354   REGISTER_MATCHER(hasSize);
355   REGISTER_MATCHER(hasSizeExpr);
356   REGISTER_MATCHER(hasSourceExpression);
357   REGISTER_MATCHER(hasSpecializedTemplate);
358   REGISTER_MATCHER(hasStaticStorageDuration);
359   REGISTER_MATCHER(hasStructuredBlock);
360   REGISTER_MATCHER(hasSyntacticForm);
361   REGISTER_MATCHER(hasTargetDecl);
362   REGISTER_MATCHER(hasTemplateArgument);
363   REGISTER_MATCHER(hasTemplateArgumentLoc);
364   REGISTER_MATCHER(hasThen);
365   REGISTER_MATCHER(hasThreadStorageDuration);
366   REGISTER_MATCHER(hasTrailingReturn);
367   REGISTER_MATCHER(hasTrueExpression);
368   REGISTER_MATCHER(hasTypeLoc);
369   REGISTER_MATCHER(hasUnaryOperand);
370   REGISTER_MATCHER(hasUnarySelector);
371   REGISTER_MATCHER(hasUnderlyingDecl);
372   REGISTER_MATCHER(hasUnderlyingType);
373   REGISTER_MATCHER(hasUnqualifiedDesugaredType);
374   REGISTER_MATCHER(hasUnqualifiedLoc);
375   REGISTER_MATCHER(hasValueType);
376   REGISTER_MATCHER(ifStmt);
377   REGISTER_MATCHER(ignoringElidableConstructorCall);
378   REGISTER_MATCHER(ignoringImpCasts);
379   REGISTER_MATCHER(ignoringImplicit);
380   REGISTER_MATCHER(ignoringParenCasts);
381   REGISTER_MATCHER(ignoringParenImpCasts);
382   REGISTER_MATCHER(imaginaryLiteral);
383   REGISTER_MATCHER(implicitCastExpr);
384   REGISTER_MATCHER(implicitValueInitExpr);
385   REGISTER_MATCHER(incompleteArrayType);
386   REGISTER_MATCHER(indirectFieldDecl);
387   REGISTER_MATCHER(initListExpr);
388   REGISTER_MATCHER(injectedClassNameType);
389   REGISTER_MATCHER(innerType);
390   REGISTER_MATCHER(integerLiteral);
391   REGISTER_MATCHER(invocation);
392   REGISTER_MATCHER(isAllowedToContainClauseKind);
393   REGISTER_MATCHER(isAnonymous);
394   REGISTER_MATCHER(isAnyCharacter);
395   REGISTER_MATCHER(isAnyPointer);
396   REGISTER_MATCHER(isArray);
397   REGISTER_MATCHER(isArrow);
398   REGISTER_MATCHER(isAssignmentOperator);
399   REGISTER_MATCHER(isAtPosition);
400   REGISTER_MATCHER(isBaseInitializer);
401   REGISTER_MATCHER(isBitField);
402   REGISTER_MATCHER(isCatchAll);
403   REGISTER_MATCHER(isClass);
404   REGISTER_MATCHER(isClassMessage);
405   REGISTER_MATCHER(isClassMethod);
406   REGISTER_MATCHER(isComparisonOperator);
407   REGISTER_MATCHER(isConst);
408   REGISTER_MATCHER(isConstQualified);
409   REGISTER_MATCHER(isConsteval);
410   REGISTER_MATCHER(isConstexpr);
411   REGISTER_MATCHER(isConstinit);
412   REGISTER_MATCHER(isCopyAssignmentOperator);
413   REGISTER_MATCHER(isCopyConstructor);
414   REGISTER_MATCHER(isDefaultConstructor);
415   REGISTER_MATCHER(isDefaulted);
416   REGISTER_MATCHER(isDefinition);
417   REGISTER_MATCHER(isDelegatingConstructor);
418   REGISTER_MATCHER(isDeleted);
419   REGISTER_MATCHER(isEnum);
420   REGISTER_MATCHER(isExceptionVariable);
421   REGISTER_MATCHER(isExpandedFromMacro);
422   REGISTER_MATCHER(isExpansionInMainFile);
423   REGISTER_MATCHER(isExpansionInSystemHeader);
424   REGISTER_MATCHER(isExplicit);
425   REGISTER_MATCHER(isExplicitTemplateSpecialization);
426   REGISTER_MATCHER(isExpr);
427   REGISTER_MATCHER(isExternC);
428   REGISTER_MATCHER(isFinal);
429   REGISTER_MATCHER(isPrivateKind);
430   REGISTER_MATCHER(isFirstPrivateKind);
431   REGISTER_MATCHER(isImplicit);
432   REGISTER_MATCHER(isInAnonymousNamespace);
433   REGISTER_MATCHER(isInStdNamespace);
434   REGISTER_MATCHER(isInTemplateInstantiation);
435   REGISTER_MATCHER(isInitCapture);
436   REGISTER_MATCHER(isInline);
437   REGISTER_MATCHER(isInstanceMessage);
438   REGISTER_MATCHER(isInstanceMethod);
439   REGISTER_MATCHER(isInstantiated);
440   REGISTER_MATCHER(isInstantiationDependent);
441   REGISTER_MATCHER(isInteger);
442   REGISTER_MATCHER(isIntegral);
443   REGISTER_MATCHER(isLambda);
444   REGISTER_MATCHER(isListInitialization);
445   REGISTER_MATCHER(isMain);
446   REGISTER_MATCHER(isMemberInitializer);
447   REGISTER_MATCHER(isMoveAssignmentOperator);
448   REGISTER_MATCHER(isMoveConstructor);
449   REGISTER_MATCHER(isNoReturn);
450   REGISTER_MATCHER(isNoThrow);
451   REGISTER_MATCHER(isNoneKind);
452   REGISTER_MATCHER(isOverride);
453   REGISTER_MATCHER(isPrivate);
454   REGISTER_MATCHER(isProtected);
455   REGISTER_MATCHER(isPublic);
456   REGISTER_MATCHER(isPure);
457   REGISTER_MATCHER(isScoped);
458   REGISTER_MATCHER(isSharedKind);
459   REGISTER_MATCHER(isSignedInteger);
460   REGISTER_MATCHER(isStandaloneDirective);
461   REGISTER_MATCHER(isStaticLocal);
462   REGISTER_MATCHER(isStaticStorageClass);
463   REGISTER_MATCHER(isStruct);
464   REGISTER_MATCHER(isTemplateInstantiation);
465   REGISTER_MATCHER(isTypeDependent);
466   REGISTER_MATCHER(isUnion);
467   REGISTER_MATCHER(isUnsignedInteger);
468   REGISTER_MATCHER(isUserProvided);
469   REGISTER_MATCHER(isValueDependent);
470   REGISTER_MATCHER(isVariadic);
471   REGISTER_MATCHER(isVirtual);
472   REGISTER_MATCHER(isVirtualAsWritten);
473   REGISTER_MATCHER(isVolatileQualified);
474   REGISTER_MATCHER(isWeak);
475   REGISTER_MATCHER(isWritten);
476   REGISTER_MATCHER(lValueReferenceType);
477   REGISTER_MATCHER(labelDecl);
478   REGISTER_MATCHER(labelStmt);
479   REGISTER_MATCHER(lambdaCapture);
480   REGISTER_MATCHER(lambdaExpr);
481   REGISTER_MATCHER(linkageSpecDecl);
482   REGISTER_MATCHER(materializeTemporaryExpr);
483   REGISTER_MATCHER(member);
484   REGISTER_MATCHER(memberExpr);
485   REGISTER_MATCHER(memberHasSameNameAsBoundNode);
486   REGISTER_MATCHER(memberPointerType);
487   REGISTER_MATCHER(namedDecl);
488   REGISTER_MATCHER(namesType);
489   REGISTER_MATCHER(namespaceAliasDecl);
490   REGISTER_MATCHER(namespaceDecl);
491   REGISTER_MATCHER(nestedNameSpecifier);
492   REGISTER_MATCHER(nestedNameSpecifierLoc);
493   REGISTER_MATCHER(nonTypeTemplateParmDecl);
494   REGISTER_MATCHER(nullPointerConstant);
495   REGISTER_MATCHER(nullStmt);
496   REGISTER_MATCHER(numSelectorArgs);
497   REGISTER_MATCHER(objcCatchStmt);
498   REGISTER_MATCHER(objcCategoryDecl);
499   REGISTER_MATCHER(objcCategoryImplDecl);
500   REGISTER_MATCHER(objcFinallyStmt);
501   REGISTER_MATCHER(objcImplementationDecl);
502   REGISTER_MATCHER(objcInterfaceDecl);
503   REGISTER_MATCHER(objcIvarDecl);
504   REGISTER_MATCHER(objcIvarRefExpr);
505   REGISTER_MATCHER(objcMessageExpr);
506   REGISTER_MATCHER(objcMethodDecl);
507   REGISTER_MATCHER(objcObjectPointerType);
508   REGISTER_MATCHER(objcPropertyDecl);
509   REGISTER_MATCHER(objcProtocolDecl);
510   REGISTER_MATCHER(objcStringLiteral);
511   REGISTER_MATCHER(objcThrowStmt);
512   REGISTER_MATCHER(objcTryStmt);
513   REGISTER_MATCHER(ofClass);
514   REGISTER_MATCHER(ofKind);
515   REGISTER_MATCHER(ompDefaultClause);
516   REGISTER_MATCHER(ompExecutableDirective);
517   REGISTER_MATCHER(on);
518   REGISTER_MATCHER(onImplicitObjectArgument);
519   REGISTER_MATCHER(opaqueValueExpr);
520   REGISTER_MATCHER(optionally);
521   REGISTER_MATCHER(parameterCountIs);
522   REGISTER_MATCHER(parenExpr);
523   REGISTER_MATCHER(parenListExpr);
524   REGISTER_MATCHER(parenType);
525   REGISTER_MATCHER(parmVarDecl);
526   REGISTER_MATCHER(pointee);
527   REGISTER_MATCHER(pointerType);
528   REGISTER_MATCHER(pointerTypeLoc);
529   REGISTER_MATCHER(predefinedExpr);
530   REGISTER_MATCHER(qualType);
531   REGISTER_MATCHER(qualifiedTypeLoc);
532   REGISTER_MATCHER(rValueReferenceType);
533   REGISTER_MATCHER(realFloatingPointType);
534   REGISTER_MATCHER(recordDecl);
535   REGISTER_MATCHER(recordType);
536   REGISTER_MATCHER(referenceType);
537   REGISTER_MATCHER(referenceTypeLoc);
538   REGISTER_MATCHER(refersToDeclaration);
539   REGISTER_MATCHER(refersToIntegralType);
540   REGISTER_MATCHER(refersToTemplate);
541   REGISTER_MATCHER(refersToType);
542   REGISTER_MATCHER(requiresZeroInitialization);
543   REGISTER_MATCHER(returnStmt);
544   REGISTER_MATCHER(returns);
545   REGISTER_MATCHER(sizeOfExpr);
546   REGISTER_MATCHER(specifiesNamespace);
547   REGISTER_MATCHER(specifiesType);
548   REGISTER_MATCHER(specifiesTypeLoc);
549   REGISTER_MATCHER(statementCountIs);
550   REGISTER_MATCHER(staticAssertDecl);
551   REGISTER_MATCHER(stmt);
552   REGISTER_MATCHER(stmtExpr);
553   REGISTER_MATCHER(stringLiteral);
554   REGISTER_MATCHER(substNonTypeTemplateParmExpr);
555   REGISTER_MATCHER(substTemplateTypeParmType);
556   REGISTER_MATCHER(switchCase);
557   REGISTER_MATCHER(switchStmt);
558   REGISTER_MATCHER(tagDecl);
559   REGISTER_MATCHER(tagType);
560   REGISTER_MATCHER(templateArgument);
561   REGISTER_MATCHER(templateArgumentCountIs);
562   REGISTER_MATCHER(templateArgumentLoc);
563   REGISTER_MATCHER(templateName);
564   REGISTER_MATCHER(templateSpecializationType);
565   REGISTER_MATCHER(templateSpecializationTypeLoc);
566   REGISTER_MATCHER(templateTemplateParmDecl);
567   REGISTER_MATCHER(templateTypeParmDecl);
568   REGISTER_MATCHER(templateTypeParmType);
569   REGISTER_MATCHER(throughUsingDecl);
570   REGISTER_MATCHER(to);
571   REGISTER_MATCHER(translationUnitDecl);
572   REGISTER_MATCHER(type);
573   REGISTER_MATCHER(typeAliasDecl);
574   REGISTER_MATCHER(typeAliasTemplateDecl);
575   REGISTER_MATCHER(typeLoc);
576   REGISTER_MATCHER(typedefDecl);
577   REGISTER_MATCHER(typedefNameDecl);
578   REGISTER_MATCHER(typedefType);
579   REGISTER_MATCHER(unaryExprOrTypeTraitExpr);
580   REGISTER_MATCHER(unaryOperator);
581   REGISTER_MATCHER(unaryTransformType);
582   REGISTER_MATCHER(unless);
583   REGISTER_MATCHER(unresolvedLookupExpr);
584   REGISTER_MATCHER(unresolvedMemberExpr);
585   REGISTER_MATCHER(unresolvedUsingTypenameDecl);
586   REGISTER_MATCHER(unresolvedUsingValueDecl);
587   REGISTER_MATCHER(userDefinedLiteral);
588   REGISTER_MATCHER(usesADL);
589   REGISTER_MATCHER(usingDecl);
590   REGISTER_MATCHER(usingEnumDecl);
591   REGISTER_MATCHER(usingDirectiveDecl);
592   REGISTER_MATCHER(valueDecl);
593   REGISTER_MATCHER(varDecl);
594   REGISTER_MATCHER(variableArrayType);
595   REGISTER_MATCHER(voidType);
596   REGISTER_MATCHER(whileStmt);
597   REGISTER_MATCHER(withInitializer);
598 }
599 
600 RegistryMaps::~RegistryMaps() = default;
601 
602 static llvm::ManagedStatic<RegistryMaps> RegistryData;
603 
604 ASTNodeKind Registry::nodeMatcherType(MatcherCtor Ctor) {
605   return Ctor->nodeMatcherType();
606 }
607 
608 internal::MatcherDescriptorPtr::MatcherDescriptorPtr(MatcherDescriptor *Ptr)
609     : Ptr(Ptr) {}
610 
611 internal::MatcherDescriptorPtr::~MatcherDescriptorPtr() { delete Ptr; }
612 
613 bool Registry::isBuilderMatcher(MatcherCtor Ctor) {
614   return Ctor->isBuilderMatcher();
615 }
616 
617 internal::MatcherDescriptorPtr
618 Registry::buildMatcherCtor(MatcherCtor Ctor, SourceRange NameRange,
619                            ArrayRef<ParserValue> Args, Diagnostics *Error) {
620   return internal::MatcherDescriptorPtr(
621       Ctor->buildMatcherCtor(NameRange, Args, Error).release());
622 }
623 
624 // static
625 llvm::Optional<MatcherCtor> Registry::lookupMatcherCtor(StringRef MatcherName) {
626   auto it = RegistryData->constructors().find(MatcherName);
627   return it == RegistryData->constructors().end()
628              ? llvm::Optional<MatcherCtor>()
629              : it->second.get();
630 }
631 
632 static llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
633                                      const std::set<ASTNodeKind> &KS) {
634   unsigned Count = 0;
635   for (std::set<ASTNodeKind>::const_iterator I = KS.begin(), E = KS.end();
636        I != E; ++I) {
637     if (I != KS.begin())
638       OS << "|";
639     if (Count++ == 3) {
640       OS << "...";
641       break;
642     }
643     OS << *I;
644   }
645   return OS;
646 }
647 
648 std::vector<ArgKind> Registry::getAcceptedCompletionTypes(
649     ArrayRef<std::pair<MatcherCtor, unsigned>> Context) {
650   ASTNodeKind InitialTypes[] = {
651       ASTNodeKind::getFromNodeKind<Decl>(),
652       ASTNodeKind::getFromNodeKind<QualType>(),
653       ASTNodeKind::getFromNodeKind<Type>(),
654       ASTNodeKind::getFromNodeKind<Stmt>(),
655       ASTNodeKind::getFromNodeKind<NestedNameSpecifier>(),
656       ASTNodeKind::getFromNodeKind<NestedNameSpecifierLoc>(),
657       ASTNodeKind::getFromNodeKind<TypeLoc>()};
658 
659   // Starting with the above seed of acceptable top-level matcher types, compute
660   // the acceptable type set for the argument indicated by each context element.
661   std::set<ArgKind> TypeSet;
662   for (auto IT : InitialTypes) {
663     TypeSet.insert(ArgKind::MakeMatcherArg(IT));
664   }
665   for (const auto &CtxEntry : Context) {
666     MatcherCtor Ctor = CtxEntry.first;
667     unsigned ArgNumber = CtxEntry.second;
668     std::vector<ArgKind> NextTypeSet;
669     for (const ArgKind &Kind : TypeSet) {
670       if (Kind.getArgKind() == Kind.AK_Matcher &&
671           Ctor->isConvertibleTo(Kind.getMatcherKind()) &&
672           (Ctor->isVariadic() || ArgNumber < Ctor->getNumArgs()))
673         Ctor->getArgKinds(Kind.getMatcherKind(), ArgNumber, NextTypeSet);
674     }
675     TypeSet.clear();
676     TypeSet.insert(NextTypeSet.begin(), NextTypeSet.end());
677   }
678   return std::vector<ArgKind>(TypeSet.begin(), TypeSet.end());
679 }
680 
681 std::vector<MatcherCompletion>
682 Registry::getMatcherCompletions(ArrayRef<ArgKind> AcceptedTypes) {
683   std::vector<MatcherCompletion> Completions;
684 
685   // Search the registry for acceptable matchers.
686   for (const auto &M : RegistryData->constructors()) {
687     const MatcherDescriptor& Matcher = *M.getValue();
688     StringRef Name = M.getKey();
689 
690     std::set<ASTNodeKind> RetKinds;
691     unsigned NumArgs = Matcher.isVariadic() ? 1 : Matcher.getNumArgs();
692     bool IsPolymorphic = Matcher.isPolymorphic();
693     std::vector<std::vector<ArgKind>> ArgsKinds(NumArgs);
694     unsigned MaxSpecificity = 0;
695     bool NodeArgs = false;
696     for (const ArgKind& Kind : AcceptedTypes) {
697       if (Kind.getArgKind() != Kind.AK_Matcher &&
698           Kind.getArgKind() != Kind.AK_Node) {
699         continue;
700       }
701 
702       if (Kind.getArgKind() == Kind.AK_Node) {
703         NodeArgs = true;
704         unsigned Specificity;
705         ASTNodeKind LeastDerivedKind;
706         if (Matcher.isConvertibleTo(Kind.getNodeKind(), &Specificity,
707                                     &LeastDerivedKind)) {
708           if (MaxSpecificity < Specificity)
709             MaxSpecificity = Specificity;
710           RetKinds.insert(LeastDerivedKind);
711           for (unsigned Arg = 0; Arg != NumArgs; ++Arg)
712             Matcher.getArgKinds(Kind.getNodeKind(), Arg, ArgsKinds[Arg]);
713           if (IsPolymorphic)
714             break;
715         }
716       } else {
717         unsigned Specificity;
718         ASTNodeKind LeastDerivedKind;
719         if (Matcher.isConvertibleTo(Kind.getMatcherKind(), &Specificity,
720                                     &LeastDerivedKind)) {
721           if (MaxSpecificity < Specificity)
722             MaxSpecificity = Specificity;
723           RetKinds.insert(LeastDerivedKind);
724           for (unsigned Arg = 0; Arg != NumArgs; ++Arg)
725             Matcher.getArgKinds(Kind.getMatcherKind(), Arg, ArgsKinds[Arg]);
726           if (IsPolymorphic)
727             break;
728         }
729       }
730     }
731 
732     if (!RetKinds.empty() && MaxSpecificity > 0) {
733       std::string Decl;
734       llvm::raw_string_ostream OS(Decl);
735 
736       std::string TypedText = std::string(Name);
737 
738       if (NodeArgs) {
739         OS << Name;
740       } else {
741 
742         if (IsPolymorphic) {
743           OS << "Matcher<T> " << Name << "(Matcher<T>";
744         } else {
745           OS << "Matcher<" << RetKinds << "> " << Name << "(";
746           for (const std::vector<ArgKind> &Arg : ArgsKinds) {
747             if (&Arg != &ArgsKinds[0])
748               OS << ", ";
749 
750             bool FirstArgKind = true;
751             std::set<ASTNodeKind> MatcherKinds;
752             // Two steps. First all non-matchers, then matchers only.
753             for (const ArgKind &AK : Arg) {
754               if (AK.getArgKind() == ArgKind::AK_Matcher) {
755                 MatcherKinds.insert(AK.getMatcherKind());
756               } else {
757                 if (!FirstArgKind)
758                   OS << "|";
759                 FirstArgKind = false;
760                 OS << AK.asString();
761               }
762             }
763             if (!MatcherKinds.empty()) {
764               if (!FirstArgKind) OS << "|";
765               OS << "Matcher<" << MatcherKinds << ">";
766             }
767           }
768         }
769         if (Matcher.isVariadic())
770           OS << "...";
771         OS << ")";
772 
773         TypedText += "(";
774         if (ArgsKinds.empty())
775           TypedText += ")";
776         else if (ArgsKinds[0][0].getArgKind() == ArgKind::AK_String)
777           TypedText += "\"";
778       }
779 
780       Completions.emplace_back(TypedText, OS.str(), MaxSpecificity);
781     }
782   }
783 
784   return Completions;
785 }
786 
787 VariantMatcher Registry::constructMatcher(MatcherCtor Ctor,
788                                           SourceRange NameRange,
789                                           ArrayRef<ParserValue> Args,
790                                           Diagnostics *Error) {
791   return Ctor->create(NameRange, Args, Error);
792 }
793 
794 VariantMatcher Registry::constructBoundMatcher(MatcherCtor Ctor,
795                                                SourceRange NameRange,
796                                                StringRef BindID,
797                                                ArrayRef<ParserValue> Args,
798                                                Diagnostics *Error) {
799   VariantMatcher Out = constructMatcher(Ctor, NameRange, Args, Error);
800   if (Out.isNull()) return Out;
801 
802   llvm::Optional<DynTypedMatcher> Result = Out.getSingleMatcher();
803   if (Result) {
804     llvm::Optional<DynTypedMatcher> Bound = Result->tryBind(BindID);
805     if (Bound) {
806       return VariantMatcher::SingleMatcher(*Bound);
807     }
808   }
809   Error->addError(NameRange, Error->ET_RegistryNotBindable);
810   return VariantMatcher();
811 }
812 
813 } // namespace dynamic
814 } // namespace ast_matchers
815 } // namespace clang
816