CIndexUSRs.cpp revision 8c367589b68019b040f73d44282fc30e4f526f62
1//===- CIndexUSR.cpp - Clang-C Source Indexing Library --------------------===// 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// This file implements the generation and use of USRs from CXEntities. 11// 12//===----------------------------------------------------------------------===// 13 14#include "CIndexer.h" 15#include "CXCursor.h" 16#include "CXString.h" 17#include "clang/AST/DeclTemplate.h" 18#include "clang/AST/DeclVisitor.h" 19#include "clang/Frontend/ASTUnit.h" 20#include "clang/Lex/PreprocessingRecord.h" 21#include "llvm/ADT/SmallString.h" 22#include "llvm/Support/raw_ostream.h" 23 24using namespace clang; 25using namespace clang::cxstring; 26 27//===----------------------------------------------------------------------===// 28// USR generation. 29//===----------------------------------------------------------------------===// 30 31namespace { 32class USRGenerator : public DeclVisitor<USRGenerator> { 33 llvm::OwningPtr<llvm::SmallString<128> > OwnedBuf; 34 llvm::SmallVectorImpl<char> &Buf; 35 llvm::raw_svector_ostream Out; 36 bool IgnoreResults; 37 ASTUnit *AU; 38 bool generatedLoc; 39 40 llvm::DenseMap<const Type *, unsigned> TypeSubstitutions; 41 42public: 43 USRGenerator(const CXCursor *C = 0, llvm::SmallVectorImpl<char> *extBuf = 0) 44 : OwnedBuf(extBuf ? 0 : new llvm::SmallString<128>()), 45 Buf(extBuf ? *extBuf : *OwnedBuf.get()), 46 Out(Buf), 47 IgnoreResults(false), 48 AU(C ? cxcursor::getCursorASTUnit(*C) : 0), 49 generatedLoc(false) 50 { 51 // Add the USR space prefix. 52 Out << "c:"; 53 } 54 55 llvm::StringRef str() { 56 return Out.str(); 57 } 58 59 USRGenerator* operator->() { return this; } 60 61 template <typename T> 62 llvm::raw_svector_ostream &operator<<(const T &x) { 63 Out << x; 64 return Out; 65 } 66 67 bool ignoreResults() const { return IgnoreResults; } 68 69 // Visitation methods from generating USRs from AST elements. 70 void VisitDeclContext(DeclContext *D); 71 void VisitFieldDecl(FieldDecl *D); 72 void VisitFunctionDecl(FunctionDecl *D); 73 void VisitNamedDecl(NamedDecl *D); 74 void VisitNamespaceDecl(NamespaceDecl *D); 75 void VisitNamespaceAliasDecl(NamespaceAliasDecl *D); 76 void VisitFunctionTemplateDecl(FunctionTemplateDecl *D); 77 void VisitClassTemplateDecl(ClassTemplateDecl *D); 78 void VisitObjCClassDecl(ObjCClassDecl *CD); 79 void VisitObjCContainerDecl(ObjCContainerDecl *CD); 80 void VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *P); 81 void VisitObjCMethodDecl(ObjCMethodDecl *MD); 82 void VisitObjCPropertyDecl(ObjCPropertyDecl *D); 83 void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D); 84 void VisitTagDecl(TagDecl *D); 85 void VisitTypedefDecl(TypedefDecl *D); 86 void VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D); 87 void VisitVarDecl(VarDecl *D); 88 void VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D); 89 void VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D); 90 void VisitLinkageSpecDecl(LinkageSpecDecl *D) { 91 IgnoreResults = true; 92 } 93 void VisitUsingDirectiveDecl(UsingDirectiveDecl *D) { 94 IgnoreResults = true; 95 } 96 void VisitUsingDecl(UsingDecl *D) { 97 IgnoreResults = true; 98 } 99 void VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) { 100 IgnoreResults = true; 101 } 102 void VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D) { 103 IgnoreResults = true; 104 } 105 106 /// Generate the string component containing the location of the 107 /// declaration. 108 bool GenLoc(const Decl *D); 109 110 /// String generation methods used both by the visitation methods 111 /// and from other clients that want to directly generate USRs. These 112 /// methods do not construct complete USRs (which incorporate the parents 113 /// of an AST element), but only the fragments concerning the AST element 114 /// itself. 115 116 /// Generate a USR for an Objective-C class. 117 void GenObjCClass(llvm::StringRef cls); 118 /// Generate a USR for an Objective-C class category. 119 void GenObjCCategory(llvm::StringRef cls, llvm::StringRef cat); 120 /// Generate a USR fragment for an Objective-C instance variable. The 121 /// complete USR can be created by concatenating the USR for the 122 /// encompassing class with this USR fragment. 123 void GenObjCIvar(llvm::StringRef ivar); 124 /// Generate a USR fragment for an Objective-C method. 125 void GenObjCMethod(llvm::StringRef sel, bool isInstanceMethod); 126 /// Generate a USR fragment for an Objective-C property. 127 void GenObjCProperty(llvm::StringRef prop); 128 /// Generate a USR for an Objective-C protocol. 129 void GenObjCProtocol(llvm::StringRef prot); 130 131 void VisitType(QualType T); 132 void VisitTemplateParameterList(const TemplateParameterList *Params); 133 void VisitTemplateName(TemplateName Name); 134 void VisitTemplateArgument(const TemplateArgument &Arg); 135 136 /// Emit a Decl's name using NamedDecl::printName() and return true if 137 /// the decl had no name. 138 bool EmitDeclName(const NamedDecl *D); 139}; 140 141} // end anonymous namespace 142 143//===----------------------------------------------------------------------===// 144// Generating USRs from ASTS. 145//===----------------------------------------------------------------------===// 146 147bool USRGenerator::EmitDeclName(const NamedDecl *D) { 148 Out.flush(); 149 const unsigned startSize = Buf.size(); 150 D->printName(Out); 151 Out.flush(); 152 const unsigned endSize = Buf.size(); 153 return startSize == endSize; 154} 155 156static bool InAnonymousNamespace(const Decl *D) { 157 if (const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(D->getDeclContext())) 158 return ND->isAnonymousNamespace(); 159 return false; 160} 161 162static inline bool ShouldGenerateLocation(const NamedDecl *D) { 163 return D->getLinkage() != ExternalLinkage && !InAnonymousNamespace(D); 164} 165 166void USRGenerator::VisitDeclContext(DeclContext *DC) { 167 if (NamedDecl *D = dyn_cast<NamedDecl>(DC)) 168 Visit(D); 169} 170 171void USRGenerator::VisitFieldDecl(FieldDecl *D) { 172 VisitDeclContext(D->getDeclContext()); 173 Out << (isa<ObjCIvarDecl>(D) ? "@" : "@FI@"); 174 if (EmitDeclName(D)) { 175 // Bit fields can be anonymous. 176 IgnoreResults = true; 177 return; 178 } 179} 180 181void USRGenerator::VisitFunctionDecl(FunctionDecl *D) { 182 if (ShouldGenerateLocation(D) && GenLoc(D)) 183 return; 184 185 VisitDeclContext(D->getDeclContext()); 186 if (FunctionTemplateDecl *FunTmpl = D->getDescribedFunctionTemplate()) { 187 Out << "@FT@"; 188 VisitTemplateParameterList(FunTmpl->getTemplateParameters()); 189 } else 190 Out << "@F@"; 191 D->printName(Out); 192 193 ASTContext &Ctx = AU->getASTContext(); 194 if (!Ctx.getLangOptions().CPlusPlus || D->isExternC()) 195 return; 196 197 // Mangle in type information for the arguments. 198 for (FunctionDecl::param_iterator I = D->param_begin(), E = D->param_end(); 199 I != E; ++I) { 200 Out << '#'; 201 if (ParmVarDecl *PD = *I) 202 VisitType(PD->getType()); 203 } 204 if (D->isVariadic()) 205 Out << '.'; 206 Out << '#'; 207 if (CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(D)) { 208 if (MD->isStatic()) 209 Out << 'S'; 210 if (unsigned quals = MD->getTypeQualifiers()) 211 Out << (char)('0' + quals); 212 } 213} 214 215void USRGenerator::VisitNamedDecl(NamedDecl *D) { 216 VisitDeclContext(D->getDeclContext()); 217 Out << "@"; 218 219 if (EmitDeclName(D)) { 220 // The string can be empty if the declaration has no name; e.g., it is 221 // the ParmDecl with no name for declaration of a function pointer type, 222 // e.g.: void (*f)(void *); 223 // In this case, don't generate a USR. 224 IgnoreResults = true; 225 } 226} 227 228void USRGenerator::VisitVarDecl(VarDecl *D) { 229 // VarDecls can be declared 'extern' within a function or method body, 230 // but their enclosing DeclContext is the function, not the TU. We need 231 // to check the storage class to correctly generate the USR. 232 if (ShouldGenerateLocation(D) && GenLoc(D)) 233 return; 234 235 VisitDeclContext(D->getDeclContext()); 236 237 // Variables always have simple names. 238 llvm::StringRef s = D->getName(); 239 240 // The string can be empty if the declaration has no name; e.g., it is 241 // the ParmDecl with no name for declaration of a function pointer type, e.g.: 242 // void (*f)(void *); 243 // In this case, don't generate a USR. 244 if (s.empty()) 245 IgnoreResults = true; 246 else 247 Out << '@' << s; 248} 249 250void USRGenerator::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) { 251 GenLoc(D); 252 return; 253} 254 255void USRGenerator::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) { 256 GenLoc(D); 257 return; 258} 259 260void USRGenerator::VisitNamespaceDecl(NamespaceDecl *D) { 261 if (D->isAnonymousNamespace()) { 262 Out << "@aN"; 263 return; 264 } 265 266 VisitDeclContext(D->getDeclContext()); 267 if (!IgnoreResults) 268 Out << "@N@" << D->getName(); 269} 270 271void USRGenerator::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) { 272 VisitFunctionDecl(D->getTemplatedDecl()); 273} 274 275void USRGenerator::VisitClassTemplateDecl(ClassTemplateDecl *D) { 276 VisitTagDecl(D->getTemplatedDecl()); 277} 278 279void USRGenerator::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) { 280 VisitDeclContext(D->getDeclContext()); 281 if (!IgnoreResults) 282 Out << "@NA@" << D->getName(); 283} 284 285void USRGenerator::VisitObjCMethodDecl(ObjCMethodDecl *D) { 286 DeclContext *container = D->getDeclContext(); 287 if (ObjCProtocolDecl *pd = dyn_cast<ObjCProtocolDecl>(container)) { 288 Visit(pd); 289 } 290 else { 291 // The USR for a method declared in a class extension or category is based on 292 // the ObjCInterfaceDecl, not the ObjCCategoryDecl. 293 ObjCInterfaceDecl *ID = D->getClassInterface(); 294 if (!ID) { 295 IgnoreResults = true; 296 return; 297 } 298 Visit(ID); 299 } 300 // Ideally we would use 'GenObjCMethod', but this is such a hot path 301 // for Objective-C code that we don't want to use 302 // DeclarationName::getAsString(). 303 Out << (D->isInstanceMethod() ? "(im)" : "(cm)"); 304 DeclarationName N(D->getSelector()); 305 N.printName(Out); 306} 307 308void USRGenerator::VisitObjCClassDecl(ObjCClassDecl *D) { 309 // FIXME: @class declarations can refer to multiple classes. We need 310 // to be able to traverse these. 311 IgnoreResults = true; 312} 313 314void USRGenerator::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) { 315 // FIXME: @protocol declarations can refer to multiple protocols. We need 316 // to be able to traverse these. 317 IgnoreResults = true; 318} 319 320void USRGenerator::VisitObjCContainerDecl(ObjCContainerDecl *D) { 321 switch (D->getKind()) { 322 default: 323 assert(false && "Invalid ObjC container."); 324 case Decl::ObjCInterface: 325 case Decl::ObjCImplementation: 326 GenObjCClass(D->getName()); 327 break; 328 case Decl::ObjCCategory: { 329 ObjCCategoryDecl *CD = cast<ObjCCategoryDecl>(D); 330 ObjCInterfaceDecl *ID = CD->getClassInterface(); 331 if (!ID) { 332 // Handle invalid code where the @interface might not 333 // have been specified. 334 // FIXME: We should be able to generate this USR even if the 335 // @interface isn't available. 336 IgnoreResults = true; 337 return; 338 } 339 // Specially handle class extensions, which are anonymous categories. 340 // We want to mangle in the location to uniquely distinguish them. 341 if (CD->IsClassExtension()) { 342 Out << "objc(ext)" << ID->getName() << '@'; 343 GenLoc(CD); 344 } 345 else 346 GenObjCCategory(ID->getName(), CD->getName()); 347 348 break; 349 } 350 case Decl::ObjCCategoryImpl: { 351 ObjCCategoryImplDecl *CD = cast<ObjCCategoryImplDecl>(D); 352 ObjCInterfaceDecl *ID = CD->getClassInterface(); 353 if (!ID) { 354 // Handle invalid code where the @interface might not 355 // have been specified. 356 // FIXME: We should be able to generate this USR even if the 357 // @interface isn't available. 358 IgnoreResults = true; 359 return; 360 } 361 GenObjCCategory(ID->getName(), CD->getName()); 362 break; 363 } 364 case Decl::ObjCProtocol: 365 GenObjCProtocol(cast<ObjCProtocolDecl>(D)->getName()); 366 break; 367 } 368} 369 370void USRGenerator::VisitObjCPropertyDecl(ObjCPropertyDecl *D) { 371 Visit(cast<Decl>(D->getDeclContext())); 372 GenObjCProperty(D->getName()); 373} 374 375void USRGenerator::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D) { 376 if (ObjCPropertyDecl *PD = D->getPropertyDecl()) { 377 VisitObjCPropertyDecl(PD); 378 return; 379 } 380 381 IgnoreResults = true; 382} 383 384void USRGenerator::VisitTagDecl(TagDecl *D) { 385 // Add the location of the tag decl to handle resolution across 386 // translation units. 387 if (ShouldGenerateLocation(D) && GenLoc(D)) 388 return; 389 390 D = D->getCanonicalDecl(); 391 VisitDeclContext(D->getDeclContext()); 392 393 bool AlreadyStarted = false; 394 if (CXXRecordDecl *CXXRecord = dyn_cast<CXXRecordDecl>(D)) { 395 if (ClassTemplateDecl *ClassTmpl = CXXRecord->getDescribedClassTemplate()) { 396 AlreadyStarted = true; 397 398 switch (D->getTagKind()) { 399 case TTK_Struct: Out << "@ST"; break; 400 case TTK_Class: Out << "@CT"; break; 401 case TTK_Union: Out << "@UT"; break; 402 case TTK_Enum: llvm_unreachable("enum template"); break; 403 } 404 VisitTemplateParameterList(ClassTmpl->getTemplateParameters()); 405 } else if (ClassTemplatePartialSpecializationDecl *PartialSpec 406 = dyn_cast<ClassTemplatePartialSpecializationDecl>(CXXRecord)) { 407 AlreadyStarted = true; 408 409 switch (D->getTagKind()) { 410 case TTK_Struct: Out << "@SP"; break; 411 case TTK_Class: Out << "@CP"; break; 412 case TTK_Union: Out << "@UP"; break; 413 case TTK_Enum: llvm_unreachable("enum partial specialization"); break; 414 } 415 VisitTemplateParameterList(PartialSpec->getTemplateParameters()); 416 } 417 } 418 419 if (!AlreadyStarted) { 420 switch (D->getTagKind()) { 421 case TTK_Struct: Out << "@S"; break; 422 case TTK_Class: Out << "@C"; break; 423 case TTK_Union: Out << "@U"; break; 424 case TTK_Enum: Out << "@E"; break; 425 } 426 } 427 428 Out << '@'; 429 Out.flush(); 430 assert(Buf.size() > 0); 431 const unsigned off = Buf.size() - 1; 432 433 if (EmitDeclName(D)) { 434 if (const TypedefNameDecl *TD = D->getTypedefNameForAnonDecl()) { 435 Buf[off] = 'A'; 436 Out << '@' << TD; 437 } 438 else 439 Buf[off] = 'a'; 440 } 441 442 // For a class template specialization, mangle the template arguments. 443 if (ClassTemplateSpecializationDecl *Spec 444 = dyn_cast<ClassTemplateSpecializationDecl>(D)) { 445 const TemplateArgumentList &Args = Spec->getTemplateInstantiationArgs(); 446 Out << '>'; 447 for (unsigned I = 0, N = Args.size(); I != N; ++I) { 448 Out << '#'; 449 VisitTemplateArgument(Args.get(I)); 450 } 451 } 452} 453 454void USRGenerator::VisitTypedefDecl(TypedefDecl *D) { 455 if (ShouldGenerateLocation(D) && GenLoc(D)) 456 return; 457 DeclContext *DC = D->getDeclContext(); 458 if (NamedDecl *DCN = dyn_cast<NamedDecl>(DC)) 459 Visit(DCN); 460 Out << "@T@"; 461 Out << D->getName(); 462} 463 464void USRGenerator::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) { 465 GenLoc(D); 466 return; 467} 468 469bool USRGenerator::GenLoc(const Decl *D) { 470 if (generatedLoc) 471 return IgnoreResults; 472 generatedLoc = true; 473 474 // Guard against null declarations in invalid code. 475 if (!D) { 476 IgnoreResults = true; 477 return true; 478 } 479 480 const SourceManager &SM = AU->getSourceManager(); 481 SourceLocation L = D->getLocStart(); 482 if (L.isInvalid()) { 483 IgnoreResults = true; 484 return true; 485 } 486 L = SM.getInstantiationLoc(L); 487 const std::pair<FileID, unsigned> &Decomposed = SM.getDecomposedLoc(L); 488 const FileEntry *FE = SM.getFileEntryForID(Decomposed.first); 489 if (FE) { 490 Out << llvm::sys::path::filename(FE->getName()); 491 } 492 else { 493 // This case really isn't interesting. 494 IgnoreResults = true; 495 return true; 496 } 497 // Use the offest into the FileID to represent the location. Using 498 // a line/column can cause us to look back at the original source file, 499 // which is expensive. 500 Out << '@' << Decomposed.second; 501 return IgnoreResults; 502} 503 504void USRGenerator::VisitType(QualType T) { 505 // This method mangles in USR information for types. It can possibly 506 // just reuse the naming-mangling logic used by codegen, although the 507 // requirements for USRs might not be the same. 508 ASTContext &Ctx = AU->getASTContext(); 509 510 do { 511 T = Ctx.getCanonicalType(T); 512 Qualifiers Q = T.getQualifiers(); 513 unsigned qVal = 0; 514 if (Q.hasConst()) 515 qVal |= 0x1; 516 if (Q.hasVolatile()) 517 qVal |= 0x2; 518 if (Q.hasRestrict()) 519 qVal |= 0x4; 520 if(qVal) 521 Out << ((char) ('0' + qVal)); 522 523 // Mangle in ObjC GC qualifiers? 524 525 if (const PackExpansionType *Expansion = T->getAs<PackExpansionType>()) { 526 Out << 'P'; 527 T = Expansion->getPattern(); 528 } 529 530 if (const BuiltinType *BT = T->getAs<BuiltinType>()) { 531 unsigned char c = '\0'; 532 switch (BT->getKind()) { 533 case BuiltinType::Void: 534 c = 'v'; break; 535 case BuiltinType::Bool: 536 c = 'b'; break; 537 case BuiltinType::Char_U: 538 case BuiltinType::UChar: 539 c = 'c'; break; 540 case BuiltinType::Char16: 541 c = 'q'; break; 542 case BuiltinType::Char32: 543 c = 'w'; break; 544 case BuiltinType::UShort: 545 c = 's'; break; 546 case BuiltinType::UInt: 547 c = 'i'; break; 548 case BuiltinType::ULong: 549 c = 'l'; break; 550 case BuiltinType::ULongLong: 551 c = 'k'; break; 552 case BuiltinType::UInt128: 553 c = 'j'; break; 554 case BuiltinType::Char_S: 555 case BuiltinType::SChar: 556 c = 'C'; break; 557 case BuiltinType::WChar_S: 558 case BuiltinType::WChar_U: 559 c = 'W'; break; 560 case BuiltinType::Short: 561 c = 'S'; break; 562 case BuiltinType::Int: 563 c = 'I'; break; 564 case BuiltinType::Long: 565 c = 'L'; break; 566 case BuiltinType::LongLong: 567 c = 'K'; break; 568 case BuiltinType::Int128: 569 c = 'J'; break; 570 case BuiltinType::Float: 571 c = 'f'; break; 572 case BuiltinType::Double: 573 c = 'd'; break; 574 case BuiltinType::LongDouble: 575 c = 'D'; break; 576 case BuiltinType::NullPtr: 577 c = 'n'; break; 578 case BuiltinType::Overload: 579 case BuiltinType::BoundMember: 580 case BuiltinType::Dependent: 581 case BuiltinType::UnknownAny: 582 IgnoreResults = true; 583 return; 584 case BuiltinType::ObjCId: 585 c = 'o'; break; 586 case BuiltinType::ObjCClass: 587 c = 'O'; break; 588 case BuiltinType::ObjCSel: 589 c = 'e'; break; 590 } 591 Out << c; 592 return; 593 } 594 595 // If we have already seen this (non-built-in) type, use a substitution 596 // encoding. 597 llvm::DenseMap<const Type *, unsigned>::iterator Substitution 598 = TypeSubstitutions.find(T.getTypePtr()); 599 if (Substitution != TypeSubstitutions.end()) { 600 Out << 'S' << Substitution->second << '_'; 601 return; 602 } else { 603 // Record this as a substitution. 604 unsigned Number = TypeSubstitutions.size(); 605 TypeSubstitutions[T.getTypePtr()] = Number; 606 } 607 608 if (const PointerType *PT = T->getAs<PointerType>()) { 609 Out << '*'; 610 T = PT->getPointeeType(); 611 continue; 612 } 613 if (const ReferenceType *RT = T->getAs<ReferenceType>()) { 614 Out << '&'; 615 T = RT->getPointeeType(); 616 continue; 617 } 618 if (const FunctionProtoType *FT = T->getAs<FunctionProtoType>()) { 619 Out << 'F'; 620 VisitType(FT->getResultType()); 621 for (FunctionProtoType::arg_type_iterator 622 I = FT->arg_type_begin(), E = FT->arg_type_end(); I!=E; ++I) { 623 VisitType(*I); 624 } 625 if (FT->isVariadic()) 626 Out << '.'; 627 return; 628 } 629 if (const BlockPointerType *BT = T->getAs<BlockPointerType>()) { 630 Out << 'B'; 631 T = BT->getPointeeType(); 632 continue; 633 } 634 if (const ComplexType *CT = T->getAs<ComplexType>()) { 635 Out << '<'; 636 T = CT->getElementType(); 637 continue; 638 } 639 if (const TagType *TT = T->getAs<TagType>()) { 640 Out << '$'; 641 VisitTagDecl(TT->getDecl()); 642 return; 643 } 644 if (const TemplateTypeParmType *TTP = T->getAs<TemplateTypeParmType>()) { 645 Out << 't' << TTP->getDepth() << '.' << TTP->getIndex(); 646 return; 647 } 648 if (const TemplateSpecializationType *Spec 649 = T->getAs<TemplateSpecializationType>()) { 650 Out << '>'; 651 VisitTemplateName(Spec->getTemplateName()); 652 Out << Spec->getNumArgs(); 653 for (unsigned I = 0, N = Spec->getNumArgs(); I != N; ++I) 654 VisitTemplateArgument(Spec->getArg(I)); 655 return; 656 } 657 658 // Unhandled type. 659 Out << ' '; 660 break; 661 } while (true); 662} 663 664void USRGenerator::VisitTemplateParameterList( 665 const TemplateParameterList *Params) { 666 if (!Params) 667 return; 668 Out << '>' << Params->size(); 669 for (TemplateParameterList::const_iterator P = Params->begin(), 670 PEnd = Params->end(); 671 P != PEnd; ++P) { 672 Out << '#'; 673 if (isa<TemplateTypeParmDecl>(*P)) { 674 if (cast<TemplateTypeParmDecl>(*P)->isParameterPack()) 675 Out<< 'p'; 676 Out << 'T'; 677 continue; 678 } 679 680 if (NonTypeTemplateParmDecl *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) { 681 if (NTTP->isParameterPack()) 682 Out << 'p'; 683 Out << 'N'; 684 VisitType(NTTP->getType()); 685 continue; 686 } 687 688 TemplateTemplateParmDecl *TTP = cast<TemplateTemplateParmDecl>(*P); 689 if (TTP->isParameterPack()) 690 Out << 'p'; 691 Out << 't'; 692 VisitTemplateParameterList(TTP->getTemplateParameters()); 693 } 694} 695 696void USRGenerator::VisitTemplateName(TemplateName Name) { 697 if (TemplateDecl *Template = Name.getAsTemplateDecl()) { 698 if (TemplateTemplateParmDecl *TTP 699 = dyn_cast<TemplateTemplateParmDecl>(Template)) { 700 Out << 't' << TTP->getDepth() << '.' << TTP->getIndex(); 701 return; 702 } 703 704 Visit(Template); 705 return; 706 } 707 708 // FIXME: Visit dependent template names. 709} 710 711void USRGenerator::VisitTemplateArgument(const TemplateArgument &Arg) { 712 switch (Arg.getKind()) { 713 case TemplateArgument::Null: 714 break; 715 716 case TemplateArgument::Declaration: 717 if (Decl *D = Arg.getAsDecl()) 718 Visit(D); 719 break; 720 721 case TemplateArgument::TemplateExpansion: 722 Out << 'P'; // pack expansion of... 723 // Fall through 724 case TemplateArgument::Template: 725 VisitTemplateName(Arg.getAsTemplateOrTemplatePattern()); 726 break; 727 728 case TemplateArgument::Expression: 729 // FIXME: Visit expressions. 730 break; 731 732 case TemplateArgument::Pack: 733 Out << 'p' << Arg.pack_size(); 734 for (TemplateArgument::pack_iterator P = Arg.pack_begin(), PEnd = Arg.pack_end(); 735 P != PEnd; ++P) 736 VisitTemplateArgument(*P); 737 break; 738 739 case TemplateArgument::Type: 740 VisitType(Arg.getAsType()); 741 break; 742 743 case TemplateArgument::Integral: 744 Out << 'V'; 745 VisitType(Arg.getIntegralType()); 746 Out << *Arg.getAsIntegral(); 747 break; 748 } 749} 750 751//===----------------------------------------------------------------------===// 752// General purpose USR generation methods. 753//===----------------------------------------------------------------------===// 754 755void USRGenerator::GenObjCClass(llvm::StringRef cls) { 756 Out << "objc(cs)" << cls; 757} 758 759void USRGenerator::GenObjCCategory(llvm::StringRef cls, llvm::StringRef cat) { 760 Out << "objc(cy)" << cls << '@' << cat; 761} 762 763void USRGenerator::GenObjCIvar(llvm::StringRef ivar) { 764 Out << '@' << ivar; 765} 766 767void USRGenerator::GenObjCMethod(llvm::StringRef meth, bool isInstanceMethod) { 768 Out << (isInstanceMethod ? "(im)" : "(cm)") << meth; 769} 770 771void USRGenerator::GenObjCProperty(llvm::StringRef prop) { 772 Out << "(py)" << prop; 773} 774 775void USRGenerator::GenObjCProtocol(llvm::StringRef prot) { 776 Out << "objc(pl)" << prot; 777} 778 779//===----------------------------------------------------------------------===// 780// API hooks. 781//===----------------------------------------------------------------------===// 782 783static inline llvm::StringRef extractUSRSuffix(llvm::StringRef s) { 784 return s.startswith("c:") ? s.substr(2) : ""; 785} 786 787static CXString getDeclCursorUSR(const CXCursor &C) { 788 Decl *D = cxcursor::getCursorDecl(C); 789 790 // Don't generate USRs for things with invalid locations. 791 if (!D || D->getLocStart().isInvalid()) 792 return createCXString(""); 793 794 // Check if the cursor has 'NoLinkage'. 795 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) 796 switch (ND->getLinkage()) { 797 case ExternalLinkage: 798 // Generate USRs for all entities with external linkage. 799 break; 800 case NoLinkage: 801 case UniqueExternalLinkage: 802 // We allow enums, typedefs, and structs that have no linkage to 803 // have USRs that are anchored to the file they were defined in 804 // (e.g., the header). This is a little gross, but in principal 805 // enums/anonymous structs/etc. defined in a common header file 806 // are referred to across multiple translation units. 807 if (isa<TagDecl>(ND) || isa<TypedefDecl>(ND) || 808 isa<EnumConstantDecl>(ND) || isa<FieldDecl>(ND) || 809 isa<VarDecl>(ND) || isa<NamespaceDecl>(ND)) 810 break; 811 // Fall-through. 812 case InternalLinkage: 813 if (isa<FunctionDecl>(ND)) 814 break; 815 } 816 817 CXTranslationUnit TU = cxcursor::getCursorTU(C); 818 if (!TU) 819 return createCXString(""); 820 821 CXStringBuf *buf = cxstring::getCXStringBuf(TU); 822 if (!buf) 823 return createCXString(""); 824 825 { 826 USRGenerator UG(&C, &buf->Data); 827 UG->Visit(D); 828 829 if (UG->ignoreResults()) { 830 disposeCXStringBuf(buf); 831 return createCXString(""); 832 } 833 } 834 // Return the C-string, but don't make a copy since it is already in 835 // the string buffer. 836 buf->Data.push_back('\0'); 837 return createCXString(buf); 838} 839 840extern "C" { 841 842CXString clang_getCursorUSR(CXCursor C) { 843 const CXCursorKind &K = clang_getCursorKind(C); 844 845 if (clang_isDeclaration(K)) 846 return getDeclCursorUSR(C); 847 848 if (K == CXCursor_MacroDefinition) { 849 CXTranslationUnit TU = cxcursor::getCursorTU(C); 850 if (!TU) 851 return createCXString(""); 852 853 CXStringBuf *buf = cxstring::getCXStringBuf(TU); 854 if (!buf) 855 return createCXString(""); 856 857 { 858 USRGenerator UG(&C, &buf->Data); 859 UG << "macro@" 860 << cxcursor::getCursorMacroDefinition(C)->getName()->getNameStart(); 861 } 862 buf->Data.push_back('\0'); 863 return createCXString(buf); 864 } 865 866 return createCXString(""); 867} 868 869CXString clang_constructUSR_ObjCIvar(const char *name, CXString classUSR) { 870 USRGenerator UG; 871 UG << extractUSRSuffix(clang_getCString(classUSR)); 872 UG->GenObjCIvar(name); 873 return createCXString(UG.str(), true); 874} 875 876CXString clang_constructUSR_ObjCMethod(const char *name, 877 unsigned isInstanceMethod, 878 CXString classUSR) { 879 USRGenerator UG; 880 UG << extractUSRSuffix(clang_getCString(classUSR)); 881 UG->GenObjCMethod(name, isInstanceMethod); 882 return createCXString(UG.str(), true); 883} 884 885CXString clang_constructUSR_ObjCClass(const char *name) { 886 USRGenerator UG; 887 UG->GenObjCClass(name); 888 return createCXString(UG.str(), true); 889} 890 891CXString clang_constructUSR_ObjCProtocol(const char *name) { 892 USRGenerator UG; 893 UG->GenObjCProtocol(name); 894 return createCXString(UG.str(), true); 895} 896 897CXString clang_constructUSR_ObjCCategory(const char *class_name, 898 const char *category_name) { 899 USRGenerator UG; 900 UG->GenObjCCategory(class_name, category_name); 901 return createCXString(UG.str(), true); 902} 903 904CXString clang_constructUSR_ObjCProperty(const char *property, 905 CXString classUSR) { 906 USRGenerator UG; 907 UG << extractUSRSuffix(clang_getCString(classUSR)); 908 UG->GenObjCProperty(property); 909 return createCXString(UG.str(), true); 910} 911 912} // end extern "C" 913