CXCursor.cpp revision 007a7c9d8dcdb2e9cd94b6075108bfc4c90e6ccd 
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 "clang/AST/ExprCXX.h"
23#include "clang-c/Index.h"
24#include "llvm/Support/ErrorHandling.h"
25
26using namespace clang;
27using namespace cxcursor;
28
29CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K) {
30  assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid);
31  CXCursor C = { K, { 0, 0, 0 } };
32  return C;
33}
34
35static CXCursorKind GetCursorKind(const Attr *A) {
36  assert(A && "Invalid arguments!");
37  switch (A->getKind()) {
38    default: break;
39    case attr::IBAction: return CXCursor_IBActionAttr;
40    case attr::IBOutlet: return CXCursor_IBOutletAttr;
41    case attr::IBOutletCollection: return CXCursor_IBOutletCollectionAttr;
42  }
43
44  return CXCursor_UnexposedAttr;
45}
46
47CXCursor cxcursor::MakeCXCursor(const Attr *A, Decl *Parent, ASTUnit *TU) {
48  assert(A && Parent && TU && "Invalid arguments!");
49  CXCursor C = { GetCursorKind(A), { Parent, (void*)A, TU } };
50  return C;
51}
52
53CXCursor cxcursor::MakeCXCursor(Decl *D, ASTUnit *TU,
54                                bool FirstInDeclGroup) {
55  assert(D && TU && "Invalid arguments!");
56  CXCursor C = { getCursorKindForDecl(D),
57                 { D, (void*) (FirstInDeclGroup ? 1 : 0), TU }
58               };
59  return C;
60}
61
62CXCursor cxcursor::MakeCXCursor(Stmt *S, Decl *Parent, ASTUnit *TU) {
63  assert(S && TU && "Invalid arguments!");
64  CXCursorKind K = CXCursor_NotImplemented;
65
66  switch (S->getStmtClass()) {
67  case Stmt::NoStmtClass:
68    break;
69
70  case Stmt::NullStmtClass:
71  case Stmt::CompoundStmtClass:
72  case Stmt::CaseStmtClass:
73  case Stmt::DefaultStmtClass:
74  case Stmt::IfStmtClass:
75  case Stmt::SwitchStmtClass:
76  case Stmt::WhileStmtClass:
77  case Stmt::DoStmtClass:
78  case Stmt::ForStmtClass:
79  case Stmt::GotoStmtClass:
80  case Stmt::IndirectGotoStmtClass:
81  case Stmt::ContinueStmtClass:
82  case Stmt::BreakStmtClass:
83  case Stmt::ReturnStmtClass:
84  case Stmt::DeclStmtClass:
85  case Stmt::SwitchCaseClass:
86  case Stmt::AsmStmtClass:
87  case Stmt::ObjCAtTryStmtClass:
88  case Stmt::ObjCAtCatchStmtClass:
89  case Stmt::ObjCAtFinallyStmtClass:
90  case Stmt::ObjCAtThrowStmtClass:
91  case Stmt::ObjCAtSynchronizedStmtClass:
92  case Stmt::ObjCForCollectionStmtClass:
93  case Stmt::CXXCatchStmtClass:
94  case Stmt::CXXTryStmtClass:
95    K = CXCursor_UnexposedStmt;
96    break;
97
98  case Stmt::LabelStmtClass:
99    K = CXCursor_LabelStmt;
100    break;
101
102  case Stmt::PredefinedExprClass:
103  case Stmt::IntegerLiteralClass:
104  case Stmt::FloatingLiteralClass:
105  case Stmt::ImaginaryLiteralClass:
106  case Stmt::StringLiteralClass:
107  case Stmt::CharacterLiteralClass:
108  case Stmt::ParenExprClass:
109  case Stmt::UnaryOperatorClass:
110  case Stmt::OffsetOfExprClass:
111  case Stmt::SizeOfAlignOfExprClass:
112  case Stmt::ArraySubscriptExprClass:
113  case Stmt::BinaryOperatorClass:
114  case Stmt::CompoundAssignOperatorClass:
115  case Stmt::ConditionalOperatorClass:
116  case Stmt::ImplicitCastExprClass:
117  case Stmt::CStyleCastExprClass:
118  case Stmt::CompoundLiteralExprClass:
119  case Stmt::ExtVectorElementExprClass:
120  case Stmt::InitListExprClass:
121  case Stmt::DesignatedInitExprClass:
122  case Stmt::ImplicitValueInitExprClass:
123  case Stmt::ParenListExprClass:
124  case Stmt::VAArgExprClass:
125  case Stmt::AddrLabelExprClass:
126  case Stmt::StmtExprClass:
127  case Stmt::TypesCompatibleExprClass:
128  case Stmt::ChooseExprClass:
129  case Stmt::GNUNullExprClass:
130  case Stmt::CXXStaticCastExprClass:
131  case Stmt::CXXDynamicCastExprClass:
132  case Stmt::CXXReinterpretCastExprClass:
133  case Stmt::CXXConstCastExprClass:
134  case Stmt::CXXFunctionalCastExprClass:
135  case Stmt::CXXTypeidExprClass:
136  case Stmt::CXXUuidofExprClass:
137  case Stmt::CXXBoolLiteralExprClass:
138  case Stmt::CXXNullPtrLiteralExprClass:
139  case Stmt::CXXThisExprClass:
140  case Stmt::CXXThrowExprClass:
141  case Stmt::CXXDefaultArgExprClass:
142  case Stmt::CXXScalarValueInitExprClass:
143  case Stmt::CXXNewExprClass:
144  case Stmt::CXXDeleteExprClass:
145  case Stmt::CXXPseudoDestructorExprClass:
146  case Stmt::UnresolvedLookupExprClass:
147  case Stmt::UnaryTypeTraitExprClass:
148  case Stmt::DependentScopeDeclRefExprClass:
149  case Stmt::CXXBindTemporaryExprClass:
150  case Stmt::CXXExprWithTemporariesClass:
151  case Stmt::CXXUnresolvedConstructExprClass:
152  case Stmt::CXXDependentScopeMemberExprClass:
153  case Stmt::UnresolvedMemberExprClass:
154  case Stmt::CXXNoexceptExprClass:
155  case Stmt::ObjCStringLiteralClass:
156  case Stmt::ObjCEncodeExprClass:
157  case Stmt::ObjCSelectorExprClass:
158  case Stmt::ObjCProtocolExprClass:
159  case Stmt::ObjCImplicitSetterGetterRefExprClass:
160  case Stmt::ObjCIsaExprClass:
161  case Stmt::ShuffleVectorExprClass:
162  case Stmt::BlockExprClass:
163    K = CXCursor_UnexposedExpr;
164    break;
165
166  case Stmt::DeclRefExprClass:
167  case Stmt::BlockDeclRefExprClass:
168    // FIXME: UnresolvedLookupExpr?
169    // FIXME: DependentScopeDeclRefExpr?
170    K = CXCursor_DeclRefExpr;
171    break;
172
173  case Stmt::MemberExprClass:
174  case Stmt::ObjCIvarRefExprClass:
175  case Stmt::ObjCPropertyRefExprClass:
176    // FIXME: UnresolvedMemberExpr?
177    // FIXME: CXXDependentScopeMemberExpr?
178    K = CXCursor_MemberRefExpr;
179    break;
180
181  case Stmt::CallExprClass:
182  case Stmt::CXXOperatorCallExprClass:
183  case Stmt::CXXMemberCallExprClass:
184  case Stmt::CXXConstructExprClass:
185  case Stmt::CXXTemporaryObjectExprClass:
186    // FIXME: CXXUnresolvedConstructExpr
187    // FIXME: ObjCImplicitSetterGetterRefExpr?
188    K = CXCursor_CallExpr;
189    break;
190
191  case Stmt::ObjCMessageExprClass:
192    K = CXCursor_ObjCMessageExpr;
193    break;
194  }
195
196  CXCursor C = { K, { Parent, S, TU } };
197  return C;
198}
199
200CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super,
201                                               SourceLocation Loc,
202                                               ASTUnit *TU) {
203  assert(Super && TU && "Invalid arguments!");
204  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
205  CXCursor C = { CXCursor_ObjCSuperClassRef, { Super, RawLoc, TU } };
206  return C;
207}
208
209std::pair<ObjCInterfaceDecl *, SourceLocation>
210cxcursor::getCursorObjCSuperClassRef(CXCursor C) {
211  assert(C.kind == CXCursor_ObjCSuperClassRef);
212  return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]),
213           SourceLocation::getFromRawEncoding(
214                                      reinterpret_cast<uintptr_t>(C.data[1])));
215}
216
217CXCursor cxcursor::MakeCursorObjCProtocolRef(ObjCProtocolDecl *Super,
218                                             SourceLocation Loc,
219                                             ASTUnit *TU) {
220  assert(Super && TU && "Invalid arguments!");
221  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
222  CXCursor C = { CXCursor_ObjCProtocolRef, { Super, RawLoc, TU } };
223  return C;
224}
225
226std::pair<ObjCProtocolDecl *, SourceLocation>
227cxcursor::getCursorObjCProtocolRef(CXCursor C) {
228  assert(C.kind == CXCursor_ObjCProtocolRef);
229  return std::make_pair(static_cast<ObjCProtocolDecl *>(C.data[0]),
230           SourceLocation::getFromRawEncoding(
231                                      reinterpret_cast<uintptr_t>(C.data[1])));
232}
233
234CXCursor cxcursor::MakeCursorObjCClassRef(ObjCInterfaceDecl *Class,
235                                          SourceLocation Loc,
236                                          ASTUnit *TU) {
237  // 'Class' can be null for invalid code.
238  if (!Class)
239    return MakeCXCursorInvalid(CXCursor_InvalidCode);
240  assert(TU && "Invalid arguments!");
241  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
242  CXCursor C = { CXCursor_ObjCClassRef, { Class, RawLoc, TU } };
243  return C;
244}
245
246std::pair<ObjCInterfaceDecl *, SourceLocation>
247cxcursor::getCursorObjCClassRef(CXCursor C) {
248  assert(C.kind == CXCursor_ObjCClassRef);
249  return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]),
250           SourceLocation::getFromRawEncoding(
251                                      reinterpret_cast<uintptr_t>(C.data[1])));
252}
253
254CXCursor cxcursor::MakeCursorTypeRef(TypeDecl *Type, SourceLocation Loc,
255                                     ASTUnit *TU) {
256  assert(Type && TU && "Invalid arguments!");
257  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
258  CXCursor C = { CXCursor_TypeRef, { Type, RawLoc, TU } };
259  return C;
260}
261
262std::pair<TypeDecl *, SourceLocation>
263cxcursor::getCursorTypeRef(CXCursor C) {
264  assert(C.kind == CXCursor_TypeRef);
265  return std::make_pair(static_cast<TypeDecl *>(C.data[0]),
266           SourceLocation::getFromRawEncoding(
267                                      reinterpret_cast<uintptr_t>(C.data[1])));
268}
269
270CXCursor cxcursor::MakeCursorTemplateRef(TemplateDecl *Template,
271                                         SourceLocation Loc, ASTUnit *TU) {
272  assert(Template && TU && "Invalid arguments!");
273  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
274  CXCursor C = { CXCursor_TemplateRef, { Template, RawLoc, TU } };
275  return C;
276}
277
278std::pair<TemplateDecl *, SourceLocation>
279cxcursor::getCursorTemplateRef(CXCursor C) {
280  assert(C.kind == CXCursor_TemplateRef);
281  return std::make_pair(static_cast<TemplateDecl *>(C.data[0]),
282                        SourceLocation::getFromRawEncoding(
283                                       reinterpret_cast<uintptr_t>(C.data[1])));
284}
285
286CXCursor cxcursor::MakeCursorNamespaceRef(NamedDecl *NS, SourceLocation Loc,
287                                          ASTUnit *TU) {
288
289  assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU &&
290         "Invalid arguments!");
291  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
292  CXCursor C = { CXCursor_NamespaceRef, { NS, RawLoc, TU } };
293  return C;
294}
295
296std::pair<NamedDecl *, SourceLocation>
297cxcursor::getCursorNamespaceRef(CXCursor C) {
298  assert(C.kind == CXCursor_NamespaceRef);
299  return std::make_pair(static_cast<NamedDecl *>(C.data[0]),
300                        SourceLocation::getFromRawEncoding(
301                                       reinterpret_cast<uintptr_t>(C.data[1])));
302}
303
304CXCursor cxcursor::MakeCursorMemberRef(FieldDecl *Field, SourceLocation Loc,
305                                       ASTUnit *TU) {
306
307  assert(Field && TU && "Invalid arguments!");
308  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
309  CXCursor C = { CXCursor_MemberRef, { Field, RawLoc, TU } };
310  return C;
311}
312
313std::pair<FieldDecl *, SourceLocation>
314cxcursor::getCursorMemberRef(CXCursor C) {
315  assert(C.kind == CXCursor_MemberRef);
316  return std::make_pair(static_cast<FieldDecl *>(C.data[0]),
317                        SourceLocation::getFromRawEncoding(
318                                       reinterpret_cast<uintptr_t>(C.data[1])));
319}
320
321CXCursor cxcursor::MakeCursorCXXBaseSpecifier(CXXBaseSpecifier *B, ASTUnit *TU){
322  CXCursor C = { CXCursor_CXXBaseSpecifier, { B, 0, TU } };
323  return C;
324}
325
326CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) {
327  assert(C.kind == CXCursor_CXXBaseSpecifier);
328  return static_cast<CXXBaseSpecifier*>(C.data[0]);
329}
330
331CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range,
332                                                    ASTUnit *TU) {
333  CXCursor C = { CXCursor_PreprocessingDirective,
334                 { reinterpret_cast<void *>(Range.getBegin().getRawEncoding()),
335                   reinterpret_cast<void *>(Range.getEnd().getRawEncoding()),
336                   TU }
337               };
338  return C;
339}
340
341SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) {
342  assert(C.kind == CXCursor_PreprocessingDirective);
343  return SourceRange(SourceLocation::getFromRawEncoding(
344                                      reinterpret_cast<uintptr_t> (C.data[0])),
345                     SourceLocation::getFromRawEncoding(
346                                      reinterpret_cast<uintptr_t> (C.data[1])));
347}
348
349CXCursor cxcursor::MakeMacroDefinitionCursor(MacroDefinition *MI, ASTUnit *TU) {
350  CXCursor C = { CXCursor_MacroDefinition, { MI, 0, TU } };
351  return C;
352}
353
354MacroDefinition *cxcursor::getCursorMacroDefinition(CXCursor C) {
355  assert(C.kind == CXCursor_MacroDefinition);
356  return static_cast<MacroDefinition *>(C.data[0]);
357}
358
359CXCursor cxcursor::MakeMacroInstantiationCursor(MacroInstantiation *MI,
360                                                ASTUnit *TU) {
361  CXCursor C = { CXCursor_MacroInstantiation, { MI, 0, TU } };
362  return C;
363}
364
365MacroInstantiation *cxcursor::getCursorMacroInstantiation(CXCursor C) {
366  assert(C.kind == CXCursor_MacroInstantiation);
367  return static_cast<MacroInstantiation *>(C.data[0]);
368}
369
370CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID,
371                                                ASTUnit *TU) {
372  CXCursor C = { CXCursor_InclusionDirective, { ID, 0, TU } };
373  return C;
374}
375
376InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) {
377  assert(C.kind == CXCursor_InclusionDirective);
378  return static_cast<InclusionDirective *>(C.data[0]);
379}
380
381CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc,
382                                      ASTUnit *TU) {
383
384  assert(Label && TU && "Invalid arguments!");
385  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
386  CXCursor C = { CXCursor_LabelRef, { Label, RawLoc, TU } };
387  return C;
388}
389
390std::pair<LabelStmt*, SourceLocation>
391cxcursor::getCursorLabelRef(CXCursor C) {
392  assert(C.kind == CXCursor_LabelRef);
393  return std::make_pair(static_cast<LabelStmt *>(C.data[0]),
394                        SourceLocation::getFromRawEncoding(
395                                       reinterpret_cast<uintptr_t>(C.data[1])));
396}
397
398CXCursor cxcursor::MakeCursorOverloadedDeclRef(OverloadExpr *E,
399                                               ASTUnit *TU) {
400  assert(E && TU && "Invalid arguments!");
401  OverloadedDeclRefStorage Storage(E);
402  void *RawLoc = reinterpret_cast<void *>(E->getNameLoc().getRawEncoding());
403  CXCursor C = {
404                 CXCursor_OverloadedDeclRef,
405                 { Storage.getOpaqueValue(), RawLoc, TU }
406               };
407  return C;
408}
409
410CXCursor cxcursor::MakeCursorOverloadedDeclRef(Decl *D,
411                                               SourceLocation Loc,
412                                               ASTUnit *TU) {
413  assert(D && TU && "Invalid arguments!");
414  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
415  OverloadedDeclRefStorage Storage(D);
416  CXCursor C = {
417    CXCursor_OverloadedDeclRef,
418    { Storage.getOpaqueValue(), RawLoc, TU }
419  };
420  return C;
421}
422
423CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name,
424                                               SourceLocation Loc,
425                                               ASTUnit *TU) {
426  assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!");
427  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
428  OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate());
429  CXCursor C = {
430    CXCursor_OverloadedDeclRef,
431    { Storage.getOpaqueValue(), RawLoc, TU }
432  };
433  return C;
434}
435
436std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation>
437cxcursor::getCursorOverloadedDeclRef(CXCursor C) {
438  assert(C.kind == CXCursor_OverloadedDeclRef);
439  return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue(C.data[0]),
440                        SourceLocation::getFromRawEncoding(
441                                       reinterpret_cast<uintptr_t>(C.data[1])));
442}
443
444Decl *cxcursor::getCursorDecl(CXCursor Cursor) {
445  return (Decl *)Cursor.data[0];
446}
447
448Expr *cxcursor::getCursorExpr(CXCursor Cursor) {
449  return dyn_cast_or_null<Expr>(getCursorStmt(Cursor));
450}
451
452Stmt *cxcursor::getCursorStmt(CXCursor Cursor) {
453  if (Cursor.kind == CXCursor_ObjCSuperClassRef ||
454      Cursor.kind == CXCursor_ObjCProtocolRef ||
455      Cursor.kind == CXCursor_ObjCClassRef)
456    return 0;
457
458  return (Stmt *)Cursor.data[1];
459}
460
461Attr *cxcursor::getCursorAttr(CXCursor Cursor) {
462  return (Attr *)Cursor.data[1];
463}
464
465ASTContext &cxcursor::getCursorContext(CXCursor Cursor) {
466  return getCursorASTUnit(Cursor)->getASTContext();
467}
468
469ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) {
470  return static_cast<ASTUnit *>(Cursor.data[2]);
471}
472
473bool cxcursor::operator==(CXCursor X, CXCursor Y) {
474  return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] &&
475         X.data[2] == Y.data[2];
476}
477
478// FIXME: Remove once we can model DeclGroups and their appropriate ranges
479// properly in the ASTs.
480bool cxcursor::isFirstInDeclGroup(CXCursor C) {
481  assert(clang_isDeclaration(C.kind));
482  return ((uintptr_t) (C.data[1])) != 0;
483}
484
485