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