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