CXCursor.cpp revision 664b06f9bd2ea83443ddc8553feba8ba48880752 
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 "CXTranslationUnit.h"
17#include "CXCursor.h"
18#include "CXString.h"
19#include "CXType.h"
20#include "clang-c/Index.h"
21#include "clang/AST/Decl.h"
22#include "clang/AST/DeclCXX.h"
23#include "clang/AST/DeclObjC.h"
24#include "clang/AST/DeclTemplate.h"
25#include "clang/AST/Expr.h"
26#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
28#include "clang/Frontend/ASTUnit.h"
29#include "llvm/Support/ErrorHandling.h"
30
31using namespace clang;
32using namespace cxcursor;
33
34CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K, CXTranslationUnit TU) {
35  assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid);
36  CXCursor C = { K, 0, { 0, 0, TU } };
37  return C;
38}
39
40static CXCursorKind GetCursorKind(const Attr *A) {
41  assert(A && "Invalid arguments!");
42  switch (A->getKind()) {
43    default: break;
44    case attr::IBAction: return CXCursor_IBActionAttr;
45    case attr::IBOutlet: return CXCursor_IBOutletAttr;
46    case attr::IBOutletCollection: return CXCursor_IBOutletCollectionAttr;
47    case attr::Final: return CXCursor_CXXFinalAttr;
48    case attr::Override: return CXCursor_CXXOverrideAttr;
49    case attr::Annotate: return CXCursor_AnnotateAttr;
50    case attr::AsmLabel: return CXCursor_AsmLabelAttr;
51  }
52
53  return CXCursor_UnexposedAttr;
54}
55
56CXCursor cxcursor::MakeCXCursor(const Attr *A, Decl *Parent,
57                                CXTranslationUnit TU) {
58  assert(A && Parent && TU && "Invalid arguments!");
59  CXCursor C = { GetCursorKind(A), 0, { Parent, (void*)A, TU } };
60  return C;
61}
62
63CXCursor cxcursor::MakeCXCursor(Decl *D, CXTranslationUnit TU,
64                                SourceRange RegionOfInterest,
65                                bool FirstInDeclGroup) {
66  assert(D && TU && "Invalid arguments!");
67
68  CXCursorKind K = getCursorKindForDecl(D);
69
70  if (K == CXCursor_ObjCClassMethodDecl ||
71      K == CXCursor_ObjCInstanceMethodDecl) {
72    int SelectorIdIndex = -1;
73    // Check if cursor points to a selector id.
74    if (RegionOfInterest.isValid() &&
75        RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) {
76      SmallVector<SourceLocation, 16> SelLocs;
77      cast<ObjCMethodDecl>(D)->getSelectorLocs(SelLocs);
78      SmallVector<SourceLocation, 16>::iterator
79        I=std::find(SelLocs.begin(), SelLocs.end(),RegionOfInterest.getBegin());
80      if (I != SelLocs.end())
81        SelectorIdIndex = I - SelLocs.begin();
82    }
83    CXCursor C = { K, SelectorIdIndex,
84                   { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }};
85    return C;
86  }
87
88  CXCursor C = { K, 0, { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }};
89  return C;
90}
91
92CXCursor cxcursor::MakeCXCursor(Stmt *S, Decl *Parent, CXTranslationUnit TU,
93                                SourceRange RegionOfInterest) {
94  assert(S && TU && "Invalid arguments!");
95  CXCursorKind K = CXCursor_NotImplemented;
96
97  switch (S->getStmtClass()) {
98  case Stmt::NoStmtClass:
99    break;
100
101  case Stmt::CaseStmtClass:
102    K = CXCursor_CaseStmt;
103    break;
104
105  case Stmt::DefaultStmtClass:
106    K = CXCursor_DefaultStmt;
107    break;
108
109  case Stmt::IfStmtClass:
110    K = CXCursor_IfStmt;
111    break;
112
113  case Stmt::SwitchStmtClass:
114    K = CXCursor_SwitchStmt;
115    break;
116
117  case Stmt::WhileStmtClass:
118    K = CXCursor_WhileStmt;
119    break;
120
121  case Stmt::DoStmtClass:
122    K = CXCursor_DoStmt;
123    break;
124
125  case Stmt::ForStmtClass:
126    K = CXCursor_ForStmt;
127    break;
128
129  case Stmt::GotoStmtClass:
130    K = CXCursor_GotoStmt;
131    break;
132
133  case Stmt::IndirectGotoStmtClass:
134    K = CXCursor_IndirectGotoStmt;
135    break;
136
137  case Stmt::ContinueStmtClass:
138    K = CXCursor_ContinueStmt;
139    break;
140
141  case Stmt::BreakStmtClass:
142    K = CXCursor_BreakStmt;
143    break;
144
145  case Stmt::ReturnStmtClass:
146    K = CXCursor_ReturnStmt;
147    break;
148
149  case Stmt::GCCAsmStmtClass:
150    K = CXCursor_GCCAsmStmt;
151    break;
152
153  case Stmt::MSAsmStmtClass:
154    K = CXCursor_MSAsmStmt;
155    break;
156
157  case Stmt::ObjCAtTryStmtClass:
158    K = CXCursor_ObjCAtTryStmt;
159    break;
160
161  case Stmt::ObjCAtCatchStmtClass:
162    K = CXCursor_ObjCAtCatchStmt;
163    break;
164
165  case Stmt::ObjCAtFinallyStmtClass:
166    K = CXCursor_ObjCAtFinallyStmt;
167    break;
168
169  case Stmt::ObjCAtThrowStmtClass:
170    K = CXCursor_ObjCAtThrowStmt;
171    break;
172
173  case Stmt::ObjCAtSynchronizedStmtClass:
174    K = CXCursor_ObjCAtSynchronizedStmt;
175    break;
176
177  case Stmt::ObjCAutoreleasePoolStmtClass:
178    K = CXCursor_ObjCAutoreleasePoolStmt;
179    break;
180
181  case Stmt::ObjCForCollectionStmtClass:
182    K = CXCursor_ObjCForCollectionStmt;
183    break;
184
185  case Stmt::CXXCatchStmtClass:
186    K = CXCursor_CXXCatchStmt;
187    break;
188
189  case Stmt::CXXTryStmtClass:
190    K = CXCursor_CXXTryStmt;
191    break;
192
193  case Stmt::CXXForRangeStmtClass:
194    K = CXCursor_CXXForRangeStmt;
195    break;
196
197  case Stmt::SEHTryStmtClass:
198    K = CXCursor_SEHTryStmt;
199    break;
200
201  case Stmt::SEHExceptStmtClass:
202    K = CXCursor_SEHExceptStmt;
203    break;
204
205  case Stmt::SEHFinallyStmtClass:
206    K = CXCursor_SEHFinallyStmt;
207    break;
208
209  case Stmt::ArrayTypeTraitExprClass:
210  case Stmt::AsTypeExprClass:
211  case Stmt::AtomicExprClass:
212  case Stmt::BinaryConditionalOperatorClass:
213  case Stmt::BinaryTypeTraitExprClass:
214  case Stmt::TypeTraitExprClass:
215  case Stmt::CXXBindTemporaryExprClass:
216  case Stmt::CXXDefaultArgExprClass:
217  case Stmt::CXXScalarValueInitExprClass:
218  case Stmt::CXXUuidofExprClass:
219  case Stmt::ChooseExprClass:
220  case Stmt::DesignatedInitExprClass:
221  case Stmt::ExprWithCleanupsClass:
222  case Stmt::ExpressionTraitExprClass:
223  case Stmt::ExtVectorElementExprClass:
224  case Stmt::ImplicitCastExprClass:
225  case Stmt::ImplicitValueInitExprClass:
226  case Stmt::MaterializeTemporaryExprClass:
227  case Stmt::ObjCIndirectCopyRestoreExprClass:
228  case Stmt::OffsetOfExprClass:
229  case Stmt::ParenListExprClass:
230  case Stmt::PredefinedExprClass:
231  case Stmt::ShuffleVectorExprClass:
232  case Stmt::UnaryExprOrTypeTraitExprClass:
233  case Stmt::UnaryTypeTraitExprClass:
234  case Stmt::VAArgExprClass:
235  case Stmt::ObjCArrayLiteralClass:
236  case Stmt::ObjCDictionaryLiteralClass:
237  case Stmt::ObjCBoxedExprClass:
238  case Stmt::ObjCSubscriptRefExprClass:
239    K = CXCursor_UnexposedExpr;
240    break;
241
242  case Stmt::OpaqueValueExprClass:
243    if (Expr *Src = cast<OpaqueValueExpr>(S)->getSourceExpr())
244      return MakeCXCursor(Src, Parent, TU, RegionOfInterest);
245    K = CXCursor_UnexposedExpr;
246    break;
247
248  case Stmt::PseudoObjectExprClass:
249    return MakeCXCursor(cast<PseudoObjectExpr>(S)->getSyntacticForm(),
250                        Parent, TU, RegionOfInterest);
251
252  case Stmt::CompoundStmtClass:
253    K = CXCursor_CompoundStmt;
254    break;
255
256  case Stmt::NullStmtClass:
257    K = CXCursor_NullStmt;
258    break;
259
260  case Stmt::LabelStmtClass:
261    K = CXCursor_LabelStmt;
262    break;
263
264  case Stmt::AttributedStmtClass:
265    K = CXCursor_UnexposedStmt;
266    break;
267
268  case Stmt::DeclStmtClass:
269    K = CXCursor_DeclStmt;
270    break;
271
272  case Stmt::IntegerLiteralClass:
273    K = CXCursor_IntegerLiteral;
274    break;
275
276  case Stmt::FloatingLiteralClass:
277    K = CXCursor_FloatingLiteral;
278    break;
279
280  case Stmt::ImaginaryLiteralClass:
281    K = CXCursor_ImaginaryLiteral;
282    break;
283
284  case Stmt::StringLiteralClass:
285    K = CXCursor_StringLiteral;
286    break;
287
288  case Stmt::CharacterLiteralClass:
289    K = CXCursor_CharacterLiteral;
290    break;
291
292  case Stmt::ParenExprClass:
293    K = CXCursor_ParenExpr;
294    break;
295
296  case Stmt::UnaryOperatorClass:
297    K = CXCursor_UnaryOperator;
298    break;
299
300  case Stmt::CXXNoexceptExprClass:
301    K = CXCursor_UnaryExpr;
302    break;
303
304  case Stmt::ArraySubscriptExprClass:
305    K = CXCursor_ArraySubscriptExpr;
306    break;
307
308  case Stmt::BinaryOperatorClass:
309    K = CXCursor_BinaryOperator;
310    break;
311
312  case Stmt::CompoundAssignOperatorClass:
313    K = CXCursor_CompoundAssignOperator;
314    break;
315
316  case Stmt::ConditionalOperatorClass:
317    K = CXCursor_ConditionalOperator;
318    break;
319
320  case Stmt::CStyleCastExprClass:
321    K = CXCursor_CStyleCastExpr;
322    break;
323
324  case Stmt::CompoundLiteralExprClass:
325    K = CXCursor_CompoundLiteralExpr;
326    break;
327
328  case Stmt::InitListExprClass:
329    K = CXCursor_InitListExpr;
330    break;
331
332  case Stmt::AddrLabelExprClass:
333    K = CXCursor_AddrLabelExpr;
334    break;
335
336  case Stmt::StmtExprClass:
337    K = CXCursor_StmtExpr;
338    break;
339
340  case Stmt::GenericSelectionExprClass:
341    K = CXCursor_GenericSelectionExpr;
342    break;
343
344  case Stmt::GNUNullExprClass:
345    K = CXCursor_GNUNullExpr;
346    break;
347
348  case Stmt::CXXStaticCastExprClass:
349    K = CXCursor_CXXStaticCastExpr;
350    break;
351
352  case Stmt::CXXDynamicCastExprClass:
353    K = CXCursor_CXXDynamicCastExpr;
354    break;
355
356  case Stmt::CXXReinterpretCastExprClass:
357    K = CXCursor_CXXReinterpretCastExpr;
358    break;
359
360  case Stmt::CXXConstCastExprClass:
361    K = CXCursor_CXXConstCastExpr;
362    break;
363
364  case Stmt::CXXFunctionalCastExprClass:
365    K = CXCursor_CXXFunctionalCastExpr;
366    break;
367
368  case Stmt::CXXTypeidExprClass:
369    K = CXCursor_CXXTypeidExpr;
370    break;
371
372  case Stmt::CXXBoolLiteralExprClass:
373    K = CXCursor_CXXBoolLiteralExpr;
374    break;
375
376  case Stmt::CXXNullPtrLiteralExprClass:
377    K = CXCursor_CXXNullPtrLiteralExpr;
378    break;
379
380  case Stmt::CXXThisExprClass:
381    K = CXCursor_CXXThisExpr;
382    break;
383
384  case Stmt::CXXThrowExprClass:
385    K = CXCursor_CXXThrowExpr;
386    break;
387
388  case Stmt::CXXNewExprClass:
389    K = CXCursor_CXXNewExpr;
390    break;
391
392  case Stmt::CXXDeleteExprClass:
393    K = CXCursor_CXXDeleteExpr;
394    break;
395
396  case Stmt::ObjCStringLiteralClass:
397    K = CXCursor_ObjCStringLiteral;
398    break;
399
400  case Stmt::ObjCEncodeExprClass:
401    K = CXCursor_ObjCEncodeExpr;
402    break;
403
404  case Stmt::ObjCSelectorExprClass:
405    K = CXCursor_ObjCSelectorExpr;
406    break;
407
408  case Stmt::ObjCProtocolExprClass:
409    K = CXCursor_ObjCProtocolExpr;
410    break;
411
412  case Stmt::ObjCBoolLiteralExprClass:
413    K = CXCursor_ObjCBoolLiteralExpr;
414    break;
415
416  case Stmt::ObjCBridgedCastExprClass:
417    K = CXCursor_ObjCBridgedCastExpr;
418    break;
419
420  case Stmt::BlockExprClass:
421    K = CXCursor_BlockExpr;
422    break;
423
424  case Stmt::PackExpansionExprClass:
425    K = CXCursor_PackExpansionExpr;
426    break;
427
428  case Stmt::SizeOfPackExprClass:
429    K = CXCursor_SizeOfPackExpr;
430    break;
431
432  case Stmt::DeclRefExprClass:
433  case Stmt::DependentScopeDeclRefExprClass:
434  case Stmt::SubstNonTypeTemplateParmExprClass:
435  case Stmt::SubstNonTypeTemplateParmPackExprClass:
436  case Stmt::FunctionParmPackExprClass:
437  case Stmt::UnresolvedLookupExprClass:
438    K = CXCursor_DeclRefExpr;
439    break;
440
441  case Stmt::CXXDependentScopeMemberExprClass:
442  case Stmt::CXXPseudoDestructorExprClass:
443  case Stmt::MemberExprClass:
444  case Stmt::ObjCIsaExprClass:
445  case Stmt::ObjCIvarRefExprClass:
446  case Stmt::ObjCPropertyRefExprClass:
447  case Stmt::UnresolvedMemberExprClass:
448    K = CXCursor_MemberRefExpr;
449    break;
450
451  case Stmt::CallExprClass:
452  case Stmt::CXXOperatorCallExprClass:
453  case Stmt::CXXMemberCallExprClass:
454  case Stmt::CUDAKernelCallExprClass:
455  case Stmt::CXXConstructExprClass:
456  case Stmt::CXXTemporaryObjectExprClass:
457  case Stmt::CXXUnresolvedConstructExprClass:
458  case Stmt::UserDefinedLiteralClass:
459    K = CXCursor_CallExpr;
460    break;
461
462  case Stmt::LambdaExprClass:
463    K = CXCursor_LambdaExpr;
464    break;
465
466  case Stmt::ObjCMessageExprClass: {
467    K = CXCursor_ObjCMessageExpr;
468    int SelectorIdIndex = -1;
469    // Check if cursor points to a selector id.
470    if (RegionOfInterest.isValid() &&
471        RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) {
472      SmallVector<SourceLocation, 16> SelLocs;
473      cast<ObjCMessageExpr>(S)->getSelectorLocs(SelLocs);
474      SmallVector<SourceLocation, 16>::iterator
475        I=std::find(SelLocs.begin(), SelLocs.end(),RegionOfInterest.getBegin());
476      if (I != SelLocs.end())
477        SelectorIdIndex = I - SelLocs.begin();
478    }
479    CXCursor C = { K, 0, { Parent, S, TU } };
480    return getSelectorIdentifierCursor(SelectorIdIndex, C);
481  }
482
483  case Stmt::MSDependentExistsStmtClass:
484    K = CXCursor_UnexposedStmt;
485    break;
486  }
487
488  CXCursor C = { K, 0, { Parent, S, TU } };
489  return C;
490}
491
492CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super,
493                                               SourceLocation Loc,
494                                               CXTranslationUnit TU) {
495  assert(Super && TU && "Invalid arguments!");
496  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
497  CXCursor C = { CXCursor_ObjCSuperClassRef, 0, { Super, RawLoc, TU } };
498  return C;
499}
500
501std::pair<ObjCInterfaceDecl *, SourceLocation>
502cxcursor::getCursorObjCSuperClassRef(CXCursor C) {
503  assert(C.kind == CXCursor_ObjCSuperClassRef);
504  return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]),
505           SourceLocation::getFromRawEncoding(
506                                      reinterpret_cast<uintptr_t>(C.data[1])));
507}
508
509CXCursor cxcursor::MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto,
510                                             SourceLocation Loc,
511                                             CXTranslationUnit TU) {
512  assert(Proto && TU && "Invalid arguments!");
513  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
514  CXCursor C = { CXCursor_ObjCProtocolRef, 0, { (void*)Proto, RawLoc, TU } };
515  return C;
516}
517
518std::pair<ObjCProtocolDecl *, SourceLocation>
519cxcursor::getCursorObjCProtocolRef(CXCursor C) {
520  assert(C.kind == CXCursor_ObjCProtocolRef);
521  return std::make_pair(static_cast<ObjCProtocolDecl *>(C.data[0]),
522           SourceLocation::getFromRawEncoding(
523                                      reinterpret_cast<uintptr_t>(C.data[1])));
524}
525
526CXCursor cxcursor::MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class,
527                                          SourceLocation Loc,
528                                          CXTranslationUnit TU) {
529  // 'Class' can be null for invalid code.
530  if (!Class)
531    return MakeCXCursorInvalid(CXCursor_InvalidCode);
532  assert(TU && "Invalid arguments!");
533  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
534  CXCursor C = { CXCursor_ObjCClassRef, 0, { (void*)Class, RawLoc, TU } };
535  return C;
536}
537
538std::pair<ObjCInterfaceDecl *, SourceLocation>
539cxcursor::getCursorObjCClassRef(CXCursor C) {
540  assert(C.kind == CXCursor_ObjCClassRef);
541  return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]),
542           SourceLocation::getFromRawEncoding(
543                                      reinterpret_cast<uintptr_t>(C.data[1])));
544}
545
546CXCursor cxcursor::MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc,
547                                     CXTranslationUnit TU) {
548  assert(Type && TU && "Invalid arguments!");
549  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
550  CXCursor C = { CXCursor_TypeRef, 0, { (void*)Type, RawLoc, TU } };
551  return C;
552}
553
554std::pair<TypeDecl *, SourceLocation>
555cxcursor::getCursorTypeRef(CXCursor C) {
556  assert(C.kind == CXCursor_TypeRef);
557  return std::make_pair(static_cast<TypeDecl *>(C.data[0]),
558           SourceLocation::getFromRawEncoding(
559                                      reinterpret_cast<uintptr_t>(C.data[1])));
560}
561
562CXCursor cxcursor::MakeCursorTemplateRef(const TemplateDecl *Template,
563                                         SourceLocation Loc,
564                                         CXTranslationUnit TU) {
565  assert(Template && TU && "Invalid arguments!");
566  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
567  CXCursor C = { CXCursor_TemplateRef, 0, { (void*)Template, RawLoc, TU } };
568  return C;
569}
570
571std::pair<TemplateDecl *, SourceLocation>
572cxcursor::getCursorTemplateRef(CXCursor C) {
573  assert(C.kind == CXCursor_TemplateRef);
574  return std::make_pair(static_cast<TemplateDecl *>(C.data[0]),
575                        SourceLocation::getFromRawEncoding(
576                                       reinterpret_cast<uintptr_t>(C.data[1])));
577}
578
579CXCursor cxcursor::MakeCursorNamespaceRef(const NamedDecl *NS,
580                                          SourceLocation Loc,
581                                          CXTranslationUnit TU) {
582
583  assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU &&
584         "Invalid arguments!");
585  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
586  CXCursor C = { CXCursor_NamespaceRef, 0, { (void*)NS, RawLoc, TU } };
587  return C;
588}
589
590std::pair<NamedDecl *, SourceLocation>
591cxcursor::getCursorNamespaceRef(CXCursor C) {
592  assert(C.kind == CXCursor_NamespaceRef);
593  return std::make_pair(static_cast<NamedDecl *>(C.data[0]),
594                        SourceLocation::getFromRawEncoding(
595                                       reinterpret_cast<uintptr_t>(C.data[1])));
596}
597
598CXCursor cxcursor::MakeCursorVariableRef(const VarDecl *Var, SourceLocation Loc,
599                                         CXTranslationUnit TU) {
600
601  assert(Var && TU && "Invalid arguments!");
602  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
603  CXCursor C = { CXCursor_VariableRef, 0, { (void*)Var, RawLoc, TU } };
604  return C;
605}
606
607std::pair<VarDecl *, SourceLocation>
608cxcursor::getCursorVariableRef(CXCursor C) {
609  assert(C.kind == CXCursor_VariableRef);
610  return std::make_pair(static_cast<VarDecl *>(C.data[0]),
611                        SourceLocation::getFromRawEncoding(
612                          reinterpret_cast<uintptr_t>(C.data[1])));
613}
614
615CXCursor cxcursor::MakeCursorMemberRef(const FieldDecl *Field, SourceLocation Loc,
616                                       CXTranslationUnit TU) {
617
618  assert(Field && TU && "Invalid arguments!");
619  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
620  CXCursor C = { CXCursor_MemberRef, 0, { (void*)Field, RawLoc, TU } };
621  return C;
622}
623
624std::pair<FieldDecl *, SourceLocation>
625cxcursor::getCursorMemberRef(CXCursor C) {
626  assert(C.kind == CXCursor_MemberRef);
627  return std::make_pair(static_cast<FieldDecl *>(C.data[0]),
628                        SourceLocation::getFromRawEncoding(
629                                       reinterpret_cast<uintptr_t>(C.data[1])));
630}
631
632CXCursor cxcursor::MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B,
633                                              CXTranslationUnit TU){
634  CXCursor C = { CXCursor_CXXBaseSpecifier, 0, { (void*)B, 0, TU } };
635  return C;
636}
637
638CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) {
639  assert(C.kind == CXCursor_CXXBaseSpecifier);
640  return static_cast<CXXBaseSpecifier*>(C.data[0]);
641}
642
643CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range,
644                                                    CXTranslationUnit TU) {
645  CXCursor C = { CXCursor_PreprocessingDirective, 0,
646                 { reinterpret_cast<void *>(Range.getBegin().getRawEncoding()),
647                   reinterpret_cast<void *>(Range.getEnd().getRawEncoding()),
648                   TU }
649               };
650  return C;
651}
652
653SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) {
654  assert(C.kind == CXCursor_PreprocessingDirective);
655  SourceRange Range = SourceRange(SourceLocation::getFromRawEncoding(
656                                      reinterpret_cast<uintptr_t> (C.data[0])),
657                     SourceLocation::getFromRawEncoding(
658                                      reinterpret_cast<uintptr_t> (C.data[1])));
659  ASTUnit *TU = getCursorASTUnit(C);
660  return TU->mapRangeFromPreamble(Range);
661}
662
663CXCursor cxcursor::MakeMacroDefinitionCursor(MacroDefinition *MI,
664                                             CXTranslationUnit TU) {
665  CXCursor C = { CXCursor_MacroDefinition, 0, { MI, 0, TU } };
666  return C;
667}
668
669MacroDefinition *cxcursor::getCursorMacroDefinition(CXCursor C) {
670  assert(C.kind == CXCursor_MacroDefinition);
671  return static_cast<MacroDefinition *>(C.data[0]);
672}
673
674CXCursor cxcursor::MakeMacroExpansionCursor(MacroExpansion *MI,
675                                            CXTranslationUnit TU) {
676  CXCursor C = { CXCursor_MacroExpansion, 0, { MI, 0, TU } };
677  return C;
678}
679
680CXCursor cxcursor::MakeMacroExpansionCursor(MacroDefinition *MI,
681                                            SourceLocation Loc,
682                                            CXTranslationUnit TU) {
683  assert(Loc.isValid());
684  CXCursor C = { CXCursor_MacroExpansion, 0, { MI, Loc.getPtrEncoding(), TU } };
685  return C;
686}
687
688const IdentifierInfo *cxcursor::MacroExpansionCursor::getName() const {
689  if (isPseudo())
690    return getAsMacroDefinition()->getName();
691  return getAsMacroExpansion()->getName();
692}
693MacroDefinition *cxcursor::MacroExpansionCursor::getDefinition() const {
694  if (isPseudo())
695    return getAsMacroDefinition();
696  return getAsMacroExpansion()->getDefinition();
697}
698SourceRange cxcursor::MacroExpansionCursor::getSourceRange() const {
699  if (isPseudo())
700    return getPseudoLoc();
701  return getAsMacroExpansion()->getSourceRange();
702}
703
704CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID,
705                                                CXTranslationUnit TU) {
706  CXCursor C = { CXCursor_InclusionDirective, 0, { ID, 0, TU } };
707  return C;
708}
709
710InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) {
711  assert(C.kind == CXCursor_InclusionDirective);
712  return static_cast<InclusionDirective *>(C.data[0]);
713}
714
715CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc,
716                                      CXTranslationUnit TU) {
717
718  assert(Label && TU && "Invalid arguments!");
719  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
720  CXCursor C = { CXCursor_LabelRef, 0, { Label, RawLoc, TU } };
721  return C;
722}
723
724std::pair<LabelStmt*, SourceLocation>
725cxcursor::getCursorLabelRef(CXCursor C) {
726  assert(C.kind == CXCursor_LabelRef);
727  return std::make_pair(static_cast<LabelStmt *>(C.data[0]),
728                        SourceLocation::getFromRawEncoding(
729                                       reinterpret_cast<uintptr_t>(C.data[1])));
730}
731
732CXCursor cxcursor::MakeCursorOverloadedDeclRef(OverloadExpr *E,
733                                               CXTranslationUnit TU) {
734  assert(E && TU && "Invalid arguments!");
735  OverloadedDeclRefStorage Storage(E);
736  void *RawLoc = reinterpret_cast<void *>(E->getNameLoc().getRawEncoding());
737  CXCursor C = {
738                 CXCursor_OverloadedDeclRef, 0,
739                 { Storage.getOpaqueValue(), RawLoc, TU }
740               };
741  return C;
742}
743
744CXCursor cxcursor::MakeCursorOverloadedDeclRef(Decl *D,
745                                               SourceLocation Loc,
746                                               CXTranslationUnit TU) {
747  assert(D && TU && "Invalid arguments!");
748  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
749  OverloadedDeclRefStorage Storage(D);
750  CXCursor C = {
751    CXCursor_OverloadedDeclRef, 0,
752    { Storage.getOpaqueValue(), RawLoc, TU }
753  };
754  return C;
755}
756
757CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name,
758                                               SourceLocation Loc,
759                                               CXTranslationUnit TU) {
760  assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!");
761  void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
762  OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate());
763  CXCursor C = {
764    CXCursor_OverloadedDeclRef, 0,
765    { Storage.getOpaqueValue(), RawLoc, TU }
766  };
767  return C;
768}
769
770std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation>
771cxcursor::getCursorOverloadedDeclRef(CXCursor C) {
772  assert(C.kind == CXCursor_OverloadedDeclRef);
773  return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue(C.data[0]),
774                        SourceLocation::getFromRawEncoding(
775                                       reinterpret_cast<uintptr_t>(C.data[1])));
776}
777
778Decl *cxcursor::getCursorDecl(CXCursor Cursor) {
779  return (Decl *)Cursor.data[0];
780}
781
782Expr *cxcursor::getCursorExpr(CXCursor Cursor) {
783  return dyn_cast_or_null<Expr>(getCursorStmt(Cursor));
784}
785
786Stmt *cxcursor::getCursorStmt(CXCursor Cursor) {
787  if (Cursor.kind == CXCursor_ObjCSuperClassRef ||
788      Cursor.kind == CXCursor_ObjCProtocolRef ||
789      Cursor.kind == CXCursor_ObjCClassRef)
790    return 0;
791
792  return (Stmt *)Cursor.data[1];
793}
794
795Attr *cxcursor::getCursorAttr(CXCursor Cursor) {
796  return (Attr *)Cursor.data[1];
797}
798
799Decl *cxcursor::getCursorParentDecl(CXCursor Cursor) {
800  return (Decl *)Cursor.data[0];
801}
802
803ASTContext &cxcursor::getCursorContext(CXCursor Cursor) {
804  return getCursorASTUnit(Cursor)->getASTContext();
805}
806
807ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) {
808  CXTranslationUnit TU = static_cast<CXTranslationUnit>(Cursor.data[2]);
809  if (!TU)
810    return 0;
811  return static_cast<ASTUnit *>(TU->TUData);
812}
813
814CXTranslationUnit cxcursor::getCursorTU(CXCursor Cursor) {
815  return static_cast<CXTranslationUnit>(Cursor.data[2]);
816}
817
818void cxcursor::getOverriddenCursors(CXCursor cursor,
819                                    SmallVectorImpl<CXCursor> &overridden) {
820  assert(clang_isDeclaration(cursor.kind));
821  const NamedDecl *D = dyn_cast_or_null<NamedDecl>(getCursorDecl(cursor));
822  if (!D)
823    return;
824
825  CXTranslationUnit TU = getCursorTU(cursor);
826  SmallVector<const NamedDecl *, 8> OverDecls;
827  D->getASTContext().getOverriddenMethods(D, OverDecls);
828
829  for (SmallVector<const NamedDecl *, 8>::iterator
830         I = OverDecls.begin(), E = OverDecls.end(); I != E; ++I) {
831    overridden.push_back(MakeCXCursor(const_cast<NamedDecl*>(*I), TU));
832  }
833}
834
835std::pair<int, SourceLocation>
836cxcursor::getSelectorIdentifierIndexAndLoc(CXCursor cursor) {
837  if (cursor.kind == CXCursor_ObjCMessageExpr) {
838    if (cursor.xdata != -1)
839      return std::make_pair(cursor.xdata,
840                            cast<ObjCMessageExpr>(getCursorExpr(cursor))
841                                                ->getSelectorLoc(cursor.xdata));
842  } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
843             cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
844    if (cursor.xdata != -1)
845      return std::make_pair(cursor.xdata,
846                            cast<ObjCMethodDecl>(getCursorDecl(cursor))
847                                                ->getSelectorLoc(cursor.xdata));
848  }
849
850  return std::make_pair(-1, SourceLocation());
851}
852
853CXCursor cxcursor::getSelectorIdentifierCursor(int SelIdx, CXCursor cursor) {
854  CXCursor newCursor = cursor;
855
856  if (cursor.kind == CXCursor_ObjCMessageExpr) {
857    if (SelIdx == -1 ||
858        unsigned(SelIdx) >= cast<ObjCMessageExpr>(getCursorExpr(cursor))
859                                                         ->getNumSelectorLocs())
860      newCursor.xdata = -1;
861    else
862      newCursor.xdata = SelIdx;
863  } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
864             cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
865    if (SelIdx == -1 ||
866        unsigned(SelIdx) >= cast<ObjCMethodDecl>(getCursorDecl(cursor))
867                                                         ->getNumSelectorLocs())
868      newCursor.xdata = -1;
869    else
870      newCursor.xdata = SelIdx;
871  }
872
873  return newCursor;
874}
875
876CXCursor cxcursor::getTypeRefCursor(CXCursor cursor) {
877  if (cursor.kind != CXCursor_CallExpr)
878    return cursor;
879
880  if (cursor.xdata == 0)
881    return cursor;
882
883  Expr *E = getCursorExpr(cursor);
884  TypeSourceInfo *Type = 0;
885  if (CXXUnresolvedConstructExpr *
886        UnCtor = dyn_cast<CXXUnresolvedConstructExpr>(E)) {
887    Type = UnCtor->getTypeSourceInfo();
888  } else if (CXXTemporaryObjectExpr *Tmp = dyn_cast<CXXTemporaryObjectExpr>(E)){
889    Type = Tmp->getTypeSourceInfo();
890  }
891
892  if (!Type)
893    return cursor;
894
895  CXTranslationUnit TU = getCursorTU(cursor);
896  QualType Ty = Type->getType();
897  TypeLoc TL = Type->getTypeLoc();
898  SourceLocation Loc = TL.getBeginLoc();
899
900  if (const ElaboratedType *ElabT = Ty->getAs<ElaboratedType>()) {
901    Ty = ElabT->getNamedType();
902    ElaboratedTypeLoc ElabTL = cast<ElaboratedTypeLoc>(TL);
903    Loc = ElabTL.getNamedTypeLoc().getBeginLoc();
904  }
905
906  if (const TypedefType *Typedef = Ty->getAs<TypedefType>())
907    return MakeCursorTypeRef(Typedef->getDecl(), Loc, TU);
908  if (const TagType *Tag = Ty->getAs<TagType>())
909    return MakeCursorTypeRef(Tag->getDecl(), Loc, TU);
910  if (const TemplateTypeParmType *TemplP = Ty->getAs<TemplateTypeParmType>())
911    return MakeCursorTypeRef(TemplP->getDecl(), Loc, TU);
912
913  return cursor;
914}
915
916bool cxcursor::operator==(CXCursor X, CXCursor Y) {
917  return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] &&
918         X.data[2] == Y.data[2];
919}
920
921// FIXME: Remove once we can model DeclGroups and their appropriate ranges
922// properly in the ASTs.
923bool cxcursor::isFirstInDeclGroup(CXCursor C) {
924  assert(clang_isDeclaration(C.kind));
925  return ((uintptr_t) (C.data[1])) != 0;
926}
927
928//===----------------------------------------------------------------------===//
929// libclang CXCursor APIs
930//===----------------------------------------------------------------------===//
931
932extern "C" {
933
934int clang_Cursor_isNull(CXCursor cursor) {
935  return clang_equalCursors(cursor, clang_getNullCursor());
936}
937
938CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor cursor) {
939  return getCursorTU(cursor);
940}
941
942int clang_Cursor_getNumArguments(CXCursor C) {
943  if (clang_isDeclaration(C.kind)) {
944    Decl *D = cxcursor::getCursorDecl(C);
945    if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D))
946      return MD->param_size();
947    if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
948      return FD->param_size();
949  }
950
951  return -1;
952}
953
954CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i) {
955  if (clang_isDeclaration(C.kind)) {
956    Decl *D = cxcursor::getCursorDecl(C);
957    if (ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
958      if (i < MD->param_size())
959        return cxcursor::MakeCXCursor(MD->param_begin()[i],
960                                      cxcursor::getCursorTU(C));
961    } else if (FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
962      if (i < FD->param_size())
963        return cxcursor::MakeCXCursor(FD->param_begin()[i],
964                                      cxcursor::getCursorTU(C));
965    }
966  }
967
968  return clang_getNullCursor();
969}
970
971} // end: extern "C"
972
973//===----------------------------------------------------------------------===//
974// CXCursorSet.
975//===----------------------------------------------------------------------===//
976
977typedef llvm::DenseMap<CXCursor, unsigned> CXCursorSet_Impl;
978
979static inline CXCursorSet packCXCursorSet(CXCursorSet_Impl *setImpl) {
980  return (CXCursorSet) setImpl;
981}
982static inline CXCursorSet_Impl *unpackCXCursorSet(CXCursorSet set) {
983  return (CXCursorSet_Impl*) set;
984}
985namespace llvm {
986template<> struct DenseMapInfo<CXCursor> {
987public:
988  static inline CXCursor getEmptyKey() {
989    return MakeCXCursorInvalid(CXCursor_InvalidFile);
990  }
991  static inline CXCursor getTombstoneKey() {
992    return MakeCXCursorInvalid(CXCursor_NoDeclFound);
993  }
994  static inline unsigned getHashValue(const CXCursor &cursor) {
995    return llvm::DenseMapInfo<std::pair<void*,void*> >
996      ::getHashValue(std::make_pair(cursor.data[0], cursor.data[1]));
997  }
998  static inline bool isEqual(const CXCursor &x, const CXCursor &y) {
999    return x.kind == y.kind &&
1000           x.data[0] == y.data[0] &&
1001           x.data[1] == y.data[1];
1002  }
1003};
1004}
1005
1006extern "C" {
1007CXCursorSet clang_createCXCursorSet() {
1008  return packCXCursorSet(new CXCursorSet_Impl());
1009}
1010
1011void clang_disposeCXCursorSet(CXCursorSet set) {
1012  delete unpackCXCursorSet(set);
1013}
1014
1015unsigned clang_CXCursorSet_contains(CXCursorSet set, CXCursor cursor) {
1016  CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1017  if (!setImpl)
1018    return 0;
1019  return setImpl->find(cursor) == setImpl->end();
1020}
1021
1022unsigned clang_CXCursorSet_insert(CXCursorSet set, CXCursor cursor) {
1023  // Do not insert invalid cursors into the set.
1024  if (cursor.kind >= CXCursor_FirstInvalid &&
1025      cursor.kind <= CXCursor_LastInvalid)
1026    return 1;
1027
1028  CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1029  if (!setImpl)
1030    return 1;
1031  unsigned &entry = (*setImpl)[cursor];
1032  unsigned flag = entry == 0 ? 1 : 0;
1033  entry = 1;
1034  return flag;
1035}
1036
1037CXCompletionString clang_getCursorCompletionString(CXCursor cursor) {
1038  enum CXCursorKind kind = clang_getCursorKind(cursor);
1039  if (clang_isDeclaration(kind)) {
1040    Decl *decl = getCursorDecl(cursor);
1041    if (NamedDecl *namedDecl = dyn_cast_or_null<NamedDecl>(decl)) {
1042      ASTUnit *unit = getCursorASTUnit(cursor);
1043      CodeCompletionResult Result(namedDecl);
1044      CodeCompletionString *String
1045        = Result.CreateCodeCompletionString(unit->getASTContext(),
1046                                            unit->getPreprocessor(),
1047                                 unit->getCodeCompletionTUInfo().getAllocator(),
1048                                 unit->getCodeCompletionTUInfo(),
1049                                 true);
1050      return String;
1051    }
1052  }
1053  else if (kind == CXCursor_MacroDefinition) {
1054    MacroDefinition *definition = getCursorMacroDefinition(cursor);
1055    const IdentifierInfo *MacroInfo = definition->getName();
1056    ASTUnit *unit = getCursorASTUnit(cursor);
1057    CodeCompletionResult Result(const_cast<IdentifierInfo *>(MacroInfo));
1058    CodeCompletionString *String
1059      = Result.CreateCodeCompletionString(unit->getASTContext(),
1060                                          unit->getPreprocessor(),
1061                                 unit->getCodeCompletionTUInfo().getAllocator(),
1062                                 unit->getCodeCompletionTUInfo(),
1063                                 false);
1064    return String;
1065  }
1066  return NULL;
1067}
1068} // end: extern C.
1069
1070namespace {
1071  struct OverridenCursorsPool {
1072    typedef llvm::SmallVector<CXCursor, 2> CursorVec;
1073    std::vector<CursorVec*> AllCursors;
1074    std::vector<CursorVec*> AvailableCursors;
1075
1076    ~OverridenCursorsPool() {
1077      for (std::vector<CursorVec*>::iterator I = AllCursors.begin(),
1078           E = AllCursors.end(); I != E; ++I) {
1079        delete *I;
1080      }
1081    }
1082  };
1083}
1084
1085void *cxcursor::createOverridenCXCursorsPool() {
1086  return new OverridenCursorsPool();
1087}
1088
1089void cxcursor::disposeOverridenCXCursorsPool(void *pool) {
1090  delete static_cast<OverridenCursorsPool*>(pool);
1091}
1092
1093extern "C" {
1094void clang_getOverriddenCursors(CXCursor cursor,
1095                                CXCursor **overridden,
1096                                unsigned *num_overridden) {
1097  if (overridden)
1098    *overridden = 0;
1099  if (num_overridden)
1100    *num_overridden = 0;
1101
1102  CXTranslationUnit TU = cxcursor::getCursorTU(cursor);
1103
1104  if (!overridden || !num_overridden || !TU)
1105    return;
1106
1107  if (!clang_isDeclaration(cursor.kind))
1108    return;
1109
1110  OverridenCursorsPool &pool =
1111    *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool);
1112
1113  OverridenCursorsPool::CursorVec *Vec = 0;
1114
1115  if (!pool.AvailableCursors.empty()) {
1116    Vec = pool.AvailableCursors.back();
1117    pool.AvailableCursors.pop_back();
1118  }
1119  else {
1120    Vec = new OverridenCursorsPool::CursorVec();
1121    pool.AllCursors.push_back(Vec);
1122  }
1123
1124  // Clear out the vector, but don't free the memory contents.  This
1125  // reduces malloc() traffic.
1126  Vec->clear();
1127
1128  // Use the first entry to contain a back reference to the vector.
1129  // This is a complete hack.
1130  CXCursor backRefCursor = MakeCXCursorInvalid(CXCursor_InvalidFile, TU);
1131  backRefCursor.data[0] = Vec;
1132  assert(cxcursor::getCursorTU(backRefCursor) == TU);
1133  Vec->push_back(backRefCursor);
1134
1135  // Get the overriden cursors.
1136  cxcursor::getOverriddenCursors(cursor, *Vec);
1137
1138  // Did we get any overriden cursors?  If not, return Vec to the pool
1139  // of available cursor vectors.
1140  if (Vec->size() == 1) {
1141    pool.AvailableCursors.push_back(Vec);
1142    return;
1143  }
1144
1145  // Now tell the caller about the overriden cursors.
1146  assert(Vec->size() > 1);
1147  *overridden = &((*Vec)[1]);
1148  *num_overridden = Vec->size() - 1;
1149}
1150
1151void clang_disposeOverriddenCursors(CXCursor *overridden) {
1152  if (!overridden)
1153    return;
1154
1155  // Use pointer arithmetic to get back the first faux entry
1156  // which has a back-reference to the TU and the vector.
1157  --overridden;
1158  OverridenCursorsPool::CursorVec *Vec =
1159    static_cast<OverridenCursorsPool::CursorVec*>(overridden->data[0]);
1160  CXTranslationUnit TU = getCursorTU(*overridden);
1161
1162  assert(Vec && TU);
1163
1164  OverridenCursorsPool &pool =
1165    *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool);
1166
1167  pool.AvailableCursors.push_back(Vec);
1168}
1169
1170int clang_Cursor_isDynamicCall(CXCursor C) {
1171  const Expr *E = 0;
1172  if (clang_isExpression(C.kind))
1173    E = getCursorExpr(C);
1174  if (!E)
1175    return 0;
1176
1177  if (const ObjCMessageExpr *MsgE = dyn_cast<ObjCMessageExpr>(E))
1178    return MsgE->getReceiverKind() == ObjCMessageExpr::Instance;
1179
1180  const MemberExpr *ME = 0;
1181  if (isa<MemberExpr>(E))
1182    ME = cast<MemberExpr>(E);
1183  else if (const CallExpr *CE = dyn_cast<CallExpr>(E))
1184    ME = dyn_cast_or_null<MemberExpr>(CE->getCallee());
1185
1186  if (ME) {
1187    if (const CXXMethodDecl *
1188          MD = dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl()))
1189      return MD->isVirtual() && !ME->hasQualifier();
1190  }
1191
1192  return 0;
1193}
1194
1195CXType clang_Cursor_getReceiverType(CXCursor C) {
1196  CXTranslationUnit TU = cxcursor::getCursorTU(C);
1197  const Expr *E = 0;
1198  if (clang_isExpression(C.kind))
1199    E = getCursorExpr(C);
1200
1201  if (const ObjCMessageExpr *MsgE = dyn_cast_or_null<ObjCMessageExpr>(E))
1202    return cxtype::MakeCXType(MsgE->getReceiverType(), TU);
1203
1204  return cxtype::MakeCXType(QualType(), TU);
1205}
1206
1207} // end: extern "C"
1208