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