1 //===- CXCursor.cpp - Routines for manipulating CXCursors -----------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file defines routines for manipulating CXCursors. It should be the 10 // only file that has internal knowledge of the encoding of the data in 11 // CXCursor. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "CXTranslationUnit.h" 16 #include "CXCursor.h" 17 #include "CXString.h" 18 #include "CXType.h" 19 #include "clang-c/Index.h" 20 #include "clang/AST/Attr.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 31 using namespace clang; 32 using namespace cxcursor; 33 34 CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K, CXTranslationUnit TU) { 35 assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid); 36 CXCursor C = { K, 0, { nullptr, nullptr, TU } }; 37 return C; 38 } 39 40 static 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 case attr::Packed: return CXCursor_PackedAttr; 52 case attr::Pure: return CXCursor_PureAttr; 53 case attr::Const: return CXCursor_ConstAttr; 54 case attr::NoDuplicate: return CXCursor_NoDuplicateAttr; 55 case attr::CUDAConstant: return CXCursor_CUDAConstantAttr; 56 case attr::CUDADevice: return CXCursor_CUDADeviceAttr; 57 case attr::CUDAGlobal: return CXCursor_CUDAGlobalAttr; 58 case attr::CUDAHost: return CXCursor_CUDAHostAttr; 59 case attr::CUDAShared: return CXCursor_CUDASharedAttr; 60 case attr::Visibility: return CXCursor_VisibilityAttr; 61 case attr::DLLExport: return CXCursor_DLLExport; 62 case attr::DLLImport: return CXCursor_DLLImport; 63 case attr::NSReturnsRetained: return CXCursor_NSReturnsRetained; 64 case attr::NSReturnsNotRetained: return CXCursor_NSReturnsNotRetained; 65 case attr::NSReturnsAutoreleased: return CXCursor_NSReturnsAutoreleased; 66 case attr::NSConsumesSelf: return CXCursor_NSConsumesSelf; 67 case attr::NSConsumed: return CXCursor_NSConsumed; 68 case attr::ObjCException: return CXCursor_ObjCException; 69 case attr::ObjCNSObject: return CXCursor_ObjCNSObject; 70 case attr::ObjCIndependentClass: return CXCursor_ObjCIndependentClass; 71 case attr::ObjCPreciseLifetime: return CXCursor_ObjCPreciseLifetime; 72 case attr::ObjCReturnsInnerPointer: return CXCursor_ObjCReturnsInnerPointer; 73 case attr::ObjCRequiresSuper: return CXCursor_ObjCRequiresSuper; 74 case attr::ObjCRootClass: return CXCursor_ObjCRootClass; 75 case attr::ObjCSubclassingRestricted: return CXCursor_ObjCSubclassingRestricted; 76 case attr::ObjCExplicitProtocolImpl: return CXCursor_ObjCExplicitProtocolImpl; 77 case attr::ObjCDesignatedInitializer: return CXCursor_ObjCDesignatedInitializer; 78 case attr::ObjCRuntimeVisible: return CXCursor_ObjCRuntimeVisible; 79 case attr::ObjCBoxable: return CXCursor_ObjCBoxable; 80 case attr::FlagEnum: return CXCursor_FlagEnum; 81 case attr::Convergent: return CXCursor_ConvergentAttr; 82 case attr::WarnUnused: return CXCursor_WarnUnusedAttr; 83 case attr::WarnUnusedResult: return CXCursor_WarnUnusedResultAttr; 84 case attr::Aligned: return CXCursor_AlignedAttr; 85 } 86 87 return CXCursor_UnexposedAttr; 88 } 89 90 CXCursor cxcursor::MakeCXCursor(const Attr *A, const Decl *Parent, 91 CXTranslationUnit TU) { 92 assert(A && Parent && TU && "Invalid arguments!"); 93 CXCursor C = { GetCursorKind(A), 0, { Parent, A, TU } }; 94 return C; 95 } 96 97 CXCursor cxcursor::MakeCXCursor(const Decl *D, CXTranslationUnit TU, 98 SourceRange RegionOfInterest, 99 bool FirstInDeclGroup) { 100 assert(D && TU && "Invalid arguments!"); 101 102 CXCursorKind K = getCursorKindForDecl(D); 103 104 if (K == CXCursor_ObjCClassMethodDecl || 105 K == CXCursor_ObjCInstanceMethodDecl) { 106 int SelectorIdIndex = -1; 107 // Check if cursor points to a selector id. 108 if (RegionOfInterest.isValid() && 109 RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) { 110 SmallVector<SourceLocation, 16> SelLocs; 111 cast<ObjCMethodDecl>(D)->getSelectorLocs(SelLocs); 112 SmallVectorImpl<SourceLocation>::iterator I = 113 llvm::find(SelLocs, RegionOfInterest.getBegin()); 114 if (I != SelLocs.end()) 115 SelectorIdIndex = I - SelLocs.begin(); 116 } 117 CXCursor C = { K, SelectorIdIndex, 118 { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }}; 119 return C; 120 } 121 122 CXCursor C = { K, 0, { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }}; 123 return C; 124 } 125 126 CXCursor cxcursor::MakeCXCursor(const Stmt *S, const Decl *Parent, 127 CXTranslationUnit TU, 128 SourceRange RegionOfInterest) { 129 assert(S && TU && "Invalid arguments!"); 130 CXCursorKind K = CXCursor_NotImplemented; 131 132 switch (S->getStmtClass()) { 133 case Stmt::NoStmtClass: 134 break; 135 136 case Stmt::CaseStmtClass: 137 K = CXCursor_CaseStmt; 138 break; 139 140 case Stmt::DefaultStmtClass: 141 K = CXCursor_DefaultStmt; 142 break; 143 144 case Stmt::IfStmtClass: 145 K = CXCursor_IfStmt; 146 break; 147 148 case Stmt::SwitchStmtClass: 149 K = CXCursor_SwitchStmt; 150 break; 151 152 case Stmt::WhileStmtClass: 153 K = CXCursor_WhileStmt; 154 break; 155 156 case Stmt::DoStmtClass: 157 K = CXCursor_DoStmt; 158 break; 159 160 case Stmt::ForStmtClass: 161 K = CXCursor_ForStmt; 162 break; 163 164 case Stmt::GotoStmtClass: 165 K = CXCursor_GotoStmt; 166 break; 167 168 case Stmt::IndirectGotoStmtClass: 169 K = CXCursor_IndirectGotoStmt; 170 break; 171 172 case Stmt::ContinueStmtClass: 173 K = CXCursor_ContinueStmt; 174 break; 175 176 case Stmt::BreakStmtClass: 177 K = CXCursor_BreakStmt; 178 break; 179 180 case Stmt::ReturnStmtClass: 181 K = CXCursor_ReturnStmt; 182 break; 183 184 case Stmt::GCCAsmStmtClass: 185 K = CXCursor_GCCAsmStmt; 186 break; 187 188 case Stmt::MSAsmStmtClass: 189 K = CXCursor_MSAsmStmt; 190 break; 191 192 case Stmt::ObjCAtTryStmtClass: 193 K = CXCursor_ObjCAtTryStmt; 194 break; 195 196 case Stmt::ObjCAtCatchStmtClass: 197 K = CXCursor_ObjCAtCatchStmt; 198 break; 199 200 case Stmt::ObjCAtFinallyStmtClass: 201 K = CXCursor_ObjCAtFinallyStmt; 202 break; 203 204 case Stmt::ObjCAtThrowStmtClass: 205 K = CXCursor_ObjCAtThrowStmt; 206 break; 207 208 case Stmt::ObjCAtSynchronizedStmtClass: 209 K = CXCursor_ObjCAtSynchronizedStmt; 210 break; 211 212 case Stmt::ObjCAutoreleasePoolStmtClass: 213 K = CXCursor_ObjCAutoreleasePoolStmt; 214 break; 215 216 case Stmt::ObjCForCollectionStmtClass: 217 K = CXCursor_ObjCForCollectionStmt; 218 break; 219 220 case Stmt::CXXCatchStmtClass: 221 K = CXCursor_CXXCatchStmt; 222 break; 223 224 case Stmt::CXXTryStmtClass: 225 K = CXCursor_CXXTryStmt; 226 break; 227 228 case Stmt::CXXForRangeStmtClass: 229 K = CXCursor_CXXForRangeStmt; 230 break; 231 232 case Stmt::SEHTryStmtClass: 233 K = CXCursor_SEHTryStmt; 234 break; 235 236 case Stmt::SEHExceptStmtClass: 237 K = CXCursor_SEHExceptStmt; 238 break; 239 240 case Stmt::SEHFinallyStmtClass: 241 K = CXCursor_SEHFinallyStmt; 242 break; 243 244 case Stmt::SEHLeaveStmtClass: 245 K = CXCursor_SEHLeaveStmt; 246 break; 247 248 case Stmt::CoroutineBodyStmtClass: 249 case Stmt::CoreturnStmtClass: 250 K = CXCursor_UnexposedStmt; 251 break; 252 253 case Stmt::ArrayTypeTraitExprClass: 254 case Stmt::AsTypeExprClass: 255 case Stmt::AtomicExprClass: 256 case Stmt::BinaryConditionalOperatorClass: 257 case Stmt::TypeTraitExprClass: 258 case Stmt::CoawaitExprClass: 259 case Stmt::DependentCoawaitExprClass: 260 case Stmt::CoyieldExprClass: 261 case Stmt::CXXBindTemporaryExprClass: 262 case Stmt::CXXDefaultArgExprClass: 263 case Stmt::CXXDefaultInitExprClass: 264 case Stmt::CXXFoldExprClass: 265 case Stmt::CXXStdInitializerListExprClass: 266 case Stmt::CXXScalarValueInitExprClass: 267 case Stmt::CXXUuidofExprClass: 268 case Stmt::ChooseExprClass: 269 case Stmt::DesignatedInitExprClass: 270 case Stmt::DesignatedInitUpdateExprClass: 271 case Stmt::ArrayInitLoopExprClass: 272 case Stmt::ArrayInitIndexExprClass: 273 case Stmt::ExprWithCleanupsClass: 274 case Stmt::ExpressionTraitExprClass: 275 case Stmt::ExtVectorElementExprClass: 276 case Stmt::ImplicitCastExprClass: 277 case Stmt::ImplicitValueInitExprClass: 278 case Stmt::NoInitExprClass: 279 case Stmt::MaterializeTemporaryExprClass: 280 case Stmt::ObjCIndirectCopyRestoreExprClass: 281 case Stmt::OffsetOfExprClass: 282 case Stmt::ParenListExprClass: 283 case Stmt::PredefinedExprClass: 284 case Stmt::ShuffleVectorExprClass: 285 case Stmt::SourceLocExprClass: 286 case Stmt::ConvertVectorExprClass: 287 case Stmt::VAArgExprClass: 288 case Stmt::ObjCArrayLiteralClass: 289 case Stmt::ObjCDictionaryLiteralClass: 290 case Stmt::ObjCBoxedExprClass: 291 case Stmt::ObjCSubscriptRefExprClass: 292 K = CXCursor_UnexposedExpr; 293 break; 294 295 case Stmt::OpaqueValueExprClass: 296 if (Expr *Src = cast<OpaqueValueExpr>(S)->getSourceExpr()) 297 return MakeCXCursor(Src, Parent, TU, RegionOfInterest); 298 K = CXCursor_UnexposedExpr; 299 break; 300 301 case Stmt::PseudoObjectExprClass: 302 return MakeCXCursor(cast<PseudoObjectExpr>(S)->getSyntacticForm(), 303 Parent, TU, RegionOfInterest); 304 305 case Stmt::CompoundStmtClass: 306 K = CXCursor_CompoundStmt; 307 break; 308 309 case Stmt::NullStmtClass: 310 K = CXCursor_NullStmt; 311 break; 312 313 case Stmt::LabelStmtClass: 314 K = CXCursor_LabelStmt; 315 break; 316 317 case Stmt::AttributedStmtClass: 318 K = CXCursor_UnexposedStmt; 319 break; 320 321 case Stmt::DeclStmtClass: 322 K = CXCursor_DeclStmt; 323 break; 324 325 case Stmt::CapturedStmtClass: 326 K = CXCursor_UnexposedStmt; 327 break; 328 329 case Stmt::IntegerLiteralClass: 330 K = CXCursor_IntegerLiteral; 331 break; 332 333 case Stmt::FixedPointLiteralClass: 334 K = CXCursor_FixedPointLiteral; 335 break; 336 337 case Stmt::FloatingLiteralClass: 338 K = CXCursor_FloatingLiteral; 339 break; 340 341 case Stmt::ImaginaryLiteralClass: 342 K = CXCursor_ImaginaryLiteral; 343 break; 344 345 case Stmt::StringLiteralClass: 346 K = CXCursor_StringLiteral; 347 break; 348 349 case Stmt::CharacterLiteralClass: 350 K = CXCursor_CharacterLiteral; 351 break; 352 353 case Stmt::ConstantExprClass: 354 return MakeCXCursor(cast<ConstantExpr>(S)->getSubExpr(), 355 Parent, TU, RegionOfInterest); 356 357 case Stmt::ParenExprClass: 358 K = CXCursor_ParenExpr; 359 break; 360 361 case Stmt::UnaryOperatorClass: 362 K = CXCursor_UnaryOperator; 363 break; 364 365 case Stmt::UnaryExprOrTypeTraitExprClass: 366 case Stmt::CXXNoexceptExprClass: 367 K = CXCursor_UnaryExpr; 368 break; 369 370 case Stmt::MSPropertySubscriptExprClass: 371 case Stmt::ArraySubscriptExprClass: 372 K = CXCursor_ArraySubscriptExpr; 373 break; 374 375 case Stmt::OMPArraySectionExprClass: 376 K = CXCursor_OMPArraySectionExpr; 377 break; 378 379 case Stmt::BinaryOperatorClass: 380 K = CXCursor_BinaryOperator; 381 break; 382 383 case Stmt::CompoundAssignOperatorClass: 384 K = CXCursor_CompoundAssignOperator; 385 break; 386 387 case Stmt::ConditionalOperatorClass: 388 K = CXCursor_ConditionalOperator; 389 break; 390 391 case Stmt::CStyleCastExprClass: 392 K = CXCursor_CStyleCastExpr; 393 break; 394 395 case Stmt::CompoundLiteralExprClass: 396 K = CXCursor_CompoundLiteralExpr; 397 break; 398 399 case Stmt::InitListExprClass: 400 K = CXCursor_InitListExpr; 401 break; 402 403 case Stmt::AddrLabelExprClass: 404 K = CXCursor_AddrLabelExpr; 405 break; 406 407 case Stmt::StmtExprClass: 408 K = CXCursor_StmtExpr; 409 break; 410 411 case Stmt::GenericSelectionExprClass: 412 K = CXCursor_GenericSelectionExpr; 413 break; 414 415 case Stmt::GNUNullExprClass: 416 K = CXCursor_GNUNullExpr; 417 break; 418 419 case Stmt::CXXStaticCastExprClass: 420 K = CXCursor_CXXStaticCastExpr; 421 break; 422 423 case Stmt::CXXDynamicCastExprClass: 424 K = CXCursor_CXXDynamicCastExpr; 425 break; 426 427 case Stmt::CXXReinterpretCastExprClass: 428 K = CXCursor_CXXReinterpretCastExpr; 429 break; 430 431 case Stmt::CXXConstCastExprClass: 432 K = CXCursor_CXXConstCastExpr; 433 break; 434 435 case Stmt::CXXFunctionalCastExprClass: 436 K = CXCursor_CXXFunctionalCastExpr; 437 break; 438 439 case Stmt::CXXTypeidExprClass: 440 K = CXCursor_CXXTypeidExpr; 441 break; 442 443 case Stmt::CXXBoolLiteralExprClass: 444 K = CXCursor_CXXBoolLiteralExpr; 445 break; 446 447 case Stmt::CXXNullPtrLiteralExprClass: 448 K = CXCursor_CXXNullPtrLiteralExpr; 449 break; 450 451 case Stmt::CXXThisExprClass: 452 K = CXCursor_CXXThisExpr; 453 break; 454 455 case Stmt::CXXThrowExprClass: 456 K = CXCursor_CXXThrowExpr; 457 break; 458 459 case Stmt::CXXNewExprClass: 460 K = CXCursor_CXXNewExpr; 461 break; 462 463 case Stmt::CXXDeleteExprClass: 464 K = CXCursor_CXXDeleteExpr; 465 break; 466 467 case Stmt::ObjCStringLiteralClass: 468 K = CXCursor_ObjCStringLiteral; 469 break; 470 471 case Stmt::ObjCEncodeExprClass: 472 K = CXCursor_ObjCEncodeExpr; 473 break; 474 475 case Stmt::ObjCSelectorExprClass: 476 K = CXCursor_ObjCSelectorExpr; 477 break; 478 479 case Stmt::ObjCProtocolExprClass: 480 K = CXCursor_ObjCProtocolExpr; 481 break; 482 483 case Stmt::ObjCBoolLiteralExprClass: 484 K = CXCursor_ObjCBoolLiteralExpr; 485 break; 486 487 case Stmt::ObjCAvailabilityCheckExprClass: 488 K = CXCursor_ObjCAvailabilityCheckExpr; 489 break; 490 491 case Stmt::ObjCBridgedCastExprClass: 492 K = CXCursor_ObjCBridgedCastExpr; 493 break; 494 495 case Stmt::BlockExprClass: 496 K = CXCursor_BlockExpr; 497 break; 498 499 case Stmt::PackExpansionExprClass: 500 K = CXCursor_PackExpansionExpr; 501 break; 502 503 case Stmt::SizeOfPackExprClass: 504 K = CXCursor_SizeOfPackExpr; 505 break; 506 507 case Stmt::DeclRefExprClass: 508 if (const ImplicitParamDecl *IPD = 509 dyn_cast_or_null<ImplicitParamDecl>(cast<DeclRefExpr>(S)->getDecl())) { 510 if (const ObjCMethodDecl *MD = 511 dyn_cast<ObjCMethodDecl>(IPD->getDeclContext())) { 512 if (MD->getSelfDecl() == IPD) { 513 K = CXCursor_ObjCSelfExpr; 514 break; 515 } 516 } 517 } 518 519 K = CXCursor_DeclRefExpr; 520 break; 521 522 case Stmt::DependentScopeDeclRefExprClass: 523 case Stmt::SubstNonTypeTemplateParmExprClass: 524 case Stmt::SubstNonTypeTemplateParmPackExprClass: 525 case Stmt::FunctionParmPackExprClass: 526 case Stmt::UnresolvedLookupExprClass: 527 case Stmt::TypoExprClass: // A typo could actually be a DeclRef or a MemberRef 528 K = CXCursor_DeclRefExpr; 529 break; 530 531 case Stmt::CXXDependentScopeMemberExprClass: 532 case Stmt::CXXPseudoDestructorExprClass: 533 case Stmt::MemberExprClass: 534 case Stmt::MSPropertyRefExprClass: 535 case Stmt::ObjCIsaExprClass: 536 case Stmt::ObjCIvarRefExprClass: 537 case Stmt::ObjCPropertyRefExprClass: 538 case Stmt::UnresolvedMemberExprClass: 539 K = CXCursor_MemberRefExpr; 540 break; 541 542 case Stmt::CallExprClass: 543 case Stmt::CXXOperatorCallExprClass: 544 case Stmt::CXXMemberCallExprClass: 545 case Stmt::CUDAKernelCallExprClass: 546 case Stmt::CXXConstructExprClass: 547 case Stmt::CXXInheritedCtorInitExprClass: 548 case Stmt::CXXTemporaryObjectExprClass: 549 case Stmt::CXXUnresolvedConstructExprClass: 550 case Stmt::UserDefinedLiteralClass: 551 K = CXCursor_CallExpr; 552 break; 553 554 case Stmt::LambdaExprClass: 555 K = CXCursor_LambdaExpr; 556 break; 557 558 case Stmt::ObjCMessageExprClass: { 559 K = CXCursor_ObjCMessageExpr; 560 int SelectorIdIndex = -1; 561 // Check if cursor points to a selector id. 562 if (RegionOfInterest.isValid() && 563 RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) { 564 SmallVector<SourceLocation, 16> SelLocs; 565 cast<ObjCMessageExpr>(S)->getSelectorLocs(SelLocs); 566 SmallVectorImpl<SourceLocation>::iterator I = 567 llvm::find(SelLocs, RegionOfInterest.getBegin()); 568 if (I != SelLocs.end()) 569 SelectorIdIndex = I - SelLocs.begin(); 570 } 571 CXCursor C = { K, 0, { Parent, S, TU } }; 572 return getSelectorIdentifierCursor(SelectorIdIndex, C); 573 } 574 575 case Stmt::MSDependentExistsStmtClass: 576 K = CXCursor_UnexposedStmt; 577 break; 578 case Stmt::OMPParallelDirectiveClass: 579 K = CXCursor_OMPParallelDirective; 580 break; 581 case Stmt::OMPSimdDirectiveClass: 582 K = CXCursor_OMPSimdDirective; 583 break; 584 case Stmt::OMPForDirectiveClass: 585 K = CXCursor_OMPForDirective; 586 break; 587 case Stmt::OMPForSimdDirectiveClass: 588 K = CXCursor_OMPForSimdDirective; 589 break; 590 case Stmt::OMPSectionsDirectiveClass: 591 K = CXCursor_OMPSectionsDirective; 592 break; 593 case Stmt::OMPSectionDirectiveClass: 594 K = CXCursor_OMPSectionDirective; 595 break; 596 case Stmt::OMPSingleDirectiveClass: 597 K = CXCursor_OMPSingleDirective; 598 break; 599 case Stmt::OMPMasterDirectiveClass: 600 K = CXCursor_OMPMasterDirective; 601 break; 602 case Stmt::OMPCriticalDirectiveClass: 603 K = CXCursor_OMPCriticalDirective; 604 break; 605 case Stmt::OMPParallelForDirectiveClass: 606 K = CXCursor_OMPParallelForDirective; 607 break; 608 case Stmt::OMPParallelForSimdDirectiveClass: 609 K = CXCursor_OMPParallelForSimdDirective; 610 break; 611 case Stmt::OMPParallelSectionsDirectiveClass: 612 K = CXCursor_OMPParallelSectionsDirective; 613 break; 614 case Stmt::OMPTaskDirectiveClass: 615 K = CXCursor_OMPTaskDirective; 616 break; 617 case Stmt::OMPTaskyieldDirectiveClass: 618 K = CXCursor_OMPTaskyieldDirective; 619 break; 620 case Stmt::OMPBarrierDirectiveClass: 621 K = CXCursor_OMPBarrierDirective; 622 break; 623 case Stmt::OMPTaskwaitDirectiveClass: 624 K = CXCursor_OMPTaskwaitDirective; 625 break; 626 case Stmt::OMPTaskgroupDirectiveClass: 627 K = CXCursor_OMPTaskgroupDirective; 628 break; 629 case Stmt::OMPFlushDirectiveClass: 630 K = CXCursor_OMPFlushDirective; 631 break; 632 case Stmt::OMPOrderedDirectiveClass: 633 K = CXCursor_OMPOrderedDirective; 634 break; 635 case Stmt::OMPAtomicDirectiveClass: 636 K = CXCursor_OMPAtomicDirective; 637 break; 638 case Stmt::OMPTargetDirectiveClass: 639 K = CXCursor_OMPTargetDirective; 640 break; 641 case Stmt::OMPTargetDataDirectiveClass: 642 K = CXCursor_OMPTargetDataDirective; 643 break; 644 case Stmt::OMPTargetEnterDataDirectiveClass: 645 K = CXCursor_OMPTargetEnterDataDirective; 646 break; 647 case Stmt::OMPTargetExitDataDirectiveClass: 648 K = CXCursor_OMPTargetExitDataDirective; 649 break; 650 case Stmt::OMPTargetParallelDirectiveClass: 651 K = CXCursor_OMPTargetParallelDirective; 652 break; 653 case Stmt::OMPTargetParallelForDirectiveClass: 654 K = CXCursor_OMPTargetParallelForDirective; 655 break; 656 case Stmt::OMPTargetUpdateDirectiveClass: 657 K = CXCursor_OMPTargetUpdateDirective; 658 break; 659 case Stmt::OMPTeamsDirectiveClass: 660 K = CXCursor_OMPTeamsDirective; 661 break; 662 case Stmt::OMPCancellationPointDirectiveClass: 663 K = CXCursor_OMPCancellationPointDirective; 664 break; 665 case Stmt::OMPCancelDirectiveClass: 666 K = CXCursor_OMPCancelDirective; 667 break; 668 case Stmt::OMPTaskLoopDirectiveClass: 669 K = CXCursor_OMPTaskLoopDirective; 670 break; 671 case Stmt::OMPTaskLoopSimdDirectiveClass: 672 K = CXCursor_OMPTaskLoopSimdDirective; 673 break; 674 case Stmt::OMPMasterTaskLoopDirectiveClass: 675 K = CXCursor_OMPMasterTaskLoopDirective; 676 break; 677 case Stmt::OMPParallelMasterTaskLoopDirectiveClass: 678 K = CXCursor_OMPParallelMasterTaskLoopDirective; 679 break; 680 case Stmt::OMPDistributeDirectiveClass: 681 K = CXCursor_OMPDistributeDirective; 682 break; 683 case Stmt::OMPDistributeParallelForDirectiveClass: 684 K = CXCursor_OMPDistributeParallelForDirective; 685 break; 686 case Stmt::OMPDistributeParallelForSimdDirectiveClass: 687 K = CXCursor_OMPDistributeParallelForSimdDirective; 688 break; 689 case Stmt::OMPDistributeSimdDirectiveClass: 690 K = CXCursor_OMPDistributeSimdDirective; 691 break; 692 case Stmt::OMPTargetParallelForSimdDirectiveClass: 693 K = CXCursor_OMPTargetParallelForSimdDirective; 694 break; 695 case Stmt::OMPTargetSimdDirectiveClass: 696 K = CXCursor_OMPTargetSimdDirective; 697 break; 698 case Stmt::OMPTeamsDistributeDirectiveClass: 699 K = CXCursor_OMPTeamsDistributeDirective; 700 break; 701 case Stmt::OMPTeamsDistributeSimdDirectiveClass: 702 K = CXCursor_OMPTeamsDistributeSimdDirective; 703 break; 704 case Stmt::OMPTeamsDistributeParallelForSimdDirectiveClass: 705 K = CXCursor_OMPTeamsDistributeParallelForSimdDirective; 706 break; 707 case Stmt::OMPTeamsDistributeParallelForDirectiveClass: 708 K = CXCursor_OMPTeamsDistributeParallelForDirective; 709 break; 710 case Stmt::OMPTargetTeamsDirectiveClass: 711 K = CXCursor_OMPTargetTeamsDirective; 712 break; 713 case Stmt::OMPTargetTeamsDistributeDirectiveClass: 714 K = CXCursor_OMPTargetTeamsDistributeDirective; 715 break; 716 case Stmt::OMPTargetTeamsDistributeParallelForDirectiveClass: 717 K = CXCursor_OMPTargetTeamsDistributeParallelForDirective; 718 break; 719 case Stmt::OMPTargetTeamsDistributeParallelForSimdDirectiveClass: 720 K = CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective; 721 break; 722 case Stmt::OMPTargetTeamsDistributeSimdDirectiveClass: 723 K = CXCursor_OMPTargetTeamsDistributeSimdDirective; 724 break; 725 case Stmt::BuiltinBitCastExprClass: 726 K = CXCursor_BuiltinBitCastExpr; 727 } 728 729 CXCursor C = { K, 0, { Parent, S, TU } }; 730 return C; 731 } 732 733 CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super, 734 SourceLocation Loc, 735 CXTranslationUnit TU) { 736 assert(Super && TU && "Invalid arguments!"); 737 void *RawLoc = Loc.getPtrEncoding(); 738 CXCursor C = { CXCursor_ObjCSuperClassRef, 0, { Super, RawLoc, TU } }; 739 return C; 740 } 741 742 std::pair<const ObjCInterfaceDecl *, SourceLocation> 743 cxcursor::getCursorObjCSuperClassRef(CXCursor C) { 744 assert(C.kind == CXCursor_ObjCSuperClassRef); 745 return std::make_pair(static_cast<const ObjCInterfaceDecl *>(C.data[0]), 746 SourceLocation::getFromPtrEncoding(C.data[1])); 747 } 748 749 CXCursor cxcursor::MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto, 750 SourceLocation Loc, 751 CXTranslationUnit TU) { 752 assert(Proto && TU && "Invalid arguments!"); 753 void *RawLoc = Loc.getPtrEncoding(); 754 CXCursor C = { CXCursor_ObjCProtocolRef, 0, { Proto, RawLoc, TU } }; 755 return C; 756 } 757 758 std::pair<const ObjCProtocolDecl *, SourceLocation> 759 cxcursor::getCursorObjCProtocolRef(CXCursor C) { 760 assert(C.kind == CXCursor_ObjCProtocolRef); 761 return std::make_pair(static_cast<const ObjCProtocolDecl *>(C.data[0]), 762 SourceLocation::getFromPtrEncoding(C.data[1])); 763 } 764 765 CXCursor cxcursor::MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class, 766 SourceLocation Loc, 767 CXTranslationUnit TU) { 768 // 'Class' can be null for invalid code. 769 if (!Class) 770 return MakeCXCursorInvalid(CXCursor_InvalidCode); 771 assert(TU && "Invalid arguments!"); 772 void *RawLoc = Loc.getPtrEncoding(); 773 CXCursor C = { CXCursor_ObjCClassRef, 0, { Class, RawLoc, TU } }; 774 return C; 775 } 776 777 std::pair<const ObjCInterfaceDecl *, SourceLocation> 778 cxcursor::getCursorObjCClassRef(CXCursor C) { 779 assert(C.kind == CXCursor_ObjCClassRef); 780 return std::make_pair(static_cast<const ObjCInterfaceDecl *>(C.data[0]), 781 SourceLocation::getFromPtrEncoding(C.data[1])); 782 } 783 784 CXCursor cxcursor::MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc, 785 CXTranslationUnit TU) { 786 assert(Type && TU && "Invalid arguments!"); 787 void *RawLoc = Loc.getPtrEncoding(); 788 CXCursor C = { CXCursor_TypeRef, 0, { Type, RawLoc, TU } }; 789 return C; 790 } 791 792 std::pair<const TypeDecl *, SourceLocation> 793 cxcursor::getCursorTypeRef(CXCursor C) { 794 assert(C.kind == CXCursor_TypeRef); 795 return std::make_pair(static_cast<const TypeDecl *>(C.data[0]), 796 SourceLocation::getFromPtrEncoding(C.data[1])); 797 } 798 799 CXCursor cxcursor::MakeCursorTemplateRef(const TemplateDecl *Template, 800 SourceLocation Loc, 801 CXTranslationUnit TU) { 802 assert(Template && TU && "Invalid arguments!"); 803 void *RawLoc = Loc.getPtrEncoding(); 804 CXCursor C = { CXCursor_TemplateRef, 0, { Template, RawLoc, TU } }; 805 return C; 806 } 807 808 std::pair<const TemplateDecl *, SourceLocation> 809 cxcursor::getCursorTemplateRef(CXCursor C) { 810 assert(C.kind == CXCursor_TemplateRef); 811 return std::make_pair(static_cast<const TemplateDecl *>(C.data[0]), 812 SourceLocation::getFromPtrEncoding(C.data[1])); 813 } 814 815 CXCursor cxcursor::MakeCursorNamespaceRef(const NamedDecl *NS, 816 SourceLocation Loc, 817 CXTranslationUnit TU) { 818 819 assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU && 820 "Invalid arguments!"); 821 void *RawLoc = Loc.getPtrEncoding(); 822 CXCursor C = { CXCursor_NamespaceRef, 0, { NS, RawLoc, TU } }; 823 return C; 824 } 825 826 std::pair<const NamedDecl *, SourceLocation> 827 cxcursor::getCursorNamespaceRef(CXCursor C) { 828 assert(C.kind == CXCursor_NamespaceRef); 829 return std::make_pair(static_cast<const NamedDecl *>(C.data[0]), 830 SourceLocation::getFromPtrEncoding(C.data[1])); 831 } 832 833 CXCursor cxcursor::MakeCursorVariableRef(const VarDecl *Var, SourceLocation Loc, 834 CXTranslationUnit TU) { 835 836 assert(Var && TU && "Invalid arguments!"); 837 void *RawLoc = Loc.getPtrEncoding(); 838 CXCursor C = { CXCursor_VariableRef, 0, { Var, RawLoc, TU } }; 839 return C; 840 } 841 842 std::pair<const VarDecl *, SourceLocation> 843 cxcursor::getCursorVariableRef(CXCursor C) { 844 assert(C.kind == CXCursor_VariableRef); 845 return std::make_pair(static_cast<const VarDecl *>(C.data[0]), 846 SourceLocation::getFromPtrEncoding(C.data[1])); 847 } 848 849 CXCursor cxcursor::MakeCursorMemberRef(const FieldDecl *Field, SourceLocation Loc, 850 CXTranslationUnit TU) { 851 852 assert(Field && TU && "Invalid arguments!"); 853 void *RawLoc = Loc.getPtrEncoding(); 854 CXCursor C = { CXCursor_MemberRef, 0, { Field, RawLoc, TU } }; 855 return C; 856 } 857 858 std::pair<const FieldDecl *, SourceLocation> 859 cxcursor::getCursorMemberRef(CXCursor C) { 860 assert(C.kind == CXCursor_MemberRef); 861 return std::make_pair(static_cast<const FieldDecl *>(C.data[0]), 862 SourceLocation::getFromPtrEncoding(C.data[1])); 863 } 864 865 CXCursor cxcursor::MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B, 866 CXTranslationUnit TU){ 867 CXCursor C = { CXCursor_CXXBaseSpecifier, 0, { B, nullptr, TU } }; 868 return C; 869 } 870 871 const CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) { 872 assert(C.kind == CXCursor_CXXBaseSpecifier); 873 return static_cast<const CXXBaseSpecifier*>(C.data[0]); 874 } 875 876 CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range, 877 CXTranslationUnit TU) { 878 CXCursor C = { CXCursor_PreprocessingDirective, 0, 879 { Range.getBegin().getPtrEncoding(), 880 Range.getEnd().getPtrEncoding(), 881 TU } 882 }; 883 return C; 884 } 885 886 SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) { 887 assert(C.kind == CXCursor_PreprocessingDirective); 888 SourceRange Range(SourceLocation::getFromPtrEncoding(C.data[0]), 889 SourceLocation::getFromPtrEncoding(C.data[1])); 890 ASTUnit *TU = getCursorASTUnit(C); 891 return TU->mapRangeFromPreamble(Range); 892 } 893 894 CXCursor cxcursor::MakeMacroDefinitionCursor(const MacroDefinitionRecord *MI, 895 CXTranslationUnit TU) { 896 CXCursor C = {CXCursor_MacroDefinition, 0, {MI, nullptr, TU}}; 897 return C; 898 } 899 900 const MacroDefinitionRecord *cxcursor::getCursorMacroDefinition(CXCursor C) { 901 assert(C.kind == CXCursor_MacroDefinition); 902 return static_cast<const MacroDefinitionRecord *>(C.data[0]); 903 } 904 905 CXCursor cxcursor::MakeMacroExpansionCursor(MacroExpansion *MI, 906 CXTranslationUnit TU) { 907 CXCursor C = { CXCursor_MacroExpansion, 0, { MI, nullptr, TU } }; 908 return C; 909 } 910 911 CXCursor cxcursor::MakeMacroExpansionCursor(MacroDefinitionRecord *MI, 912 SourceLocation Loc, 913 CXTranslationUnit TU) { 914 assert(Loc.isValid()); 915 CXCursor C = {CXCursor_MacroExpansion, 0, {MI, Loc.getPtrEncoding(), TU}}; 916 return C; 917 } 918 919 const IdentifierInfo *cxcursor::MacroExpansionCursor::getName() const { 920 if (isPseudo()) 921 return getAsMacroDefinition()->getName(); 922 return getAsMacroExpansion()->getName(); 923 } 924 const MacroDefinitionRecord * 925 cxcursor::MacroExpansionCursor::getDefinition() const { 926 if (isPseudo()) 927 return getAsMacroDefinition(); 928 return getAsMacroExpansion()->getDefinition(); 929 } 930 SourceRange cxcursor::MacroExpansionCursor::getSourceRange() const { 931 if (isPseudo()) 932 return getPseudoLoc(); 933 return getAsMacroExpansion()->getSourceRange(); 934 } 935 936 CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID, 937 CXTranslationUnit TU) { 938 CXCursor C = { CXCursor_InclusionDirective, 0, { ID, nullptr, TU } }; 939 return C; 940 } 941 942 const InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) { 943 assert(C.kind == CXCursor_InclusionDirective); 944 return static_cast<const InclusionDirective *>(C.data[0]); 945 } 946 947 CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc, 948 CXTranslationUnit TU) { 949 950 assert(Label && TU && "Invalid arguments!"); 951 void *RawLoc = Loc.getPtrEncoding(); 952 CXCursor C = { CXCursor_LabelRef, 0, { Label, RawLoc, TU } }; 953 return C; 954 } 955 956 std::pair<const LabelStmt *, SourceLocation> 957 cxcursor::getCursorLabelRef(CXCursor C) { 958 assert(C.kind == CXCursor_LabelRef); 959 return std::make_pair(static_cast<const LabelStmt *>(C.data[0]), 960 SourceLocation::getFromPtrEncoding(C.data[1])); 961 } 962 963 CXCursor cxcursor::MakeCursorOverloadedDeclRef(const OverloadExpr *E, 964 CXTranslationUnit TU) { 965 assert(E && TU && "Invalid arguments!"); 966 OverloadedDeclRefStorage Storage(E); 967 void *RawLoc = E->getNameLoc().getPtrEncoding(); 968 CXCursor C = { 969 CXCursor_OverloadedDeclRef, 0, 970 { Storage.getOpaqueValue(), RawLoc, TU } 971 }; 972 return C; 973 } 974 975 CXCursor cxcursor::MakeCursorOverloadedDeclRef(const Decl *D, 976 SourceLocation Loc, 977 CXTranslationUnit TU) { 978 assert(D && TU && "Invalid arguments!"); 979 void *RawLoc = Loc.getPtrEncoding(); 980 OverloadedDeclRefStorage Storage(D); 981 CXCursor C = { 982 CXCursor_OverloadedDeclRef, 0, 983 { Storage.getOpaqueValue(), RawLoc, TU } 984 }; 985 return C; 986 } 987 988 CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name, 989 SourceLocation Loc, 990 CXTranslationUnit TU) { 991 assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!"); 992 void *RawLoc = Loc.getPtrEncoding(); 993 OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate()); 994 CXCursor C = { 995 CXCursor_OverloadedDeclRef, 0, 996 { Storage.getOpaqueValue(), RawLoc, TU } 997 }; 998 return C; 999 } 1000 1001 std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation> 1002 cxcursor::getCursorOverloadedDeclRef(CXCursor C) { 1003 assert(C.kind == CXCursor_OverloadedDeclRef); 1004 return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue( 1005 const_cast<void *>(C.data[0])), 1006 SourceLocation::getFromPtrEncoding(C.data[1])); 1007 } 1008 1009 const Decl *cxcursor::getCursorDecl(CXCursor Cursor) { 1010 return static_cast<const Decl *>(Cursor.data[0]); 1011 } 1012 1013 const Expr *cxcursor::getCursorExpr(CXCursor Cursor) { 1014 return dyn_cast_or_null<Expr>(getCursorStmt(Cursor)); 1015 } 1016 1017 const Stmt *cxcursor::getCursorStmt(CXCursor Cursor) { 1018 if (Cursor.kind == CXCursor_ObjCSuperClassRef || 1019 Cursor.kind == CXCursor_ObjCProtocolRef || 1020 Cursor.kind == CXCursor_ObjCClassRef) 1021 return nullptr; 1022 1023 return static_cast<const Stmt *>(Cursor.data[1]); 1024 } 1025 1026 const Attr *cxcursor::getCursorAttr(CXCursor Cursor) { 1027 return static_cast<const Attr *>(Cursor.data[1]); 1028 } 1029 1030 ASTContext &cxcursor::getCursorContext(CXCursor Cursor) { 1031 return getCursorASTUnit(Cursor)->getASTContext(); 1032 } 1033 1034 ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) { 1035 CXTranslationUnit TU = getCursorTU(Cursor); 1036 if (!TU) 1037 return nullptr; 1038 return cxtu::getASTUnit(TU); 1039 } 1040 1041 CXTranslationUnit cxcursor::getCursorTU(CXCursor Cursor) { 1042 return static_cast<CXTranslationUnit>(const_cast<void*>(Cursor.data[2])); 1043 } 1044 1045 void cxcursor::getOverriddenCursors(CXCursor cursor, 1046 SmallVectorImpl<CXCursor> &overridden) { 1047 assert(clang_isDeclaration(cursor.kind)); 1048 const NamedDecl *D = dyn_cast_or_null<NamedDecl>(getCursorDecl(cursor)); 1049 if (!D) 1050 return; 1051 1052 CXTranslationUnit TU = getCursorTU(cursor); 1053 SmallVector<const NamedDecl *, 8> OverDecls; 1054 D->getASTContext().getOverriddenMethods(D, OverDecls); 1055 1056 for (SmallVectorImpl<const NamedDecl *>::iterator 1057 I = OverDecls.begin(), E = OverDecls.end(); I != E; ++I) { 1058 overridden.push_back(MakeCXCursor(*I, TU)); 1059 } 1060 } 1061 1062 std::pair<int, SourceLocation> 1063 cxcursor::getSelectorIdentifierIndexAndLoc(CXCursor cursor) { 1064 if (cursor.kind == CXCursor_ObjCMessageExpr) { 1065 if (cursor.xdata != -1) 1066 return std::make_pair(cursor.xdata, 1067 cast<ObjCMessageExpr>(getCursorExpr(cursor)) 1068 ->getSelectorLoc(cursor.xdata)); 1069 } else if (cursor.kind == CXCursor_ObjCClassMethodDecl || 1070 cursor.kind == CXCursor_ObjCInstanceMethodDecl) { 1071 if (cursor.xdata != -1) 1072 return std::make_pair(cursor.xdata, 1073 cast<ObjCMethodDecl>(getCursorDecl(cursor)) 1074 ->getSelectorLoc(cursor.xdata)); 1075 } 1076 1077 return std::make_pair(-1, SourceLocation()); 1078 } 1079 1080 CXCursor cxcursor::getSelectorIdentifierCursor(int SelIdx, CXCursor cursor) { 1081 CXCursor newCursor = cursor; 1082 1083 if (cursor.kind == CXCursor_ObjCMessageExpr) { 1084 if (SelIdx == -1 || 1085 unsigned(SelIdx) >= cast<ObjCMessageExpr>(getCursorExpr(cursor)) 1086 ->getNumSelectorLocs()) 1087 newCursor.xdata = -1; 1088 else 1089 newCursor.xdata = SelIdx; 1090 } else if (cursor.kind == CXCursor_ObjCClassMethodDecl || 1091 cursor.kind == CXCursor_ObjCInstanceMethodDecl) { 1092 if (SelIdx == -1 || 1093 unsigned(SelIdx) >= cast<ObjCMethodDecl>(getCursorDecl(cursor)) 1094 ->getNumSelectorLocs()) 1095 newCursor.xdata = -1; 1096 else 1097 newCursor.xdata = SelIdx; 1098 } 1099 1100 return newCursor; 1101 } 1102 1103 CXCursor cxcursor::getTypeRefCursor(CXCursor cursor) { 1104 if (cursor.kind != CXCursor_CallExpr) 1105 return cursor; 1106 1107 if (cursor.xdata == 0) 1108 return cursor; 1109 1110 const Expr *E = getCursorExpr(cursor); 1111 TypeSourceInfo *Type = nullptr; 1112 if (const CXXUnresolvedConstructExpr * 1113 UnCtor = dyn_cast<CXXUnresolvedConstructExpr>(E)) { 1114 Type = UnCtor->getTypeSourceInfo(); 1115 } else if (const CXXTemporaryObjectExpr *Tmp = 1116 dyn_cast<CXXTemporaryObjectExpr>(E)){ 1117 Type = Tmp->getTypeSourceInfo(); 1118 } 1119 1120 if (!Type) 1121 return cursor; 1122 1123 CXTranslationUnit TU = getCursorTU(cursor); 1124 QualType Ty = Type->getType(); 1125 TypeLoc TL = Type->getTypeLoc(); 1126 SourceLocation Loc = TL.getBeginLoc(); 1127 1128 if (const ElaboratedType *ElabT = Ty->getAs<ElaboratedType>()) { 1129 Ty = ElabT->getNamedType(); 1130 ElaboratedTypeLoc ElabTL = TL.castAs<ElaboratedTypeLoc>(); 1131 Loc = ElabTL.getNamedTypeLoc().getBeginLoc(); 1132 } 1133 1134 if (const TypedefType *Typedef = Ty->getAs<TypedefType>()) 1135 return MakeCursorTypeRef(Typedef->getDecl(), Loc, TU); 1136 if (const TagType *Tag = Ty->getAs<TagType>()) 1137 return MakeCursorTypeRef(Tag->getDecl(), Loc, TU); 1138 if (const TemplateTypeParmType *TemplP = Ty->getAs<TemplateTypeParmType>()) 1139 return MakeCursorTypeRef(TemplP->getDecl(), Loc, TU); 1140 1141 return cursor; 1142 } 1143 1144 bool cxcursor::operator==(CXCursor X, CXCursor Y) { 1145 return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] && 1146 X.data[2] == Y.data[2]; 1147 } 1148 1149 // FIXME: Remove once we can model DeclGroups and their appropriate ranges 1150 // properly in the ASTs. 1151 bool cxcursor::isFirstInDeclGroup(CXCursor C) { 1152 assert(clang_isDeclaration(C.kind)); 1153 return ((uintptr_t) (C.data[1])) != 0; 1154 } 1155 1156 //===----------------------------------------------------------------------===// 1157 // libclang CXCursor APIs 1158 //===----------------------------------------------------------------------===// 1159 1160 int clang_Cursor_isNull(CXCursor cursor) { 1161 return clang_equalCursors(cursor, clang_getNullCursor()); 1162 } 1163 1164 CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor cursor) { 1165 return getCursorTU(cursor); 1166 } 1167 1168 int clang_Cursor_getNumArguments(CXCursor C) { 1169 if (clang_isDeclaration(C.kind)) { 1170 const Decl *D = cxcursor::getCursorDecl(C); 1171 if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) 1172 return MD->param_size(); 1173 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) 1174 return FD->param_size(); 1175 } 1176 1177 if (clang_isExpression(C.kind)) { 1178 const Expr *E = cxcursor::getCursorExpr(C); 1179 if (const CallExpr *CE = dyn_cast<CallExpr>(E)) { 1180 return CE->getNumArgs(); 1181 } 1182 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E)) { 1183 return CE->getNumArgs(); 1184 } 1185 } 1186 1187 return -1; 1188 } 1189 1190 CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i) { 1191 if (clang_isDeclaration(C.kind)) { 1192 const Decl *D = cxcursor::getCursorDecl(C); 1193 if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) { 1194 if (i < MD->param_size()) 1195 return cxcursor::MakeCXCursor(MD->parameters()[i], 1196 cxcursor::getCursorTU(C)); 1197 } else if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) { 1198 if (i < FD->param_size()) 1199 return cxcursor::MakeCXCursor(FD->parameters()[i], 1200 cxcursor::getCursorTU(C)); 1201 } 1202 } 1203 1204 if (clang_isExpression(C.kind)) { 1205 const Expr *E = cxcursor::getCursorExpr(C); 1206 if (const CallExpr *CE = dyn_cast<CallExpr>(E)) { 1207 if (i < CE->getNumArgs()) { 1208 return cxcursor::MakeCXCursor(CE->getArg(i), 1209 getCursorDecl(C), 1210 cxcursor::getCursorTU(C)); 1211 } 1212 } 1213 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E)) { 1214 if (i < CE->getNumArgs()) { 1215 return cxcursor::MakeCXCursor(CE->getArg(i), 1216 getCursorDecl(C), 1217 cxcursor::getCursorTU(C)); 1218 } 1219 } 1220 } 1221 1222 return clang_getNullCursor(); 1223 } 1224 1225 int clang_Cursor_getNumTemplateArguments(CXCursor C) { 1226 if (clang_getCursorKind(C) != CXCursor_FunctionDecl) { 1227 return -1; 1228 } 1229 1230 const FunctionDecl *FD = llvm::dyn_cast_or_null<clang::FunctionDecl>( 1231 getCursorDecl(C)); 1232 if (!FD) { 1233 return -1; 1234 } 1235 1236 const FunctionTemplateSpecializationInfo* SpecInfo = 1237 FD->getTemplateSpecializationInfo(); 1238 if (!SpecInfo) { 1239 return -1; 1240 } 1241 1242 return SpecInfo->TemplateArguments->size(); 1243 } 1244 1245 enum CXGetTemplateArgumentStatus { 1246 /** The operation completed successfully */ 1247 CXGetTemplateArgumentStatus_Success = 0, 1248 1249 /** The specified cursor did not represent a FunctionDecl. */ 1250 CXGetTemplateArgumentStatus_CursorNotFunctionDecl = -1, 1251 1252 /** The specified cursor was not castable to a FunctionDecl. */ 1253 CXGetTemplateArgumentStatus_BadFunctionDeclCast = -2, 1254 1255 /** A NULL FunctionTemplateSpecializationInfo was retrieved. */ 1256 CXGetTemplateArgumentStatus_NullTemplSpecInfo = -3, 1257 1258 /** An invalid (OOB) argument index was specified */ 1259 CXGetTemplateArgumentStatus_InvalidIndex = -4 1260 }; 1261 1262 static int clang_Cursor_getTemplateArgument( 1263 CXCursor C, unsigned I, TemplateArgument *TA) { 1264 if (clang_getCursorKind(C) != CXCursor_FunctionDecl) { 1265 return CXGetTemplateArgumentStatus_CursorNotFunctionDecl; 1266 } 1267 1268 const FunctionDecl *FD = llvm::dyn_cast_or_null<clang::FunctionDecl>( 1269 getCursorDecl(C)); 1270 if (!FD) { 1271 return CXGetTemplateArgumentStatus_BadFunctionDeclCast; 1272 } 1273 1274 const FunctionTemplateSpecializationInfo* SpecInfo = 1275 FD->getTemplateSpecializationInfo(); 1276 if (!SpecInfo) { 1277 return CXGetTemplateArgumentStatus_NullTemplSpecInfo; 1278 } 1279 1280 if (I >= SpecInfo->TemplateArguments->size()) { 1281 return CXGetTemplateArgumentStatus_InvalidIndex; 1282 } 1283 1284 *TA = SpecInfo->TemplateArguments->get(I); 1285 return 0; 1286 } 1287 1288 enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(CXCursor C, 1289 unsigned I) { 1290 TemplateArgument TA; 1291 if (clang_Cursor_getTemplateArgument(C, I, &TA)) { 1292 return CXTemplateArgumentKind_Invalid; 1293 } 1294 1295 switch (TA.getKind()) { 1296 case TemplateArgument::Null: return CXTemplateArgumentKind_Null; 1297 case TemplateArgument::Type: return CXTemplateArgumentKind_Type; 1298 case TemplateArgument::Declaration: 1299 return CXTemplateArgumentKind_Declaration; 1300 case TemplateArgument::NullPtr: return CXTemplateArgumentKind_NullPtr; 1301 case TemplateArgument::Integral: return CXTemplateArgumentKind_Integral; 1302 case TemplateArgument::Template: return CXTemplateArgumentKind_Template; 1303 case TemplateArgument::TemplateExpansion: 1304 return CXTemplateArgumentKind_TemplateExpansion; 1305 case TemplateArgument::Expression: return CXTemplateArgumentKind_Expression; 1306 case TemplateArgument::Pack: return CXTemplateArgumentKind_Pack; 1307 } 1308 1309 return CXTemplateArgumentKind_Invalid; 1310 } 1311 1312 CXType clang_Cursor_getTemplateArgumentType(CXCursor C, unsigned I) { 1313 TemplateArgument TA; 1314 if (clang_Cursor_getTemplateArgument(C, I, &TA) != 1315 CXGetTemplateArgumentStatus_Success) { 1316 return cxtype::MakeCXType(QualType(), getCursorTU(C)); 1317 } 1318 1319 if (TA.getKind() != TemplateArgument::Type) { 1320 return cxtype::MakeCXType(QualType(), getCursorTU(C)); 1321 } 1322 1323 return cxtype::MakeCXType(TA.getAsType(), getCursorTU(C)); 1324 } 1325 1326 long long clang_Cursor_getTemplateArgumentValue(CXCursor C, unsigned I) { 1327 TemplateArgument TA; 1328 if (clang_Cursor_getTemplateArgument(C, I, &TA) != 1329 CXGetTemplateArgumentStatus_Success) { 1330 assert(0 && "Unable to retrieve TemplateArgument"); 1331 return 0; 1332 } 1333 1334 if (TA.getKind() != TemplateArgument::Integral) { 1335 assert(0 && "Passed template argument is not Integral"); 1336 return 0; 1337 } 1338 1339 return TA.getAsIntegral().getSExtValue(); 1340 } 1341 1342 unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(CXCursor C, 1343 unsigned I) { 1344 TemplateArgument TA; 1345 if (clang_Cursor_getTemplateArgument(C, I, &TA) != 1346 CXGetTemplateArgumentStatus_Success) { 1347 assert(0 && "Unable to retrieve TemplateArgument"); 1348 return 0; 1349 } 1350 1351 if (TA.getKind() != TemplateArgument::Integral) { 1352 assert(0 && "Passed template argument is not Integral"); 1353 return 0; 1354 } 1355 1356 return TA.getAsIntegral().getZExtValue(); 1357 } 1358 1359 //===----------------------------------------------------------------------===// 1360 // CXCursorSet. 1361 //===----------------------------------------------------------------------===// 1362 1363 typedef llvm::DenseMap<CXCursor, unsigned> CXCursorSet_Impl; 1364 1365 static inline CXCursorSet packCXCursorSet(CXCursorSet_Impl *setImpl) { 1366 return (CXCursorSet) setImpl; 1367 } 1368 static inline CXCursorSet_Impl *unpackCXCursorSet(CXCursorSet set) { 1369 return (CXCursorSet_Impl*) set; 1370 } 1371 namespace llvm { 1372 template<> struct DenseMapInfo<CXCursor> { 1373 public: 1374 static inline CXCursor getEmptyKey() { 1375 return MakeCXCursorInvalid(CXCursor_InvalidFile); 1376 } 1377 static inline CXCursor getTombstoneKey() { 1378 return MakeCXCursorInvalid(CXCursor_NoDeclFound); 1379 } 1380 static inline unsigned getHashValue(const CXCursor &cursor) { 1381 return llvm::DenseMapInfo<std::pair<const void *, const void *> > 1382 ::getHashValue(std::make_pair(cursor.data[0], cursor.data[1])); 1383 } 1384 static inline bool isEqual(const CXCursor &x, const CXCursor &y) { 1385 return x.kind == y.kind && 1386 x.data[0] == y.data[0] && 1387 x.data[1] == y.data[1]; 1388 } 1389 }; 1390 } 1391 1392 CXCursorSet clang_createCXCursorSet() { 1393 return packCXCursorSet(new CXCursorSet_Impl()); 1394 } 1395 1396 void clang_disposeCXCursorSet(CXCursorSet set) { 1397 delete unpackCXCursorSet(set); 1398 } 1399 1400 unsigned clang_CXCursorSet_contains(CXCursorSet set, CXCursor cursor) { 1401 CXCursorSet_Impl *setImpl = unpackCXCursorSet(set); 1402 if (!setImpl) 1403 return 0; 1404 return setImpl->find(cursor) != setImpl->end(); 1405 } 1406 1407 unsigned clang_CXCursorSet_insert(CXCursorSet set, CXCursor cursor) { 1408 // Do not insert invalid cursors into the set. 1409 if (cursor.kind >= CXCursor_FirstInvalid && 1410 cursor.kind <= CXCursor_LastInvalid) 1411 return 1; 1412 1413 CXCursorSet_Impl *setImpl = unpackCXCursorSet(set); 1414 if (!setImpl) 1415 return 1; 1416 unsigned &entry = (*setImpl)[cursor]; 1417 unsigned flag = entry == 0 ? 1 : 0; 1418 entry = 1; 1419 return flag; 1420 } 1421 1422 CXCompletionString clang_getCursorCompletionString(CXCursor cursor) { 1423 enum CXCursorKind kind = clang_getCursorKind(cursor); 1424 if (clang_isDeclaration(kind)) { 1425 const Decl *decl = getCursorDecl(cursor); 1426 if (const NamedDecl *namedDecl = dyn_cast_or_null<NamedDecl>(decl)) { 1427 ASTUnit *unit = getCursorASTUnit(cursor); 1428 CodeCompletionResult Result(namedDecl, CCP_Declaration); 1429 CodeCompletionString *String 1430 = Result.CreateCodeCompletionString(unit->getASTContext(), 1431 unit->getPreprocessor(), 1432 CodeCompletionContext::CCC_Other, 1433 unit->getCodeCompletionTUInfo().getAllocator(), 1434 unit->getCodeCompletionTUInfo(), 1435 true); 1436 return String; 1437 } 1438 } else if (kind == CXCursor_MacroDefinition) { 1439 const MacroDefinitionRecord *definition = getCursorMacroDefinition(cursor); 1440 const IdentifierInfo *Macro = definition->getName(); 1441 ASTUnit *unit = getCursorASTUnit(cursor); 1442 CodeCompletionResult Result( 1443 Macro, 1444 unit->getPreprocessor().getMacroDefinition(Macro).getMacroInfo()); 1445 CodeCompletionString *String = Result.CreateCodeCompletionString( 1446 unit->getASTContext(), unit->getPreprocessor(), 1447 CodeCompletionContext::CCC_Other, 1448 unit->getCodeCompletionTUInfo().getAllocator(), 1449 unit->getCodeCompletionTUInfo(), false); 1450 return String; 1451 } 1452 return nullptr; 1453 } 1454 1455 namespace { 1456 struct OverridenCursorsPool { 1457 typedef SmallVector<CXCursor, 2> CursorVec; 1458 std::vector<CursorVec*> AllCursors; 1459 std::vector<CursorVec*> AvailableCursors; 1460 1461 ~OverridenCursorsPool() { 1462 for (std::vector<CursorVec*>::iterator I = AllCursors.begin(), 1463 E = AllCursors.end(); I != E; ++I) { 1464 delete *I; 1465 } 1466 } 1467 }; 1468 } 1469 1470 void *cxcursor::createOverridenCXCursorsPool() { 1471 return new OverridenCursorsPool(); 1472 } 1473 1474 void cxcursor::disposeOverridenCXCursorsPool(void *pool) { 1475 delete static_cast<OverridenCursorsPool*>(pool); 1476 } 1477 1478 void clang_getOverriddenCursors(CXCursor cursor, 1479 CXCursor **overridden, 1480 unsigned *num_overridden) { 1481 if (overridden) 1482 *overridden = nullptr; 1483 if (num_overridden) 1484 *num_overridden = 0; 1485 1486 CXTranslationUnit TU = cxcursor::getCursorTU(cursor); 1487 1488 if (!overridden || !num_overridden || !TU) 1489 return; 1490 1491 if (!clang_isDeclaration(cursor.kind)) 1492 return; 1493 1494 OverridenCursorsPool &pool = 1495 *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool); 1496 1497 OverridenCursorsPool::CursorVec *Vec = nullptr; 1498 1499 if (!pool.AvailableCursors.empty()) { 1500 Vec = pool.AvailableCursors.back(); 1501 pool.AvailableCursors.pop_back(); 1502 } 1503 else { 1504 Vec = new OverridenCursorsPool::CursorVec(); 1505 pool.AllCursors.push_back(Vec); 1506 } 1507 1508 // Clear out the vector, but don't free the memory contents. This 1509 // reduces malloc() traffic. 1510 Vec->clear(); 1511 1512 // Use the first entry to contain a back reference to the vector. 1513 // This is a complete hack. 1514 CXCursor backRefCursor = MakeCXCursorInvalid(CXCursor_InvalidFile, TU); 1515 backRefCursor.data[0] = Vec; 1516 assert(cxcursor::getCursorTU(backRefCursor) == TU); 1517 Vec->push_back(backRefCursor); 1518 1519 // Get the overridden cursors. 1520 cxcursor::getOverriddenCursors(cursor, *Vec); 1521 1522 // Did we get any overridden cursors? If not, return Vec to the pool 1523 // of available cursor vectors. 1524 if (Vec->size() == 1) { 1525 pool.AvailableCursors.push_back(Vec); 1526 return; 1527 } 1528 1529 // Now tell the caller about the overridden cursors. 1530 assert(Vec->size() > 1); 1531 *overridden = &((*Vec)[1]); 1532 *num_overridden = Vec->size() - 1; 1533 } 1534 1535 void clang_disposeOverriddenCursors(CXCursor *overridden) { 1536 if (!overridden) 1537 return; 1538 1539 // Use pointer arithmetic to get back the first faux entry 1540 // which has a back-reference to the TU and the vector. 1541 --overridden; 1542 OverridenCursorsPool::CursorVec *Vec = 1543 static_cast<OverridenCursorsPool::CursorVec *>( 1544 const_cast<void *>(overridden->data[0])); 1545 CXTranslationUnit TU = getCursorTU(*overridden); 1546 1547 assert(Vec && TU); 1548 1549 OverridenCursorsPool &pool = 1550 *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool); 1551 1552 pool.AvailableCursors.push_back(Vec); 1553 } 1554 1555 int clang_Cursor_isDynamicCall(CXCursor C) { 1556 const Expr *E = nullptr; 1557 if (clang_isExpression(C.kind)) 1558 E = getCursorExpr(C); 1559 if (!E) 1560 return 0; 1561 1562 if (const ObjCMessageExpr *MsgE = dyn_cast<ObjCMessageExpr>(E)) { 1563 if (MsgE->getReceiverKind() != ObjCMessageExpr::Instance) 1564 return false; 1565 if (auto *RecE = dyn_cast<ObjCMessageExpr>( 1566 MsgE->getInstanceReceiver()->IgnoreParenCasts())) { 1567 if (RecE->getMethodFamily() == OMF_alloc) 1568 return false; 1569 } 1570 return true; 1571 } 1572 1573 if (auto *PropRefE = dyn_cast<ObjCPropertyRefExpr>(E)) { 1574 return !PropRefE->isSuperReceiver(); 1575 } 1576 1577 const MemberExpr *ME = nullptr; 1578 if (isa<MemberExpr>(E)) 1579 ME = cast<MemberExpr>(E); 1580 else if (const CallExpr *CE = dyn_cast<CallExpr>(E)) 1581 ME = dyn_cast_or_null<MemberExpr>(CE->getCallee()); 1582 1583 if (ME) { 1584 if (const CXXMethodDecl * 1585 MD = dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl())) 1586 return MD->isVirtual() && 1587 ME->performsVirtualDispatch( 1588 cxcursor::getCursorContext(C).getLangOpts()); 1589 } 1590 1591 return 0; 1592 } 1593 1594 CXType clang_Cursor_getReceiverType(CXCursor C) { 1595 CXTranslationUnit TU = cxcursor::getCursorTU(C); 1596 const Expr *E = nullptr; 1597 if (clang_isExpression(C.kind)) 1598 E = getCursorExpr(C); 1599 1600 if (const ObjCMessageExpr *MsgE = dyn_cast_or_null<ObjCMessageExpr>(E)) 1601 return cxtype::MakeCXType(MsgE->getReceiverType(), TU); 1602 1603 if (auto *PropRefE = dyn_cast<ObjCPropertyRefExpr>(E)) { 1604 return cxtype::MakeCXType( 1605 PropRefE->getReceiverType(cxcursor::getCursorContext(C)), TU); 1606 } 1607 1608 const MemberExpr *ME = nullptr; 1609 if (isa<MemberExpr>(E)) 1610 ME = cast<MemberExpr>(E); 1611 else if (const CallExpr *CE = dyn_cast<CallExpr>(E)) 1612 ME = dyn_cast_or_null<MemberExpr>(CE->getCallee()); 1613 1614 if (ME) { 1615 if (dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl())) { 1616 auto receiverTy = ME->getBase()->IgnoreImpCasts()->getType(); 1617 return cxtype::MakeCXType(receiverTy, TU); 1618 } 1619 } 1620 1621 return cxtype::MakeCXType(QualType(), TU); 1622 } 1623