1 //===--- Registry.cpp - Matcher registry -------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===------------------------------------------------------------===// 9 /// 10 /// \file 11 /// \brief Registry map populated at static initialization time. 12 /// 13 //===------------------------------------------------------------===// 14 15 #include "clang/ASTMatchers/Dynamic/Registry.h" 16 #include "Marshallers.h" 17 #include "clang/ASTMatchers/ASTMatchers.h" 18 #include "llvm/ADT/StringMap.h" 19 #include "llvm/ADT/StringRef.h" 20 #include "llvm/Support/ManagedStatic.h" 21 #include <set> 22 #include <utility> 23 24 using namespace clang::ast_type_traits; 25 26 namespace clang { 27 namespace ast_matchers { 28 namespace dynamic { 29 namespace { 30 31 using internal::MatcherDescriptor; 32 33 typedef llvm::StringMap<const MatcherDescriptor *> ConstructorMap; 34 class RegistryMaps { 35 public: 36 RegistryMaps(); 37 ~RegistryMaps(); 38 39 const ConstructorMap &constructors() const { return Constructors; } 40 41 private: 42 void registerMatcher(StringRef MatcherName, MatcherDescriptor *Callback); 43 ConstructorMap Constructors; 44 }; 45 46 void RegistryMaps::registerMatcher(StringRef MatcherName, 47 MatcherDescriptor *Callback) { 48 assert(Constructors.find(MatcherName) == Constructors.end()); 49 Constructors[MatcherName] = Callback; 50 } 51 52 #define REGISTER_MATCHER(name) \ 53 registerMatcher(#name, internal::makeMatcherAutoMarshall( \ 54 ::clang::ast_matchers::name, #name)); 55 56 #define SPECIFIC_MATCHER_OVERLOAD(name, Id) \ 57 static_cast< ::clang::ast_matchers::name##_Type##Id>( \ 58 ::clang::ast_matchers::name) 59 60 #define REGISTER_OVERLOADED_2(name) \ 61 do { \ 62 MatcherDescriptor *Callbacks[] = { \ 63 internal::makeMatcherAutoMarshall(SPECIFIC_MATCHER_OVERLOAD(name, 0), \ 64 #name), \ 65 internal::makeMatcherAutoMarshall(SPECIFIC_MATCHER_OVERLOAD(name, 1), \ 66 #name) \ 67 }; \ 68 registerMatcher(#name, \ 69 new internal::OverloadedMatcherDescriptor(Callbacks)); \ 70 } while (0) 71 72 /// \brief Generate a registry map with all the known matchers. 73 RegistryMaps::RegistryMaps() { 74 // TODO: Here is the list of the missing matchers, grouped by reason. 75 // 76 // Need Variant/Parser fixes: 77 // ofKind 78 // 79 // Polymorphic + argument overload: 80 // findAll 81 // 82 // Other: 83 // loc 84 // equals 85 // equalsNode 86 87 REGISTER_OVERLOADED_2(callee); 88 REGISTER_OVERLOADED_2(hasPrefix); 89 REGISTER_OVERLOADED_2(hasType); 90 REGISTER_OVERLOADED_2(isDerivedFrom); 91 REGISTER_OVERLOADED_2(isSameOrDerivedFrom); 92 REGISTER_OVERLOADED_2(pointsTo); 93 REGISTER_OVERLOADED_2(references); 94 REGISTER_OVERLOADED_2(thisPointerType); 95 96 REGISTER_MATCHER(accessSpecDecl); 97 REGISTER_MATCHER(alignOfExpr); 98 REGISTER_MATCHER(allOf); 99 REGISTER_MATCHER(anyOf); 100 REGISTER_MATCHER(anything); 101 REGISTER_MATCHER(argumentCountIs); 102 REGISTER_MATCHER(arraySubscriptExpr); 103 REGISTER_MATCHER(arrayType); 104 REGISTER_MATCHER(asString); 105 REGISTER_MATCHER(asmStmt); 106 REGISTER_MATCHER(atomicType); 107 REGISTER_MATCHER(autoType); 108 REGISTER_MATCHER(binaryOperator); 109 REGISTER_MATCHER(bindTemporaryExpr); 110 REGISTER_MATCHER(blockPointerType); 111 REGISTER_MATCHER(boolLiteral); 112 REGISTER_MATCHER(breakStmt); 113 REGISTER_MATCHER(builtinType); 114 REGISTER_MATCHER(cStyleCastExpr); 115 REGISTER_MATCHER(callExpr); 116 REGISTER_MATCHER(caseStmt); 117 REGISTER_MATCHER(castExpr); 118 REGISTER_MATCHER(catchStmt); 119 REGISTER_MATCHER(characterLiteral); 120 REGISTER_MATCHER(classTemplateDecl); 121 REGISTER_MATCHER(classTemplateSpecializationDecl); 122 REGISTER_MATCHER(complexType); 123 REGISTER_MATCHER(compoundLiteralExpr); 124 REGISTER_MATCHER(compoundStmt); 125 REGISTER_MATCHER(conditionalOperator); 126 REGISTER_MATCHER(constCastExpr); 127 REGISTER_MATCHER(constantArrayType); 128 REGISTER_MATCHER(constructExpr); 129 REGISTER_MATCHER(constructorDecl); 130 REGISTER_MATCHER(containsDeclaration); 131 REGISTER_MATCHER(continueStmt); 132 REGISTER_MATCHER(ctorInitializer); 133 REGISTER_MATCHER(decl); 134 REGISTER_MATCHER(declCountIs); 135 REGISTER_MATCHER(declRefExpr); 136 REGISTER_MATCHER(declStmt); 137 REGISTER_MATCHER(declaratorDecl); 138 REGISTER_MATCHER(defaultArgExpr); 139 REGISTER_MATCHER(defaultStmt); 140 REGISTER_MATCHER(deleteExpr); 141 REGISTER_MATCHER(dependentSizedArrayType); 142 REGISTER_MATCHER(destructorDecl); 143 REGISTER_MATCHER(doStmt); 144 REGISTER_MATCHER(dynamicCastExpr); 145 REGISTER_MATCHER(eachOf); 146 REGISTER_MATCHER(elaboratedType); 147 REGISTER_MATCHER(enumConstantDecl); 148 REGISTER_MATCHER(enumDecl); 149 REGISTER_MATCHER(equalsBoundNode); 150 REGISTER_MATCHER(explicitCastExpr); 151 REGISTER_MATCHER(expr); 152 REGISTER_MATCHER(fieldDecl); 153 REGISTER_MATCHER(floatLiteral); 154 REGISTER_MATCHER(forEach); 155 REGISTER_MATCHER(forEachConstructorInitializer); 156 REGISTER_MATCHER(forEachDescendant); 157 REGISTER_MATCHER(forEachSwitchCase); 158 REGISTER_MATCHER(forField); 159 REGISTER_MATCHER(forRangeStmt); 160 REGISTER_MATCHER(forStmt); 161 REGISTER_MATCHER(friendDecl); 162 REGISTER_MATCHER(functionDecl); 163 REGISTER_MATCHER(functionTemplateDecl); 164 REGISTER_MATCHER(functionType); 165 REGISTER_MATCHER(functionalCastExpr); 166 REGISTER_MATCHER(gotoStmt); 167 REGISTER_MATCHER(has); 168 REGISTER_MATCHER(hasAncestor); 169 REGISTER_MATCHER(hasAnyArgument); 170 REGISTER_MATCHER(hasAnyConstructorInitializer); 171 REGISTER_MATCHER(hasAnyParameter); 172 REGISTER_MATCHER(hasAnySubstatement); 173 REGISTER_MATCHER(hasAnyTemplateArgument); 174 REGISTER_MATCHER(hasAnyUsingShadowDecl); 175 REGISTER_MATCHER(hasArgument); 176 REGISTER_MATCHER(hasArgumentOfType); 177 REGISTER_MATCHER(hasBase); 178 REGISTER_MATCHER(hasBody); 179 REGISTER_MATCHER(hasCanonicalType); 180 REGISTER_MATCHER(hasCaseConstant); 181 REGISTER_MATCHER(hasCondition); 182 REGISTER_MATCHER(hasConditionVariableStatement); 183 REGISTER_MATCHER(hasDeclContext); 184 REGISTER_MATCHER(hasDeclaration); 185 REGISTER_MATCHER(hasDeducedType); 186 REGISTER_MATCHER(hasDescendant); 187 REGISTER_MATCHER(hasDestinationType); 188 REGISTER_MATCHER(hasEitherOperand); 189 REGISTER_MATCHER(hasElementType); 190 REGISTER_MATCHER(hasFalseExpression); 191 REGISTER_MATCHER(hasImplicitDestinationType); 192 REGISTER_MATCHER(hasIncrement); 193 REGISTER_MATCHER(hasIndex); 194 REGISTER_MATCHER(hasInitializer); 195 REGISTER_MATCHER(hasLHS); 196 REGISTER_MATCHER(hasLocalQualifiers); 197 REGISTER_MATCHER(hasLoopInit); 198 REGISTER_MATCHER(hasMethod); 199 REGISTER_MATCHER(hasName); 200 REGISTER_MATCHER(hasObjectExpression); 201 REGISTER_MATCHER(hasOperatorName); 202 REGISTER_MATCHER(hasOverloadedOperatorName); 203 REGISTER_MATCHER(hasParameter); 204 REGISTER_MATCHER(hasParent); 205 REGISTER_MATCHER(hasQualifier); 206 REGISTER_MATCHER(hasRHS); 207 REGISTER_MATCHER(hasSingleDecl); 208 REGISTER_MATCHER(hasSize); 209 REGISTER_MATCHER(hasSizeExpr); 210 REGISTER_MATCHER(hasSourceExpression); 211 REGISTER_MATCHER(hasTargetDecl); 212 REGISTER_MATCHER(hasTemplateArgument); 213 REGISTER_MATCHER(hasTrueExpression); 214 REGISTER_MATCHER(hasTypeLoc); 215 REGISTER_MATCHER(hasUnaryOperand); 216 REGISTER_MATCHER(hasValueType); 217 REGISTER_MATCHER(ifStmt); 218 REGISTER_MATCHER(ignoringImpCasts); 219 REGISTER_MATCHER(ignoringParenCasts); 220 REGISTER_MATCHER(ignoringParenImpCasts); 221 REGISTER_MATCHER(implicitCastExpr); 222 REGISTER_MATCHER(incompleteArrayType); 223 REGISTER_MATCHER(initListExpr); 224 REGISTER_MATCHER(innerType); 225 REGISTER_MATCHER(integerLiteral); 226 REGISTER_MATCHER(isArrow); 227 REGISTER_MATCHER(isConst); 228 REGISTER_MATCHER(isConstQualified); 229 REGISTER_MATCHER(isDefinition); 230 REGISTER_MATCHER(isExplicitTemplateSpecialization); 231 REGISTER_MATCHER(isExternC); 232 REGISTER_MATCHER(isImplicit); 233 REGISTER_MATCHER(isInteger); 234 REGISTER_MATCHER(isListInitialization); 235 REGISTER_MATCHER(isOverride); 236 REGISTER_MATCHER(isPrivate); 237 REGISTER_MATCHER(isProtected); 238 REGISTER_MATCHER(isPublic); 239 REGISTER_MATCHER(isTemplateInstantiation); 240 REGISTER_MATCHER(isVirtual); 241 REGISTER_MATCHER(isWritten); 242 REGISTER_MATCHER(lValueReferenceType); 243 REGISTER_MATCHER(labelStmt); 244 REGISTER_MATCHER(lambdaExpr); 245 REGISTER_MATCHER(matchesName); 246 REGISTER_MATCHER(materializeTemporaryExpr); 247 REGISTER_MATCHER(member); 248 REGISTER_MATCHER(memberCallExpr); 249 REGISTER_MATCHER(memberExpr); 250 REGISTER_MATCHER(memberPointerType); 251 REGISTER_MATCHER(methodDecl); 252 REGISTER_MATCHER(namedDecl); 253 REGISTER_MATCHER(namesType); 254 REGISTER_MATCHER(namespaceDecl); 255 REGISTER_MATCHER(nestedNameSpecifier); 256 REGISTER_MATCHER(nestedNameSpecifierLoc); 257 REGISTER_MATCHER(newExpr); 258 REGISTER_MATCHER(nullPtrLiteralExpr); 259 REGISTER_MATCHER(nullStmt); 260 REGISTER_MATCHER(ofClass); 261 REGISTER_MATCHER(on); 262 REGISTER_MATCHER(onImplicitObjectArgument); 263 REGISTER_MATCHER(operatorCallExpr); 264 REGISTER_MATCHER(parameterCountIs); 265 REGISTER_MATCHER(parenType); 266 REGISTER_MATCHER(parmVarDecl); 267 REGISTER_MATCHER(pointee); 268 REGISTER_MATCHER(pointerType); 269 REGISTER_MATCHER(qualType); 270 REGISTER_MATCHER(rValueReferenceType); 271 REGISTER_MATCHER(recordDecl); 272 REGISTER_MATCHER(recordType); 273 REGISTER_MATCHER(referenceType); 274 REGISTER_MATCHER(refersToDeclaration); 275 REGISTER_MATCHER(refersToType); 276 REGISTER_MATCHER(reinterpretCastExpr); 277 REGISTER_MATCHER(returnStmt); 278 REGISTER_MATCHER(returns); 279 REGISTER_MATCHER(sizeOfExpr); 280 REGISTER_MATCHER(specifiesNamespace); 281 REGISTER_MATCHER(specifiesType); 282 REGISTER_MATCHER(specifiesTypeLoc); 283 REGISTER_MATCHER(statementCountIs); 284 REGISTER_MATCHER(staticCastExpr); 285 REGISTER_MATCHER(stmt); 286 REGISTER_MATCHER(stringLiteral); 287 REGISTER_MATCHER(switchCase); 288 REGISTER_MATCHER(switchStmt); 289 REGISTER_MATCHER(templateSpecializationType); 290 REGISTER_MATCHER(temporaryObjectExpr); 291 REGISTER_MATCHER(thisExpr); 292 REGISTER_MATCHER(throughUsingDecl); 293 REGISTER_MATCHER(throwExpr); 294 REGISTER_MATCHER(to); 295 REGISTER_MATCHER(tryStmt); 296 REGISTER_MATCHER(type); 297 REGISTER_MATCHER(typeLoc); 298 REGISTER_MATCHER(typedefType); 299 REGISTER_MATCHER(unaryExprOrTypeTraitExpr); 300 REGISTER_MATCHER(unaryOperator); 301 REGISTER_MATCHER(unaryTransformType); 302 REGISTER_MATCHER(unless); 303 REGISTER_MATCHER(unresolvedConstructExpr); 304 REGISTER_MATCHER(unresolvedUsingValueDecl); 305 REGISTER_MATCHER(userDefinedLiteral); 306 REGISTER_MATCHER(usingDecl); 307 REGISTER_MATCHER(varDecl); 308 REGISTER_MATCHER(variableArrayType); 309 REGISTER_MATCHER(whileStmt); 310 REGISTER_MATCHER(withInitializer); 311 } 312 313 RegistryMaps::~RegistryMaps() { 314 for (ConstructorMap::iterator it = Constructors.begin(), 315 end = Constructors.end(); 316 it != end; ++it) { 317 delete it->second; 318 } 319 } 320 321 static llvm::ManagedStatic<RegistryMaps> RegistryData; 322 323 } // anonymous namespace 324 325 // static 326 llvm::Optional<MatcherCtor> 327 Registry::lookupMatcherCtor(StringRef MatcherName, const SourceRange &NameRange, 328 Diagnostics *Error) { 329 ConstructorMap::const_iterator it = 330 RegistryData->constructors().find(MatcherName); 331 if (it == RegistryData->constructors().end()) { 332 Error->addError(NameRange, Error->ET_RegistryNotFound) << MatcherName; 333 return llvm::Optional<MatcherCtor>(); 334 } 335 336 return it->second; 337 } 338 339 namespace { 340 341 llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, 342 const std::set<ASTNodeKind> &KS) { 343 unsigned Count = 0; 344 for (std::set<ASTNodeKind>::const_iterator I = KS.begin(), E = KS.end(); 345 I != E; ++I) { 346 if (I != KS.begin()) 347 OS << "|"; 348 if (Count++ == 3) { 349 OS << "..."; 350 break; 351 } 352 OS << *I; 353 } 354 return OS; 355 } 356 357 struct ReverseSpecificityThenName { 358 bool operator()(const std::pair<unsigned, std::string> &A, 359 const std::pair<unsigned, std::string> &B) const { 360 return A.first > B.first || (A.first == B.first && A.second < B.second); 361 } 362 }; 363 364 } 365 366 std::vector<MatcherCompletion> Registry::getCompletions( 367 llvm::ArrayRef<std::pair<MatcherCtor, unsigned> > Context) { 368 ASTNodeKind InitialTypes[] = { 369 ASTNodeKind::getFromNodeKind<Decl>(), 370 ASTNodeKind::getFromNodeKind<QualType>(), 371 ASTNodeKind::getFromNodeKind<Type>(), 372 ASTNodeKind::getFromNodeKind<Stmt>(), 373 ASTNodeKind::getFromNodeKind<NestedNameSpecifier>(), 374 ASTNodeKind::getFromNodeKind<NestedNameSpecifierLoc>(), 375 ASTNodeKind::getFromNodeKind<TypeLoc>() 376 }; 377 llvm::ArrayRef<ASTNodeKind> InitialTypesRef(InitialTypes); 378 379 // Starting with the above seed of acceptable top-level matcher types, compute 380 // the acceptable type set for the argument indicated by each context element. 381 std::set<ASTNodeKind> TypeSet(InitialTypesRef.begin(), InitialTypesRef.end()); 382 for (llvm::ArrayRef<std::pair<MatcherCtor, unsigned> >::iterator 383 CtxI = Context.begin(), 384 CtxE = Context.end(); 385 CtxI != CtxE; ++CtxI) { 386 std::vector<internal::ArgKind> NextTypeSet; 387 for (std::set<ASTNodeKind>::iterator I = TypeSet.begin(), E = TypeSet.end(); 388 I != E; ++I) { 389 if (CtxI->first->isConvertibleTo(*I) && 390 (CtxI->first->isVariadic() || 391 CtxI->second < CtxI->first->getNumArgs())) 392 CtxI->first->getArgKinds(*I, CtxI->second, NextTypeSet); 393 } 394 TypeSet.clear(); 395 for (std::vector<internal::ArgKind>::iterator I = NextTypeSet.begin(), 396 E = NextTypeSet.end(); 397 I != E; ++I) { 398 if (I->getArgKind() == internal::ArgKind::AK_Matcher) 399 TypeSet.insert(I->getMatcherKind()); 400 } 401 } 402 403 typedef std::map<std::pair<unsigned, std::string>, MatcherCompletion, 404 ReverseSpecificityThenName> CompletionsTy; 405 CompletionsTy Completions; 406 407 // TypeSet now contains the list of acceptable types for the argument we are 408 // completing. Search the registry for acceptable matchers. 409 for (ConstructorMap::const_iterator I = RegistryData->constructors().begin(), 410 E = RegistryData->constructors().end(); 411 I != E; ++I) { 412 std::set<ASTNodeKind> RetKinds; 413 unsigned NumArgs = I->second->isVariadic() ? 1 : I->second->getNumArgs(); 414 bool IsPolymorphic = I->second->isPolymorphic(); 415 std::vector<std::vector<internal::ArgKind> > ArgsKinds(NumArgs); 416 unsigned MaxSpecificity = 0; 417 for (std::set<ASTNodeKind>::iterator TI = TypeSet.begin(), 418 TE = TypeSet.end(); 419 TI != TE; ++TI) { 420 unsigned Specificity; 421 ASTNodeKind LeastDerivedKind; 422 if (I->second->isConvertibleTo(*TI, &Specificity, &LeastDerivedKind)) { 423 if (MaxSpecificity < Specificity) 424 MaxSpecificity = Specificity; 425 RetKinds.insert(LeastDerivedKind); 426 for (unsigned Arg = 0; Arg != NumArgs; ++Arg) 427 I->second->getArgKinds(*TI, Arg, ArgsKinds[Arg]); 428 if (IsPolymorphic) 429 break; 430 } 431 } 432 433 if (!RetKinds.empty() && MaxSpecificity > 0) { 434 std::string Decl; 435 llvm::raw_string_ostream OS(Decl); 436 437 if (IsPolymorphic) { 438 OS << "Matcher<T> " << I->first() << "(Matcher<T>"; 439 } else { 440 OS << "Matcher<" << RetKinds << "> " << I->first() << "("; 441 for (std::vector<std::vector<internal::ArgKind> >::iterator 442 KI = ArgsKinds.begin(), 443 KE = ArgsKinds.end(); 444 KI != KE; ++KI) { 445 if (KI != ArgsKinds.begin()) 446 OS << ", "; 447 // This currently assumes that a matcher may not overload a 448 // non-matcher, and all non-matcher overloads have identical 449 // arguments. 450 if ((*KI)[0].getArgKind() == internal::ArgKind::AK_Matcher) { 451 std::set<ASTNodeKind> MatcherKinds; 452 std::transform( 453 KI->begin(), KI->end(), 454 std::inserter(MatcherKinds, MatcherKinds.end()), 455 std::mem_fun_ref(&internal::ArgKind::getMatcherKind)); 456 OS << "Matcher<" << MatcherKinds << ">"; 457 } else { 458 OS << (*KI)[0].asString(); 459 } 460 } 461 } 462 if (I->second->isVariadic()) 463 OS << "..."; 464 OS << ")"; 465 466 std::string TypedText = I->first(); 467 TypedText += "("; 468 if (ArgsKinds.empty()) 469 TypedText += ")"; 470 else if (ArgsKinds[0][0].getArgKind() == internal::ArgKind::AK_String) 471 TypedText += "\""; 472 473 Completions[std::make_pair(MaxSpecificity, I->first())] = 474 MatcherCompletion(TypedText, OS.str()); 475 } 476 } 477 478 std::vector<MatcherCompletion> RetVal; 479 for (CompletionsTy::iterator I = Completions.begin(), E = Completions.end(); 480 I != E; ++I) 481 RetVal.push_back(I->second); 482 return RetVal; 483 } 484 485 // static 486 VariantMatcher Registry::constructMatcher(MatcherCtor Ctor, 487 const SourceRange &NameRange, 488 ArrayRef<ParserValue> Args, 489 Diagnostics *Error) { 490 return Ctor->create(NameRange, Args, Error); 491 } 492 493 // static 494 VariantMatcher Registry::constructBoundMatcher(MatcherCtor Ctor, 495 const SourceRange &NameRange, 496 StringRef BindID, 497 ArrayRef<ParserValue> Args, 498 Diagnostics *Error) { 499 VariantMatcher Out = constructMatcher(Ctor, NameRange, Args, Error); 500 if (Out.isNull()) return Out; 501 502 llvm::Optional<DynTypedMatcher> Result = Out.getSingleMatcher(); 503 if (Result.hasValue()) { 504 llvm::Optional<DynTypedMatcher> Bound = Result->tryBind(BindID); 505 if (Bound.hasValue()) { 506 return VariantMatcher::SingleMatcher(*Bound); 507 } 508 } 509 Error->addError(NameRange, Error->ET_RegistryNotBindable); 510 return VariantMatcher(); 511 } 512 513 } // namespace dynamic 514 } // namespace ast_matchers 515 } // namespace clang 516