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