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