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