1 //===- CXCursor.cpp - Routines for manipulating CXCursors -----------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines routines for manipulating CXCursors. It should be the
10 // only file that has internal knowledge of the encoding of the data in
11 // CXCursor.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "CXCursor.h"
16 #include "CXString.h"
17 #include "CXTranslationUnit.h"
18 #include "CXType.h"
19 #include "clang-c/Index.h"
20 #include "clang/AST/Attr.h"
21 #include "clang/AST/Decl.h"
22 #include "clang/AST/DeclCXX.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/Expr.h"
26 #include "clang/AST/ExprCXX.h"
27 #include "clang/AST/ExprObjC.h"
28 #include "clang/Frontend/ASTUnit.h"
29 #include "llvm/Support/ErrorHandling.h"
30 
31 using namespace clang;
32 using namespace cxcursor;
33 
34 CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K, CXTranslationUnit TU) {
35   assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid);
36   CXCursor C = {K, 0, {nullptr, nullptr, TU}};
37   return C;
38 }
39 
40 static CXCursorKind GetCursorKind(const Attr *A) {
41   assert(A && "Invalid arguments!");
42   switch (A->getKind()) {
43   default:
44     break;
45   case attr::IBAction:
46     return CXCursor_IBActionAttr;
47   case attr::IBOutlet:
48     return CXCursor_IBOutletAttr;
49   case attr::IBOutletCollection:
50     return CXCursor_IBOutletCollectionAttr;
51   case attr::Final:
52     return CXCursor_CXXFinalAttr;
53   case attr::Override:
54     return CXCursor_CXXOverrideAttr;
55   case attr::Annotate:
56     return CXCursor_AnnotateAttr;
57   case attr::AsmLabel:
58     return CXCursor_AsmLabelAttr;
59   case attr::Packed:
60     return CXCursor_PackedAttr;
61   case attr::Pure:
62     return CXCursor_PureAttr;
63   case attr::Const:
64     return CXCursor_ConstAttr;
65   case attr::NoDuplicate:
66     return CXCursor_NoDuplicateAttr;
67   case attr::CUDAConstant:
68     return CXCursor_CUDAConstantAttr;
69   case attr::CUDADevice:
70     return CXCursor_CUDADeviceAttr;
71   case attr::CUDAGlobal:
72     return CXCursor_CUDAGlobalAttr;
73   case attr::CUDAHost:
74     return CXCursor_CUDAHostAttr;
75   case attr::CUDAShared:
76     return CXCursor_CUDASharedAttr;
77   case attr::Visibility:
78     return CXCursor_VisibilityAttr;
79   case attr::DLLExport:
80     return CXCursor_DLLExport;
81   case attr::DLLImport:
82     return CXCursor_DLLImport;
83   case attr::NSReturnsRetained:
84     return CXCursor_NSReturnsRetained;
85   case attr::NSReturnsNotRetained:
86     return CXCursor_NSReturnsNotRetained;
87   case attr::NSReturnsAutoreleased:
88     return CXCursor_NSReturnsAutoreleased;
89   case attr::NSConsumesSelf:
90     return CXCursor_NSConsumesSelf;
91   case attr::NSConsumed:
92     return CXCursor_NSConsumed;
93   case attr::ObjCException:
94     return CXCursor_ObjCException;
95   case attr::ObjCNSObject:
96     return CXCursor_ObjCNSObject;
97   case attr::ObjCIndependentClass:
98     return CXCursor_ObjCIndependentClass;
99   case attr::ObjCPreciseLifetime:
100     return CXCursor_ObjCPreciseLifetime;
101   case attr::ObjCReturnsInnerPointer:
102     return CXCursor_ObjCReturnsInnerPointer;
103   case attr::ObjCRequiresSuper:
104     return CXCursor_ObjCRequiresSuper;
105   case attr::ObjCRootClass:
106     return CXCursor_ObjCRootClass;
107   case attr::ObjCSubclassingRestricted:
108     return CXCursor_ObjCSubclassingRestricted;
109   case attr::ObjCExplicitProtocolImpl:
110     return CXCursor_ObjCExplicitProtocolImpl;
111   case attr::ObjCDesignatedInitializer:
112     return CXCursor_ObjCDesignatedInitializer;
113   case attr::ObjCRuntimeVisible:
114     return CXCursor_ObjCRuntimeVisible;
115   case attr::ObjCBoxable:
116     return CXCursor_ObjCBoxable;
117   case attr::FlagEnum:
118     return CXCursor_FlagEnum;
119   case attr::Convergent:
120     return CXCursor_ConvergentAttr;
121   case attr::WarnUnused:
122     return CXCursor_WarnUnusedAttr;
123   case attr::WarnUnusedResult:
124     return CXCursor_WarnUnusedResultAttr;
125   case attr::Aligned:
126     return CXCursor_AlignedAttr;
127   }
128 
129   return CXCursor_UnexposedAttr;
130 }
131 
132 CXCursor cxcursor::MakeCXCursor(const Attr *A, const Decl *Parent,
133                                 CXTranslationUnit TU) {
134   assert(A && Parent && TU && "Invalid arguments!");
135   CXCursor C = {GetCursorKind(A), 0, {Parent, A, TU}};
136   return C;
137 }
138 
139 CXCursor cxcursor::MakeCXCursor(const Decl *D, CXTranslationUnit TU,
140                                 SourceRange RegionOfInterest,
141                                 bool FirstInDeclGroup) {
142   assert(D && TU && "Invalid arguments!");
143 
144   CXCursorKind K = getCursorKindForDecl(D);
145 
146   if (K == CXCursor_ObjCClassMethodDecl ||
147       K == CXCursor_ObjCInstanceMethodDecl) {
148     int SelectorIdIndex = -1;
149     // Check if cursor points to a selector id.
150     if (RegionOfInterest.isValid() &&
151         RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) {
152       SmallVector<SourceLocation, 16> SelLocs;
153       cast<ObjCMethodDecl>(D)->getSelectorLocs(SelLocs);
154       SmallVectorImpl<SourceLocation>::iterator I =
155           llvm::find(SelLocs, RegionOfInterest.getBegin());
156       if (I != SelLocs.end())
157         SelectorIdIndex = I - SelLocs.begin();
158     }
159     CXCursor C = {K,
160                   SelectorIdIndex,
161                   {D, (void *)(intptr_t)(FirstInDeclGroup ? 1 : 0), TU}};
162     return C;
163   }
164 
165   CXCursor C = {K, 0, {D, (void *)(intptr_t)(FirstInDeclGroup ? 1 : 0), TU}};
166   return C;
167 }
168 
169 CXCursor cxcursor::MakeCXCursor(const Stmt *S, const Decl *Parent,
170                                 CXTranslationUnit TU,
171                                 SourceRange RegionOfInterest) {
172   assert(S && TU && "Invalid arguments!");
173   CXCursorKind K = CXCursor_NotImplemented;
174 
175   switch (S->getStmtClass()) {
176   case Stmt::NoStmtClass:
177     break;
178 
179   case Stmt::CaseStmtClass:
180     K = CXCursor_CaseStmt;
181     break;
182 
183   case Stmt::DefaultStmtClass:
184     K = CXCursor_DefaultStmt;
185     break;
186 
187   case Stmt::IfStmtClass:
188     K = CXCursor_IfStmt;
189     break;
190 
191   case Stmt::SwitchStmtClass:
192     K = CXCursor_SwitchStmt;
193     break;
194 
195   case Stmt::WhileStmtClass:
196     K = CXCursor_WhileStmt;
197     break;
198 
199   case Stmt::DoStmtClass:
200     K = CXCursor_DoStmt;
201     break;
202 
203   case Stmt::ForStmtClass:
204     K = CXCursor_ForStmt;
205     break;
206 
207   case Stmt::GotoStmtClass:
208     K = CXCursor_GotoStmt;
209     break;
210 
211   case Stmt::IndirectGotoStmtClass:
212     K = CXCursor_IndirectGotoStmt;
213     break;
214 
215   case Stmt::ContinueStmtClass:
216     K = CXCursor_ContinueStmt;
217     break;
218 
219   case Stmt::BreakStmtClass:
220     K = CXCursor_BreakStmt;
221     break;
222 
223   case Stmt::ReturnStmtClass:
224     K = CXCursor_ReturnStmt;
225     break;
226 
227   case Stmt::GCCAsmStmtClass:
228     K = CXCursor_GCCAsmStmt;
229     break;
230 
231   case Stmt::MSAsmStmtClass:
232     K = CXCursor_MSAsmStmt;
233     break;
234 
235   case Stmt::ObjCAtTryStmtClass:
236     K = CXCursor_ObjCAtTryStmt;
237     break;
238 
239   case Stmt::ObjCAtCatchStmtClass:
240     K = CXCursor_ObjCAtCatchStmt;
241     break;
242 
243   case Stmt::ObjCAtFinallyStmtClass:
244     K = CXCursor_ObjCAtFinallyStmt;
245     break;
246 
247   case Stmt::ObjCAtThrowStmtClass:
248     K = CXCursor_ObjCAtThrowStmt;
249     break;
250 
251   case Stmt::ObjCAtSynchronizedStmtClass:
252     K = CXCursor_ObjCAtSynchronizedStmt;
253     break;
254 
255   case Stmt::ObjCAutoreleasePoolStmtClass:
256     K = CXCursor_ObjCAutoreleasePoolStmt;
257     break;
258 
259   case Stmt::ObjCForCollectionStmtClass:
260     K = CXCursor_ObjCForCollectionStmt;
261     break;
262 
263   case Stmt::CXXCatchStmtClass:
264     K = CXCursor_CXXCatchStmt;
265     break;
266 
267   case Stmt::CXXTryStmtClass:
268     K = CXCursor_CXXTryStmt;
269     break;
270 
271   case Stmt::CXXForRangeStmtClass:
272     K = CXCursor_CXXForRangeStmt;
273     break;
274 
275   case Stmt::SEHTryStmtClass:
276     K = CXCursor_SEHTryStmt;
277     break;
278 
279   case Stmt::SEHExceptStmtClass:
280     K = CXCursor_SEHExceptStmt;
281     break;
282 
283   case Stmt::SEHFinallyStmtClass:
284     K = CXCursor_SEHFinallyStmt;
285     break;
286 
287   case Stmt::SEHLeaveStmtClass:
288     K = CXCursor_SEHLeaveStmt;
289     break;
290 
291   case Stmt::CoroutineBodyStmtClass:
292   case Stmt::CoreturnStmtClass:
293     K = CXCursor_UnexposedStmt;
294     break;
295 
296   case Stmt::ArrayTypeTraitExprClass:
297   case Stmt::AsTypeExprClass:
298   case Stmt::AtomicExprClass:
299   case Stmt::BinaryConditionalOperatorClass:
300   case Stmt::TypeTraitExprClass:
301   case Stmt::CoawaitExprClass:
302   case Stmt::ConceptSpecializationExprClass:
303   case Stmt::RequiresExprClass:
304   case Stmt::DependentCoawaitExprClass:
305   case Stmt::CoyieldExprClass:
306   case Stmt::CXXBindTemporaryExprClass:
307   case Stmt::CXXDefaultArgExprClass:
308   case Stmt::CXXDefaultInitExprClass:
309   case Stmt::CXXFoldExprClass:
310   case Stmt::CXXRewrittenBinaryOperatorClass:
311   case Stmt::CXXStdInitializerListExprClass:
312   case Stmt::CXXScalarValueInitExprClass:
313   case Stmt::CXXUuidofExprClass:
314   case Stmt::ChooseExprClass:
315   case Stmt::DesignatedInitExprClass:
316   case Stmt::DesignatedInitUpdateExprClass:
317   case Stmt::ArrayInitLoopExprClass:
318   case Stmt::ArrayInitIndexExprClass:
319   case Stmt::ExprWithCleanupsClass:
320   case Stmt::ExpressionTraitExprClass:
321   case Stmt::ExtVectorElementExprClass:
322   case Stmt::ImplicitCastExprClass:
323   case Stmt::ImplicitValueInitExprClass:
324   case Stmt::NoInitExprClass:
325   case Stmt::MaterializeTemporaryExprClass:
326   case Stmt::ObjCIndirectCopyRestoreExprClass:
327   case Stmt::OffsetOfExprClass:
328   case Stmt::ParenListExprClass:
329   case Stmt::PredefinedExprClass:
330   case Stmt::ShuffleVectorExprClass:
331   case Stmt::SourceLocExprClass:
332   case Stmt::ConvertVectorExprClass:
333   case Stmt::VAArgExprClass:
334   case Stmt::ObjCArrayLiteralClass:
335   case Stmt::ObjCDictionaryLiteralClass:
336   case Stmt::ObjCBoxedExprClass:
337   case Stmt::ObjCSubscriptRefExprClass:
338   case Stmt::RecoveryExprClass:
339   case Stmt::SYCLUniqueStableNameExprClass:
340     K = CXCursor_UnexposedExpr;
341     break;
342 
343   case Stmt::OpaqueValueExprClass:
344     if (Expr *Src = cast<OpaqueValueExpr>(S)->getSourceExpr())
345       return MakeCXCursor(Src, Parent, TU, RegionOfInterest);
346     K = CXCursor_UnexposedExpr;
347     break;
348 
349   case Stmt::PseudoObjectExprClass:
350     return MakeCXCursor(cast<PseudoObjectExpr>(S)->getSyntacticForm(), Parent,
351                         TU, RegionOfInterest);
352 
353   case Stmt::CompoundStmtClass:
354     K = CXCursor_CompoundStmt;
355     break;
356 
357   case Stmt::NullStmtClass:
358     K = CXCursor_NullStmt;
359     break;
360 
361   case Stmt::LabelStmtClass:
362     K = CXCursor_LabelStmt;
363     break;
364 
365   case Stmt::AttributedStmtClass:
366     K = CXCursor_UnexposedStmt;
367     break;
368 
369   case Stmt::DeclStmtClass:
370     K = CXCursor_DeclStmt;
371     break;
372 
373   case Stmt::CapturedStmtClass:
374     K = CXCursor_UnexposedStmt;
375     break;
376 
377   case Stmt::IntegerLiteralClass:
378     K = CXCursor_IntegerLiteral;
379     break;
380 
381   case Stmt::FixedPointLiteralClass:
382     K = CXCursor_FixedPointLiteral;
383     break;
384 
385   case Stmt::FloatingLiteralClass:
386     K = CXCursor_FloatingLiteral;
387     break;
388 
389   case Stmt::ImaginaryLiteralClass:
390     K = CXCursor_ImaginaryLiteral;
391     break;
392 
393   case Stmt::StringLiteralClass:
394     K = CXCursor_StringLiteral;
395     break;
396 
397   case Stmt::CharacterLiteralClass:
398     K = CXCursor_CharacterLiteral;
399     break;
400 
401   case Stmt::ConstantExprClass:
402     return MakeCXCursor(cast<ConstantExpr>(S)->getSubExpr(), Parent, TU,
403                         RegionOfInterest);
404 
405   case Stmt::ParenExprClass:
406     K = CXCursor_ParenExpr;
407     break;
408 
409   case Stmt::UnaryOperatorClass:
410     K = CXCursor_UnaryOperator;
411     break;
412 
413   case Stmt::UnaryExprOrTypeTraitExprClass:
414   case Stmt::CXXNoexceptExprClass:
415     K = CXCursor_UnaryExpr;
416     break;
417 
418   case Stmt::MSPropertySubscriptExprClass:
419   case Stmt::ArraySubscriptExprClass:
420     K = CXCursor_ArraySubscriptExpr;
421     break;
422 
423   case Stmt::MatrixSubscriptExprClass:
424     // TODO: add support for MatrixSubscriptExpr.
425     K = CXCursor_UnexposedExpr;
426     break;
427 
428   case Stmt::OMPArraySectionExprClass:
429     K = CXCursor_OMPArraySectionExpr;
430     break;
431 
432   case Stmt::OMPArrayShapingExprClass:
433     K = CXCursor_OMPArrayShapingExpr;
434     break;
435 
436   case Stmt::OMPIteratorExprClass:
437     K = CXCursor_OMPIteratorExpr;
438     break;
439 
440   case Stmt::BinaryOperatorClass:
441     K = CXCursor_BinaryOperator;
442     break;
443 
444   case Stmt::CompoundAssignOperatorClass:
445     K = CXCursor_CompoundAssignOperator;
446     break;
447 
448   case Stmt::ConditionalOperatorClass:
449     K = CXCursor_ConditionalOperator;
450     break;
451 
452   case Stmt::CStyleCastExprClass:
453     K = CXCursor_CStyleCastExpr;
454     break;
455 
456   case Stmt::CompoundLiteralExprClass:
457     K = CXCursor_CompoundLiteralExpr;
458     break;
459 
460   case Stmt::InitListExprClass:
461     K = CXCursor_InitListExpr;
462     break;
463 
464   case Stmt::AddrLabelExprClass:
465     K = CXCursor_AddrLabelExpr;
466     break;
467 
468   case Stmt::StmtExprClass:
469     K = CXCursor_StmtExpr;
470     break;
471 
472   case Stmt::GenericSelectionExprClass:
473     K = CXCursor_GenericSelectionExpr;
474     break;
475 
476   case Stmt::GNUNullExprClass:
477     K = CXCursor_GNUNullExpr;
478     break;
479 
480   case Stmt::CXXStaticCastExprClass:
481     K = CXCursor_CXXStaticCastExpr;
482     break;
483 
484   case Stmt::CXXDynamicCastExprClass:
485     K = CXCursor_CXXDynamicCastExpr;
486     break;
487 
488   case Stmt::CXXReinterpretCastExprClass:
489     K = CXCursor_CXXReinterpretCastExpr;
490     break;
491 
492   case Stmt::CXXConstCastExprClass:
493     K = CXCursor_CXXConstCastExpr;
494     break;
495 
496   case Stmt::CXXFunctionalCastExprClass:
497     K = CXCursor_CXXFunctionalCastExpr;
498     break;
499 
500   case Stmt::CXXAddrspaceCastExprClass:
501     K = CXCursor_CXXAddrspaceCastExpr;
502     break;
503 
504   case Stmt::CXXTypeidExprClass:
505     K = CXCursor_CXXTypeidExpr;
506     break;
507 
508   case Stmt::CXXBoolLiteralExprClass:
509     K = CXCursor_CXXBoolLiteralExpr;
510     break;
511 
512   case Stmt::CXXNullPtrLiteralExprClass:
513     K = CXCursor_CXXNullPtrLiteralExpr;
514     break;
515 
516   case Stmt::CXXThisExprClass:
517     K = CXCursor_CXXThisExpr;
518     break;
519 
520   case Stmt::CXXThrowExprClass:
521     K = CXCursor_CXXThrowExpr;
522     break;
523 
524   case Stmt::CXXNewExprClass:
525     K = CXCursor_CXXNewExpr;
526     break;
527 
528   case Stmt::CXXDeleteExprClass:
529     K = CXCursor_CXXDeleteExpr;
530     break;
531 
532   case Stmt::ObjCStringLiteralClass:
533     K = CXCursor_ObjCStringLiteral;
534     break;
535 
536   case Stmt::ObjCEncodeExprClass:
537     K = CXCursor_ObjCEncodeExpr;
538     break;
539 
540   case Stmt::ObjCSelectorExprClass:
541     K = CXCursor_ObjCSelectorExpr;
542     break;
543 
544   case Stmt::ObjCProtocolExprClass:
545     K = CXCursor_ObjCProtocolExpr;
546     break;
547 
548   case Stmt::ObjCBoolLiteralExprClass:
549     K = CXCursor_ObjCBoolLiteralExpr;
550     break;
551 
552   case Stmt::ObjCAvailabilityCheckExprClass:
553     K = CXCursor_ObjCAvailabilityCheckExpr;
554     break;
555 
556   case Stmt::ObjCBridgedCastExprClass:
557     K = CXCursor_ObjCBridgedCastExpr;
558     break;
559 
560   case Stmt::BlockExprClass:
561     K = CXCursor_BlockExpr;
562     break;
563 
564   case Stmt::PackExpansionExprClass:
565     K = CXCursor_PackExpansionExpr;
566     break;
567 
568   case Stmt::SizeOfPackExprClass:
569     K = CXCursor_SizeOfPackExpr;
570     break;
571 
572   case Stmt::DeclRefExprClass:
573     if (const ImplicitParamDecl *IPD = dyn_cast_or_null<ImplicitParamDecl>(
574             cast<DeclRefExpr>(S)->getDecl())) {
575       if (const ObjCMethodDecl *MD =
576               dyn_cast<ObjCMethodDecl>(IPD->getDeclContext())) {
577         if (MD->getSelfDecl() == IPD) {
578           K = CXCursor_ObjCSelfExpr;
579           break;
580         }
581       }
582     }
583 
584     K = CXCursor_DeclRefExpr;
585     break;
586 
587   case Stmt::DependentScopeDeclRefExprClass:
588   case Stmt::SubstNonTypeTemplateParmExprClass:
589   case Stmt::SubstNonTypeTemplateParmPackExprClass:
590   case Stmt::FunctionParmPackExprClass:
591   case Stmt::UnresolvedLookupExprClass:
592   case Stmt::TypoExprClass: // A typo could actually be a DeclRef or a MemberRef
593     K = CXCursor_DeclRefExpr;
594     break;
595 
596   case Stmt::CXXDependentScopeMemberExprClass:
597   case Stmt::CXXPseudoDestructorExprClass:
598   case Stmt::MemberExprClass:
599   case Stmt::MSPropertyRefExprClass:
600   case Stmt::ObjCIsaExprClass:
601   case Stmt::ObjCIvarRefExprClass:
602   case Stmt::ObjCPropertyRefExprClass:
603   case Stmt::UnresolvedMemberExprClass:
604     K = CXCursor_MemberRefExpr;
605     break;
606 
607   case Stmt::CallExprClass:
608   case Stmt::CXXOperatorCallExprClass:
609   case Stmt::CXXMemberCallExprClass:
610   case Stmt::CUDAKernelCallExprClass:
611   case Stmt::CXXConstructExprClass:
612   case Stmt::CXXInheritedCtorInitExprClass:
613   case Stmt::CXXTemporaryObjectExprClass:
614   case Stmt::CXXUnresolvedConstructExprClass:
615   case Stmt::UserDefinedLiteralClass:
616     K = CXCursor_CallExpr;
617     break;
618 
619   case Stmt::LambdaExprClass:
620     K = CXCursor_LambdaExpr;
621     break;
622 
623   case Stmt::ObjCMessageExprClass: {
624     K = CXCursor_ObjCMessageExpr;
625     int SelectorIdIndex = -1;
626     // Check if cursor points to a selector id.
627     if (RegionOfInterest.isValid() &&
628         RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) {
629       SmallVector<SourceLocation, 16> SelLocs;
630       cast<ObjCMessageExpr>(S)->getSelectorLocs(SelLocs);
631       SmallVectorImpl<SourceLocation>::iterator I =
632           llvm::find(SelLocs, RegionOfInterest.getBegin());
633       if (I != SelLocs.end())
634         SelectorIdIndex = I - SelLocs.begin();
635     }
636     CXCursor C = {K, 0, {Parent, S, TU}};
637     return getSelectorIdentifierCursor(SelectorIdIndex, C);
638   }
639 
640   case Stmt::MSDependentExistsStmtClass:
641     K = CXCursor_UnexposedStmt;
642     break;
643   case Stmt::OMPCanonicalLoopClass:
644     K = CXCursor_OMPCanonicalLoop;
645     break;
646   case Stmt::OMPMetaDirectiveClass:
647     K = CXCursor_OMPMetaDirective;
648     break;
649   case Stmt::OMPParallelDirectiveClass:
650     K = CXCursor_OMPParallelDirective;
651     break;
652   case Stmt::OMPSimdDirectiveClass:
653     K = CXCursor_OMPSimdDirective;
654     break;
655   case Stmt::OMPTileDirectiveClass:
656     K = CXCursor_OMPTileDirective;
657     break;
658   case Stmt::OMPUnrollDirectiveClass:
659     K = CXCursor_OMPUnrollDirective;
660     break;
661   case Stmt::OMPForDirectiveClass:
662     K = CXCursor_OMPForDirective;
663     break;
664   case Stmt::OMPForSimdDirectiveClass:
665     K = CXCursor_OMPForSimdDirective;
666     break;
667   case Stmt::OMPSectionsDirectiveClass:
668     K = CXCursor_OMPSectionsDirective;
669     break;
670   case Stmt::OMPSectionDirectiveClass:
671     K = CXCursor_OMPSectionDirective;
672     break;
673   case Stmt::OMPSingleDirectiveClass:
674     K = CXCursor_OMPSingleDirective;
675     break;
676   case Stmt::OMPMasterDirectiveClass:
677     K = CXCursor_OMPMasterDirective;
678     break;
679   case Stmt::OMPCriticalDirectiveClass:
680     K = CXCursor_OMPCriticalDirective;
681     break;
682   case Stmt::OMPParallelForDirectiveClass:
683     K = CXCursor_OMPParallelForDirective;
684     break;
685   case Stmt::OMPParallelForSimdDirectiveClass:
686     K = CXCursor_OMPParallelForSimdDirective;
687     break;
688   case Stmt::OMPParallelMasterDirectiveClass:
689     K = CXCursor_OMPParallelMasterDirective;
690     break;
691   case Stmt::OMPParallelSectionsDirectiveClass:
692     K = CXCursor_OMPParallelSectionsDirective;
693     break;
694   case Stmt::OMPTaskDirectiveClass:
695     K = CXCursor_OMPTaskDirective;
696     break;
697   case Stmt::OMPTaskyieldDirectiveClass:
698     K = CXCursor_OMPTaskyieldDirective;
699     break;
700   case Stmt::OMPBarrierDirectiveClass:
701     K = CXCursor_OMPBarrierDirective;
702     break;
703   case Stmt::OMPTaskwaitDirectiveClass:
704     K = CXCursor_OMPTaskwaitDirective;
705     break;
706   case Stmt::OMPTaskgroupDirectiveClass:
707     K = CXCursor_OMPTaskgroupDirective;
708     break;
709   case Stmt::OMPFlushDirectiveClass:
710     K = CXCursor_OMPFlushDirective;
711     break;
712   case Stmt::OMPDepobjDirectiveClass:
713     K = CXCursor_OMPDepobjDirective;
714     break;
715   case Stmt::OMPScanDirectiveClass:
716     K = CXCursor_OMPScanDirective;
717     break;
718   case Stmt::OMPOrderedDirectiveClass:
719     K = CXCursor_OMPOrderedDirective;
720     break;
721   case Stmt::OMPAtomicDirectiveClass:
722     K = CXCursor_OMPAtomicDirective;
723     break;
724   case Stmt::OMPTargetDirectiveClass:
725     K = CXCursor_OMPTargetDirective;
726     break;
727   case Stmt::OMPTargetDataDirectiveClass:
728     K = CXCursor_OMPTargetDataDirective;
729     break;
730   case Stmt::OMPTargetEnterDataDirectiveClass:
731     K = CXCursor_OMPTargetEnterDataDirective;
732     break;
733   case Stmt::OMPTargetExitDataDirectiveClass:
734     K = CXCursor_OMPTargetExitDataDirective;
735     break;
736   case Stmt::OMPTargetParallelDirectiveClass:
737     K = CXCursor_OMPTargetParallelDirective;
738     break;
739   case Stmt::OMPTargetParallelForDirectiveClass:
740     K = CXCursor_OMPTargetParallelForDirective;
741     break;
742   case Stmt::OMPTargetUpdateDirectiveClass:
743     K = CXCursor_OMPTargetUpdateDirective;
744     break;
745   case Stmt::OMPTeamsDirectiveClass:
746     K = CXCursor_OMPTeamsDirective;
747     break;
748   case Stmt::OMPCancellationPointDirectiveClass:
749     K = CXCursor_OMPCancellationPointDirective;
750     break;
751   case Stmt::OMPCancelDirectiveClass:
752     K = CXCursor_OMPCancelDirective;
753     break;
754   case Stmt::OMPTaskLoopDirectiveClass:
755     K = CXCursor_OMPTaskLoopDirective;
756     break;
757   case Stmt::OMPTaskLoopSimdDirectiveClass:
758     K = CXCursor_OMPTaskLoopSimdDirective;
759     break;
760   case Stmt::OMPMasterTaskLoopDirectiveClass:
761     K = CXCursor_OMPMasterTaskLoopDirective;
762     break;
763   case Stmt::OMPMasterTaskLoopSimdDirectiveClass:
764     K = CXCursor_OMPMasterTaskLoopSimdDirective;
765     break;
766   case Stmt::OMPParallelMasterTaskLoopDirectiveClass:
767     K = CXCursor_OMPParallelMasterTaskLoopDirective;
768     break;
769   case Stmt::OMPParallelMasterTaskLoopSimdDirectiveClass:
770     K = CXCursor_OMPParallelMasterTaskLoopSimdDirective;
771     break;
772   case Stmt::OMPDistributeDirectiveClass:
773     K = CXCursor_OMPDistributeDirective;
774     break;
775   case Stmt::OMPDistributeParallelForDirectiveClass:
776     K = CXCursor_OMPDistributeParallelForDirective;
777     break;
778   case Stmt::OMPDistributeParallelForSimdDirectiveClass:
779     K = CXCursor_OMPDistributeParallelForSimdDirective;
780     break;
781   case Stmt::OMPDistributeSimdDirectiveClass:
782     K = CXCursor_OMPDistributeSimdDirective;
783     break;
784   case Stmt::OMPTargetParallelForSimdDirectiveClass:
785     K = CXCursor_OMPTargetParallelForSimdDirective;
786     break;
787   case Stmt::OMPTargetSimdDirectiveClass:
788     K = CXCursor_OMPTargetSimdDirective;
789     break;
790   case Stmt::OMPTeamsDistributeDirectiveClass:
791     K = CXCursor_OMPTeamsDistributeDirective;
792     break;
793   case Stmt::OMPTeamsDistributeSimdDirectiveClass:
794     K = CXCursor_OMPTeamsDistributeSimdDirective;
795     break;
796   case Stmt::OMPTeamsDistributeParallelForSimdDirectiveClass:
797     K = CXCursor_OMPTeamsDistributeParallelForSimdDirective;
798     break;
799   case Stmt::OMPTeamsDistributeParallelForDirectiveClass:
800     K = CXCursor_OMPTeamsDistributeParallelForDirective;
801     break;
802   case Stmt::OMPTargetTeamsDirectiveClass:
803     K = CXCursor_OMPTargetTeamsDirective;
804     break;
805   case Stmt::OMPTargetTeamsDistributeDirectiveClass:
806     K = CXCursor_OMPTargetTeamsDistributeDirective;
807     break;
808   case Stmt::OMPTargetTeamsDistributeParallelForDirectiveClass:
809     K = CXCursor_OMPTargetTeamsDistributeParallelForDirective;
810     break;
811   case Stmt::OMPTargetTeamsDistributeParallelForSimdDirectiveClass:
812     K = CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective;
813     break;
814   case Stmt::OMPTargetTeamsDistributeSimdDirectiveClass:
815     K = CXCursor_OMPTargetTeamsDistributeSimdDirective;
816     break;
817   case Stmt::OMPInteropDirectiveClass:
818     K = CXCursor_OMPInteropDirective;
819     break;
820   case Stmt::OMPDispatchDirectiveClass:
821     K = CXCursor_OMPDispatchDirective;
822     break;
823   case Stmt::OMPMaskedDirectiveClass:
824     K = CXCursor_OMPMaskedDirective;
825     break;
826   case Stmt::OMPGenericLoopDirectiveClass:
827     K = CXCursor_OMPGenericLoopDirective;
828     break;
829   case Stmt::OMPTeamsGenericLoopDirectiveClass:
830     K = CXCursor_OMPTeamsGenericLoopDirective;
831     break;
832   case Stmt::OMPTargetTeamsGenericLoopDirectiveClass:
833     K = CXCursor_OMPTargetTeamsGenericLoopDirective;
834     break;
835   case Stmt::OMPParallelGenericLoopDirectiveClass:
836     K = CXCursor_OMPParallelGenericLoopDirective;
837     break;
838   case Stmt::OMPTargetParallelGenericLoopDirectiveClass:
839     K = CXCursor_OMPTargetParallelGenericLoopDirective;
840     break;
841   case Stmt::BuiltinBitCastExprClass:
842     K = CXCursor_BuiltinBitCastExpr;
843   }
844 
845   CXCursor C = {K, 0, {Parent, S, TU}};
846   return C;
847 }
848 
849 CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super,
850                                                SourceLocation Loc,
851                                                CXTranslationUnit TU) {
852   assert(Super && TU && "Invalid arguments!");
853   void *RawLoc = Loc.getPtrEncoding();
854   CXCursor C = {CXCursor_ObjCSuperClassRef, 0, {Super, RawLoc, TU}};
855   return C;
856 }
857 
858 std::pair<const ObjCInterfaceDecl *, SourceLocation>
859 cxcursor::getCursorObjCSuperClassRef(CXCursor C) {
860   assert(C.kind == CXCursor_ObjCSuperClassRef);
861   return std::make_pair(static_cast<const ObjCInterfaceDecl *>(C.data[0]),
862                         SourceLocation::getFromPtrEncoding(C.data[1]));
863 }
864 
865 CXCursor cxcursor::MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto,
866                                              SourceLocation Loc,
867                                              CXTranslationUnit TU) {
868   assert(Proto && TU && "Invalid arguments!");
869   void *RawLoc = Loc.getPtrEncoding();
870   CXCursor C = {CXCursor_ObjCProtocolRef, 0, {Proto, RawLoc, TU}};
871   return C;
872 }
873 
874 std::pair<const ObjCProtocolDecl *, SourceLocation>
875 cxcursor::getCursorObjCProtocolRef(CXCursor C) {
876   assert(C.kind == CXCursor_ObjCProtocolRef);
877   return std::make_pair(static_cast<const ObjCProtocolDecl *>(C.data[0]),
878                         SourceLocation::getFromPtrEncoding(C.data[1]));
879 }
880 
881 CXCursor cxcursor::MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class,
882                                           SourceLocation Loc,
883                                           CXTranslationUnit TU) {
884   // 'Class' can be null for invalid code.
885   if (!Class)
886     return MakeCXCursorInvalid(CXCursor_InvalidCode);
887   assert(TU && "Invalid arguments!");
888   void *RawLoc = Loc.getPtrEncoding();
889   CXCursor C = {CXCursor_ObjCClassRef, 0, {Class, RawLoc, TU}};
890   return C;
891 }
892 
893 std::pair<const ObjCInterfaceDecl *, SourceLocation>
894 cxcursor::getCursorObjCClassRef(CXCursor C) {
895   assert(C.kind == CXCursor_ObjCClassRef);
896   return std::make_pair(static_cast<const ObjCInterfaceDecl *>(C.data[0]),
897                         SourceLocation::getFromPtrEncoding(C.data[1]));
898 }
899 
900 CXCursor cxcursor::MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc,
901                                      CXTranslationUnit TU) {
902   assert(Type && TU && "Invalid arguments!");
903   void *RawLoc = Loc.getPtrEncoding();
904   CXCursor C = {CXCursor_TypeRef, 0, {Type, RawLoc, TU}};
905   return C;
906 }
907 
908 std::pair<const TypeDecl *, SourceLocation>
909 cxcursor::getCursorTypeRef(CXCursor C) {
910   assert(C.kind == CXCursor_TypeRef);
911   return std::make_pair(static_cast<const TypeDecl *>(C.data[0]),
912                         SourceLocation::getFromPtrEncoding(C.data[1]));
913 }
914 
915 CXCursor cxcursor::MakeCursorTemplateRef(const TemplateDecl *Template,
916                                          SourceLocation Loc,
917                                          CXTranslationUnit TU) {
918   assert(Template && TU && "Invalid arguments!");
919   void *RawLoc = Loc.getPtrEncoding();
920   CXCursor C = {CXCursor_TemplateRef, 0, {Template, RawLoc, TU}};
921   return C;
922 }
923 
924 std::pair<const TemplateDecl *, SourceLocation>
925 cxcursor::getCursorTemplateRef(CXCursor C) {
926   assert(C.kind == CXCursor_TemplateRef);
927   return std::make_pair(static_cast<const TemplateDecl *>(C.data[0]),
928                         SourceLocation::getFromPtrEncoding(C.data[1]));
929 }
930 
931 CXCursor cxcursor::MakeCursorNamespaceRef(const NamedDecl *NS,
932                                           SourceLocation Loc,
933                                           CXTranslationUnit TU) {
934 
935   assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU &&
936          "Invalid arguments!");
937   void *RawLoc = Loc.getPtrEncoding();
938   CXCursor C = {CXCursor_NamespaceRef, 0, {NS, RawLoc, TU}};
939   return C;
940 }
941 
942 std::pair<const NamedDecl *, SourceLocation>
943 cxcursor::getCursorNamespaceRef(CXCursor C) {
944   assert(C.kind == CXCursor_NamespaceRef);
945   return std::make_pair(static_cast<const NamedDecl *>(C.data[0]),
946                         SourceLocation::getFromPtrEncoding(C.data[1]));
947 }
948 
949 CXCursor cxcursor::MakeCursorVariableRef(const VarDecl *Var, SourceLocation Loc,
950                                          CXTranslationUnit TU) {
951 
952   assert(Var && TU && "Invalid arguments!");
953   void *RawLoc = Loc.getPtrEncoding();
954   CXCursor C = {CXCursor_VariableRef, 0, {Var, RawLoc, TU}};
955   return C;
956 }
957 
958 std::pair<const VarDecl *, SourceLocation>
959 cxcursor::getCursorVariableRef(CXCursor C) {
960   assert(C.kind == CXCursor_VariableRef);
961   return std::make_pair(static_cast<const VarDecl *>(C.data[0]),
962                         SourceLocation::getFromPtrEncoding(C.data[1]));
963 }
964 
965 CXCursor cxcursor::MakeCursorMemberRef(const FieldDecl *Field,
966                                        SourceLocation Loc,
967                                        CXTranslationUnit TU) {
968 
969   assert(Field && TU && "Invalid arguments!");
970   void *RawLoc = Loc.getPtrEncoding();
971   CXCursor C = {CXCursor_MemberRef, 0, {Field, RawLoc, TU}};
972   return C;
973 }
974 
975 std::pair<const FieldDecl *, SourceLocation>
976 cxcursor::getCursorMemberRef(CXCursor C) {
977   assert(C.kind == CXCursor_MemberRef);
978   return std::make_pair(static_cast<const FieldDecl *>(C.data[0]),
979                         SourceLocation::getFromPtrEncoding(C.data[1]));
980 }
981 
982 CXCursor cxcursor::MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B,
983                                               CXTranslationUnit TU) {
984   CXCursor C = {CXCursor_CXXBaseSpecifier, 0, {B, nullptr, TU}};
985   return C;
986 }
987 
988 const CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) {
989   assert(C.kind == CXCursor_CXXBaseSpecifier);
990   return static_cast<const CXXBaseSpecifier *>(C.data[0]);
991 }
992 
993 CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range,
994                                                     CXTranslationUnit TU) {
995   CXCursor C = {
996       CXCursor_PreprocessingDirective,
997       0,
998       {Range.getBegin().getPtrEncoding(), Range.getEnd().getPtrEncoding(), TU}};
999   return C;
1000 }
1001 
1002 SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) {
1003   assert(C.kind == CXCursor_PreprocessingDirective);
1004   SourceRange Range(SourceLocation::getFromPtrEncoding(C.data[0]),
1005                     SourceLocation::getFromPtrEncoding(C.data[1]));
1006   ASTUnit *TU = getCursorASTUnit(C);
1007   return TU->mapRangeFromPreamble(Range);
1008 }
1009 
1010 CXCursor cxcursor::MakeMacroDefinitionCursor(const MacroDefinitionRecord *MI,
1011                                              CXTranslationUnit TU) {
1012   CXCursor C = {CXCursor_MacroDefinition, 0, {MI, nullptr, TU}};
1013   return C;
1014 }
1015 
1016 const MacroDefinitionRecord *cxcursor::getCursorMacroDefinition(CXCursor C) {
1017   assert(C.kind == CXCursor_MacroDefinition);
1018   return static_cast<const MacroDefinitionRecord *>(C.data[0]);
1019 }
1020 
1021 CXCursor cxcursor::MakeMacroExpansionCursor(MacroExpansion *MI,
1022                                             CXTranslationUnit TU) {
1023   CXCursor C = {CXCursor_MacroExpansion, 0, {MI, nullptr, TU}};
1024   return C;
1025 }
1026 
1027 CXCursor cxcursor::MakeMacroExpansionCursor(MacroDefinitionRecord *MI,
1028                                             SourceLocation Loc,
1029                                             CXTranslationUnit TU) {
1030   assert(Loc.isValid());
1031   CXCursor C = {CXCursor_MacroExpansion, 0, {MI, Loc.getPtrEncoding(), TU}};
1032   return C;
1033 }
1034 
1035 const IdentifierInfo *cxcursor::MacroExpansionCursor::getName() const {
1036   if (isPseudo())
1037     return getAsMacroDefinition()->getName();
1038   return getAsMacroExpansion()->getName();
1039 }
1040 const MacroDefinitionRecord *
1041 cxcursor::MacroExpansionCursor::getDefinition() const {
1042   if (isPseudo())
1043     return getAsMacroDefinition();
1044   return getAsMacroExpansion()->getDefinition();
1045 }
1046 SourceRange cxcursor::MacroExpansionCursor::getSourceRange() const {
1047   if (isPseudo())
1048     return getPseudoLoc();
1049   return getAsMacroExpansion()->getSourceRange();
1050 }
1051 
1052 CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID,
1053                                                 CXTranslationUnit TU) {
1054   CXCursor C = {CXCursor_InclusionDirective, 0, {ID, nullptr, TU}};
1055   return C;
1056 }
1057 
1058 const InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) {
1059   assert(C.kind == CXCursor_InclusionDirective);
1060   return static_cast<const InclusionDirective *>(C.data[0]);
1061 }
1062 
1063 CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc,
1064                                       CXTranslationUnit TU) {
1065 
1066   assert(Label && TU && "Invalid arguments!");
1067   void *RawLoc = Loc.getPtrEncoding();
1068   CXCursor C = {CXCursor_LabelRef, 0, {Label, RawLoc, TU}};
1069   return C;
1070 }
1071 
1072 std::pair<const LabelStmt *, SourceLocation>
1073 cxcursor::getCursorLabelRef(CXCursor C) {
1074   assert(C.kind == CXCursor_LabelRef);
1075   return std::make_pair(static_cast<const LabelStmt *>(C.data[0]),
1076                         SourceLocation::getFromPtrEncoding(C.data[1]));
1077 }
1078 
1079 CXCursor cxcursor::MakeCursorOverloadedDeclRef(const OverloadExpr *E,
1080                                                CXTranslationUnit TU) {
1081   assert(E && TU && "Invalid arguments!");
1082   OverloadedDeclRefStorage Storage(E);
1083   void *RawLoc = E->getNameLoc().getPtrEncoding();
1084   CXCursor C = {
1085       CXCursor_OverloadedDeclRef, 0, {Storage.getOpaqueValue(), RawLoc, TU}};
1086   return C;
1087 }
1088 
1089 CXCursor cxcursor::MakeCursorOverloadedDeclRef(const Decl *D,
1090                                                SourceLocation Loc,
1091                                                CXTranslationUnit TU) {
1092   assert(D && TU && "Invalid arguments!");
1093   void *RawLoc = Loc.getPtrEncoding();
1094   OverloadedDeclRefStorage Storage(D);
1095   CXCursor C = {
1096       CXCursor_OverloadedDeclRef, 0, {Storage.getOpaqueValue(), RawLoc, TU}};
1097   return C;
1098 }
1099 
1100 CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name,
1101                                                SourceLocation Loc,
1102                                                CXTranslationUnit TU) {
1103   assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!");
1104   void *RawLoc = Loc.getPtrEncoding();
1105   OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate());
1106   CXCursor C = {
1107       CXCursor_OverloadedDeclRef, 0, {Storage.getOpaqueValue(), RawLoc, TU}};
1108   return C;
1109 }
1110 
1111 std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation>
1112 cxcursor::getCursorOverloadedDeclRef(CXCursor C) {
1113   assert(C.kind == CXCursor_OverloadedDeclRef);
1114   return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue(
1115                             const_cast<void *>(C.data[0])),
1116                         SourceLocation::getFromPtrEncoding(C.data[1]));
1117 }
1118 
1119 const Decl *cxcursor::getCursorDecl(CXCursor Cursor) {
1120   return static_cast<const Decl *>(Cursor.data[0]);
1121 }
1122 
1123 const Expr *cxcursor::getCursorExpr(CXCursor Cursor) {
1124   return dyn_cast_or_null<Expr>(getCursorStmt(Cursor));
1125 }
1126 
1127 const Stmt *cxcursor::getCursorStmt(CXCursor Cursor) {
1128   if (Cursor.kind == CXCursor_ObjCSuperClassRef ||
1129       Cursor.kind == CXCursor_ObjCProtocolRef ||
1130       Cursor.kind == CXCursor_ObjCClassRef)
1131     return nullptr;
1132 
1133   return static_cast<const Stmt *>(Cursor.data[1]);
1134 }
1135 
1136 const Attr *cxcursor::getCursorAttr(CXCursor Cursor) {
1137   return static_cast<const Attr *>(Cursor.data[1]);
1138 }
1139 
1140 ASTContext &cxcursor::getCursorContext(CXCursor Cursor) {
1141   return getCursorASTUnit(Cursor)->getASTContext();
1142 }
1143 
1144 ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) {
1145   CXTranslationUnit TU = getCursorTU(Cursor);
1146   if (!TU)
1147     return nullptr;
1148   return cxtu::getASTUnit(TU);
1149 }
1150 
1151 CXTranslationUnit cxcursor::getCursorTU(CXCursor Cursor) {
1152   return static_cast<CXTranslationUnit>(const_cast<void *>(Cursor.data[2]));
1153 }
1154 
1155 void cxcursor::getOverriddenCursors(CXCursor cursor,
1156                                     SmallVectorImpl<CXCursor> &overridden) {
1157   assert(clang_isDeclaration(cursor.kind));
1158   const NamedDecl *D = dyn_cast_or_null<NamedDecl>(getCursorDecl(cursor));
1159   if (!D)
1160     return;
1161 
1162   CXTranslationUnit TU = getCursorTU(cursor);
1163   SmallVector<const NamedDecl *, 8> OverDecls;
1164   D->getASTContext().getOverriddenMethods(D, OverDecls);
1165 
1166   for (SmallVectorImpl<const NamedDecl *>::iterator I = OverDecls.begin(),
1167                                                     E = OverDecls.end();
1168        I != E; ++I) {
1169     overridden.push_back(MakeCXCursor(*I, TU));
1170   }
1171 }
1172 
1173 std::pair<int, SourceLocation>
1174 cxcursor::getSelectorIdentifierIndexAndLoc(CXCursor cursor) {
1175   if (cursor.kind == CXCursor_ObjCMessageExpr) {
1176     if (cursor.xdata != -1)
1177       return std::make_pair(cursor.xdata,
1178                             cast<ObjCMessageExpr>(getCursorExpr(cursor))
1179                                 ->getSelectorLoc(cursor.xdata));
1180   } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
1181              cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
1182     if (cursor.xdata != -1)
1183       return std::make_pair(cursor.xdata,
1184                             cast<ObjCMethodDecl>(getCursorDecl(cursor))
1185                                 ->getSelectorLoc(cursor.xdata));
1186   }
1187 
1188   return std::make_pair(-1, SourceLocation());
1189 }
1190 
1191 CXCursor cxcursor::getSelectorIdentifierCursor(int SelIdx, CXCursor cursor) {
1192   CXCursor newCursor = cursor;
1193 
1194   if (cursor.kind == CXCursor_ObjCMessageExpr) {
1195     if (SelIdx == -1 ||
1196         unsigned(SelIdx) >=
1197             cast<ObjCMessageExpr>(getCursorExpr(cursor))->getNumSelectorLocs())
1198       newCursor.xdata = -1;
1199     else
1200       newCursor.xdata = SelIdx;
1201   } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
1202              cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
1203     if (SelIdx == -1 ||
1204         unsigned(SelIdx) >=
1205             cast<ObjCMethodDecl>(getCursorDecl(cursor))->getNumSelectorLocs())
1206       newCursor.xdata = -1;
1207     else
1208       newCursor.xdata = SelIdx;
1209   }
1210 
1211   return newCursor;
1212 }
1213 
1214 CXCursor cxcursor::getTypeRefCursor(CXCursor cursor) {
1215   if (cursor.kind != CXCursor_CallExpr)
1216     return cursor;
1217 
1218   if (cursor.xdata == 0)
1219     return cursor;
1220 
1221   const Expr *E = getCursorExpr(cursor);
1222   TypeSourceInfo *Type = nullptr;
1223   if (const CXXUnresolvedConstructExpr *UnCtor =
1224           dyn_cast<CXXUnresolvedConstructExpr>(E)) {
1225     Type = UnCtor->getTypeSourceInfo();
1226   } else if (const CXXTemporaryObjectExpr *Tmp =
1227                  dyn_cast<CXXTemporaryObjectExpr>(E)) {
1228     Type = Tmp->getTypeSourceInfo();
1229   }
1230 
1231   if (!Type)
1232     return cursor;
1233 
1234   CXTranslationUnit TU = getCursorTU(cursor);
1235   QualType Ty = Type->getType();
1236   TypeLoc TL = Type->getTypeLoc();
1237   SourceLocation Loc = TL.getBeginLoc();
1238 
1239   if (const ElaboratedType *ElabT = Ty->getAs<ElaboratedType>()) {
1240     Ty = ElabT->getNamedType();
1241     ElaboratedTypeLoc ElabTL = TL.castAs<ElaboratedTypeLoc>();
1242     Loc = ElabTL.getNamedTypeLoc().getBeginLoc();
1243   }
1244 
1245   if (const TypedefType *Typedef = Ty->getAs<TypedefType>())
1246     return MakeCursorTypeRef(Typedef->getDecl(), Loc, TU);
1247   if (const TagType *Tag = Ty->getAs<TagType>())
1248     return MakeCursorTypeRef(Tag->getDecl(), Loc, TU);
1249   if (const TemplateTypeParmType *TemplP = Ty->getAs<TemplateTypeParmType>())
1250     return MakeCursorTypeRef(TemplP->getDecl(), Loc, TU);
1251 
1252   return cursor;
1253 }
1254 
1255 bool cxcursor::operator==(CXCursor X, CXCursor Y) {
1256   return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] &&
1257          X.data[2] == Y.data[2];
1258 }
1259 
1260 // FIXME: Remove once we can model DeclGroups and their appropriate ranges
1261 // properly in the ASTs.
1262 bool cxcursor::isFirstInDeclGroup(CXCursor C) {
1263   assert(clang_isDeclaration(C.kind));
1264   return ((uintptr_t)(C.data[1])) != 0;
1265 }
1266 
1267 //===----------------------------------------------------------------------===//
1268 // libclang CXCursor APIs
1269 //===----------------------------------------------------------------------===//
1270 
1271 int clang_Cursor_isNull(CXCursor cursor) {
1272   return clang_equalCursors(cursor, clang_getNullCursor());
1273 }
1274 
1275 CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor cursor) {
1276   return getCursorTU(cursor);
1277 }
1278 
1279 int clang_Cursor_getNumArguments(CXCursor C) {
1280   if (clang_isDeclaration(C.kind)) {
1281     const Decl *D = cxcursor::getCursorDecl(C);
1282     if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D))
1283       return MD->param_size();
1284     if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
1285       return FD->param_size();
1286   }
1287 
1288   if (clang_isExpression(C.kind)) {
1289     const Expr *E = cxcursor::getCursorExpr(C);
1290     if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
1291       return CE->getNumArgs();
1292     }
1293     if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E)) {
1294       return CE->getNumArgs();
1295     }
1296   }
1297 
1298   return -1;
1299 }
1300 
1301 CXCursor clang_Cursor_getArgument(CXCursor C, unsigned i) {
1302   if (clang_isDeclaration(C.kind)) {
1303     const Decl *D = cxcursor::getCursorDecl(C);
1304     if (const ObjCMethodDecl *MD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
1305       if (i < MD->param_size())
1306         return cxcursor::MakeCXCursor(MD->parameters()[i],
1307                                       cxcursor::getCursorTU(C));
1308     } else if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
1309       if (i < FD->param_size())
1310         return cxcursor::MakeCXCursor(FD->parameters()[i],
1311                                       cxcursor::getCursorTU(C));
1312     }
1313   }
1314 
1315   if (clang_isExpression(C.kind)) {
1316     const Expr *E = cxcursor::getCursorExpr(C);
1317     if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
1318       if (i < CE->getNumArgs()) {
1319         return cxcursor::MakeCXCursor(CE->getArg(i), getCursorDecl(C),
1320                                       cxcursor::getCursorTU(C));
1321       }
1322     }
1323     if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E)) {
1324       if (i < CE->getNumArgs()) {
1325         return cxcursor::MakeCXCursor(CE->getArg(i), getCursorDecl(C),
1326                                       cxcursor::getCursorTU(C));
1327       }
1328     }
1329   }
1330 
1331   return clang_getNullCursor();
1332 }
1333 
1334 int clang_Cursor_getNumTemplateArguments(CXCursor C) {
1335   if (clang_getCursorKind(C) != CXCursor_FunctionDecl) {
1336     return -1;
1337   }
1338 
1339   const FunctionDecl *FD =
1340       llvm::dyn_cast_or_null<clang::FunctionDecl>(getCursorDecl(C));
1341   if (!FD) {
1342     return -1;
1343   }
1344 
1345   const FunctionTemplateSpecializationInfo *SpecInfo =
1346       FD->getTemplateSpecializationInfo();
1347   if (!SpecInfo) {
1348     return -1;
1349   }
1350 
1351   return SpecInfo->TemplateArguments->size();
1352 }
1353 
1354 enum CXGetTemplateArgumentStatus {
1355   /** The operation completed successfully */
1356   CXGetTemplateArgumentStatus_Success = 0,
1357 
1358   /** The specified cursor did not represent a FunctionDecl. */
1359   CXGetTemplateArgumentStatus_CursorNotFunctionDecl = -1,
1360 
1361   /** The specified cursor was not castable to a FunctionDecl. */
1362   CXGetTemplateArgumentStatus_BadFunctionDeclCast = -2,
1363 
1364   /** A NULL FunctionTemplateSpecializationInfo was retrieved. */
1365   CXGetTemplateArgumentStatus_NullTemplSpecInfo = -3,
1366 
1367   /** An invalid (OOB) argument index was specified */
1368   CXGetTemplateArgumentStatus_InvalidIndex = -4
1369 };
1370 
1371 static int clang_Cursor_getTemplateArgument(CXCursor C, unsigned I,
1372                                             TemplateArgument *TA) {
1373   if (clang_getCursorKind(C) != CXCursor_FunctionDecl) {
1374     return CXGetTemplateArgumentStatus_CursorNotFunctionDecl;
1375   }
1376 
1377   const FunctionDecl *FD =
1378       llvm::dyn_cast_or_null<clang::FunctionDecl>(getCursorDecl(C));
1379   if (!FD) {
1380     return CXGetTemplateArgumentStatus_BadFunctionDeclCast;
1381   }
1382 
1383   const FunctionTemplateSpecializationInfo *SpecInfo =
1384       FD->getTemplateSpecializationInfo();
1385   if (!SpecInfo) {
1386     return CXGetTemplateArgumentStatus_NullTemplSpecInfo;
1387   }
1388 
1389   if (I >= SpecInfo->TemplateArguments->size()) {
1390     return CXGetTemplateArgumentStatus_InvalidIndex;
1391   }
1392 
1393   *TA = SpecInfo->TemplateArguments->get(I);
1394   return 0;
1395 }
1396 
1397 enum CXTemplateArgumentKind clang_Cursor_getTemplateArgumentKind(CXCursor C,
1398                                                                  unsigned I) {
1399   TemplateArgument TA;
1400   if (clang_Cursor_getTemplateArgument(C, I, &TA)) {
1401     return CXTemplateArgumentKind_Invalid;
1402   }
1403 
1404   switch (TA.getKind()) {
1405   case TemplateArgument::Null:
1406     return CXTemplateArgumentKind_Null;
1407   case TemplateArgument::Type:
1408     return CXTemplateArgumentKind_Type;
1409   case TemplateArgument::Declaration:
1410     return CXTemplateArgumentKind_Declaration;
1411   case TemplateArgument::NullPtr:
1412     return CXTemplateArgumentKind_NullPtr;
1413   case TemplateArgument::Integral:
1414     return CXTemplateArgumentKind_Integral;
1415   case TemplateArgument::Template:
1416     return CXTemplateArgumentKind_Template;
1417   case TemplateArgument::TemplateExpansion:
1418     return CXTemplateArgumentKind_TemplateExpansion;
1419   case TemplateArgument::Expression:
1420     return CXTemplateArgumentKind_Expression;
1421   case TemplateArgument::Pack:
1422     return CXTemplateArgumentKind_Pack;
1423   }
1424 
1425   return CXTemplateArgumentKind_Invalid;
1426 }
1427 
1428 CXType clang_Cursor_getTemplateArgumentType(CXCursor C, unsigned I) {
1429   TemplateArgument TA;
1430   if (clang_Cursor_getTemplateArgument(C, I, &TA) !=
1431       CXGetTemplateArgumentStatus_Success) {
1432     return cxtype::MakeCXType(QualType(), getCursorTU(C));
1433   }
1434 
1435   if (TA.getKind() != TemplateArgument::Type) {
1436     return cxtype::MakeCXType(QualType(), getCursorTU(C));
1437   }
1438 
1439   return cxtype::MakeCXType(TA.getAsType(), getCursorTU(C));
1440 }
1441 
1442 long long clang_Cursor_getTemplateArgumentValue(CXCursor C, unsigned I) {
1443   TemplateArgument TA;
1444   if (clang_Cursor_getTemplateArgument(C, I, &TA) !=
1445       CXGetTemplateArgumentStatus_Success) {
1446     assert(0 && "Unable to retrieve TemplateArgument");
1447     return 0;
1448   }
1449 
1450   if (TA.getKind() != TemplateArgument::Integral) {
1451     assert(0 && "Passed template argument is not Integral");
1452     return 0;
1453   }
1454 
1455   return TA.getAsIntegral().getSExtValue();
1456 }
1457 
1458 unsigned long long clang_Cursor_getTemplateArgumentUnsignedValue(CXCursor C,
1459                                                                  unsigned I) {
1460   TemplateArgument TA;
1461   if (clang_Cursor_getTemplateArgument(C, I, &TA) !=
1462       CXGetTemplateArgumentStatus_Success) {
1463     assert(0 && "Unable to retrieve TemplateArgument");
1464     return 0;
1465   }
1466 
1467   if (TA.getKind() != TemplateArgument::Integral) {
1468     assert(0 && "Passed template argument is not Integral");
1469     return 0;
1470   }
1471 
1472   return TA.getAsIntegral().getZExtValue();
1473 }
1474 
1475 //===----------------------------------------------------------------------===//
1476 // CXCursorSet.
1477 //===----------------------------------------------------------------------===//
1478 
1479 typedef llvm::DenseMap<CXCursor, unsigned> CXCursorSet_Impl;
1480 
1481 static inline CXCursorSet packCXCursorSet(CXCursorSet_Impl *setImpl) {
1482   return (CXCursorSet)setImpl;
1483 }
1484 static inline CXCursorSet_Impl *unpackCXCursorSet(CXCursorSet set) {
1485   return (CXCursorSet_Impl *)set;
1486 }
1487 namespace llvm {
1488 template <> struct DenseMapInfo<CXCursor> {
1489 public:
1490   static inline CXCursor getEmptyKey() {
1491     return MakeCXCursorInvalid(CXCursor_InvalidFile);
1492   }
1493   static inline CXCursor getTombstoneKey() {
1494     return MakeCXCursorInvalid(CXCursor_NoDeclFound);
1495   }
1496   static inline unsigned getHashValue(const CXCursor &cursor) {
1497     return llvm::DenseMapInfo<std::pair<const void *, const void *>>::
1498         getHashValue(std::make_pair(cursor.data[0], cursor.data[1]));
1499   }
1500   static inline bool isEqual(const CXCursor &x, const CXCursor &y) {
1501     return x.kind == y.kind && x.data[0] == y.data[0] && x.data[1] == y.data[1];
1502   }
1503 };
1504 } // namespace llvm
1505 
1506 CXCursorSet clang_createCXCursorSet() {
1507   return packCXCursorSet(new CXCursorSet_Impl());
1508 }
1509 
1510 void clang_disposeCXCursorSet(CXCursorSet set) {
1511   delete unpackCXCursorSet(set);
1512 }
1513 
1514 unsigned clang_CXCursorSet_contains(CXCursorSet set, CXCursor cursor) {
1515   CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1516   if (!setImpl)
1517     return 0;
1518   return setImpl->find(cursor) != setImpl->end();
1519 }
1520 
1521 unsigned clang_CXCursorSet_insert(CXCursorSet set, CXCursor cursor) {
1522   // Do not insert invalid cursors into the set.
1523   if (cursor.kind >= CXCursor_FirstInvalid &&
1524       cursor.kind <= CXCursor_LastInvalid)
1525     return 1;
1526 
1527   CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1528   if (!setImpl)
1529     return 1;
1530   unsigned &entry = (*setImpl)[cursor];
1531   unsigned flag = entry == 0 ? 1 : 0;
1532   entry = 1;
1533   return flag;
1534 }
1535 
1536 CXCompletionString clang_getCursorCompletionString(CXCursor cursor) {
1537   enum CXCursorKind kind = clang_getCursorKind(cursor);
1538   if (clang_isDeclaration(kind)) {
1539     const Decl *decl = getCursorDecl(cursor);
1540     if (const NamedDecl *namedDecl = dyn_cast_or_null<NamedDecl>(decl)) {
1541       ASTUnit *unit = getCursorASTUnit(cursor);
1542       CodeCompletionResult Result(namedDecl, CCP_Declaration);
1543       CodeCompletionString *String = Result.CreateCodeCompletionString(
1544           unit->getASTContext(), unit->getPreprocessor(),
1545           CodeCompletionContext::CCC_Other,
1546           unit->getCodeCompletionTUInfo().getAllocator(),
1547           unit->getCodeCompletionTUInfo(), true);
1548       return String;
1549     }
1550   } else if (kind == CXCursor_MacroDefinition) {
1551     const MacroDefinitionRecord *definition = getCursorMacroDefinition(cursor);
1552     const IdentifierInfo *Macro = definition->getName();
1553     ASTUnit *unit = getCursorASTUnit(cursor);
1554     CodeCompletionResult Result(
1555         Macro,
1556         unit->getPreprocessor().getMacroDefinition(Macro).getMacroInfo());
1557     CodeCompletionString *String = Result.CreateCodeCompletionString(
1558         unit->getASTContext(), unit->getPreprocessor(),
1559         CodeCompletionContext::CCC_Other,
1560         unit->getCodeCompletionTUInfo().getAllocator(),
1561         unit->getCodeCompletionTUInfo(), false);
1562     return String;
1563   }
1564   return nullptr;
1565 }
1566 
1567 namespace {
1568 struct OverridenCursorsPool {
1569   typedef SmallVector<CXCursor, 2> CursorVec;
1570   std::vector<CursorVec *> AllCursors;
1571   std::vector<CursorVec *> AvailableCursors;
1572 
1573   ~OverridenCursorsPool() {
1574     for (std::vector<CursorVec *>::iterator I = AllCursors.begin(),
1575                                             E = AllCursors.end();
1576          I != E; ++I) {
1577       delete *I;
1578     }
1579   }
1580 };
1581 } // namespace
1582 
1583 void *cxcursor::createOverridenCXCursorsPool() {
1584   return new OverridenCursorsPool();
1585 }
1586 
1587 void cxcursor::disposeOverridenCXCursorsPool(void *pool) {
1588   delete static_cast<OverridenCursorsPool *>(pool);
1589 }
1590 
1591 void clang_getOverriddenCursors(CXCursor cursor, CXCursor **overridden,
1592                                 unsigned *num_overridden) {
1593   if (overridden)
1594     *overridden = nullptr;
1595   if (num_overridden)
1596     *num_overridden = 0;
1597 
1598   CXTranslationUnit TU = cxcursor::getCursorTU(cursor);
1599 
1600   if (!overridden || !num_overridden || !TU)
1601     return;
1602 
1603   if (!clang_isDeclaration(cursor.kind))
1604     return;
1605 
1606   OverridenCursorsPool &pool =
1607       *static_cast<OverridenCursorsPool *>(TU->OverridenCursorsPool);
1608 
1609   OverridenCursorsPool::CursorVec *Vec = nullptr;
1610 
1611   if (!pool.AvailableCursors.empty()) {
1612     Vec = pool.AvailableCursors.back();
1613     pool.AvailableCursors.pop_back();
1614   } else {
1615     Vec = new OverridenCursorsPool::CursorVec();
1616     pool.AllCursors.push_back(Vec);
1617   }
1618 
1619   // Clear out the vector, but don't free the memory contents.  This
1620   // reduces malloc() traffic.
1621   Vec->clear();
1622 
1623   // Use the first entry to contain a back reference to the vector.
1624   // This is a complete hack.
1625   CXCursor backRefCursor = MakeCXCursorInvalid(CXCursor_InvalidFile, TU);
1626   backRefCursor.data[0] = Vec;
1627   assert(cxcursor::getCursorTU(backRefCursor) == TU);
1628   Vec->push_back(backRefCursor);
1629 
1630   // Get the overridden cursors.
1631   cxcursor::getOverriddenCursors(cursor, *Vec);
1632 
1633   // Did we get any overridden cursors?  If not, return Vec to the pool
1634   // of available cursor vectors.
1635   if (Vec->size() == 1) {
1636     pool.AvailableCursors.push_back(Vec);
1637     return;
1638   }
1639 
1640   // Now tell the caller about the overridden cursors.
1641   assert(Vec->size() > 1);
1642   *overridden = &((*Vec)[1]);
1643   *num_overridden = Vec->size() - 1;
1644 }
1645 
1646 void clang_disposeOverriddenCursors(CXCursor *overridden) {
1647   if (!overridden)
1648     return;
1649 
1650   // Use pointer arithmetic to get back the first faux entry
1651   // which has a back-reference to the TU and the vector.
1652   --overridden;
1653   OverridenCursorsPool::CursorVec *Vec =
1654       static_cast<OverridenCursorsPool::CursorVec *>(
1655           const_cast<void *>(overridden->data[0]));
1656   CXTranslationUnit TU = getCursorTU(*overridden);
1657 
1658   assert(Vec && TU);
1659 
1660   OverridenCursorsPool &pool =
1661       *static_cast<OverridenCursorsPool *>(TU->OverridenCursorsPool);
1662 
1663   pool.AvailableCursors.push_back(Vec);
1664 }
1665 
1666 int clang_Cursor_isDynamicCall(CXCursor C) {
1667   const Expr *E = nullptr;
1668   if (clang_isExpression(C.kind))
1669     E = getCursorExpr(C);
1670   if (!E)
1671     return 0;
1672 
1673   if (const ObjCMessageExpr *MsgE = dyn_cast<ObjCMessageExpr>(E)) {
1674     if (MsgE->getReceiverKind() != ObjCMessageExpr::Instance)
1675       return false;
1676     if (auto *RecE = dyn_cast<ObjCMessageExpr>(
1677             MsgE->getInstanceReceiver()->IgnoreParenCasts())) {
1678       if (RecE->getMethodFamily() == OMF_alloc)
1679         return false;
1680     }
1681     return true;
1682   }
1683 
1684   if (auto *PropRefE = dyn_cast<ObjCPropertyRefExpr>(E)) {
1685     return !PropRefE->isSuperReceiver();
1686   }
1687 
1688   const MemberExpr *ME = nullptr;
1689   if (isa<MemberExpr>(E))
1690     ME = cast<MemberExpr>(E);
1691   else if (const CallExpr *CE = dyn_cast<CallExpr>(E))
1692     ME = dyn_cast_or_null<MemberExpr>(CE->getCallee());
1693 
1694   if (ME) {
1695     if (const CXXMethodDecl *MD =
1696             dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl()))
1697       return MD->isVirtual() &&
1698              ME->performsVirtualDispatch(
1699                  cxcursor::getCursorContext(C).getLangOpts());
1700   }
1701 
1702   return 0;
1703 }
1704 
1705 CXType clang_Cursor_getReceiverType(CXCursor C) {
1706   CXTranslationUnit TU = cxcursor::getCursorTU(C);
1707   const Expr *E = nullptr;
1708   if (clang_isExpression(C.kind))
1709     E = getCursorExpr(C);
1710 
1711   if (const ObjCMessageExpr *MsgE = dyn_cast_or_null<ObjCMessageExpr>(E))
1712     return cxtype::MakeCXType(MsgE->getReceiverType(), TU);
1713 
1714   if (auto *PropRefE = dyn_cast<ObjCPropertyRefExpr>(E)) {
1715     return cxtype::MakeCXType(
1716         PropRefE->getReceiverType(cxcursor::getCursorContext(C)), TU);
1717   }
1718 
1719   const MemberExpr *ME = nullptr;
1720   if (isa<MemberExpr>(E))
1721     ME = cast<MemberExpr>(E);
1722   else if (const CallExpr *CE = dyn_cast<CallExpr>(E))
1723     ME = dyn_cast_or_null<MemberExpr>(CE->getCallee());
1724 
1725   if (ME) {
1726     if (isa_and_nonnull<CXXMethodDecl>(ME->getMemberDecl())) {
1727       auto receiverTy = ME->getBase()->IgnoreImpCasts()->getType();
1728       return cxtype::MakeCXType(receiverTy, TU);
1729     }
1730   }
1731 
1732   return cxtype::MakeCXType(QualType(), TU);
1733 }
1734