CXCursor.cpp revision f59edb96b2d0bfe612b732f19519ab84bb995bd4
1//===- CXCursor.cpp - Routines for manipulating CXCursors -----------------===// 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 defines routines for manipulating CXCursors. It should be the 11// only file that has internal knowledge of the encoding of the data in 12// CXCursor. 13// 14//===----------------------------------------------------------------------===// 15 16#include "CXTranslationUnit.h" 17#include "CXCursor.h" 18#include "CXString.h" 19#include "CXType.h" 20#include "clang-c/Index.h" 21#include "clang/AST/Decl.h" 22#include "clang/AST/DeclCXX.h" 23#include "clang/AST/DeclObjC.h" 24#include "clang/AST/DeclTemplate.h" 25#include "clang/AST/Expr.h" 26#include "clang/AST/ExprCXX.h" 27#include "clang/AST/ExprObjC.h" 28#include "clang/Frontend/ASTUnit.h" 29#include "llvm/Support/ErrorHandling.h" 30 31using namespace clang; 32using namespace cxcursor; 33 34CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K, CXTranslationUnit TU) { 35 assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid); 36 CXCursor C = { K, 0, { 0, 0, TU } }; 37 return C; 38} 39 40static CXCursorKind GetCursorKind(const Attr *A) { 41 assert(A && "Invalid arguments!"); 42 switch (A->getKind()) { 43 default: break; 44 case attr::IBAction: return CXCursor_IBActionAttr; 45 case attr::IBOutlet: return CXCursor_IBOutletAttr; 46 case attr::IBOutletCollection: return CXCursor_IBOutletCollectionAttr; 47 case attr::Final: return CXCursor_CXXFinalAttr; 48 case attr::Override: return CXCursor_CXXOverrideAttr; 49 case attr::Annotate: return CXCursor_AnnotateAttr; 50 case attr::AsmLabel: return CXCursor_AsmLabelAttr; 51 } 52 53 return CXCursor_UnexposedAttr; 54} 55 56CXCursor cxcursor::MakeCXCursor(const Attr *A, Decl *Parent, 57 CXTranslationUnit TU) { 58 assert(A && Parent && TU && "Invalid arguments!"); 59 CXCursor C = { GetCursorKind(A), 0, { Parent, (void*)A, TU } }; 60 return C; 61} 62 63CXCursor cxcursor::MakeCXCursor(Decl *D, CXTranslationUnit TU, 64 SourceRange RegionOfInterest, 65 bool FirstInDeclGroup) { 66 assert(D && TU && "Invalid arguments!"); 67 68 CXCursorKind K = getCursorKindForDecl(D); 69 70 if (K == CXCursor_ObjCClassMethodDecl || 71 K == CXCursor_ObjCInstanceMethodDecl) { 72 int SelectorIdIndex = -1; 73 // Check if cursor points to a selector id. 74 if (RegionOfInterest.isValid() && 75 RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) { 76 SmallVector<SourceLocation, 16> SelLocs; 77 cast<ObjCMethodDecl>(D)->getSelectorLocs(SelLocs); 78 SmallVector<SourceLocation, 16>::iterator 79 I=std::find(SelLocs.begin(), SelLocs.end(),RegionOfInterest.getBegin()); 80 if (I != SelLocs.end()) 81 SelectorIdIndex = I - SelLocs.begin(); 82 } 83 CXCursor C = { K, SelectorIdIndex, 84 { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }}; 85 return C; 86 } 87 88 CXCursor C = { K, 0, { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }}; 89 return C; 90} 91 92CXCursor cxcursor::MakeCXCursor(Stmt *S, Decl *Parent, CXTranslationUnit TU, 93 SourceRange RegionOfInterest) { 94 assert(S && TU && "Invalid arguments!"); 95 CXCursorKind K = CXCursor_NotImplemented; 96 97 switch (S->getStmtClass()) { 98 case Stmt::NoStmtClass: 99 break; 100 101 case Stmt::CaseStmtClass: 102 K = CXCursor_CaseStmt; 103 break; 104 105 case Stmt::DefaultStmtClass: 106 K = CXCursor_DefaultStmt; 107 break; 108 109 case Stmt::IfStmtClass: 110 K = CXCursor_IfStmt; 111 break; 112 113 case Stmt::SwitchStmtClass: 114 K = CXCursor_SwitchStmt; 115 break; 116 117 case Stmt::WhileStmtClass: 118 K = CXCursor_WhileStmt; 119 break; 120 121 case Stmt::DoStmtClass: 122 K = CXCursor_DoStmt; 123 break; 124 125 case Stmt::ForStmtClass: 126 K = CXCursor_ForStmt; 127 break; 128 129 case Stmt::GotoStmtClass: 130 K = CXCursor_GotoStmt; 131 break; 132 133 case Stmt::IndirectGotoStmtClass: 134 K = CXCursor_IndirectGotoStmt; 135 break; 136 137 case Stmt::ContinueStmtClass: 138 K = CXCursor_ContinueStmt; 139 break; 140 141 case Stmt::BreakStmtClass: 142 K = CXCursor_BreakStmt; 143 break; 144 145 case Stmt::ReturnStmtClass: 146 K = CXCursor_ReturnStmt; 147 break; 148 149 case Stmt::GCCAsmStmtClass: 150 K = CXCursor_GCCAsmStmt; 151 break; 152 153 case Stmt::MSAsmStmtClass: 154 K = CXCursor_MSAsmStmt; 155 break; 156 157 case Stmt::ObjCAtTryStmtClass: 158 K = CXCursor_ObjCAtTryStmt; 159 break; 160 161 case Stmt::ObjCAtCatchStmtClass: 162 K = CXCursor_ObjCAtCatchStmt; 163 break; 164 165 case Stmt::ObjCAtFinallyStmtClass: 166 K = CXCursor_ObjCAtFinallyStmt; 167 break; 168 169 case Stmt::ObjCAtThrowStmtClass: 170 K = CXCursor_ObjCAtThrowStmt; 171 break; 172 173 case Stmt::ObjCAtSynchronizedStmtClass: 174 K = CXCursor_ObjCAtSynchronizedStmt; 175 break; 176 177 case Stmt::ObjCAutoreleasePoolStmtClass: 178 K = CXCursor_ObjCAutoreleasePoolStmt; 179 break; 180 181 case Stmt::ObjCForCollectionStmtClass: 182 K = CXCursor_ObjCForCollectionStmt; 183 break; 184 185 case Stmt::CXXCatchStmtClass: 186 K = CXCursor_CXXCatchStmt; 187 break; 188 189 case Stmt::CXXTryStmtClass: 190 K = CXCursor_CXXTryStmt; 191 break; 192 193 case Stmt::CXXForRangeStmtClass: 194 K = CXCursor_CXXForRangeStmt; 195 break; 196 197 case Stmt::SEHTryStmtClass: 198 K = CXCursor_SEHTryStmt; 199 break; 200 201 case Stmt::SEHExceptStmtClass: 202 K = CXCursor_SEHExceptStmt; 203 break; 204 205 case Stmt::SEHFinallyStmtClass: 206 K = CXCursor_SEHFinallyStmt; 207 break; 208 209 case Stmt::ArrayTypeTraitExprClass: 210 case Stmt::AsTypeExprClass: 211 case Stmt::AtomicExprClass: 212 case Stmt::BinaryConditionalOperatorClass: 213 case Stmt::BinaryTypeTraitExprClass: 214 case Stmt::TypeTraitExprClass: 215 case Stmt::CXXBindTemporaryExprClass: 216 case Stmt::CXXDefaultArgExprClass: 217 case Stmt::CXXScalarValueInitExprClass: 218 case Stmt::CXXUuidofExprClass: 219 case Stmt::ChooseExprClass: 220 case Stmt::DesignatedInitExprClass: 221 case Stmt::ExprWithCleanupsClass: 222 case Stmt::ExpressionTraitExprClass: 223 case Stmt::ExtVectorElementExprClass: 224 case Stmt::ImplicitCastExprClass: 225 case Stmt::ImplicitValueInitExprClass: 226 case Stmt::MaterializeTemporaryExprClass: 227 case Stmt::ObjCIndirectCopyRestoreExprClass: 228 case Stmt::OffsetOfExprClass: 229 case Stmt::ParenListExprClass: 230 case Stmt::PredefinedExprClass: 231 case Stmt::ShuffleVectorExprClass: 232 case Stmt::UnaryExprOrTypeTraitExprClass: 233 case Stmt::UnaryTypeTraitExprClass: 234 case Stmt::VAArgExprClass: 235 case Stmt::ObjCArrayLiteralClass: 236 case Stmt::ObjCDictionaryLiteralClass: 237 case Stmt::ObjCBoxedExprClass: 238 case Stmt::ObjCSubscriptRefExprClass: 239 K = CXCursor_UnexposedExpr; 240 break; 241 242 case Stmt::OpaqueValueExprClass: 243 if (Expr *Src = cast<OpaqueValueExpr>(S)->getSourceExpr()) 244 return MakeCXCursor(Src, Parent, TU, RegionOfInterest); 245 K = CXCursor_UnexposedExpr; 246 break; 247 248 case Stmt::PseudoObjectExprClass: 249 return MakeCXCursor(cast<PseudoObjectExpr>(S)->getSyntacticForm(), 250 Parent, TU, RegionOfInterest); 251 252 case Stmt::CompoundStmtClass: 253 K = CXCursor_CompoundStmt; 254 break; 255 256 case Stmt::NullStmtClass: 257 K = CXCursor_NullStmt; 258 break; 259 260 case Stmt::LabelStmtClass: 261 K = CXCursor_LabelStmt; 262 break; 263 264 case Stmt::AttributedStmtClass: 265 K = CXCursor_UnexposedStmt; 266 break; 267 268 case Stmt::DeclStmtClass: 269 K = CXCursor_DeclStmt; 270 break; 271 272 case Stmt::IntegerLiteralClass: 273 K = CXCursor_IntegerLiteral; 274 break; 275 276 case Stmt::FloatingLiteralClass: 277 K = CXCursor_FloatingLiteral; 278 break; 279 280 case Stmt::ImaginaryLiteralClass: 281 K = CXCursor_ImaginaryLiteral; 282 break; 283 284 case Stmt::StringLiteralClass: 285 K = CXCursor_StringLiteral; 286 break; 287 288 case Stmt::CharacterLiteralClass: 289 K = CXCursor_CharacterLiteral; 290 break; 291 292 case Stmt::ParenExprClass: 293 K = CXCursor_ParenExpr; 294 break; 295 296 case Stmt::UnaryOperatorClass: 297 K = CXCursor_UnaryOperator; 298 break; 299 300 case Stmt::CXXNoexceptExprClass: 301 K = CXCursor_UnaryExpr; 302 break; 303 304 case Stmt::ArraySubscriptExprClass: 305 K = CXCursor_ArraySubscriptExpr; 306 break; 307 308 case Stmt::BinaryOperatorClass: 309 K = CXCursor_BinaryOperator; 310 break; 311 312 case Stmt::CompoundAssignOperatorClass: 313 K = CXCursor_CompoundAssignOperator; 314 break; 315 316 case Stmt::ConditionalOperatorClass: 317 K = CXCursor_ConditionalOperator; 318 break; 319 320 case Stmt::CStyleCastExprClass: 321 K = CXCursor_CStyleCastExpr; 322 break; 323 324 case Stmt::CompoundLiteralExprClass: 325 K = CXCursor_CompoundLiteralExpr; 326 break; 327 328 case Stmt::InitListExprClass: 329 K = CXCursor_InitListExpr; 330 break; 331 332 case Stmt::AddrLabelExprClass: 333 K = CXCursor_AddrLabelExpr; 334 break; 335 336 case Stmt::StmtExprClass: 337 K = CXCursor_StmtExpr; 338 break; 339 340 case Stmt::GenericSelectionExprClass: 341 K = CXCursor_GenericSelectionExpr; 342 break; 343 344 case Stmt::GNUNullExprClass: 345 K = CXCursor_GNUNullExpr; 346 break; 347 348 case Stmt::CXXStaticCastExprClass: 349 K = CXCursor_CXXStaticCastExpr; 350 break; 351 352 case Stmt::CXXDynamicCastExprClass: 353 K = CXCursor_CXXDynamicCastExpr; 354 break; 355 356 case Stmt::CXXReinterpretCastExprClass: 357 K = CXCursor_CXXReinterpretCastExpr; 358 break; 359 360 case Stmt::CXXConstCastExprClass: 361 K = CXCursor_CXXConstCastExpr; 362 break; 363 364 case Stmt::CXXFunctionalCastExprClass: 365 K = CXCursor_CXXFunctionalCastExpr; 366 break; 367 368 case Stmt::CXXTypeidExprClass: 369 K = CXCursor_CXXTypeidExpr; 370 break; 371 372 case Stmt::CXXBoolLiteralExprClass: 373 K = CXCursor_CXXBoolLiteralExpr; 374 break; 375 376 case Stmt::CXXNullPtrLiteralExprClass: 377 K = CXCursor_CXXNullPtrLiteralExpr; 378 break; 379 380 case Stmt::CXXThisExprClass: 381 K = CXCursor_CXXThisExpr; 382 break; 383 384 case Stmt::CXXThrowExprClass: 385 K = CXCursor_CXXThrowExpr; 386 break; 387 388 case Stmt::CXXNewExprClass: 389 K = CXCursor_CXXNewExpr; 390 break; 391 392 case Stmt::CXXDeleteExprClass: 393 K = CXCursor_CXXDeleteExpr; 394 break; 395 396 case Stmt::ObjCStringLiteralClass: 397 K = CXCursor_ObjCStringLiteral; 398 break; 399 400 case Stmt::ObjCEncodeExprClass: 401 K = CXCursor_ObjCEncodeExpr; 402 break; 403 404 case Stmt::ObjCSelectorExprClass: 405 K = CXCursor_ObjCSelectorExpr; 406 break; 407 408 case Stmt::ObjCProtocolExprClass: 409 K = CXCursor_ObjCProtocolExpr; 410 break; 411 412 case Stmt::ObjCBoolLiteralExprClass: 413 K = CXCursor_ObjCBoolLiteralExpr; 414 break; 415 416 case Stmt::ObjCBridgedCastExprClass: 417 K = CXCursor_ObjCBridgedCastExpr; 418 break; 419 420 case Stmt::BlockExprClass: 421 K = CXCursor_BlockExpr; 422 break; 423 424 case Stmt::PackExpansionExprClass: 425 K = CXCursor_PackExpansionExpr; 426 break; 427 428 case Stmt::SizeOfPackExprClass: 429 K = CXCursor_SizeOfPackExpr; 430 break; 431 432 case Stmt::DeclRefExprClass: 433 case Stmt::DependentScopeDeclRefExprClass: 434 case Stmt::SubstNonTypeTemplateParmExprClass: 435 case Stmt::SubstNonTypeTemplateParmPackExprClass: 436 case Stmt::FunctionParmPackExprClass: 437 case Stmt::UnresolvedLookupExprClass: 438 K = CXCursor_DeclRefExpr; 439 break; 440 441 case Stmt::CXXDependentScopeMemberExprClass: 442 case Stmt::CXXPseudoDestructorExprClass: 443 case Stmt::MemberExprClass: 444 case Stmt::ObjCIsaExprClass: 445 case Stmt::ObjCIvarRefExprClass: 446 case Stmt::ObjCPropertyRefExprClass: 447 case Stmt::UnresolvedMemberExprClass: 448 K = CXCursor_MemberRefExpr; 449 break; 450 451 case Stmt::CallExprClass: 452 case Stmt::CXXOperatorCallExprClass: 453 case Stmt::CXXMemberCallExprClass: 454 case Stmt::CUDAKernelCallExprClass: 455 case Stmt::CXXConstructExprClass: 456 case Stmt::CXXTemporaryObjectExprClass: 457 case Stmt::CXXUnresolvedConstructExprClass: 458 case Stmt::UserDefinedLiteralClass: 459 K = CXCursor_CallExpr; 460 break; 461 462 case Stmt::LambdaExprClass: 463 K = CXCursor_LambdaExpr; 464 break; 465 466 case Stmt::ObjCMessageExprClass: { 467 K = CXCursor_ObjCMessageExpr; 468 int SelectorIdIndex = -1; 469 // Check if cursor points to a selector id. 470 if (RegionOfInterest.isValid() && 471 RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) { 472 SmallVector<SourceLocation, 16> SelLocs; 473 cast<ObjCMessageExpr>(S)->getSelectorLocs(SelLocs); 474 SmallVector<SourceLocation, 16>::iterator 475 I=std::find(SelLocs.begin(), SelLocs.end(),RegionOfInterest.getBegin()); 476 if (I != SelLocs.end()) 477 SelectorIdIndex = I - SelLocs.begin(); 478 } 479 CXCursor C = { K, 0, { Parent, S, TU } }; 480 return getSelectorIdentifierCursor(SelectorIdIndex, C); 481 } 482 483 case Stmt::MSDependentExistsStmtClass: 484 K = CXCursor_UnexposedStmt; 485 break; 486 } 487 488 CXCursor C = { K, 0, { Parent, S, TU } }; 489 return C; 490} 491 492CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super, 493 SourceLocation Loc, 494 CXTranslationUnit TU) { 495 assert(Super && TU && "Invalid arguments!"); 496 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 497 CXCursor C = { CXCursor_ObjCSuperClassRef, 0, { Super, RawLoc, TU } }; 498 return C; 499} 500 501std::pair<ObjCInterfaceDecl *, SourceLocation> 502cxcursor::getCursorObjCSuperClassRef(CXCursor C) { 503 assert(C.kind == CXCursor_ObjCSuperClassRef); 504 return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]), 505 SourceLocation::getFromRawEncoding( 506 reinterpret_cast<uintptr_t>(C.data[1]))); 507} 508 509CXCursor cxcursor::MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto, 510 SourceLocation Loc, 511 CXTranslationUnit TU) { 512 assert(Proto && TU && "Invalid arguments!"); 513 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 514 CXCursor C = { CXCursor_ObjCProtocolRef, 0, { (void*)Proto, RawLoc, TU } }; 515 return C; 516} 517 518std::pair<ObjCProtocolDecl *, SourceLocation> 519cxcursor::getCursorObjCProtocolRef(CXCursor C) { 520 assert(C.kind == CXCursor_ObjCProtocolRef); 521 return std::make_pair(static_cast<ObjCProtocolDecl *>(C.data[0]), 522 SourceLocation::getFromRawEncoding( 523 reinterpret_cast<uintptr_t>(C.data[1]))); 524} 525 526CXCursor cxcursor::MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class, 527 SourceLocation Loc, 528 CXTranslationUnit TU) { 529 // 'Class' can be null for invalid code. 530 if (!Class) 531 return MakeCXCursorInvalid(CXCursor_InvalidCode); 532 assert(TU && "Invalid arguments!"); 533 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 534 CXCursor C = { CXCursor_ObjCClassRef, 0, { (void*)Class, RawLoc, TU } }; 535 return C; 536} 537 538std::pair<ObjCInterfaceDecl *, SourceLocation> 539cxcursor::getCursorObjCClassRef(CXCursor C) { 540 assert(C.kind == CXCursor_ObjCClassRef); 541 return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]), 542 SourceLocation::getFromRawEncoding( 543 reinterpret_cast<uintptr_t>(C.data[1]))); 544} 545 546CXCursor cxcursor::MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc, 547 CXTranslationUnit TU) { 548 assert(Type && TU && "Invalid arguments!"); 549 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 550 CXCursor C = { CXCursor_TypeRef, 0, { (void*)Type, RawLoc, TU } }; 551 return C; 552} 553 554std::pair<TypeDecl *, SourceLocation> 555cxcursor::getCursorTypeRef(CXCursor C) { 556 assert(C.kind == CXCursor_TypeRef); 557 return std::make_pair(static_cast<TypeDecl *>(C.data[0]), 558 SourceLocation::getFromRawEncoding( 559 reinterpret_cast<uintptr_t>(C.data[1]))); 560} 561 562CXCursor cxcursor::MakeCursorTemplateRef(const TemplateDecl *Template, 563 SourceLocation Loc, 564 CXTranslationUnit TU) { 565 assert(Template && TU && "Invalid arguments!"); 566 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 567 CXCursor C = { CXCursor_TemplateRef, 0, { (void*)Template, RawLoc, TU } }; 568 return C; 569} 570 571std::pair<TemplateDecl *, SourceLocation> 572cxcursor::getCursorTemplateRef(CXCursor C) { 573 assert(C.kind == CXCursor_TemplateRef); 574 return std::make_pair(static_cast<TemplateDecl *>(C.data[0]), 575 SourceLocation::getFromRawEncoding( 576 reinterpret_cast<uintptr_t>(C.data[1]))); 577} 578 579CXCursor cxcursor::MakeCursorNamespaceRef(const NamedDecl *NS, 580 SourceLocation Loc, 581 CXTranslationUnit TU) { 582 583 assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU && 584 "Invalid arguments!"); 585 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 586 CXCursor C = { CXCursor_NamespaceRef, 0, { (void*)NS, RawLoc, TU } }; 587 return C; 588} 589 590std::pair<NamedDecl *, SourceLocation> 591cxcursor::getCursorNamespaceRef(CXCursor C) { 592 assert(C.kind == CXCursor_NamespaceRef); 593 return std::make_pair(static_cast<NamedDecl *>(C.data[0]), 594 SourceLocation::getFromRawEncoding( 595 reinterpret_cast<uintptr_t>(C.data[1]))); 596} 597 598CXCursor cxcursor::MakeCursorVariableRef(const VarDecl *Var, SourceLocation Loc, 599 CXTranslationUnit TU) { 600 601 assert(Var && TU && "Invalid arguments!"); 602 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 603 CXCursor C = { CXCursor_VariableRef, 0, { (void*)Var, RawLoc, TU } }; 604 return C; 605} 606 607std::pair<VarDecl *, SourceLocation> 608cxcursor::getCursorVariableRef(CXCursor C) { 609 assert(C.kind == CXCursor_VariableRef); 610 return std::make_pair(static_cast<VarDecl *>(C.data[0]), 611 SourceLocation::getFromRawEncoding( 612 reinterpret_cast<uintptr_t>(C.data[1]))); 613} 614 615CXCursor cxcursor::MakeCursorMemberRef(const FieldDecl *Field, SourceLocation Loc, 616 CXTranslationUnit TU) { 617 618 assert(Field && TU && "Invalid arguments!"); 619 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 620 CXCursor C = { CXCursor_MemberRef, 0, { (void*)Field, RawLoc, TU } }; 621 return C; 622} 623 624std::pair<FieldDecl *, SourceLocation> 625cxcursor::getCursorMemberRef(CXCursor C) { 626 assert(C.kind == CXCursor_MemberRef); 627 return std::make_pair(static_cast<FieldDecl *>(C.data[0]), 628 SourceLocation::getFromRawEncoding( 629 reinterpret_cast<uintptr_t>(C.data[1]))); 630} 631 632CXCursor cxcursor::MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B, 633 CXTranslationUnit TU){ 634 CXCursor C = { CXCursor_CXXBaseSpecifier, 0, { (void*)B, 0, TU } }; 635 return C; 636} 637 638CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) { 639 assert(C.kind == CXCursor_CXXBaseSpecifier); 640 return static_cast<CXXBaseSpecifier*>(C.data[0]); 641} 642 643CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range, 644 CXTranslationUnit TU) { 645 CXCursor C = { CXCursor_PreprocessingDirective, 0, 646 { reinterpret_cast<void *>(Range.getBegin().getRawEncoding()), 647 reinterpret_cast<void *>(Range.getEnd().getRawEncoding()), 648 TU } 649 }; 650 return C; 651} 652 653SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) { 654 assert(C.kind == CXCursor_PreprocessingDirective); 655 SourceRange Range = SourceRange(SourceLocation::getFromRawEncoding( 656 reinterpret_cast<uintptr_t> (C.data[0])), 657 SourceLocation::getFromRawEncoding( 658 reinterpret_cast<uintptr_t> (C.data[1]))); 659 ASTUnit *TU = getCursorASTUnit(C); 660 return TU->mapRangeFromPreamble(Range); 661} 662 663CXCursor cxcursor::MakeMacroDefinitionCursor(MacroDefinition *MI, 664 CXTranslationUnit TU) { 665 CXCursor C = { CXCursor_MacroDefinition, 0, { MI, 0, TU } }; 666 return C; 667} 668 669MacroDefinition *cxcursor::getCursorMacroDefinition(CXCursor C) { 670 assert(C.kind == CXCursor_MacroDefinition); 671 return static_cast<MacroDefinition *>(C.data[0]); 672} 673 674CXCursor cxcursor::MakeMacroExpansionCursor(MacroExpansion *MI, 675 CXTranslationUnit TU) { 676 CXCursor C = { CXCursor_MacroExpansion, 0, { MI, 0, TU } }; 677 return C; 678} 679 680MacroExpansion *cxcursor::getCursorMacroExpansion(CXCursor C) { 681 assert(C.kind == CXCursor_MacroExpansion); 682 return static_cast<MacroExpansion *>(C.data[0]); 683} 684 685CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID, 686 CXTranslationUnit TU) { 687 CXCursor C = { CXCursor_InclusionDirective, 0, { ID, 0, TU } }; 688 return C; 689} 690 691InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) { 692 assert(C.kind == CXCursor_InclusionDirective); 693 return static_cast<InclusionDirective *>(C.data[0]); 694} 695 696CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc, 697 CXTranslationUnit TU) { 698 699 assert(Label && TU && "Invalid arguments!"); 700 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 701 CXCursor C = { CXCursor_LabelRef, 0, { Label, RawLoc, TU } }; 702 return C; 703} 704 705std::pair<LabelStmt*, SourceLocation> 706cxcursor::getCursorLabelRef(CXCursor C) { 707 assert(C.kind == CXCursor_LabelRef); 708 return std::make_pair(static_cast<LabelStmt *>(C.data[0]), 709 SourceLocation::getFromRawEncoding( 710 reinterpret_cast<uintptr_t>(C.data[1]))); 711} 712 713CXCursor cxcursor::MakeCursorOverloadedDeclRef(OverloadExpr *E, 714 CXTranslationUnit TU) { 715 assert(E && TU && "Invalid arguments!"); 716 OverloadedDeclRefStorage Storage(E); 717 void *RawLoc = reinterpret_cast<void *>(E->getNameLoc().getRawEncoding()); 718 CXCursor C = { 719 CXCursor_OverloadedDeclRef, 0, 720 { Storage.getOpaqueValue(), RawLoc, TU } 721 }; 722 return C; 723} 724 725CXCursor cxcursor::MakeCursorOverloadedDeclRef(Decl *D, 726 SourceLocation Loc, 727 CXTranslationUnit TU) { 728 assert(D && TU && "Invalid arguments!"); 729 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 730 OverloadedDeclRefStorage Storage(D); 731 CXCursor C = { 732 CXCursor_OverloadedDeclRef, 0, 733 { Storage.getOpaqueValue(), RawLoc, TU } 734 }; 735 return C; 736} 737 738CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name, 739 SourceLocation Loc, 740 CXTranslationUnit TU) { 741 assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!"); 742 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 743 OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate()); 744 CXCursor C = { 745 CXCursor_OverloadedDeclRef, 0, 746 { Storage.getOpaqueValue(), RawLoc, TU } 747 }; 748 return C; 749} 750 751std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation> 752cxcursor::getCursorOverloadedDeclRef(CXCursor C) { 753 assert(C.kind == CXCursor_OverloadedDeclRef); 754 return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue(C.data[0]), 755 SourceLocation::getFromRawEncoding( 756 reinterpret_cast<uintptr_t>(C.data[1]))); 757} 758 759Decl *cxcursor::getCursorDecl(CXCursor Cursor) { 760 return (Decl *)Cursor.data[0]; 761} 762 763Expr *cxcursor::getCursorExpr(CXCursor Cursor) { 764 return dyn_cast_or_null<Expr>(getCursorStmt(Cursor)); 765} 766 767Stmt *cxcursor::getCursorStmt(CXCursor Cursor) { 768 if (Cursor.kind == CXCursor_ObjCSuperClassRef || 769 Cursor.kind == CXCursor_ObjCProtocolRef || 770 Cursor.kind == CXCursor_ObjCClassRef) 771 return 0; 772 773 return (Stmt *)Cursor.data[1]; 774} 775 776Attr *cxcursor::getCursorAttr(CXCursor Cursor) { 777 return (Attr *)Cursor.data[1]; 778} 779 780Decl *cxcursor::getCursorParentDecl(CXCursor Cursor) { 781 return (Decl *)Cursor.data[0]; 782} 783 784ASTContext &cxcursor::getCursorContext(CXCursor Cursor) { 785 return getCursorASTUnit(Cursor)->getASTContext(); 786} 787 788ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) { 789 CXTranslationUnit TU = static_cast<CXTranslationUnit>(Cursor.data[2]); 790 if (!TU) 791 return 0; 792 return static_cast<ASTUnit *>(TU->TUData); 793} 794 795CXTranslationUnit cxcursor::getCursorTU(CXCursor Cursor) { 796 return static_cast<CXTranslationUnit>(Cursor.data[2]); 797} 798 799void cxcursor::getOverriddenCursors(CXCursor cursor, 800 SmallVectorImpl<CXCursor> &overridden) { 801 assert(clang_isDeclaration(cursor.kind)); 802 const NamedDecl *D = dyn_cast_or_null<NamedDecl>(getCursorDecl(cursor)); 803 if (!D) 804 return; 805 806 CXTranslationUnit TU = getCursorTU(cursor); 807 SmallVector<const NamedDecl *, 8> OverDecls; 808 D->getASTContext().getOverriddenMethods(D, OverDecls); 809 810 for (SmallVector<const NamedDecl *, 8>::iterator 811 I = OverDecls.begin(), E = OverDecls.end(); I != E; ++I) { 812 overridden.push_back(MakeCXCursor(const_cast<NamedDecl*>(*I), TU)); 813 } 814} 815 816std::pair<int, SourceLocation> 817cxcursor::getSelectorIdentifierIndexAndLoc(CXCursor cursor) { 818 if (cursor.kind == CXCursor_ObjCMessageExpr) { 819 if (cursor.xdata != -1) 820 return std::make_pair(cursor.xdata, 821 cast<ObjCMessageExpr>(getCursorExpr(cursor)) 822 ->getSelectorLoc(cursor.xdata)); 823 } else if (cursor.kind == CXCursor_ObjCClassMethodDecl || 824 cursor.kind == CXCursor_ObjCInstanceMethodDecl) { 825 if (cursor.xdata != -1) 826 return std::make_pair(cursor.xdata, 827 cast<ObjCMethodDecl>(getCursorDecl(cursor)) 828 ->getSelectorLoc(cursor.xdata)); 829 } 830 831 return std::make_pair(-1, SourceLocation()); 832} 833 834CXCursor cxcursor::getSelectorIdentifierCursor(int SelIdx, CXCursor cursor) { 835 CXCursor newCursor = cursor; 836 837 if (cursor.kind == CXCursor_ObjCMessageExpr) { 838 if (SelIdx == -1 || 839 unsigned(SelIdx) >= cast<ObjCMessageExpr>(getCursorExpr(cursor)) 840 ->getNumSelectorLocs()) 841 newCursor.xdata = -1; 842 else 843 newCursor.xdata = SelIdx; 844 } else if (cursor.kind == CXCursor_ObjCClassMethodDecl || 845 cursor.kind == CXCursor_ObjCInstanceMethodDecl) { 846 if (SelIdx == -1 || 847 unsigned(SelIdx) >= cast<ObjCMethodDecl>(getCursorDecl(cursor)) 848 ->getNumSelectorLocs()) 849 newCursor.xdata = -1; 850 else 851 newCursor.xdata = SelIdx; 852 } 853 854 return newCursor; 855} 856 857CXCursor cxcursor::getTypeRefCursor(CXCursor cursor) { 858 if (cursor.kind != CXCursor_CallExpr) 859 return cursor; 860 861 if (cursor.xdata == 0) 862 return cursor; 863 864 Expr *E = getCursorExpr(cursor); 865 TypeSourceInfo *Type = 0; 866 if (CXXUnresolvedConstructExpr * 867 UnCtor = dyn_cast<CXXUnresolvedConstructExpr>(E)) { 868 Type = UnCtor->getTypeSourceInfo(); 869 } else if (CXXTemporaryObjectExpr *Tmp = dyn_cast<CXXTemporaryObjectExpr>(E)){ 870 Type = Tmp->getTypeSourceInfo(); 871 } 872 873 if (!Type) 874 return cursor; 875 876 CXTranslationUnit TU = getCursorTU(cursor); 877 QualType Ty = Type->getType(); 878 TypeLoc TL = Type->getTypeLoc(); 879 SourceLocation Loc = TL.getBeginLoc(); 880 881 if (const ElaboratedType *ElabT = Ty->getAs<ElaboratedType>()) { 882 Ty = ElabT->getNamedType(); 883 ElaboratedTypeLoc ElabTL = cast<ElaboratedTypeLoc>(TL); 884 Loc = ElabTL.getNamedTypeLoc().getBeginLoc(); 885 } 886 887 if (const TypedefType *Typedef = Ty->getAs<TypedefType>()) 888 return MakeCursorTypeRef(Typedef->getDecl(), Loc, TU); 889 if (const TagType *Tag = Ty->getAs<TagType>()) 890 return MakeCursorTypeRef(Tag->getDecl(), Loc, TU); 891 if (const TemplateTypeParmType *TemplP = Ty->getAs<TemplateTypeParmType>()) 892 return MakeCursorTypeRef(TemplP->getDecl(), Loc, TU); 893 894 return cursor; 895} 896 897bool cxcursor::operator==(CXCursor X, CXCursor Y) { 898 return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] && 899 X.data[2] == Y.data[2]; 900} 901 902// FIXME: Remove once we can model DeclGroups and their appropriate ranges 903// properly in the ASTs. 904bool cxcursor::isFirstInDeclGroup(CXCursor C) { 905 assert(clang_isDeclaration(C.kind)); 906 return ((uintptr_t) (C.data[1])) != 0; 907} 908 909//===----------------------------------------------------------------------===// 910// libclang CXCursor APIs 911//===----------------------------------------------------------------------===// 912 913extern "C" { 914 915int clang_Cursor_isNull(CXCursor cursor) { 916 return clang_equalCursors(cursor, clang_getNullCursor()); 917} 918 919CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor cursor) { 920 return getCursorTU(cursor); 921} 922 923int clang_Cursor_getNumArguments(CXCursor C) { 924 if (clang_isDeclaration(C.kind)) { 925 Decl *D = cxcursor::getCursorDecl(C); 926 if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) 927 return MD->param_size(); 928 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 929 return FD->param_size(); 930 } 931 932 return -1; 933} 934 935CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i) { 936 if (clang_isDeclaration(C.kind)) { 937 Decl *D = cxcursor::getCursorDecl(C); 938 if (ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) { 939 if (i < MD->param_size()) 940 return cxcursor::MakeCXCursor(MD->param_begin()[i], 941 cxcursor::getCursorTU(C)); 942 } else if (FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) { 943 if (i < FD->param_size()) 944 return cxcursor::MakeCXCursor(FD->param_begin()[i], 945 cxcursor::getCursorTU(C)); 946 } 947 } 948 949 return clang_getNullCursor(); 950} 951 952} // end: extern "C" 953 954//===----------------------------------------------------------------------===// 955// CXCursorSet. 956//===----------------------------------------------------------------------===// 957 958typedef llvm::DenseMap<CXCursor, unsigned> CXCursorSet_Impl; 959 960static inline CXCursorSet packCXCursorSet(CXCursorSet_Impl *setImpl) { 961 return (CXCursorSet) setImpl; 962} 963static inline CXCursorSet_Impl *unpackCXCursorSet(CXCursorSet set) { 964 return (CXCursorSet_Impl*) set; 965} 966namespace llvm { 967template<> struct DenseMapInfo<CXCursor> { 968public: 969 static inline CXCursor getEmptyKey() { 970 return MakeCXCursorInvalid(CXCursor_InvalidFile); 971 } 972 static inline CXCursor getTombstoneKey() { 973 return MakeCXCursorInvalid(CXCursor_NoDeclFound); 974 } 975 static inline unsigned getHashValue(const CXCursor &cursor) { 976 return llvm::DenseMapInfo<std::pair<void*,void*> > 977 ::getHashValue(std::make_pair(cursor.data[0], cursor.data[1])); 978 } 979 static inline bool isEqual(const CXCursor &x, const CXCursor &y) { 980 return x.kind == y.kind && 981 x.data[0] == y.data[0] && 982 x.data[1] == y.data[1]; 983 } 984}; 985} 986 987extern "C" { 988CXCursorSet clang_createCXCursorSet() { 989 return packCXCursorSet(new CXCursorSet_Impl()); 990} 991 992void clang_disposeCXCursorSet(CXCursorSet set) { 993 delete unpackCXCursorSet(set); 994} 995 996unsigned clang_CXCursorSet_contains(CXCursorSet set, CXCursor cursor) { 997 CXCursorSet_Impl *setImpl = unpackCXCursorSet(set); 998 if (!setImpl) 999 return 0; 1000 return setImpl->find(cursor) == setImpl->end(); 1001} 1002 1003unsigned clang_CXCursorSet_insert(CXCursorSet set, CXCursor cursor) { 1004 // Do not insert invalid cursors into the set. 1005 if (cursor.kind >= CXCursor_FirstInvalid && 1006 cursor.kind <= CXCursor_LastInvalid) 1007 return 1; 1008 1009 CXCursorSet_Impl *setImpl = unpackCXCursorSet(set); 1010 if (!setImpl) 1011 return 1; 1012 unsigned &entry = (*setImpl)[cursor]; 1013 unsigned flag = entry == 0 ? 1 : 0; 1014 entry = 1; 1015 return flag; 1016} 1017 1018CXCompletionString clang_getCursorCompletionString(CXCursor cursor) { 1019 enum CXCursorKind kind = clang_getCursorKind(cursor); 1020 if (clang_isDeclaration(kind)) { 1021 Decl *decl = getCursorDecl(cursor); 1022 if (NamedDecl *namedDecl = dyn_cast_or_null<NamedDecl>(decl)) { 1023 ASTUnit *unit = getCursorASTUnit(cursor); 1024 CodeCompletionResult Result(namedDecl); 1025 CodeCompletionString *String 1026 = Result.CreateCodeCompletionString(unit->getASTContext(), 1027 unit->getPreprocessor(), 1028 unit->getCodeCompletionTUInfo().getAllocator(), 1029 unit->getCodeCompletionTUInfo(), 1030 true); 1031 return String; 1032 } 1033 } 1034 else if (kind == CXCursor_MacroDefinition) { 1035 MacroDefinition *definition = getCursorMacroDefinition(cursor); 1036 const IdentifierInfo *MacroInfo = definition->getName(); 1037 ASTUnit *unit = getCursorASTUnit(cursor); 1038 CodeCompletionResult Result(const_cast<IdentifierInfo *>(MacroInfo)); 1039 CodeCompletionString *String 1040 = Result.CreateCodeCompletionString(unit->getASTContext(), 1041 unit->getPreprocessor(), 1042 unit->getCodeCompletionTUInfo().getAllocator(), 1043 unit->getCodeCompletionTUInfo(), 1044 false); 1045 return String; 1046 } 1047 return NULL; 1048} 1049} // end: extern C. 1050 1051namespace { 1052 struct OverridenCursorsPool { 1053 typedef llvm::SmallVector<CXCursor, 2> CursorVec; 1054 std::vector<CursorVec*> AllCursors; 1055 std::vector<CursorVec*> AvailableCursors; 1056 1057 ~OverridenCursorsPool() { 1058 for (std::vector<CursorVec*>::iterator I = AllCursors.begin(), 1059 E = AllCursors.end(); I != E; ++I) { 1060 delete *I; 1061 } 1062 } 1063 }; 1064} 1065 1066void *cxcursor::createOverridenCXCursorsPool() { 1067 return new OverridenCursorsPool(); 1068} 1069 1070void cxcursor::disposeOverridenCXCursorsPool(void *pool) { 1071 delete static_cast<OverridenCursorsPool*>(pool); 1072} 1073 1074extern "C" { 1075void clang_getOverriddenCursors(CXCursor cursor, 1076 CXCursor **overridden, 1077 unsigned *num_overridden) { 1078 if (overridden) 1079 *overridden = 0; 1080 if (num_overridden) 1081 *num_overridden = 0; 1082 1083 CXTranslationUnit TU = cxcursor::getCursorTU(cursor); 1084 1085 if (!overridden || !num_overridden || !TU) 1086 return; 1087 1088 if (!clang_isDeclaration(cursor.kind)) 1089 return; 1090 1091 OverridenCursorsPool &pool = 1092 *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool); 1093 1094 OverridenCursorsPool::CursorVec *Vec = 0; 1095 1096 if (!pool.AvailableCursors.empty()) { 1097 Vec = pool.AvailableCursors.back(); 1098 pool.AvailableCursors.pop_back(); 1099 } 1100 else { 1101 Vec = new OverridenCursorsPool::CursorVec(); 1102 pool.AllCursors.push_back(Vec); 1103 } 1104 1105 // Clear out the vector, but don't free the memory contents. This 1106 // reduces malloc() traffic. 1107 Vec->clear(); 1108 1109 // Use the first entry to contain a back reference to the vector. 1110 // This is a complete hack. 1111 CXCursor backRefCursor = MakeCXCursorInvalid(CXCursor_InvalidFile, TU); 1112 backRefCursor.data[0] = Vec; 1113 assert(cxcursor::getCursorTU(backRefCursor) == TU); 1114 Vec->push_back(backRefCursor); 1115 1116 // Get the overriden cursors. 1117 cxcursor::getOverriddenCursors(cursor, *Vec); 1118 1119 // Did we get any overriden cursors? If not, return Vec to the pool 1120 // of available cursor vectors. 1121 if (Vec->size() == 1) { 1122 pool.AvailableCursors.push_back(Vec); 1123 return; 1124 } 1125 1126 // Now tell the caller about the overriden cursors. 1127 assert(Vec->size() > 1); 1128 *overridden = &((*Vec)[1]); 1129 *num_overridden = Vec->size() - 1; 1130} 1131 1132void clang_disposeOverriddenCursors(CXCursor *overridden) { 1133 if (!overridden) 1134 return; 1135 1136 // Use pointer arithmetic to get back the first faux entry 1137 // which has a back-reference to the TU and the vector. 1138 --overridden; 1139 OverridenCursorsPool::CursorVec *Vec = 1140 static_cast<OverridenCursorsPool::CursorVec*>(overridden->data[0]); 1141 CXTranslationUnit TU = getCursorTU(*overridden); 1142 1143 assert(Vec && TU); 1144 1145 OverridenCursorsPool &pool = 1146 *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool); 1147 1148 pool.AvailableCursors.push_back(Vec); 1149} 1150 1151int clang_Cursor_isDynamicCall(CXCursor C) { 1152 const Expr *E = 0; 1153 if (clang_isExpression(C.kind)) 1154 E = getCursorExpr(C); 1155 if (!E) 1156 return 0; 1157 1158 if (const ObjCMessageExpr *MsgE = dyn_cast<ObjCMessageExpr>(E)) 1159 return MsgE->getReceiverKind() == ObjCMessageExpr::Instance; 1160 1161 const MemberExpr *ME = 0; 1162 if (isa<MemberExpr>(E)) 1163 ME = cast<MemberExpr>(E); 1164 else if (const CallExpr *CE = dyn_cast<CallExpr>(E)) 1165 ME = dyn_cast_or_null<MemberExpr>(CE->getCallee()); 1166 1167 if (ME) { 1168 if (const CXXMethodDecl * 1169 MD = dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl())) 1170 return MD->isVirtual() && !ME->hasQualifier(); 1171 } 1172 1173 return 0; 1174} 1175 1176CXType clang_Cursor_getReceiverType(CXCursor C) { 1177 CXTranslationUnit TU = cxcursor::getCursorTU(C); 1178 const Expr *E = 0; 1179 if (clang_isExpression(C.kind)) 1180 E = getCursorExpr(C); 1181 1182 if (const ObjCMessageExpr *MsgE = dyn_cast_or_null<ObjCMessageExpr>(E)) 1183 return cxtype::MakeCXType(MsgE->getReceiverType(), TU); 1184 1185 return cxtype::MakeCXType(QualType(), TU); 1186} 1187 1188} // end: extern "C" 1189