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