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