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