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