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