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