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