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