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