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