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