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