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