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