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