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