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