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