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