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