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