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