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