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