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