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