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