CIndex.cpp revision 93798e25d68e2d146cff9bd0355d4b7b1ca765f1
1//===- CIndex.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 main API hooks in the Clang-C Source Indexing 11// library. 12// 13//===----------------------------------------------------------------------===// 14 15#include "CIndexer.h" 16#include "CXCursor.h" 17#include "CXType.h" 18#include "CXSourceLocation.h" 19#include "CIndexDiagnostic.h" 20 21#include "clang/Basic/Version.h" 22 23#include "clang/AST/DeclVisitor.h" 24#include "clang/AST/StmtVisitor.h" 25#include "clang/AST/TypeLocVisitor.h" 26#include "clang/Basic/Diagnostic.h" 27#include "clang/Frontend/ASTUnit.h" 28#include "clang/Frontend/CompilerInstance.h" 29#include "clang/Frontend/FrontendDiagnostic.h" 30#include "clang/Lex/Lexer.h" 31#include "clang/Lex/PreprocessingRecord.h" 32#include "clang/Lex/Preprocessor.h" 33#include "llvm/ADT/STLExtras.h" 34#include "llvm/ADT/Optional.h" 35#include "clang/Analysis/Support/SaveAndRestore.h" 36#include "llvm/Support/CrashRecoveryContext.h" 37#include "llvm/Support/PrettyStackTrace.h" 38#include "llvm/Support/MemoryBuffer.h" 39#include "llvm/Support/raw_ostream.h" 40#include "llvm/Support/Timer.h" 41#include "llvm/System/Mutex.h" 42#include "llvm/System/Program.h" 43#include "llvm/System/Signals.h" 44#include "llvm/System/Threading.h" 45 46// Needed to define L_TMPNAM on some systems. 47#include <cstdio> 48 49using namespace clang; 50using namespace clang::cxcursor; 51using namespace clang::cxstring; 52 53/// \brief The result of comparing two source ranges. 54enum RangeComparisonResult { 55 /// \brief Either the ranges overlap or one of the ranges is invalid. 56 RangeOverlap, 57 58 /// \brief The first range ends before the second range starts. 59 RangeBefore, 60 61 /// \brief The first range starts after the second range ends. 62 RangeAfter 63}; 64 65/// \brief Compare two source ranges to determine their relative position in 66/// the translation unit. 67static RangeComparisonResult RangeCompare(SourceManager &SM, 68 SourceRange R1, 69 SourceRange R2) { 70 assert(R1.isValid() && "First range is invalid?"); 71 assert(R2.isValid() && "Second range is invalid?"); 72 if (R1.getEnd() != R2.getBegin() && 73 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin())) 74 return RangeBefore; 75 if (R2.getEnd() != R1.getBegin() && 76 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin())) 77 return RangeAfter; 78 return RangeOverlap; 79} 80 81/// \brief Determine if a source location falls within, before, or after a 82/// a given source range. 83static RangeComparisonResult LocationCompare(SourceManager &SM, 84 SourceLocation L, SourceRange R) { 85 assert(R.isValid() && "First range is invalid?"); 86 assert(L.isValid() && "Second range is invalid?"); 87 if (L == R.getBegin() || L == R.getEnd()) 88 return RangeOverlap; 89 if (SM.isBeforeInTranslationUnit(L, R.getBegin())) 90 return RangeBefore; 91 if (SM.isBeforeInTranslationUnit(R.getEnd(), L)) 92 return RangeAfter; 93 return RangeOverlap; 94} 95 96/// \brief Translate a Clang source range into a CIndex source range. 97/// 98/// Clang internally represents ranges where the end location points to the 99/// start of the token at the end. However, for external clients it is more 100/// useful to have a CXSourceRange be a proper half-open interval. This routine 101/// does the appropriate translation. 102CXSourceRange cxloc::translateSourceRange(const SourceManager &SM, 103 const LangOptions &LangOpts, 104 const CharSourceRange &R) { 105 // We want the last character in this location, so we will adjust the 106 // location accordingly. 107 // FIXME: How do do this with a macro instantiation location? 108 SourceLocation EndLoc = R.getEnd(); 109 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) { 110 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts); 111 EndLoc = EndLoc.getFileLocWithOffset(Length); 112 } 113 114 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts }, 115 R.getBegin().getRawEncoding(), 116 EndLoc.getRawEncoding() }; 117 return Result; 118} 119 120//===----------------------------------------------------------------------===// 121// Cursor visitor. 122//===----------------------------------------------------------------------===// 123 124namespace { 125 126// Cursor visitor. 127class CursorVisitor : public DeclVisitor<CursorVisitor, bool>, 128 public TypeLocVisitor<CursorVisitor, bool>, 129 public StmtVisitor<CursorVisitor, bool> 130{ 131 /// \brief The translation unit we are traversing. 132 ASTUnit *TU; 133 134 /// \brief The parent cursor whose children we are traversing. 135 CXCursor Parent; 136 137 /// \brief The declaration that serves at the parent of any statement or 138 /// expression nodes. 139 Decl *StmtParent; 140 141 /// \brief The visitor function. 142 CXCursorVisitor Visitor; 143 144 /// \brief The opaque client data, to be passed along to the visitor. 145 CXClientData ClientData; 146 147 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on 148 // to the visitor. Declarations with a PCH level greater than this value will 149 // be suppressed. 150 unsigned MaxPCHLevel; 151 152 /// \brief When valid, a source range to which the cursor should restrict 153 /// its search. 154 SourceRange RegionOfInterest; 155 156 // FIXME: Eventually remove. This part of a hack to support proper 157 // iteration over all Decls contained lexically within an ObjC container. 158 DeclContext::decl_iterator *DI_current; 159 DeclContext::decl_iterator DE_current; 160 161 using DeclVisitor<CursorVisitor, bool>::Visit; 162 using TypeLocVisitor<CursorVisitor, bool>::Visit; 163 using StmtVisitor<CursorVisitor, bool>::Visit; 164 165 /// \brief Determine whether this particular source range comes before, comes 166 /// after, or overlaps the region of interest. 167 /// 168 /// \param R a half-open source range retrieved from the abstract syntax tree. 169 RangeComparisonResult CompareRegionOfInterest(SourceRange R); 170 171 class SetParentRAII { 172 CXCursor &Parent; 173 Decl *&StmtParent; 174 CXCursor OldParent; 175 176 public: 177 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent) 178 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent) 179 { 180 Parent = NewParent; 181 if (clang_isDeclaration(Parent.kind)) 182 StmtParent = getCursorDecl(Parent); 183 } 184 185 ~SetParentRAII() { 186 Parent = OldParent; 187 if (clang_isDeclaration(Parent.kind)) 188 StmtParent = getCursorDecl(Parent); 189 } 190 }; 191 192public: 193 CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData, 194 unsigned MaxPCHLevel, 195 SourceRange RegionOfInterest = SourceRange()) 196 : TU(TU), Visitor(Visitor), ClientData(ClientData), 197 MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest), 198 DI_current(0) 199 { 200 Parent.kind = CXCursor_NoDeclFound; 201 Parent.data[0] = 0; 202 Parent.data[1] = 0; 203 Parent.data[2] = 0; 204 StmtParent = 0; 205 } 206 207 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false); 208 209 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator> 210 getPreprocessedEntities(); 211 212 bool VisitChildren(CXCursor Parent); 213 214 // Declaration visitors 215 bool VisitAttributes(Decl *D); 216 bool VisitBlockDecl(BlockDecl *B); 217 bool VisitCXXRecordDecl(CXXRecordDecl *D); 218 llvm::Optional<bool> shouldVisitCursor(CXCursor C); 219 bool VisitDeclContext(DeclContext *DC); 220 bool VisitTranslationUnitDecl(TranslationUnitDecl *D); 221 bool VisitTypedefDecl(TypedefDecl *D); 222 bool VisitTagDecl(TagDecl *D); 223 bool VisitClassTemplateSpecializationDecl(ClassTemplateSpecializationDecl *D); 224 bool VisitClassTemplatePartialSpecializationDecl( 225 ClassTemplatePartialSpecializationDecl *D); 226 bool VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D); 227 bool VisitEnumConstantDecl(EnumConstantDecl *D); 228 bool VisitDeclaratorDecl(DeclaratorDecl *DD); 229 bool VisitFunctionDecl(FunctionDecl *ND); 230 bool VisitFieldDecl(FieldDecl *D); 231 bool VisitVarDecl(VarDecl *); 232 bool VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D); 233 bool VisitFunctionTemplateDecl(FunctionTemplateDecl *D); 234 bool VisitClassTemplateDecl(ClassTemplateDecl *D); 235 bool VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D); 236 bool VisitObjCMethodDecl(ObjCMethodDecl *ND); 237 bool VisitObjCContainerDecl(ObjCContainerDecl *D); 238 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND); 239 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID); 240 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD); 241 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D); 242 bool VisitObjCImplDecl(ObjCImplDecl *D); 243 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D); 244 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D); 245 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations. 246 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D); 247 bool VisitObjCClassDecl(ObjCClassDecl *D); 248 bool VisitLinkageSpecDecl(LinkageSpecDecl *D); 249 bool VisitNamespaceDecl(NamespaceDecl *D); 250 bool VisitNamespaceAliasDecl(NamespaceAliasDecl *D); 251 bool VisitUsingDirectiveDecl(UsingDirectiveDecl *D); 252 bool VisitUsingDecl(UsingDecl *D); 253 bool VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D); 254 bool VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D); 255 256 // Name visitor 257 bool VisitDeclarationNameInfo(DeclarationNameInfo Name); 258 bool VisitNestedNameSpecifier(NestedNameSpecifier *NNS, SourceRange Range); 259 260 // Template visitors 261 bool VisitTemplateParameters(const TemplateParameterList *Params); 262 bool VisitTemplateName(TemplateName Name, SourceLocation Loc); 263 bool VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL); 264 265 // Type visitors 266 bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL); 267 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL); 268 bool VisitTypedefTypeLoc(TypedefTypeLoc TL); 269 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL); 270 bool VisitTagTypeLoc(TagTypeLoc TL); 271 bool VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL); 272 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL); 273 bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL); 274 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL); 275 bool VisitPointerTypeLoc(PointerTypeLoc TL); 276 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL); 277 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL); 278 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL); 279 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL); 280 bool VisitFunctionTypeLoc(FunctionTypeLoc TL, bool SkipResultType = false); 281 bool VisitArrayTypeLoc(ArrayTypeLoc TL); 282 bool VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc TL); 283 // FIXME: Implement visitors here when the unimplemented TypeLocs get 284 // implemented 285 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL); 286 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL); 287 288 // Statement visitors 289 bool VisitStmt(Stmt *S); 290 bool VisitDeclStmt(DeclStmt *S); 291 bool VisitGotoStmt(GotoStmt *S); 292 bool VisitIfStmt(IfStmt *S); 293 bool VisitSwitchStmt(SwitchStmt *S); 294 bool VisitCaseStmt(CaseStmt *S); 295 bool VisitWhileStmt(WhileStmt *S); 296 bool VisitForStmt(ForStmt *S); 297 298 // Expression visitors 299 bool VisitDeclRefExpr(DeclRefExpr *E); 300 bool VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E); 301 bool VisitBlockExpr(BlockExpr *B); 302 bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E); 303 bool VisitExplicitCastExpr(ExplicitCastExpr *E); 304 bool VisitObjCMessageExpr(ObjCMessageExpr *E); 305 bool VisitObjCEncodeExpr(ObjCEncodeExpr *E); 306 bool VisitOffsetOfExpr(OffsetOfExpr *E); 307 bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E); 308 bool VisitMemberExpr(MemberExpr *E); 309 bool VisitAddrLabelExpr(AddrLabelExpr *E); 310 bool VisitTypesCompatibleExpr(TypesCompatibleExpr *E); 311 bool VisitVAArgExpr(VAArgExpr *E); 312 bool VisitInitListExpr(InitListExpr *E); 313 bool VisitDesignatedInitExpr(DesignatedInitExpr *E); 314 bool VisitCXXTypeidExpr(CXXTypeidExpr *E); 315 bool VisitCXXUuidofExpr(CXXUuidofExpr *E); 316 bool VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { return false; } 317 bool VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E); 318 bool VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E); 319 bool VisitCXXNewExpr(CXXNewExpr *E); 320 bool VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E); 321 bool VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E); 322 bool VisitOverloadExpr(OverloadExpr *E); 323 bool VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E); 324 bool VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E); 325 bool VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E); 326 bool VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E); 327}; 328 329} // end anonymous namespace 330 331static SourceRange getRawCursorExtent(CXCursor C); 332 333RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) { 334 return RangeCompare(TU->getSourceManager(), R, RegionOfInterest); 335} 336 337/// \brief Visit the given cursor and, if requested by the visitor, 338/// its children. 339/// 340/// \param Cursor the cursor to visit. 341/// 342/// \param CheckRegionOfInterest if true, then the caller already checked that 343/// this cursor is within the region of interest. 344/// 345/// \returns true if the visitation should be aborted, false if it 346/// should continue. 347bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) { 348 if (clang_isInvalid(Cursor.kind)) 349 return false; 350 351 if (clang_isDeclaration(Cursor.kind)) { 352 Decl *D = getCursorDecl(Cursor); 353 assert(D && "Invalid declaration cursor"); 354 if (D->getPCHLevel() > MaxPCHLevel) 355 return false; 356 357 if (D->isImplicit()) 358 return false; 359 } 360 361 // If we have a range of interest, and this cursor doesn't intersect with it, 362 // we're done. 363 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) { 364 SourceRange Range = getRawCursorExtent(Cursor); 365 if (Range.isInvalid() || CompareRegionOfInterest(Range)) 366 return false; 367 } 368 369 switch (Visitor(Cursor, Parent, ClientData)) { 370 case CXChildVisit_Break: 371 return true; 372 373 case CXChildVisit_Continue: 374 return false; 375 376 case CXChildVisit_Recurse: 377 return VisitChildren(Cursor); 378 } 379 380 return false; 381} 382 383std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator> 384CursorVisitor::getPreprocessedEntities() { 385 PreprocessingRecord &PPRec 386 = *TU->getPreprocessor().getPreprocessingRecord(); 387 388 bool OnlyLocalDecls 389 = !TU->isMainFileAST() && TU->getOnlyLocalDecls(); 390 391 // There is no region of interest; we have to walk everything. 392 if (RegionOfInterest.isInvalid()) 393 return std::make_pair(PPRec.begin(OnlyLocalDecls), 394 PPRec.end(OnlyLocalDecls)); 395 396 // Find the file in which the region of interest lands. 397 SourceManager &SM = TU->getSourceManager(); 398 std::pair<FileID, unsigned> Begin 399 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin()); 400 std::pair<FileID, unsigned> End 401 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd()); 402 403 // The region of interest spans files; we have to walk everything. 404 if (Begin.first != End.first) 405 return std::make_pair(PPRec.begin(OnlyLocalDecls), 406 PPRec.end(OnlyLocalDecls)); 407 408 ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap 409 = TU->getPreprocessedEntitiesByFile(); 410 if (ByFileMap.empty()) { 411 // Build the mapping from files to sets of preprocessed entities. 412 for (PreprocessingRecord::iterator E = PPRec.begin(OnlyLocalDecls), 413 EEnd = PPRec.end(OnlyLocalDecls); 414 E != EEnd; ++E) { 415 std::pair<FileID, unsigned> P 416 = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin()); 417 ByFileMap[P.first].push_back(*E); 418 } 419 } 420 421 return std::make_pair(ByFileMap[Begin.first].begin(), 422 ByFileMap[Begin.first].end()); 423} 424 425/// \brief Visit the children of the given cursor. 426/// 427/// \returns true if the visitation should be aborted, false if it 428/// should continue. 429bool CursorVisitor::VisitChildren(CXCursor Cursor) { 430 if (clang_isReference(Cursor.kind)) { 431 // By definition, references have no children. 432 return false; 433 } 434 435 // Set the Parent field to Cursor, then back to its old value once we're 436 // done. 437 SetParentRAII SetParent(Parent, StmtParent, Cursor); 438 439 if (clang_isDeclaration(Cursor.kind)) { 440 Decl *D = getCursorDecl(Cursor); 441 assert(D && "Invalid declaration cursor"); 442 return VisitAttributes(D) || Visit(D); 443 } 444 445 if (clang_isStatement(Cursor.kind)) 446 return Visit(getCursorStmt(Cursor)); 447 if (clang_isExpression(Cursor.kind)) 448 return Visit(getCursorExpr(Cursor)); 449 450 if (clang_isTranslationUnit(Cursor.kind)) { 451 ASTUnit *CXXUnit = getCursorASTUnit(Cursor); 452 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() && 453 RegionOfInterest.isInvalid()) { 454 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(), 455 TLEnd = CXXUnit->top_level_end(); 456 TL != TLEnd; ++TL) { 457 if (Visit(MakeCXCursor(*TL, CXXUnit), true)) 458 return true; 459 } 460 } else if (VisitDeclContext( 461 CXXUnit->getASTContext().getTranslationUnitDecl())) 462 return true; 463 464 // Walk the preprocessing record. 465 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) { 466 // FIXME: Once we have the ability to deserialize a preprocessing record, 467 // do so. 468 PreprocessingRecord::iterator E, EEnd; 469 for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) { 470 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) { 471 if (Visit(MakeMacroInstantiationCursor(MI, CXXUnit))) 472 return true; 473 474 continue; 475 } 476 477 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) { 478 if (Visit(MakeMacroDefinitionCursor(MD, CXXUnit))) 479 return true; 480 481 continue; 482 } 483 484 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) { 485 if (Visit(MakeInclusionDirectiveCursor(ID, CXXUnit))) 486 return true; 487 488 continue; 489 } 490 } 491 } 492 return false; 493 } 494 495 // Nothing to visit at the moment. 496 return false; 497} 498 499bool CursorVisitor::VisitBlockDecl(BlockDecl *B) { 500 if (Visit(B->getSignatureAsWritten()->getTypeLoc())) 501 return true; 502 503 if (Stmt *Body = B->getBody()) 504 return Visit(MakeCXCursor(Body, StmtParent, TU)); 505 506 return false; 507} 508 509llvm::Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) { 510 if (RegionOfInterest.isValid()) { 511 SourceRange Range = getRawCursorExtent(Cursor); 512 if (Range.isInvalid()) 513 return llvm::Optional<bool>(); 514 515 switch (CompareRegionOfInterest(Range)) { 516 case RangeBefore: 517 // This declaration comes before the region of interest; skip it. 518 return llvm::Optional<bool>(); 519 520 case RangeAfter: 521 // This declaration comes after the region of interest; we're done. 522 return false; 523 524 case RangeOverlap: 525 // This declaration overlaps the region of interest; visit it. 526 break; 527 } 528 } 529 return true; 530} 531 532bool CursorVisitor::VisitDeclContext(DeclContext *DC) { 533 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end(); 534 535 // FIXME: Eventually remove. This part of a hack to support proper 536 // iteration over all Decls contained lexically within an ObjC container. 537 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I); 538 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E); 539 540 for ( ; I != E; ++I) { 541 Decl *D = *I; 542 if (D->getLexicalDeclContext() != DC) 543 continue; 544 CXCursor Cursor = MakeCXCursor(D, TU); 545 const llvm::Optional<bool> &V = shouldVisitCursor(Cursor); 546 if (!V.hasValue()) 547 continue; 548 if (!V.getValue()) 549 return false; 550 if (Visit(Cursor, true)) 551 return true; 552 } 553 return false; 554} 555 556bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) { 557 llvm_unreachable("Translation units are visited directly by Visit()"); 558 return false; 559} 560 561bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) { 562 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo()) 563 return Visit(TSInfo->getTypeLoc()); 564 565 return false; 566} 567 568bool CursorVisitor::VisitTagDecl(TagDecl *D) { 569 return VisitDeclContext(D); 570} 571 572bool CursorVisitor::VisitClassTemplateSpecializationDecl( 573 ClassTemplateSpecializationDecl *D) { 574 bool ShouldVisitBody = false; 575 switch (D->getSpecializationKind()) { 576 case TSK_Undeclared: 577 case TSK_ImplicitInstantiation: 578 // Nothing to visit 579 return false; 580 581 case TSK_ExplicitInstantiationDeclaration: 582 case TSK_ExplicitInstantiationDefinition: 583 break; 584 585 case TSK_ExplicitSpecialization: 586 ShouldVisitBody = true; 587 break; 588 } 589 590 // Visit the template arguments used in the specialization. 591 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) { 592 TypeLoc TL = SpecType->getTypeLoc(); 593 if (TemplateSpecializationTypeLoc *TSTLoc 594 = dyn_cast<TemplateSpecializationTypeLoc>(&TL)) { 595 for (unsigned I = 0, N = TSTLoc->getNumArgs(); I != N; ++I) 596 if (VisitTemplateArgumentLoc(TSTLoc->getArgLoc(I))) 597 return true; 598 } 599 } 600 601 if (ShouldVisitBody && VisitCXXRecordDecl(D)) 602 return true; 603 604 return false; 605} 606 607bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl( 608 ClassTemplatePartialSpecializationDecl *D) { 609 // FIXME: Visit the "outer" template parameter lists on the TagDecl 610 // before visiting these template parameters. 611 if (VisitTemplateParameters(D->getTemplateParameters())) 612 return true; 613 614 // Visit the partial specialization arguments. 615 const TemplateArgumentLoc *TemplateArgs = D->getTemplateArgsAsWritten(); 616 for (unsigned I = 0, N = D->getNumTemplateArgsAsWritten(); I != N; ++I) 617 if (VisitTemplateArgumentLoc(TemplateArgs[I])) 618 return true; 619 620 return VisitCXXRecordDecl(D); 621} 622 623bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) { 624 // Visit the default argument. 625 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited()) 626 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo()) 627 if (Visit(DefArg->getTypeLoc())) 628 return true; 629 630 return false; 631} 632 633bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) { 634 if (Expr *Init = D->getInitExpr()) 635 return Visit(MakeCXCursor(Init, StmtParent, TU)); 636 return false; 637} 638 639bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) { 640 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo()) 641 if (Visit(TSInfo->getTypeLoc())) 642 return true; 643 644 return false; 645} 646 647/// \brief Compare two base or member initializers based on their source order. 648static int CompareCXXBaseOrMemberInitializers(const void* Xp, const void *Yp) { 649 CXXBaseOrMemberInitializer const * const *X 650 = static_cast<CXXBaseOrMemberInitializer const * const *>(Xp); 651 CXXBaseOrMemberInitializer const * const *Y 652 = static_cast<CXXBaseOrMemberInitializer const * const *>(Yp); 653 654 if ((*X)->getSourceOrder() < (*Y)->getSourceOrder()) 655 return -1; 656 else if ((*X)->getSourceOrder() > (*Y)->getSourceOrder()) 657 return 1; 658 else 659 return 0; 660} 661 662bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) { 663 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) { 664 // Visit the function declaration's syntactic components in the order 665 // written. This requires a bit of work. 666 TypeLoc TL = TSInfo->getTypeLoc(); 667 FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL); 668 669 // If we have a function declared directly (without the use of a typedef), 670 // visit just the return type. Otherwise, just visit the function's type 671 // now. 672 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL->getResultLoc())) || 673 (!FTL && Visit(TL))) 674 return true; 675 676 // Visit the nested-name-specifier, if present. 677 if (NestedNameSpecifier *Qualifier = ND->getQualifier()) 678 if (VisitNestedNameSpecifier(Qualifier, ND->getQualifierRange())) 679 return true; 680 681 // Visit the declaration name. 682 if (VisitDeclarationNameInfo(ND->getNameInfo())) 683 return true; 684 685 // FIXME: Visit explicitly-specified template arguments! 686 687 // Visit the function parameters, if we have a function type. 688 if (FTL && VisitFunctionTypeLoc(*FTL, true)) 689 return true; 690 691 // FIXME: Attributes? 692 } 693 694 if (ND->isThisDeclarationADefinition()) { 695 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) { 696 // Find the initializers that were written in the source. 697 llvm::SmallVector<CXXBaseOrMemberInitializer *, 4> WrittenInits; 698 for (CXXConstructorDecl::init_iterator I = Constructor->init_begin(), 699 IEnd = Constructor->init_end(); 700 I != IEnd; ++I) { 701 if (!(*I)->isWritten()) 702 continue; 703 704 WrittenInits.push_back(*I); 705 } 706 707 // Sort the initializers in source order 708 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(), 709 &CompareCXXBaseOrMemberInitializers); 710 711 // Visit the initializers in source order 712 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) { 713 CXXBaseOrMemberInitializer *Init = WrittenInits[I]; 714 if (Init->isMemberInitializer()) { 715 if (Visit(MakeCursorMemberRef(Init->getMember(), 716 Init->getMemberLocation(), TU))) 717 return true; 718 } else if (TypeSourceInfo *BaseInfo = Init->getBaseClassInfo()) { 719 if (Visit(BaseInfo->getTypeLoc())) 720 return true; 721 } 722 723 // Visit the initializer value. 724 if (Expr *Initializer = Init->getInit()) 725 if (Visit(MakeCXCursor(Initializer, ND, TU))) 726 return true; 727 } 728 } 729 730 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU))) 731 return true; 732 } 733 734 return false; 735} 736 737bool CursorVisitor::VisitFieldDecl(FieldDecl *D) { 738 if (VisitDeclaratorDecl(D)) 739 return true; 740 741 if (Expr *BitWidth = D->getBitWidth()) 742 return Visit(MakeCXCursor(BitWidth, StmtParent, TU)); 743 744 return false; 745} 746 747bool CursorVisitor::VisitVarDecl(VarDecl *D) { 748 if (VisitDeclaratorDecl(D)) 749 return true; 750 751 if (Expr *Init = D->getInit()) 752 return Visit(MakeCXCursor(Init, StmtParent, TU)); 753 754 return false; 755} 756 757bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) { 758 if (VisitDeclaratorDecl(D)) 759 return true; 760 761 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited()) 762 if (Expr *DefArg = D->getDefaultArgument()) 763 return Visit(MakeCXCursor(DefArg, StmtParent, TU)); 764 765 return false; 766} 767 768bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) { 769 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl 770 // before visiting these template parameters. 771 if (VisitTemplateParameters(D->getTemplateParameters())) 772 return true; 773 774 return VisitFunctionDecl(D->getTemplatedDecl()); 775} 776 777bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) { 778 // FIXME: Visit the "outer" template parameter lists on the TagDecl 779 // before visiting these template parameters. 780 if (VisitTemplateParameters(D->getTemplateParameters())) 781 return true; 782 783 return VisitCXXRecordDecl(D->getTemplatedDecl()); 784} 785 786bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) { 787 if (VisitTemplateParameters(D->getTemplateParameters())) 788 return true; 789 790 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() && 791 VisitTemplateArgumentLoc(D->getDefaultArgument())) 792 return true; 793 794 return false; 795} 796 797bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) { 798 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo()) 799 if (Visit(TSInfo->getTypeLoc())) 800 return true; 801 802 for (ObjCMethodDecl::param_iterator P = ND->param_begin(), 803 PEnd = ND->param_end(); 804 P != PEnd; ++P) { 805 if (Visit(MakeCXCursor(*P, TU))) 806 return true; 807 } 808 809 if (ND->isThisDeclarationADefinition() && 810 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU))) 811 return true; 812 813 return false; 814} 815 816namespace { 817 struct ContainerDeclsSort { 818 SourceManager &SM; 819 ContainerDeclsSort(SourceManager &sm) : SM(sm) {} 820 bool operator()(Decl *A, Decl *B) { 821 SourceLocation L_A = A->getLocStart(); 822 SourceLocation L_B = B->getLocStart(); 823 assert(L_A.isValid() && L_B.isValid()); 824 return SM.isBeforeInTranslationUnit(L_A, L_B); 825 } 826 }; 827} 828 829bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) { 830 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially 831 // an @implementation can lexically contain Decls that are not properly 832 // nested in the AST. When we identify such cases, we need to retrofit 833 // this nesting here. 834 if (!DI_current) 835 return VisitDeclContext(D); 836 837 // Scan the Decls that immediately come after the container 838 // in the current DeclContext. If any fall within the 839 // container's lexical region, stash them into a vector 840 // for later processing. 841 llvm::SmallVector<Decl *, 24> DeclsInContainer; 842 SourceLocation EndLoc = D->getSourceRange().getEnd(); 843 SourceManager &SM = TU->getSourceManager(); 844 if (EndLoc.isValid()) { 845 DeclContext::decl_iterator next = *DI_current; 846 while (++next != DE_current) { 847 Decl *D_next = *next; 848 if (!D_next) 849 break; 850 SourceLocation L = D_next->getLocStart(); 851 if (!L.isValid()) 852 break; 853 if (SM.isBeforeInTranslationUnit(L, EndLoc)) { 854 *DI_current = next; 855 DeclsInContainer.push_back(D_next); 856 continue; 857 } 858 break; 859 } 860 } 861 862 // The common case. 863 if (DeclsInContainer.empty()) 864 return VisitDeclContext(D); 865 866 // Get all the Decls in the DeclContext, and sort them with the 867 // additional ones we've collected. Then visit them. 868 for (DeclContext::decl_iterator I = D->decls_begin(), E = D->decls_end(); 869 I!=E; ++I) { 870 Decl *subDecl = *I; 871 if (!subDecl || subDecl->getLexicalDeclContext() != D || 872 subDecl->getLocStart().isInvalid()) 873 continue; 874 DeclsInContainer.push_back(subDecl); 875 } 876 877 // Now sort the Decls so that they appear in lexical order. 878 std::sort(DeclsInContainer.begin(), DeclsInContainer.end(), 879 ContainerDeclsSort(SM)); 880 881 // Now visit the decls. 882 for (llvm::SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(), 883 E = DeclsInContainer.end(); I != E; ++I) { 884 CXCursor Cursor = MakeCXCursor(*I, TU); 885 const llvm::Optional<bool> &V = shouldVisitCursor(Cursor); 886 if (!V.hasValue()) 887 continue; 888 if (!V.getValue()) 889 return false; 890 if (Visit(Cursor, true)) 891 return true; 892 } 893 return false; 894} 895 896bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) { 897 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(), 898 TU))) 899 return true; 900 901 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin(); 902 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(), 903 E = ND->protocol_end(); I != E; ++I, ++PL) 904 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 905 return true; 906 907 return VisitObjCContainerDecl(ND); 908} 909 910bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) { 911 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin(); 912 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(), 913 E = PID->protocol_end(); I != E; ++I, ++PL) 914 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 915 return true; 916 917 return VisitObjCContainerDecl(PID); 918} 919 920bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) { 921 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc())) 922 return true; 923 924 // FIXME: This implements a workaround with @property declarations also being 925 // installed in the DeclContext for the @interface. Eventually this code 926 // should be removed. 927 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext()); 928 if (!CDecl || !CDecl->IsClassExtension()) 929 return false; 930 931 ObjCInterfaceDecl *ID = CDecl->getClassInterface(); 932 if (!ID) 933 return false; 934 935 IdentifierInfo *PropertyId = PD->getIdentifier(); 936 ObjCPropertyDecl *prevDecl = 937 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId); 938 939 if (!prevDecl) 940 return false; 941 942 // Visit synthesized methods since they will be skipped when visiting 943 // the @interface. 944 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl()) 945 if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl) 946 if (Visit(MakeCXCursor(MD, TU))) 947 return true; 948 949 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl()) 950 if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl) 951 if (Visit(MakeCXCursor(MD, TU))) 952 return true; 953 954 return false; 955} 956 957bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) { 958 // Issue callbacks for super class. 959 if (D->getSuperClass() && 960 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(), 961 D->getSuperClassLoc(), 962 TU))) 963 return true; 964 965 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin(); 966 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(), 967 E = D->protocol_end(); I != E; ++I, ++PL) 968 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 969 return true; 970 971 return VisitObjCContainerDecl(D); 972} 973 974bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) { 975 return VisitObjCContainerDecl(D); 976} 977 978bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) { 979 // 'ID' could be null when dealing with invalid code. 980 if (ObjCInterfaceDecl *ID = D->getClassInterface()) 981 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU))) 982 return true; 983 984 return VisitObjCImplDecl(D); 985} 986 987bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) { 988#if 0 989 // Issue callbacks for super class. 990 // FIXME: No source location information! 991 if (D->getSuperClass() && 992 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(), 993 D->getSuperClassLoc(), 994 TU))) 995 return true; 996#endif 997 998 return VisitObjCImplDecl(D); 999} 1000 1001bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) { 1002 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin(); 1003 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(), 1004 E = D->protocol_end(); 1005 I != E; ++I, ++PL) 1006 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 1007 return true; 1008 1009 return false; 1010} 1011 1012bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) { 1013 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C) 1014 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU))) 1015 return true; 1016 1017 return false; 1018} 1019 1020bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) { 1021 return VisitDeclContext(D); 1022} 1023 1024bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) { 1025 // Visit nested-name-specifier. 1026 if (NestedNameSpecifier *Qualifier = D->getQualifier()) 1027 if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange())) 1028 return true; 1029 1030 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(), 1031 D->getTargetNameLoc(), TU)); 1032} 1033 1034bool CursorVisitor::VisitUsingDecl(UsingDecl *D) { 1035 // Visit nested-name-specifier. 1036 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameDecl()) 1037 if (VisitNestedNameSpecifier(Qualifier, D->getNestedNameRange())) 1038 return true; 1039 1040 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU))) 1041 return true; 1042 1043 return VisitDeclarationNameInfo(D->getNameInfo()); 1044} 1045 1046bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) { 1047 // Visit nested-name-specifier. 1048 if (NestedNameSpecifier *Qualifier = D->getQualifier()) 1049 if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange())) 1050 return true; 1051 1052 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(), 1053 D->getIdentLocation(), TU)); 1054} 1055 1056bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) { 1057 // Visit nested-name-specifier. 1058 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier()) 1059 if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange())) 1060 return true; 1061 1062 return VisitDeclarationNameInfo(D->getNameInfo()); 1063} 1064 1065bool CursorVisitor::VisitUnresolvedUsingTypenameDecl( 1066 UnresolvedUsingTypenameDecl *D) { 1067 // Visit nested-name-specifier. 1068 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier()) 1069 if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange())) 1070 return true; 1071 1072 return false; 1073} 1074 1075bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) { 1076 switch (Name.getName().getNameKind()) { 1077 case clang::DeclarationName::Identifier: 1078 case clang::DeclarationName::CXXLiteralOperatorName: 1079 case clang::DeclarationName::CXXOperatorName: 1080 case clang::DeclarationName::CXXUsingDirective: 1081 return false; 1082 1083 case clang::DeclarationName::CXXConstructorName: 1084 case clang::DeclarationName::CXXDestructorName: 1085 case clang::DeclarationName::CXXConversionFunctionName: 1086 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo()) 1087 return Visit(TSInfo->getTypeLoc()); 1088 return false; 1089 1090 case clang::DeclarationName::ObjCZeroArgSelector: 1091 case clang::DeclarationName::ObjCOneArgSelector: 1092 case clang::DeclarationName::ObjCMultiArgSelector: 1093 // FIXME: Per-identifier location info? 1094 return false; 1095 } 1096 1097 return false; 1098} 1099 1100bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS, 1101 SourceRange Range) { 1102 // FIXME: This whole routine is a hack to work around the lack of proper 1103 // source information in nested-name-specifiers (PR5791). Since we do have 1104 // a beginning source location, we can visit the first component of the 1105 // nested-name-specifier, if it's a single-token component. 1106 if (!NNS) 1107 return false; 1108 1109 // Get the first component in the nested-name-specifier. 1110 while (NestedNameSpecifier *Prefix = NNS->getPrefix()) 1111 NNS = Prefix; 1112 1113 switch (NNS->getKind()) { 1114 case NestedNameSpecifier::Namespace: 1115 // FIXME: The token at this source location might actually have been a 1116 // namespace alias, but we don't model that. Lame! 1117 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(), 1118 TU)); 1119 1120 case NestedNameSpecifier::TypeSpec: { 1121 // If the type has a form where we know that the beginning of the source 1122 // range matches up with a reference cursor. Visit the appropriate reference 1123 // cursor. 1124 Type *T = NNS->getAsType(); 1125 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T)) 1126 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU)); 1127 if (const TagType *Tag = dyn_cast<TagType>(T)) 1128 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU)); 1129 if (const TemplateSpecializationType *TST 1130 = dyn_cast<TemplateSpecializationType>(T)) 1131 return VisitTemplateName(TST->getTemplateName(), Range.getBegin()); 1132 break; 1133 } 1134 1135 case NestedNameSpecifier::TypeSpecWithTemplate: 1136 case NestedNameSpecifier::Global: 1137 case NestedNameSpecifier::Identifier: 1138 break; 1139 } 1140 1141 return false; 1142} 1143 1144bool CursorVisitor::VisitTemplateParameters( 1145 const TemplateParameterList *Params) { 1146 if (!Params) 1147 return false; 1148 1149 for (TemplateParameterList::const_iterator P = Params->begin(), 1150 PEnd = Params->end(); 1151 P != PEnd; ++P) { 1152 if (Visit(MakeCXCursor(*P, TU))) 1153 return true; 1154 } 1155 1156 return false; 1157} 1158 1159bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) { 1160 switch (Name.getKind()) { 1161 case TemplateName::Template: 1162 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU)); 1163 1164 case TemplateName::OverloadedTemplate: 1165 // Visit the overloaded template set. 1166 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU))) 1167 return true; 1168 1169 return false; 1170 1171 case TemplateName::DependentTemplate: 1172 // FIXME: Visit nested-name-specifier. 1173 return false; 1174 1175 case TemplateName::QualifiedTemplate: 1176 // FIXME: Visit nested-name-specifier. 1177 return Visit(MakeCursorTemplateRef( 1178 Name.getAsQualifiedTemplateName()->getDecl(), 1179 Loc, TU)); 1180 } 1181 1182 return false; 1183} 1184 1185bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) { 1186 switch (TAL.getArgument().getKind()) { 1187 case TemplateArgument::Null: 1188 case TemplateArgument::Integral: 1189 return false; 1190 1191 case TemplateArgument::Pack: 1192 // FIXME: Implement when variadic templates come along. 1193 return false; 1194 1195 case TemplateArgument::Type: 1196 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo()) 1197 return Visit(TSInfo->getTypeLoc()); 1198 return false; 1199 1200 case TemplateArgument::Declaration: 1201 if (Expr *E = TAL.getSourceDeclExpression()) 1202 return Visit(MakeCXCursor(E, StmtParent, TU)); 1203 return false; 1204 1205 case TemplateArgument::Expression: 1206 if (Expr *E = TAL.getSourceExpression()) 1207 return Visit(MakeCXCursor(E, StmtParent, TU)); 1208 return false; 1209 1210 case TemplateArgument::Template: 1211 return VisitTemplateName(TAL.getArgument().getAsTemplate(), 1212 TAL.getTemplateNameLoc()); 1213 } 1214 1215 return false; 1216} 1217 1218bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) { 1219 return VisitDeclContext(D); 1220} 1221 1222bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) { 1223 return Visit(TL.getUnqualifiedLoc()); 1224} 1225 1226bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) { 1227 ASTContext &Context = TU->getASTContext(); 1228 1229 // Some builtin types (such as Objective-C's "id", "sel", and 1230 // "Class") have associated declarations. Create cursors for those. 1231 QualType VisitType; 1232 switch (TL.getType()->getAs<BuiltinType>()->getKind()) { 1233 case BuiltinType::Void: 1234 case BuiltinType::Bool: 1235 case BuiltinType::Char_U: 1236 case BuiltinType::UChar: 1237 case BuiltinType::Char16: 1238 case BuiltinType::Char32: 1239 case BuiltinType::UShort: 1240 case BuiltinType::UInt: 1241 case BuiltinType::ULong: 1242 case BuiltinType::ULongLong: 1243 case BuiltinType::UInt128: 1244 case BuiltinType::Char_S: 1245 case BuiltinType::SChar: 1246 case BuiltinType::WChar: 1247 case BuiltinType::Short: 1248 case BuiltinType::Int: 1249 case BuiltinType::Long: 1250 case BuiltinType::LongLong: 1251 case BuiltinType::Int128: 1252 case BuiltinType::Float: 1253 case BuiltinType::Double: 1254 case BuiltinType::LongDouble: 1255 case BuiltinType::NullPtr: 1256 case BuiltinType::Overload: 1257 case BuiltinType::Dependent: 1258 break; 1259 1260 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor? 1261 break; 1262 1263 case BuiltinType::ObjCId: 1264 VisitType = Context.getObjCIdType(); 1265 break; 1266 1267 case BuiltinType::ObjCClass: 1268 VisitType = Context.getObjCClassType(); 1269 break; 1270 1271 case BuiltinType::ObjCSel: 1272 VisitType = Context.getObjCSelType(); 1273 break; 1274 } 1275 1276 if (!VisitType.isNull()) { 1277 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>()) 1278 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(), 1279 TU)); 1280 } 1281 1282 return false; 1283} 1284 1285bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) { 1286 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU)); 1287} 1288 1289bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) { 1290 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU)); 1291} 1292 1293bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) { 1294 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU)); 1295} 1296 1297bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) { 1298 // FIXME: We can't visit the template type parameter, because there's 1299 // no context information with which we can match up the depth/index in the 1300 // type to the appropriate 1301 return false; 1302} 1303 1304bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) { 1305 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU))) 1306 return true; 1307 1308 return false; 1309} 1310 1311bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) { 1312 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc())) 1313 return true; 1314 1315 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) { 1316 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I), 1317 TU))) 1318 return true; 1319 } 1320 1321 return false; 1322} 1323 1324bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) { 1325 return Visit(TL.getPointeeLoc()); 1326} 1327 1328bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) { 1329 return Visit(TL.getPointeeLoc()); 1330} 1331 1332bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) { 1333 return Visit(TL.getPointeeLoc()); 1334} 1335 1336bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) { 1337 return Visit(TL.getPointeeLoc()); 1338} 1339 1340bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) { 1341 return Visit(TL.getPointeeLoc()); 1342} 1343 1344bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) { 1345 return Visit(TL.getPointeeLoc()); 1346} 1347 1348bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL, 1349 bool SkipResultType) { 1350 if (!SkipResultType && Visit(TL.getResultLoc())) 1351 return true; 1352 1353 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I) 1354 if (Decl *D = TL.getArg(I)) 1355 if (Visit(MakeCXCursor(D, TU))) 1356 return true; 1357 1358 return false; 1359} 1360 1361bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) { 1362 if (Visit(TL.getElementLoc())) 1363 return true; 1364 1365 if (Expr *Size = TL.getSizeExpr()) 1366 return Visit(MakeCXCursor(Size, StmtParent, TU)); 1367 1368 return false; 1369} 1370 1371bool CursorVisitor::VisitTemplateSpecializationTypeLoc( 1372 TemplateSpecializationTypeLoc TL) { 1373 // Visit the template name. 1374 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(), 1375 TL.getTemplateNameLoc())) 1376 return true; 1377 1378 // Visit the template arguments. 1379 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I) 1380 if (VisitTemplateArgumentLoc(TL.getArgLoc(I))) 1381 return true; 1382 1383 return false; 1384} 1385 1386bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) { 1387 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU)); 1388} 1389 1390bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) { 1391 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo()) 1392 return Visit(TSInfo->getTypeLoc()); 1393 1394 return false; 1395} 1396 1397bool CursorVisitor::VisitStmt(Stmt *S) { 1398 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end(); 1399 Child != ChildEnd; ++Child) { 1400 if (Stmt *C = *Child) 1401 if (Visit(MakeCXCursor(C, StmtParent, TU))) 1402 return true; 1403 } 1404 1405 return false; 1406} 1407 1408bool CursorVisitor::VisitCaseStmt(CaseStmt *S) { 1409 // Specially handle CaseStmts because they can be nested, e.g.: 1410 // 1411 // case 1: 1412 // case 2: 1413 // 1414 // In this case the second CaseStmt is the child of the first. Walking 1415 // these recursively can blow out the stack. 1416 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU); 1417 while (true) { 1418 // Set the Parent field to Cursor, then back to its old value once we're 1419 // done. 1420 SetParentRAII SetParent(Parent, StmtParent, Cursor); 1421 1422 if (Stmt *LHS = S->getLHS()) 1423 if (Visit(MakeCXCursor(LHS, StmtParent, TU))) 1424 return true; 1425 if (Stmt *RHS = S->getRHS()) 1426 if (Visit(MakeCXCursor(RHS, StmtParent, TU))) 1427 return true; 1428 if (Stmt *SubStmt = S->getSubStmt()) { 1429 if (!isa<CaseStmt>(SubStmt)) 1430 return Visit(MakeCXCursor(SubStmt, StmtParent, TU)); 1431 1432 // Specially handle 'CaseStmt' so that we don't blow out the stack. 1433 CaseStmt *CS = cast<CaseStmt>(SubStmt); 1434 Cursor = MakeCXCursor(CS, StmtParent, TU); 1435 if (RegionOfInterest.isValid()) { 1436 SourceRange Range = CS->getSourceRange(); 1437 if (Range.isInvalid() || CompareRegionOfInterest(Range)) 1438 return false; 1439 } 1440 1441 switch (Visitor(Cursor, Parent, ClientData)) { 1442 case CXChildVisit_Break: return true; 1443 case CXChildVisit_Continue: return false; 1444 case CXChildVisit_Recurse: 1445 // Perform tail-recursion manually. 1446 S = CS; 1447 continue; 1448 } 1449 } 1450 return false; 1451 } 1452} 1453 1454bool CursorVisitor::VisitDeclStmt(DeclStmt *S) { 1455 bool isFirst = true; 1456 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end(); 1457 D != DEnd; ++D) { 1458 if (*D && Visit(MakeCXCursor(*D, TU, isFirst))) 1459 return true; 1460 isFirst = false; 1461 } 1462 1463 return false; 1464} 1465 1466bool CursorVisitor::VisitGotoStmt(GotoStmt *S) { 1467 return Visit(MakeCursorLabelRef(S->getLabel(), S->getLabelLoc(), TU)); 1468} 1469 1470bool CursorVisitor::VisitIfStmt(IfStmt *S) { 1471 if (VarDecl *Var = S->getConditionVariable()) { 1472 if (Visit(MakeCXCursor(Var, TU))) 1473 return true; 1474 } 1475 1476 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1477 return true; 1478 if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU))) 1479 return true; 1480 if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU))) 1481 return true; 1482 1483 return false; 1484} 1485 1486bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) { 1487 if (VarDecl *Var = S->getConditionVariable()) { 1488 if (Visit(MakeCXCursor(Var, TU))) 1489 return true; 1490 } 1491 1492 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1493 return true; 1494 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1495 return true; 1496 1497 return false; 1498} 1499 1500bool CursorVisitor::VisitWhileStmt(WhileStmt *S) { 1501 if (VarDecl *Var = S->getConditionVariable()) { 1502 if (Visit(MakeCXCursor(Var, TU))) 1503 return true; 1504 } 1505 1506 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1507 return true; 1508 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1509 return true; 1510 1511 return false; 1512} 1513 1514bool CursorVisitor::VisitForStmt(ForStmt *S) { 1515 if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU))) 1516 return true; 1517 if (VarDecl *Var = S->getConditionVariable()) { 1518 if (Visit(MakeCXCursor(Var, TU))) 1519 return true; 1520 } 1521 1522 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1523 return true; 1524 if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU))) 1525 return true; 1526 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1527 return true; 1528 1529 return false; 1530} 1531 1532bool CursorVisitor::VisitDeclRefExpr(DeclRefExpr *E) { 1533 // Visit nested-name-specifier, if present. 1534 if (NestedNameSpecifier *Qualifier = E->getQualifier()) 1535 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange())) 1536 return true; 1537 1538 // Visit declaration name. 1539 if (VisitDeclarationNameInfo(E->getNameInfo())) 1540 return true; 1541 1542 // Visit explicitly-specified template arguments. 1543 if (E->hasExplicitTemplateArgs()) { 1544 ExplicitTemplateArgumentList &Args = E->getExplicitTemplateArgs(); 1545 for (TemplateArgumentLoc *Arg = Args.getTemplateArgs(), 1546 *ArgEnd = Arg + Args.NumTemplateArgs; 1547 Arg != ArgEnd; ++Arg) 1548 if (VisitTemplateArgumentLoc(*Arg)) 1549 return true; 1550 } 1551 1552 return false; 1553} 1554 1555bool CursorVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E) { 1556 if (Visit(MakeCXCursor(E->getArg(0), StmtParent, TU))) 1557 return true; 1558 1559 if (Visit(MakeCXCursor(E->getCallee(), StmtParent, TU))) 1560 return true; 1561 1562 for (unsigned I = 1, N = E->getNumArgs(); I != N; ++I) 1563 if (Visit(MakeCXCursor(E->getArg(I), StmtParent, TU))) 1564 return true; 1565 1566 return false; 1567} 1568 1569bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) { 1570 if (D->isDefinition()) { 1571 for (CXXRecordDecl::base_class_iterator I = D->bases_begin(), 1572 E = D->bases_end(); I != E; ++I) { 1573 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU))) 1574 return true; 1575 } 1576 } 1577 1578 return VisitTagDecl(D); 1579} 1580 1581 1582bool CursorVisitor::VisitBlockExpr(BlockExpr *B) { 1583 return Visit(B->getBlockDecl()); 1584} 1585 1586bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) { 1587 // Visit the type into which we're computing an offset. 1588 if (Visit(E->getTypeSourceInfo()->getTypeLoc())) 1589 return true; 1590 1591 // Visit the components of the offsetof expression. 1592 for (unsigned I = 0, N = E->getNumComponents(); I != N; ++I) { 1593 typedef OffsetOfExpr::OffsetOfNode OffsetOfNode; 1594 const OffsetOfNode &Node = E->getComponent(I); 1595 switch (Node.getKind()) { 1596 case OffsetOfNode::Array: 1597 if (Visit(MakeCXCursor(E->getIndexExpr(Node.getArrayExprIndex()), 1598 StmtParent, TU))) 1599 return true; 1600 break; 1601 1602 case OffsetOfNode::Field: 1603 if (Visit(MakeCursorMemberRef(Node.getField(), Node.getRange().getEnd(), 1604 TU))) 1605 return true; 1606 break; 1607 1608 case OffsetOfNode::Identifier: 1609 case OffsetOfNode::Base: 1610 continue; 1611 } 1612 } 1613 1614 return false; 1615} 1616 1617bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) { 1618 if (E->isArgumentType()) { 1619 if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo()) 1620 return Visit(TSInfo->getTypeLoc()); 1621 1622 return false; 1623 } 1624 1625 return VisitExpr(E); 1626} 1627 1628bool CursorVisitor::VisitMemberExpr(MemberExpr *E) { 1629 // Visit the base expression. 1630 if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU))) 1631 return true; 1632 1633 // Visit the nested-name-specifier 1634 if (NestedNameSpecifier *Qualifier = E->getQualifier()) 1635 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange())) 1636 return true; 1637 1638 // Visit the declaration name. 1639 if (VisitDeclarationNameInfo(E->getMemberNameInfo())) 1640 return true; 1641 1642 // Visit the explicitly-specified template arguments, if any. 1643 if (E->hasExplicitTemplateArgs()) { 1644 for (const TemplateArgumentLoc *Arg = E->getTemplateArgs(), 1645 *ArgEnd = Arg + E->getNumTemplateArgs(); 1646 Arg != ArgEnd; 1647 ++Arg) { 1648 if (VisitTemplateArgumentLoc(*Arg)) 1649 return true; 1650 } 1651 } 1652 1653 return false; 1654} 1655 1656bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) { 1657 if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten()) 1658 if (Visit(TSInfo->getTypeLoc())) 1659 return true; 1660 1661 return VisitCastExpr(E); 1662} 1663 1664bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) { 1665 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo()) 1666 if (Visit(TSInfo->getTypeLoc())) 1667 return true; 1668 1669 return VisitExpr(E); 1670} 1671 1672bool CursorVisitor::VisitAddrLabelExpr(AddrLabelExpr *E) { 1673 return Visit(MakeCursorLabelRef(E->getLabel(), E->getLabelLoc(), TU)); 1674} 1675 1676bool CursorVisitor::VisitTypesCompatibleExpr(TypesCompatibleExpr *E) { 1677 return Visit(E->getArgTInfo1()->getTypeLoc()) || 1678 Visit(E->getArgTInfo2()->getTypeLoc()); 1679} 1680 1681bool CursorVisitor::VisitVAArgExpr(VAArgExpr *E) { 1682 if (Visit(E->getWrittenTypeInfo()->getTypeLoc())) 1683 return true; 1684 1685 return Visit(MakeCXCursor(E->getSubExpr(), StmtParent, TU)); 1686} 1687 1688bool CursorVisitor::VisitInitListExpr(InitListExpr *E) { 1689 // We care about the syntactic form of the initializer list, only. 1690 if (InitListExpr *Syntactic = E->getSyntacticForm()) 1691 return VisitExpr(Syntactic); 1692 1693 return VisitExpr(E); 1694} 1695 1696bool CursorVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) { 1697 // Visit the designators. 1698 typedef DesignatedInitExpr::Designator Designator; 1699 for (DesignatedInitExpr::designators_iterator D = E->designators_begin(), 1700 DEnd = E->designators_end(); 1701 D != DEnd; ++D) { 1702 if (D->isFieldDesignator()) { 1703 if (FieldDecl *Field = D->getField()) 1704 if (Visit(MakeCursorMemberRef(Field, D->getFieldLoc(), TU))) 1705 return true; 1706 1707 continue; 1708 } 1709 1710 if (D->isArrayDesignator()) { 1711 if (Visit(MakeCXCursor(E->getArrayIndex(*D), StmtParent, TU))) 1712 return true; 1713 1714 continue; 1715 } 1716 1717 assert(D->isArrayRangeDesignator() && "Unknown designator kind"); 1718 if (Visit(MakeCXCursor(E->getArrayRangeStart(*D), StmtParent, TU)) || 1719 Visit(MakeCXCursor(E->getArrayRangeEnd(*D), StmtParent, TU))) 1720 return true; 1721 } 1722 1723 // Visit the initializer value itself. 1724 return Visit(MakeCXCursor(E->getInit(), StmtParent, TU)); 1725} 1726 1727bool CursorVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) { 1728 if (E->isTypeOperand()) { 1729 if (TypeSourceInfo *TSInfo = E->getTypeOperandSourceInfo()) 1730 return Visit(TSInfo->getTypeLoc()); 1731 1732 return false; 1733 } 1734 1735 return VisitExpr(E); 1736} 1737 1738bool CursorVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) { 1739 if (E->isTypeOperand()) { 1740 if (TypeSourceInfo *TSInfo = E->getTypeOperandSourceInfo()) 1741 return Visit(TSInfo->getTypeLoc()); 1742 1743 return false; 1744 } 1745 1746 return VisitExpr(E); 1747} 1748 1749bool CursorVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) { 1750 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo()) 1751 if (Visit(TSInfo->getTypeLoc())) 1752 return true; 1753 1754 return VisitExpr(E); 1755} 1756 1757bool CursorVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) { 1758 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo()) 1759 return Visit(TSInfo->getTypeLoc()); 1760 1761 return false; 1762} 1763 1764bool CursorVisitor::VisitCXXNewExpr(CXXNewExpr *E) { 1765 // Visit placement arguments. 1766 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) 1767 if (Visit(MakeCXCursor(E->getPlacementArg(I), StmtParent, TU))) 1768 return true; 1769 1770 // Visit the allocated type. 1771 if (TypeSourceInfo *TSInfo = E->getAllocatedTypeSourceInfo()) 1772 if (Visit(TSInfo->getTypeLoc())) 1773 return true; 1774 1775 // Visit the array size, if any. 1776 if (E->isArray() && Visit(MakeCXCursor(E->getArraySize(), StmtParent, TU))) 1777 return true; 1778 1779 // Visit the initializer or constructor arguments. 1780 for (unsigned I = 0, N = E->getNumConstructorArgs(); I != N; ++I) 1781 if (Visit(MakeCXCursor(E->getConstructorArg(I), StmtParent, TU))) 1782 return true; 1783 1784 return false; 1785} 1786 1787bool CursorVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) { 1788 // Visit base expression. 1789 if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU))) 1790 return true; 1791 1792 // Visit the nested-name-specifier. 1793 if (NestedNameSpecifier *Qualifier = E->getQualifier()) 1794 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange())) 1795 return true; 1796 1797 // Visit the scope type that looks disturbingly like the nested-name-specifier 1798 // but isn't. 1799 if (TypeSourceInfo *TSInfo = E->getScopeTypeInfo()) 1800 if (Visit(TSInfo->getTypeLoc())) 1801 return true; 1802 1803 // Visit the name of the type being destroyed. 1804 if (TypeSourceInfo *TSInfo = E->getDestroyedTypeInfo()) 1805 if (Visit(TSInfo->getTypeLoc())) 1806 return true; 1807 1808 return false; 1809} 1810 1811bool CursorVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) { 1812 return Visit(E->getQueriedTypeSourceInfo()->getTypeLoc()); 1813} 1814 1815bool CursorVisitor::VisitOverloadExpr(OverloadExpr *E) { 1816 // Visit the nested-name-specifier. 1817 if (NestedNameSpecifier *Qualifier = E->getQualifier()) 1818 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange())) 1819 return true; 1820 1821 // Visit the declaration name. 1822 if (VisitDeclarationNameInfo(E->getNameInfo())) 1823 return true; 1824 1825 // Visit the overloaded declaration reference. 1826 if (Visit(MakeCursorOverloadedDeclRef(E, TU))) 1827 return true; 1828 1829 // Visit the explicitly-specified template arguments. 1830 if (const ExplicitTemplateArgumentList *ArgList 1831 = E->getOptionalExplicitTemplateArgs()) { 1832 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(), 1833 *ArgEnd = Arg + ArgList->NumTemplateArgs; 1834 Arg != ArgEnd; ++Arg) { 1835 if (VisitTemplateArgumentLoc(*Arg)) 1836 return true; 1837 } 1838 } 1839 1840 return false; 1841} 1842 1843bool CursorVisitor::VisitDependentScopeDeclRefExpr( 1844 DependentScopeDeclRefExpr *E) { 1845 // Visit the nested-name-specifier. 1846 if (NestedNameSpecifier *Qualifier = E->getQualifier()) 1847 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange())) 1848 return true; 1849 1850 // Visit the declaration name. 1851 if (VisitDeclarationNameInfo(E->getNameInfo())) 1852 return true; 1853 1854 // Visit the explicitly-specified template arguments. 1855 if (const ExplicitTemplateArgumentList *ArgList 1856 = E->getOptionalExplicitTemplateArgs()) { 1857 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(), 1858 *ArgEnd = Arg + ArgList->NumTemplateArgs; 1859 Arg != ArgEnd; ++Arg) { 1860 if (VisitTemplateArgumentLoc(*Arg)) 1861 return true; 1862 } 1863 } 1864 1865 return false; 1866} 1867 1868bool CursorVisitor::VisitCXXUnresolvedConstructExpr( 1869 CXXUnresolvedConstructExpr *E) { 1870 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo()) 1871 if (Visit(TSInfo->getTypeLoc())) 1872 return true; 1873 1874 return VisitExpr(E); 1875} 1876 1877bool CursorVisitor::VisitCXXDependentScopeMemberExpr( 1878 CXXDependentScopeMemberExpr *E) { 1879 // Visit the base expression, if there is one. 1880 if (!E->isImplicitAccess() && 1881 Visit(MakeCXCursor(E->getBase(), StmtParent, TU))) 1882 return true; 1883 1884 // Visit the nested-name-specifier. 1885 if (NestedNameSpecifier *Qualifier = E->getQualifier()) 1886 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange())) 1887 return true; 1888 1889 // Visit the declaration name. 1890 if (VisitDeclarationNameInfo(E->getMemberNameInfo())) 1891 return true; 1892 1893 // Visit the explicitly-specified template arguments. 1894 if (const ExplicitTemplateArgumentList *ArgList 1895 = E->getOptionalExplicitTemplateArgs()) { 1896 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(), 1897 *ArgEnd = Arg + ArgList->NumTemplateArgs; 1898 Arg != ArgEnd; ++Arg) { 1899 if (VisitTemplateArgumentLoc(*Arg)) 1900 return true; 1901 } 1902 } 1903 1904 return false; 1905} 1906 1907bool CursorVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E) { 1908 // Visit the base expression, if there is one. 1909 if (!E->isImplicitAccess() && 1910 Visit(MakeCXCursor(E->getBase(), StmtParent, TU))) 1911 return true; 1912 1913 return VisitOverloadExpr(E); 1914} 1915 1916bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) { 1917 if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo()) 1918 if (Visit(TSInfo->getTypeLoc())) 1919 return true; 1920 1921 return VisitExpr(E); 1922} 1923 1924bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) { 1925 return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc()); 1926} 1927 1928 1929bool CursorVisitor::VisitAttributes(Decl *D) { 1930 for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end(); 1931 i != e; ++i) 1932 if (Visit(MakeCXCursor(*i, D, TU))) 1933 return true; 1934 1935 return false; 1936} 1937 1938static llvm::sys::Mutex EnableMultithreadingMutex; 1939static bool EnabledMultithreading; 1940 1941extern "C" { 1942CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1943 int displayDiagnostics) { 1944 // Disable pretty stack trace functionality, which will otherwise be a very 1945 // poor citizen of the world and set up all sorts of signal handlers. 1946 llvm::DisablePrettyStackTrace = true; 1947 1948 // We use crash recovery to make some of our APIs more reliable, implicitly 1949 // enable it. 1950 llvm::CrashRecoveryContext::Enable(); 1951 1952 // Enable support for multithreading in LLVM. 1953 { 1954 llvm::sys::ScopedLock L(EnableMultithreadingMutex); 1955 if (!EnabledMultithreading) { 1956 llvm::llvm_start_multithreaded(); 1957 EnabledMultithreading = true; 1958 } 1959 } 1960 1961 CIndexer *CIdxr = new CIndexer(); 1962 if (excludeDeclarationsFromPCH) 1963 CIdxr->setOnlyLocalDecls(); 1964 if (displayDiagnostics) 1965 CIdxr->setDisplayDiagnostics(); 1966 return CIdxr; 1967} 1968 1969void clang_disposeIndex(CXIndex CIdx) { 1970 if (CIdx) 1971 delete static_cast<CIndexer *>(CIdx); 1972} 1973 1974CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx, 1975 const char *ast_filename) { 1976 if (!CIdx) 1977 return 0; 1978 1979 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1980 FileSystemOptions FileSystemOpts; 1981 FileSystemOpts.WorkingDir = CXXIdx->getWorkingDirectory(); 1982 1983 llvm::IntrusiveRefCntPtr<Diagnostic> Diags; 1984 return ASTUnit::LoadFromASTFile(ast_filename, Diags, FileSystemOpts, 1985 CXXIdx->getOnlyLocalDecls(), 1986 0, 0, true); 1987} 1988 1989unsigned clang_defaultEditingTranslationUnitOptions() { 1990 return CXTranslationUnit_PrecompiledPreamble | 1991 CXTranslationUnit_CacheCompletionResults | 1992 CXTranslationUnit_CXXPrecompiledPreamble; 1993} 1994 1995CXTranslationUnit 1996clang_createTranslationUnitFromSourceFile(CXIndex CIdx, 1997 const char *source_filename, 1998 int num_command_line_args, 1999 const char * const *command_line_args, 2000 unsigned num_unsaved_files, 2001 struct CXUnsavedFile *unsaved_files) { 2002 return clang_parseTranslationUnit(CIdx, source_filename, 2003 command_line_args, num_command_line_args, 2004 unsaved_files, num_unsaved_files, 2005 CXTranslationUnit_DetailedPreprocessingRecord); 2006} 2007 2008struct ParseTranslationUnitInfo { 2009 CXIndex CIdx; 2010 const char *source_filename; 2011 const char *const *command_line_args; 2012 int num_command_line_args; 2013 struct CXUnsavedFile *unsaved_files; 2014 unsigned num_unsaved_files; 2015 unsigned options; 2016 CXTranslationUnit result; 2017}; 2018static void clang_parseTranslationUnit_Impl(void *UserData) { 2019 ParseTranslationUnitInfo *PTUI = 2020 static_cast<ParseTranslationUnitInfo*>(UserData); 2021 CXIndex CIdx = PTUI->CIdx; 2022 const char *source_filename = PTUI->source_filename; 2023 const char * const *command_line_args = PTUI->command_line_args; 2024 int num_command_line_args = PTUI->num_command_line_args; 2025 struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files; 2026 unsigned num_unsaved_files = PTUI->num_unsaved_files; 2027 unsigned options = PTUI->options; 2028 PTUI->result = 0; 2029 2030 if (!CIdx) 2031 return; 2032 2033 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 2034 2035 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble; 2036 bool CompleteTranslationUnit 2037 = ((options & CXTranslationUnit_Incomplete) == 0); 2038 bool CacheCodeCompetionResults 2039 = options & CXTranslationUnit_CacheCompletionResults; 2040 bool CXXPrecompilePreamble 2041 = options & CXTranslationUnit_CXXPrecompiledPreamble; 2042 bool CXXChainedPCH 2043 = options & CXTranslationUnit_CXXChainedPCH; 2044 2045 // Configure the diagnostics. 2046 DiagnosticOptions DiagOpts; 2047 llvm::IntrusiveRefCntPtr<Diagnostic> Diags; 2048 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0); 2049 2050 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles; 2051 for (unsigned I = 0; I != num_unsaved_files; ++I) { 2052 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length); 2053 const llvm::MemoryBuffer *Buffer 2054 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename); 2055 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename, 2056 Buffer)); 2057 } 2058 2059 llvm::SmallVector<const char *, 16> Args; 2060 2061 // The 'source_filename' argument is optional. If the caller does not 2062 // specify it then it is assumed that the source file is specified 2063 // in the actual argument list. 2064 if (source_filename) 2065 Args.push_back(source_filename); 2066 2067 // Since the Clang C library is primarily used by batch tools dealing with 2068 // (often very broken) source code, where spell-checking can have a 2069 // significant negative impact on performance (particularly when 2070 // precompiled headers are involved), we disable it by default. 2071 // Only do this if we haven't found a spell-checking-related argument. 2072 bool FoundSpellCheckingArgument = false; 2073 for (int I = 0; I != num_command_line_args; ++I) { 2074 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 || 2075 strcmp(command_line_args[I], "-fspell-checking") == 0) { 2076 FoundSpellCheckingArgument = true; 2077 break; 2078 } 2079 } 2080 if (!FoundSpellCheckingArgument) 2081 Args.push_back("-fno-spell-checking"); 2082 2083 Args.insert(Args.end(), command_line_args, 2084 command_line_args + num_command_line_args); 2085 2086 // Do we need the detailed preprocessing record? 2087 if (options & CXTranslationUnit_DetailedPreprocessingRecord) { 2088 Args.push_back("-Xclang"); 2089 Args.push_back("-detailed-preprocessing-record"); 2090 } 2091 2092 unsigned NumErrors = Diags->getNumErrors(); 2093 llvm::OwningPtr<ASTUnit> Unit( 2094 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(), 2095 Diags, 2096 CXXIdx->getClangResourcesPath(), 2097 CXXIdx->getOnlyLocalDecls(), 2098 RemappedFiles.data(), 2099 RemappedFiles.size(), 2100 /*CaptureDiagnostics=*/true, 2101 PrecompilePreamble, 2102 CompleteTranslationUnit, 2103 CacheCodeCompetionResults, 2104 CXXPrecompilePreamble, 2105 CXXChainedPCH)); 2106 2107 if (NumErrors != Diags->getNumErrors()) { 2108 // Make sure to check that 'Unit' is non-NULL. 2109 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) { 2110 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(), 2111 DEnd = Unit->stored_diag_end(); 2112 D != DEnd; ++D) { 2113 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions()); 2114 CXString Msg = clang_formatDiagnostic(&Diag, 2115 clang_defaultDiagnosticDisplayOptions()); 2116 fprintf(stderr, "%s\n", clang_getCString(Msg)); 2117 clang_disposeString(Msg); 2118 } 2119#ifdef LLVM_ON_WIN32 2120 // On Windows, force a flush, since there may be multiple copies of 2121 // stderr and stdout in the file system, all with different buffers 2122 // but writing to the same device. 2123 fflush(stderr); 2124#endif 2125 } 2126 } 2127 2128 PTUI->result = Unit.take(); 2129} 2130CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx, 2131 const char *source_filename, 2132 const char * const *command_line_args, 2133 int num_command_line_args, 2134 struct CXUnsavedFile *unsaved_files, 2135 unsigned num_unsaved_files, 2136 unsigned options) { 2137 ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args, 2138 num_command_line_args, unsaved_files, 2139 num_unsaved_files, options, 0 }; 2140 llvm::CrashRecoveryContext CRC; 2141 2142 if (!RunSafely(CRC, clang_parseTranslationUnit_Impl, &PTUI)) { 2143 fprintf(stderr, "libclang: crash detected during parsing: {\n"); 2144 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename); 2145 fprintf(stderr, " 'command_line_args' : ["); 2146 for (int i = 0; i != num_command_line_args; ++i) { 2147 if (i) 2148 fprintf(stderr, ", "); 2149 fprintf(stderr, "'%s'", command_line_args[i]); 2150 } 2151 fprintf(stderr, "],\n"); 2152 fprintf(stderr, " 'unsaved_files' : ["); 2153 for (unsigned i = 0; i != num_unsaved_files; ++i) { 2154 if (i) 2155 fprintf(stderr, ", "); 2156 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename, 2157 unsaved_files[i].Length); 2158 } 2159 fprintf(stderr, "],\n"); 2160 fprintf(stderr, " 'options' : %d,\n", options); 2161 fprintf(stderr, "}\n"); 2162 2163 return 0; 2164 } 2165 2166 return PTUI.result; 2167} 2168 2169unsigned clang_defaultSaveOptions(CXTranslationUnit TU) { 2170 return CXSaveTranslationUnit_None; 2171} 2172 2173int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName, 2174 unsigned options) { 2175 if (!TU) 2176 return 1; 2177 2178 return static_cast<ASTUnit *>(TU)->Save(FileName); 2179} 2180 2181void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) { 2182 if (CTUnit) { 2183 // If the translation unit has been marked as unsafe to free, just discard 2184 // it. 2185 if (static_cast<ASTUnit *>(CTUnit)->isUnsafeToFree()) 2186 return; 2187 2188 delete static_cast<ASTUnit *>(CTUnit); 2189 } 2190} 2191 2192unsigned clang_defaultReparseOptions(CXTranslationUnit TU) { 2193 return CXReparse_None; 2194} 2195 2196struct ReparseTranslationUnitInfo { 2197 CXTranslationUnit TU; 2198 unsigned num_unsaved_files; 2199 struct CXUnsavedFile *unsaved_files; 2200 unsigned options; 2201 int result; 2202}; 2203 2204static void clang_reparseTranslationUnit_Impl(void *UserData) { 2205 ReparseTranslationUnitInfo *RTUI = 2206 static_cast<ReparseTranslationUnitInfo*>(UserData); 2207 CXTranslationUnit TU = RTUI->TU; 2208 unsigned num_unsaved_files = RTUI->num_unsaved_files; 2209 struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files; 2210 unsigned options = RTUI->options; 2211 (void) options; 2212 RTUI->result = 1; 2213 2214 if (!TU) 2215 return; 2216 2217 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2218 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 2219 2220 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles; 2221 for (unsigned I = 0; I != num_unsaved_files; ++I) { 2222 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length); 2223 const llvm::MemoryBuffer *Buffer 2224 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename); 2225 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename, 2226 Buffer)); 2227 } 2228 2229 if (!CXXUnit->Reparse(RemappedFiles.data(), RemappedFiles.size())) 2230 RTUI->result = 0; 2231} 2232 2233int clang_reparseTranslationUnit(CXTranslationUnit TU, 2234 unsigned num_unsaved_files, 2235 struct CXUnsavedFile *unsaved_files, 2236 unsigned options) { 2237 ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files, 2238 options, 0 }; 2239 llvm::CrashRecoveryContext CRC; 2240 2241 if (!RunSafely(CRC, clang_reparseTranslationUnit_Impl, &RTUI)) { 2242 fprintf(stderr, "libclang: crash detected during reparsing\n"); 2243 static_cast<ASTUnit *>(TU)->setUnsafeToFree(true); 2244 return 1; 2245 } 2246 2247 2248 return RTUI.result; 2249} 2250 2251 2252CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) { 2253 if (!CTUnit) 2254 return createCXString(""); 2255 2256 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit); 2257 return createCXString(CXXUnit->getOriginalSourceFileName(), true); 2258} 2259 2260CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) { 2261 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } }; 2262 return Result; 2263} 2264 2265} // end: extern "C" 2266 2267//===----------------------------------------------------------------------===// 2268// CXSourceLocation and CXSourceRange Operations. 2269//===----------------------------------------------------------------------===// 2270 2271extern "C" { 2272CXSourceLocation clang_getNullLocation() { 2273 CXSourceLocation Result = { { 0, 0 }, 0 }; 2274 return Result; 2275} 2276 2277unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) { 2278 return (loc1.ptr_data[0] == loc2.ptr_data[0] && 2279 loc1.ptr_data[1] == loc2.ptr_data[1] && 2280 loc1.int_data == loc2.int_data); 2281} 2282 2283CXSourceLocation clang_getLocation(CXTranslationUnit tu, 2284 CXFile file, 2285 unsigned line, 2286 unsigned column) { 2287 if (!tu || !file) 2288 return clang_getNullLocation(); 2289 2290 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 2291 SourceLocation SLoc 2292 = CXXUnit->getSourceManager().getLocation( 2293 static_cast<const FileEntry *>(file), 2294 line, column); 2295 if (SLoc.isInvalid()) return clang_getNullLocation(); 2296 2297 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc); 2298} 2299 2300CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu, 2301 CXFile file, 2302 unsigned offset) { 2303 if (!tu || !file) 2304 return clang_getNullLocation(); 2305 2306 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 2307 SourceLocation Start 2308 = CXXUnit->getSourceManager().getLocation( 2309 static_cast<const FileEntry *>(file), 2310 1, 1); 2311 if (Start.isInvalid()) return clang_getNullLocation(); 2312 2313 SourceLocation SLoc = Start.getFileLocWithOffset(offset); 2314 2315 if (SLoc.isInvalid()) return clang_getNullLocation(); 2316 2317 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc); 2318} 2319 2320CXSourceRange clang_getNullRange() { 2321 CXSourceRange Result = { { 0, 0 }, 0, 0 }; 2322 return Result; 2323} 2324 2325CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) { 2326 if (begin.ptr_data[0] != end.ptr_data[0] || 2327 begin.ptr_data[1] != end.ptr_data[1]) 2328 return clang_getNullRange(); 2329 2330 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] }, 2331 begin.int_data, end.int_data }; 2332 return Result; 2333} 2334 2335void clang_getInstantiationLocation(CXSourceLocation location, 2336 CXFile *file, 2337 unsigned *line, 2338 unsigned *column, 2339 unsigned *offset) { 2340 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data); 2341 2342 if (!location.ptr_data[0] || Loc.isInvalid()) { 2343 if (file) 2344 *file = 0; 2345 if (line) 2346 *line = 0; 2347 if (column) 2348 *column = 0; 2349 if (offset) 2350 *offset = 0; 2351 return; 2352 } 2353 2354 const SourceManager &SM = 2355 *static_cast<const SourceManager*>(location.ptr_data[0]); 2356 SourceLocation InstLoc = SM.getInstantiationLoc(Loc); 2357 2358 if (file) 2359 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc)); 2360 if (line) 2361 *line = SM.getInstantiationLineNumber(InstLoc); 2362 if (column) 2363 *column = SM.getInstantiationColumnNumber(InstLoc); 2364 if (offset) 2365 *offset = SM.getDecomposedLoc(InstLoc).second; 2366} 2367 2368CXSourceLocation clang_getRangeStart(CXSourceRange range) { 2369 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] }, 2370 range.begin_int_data }; 2371 return Result; 2372} 2373 2374CXSourceLocation clang_getRangeEnd(CXSourceRange range) { 2375 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] }, 2376 range.end_int_data }; 2377 return Result; 2378} 2379 2380} // end: extern "C" 2381 2382//===----------------------------------------------------------------------===// 2383// CXFile Operations. 2384//===----------------------------------------------------------------------===// 2385 2386extern "C" { 2387CXString clang_getFileName(CXFile SFile) { 2388 if (!SFile) 2389 return createCXString(NULL); 2390 2391 FileEntry *FEnt = static_cast<FileEntry *>(SFile); 2392 return createCXString(FEnt->getName()); 2393} 2394 2395time_t clang_getFileTime(CXFile SFile) { 2396 if (!SFile) 2397 return 0; 2398 2399 FileEntry *FEnt = static_cast<FileEntry *>(SFile); 2400 return FEnt->getModificationTime(); 2401} 2402 2403CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) { 2404 if (!tu) 2405 return 0; 2406 2407 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 2408 2409 FileManager &FMgr = CXXUnit->getFileManager(); 2410 const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name), 2411 CXXUnit->getFileSystemOpts()); 2412 return const_cast<FileEntry *>(File); 2413} 2414 2415} // end: extern "C" 2416 2417//===----------------------------------------------------------------------===// 2418// CXCursor Operations. 2419//===----------------------------------------------------------------------===// 2420 2421static Decl *getDeclFromExpr(Stmt *E) { 2422 if (CastExpr *CE = dyn_cast<CastExpr>(E)) 2423 return getDeclFromExpr(CE->getSubExpr()); 2424 2425 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E)) 2426 return RefExpr->getDecl(); 2427 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E)) 2428 return RefExpr->getDecl(); 2429 if (MemberExpr *ME = dyn_cast<MemberExpr>(E)) 2430 return ME->getMemberDecl(); 2431 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E)) 2432 return RE->getDecl(); 2433 if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E)) 2434 return PRE->getProperty(); 2435 2436 if (CallExpr *CE = dyn_cast<CallExpr>(E)) 2437 return getDeclFromExpr(CE->getCallee()); 2438 if (CXXConstructExpr *CE = llvm::dyn_cast<CXXConstructExpr>(E)) 2439 if (!CE->isElidable()) 2440 return CE->getConstructor(); 2441 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E)) 2442 return OME->getMethodDecl(); 2443 2444 if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E)) 2445 return PE->getProtocol(); 2446 2447 return 0; 2448} 2449 2450static SourceLocation getLocationFromExpr(Expr *E) { 2451 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E)) 2452 return /*FIXME:*/Msg->getLeftLoc(); 2453 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) 2454 return DRE->getLocation(); 2455 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E)) 2456 return RefExpr->getLocation(); 2457 if (MemberExpr *Member = dyn_cast<MemberExpr>(E)) 2458 return Member->getMemberLoc(); 2459 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E)) 2460 return Ivar->getLocation(); 2461 return E->getLocStart(); 2462} 2463 2464extern "C" { 2465 2466unsigned clang_visitChildren(CXCursor parent, 2467 CXCursorVisitor visitor, 2468 CXClientData client_data) { 2469 ASTUnit *CXXUnit = getCursorASTUnit(parent); 2470 2471 CursorVisitor CursorVis(CXXUnit, visitor, client_data, 2472 CXXUnit->getMaxPCHLevel()); 2473 return CursorVis.VisitChildren(parent); 2474} 2475 2476#ifndef __has_feature 2477#define __has_feature(x) 0 2478#endif 2479#if __has_feature(blocks) 2480typedef enum CXChildVisitResult 2481 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent); 2482 2483static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent, 2484 CXClientData client_data) { 2485 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data; 2486 return block(cursor, parent); 2487} 2488#else 2489// If we are compiled with a compiler that doesn't have native blocks support, 2490// define and call the block manually, so the 2491typedef struct _CXChildVisitResult 2492{ 2493 void *isa; 2494 int flags; 2495 int reserved; 2496 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor, 2497 CXCursor); 2498} *CXCursorVisitorBlock; 2499 2500static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent, 2501 CXClientData client_data) { 2502 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data; 2503 return block->invoke(block, cursor, parent); 2504} 2505#endif 2506 2507 2508unsigned clang_visitChildrenWithBlock(CXCursor parent, 2509 CXCursorVisitorBlock block) { 2510 return clang_visitChildren(parent, visitWithBlock, block); 2511} 2512 2513static CXString getDeclSpelling(Decl *D) { 2514 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D); 2515 if (!ND) 2516 return createCXString(""); 2517 2518 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND)) 2519 return createCXString(OMD->getSelector().getAsString()); 2520 2521 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND)) 2522 // No, this isn't the same as the code below. getIdentifier() is non-virtual 2523 // and returns different names. NamedDecl returns the class name and 2524 // ObjCCategoryImplDecl returns the category name. 2525 return createCXString(CIMP->getIdentifier()->getNameStart()); 2526 2527 if (isa<UsingDirectiveDecl>(D)) 2528 return createCXString(""); 2529 2530 llvm::SmallString<1024> S; 2531 llvm::raw_svector_ostream os(S); 2532 ND->printName(os); 2533 2534 return createCXString(os.str()); 2535} 2536 2537CXString clang_getCursorSpelling(CXCursor C) { 2538 if (clang_isTranslationUnit(C.kind)) 2539 return clang_getTranslationUnitSpelling(C.data[2]); 2540 2541 if (clang_isReference(C.kind)) { 2542 switch (C.kind) { 2543 case CXCursor_ObjCSuperClassRef: { 2544 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first; 2545 return createCXString(Super->getIdentifier()->getNameStart()); 2546 } 2547 case CXCursor_ObjCClassRef: { 2548 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first; 2549 return createCXString(Class->getIdentifier()->getNameStart()); 2550 } 2551 case CXCursor_ObjCProtocolRef: { 2552 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first; 2553 assert(OID && "getCursorSpelling(): Missing protocol decl"); 2554 return createCXString(OID->getIdentifier()->getNameStart()); 2555 } 2556 case CXCursor_CXXBaseSpecifier: { 2557 CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C); 2558 return createCXString(B->getType().getAsString()); 2559 } 2560 case CXCursor_TypeRef: { 2561 TypeDecl *Type = getCursorTypeRef(C).first; 2562 assert(Type && "Missing type decl"); 2563 2564 return createCXString(getCursorContext(C).getTypeDeclType(Type). 2565 getAsString()); 2566 } 2567 case CXCursor_TemplateRef: { 2568 TemplateDecl *Template = getCursorTemplateRef(C).first; 2569 assert(Template && "Missing template decl"); 2570 2571 return createCXString(Template->getNameAsString()); 2572 } 2573 2574 case CXCursor_NamespaceRef: { 2575 NamedDecl *NS = getCursorNamespaceRef(C).first; 2576 assert(NS && "Missing namespace decl"); 2577 2578 return createCXString(NS->getNameAsString()); 2579 } 2580 2581 case CXCursor_MemberRef: { 2582 FieldDecl *Field = getCursorMemberRef(C).first; 2583 assert(Field && "Missing member decl"); 2584 2585 return createCXString(Field->getNameAsString()); 2586 } 2587 2588 case CXCursor_LabelRef: { 2589 LabelStmt *Label = getCursorLabelRef(C).first; 2590 assert(Label && "Missing label"); 2591 2592 return createCXString(Label->getID()->getName()); 2593 } 2594 2595 case CXCursor_OverloadedDeclRef: { 2596 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first; 2597 if (Decl *D = Storage.dyn_cast<Decl *>()) { 2598 if (NamedDecl *ND = dyn_cast<NamedDecl>(D)) 2599 return createCXString(ND->getNameAsString()); 2600 return createCXString(""); 2601 } 2602 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>()) 2603 return createCXString(E->getName().getAsString()); 2604 OverloadedTemplateStorage *Ovl 2605 = Storage.get<OverloadedTemplateStorage*>(); 2606 if (Ovl->size() == 0) 2607 return createCXString(""); 2608 return createCXString((*Ovl->begin())->getNameAsString()); 2609 } 2610 2611 default: 2612 return createCXString("<not implemented>"); 2613 } 2614 } 2615 2616 if (clang_isExpression(C.kind)) { 2617 Decl *D = getDeclFromExpr(getCursorExpr(C)); 2618 if (D) 2619 return getDeclSpelling(D); 2620 return createCXString(""); 2621 } 2622 2623 if (clang_isStatement(C.kind)) { 2624 Stmt *S = getCursorStmt(C); 2625 if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S)) 2626 return createCXString(Label->getID()->getName()); 2627 2628 return createCXString(""); 2629 } 2630 2631 if (C.kind == CXCursor_MacroInstantiation) 2632 return createCXString(getCursorMacroInstantiation(C)->getName() 2633 ->getNameStart()); 2634 2635 if (C.kind == CXCursor_MacroDefinition) 2636 return createCXString(getCursorMacroDefinition(C)->getName() 2637 ->getNameStart()); 2638 2639 if (C.kind == CXCursor_InclusionDirective) 2640 return createCXString(getCursorInclusionDirective(C)->getFileName()); 2641 2642 if (clang_isDeclaration(C.kind)) 2643 return getDeclSpelling(getCursorDecl(C)); 2644 2645 return createCXString(""); 2646} 2647 2648CXString clang_getCursorDisplayName(CXCursor C) { 2649 if (!clang_isDeclaration(C.kind)) 2650 return clang_getCursorSpelling(C); 2651 2652 Decl *D = getCursorDecl(C); 2653 if (!D) 2654 return createCXString(""); 2655 2656 PrintingPolicy &Policy = getCursorContext(C).PrintingPolicy; 2657 if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D)) 2658 D = FunTmpl->getTemplatedDecl(); 2659 2660 if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) { 2661 llvm::SmallString<64> Str; 2662 llvm::raw_svector_ostream OS(Str); 2663 OS << Function->getNameAsString(); 2664 if (Function->getPrimaryTemplate()) 2665 OS << "<>"; 2666 OS << "("; 2667 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) { 2668 if (I) 2669 OS << ", "; 2670 OS << Function->getParamDecl(I)->getType().getAsString(Policy); 2671 } 2672 2673 if (Function->isVariadic()) { 2674 if (Function->getNumParams()) 2675 OS << ", "; 2676 OS << "..."; 2677 } 2678 OS << ")"; 2679 return createCXString(OS.str()); 2680 } 2681 2682 if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) { 2683 llvm::SmallString<64> Str; 2684 llvm::raw_svector_ostream OS(Str); 2685 OS << ClassTemplate->getNameAsString(); 2686 OS << "<"; 2687 TemplateParameterList *Params = ClassTemplate->getTemplateParameters(); 2688 for (unsigned I = 0, N = Params->size(); I != N; ++I) { 2689 if (I) 2690 OS << ", "; 2691 2692 NamedDecl *Param = Params->getParam(I); 2693 if (Param->getIdentifier()) { 2694 OS << Param->getIdentifier()->getName(); 2695 continue; 2696 } 2697 2698 // There is no parameter name, which makes this tricky. Try to come up 2699 // with something useful that isn't too long. 2700 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param)) 2701 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class"); 2702 else if (NonTypeTemplateParmDecl *NTTP 2703 = dyn_cast<NonTypeTemplateParmDecl>(Param)) 2704 OS << NTTP->getType().getAsString(Policy); 2705 else 2706 OS << "template<...> class"; 2707 } 2708 2709 OS << ">"; 2710 return createCXString(OS.str()); 2711 } 2712 2713 if (ClassTemplateSpecializationDecl *ClassSpec 2714 = dyn_cast<ClassTemplateSpecializationDecl>(D)) { 2715 // If the type was explicitly written, use that. 2716 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten()) 2717 return createCXString(TSInfo->getType().getAsString(Policy)); 2718 2719 llvm::SmallString<64> Str; 2720 llvm::raw_svector_ostream OS(Str); 2721 OS << ClassSpec->getNameAsString(); 2722 OS << TemplateSpecializationType::PrintTemplateArgumentList( 2723 ClassSpec->getTemplateArgs().getFlatArgumentList(), 2724 ClassSpec->getTemplateArgs().flat_size(), 2725 Policy); 2726 return createCXString(OS.str()); 2727 } 2728 2729 return clang_getCursorSpelling(C); 2730} 2731 2732CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) { 2733 switch (Kind) { 2734 case CXCursor_FunctionDecl: 2735 return createCXString("FunctionDecl"); 2736 case CXCursor_TypedefDecl: 2737 return createCXString("TypedefDecl"); 2738 case CXCursor_EnumDecl: 2739 return createCXString("EnumDecl"); 2740 case CXCursor_EnumConstantDecl: 2741 return createCXString("EnumConstantDecl"); 2742 case CXCursor_StructDecl: 2743 return createCXString("StructDecl"); 2744 case CXCursor_UnionDecl: 2745 return createCXString("UnionDecl"); 2746 case CXCursor_ClassDecl: 2747 return createCXString("ClassDecl"); 2748 case CXCursor_FieldDecl: 2749 return createCXString("FieldDecl"); 2750 case CXCursor_VarDecl: 2751 return createCXString("VarDecl"); 2752 case CXCursor_ParmDecl: 2753 return createCXString("ParmDecl"); 2754 case CXCursor_ObjCInterfaceDecl: 2755 return createCXString("ObjCInterfaceDecl"); 2756 case CXCursor_ObjCCategoryDecl: 2757 return createCXString("ObjCCategoryDecl"); 2758 case CXCursor_ObjCProtocolDecl: 2759 return createCXString("ObjCProtocolDecl"); 2760 case CXCursor_ObjCPropertyDecl: 2761 return createCXString("ObjCPropertyDecl"); 2762 case CXCursor_ObjCIvarDecl: 2763 return createCXString("ObjCIvarDecl"); 2764 case CXCursor_ObjCInstanceMethodDecl: 2765 return createCXString("ObjCInstanceMethodDecl"); 2766 case CXCursor_ObjCClassMethodDecl: 2767 return createCXString("ObjCClassMethodDecl"); 2768 case CXCursor_ObjCImplementationDecl: 2769 return createCXString("ObjCImplementationDecl"); 2770 case CXCursor_ObjCCategoryImplDecl: 2771 return createCXString("ObjCCategoryImplDecl"); 2772 case CXCursor_CXXMethod: 2773 return createCXString("CXXMethod"); 2774 case CXCursor_UnexposedDecl: 2775 return createCXString("UnexposedDecl"); 2776 case CXCursor_ObjCSuperClassRef: 2777 return createCXString("ObjCSuperClassRef"); 2778 case CXCursor_ObjCProtocolRef: 2779 return createCXString("ObjCProtocolRef"); 2780 case CXCursor_ObjCClassRef: 2781 return createCXString("ObjCClassRef"); 2782 case CXCursor_TypeRef: 2783 return createCXString("TypeRef"); 2784 case CXCursor_TemplateRef: 2785 return createCXString("TemplateRef"); 2786 case CXCursor_NamespaceRef: 2787 return createCXString("NamespaceRef"); 2788 case CXCursor_MemberRef: 2789 return createCXString("MemberRef"); 2790 case CXCursor_LabelRef: 2791 return createCXString("LabelRef"); 2792 case CXCursor_OverloadedDeclRef: 2793 return createCXString("OverloadedDeclRef"); 2794 case CXCursor_UnexposedExpr: 2795 return createCXString("UnexposedExpr"); 2796 case CXCursor_BlockExpr: 2797 return createCXString("BlockExpr"); 2798 case CXCursor_DeclRefExpr: 2799 return createCXString("DeclRefExpr"); 2800 case CXCursor_MemberRefExpr: 2801 return createCXString("MemberRefExpr"); 2802 case CXCursor_CallExpr: 2803 return createCXString("CallExpr"); 2804 case CXCursor_ObjCMessageExpr: 2805 return createCXString("ObjCMessageExpr"); 2806 case CXCursor_UnexposedStmt: 2807 return createCXString("UnexposedStmt"); 2808 case CXCursor_LabelStmt: 2809 return createCXString("LabelStmt"); 2810 case CXCursor_InvalidFile: 2811 return createCXString("InvalidFile"); 2812 case CXCursor_InvalidCode: 2813 return createCXString("InvalidCode"); 2814 case CXCursor_NoDeclFound: 2815 return createCXString("NoDeclFound"); 2816 case CXCursor_NotImplemented: 2817 return createCXString("NotImplemented"); 2818 case CXCursor_TranslationUnit: 2819 return createCXString("TranslationUnit"); 2820 case CXCursor_UnexposedAttr: 2821 return createCXString("UnexposedAttr"); 2822 case CXCursor_IBActionAttr: 2823 return createCXString("attribute(ibaction)"); 2824 case CXCursor_IBOutletAttr: 2825 return createCXString("attribute(iboutlet)"); 2826 case CXCursor_IBOutletCollectionAttr: 2827 return createCXString("attribute(iboutletcollection)"); 2828 case CXCursor_PreprocessingDirective: 2829 return createCXString("preprocessing directive"); 2830 case CXCursor_MacroDefinition: 2831 return createCXString("macro definition"); 2832 case CXCursor_MacroInstantiation: 2833 return createCXString("macro instantiation"); 2834 case CXCursor_InclusionDirective: 2835 return createCXString("inclusion directive"); 2836 case CXCursor_Namespace: 2837 return createCXString("Namespace"); 2838 case CXCursor_LinkageSpec: 2839 return createCXString("LinkageSpec"); 2840 case CXCursor_CXXBaseSpecifier: 2841 return createCXString("C++ base class specifier"); 2842 case CXCursor_Constructor: 2843 return createCXString("CXXConstructor"); 2844 case CXCursor_Destructor: 2845 return createCXString("CXXDestructor"); 2846 case CXCursor_ConversionFunction: 2847 return createCXString("CXXConversion"); 2848 case CXCursor_TemplateTypeParameter: 2849 return createCXString("TemplateTypeParameter"); 2850 case CXCursor_NonTypeTemplateParameter: 2851 return createCXString("NonTypeTemplateParameter"); 2852 case CXCursor_TemplateTemplateParameter: 2853 return createCXString("TemplateTemplateParameter"); 2854 case CXCursor_FunctionTemplate: 2855 return createCXString("FunctionTemplate"); 2856 case CXCursor_ClassTemplate: 2857 return createCXString("ClassTemplate"); 2858 case CXCursor_ClassTemplatePartialSpecialization: 2859 return createCXString("ClassTemplatePartialSpecialization"); 2860 case CXCursor_NamespaceAlias: 2861 return createCXString("NamespaceAlias"); 2862 case CXCursor_UsingDirective: 2863 return createCXString("UsingDirective"); 2864 case CXCursor_UsingDeclaration: 2865 return createCXString("UsingDeclaration"); 2866 } 2867 2868 llvm_unreachable("Unhandled CXCursorKind"); 2869 return createCXString(NULL); 2870} 2871 2872enum CXChildVisitResult GetCursorVisitor(CXCursor cursor, 2873 CXCursor parent, 2874 CXClientData client_data) { 2875 CXCursor *BestCursor = static_cast<CXCursor *>(client_data); 2876 2877 // If our current best cursor is the construction of a temporary object, 2878 // don't replace that cursor with a type reference, because we want 2879 // clang_getCursor() to point at the constructor. 2880 if (clang_isExpression(BestCursor->kind) && 2881 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) && 2882 cursor.kind == CXCursor_TypeRef) 2883 return CXChildVisit_Recurse; 2884 2885 *BestCursor = cursor; 2886 return CXChildVisit_Recurse; 2887} 2888 2889CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) { 2890 if (!TU) 2891 return clang_getNullCursor(); 2892 2893 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2894 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 2895 2896 // Translate the given source location to make it point at the beginning of 2897 // the token under the cursor. 2898 SourceLocation SLoc = cxloc::translateSourceLocation(Loc); 2899 2900 // Guard against an invalid SourceLocation, or we may assert in one 2901 // of the following calls. 2902 if (SLoc.isInvalid()) 2903 return clang_getNullCursor(); 2904 2905 bool Logging = getenv("LIBCLANG_LOGGING"); 2906 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(), 2907 CXXUnit->getASTContext().getLangOptions()); 2908 2909 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound); 2910 if (SLoc.isValid()) { 2911 // FIXME: Would be great to have a "hint" cursor, then walk from that 2912 // hint cursor upward until we find a cursor whose source range encloses 2913 // the region of interest, rather than starting from the translation unit. 2914 CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit); 2915 CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result, 2916 Decl::MaxPCHLevel, SourceLocation(SLoc)); 2917 CursorVis.VisitChildren(Parent); 2918 } 2919 2920 if (Logging) { 2921 CXFile SearchFile; 2922 unsigned SearchLine, SearchColumn; 2923 CXFile ResultFile; 2924 unsigned ResultLine, ResultColumn; 2925 CXString SearchFileName, ResultFileName, KindSpelling; 2926 CXSourceLocation ResultLoc = clang_getCursorLocation(Result); 2927 2928 clang_getInstantiationLocation(Loc, &SearchFile, &SearchLine, &SearchColumn, 2929 0); 2930 clang_getInstantiationLocation(ResultLoc, &ResultFile, &ResultLine, 2931 &ResultColumn, 0); 2932 SearchFileName = clang_getFileName(SearchFile); 2933 ResultFileName = clang_getFileName(ResultFile); 2934 KindSpelling = clang_getCursorKindSpelling(Result.kind); 2935 fprintf(stderr, "clang_getCursor(%s:%d:%d) = %s(%s:%d:%d)\n", 2936 clang_getCString(SearchFileName), SearchLine, SearchColumn, 2937 clang_getCString(KindSpelling), 2938 clang_getCString(ResultFileName), ResultLine, ResultColumn); 2939 clang_disposeString(SearchFileName); 2940 clang_disposeString(ResultFileName); 2941 clang_disposeString(KindSpelling); 2942 } 2943 2944 return Result; 2945} 2946 2947CXCursor clang_getNullCursor(void) { 2948 return MakeCXCursorInvalid(CXCursor_InvalidFile); 2949} 2950 2951unsigned clang_equalCursors(CXCursor X, CXCursor Y) { 2952 return X == Y; 2953} 2954 2955unsigned clang_isInvalid(enum CXCursorKind K) { 2956 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid; 2957} 2958 2959unsigned clang_isDeclaration(enum CXCursorKind K) { 2960 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl; 2961} 2962 2963unsigned clang_isReference(enum CXCursorKind K) { 2964 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef; 2965} 2966 2967unsigned clang_isExpression(enum CXCursorKind K) { 2968 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr; 2969} 2970 2971unsigned clang_isStatement(enum CXCursorKind K) { 2972 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt; 2973} 2974 2975unsigned clang_isTranslationUnit(enum CXCursorKind K) { 2976 return K == CXCursor_TranslationUnit; 2977} 2978 2979unsigned clang_isPreprocessing(enum CXCursorKind K) { 2980 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing; 2981} 2982 2983unsigned clang_isUnexposed(enum CXCursorKind K) { 2984 switch (K) { 2985 case CXCursor_UnexposedDecl: 2986 case CXCursor_UnexposedExpr: 2987 case CXCursor_UnexposedStmt: 2988 case CXCursor_UnexposedAttr: 2989 return true; 2990 default: 2991 return false; 2992 } 2993} 2994 2995CXCursorKind clang_getCursorKind(CXCursor C) { 2996 return C.kind; 2997} 2998 2999CXSourceLocation clang_getCursorLocation(CXCursor C) { 3000 if (clang_isReference(C.kind)) { 3001 switch (C.kind) { 3002 case CXCursor_ObjCSuperClassRef: { 3003 std::pair<ObjCInterfaceDecl *, SourceLocation> P 3004 = getCursorObjCSuperClassRef(C); 3005 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3006 } 3007 3008 case CXCursor_ObjCProtocolRef: { 3009 std::pair<ObjCProtocolDecl *, SourceLocation> P 3010 = getCursorObjCProtocolRef(C); 3011 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3012 } 3013 3014 case CXCursor_ObjCClassRef: { 3015 std::pair<ObjCInterfaceDecl *, SourceLocation> P 3016 = getCursorObjCClassRef(C); 3017 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3018 } 3019 3020 case CXCursor_TypeRef: { 3021 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C); 3022 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3023 } 3024 3025 case CXCursor_TemplateRef: { 3026 std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C); 3027 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3028 } 3029 3030 case CXCursor_NamespaceRef: { 3031 std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C); 3032 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3033 } 3034 3035 case CXCursor_MemberRef: { 3036 std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C); 3037 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 3038 } 3039 3040 case CXCursor_CXXBaseSpecifier: { 3041 CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C); 3042 if (!BaseSpec) 3043 return clang_getNullLocation(); 3044 3045 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo()) 3046 return cxloc::translateSourceLocation(getCursorContext(C), 3047 TSInfo->getTypeLoc().getBeginLoc()); 3048 3049 return cxloc::translateSourceLocation(getCursorContext(C), 3050 BaseSpec->getSourceRange().getBegin()); 3051 } 3052 3053 case CXCursor_LabelRef: { 3054 std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C); 3055 return cxloc::translateSourceLocation(getCursorContext(C), P.second); 3056 } 3057 3058 case CXCursor_OverloadedDeclRef: 3059 return cxloc::translateSourceLocation(getCursorContext(C), 3060 getCursorOverloadedDeclRef(C).second); 3061 3062 default: 3063 // FIXME: Need a way to enumerate all non-reference cases. 3064 llvm_unreachable("Missed a reference kind"); 3065 } 3066 } 3067 3068 if (clang_isExpression(C.kind)) 3069 return cxloc::translateSourceLocation(getCursorContext(C), 3070 getLocationFromExpr(getCursorExpr(C))); 3071 3072 if (clang_isStatement(C.kind)) 3073 return cxloc::translateSourceLocation(getCursorContext(C), 3074 getCursorStmt(C)->getLocStart()); 3075 3076 if (C.kind == CXCursor_PreprocessingDirective) { 3077 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin(); 3078 return cxloc::translateSourceLocation(getCursorContext(C), L); 3079 } 3080 3081 if (C.kind == CXCursor_MacroInstantiation) { 3082 SourceLocation L 3083 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin(); 3084 return cxloc::translateSourceLocation(getCursorContext(C), L); 3085 } 3086 3087 if (C.kind == CXCursor_MacroDefinition) { 3088 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation(); 3089 return cxloc::translateSourceLocation(getCursorContext(C), L); 3090 } 3091 3092 if (C.kind == CXCursor_InclusionDirective) { 3093 SourceLocation L 3094 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin(); 3095 return cxloc::translateSourceLocation(getCursorContext(C), L); 3096 } 3097 3098 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl) 3099 return clang_getNullLocation(); 3100 3101 Decl *D = getCursorDecl(C); 3102 SourceLocation Loc = D->getLocation(); 3103 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D)) 3104 Loc = Class->getClassLoc(); 3105 // FIXME: Multiple variables declared in a single declaration 3106 // currently lack the information needed to correctly determine their 3107 // ranges when accounting for the type-specifier. We use context 3108 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup, 3109 // and if so, whether it is the first decl. 3110 if (VarDecl *VD = dyn_cast<VarDecl>(D)) { 3111 if (!cxcursor::isFirstInDeclGroup(C)) 3112 Loc = VD->getLocation(); 3113 } 3114 3115 return cxloc::translateSourceLocation(getCursorContext(C), Loc); 3116} 3117 3118} // end extern "C" 3119 3120static SourceRange getRawCursorExtent(CXCursor C) { 3121 if (clang_isReference(C.kind)) { 3122 switch (C.kind) { 3123 case CXCursor_ObjCSuperClassRef: 3124 return getCursorObjCSuperClassRef(C).second; 3125 3126 case CXCursor_ObjCProtocolRef: 3127 return getCursorObjCProtocolRef(C).second; 3128 3129 case CXCursor_ObjCClassRef: 3130 return getCursorObjCClassRef(C).second; 3131 3132 case CXCursor_TypeRef: 3133 return getCursorTypeRef(C).second; 3134 3135 case CXCursor_TemplateRef: 3136 return getCursorTemplateRef(C).second; 3137 3138 case CXCursor_NamespaceRef: 3139 return getCursorNamespaceRef(C).second; 3140 3141 case CXCursor_MemberRef: 3142 return getCursorMemberRef(C).second; 3143 3144 case CXCursor_CXXBaseSpecifier: 3145 return getCursorCXXBaseSpecifier(C)->getSourceRange(); 3146 3147 case CXCursor_LabelRef: 3148 return getCursorLabelRef(C).second; 3149 3150 case CXCursor_OverloadedDeclRef: 3151 return getCursorOverloadedDeclRef(C).second; 3152 3153 default: 3154 // FIXME: Need a way to enumerate all non-reference cases. 3155 llvm_unreachable("Missed a reference kind"); 3156 } 3157 } 3158 3159 if (clang_isExpression(C.kind)) 3160 return getCursorExpr(C)->getSourceRange(); 3161 3162 if (clang_isStatement(C.kind)) 3163 return getCursorStmt(C)->getSourceRange(); 3164 3165 if (C.kind == CXCursor_PreprocessingDirective) 3166 return cxcursor::getCursorPreprocessingDirective(C); 3167 3168 if (C.kind == CXCursor_MacroInstantiation) 3169 return cxcursor::getCursorMacroInstantiation(C)->getSourceRange(); 3170 3171 if (C.kind == CXCursor_MacroDefinition) 3172 return cxcursor::getCursorMacroDefinition(C)->getSourceRange(); 3173 3174 if (C.kind == CXCursor_InclusionDirective) 3175 return cxcursor::getCursorInclusionDirective(C)->getSourceRange(); 3176 3177 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) { 3178 Decl *D = cxcursor::getCursorDecl(C); 3179 SourceRange R = D->getSourceRange(); 3180 // FIXME: Multiple variables declared in a single declaration 3181 // currently lack the information needed to correctly determine their 3182 // ranges when accounting for the type-specifier. We use context 3183 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup, 3184 // and if so, whether it is the first decl. 3185 if (VarDecl *VD = dyn_cast<VarDecl>(D)) { 3186 if (!cxcursor::isFirstInDeclGroup(C)) 3187 R.setBegin(VD->getLocation()); 3188 } 3189 return R; 3190 } 3191 return SourceRange();} 3192 3193extern "C" { 3194 3195CXSourceRange clang_getCursorExtent(CXCursor C) { 3196 SourceRange R = getRawCursorExtent(C); 3197 if (R.isInvalid()) 3198 return clang_getNullRange(); 3199 3200 return cxloc::translateSourceRange(getCursorContext(C), R); 3201} 3202 3203CXCursor clang_getCursorReferenced(CXCursor C) { 3204 if (clang_isInvalid(C.kind)) 3205 return clang_getNullCursor(); 3206 3207 ASTUnit *CXXUnit = getCursorASTUnit(C); 3208 if (clang_isDeclaration(C.kind)) { 3209 Decl *D = getCursorDecl(C); 3210 if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) 3211 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), CXXUnit); 3212 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D)) 3213 return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), CXXUnit); 3214 if (ObjCForwardProtocolDecl *Protocols 3215 = dyn_cast<ObjCForwardProtocolDecl>(D)) 3216 return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), CXXUnit); 3217 3218 return C; 3219 } 3220 3221 if (clang_isExpression(C.kind)) { 3222 Expr *E = getCursorExpr(C); 3223 Decl *D = getDeclFromExpr(E); 3224 if (D) 3225 return MakeCXCursor(D, CXXUnit); 3226 3227 if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E)) 3228 return MakeCursorOverloadedDeclRef(Ovl, CXXUnit); 3229 3230 return clang_getNullCursor(); 3231 } 3232 3233 if (clang_isStatement(C.kind)) { 3234 Stmt *S = getCursorStmt(C); 3235 if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S)) 3236 return MakeCXCursor(Goto->getLabel(), getCursorDecl(C), 3237 getCursorASTUnit(C)); 3238 3239 return clang_getNullCursor(); 3240 } 3241 3242 if (C.kind == CXCursor_MacroInstantiation) { 3243 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition()) 3244 return MakeMacroDefinitionCursor(Def, CXXUnit); 3245 } 3246 3247 if (!clang_isReference(C.kind)) 3248 return clang_getNullCursor(); 3249 3250 switch (C.kind) { 3251 case CXCursor_ObjCSuperClassRef: 3252 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit); 3253 3254 case CXCursor_ObjCProtocolRef: { 3255 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit); 3256 3257 case CXCursor_ObjCClassRef: 3258 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit); 3259 3260 case CXCursor_TypeRef: 3261 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit); 3262 3263 case CXCursor_TemplateRef: 3264 return MakeCXCursor(getCursorTemplateRef(C).first, CXXUnit); 3265 3266 case CXCursor_NamespaceRef: 3267 return MakeCXCursor(getCursorNamespaceRef(C).first, CXXUnit); 3268 3269 case CXCursor_MemberRef: 3270 return MakeCXCursor(getCursorMemberRef(C).first, CXXUnit); 3271 3272 case CXCursor_CXXBaseSpecifier: { 3273 CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C); 3274 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(), 3275 CXXUnit)); 3276 } 3277 3278 case CXCursor_LabelRef: 3279 // FIXME: We end up faking the "parent" declaration here because we 3280 // don't want to make CXCursor larger. 3281 return MakeCXCursor(getCursorLabelRef(C).first, 3282 CXXUnit->getASTContext().getTranslationUnitDecl(), 3283 CXXUnit); 3284 3285 case CXCursor_OverloadedDeclRef: 3286 return C; 3287 3288 default: 3289 // We would prefer to enumerate all non-reference cursor kinds here. 3290 llvm_unreachable("Unhandled reference cursor kind"); 3291 break; 3292 } 3293 } 3294 3295 return clang_getNullCursor(); 3296} 3297 3298CXCursor clang_getCursorDefinition(CXCursor C) { 3299 if (clang_isInvalid(C.kind)) 3300 return clang_getNullCursor(); 3301 3302 ASTUnit *CXXUnit = getCursorASTUnit(C); 3303 3304 bool WasReference = false; 3305 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) { 3306 C = clang_getCursorReferenced(C); 3307 WasReference = true; 3308 } 3309 3310 if (C.kind == CXCursor_MacroInstantiation) 3311 return clang_getCursorReferenced(C); 3312 3313 if (!clang_isDeclaration(C.kind)) 3314 return clang_getNullCursor(); 3315 3316 Decl *D = getCursorDecl(C); 3317 if (!D) 3318 return clang_getNullCursor(); 3319 3320 switch (D->getKind()) { 3321 // Declaration kinds that don't really separate the notions of 3322 // declaration and definition. 3323 case Decl::Namespace: 3324 case Decl::Typedef: 3325 case Decl::TemplateTypeParm: 3326 case Decl::EnumConstant: 3327 case Decl::Field: 3328 case Decl::ObjCIvar: 3329 case Decl::ObjCAtDefsField: 3330 case Decl::ImplicitParam: 3331 case Decl::ParmVar: 3332 case Decl::NonTypeTemplateParm: 3333 case Decl::TemplateTemplateParm: 3334 case Decl::ObjCCategoryImpl: 3335 case Decl::ObjCImplementation: 3336 case Decl::AccessSpec: 3337 case Decl::LinkageSpec: 3338 case Decl::ObjCPropertyImpl: 3339 case Decl::FileScopeAsm: 3340 case Decl::StaticAssert: 3341 case Decl::Block: 3342 return C; 3343 3344 // Declaration kinds that don't make any sense here, but are 3345 // nonetheless harmless. 3346 case Decl::TranslationUnit: 3347 break; 3348 3349 // Declaration kinds for which the definition is not resolvable. 3350 case Decl::UnresolvedUsingTypename: 3351 case Decl::UnresolvedUsingValue: 3352 break; 3353 3354 case Decl::UsingDirective: 3355 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(), 3356 CXXUnit); 3357 3358 case Decl::NamespaceAlias: 3359 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit); 3360 3361 case Decl::Enum: 3362 case Decl::Record: 3363 case Decl::CXXRecord: 3364 case Decl::ClassTemplateSpecialization: 3365 case Decl::ClassTemplatePartialSpecialization: 3366 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition()) 3367 return MakeCXCursor(Def, CXXUnit); 3368 return clang_getNullCursor(); 3369 3370 case Decl::Function: 3371 case Decl::CXXMethod: 3372 case Decl::CXXConstructor: 3373 case Decl::CXXDestructor: 3374 case Decl::CXXConversion: { 3375 const FunctionDecl *Def = 0; 3376 if (cast<FunctionDecl>(D)->getBody(Def)) 3377 return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit); 3378 return clang_getNullCursor(); 3379 } 3380 3381 case Decl::Var: { 3382 // Ask the variable if it has a definition. 3383 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition()) 3384 return MakeCXCursor(Def, CXXUnit); 3385 return clang_getNullCursor(); 3386 } 3387 3388 case Decl::FunctionTemplate: { 3389 const FunctionDecl *Def = 0; 3390 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def)) 3391 return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit); 3392 return clang_getNullCursor(); 3393 } 3394 3395 case Decl::ClassTemplate: { 3396 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl() 3397 ->getDefinition()) 3398 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(), 3399 CXXUnit); 3400 return clang_getNullCursor(); 3401 } 3402 3403 case Decl::Using: 3404 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D), 3405 D->getLocation(), CXXUnit); 3406 3407 case Decl::UsingShadow: 3408 return clang_getCursorDefinition( 3409 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(), 3410 CXXUnit)); 3411 3412 case Decl::ObjCMethod: { 3413 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D); 3414 if (Method->isThisDeclarationADefinition()) 3415 return C; 3416 3417 // Dig out the method definition in the associated 3418 // @implementation, if we have it. 3419 // FIXME: The ASTs should make finding the definition easier. 3420 if (ObjCInterfaceDecl *Class 3421 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext())) 3422 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation()) 3423 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(), 3424 Method->isInstanceMethod())) 3425 if (Def->isThisDeclarationADefinition()) 3426 return MakeCXCursor(Def, CXXUnit); 3427 3428 return clang_getNullCursor(); 3429 } 3430 3431 case Decl::ObjCCategory: 3432 if (ObjCCategoryImplDecl *Impl 3433 = cast<ObjCCategoryDecl>(D)->getImplementation()) 3434 return MakeCXCursor(Impl, CXXUnit); 3435 return clang_getNullCursor(); 3436 3437 case Decl::ObjCProtocol: 3438 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl()) 3439 return C; 3440 return clang_getNullCursor(); 3441 3442 case Decl::ObjCInterface: 3443 // There are two notions of a "definition" for an Objective-C 3444 // class: the interface and its implementation. When we resolved a 3445 // reference to an Objective-C class, produce the @interface as 3446 // the definition; when we were provided with the interface, 3447 // produce the @implementation as the definition. 3448 if (WasReference) { 3449 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl()) 3450 return C; 3451 } else if (ObjCImplementationDecl *Impl 3452 = cast<ObjCInterfaceDecl>(D)->getImplementation()) 3453 return MakeCXCursor(Impl, CXXUnit); 3454 return clang_getNullCursor(); 3455 3456 case Decl::ObjCProperty: 3457 // FIXME: We don't really know where to find the 3458 // ObjCPropertyImplDecls that implement this property. 3459 return clang_getNullCursor(); 3460 3461 case Decl::ObjCCompatibleAlias: 3462 if (ObjCInterfaceDecl *Class 3463 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface()) 3464 if (!Class->isForwardDecl()) 3465 return MakeCXCursor(Class, CXXUnit); 3466 3467 return clang_getNullCursor(); 3468 3469 case Decl::ObjCForwardProtocol: 3470 return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D), 3471 D->getLocation(), CXXUnit); 3472 3473 case Decl::ObjCClass: 3474 return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(), 3475 CXXUnit); 3476 3477 case Decl::Friend: 3478 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl()) 3479 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit)); 3480 return clang_getNullCursor(); 3481 3482 case Decl::FriendTemplate: 3483 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl()) 3484 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit)); 3485 return clang_getNullCursor(); 3486 } 3487 3488 return clang_getNullCursor(); 3489} 3490 3491unsigned clang_isCursorDefinition(CXCursor C) { 3492 if (!clang_isDeclaration(C.kind)) 3493 return 0; 3494 3495 return clang_getCursorDefinition(C) == C; 3496} 3497 3498unsigned clang_getNumOverloadedDecls(CXCursor C) { 3499 if (C.kind != CXCursor_OverloadedDeclRef) 3500 return 0; 3501 3502 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first; 3503 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>()) 3504 return E->getNumDecls(); 3505 3506 if (OverloadedTemplateStorage *S 3507 = Storage.dyn_cast<OverloadedTemplateStorage*>()) 3508 return S->size(); 3509 3510 Decl *D = Storage.get<Decl*>(); 3511 if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) 3512 return Using->getNumShadowDecls(); 3513 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D)) 3514 return Classes->size(); 3515 if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D)) 3516 return Protocols->protocol_size(); 3517 3518 return 0; 3519} 3520 3521CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) { 3522 if (cursor.kind != CXCursor_OverloadedDeclRef) 3523 return clang_getNullCursor(); 3524 3525 if (index >= clang_getNumOverloadedDecls(cursor)) 3526 return clang_getNullCursor(); 3527 3528 ASTUnit *Unit = getCursorASTUnit(cursor); 3529 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first; 3530 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>()) 3531 return MakeCXCursor(E->decls_begin()[index], Unit); 3532 3533 if (OverloadedTemplateStorage *S 3534 = Storage.dyn_cast<OverloadedTemplateStorage*>()) 3535 return MakeCXCursor(S->begin()[index], Unit); 3536 3537 Decl *D = Storage.get<Decl*>(); 3538 if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) { 3539 // FIXME: This is, unfortunately, linear time. 3540 UsingDecl::shadow_iterator Pos = Using->shadow_begin(); 3541 std::advance(Pos, index); 3542 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), Unit); 3543 } 3544 3545 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D)) 3546 return MakeCXCursor(Classes->begin()[index].getInterface(), Unit); 3547 3548 if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D)) 3549 return MakeCXCursor(Protocols->protocol_begin()[index], Unit); 3550 3551 return clang_getNullCursor(); 3552} 3553 3554void clang_getDefinitionSpellingAndExtent(CXCursor C, 3555 const char **startBuf, 3556 const char **endBuf, 3557 unsigned *startLine, 3558 unsigned *startColumn, 3559 unsigned *endLine, 3560 unsigned *endColumn) { 3561 assert(getCursorDecl(C) && "CXCursor has null decl"); 3562 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C)); 3563 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND); 3564 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody()); 3565 3566 SourceManager &SM = FD->getASTContext().getSourceManager(); 3567 *startBuf = SM.getCharacterData(Body->getLBracLoc()); 3568 *endBuf = SM.getCharacterData(Body->getRBracLoc()); 3569 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc()); 3570 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc()); 3571 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc()); 3572 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc()); 3573} 3574 3575void clang_enableStackTraces(void) { 3576 llvm::sys::PrintStackTraceOnErrorSignal(); 3577} 3578 3579void clang_executeOnThread(void (*fn)(void*), void *user_data, 3580 unsigned stack_size) { 3581 llvm::llvm_execute_on_thread(fn, user_data, stack_size); 3582} 3583 3584} // end: extern "C" 3585 3586//===----------------------------------------------------------------------===// 3587// Token-based Operations. 3588//===----------------------------------------------------------------------===// 3589 3590/* CXToken layout: 3591 * int_data[0]: a CXTokenKind 3592 * int_data[1]: starting token location 3593 * int_data[2]: token length 3594 * int_data[3]: reserved 3595 * ptr_data: for identifiers and keywords, an IdentifierInfo*. 3596 * otherwise unused. 3597 */ 3598extern "C" { 3599 3600CXTokenKind clang_getTokenKind(CXToken CXTok) { 3601 return static_cast<CXTokenKind>(CXTok.int_data[0]); 3602} 3603 3604CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) { 3605 switch (clang_getTokenKind(CXTok)) { 3606 case CXToken_Identifier: 3607 case CXToken_Keyword: 3608 // We know we have an IdentifierInfo*, so use that. 3609 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data) 3610 ->getNameStart()); 3611 3612 case CXToken_Literal: { 3613 // We have stashed the starting pointer in the ptr_data field. Use it. 3614 const char *Text = static_cast<const char *>(CXTok.ptr_data); 3615 return createCXString(llvm::StringRef(Text, CXTok.int_data[2])); 3616 } 3617 3618 case CXToken_Punctuation: 3619 case CXToken_Comment: 3620 break; 3621 } 3622 3623 // We have to find the starting buffer pointer the hard way, by 3624 // deconstructing the source location. 3625 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 3626 if (!CXXUnit) 3627 return createCXString(""); 3628 3629 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]); 3630 std::pair<FileID, unsigned> LocInfo 3631 = CXXUnit->getSourceManager().getDecomposedLoc(Loc); 3632 bool Invalid = false; 3633 llvm::StringRef Buffer 3634 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid); 3635 if (Invalid) 3636 return createCXString(""); 3637 3638 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2])); 3639} 3640 3641CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) { 3642 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 3643 if (!CXXUnit) 3644 return clang_getNullLocation(); 3645 3646 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), 3647 SourceLocation::getFromRawEncoding(CXTok.int_data[1])); 3648} 3649 3650CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) { 3651 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 3652 if (!CXXUnit) 3653 return clang_getNullRange(); 3654 3655 return cxloc::translateSourceRange(CXXUnit->getASTContext(), 3656 SourceLocation::getFromRawEncoding(CXTok.int_data[1])); 3657} 3658 3659void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 3660 CXToken **Tokens, unsigned *NumTokens) { 3661 if (Tokens) 3662 *Tokens = 0; 3663 if (NumTokens) 3664 *NumTokens = 0; 3665 3666 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 3667 if (!CXXUnit || !Tokens || !NumTokens) 3668 return; 3669 3670 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 3671 3672 SourceRange R = cxloc::translateCXSourceRange(Range); 3673 if (R.isInvalid()) 3674 return; 3675 3676 SourceManager &SourceMgr = CXXUnit->getSourceManager(); 3677 std::pair<FileID, unsigned> BeginLocInfo 3678 = SourceMgr.getDecomposedLoc(R.getBegin()); 3679 std::pair<FileID, unsigned> EndLocInfo 3680 = SourceMgr.getDecomposedLoc(R.getEnd()); 3681 3682 // Cannot tokenize across files. 3683 if (BeginLocInfo.first != EndLocInfo.first) 3684 return; 3685 3686 // Create a lexer 3687 bool Invalid = false; 3688 llvm::StringRef Buffer 3689 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid); 3690 if (Invalid) 3691 return; 3692 3693 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first), 3694 CXXUnit->getASTContext().getLangOptions(), 3695 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end()); 3696 Lex.SetCommentRetentionState(true); 3697 3698 // Lex tokens until we hit the end of the range. 3699 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second; 3700 llvm::SmallVector<CXToken, 32> CXTokens; 3701 Token Tok; 3702 bool previousWasAt = false; 3703 do { 3704 // Lex the next token 3705 Lex.LexFromRawLexer(Tok); 3706 if (Tok.is(tok::eof)) 3707 break; 3708 3709 // Initialize the CXToken. 3710 CXToken CXTok; 3711 3712 // - Common fields 3713 CXTok.int_data[1] = Tok.getLocation().getRawEncoding(); 3714 CXTok.int_data[2] = Tok.getLength(); 3715 CXTok.int_data[3] = 0; 3716 3717 // - Kind-specific fields 3718 if (Tok.isLiteral()) { 3719 CXTok.int_data[0] = CXToken_Literal; 3720 CXTok.ptr_data = (void *)Tok.getLiteralData(); 3721 } else if (Tok.is(tok::identifier)) { 3722 // Lookup the identifier to determine whether we have a keyword. 3723 std::pair<FileID, unsigned> LocInfo 3724 = SourceMgr.getDecomposedLoc(Tok.getLocation()); 3725 bool Invalid = false; 3726 llvm::StringRef Buf 3727 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid); 3728 if (Invalid) 3729 return; 3730 3731 const char *StartPos = Buf.data() + LocInfo.second; 3732 IdentifierInfo *II 3733 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos); 3734 3735 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) { 3736 CXTok.int_data[0] = CXToken_Keyword; 3737 } 3738 else { 3739 CXTok.int_data[0] = II->getTokenID() == tok::identifier? 3740 CXToken_Identifier 3741 : CXToken_Keyword; 3742 } 3743 CXTok.ptr_data = II; 3744 } else if (Tok.is(tok::comment)) { 3745 CXTok.int_data[0] = CXToken_Comment; 3746 CXTok.ptr_data = 0; 3747 } else { 3748 CXTok.int_data[0] = CXToken_Punctuation; 3749 CXTok.ptr_data = 0; 3750 } 3751 CXTokens.push_back(CXTok); 3752 previousWasAt = Tok.is(tok::at); 3753 } while (Lex.getBufferLocation() <= EffectiveBufferEnd); 3754 3755 if (CXTokens.empty()) 3756 return; 3757 3758 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size()); 3759 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size()); 3760 *NumTokens = CXTokens.size(); 3761} 3762 3763void clang_disposeTokens(CXTranslationUnit TU, 3764 CXToken *Tokens, unsigned NumTokens) { 3765 free(Tokens); 3766} 3767 3768} // end: extern "C" 3769 3770//===----------------------------------------------------------------------===// 3771// Token annotation APIs. 3772//===----------------------------------------------------------------------===// 3773 3774typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData; 3775static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor, 3776 CXCursor parent, 3777 CXClientData client_data); 3778namespace { 3779class AnnotateTokensWorker { 3780 AnnotateTokensData &Annotated; 3781 CXToken *Tokens; 3782 CXCursor *Cursors; 3783 unsigned NumTokens; 3784 unsigned TokIdx; 3785 unsigned PreprocessingTokIdx; 3786 CursorVisitor AnnotateVis; 3787 SourceManager &SrcMgr; 3788 3789 bool MoreTokens() const { return TokIdx < NumTokens; } 3790 unsigned NextToken() const { return TokIdx; } 3791 void AdvanceToken() { ++TokIdx; } 3792 SourceLocation GetTokenLoc(unsigned tokI) { 3793 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]); 3794 } 3795 3796public: 3797 AnnotateTokensWorker(AnnotateTokensData &annotated, 3798 CXToken *tokens, CXCursor *cursors, unsigned numTokens, 3799 ASTUnit *CXXUnit, SourceRange RegionOfInterest) 3800 : Annotated(annotated), Tokens(tokens), Cursors(cursors), 3801 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0), 3802 AnnotateVis(CXXUnit, AnnotateTokensVisitor, this, 3803 Decl::MaxPCHLevel, RegionOfInterest), 3804 SrcMgr(CXXUnit->getSourceManager()) {} 3805 3806 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); } 3807 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent); 3808 void AnnotateTokens(CXCursor parent); 3809}; 3810} 3811 3812void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) { 3813 // Walk the AST within the region of interest, annotating tokens 3814 // along the way. 3815 VisitChildren(parent); 3816 3817 for (unsigned I = 0 ; I < TokIdx ; ++I) { 3818 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]); 3819 if (Pos != Annotated.end() && 3820 (clang_isInvalid(Cursors[I].kind) || 3821 Pos->second.kind != CXCursor_PreprocessingDirective)) 3822 Cursors[I] = Pos->second; 3823 } 3824 3825 // Finish up annotating any tokens left. 3826 if (!MoreTokens()) 3827 return; 3828 3829 const CXCursor &C = clang_getNullCursor(); 3830 for (unsigned I = TokIdx ; I < NumTokens ; ++I) { 3831 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]); 3832 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second; 3833 } 3834} 3835 3836enum CXChildVisitResult 3837AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) { 3838 CXSourceLocation Loc = clang_getCursorLocation(cursor); 3839 SourceRange cursorRange = getRawCursorExtent(cursor); 3840 if (cursorRange.isInvalid()) 3841 return CXChildVisit_Recurse; 3842 3843 if (clang_isPreprocessing(cursor.kind)) { 3844 // For macro instantiations, just note where the beginning of the macro 3845 // instantiation occurs. 3846 if (cursor.kind == CXCursor_MacroInstantiation) { 3847 Annotated[Loc.int_data] = cursor; 3848 return CXChildVisit_Recurse; 3849 } 3850 3851 // Items in the preprocessing record are kept separate from items in 3852 // declarations, so we keep a separate token index. 3853 unsigned SavedTokIdx = TokIdx; 3854 TokIdx = PreprocessingTokIdx; 3855 3856 // Skip tokens up until we catch up to the beginning of the preprocessing 3857 // entry. 3858 while (MoreTokens()) { 3859 const unsigned I = NextToken(); 3860 SourceLocation TokLoc = GetTokenLoc(I); 3861 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) { 3862 case RangeBefore: 3863 AdvanceToken(); 3864 continue; 3865 case RangeAfter: 3866 case RangeOverlap: 3867 break; 3868 } 3869 break; 3870 } 3871 3872 // Look at all of the tokens within this range. 3873 while (MoreTokens()) { 3874 const unsigned I = NextToken(); 3875 SourceLocation TokLoc = GetTokenLoc(I); 3876 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) { 3877 case RangeBefore: 3878 assert(0 && "Infeasible"); 3879 case RangeAfter: 3880 break; 3881 case RangeOverlap: 3882 Cursors[I] = cursor; 3883 AdvanceToken(); 3884 continue; 3885 } 3886 break; 3887 } 3888 3889 // Save the preprocessing token index; restore the non-preprocessing 3890 // token index. 3891 PreprocessingTokIdx = TokIdx; 3892 TokIdx = SavedTokIdx; 3893 return CXChildVisit_Recurse; 3894 } 3895 3896 if (cursorRange.isInvalid()) 3897 return CXChildVisit_Continue; 3898 3899 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data); 3900 3901 // Adjust the annotated range based specific declarations. 3902 const enum CXCursorKind cursorK = clang_getCursorKind(cursor); 3903 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) { 3904 Decl *D = cxcursor::getCursorDecl(cursor); 3905 // Don't visit synthesized ObjC methods, since they have no syntatic 3906 // representation in the source. 3907 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 3908 if (MD->isSynthesized()) 3909 return CXChildVisit_Continue; 3910 } 3911 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) { 3912 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) { 3913 TypeLoc TL = TI->getTypeLoc(); 3914 SourceLocation TLoc = TL.getSourceRange().getBegin(); 3915 if (TLoc.isValid() && L.isValid() && 3916 SrcMgr.isBeforeInTranslationUnit(TLoc, L)) 3917 cursorRange.setBegin(TLoc); 3918 } 3919 } 3920 } 3921 3922 // If the location of the cursor occurs within a macro instantiation, record 3923 // the spelling location of the cursor in our annotation map. We can then 3924 // paper over the token labelings during a post-processing step to try and 3925 // get cursor mappings for tokens that are the *arguments* of a macro 3926 // instantiation. 3927 if (L.isMacroID()) { 3928 unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding(); 3929 // Only invalidate the old annotation if it isn't part of a preprocessing 3930 // directive. Here we assume that the default construction of CXCursor 3931 // results in CXCursor.kind being an initialized value (i.e., 0). If 3932 // this isn't the case, we can fix by doing lookup + insertion. 3933 3934 CXCursor &oldC = Annotated[rawEncoding]; 3935 if (!clang_isPreprocessing(oldC.kind)) 3936 oldC = cursor; 3937 } 3938 3939 const enum CXCursorKind K = clang_getCursorKind(parent); 3940 const CXCursor updateC = 3941 (clang_isInvalid(K) || K == CXCursor_TranslationUnit) 3942 ? clang_getNullCursor() : parent; 3943 3944 while (MoreTokens()) { 3945 const unsigned I = NextToken(); 3946 SourceLocation TokLoc = GetTokenLoc(I); 3947 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) { 3948 case RangeBefore: 3949 Cursors[I] = updateC; 3950 AdvanceToken(); 3951 continue; 3952 case RangeAfter: 3953 case RangeOverlap: 3954 break; 3955 } 3956 break; 3957 } 3958 3959 // Visit children to get their cursor information. 3960 const unsigned BeforeChildren = NextToken(); 3961 VisitChildren(cursor); 3962 const unsigned AfterChildren = NextToken(); 3963 3964 // Adjust 'Last' to the last token within the extent of the cursor. 3965 while (MoreTokens()) { 3966 const unsigned I = NextToken(); 3967 SourceLocation TokLoc = GetTokenLoc(I); 3968 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) { 3969 case RangeBefore: 3970 assert(0 && "Infeasible"); 3971 case RangeAfter: 3972 break; 3973 case RangeOverlap: 3974 Cursors[I] = updateC; 3975 AdvanceToken(); 3976 continue; 3977 } 3978 break; 3979 } 3980 const unsigned Last = NextToken(); 3981 3982 // Scan the tokens that are at the beginning of the cursor, but are not 3983 // capture by the child cursors. 3984 3985 // For AST elements within macros, rely on a post-annotate pass to 3986 // to correctly annotate the tokens with cursors. Otherwise we can 3987 // get confusing results of having tokens that map to cursors that really 3988 // are expanded by an instantiation. 3989 if (L.isMacroID()) 3990 cursor = clang_getNullCursor(); 3991 3992 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) { 3993 if (!clang_isInvalid(clang_getCursorKind(Cursors[I]))) 3994 break; 3995 3996 Cursors[I] = cursor; 3997 } 3998 // Scan the tokens that are at the end of the cursor, but are not captured 3999 // but the child cursors. 4000 for (unsigned I = AfterChildren; I != Last; ++I) 4001 Cursors[I] = cursor; 4002 4003 TokIdx = Last; 4004 return CXChildVisit_Continue; 4005} 4006 4007static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor, 4008 CXCursor parent, 4009 CXClientData client_data) { 4010 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent); 4011} 4012 4013extern "C" { 4014 4015void clang_annotateTokens(CXTranslationUnit TU, 4016 CXToken *Tokens, unsigned NumTokens, 4017 CXCursor *Cursors) { 4018 4019 if (NumTokens == 0 || !Tokens || !Cursors) 4020 return; 4021 4022 // Any token we don't specifically annotate will have a NULL cursor. 4023 CXCursor C = clang_getNullCursor(); 4024 for (unsigned I = 0; I != NumTokens; ++I) 4025 Cursors[I] = C; 4026 4027 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 4028 if (!CXXUnit) 4029 return; 4030 4031 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 4032 4033 // Determine the region of interest, which contains all of the tokens. 4034 SourceRange RegionOfInterest; 4035 RegionOfInterest.setBegin(cxloc::translateSourceLocation( 4036 clang_getTokenLocation(TU, Tokens[0]))); 4037 RegionOfInterest.setEnd(cxloc::translateSourceLocation( 4038 clang_getTokenLocation(TU, 4039 Tokens[NumTokens - 1]))); 4040 4041 // A mapping from the source locations found when re-lexing or traversing the 4042 // region of interest to the corresponding cursors. 4043 AnnotateTokensData Annotated; 4044 4045 // Relex the tokens within the source range to look for preprocessing 4046 // directives. 4047 SourceManager &SourceMgr = CXXUnit->getSourceManager(); 4048 std::pair<FileID, unsigned> BeginLocInfo 4049 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin()); 4050 std::pair<FileID, unsigned> EndLocInfo 4051 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd()); 4052 4053 llvm::StringRef Buffer; 4054 bool Invalid = false; 4055 if (BeginLocInfo.first == EndLocInfo.first && 4056 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) && 4057 !Invalid) { 4058 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first), 4059 CXXUnit->getASTContext().getLangOptions(), 4060 Buffer.begin(), Buffer.data() + BeginLocInfo.second, 4061 Buffer.end()); 4062 Lex.SetCommentRetentionState(true); 4063 4064 // Lex tokens in raw mode until we hit the end of the range, to avoid 4065 // entering #includes or expanding macros. 4066 while (true) { 4067 Token Tok; 4068 Lex.LexFromRawLexer(Tok); 4069 4070 reprocess: 4071 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) { 4072 // We have found a preprocessing directive. Gobble it up so that we 4073 // don't see it while preprocessing these tokens later, but keep track 4074 // of all of the token locations inside this preprocessing directive so 4075 // that we can annotate them appropriately. 4076 // 4077 // FIXME: Some simple tests here could identify macro definitions and 4078 // #undefs, to provide specific cursor kinds for those. 4079 std::vector<SourceLocation> Locations; 4080 do { 4081 Locations.push_back(Tok.getLocation()); 4082 Lex.LexFromRawLexer(Tok); 4083 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof)); 4084 4085 using namespace cxcursor; 4086 CXCursor Cursor 4087 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(), 4088 Locations.back()), 4089 CXXUnit); 4090 for (unsigned I = 0, N = Locations.size(); I != N; ++I) { 4091 Annotated[Locations[I].getRawEncoding()] = Cursor; 4092 } 4093 4094 if (Tok.isAtStartOfLine()) 4095 goto reprocess; 4096 4097 continue; 4098 } 4099 4100 if (Tok.is(tok::eof)) 4101 break; 4102 } 4103 } 4104 4105 // Annotate all of the source locations in the region of interest that map to 4106 // a specific cursor. 4107 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens, 4108 CXXUnit, RegionOfInterest); 4109 W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit)); 4110} 4111} // end: extern "C" 4112 4113//===----------------------------------------------------------------------===// 4114// Operations for querying linkage of a cursor. 4115//===----------------------------------------------------------------------===// 4116 4117extern "C" { 4118CXLinkageKind clang_getCursorLinkage(CXCursor cursor) { 4119 if (!clang_isDeclaration(cursor.kind)) 4120 return CXLinkage_Invalid; 4121 4122 Decl *D = cxcursor::getCursorDecl(cursor); 4123 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D)) 4124 switch (ND->getLinkage()) { 4125 case NoLinkage: return CXLinkage_NoLinkage; 4126 case InternalLinkage: return CXLinkage_Internal; 4127 case UniqueExternalLinkage: return CXLinkage_UniqueExternal; 4128 case ExternalLinkage: return CXLinkage_External; 4129 }; 4130 4131 return CXLinkage_Invalid; 4132} 4133} // end: extern "C" 4134 4135//===----------------------------------------------------------------------===// 4136// Operations for querying language of a cursor. 4137//===----------------------------------------------------------------------===// 4138 4139static CXLanguageKind getDeclLanguage(const Decl *D) { 4140 switch (D->getKind()) { 4141 default: 4142 break; 4143 case Decl::ImplicitParam: 4144 case Decl::ObjCAtDefsField: 4145 case Decl::ObjCCategory: 4146 case Decl::ObjCCategoryImpl: 4147 case Decl::ObjCClass: 4148 case Decl::ObjCCompatibleAlias: 4149 case Decl::ObjCForwardProtocol: 4150 case Decl::ObjCImplementation: 4151 case Decl::ObjCInterface: 4152 case Decl::ObjCIvar: 4153 case Decl::ObjCMethod: 4154 case Decl::ObjCProperty: 4155 case Decl::ObjCPropertyImpl: 4156 case Decl::ObjCProtocol: 4157 return CXLanguage_ObjC; 4158 case Decl::CXXConstructor: 4159 case Decl::CXXConversion: 4160 case Decl::CXXDestructor: 4161 case Decl::CXXMethod: 4162 case Decl::CXXRecord: 4163 case Decl::ClassTemplate: 4164 case Decl::ClassTemplatePartialSpecialization: 4165 case Decl::ClassTemplateSpecialization: 4166 case Decl::Friend: 4167 case Decl::FriendTemplate: 4168 case Decl::FunctionTemplate: 4169 case Decl::LinkageSpec: 4170 case Decl::Namespace: 4171 case Decl::NamespaceAlias: 4172 case Decl::NonTypeTemplateParm: 4173 case Decl::StaticAssert: 4174 case Decl::TemplateTemplateParm: 4175 case Decl::TemplateTypeParm: 4176 case Decl::UnresolvedUsingTypename: 4177 case Decl::UnresolvedUsingValue: 4178 case Decl::Using: 4179 case Decl::UsingDirective: 4180 case Decl::UsingShadow: 4181 return CXLanguage_CPlusPlus; 4182 } 4183 4184 return CXLanguage_C; 4185} 4186 4187extern "C" { 4188 4189enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) { 4190 if (clang_isDeclaration(cursor.kind)) 4191 if (Decl *D = cxcursor::getCursorDecl(cursor)) { 4192 if (D->hasAttr<UnavailableAttr>() || 4193 (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())) 4194 return CXAvailability_Available; 4195 4196 if (D->hasAttr<DeprecatedAttr>()) 4197 return CXAvailability_Deprecated; 4198 } 4199 4200 return CXAvailability_Available; 4201} 4202 4203CXLanguageKind clang_getCursorLanguage(CXCursor cursor) { 4204 if (clang_isDeclaration(cursor.kind)) 4205 return getDeclLanguage(cxcursor::getCursorDecl(cursor)); 4206 4207 return CXLanguage_Invalid; 4208} 4209 4210CXCursor clang_getCursorSemanticParent(CXCursor cursor) { 4211 if (clang_isDeclaration(cursor.kind)) { 4212 if (Decl *D = getCursorDecl(cursor)) { 4213 DeclContext *DC = D->getDeclContext(); 4214 return MakeCXCursor(cast<Decl>(DC), getCursorASTUnit(cursor)); 4215 } 4216 } 4217 4218 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) { 4219 if (Decl *D = getCursorDecl(cursor)) 4220 return MakeCXCursor(D, getCursorASTUnit(cursor)); 4221 } 4222 4223 return clang_getNullCursor(); 4224} 4225 4226CXCursor clang_getCursorLexicalParent(CXCursor cursor) { 4227 if (clang_isDeclaration(cursor.kind)) { 4228 if (Decl *D = getCursorDecl(cursor)) { 4229 DeclContext *DC = D->getLexicalDeclContext(); 4230 return MakeCXCursor(cast<Decl>(DC), getCursorASTUnit(cursor)); 4231 } 4232 } 4233 4234 // FIXME: Note that we can't easily compute the lexical context of a 4235 // statement or expression, so we return nothing. 4236 return clang_getNullCursor(); 4237} 4238 4239static void CollectOverriddenMethods(DeclContext *Ctx, 4240 ObjCMethodDecl *Method, 4241 llvm::SmallVectorImpl<ObjCMethodDecl *> &Methods) { 4242 if (!Ctx) 4243 return; 4244 4245 // If we have a class or category implementation, jump straight to the 4246 // interface. 4247 if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx)) 4248 return CollectOverriddenMethods(Impl->getClassInterface(), Method, Methods); 4249 4250 ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx); 4251 if (!Container) 4252 return; 4253 4254 // Check whether we have a matching method at this level. 4255 if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(), 4256 Method->isInstanceMethod())) 4257 if (Method != Overridden) { 4258 // We found an override at this level; there is no need to look 4259 // into other protocols or categories. 4260 Methods.push_back(Overridden); 4261 return; 4262 } 4263 4264 if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) { 4265 for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(), 4266 PEnd = Protocol->protocol_end(); 4267 P != PEnd; ++P) 4268 CollectOverriddenMethods(*P, Method, Methods); 4269 } 4270 4271 if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) { 4272 for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(), 4273 PEnd = Category->protocol_end(); 4274 P != PEnd; ++P) 4275 CollectOverriddenMethods(*P, Method, Methods); 4276 } 4277 4278 if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) { 4279 for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(), 4280 PEnd = Interface->protocol_end(); 4281 P != PEnd; ++P) 4282 CollectOverriddenMethods(*P, Method, Methods); 4283 4284 for (ObjCCategoryDecl *Category = Interface->getCategoryList(); 4285 Category; Category = Category->getNextClassCategory()) 4286 CollectOverriddenMethods(Category, Method, Methods); 4287 4288 // We only look into the superclass if we haven't found anything yet. 4289 if (Methods.empty()) 4290 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) 4291 return CollectOverriddenMethods(Super, Method, Methods); 4292 } 4293} 4294 4295void clang_getOverriddenCursors(CXCursor cursor, 4296 CXCursor **overridden, 4297 unsigned *num_overridden) { 4298 if (overridden) 4299 *overridden = 0; 4300 if (num_overridden) 4301 *num_overridden = 0; 4302 if (!overridden || !num_overridden) 4303 return; 4304 4305 if (!clang_isDeclaration(cursor.kind)) 4306 return; 4307 4308 Decl *D = getCursorDecl(cursor); 4309 if (!D) 4310 return; 4311 4312 // Handle C++ member functions. 4313 ASTUnit *CXXUnit = getCursorASTUnit(cursor); 4314 if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) { 4315 *num_overridden = CXXMethod->size_overridden_methods(); 4316 if (!*num_overridden) 4317 return; 4318 4319 *overridden = new CXCursor [*num_overridden]; 4320 unsigned I = 0; 4321 for (CXXMethodDecl::method_iterator 4322 M = CXXMethod->begin_overridden_methods(), 4323 MEnd = CXXMethod->end_overridden_methods(); 4324 M != MEnd; (void)++M, ++I) 4325 (*overridden)[I] = MakeCXCursor(const_cast<CXXMethodDecl*>(*M), CXXUnit); 4326 return; 4327 } 4328 4329 ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D); 4330 if (!Method) 4331 return; 4332 4333 // Handle Objective-C methods. 4334 llvm::SmallVector<ObjCMethodDecl *, 4> Methods; 4335 CollectOverriddenMethods(Method->getDeclContext(), Method, Methods); 4336 4337 if (Methods.empty()) 4338 return; 4339 4340 *num_overridden = Methods.size(); 4341 *overridden = new CXCursor [Methods.size()]; 4342 for (unsigned I = 0, N = Methods.size(); I != N; ++I) 4343 (*overridden)[I] = MakeCXCursor(Methods[I], CXXUnit); 4344} 4345 4346void clang_disposeOverriddenCursors(CXCursor *overridden) { 4347 delete [] overridden; 4348} 4349 4350CXFile clang_getIncludedFile(CXCursor cursor) { 4351 if (cursor.kind != CXCursor_InclusionDirective) 4352 return 0; 4353 4354 InclusionDirective *ID = getCursorInclusionDirective(cursor); 4355 return (void *)ID->getFile(); 4356} 4357 4358} // end: extern "C" 4359 4360 4361//===----------------------------------------------------------------------===// 4362// C++ AST instrospection. 4363//===----------------------------------------------------------------------===// 4364 4365extern "C" { 4366unsigned clang_CXXMethod_isStatic(CXCursor C) { 4367 if (!clang_isDeclaration(C.kind)) 4368 return 0; 4369 4370 CXXMethodDecl *Method = 0; 4371 Decl *D = cxcursor::getCursorDecl(C); 4372 if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D)) 4373 Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl()); 4374 else 4375 Method = dyn_cast_or_null<CXXMethodDecl>(D); 4376 return (Method && Method->isStatic()) ? 1 : 0; 4377} 4378 4379} // end: extern "C" 4380 4381//===----------------------------------------------------------------------===// 4382// Attribute introspection. 4383//===----------------------------------------------------------------------===// 4384 4385extern "C" { 4386CXType clang_getIBOutletCollectionType(CXCursor C) { 4387 if (C.kind != CXCursor_IBOutletCollectionAttr) 4388 return cxtype::MakeCXType(QualType(), cxcursor::getCursorASTUnit(C)); 4389 4390 IBOutletCollectionAttr *A = 4391 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C)); 4392 4393 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorASTUnit(C)); 4394} 4395} // end: extern "C" 4396 4397//===----------------------------------------------------------------------===// 4398// CXString Operations. 4399//===----------------------------------------------------------------------===// 4400 4401extern "C" { 4402const char *clang_getCString(CXString string) { 4403 return string.Spelling; 4404} 4405 4406void clang_disposeString(CXString string) { 4407 if (string.MustFreeString && string.Spelling) 4408 free((void*)string.Spelling); 4409} 4410 4411} // end: extern "C" 4412 4413namespace clang { namespace cxstring { 4414CXString createCXString(const char *String, bool DupString){ 4415 CXString Str; 4416 if (DupString) { 4417 Str.Spelling = strdup(String); 4418 Str.MustFreeString = 1; 4419 } else { 4420 Str.Spelling = String; 4421 Str.MustFreeString = 0; 4422 } 4423 return Str; 4424} 4425 4426CXString createCXString(llvm::StringRef String, bool DupString) { 4427 CXString Result; 4428 if (DupString || (!String.empty() && String.data()[String.size()] != 0)) { 4429 char *Spelling = (char *)malloc(String.size() + 1); 4430 memmove(Spelling, String.data(), String.size()); 4431 Spelling[String.size()] = 0; 4432 Result.Spelling = Spelling; 4433 Result.MustFreeString = 1; 4434 } else { 4435 Result.Spelling = String.data(); 4436 Result.MustFreeString = 0; 4437 } 4438 return Result; 4439} 4440}} 4441 4442//===----------------------------------------------------------------------===// 4443// Misc. utility functions. 4444//===----------------------------------------------------------------------===// 4445 4446/// Default to using an 8 MB stack size on "safety" threads. 4447static unsigned SafetyStackThreadSize = 8 << 20; 4448 4449namespace clang { 4450 4451bool RunSafely(llvm::CrashRecoveryContext &CRC, 4452 void (*Fn)(void*), void *UserData) { 4453 if (unsigned Size = GetSafetyThreadStackSize()) 4454 return CRC.RunSafelyOnThread(Fn, UserData, Size); 4455 return CRC.RunSafely(Fn, UserData); 4456} 4457 4458unsigned GetSafetyThreadStackSize() { 4459 return SafetyStackThreadSize; 4460} 4461 4462void SetSafetyThreadStackSize(unsigned Value) { 4463 SafetyStackThreadSize = Value; 4464} 4465 4466} 4467 4468extern "C" { 4469 4470CXString clang_getClangVersion() { 4471 return createCXString(getClangFullVersion()); 4472} 4473 4474} // end: extern "C" 4475