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