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