CIndex.cpp revision df432e338c68e0e06dd7644c43f3f218750b3d58
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 SourceRange 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 (!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 for (BlockDecl::param_iterator I=B->param_begin(), E=B->param_end(); I!=E;++I) 521 if (Decl *D = *I) 522 if (Visit(D)) 523 return true; 524 525 return Visit(MakeCXCursor(B->getBody(), StmtParent, TU)); 526} 527 528bool CursorVisitor::VisitDeclContext(DeclContext *DC) { 529 for (DeclContext::decl_iterator 530 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) { 531 532 Decl *D = *I; 533 if (D->getLexicalDeclContext() != DC) 534 continue; 535 536 CXCursor Cursor = MakeCXCursor(D, TU); 537 538 if (RegionOfInterest.isValid()) { 539 SourceRange Range = 540 cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor)); 541 if (Range.isInvalid()) 542 continue; 543 544 switch (CompareRegionOfInterest(Range)) { 545 case RangeBefore: 546 // This declaration comes before the region of interest; skip it. 547 continue; 548 549 case RangeAfter: 550 // This declaration comes after the region of interest; we're done. 551 return false; 552 553 case RangeOverlap: 554 // This declaration overlaps the region of interest; visit it. 555 break; 556 } 557 } 558 559 if (Visit(Cursor, true)) 560 return true; 561 } 562 563 return false; 564} 565 566bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) { 567 llvm_unreachable("Translation units are visited directly by Visit()"); 568 return false; 569} 570 571bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) { 572 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo()) 573 return Visit(TSInfo->getTypeLoc()); 574 575 return false; 576} 577 578bool CursorVisitor::VisitTagDecl(TagDecl *D) { 579 return VisitDeclContext(D); 580} 581 582bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) { 583 if (Expr *Init = D->getInitExpr()) 584 return Visit(MakeCXCursor(Init, StmtParent, TU)); 585 return false; 586} 587 588bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) { 589 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo()) 590 if (Visit(TSInfo->getTypeLoc())) 591 return true; 592 593 return false; 594} 595 596bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) { 597 if (VisitDeclaratorDecl(ND)) 598 return true; 599 600 if (ND->isThisDeclarationADefinition() && 601 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU))) 602 return true; 603 604 return false; 605} 606 607bool CursorVisitor::VisitFieldDecl(FieldDecl *D) { 608 if (VisitDeclaratorDecl(D)) 609 return true; 610 611 if (Expr *BitWidth = D->getBitWidth()) 612 return Visit(MakeCXCursor(BitWidth, StmtParent, TU)); 613 614 return false; 615} 616 617bool CursorVisitor::VisitVarDecl(VarDecl *D) { 618 if (VisitDeclaratorDecl(D)) 619 return true; 620 621 if (Expr *Init = D->getInit()) 622 return Visit(MakeCXCursor(Init, StmtParent, TU)); 623 624 return false; 625} 626 627bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) { 628 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo()) 629 if (Visit(TSInfo->getTypeLoc())) 630 return true; 631 632 for (ObjCMethodDecl::param_iterator P = ND->param_begin(), 633 PEnd = ND->param_end(); 634 P != PEnd; ++P) { 635 if (Visit(MakeCXCursor(*P, TU))) 636 return true; 637 } 638 639 if (ND->isThisDeclarationADefinition() && 640 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU))) 641 return true; 642 643 return false; 644} 645 646bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) { 647 return VisitDeclContext(D); 648} 649 650bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) { 651 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(), 652 TU))) 653 return true; 654 655 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin(); 656 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(), 657 E = ND->protocol_end(); I != E; ++I, ++PL) 658 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 659 return true; 660 661 return VisitObjCContainerDecl(ND); 662} 663 664bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) { 665 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin(); 666 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(), 667 E = PID->protocol_end(); I != E; ++I, ++PL) 668 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 669 return true; 670 671 return VisitObjCContainerDecl(PID); 672} 673 674bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) { 675 // FIXME: This implements a workaround with @property declarations also being 676 // installed in the DeclContext for the @interface. Eventually this code 677 // should be removed. 678 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext()); 679 if (!CDecl || !CDecl->IsClassExtension()) 680 return false; 681 682 ObjCInterfaceDecl *ID = CDecl->getClassInterface(); 683 if (!ID) 684 return false; 685 686 IdentifierInfo *PropertyId = PD->getIdentifier(); 687 ObjCPropertyDecl *prevDecl = 688 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId); 689 690 if (!prevDecl) 691 return false; 692 693 // Visit synthesized methods since they will be skipped when visiting 694 // the @interface. 695 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl()) 696 if (MD->isSynthesized()) 697 if (Visit(MakeCXCursor(MD, TU))) 698 return true; 699 700 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl()) 701 if (MD->isSynthesized()) 702 if (Visit(MakeCXCursor(MD, TU))) 703 return true; 704 705 return false; 706} 707 708bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) { 709 // Issue callbacks for super class. 710 if (D->getSuperClass() && 711 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(), 712 D->getSuperClassLoc(), 713 TU))) 714 return true; 715 716 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin(); 717 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(), 718 E = D->protocol_end(); I != E; ++I, ++PL) 719 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 720 return true; 721 722 return VisitObjCContainerDecl(D); 723} 724 725bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) { 726 return VisitObjCContainerDecl(D); 727} 728 729bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) { 730 // 'ID' could be null when dealing with invalid code. 731 if (ObjCInterfaceDecl *ID = D->getClassInterface()) 732 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU))) 733 return true; 734 735 return VisitObjCImplDecl(D); 736} 737 738bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) { 739#if 0 740 // Issue callbacks for super class. 741 // FIXME: No source location information! 742 if (D->getSuperClass() && 743 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(), 744 D->getSuperClassLoc(), 745 TU))) 746 return true; 747#endif 748 749 return VisitObjCImplDecl(D); 750} 751 752bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) { 753 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin(); 754 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(), 755 E = D->protocol_end(); 756 I != E; ++I, ++PL) 757 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU))) 758 return true; 759 760 return false; 761} 762 763bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) { 764 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C) 765 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU))) 766 return true; 767 768 return false; 769} 770 771bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) { 772 return VisitDeclContext(D); 773} 774 775bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) { 776 return VisitDeclContext(D); 777} 778 779bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) { 780 ASTContext &Context = TU->getASTContext(); 781 782 // Some builtin types (such as Objective-C's "id", "sel", and 783 // "Class") have associated declarations. Create cursors for those. 784 QualType VisitType; 785 switch (TL.getType()->getAs<BuiltinType>()->getKind()) { 786 case BuiltinType::Void: 787 case BuiltinType::Bool: 788 case BuiltinType::Char_U: 789 case BuiltinType::UChar: 790 case BuiltinType::Char16: 791 case BuiltinType::Char32: 792 case BuiltinType::UShort: 793 case BuiltinType::UInt: 794 case BuiltinType::ULong: 795 case BuiltinType::ULongLong: 796 case BuiltinType::UInt128: 797 case BuiltinType::Char_S: 798 case BuiltinType::SChar: 799 case BuiltinType::WChar: 800 case BuiltinType::Short: 801 case BuiltinType::Int: 802 case BuiltinType::Long: 803 case BuiltinType::LongLong: 804 case BuiltinType::Int128: 805 case BuiltinType::Float: 806 case BuiltinType::Double: 807 case BuiltinType::LongDouble: 808 case BuiltinType::NullPtr: 809 case BuiltinType::Overload: 810 case BuiltinType::Dependent: 811 break; 812 813 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor? 814 break; 815 816 case BuiltinType::ObjCId: 817 VisitType = Context.getObjCIdType(); 818 break; 819 820 case BuiltinType::ObjCClass: 821 VisitType = Context.getObjCClassType(); 822 break; 823 824 case BuiltinType::ObjCSel: 825 VisitType = Context.getObjCSelType(); 826 break; 827 } 828 829 if (!VisitType.isNull()) { 830 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>()) 831 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(), 832 TU)); 833 } 834 835 return false; 836} 837 838bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) { 839 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU)); 840} 841 842bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) { 843 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU)); 844} 845 846bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) { 847 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU)); 848} 849 850bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) { 851 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU))) 852 return true; 853 854 return false; 855} 856 857bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) { 858 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc())) 859 return true; 860 861 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) { 862 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I), 863 TU))) 864 return true; 865 } 866 867 return false; 868} 869 870bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) { 871 return Visit(TL.getPointeeLoc()); 872} 873 874bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) { 875 return Visit(TL.getPointeeLoc()); 876} 877 878bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) { 879 return Visit(TL.getPointeeLoc()); 880} 881 882bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) { 883 return Visit(TL.getPointeeLoc()); 884} 885 886bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) { 887 return Visit(TL.getPointeeLoc()); 888} 889 890bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) { 891 return Visit(TL.getPointeeLoc()); 892} 893 894bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL) { 895 if (Visit(TL.getResultLoc())) 896 return true; 897 898 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I) 899 if (Decl *D = TL.getArg(I)) 900 if (Visit(MakeCXCursor(D, TU))) 901 return true; 902 903 return false; 904} 905 906bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) { 907 if (Visit(TL.getElementLoc())) 908 return true; 909 910 if (Expr *Size = TL.getSizeExpr()) 911 return Visit(MakeCXCursor(Size, StmtParent, TU)); 912 913 return false; 914} 915 916bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) { 917 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU)); 918} 919 920bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) { 921 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo()) 922 return Visit(TSInfo->getTypeLoc()); 923 924 return false; 925} 926 927bool CursorVisitor::VisitStmt(Stmt *S) { 928 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end(); 929 Child != ChildEnd; ++Child) { 930 if (Stmt *C = *Child) 931 if (Visit(MakeCXCursor(C, StmtParent, TU))) 932 return true; 933 } 934 935 return false; 936} 937 938bool CursorVisitor::VisitCaseStmt(CaseStmt *S) { 939 // Specially handle CaseStmts because they can be nested, e.g.: 940 // 941 // case 1: 942 // case 2: 943 // 944 // In this case the second CaseStmt is the child of the first. Walking 945 // these recursively can blow out the stack. 946 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU); 947 while (true) { 948 // Set the Parent field to Cursor, then back to its old value once we're 949 // done. 950 SetParentRAII SetParent(Parent, StmtParent, Cursor); 951 952 if (Stmt *LHS = S->getLHS()) 953 if (Visit(MakeCXCursor(LHS, StmtParent, TU))) 954 return true; 955 if (Stmt *RHS = S->getRHS()) 956 if (Visit(MakeCXCursor(RHS, StmtParent, TU))) 957 return true; 958 if (Stmt *SubStmt = S->getSubStmt()) { 959 if (!isa<CaseStmt>(SubStmt)) 960 return Visit(MakeCXCursor(SubStmt, StmtParent, TU)); 961 962 // Specially handle 'CaseStmt' so that we don't blow out the stack. 963 CaseStmt *CS = cast<CaseStmt>(SubStmt); 964 Cursor = MakeCXCursor(CS, StmtParent, TU); 965 if (RegionOfInterest.isValid()) { 966 SourceRange Range = CS->getSourceRange(); 967 if (Range.isInvalid() || CompareRegionOfInterest(Range)) 968 return false; 969 } 970 971 switch (Visitor(Cursor, Parent, ClientData)) { 972 case CXChildVisit_Break: return true; 973 case CXChildVisit_Continue: return false; 974 case CXChildVisit_Recurse: 975 // Perform tail-recursion manually. 976 S = CS; 977 continue; 978 } 979 } 980 return false; 981 } 982} 983 984bool CursorVisitor::VisitDeclStmt(DeclStmt *S) { 985 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end(); 986 D != DEnd; ++D) { 987 if (*D && Visit(MakeCXCursor(*D, TU))) 988 return true; 989 } 990 991 return false; 992} 993 994bool CursorVisitor::VisitIfStmt(IfStmt *S) { 995 if (VarDecl *Var = S->getConditionVariable()) { 996 if (Visit(MakeCXCursor(Var, TU))) 997 return true; 998 } 999 1000 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1001 return true; 1002 if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU))) 1003 return true; 1004 if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU))) 1005 return true; 1006 1007 return false; 1008} 1009 1010bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) { 1011 if (VarDecl *Var = S->getConditionVariable()) { 1012 if (Visit(MakeCXCursor(Var, TU))) 1013 return true; 1014 } 1015 1016 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1017 return true; 1018 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1019 return true; 1020 1021 return false; 1022} 1023 1024bool CursorVisitor::VisitWhileStmt(WhileStmt *S) { 1025 if (VarDecl *Var = S->getConditionVariable()) { 1026 if (Visit(MakeCXCursor(Var, TU))) 1027 return true; 1028 } 1029 1030 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1031 return true; 1032 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1033 return true; 1034 1035 return false; 1036} 1037 1038bool CursorVisitor::VisitForStmt(ForStmt *S) { 1039 if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU))) 1040 return true; 1041 if (VarDecl *Var = S->getConditionVariable()) { 1042 if (Visit(MakeCXCursor(Var, TU))) 1043 return true; 1044 } 1045 1046 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU))) 1047 return true; 1048 if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU))) 1049 return true; 1050 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU))) 1051 return true; 1052 1053 return false; 1054} 1055 1056bool CursorVisitor::VisitBlockExpr(BlockExpr *B) { 1057 return Visit(B->getBlockDecl()); 1058} 1059 1060bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) { 1061 // FIXME: Visit fields as well? 1062 if (Visit(E->getTypeSourceInfo()->getTypeLoc())) 1063 return true; 1064 1065 return VisitExpr(E); 1066} 1067 1068bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) { 1069 if (E->isArgumentType()) { 1070 if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo()) 1071 return Visit(TSInfo->getTypeLoc()); 1072 1073 return false; 1074 } 1075 1076 return VisitExpr(E); 1077} 1078 1079bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) { 1080 if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten()) 1081 if (Visit(TSInfo->getTypeLoc())) 1082 return true; 1083 1084 return VisitCastExpr(E); 1085} 1086 1087bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) { 1088 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo()) 1089 if (Visit(TSInfo->getTypeLoc())) 1090 return true; 1091 1092 return VisitExpr(E); 1093} 1094 1095bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) { 1096 if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo()) 1097 if (Visit(TSInfo->getTypeLoc())) 1098 return true; 1099 1100 return VisitExpr(E); 1101} 1102 1103bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) { 1104 return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc()); 1105} 1106 1107 1108bool CursorVisitor::VisitAttributes(Decl *D) { 1109 for (const Attr *A = D->getAttrs(); A; A = A->getNext()) 1110 if (Visit(MakeCXCursor(A, D, TU))) 1111 return true; 1112 1113 return false; 1114} 1115 1116extern "C" { 1117CXIndex clang_createIndex(int excludeDeclarationsFromPCH, 1118 int displayDiagnostics) { 1119 CIndexer *CIdxr = new CIndexer(); 1120 if (excludeDeclarationsFromPCH) 1121 CIdxr->setOnlyLocalDecls(); 1122 if (displayDiagnostics) 1123 CIdxr->setDisplayDiagnostics(); 1124 return CIdxr; 1125} 1126 1127void clang_disposeIndex(CXIndex CIdx) { 1128 if (CIdx) 1129 delete static_cast<CIndexer *>(CIdx); 1130} 1131 1132void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) { 1133 if (CIdx) { 1134 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1135 CXXIdx->setUseExternalASTGeneration(value); 1136 } 1137} 1138 1139CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx, 1140 const char *ast_filename) { 1141 if (!CIdx) 1142 return 0; 1143 1144 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1145 1146 llvm::IntrusiveRefCntPtr<Diagnostic> Diags; 1147 return ASTUnit::LoadFromPCHFile(ast_filename, Diags, 1148 CXXIdx->getOnlyLocalDecls(), 1149 0, 0, true); 1150} 1151 1152CXTranslationUnit 1153clang_createTranslationUnitFromSourceFile(CXIndex CIdx, 1154 const char *source_filename, 1155 int num_command_line_args, 1156 const char **command_line_args, 1157 unsigned num_unsaved_files, 1158 struct CXUnsavedFile *unsaved_files) { 1159 if (!CIdx) 1160 return 0; 1161 1162 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx); 1163 1164 // Configure the diagnostics. 1165 DiagnosticOptions DiagOpts; 1166 llvm::IntrusiveRefCntPtr<Diagnostic> Diags; 1167 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0); 1168 1169 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles; 1170 for (unsigned I = 0; I != num_unsaved_files; ++I) { 1171 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length); 1172 const llvm::MemoryBuffer *Buffer 1173 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename); 1174 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename, 1175 Buffer)); 1176 } 1177 1178 if (!CXXIdx->getUseExternalASTGeneration()) { 1179 llvm::SmallVector<const char *, 16> Args; 1180 1181 // The 'source_filename' argument is optional. If the caller does not 1182 // specify it then it is assumed that the source file is specified 1183 // in the actual argument list. 1184 if (source_filename) 1185 Args.push_back(source_filename); 1186 Args.insert(Args.end(), command_line_args, 1187 command_line_args + num_command_line_args); 1188 Args.push_back("-Xclang"); 1189 Args.push_back("-detailed-preprocessing-record"); 1190 unsigned NumErrors = Diags->getNumErrors(); 1191 1192#ifdef USE_CRASHTRACER 1193 ArgsCrashTracerInfo ACTI(Args); 1194#endif 1195 1196 llvm::OwningPtr<ASTUnit> Unit( 1197 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(), 1198 Diags, 1199 CXXIdx->getClangResourcesPath(), 1200 CXXIdx->getOnlyLocalDecls(), 1201 RemappedFiles.data(), 1202 RemappedFiles.size(), 1203 /*CaptureDiagnostics=*/true)); 1204 1205 if (NumErrors != Diags->getNumErrors()) { 1206 // Make sure to check that 'Unit' is non-NULL. 1207 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) { 1208 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(), 1209 DEnd = Unit->stored_diag_end(); 1210 D != DEnd; ++D) { 1211 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions()); 1212 CXString Msg = clang_formatDiagnostic(&Diag, 1213 clang_defaultDiagnosticDisplayOptions()); 1214 fprintf(stderr, "%s\n", clang_getCString(Msg)); 1215 clang_disposeString(Msg); 1216 } 1217#ifdef LLVM_ON_WIN32 1218 // On Windows, force a flush, since there may be multiple copies of 1219 // stderr and stdout in the file system, all with different buffers 1220 // but writing to the same device. 1221 fflush(stderr); 1222#endif 1223 } 1224 } 1225 1226 return Unit.take(); 1227 } 1228 1229 // Build up the arguments for invoking 'clang'. 1230 std::vector<const char *> argv; 1231 1232 // First add the complete path to the 'clang' executable. 1233 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath(); 1234 argv.push_back(ClangPath.c_str()); 1235 1236 // Add the '-emit-ast' option as our execution mode for 'clang'. 1237 argv.push_back("-emit-ast"); 1238 1239 // The 'source_filename' argument is optional. If the caller does not 1240 // specify it then it is assumed that the source file is specified 1241 // in the actual argument list. 1242 if (source_filename) 1243 argv.push_back(source_filename); 1244 1245 // Generate a temporary name for the AST file. 1246 argv.push_back("-o"); 1247 char astTmpFile[L_tmpnam]; 1248 argv.push_back(tmpnam(astTmpFile)); 1249 1250 // Remap any unsaved files to temporary files. 1251 std::vector<llvm::sys::Path> TemporaryFiles; 1252 std::vector<std::string> RemapArgs; 1253 if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles)) 1254 return 0; 1255 1256 // The pointers into the elements of RemapArgs are stable because we 1257 // won't be adding anything to RemapArgs after this point. 1258 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i) 1259 argv.push_back(RemapArgs[i].c_str()); 1260 1261 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'. 1262 for (int i = 0; i < num_command_line_args; ++i) 1263 if (const char *arg = command_line_args[i]) { 1264 if (strcmp(arg, "-o") == 0) { 1265 ++i; // Also skip the matching argument. 1266 continue; 1267 } 1268 if (strcmp(arg, "-emit-ast") == 0 || 1269 strcmp(arg, "-c") == 0 || 1270 strcmp(arg, "-fsyntax-only") == 0) { 1271 continue; 1272 } 1273 1274 // Keep the argument. 1275 argv.push_back(arg); 1276 } 1277 1278 // Generate a temporary name for the diagnostics file. 1279 char tmpFileResults[L_tmpnam]; 1280 char *tmpResultsFileName = tmpnam(tmpFileResults); 1281 llvm::sys::Path DiagnosticsFile(tmpResultsFileName); 1282 TemporaryFiles.push_back(DiagnosticsFile); 1283 argv.push_back("-fdiagnostics-binary"); 1284 1285 argv.push_back("-Xclang"); 1286 argv.push_back("-detailed-preprocessing-record"); 1287 1288 // Add the null terminator. 1289 argv.push_back(NULL); 1290 1291 // Invoke 'clang'. 1292 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null 1293 // on Unix or NUL (Windows). 1294 std::string ErrMsg; 1295 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DiagnosticsFile, 1296 NULL }; 1297 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL, 1298 /* redirects */ &Redirects[0], 1299 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg); 1300 1301 if (!ErrMsg.empty()) { 1302 std::string AllArgs; 1303 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end(); 1304 I != E; ++I) { 1305 AllArgs += ' '; 1306 if (*I) 1307 AllArgs += *I; 1308 } 1309 1310 Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg; 1311 } 1312 1313 ASTUnit *ATU = ASTUnit::LoadFromPCHFile(astTmpFile, Diags, 1314 CXXIdx->getOnlyLocalDecls(), 1315 RemappedFiles.data(), 1316 RemappedFiles.size(), 1317 /*CaptureDiagnostics=*/true); 1318 if (ATU) { 1319 LoadSerializedDiagnostics(DiagnosticsFile, 1320 num_unsaved_files, unsaved_files, 1321 ATU->getFileManager(), 1322 ATU->getSourceManager(), 1323 ATU->getStoredDiagnostics()); 1324 } else if (CXXIdx->getDisplayDiagnostics()) { 1325 // We failed to load the ASTUnit, but we can still deserialize the 1326 // diagnostics and emit them. 1327 FileManager FileMgr; 1328 Diagnostic Diag; 1329 SourceManager SourceMgr(Diag); 1330 // FIXME: Faked LangOpts! 1331 LangOptions LangOpts; 1332 llvm::SmallVector<StoredDiagnostic, 4> Diags; 1333 LoadSerializedDiagnostics(DiagnosticsFile, 1334 num_unsaved_files, unsaved_files, 1335 FileMgr, SourceMgr, Diags); 1336 for (llvm::SmallVector<StoredDiagnostic, 4>::iterator D = Diags.begin(), 1337 DEnd = Diags.end(); 1338 D != DEnd; ++D) { 1339 CXStoredDiagnostic Diag(*D, LangOpts); 1340 CXString Msg = clang_formatDiagnostic(&Diag, 1341 clang_defaultDiagnosticDisplayOptions()); 1342 fprintf(stderr, "%s\n", clang_getCString(Msg)); 1343 clang_disposeString(Msg); 1344 } 1345 1346#ifdef LLVM_ON_WIN32 1347 // On Windows, force a flush, since there may be multiple copies of 1348 // stderr and stdout in the file system, all with different buffers 1349 // but writing to the same device. 1350 fflush(stderr); 1351#endif 1352 } 1353 1354 if (ATU) { 1355 // Make the translation unit responsible for destroying all temporary files. 1356 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i) 1357 ATU->addTemporaryFile(TemporaryFiles[i]); 1358 ATU->addTemporaryFile(llvm::sys::Path(ATU->getPCHFileName())); 1359 } else { 1360 // Destroy all of the temporary files now; they can't be referenced any 1361 // longer. 1362 llvm::sys::Path(astTmpFile).eraseFromDisk(); 1363 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i) 1364 TemporaryFiles[i].eraseFromDisk(); 1365 } 1366 1367 return ATU; 1368} 1369 1370void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) { 1371 if (CTUnit) 1372 delete static_cast<ASTUnit *>(CTUnit); 1373} 1374 1375CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) { 1376 if (!CTUnit) 1377 return createCXString(""); 1378 1379 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit); 1380 return createCXString(CXXUnit->getOriginalSourceFileName(), true); 1381} 1382 1383CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) { 1384 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } }; 1385 return Result; 1386} 1387 1388} // end: extern "C" 1389 1390//===----------------------------------------------------------------------===// 1391// CXSourceLocation and CXSourceRange Operations. 1392//===----------------------------------------------------------------------===// 1393 1394extern "C" { 1395CXSourceLocation clang_getNullLocation() { 1396 CXSourceLocation Result = { { 0, 0 }, 0 }; 1397 return Result; 1398} 1399 1400unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) { 1401 return (loc1.ptr_data[0] == loc2.ptr_data[0] && 1402 loc1.ptr_data[1] == loc2.ptr_data[1] && 1403 loc1.int_data == loc2.int_data); 1404} 1405 1406CXSourceLocation clang_getLocation(CXTranslationUnit tu, 1407 CXFile file, 1408 unsigned line, 1409 unsigned column) { 1410 if (!tu || !file) 1411 return clang_getNullLocation(); 1412 1413 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 1414 SourceLocation SLoc 1415 = CXXUnit->getSourceManager().getLocation( 1416 static_cast<const FileEntry *>(file), 1417 line, column); 1418 1419 return SLoc.isInvalid() ? 1420 clang_getNullLocation() : 1421 cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc); 1422} 1423 1424CXSourceRange clang_getNullRange() { 1425 CXSourceRange Result = { { 0, 0 }, 0, 0 }; 1426 return Result; 1427} 1428 1429CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) { 1430 if (begin.ptr_data[0] != end.ptr_data[0] || 1431 begin.ptr_data[1] != end.ptr_data[1]) 1432 return clang_getNullRange(); 1433 1434 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] }, 1435 begin.int_data, end.int_data }; 1436 return Result; 1437} 1438 1439void clang_getInstantiationLocation(CXSourceLocation location, 1440 CXFile *file, 1441 unsigned *line, 1442 unsigned *column, 1443 unsigned *offset) { 1444 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data); 1445 1446 if (!location.ptr_data[0] || Loc.isInvalid()) { 1447 if (file) 1448 *file = 0; 1449 if (line) 1450 *line = 0; 1451 if (column) 1452 *column = 0; 1453 if (offset) 1454 *offset = 0; 1455 return; 1456 } 1457 1458 const SourceManager &SM = 1459 *static_cast<const SourceManager*>(location.ptr_data[0]); 1460 SourceLocation InstLoc = SM.getInstantiationLoc(Loc); 1461 1462 if (file) 1463 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc)); 1464 if (line) 1465 *line = SM.getInstantiationLineNumber(InstLoc); 1466 if (column) 1467 *column = SM.getInstantiationColumnNumber(InstLoc); 1468 if (offset) 1469 *offset = SM.getDecomposedLoc(InstLoc).second; 1470} 1471 1472CXSourceLocation clang_getRangeStart(CXSourceRange range) { 1473 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] }, 1474 range.begin_int_data }; 1475 return Result; 1476} 1477 1478CXSourceLocation clang_getRangeEnd(CXSourceRange range) { 1479 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] }, 1480 range.end_int_data }; 1481 return Result; 1482} 1483 1484} // end: extern "C" 1485 1486//===----------------------------------------------------------------------===// 1487// CXFile Operations. 1488//===----------------------------------------------------------------------===// 1489 1490extern "C" { 1491CXString clang_getFileName(CXFile SFile) { 1492 if (!SFile) 1493 return createCXString(NULL); 1494 1495 FileEntry *FEnt = static_cast<FileEntry *>(SFile); 1496 return createCXString(FEnt->getName()); 1497} 1498 1499time_t clang_getFileTime(CXFile SFile) { 1500 if (!SFile) 1501 return 0; 1502 1503 FileEntry *FEnt = static_cast<FileEntry *>(SFile); 1504 return FEnt->getModificationTime(); 1505} 1506 1507CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) { 1508 if (!tu) 1509 return 0; 1510 1511 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu); 1512 1513 FileManager &FMgr = CXXUnit->getFileManager(); 1514 const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name)); 1515 return const_cast<FileEntry *>(File); 1516} 1517 1518} // end: extern "C" 1519 1520//===----------------------------------------------------------------------===// 1521// CXCursor Operations. 1522//===----------------------------------------------------------------------===// 1523 1524static Decl *getDeclFromExpr(Stmt *E) { 1525 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E)) 1526 return RefExpr->getDecl(); 1527 if (MemberExpr *ME = dyn_cast<MemberExpr>(E)) 1528 return ME->getMemberDecl(); 1529 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E)) 1530 return RE->getDecl(); 1531 1532 if (CallExpr *CE = dyn_cast<CallExpr>(E)) 1533 return getDeclFromExpr(CE->getCallee()); 1534 if (CastExpr *CE = dyn_cast<CastExpr>(E)) 1535 return getDeclFromExpr(CE->getSubExpr()); 1536 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E)) 1537 return OME->getMethodDecl(); 1538 1539 return 0; 1540} 1541 1542static SourceLocation getLocationFromExpr(Expr *E) { 1543 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E)) 1544 return /*FIXME:*/Msg->getLeftLoc(); 1545 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) 1546 return DRE->getLocation(); 1547 if (MemberExpr *Member = dyn_cast<MemberExpr>(E)) 1548 return Member->getMemberLoc(); 1549 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E)) 1550 return Ivar->getLocation(); 1551 return E->getLocStart(); 1552} 1553 1554extern "C" { 1555 1556unsigned clang_visitChildren(CXCursor parent, 1557 CXCursorVisitor visitor, 1558 CXClientData client_data) { 1559 ASTUnit *CXXUnit = getCursorASTUnit(parent); 1560 1561 unsigned PCHLevel = Decl::MaxPCHLevel; 1562 1563 // Set the PCHLevel to filter out unwanted decls if requested. 1564 if (CXXUnit->getOnlyLocalDecls()) { 1565 PCHLevel = 0; 1566 1567 // If the main input was an AST, bump the level. 1568 if (CXXUnit->isMainFileAST()) 1569 ++PCHLevel; 1570 } 1571 1572 CursorVisitor CursorVis(CXXUnit, visitor, client_data, PCHLevel); 1573 return CursorVis.VisitChildren(parent); 1574} 1575 1576static CXString getDeclSpelling(Decl *D) { 1577 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D); 1578 if (!ND) 1579 return createCXString(""); 1580 1581 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND)) 1582 return createCXString(OMD->getSelector().getAsString()); 1583 1584 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND)) 1585 // No, this isn't the same as the code below. getIdentifier() is non-virtual 1586 // and returns different names. NamedDecl returns the class name and 1587 // ObjCCategoryImplDecl returns the category name. 1588 return createCXString(CIMP->getIdentifier()->getNameStart()); 1589 1590 llvm::SmallString<1024> S; 1591 llvm::raw_svector_ostream os(S); 1592 ND->printName(os); 1593 1594 return createCXString(os.str()); 1595} 1596 1597CXString clang_getCursorSpelling(CXCursor C) { 1598 if (clang_isTranslationUnit(C.kind)) 1599 return clang_getTranslationUnitSpelling(C.data[2]); 1600 1601 if (clang_isReference(C.kind)) { 1602 switch (C.kind) { 1603 case CXCursor_ObjCSuperClassRef: { 1604 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first; 1605 return createCXString(Super->getIdentifier()->getNameStart()); 1606 } 1607 case CXCursor_ObjCClassRef: { 1608 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first; 1609 return createCXString(Class->getIdentifier()->getNameStart()); 1610 } 1611 case CXCursor_ObjCProtocolRef: { 1612 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first; 1613 assert(OID && "getCursorSpelling(): Missing protocol decl"); 1614 return createCXString(OID->getIdentifier()->getNameStart()); 1615 } 1616 case CXCursor_TypeRef: { 1617 TypeDecl *Type = getCursorTypeRef(C).first; 1618 assert(Type && "Missing type decl"); 1619 1620 return createCXString(getCursorContext(C).getTypeDeclType(Type). 1621 getAsString()); 1622 } 1623 1624 default: 1625 return createCXString("<not implemented>"); 1626 } 1627 } 1628 1629 if (clang_isExpression(C.kind)) { 1630 Decl *D = getDeclFromExpr(getCursorExpr(C)); 1631 if (D) 1632 return getDeclSpelling(D); 1633 return createCXString(""); 1634 } 1635 1636 if (C.kind == CXCursor_MacroInstantiation) 1637 return createCXString(getCursorMacroInstantiation(C)->getName() 1638 ->getNameStart()); 1639 1640 if (C.kind == CXCursor_MacroDefinition) 1641 return createCXString(getCursorMacroDefinition(C)->getName() 1642 ->getNameStart()); 1643 1644 if (clang_isDeclaration(C.kind)) 1645 return getDeclSpelling(getCursorDecl(C)); 1646 1647 return createCXString(""); 1648} 1649 1650CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) { 1651 switch (Kind) { 1652 case CXCursor_FunctionDecl: 1653 return createCXString("FunctionDecl"); 1654 case CXCursor_TypedefDecl: 1655 return createCXString("TypedefDecl"); 1656 case CXCursor_EnumDecl: 1657 return createCXString("EnumDecl"); 1658 case CXCursor_EnumConstantDecl: 1659 return createCXString("EnumConstantDecl"); 1660 case CXCursor_StructDecl: 1661 return createCXString("StructDecl"); 1662 case CXCursor_UnionDecl: 1663 return createCXString("UnionDecl"); 1664 case CXCursor_ClassDecl: 1665 return createCXString("ClassDecl"); 1666 case CXCursor_FieldDecl: 1667 return createCXString("FieldDecl"); 1668 case CXCursor_VarDecl: 1669 return createCXString("VarDecl"); 1670 case CXCursor_ParmDecl: 1671 return createCXString("ParmDecl"); 1672 case CXCursor_ObjCInterfaceDecl: 1673 return createCXString("ObjCInterfaceDecl"); 1674 case CXCursor_ObjCCategoryDecl: 1675 return createCXString("ObjCCategoryDecl"); 1676 case CXCursor_ObjCProtocolDecl: 1677 return createCXString("ObjCProtocolDecl"); 1678 case CXCursor_ObjCPropertyDecl: 1679 return createCXString("ObjCPropertyDecl"); 1680 case CXCursor_ObjCIvarDecl: 1681 return createCXString("ObjCIvarDecl"); 1682 case CXCursor_ObjCInstanceMethodDecl: 1683 return createCXString("ObjCInstanceMethodDecl"); 1684 case CXCursor_ObjCClassMethodDecl: 1685 return createCXString("ObjCClassMethodDecl"); 1686 case CXCursor_ObjCImplementationDecl: 1687 return createCXString("ObjCImplementationDecl"); 1688 case CXCursor_ObjCCategoryImplDecl: 1689 return createCXString("ObjCCategoryImplDecl"); 1690 case CXCursor_CXXMethod: 1691 return createCXString("CXXMethod"); 1692 case CXCursor_UnexposedDecl: 1693 return createCXString("UnexposedDecl"); 1694 case CXCursor_ObjCSuperClassRef: 1695 return createCXString("ObjCSuperClassRef"); 1696 case CXCursor_ObjCProtocolRef: 1697 return createCXString("ObjCProtocolRef"); 1698 case CXCursor_ObjCClassRef: 1699 return createCXString("ObjCClassRef"); 1700 case CXCursor_TypeRef: 1701 return createCXString("TypeRef"); 1702 case CXCursor_UnexposedExpr: 1703 return createCXString("UnexposedExpr"); 1704 case CXCursor_BlockExpr: 1705 return createCXString("BlockExpr"); 1706 case CXCursor_DeclRefExpr: 1707 return createCXString("DeclRefExpr"); 1708 case CXCursor_MemberRefExpr: 1709 return createCXString("MemberRefExpr"); 1710 case CXCursor_CallExpr: 1711 return createCXString("CallExpr"); 1712 case CXCursor_ObjCMessageExpr: 1713 return createCXString("ObjCMessageExpr"); 1714 case CXCursor_UnexposedStmt: 1715 return createCXString("UnexposedStmt"); 1716 case CXCursor_InvalidFile: 1717 return createCXString("InvalidFile"); 1718 case CXCursor_InvalidCode: 1719 return createCXString("InvalidCode"); 1720 case CXCursor_NoDeclFound: 1721 return createCXString("NoDeclFound"); 1722 case CXCursor_NotImplemented: 1723 return createCXString("NotImplemented"); 1724 case CXCursor_TranslationUnit: 1725 return createCXString("TranslationUnit"); 1726 case CXCursor_UnexposedAttr: 1727 return createCXString("UnexposedAttr"); 1728 case CXCursor_IBActionAttr: 1729 return createCXString("attribute(ibaction)"); 1730 case CXCursor_IBOutletAttr: 1731 return createCXString("attribute(iboutlet)"); 1732 case CXCursor_IBOutletCollectionAttr: 1733 return createCXString("attribute(iboutletcollection)"); 1734 case CXCursor_PreprocessingDirective: 1735 return createCXString("preprocessing directive"); 1736 case CXCursor_MacroDefinition: 1737 return createCXString("macro definition"); 1738 case CXCursor_MacroInstantiation: 1739 return createCXString("macro instantiation"); 1740 case CXCursor_Namespace: 1741 return createCXString("Namespace"); 1742 case CXCursor_LinkageSpec: 1743 return createCXString("LinkageSpec"); 1744 } 1745 1746 llvm_unreachable("Unhandled CXCursorKind"); 1747 return createCXString(NULL); 1748} 1749 1750enum CXChildVisitResult GetCursorVisitor(CXCursor cursor, 1751 CXCursor parent, 1752 CXClientData client_data) { 1753 CXCursor *BestCursor = static_cast<CXCursor *>(client_data); 1754 *BestCursor = cursor; 1755 return CXChildVisit_Recurse; 1756} 1757 1758CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) { 1759 if (!TU) 1760 return clang_getNullCursor(); 1761 1762 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU); 1763 1764 ASTUnit::ConcurrencyCheck Check(*CXXUnit); 1765 1766 SourceLocation SLoc = cxloc::translateSourceLocation(Loc); 1767 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound); 1768 if (SLoc.isValid()) { 1769 SourceRange RegionOfInterest(SLoc, SLoc.getFileLocWithOffset(1)); 1770 1771 // FIXME: Would be great to have a "hint" cursor, then walk from that 1772 // hint cursor upward until we find a cursor whose source range encloses 1773 // the region of interest, rather than starting from the translation unit. 1774 CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit); 1775 CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result, 1776 Decl::MaxPCHLevel, RegionOfInterest); 1777 CursorVis.VisitChildren(Parent); 1778 } 1779 return Result; 1780} 1781 1782CXCursor clang_getNullCursor(void) { 1783 return MakeCXCursorInvalid(CXCursor_InvalidFile); 1784} 1785 1786unsigned clang_equalCursors(CXCursor X, CXCursor Y) { 1787 return X == Y; 1788} 1789 1790unsigned clang_isInvalid(enum CXCursorKind K) { 1791 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid; 1792} 1793 1794unsigned clang_isDeclaration(enum CXCursorKind K) { 1795 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl; 1796} 1797 1798unsigned clang_isReference(enum CXCursorKind K) { 1799 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef; 1800} 1801 1802unsigned clang_isExpression(enum CXCursorKind K) { 1803 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr; 1804} 1805 1806unsigned clang_isStatement(enum CXCursorKind K) { 1807 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt; 1808} 1809 1810unsigned clang_isTranslationUnit(enum CXCursorKind K) { 1811 return K == CXCursor_TranslationUnit; 1812} 1813 1814unsigned clang_isPreprocessing(enum CXCursorKind K) { 1815 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing; 1816} 1817 1818unsigned clang_isUnexposed(enum CXCursorKind K) { 1819 switch (K) { 1820 case CXCursor_UnexposedDecl: 1821 case CXCursor_UnexposedExpr: 1822 case CXCursor_UnexposedStmt: 1823 case CXCursor_UnexposedAttr: 1824 return true; 1825 default: 1826 return false; 1827 } 1828} 1829 1830CXCursorKind clang_getCursorKind(CXCursor C) { 1831 return C.kind; 1832} 1833 1834CXSourceLocation clang_getCursorLocation(CXCursor C) { 1835 if (clang_isReference(C.kind)) { 1836 switch (C.kind) { 1837 case CXCursor_ObjCSuperClassRef: { 1838 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1839 = getCursorObjCSuperClassRef(C); 1840 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1841 } 1842 1843 case CXCursor_ObjCProtocolRef: { 1844 std::pair<ObjCProtocolDecl *, SourceLocation> P 1845 = getCursorObjCProtocolRef(C); 1846 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1847 } 1848 1849 case CXCursor_ObjCClassRef: { 1850 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1851 = getCursorObjCClassRef(C); 1852 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1853 } 1854 1855 case CXCursor_TypeRef: { 1856 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C); 1857 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second); 1858 } 1859 1860 default: 1861 // FIXME: Need a way to enumerate all non-reference cases. 1862 llvm_unreachable("Missed a reference kind"); 1863 } 1864 } 1865 1866 if (clang_isExpression(C.kind)) 1867 return cxloc::translateSourceLocation(getCursorContext(C), 1868 getLocationFromExpr(getCursorExpr(C))); 1869 1870 if (C.kind == CXCursor_PreprocessingDirective) { 1871 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin(); 1872 return cxloc::translateSourceLocation(getCursorContext(C), L); 1873 } 1874 1875 if (C.kind == CXCursor_MacroInstantiation) { 1876 SourceLocation L 1877 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin(); 1878 return cxloc::translateSourceLocation(getCursorContext(C), L); 1879 } 1880 1881 if (C.kind == CXCursor_MacroDefinition) { 1882 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation(); 1883 return cxloc::translateSourceLocation(getCursorContext(C), L); 1884 } 1885 1886 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl) 1887 return clang_getNullLocation(); 1888 1889 Decl *D = getCursorDecl(C); 1890 SourceLocation Loc = D->getLocation(); 1891 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D)) 1892 Loc = Class->getClassLoc(); 1893 return cxloc::translateSourceLocation(getCursorContext(C), Loc); 1894} 1895 1896CXSourceRange clang_getCursorExtent(CXCursor C) { 1897 if (clang_isReference(C.kind)) { 1898 switch (C.kind) { 1899 case CXCursor_ObjCSuperClassRef: { 1900 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1901 = getCursorObjCSuperClassRef(C); 1902 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1903 } 1904 1905 case CXCursor_ObjCProtocolRef: { 1906 std::pair<ObjCProtocolDecl *, SourceLocation> P 1907 = getCursorObjCProtocolRef(C); 1908 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1909 } 1910 1911 case CXCursor_ObjCClassRef: { 1912 std::pair<ObjCInterfaceDecl *, SourceLocation> P 1913 = getCursorObjCClassRef(C); 1914 1915 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1916 } 1917 1918 case CXCursor_TypeRef: { 1919 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C); 1920 return cxloc::translateSourceRange(P.first->getASTContext(), P.second); 1921 } 1922 1923 default: 1924 // FIXME: Need a way to enumerate all non-reference cases. 1925 llvm_unreachable("Missed a reference kind"); 1926 } 1927 } 1928 1929 if (clang_isExpression(C.kind)) 1930 return cxloc::translateSourceRange(getCursorContext(C), 1931 getCursorExpr(C)->getSourceRange()); 1932 1933 if (clang_isStatement(C.kind)) 1934 return cxloc::translateSourceRange(getCursorContext(C), 1935 getCursorStmt(C)->getSourceRange()); 1936 1937 if (C.kind == CXCursor_PreprocessingDirective) { 1938 SourceRange R = cxcursor::getCursorPreprocessingDirective(C); 1939 return cxloc::translateSourceRange(getCursorContext(C), R); 1940 } 1941 1942 if (C.kind == CXCursor_MacroInstantiation) { 1943 SourceRange R = cxcursor::getCursorMacroInstantiation(C)->getSourceRange(); 1944 return cxloc::translateSourceRange(getCursorContext(C), R); 1945 } 1946 1947 if (C.kind == CXCursor_MacroDefinition) { 1948 SourceRange R = cxcursor::getCursorMacroDefinition(C)->getSourceRange(); 1949 return cxloc::translateSourceRange(getCursorContext(C), R); 1950 } 1951 1952 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl) 1953 return clang_getNullRange(); 1954 1955 Decl *D = getCursorDecl(C); 1956 return cxloc::translateSourceRange(getCursorContext(C), D->getSourceRange()); 1957} 1958 1959CXCursor clang_getCursorReferenced(CXCursor C) { 1960 if (clang_isInvalid(C.kind)) 1961 return clang_getNullCursor(); 1962 1963 ASTUnit *CXXUnit = getCursorASTUnit(C); 1964 if (clang_isDeclaration(C.kind)) 1965 return C; 1966 1967 if (clang_isExpression(C.kind)) { 1968 Decl *D = getDeclFromExpr(getCursorExpr(C)); 1969 if (D) 1970 return MakeCXCursor(D, CXXUnit); 1971 return clang_getNullCursor(); 1972 } 1973 1974 if (C.kind == CXCursor_MacroInstantiation) { 1975 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition()) 1976 return MakeMacroDefinitionCursor(Def, CXXUnit); 1977 } 1978 1979 if (!clang_isReference(C.kind)) 1980 return clang_getNullCursor(); 1981 1982 switch (C.kind) { 1983 case CXCursor_ObjCSuperClassRef: 1984 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit); 1985 1986 case CXCursor_ObjCProtocolRef: { 1987 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit); 1988 1989 case CXCursor_ObjCClassRef: 1990 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit); 1991 1992 case CXCursor_TypeRef: 1993 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit); 1994 1995 default: 1996 // We would prefer to enumerate all non-reference cursor kinds here. 1997 llvm_unreachable("Unhandled reference cursor kind"); 1998 break; 1999 } 2000 } 2001 2002 return clang_getNullCursor(); 2003} 2004 2005CXCursor clang_getCursorDefinition(CXCursor C) { 2006 if (clang_isInvalid(C.kind)) 2007 return clang_getNullCursor(); 2008 2009 ASTUnit *CXXUnit = getCursorASTUnit(C); 2010 2011 bool WasReference = false; 2012 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) { 2013 C = clang_getCursorReferenced(C); 2014 WasReference = true; 2015 } 2016 2017 if (C.kind == CXCursor_MacroInstantiation) 2018 return clang_getCursorReferenced(C); 2019 2020 if (!clang_isDeclaration(C.kind)) 2021 return clang_getNullCursor(); 2022 2023 Decl *D = getCursorDecl(C); 2024 if (!D) 2025 return clang_getNullCursor(); 2026 2027 switch (D->getKind()) { 2028 // Declaration kinds that don't really separate the notions of 2029 // declaration and definition. 2030 case Decl::Namespace: 2031 case Decl::Typedef: 2032 case Decl::TemplateTypeParm: 2033 case Decl::EnumConstant: 2034 case Decl::Field: 2035 case Decl::ObjCIvar: 2036 case Decl::ObjCAtDefsField: 2037 case Decl::ImplicitParam: 2038 case Decl::ParmVar: 2039 case Decl::NonTypeTemplateParm: 2040 case Decl::TemplateTemplateParm: 2041 case Decl::ObjCCategoryImpl: 2042 case Decl::ObjCImplementation: 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