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