CIndex.cpp revision 1a9a0bc472ee4fec72ee8be8b575fb66ca600d1b
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 "CXSourceLocation.h" 18#include "CIndexDiagnostic.h" 19 20#include "clang/Basic/Version.h" 21 22#include "clang/AST/DeclVisitor.h" 23#include "clang/AST/StmtVisitor.h" 24#include "clang/AST/TypeLocVisitor.h" 25#include "clang/Basic/Diagnostic.h" 26#include "clang/Frontend/ASTUnit.h" 27#include "clang/Frontend/CompilerInstance.h" 28#include "clang/Frontend/FrontendDiagnostic.h" 29#include "clang/Lex/Lexer.h" 30#include "clang/Lex/PreprocessingRecord.h" 31#include "clang/Lex/Preprocessor.h" 32#include "llvm/Support/MemoryBuffer.h" 33#include "llvm/System/Program.h" 34#include "llvm/System/Signals.h" 35 36// Needed to define L_TMPNAM on some systems. 37#include <cstdio> 38 39using namespace clang; 40using namespace clang::cxcursor; 41using namespace clang::cxstring; 42 43//===----------------------------------------------------------------------===// 44// Crash Reporting. 45//===----------------------------------------------------------------------===// 46 47#ifdef USE_CRASHTRACER 48#include "clang/Analysis/Support/SaveAndRestore.h" 49// Integrate with crash reporter. 50static const char *__crashreporter_info__ = 0; 51asm(".desc ___crashreporter_info__, 0x10"); 52#define NUM_CRASH_STRINGS 32 53static unsigned crashtracer_counter = 0; 54static unsigned crashtracer_counter_id[NUM_CRASH_STRINGS] = { 0 }; 55static const char *crashtracer_strings[NUM_CRASH_STRINGS] = { 0 }; 56static const char *agg_crashtracer_strings[NUM_CRASH_STRINGS] = { 0 }; 57 58static unsigned SetCrashTracerInfo(const char *str, 59 llvm::SmallString<1024> &AggStr) { 60 61 unsigned slot = 0; 62 while (crashtracer_strings[slot]) { 63 if (++slot == NUM_CRASH_STRINGS) 64 slot = 0; 65 } 66 crashtracer_strings[slot] = str; 67 crashtracer_counter_id[slot] = ++crashtracer_counter; 68 69 // We need to create an aggregate string because multiple threads 70 // may be in this method at one time. The crash reporter string 71 // will attempt to overapproximate the set of in-flight invocations 72 // of this function. Race conditions can still cause this goal 73 // to not be achieved. 74 { 75 llvm::raw_svector_ostream Out(AggStr); 76 for (unsigned i = 0; i < NUM_CRASH_STRINGS; ++i) 77 if (crashtracer_strings[i]) Out << crashtracer_strings[i] << '\n'; 78 } 79 __crashreporter_info__ = agg_crashtracer_strings[slot] = AggStr.c_str(); 80 return slot; 81} 82 83static void ResetCrashTracerInfo(unsigned slot) { 84 unsigned max_slot = 0; 85 unsigned max_value = 0; 86 87 crashtracer_strings[slot] = agg_crashtracer_strings[slot] = 0; 88 89 for (unsigned i = 0 ; i < NUM_CRASH_STRINGS; ++i) 90 if (agg_crashtracer_strings[i] && 91 crashtracer_counter_id[i] > max_value) { 92 max_slot = i; 93 max_value = crashtracer_counter_id[i]; 94 } 95 96 __crashreporter_info__ = agg_crashtracer_strings[max_slot]; 97} 98 99namespace { 100class ArgsCrashTracerInfo { 101 llvm::SmallString<1024> CrashString; 102 llvm::SmallString<1024> AggregateString; 103 unsigned crashtracerSlot; 104public: 105 ArgsCrashTracerInfo(llvm::SmallVectorImpl<const char*> &Args) 106 : crashtracerSlot(0) 107 { 108 { 109 llvm::raw_svector_ostream Out(CrashString); 110 Out << "ClangCIndex [" << getClangFullVersion() << "]" 111 << "[createTranslationUnitFromSourceFile]: clang"; 112 for (llvm::SmallVectorImpl<const char*>::iterator I=Args.begin(), 113 E=Args.end(); I!=E; ++I) 114 Out << ' ' << *I; 115 } 116 crashtracerSlot = SetCrashTracerInfo(CrashString.c_str(), 117 AggregateString); 118 } 119 120 ~ArgsCrashTracerInfo() { 121 ResetCrashTracerInfo(crashtracerSlot); 122 } 123}; 124} 125#endif 126 127/// \brief The result of comparing two source ranges. 128enum RangeComparisonResult { 129 /// \brief Either the ranges overlap or one of the ranges is invalid. 130 RangeOverlap, 131 132 /// \brief The first range ends before the second range starts. 133 RangeBefore, 134 135 /// \brief The first range starts after the second range ends. 136 RangeAfter 137}; 138 139/// \brief Compare two source ranges to determine their relative position in 140/// the translation unit. 141static RangeComparisonResult RangeCompare(SourceManager &SM, 142 SourceRange R1, 143 SourceRange R2) { 144 assert(R1.isValid() && "First range is invalid?"); 145 assert(R2.isValid() && "Second range is invalid?"); 146 if (R1.getEnd() == R2.getBegin() || 147 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin())) 148 return RangeBefore; 149 if (R2.getEnd() == R1.getBegin() || 150 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin())) 151 return RangeAfter; 152 return RangeOverlap; 153} 154 155/// \brief Determine if a source location falls within, before, or after a 156/// a given source range. 157static RangeComparisonResult LocationCompare(SourceManager &SM, 158 SourceLocation L, SourceRange R) { 159 assert(R.isValid() && "First range is invalid?"); 160 assert(L.isValid() && "Second range is invalid?"); 161 if (L == R.getBegin()) 162 return RangeOverlap; 163 if (L == R.getEnd()) 164 return RangeAfter; 165 if (SM.isBeforeInTranslationUnit(L, R.getBegin())) 166 return RangeBefore; 167 if (SM.isBeforeInTranslationUnit(R.getEnd(), L)) 168 return RangeAfter; 169 return RangeOverlap; 170} 171 172/// \brief Translate a Clang source range into a CIndex source range. 173/// 174/// Clang internally represents ranges where the end location points to the 175/// start of the token at the end. However, for external clients it is more 176/// useful to have a CXSourceRange be a proper half-open interval. This routine 177/// does the appropriate translation. 178CXSourceRange cxloc::translateSourceRange(const SourceManager &SM, 179 const LangOptions &LangOpts, 180 const CharSourceRange &R) { 181 // We want the last character in this location, so we will adjust the 182 // location accordingly. 183 // FIXME: How do do this with a macro instantiation location? 184 SourceLocation EndLoc = R.getEnd(); 185 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) { 186 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts); 187 EndLoc = EndLoc.getFileLocWithOffset(Length); 188 } 189 190 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts }, 191 R.getBegin().getRawEncoding(), 192 EndLoc.getRawEncoding() }; 193 return Result; 194} 195 196//===----------------------------------------------------------------------===// 197// Cursor visitor. 198//===----------------------------------------------------------------------===// 199 200namespace { 201 202// Cursor visitor. 203class CursorVisitor : public DeclVisitor<CursorVisitor, bool>, 204 public TypeLocVisitor<CursorVisitor, bool>, 205 public StmtVisitor<CursorVisitor, bool> 206{ 207 /// \brief The translation unit we are traversing. 208 ASTUnit *TU; 209 210 /// \brief The parent cursor whose children we are traversing. 211 CXCursor Parent; 212 213 /// \brief The declaration that serves at the parent of any statement or 214 /// expression nodes. 215 Decl *StmtParent; 216 217 /// \brief The visitor function. 218 CXCursorVisitor Visitor; 219 220 /// \brief The opaque client data, to be passed along to the visitor. 221 CXClientData ClientData; 222 223 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on 224 // to the visitor. Declarations with a PCH level greater than this value will 225 // be suppressed. 226 unsigned MaxPCHLevel; 227 228 /// \brief When valid, a source range to which the cursor should restrict 229 /// its search. 230 SourceRange RegionOfInterest; 231 232 using DeclVisitor<CursorVisitor, bool>::Visit; 233 using TypeLocVisitor<CursorVisitor, bool>::Visit; 234 using StmtVisitor<CursorVisitor, bool>::Visit; 235 236 /// \brief Determine whether this particular source range comes before, comes 237 /// after, or overlaps the region of interest. 238 /// 239 /// \param R a half-open source range retrieved from the abstract syntax tree. 240 RangeComparisonResult CompareRegionOfInterest(SourceRange R); 241 242 class SetParentRAII { 243 CXCursor &Parent; 244 Decl *&StmtParent; 245 CXCursor OldParent; 246 247 public: 248 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent) 249 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent) 250 { 251 Parent = NewParent; 252 if (clang_isDeclaration(Parent.kind)) 253 StmtParent = getCursorDecl(Parent); 254 } 255 256 ~SetParentRAII() { 257 Parent = OldParent; 258 if (clang_isDeclaration(Parent.kind)) 259 StmtParent = getCursorDecl(Parent); 260 } 261 }; 262 263public: 264 CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData, 265 unsigned MaxPCHLevel, 266 SourceRange RegionOfInterest = SourceRange()) 267 : TU(TU), Visitor(Visitor), ClientData(ClientData), 268 MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest) 269 { 270 Parent.kind = CXCursor_NoDeclFound; 271 Parent.data[0] = 0; 272 Parent.data[1] = 0; 273 Parent.data[2] = 0; 274 StmtParent = 0; 275 } 276 277 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false); 278 279 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator> 280 getPreprocessedEntities(); 281 282 bool VisitChildren(CXCursor Parent); 283 284 // Declaration visitors 285 bool VisitAttributes(Decl *D); 286 bool VisitBlockDecl(BlockDecl *B); 287 bool VisitDeclContext(DeclContext *DC); 288 bool VisitTranslationUnitDecl(TranslationUnitDecl *D); 289 bool VisitTypedefDecl(TypedefDecl *D); 290 bool VisitTagDecl(TagDecl *D); 291 bool VisitEnumConstantDecl(EnumConstantDecl *D); 292 bool VisitDeclaratorDecl(DeclaratorDecl *DD); 293 bool VisitFunctionDecl(FunctionDecl *ND); 294 bool VisitFieldDecl(FieldDecl *D); 295 bool VisitVarDecl(VarDecl *); 296 bool VisitObjCMethodDecl(ObjCMethodDecl *ND); 297 bool VisitObjCContainerDecl(ObjCContainerDecl *D); 298 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND); 299 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID); 300 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD); 301 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D); 302 bool VisitObjCImplDecl(ObjCImplDecl *D); 303 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D); 304 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D); 305 // FIXME: ObjCPropertyDecl requires TypeSourceInfo, getter/setter locations, 306 // etc. 307 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations. 308 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D); 309 bool VisitObjCClassDecl(ObjCClassDecl *D); 310 bool VisitLinkageSpecDecl(LinkageSpecDecl *D); 311 bool VisitNamespaceDecl(NamespaceDecl *D); 312 313 // Type visitors 314 // FIXME: QualifiedTypeLoc doesn't provide any location information 315 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL); 316 bool VisitTypedefTypeLoc(TypedefTypeLoc TL); 317 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL); 318 bool VisitTagTypeLoc(TagTypeLoc TL); 319 // FIXME: TemplateTypeParmTypeLoc doesn't provide any location information 320 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL); 321 bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL); 322 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL); 323 bool VisitPointerTypeLoc(PointerTypeLoc TL); 324 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL); 325 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL); 326 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL); 327 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL); 328 bool VisitFunctionTypeLoc(FunctionTypeLoc TL); 329 bool VisitArrayTypeLoc(ArrayTypeLoc TL); 330 // FIXME: Implement for TemplateSpecializationTypeLoc 331 // FIXME: Implement visitors here when the unimplemented TypeLocs get 332 // implemented 333 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL); 334 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL); 335 336 // Statement visitors 337 bool VisitStmt(Stmt *S); 338 bool VisitDeclStmt(DeclStmt *S); 339 // FIXME: LabelStmt label? 340 bool VisitIfStmt(IfStmt *S); 341 bool VisitSwitchStmt(SwitchStmt *S); 342 bool VisitCaseStmt(CaseStmt *S); 343 bool VisitWhileStmt(WhileStmt *S); 344 bool VisitForStmt(ForStmt *S); 345// bool VisitSwitchCase(SwitchCase *S); 346 347 // Expression visitors 348 bool VisitBlockExpr(BlockExpr *B); 349 bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E); 350 bool VisitExplicitCastExpr(ExplicitCastExpr *E); 351 bool VisitObjCMessageExpr(ObjCMessageExpr *E); 352 bool VisitObjCEncodeExpr(ObjCEncodeExpr *E); 353 bool VisitOffsetOfExpr(OffsetOfExpr *E); 354 bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E); 355}; 356 357} // end anonymous namespace 358 359RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) { 360 return RangeCompare(TU->getSourceManager(), R, RegionOfInterest); 361} 362 363/// \brief Visit the given cursor and, if requested by the visitor, 364/// its children. 365/// 366/// \param Cursor the cursor to visit. 367/// 368/// \param CheckRegionOfInterest if true, then the caller already checked that 369/// this cursor is within the region of interest. 370/// 371/// \returns true if the visitation should be aborted, false if it 372/// should continue. 373bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) { 374 if (clang_isInvalid(Cursor.kind)) 375 return false; 376 377 if (clang_isDeclaration(Cursor.kind)) { 378 Decl *D = getCursorDecl(Cursor); 379 assert(D && "Invalid declaration cursor"); 380 if (D->getPCHLevel() > MaxPCHLevel) 381 return false; 382 383 if (D->isImplicit()) 384 return false; 385 } 386 387 // If we have a range of interest, and this cursor doesn't intersect with it, 388 // we're done. 389 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) { 390 SourceRange Range = 391 cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor)); 392 if (Range.isInvalid() || CompareRegionOfInterest(Range)) 393 return false; 394 } 395 396 switch (Visitor(Cursor, Parent, ClientData)) { 397 case CXChildVisit_Break: 398 return true; 399 400 case CXChildVisit_Continue: 401 return false; 402 403 case CXChildVisit_Recurse: 404 return VisitChildren(Cursor); 405 } 406 407 return false; 408} 409 410std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator> 411CursorVisitor::getPreprocessedEntities() { 412 PreprocessingRecord &PPRec 413 = *TU->getPreprocessor().getPreprocessingRecord(); 414 415 bool OnlyLocalDecls 416 = !TU->isMainFileAST() && TU->getOnlyLocalDecls(); 417 418 // There is no region of interest; we have to walk everything. 419 if (RegionOfInterest.isInvalid()) 420 return std::make_pair(PPRec.begin(OnlyLocalDecls), 421 PPRec.end(OnlyLocalDecls)); 422 423 // Find the file in which the region of interest lands. 424 SourceManager &SM = TU->getSourceManager(); 425 std::pair<FileID, unsigned> Begin 426 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin()); 427 std::pair<FileID, unsigned> End 428 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd()); 429 430 // The region of interest spans files; we have to walk everything. 431 if (Begin.first != End.first) 432 return std::make_pair(PPRec.begin(OnlyLocalDecls), 433 PPRec.end(OnlyLocalDecls)); 434 435 ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap 436 = TU->getPreprocessedEntitiesByFile(); 437 if (ByFileMap.empty()) { 438 // Build the mapping from files to sets of preprocessed entities. 439 for (PreprocessingRecord::iterator E = PPRec.begin(OnlyLocalDecls), 440 EEnd = PPRec.end(OnlyLocalDecls); 441 E != EEnd; ++E) { 442 std::pair<FileID, unsigned> P 443 = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin()); 444 ByFileMap[P.first].push_back(*E); 445 } 446 } 447 448 return std::make_pair(ByFileMap[Begin.first].begin(), 449 ByFileMap[Begin.first].end()); 450} 451 452/// \brief Visit the children of the given cursor. 453/// 454/// \returns true if the visitation should be aborted, false if it 455/// should continue. 456bool CursorVisitor::VisitChildren(CXCursor Cursor) { 457 if (clang_isReference(Cursor.kind)) { 458 // By definition, references have no children. 459 return false; 460 } 461 462 // Set the Parent field to Cursor, then back to its old value once we're 463 // done. 464 SetParentRAII SetParent(Parent, StmtParent, Cursor); 465 466 if (clang_isDeclaration(Cursor.kind)) { 467 Decl *D = getCursorDecl(Cursor); 468 assert(D && "Invalid declaration cursor"); 469 return VisitAttributes(D) || Visit(D); 470 } 471 472 if (clang_isStatement(Cursor.kind)) 473 return Visit(getCursorStmt(Cursor)); 474 if (clang_isExpression(Cursor.kind)) 475 return Visit(getCursorExpr(Cursor)); 476 477 if (clang_isTranslationUnit(Cursor.kind)) { 478 ASTUnit *CXXUnit = getCursorASTUnit(Cursor); 479 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() && 480 RegionOfInterest.isInvalid()) { 481 const std::vector<Decl*> &TLDs = CXXUnit->getTopLevelDecls(); 482 for (std::vector<Decl*>::const_iterator it = TLDs.begin(), 483 ie = TLDs.end(); it != ie; ++it) { 484 if (Visit(MakeCXCursor(*it, CXXUnit), true)) 485 return true; 486 } 487 } else if (VisitDeclContext( 488 CXXUnit->getASTContext().getTranslationUnitDecl())) 489 return true; 490 491 // Walk the preprocessing record. 492 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) { 493 // FIXME: Once we have the ability to deserialize a preprocessing record, 494 // do so. 495 PreprocessingRecord::iterator E, EEnd; 496 for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) { 497 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) { 498 if (Visit(MakeMacroInstantiationCursor(MI, CXXUnit))) 499 return true; 500 501 continue; 502 } 503 504 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) { 505 if (Visit(MakeMacroDefinitionCursor(MD, CXXUnit))) 506 return true; 507 508 continue; 509 } 510 } 511 } 512 return false; 513 } 514 515 // Nothing to visit at the moment. 516 return false; 517} 518 519bool CursorVisitor::VisitBlockDecl(BlockDecl *B) { 520 if (Visit(B->getSignatureAsWritten()->getTypeLoc())) 521 return true; 522 523 return Visit(MakeCXCursor(B->getBody(), StmtParent, TU)); 524} 525 526bool CursorVisitor::VisitDeclContext(DeclContext *DC) { 527 for (DeclContext::decl_iterator 528 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) { 529 530 Decl *D = *I; 531 if (D->getLexicalDeclContext() != DC) 532 continue; 533 534 CXCursor Cursor = MakeCXCursor(D, TU); 535 536 if (RegionOfInterest.isValid()) { 537 SourceRange Range = 538 cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor)); 539 if (Range.isInvalid()) 540 continue; 541 542 switch (CompareRegionOfInterest(Range)) { 543 case RangeBefore: 544 // This declaration comes before the region of interest; skip it. 545 continue; 546 547 case RangeAfter: 548 // This declaration comes after the region of interest; we're done. 549 return false; 550 551 case RangeOverlap: 552 // This declaration overlaps the region of interest; visit it. 553 break; 554 } 555 } 556 557 if (Visit(Cursor, true)) 558 return true; 559 } 560 561 return false; 562} 563 564bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) { 565 llvm_unreachable("Translation units are visited directly by Visit()"); 566 return false; 567} 568 569bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) { 570 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo()) 571 return Visit(TSInfo->getTypeLoc()); 572 573 return false; 574} 575 576bool CursorVisitor::VisitTagDecl(TagDecl *D) { 577 return VisitDeclContext(D); 578} 579 580bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) { 581 if (Expr *Init = D->getInitExpr()) 582 return Visit(MakeCXCursor(Init, StmtParent, TU)); 583 return false; 584} 585 586bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) { 587 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo()) 588 if (Visit(TSInfo->getTypeLoc())) 589 return true; 590 591 return false; 592} 593 594bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) { 595 if (VisitDeclaratorDecl(ND)) 596 return true; 597 598 if (ND->isThisDeclarationADefinition() && 599 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU))) 600 return true; 601 602 return false; 603} 604 605bool CursorVisitor::VisitFieldDecl(FieldDecl *D) { 606 if (VisitDeclaratorDecl(D)) 607 return true; 608 609 if (Expr *BitWidth = D->getBitWidth()) 610 return Visit(MakeCXCursor(BitWidth, StmtParent, TU)); 611 612 return false; 613} 614 615bool CursorVisitor::VisitVarDecl(VarDecl *D) { 616 if (VisitDeclaratorDecl(D)) 617 return true; 618 619 if (Expr *Init = D->getInit()) 620 return Visit(MakeCXCursor(Init, StmtParent, TU)); 621 622 return false; 623} 624 625bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) { 626 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo()) 627 if (Visit(TSInfo->getTypeLoc())) 628 return true; 629 630 for (ObjCMethodDecl::param_iterator P = ND->param_begin(), 631 PEnd = ND->param_end(); 632 P != PEnd; ++P) { 633 if (Visit(MakeCXCursor(*P, TU))) 634 return true; 635 } 636 637 if (ND->isThisDeclarationADefinition() && 638 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU))) 639 return true; 640 641 return false; 642} 643 644bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) { 645 return VisitDeclContext(D); 646} 647 648bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) { 649 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(), 650 TU))) 651 return true; 652 653 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin(); 654 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(), 655 E = ND->protocol_end(); I != E; ++I, ++PL) 656 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 657 return true; 658 659 return VisitObjCContainerDecl(ND); 660} 661 662bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) { 663 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin(); 664 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(), 665 E = PID->protocol_end(); I != E; ++I, ++PL) 666 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 667 return true; 668 669 return VisitObjCContainerDecl(PID); 670} 671 672bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) { 673 if (Visit(PD->getTypeSourceInfo()->getTypeLoc())) 674 return true; 675 676 // FIXME: This implements a workaround with @property declarations also being 677 // installed in the DeclContext for the @interface. Eventually this code 678 // should be removed. 679 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext()); 680 if (!CDecl || !CDecl->IsClassExtension()) 681 return false; 682 683 ObjCInterfaceDecl *ID = CDecl->getClassInterface(); 684 if (!ID) 685 return false; 686 687 IdentifierInfo *PropertyId = PD->getIdentifier(); 688 ObjCPropertyDecl *prevDecl = 689 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId); 690 691 if (!prevDecl) 692 return false; 693 694 // Visit synthesized methods since they will be skipped when visiting 695 // the @interface. 696 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl()) 697 if (MD->isSynthesized()) 698 if (Visit(MakeCXCursor(MD, TU))) 699 return true; 700 701 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl()) 702 if (MD->isSynthesized()) 703 if (Visit(MakeCXCursor(MD, TU))) 704 return true; 705 706 return false; 707} 708 709bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) { 710 // Issue callbacks for super class. 711 if (D->getSuperClass() && 712 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(), 713 D->getSuperClassLoc(), 714 TU))) 715 return true; 716 717 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin(); 718 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(), 719 E = D->protocol_end(); I != E; ++I, ++PL) 720 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 721 return true; 722 723 return VisitObjCContainerDecl(D); 724} 725 726bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) { 727 return VisitObjCContainerDecl(D); 728} 729 730bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) { 731 // 'ID' could be null when dealing with invalid code. 732 if (ObjCInterfaceDecl *ID = D->getClassInterface()) 733 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU))) 734 return true; 735 736 return VisitObjCImplDecl(D); 737} 738 739bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) { 740#if 0 741 // Issue callbacks for super class. 742 // FIXME: No source location information! 743 if (D->getSuperClass() && 744 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(), 745 D->getSuperClassLoc(), 746 TU))) 747 return true; 748#endif 749 750 return VisitObjCImplDecl(D); 751} 752 753bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) { 754 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin(); 755 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(), 756 E = D->protocol_end(); 757 I != E; ++I, ++PL) 758 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 759 return true; 760 761 return false; 762} 763 764bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) { 765 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C) 766 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU))) 767 return true; 768 769 return false; 770} 771 772bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) { 773 return VisitDeclContext(D); 774} 775 776bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) { 777 return VisitDeclContext(D); 778} 779 780bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) { 781 ASTContext &Context = TU->getASTContext(); 782 783 // Some builtin types (such as Objective-C's "id", "sel", and 784 // "Class") have associated declarations. Create cursors for those. 785 QualType VisitType; 786 switch (TL.getType()->getAs<BuiltinType>()->getKind()) { 787 case BuiltinType::Void: 788 case BuiltinType::Bool: 789 case BuiltinType::Char_U: 790 case BuiltinType::UChar: 791 case BuiltinType::Char16: 792 case BuiltinType::Char32: 793 case BuiltinType::UShort: 794 case BuiltinType::UInt: 795 case BuiltinType::ULong: 796 case BuiltinType::ULongLong: 797 case BuiltinType::UInt128: 798 case BuiltinType::Char_S: 799 case BuiltinType::SChar: 800 case BuiltinType::WChar: 801 case BuiltinType::Short: 802 case BuiltinType::Int: 803 case BuiltinType::Long: 804 case BuiltinType::LongLong: 805 case BuiltinType::Int128: 806 case BuiltinType::Float: 807 case BuiltinType::Double: 808 case BuiltinType::LongDouble: 809 case BuiltinType::NullPtr: 810 case BuiltinType::Overload: 811 case BuiltinType::Dependent: 812 break; 813 814 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor? 815 break; 816 817 case BuiltinType::ObjCId: 818 VisitType = Context.getObjCIdType(); 819 break; 820 821 case BuiltinType::ObjCClass: 822 VisitType = Context.getObjCClassType(); 823 break; 824 825 case BuiltinType::ObjCSel: 826 VisitType = Context.getObjCSelType(); 827 break; 828 } 829 830 if (!VisitType.isNull()) { 831 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>()) 832 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(), 833 TU)); 834 } 835 836 return false; 837} 838 839bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) { 840 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU)); 841} 842 843bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) { 844 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU)); 845} 846 847bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) { 848 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU)); 849} 850 851bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) { 852 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU))) 853 return true; 854 855 return false; 856} 857 858bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) { 859 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc())) 860 return true; 861 862 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) { 863 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I), 864 TU))) 865 return true; 866 } 867 868 return false; 869} 870 871bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) { 872 return Visit(TL.getPointeeLoc()); 873} 874 875bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) { 876 return Visit(TL.getPointeeLoc()); 877} 878 879bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) { 880 return Visit(TL.getPointeeLoc()); 881} 882 883bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) { 884 return Visit(TL.getPointeeLoc()); 885} 886 887bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) { 888 return Visit(TL.getPointeeLoc()); 889} 890 891bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) { 892 return Visit(TL.getPointeeLoc()); 893} 894 895bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL) { 896 if (Visit(TL.getResultLoc())) 897 return true; 898 899 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I) 900 if (Decl *D = TL.getArg(I)) 901 if (Visit(MakeCXCursor(D, TU))) 902 return true; 903 904 return false; 905} 906 907bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) { 908 if (Visit(TL.getElementLoc())) 909 return true; 910 911 if (Expr *Size = TL.getSizeExpr()) 912 return Visit(MakeCXCursor(Size, StmtParent, TU)); 913 914 return false; 915} 916 917bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) { 918 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU)); 919} 920 921bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) { 922 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo()) 923 return Visit(TSInfo->getTypeLoc()); 924 925 return false; 926} 927 928bool CursorVisitor::VisitStmt(Stmt *S) { 929 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end(); 930 Child != ChildEnd; ++Child) { 931 if (Stmt *C = *Child) 932 if (Visit(MakeCXCursor(C, StmtParent, TU))) 933 return true; 934 } 935 936 return false; 937} 938 939bool CursorVisitor::VisitCaseStmt(CaseStmt *S) { 940 // Specially handle CaseStmts because they can be nested, e.g.: 941 // 942 // case 1: 943 // case 2: 944 // 945 // In this case the second CaseStmt is the child of the first. Walking 946 // these recursively can blow out the stack. 947 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU); 948 while (true) { 949 // Set the Parent field to Cursor, then back to its old value once we're 950 // done. 951 SetParentRAII SetParent(Parent, StmtParent, Cursor); 952 953 if (Stmt *LHS = S->getLHS()) 954 if (Visit(MakeCXCursor(LHS, StmtParent, TU))) 955 return true; 956 if (Stmt *RHS = S->getRHS()) 957 if (Visit(MakeCXCursor(RHS, StmtParent, TU))) 958 return true; 959 if (Stmt *SubStmt = S->getSubStmt()) { 960 if (!isa<CaseStmt>(SubStmt)) 961 return Visit(MakeCXCursor(SubStmt, StmtParent, TU)); 962 963 // Specially handle 'CaseStmt' so that we don't blow out the stack. 964 CaseStmt *CS = cast<CaseStmt>(SubStmt); 965 Cursor = MakeCXCursor(CS, StmtParent, TU); 966 if (RegionOfInterest.isValid()) { 967 SourceRange Range = CS->getSourceRange(); 968 if (Range.isInvalid() || CompareRegionOfInterest(Range)) 969 return false; 970 } 971 972 switch (Visitor(Cursor, Parent, ClientData)) { 973 case CXChildVisit_Break: return true; 974 case CXChildVisit_Continue: return false; 975 case CXChildVisit_Recurse: 976 // Perform tail-recursion manually. 977 S = CS; 978 continue; 979 } 980 } 981 return false; 982 } 983} 984 985bool CursorVisitor::VisitDeclStmt(DeclStmt *S) { 986 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end(); 987 D != DEnd; ++D) { 988 if (*D && Visit(MakeCXCursor(*D, TU))) 989 return true; 990 } 991 992 return false; 993} 994 995bool CursorVisitor::VisitIfStmt(IfStmt *S) { 996 if (VarDecl *Var = S->getConditionVariable()) { 997 if (Visit(MakeCXCursor(Var, TU))) 998 return true; 999 } 1000 1001 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1002 return true; 1003 if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU))) 1004 return true; 1005 if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU))) 1006 return true; 1007 1008 return false; 1009} 1010 1011bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) { 1012 if (VarDecl *Var = S->getConditionVariable()) { 1013 if (Visit(MakeCXCursor(Var, TU))) 1014 return true; 1015 } 1016 1017 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1018 return true; 1019 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1020 return true; 1021 1022 return false; 1023} 1024 1025bool CursorVisitor::VisitWhileStmt(WhileStmt *S) { 1026 if (VarDecl *Var = S->getConditionVariable()) { 1027 if (Visit(MakeCXCursor(Var, TU))) 1028 return true; 1029 } 1030 1031 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1032 return true; 1033 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1034 return true; 1035 1036 return false; 1037} 1038 1039bool CursorVisitor::VisitForStmt(ForStmt *S) { 1040 if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU))) 1041 return true; 1042 if (VarDecl *Var = S->getConditionVariable()) { 1043 if (Visit(MakeCXCursor(Var, TU))) 1044 return true; 1045 } 1046 1047 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1048 return true; 1049 if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU))) 1050 return true; 1051 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1052 return true; 1053 1054 return false; 1055} 1056 1057bool CursorVisitor::VisitBlockExpr(BlockExpr *B) { 1058 return Visit(B->getBlockDecl()); 1059} 1060 1061bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) { 1062 // FIXME: Visit fields as well? 1063 if (Visit(E->getTypeSourceInfo()->getTypeLoc())) 1064 return true; 1065 1066 return VisitExpr(E); 1067} 1068 1069bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) { 1070 if (E->isArgumentType()) { 1071 if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo()) 1072 return Visit(TSInfo->getTypeLoc()); 1073 1074 return false; 1075 } 1076 1077 return VisitExpr(E); 1078} 1079 1080bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) { 1081 if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten()) 1082 if (Visit(TSInfo->getTypeLoc())) 1083 return true; 1084 1085 return VisitCastExpr(E); 1086} 1087 1088bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) { 1089 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo()) 1090 if (Visit(TSInfo->getTypeLoc())) 1091 return true; 1092 1093 return VisitExpr(E); 1094} 1095 1096bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) { 1097 if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo()) 1098 if (Visit(TSInfo->getTypeLoc())) 1099 return true; 1100 1101 return VisitExpr(E); 1102} 1103 1104bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) { 1105 return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc()); 1106} 1107 1108 1109bool CursorVisitor::VisitAttributes(Decl *D) { 1110 for (const Attr *A = D->getAttrs(); A; A = A->getNext()) 1111 if (Visit(MakeCXCursor(A, D, TU))) 1112 return true; 1113 1114 return false; 1115} 1116 1117extern "C" { 1118CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1119 int displayDiagnostics) { 1120 CIndexer *CIdxr = new CIndexer(); 1121 if (excludeDeclarationsFromPCH) 1122 CIdxr->setOnlyLocalDecls(); 1123 if (displayDiagnostics) 1124 CIdxr->setDisplayDiagnostics(); 1125 return CIdxr; 1126} 1127 1128void clang_disposeIndex(CXIndex CIdx) { 1129 if (CIdx) 1130 delete static_cast<CIndexer *>(CIdx); 1131} 1132 1133void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) { 1134 if (CIdx) { 1135 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1136 CXXIdx->setUseExternalASTGeneration(value); 1137 } 1138} 1139 1140CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx, 1141 const char *ast_filename) { 1142 if (!CIdx) 1143 return 0; 1144 1145 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1146 1147 llvm::IntrusiveRefCntPtr<Diagnostic> Diags; 1148 return ASTUnit::LoadFromPCHFile(ast_filename, Diags, 1149 CXXIdx->getOnlyLocalDecls(), 1150 0, 0, true); 1151} 1152 1153CXTranslationUnit 1154clang_createTranslationUnitFromSourceFile(CXIndex CIdx, 1155 const char *source_filename, 1156 int num_command_line_args, 1157 const char **command_line_args, 1158 unsigned num_unsaved_files, 1159 struct CXUnsavedFile *unsaved_files) { 1160 if (!CIdx) 1161 return 0; 1162 1163 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1164 1165 // Configure the diagnostics. 1166 DiagnosticOptions DiagOpts; 1167 llvm::IntrusiveRefCntPtr<Diagnostic> Diags; 1168 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0); 1169 1170 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles; 1171 for (unsigned I = 0; I != num_unsaved_files; ++I) { 1172 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length); 1173 const llvm::MemoryBuffer *Buffer 1174 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename); 1175 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename, 1176 Buffer)); 1177 } 1178 1179 if (!CXXIdx->getUseExternalASTGeneration()) { 1180 llvm::SmallVector<const char *, 16> Args; 1181 1182 // The 'source_filename' argument is optional. If the caller does not 1183 // specify it then it is assumed that the source file is specified 1184 // in the actual argument list. 1185 if (source_filename) 1186 Args.push_back(source_filename); 1187 Args.insert(Args.end(), command_line_args, 1188 command_line_args + num_command_line_args); 1189 Args.push_back("-Xclang"); 1190 Args.push_back("-detailed-preprocessing-record"); 1191 unsigned NumErrors = Diags->getNumErrors(); 1192 1193#ifdef USE_CRASHTRACER 1194 ArgsCrashTracerInfo ACTI(Args); 1195#endif 1196 1197 llvm::OwningPtr<ASTUnit> Unit( 1198 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(), 1199 Diags, 1200 CXXIdx->getClangResourcesPath(), 1201 CXXIdx->getOnlyLocalDecls(), 1202 RemappedFiles.data(), 1203 RemappedFiles.size(), 1204 /*CaptureDiagnostics=*/true)); 1205 1206 if (NumErrors != Diags->getNumErrors()) { 1207 // Make sure to check that 'Unit' is non-NULL. 1208 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) { 1209 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(), 1210 DEnd = Unit->stored_diag_end(); 1211 D != DEnd; ++D) { 1212 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions()); 1213 CXString Msg = clang_formatDiagnostic(&Diag, 1214 clang_defaultDiagnosticDisplayOptions()); 1215 fprintf(stderr, "%s\n", clang_getCString(Msg)); 1216 clang_disposeString(Msg); 1217 } 1218#ifdef LLVM_ON_WIN32 1219 // On Windows, force a flush, since there may be multiple copies of 1220 // stderr and stdout in the file system, all with different buffers 1221 // but writing to the same device. 1222 fflush(stderr); 1223#endif 1224 } 1225 } 1226 1227 return Unit.take(); 1228 } 1229 1230 // Build up the arguments for invoking 'clang'. 1231 std::vector<const char *> argv; 1232 1233 // First add the complete path to the 'clang' executable. 1234 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath(); 1235 argv.push_back(ClangPath.c_str()); 1236 1237 // Add the '-emit-ast' option as our execution mode for 'clang'. 1238 argv.push_back("-emit-ast"); 1239 1240 // The 'source_filename' argument is optional. If the caller does not 1241 // specify it then it is assumed that the source file is specified 1242 // in the actual argument list. 1243 if (source_filename) 1244 argv.push_back(source_filename); 1245 1246 // Generate a temporary name for the AST file. 1247 argv.push_back("-o"); 1248 char astTmpFile[L_tmpnam]; 1249 argv.push_back(tmpnam(astTmpFile)); 1250 1251 // Remap any unsaved files to temporary files. 1252 std::vector<llvm::sys::Path> TemporaryFiles; 1253 std::vector<std::string> RemapArgs; 1254 if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles)) 1255 return 0; 1256 1257 // The pointers into the elements of RemapArgs are stable because we 1258 // won't be adding anything to RemapArgs after this point. 1259 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i) 1260 argv.push_back(RemapArgs[i].c_str()); 1261 1262 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'. 1263 for (int i = 0; i < num_command_line_args; ++i) 1264 if (const char *arg = command_line_args[i]) { 1265 if (strcmp(arg, "-o") == 0) { 1266 ++i; // Also skip the matching argument. 1267 continue; 1268 } 1269 if (strcmp(arg, "-emit-ast") == 0 || 1270 strcmp(arg, "-c") == 0 || 1271 strcmp(arg, "-fsyntax-only") == 0) { 1272 continue; 1273 } 1274 1275 // Keep the argument. 1276 argv.push_back(arg); 1277 } 1278 1279 // Generate a temporary name for the diagnostics file. 1280 char tmpFileResults[L_tmpnam]; 1281 char *tmpResultsFileName = tmpnam(tmpFileResults); 1282 llvm::sys::Path DiagnosticsFile(tmpResultsFileName); 1283 TemporaryFiles.push_back(DiagnosticsFile); 1284 argv.push_back("-fdiagnostics-binary"); 1285 1286 argv.push_back("-Xclang"); 1287 argv.push_back("-detailed-preprocessing-record"); 1288 1289 // Add the null terminator. 1290 argv.push_back(NULL); 1291 1292 // Invoke 'clang'. 1293 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null 1294 // on Unix or NUL (Windows). 1295 std::string ErrMsg; 1296 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DiagnosticsFile, 1297 NULL }; 1298 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL, 1299 /* redirects */ &Redirects[0], 1300 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg); 1301 1302 if (!ErrMsg.empty()) { 1303 std::string AllArgs; 1304 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end(); 1305 I != E; ++I) { 1306 AllArgs += ' '; 1307 if (*I) 1308 AllArgs += *I; 1309 } 1310 1311 Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg; 1312 } 1313 1314 ASTUnit *ATU = ASTUnit::LoadFromPCHFile(astTmpFile, Diags, 1315 CXXIdx->getOnlyLocalDecls(), 1316 RemappedFiles.data(), 1317 RemappedFiles.size(), 1318 /*CaptureDiagnostics=*/true); 1319 if (ATU) { 1320 LoadSerializedDiagnostics(DiagnosticsFile, 1321 num_unsaved_files, unsaved_files, 1322 ATU->getFileManager(), 1323 ATU->getSourceManager(), 1324 ATU->getStoredDiagnostics()); 1325 } else if (CXXIdx->getDisplayDiagnostics()) { 1326 // We failed to load the ASTUnit, but we can still deserialize the 1327 // diagnostics and emit them. 1328 FileManager FileMgr; 1329 Diagnostic Diag; 1330 SourceManager SourceMgr(Diag); 1331 // FIXME: Faked LangOpts! 1332 LangOptions LangOpts; 1333 llvm::SmallVector<StoredDiagnostic, 4> Diags; 1334 LoadSerializedDiagnostics(DiagnosticsFile, 1335 num_unsaved_files, unsaved_files, 1336 FileMgr, SourceMgr, Diags); 1337 for (llvm::SmallVector<StoredDiagnostic, 4>::iterator D = Diags.begin(), 1338 DEnd = Diags.end(); 1339 D != DEnd; ++D) { 1340 CXStoredDiagnostic Diag(*D, LangOpts); 1341 CXString Msg = clang_formatDiagnostic(&Diag, 1342 clang_defaultDiagnosticDisplayOptions()); 1343 fprintf(stderr, "%s\n", clang_getCString(Msg)); 1344 clang_disposeString(Msg); 1345 } 1346 1347#ifdef LLVM_ON_WIN32 1348 // On Windows, force a flush, since there may be multiple copies of 1349 // stderr and stdout in the file system, all with different buffers 1350 // but writing to the same device. 1351 fflush(stderr); 1352#endif 1353 } 1354 1355 if (ATU) { 1356 // Make the translation unit responsible for destroying all temporary files. 1357 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i) 1358 ATU->addTemporaryFile(TemporaryFiles[i]); 1359 ATU->addTemporaryFile(llvm::sys::Path(ATU->getPCHFileName())); 1360 } else { 1361 // Destroy all of the temporary files now; they can't be referenced any 1362 // longer. 1363 llvm::sys::Path(astTmpFile).eraseFromDisk(); 1364 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i) 1365 TemporaryFiles[i].eraseFromDisk(); 1366 } 1367 1368 return ATU; 1369} 1370 1371void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) { 1372 if (CTUnit) 1373 delete static_cast<ASTUnit *>(CTUnit); 1374} 1375 1376CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) { 1377 if (!CTUnit) 1378 return createCXString(""); 1379 1380 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit); 1381 return createCXString(CXXUnit->getOriginalSourceFileName(), true); 1382} 1383 1384CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) { 1385 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } }; 1386 return Result; 1387} 1388 1389} // end: extern "C" 1390 1391//===----------------------------------------------------------------------===// 1392// CXSourceLocation and CXSourceRange Operations. 1393//===----------------------------------------------------------------------===// 1394 1395extern "C" { 1396CXSourceLocation clang_getNullLocation() { 1397 CXSourceLocation Result = { { 0, 0 }, 0 }; 1398 return Result; 1399} 1400 1401unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) { 1402 return (loc1.ptr_data[0] == loc2.ptr_data[0] && 1403 loc1.ptr_data[1] == loc2.ptr_data[1] && 1404 loc1.int_data == loc2.int_data); 1405} 1406 1407CXSourceLocation clang_getLocation(CXTranslationUnit tu, 1408 CXFile file, 1409 unsigned line, 1410 unsigned column) { 1411 if (!tu || !file) 1412 return clang_getNullLocation(); 1413 1414 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 1415 SourceLocation SLoc 1416 = CXXUnit->getSourceManager().getLocation( 1417 static_cast<const FileEntry *>(file), 1418 line, column); 1419 1420 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc); 1421} 1422 1423CXSourceRange clang_getNullRange() { 1424 CXSourceRange Result = { { 0, 0 }, 0, 0 }; 1425 return Result; 1426} 1427 1428CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) { 1429 if (begin.ptr_data[0] != end.ptr_data[0] || 1430 begin.ptr_data[1] != end.ptr_data[1]) 1431 return clang_getNullRange(); 1432 1433 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] }, 1434 begin.int_data, end.int_data }; 1435 return Result; 1436} 1437 1438void clang_getInstantiationLocation(CXSourceLocation location, 1439 CXFile *file, 1440 unsigned *line, 1441 unsigned *column, 1442 unsigned *offset) { 1443 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data); 1444 1445 if (!location.ptr_data[0] || Loc.isInvalid()) { 1446 if (file) 1447 *file = 0; 1448 if (line) 1449 *line = 0; 1450 if (column) 1451 *column = 0; 1452 if (offset) 1453 *offset = 0; 1454 return; 1455 } 1456 1457 const SourceManager &SM = 1458 *static_cast<const SourceManager*>(location.ptr_data[0]); 1459 SourceLocation InstLoc = SM.getInstantiationLoc(Loc); 1460 1461 if (file) 1462 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc)); 1463 if (line) 1464 *line = SM.getInstantiationLineNumber(InstLoc); 1465 if (column) 1466 *column = SM.getInstantiationColumnNumber(InstLoc); 1467 if (offset) 1468 *offset = SM.getDecomposedLoc(InstLoc).second; 1469} 1470 1471CXSourceLocation clang_getRangeStart(CXSourceRange range) { 1472 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] }, 1473 range.begin_int_data }; 1474 return Result; 1475} 1476 1477CXSourceLocation clang_getRangeEnd(CXSourceRange range) { 1478 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] }, 1479 range.end_int_data }; 1480 return Result; 1481} 1482 1483} // end: extern "C" 1484 1485//===----------------------------------------------------------------------===// 1486// CXFile Operations. 1487//===----------------------------------------------------------------------===// 1488 1489extern "C" { 1490CXString clang_getFileName(CXFile SFile) { 1491 if (!SFile) 1492 return createCXString(NULL); 1493 1494 FileEntry *FEnt = static_cast<FileEntry *>(SFile); 1495 return createCXString(FEnt->getName()); 1496} 1497 1498time_t clang_getFileTime(CXFile SFile) { 1499 if (!SFile) 1500 return 0; 1501 1502 FileEntry *FEnt = static_cast<FileEntry *>(SFile); 1503 return FEnt->getModificationTime(); 1504} 1505 1506CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) { 1507 if (!tu) 1508 return 0; 1509 1510 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 1511 1512 FileManager &FMgr = CXXUnit->getFileManager(); 1513 const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name)); 1514 return const_cast<FileEntry *>(File); 1515} 1516 1517} // end: extern "C" 1518 1519//===----------------------------------------------------------------------===// 1520// CXCursor Operations. 1521//===----------------------------------------------------------------------===// 1522 1523static Decl *getDeclFromExpr(Stmt *E) { 1524 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E)) 1525 return RefExpr->getDecl(); 1526 if (MemberExpr *ME = dyn_cast<MemberExpr>(E)) 1527 return ME->getMemberDecl(); 1528 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E)) 1529 return RE->getDecl(); 1530 1531 if (CallExpr *CE = dyn_cast<CallExpr>(E)) 1532 return getDeclFromExpr(CE->getCallee()); 1533 if (CastExpr *CE = dyn_cast<CastExpr>(E)) 1534 return getDeclFromExpr(CE->getSubExpr()); 1535 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E)) 1536 return OME->getMethodDecl(); 1537 1538 return 0; 1539} 1540 1541static SourceLocation getLocationFromExpr(Expr *E) { 1542 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E)) 1543 return /*FIXME:*/Msg->getLeftLoc(); 1544 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) 1545 return DRE->getLocation(); 1546 if (MemberExpr *Member = dyn_cast<MemberExpr>(E)) 1547 return Member->getMemberLoc(); 1548 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E)) 1549 return Ivar->getLocation(); 1550 return E->getLocStart(); 1551} 1552 1553extern "C" { 1554 1555unsigned clang_visitChildren(CXCursor parent, 1556 CXCursorVisitor visitor, 1557 CXClientData client_data) { 1558 ASTUnit *CXXUnit = getCursorASTUnit(parent); 1559 1560 unsigned PCHLevel = Decl::MaxPCHLevel; 1561 1562 // Set the PCHLevel to filter out unwanted decls if requested. 1563 if (CXXUnit->getOnlyLocalDecls()) { 1564 PCHLevel = 0; 1565 1566 // If the main input was an AST, bump the level. 1567 if (CXXUnit->isMainFileAST()) 1568 ++PCHLevel; 1569 } 1570 1571 CursorVisitor CursorVis(CXXUnit, visitor, client_data, PCHLevel); 1572 return CursorVis.VisitChildren(parent); 1573} 1574 1575static CXString getDeclSpelling(Decl *D) { 1576 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D); 1577 if (!ND) 1578 return createCXString(""); 1579 1580 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND)) 1581 return createCXString(OMD->getSelector().getAsString()); 1582 1583 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND)) 1584 // No, this isn't the same as the code below. getIdentifier() is non-virtual 1585 // and returns different names. NamedDecl returns the class name and 1586 // ObjCCategoryImplDecl returns the category name. 1587 return createCXString(CIMP->getIdentifier()->getNameStart()); 1588 1589 llvm::SmallString<1024> S; 1590 llvm::raw_svector_ostream os(S); 1591 ND->printName(os); 1592 1593 return createCXString(os.str()); 1594} 1595 1596CXString clang_getCursorSpelling(CXCursor C) { 1597 if (clang_isTranslationUnit(C.kind)) 1598 return clang_getTranslationUnitSpelling(C.data[2]); 1599 1600 if (clang_isReference(C.kind)) { 1601 switch (C.kind) { 1602 case CXCursor_ObjCSuperClassRef: { 1603 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first; 1604 return createCXString(Super->getIdentifier()->getNameStart()); 1605 } 1606 case CXCursor_ObjCClassRef: { 1607 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first; 1608 return createCXString(Class->getIdentifier()->getNameStart()); 1609 } 1610 case CXCursor_ObjCProtocolRef: { 1611 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first; 1612 assert(OID && "getCursorSpelling(): Missing protocol decl"); 1613 return createCXString(OID->getIdentifier()->getNameStart()); 1614 } 1615 case CXCursor_TypeRef: { 1616 TypeDecl *Type = getCursorTypeRef(C).first; 1617 assert(Type && "Missing type decl"); 1618 1619 return createCXString(getCursorContext(C).getTypeDeclType(Type). 1620 getAsString()); 1621 } 1622 1623 default: 1624 return createCXString("<not implemented>"); 1625 } 1626 } 1627 1628 if (clang_isExpression(C.kind)) { 1629 Decl *D = getDeclFromExpr(getCursorExpr(C)); 1630 if (D) 1631 return getDeclSpelling(D); 1632 return createCXString(""); 1633 } 1634 1635 if (C.kind == CXCursor_MacroInstantiation) 1636 return createCXString(getCursorMacroInstantiation(C)->getName() 1637 ->getNameStart()); 1638 1639 if (C.kind == CXCursor_MacroDefinition) 1640 return createCXString(getCursorMacroDefinition(C)->getName() 1641 ->getNameStart()); 1642 1643 if (clang_isDeclaration(C.kind)) 1644 return getDeclSpelling(getCursorDecl(C)); 1645 1646 return createCXString(""); 1647} 1648 1649CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) { 1650 switch (Kind) { 1651 case CXCursor_FunctionDecl: 1652 return createCXString("FunctionDecl"); 1653 case CXCursor_TypedefDecl: 1654 return createCXString("TypedefDecl"); 1655 case CXCursor_EnumDecl: 1656 return createCXString("EnumDecl"); 1657 case CXCursor_EnumConstantDecl: 1658 return createCXString("EnumConstantDecl"); 1659 case CXCursor_StructDecl: 1660 return createCXString("StructDecl"); 1661 case CXCursor_UnionDecl: 1662 return createCXString("UnionDecl"); 1663 case CXCursor_ClassDecl: 1664 return createCXString("ClassDecl"); 1665 case CXCursor_FieldDecl: 1666 return createCXString("FieldDecl"); 1667 case CXCursor_VarDecl: 1668 return createCXString("VarDecl"); 1669 case CXCursor_ParmDecl: 1670 return createCXString("ParmDecl"); 1671 case CXCursor_ObjCInterfaceDecl: 1672 return createCXString("ObjCInterfaceDecl"); 1673 case CXCursor_ObjCCategoryDecl: 1674 return createCXString("ObjCCategoryDecl"); 1675 case CXCursor_ObjCProtocolDecl: 1676 return createCXString("ObjCProtocolDecl"); 1677 case CXCursor_ObjCPropertyDecl: 1678 return createCXString("ObjCPropertyDecl"); 1679 case CXCursor_ObjCIvarDecl: 1680 return createCXString("ObjCIvarDecl"); 1681 case CXCursor_ObjCInstanceMethodDecl: 1682 return createCXString("ObjCInstanceMethodDecl"); 1683 case CXCursor_ObjCClassMethodDecl: 1684 return createCXString("ObjCClassMethodDecl"); 1685 case CXCursor_ObjCImplementationDecl: 1686 return createCXString("ObjCImplementationDecl"); 1687 case CXCursor_ObjCCategoryImplDecl: 1688 return createCXString("ObjCCategoryImplDecl"); 1689 case CXCursor_CXXMethod: 1690 return createCXString("CXXMethod"); 1691 case CXCursor_UnexposedDecl: 1692 return createCXString("UnexposedDecl"); 1693 case CXCursor_ObjCSuperClassRef: 1694 return createCXString("ObjCSuperClassRef"); 1695 case CXCursor_ObjCProtocolRef: 1696 return createCXString("ObjCProtocolRef"); 1697 case CXCursor_ObjCClassRef: 1698 return createCXString("ObjCClassRef"); 1699 case CXCursor_TypeRef: 1700 return createCXString("TypeRef"); 1701 case CXCursor_UnexposedExpr: 1702 return createCXString("UnexposedExpr"); 1703 case CXCursor_BlockExpr: 1704 return createCXString("BlockExpr"); 1705 case CXCursor_DeclRefExpr: 1706 return createCXString("DeclRefExpr"); 1707 case CXCursor_MemberRefExpr: 1708 return createCXString("MemberRefExpr"); 1709 case CXCursor_CallExpr: 1710 return createCXString("CallExpr"); 1711 case CXCursor_ObjCMessageExpr: 1712 return createCXString("ObjCMessageExpr"); 1713 case CXCursor_UnexposedStmt: 1714 return createCXString("UnexposedStmt"); 1715 case CXCursor_InvalidFile: 1716 return createCXString("InvalidFile"); 1717 case CXCursor_InvalidCode: 1718 return createCXString("InvalidCode"); 1719 case CXCursor_NoDeclFound: 1720 return createCXString("NoDeclFound"); 1721 case CXCursor_NotImplemented: 1722 return createCXString("NotImplemented"); 1723 case CXCursor_TranslationUnit: 1724 return createCXString("TranslationUnit"); 1725 case CXCursor_UnexposedAttr: 1726 return createCXString("UnexposedAttr"); 1727 case CXCursor_IBActionAttr: 1728 return createCXString("attribute(ibaction)"); 1729 case CXCursor_IBOutletAttr: 1730 return createCXString("attribute(iboutlet)"); 1731 case CXCursor_IBOutletCollectionAttr: 1732 return createCXString("attribute(iboutletcollection)"); 1733 case CXCursor_PreprocessingDirective: 1734 return createCXString("preprocessing directive"); 1735 case CXCursor_MacroDefinition: 1736 return createCXString("macro definition"); 1737 case CXCursor_MacroInstantiation: 1738 return createCXString("macro instantiation"); 1739 case CXCursor_Namespace: 1740 return createCXString("Namespace"); 1741 case CXCursor_LinkageSpec: 1742 return createCXString("LinkageSpec"); 1743 } 1744 1745 llvm_unreachable("Unhandled CXCursorKind"); 1746 return createCXString(NULL); 1747} 1748 1749enum CXChildVisitResult GetCursorVisitor(CXCursor cursor, 1750 CXCursor parent, 1751 CXClientData client_data) { 1752 CXCursor *BestCursor = static_cast<CXCursor *>(client_data); 1753 *BestCursor = cursor; 1754 return CXChildVisit_Recurse; 1755} 1756 1757CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) { 1758 if (!TU) 1759 return clang_getNullCursor(); 1760 1761 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 1762 1763 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 1764 1765 SourceLocation SLoc = cxloc::translateSourceLocation(Loc); 1766 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound); 1767 if (SLoc.isValid()) { 1768 SourceRange RegionOfInterest(SLoc, SLoc.getFileLocWithOffset(1)); 1769 1770 // FIXME: Would be great to have a "hint" cursor, then walk from that 1771 // hint cursor upward until we find a cursor whose source range encloses 1772 // the region of interest, rather than starting from the translation unit. 1773 CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit); 1774 CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result, 1775 Decl::MaxPCHLevel, RegionOfInterest); 1776 CursorVis.VisitChildren(Parent); 1777 } 1778 return Result; 1779} 1780 1781CXCursor clang_getNullCursor(void) { 1782 return MakeCXCursorInvalid(CXCursor_InvalidFile); 1783} 1784 1785unsigned clang_equalCursors(CXCursor X, CXCursor Y) { 1786 return X == Y; 1787} 1788 1789unsigned clang_isInvalid(enum CXCursorKind K) { 1790 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid; 1791} 1792 1793unsigned clang_isDeclaration(enum CXCursorKind K) { 1794 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl; 1795} 1796 1797unsigned clang_isReference(enum CXCursorKind K) { 1798 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef; 1799} 1800 1801unsigned clang_isExpression(enum CXCursorKind K) { 1802 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr; 1803} 1804 1805unsigned clang_isStatement(enum CXCursorKind K) { 1806 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt; 1807} 1808 1809unsigned clang_isTranslationUnit(enum CXCursorKind K) { 1810 return K == CXCursor_TranslationUnit; 1811} 1812 1813unsigned clang_isPreprocessing(enum CXCursorKind K) { 1814 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing; 1815} 1816 1817unsigned clang_isUnexposed(enum CXCursorKind K) { 1818 switch (K) { 1819 case CXCursor_UnexposedDecl: 1820 case CXCursor_UnexposedExpr: 1821 case CXCursor_UnexposedStmt: 1822 case CXCursor_UnexposedAttr: 1823 return true; 1824 default: 1825 return false; 1826 } 1827} 1828 1829CXCursorKind clang_getCursorKind(CXCursor C) { 1830 return C.kind; 1831} 1832 1833CXSourceLocation clang_getCursorLocation(CXCursor C) { 1834 if (clang_isReference(C.kind)) { 1835 switch (C.kind) { 1836 case CXCursor_ObjCSuperClassRef: { 1837 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1838 = getCursorObjCSuperClassRef(C); 1839 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1840 } 1841 1842 case CXCursor_ObjCProtocolRef: { 1843 std::pair<ObjCProtocolDecl *, SourceLocation> P 1844 = getCursorObjCProtocolRef(C); 1845 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1846 } 1847 1848 case CXCursor_ObjCClassRef: { 1849 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1850 = getCursorObjCClassRef(C); 1851 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1852 } 1853 1854 case CXCursor_TypeRef: { 1855 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C); 1856 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1857 } 1858 1859 default: 1860 // FIXME: Need a way to enumerate all non-reference cases. 1861 llvm_unreachable("Missed a reference kind"); 1862 } 1863 } 1864 1865 if (clang_isExpression(C.kind)) 1866 return cxloc::translateSourceLocation(getCursorContext(C), 1867 getLocationFromExpr(getCursorExpr(C))); 1868 1869 if (C.kind == CXCursor_PreprocessingDirective) { 1870 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin(); 1871 return cxloc::translateSourceLocation(getCursorContext(C), L); 1872 } 1873 1874 if (C.kind == CXCursor_MacroInstantiation) { 1875 SourceLocation L 1876 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin(); 1877 return cxloc::translateSourceLocation(getCursorContext(C), L); 1878 } 1879 1880 if (C.kind == CXCursor_MacroDefinition) { 1881 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation(); 1882 return cxloc::translateSourceLocation(getCursorContext(C), L); 1883 } 1884 1885 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl) 1886 return clang_getNullLocation(); 1887 1888 Decl *D = getCursorDecl(C); 1889 SourceLocation Loc = D->getLocation(); 1890 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D)) 1891 Loc = Class->getClassLoc(); 1892 return cxloc::translateSourceLocation(getCursorContext(C), Loc); 1893} 1894 1895CXSourceRange clang_getCursorExtent(CXCursor C) { 1896 if (clang_isReference(C.kind)) { 1897 switch (C.kind) { 1898 case CXCursor_ObjCSuperClassRef: { 1899 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1900 = getCursorObjCSuperClassRef(C); 1901 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1902 } 1903 1904 case CXCursor_ObjCProtocolRef: { 1905 std::pair<ObjCProtocolDecl *, SourceLocation> P 1906 = getCursorObjCProtocolRef(C); 1907 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1908 } 1909 1910 case CXCursor_ObjCClassRef: { 1911 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1912 = getCursorObjCClassRef(C); 1913 1914 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1915 } 1916 1917 case CXCursor_TypeRef: { 1918 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C); 1919 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1920 } 1921 1922 default: 1923 // FIXME: Need a way to enumerate all non-reference cases. 1924 llvm_unreachable("Missed a reference kind"); 1925 } 1926 } 1927 1928 if (clang_isExpression(C.kind)) 1929 return cxloc::translateSourceRange(getCursorContext(C), 1930 getCursorExpr(C)->getSourceRange()); 1931 1932 if (clang_isStatement(C.kind)) 1933 return cxloc::translateSourceRange(getCursorContext(C), 1934 getCursorStmt(C)->getSourceRange()); 1935 1936 if (C.kind == CXCursor_PreprocessingDirective) { 1937 SourceRange R = cxcursor::getCursorPreprocessingDirective(C); 1938 return cxloc::translateSourceRange(getCursorContext(C), R); 1939 } 1940 1941 if (C.kind == CXCursor_MacroInstantiation) { 1942 SourceRange R = cxcursor::getCursorMacroInstantiation(C)->getSourceRange(); 1943 return cxloc::translateSourceRange(getCursorContext(C), R); 1944 } 1945 1946 if (C.kind == CXCursor_MacroDefinition) { 1947 SourceRange R = cxcursor::getCursorMacroDefinition(C)->getSourceRange(); 1948 return cxloc::translateSourceRange(getCursorContext(C), R); 1949 } 1950 1951 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl) 1952 return clang_getNullRange(); 1953 1954 Decl *D = getCursorDecl(C); 1955 return cxloc::translateSourceRange(getCursorContext(C), D->getSourceRange()); 1956} 1957 1958CXCursor clang_getCursorReferenced(CXCursor C) { 1959 if (clang_isInvalid(C.kind)) 1960 return clang_getNullCursor(); 1961 1962 ASTUnit *CXXUnit = getCursorASTUnit(C); 1963 if (clang_isDeclaration(C.kind)) 1964 return C; 1965 1966 if (clang_isExpression(C.kind)) { 1967 Decl *D = getDeclFromExpr(getCursorExpr(C)); 1968 if (D) 1969 return MakeCXCursor(D, CXXUnit); 1970 return clang_getNullCursor(); 1971 } 1972 1973 if (C.kind == CXCursor_MacroInstantiation) { 1974 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition()) 1975 return MakeMacroDefinitionCursor(Def, CXXUnit); 1976 } 1977 1978 if (!clang_isReference(C.kind)) 1979 return clang_getNullCursor(); 1980 1981 switch (C.kind) { 1982 case CXCursor_ObjCSuperClassRef: 1983 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit); 1984 1985 case CXCursor_ObjCProtocolRef: { 1986 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit); 1987 1988 case CXCursor_ObjCClassRef: 1989 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit); 1990 1991 case CXCursor_TypeRef: 1992 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit); 1993 1994 default: 1995 // We would prefer to enumerate all non-reference cursor kinds here. 1996 llvm_unreachable("Unhandled reference cursor kind"); 1997 break; 1998 } 1999 } 2000 2001 return clang_getNullCursor(); 2002} 2003 2004CXCursor clang_getCursorDefinition(CXCursor C) { 2005 if (clang_isInvalid(C.kind)) 2006 return clang_getNullCursor(); 2007 2008 ASTUnit *CXXUnit = getCursorASTUnit(C); 2009 2010 bool WasReference = false; 2011 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) { 2012 C = clang_getCursorReferenced(C); 2013 WasReference = true; 2014 } 2015 2016 if (C.kind == CXCursor_MacroInstantiation) 2017 return clang_getCursorReferenced(C); 2018 2019 if (!clang_isDeclaration(C.kind)) 2020 return clang_getNullCursor(); 2021 2022 Decl *D = getCursorDecl(C); 2023 if (!D) 2024 return clang_getNullCursor(); 2025 2026 switch (D->getKind()) { 2027 // Declaration kinds that don't really separate the notions of 2028 // declaration and definition. 2029 case Decl::Namespace: 2030 case Decl::Typedef: 2031 case Decl::TemplateTypeParm: 2032 case Decl::EnumConstant: 2033 case Decl::Field: 2034 case Decl::ObjCIvar: 2035 case Decl::ObjCAtDefsField: 2036 case Decl::ImplicitParam: 2037 case Decl::ParmVar: 2038 case Decl::NonTypeTemplateParm: 2039 case Decl::TemplateTemplateParm: 2040 case Decl::ObjCCategoryImpl: 2041 case Decl::ObjCImplementation: 2042 case Decl::AccessSpec: 2043 case Decl::LinkageSpec: 2044 case Decl::ObjCPropertyImpl: 2045 case Decl::FileScopeAsm: 2046 case Decl::StaticAssert: 2047 case Decl::Block: 2048 return C; 2049 2050 // Declaration kinds that don't make any sense here, but are 2051 // nonetheless harmless. 2052 case Decl::TranslationUnit: 2053 break; 2054 2055 // Declaration kinds for which the definition is not resolvable. 2056 case Decl::UnresolvedUsingTypename: 2057 case Decl::UnresolvedUsingValue: 2058 break; 2059 2060 case Decl::UsingDirective: 2061 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(), 2062 CXXUnit); 2063 2064 case Decl::NamespaceAlias: 2065 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit); 2066 2067 case Decl::Enum: 2068 case Decl::Record: 2069 case Decl::CXXRecord: 2070 case Decl::ClassTemplateSpecialization: 2071 case Decl::ClassTemplatePartialSpecialization: 2072 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition()) 2073 return MakeCXCursor(Def, CXXUnit); 2074 return clang_getNullCursor(); 2075 2076 case Decl::Function: 2077 case Decl::CXXMethod: 2078 case Decl::CXXConstructor: 2079 case Decl::CXXDestructor: 2080 case Decl::CXXConversion: { 2081 const FunctionDecl *Def = 0; 2082 if (cast<FunctionDecl>(D)->getBody(Def)) 2083 return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit); 2084 return clang_getNullCursor(); 2085 } 2086 2087 case Decl::Var: { 2088 // Ask the variable if it has a definition. 2089 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition()) 2090 return MakeCXCursor(Def, CXXUnit); 2091 return clang_getNullCursor(); 2092 } 2093 2094 case Decl::FunctionTemplate: { 2095 const FunctionDecl *Def = 0; 2096 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def)) 2097 return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit); 2098 return clang_getNullCursor(); 2099 } 2100 2101 case Decl::ClassTemplate: { 2102 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl() 2103 ->getDefinition()) 2104 return MakeCXCursor( 2105 cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(), 2106 CXXUnit); 2107 return clang_getNullCursor(); 2108 } 2109 2110 case Decl::Using: { 2111 UsingDecl *Using = cast<UsingDecl>(D); 2112 CXCursor Def = clang_getNullCursor(); 2113 for (UsingDecl::shadow_iterator S = Using->shadow_begin(), 2114 SEnd = Using->shadow_end(); 2115 S != SEnd; ++S) { 2116 if (Def != clang_getNullCursor()) { 2117 // FIXME: We have no way to return multiple results. 2118 return clang_getNullCursor(); 2119 } 2120 2121 Def = clang_getCursorDefinition(MakeCXCursor((*S)->getTargetDecl(), 2122 CXXUnit)); 2123 } 2124 2125 return Def; 2126 } 2127 2128 case Decl::UsingShadow: 2129 return clang_getCursorDefinition( 2130 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(), 2131 CXXUnit)); 2132 2133 case Decl::ObjCMethod: { 2134 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D); 2135 if (Method->isThisDeclarationADefinition()) 2136 return C; 2137 2138 // Dig out the method definition in the associated 2139 // @implementation, if we have it. 2140 // FIXME: The ASTs should make finding the definition easier. 2141 if (ObjCInterfaceDecl *Class 2142 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext())) 2143 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation()) 2144 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(), 2145 Method->isInstanceMethod())) 2146 if (Def->isThisDeclarationADefinition()) 2147 return MakeCXCursor(Def, CXXUnit); 2148 2149 return clang_getNullCursor(); 2150 } 2151 2152 case Decl::ObjCCategory: 2153 if (ObjCCategoryImplDecl *Impl 2154 = cast<ObjCCategoryDecl>(D)->getImplementation()) 2155 return MakeCXCursor(Impl, CXXUnit); 2156 return clang_getNullCursor(); 2157 2158 case Decl::ObjCProtocol: 2159 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl()) 2160 return C; 2161 return clang_getNullCursor(); 2162 2163 case Decl::ObjCInterface: 2164 // There are two notions of a "definition" for an Objective-C 2165 // class: the interface and its implementation. When we resolved a 2166 // reference to an Objective-C class, produce the @interface as 2167 // the definition; when we were provided with the interface, 2168 // produce the @implementation as the definition. 2169 if (WasReference) { 2170 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl()) 2171 return C; 2172 } else if (ObjCImplementationDecl *Impl 2173 = cast<ObjCInterfaceDecl>(D)->getImplementation()) 2174 return MakeCXCursor(Impl, CXXUnit); 2175 return clang_getNullCursor(); 2176 2177 case Decl::ObjCProperty: 2178 // FIXME: We don't really know where to find the 2179 // ObjCPropertyImplDecls that implement this property. 2180 return clang_getNullCursor(); 2181 2182 case Decl::ObjCCompatibleAlias: 2183 if (ObjCInterfaceDecl *Class 2184 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface()) 2185 if (!Class->isForwardDecl()) 2186 return MakeCXCursor(Class, CXXUnit); 2187 2188 return clang_getNullCursor(); 2189 2190 case Decl::ObjCForwardProtocol: { 2191 ObjCForwardProtocolDecl *Forward = cast<ObjCForwardProtocolDecl>(D); 2192 if (Forward->protocol_size() == 1) 2193 return clang_getCursorDefinition( 2194 MakeCXCursor(*Forward->protocol_begin(), 2195 CXXUnit)); 2196 2197 // FIXME: Cannot return multiple definitions. 2198 return clang_getNullCursor(); 2199 } 2200 2201 case Decl::ObjCClass: { 2202 ObjCClassDecl *Class = cast<ObjCClassDecl>(D); 2203 if (Class->size() == 1) { 2204 ObjCInterfaceDecl *IFace = Class->begin()->getInterface(); 2205 if (!IFace->isForwardDecl()) 2206 return MakeCXCursor(IFace, CXXUnit); 2207 return clang_getNullCursor(); 2208 } 2209 2210 // FIXME: Cannot return multiple definitions. 2211 return clang_getNullCursor(); 2212 } 2213 2214 case Decl::Friend: 2215 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl()) 2216 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit)); 2217 return clang_getNullCursor(); 2218 2219 case Decl::FriendTemplate: 2220 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl()) 2221 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit)); 2222 return clang_getNullCursor(); 2223 } 2224 2225 return clang_getNullCursor(); 2226} 2227 2228unsigned clang_isCursorDefinition(CXCursor C) { 2229 if (!clang_isDeclaration(C.kind)) 2230 return 0; 2231 2232 return clang_getCursorDefinition(C) == C; 2233} 2234 2235void clang_getDefinitionSpellingAndExtent(CXCursor C, 2236 const char **startBuf, 2237 const char **endBuf, 2238 unsigned *startLine, 2239 unsigned *startColumn, 2240 unsigned *endLine, 2241 unsigned *endColumn) { 2242 assert(getCursorDecl(C) && "CXCursor has null decl"); 2243 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C)); 2244 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND); 2245 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody()); 2246 2247 SourceManager &SM = FD->getASTContext().getSourceManager(); 2248 *startBuf = SM.getCharacterData(Body->getLBracLoc()); 2249 *endBuf = SM.getCharacterData(Body->getRBracLoc()); 2250 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc()); 2251 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc()); 2252 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc()); 2253 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc()); 2254} 2255 2256void clang_enableStackTraces(void) { 2257 llvm::sys::PrintStackTraceOnErrorSignal(); 2258} 2259 2260} // end: extern "C" 2261 2262//===----------------------------------------------------------------------===// 2263// Token-based Operations. 2264//===----------------------------------------------------------------------===// 2265 2266/* CXToken layout: 2267 * int_data[0]: a CXTokenKind 2268 * int_data[1]: starting token location 2269 * int_data[2]: token length 2270 * int_data[3]: reserved 2271 * ptr_data: for identifiers and keywords, an IdentifierInfo*. 2272 * otherwise unused. 2273 */ 2274extern "C" { 2275 2276CXTokenKind clang_getTokenKind(CXToken CXTok) { 2277 return static_cast<CXTokenKind>(CXTok.int_data[0]); 2278} 2279 2280CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) { 2281 switch (clang_getTokenKind(CXTok)) { 2282 case CXToken_Identifier: 2283 case CXToken_Keyword: 2284 // We know we have an IdentifierInfo*, so use that. 2285 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data) 2286 ->getNameStart()); 2287 2288 case CXToken_Literal: { 2289 // We have stashed the starting pointer in the ptr_data field. Use it. 2290 const char *Text = static_cast<const char *>(CXTok.ptr_data); 2291 return createCXString(llvm::StringRef(Text, CXTok.int_data[2])); 2292 } 2293 2294 case CXToken_Punctuation: 2295 case CXToken_Comment: 2296 break; 2297 } 2298 2299 // We have to find the starting buffer pointer the hard way, by 2300 // deconstructing the source location. 2301 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2302 if (!CXXUnit) 2303 return createCXString(""); 2304 2305 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]); 2306 std::pair<FileID, unsigned> LocInfo 2307 = CXXUnit->getSourceManager().getDecomposedLoc(Loc); 2308 bool Invalid = false; 2309 llvm::StringRef Buffer 2310 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid); 2311 if (Invalid) 2312 return createCXString(""); 2313 2314 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2])); 2315} 2316 2317CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) { 2318 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2319 if (!CXXUnit) 2320 return clang_getNullLocation(); 2321 2322 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), 2323 SourceLocation::getFromRawEncoding(CXTok.int_data[1])); 2324} 2325 2326CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) { 2327 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2328 if (!CXXUnit) 2329 return clang_getNullRange(); 2330 2331 return cxloc::translateSourceRange(CXXUnit->getASTContext(), 2332 SourceLocation::getFromRawEncoding(CXTok.int_data[1])); 2333} 2334 2335void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range, 2336 CXToken **Tokens, unsigned *NumTokens) { 2337 if (Tokens) 2338 *Tokens = 0; 2339 if (NumTokens) 2340 *NumTokens = 0; 2341 2342 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2343 if (!CXXUnit || !Tokens || !NumTokens) 2344 return; 2345 2346 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 2347 2348 SourceRange R = cxloc::translateCXSourceRange(Range); 2349 if (R.isInvalid()) 2350 return; 2351 2352 SourceManager &SourceMgr = CXXUnit->getSourceManager(); 2353 std::pair<FileID, unsigned> BeginLocInfo 2354 = SourceMgr.getDecomposedLoc(R.getBegin()); 2355 std::pair<FileID, unsigned> EndLocInfo 2356 = SourceMgr.getDecomposedLoc(R.getEnd()); 2357 2358 // Cannot tokenize across files. 2359 if (BeginLocInfo.first != EndLocInfo.first) 2360 return; 2361 2362 // Create a lexer 2363 bool Invalid = false; 2364 llvm::StringRef Buffer 2365 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid); 2366 if (Invalid) 2367 return; 2368 2369 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first), 2370 CXXUnit->getASTContext().getLangOptions(), 2371 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end()); 2372 Lex.SetCommentRetentionState(true); 2373 2374 // Lex tokens until we hit the end of the range. 2375 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second; 2376 llvm::SmallVector<CXToken, 32> CXTokens; 2377 Token Tok; 2378 do { 2379 // Lex the next token 2380 Lex.LexFromRawLexer(Tok); 2381 if (Tok.is(tok::eof)) 2382 break; 2383 2384 // Initialize the CXToken. 2385 CXToken CXTok; 2386 2387 // - Common fields 2388 CXTok.int_data[1] = Tok.getLocation().getRawEncoding(); 2389 CXTok.int_data[2] = Tok.getLength(); 2390 CXTok.int_data[3] = 0; 2391 2392 // - Kind-specific fields 2393 if (Tok.isLiteral()) { 2394 CXTok.int_data[0] = CXToken_Literal; 2395 CXTok.ptr_data = (void *)Tok.getLiteralData(); 2396 } else if (Tok.is(tok::identifier)) { 2397 // Lookup the identifier to determine whether we have a keyword. 2398 std::pair<FileID, unsigned> LocInfo 2399 = SourceMgr.getDecomposedLoc(Tok.getLocation()); 2400 bool Invalid = false; 2401 llvm::StringRef Buf 2402 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid); 2403 if (Invalid) 2404 return; 2405 2406 const char *StartPos = Buf.data() + LocInfo.second; 2407 IdentifierInfo *II 2408 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos); 2409 2410 if (II->getObjCKeywordID() != tok::objc_not_keyword) { 2411 CXTok.int_data[0] = CXToken_Keyword; 2412 } 2413 else { 2414 CXTok.int_data[0] = II->getTokenID() == tok::identifier? 2415 CXToken_Identifier 2416 : CXToken_Keyword; 2417 } 2418 CXTok.ptr_data = II; 2419 } else if (Tok.is(tok::comment)) { 2420 CXTok.int_data[0] = CXToken_Comment; 2421 CXTok.ptr_data = 0; 2422 } else { 2423 CXTok.int_data[0] = CXToken_Punctuation; 2424 CXTok.ptr_data = 0; 2425 } 2426 CXTokens.push_back(CXTok); 2427 } while (Lex.getBufferLocation() <= EffectiveBufferEnd); 2428 2429 if (CXTokens.empty()) 2430 return; 2431 2432 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size()); 2433 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size()); 2434 *NumTokens = CXTokens.size(); 2435} 2436 2437void clang_disposeTokens(CXTranslationUnit TU, 2438 CXToken *Tokens, unsigned NumTokens) { 2439 free(Tokens); 2440} 2441 2442} // end: extern "C" 2443 2444//===----------------------------------------------------------------------===// 2445// Token annotation APIs. 2446//===----------------------------------------------------------------------===// 2447 2448typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData; 2449static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor, 2450 CXCursor parent, 2451 CXClientData client_data); 2452namespace { 2453class AnnotateTokensWorker { 2454 AnnotateTokensData &Annotated; 2455 CXToken *Tokens; 2456 CXCursor *Cursors; 2457 unsigned NumTokens; 2458 unsigned TokIdx; 2459 CursorVisitor AnnotateVis; 2460 SourceManager &SrcMgr; 2461 2462 bool MoreTokens() const { return TokIdx < NumTokens; } 2463 unsigned NextToken() const { return TokIdx; } 2464 void AdvanceToken() { ++TokIdx; } 2465 SourceLocation GetTokenLoc(unsigned tokI) { 2466 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]); 2467 } 2468 2469public: 2470 AnnotateTokensWorker(AnnotateTokensData &annotated, 2471 CXToken *tokens, CXCursor *cursors, unsigned numTokens, 2472 ASTUnit *CXXUnit, SourceRange RegionOfInterest) 2473 : Annotated(annotated), Tokens(tokens), Cursors(cursors), 2474 NumTokens(numTokens), TokIdx(0), 2475 AnnotateVis(CXXUnit, AnnotateTokensVisitor, this, 2476 Decl::MaxPCHLevel, RegionOfInterest), 2477 SrcMgr(CXXUnit->getSourceManager()) {} 2478 2479 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); } 2480 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent); 2481 void AnnotateTokens(CXCursor parent); 2482}; 2483} 2484 2485void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) { 2486 // Walk the AST within the region of interest, annotating tokens 2487 // along the way. 2488 VisitChildren(parent); 2489 2490 for (unsigned I = 0 ; I < TokIdx ; ++I) { 2491 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]); 2492 if (Pos != Annotated.end()) 2493 Cursors[I] = Pos->second; 2494 } 2495 2496 // Finish up annotating any tokens left. 2497 if (!MoreTokens()) 2498 return; 2499 2500 const CXCursor &C = clang_getNullCursor(); 2501 for (unsigned I = TokIdx ; I < NumTokens ; ++I) { 2502 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]); 2503 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second; 2504 } 2505} 2506 2507enum CXChildVisitResult 2508AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) { 2509 CXSourceLocation Loc = clang_getCursorLocation(cursor); 2510 // We can always annotate a preprocessing directive/macro instantiation. 2511 if (clang_isPreprocessing(cursor.kind)) { 2512 Annotated[Loc.int_data] = cursor; 2513 return CXChildVisit_Recurse; 2514 } 2515 2516 CXSourceRange cursorExtent = clang_getCursorExtent(cursor); 2517 SourceRange cursorRange = cxloc::translateCXSourceRange(cursorExtent); 2518 2519 if (cursorRange.isInvalid()) 2520 return CXChildVisit_Continue; 2521 2522 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data); 2523 2524 // Adjust the annotated range based specific declarations. 2525 const enum CXCursorKind cursorK = clang_getCursorKind(cursor); 2526 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) { 2527 Decl *D = cxcursor::getCursorDecl(cursor); 2528 // Don't visit synthesized ObjC methods, since they have no syntatic 2529 // representation in the source. 2530 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2531 if (MD->isSynthesized()) 2532 return CXChildVisit_Continue; 2533 } 2534 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) { 2535 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) { 2536 TypeLoc TL = TI->getTypeLoc(); 2537 SourceLocation TLoc = TL.getSourceRange().getBegin(); 2538 if (TLoc.isValid() && 2539 SrcMgr.isBeforeInTranslationUnit(TLoc, L)) 2540 cursorRange.setBegin(TLoc); 2541 } 2542 } 2543 } 2544 2545 const enum CXCursorKind K = clang_getCursorKind(parent); 2546 const CXCursor updateC = 2547 (clang_isInvalid(K) || K == CXCursor_TranslationUnit || 2548 L.isMacroID()) 2549 ? clang_getNullCursor() : parent; 2550 2551 while (MoreTokens()) { 2552 const unsigned I = NextToken(); 2553 SourceLocation TokLoc = GetTokenLoc(I); 2554 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) { 2555 case RangeBefore: 2556 Cursors[I] = updateC; 2557 AdvanceToken(); 2558 continue; 2559 case RangeAfter: 2560 return CXChildVisit_Continue; 2561 case RangeOverlap: 2562 break; 2563 } 2564 break; 2565 } 2566 2567 // Visit children to get their cursor information. 2568 const unsigned BeforeChildren = NextToken(); 2569 VisitChildren(cursor); 2570 const unsigned AfterChildren = NextToken(); 2571 2572 // Adjust 'Last' to the last token within the extent of the cursor. 2573 while (MoreTokens()) { 2574 const unsigned I = NextToken(); 2575 SourceLocation TokLoc = GetTokenLoc(I); 2576 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) { 2577 case RangeBefore: 2578 assert(0 && "Infeasible"); 2579 case RangeAfter: 2580 break; 2581 case RangeOverlap: 2582 Cursors[I] = updateC; 2583 AdvanceToken(); 2584 continue; 2585 } 2586 break; 2587 } 2588 const unsigned Last = NextToken(); 2589 2590 // Scan the tokens that are at the beginning of the cursor, but are not 2591 // capture by the child cursors. 2592 2593 // For AST elements within macros, rely on a post-annotate pass to 2594 // to correctly annotate the tokens with cursors. Otherwise we can 2595 // get confusing results of having tokens that map to cursors that really 2596 // are expanded by an instantiation. 2597 if (L.isMacroID()) 2598 cursor = clang_getNullCursor(); 2599 2600 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) { 2601 if (!clang_isInvalid(clang_getCursorKind(Cursors[I]))) 2602 break; 2603 Cursors[I] = cursor; 2604 } 2605 // Scan the tokens that are at the end of the cursor, but are not captured 2606 // but the child cursors. 2607 for (unsigned I = AfterChildren; I != Last; ++I) 2608 Cursors[I] = cursor; 2609 2610 TokIdx = Last; 2611 return CXChildVisit_Continue; 2612} 2613 2614static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor, 2615 CXCursor parent, 2616 CXClientData client_data) { 2617 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent); 2618} 2619 2620extern "C" { 2621 2622void clang_annotateTokens(CXTranslationUnit TU, 2623 CXToken *Tokens, unsigned NumTokens, 2624 CXCursor *Cursors) { 2625 2626 if (NumTokens == 0 || !Tokens || !Cursors) 2627 return; 2628 2629 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 2630 if (!CXXUnit) { 2631 // Any token we don't specifically annotate will have a NULL cursor. 2632 const CXCursor &C = clang_getNullCursor(); 2633 for (unsigned I = 0; I != NumTokens; ++I) 2634 Cursors[I] = C; 2635 return; 2636 } 2637 2638 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 2639 2640 // Determine the region of interest, which contains all of the tokens. 2641 SourceRange RegionOfInterest; 2642 RegionOfInterest.setBegin(cxloc::translateSourceLocation( 2643 clang_getTokenLocation(TU, Tokens[0]))); 2644 2645 SourceLocation End 2646 = cxloc::translateSourceLocation(clang_getTokenLocation(TU, 2647 Tokens[NumTokens - 1])); 2648 RegionOfInterest.setEnd(CXXUnit->getPreprocessor().getLocForEndOfToken(End)); 2649 2650 // A mapping from the source locations found when re-lexing or traversing the 2651 // region of interest to the corresponding cursors. 2652 AnnotateTokensData Annotated; 2653 2654 // Relex the tokens within the source range to look for preprocessing 2655 // directives. 2656 SourceManager &SourceMgr = CXXUnit->getSourceManager(); 2657 std::pair<FileID, unsigned> BeginLocInfo 2658 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin()); 2659 std::pair<FileID, unsigned> EndLocInfo 2660 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd()); 2661 2662 llvm::StringRef Buffer; 2663 bool Invalid = false; 2664 if (BeginLocInfo.first == EndLocInfo.first && 2665 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) && 2666 !Invalid) { 2667 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first), 2668 CXXUnit->getASTContext().getLangOptions(), 2669 Buffer.begin(), Buffer.data() + BeginLocInfo.second, 2670 Buffer.end()); 2671 Lex.SetCommentRetentionState(true); 2672 2673 // Lex tokens in raw mode until we hit the end of the range, to avoid 2674 // entering #includes or expanding macros. 2675 while (true) { 2676 Token Tok; 2677 Lex.LexFromRawLexer(Tok); 2678 2679 reprocess: 2680 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) { 2681 // We have found a preprocessing directive. Gobble it up so that we 2682 // don't see it while preprocessing these tokens later, but keep track of 2683 // all of the token locations inside this preprocessing directive so that 2684 // we can annotate them appropriately. 2685 // 2686 // FIXME: Some simple tests here could identify macro definitions and 2687 // #undefs, to provide specific cursor kinds for those. 2688 std::vector<SourceLocation> Locations; 2689 do { 2690 Locations.push_back(Tok.getLocation()); 2691 Lex.LexFromRawLexer(Tok); 2692 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof)); 2693 2694 using namespace cxcursor; 2695 CXCursor Cursor 2696 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(), 2697 Locations.back()), 2698 CXXUnit); 2699 for (unsigned I = 0, N = Locations.size(); I != N; ++I) { 2700 Annotated[Locations[I].getRawEncoding()] = Cursor; 2701 } 2702 2703 if (Tok.isAtStartOfLine()) 2704 goto reprocess; 2705 2706 continue; 2707 } 2708 2709 if (Tok.is(tok::eof)) 2710 break; 2711 } 2712 } 2713 2714 // Annotate all of the source locations in the region of interest that map to 2715 // a specific cursor. 2716 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens, 2717 CXXUnit, RegionOfInterest); 2718 W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit)); 2719} 2720} // end: extern "C" 2721 2722//===----------------------------------------------------------------------===// 2723// Operations for querying linkage of a cursor. 2724//===----------------------------------------------------------------------===// 2725 2726extern "C" { 2727CXLinkageKind clang_getCursorLinkage(CXCursor cursor) { 2728 if (!clang_isDeclaration(cursor.kind)) 2729 return CXLinkage_Invalid; 2730 2731 Decl *D = cxcursor::getCursorDecl(cursor); 2732 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D)) 2733 switch (ND->getLinkage()) { 2734 case NoLinkage: return CXLinkage_NoLinkage; 2735 case InternalLinkage: return CXLinkage_Internal; 2736 case UniqueExternalLinkage: return CXLinkage_UniqueExternal; 2737 case ExternalLinkage: return CXLinkage_External; 2738 }; 2739 2740 return CXLinkage_Invalid; 2741} 2742} // end: extern "C" 2743 2744//===----------------------------------------------------------------------===// 2745// Operations for querying language of a cursor. 2746//===----------------------------------------------------------------------===// 2747 2748static CXLanguageKind getDeclLanguage(const Decl *D) { 2749 switch (D->getKind()) { 2750 default: 2751 break; 2752 case Decl::ImplicitParam: 2753 case Decl::ObjCAtDefsField: 2754 case Decl::ObjCCategory: 2755 case Decl::ObjCCategoryImpl: 2756 case Decl::ObjCClass: 2757 case Decl::ObjCCompatibleAlias: 2758 case Decl::ObjCForwardProtocol: 2759 case Decl::ObjCImplementation: 2760 case Decl::ObjCInterface: 2761 case Decl::ObjCIvar: 2762 case Decl::ObjCMethod: 2763 case Decl::ObjCProperty: 2764 case Decl::ObjCPropertyImpl: 2765 case Decl::ObjCProtocol: 2766 return CXLanguage_ObjC; 2767 case Decl::CXXConstructor: 2768 case Decl::CXXConversion: 2769 case Decl::CXXDestructor: 2770 case Decl::CXXMethod: 2771 case Decl::CXXRecord: 2772 case Decl::ClassTemplate: 2773 case Decl::ClassTemplatePartialSpecialization: 2774 case Decl::ClassTemplateSpecialization: 2775 case Decl::Friend: 2776 case Decl::FriendTemplate: 2777 case Decl::FunctionTemplate: 2778 case Decl::LinkageSpec: 2779 case Decl::Namespace: 2780 case Decl::NamespaceAlias: 2781 case Decl::NonTypeTemplateParm: 2782 case Decl::StaticAssert: 2783 case Decl::TemplateTemplateParm: 2784 case Decl::TemplateTypeParm: 2785 case Decl::UnresolvedUsingTypename: 2786 case Decl::UnresolvedUsingValue: 2787 case Decl::Using: 2788 case Decl::UsingDirective: 2789 case Decl::UsingShadow: 2790 return CXLanguage_CPlusPlus; 2791 } 2792 2793 return CXLanguage_C; 2794} 2795 2796extern "C" { 2797CXLanguageKind clang_getCursorLanguage(CXCursor cursor) { 2798 if (clang_isDeclaration(cursor.kind)) 2799 return getDeclLanguage(cxcursor::getCursorDecl(cursor)); 2800 2801 return CXLanguage_Invalid; 2802} 2803} // end: extern "C" 2804 2805 2806//===----------------------------------------------------------------------===// 2807// C++ AST instrospection. 2808//===----------------------------------------------------------------------===// 2809 2810extern "C" { 2811unsigned clang_CXXMethod_isStatic(CXCursor C) { 2812 if (!clang_isDeclaration(C.kind)) 2813 return 0; 2814 CXXMethodDecl *D = dyn_cast<CXXMethodDecl>(cxcursor::getCursorDecl(C)); 2815 return (D && D->isStatic()) ? 1 : 0; 2816} 2817 2818} // end: extern "C" 2819 2820//===----------------------------------------------------------------------===// 2821// CXString Operations. 2822//===----------------------------------------------------------------------===// 2823 2824extern "C" { 2825const char *clang_getCString(CXString string) { 2826 return string.Spelling; 2827} 2828 2829void clang_disposeString(CXString string) { 2830 if (string.MustFreeString && string.Spelling) 2831 free((void*)string.Spelling); 2832} 2833 2834} // end: extern "C" 2835 2836namespace clang { namespace cxstring { 2837CXString createCXString(const char *String, bool DupString){ 2838 CXString Str; 2839 if (DupString) { 2840 Str.Spelling = strdup(String); 2841 Str.MustFreeString = 1; 2842 } else { 2843 Str.Spelling = String; 2844 Str.MustFreeString = 0; 2845 } 2846 return Str; 2847} 2848 2849CXString createCXString(llvm::StringRef String, bool DupString) { 2850 CXString Result; 2851 if (DupString || (!String.empty() && String.data()[String.size()] != 0)) { 2852 char *Spelling = (char *)malloc(String.size() + 1); 2853 memmove(Spelling, String.data(), String.size()); 2854 Spelling[String.size()] = 0; 2855 Result.Spelling = Spelling; 2856 Result.MustFreeString = 1; 2857 } else { 2858 Result.Spelling = String.data(); 2859 Result.MustFreeString = 0; 2860 } 2861 return Result; 2862} 2863}} 2864 2865//===----------------------------------------------------------------------===// 2866// Misc. utility functions. 2867//===----------------------------------------------------------------------===// 2868 2869extern "C" { 2870 2871CXString clang_getClangVersion() { 2872 return createCXString(getClangFullVersion()); 2873} 2874 2875} // end: extern "C" 2876