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