xref: /llvm-project/clang/tools/libclang/CXCursor.cpp (revision 65f367fcbbf38e599b2f747ca101c97d40c6420d)
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::OMPTaskgroupDirectiveClass:
574     K = CXCursor_OMPTaskgroupDirective;
575     break;
576   case Stmt::OMPFlushDirectiveClass:
577     K = CXCursor_OMPFlushDirective;
578     break;
579   case Stmt::OMPOrderedDirectiveClass:
580     K = CXCursor_OMPOrderedDirective;
581     break;
582   case Stmt::OMPAtomicDirectiveClass:
583     K = CXCursor_OMPAtomicDirective;
584     break;
585   case Stmt::OMPTargetDirectiveClass:
586     K = CXCursor_OMPTargetDirective;
587     break;
588   case Stmt::OMPTargetDataDirectiveClass:
589     K = CXCursor_OMPTargetDataDirective;
590     break;
591   case Stmt::OMPTeamsDirectiveClass:
592     K = CXCursor_OMPTeamsDirective;
593     break;
594   case Stmt::OMPCancellationPointDirectiveClass:
595     K = CXCursor_OMPCancellationPointDirective;
596     break;
597   case Stmt::OMPCancelDirectiveClass:
598     K = CXCursor_OMPCancelDirective;
599     break;
600   }
601 
602   CXCursor C = { K, 0, { Parent, S, TU } };
603   return C;
604 }
605 
606 CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super,
607                                                SourceLocation Loc,
608                                                CXTranslationUnit TU) {
609   assert(Super && TU && "Invalid arguments!");
610   void *RawLoc = Loc.getPtrEncoding();
611   CXCursor C = { CXCursor_ObjCSuperClassRef, 0, { Super, RawLoc, TU } };
612   return C;
613 }
614 
615 std::pair<const ObjCInterfaceDecl *, SourceLocation>
616 cxcursor::getCursorObjCSuperClassRef(CXCursor C) {
617   assert(C.kind == CXCursor_ObjCSuperClassRef);
618   return std::make_pair(static_cast<const ObjCInterfaceDecl *>(C.data[0]),
619                         SourceLocation::getFromPtrEncoding(C.data[1]));
620 }
621 
622 CXCursor cxcursor::MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto,
623                                              SourceLocation Loc,
624                                              CXTranslationUnit TU) {
625   assert(Proto && TU && "Invalid arguments!");
626   void *RawLoc = Loc.getPtrEncoding();
627   CXCursor C = { CXCursor_ObjCProtocolRef, 0, { Proto, RawLoc, TU } };
628   return C;
629 }
630 
631 std::pair<const ObjCProtocolDecl *, SourceLocation>
632 cxcursor::getCursorObjCProtocolRef(CXCursor C) {
633   assert(C.kind == CXCursor_ObjCProtocolRef);
634   return std::make_pair(static_cast<const ObjCProtocolDecl *>(C.data[0]),
635                         SourceLocation::getFromPtrEncoding(C.data[1]));
636 }
637 
638 CXCursor cxcursor::MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class,
639                                           SourceLocation Loc,
640                                           CXTranslationUnit TU) {
641   // 'Class' can be null for invalid code.
642   if (!Class)
643     return MakeCXCursorInvalid(CXCursor_InvalidCode);
644   assert(TU && "Invalid arguments!");
645   void *RawLoc = Loc.getPtrEncoding();
646   CXCursor C = { CXCursor_ObjCClassRef, 0, { Class, RawLoc, TU } };
647   return C;
648 }
649 
650 std::pair<const ObjCInterfaceDecl *, SourceLocation>
651 cxcursor::getCursorObjCClassRef(CXCursor C) {
652   assert(C.kind == CXCursor_ObjCClassRef);
653   return std::make_pair(static_cast<const ObjCInterfaceDecl *>(C.data[0]),
654                         SourceLocation::getFromPtrEncoding(C.data[1]));
655 }
656 
657 CXCursor cxcursor::MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc,
658                                      CXTranslationUnit TU) {
659   assert(Type && TU && "Invalid arguments!");
660   void *RawLoc = Loc.getPtrEncoding();
661   CXCursor C = { CXCursor_TypeRef, 0, { Type, RawLoc, TU } };
662   return C;
663 }
664 
665 std::pair<const TypeDecl *, SourceLocation>
666 cxcursor::getCursorTypeRef(CXCursor C) {
667   assert(C.kind == CXCursor_TypeRef);
668   return std::make_pair(static_cast<const TypeDecl *>(C.data[0]),
669                         SourceLocation::getFromPtrEncoding(C.data[1]));
670 }
671 
672 CXCursor cxcursor::MakeCursorTemplateRef(const TemplateDecl *Template,
673                                          SourceLocation Loc,
674                                          CXTranslationUnit TU) {
675   assert(Template && TU && "Invalid arguments!");
676   void *RawLoc = Loc.getPtrEncoding();
677   CXCursor C = { CXCursor_TemplateRef, 0, { Template, RawLoc, TU } };
678   return C;
679 }
680 
681 std::pair<const TemplateDecl *, SourceLocation>
682 cxcursor::getCursorTemplateRef(CXCursor C) {
683   assert(C.kind == CXCursor_TemplateRef);
684   return std::make_pair(static_cast<const TemplateDecl *>(C.data[0]),
685                         SourceLocation::getFromPtrEncoding(C.data[1]));
686 }
687 
688 CXCursor cxcursor::MakeCursorNamespaceRef(const NamedDecl *NS,
689                                           SourceLocation Loc,
690                                           CXTranslationUnit TU) {
691 
692   assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU &&
693          "Invalid arguments!");
694   void *RawLoc = Loc.getPtrEncoding();
695   CXCursor C = { CXCursor_NamespaceRef, 0, { NS, RawLoc, TU } };
696   return C;
697 }
698 
699 std::pair<const NamedDecl *, SourceLocation>
700 cxcursor::getCursorNamespaceRef(CXCursor C) {
701   assert(C.kind == CXCursor_NamespaceRef);
702   return std::make_pair(static_cast<const NamedDecl *>(C.data[0]),
703                         SourceLocation::getFromPtrEncoding(C.data[1]));
704 }
705 
706 CXCursor cxcursor::MakeCursorVariableRef(const VarDecl *Var, SourceLocation Loc,
707                                          CXTranslationUnit TU) {
708 
709   assert(Var && TU && "Invalid arguments!");
710   void *RawLoc = Loc.getPtrEncoding();
711   CXCursor C = { CXCursor_VariableRef, 0, { Var, RawLoc, TU } };
712   return C;
713 }
714 
715 std::pair<const VarDecl *, SourceLocation>
716 cxcursor::getCursorVariableRef(CXCursor C) {
717   assert(C.kind == CXCursor_VariableRef);
718   return std::make_pair(static_cast<const VarDecl *>(C.data[0]),
719                         SourceLocation::getFromPtrEncoding(C.data[1]));
720 }
721 
722 CXCursor cxcursor::MakeCursorMemberRef(const FieldDecl *Field, SourceLocation Loc,
723                                        CXTranslationUnit TU) {
724 
725   assert(Field && TU && "Invalid arguments!");
726   void *RawLoc = Loc.getPtrEncoding();
727   CXCursor C = { CXCursor_MemberRef, 0, { Field, RawLoc, TU } };
728   return C;
729 }
730 
731 std::pair<const FieldDecl *, SourceLocation>
732 cxcursor::getCursorMemberRef(CXCursor C) {
733   assert(C.kind == CXCursor_MemberRef);
734   return std::make_pair(static_cast<const FieldDecl *>(C.data[0]),
735                         SourceLocation::getFromPtrEncoding(C.data[1]));
736 }
737 
738 CXCursor cxcursor::MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B,
739                                               CXTranslationUnit TU){
740   CXCursor C = { CXCursor_CXXBaseSpecifier, 0, { B, nullptr, TU } };
741   return C;
742 }
743 
744 const CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) {
745   assert(C.kind == CXCursor_CXXBaseSpecifier);
746   return static_cast<const CXXBaseSpecifier*>(C.data[0]);
747 }
748 
749 CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range,
750                                                     CXTranslationUnit TU) {
751   CXCursor C = { CXCursor_PreprocessingDirective, 0,
752                  { Range.getBegin().getPtrEncoding(),
753                    Range.getEnd().getPtrEncoding(),
754                    TU }
755                };
756   return C;
757 }
758 
759 SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) {
760   assert(C.kind == CXCursor_PreprocessingDirective);
761   SourceRange Range(SourceLocation::getFromPtrEncoding(C.data[0]),
762                     SourceLocation::getFromPtrEncoding(C.data[1]));
763   ASTUnit *TU = getCursorASTUnit(C);
764   return TU->mapRangeFromPreamble(Range);
765 }
766 
767 CXCursor cxcursor::MakeMacroDefinitionCursor(const MacroDefinitionRecord *MI,
768                                              CXTranslationUnit TU) {
769   CXCursor C = {CXCursor_MacroDefinition, 0, {MI, nullptr, TU}};
770   return C;
771 }
772 
773 const MacroDefinitionRecord *cxcursor::getCursorMacroDefinition(CXCursor C) {
774   assert(C.kind == CXCursor_MacroDefinition);
775   return static_cast<const MacroDefinitionRecord *>(C.data[0]);
776 }
777 
778 CXCursor cxcursor::MakeMacroExpansionCursor(MacroExpansion *MI,
779                                             CXTranslationUnit TU) {
780   CXCursor C = { CXCursor_MacroExpansion, 0, { MI, nullptr, TU } };
781   return C;
782 }
783 
784 CXCursor cxcursor::MakeMacroExpansionCursor(MacroDefinitionRecord *MI,
785                                             SourceLocation Loc,
786                                             CXTranslationUnit TU) {
787   assert(Loc.isValid());
788   CXCursor C = {CXCursor_MacroExpansion, 0, {MI, Loc.getPtrEncoding(), TU}};
789   return C;
790 }
791 
792 const IdentifierInfo *cxcursor::MacroExpansionCursor::getName() const {
793   if (isPseudo())
794     return getAsMacroDefinition()->getName();
795   return getAsMacroExpansion()->getName();
796 }
797 const MacroDefinitionRecord *
798 cxcursor::MacroExpansionCursor::getDefinition() const {
799   if (isPseudo())
800     return getAsMacroDefinition();
801   return getAsMacroExpansion()->getDefinition();
802 }
803 SourceRange cxcursor::MacroExpansionCursor::getSourceRange() const {
804   if (isPseudo())
805     return getPseudoLoc();
806   return getAsMacroExpansion()->getSourceRange();
807 }
808 
809 CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID,
810                                                 CXTranslationUnit TU) {
811   CXCursor C = { CXCursor_InclusionDirective, 0, { ID, nullptr, TU } };
812   return C;
813 }
814 
815 const InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) {
816   assert(C.kind == CXCursor_InclusionDirective);
817   return static_cast<const InclusionDirective *>(C.data[0]);
818 }
819 
820 CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc,
821                                       CXTranslationUnit TU) {
822 
823   assert(Label && TU && "Invalid arguments!");
824   void *RawLoc = Loc.getPtrEncoding();
825   CXCursor C = { CXCursor_LabelRef, 0, { Label, RawLoc, TU } };
826   return C;
827 }
828 
829 std::pair<const LabelStmt *, SourceLocation>
830 cxcursor::getCursorLabelRef(CXCursor C) {
831   assert(C.kind == CXCursor_LabelRef);
832   return std::make_pair(static_cast<const LabelStmt *>(C.data[0]),
833                         SourceLocation::getFromPtrEncoding(C.data[1]));
834 }
835 
836 CXCursor cxcursor::MakeCursorOverloadedDeclRef(const OverloadExpr *E,
837                                                CXTranslationUnit TU) {
838   assert(E && TU && "Invalid arguments!");
839   OverloadedDeclRefStorage Storage(E);
840   void *RawLoc = E->getNameLoc().getPtrEncoding();
841   CXCursor C = {
842                  CXCursor_OverloadedDeclRef, 0,
843                  { Storage.getOpaqueValue(), RawLoc, TU }
844                };
845   return C;
846 }
847 
848 CXCursor cxcursor::MakeCursorOverloadedDeclRef(const Decl *D,
849                                                SourceLocation Loc,
850                                                CXTranslationUnit TU) {
851   assert(D && TU && "Invalid arguments!");
852   void *RawLoc = Loc.getPtrEncoding();
853   OverloadedDeclRefStorage Storage(D);
854   CXCursor C = {
855     CXCursor_OverloadedDeclRef, 0,
856     { Storage.getOpaqueValue(), RawLoc, TU }
857   };
858   return C;
859 }
860 
861 CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name,
862                                                SourceLocation Loc,
863                                                CXTranslationUnit TU) {
864   assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!");
865   void *RawLoc = Loc.getPtrEncoding();
866   OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate());
867   CXCursor C = {
868     CXCursor_OverloadedDeclRef, 0,
869     { Storage.getOpaqueValue(), RawLoc, TU }
870   };
871   return C;
872 }
873 
874 std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation>
875 cxcursor::getCursorOverloadedDeclRef(CXCursor C) {
876   assert(C.kind == CXCursor_OverloadedDeclRef);
877   return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue(
878                                        const_cast<void *>(C.data[0])),
879                         SourceLocation::getFromPtrEncoding(C.data[1]));
880 }
881 
882 const Decl *cxcursor::getCursorDecl(CXCursor Cursor) {
883   return static_cast<const Decl *>(Cursor.data[0]);
884 }
885 
886 const Expr *cxcursor::getCursorExpr(CXCursor Cursor) {
887   return dyn_cast_or_null<Expr>(getCursorStmt(Cursor));
888 }
889 
890 const Stmt *cxcursor::getCursorStmt(CXCursor Cursor) {
891   if (Cursor.kind == CXCursor_ObjCSuperClassRef ||
892       Cursor.kind == CXCursor_ObjCProtocolRef ||
893       Cursor.kind == CXCursor_ObjCClassRef)
894     return nullptr;
895 
896   return static_cast<const Stmt *>(Cursor.data[1]);
897 }
898 
899 const Attr *cxcursor::getCursorAttr(CXCursor Cursor) {
900   return static_cast<const Attr *>(Cursor.data[1]);
901 }
902 
903 const Decl *cxcursor::getCursorParentDecl(CXCursor Cursor) {
904   return static_cast<const Decl *>(Cursor.data[0]);
905 }
906 
907 ASTContext &cxcursor::getCursorContext(CXCursor Cursor) {
908   return getCursorASTUnit(Cursor)->getASTContext();
909 }
910 
911 ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) {
912   CXTranslationUnit TU = getCursorTU(Cursor);
913   if (!TU)
914     return nullptr;
915   return cxtu::getASTUnit(TU);
916 }
917 
918 CXTranslationUnit cxcursor::getCursorTU(CXCursor Cursor) {
919   return static_cast<CXTranslationUnit>(const_cast<void*>(Cursor.data[2]));
920 }
921 
922 void cxcursor::getOverriddenCursors(CXCursor cursor,
923                                     SmallVectorImpl<CXCursor> &overridden) {
924   assert(clang_isDeclaration(cursor.kind));
925   const NamedDecl *D = dyn_cast_or_null<NamedDecl>(getCursorDecl(cursor));
926   if (!D)
927     return;
928 
929   CXTranslationUnit TU = getCursorTU(cursor);
930   SmallVector<const NamedDecl *, 8> OverDecls;
931   D->getASTContext().getOverriddenMethods(D, OverDecls);
932 
933   for (SmallVectorImpl<const NamedDecl *>::iterator
934          I = OverDecls.begin(), E = OverDecls.end(); I != E; ++I) {
935     overridden.push_back(MakeCXCursor(*I, TU));
936   }
937 }
938 
939 std::pair<int, SourceLocation>
940 cxcursor::getSelectorIdentifierIndexAndLoc(CXCursor cursor) {
941   if (cursor.kind == CXCursor_ObjCMessageExpr) {
942     if (cursor.xdata != -1)
943       return std::make_pair(cursor.xdata,
944                             cast<ObjCMessageExpr>(getCursorExpr(cursor))
945                                                 ->getSelectorLoc(cursor.xdata));
946   } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
947              cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
948     if (cursor.xdata != -1)
949       return std::make_pair(cursor.xdata,
950                             cast<ObjCMethodDecl>(getCursorDecl(cursor))
951                                                 ->getSelectorLoc(cursor.xdata));
952   }
953 
954   return std::make_pair(-1, SourceLocation());
955 }
956 
957 CXCursor cxcursor::getSelectorIdentifierCursor(int SelIdx, CXCursor cursor) {
958   CXCursor newCursor = cursor;
959 
960   if (cursor.kind == CXCursor_ObjCMessageExpr) {
961     if (SelIdx == -1 ||
962         unsigned(SelIdx) >= cast<ObjCMessageExpr>(getCursorExpr(cursor))
963                                                          ->getNumSelectorLocs())
964       newCursor.xdata = -1;
965     else
966       newCursor.xdata = SelIdx;
967   } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
968              cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
969     if (SelIdx == -1 ||
970         unsigned(SelIdx) >= cast<ObjCMethodDecl>(getCursorDecl(cursor))
971                                                          ->getNumSelectorLocs())
972       newCursor.xdata = -1;
973     else
974       newCursor.xdata = SelIdx;
975   }
976 
977   return newCursor;
978 }
979 
980 CXCursor cxcursor::getTypeRefCursor(CXCursor cursor) {
981   if (cursor.kind != CXCursor_CallExpr)
982     return cursor;
983 
984   if (cursor.xdata == 0)
985     return cursor;
986 
987   const Expr *E = getCursorExpr(cursor);
988   TypeSourceInfo *Type = nullptr;
989   if (const CXXUnresolvedConstructExpr *
990         UnCtor = dyn_cast<CXXUnresolvedConstructExpr>(E)) {
991     Type = UnCtor->getTypeSourceInfo();
992   } else if (const CXXTemporaryObjectExpr *Tmp =
993                  dyn_cast<CXXTemporaryObjectExpr>(E)){
994     Type = Tmp->getTypeSourceInfo();
995   }
996 
997   if (!Type)
998     return cursor;
999 
1000   CXTranslationUnit TU = getCursorTU(cursor);
1001   QualType Ty = Type->getType();
1002   TypeLoc TL = Type->getTypeLoc();
1003   SourceLocation Loc = TL.getBeginLoc();
1004 
1005   if (const ElaboratedType *ElabT = Ty->getAs<ElaboratedType>()) {
1006     Ty = ElabT->getNamedType();
1007     ElaboratedTypeLoc ElabTL = TL.castAs<ElaboratedTypeLoc>();
1008     Loc = ElabTL.getNamedTypeLoc().getBeginLoc();
1009   }
1010 
1011   if (const TypedefType *Typedef = Ty->getAs<TypedefType>())
1012     return MakeCursorTypeRef(Typedef->getDecl(), Loc, TU);
1013   if (const TagType *Tag = Ty->getAs<TagType>())
1014     return MakeCursorTypeRef(Tag->getDecl(), Loc, TU);
1015   if (const TemplateTypeParmType *TemplP = Ty->getAs<TemplateTypeParmType>())
1016     return MakeCursorTypeRef(TemplP->getDecl(), Loc, TU);
1017 
1018   return cursor;
1019 }
1020 
1021 bool cxcursor::operator==(CXCursor X, CXCursor Y) {
1022   return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] &&
1023          X.data[2] == Y.data[2];
1024 }
1025 
1026 // FIXME: Remove once we can model DeclGroups and their appropriate ranges
1027 // properly in the ASTs.
1028 bool cxcursor::isFirstInDeclGroup(CXCursor C) {
1029   assert(clang_isDeclaration(C.kind));
1030   return ((uintptr_t) (C.data[1])) != 0;
1031 }
1032 
1033 //===----------------------------------------------------------------------===//
1034 // libclang CXCursor APIs
1035 //===----------------------------------------------------------------------===//
1036 
1037 extern "C" {
1038 
1039 int clang_Cursor_isNull(CXCursor cursor) {
1040   return clang_equalCursors(cursor, clang_getNullCursor());
1041 }
1042 
1043 CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor cursor) {
1044   return getCursorTU(cursor);
1045 }
1046 
1047 int clang_Cursor_getNumArguments(CXCursor C) {
1048   if (clang_isDeclaration(C.kind)) {
1049     const Decl *D = cxcursor::getCursorDecl(C);
1050     if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D))
1051       return MD->param_size();
1052     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
1053       return FD->param_size();
1054   }
1055 
1056   if (clang_isExpression(C.kind)) {
1057     const Expr *E = cxcursor::getCursorExpr(C);
1058     if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
1059       return CE->getNumArgs();
1060     }
1061   }
1062 
1063   return -1;
1064 }
1065 
1066 CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i) {
1067   if (clang_isDeclaration(C.kind)) {
1068     const Decl *D = cxcursor::getCursorDecl(C);
1069     if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
1070       if (i < MD->param_size())
1071         return cxcursor::MakeCXCursor(MD->parameters()[i],
1072                                       cxcursor::getCursorTU(C));
1073     } else if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
1074       if (i < FD->param_size())
1075         return cxcursor::MakeCXCursor(FD->parameters()[i],
1076                                       cxcursor::getCursorTU(C));
1077     }
1078   }
1079 
1080   if (clang_isExpression(C.kind)) {
1081     const Expr *E = cxcursor::getCursorExpr(C);
1082     if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
1083       if (i < CE->getNumArgs()) {
1084         return cxcursor::MakeCXCursor(CE->getArg(i),
1085                                       getCursorDecl(C),
1086                                       cxcursor::getCursorTU(C));
1087       }
1088     }
1089   }
1090 
1091   return clang_getNullCursor();
1092 }
1093 
1094 int clang_Cursor_getNumTemplateArguments(CXCursor C) {
1095   if (clang_getCursorKind(C) != CXCursor_FunctionDecl) {
1096     return -1;
1097   }
1098 
1099   const FunctionDecl *FD = llvm::dyn_cast_or_null<clang::FunctionDecl>(
1100       getCursorDecl(C));
1101   if (!FD) {
1102     return -1;
1103   }
1104 
1105   const FunctionTemplateSpecializationInfo* SpecInfo =
1106       FD->getTemplateSpecializationInfo();
1107   if (!SpecInfo) {
1108     return -1;
1109   }
1110 
1111   return SpecInfo->TemplateArguments->size();
1112 }
1113 
1114 enum CXGetTemplateArgumentStatus {
1115   /** \brief The operation completed successfully */
1116   CXGetTemplateArgumentStatus_Success = 0,
1117 
1118   /** \brief The specified cursor did not represent a FunctionDecl. */
1119   CXGetTemplateArgumentStatus_CursorNotFunctionDecl = -1,
1120 
1121   /** \brief The specified cursor was not castable to a FunctionDecl. */
1122   CXGetTemplateArgumentStatus_BadFunctionDeclCast = -2,
1123 
1124   /** \brief A NULL FunctionTemplateSpecializationInfo was retrieved. */
1125   CXGetTemplateArgumentStatus_NullTemplSpecInfo = -3,
1126 
1127   /** \brief An invalid (OOB) argument index was specified */
1128   CXGetTemplateArgumentStatus_InvalidIndex = -4
1129 };
1130 
1131 static int clang_Cursor_getTemplateArgument(
1132     CXCursor C, unsigned I, TemplateArgument *TA) {
1133   if (clang_getCursorKind(C) != CXCursor_FunctionDecl) {
1134     return CXGetTemplateArgumentStatus_CursorNotFunctionDecl;
1135   }
1136 
1137   const FunctionDecl *FD = llvm::dyn_cast_or_null<clang::FunctionDecl>(
1138       getCursorDecl(C));
1139   if (!FD) {
1140     return CXGetTemplateArgumentStatus_BadFunctionDeclCast;
1141   }
1142 
1143   const FunctionTemplateSpecializationInfo* SpecInfo =
1144       FD->getTemplateSpecializationInfo();
1145   if (!SpecInfo) {
1146     return CXGetTemplateArgumentStatus_NullTemplSpecInfo;
1147   }
1148 
1149   if (I >= SpecInfo->TemplateArguments->size()) {
1150     return CXGetTemplateArgumentStatus_InvalidIndex;
1151   }
1152 
1153   *TA = SpecInfo->TemplateArguments->get(I);
1154   return 0;
1155 }
1156 
1157 enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(CXCursor C,
1158                                                                  unsigned I) {
1159   TemplateArgument TA;
1160   if (clang_Cursor_getTemplateArgument(C, I, &TA)) {
1161     return CXTemplateArgumentKind_Invalid;
1162   }
1163 
1164   switch (TA.getKind()) {
1165     case TemplateArgument::Null: return CXTemplateArgumentKind_Null;
1166     case TemplateArgument::Type: return CXTemplateArgumentKind_Type;
1167     case TemplateArgument::Declaration:
1168       return CXTemplateArgumentKind_Declaration;
1169     case TemplateArgument::NullPtr: return CXTemplateArgumentKind_NullPtr;
1170     case TemplateArgument::Integral: return CXTemplateArgumentKind_Integral;
1171     case TemplateArgument::Template: return CXTemplateArgumentKind_Template;
1172     case TemplateArgument::TemplateExpansion:
1173       return CXTemplateArgumentKind_TemplateExpansion;
1174     case TemplateArgument::Expression: return CXTemplateArgumentKind_Expression;
1175     case TemplateArgument::Pack: return CXTemplateArgumentKind_Pack;
1176   }
1177 
1178   return CXTemplateArgumentKind_Invalid;
1179 }
1180 
1181 CXType clang_Cursor_getTemplateArgumentType(CXCursor C, unsigned I) {
1182   TemplateArgument TA;
1183   if (clang_Cursor_getTemplateArgument(C, I, &TA) !=
1184       CXGetTemplateArgumentStatus_Success) {
1185     return cxtype::MakeCXType(QualType(), getCursorTU(C));
1186   }
1187 
1188   if (TA.getKind() != TemplateArgument::Type) {
1189     return cxtype::MakeCXType(QualType(), getCursorTU(C));
1190   }
1191 
1192   return cxtype::MakeCXType(TA.getAsType(), getCursorTU(C));
1193 }
1194 
1195 long long clang_Cursor_getTemplateArgumentValue(CXCursor C, unsigned I) {
1196   TemplateArgument TA;
1197   if (clang_Cursor_getTemplateArgument(C, I, &TA) !=
1198       CXGetTemplateArgumentStatus_Success) {
1199     assert(0 && "Unable to retrieve TemplateArgument");
1200     return 0;
1201   }
1202 
1203   if (TA.getKind() != TemplateArgument::Integral) {
1204     assert(0 && "Passed template argument is not Integral");
1205     return 0;
1206   }
1207 
1208   return TA.getAsIntegral().getSExtValue();
1209 }
1210 
1211 unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(CXCursor C,
1212                                                                  unsigned I) {
1213   TemplateArgument TA;
1214   if (clang_Cursor_getTemplateArgument(C, I, &TA) !=
1215       CXGetTemplateArgumentStatus_Success) {
1216     assert(0 && "Unable to retrieve TemplateArgument");
1217     return 0;
1218   }
1219 
1220   if (TA.getKind() != TemplateArgument::Integral) {
1221     assert(0 && "Passed template argument is not Integral");
1222     return 0;
1223   }
1224 
1225   return TA.getAsIntegral().getZExtValue();
1226 }
1227 
1228 } // end: extern "C"
1229 
1230 //===----------------------------------------------------------------------===//
1231 // CXCursorSet.
1232 //===----------------------------------------------------------------------===//
1233 
1234 typedef llvm::DenseMap<CXCursor, unsigned> CXCursorSet_Impl;
1235 
1236 static inline CXCursorSet packCXCursorSet(CXCursorSet_Impl *setImpl) {
1237   return (CXCursorSet) setImpl;
1238 }
1239 static inline CXCursorSet_Impl *unpackCXCursorSet(CXCursorSet set) {
1240   return (CXCursorSet_Impl*) set;
1241 }
1242 namespace llvm {
1243 template<> struct DenseMapInfo<CXCursor> {
1244 public:
1245   static inline CXCursor getEmptyKey() {
1246     return MakeCXCursorInvalid(CXCursor_InvalidFile);
1247   }
1248   static inline CXCursor getTombstoneKey() {
1249     return MakeCXCursorInvalid(CXCursor_NoDeclFound);
1250   }
1251   static inline unsigned getHashValue(const CXCursor &cursor) {
1252     return llvm::DenseMapInfo<std::pair<const void *, const void *> >
1253       ::getHashValue(std::make_pair(cursor.data[0], cursor.data[1]));
1254   }
1255   static inline bool isEqual(const CXCursor &x, const CXCursor &y) {
1256     return x.kind == y.kind &&
1257            x.data[0] == y.data[0] &&
1258            x.data[1] == y.data[1];
1259   }
1260 };
1261 }
1262 
1263 extern "C" {
1264 CXCursorSet clang_createCXCursorSet() {
1265   return packCXCursorSet(new CXCursorSet_Impl());
1266 }
1267 
1268 void clang_disposeCXCursorSet(CXCursorSet set) {
1269   delete unpackCXCursorSet(set);
1270 }
1271 
1272 unsigned clang_CXCursorSet_contains(CXCursorSet set, CXCursor cursor) {
1273   CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1274   if (!setImpl)
1275     return 0;
1276   return setImpl->find(cursor) != setImpl->end();
1277 }
1278 
1279 unsigned clang_CXCursorSet_insert(CXCursorSet set, CXCursor cursor) {
1280   // Do not insert invalid cursors into the set.
1281   if (cursor.kind >= CXCursor_FirstInvalid &&
1282       cursor.kind <= CXCursor_LastInvalid)
1283     return 1;
1284 
1285   CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1286   if (!setImpl)
1287     return 1;
1288   unsigned &entry = (*setImpl)[cursor];
1289   unsigned flag = entry == 0 ? 1 : 0;
1290   entry = 1;
1291   return flag;
1292 }
1293 
1294 CXCompletionString clang_getCursorCompletionString(CXCursor cursor) {
1295   enum CXCursorKind kind = clang_getCursorKind(cursor);
1296   if (clang_isDeclaration(kind)) {
1297     const Decl *decl = getCursorDecl(cursor);
1298     if (const NamedDecl *namedDecl = dyn_cast_or_null<NamedDecl>(decl)) {
1299       ASTUnit *unit = getCursorASTUnit(cursor);
1300       CodeCompletionResult Result(namedDecl, CCP_Declaration);
1301       CodeCompletionString *String
1302         = Result.CreateCodeCompletionString(unit->getASTContext(),
1303                                             unit->getPreprocessor(),
1304                                             CodeCompletionContext::CCC_Other,
1305                                  unit->getCodeCompletionTUInfo().getAllocator(),
1306                                  unit->getCodeCompletionTUInfo(),
1307                                  true);
1308       return String;
1309     }
1310   } else if (kind == CXCursor_MacroDefinition) {
1311     const MacroDefinitionRecord *definition = getCursorMacroDefinition(cursor);
1312     const IdentifierInfo *MacroInfo = definition->getName();
1313     ASTUnit *unit = getCursorASTUnit(cursor);
1314     CodeCompletionResult Result(MacroInfo);
1315     CodeCompletionString *String
1316       = Result.CreateCodeCompletionString(unit->getASTContext(),
1317                                           unit->getPreprocessor(),
1318                                           CodeCompletionContext::CCC_Other,
1319                                  unit->getCodeCompletionTUInfo().getAllocator(),
1320                                  unit->getCodeCompletionTUInfo(),
1321                                  false);
1322     return String;
1323   }
1324   return nullptr;
1325 }
1326 } // end: extern C.
1327 
1328 namespace {
1329   struct OverridenCursorsPool {
1330     typedef SmallVector<CXCursor, 2> CursorVec;
1331     std::vector<CursorVec*> AllCursors;
1332     std::vector<CursorVec*> AvailableCursors;
1333 
1334     ~OverridenCursorsPool() {
1335       for (std::vector<CursorVec*>::iterator I = AllCursors.begin(),
1336            E = AllCursors.end(); I != E; ++I) {
1337         delete *I;
1338       }
1339     }
1340   };
1341 }
1342 
1343 void *cxcursor::createOverridenCXCursorsPool() {
1344   return new OverridenCursorsPool();
1345 }
1346 
1347 void cxcursor::disposeOverridenCXCursorsPool(void *pool) {
1348   delete static_cast<OverridenCursorsPool*>(pool);
1349 }
1350 
1351 extern "C" {
1352 void clang_getOverriddenCursors(CXCursor cursor,
1353                                 CXCursor **overridden,
1354                                 unsigned *num_overridden) {
1355   if (overridden)
1356     *overridden = nullptr;
1357   if (num_overridden)
1358     *num_overridden = 0;
1359 
1360   CXTranslationUnit TU = cxcursor::getCursorTU(cursor);
1361 
1362   if (!overridden || !num_overridden || !TU)
1363     return;
1364 
1365   if (!clang_isDeclaration(cursor.kind))
1366     return;
1367 
1368   OverridenCursorsPool &pool =
1369     *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool);
1370 
1371   OverridenCursorsPool::CursorVec *Vec = nullptr;
1372 
1373   if (!pool.AvailableCursors.empty()) {
1374     Vec = pool.AvailableCursors.back();
1375     pool.AvailableCursors.pop_back();
1376   }
1377   else {
1378     Vec = new OverridenCursorsPool::CursorVec();
1379     pool.AllCursors.push_back(Vec);
1380   }
1381 
1382   // Clear out the vector, but don't free the memory contents.  This
1383   // reduces malloc() traffic.
1384   Vec->clear();
1385 
1386   // Use the first entry to contain a back reference to the vector.
1387   // This is a complete hack.
1388   CXCursor backRefCursor = MakeCXCursorInvalid(CXCursor_InvalidFile, TU);
1389   backRefCursor.data[0] = Vec;
1390   assert(cxcursor::getCursorTU(backRefCursor) == TU);
1391   Vec->push_back(backRefCursor);
1392 
1393   // Get the overriden cursors.
1394   cxcursor::getOverriddenCursors(cursor, *Vec);
1395 
1396   // Did we get any overriden cursors?  If not, return Vec to the pool
1397   // of available cursor vectors.
1398   if (Vec->size() == 1) {
1399     pool.AvailableCursors.push_back(Vec);
1400     return;
1401   }
1402 
1403   // Now tell the caller about the overriden cursors.
1404   assert(Vec->size() > 1);
1405   *overridden = &((*Vec)[1]);
1406   *num_overridden = Vec->size() - 1;
1407 }
1408 
1409 void clang_disposeOverriddenCursors(CXCursor *overridden) {
1410   if (!overridden)
1411     return;
1412 
1413   // Use pointer arithmetic to get back the first faux entry
1414   // which has a back-reference to the TU and the vector.
1415   --overridden;
1416   OverridenCursorsPool::CursorVec *Vec =
1417       static_cast<OverridenCursorsPool::CursorVec *>(
1418           const_cast<void *>(overridden->data[0]));
1419   CXTranslationUnit TU = getCursorTU(*overridden);
1420 
1421   assert(Vec && TU);
1422 
1423   OverridenCursorsPool &pool =
1424     *static_cast<OverridenCursorsPool*>(TU->OverridenCursorsPool);
1425 
1426   pool.AvailableCursors.push_back(Vec);
1427 }
1428 
1429 int clang_Cursor_isDynamicCall(CXCursor C) {
1430   const Expr *E = nullptr;
1431   if (clang_isExpression(C.kind))
1432     E = getCursorExpr(C);
1433   if (!E)
1434     return 0;
1435 
1436   if (const ObjCMessageExpr *MsgE = dyn_cast<ObjCMessageExpr>(E)) {
1437     if (MsgE->getReceiverKind() != ObjCMessageExpr::Instance)
1438       return false;
1439     if (auto *RecE = dyn_cast<ObjCMessageExpr>(
1440             MsgE->getInstanceReceiver()->IgnoreParenCasts())) {
1441       if (RecE->getMethodFamily() == OMF_alloc)
1442         return false;
1443     }
1444     return true;
1445   }
1446 
1447   const MemberExpr *ME = nullptr;
1448   if (isa<MemberExpr>(E))
1449     ME = cast<MemberExpr>(E);
1450   else if (const CallExpr *CE = dyn_cast<CallExpr>(E))
1451     ME = dyn_cast_or_null<MemberExpr>(CE->getCallee());
1452 
1453   if (ME) {
1454     if (const CXXMethodDecl *
1455           MD = dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl()))
1456       return MD->isVirtual() && !ME->hasQualifier();
1457   }
1458 
1459   return 0;
1460 }
1461 
1462 CXType clang_Cursor_getReceiverType(CXCursor C) {
1463   CXTranslationUnit TU = cxcursor::getCursorTU(C);
1464   const Expr *E = nullptr;
1465   if (clang_isExpression(C.kind))
1466     E = getCursorExpr(C);
1467 
1468   if (const ObjCMessageExpr *MsgE = dyn_cast_or_null<ObjCMessageExpr>(E))
1469     return cxtype::MakeCXType(MsgE->getReceiverType(), TU);
1470 
1471   return cxtype::MakeCXType(QualType(), TU);
1472 }
1473 
1474 } // end: extern "C"
1475