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