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