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