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