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