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