1 //===- CXCursor.cpp - Routines for manipulating CXCursors -----------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file defines routines for manipulating CXCursors. It should be the 11 // only file that has internal knowledge of the encoding of the data in 12 // CXCursor. 13 // 14 //===----------------------------------------------------------------------===// 15 16 #include "CXCursor.h" 17 #include "clang/Frontend/ASTUnit.h" 18 #include "clang/AST/Decl.h" 19 #include "clang/AST/DeclCXX.h" 20 #include "clang/AST/DeclObjC.h" 21 #include "clang/AST/Expr.h" 22 #include "llvm/Support/ErrorHandling.h" 23 24 using namespace clang; 25 26 CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K) { 27 assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid); 28 CXCursor C = { K, { 0, 0, 0 } }; 29 return C; 30 } 31 32 static CXCursorKind GetCursorKind(Decl *D) { 33 assert(D && "Invalid arguments!"); 34 switch (D->getKind()) { 35 case Decl::Enum: return CXCursor_EnumDecl; 36 case Decl::EnumConstant: return CXCursor_EnumConstantDecl; 37 case Decl::Field: return CXCursor_FieldDecl; 38 case Decl::Function: 39 return CXCursor_FunctionDecl; 40 case Decl::ObjCCategory: return CXCursor_ObjCCategoryDecl; 41 case Decl::ObjCCategoryImpl: return CXCursor_ObjCCategoryImplDecl; 42 case Decl::ObjCClass: 43 // FIXME 44 return CXCursor_UnexposedDecl; 45 case Decl::ObjCForwardProtocol: 46 // FIXME 47 return CXCursor_UnexposedDecl; 48 case Decl::ObjCImplementation: return CXCursor_ObjCImplementationDecl; 49 case Decl::ObjCInterface: return CXCursor_ObjCInterfaceDecl; 50 case Decl::ObjCIvar: return CXCursor_ObjCIvarDecl; 51 case Decl::ObjCMethod: 52 return cast<ObjCMethodDecl>(D)->isInstanceMethod() 53 ? CXCursor_ObjCInstanceMethodDecl : CXCursor_ObjCClassMethodDecl; 54 case Decl::CXXMethod: return CXCursor_CXXMethod; 55 case Decl::CXXConstructor: return CXCursor_Constructor; 56 case Decl::CXXDestructor: return CXCursor_Destructor; 57 case Decl::CXXConversion: return CXCursor_ConversionFunction; 58 case Decl::ObjCProperty: return CXCursor_ObjCPropertyDecl; 59 case Decl::ObjCProtocol: return CXCursor_ObjCProtocolDecl; 60 case Decl::ParmVar: return CXCursor_ParmDecl; 61 case Decl::Typedef: return CXCursor_TypedefDecl; 62 case Decl::Var: return CXCursor_VarDecl; 63 case Decl::Namespace: return CXCursor_Namespace; 64 case Decl::NamespaceAlias: return CXCursor_NamespaceAlias; 65 case Decl::TemplateTypeParm: return CXCursor_TemplateTypeParameter; 66 case Decl::NonTypeTemplateParm:return CXCursor_NonTypeTemplateParameter; 67 case Decl::TemplateTemplateParm:return CXCursor_TemplateTemplateParameter; 68 case Decl::FunctionTemplate: return CXCursor_FunctionTemplate; 69 case Decl::ClassTemplate: return CXCursor_ClassTemplate; 70 case Decl::ClassTemplatePartialSpecialization: 71 return CXCursor_ClassTemplatePartialSpecialization; 72 case Decl::UsingDirective: return CXCursor_UsingDirective; 73 74 case Decl::Using: 75 case Decl::UnresolvedUsingValue: 76 case Decl::UnresolvedUsingTypename: 77 return CXCursor_UsingDeclaration; 78 79 default: 80 if (TagDecl *TD = dyn_cast<TagDecl>(D)) { 81 switch (TD->getTagKind()) { 82 case TTK_Struct: return CXCursor_StructDecl; 83 case TTK_Class: return CXCursor_ClassDecl; 84 case TTK_Union: return CXCursor_UnionDecl; 85 case TTK_Enum: return CXCursor_EnumDecl; 86 } 87 } 88 89 return CXCursor_UnexposedDecl; 90 } 91 92 llvm_unreachable("Invalid Decl"); 93 return CXCursor_NotImplemented; 94 } 95 96 static CXCursorKind GetCursorKind(const Attr *A) { 97 assert(A && "Invalid arguments!"); 98 switch (A->getKind()) { 99 default: break; 100 case attr::IBAction: return CXCursor_IBActionAttr; 101 case attr::IBOutlet: return CXCursor_IBOutletAttr; 102 case attr::IBOutletCollection: return CXCursor_IBOutletCollectionAttr; 103 } 104 105 return CXCursor_UnexposedAttr; 106 } 107 108 CXCursor cxcursor::MakeCXCursor(const Attr *A, Decl *Parent, ASTUnit *TU) { 109 assert(A && Parent && TU && "Invalid arguments!"); 110 CXCursor C = { GetCursorKind(A), { Parent, (void*)A, TU } }; 111 return C; 112 } 113 114 CXCursor cxcursor::MakeCXCursor(Decl *D, ASTUnit *TU) { 115 assert(D && TU && "Invalid arguments!"); 116 CXCursor C = { GetCursorKind(D), { D, 0, TU } }; 117 return C; 118 } 119 120 CXCursor cxcursor::MakeCXCursor(Stmt *S, Decl *Parent, ASTUnit *TU) { 121 assert(S && TU && "Invalid arguments!"); 122 CXCursorKind K = CXCursor_NotImplemented; 123 124 switch (S->getStmtClass()) { 125 case Stmt::NoStmtClass: 126 break; 127 128 case Stmt::NullStmtClass: 129 case Stmt::CompoundStmtClass: 130 case Stmt::CaseStmtClass: 131 case Stmt::DefaultStmtClass: 132 case Stmt::LabelStmtClass: 133 case Stmt::IfStmtClass: 134 case Stmt::SwitchStmtClass: 135 case Stmt::WhileStmtClass: 136 case Stmt::DoStmtClass: 137 case Stmt::ForStmtClass: 138 case Stmt::GotoStmtClass: 139 case Stmt::IndirectGotoStmtClass: 140 case Stmt::ContinueStmtClass: 141 case Stmt::BreakStmtClass: 142 case Stmt::ReturnStmtClass: 143 case Stmt::DeclStmtClass: 144 case Stmt::SwitchCaseClass: 145 case Stmt::AsmStmtClass: 146 case Stmt::ObjCAtTryStmtClass: 147 case Stmt::ObjCAtCatchStmtClass: 148 case Stmt::ObjCAtFinallyStmtClass: 149 case Stmt::ObjCAtThrowStmtClass: 150 case Stmt::ObjCAtSynchronizedStmtClass: 151 case Stmt::ObjCForCollectionStmtClass: 152 case Stmt::CXXCatchStmtClass: 153 case Stmt::CXXTryStmtClass: 154 K = CXCursor_UnexposedStmt; 155 break; 156 157 case Stmt::PredefinedExprClass: 158 case Stmt::IntegerLiteralClass: 159 case Stmt::FloatingLiteralClass: 160 case Stmt::ImaginaryLiteralClass: 161 case Stmt::StringLiteralClass: 162 case Stmt::CharacterLiteralClass: 163 case Stmt::ParenExprClass: 164 case Stmt::UnaryOperatorClass: 165 case Stmt::OffsetOfExprClass: 166 case Stmt::SizeOfAlignOfExprClass: 167 case Stmt::ArraySubscriptExprClass: 168 case Stmt::BinaryOperatorClass: 169 case Stmt::CompoundAssignOperatorClass: 170 case Stmt::ConditionalOperatorClass: 171 case Stmt::ImplicitCastExprClass: 172 case Stmt::CStyleCastExprClass: 173 case Stmt::CompoundLiteralExprClass: 174 case Stmt::ExtVectorElementExprClass: 175 case Stmt::InitListExprClass: 176 case Stmt::DesignatedInitExprClass: 177 case Stmt::ImplicitValueInitExprClass: 178 case Stmt::ParenListExprClass: 179 case Stmt::VAArgExprClass: 180 case Stmt::AddrLabelExprClass: 181 case Stmt::StmtExprClass: 182 case Stmt::TypesCompatibleExprClass: 183 case Stmt::ChooseExprClass: 184 case Stmt::GNUNullExprClass: 185 case Stmt::CXXStaticCastExprClass: 186 case Stmt::CXXDynamicCastExprClass: 187 case Stmt::CXXReinterpretCastExprClass: 188 case Stmt::CXXConstCastExprClass: 189 case Stmt::CXXFunctionalCastExprClass: 190 case Stmt::CXXTypeidExprClass: 191 case Stmt::CXXBoolLiteralExprClass: 192 case Stmt::CXXNullPtrLiteralExprClass: 193 case Stmt::CXXThisExprClass: 194 case Stmt::CXXThrowExprClass: 195 case Stmt::CXXDefaultArgExprClass: 196 case Stmt::CXXScalarValueInitExprClass: 197 case Stmt::CXXNewExprClass: 198 case Stmt::CXXDeleteExprClass: 199 case Stmt::CXXPseudoDestructorExprClass: 200 case Stmt::UnresolvedLookupExprClass: 201 case Stmt::UnaryTypeTraitExprClass: 202 case Stmt::DependentScopeDeclRefExprClass: 203 case Stmt::CXXBindTemporaryExprClass: 204 case Stmt::CXXBindReferenceExprClass: 205 case Stmt::CXXExprWithTemporariesClass: 206 case Stmt::CXXUnresolvedConstructExprClass: 207 case Stmt::CXXDependentScopeMemberExprClass: 208 case Stmt::UnresolvedMemberExprClass: 209 case Stmt::ObjCStringLiteralClass: 210 case Stmt::ObjCEncodeExprClass: 211 case Stmt::ObjCSelectorExprClass: 212 case Stmt::ObjCProtocolExprClass: 213 case Stmt::ObjCImplicitSetterGetterRefExprClass: 214 case Stmt::ObjCSuperExprClass: 215 case Stmt::ObjCIsaExprClass: 216 case Stmt::ShuffleVectorExprClass: 217 case Stmt::BlockExprClass: 218 K = CXCursor_UnexposedExpr; 219 break; 220 case Stmt::DeclRefExprClass: 221 case Stmt::BlockDeclRefExprClass: 222 // FIXME: UnresolvedLookupExpr? 223 // FIXME: DependentScopeDeclRefExpr? 224 K = CXCursor_DeclRefExpr; 225 break; 226 227 case Stmt::MemberExprClass: 228 case Stmt::ObjCIvarRefExprClass: 229 case Stmt::ObjCPropertyRefExprClass: 230 // FIXME: UnresolvedMemberExpr? 231 // FIXME: CXXDependentScopeMemberExpr? 232 K = CXCursor_MemberRefExpr; 233 break; 234 235 case Stmt::CallExprClass: 236 case Stmt::CXXOperatorCallExprClass: 237 case Stmt::CXXMemberCallExprClass: 238 case Stmt::CXXConstructExprClass: 239 case Stmt::CXXTemporaryObjectExprClass: 240 // FIXME: CXXUnresolvedConstructExpr 241 // FIXME: ObjCImplicitSetterGetterRefExpr? 242 K = CXCursor_CallExpr; 243 break; 244 245 case Stmt::ObjCMessageExprClass: 246 K = CXCursor_ObjCMessageExpr; 247 break; 248 } 249 250 CXCursor C = { K, { Parent, S, TU } }; 251 return C; 252 } 253 254 CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super, 255 SourceLocation Loc, 256 ASTUnit *TU) { 257 assert(Super && TU && "Invalid arguments!"); 258 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 259 CXCursor C = { CXCursor_ObjCSuperClassRef, { Super, RawLoc, TU } }; 260 return C; 261 } 262 263 std::pair<ObjCInterfaceDecl *, SourceLocation> 264 cxcursor::getCursorObjCSuperClassRef(CXCursor C) { 265 assert(C.kind == CXCursor_ObjCSuperClassRef); 266 return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]), 267 SourceLocation::getFromRawEncoding( 268 reinterpret_cast<uintptr_t>(C.data[1]))); 269 } 270 271 CXCursor cxcursor::MakeCursorObjCProtocolRef(ObjCProtocolDecl *Super, 272 SourceLocation Loc, 273 ASTUnit *TU) { 274 assert(Super && TU && "Invalid arguments!"); 275 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 276 CXCursor C = { CXCursor_ObjCProtocolRef, { Super, RawLoc, TU } }; 277 return C; 278 } 279 280 std::pair<ObjCProtocolDecl *, SourceLocation> 281 cxcursor::getCursorObjCProtocolRef(CXCursor C) { 282 assert(C.kind == CXCursor_ObjCProtocolRef); 283 return std::make_pair(static_cast<ObjCProtocolDecl *>(C.data[0]), 284 SourceLocation::getFromRawEncoding( 285 reinterpret_cast<uintptr_t>(C.data[1]))); 286 } 287 288 CXCursor cxcursor::MakeCursorObjCClassRef(ObjCInterfaceDecl *Class, 289 SourceLocation Loc, 290 ASTUnit *TU) { 291 // 'Class' can be null for invalid code. 292 if (!Class) 293 return MakeCXCursorInvalid(CXCursor_InvalidCode); 294 assert(TU && "Invalid arguments!"); 295 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 296 CXCursor C = { CXCursor_ObjCClassRef, { Class, RawLoc, TU } }; 297 return C; 298 } 299 300 std::pair<ObjCInterfaceDecl *, SourceLocation> 301 cxcursor::getCursorObjCClassRef(CXCursor C) { 302 assert(C.kind == CXCursor_ObjCClassRef); 303 return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]), 304 SourceLocation::getFromRawEncoding( 305 reinterpret_cast<uintptr_t>(C.data[1]))); 306 } 307 308 CXCursor cxcursor::MakeCursorTypeRef(TypeDecl *Type, SourceLocation Loc, 309 ASTUnit *TU) { 310 assert(Type && TU && "Invalid arguments!"); 311 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 312 CXCursor C = { CXCursor_TypeRef, { Type, RawLoc, TU } }; 313 return C; 314 } 315 316 std::pair<TypeDecl *, SourceLocation> 317 cxcursor::getCursorTypeRef(CXCursor C) { 318 assert(C.kind == CXCursor_TypeRef); 319 return std::make_pair(static_cast<TypeDecl *>(C.data[0]), 320 SourceLocation::getFromRawEncoding( 321 reinterpret_cast<uintptr_t>(C.data[1]))); 322 } 323 324 CXCursor cxcursor::MakeCursorTemplateRef(TemplateDecl *Template, 325 SourceLocation Loc, ASTUnit *TU) { 326 assert(Template && TU && "Invalid arguments!"); 327 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 328 CXCursor C = { CXCursor_TemplateRef, { Template, RawLoc, TU } }; 329 return C; 330 } 331 332 std::pair<TemplateDecl *, SourceLocation> 333 cxcursor::getCursorTemplateRef(CXCursor C) { 334 assert(C.kind == CXCursor_TemplateRef); 335 return std::make_pair(static_cast<TemplateDecl *>(C.data[0]), 336 SourceLocation::getFromRawEncoding( 337 reinterpret_cast<uintptr_t>(C.data[1]))); 338 } 339 340 CXCursor cxcursor::MakeCursorNamespaceRef(NamedDecl *NS, SourceLocation Loc, 341 ASTUnit *TU) { 342 343 assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU && 344 "Invalid arguments!"); 345 void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding()); 346 CXCursor C = { CXCursor_NamespaceRef, { NS, RawLoc, TU } }; 347 return C; 348 } 349 350 std::pair<NamedDecl *, SourceLocation> 351 cxcursor::getCursorNamespaceRef(CXCursor C) { 352 assert(C.kind == CXCursor_NamespaceRef); 353 return std::make_pair(static_cast<NamedDecl *>(C.data[0]), 354 SourceLocation::getFromRawEncoding( 355 reinterpret_cast<uintptr_t>(C.data[1]))); 356 } 357 358 CXCursor cxcursor::MakeCursorCXXBaseSpecifier(CXXBaseSpecifier *B, ASTUnit *TU){ 359 CXCursor C = { CXCursor_CXXBaseSpecifier, { B, 0, TU } }; 360 return C; 361 } 362 363 CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) { 364 assert(C.kind == CXCursor_CXXBaseSpecifier); 365 return static_cast<CXXBaseSpecifier*>(C.data[0]); 366 } 367 368 CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range, 369 ASTUnit *TU) { 370 CXCursor C = { CXCursor_PreprocessingDirective, 371 { reinterpret_cast<void *>(Range.getBegin().getRawEncoding()), 372 reinterpret_cast<void *>(Range.getEnd().getRawEncoding()), 373 TU } 374 }; 375 return C; 376 } 377 378 SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) { 379 assert(C.kind == CXCursor_PreprocessingDirective); 380 return SourceRange(SourceLocation::getFromRawEncoding( 381 reinterpret_cast<uintptr_t> (C.data[0])), 382 SourceLocation::getFromRawEncoding( 383 reinterpret_cast<uintptr_t> (C.data[1]))); 384 } 385 386 CXCursor cxcursor::MakeMacroDefinitionCursor(MacroDefinition *MI, ASTUnit *TU) { 387 CXCursor C = { CXCursor_MacroDefinition, { MI, 0, TU } }; 388 return C; 389 } 390 391 MacroDefinition *cxcursor::getCursorMacroDefinition(CXCursor C) { 392 assert(C.kind == CXCursor_MacroDefinition); 393 return static_cast<MacroDefinition *>(C.data[0]); 394 } 395 396 CXCursor cxcursor::MakeMacroInstantiationCursor(MacroInstantiation *MI, 397 ASTUnit *TU) { 398 CXCursor C = { CXCursor_MacroInstantiation, { MI, 0, TU } }; 399 return C; 400 } 401 402 MacroInstantiation *cxcursor::getCursorMacroInstantiation(CXCursor C) { 403 assert(C.kind == CXCursor_MacroInstantiation); 404 return static_cast<MacroInstantiation *>(C.data[0]); 405 } 406 407 Decl *cxcursor::getCursorDecl(CXCursor Cursor) { 408 return (Decl *)Cursor.data[0]; 409 } 410 411 Expr *cxcursor::getCursorExpr(CXCursor Cursor) { 412 return dyn_cast_or_null<Expr>(getCursorStmt(Cursor)); 413 } 414 415 Stmt *cxcursor::getCursorStmt(CXCursor Cursor) { 416 if (Cursor.kind == CXCursor_ObjCSuperClassRef || 417 Cursor.kind == CXCursor_ObjCProtocolRef || 418 Cursor.kind == CXCursor_ObjCClassRef) 419 return 0; 420 421 return (Stmt *)Cursor.data[1]; 422 } 423 424 Attr *cxcursor::getCursorAttr(CXCursor Cursor) { 425 return (Attr *)Cursor.data[1]; 426 } 427 428 ASTContext &cxcursor::getCursorContext(CXCursor Cursor) { 429 return getCursorASTUnit(Cursor)->getASTContext(); 430 } 431 432 ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) { 433 return static_cast<ASTUnit *>(Cursor.data[2]); 434 } 435 436 bool cxcursor::operator==(CXCursor X, CXCursor Y) { 437 return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] && 438 X.data[2] == Y.data[2]; 439 } 440