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