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