xref: /llvm-project/clang/tools/libclang/CXCursor.cpp (revision e31e606ff34aea7d248acb4fd3e23383860383e2) 
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 "clang/Frontend/ASTUnit.h"
20 #include "clang/AST/Decl.h"
21 #include "clang/AST/DeclCXX.h"
22 #include "clang/AST/DeclObjC.h"
23 #include "clang/AST/DeclTemplate.h"
24 #include "clang/AST/Expr.h"
25 #include "clang/AST/ExprCXX.h"
26 #include "clang/AST/ExprObjC.h"
27 #include "clang-c/Index.h"
28 #include "llvm/Support/ErrorHandling.h"
29 
30 using namespace clang;
31 using namespace cxcursor;
32 
33 CXCursor cxcursor::MakeCXCursorInvalid(CXCursorKind K) {
34   assert(K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid);
35   CXCursor C = { K, 0, { 0, 0, 0 } };
36   return C;
37 }
38 
39 static CXCursorKind GetCursorKind(const Attr *A) {
40   assert(A && "Invalid arguments!");
41   switch (A->getKind()) {
42     default: break;
43     case attr::IBAction: return CXCursor_IBActionAttr;
44     case attr::IBOutlet: return CXCursor_IBOutletAttr;
45     case attr::IBOutletCollection: return CXCursor_IBOutletCollectionAttr;
46     case attr::Final: return CXCursor_CXXFinalAttr;
47     case attr::Override: return CXCursor_CXXOverrideAttr;
48     case attr::Annotate: return CXCursor_AnnotateAttr;
49     case attr::AsmLabel: return CXCursor_AsmLabelAttr;
50   }
51 
52   return CXCursor_UnexposedAttr;
53 }
54 
55 CXCursor cxcursor::MakeCXCursor(const Attr *A, Decl *Parent,
56                                 CXTranslationUnit TU) {
57   assert(A && Parent && TU && "Invalid arguments!");
58   CXCursor C = { GetCursorKind(A), 0, { Parent, (void*)A, TU } };
59   return C;
60 }
61 
62 CXCursor cxcursor::MakeCXCursor(Decl *D, CXTranslationUnit TU,
63                                 SourceRange RegionOfInterest,
64                                 bool FirstInDeclGroup) {
65   assert(D && TU && "Invalid arguments!");
66 
67   CXCursorKind K = getCursorKindForDecl(D);
68 
69   if (K == CXCursor_ObjCClassMethodDecl ||
70       K == CXCursor_ObjCInstanceMethodDecl) {
71     int SelectorIdIndex = -1;
72     // Check if cursor points to a selector id.
73     if (RegionOfInterest.isValid() &&
74         RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) {
75       SmallVector<SourceLocation, 16> SelLocs;
76       cast<ObjCMethodDecl>(D)->getSelectorLocs(SelLocs);
77       SmallVector<SourceLocation, 16>::iterator
78         I=std::find(SelLocs.begin(), SelLocs.end(),RegionOfInterest.getBegin());
79       if (I != SelLocs.end())
80         SelectorIdIndex = I - SelLocs.begin();
81     }
82     CXCursor C = { K, SelectorIdIndex,
83                    { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }};
84     return C;
85   }
86 
87   CXCursor C = { K, 0, { D, (void*)(intptr_t) (FirstInDeclGroup ? 1 : 0), TU }};
88   return C;
89 }
90 
91 CXCursor cxcursor::MakeCXCursor(Stmt *S, Decl *Parent, CXTranslationUnit TU,
92                                 SourceRange RegionOfInterest) {
93   assert(S && TU && "Invalid arguments!");
94   CXCursorKind K = CXCursor_NotImplemented;
95 
96   switch (S->getStmtClass()) {
97   case Stmt::NoStmtClass:
98     break;
99 
100   case Stmt::CaseStmtClass:
101     K = CXCursor_CaseStmt;
102     break;
103 
104   case Stmt::DefaultStmtClass:
105     K = CXCursor_DefaultStmt;
106     break;
107 
108   case Stmt::IfStmtClass:
109     K = CXCursor_IfStmt;
110     break;
111 
112   case Stmt::SwitchStmtClass:
113     K = CXCursor_SwitchStmt;
114     break;
115 
116   case Stmt::WhileStmtClass:
117     K = CXCursor_WhileStmt;
118     break;
119 
120   case Stmt::DoStmtClass:
121     K = CXCursor_DoStmt;
122     break;
123 
124   case Stmt::ForStmtClass:
125     K = CXCursor_ForStmt;
126     break;
127 
128   case Stmt::GotoStmtClass:
129     K = CXCursor_GotoStmt;
130     break;
131 
132   case Stmt::IndirectGotoStmtClass:
133     K = CXCursor_IndirectGotoStmt;
134     break;
135 
136   case Stmt::ContinueStmtClass:
137     K = CXCursor_ContinueStmt;
138     break;
139 
140   case Stmt::BreakStmtClass:
141     K = CXCursor_BreakStmt;
142     break;
143 
144   case Stmt::ReturnStmtClass:
145     K = CXCursor_ReturnStmt;
146     break;
147 
148   case Stmt::AsmStmtClass:
149     K = CXCursor_AsmStmt;
150     break;
151 
152   case Stmt::ObjCAtTryStmtClass:
153     K = CXCursor_ObjCAtTryStmt;
154     break;
155 
156   case Stmt::ObjCAtCatchStmtClass:
157     K = CXCursor_ObjCAtCatchStmt;
158     break;
159 
160   case Stmt::ObjCAtFinallyStmtClass:
161     K = CXCursor_ObjCAtFinallyStmt;
162     break;
163 
164   case Stmt::ObjCAtThrowStmtClass:
165     K = CXCursor_ObjCAtThrowStmt;
166     break;
167 
168   case Stmt::ObjCAtSynchronizedStmtClass:
169     K = CXCursor_ObjCAtSynchronizedStmt;
170     break;
171 
172   case Stmt::ObjCAutoreleasePoolStmtClass:
173     K = CXCursor_ObjCAutoreleasePoolStmt;
174     break;
175 
176   case Stmt::ObjCForCollectionStmtClass:
177     K = CXCursor_ObjCForCollectionStmt;
178     break;
179 
180   case Stmt::CXXCatchStmtClass:
181     K = CXCursor_CXXCatchStmt;
182     break;
183 
184   case Stmt::CXXTryStmtClass:
185     K = CXCursor_CXXTryStmt;
186     break;
187 
188   case Stmt::CXXForRangeStmtClass:
189     K = CXCursor_CXXForRangeStmt;
190     break;
191 
192   case Stmt::SEHTryStmtClass:
193     K = CXCursor_SEHTryStmt;
194     break;
195 
196   case Stmt::SEHExceptStmtClass:
197     K = CXCursor_SEHExceptStmt;
198     break;
199 
200   case Stmt::SEHFinallyStmtClass:
201     K = CXCursor_SEHFinallyStmt;
202     break;
203 
204   case Stmt::ArrayTypeTraitExprClass:
205   case Stmt::AsTypeExprClass:
206   case Stmt::AtomicExprClass:
207   case Stmt::BinaryConditionalOperatorClass:
208   case Stmt::BinaryTypeTraitExprClass:
209   case Stmt::CXXBindTemporaryExprClass:
210   case Stmt::CXXDefaultArgExprClass:
211   case Stmt::CXXScalarValueInitExprClass:
212   case Stmt::CXXUuidofExprClass:
213   case Stmt::ChooseExprClass:
214   case Stmt::DesignatedInitExprClass:
215   case Stmt::ExprWithCleanupsClass:
216   case Stmt::ExpressionTraitExprClass:
217   case Stmt::ExtVectorElementExprClass:
218   case Stmt::ImplicitCastExprClass:
219   case Stmt::ImplicitValueInitExprClass:
220   case Stmt::MaterializeTemporaryExprClass:
221   case Stmt::ObjCIndirectCopyRestoreExprClass:
222   case Stmt::OffsetOfExprClass:
223   case Stmt::ParenListExprClass:
224   case Stmt::PredefinedExprClass:
225   case Stmt::ShuffleVectorExprClass:
226   case Stmt::UnaryExprOrTypeTraitExprClass:
227   case Stmt::UnaryTypeTraitExprClass:
228   case Stmt::VAArgExprClass:
229   case Stmt::LambdaExprClass:
230     K = CXCursor_UnexposedExpr;
231     break;
232 
233   case Stmt::OpaqueValueExprClass:
234     if (Expr *Src = cast<OpaqueValueExpr>(S)->getSourceExpr())
235       return MakeCXCursor(Src, Parent, TU, RegionOfInterest);
236     K = CXCursor_UnexposedExpr;
237     break;
238 
239   case Stmt::PseudoObjectExprClass:
240     return MakeCXCursor(cast<PseudoObjectExpr>(S)->getSyntacticForm(),
241                         Parent, TU, RegionOfInterest);
242 
243   case Stmt::CompoundStmtClass:
244     K = CXCursor_CompoundStmt;
245     break;
246 
247   case Stmt::NullStmtClass:
248     K = CXCursor_NullStmt;
249     break;
250 
251   case Stmt::LabelStmtClass:
252     K = CXCursor_LabelStmt;
253     break;
254 
255   case Stmt::DeclStmtClass:
256     K = CXCursor_DeclStmt;
257     break;
258 
259   case Stmt::IntegerLiteralClass:
260     K = CXCursor_IntegerLiteral;
261     break;
262 
263   case Stmt::FloatingLiteralClass:
264     K = CXCursor_FloatingLiteral;
265     break;
266 
267   case Stmt::ImaginaryLiteralClass:
268     K = CXCursor_ImaginaryLiteral;
269     break;
270 
271   case Stmt::StringLiteralClass:
272     K = CXCursor_StringLiteral;
273     break;
274 
275   case Stmt::CharacterLiteralClass:
276     K = CXCursor_CharacterLiteral;
277     break;
278 
279   case Stmt::ParenExprClass:
280     K = CXCursor_ParenExpr;
281     break;
282 
283   case Stmt::UnaryOperatorClass:
284     K = CXCursor_UnaryOperator;
285     break;
286 
287   case Stmt::CXXNoexceptExprClass:
288     K = CXCursor_UnaryExpr;
289     break;
290 
291   case Stmt::ArraySubscriptExprClass:
292     K = CXCursor_ArraySubscriptExpr;
293     break;
294 
295   case Stmt::BinaryOperatorClass:
296     K = CXCursor_BinaryOperator;
297     break;
298 
299   case Stmt::CompoundAssignOperatorClass:
300     K = CXCursor_CompoundAssignOperator;
301     break;
302 
303   case Stmt::ConditionalOperatorClass:
304     K = CXCursor_ConditionalOperator;
305     break;
306 
307   case Stmt::CStyleCastExprClass:
308     K = CXCursor_CStyleCastExpr;
309     break;
310 
311   case Stmt::CompoundLiteralExprClass:
312     K = CXCursor_CompoundLiteralExpr;
313     break;
314 
315   case Stmt::InitListExprClass:
316     K = CXCursor_InitListExpr;
317     break;
318 
319   case Stmt::AddrLabelExprClass:
320     K = CXCursor_AddrLabelExpr;
321     break;
322 
323   case Stmt::StmtExprClass:
324     K = CXCursor_StmtExpr;
325     break;
326 
327   case Stmt::GenericSelectionExprClass:
328     K = CXCursor_GenericSelectionExpr;
329     break;
330 
331   case Stmt::GNUNullExprClass:
332     K = CXCursor_GNUNullExpr;
333     break;
334 
335   case Stmt::CXXStaticCastExprClass:
336     K = CXCursor_CXXStaticCastExpr;
337     break;
338 
339   case Stmt::CXXDynamicCastExprClass:
340     K = CXCursor_CXXDynamicCastExpr;
341     break;
342 
343   case Stmt::CXXReinterpretCastExprClass:
344     K = CXCursor_CXXReinterpretCastExpr;
345     break;
346 
347   case Stmt::CXXConstCastExprClass:
348     K = CXCursor_CXXConstCastExpr;
349     break;
350 
351   case Stmt::CXXFunctionalCastExprClass:
352     K = CXCursor_CXXFunctionalCastExpr;
353     break;
354 
355   case Stmt::CXXTypeidExprClass:
356     K = CXCursor_CXXTypeidExpr;
357     break;
358 
359   case Stmt::CXXBoolLiteralExprClass:
360     K = CXCursor_CXXBoolLiteralExpr;
361     break;
362 
363   case Stmt::CXXNullPtrLiteralExprClass:
364     K = CXCursor_CXXNullPtrLiteralExpr;
365     break;
366 
367   case Stmt::CXXThisExprClass:
368     K = CXCursor_CXXThisExpr;
369     break;
370 
371   case Stmt::CXXThrowExprClass:
372     K = CXCursor_CXXThrowExpr;
373     break;
374 
375   case Stmt::CXXNewExprClass:
376     K = CXCursor_CXXNewExpr;
377     break;
378 
379   case Stmt::CXXDeleteExprClass:
380     K = CXCursor_CXXDeleteExpr;
381     break;
382 
383   case Stmt::ObjCStringLiteralClass:
384     K = CXCursor_ObjCStringLiteral;
385     break;
386 
387   case Stmt::ObjCEncodeExprClass:
388     K = CXCursor_ObjCEncodeExpr;
389     break;
390 
391   case Stmt::ObjCSelectorExprClass:
392     K = CXCursor_ObjCSelectorExpr;
393     break;
394 
395   case Stmt::ObjCProtocolExprClass:
396     K = CXCursor_ObjCProtocolExpr;
397     break;
398 
399   case Stmt::ObjCBridgedCastExprClass:
400     K = CXCursor_ObjCBridgedCastExpr;
401     break;
402 
403   case Stmt::BlockExprClass:
404     K = CXCursor_BlockExpr;
405     break;
406 
407   case Stmt::PackExpansionExprClass:
408     K = CXCursor_PackExpansionExpr;
409     break;
410 
411   case Stmt::SizeOfPackExprClass:
412     K = CXCursor_SizeOfPackExpr;
413     break;
414 
415   case Stmt::BlockDeclRefExprClass:
416   case Stmt::DeclRefExprClass:
417   case Stmt::DependentScopeDeclRefExprClass:
418   case Stmt::SubstNonTypeTemplateParmExprClass:
419   case Stmt::SubstNonTypeTemplateParmPackExprClass:
420   case Stmt::UnresolvedLookupExprClass:
421     K = CXCursor_DeclRefExpr;
422     break;
423 
424   case Stmt::CXXDependentScopeMemberExprClass:
425   case Stmt::CXXPseudoDestructorExprClass:
426   case Stmt::MemberExprClass:
427   case Stmt::ObjCIsaExprClass:
428   case Stmt::ObjCIvarRefExprClass:
429   case Stmt::ObjCPropertyRefExprClass:
430   case Stmt::UnresolvedMemberExprClass:
431     K = CXCursor_MemberRefExpr;
432     break;
433 
434   case Stmt::CallExprClass:
435   case Stmt::CXXOperatorCallExprClass:
436   case Stmt::CXXMemberCallExprClass:
437   case Stmt::CUDAKernelCallExprClass:
438   case Stmt::CXXConstructExprClass:
439   case Stmt::CXXTemporaryObjectExprClass:
440   case Stmt::CXXUnresolvedConstructExprClass:
441     K = CXCursor_CallExpr;
442     break;
443 
444   case Stmt::ObjCMessageExprClass: {
445     K = CXCursor_ObjCMessageExpr;
446     int SelectorIdIndex = -1;
447     // Check if cursor points to a selector id.
448     if (RegionOfInterest.isValid() &&
449         RegionOfInterest.getBegin() == RegionOfInterest.getEnd()) {
450       SmallVector<SourceLocation, 16> SelLocs;
451       cast<ObjCMessageExpr>(S)->getSelectorLocs(SelLocs);
452       SmallVector<SourceLocation, 16>::iterator
453         I=std::find(SelLocs.begin(), SelLocs.end(),RegionOfInterest.getBegin());
454       if (I != SelLocs.end())
455         SelectorIdIndex = I - SelLocs.begin();
456     }
457     CXCursor C = { K, 0, { Parent, S, TU } };
458     return getSelectorIdentifierCursor(SelectorIdIndex, C);
459   }
460 
461   case Stmt::MSDependentExistsStmtClass:
462     K = CXCursor_UnexposedStmt;
463     break;
464   }
465 
466   CXCursor C = { K, 0, { Parent, S, TU } };
467   return C;
468 }
469 
470 CXCursor cxcursor::MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super,
471                                                SourceLocation Loc,
472                                                CXTranslationUnit TU) {
473   assert(Super && TU && "Invalid arguments!");
474   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
475   CXCursor C = { CXCursor_ObjCSuperClassRef, 0, { Super, RawLoc, TU } };
476   return C;
477 }
478 
479 std::pair<ObjCInterfaceDecl *, SourceLocation>
480 cxcursor::getCursorObjCSuperClassRef(CXCursor C) {
481   assert(C.kind == CXCursor_ObjCSuperClassRef);
482   return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]),
483            SourceLocation::getFromRawEncoding(
484                                       reinterpret_cast<uintptr_t>(C.data[1])));
485 }
486 
487 CXCursor cxcursor::MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto,
488                                              SourceLocation Loc,
489                                              CXTranslationUnit TU) {
490   assert(Proto && TU && "Invalid arguments!");
491   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
492   CXCursor C = { CXCursor_ObjCProtocolRef, 0, { (void*)Proto, RawLoc, TU } };
493   return C;
494 }
495 
496 std::pair<ObjCProtocolDecl *, SourceLocation>
497 cxcursor::getCursorObjCProtocolRef(CXCursor C) {
498   assert(C.kind == CXCursor_ObjCProtocolRef);
499   return std::make_pair(static_cast<ObjCProtocolDecl *>(C.data[0]),
500            SourceLocation::getFromRawEncoding(
501                                       reinterpret_cast<uintptr_t>(C.data[1])));
502 }
503 
504 CXCursor cxcursor::MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class,
505                                           SourceLocation Loc,
506                                           CXTranslationUnit TU) {
507   // 'Class' can be null for invalid code.
508   if (!Class)
509     return MakeCXCursorInvalid(CXCursor_InvalidCode);
510   assert(TU && "Invalid arguments!");
511   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
512   CXCursor C = { CXCursor_ObjCClassRef, 0, { (void*)Class, RawLoc, TU } };
513   return C;
514 }
515 
516 std::pair<ObjCInterfaceDecl *, SourceLocation>
517 cxcursor::getCursorObjCClassRef(CXCursor C) {
518   assert(C.kind == CXCursor_ObjCClassRef);
519   return std::make_pair(static_cast<ObjCInterfaceDecl *>(C.data[0]),
520            SourceLocation::getFromRawEncoding(
521                                       reinterpret_cast<uintptr_t>(C.data[1])));
522 }
523 
524 CXCursor cxcursor::MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc,
525                                      CXTranslationUnit TU) {
526   assert(Type && TU && "Invalid arguments!");
527   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
528   CXCursor C = { CXCursor_TypeRef, 0, { (void*)Type, RawLoc, TU } };
529   return C;
530 }
531 
532 std::pair<TypeDecl *, SourceLocation>
533 cxcursor::getCursorTypeRef(CXCursor C) {
534   assert(C.kind == CXCursor_TypeRef);
535   return std::make_pair(static_cast<TypeDecl *>(C.data[0]),
536            SourceLocation::getFromRawEncoding(
537                                       reinterpret_cast<uintptr_t>(C.data[1])));
538 }
539 
540 CXCursor cxcursor::MakeCursorTemplateRef(const TemplateDecl *Template,
541                                          SourceLocation Loc,
542                                          CXTranslationUnit TU) {
543   assert(Template && TU && "Invalid arguments!");
544   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
545   CXCursor C = { CXCursor_TemplateRef, 0, { (void*)Template, RawLoc, TU } };
546   return C;
547 }
548 
549 std::pair<TemplateDecl *, SourceLocation>
550 cxcursor::getCursorTemplateRef(CXCursor C) {
551   assert(C.kind == CXCursor_TemplateRef);
552   return std::make_pair(static_cast<TemplateDecl *>(C.data[0]),
553                         SourceLocation::getFromRawEncoding(
554                                        reinterpret_cast<uintptr_t>(C.data[1])));
555 }
556 
557 CXCursor cxcursor::MakeCursorNamespaceRef(const NamedDecl *NS,
558                                           SourceLocation Loc,
559                                           CXTranslationUnit TU) {
560 
561   assert(NS && (isa<NamespaceDecl>(NS) || isa<NamespaceAliasDecl>(NS)) && TU &&
562          "Invalid arguments!");
563   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
564   CXCursor C = { CXCursor_NamespaceRef, 0, { (void*)NS, RawLoc, TU } };
565   return C;
566 }
567 
568 std::pair<NamedDecl *, SourceLocation>
569 cxcursor::getCursorNamespaceRef(CXCursor C) {
570   assert(C.kind == CXCursor_NamespaceRef);
571   return std::make_pair(static_cast<NamedDecl *>(C.data[0]),
572                         SourceLocation::getFromRawEncoding(
573                                        reinterpret_cast<uintptr_t>(C.data[1])));
574 }
575 
576 CXCursor cxcursor::MakeCursorMemberRef(const FieldDecl *Field, SourceLocation Loc,
577                                        CXTranslationUnit TU) {
578 
579   assert(Field && TU && "Invalid arguments!");
580   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
581   CXCursor C = { CXCursor_MemberRef, 0, { (void*)Field, RawLoc, TU } };
582   return C;
583 }
584 
585 std::pair<FieldDecl *, SourceLocation>
586 cxcursor::getCursorMemberRef(CXCursor C) {
587   assert(C.kind == CXCursor_MemberRef);
588   return std::make_pair(static_cast<FieldDecl *>(C.data[0]),
589                         SourceLocation::getFromRawEncoding(
590                                        reinterpret_cast<uintptr_t>(C.data[1])));
591 }
592 
593 CXCursor cxcursor::MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B,
594                                               CXTranslationUnit TU){
595   CXCursor C = { CXCursor_CXXBaseSpecifier, 0, { (void*)B, 0, TU } };
596   return C;
597 }
598 
599 CXXBaseSpecifier *cxcursor::getCursorCXXBaseSpecifier(CXCursor C) {
600   assert(C.kind == CXCursor_CXXBaseSpecifier);
601   return static_cast<CXXBaseSpecifier*>(C.data[0]);
602 }
603 
604 CXCursor cxcursor::MakePreprocessingDirectiveCursor(SourceRange Range,
605                                                     CXTranslationUnit TU) {
606   CXCursor C = { CXCursor_PreprocessingDirective, 0,
607                  { reinterpret_cast<void *>(Range.getBegin().getRawEncoding()),
608                    reinterpret_cast<void *>(Range.getEnd().getRawEncoding()),
609                    TU }
610                };
611   return C;
612 }
613 
614 SourceRange cxcursor::getCursorPreprocessingDirective(CXCursor C) {
615   assert(C.kind == CXCursor_PreprocessingDirective);
616   SourceRange Range = SourceRange(SourceLocation::getFromRawEncoding(
617                                       reinterpret_cast<uintptr_t> (C.data[0])),
618                      SourceLocation::getFromRawEncoding(
619                                       reinterpret_cast<uintptr_t> (C.data[1])));
620   ASTUnit *TU = getCursorASTUnit(C);
621   return TU->mapRangeFromPreamble(Range);
622 }
623 
624 CXCursor cxcursor::MakeMacroDefinitionCursor(MacroDefinition *MI,
625                                              CXTranslationUnit TU) {
626   CXCursor C = { CXCursor_MacroDefinition, 0, { MI, 0, TU } };
627   return C;
628 }
629 
630 MacroDefinition *cxcursor::getCursorMacroDefinition(CXCursor C) {
631   assert(C.kind == CXCursor_MacroDefinition);
632   return static_cast<MacroDefinition *>(C.data[0]);
633 }
634 
635 CXCursor cxcursor::MakeMacroExpansionCursor(MacroExpansion *MI,
636                                             CXTranslationUnit TU) {
637   CXCursor C = { CXCursor_MacroExpansion, 0, { MI, 0, TU } };
638   return C;
639 }
640 
641 MacroExpansion *cxcursor::getCursorMacroExpansion(CXCursor C) {
642   assert(C.kind == CXCursor_MacroExpansion);
643   return static_cast<MacroExpansion *>(C.data[0]);
644 }
645 
646 CXCursor cxcursor::MakeInclusionDirectiveCursor(InclusionDirective *ID,
647                                                 CXTranslationUnit TU) {
648   CXCursor C = { CXCursor_InclusionDirective, 0, { ID, 0, TU } };
649   return C;
650 }
651 
652 InclusionDirective *cxcursor::getCursorInclusionDirective(CXCursor C) {
653   assert(C.kind == CXCursor_InclusionDirective);
654   return static_cast<InclusionDirective *>(C.data[0]);
655 }
656 
657 CXCursor cxcursor::MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc,
658                                       CXTranslationUnit TU) {
659 
660   assert(Label && TU && "Invalid arguments!");
661   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
662   CXCursor C = { CXCursor_LabelRef, 0, { Label, RawLoc, TU } };
663   return C;
664 }
665 
666 std::pair<LabelStmt*, SourceLocation>
667 cxcursor::getCursorLabelRef(CXCursor C) {
668   assert(C.kind == CXCursor_LabelRef);
669   return std::make_pair(static_cast<LabelStmt *>(C.data[0]),
670                         SourceLocation::getFromRawEncoding(
671                                        reinterpret_cast<uintptr_t>(C.data[1])));
672 }
673 
674 CXCursor cxcursor::MakeCursorOverloadedDeclRef(OverloadExpr *E,
675                                                CXTranslationUnit TU) {
676   assert(E && TU && "Invalid arguments!");
677   OverloadedDeclRefStorage Storage(E);
678   void *RawLoc = reinterpret_cast<void *>(E->getNameLoc().getRawEncoding());
679   CXCursor C = {
680                  CXCursor_OverloadedDeclRef, 0,
681                  { Storage.getOpaqueValue(), RawLoc, TU }
682                };
683   return C;
684 }
685 
686 CXCursor cxcursor::MakeCursorOverloadedDeclRef(Decl *D,
687                                                SourceLocation Loc,
688                                                CXTranslationUnit TU) {
689   assert(D && TU && "Invalid arguments!");
690   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
691   OverloadedDeclRefStorage Storage(D);
692   CXCursor C = {
693     CXCursor_OverloadedDeclRef, 0,
694     { Storage.getOpaqueValue(), RawLoc, TU }
695   };
696   return C;
697 }
698 
699 CXCursor cxcursor::MakeCursorOverloadedDeclRef(TemplateName Name,
700                                                SourceLocation Loc,
701                                                CXTranslationUnit TU) {
702   assert(Name.getAsOverloadedTemplate() && TU && "Invalid arguments!");
703   void *RawLoc = reinterpret_cast<void *>(Loc.getRawEncoding());
704   OverloadedDeclRefStorage Storage(Name.getAsOverloadedTemplate());
705   CXCursor C = {
706     CXCursor_OverloadedDeclRef, 0,
707     { Storage.getOpaqueValue(), RawLoc, TU }
708   };
709   return C;
710 }
711 
712 std::pair<cxcursor::OverloadedDeclRefStorage, SourceLocation>
713 cxcursor::getCursorOverloadedDeclRef(CXCursor C) {
714   assert(C.kind == CXCursor_OverloadedDeclRef);
715   return std::make_pair(OverloadedDeclRefStorage::getFromOpaqueValue(C.data[0]),
716                         SourceLocation::getFromRawEncoding(
717                                        reinterpret_cast<uintptr_t>(C.data[1])));
718 }
719 
720 Decl *cxcursor::getCursorDecl(CXCursor Cursor) {
721   return (Decl *)Cursor.data[0];
722 }
723 
724 Expr *cxcursor::getCursorExpr(CXCursor Cursor) {
725   return dyn_cast_or_null<Expr>(getCursorStmt(Cursor));
726 }
727 
728 Stmt *cxcursor::getCursorStmt(CXCursor Cursor) {
729   if (Cursor.kind == CXCursor_ObjCSuperClassRef ||
730       Cursor.kind == CXCursor_ObjCProtocolRef ||
731       Cursor.kind == CXCursor_ObjCClassRef)
732     return 0;
733 
734   return (Stmt *)Cursor.data[1];
735 }
736 
737 Attr *cxcursor::getCursorAttr(CXCursor Cursor) {
738   return (Attr *)Cursor.data[1];
739 }
740 
741 Decl *cxcursor::getCursorParentDecl(CXCursor Cursor) {
742   return (Decl *)Cursor.data[0];
743 }
744 
745 ASTContext &cxcursor::getCursorContext(CXCursor Cursor) {
746   return getCursorASTUnit(Cursor)->getASTContext();
747 }
748 
749 ASTUnit *cxcursor::getCursorASTUnit(CXCursor Cursor) {
750   CXTranslationUnit TU = static_cast<CXTranslationUnit>(Cursor.data[2]);
751   if (!TU)
752     return 0;
753   return static_cast<ASTUnit *>(TU->TUData);
754 }
755 
756 CXTranslationUnit cxcursor::getCursorTU(CXCursor Cursor) {
757   return static_cast<CXTranslationUnit>(Cursor.data[2]);
758 }
759 
760 static void CollectOverriddenMethods(CXTranslationUnit TU,
761                                      DeclContext *Ctx,
762                                      ObjCMethodDecl *Method,
763                                      SmallVectorImpl<CXCursor> &Methods) {
764   if (!Ctx)
765     return;
766 
767   // If we have a class or category implementation, jump straight to the
768   // interface.
769   if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx))
770     return CollectOverriddenMethods(TU, Impl->getClassInterface(),
771                                     Method, Methods);
772 
773   ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx);
774   if (!Container)
775     return;
776 
777   // Check whether we have a matching method at this level.
778   if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(),
779                                                     Method->isInstanceMethod()))
780     if (Method != Overridden) {
781       // We found an override at this level; there is no need to look
782       // into other protocols or categories.
783       Methods.push_back(MakeCXCursor(Overridden, TU));
784       return;
785     }
786 
787   if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) {
788     for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(),
789                                           PEnd = Protocol->protocol_end();
790          P != PEnd; ++P)
791       CollectOverriddenMethods(TU, *P, Method, Methods);
792   }
793 
794   if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
795     for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(),
796                                           PEnd = Category->protocol_end();
797          P != PEnd; ++P)
798       CollectOverriddenMethods(TU, *P, Method, Methods);
799   }
800 
801   if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
802     for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(),
803                                            PEnd = Interface->protocol_end();
804          P != PEnd; ++P)
805       CollectOverriddenMethods(TU, *P, Method, Methods);
806 
807     for (ObjCCategoryDecl *Category = Interface->getCategoryList();
808          Category; Category = Category->getNextClassCategory())
809       CollectOverriddenMethods(TU, Category, Method, Methods);
810 
811     // We only look into the superclass if we haven't found anything yet.
812     if (Methods.empty())
813       if (ObjCInterfaceDecl *Super = Interface->getSuperClass())
814         return CollectOverriddenMethods(TU, Super, Method, Methods);
815   }
816 }
817 
818 void cxcursor::getOverriddenCursors(CXCursor cursor,
819                                     SmallVectorImpl<CXCursor> &overridden) {
820   if (!clang_isDeclaration(cursor.kind))
821     return;
822 
823   Decl *D = getCursorDecl(cursor);
824   if (!D)
825     return;
826 
827   // Handle C++ member functions.
828   CXTranslationUnit TU = getCursorTU(cursor);
829   if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
830     for (CXXMethodDecl::method_iterator
831               M = CXXMethod->begin_overridden_methods(),
832            MEnd = CXXMethod->end_overridden_methods();
833          M != MEnd; ++M)
834       overridden.push_back(MakeCXCursor(const_cast<CXXMethodDecl*>(*M), TU));
835     return;
836   }
837 
838   ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
839   if (!Method)
840     return;
841 
842   // Handle Objective-C methods.
843   CollectOverriddenMethods(TU, Method->getDeclContext(), Method, overridden);
844 }
845 
846 std::pair<int, SourceLocation>
847 cxcursor::getSelectorIdentifierIndexAndLoc(CXCursor cursor) {
848   if (cursor.kind == CXCursor_ObjCMessageExpr) {
849     if (cursor.xdata != -1)
850       return std::make_pair(cursor.xdata,
851                             cast<ObjCMessageExpr>(getCursorExpr(cursor))
852                                                 ->getSelectorLoc(cursor.xdata));
853   } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
854              cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
855     if (cursor.xdata != -1)
856       return std::make_pair(cursor.xdata,
857                             cast<ObjCMethodDecl>(getCursorDecl(cursor))
858                                                 ->getSelectorLoc(cursor.xdata));
859   }
860 
861   return std::make_pair(-1, SourceLocation());
862 }
863 
864 CXCursor cxcursor::getSelectorIdentifierCursor(int SelIdx, CXCursor cursor) {
865   CXCursor newCursor = cursor;
866 
867   if (cursor.kind == CXCursor_ObjCMessageExpr) {
868     if (SelIdx == -1 ||
869         unsigned(SelIdx) >= cast<ObjCMessageExpr>(getCursorExpr(cursor))
870                                                          ->getNumSelectorLocs())
871       newCursor.xdata = -1;
872     else
873       newCursor.xdata = SelIdx;
874   } else if (cursor.kind == CXCursor_ObjCClassMethodDecl ||
875              cursor.kind == CXCursor_ObjCInstanceMethodDecl) {
876     if (SelIdx == -1 ||
877         unsigned(SelIdx) >= cast<ObjCMethodDecl>(getCursorDecl(cursor))
878                                                          ->getNumSelectorLocs())
879       newCursor.xdata = -1;
880     else
881       newCursor.xdata = SelIdx;
882   }
883 
884   return newCursor;
885 }
886 
887 CXCursor cxcursor::getTypeRefCursor(CXCursor cursor) {
888   if (cursor.kind != CXCursor_CallExpr)
889     return cursor;
890 
891   if (cursor.xdata == 0)
892     return cursor;
893 
894   Expr *E = getCursorExpr(cursor);
895   TypeSourceInfo *Type = 0;
896   if (CXXUnresolvedConstructExpr *
897         UnCtor = dyn_cast<CXXUnresolvedConstructExpr>(E)) {
898     Type = UnCtor->getTypeSourceInfo();
899   } else if (CXXTemporaryObjectExpr *Tmp = dyn_cast<CXXTemporaryObjectExpr>(E)){
900     Type = Tmp->getTypeSourceInfo();
901   }
902 
903   if (!Type)
904     return cursor;
905 
906   CXTranslationUnit TU = getCursorTU(cursor);
907   QualType Ty = Type->getType();
908   TypeLoc TL = Type->getTypeLoc();
909   SourceLocation Loc = TL.getBeginLoc();
910 
911   if (const ElaboratedType *ElabT = Ty->getAs<ElaboratedType>()) {
912     Ty = ElabT->getNamedType();
913     ElaboratedTypeLoc ElabTL = cast<ElaboratedTypeLoc>(TL);
914     Loc = ElabTL.getNamedTypeLoc().getBeginLoc();
915   }
916 
917   if (const TypedefType *Typedef = Ty->getAs<TypedefType>())
918     return MakeCursorTypeRef(Typedef->getDecl(), Loc, TU);
919   if (const TagType *Tag = Ty->getAs<TagType>())
920     return MakeCursorTypeRef(Tag->getDecl(), Loc, TU);
921   if (const TemplateTypeParmType *TemplP = Ty->getAs<TemplateTypeParmType>())
922     return MakeCursorTypeRef(TemplP->getDecl(), Loc, TU);
923 
924   return cursor;
925 }
926 
927 bool cxcursor::operator==(CXCursor X, CXCursor Y) {
928   return X.kind == Y.kind && X.data[0] == Y.data[0] && X.data[1] == Y.data[1] &&
929          X.data[2] == Y.data[2];
930 }
931 
932 // FIXME: Remove once we can model DeclGroups and their appropriate ranges
933 // properly in the ASTs.
934 bool cxcursor::isFirstInDeclGroup(CXCursor C) {
935   assert(clang_isDeclaration(C.kind));
936   return ((uintptr_t) (C.data[1])) != 0;
937 }
938 
939 //===----------------------------------------------------------------------===//
940 // libclang CXCursor APIs
941 //===----------------------------------------------------------------------===//
942 
943 extern "C" {
944 
945 int clang_Cursor_isNull(CXCursor cursor) {
946   return clang_equalCursors(cursor, clang_getNullCursor());
947 }
948 
949 CXTranslationUnit clang_Cursor_getTranslationUnit(CXCursor cursor) {
950   return getCursorTU(cursor);
951 }
952 
953 } // end: extern "C"
954 
955 //===----------------------------------------------------------------------===//
956 // CXCursorSet.
957 //===----------------------------------------------------------------------===//
958 
959 typedef llvm::DenseMap<CXCursor, unsigned> CXCursorSet_Impl;
960 
961 static inline CXCursorSet packCXCursorSet(CXCursorSet_Impl *setImpl) {
962   return (CXCursorSet) setImpl;
963 }
964 static inline CXCursorSet_Impl *unpackCXCursorSet(CXCursorSet set) {
965   return (CXCursorSet_Impl*) set;
966 }
967 namespace llvm {
968 template<> struct DenseMapInfo<CXCursor> {
969 public:
970   static inline CXCursor getEmptyKey() {
971     return MakeCXCursorInvalid(CXCursor_InvalidFile);
972   }
973   static inline CXCursor getTombstoneKey() {
974     return MakeCXCursorInvalid(CXCursor_NoDeclFound);
975   }
976   static inline unsigned getHashValue(const CXCursor &cursor) {
977     return llvm::DenseMapInfo<std::pair<void*,void*> >
978       ::getHashValue(std::make_pair(cursor.data[0], cursor.data[1]));
979   }
980   static inline bool isEqual(const CXCursor &x, const CXCursor &y) {
981     return x.kind == y.kind &&
982            x.data[0] == y.data[0] &&
983            x.data[1] == y.data[1];
984   }
985 };
986 }
987 
988 extern "C" {
989 CXCursorSet clang_createCXCursorSet() {
990   return packCXCursorSet(new CXCursorSet_Impl());
991 }
992 
993 void clang_disposeCXCursorSet(CXCursorSet set) {
994   delete unpackCXCursorSet(set);
995 }
996 
997 unsigned clang_CXCursorSet_contains(CXCursorSet set, CXCursor cursor) {
998   CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
999   if (!setImpl)
1000     return 0;
1001   return setImpl->find(cursor) == setImpl->end();
1002 }
1003 
1004 unsigned clang_CXCursorSet_insert(CXCursorSet set, CXCursor cursor) {
1005   // Do not insert invalid cursors into the set.
1006   if (cursor.kind >= CXCursor_FirstInvalid &&
1007       cursor.kind <= CXCursor_LastInvalid)
1008     return 1;
1009 
1010   CXCursorSet_Impl *setImpl = unpackCXCursorSet(set);
1011   if (!setImpl)
1012     return 1;
1013   unsigned &entry = (*setImpl)[cursor];
1014   unsigned flag = entry == 0 ? 1 : 0;
1015   entry = 1;
1016   return flag;
1017 }
1018 
1019 CXCompletionString clang_getCursorCompletionString(CXCursor cursor) {
1020   enum CXCursorKind kind = clang_getCursorKind(cursor);
1021   if (clang_isDeclaration(kind)) {
1022     Decl *decl = getCursorDecl(cursor);
1023     if (NamedDecl *namedDecl = dyn_cast_or_null<NamedDecl>(decl)) {
1024       ASTUnit *unit = getCursorASTUnit(cursor);
1025       CodeCompletionAllocator *Allocator
1026         = unit->getCursorCompletionAllocator().getPtr();
1027       CodeCompletionResult Result(namedDecl);
1028       CodeCompletionString *String
1029         = Result.CreateCodeCompletionString(unit->getASTContext(),
1030                                             unit->getPreprocessor(),
1031                                             *Allocator);
1032       return String;
1033     }
1034   }
1035   else if (kind == CXCursor_MacroDefinition) {
1036     MacroDefinition *definition = getCursorMacroDefinition(cursor);
1037     const IdentifierInfo *MacroInfo = definition->getName();
1038     ASTUnit *unit = getCursorASTUnit(cursor);
1039     CodeCompletionAllocator *Allocator
1040       = unit->getCursorCompletionAllocator().getPtr();
1041     CodeCompletionResult Result(const_cast<IdentifierInfo *>(MacroInfo));
1042     CodeCompletionString *String
1043       = Result.CreateCodeCompletionString(unit->getASTContext(),
1044                                           unit->getPreprocessor(),
1045                                           *Allocator);
1046     return String;
1047   }
1048   return NULL;
1049 }
1050 
1051 } // end: extern "C"
1052