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