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