CIndex.cpp revision 0582c897ec7261b4c6af0fe26dc2a0b6b54d266c 
1//===- CIndex.cpp - Clang-C Source Indexing Library -----------------------===//
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 implements the main API hooks in the Clang-C Source Indexing
11// library.
12//
13//===----------------------------------------------------------------------===//
14
15#include "CIndexer.h"
16#include "CXCursor.h"
17#include "CXType.h"
18#include "CXSourceLocation.h"
19#include "CIndexDiagnostic.h"
20
21#include "clang/Basic/Version.h"
22
23#include "clang/AST/DeclVisitor.h"
24#include "clang/AST/StmtVisitor.h"
25#include "clang/AST/TypeLocVisitor.h"
26#include "clang/Basic/Diagnostic.h"
27#include "clang/Frontend/ASTUnit.h"
28#include "clang/Frontend/CompilerInstance.h"
29#include "clang/Frontend/FrontendDiagnostic.h"
30#include "clang/Lex/Lexer.h"
31#include "clang/Lex/PreprocessingRecord.h"
32#include "clang/Lex/Preprocessor.h"
33#include "llvm/ADT/STLExtras.h"
34#include "llvm/ADT/Optional.h"
35#include "clang/Analysis/Support/SaveAndRestore.h"
36#include "llvm/Support/CrashRecoveryContext.h"
37#include "llvm/Support/PrettyStackTrace.h"
38#include "llvm/Support/MemoryBuffer.h"
39#include "llvm/Support/raw_ostream.h"
40#include "llvm/Support/Timer.h"
41#include "llvm/System/Mutex.h"
42#include "llvm/System/Program.h"
43#include "llvm/System/Signals.h"
44#include "llvm/System/Threading.h"
45
46// Needed to define L_TMPNAM on some systems.
47#include <cstdio>
48
49using namespace clang;
50using namespace clang::cxcursor;
51using namespace clang::cxstring;
52
53/// \brief The result of comparing two source ranges.
54enum RangeComparisonResult {
55  /// \brief Either the ranges overlap or one of the ranges is invalid.
56  RangeOverlap,
57
58  /// \brief The first range ends before the second range starts.
59  RangeBefore,
60
61  /// \brief The first range starts after the second range ends.
62  RangeAfter
63};
64
65/// \brief Compare two source ranges to determine their relative position in
66/// the translation unit.
67static RangeComparisonResult RangeCompare(SourceManager &SM,
68                                          SourceRange R1,
69                                          SourceRange R2) {
70  assert(R1.isValid() && "First range is invalid?");
71  assert(R2.isValid() && "Second range is invalid?");
72  if (R1.getEnd() != R2.getBegin() &&
73      SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
74    return RangeBefore;
75  if (R2.getEnd() != R1.getBegin() &&
76      SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
77    return RangeAfter;
78  return RangeOverlap;
79}
80
81/// \brief Determine if a source location falls within, before, or after a
82///   a given source range.
83static RangeComparisonResult LocationCompare(SourceManager &SM,
84                                             SourceLocation L, SourceRange R) {
85  assert(R.isValid() && "First range is invalid?");
86  assert(L.isValid() && "Second range is invalid?");
87  if (L == R.getBegin() || L == R.getEnd())
88    return RangeOverlap;
89  if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
90    return RangeBefore;
91  if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
92    return RangeAfter;
93  return RangeOverlap;
94}
95
96/// \brief Translate a Clang source range into a CIndex source range.
97///
98/// Clang internally represents ranges where the end location points to the
99/// start of the token at the end. However, for external clients it is more
100/// useful to have a CXSourceRange be a proper half-open interval. This routine
101/// does the appropriate translation.
102CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
103                                          const LangOptions &LangOpts,
104                                          const CharSourceRange &R) {
105  // We want the last character in this location, so we will adjust the
106  // location accordingly.
107  // FIXME: How do do this with a macro instantiation location?
108  SourceLocation EndLoc = R.getEnd();
109  if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
110    unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
111    EndLoc = EndLoc.getFileLocWithOffset(Length);
112  }
113
114  CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
115                           R.getBegin().getRawEncoding(),
116                           EndLoc.getRawEncoding() };
117  return Result;
118}
119
120//===----------------------------------------------------------------------===//
121// Cursor visitor.
122//===----------------------------------------------------------------------===//
123
124namespace {
125
126// Cursor visitor.
127class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
128                      public TypeLocVisitor<CursorVisitor, bool>,
129                      public StmtVisitor<CursorVisitor, bool>
130{
131  /// \brief The translation unit we are traversing.
132  ASTUnit *TU;
133
134  /// \brief The parent cursor whose children we are traversing.
135  CXCursor Parent;
136
137  /// \brief The declaration that serves at the parent of any statement or
138  /// expression nodes.
139  Decl *StmtParent;
140
141  /// \brief The visitor function.
142  CXCursorVisitor Visitor;
143
144  /// \brief The opaque client data, to be passed along to the visitor.
145  CXClientData ClientData;
146
147  // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
148  // to the visitor. Declarations with a PCH level greater than this value will
149  // be suppressed.
150  unsigned MaxPCHLevel;
151
152  /// \brief When valid, a source range to which the cursor should restrict
153  /// its search.
154  SourceRange RegionOfInterest;
155
156  // FIXME: Eventually remove.  This part of a hack to support proper
157  // iteration over all Decls contained lexically within an ObjC container.
158  DeclContext::decl_iterator *DI_current;
159  DeclContext::decl_iterator DE_current;
160
161  using DeclVisitor<CursorVisitor, bool>::Visit;
162  using TypeLocVisitor<CursorVisitor, bool>::Visit;
163  using StmtVisitor<CursorVisitor, bool>::Visit;
164
165  /// \brief Determine whether this particular source range comes before, comes
166  /// after, or overlaps the region of interest.
167  ///
168  /// \param R a half-open source range retrieved from the abstract syntax tree.
169  RangeComparisonResult CompareRegionOfInterest(SourceRange R);
170
171  class SetParentRAII {
172    CXCursor &Parent;
173    Decl *&StmtParent;
174    CXCursor OldParent;
175
176  public:
177    SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
178      : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
179    {
180      Parent = NewParent;
181      if (clang_isDeclaration(Parent.kind))
182        StmtParent = getCursorDecl(Parent);
183    }
184
185    ~SetParentRAII() {
186      Parent = OldParent;
187      if (clang_isDeclaration(Parent.kind))
188        StmtParent = getCursorDecl(Parent);
189    }
190  };
191
192public:
193  CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData,
194                unsigned MaxPCHLevel,
195                SourceRange RegionOfInterest = SourceRange())
196    : TU(TU), Visitor(Visitor), ClientData(ClientData),
197      MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest),
198      DI_current(0)
199  {
200    Parent.kind = CXCursor_NoDeclFound;
201    Parent.data[0] = 0;
202    Parent.data[1] = 0;
203    Parent.data[2] = 0;
204    StmtParent = 0;
205  }
206
207  bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
208
209  std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
210    getPreprocessedEntities();
211
212  bool VisitChildren(CXCursor Parent);
213
214  // Declaration visitors
215  bool VisitAttributes(Decl *D);
216  bool VisitBlockDecl(BlockDecl *B);
217  bool VisitCXXRecordDecl(CXXRecordDecl *D);
218  llvm::Optional<bool> shouldVisitCursor(CXCursor C);
219  bool VisitDeclContext(DeclContext *DC);
220  bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
221  bool VisitTypedefDecl(TypedefDecl *D);
222  bool VisitTagDecl(TagDecl *D);
223  bool VisitClassTemplateSpecializationDecl(ClassTemplateSpecializationDecl *D);
224  bool VisitClassTemplatePartialSpecializationDecl(
225                                     ClassTemplatePartialSpecializationDecl *D);
226  bool VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
227  bool VisitEnumConstantDecl(EnumConstantDecl *D);
228  bool VisitDeclaratorDecl(DeclaratorDecl *DD);
229  bool VisitFunctionDecl(FunctionDecl *ND);
230  bool VisitFieldDecl(FieldDecl *D);
231  bool VisitVarDecl(VarDecl *);
232  bool VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
233  bool VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
234  bool VisitClassTemplateDecl(ClassTemplateDecl *D);
235  bool VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
236  bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
237  bool VisitObjCContainerDecl(ObjCContainerDecl *D);
238  bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
239  bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
240  bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
241  bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
242  bool VisitObjCImplDecl(ObjCImplDecl *D);
243  bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
244  bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
245  // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
246  bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
247  bool VisitObjCClassDecl(ObjCClassDecl *D);
248  bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
249  bool VisitNamespaceDecl(NamespaceDecl *D);
250  bool VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
251  bool VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
252  bool VisitUsingDecl(UsingDecl *D);
253  bool VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
254  bool VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
255
256  // Name visitor
257  bool VisitDeclarationNameInfo(DeclarationNameInfo Name);
258  bool VisitNestedNameSpecifier(NestedNameSpecifier *NNS, SourceRange Range);
259
260  // Template visitors
261  bool VisitTemplateParameters(const TemplateParameterList *Params);
262  bool VisitTemplateName(TemplateName Name, SourceLocation Loc);
263  bool VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL);
264
265  // Type visitors
266  bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL);
267  bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
268  bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
269  bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
270  bool VisitTagTypeLoc(TagTypeLoc TL);
271  bool VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL);
272  bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
273  bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
274  bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
275  bool VisitPointerTypeLoc(PointerTypeLoc TL);
276  bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
277  bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
278  bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
279  bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
280  bool VisitFunctionTypeLoc(FunctionTypeLoc TL, bool SkipResultType = false);
281  bool VisitArrayTypeLoc(ArrayTypeLoc TL);
282  bool VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc TL);
283  // FIXME: Implement visitors here when the unimplemented TypeLocs get
284  // implemented
285  bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
286  bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
287
288  // Statement visitors
289  bool VisitStmt(Stmt *S);
290  bool VisitDeclStmt(DeclStmt *S);
291  bool VisitGotoStmt(GotoStmt *S);
292  bool VisitIfStmt(IfStmt *S);
293  bool VisitSwitchStmt(SwitchStmt *S);
294  bool VisitCaseStmt(CaseStmt *S);
295  bool VisitWhileStmt(WhileStmt *S);
296  bool VisitForStmt(ForStmt *S);
297
298  // Expression visitors
299  bool VisitDeclRefExpr(DeclRefExpr *E);
300  bool VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
301  bool VisitBlockExpr(BlockExpr *B);
302  bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
303  bool VisitExplicitCastExpr(ExplicitCastExpr *E);
304  bool VisitObjCMessageExpr(ObjCMessageExpr *E);
305  bool VisitObjCEncodeExpr(ObjCEncodeExpr *E);
306  bool VisitOffsetOfExpr(OffsetOfExpr *E);
307  bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
308  bool VisitMemberExpr(MemberExpr *E);
309  bool VisitAddrLabelExpr(AddrLabelExpr *E);
310  bool VisitTypesCompatibleExpr(TypesCompatibleExpr *E);
311  bool VisitVAArgExpr(VAArgExpr *E);
312  bool VisitInitListExpr(InitListExpr *E);
313  bool VisitDesignatedInitExpr(DesignatedInitExpr *E);
314  bool VisitCXXTypeidExpr(CXXTypeidExpr *E);
315  bool VisitCXXUuidofExpr(CXXUuidofExpr *E);
316  bool VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { return false; }
317  bool VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E);
318  bool VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
319  bool VisitCXXNewExpr(CXXNewExpr *E);
320  bool VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E);
321  bool VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E);
322  bool VisitOverloadExpr(OverloadExpr *E);
323  bool VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E);
324  bool VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E);
325  bool VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E);
326  bool VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E);
327};
328
329} // end anonymous namespace
330
331static SourceRange getRawCursorExtent(CXCursor C);
332
333RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
334  return RangeCompare(TU->getSourceManager(), R, RegionOfInterest);
335}
336
337/// \brief Visit the given cursor and, if requested by the visitor,
338/// its children.
339///
340/// \param Cursor the cursor to visit.
341///
342/// \param CheckRegionOfInterest if true, then the caller already checked that
343/// this cursor is within the region of interest.
344///
345/// \returns true if the visitation should be aborted, false if it
346/// should continue.
347bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
348  if (clang_isInvalid(Cursor.kind))
349    return false;
350
351  if (clang_isDeclaration(Cursor.kind)) {
352    Decl *D = getCursorDecl(Cursor);
353    assert(D && "Invalid declaration cursor");
354    if (D->getPCHLevel() > MaxPCHLevel)
355      return false;
356
357    if (D->isImplicit())
358      return false;
359  }
360
361  // If we have a range of interest, and this cursor doesn't intersect with it,
362  // we're done.
363  if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
364    SourceRange Range = getRawCursorExtent(Cursor);
365    if (Range.isInvalid() || CompareRegionOfInterest(Range))
366      return false;
367  }
368
369  switch (Visitor(Cursor, Parent, ClientData)) {
370  case CXChildVisit_Break:
371    return true;
372
373  case CXChildVisit_Continue:
374    return false;
375
376  case CXChildVisit_Recurse:
377    return VisitChildren(Cursor);
378  }
379
380  return false;
381}
382
383std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
384CursorVisitor::getPreprocessedEntities() {
385  PreprocessingRecord &PPRec
386    = *TU->getPreprocessor().getPreprocessingRecord();
387
388  bool OnlyLocalDecls
389    = !TU->isMainFileAST() && TU->getOnlyLocalDecls();
390
391  // There is no region of interest; we have to walk everything.
392  if (RegionOfInterest.isInvalid())
393    return std::make_pair(PPRec.begin(OnlyLocalDecls),
394                          PPRec.end(OnlyLocalDecls));
395
396  // Find the file in which the region of interest lands.
397  SourceManager &SM = TU->getSourceManager();
398  std::pair<FileID, unsigned> Begin
399    = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin());
400  std::pair<FileID, unsigned> End
401    = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd());
402
403  // The region of interest spans files; we have to walk everything.
404  if (Begin.first != End.first)
405    return std::make_pair(PPRec.begin(OnlyLocalDecls),
406                          PPRec.end(OnlyLocalDecls));
407
408  ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap
409    = TU->getPreprocessedEntitiesByFile();
410  if (ByFileMap.empty()) {
411    // Build the mapping from files to sets of preprocessed entities.
412    for (PreprocessingRecord::iterator E = PPRec.begin(OnlyLocalDecls),
413                                    EEnd = PPRec.end(OnlyLocalDecls);
414         E != EEnd; ++E) {
415      std::pair<FileID, unsigned> P
416        = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin());
417      ByFileMap[P.first].push_back(*E);
418    }
419  }
420
421  return std::make_pair(ByFileMap[Begin.first].begin(),
422                        ByFileMap[Begin.first].end());
423}
424
425/// \brief Visit the children of the given cursor.
426///
427/// \returns true if the visitation should be aborted, false if it
428/// should continue.
429bool CursorVisitor::VisitChildren(CXCursor Cursor) {
430  if (clang_isReference(Cursor.kind)) {
431    // By definition, references have no children.
432    return false;
433  }
434
435  // Set the Parent field to Cursor, then back to its old value once we're
436  // done.
437  SetParentRAII SetParent(Parent, StmtParent, Cursor);
438
439  if (clang_isDeclaration(Cursor.kind)) {
440    Decl *D = getCursorDecl(Cursor);
441    assert(D && "Invalid declaration cursor");
442    return VisitAttributes(D) || Visit(D);
443  }
444
445  if (clang_isStatement(Cursor.kind))
446    return Visit(getCursorStmt(Cursor));
447  if (clang_isExpression(Cursor.kind))
448    return Visit(getCursorExpr(Cursor));
449
450  if (clang_isTranslationUnit(Cursor.kind)) {
451    ASTUnit *CXXUnit = getCursorASTUnit(Cursor);
452    if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
453        RegionOfInterest.isInvalid()) {
454      for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
455                                    TLEnd = CXXUnit->top_level_end();
456           TL != TLEnd; ++TL) {
457        if (Visit(MakeCXCursor(*TL, CXXUnit), true))
458          return true;
459      }
460    } else if (VisitDeclContext(
461                            CXXUnit->getASTContext().getTranslationUnitDecl()))
462      return true;
463
464    // Walk the preprocessing record.
465    if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
466      // FIXME: Once we have the ability to deserialize a preprocessing record,
467      // do so.
468      PreprocessingRecord::iterator E, EEnd;
469      for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) {
470        if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
471          if (Visit(MakeMacroInstantiationCursor(MI, CXXUnit)))
472            return true;
473
474          continue;
475        }
476
477        if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
478          if (Visit(MakeMacroDefinitionCursor(MD, CXXUnit)))
479            return true;
480
481          continue;
482        }
483
484        if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
485          if (Visit(MakeInclusionDirectiveCursor(ID, CXXUnit)))
486            return true;
487
488          continue;
489        }
490      }
491    }
492    return false;
493  }
494
495  // Nothing to visit at the moment.
496  return false;
497}
498
499bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
500  if (Visit(B->getSignatureAsWritten()->getTypeLoc()))
501    return true;
502
503  if (Stmt *Body = B->getBody())
504    return Visit(MakeCXCursor(Body, StmtParent, TU));
505
506  return false;
507}
508
509llvm::Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
510  if (RegionOfInterest.isValid()) {
511    SourceRange Range = getRawCursorExtent(Cursor);
512    if (Range.isInvalid())
513      return llvm::Optional<bool>();
514
515    switch (CompareRegionOfInterest(Range)) {
516    case RangeBefore:
517      // This declaration comes before the region of interest; skip it.
518      return llvm::Optional<bool>();
519
520    case RangeAfter:
521      // This declaration comes after the region of interest; we're done.
522      return false;
523
524    case RangeOverlap:
525      // This declaration overlaps the region of interest; visit it.
526      break;
527    }
528  }
529  return true;
530}
531
532bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
533  DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
534
535  // FIXME: Eventually remove.  This part of a hack to support proper
536  // iteration over all Decls contained lexically within an ObjC container.
537  SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
538  SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
539
540  for ( ; I != E; ++I) {
541    Decl *D = *I;
542    if (D->getLexicalDeclContext() != DC)
543      continue;
544    CXCursor Cursor = MakeCXCursor(D, TU);
545    const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
546    if (!V.hasValue())
547      continue;
548    if (!V.getValue())
549      return false;
550    if (Visit(Cursor, true))
551      return true;
552  }
553  return false;
554}
555
556bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
557  llvm_unreachable("Translation units are visited directly by Visit()");
558  return false;
559}
560
561bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
562  if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
563    return Visit(TSInfo->getTypeLoc());
564
565  return false;
566}
567
568bool CursorVisitor::VisitTagDecl(TagDecl *D) {
569  return VisitDeclContext(D);
570}
571
572bool CursorVisitor::VisitClassTemplateSpecializationDecl(
573                                          ClassTemplateSpecializationDecl *D) {
574  bool ShouldVisitBody = false;
575  switch (D->getSpecializationKind()) {
576  case TSK_Undeclared:
577  case TSK_ImplicitInstantiation:
578    // Nothing to visit
579    return false;
580
581  case TSK_ExplicitInstantiationDeclaration:
582  case TSK_ExplicitInstantiationDefinition:
583    break;
584
585  case TSK_ExplicitSpecialization:
586    ShouldVisitBody = true;
587    break;
588  }
589
590  // Visit the template arguments used in the specialization.
591  if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
592    TypeLoc TL = SpecType->getTypeLoc();
593    if (TemplateSpecializationTypeLoc *TSTLoc
594          = dyn_cast<TemplateSpecializationTypeLoc>(&TL)) {
595      for (unsigned I = 0, N = TSTLoc->getNumArgs(); I != N; ++I)
596        if (VisitTemplateArgumentLoc(TSTLoc->getArgLoc(I)))
597          return true;
598    }
599  }
600
601  if (ShouldVisitBody && VisitCXXRecordDecl(D))
602    return true;
603
604  return false;
605}
606
607bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
608                                   ClassTemplatePartialSpecializationDecl *D) {
609  // FIXME: Visit the "outer" template parameter lists on the TagDecl
610  // before visiting these template parameters.
611  if (VisitTemplateParameters(D->getTemplateParameters()))
612    return true;
613
614  // Visit the partial specialization arguments.
615  const TemplateArgumentLoc *TemplateArgs = D->getTemplateArgsAsWritten();
616  for (unsigned I = 0, N = D->getNumTemplateArgsAsWritten(); I != N; ++I)
617    if (VisitTemplateArgumentLoc(TemplateArgs[I]))
618      return true;
619
620  return VisitCXXRecordDecl(D);
621}
622
623bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
624  // Visit the default argument.
625  if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
626    if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
627      if (Visit(DefArg->getTypeLoc()))
628        return true;
629
630  return false;
631}
632
633bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
634  if (Expr *Init = D->getInitExpr())
635    return Visit(MakeCXCursor(Init, StmtParent, TU));
636  return false;
637}
638
639bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
640  if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
641    if (Visit(TSInfo->getTypeLoc()))
642      return true;
643
644  return false;
645}
646
647/// \brief Compare two base or member initializers based on their source order.
648static int CompareCXXBaseOrMemberInitializers(const void* Xp, const void *Yp) {
649  CXXBaseOrMemberInitializer const * const *X
650    = static_cast<CXXBaseOrMemberInitializer const * const *>(Xp);
651  CXXBaseOrMemberInitializer const * const *Y
652    = static_cast<CXXBaseOrMemberInitializer const * const *>(Yp);
653
654  if ((*X)->getSourceOrder() < (*Y)->getSourceOrder())
655    return -1;
656  else if ((*X)->getSourceOrder() > (*Y)->getSourceOrder())
657    return 1;
658  else
659    return 0;
660}
661
662bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
663  if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
664    // Visit the function declaration's syntactic components in the order
665    // written. This requires a bit of work.
666    TypeLoc TL = TSInfo->getTypeLoc();
667    FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL);
668
669    // If we have a function declared directly (without the use of a typedef),
670    // visit just the return type. Otherwise, just visit the function's type
671    // now.
672    if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL->getResultLoc())) ||
673        (!FTL && Visit(TL)))
674      return true;
675
676    // Visit the nested-name-specifier, if present.
677    if (NestedNameSpecifier *Qualifier = ND->getQualifier())
678      if (VisitNestedNameSpecifier(Qualifier, ND->getQualifierRange()))
679        return true;
680
681    // Visit the declaration name.
682    if (VisitDeclarationNameInfo(ND->getNameInfo()))
683      return true;
684
685    // FIXME: Visit explicitly-specified template arguments!
686
687    // Visit the function parameters, if we have a function type.
688    if (FTL && VisitFunctionTypeLoc(*FTL, true))
689      return true;
690
691    // FIXME: Attributes?
692  }
693
694  if (ND->isThisDeclarationADefinition()) {
695    if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
696      // Find the initializers that were written in the source.
697      llvm::SmallVector<CXXBaseOrMemberInitializer *, 4> WrittenInits;
698      for (CXXConstructorDecl::init_iterator I = Constructor->init_begin(),
699                                          IEnd = Constructor->init_end();
700           I != IEnd; ++I) {
701        if (!(*I)->isWritten())
702          continue;
703
704        WrittenInits.push_back(*I);
705      }
706
707      // Sort the initializers in source order
708      llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
709                           &CompareCXXBaseOrMemberInitializers);
710
711      // Visit the initializers in source order
712      for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
713        CXXBaseOrMemberInitializer *Init = WrittenInits[I];
714        if (Init->isMemberInitializer()) {
715          if (Visit(MakeCursorMemberRef(Init->getMember(),
716                                        Init->getMemberLocation(), TU)))
717            return true;
718        } else if (TypeSourceInfo *BaseInfo = Init->getBaseClassInfo()) {
719          if (Visit(BaseInfo->getTypeLoc()))
720            return true;
721        }
722
723        // Visit the initializer value.
724        if (Expr *Initializer = Init->getInit())
725          if (Visit(MakeCXCursor(Initializer, ND, TU)))
726            return true;
727      }
728    }
729
730    if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
731      return true;
732  }
733
734  return false;
735}
736
737bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
738  if (VisitDeclaratorDecl(D))
739    return true;
740
741  if (Expr *BitWidth = D->getBitWidth())
742    return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
743
744  return false;
745}
746
747bool CursorVisitor::VisitVarDecl(VarDecl *D) {
748  if (VisitDeclaratorDecl(D))
749    return true;
750
751  if (Expr *Init = D->getInit())
752    return Visit(MakeCXCursor(Init, StmtParent, TU));
753
754  return false;
755}
756
757bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
758  if (VisitDeclaratorDecl(D))
759    return true;
760
761  if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
762    if (Expr *DefArg = D->getDefaultArgument())
763      return Visit(MakeCXCursor(DefArg, StmtParent, TU));
764
765  return false;
766}
767
768bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
769  // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
770  // before visiting these template parameters.
771  if (VisitTemplateParameters(D->getTemplateParameters()))
772    return true;
773
774  return VisitFunctionDecl(D->getTemplatedDecl());
775}
776
777bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
778  // FIXME: Visit the "outer" template parameter lists on the TagDecl
779  // before visiting these template parameters.
780  if (VisitTemplateParameters(D->getTemplateParameters()))
781    return true;
782
783  return VisitCXXRecordDecl(D->getTemplatedDecl());
784}
785
786bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
787  if (VisitTemplateParameters(D->getTemplateParameters()))
788    return true;
789
790  if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
791      VisitTemplateArgumentLoc(D->getDefaultArgument()))
792    return true;
793
794  return false;
795}
796
797bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
798  if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
799    if (Visit(TSInfo->getTypeLoc()))
800      return true;
801
802  for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
803       PEnd = ND->param_end();
804       P != PEnd; ++P) {
805    if (Visit(MakeCXCursor(*P, TU)))
806      return true;
807  }
808
809  if (ND->isThisDeclarationADefinition() &&
810      Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
811    return true;
812
813  return false;
814}
815
816namespace {
817  struct ContainerDeclsSort {
818    SourceManager &SM;
819    ContainerDeclsSort(SourceManager &sm) : SM(sm) {}
820    bool operator()(Decl *A, Decl *B) {
821      SourceLocation L_A = A->getLocStart();
822      SourceLocation L_B = B->getLocStart();
823      assert(L_A.isValid() && L_B.isValid());
824      return SM.isBeforeInTranslationUnit(L_A, L_B);
825    }
826  };
827}
828
829bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
830  // FIXME: Eventually convert back to just 'VisitDeclContext()'.  Essentially
831  // an @implementation can lexically contain Decls that are not properly
832  // nested in the AST.  When we identify such cases, we need to retrofit
833  // this nesting here.
834  if (!DI_current)
835    return VisitDeclContext(D);
836
837  // Scan the Decls that immediately come after the container
838  // in the current DeclContext.  If any fall within the
839  // container's lexical region, stash them into a vector
840  // for later processing.
841  llvm::SmallVector<Decl *, 24> DeclsInContainer;
842  SourceLocation EndLoc = D->getSourceRange().getEnd();
843  SourceManager &SM = TU->getSourceManager();
844  if (EndLoc.isValid()) {
845    DeclContext::decl_iterator next = *DI_current;
846    while (++next != DE_current) {
847      Decl *D_next = *next;
848      if (!D_next)
849        break;
850      SourceLocation L = D_next->getLocStart();
851      if (!L.isValid())
852        break;
853      if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
854        *DI_current = next;
855        DeclsInContainer.push_back(D_next);
856        continue;
857      }
858      break;
859    }
860  }
861
862  // The common case.
863  if (DeclsInContainer.empty())
864    return VisitDeclContext(D);
865
866  // Get all the Decls in the DeclContext, and sort them with the
867  // additional ones we've collected.  Then visit them.
868  for (DeclContext::decl_iterator I = D->decls_begin(), E = D->decls_end();
869       I!=E; ++I) {
870    Decl *subDecl = *I;
871    if (!subDecl || subDecl->getLexicalDeclContext() != D ||
872        subDecl->getLocStart().isInvalid())
873      continue;
874    DeclsInContainer.push_back(subDecl);
875  }
876
877  // Now sort the Decls so that they appear in lexical order.
878  std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
879            ContainerDeclsSort(SM));
880
881  // Now visit the decls.
882  for (llvm::SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
883         E = DeclsInContainer.end(); I != E; ++I) {
884    CXCursor Cursor = MakeCXCursor(*I, TU);
885    const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
886    if (!V.hasValue())
887      continue;
888    if (!V.getValue())
889      return false;
890    if (Visit(Cursor, true))
891      return true;
892  }
893  return false;
894}
895
896bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
897  if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
898                                   TU)))
899    return true;
900
901  ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
902  for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
903         E = ND->protocol_end(); I != E; ++I, ++PL)
904    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
905      return true;
906
907  return VisitObjCContainerDecl(ND);
908}
909
910bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
911  ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
912  for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
913       E = PID->protocol_end(); I != E; ++I, ++PL)
914    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
915      return true;
916
917  return VisitObjCContainerDecl(PID);
918}
919
920bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
921  if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
922    return true;
923
924  // FIXME: This implements a workaround with @property declarations also being
925  // installed in the DeclContext for the @interface.  Eventually this code
926  // should be removed.
927  ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
928  if (!CDecl || !CDecl->IsClassExtension())
929    return false;
930
931  ObjCInterfaceDecl *ID = CDecl->getClassInterface();
932  if (!ID)
933    return false;
934
935  IdentifierInfo *PropertyId = PD->getIdentifier();
936  ObjCPropertyDecl *prevDecl =
937    ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
938
939  if (!prevDecl)
940    return false;
941
942  // Visit synthesized methods since they will be skipped when visiting
943  // the @interface.
944  if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
945    if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
946      if (Visit(MakeCXCursor(MD, TU)))
947        return true;
948
949  if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
950    if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
951      if (Visit(MakeCXCursor(MD, TU)))
952        return true;
953
954  return false;
955}
956
957bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
958  // Issue callbacks for super class.
959  if (D->getSuperClass() &&
960      Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
961                                        D->getSuperClassLoc(),
962                                        TU)))
963    return true;
964
965  ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
966  for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
967         E = D->protocol_end(); I != E; ++I, ++PL)
968    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
969      return true;
970
971  return VisitObjCContainerDecl(D);
972}
973
974bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
975  return VisitObjCContainerDecl(D);
976}
977
978bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
979  // 'ID' could be null when dealing with invalid code.
980  if (ObjCInterfaceDecl *ID = D->getClassInterface())
981    if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
982      return true;
983
984  return VisitObjCImplDecl(D);
985}
986
987bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
988#if 0
989  // Issue callbacks for super class.
990  // FIXME: No source location information!
991  if (D->getSuperClass() &&
992      Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
993                                        D->getSuperClassLoc(),
994                                        TU)))
995    return true;
996#endif
997
998  return VisitObjCImplDecl(D);
999}
1000
1001bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
1002  ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1003  for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
1004                                                  E = D->protocol_end();
1005       I != E; ++I, ++PL)
1006    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1007      return true;
1008
1009  return false;
1010}
1011
1012bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
1013  for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
1014    if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
1015      return true;
1016
1017  return false;
1018}
1019
1020bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1021  return VisitDeclContext(D);
1022}
1023
1024bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
1025  // Visit nested-name-specifier.
1026  if (NestedNameSpecifier *Qualifier = D->getQualifier())
1027    if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1028      return true;
1029
1030  return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1031                                      D->getTargetNameLoc(), TU));
1032}
1033
1034bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
1035  // Visit nested-name-specifier.
1036  if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameDecl())
1037    if (VisitNestedNameSpecifier(Qualifier, D->getNestedNameRange()))
1038      return true;
1039
1040  if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1041    return true;
1042
1043  return VisitDeclarationNameInfo(D->getNameInfo());
1044}
1045
1046bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
1047  // Visit nested-name-specifier.
1048  if (NestedNameSpecifier *Qualifier = D->getQualifier())
1049    if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1050      return true;
1051
1052  return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1053                                      D->getIdentLocation(), TU));
1054}
1055
1056bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1057  // Visit nested-name-specifier.
1058  if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1059    if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1060      return true;
1061
1062  return VisitDeclarationNameInfo(D->getNameInfo());
1063}
1064
1065bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1066                                               UnresolvedUsingTypenameDecl *D) {
1067  // Visit nested-name-specifier.
1068  if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1069    if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1070      return true;
1071
1072  return false;
1073}
1074
1075bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1076  switch (Name.getName().getNameKind()) {
1077  case clang::DeclarationName::Identifier:
1078  case clang::DeclarationName::CXXLiteralOperatorName:
1079  case clang::DeclarationName::CXXOperatorName:
1080  case clang::DeclarationName::CXXUsingDirective:
1081    return false;
1082
1083  case clang::DeclarationName::CXXConstructorName:
1084  case clang::DeclarationName::CXXDestructorName:
1085  case clang::DeclarationName::CXXConversionFunctionName:
1086    if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1087      return Visit(TSInfo->getTypeLoc());
1088    return false;
1089
1090  case clang::DeclarationName::ObjCZeroArgSelector:
1091  case clang::DeclarationName::ObjCOneArgSelector:
1092  case clang::DeclarationName::ObjCMultiArgSelector:
1093    // FIXME: Per-identifier location info?
1094    return false;
1095  }
1096
1097  return false;
1098}
1099
1100bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1101                                             SourceRange Range) {
1102  // FIXME: This whole routine is a hack to work around the lack of proper
1103  // source information in nested-name-specifiers (PR5791). Since we do have
1104  // a beginning source location, we can visit the first component of the
1105  // nested-name-specifier, if it's a single-token component.
1106  if (!NNS)
1107    return false;
1108
1109  // Get the first component in the nested-name-specifier.
1110  while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1111    NNS = Prefix;
1112
1113  switch (NNS->getKind()) {
1114  case NestedNameSpecifier::Namespace:
1115    // FIXME: The token at this source location might actually have been a
1116    // namespace alias, but we don't model that. Lame!
1117    return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1118                                        TU));
1119
1120  case NestedNameSpecifier::TypeSpec: {
1121    // If the type has a form where we know that the beginning of the source
1122    // range matches up with a reference cursor. Visit the appropriate reference
1123    // cursor.
1124    Type *T = NNS->getAsType();
1125    if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1126      return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1127    if (const TagType *Tag = dyn_cast<TagType>(T))
1128      return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1129    if (const TemplateSpecializationType *TST
1130                                      = dyn_cast<TemplateSpecializationType>(T))
1131      return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1132    break;
1133  }
1134
1135  case NestedNameSpecifier::TypeSpecWithTemplate:
1136  case NestedNameSpecifier::Global:
1137  case NestedNameSpecifier::Identifier:
1138    break;
1139  }
1140
1141  return false;
1142}
1143
1144bool CursorVisitor::VisitTemplateParameters(
1145                                          const TemplateParameterList *Params) {
1146  if (!Params)
1147    return false;
1148
1149  for (TemplateParameterList::const_iterator P = Params->begin(),
1150                                          PEnd = Params->end();
1151       P != PEnd; ++P) {
1152    if (Visit(MakeCXCursor(*P, TU)))
1153      return true;
1154  }
1155
1156  return false;
1157}
1158
1159bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1160  switch (Name.getKind()) {
1161  case TemplateName::Template:
1162    return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1163
1164  case TemplateName::OverloadedTemplate:
1165    // Visit the overloaded template set.
1166    if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1167      return true;
1168
1169    return false;
1170
1171  case TemplateName::DependentTemplate:
1172    // FIXME: Visit nested-name-specifier.
1173    return false;
1174
1175  case TemplateName::QualifiedTemplate:
1176    // FIXME: Visit nested-name-specifier.
1177    return Visit(MakeCursorTemplateRef(
1178                                  Name.getAsQualifiedTemplateName()->getDecl(),
1179                                       Loc, TU));
1180  }
1181
1182  return false;
1183}
1184
1185bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1186  switch (TAL.getArgument().getKind()) {
1187  case TemplateArgument::Null:
1188  case TemplateArgument::Integral:
1189    return false;
1190
1191  case TemplateArgument::Pack:
1192    // FIXME: Implement when variadic templates come along.
1193    return false;
1194
1195  case TemplateArgument::Type:
1196    if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1197      return Visit(TSInfo->getTypeLoc());
1198    return false;
1199
1200  case TemplateArgument::Declaration:
1201    if (Expr *E = TAL.getSourceDeclExpression())
1202      return Visit(MakeCXCursor(E, StmtParent, TU));
1203    return false;
1204
1205  case TemplateArgument::Expression:
1206    if (Expr *E = TAL.getSourceExpression())
1207      return Visit(MakeCXCursor(E, StmtParent, TU));
1208    return false;
1209
1210  case TemplateArgument::Template:
1211    return VisitTemplateName(TAL.getArgument().getAsTemplate(),
1212                             TAL.getTemplateNameLoc());
1213  }
1214
1215  return false;
1216}
1217
1218bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1219  return VisitDeclContext(D);
1220}
1221
1222bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1223  return Visit(TL.getUnqualifiedLoc());
1224}
1225
1226bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1227  ASTContext &Context = TU->getASTContext();
1228
1229  // Some builtin types (such as Objective-C's "id", "sel", and
1230  // "Class") have associated declarations. Create cursors for those.
1231  QualType VisitType;
1232  switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
1233  case BuiltinType::Void:
1234  case BuiltinType::Bool:
1235  case BuiltinType::Char_U:
1236  case BuiltinType::UChar:
1237  case BuiltinType::Char16:
1238  case BuiltinType::Char32:
1239  case BuiltinType::UShort:
1240  case BuiltinType::UInt:
1241  case BuiltinType::ULong:
1242  case BuiltinType::ULongLong:
1243  case BuiltinType::UInt128:
1244  case BuiltinType::Char_S:
1245  case BuiltinType::SChar:
1246  case BuiltinType::WChar:
1247  case BuiltinType::Short:
1248  case BuiltinType::Int:
1249  case BuiltinType::Long:
1250  case BuiltinType::LongLong:
1251  case BuiltinType::Int128:
1252  case BuiltinType::Float:
1253  case BuiltinType::Double:
1254  case BuiltinType::LongDouble:
1255  case BuiltinType::NullPtr:
1256  case BuiltinType::Overload:
1257  case BuiltinType::Dependent:
1258    break;
1259
1260  case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
1261    break;
1262
1263  case BuiltinType::ObjCId:
1264    VisitType = Context.getObjCIdType();
1265    break;
1266
1267  case BuiltinType::ObjCClass:
1268    VisitType = Context.getObjCClassType();
1269    break;
1270
1271  case BuiltinType::ObjCSel:
1272    VisitType = Context.getObjCSelType();
1273    break;
1274  }
1275
1276  if (!VisitType.isNull()) {
1277    if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
1278      return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
1279                                     TU));
1280  }
1281
1282  return false;
1283}
1284
1285bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1286  return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
1287}
1288
1289bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1290  return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1291}
1292
1293bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1294  return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1295}
1296
1297bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1298  // FIXME: We can't visit the template type parameter, because there's
1299  // no context information with which we can match up the depth/index in the
1300  // type to the appropriate
1301  return false;
1302}
1303
1304bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1305  if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
1306    return true;
1307
1308  return false;
1309}
1310
1311bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1312  if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1313    return true;
1314
1315  for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1316    if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1317                                        TU)))
1318      return true;
1319  }
1320
1321  return false;
1322}
1323
1324bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
1325  return Visit(TL.getPointeeLoc());
1326}
1327
1328bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1329  return Visit(TL.getPointeeLoc());
1330}
1331
1332bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1333  return Visit(TL.getPointeeLoc());
1334}
1335
1336bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1337  return Visit(TL.getPointeeLoc());
1338}
1339
1340bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
1341  return Visit(TL.getPointeeLoc());
1342}
1343
1344bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
1345  return Visit(TL.getPointeeLoc());
1346}
1347
1348bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1349                                         bool SkipResultType) {
1350  if (!SkipResultType && Visit(TL.getResultLoc()))
1351    return true;
1352
1353  for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1354    if (Decl *D = TL.getArg(I))
1355      if (Visit(MakeCXCursor(D, TU)))
1356        return true;
1357
1358  return false;
1359}
1360
1361bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1362  if (Visit(TL.getElementLoc()))
1363    return true;
1364
1365  if (Expr *Size = TL.getSizeExpr())
1366    return Visit(MakeCXCursor(Size, StmtParent, TU));
1367
1368  return false;
1369}
1370
1371bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1372                                             TemplateSpecializationTypeLoc TL) {
1373  // Visit the template name.
1374  if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1375                        TL.getTemplateNameLoc()))
1376    return true;
1377
1378  // Visit the template arguments.
1379  for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1380    if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1381      return true;
1382
1383  return false;
1384}
1385
1386bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1387  return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1388}
1389
1390bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1391  if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1392    return Visit(TSInfo->getTypeLoc());
1393
1394  return false;
1395}
1396
1397bool CursorVisitor::VisitStmt(Stmt *S) {
1398  for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
1399       Child != ChildEnd; ++Child) {
1400    if (Stmt *C = *Child)
1401      if (Visit(MakeCXCursor(C, StmtParent, TU)))
1402        return true;
1403  }
1404
1405  return false;
1406}
1407
1408bool CursorVisitor::VisitCaseStmt(CaseStmt *S) {
1409  // Specially handle CaseStmts because they can be nested, e.g.:
1410  //
1411  //    case 1:
1412  //    case 2:
1413  //
1414  // In this case the second CaseStmt is the child of the first.  Walking
1415  // these recursively can blow out the stack.
1416  CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
1417  while (true) {
1418    // Set the Parent field to Cursor, then back to its old value once we're
1419    //   done.
1420    SetParentRAII SetParent(Parent, StmtParent, Cursor);
1421
1422    if (Stmt *LHS = S->getLHS())
1423      if (Visit(MakeCXCursor(LHS, StmtParent, TU)))
1424        return true;
1425    if (Stmt *RHS = S->getRHS())
1426      if (Visit(MakeCXCursor(RHS, StmtParent, TU)))
1427        return true;
1428    if (Stmt *SubStmt = S->getSubStmt()) {
1429      if (!isa<CaseStmt>(SubStmt))
1430        return Visit(MakeCXCursor(SubStmt, StmtParent, TU));
1431
1432      // Specially handle 'CaseStmt' so that we don't blow out the stack.
1433      CaseStmt *CS = cast<CaseStmt>(SubStmt);
1434      Cursor = MakeCXCursor(CS, StmtParent, TU);
1435      if (RegionOfInterest.isValid()) {
1436        SourceRange Range = CS->getSourceRange();
1437        if (Range.isInvalid() || CompareRegionOfInterest(Range))
1438          return false;
1439      }
1440
1441      switch (Visitor(Cursor, Parent, ClientData)) {
1442        case CXChildVisit_Break: return true;
1443        case CXChildVisit_Continue: return false;
1444        case CXChildVisit_Recurse:
1445          // Perform tail-recursion manually.
1446          S = CS;
1447          continue;
1448      }
1449    }
1450    return false;
1451  }
1452}
1453
1454bool CursorVisitor::VisitDeclStmt(DeclStmt *S) {
1455  bool isFirst = true;
1456  for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
1457       D != DEnd; ++D) {
1458    if (*D && Visit(MakeCXCursor(*D, TU, isFirst)))
1459      return true;
1460    isFirst = false;
1461  }
1462
1463  return false;
1464}
1465
1466bool CursorVisitor::VisitGotoStmt(GotoStmt *S) {
1467  return Visit(MakeCursorLabelRef(S->getLabel(), S->getLabelLoc(), TU));
1468}
1469
1470bool CursorVisitor::VisitIfStmt(IfStmt *S) {
1471  if (VarDecl *Var = S->getConditionVariable()) {
1472    if (Visit(MakeCXCursor(Var, TU)))
1473      return true;
1474  }
1475
1476  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1477    return true;
1478  if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU)))
1479    return true;
1480  if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU)))
1481    return true;
1482
1483  return false;
1484}
1485
1486bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) {
1487  if (VarDecl *Var = S->getConditionVariable()) {
1488    if (Visit(MakeCXCursor(Var, TU)))
1489      return true;
1490  }
1491
1492  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1493    return true;
1494  if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1495    return true;
1496
1497  return false;
1498}
1499
1500bool CursorVisitor::VisitWhileStmt(WhileStmt *S) {
1501  if (VarDecl *Var = S->getConditionVariable()) {
1502    if (Visit(MakeCXCursor(Var, TU)))
1503      return true;
1504  }
1505
1506  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1507    return true;
1508  if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1509    return true;
1510
1511  return false;
1512}
1513
1514bool CursorVisitor::VisitForStmt(ForStmt *S) {
1515  if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU)))
1516    return true;
1517  if (VarDecl *Var = S->getConditionVariable()) {
1518    if (Visit(MakeCXCursor(Var, TU)))
1519      return true;
1520  }
1521
1522  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1523    return true;
1524  if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU)))
1525    return true;
1526  if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1527    return true;
1528
1529  return false;
1530}
1531
1532bool CursorVisitor::VisitDeclRefExpr(DeclRefExpr *E) {
1533  // Visit nested-name-specifier, if present.
1534  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1535    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1536      return true;
1537
1538  // Visit declaration name.
1539  if (VisitDeclarationNameInfo(E->getNameInfo()))
1540    return true;
1541
1542  // Visit explicitly-specified template arguments.
1543  if (E->hasExplicitTemplateArgs()) {
1544    ExplicitTemplateArgumentList &Args = E->getExplicitTemplateArgs();
1545    for (TemplateArgumentLoc *Arg = Args.getTemplateArgs(),
1546                          *ArgEnd = Arg + Args.NumTemplateArgs;
1547         Arg != ArgEnd; ++Arg)
1548      if (VisitTemplateArgumentLoc(*Arg))
1549        return true;
1550  }
1551
1552  return false;
1553}
1554
1555bool CursorVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E) {
1556  if (Visit(MakeCXCursor(E->getArg(0), StmtParent, TU)))
1557    return true;
1558
1559  if (Visit(MakeCXCursor(E->getCallee(), StmtParent, TU)))
1560    return true;
1561
1562  for (unsigned I = 1, N = E->getNumArgs(); I != N; ++I)
1563    if (Visit(MakeCXCursor(E->getArg(I), StmtParent, TU)))
1564      return true;
1565
1566  return false;
1567}
1568
1569bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1570  if (D->isDefinition()) {
1571    for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1572         E = D->bases_end(); I != E; ++I) {
1573      if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU)))
1574        return true;
1575    }
1576  }
1577
1578  return VisitTagDecl(D);
1579}
1580
1581
1582bool CursorVisitor::VisitBlockExpr(BlockExpr *B) {
1583  return Visit(B->getBlockDecl());
1584}
1585
1586bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1587  // Visit the type into which we're computing an offset.
1588  if (Visit(E->getTypeSourceInfo()->getTypeLoc()))
1589    return true;
1590
1591  // Visit the components of the offsetof expression.
1592  for (unsigned I = 0, N = E->getNumComponents(); I != N; ++I) {
1593    typedef OffsetOfExpr::OffsetOfNode OffsetOfNode;
1594    const OffsetOfNode &Node = E->getComponent(I);
1595    switch (Node.getKind()) {
1596    case OffsetOfNode::Array:
1597      if (Visit(MakeCXCursor(E->getIndexExpr(Node.getArrayExprIndex()),
1598                             StmtParent, TU)))
1599        return true;
1600      break;
1601
1602    case OffsetOfNode::Field:
1603      if (Visit(MakeCursorMemberRef(Node.getField(), Node.getRange().getEnd(),
1604                                    TU)))
1605        return true;
1606      break;
1607
1608    case OffsetOfNode::Identifier:
1609    case OffsetOfNode::Base:
1610      continue;
1611    }
1612  }
1613
1614  return false;
1615}
1616
1617bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1618  if (E->isArgumentType()) {
1619    if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo())
1620      return Visit(TSInfo->getTypeLoc());
1621
1622    return false;
1623  }
1624
1625  return VisitExpr(E);
1626}
1627
1628bool CursorVisitor::VisitMemberExpr(MemberExpr *E) {
1629  // Visit the base expression.
1630  if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1631    return true;
1632
1633  // Visit the nested-name-specifier
1634  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1635    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1636      return true;
1637
1638  // Visit the declaration name.
1639  if (VisitDeclarationNameInfo(E->getMemberNameInfo()))
1640    return true;
1641
1642  // Visit the explicitly-specified template arguments, if any.
1643  if (E->hasExplicitTemplateArgs()) {
1644    for (const TemplateArgumentLoc *Arg = E->getTemplateArgs(),
1645                                *ArgEnd = Arg + E->getNumTemplateArgs();
1646         Arg != ArgEnd;
1647         ++Arg) {
1648      if (VisitTemplateArgumentLoc(*Arg))
1649        return true;
1650    }
1651  }
1652
1653  return false;
1654}
1655
1656bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1657  if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten())
1658    if (Visit(TSInfo->getTypeLoc()))
1659      return true;
1660
1661  return VisitCastExpr(E);
1662}
1663
1664bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1665  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1666    if (Visit(TSInfo->getTypeLoc()))
1667      return true;
1668
1669  return VisitExpr(E);
1670}
1671
1672bool CursorVisitor::VisitAddrLabelExpr(AddrLabelExpr *E) {
1673  return Visit(MakeCursorLabelRef(E->getLabel(), E->getLabelLoc(), TU));
1674}
1675
1676bool CursorVisitor::VisitTypesCompatibleExpr(TypesCompatibleExpr *E) {
1677  return Visit(E->getArgTInfo1()->getTypeLoc()) ||
1678         Visit(E->getArgTInfo2()->getTypeLoc());
1679}
1680
1681bool CursorVisitor::VisitVAArgExpr(VAArgExpr *E) {
1682  if (Visit(E->getWrittenTypeInfo()->getTypeLoc()))
1683    return true;
1684
1685  return Visit(MakeCXCursor(E->getSubExpr(), StmtParent, TU));
1686}
1687
1688bool CursorVisitor::VisitInitListExpr(InitListExpr *E) {
1689  // We care about the syntactic form of the initializer list, only.
1690  if (InitListExpr *Syntactic = E->getSyntacticForm())
1691    return VisitExpr(Syntactic);
1692
1693  return VisitExpr(E);
1694}
1695
1696bool CursorVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) {
1697  // Visit the designators.
1698  typedef DesignatedInitExpr::Designator Designator;
1699  for (DesignatedInitExpr::designators_iterator D = E->designators_begin(),
1700                                             DEnd = E->designators_end();
1701       D != DEnd; ++D) {
1702    if (D->isFieldDesignator()) {
1703      if (FieldDecl *Field = D->getField())
1704        if (Visit(MakeCursorMemberRef(Field, D->getFieldLoc(), TU)))
1705          return true;
1706
1707      continue;
1708    }
1709
1710    if (D->isArrayDesignator()) {
1711      if (Visit(MakeCXCursor(E->getArrayIndex(*D), StmtParent, TU)))
1712        return true;
1713
1714      continue;
1715    }
1716
1717    assert(D->isArrayRangeDesignator() && "Unknown designator kind");
1718    if (Visit(MakeCXCursor(E->getArrayRangeStart(*D), StmtParent, TU)) ||
1719        Visit(MakeCXCursor(E->getArrayRangeEnd(*D), StmtParent, TU)))
1720      return true;
1721  }
1722
1723  // Visit the initializer value itself.
1724  return Visit(MakeCXCursor(E->getInit(), StmtParent, TU));
1725}
1726
1727bool CursorVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
1728  if (E->isTypeOperand()) {
1729    if (TypeSourceInfo *TSInfo = E->getTypeOperandSourceInfo())
1730      return Visit(TSInfo->getTypeLoc());
1731
1732    return false;
1733  }
1734
1735  return VisitExpr(E);
1736}
1737
1738bool CursorVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) {
1739  if (E->isTypeOperand()) {
1740    if (TypeSourceInfo *TSInfo = E->getTypeOperandSourceInfo())
1741      return Visit(TSInfo->getTypeLoc());
1742
1743    return false;
1744  }
1745
1746  return VisitExpr(E);
1747}
1748
1749bool CursorVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) {
1750  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1751    return Visit(TSInfo->getTypeLoc());
1752
1753  return VisitExpr(E);
1754}
1755
1756bool CursorVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1757  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1758    return Visit(TSInfo->getTypeLoc());
1759
1760  return false;
1761}
1762
1763bool CursorVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1764  // Visit placement arguments.
1765  for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I)
1766    if (Visit(MakeCXCursor(E->getPlacementArg(I), StmtParent, TU)))
1767      return true;
1768
1769  // Visit the allocated type.
1770  if (TypeSourceInfo *TSInfo = E->getAllocatedTypeSourceInfo())
1771    if (Visit(TSInfo->getTypeLoc()))
1772      return true;
1773
1774  // Visit the array size, if any.
1775  if (E->isArray() && Visit(MakeCXCursor(E->getArraySize(), StmtParent, TU)))
1776    return true;
1777
1778  // Visit the initializer or constructor arguments.
1779  for (unsigned I = 0, N = E->getNumConstructorArgs(); I != N; ++I)
1780    if (Visit(MakeCXCursor(E->getConstructorArg(I), StmtParent, TU)))
1781      return true;
1782
1783  return false;
1784}
1785
1786bool CursorVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1787  // Visit base expression.
1788  if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1789    return true;
1790
1791  // Visit the nested-name-specifier.
1792  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1793    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1794      return true;
1795
1796  // Visit the scope type that looks disturbingly like the nested-name-specifier
1797  // but isn't.
1798  if (TypeSourceInfo *TSInfo = E->getScopeTypeInfo())
1799    if (Visit(TSInfo->getTypeLoc()))
1800      return true;
1801
1802  // Visit the name of the type being destroyed.
1803  if (TypeSourceInfo *TSInfo = E->getDestroyedTypeInfo())
1804    if (Visit(TSInfo->getTypeLoc()))
1805      return true;
1806
1807  return false;
1808}
1809
1810bool CursorVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
1811  return Visit(E->getQueriedTypeSourceInfo()->getTypeLoc());
1812}
1813
1814bool CursorVisitor::VisitOverloadExpr(OverloadExpr *E) {
1815  // Visit the nested-name-specifier.
1816  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1817    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1818      return true;
1819
1820  // Visit the declaration name.
1821  if (VisitDeclarationNameInfo(E->getNameInfo()))
1822    return true;
1823
1824  // Visit the overloaded declaration reference.
1825  if (Visit(MakeCursorOverloadedDeclRef(E, TU)))
1826    return true;
1827
1828  // Visit the explicitly-specified template arguments.
1829  if (const ExplicitTemplateArgumentList *ArgList
1830                                      = E->getOptionalExplicitTemplateArgs()) {
1831    for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1832                                *ArgEnd = Arg + ArgList->NumTemplateArgs;
1833         Arg != ArgEnd; ++Arg) {
1834      if (VisitTemplateArgumentLoc(*Arg))
1835        return true;
1836    }
1837  }
1838
1839  return false;
1840}
1841
1842bool CursorVisitor::VisitDependentScopeDeclRefExpr(
1843                                                DependentScopeDeclRefExpr *E) {
1844  // Visit the nested-name-specifier.
1845  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1846    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1847      return true;
1848
1849  // Visit the declaration name.
1850  if (VisitDeclarationNameInfo(E->getNameInfo()))
1851    return true;
1852
1853  // Visit the explicitly-specified template arguments.
1854  if (const ExplicitTemplateArgumentList *ArgList
1855      = E->getOptionalExplicitTemplateArgs()) {
1856    for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1857         *ArgEnd = Arg + ArgList->NumTemplateArgs;
1858         Arg != ArgEnd; ++Arg) {
1859      if (VisitTemplateArgumentLoc(*Arg))
1860        return true;
1861    }
1862  }
1863
1864  return false;
1865}
1866
1867bool CursorVisitor::VisitCXXUnresolvedConstructExpr(
1868                                                CXXUnresolvedConstructExpr *E) {
1869  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1870    if (Visit(TSInfo->getTypeLoc()))
1871      return true;
1872
1873  return VisitExpr(E);
1874}
1875
1876bool CursorVisitor::VisitCXXDependentScopeMemberExpr(
1877                                              CXXDependentScopeMemberExpr *E) {
1878  // Visit the base expression, if there is one.
1879  if (!E->isImplicitAccess() &&
1880      Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1881    return true;
1882
1883  // Visit the nested-name-specifier.
1884  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1885    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1886      return true;
1887
1888  // Visit the declaration name.
1889  if (VisitDeclarationNameInfo(E->getMemberNameInfo()))
1890    return true;
1891
1892  // Visit the explicitly-specified template arguments.
1893  if (const ExplicitTemplateArgumentList *ArgList
1894      = E->getOptionalExplicitTemplateArgs()) {
1895    for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1896         *ArgEnd = Arg + ArgList->NumTemplateArgs;
1897         Arg != ArgEnd; ++Arg) {
1898      if (VisitTemplateArgumentLoc(*Arg))
1899        return true;
1900    }
1901  }
1902
1903  return false;
1904}
1905
1906bool CursorVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E) {
1907  // Visit the base expression, if there is one.
1908  if (!E->isImplicitAccess() &&
1909      Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1910    return true;
1911
1912  return VisitOverloadExpr(E);
1913}
1914
1915bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) {
1916  if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo())
1917    if (Visit(TSInfo->getTypeLoc()))
1918      return true;
1919
1920  return VisitExpr(E);
1921}
1922
1923bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1924  return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc());
1925}
1926
1927
1928bool CursorVisitor::VisitAttributes(Decl *D) {
1929  for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1930       i != e; ++i)
1931    if (Visit(MakeCXCursor(*i, D, TU)))
1932        return true;
1933
1934  return false;
1935}
1936
1937static llvm::sys::Mutex EnableMultithreadingMutex;
1938static bool EnabledMultithreading;
1939
1940extern "C" {
1941CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
1942                          int displayDiagnostics) {
1943  // Disable pretty stack trace functionality, which will otherwise be a very
1944  // poor citizen of the world and set up all sorts of signal handlers.
1945  llvm::DisablePrettyStackTrace = true;
1946
1947  // We use crash recovery to make some of our APIs more reliable, implicitly
1948  // enable it.
1949  llvm::CrashRecoveryContext::Enable();
1950
1951  // Enable support for multithreading in LLVM.
1952  {
1953    llvm::sys::ScopedLock L(EnableMultithreadingMutex);
1954    if (!EnabledMultithreading) {
1955      llvm::llvm_start_multithreaded();
1956      EnabledMultithreading = true;
1957    }
1958  }
1959
1960  CIndexer *CIdxr = new CIndexer();
1961  if (excludeDeclarationsFromPCH)
1962    CIdxr->setOnlyLocalDecls();
1963  if (displayDiagnostics)
1964    CIdxr->setDisplayDiagnostics();
1965  return CIdxr;
1966}
1967
1968void clang_disposeIndex(CXIndex CIdx) {
1969  if (CIdx)
1970    delete static_cast<CIndexer *>(CIdx);
1971}
1972
1973CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
1974                                              const char *ast_filename) {
1975  if (!CIdx)
1976    return 0;
1977
1978  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1979
1980  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1981  return ASTUnit::LoadFromASTFile(ast_filename, Diags,
1982                                  CXXIdx->getOnlyLocalDecls(),
1983                                  0, 0, true);
1984}
1985
1986unsigned clang_defaultEditingTranslationUnitOptions() {
1987  return CXTranslationUnit_PrecompiledPreamble |
1988         CXTranslationUnit_CacheCompletionResults |
1989         CXTranslationUnit_CXXPrecompiledPreamble;
1990}
1991
1992CXTranslationUnit
1993clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
1994                                          const char *source_filename,
1995                                          int num_command_line_args,
1996                                          const char * const *command_line_args,
1997                                          unsigned num_unsaved_files,
1998                                          struct CXUnsavedFile *unsaved_files) {
1999  return clang_parseTranslationUnit(CIdx, source_filename,
2000                                    command_line_args, num_command_line_args,
2001                                    unsaved_files, num_unsaved_files,
2002                                 CXTranslationUnit_DetailedPreprocessingRecord);
2003}
2004
2005struct ParseTranslationUnitInfo {
2006  CXIndex CIdx;
2007  const char *source_filename;
2008  const char *const *command_line_args;
2009  int num_command_line_args;
2010  struct CXUnsavedFile *unsaved_files;
2011  unsigned num_unsaved_files;
2012  unsigned options;
2013  CXTranslationUnit result;
2014};
2015static void clang_parseTranslationUnit_Impl(void *UserData) {
2016  ParseTranslationUnitInfo *PTUI =
2017    static_cast<ParseTranslationUnitInfo*>(UserData);
2018  CXIndex CIdx = PTUI->CIdx;
2019  const char *source_filename = PTUI->source_filename;
2020  const char * const *command_line_args = PTUI->command_line_args;
2021  int num_command_line_args = PTUI->num_command_line_args;
2022  struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
2023  unsigned num_unsaved_files = PTUI->num_unsaved_files;
2024  unsigned options = PTUI->options;
2025  PTUI->result = 0;
2026
2027  if (!CIdx)
2028    return;
2029
2030  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2031
2032  bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
2033  bool CompleteTranslationUnit
2034    = ((options & CXTranslationUnit_Incomplete) == 0);
2035  bool CacheCodeCompetionResults
2036    = options & CXTranslationUnit_CacheCompletionResults;
2037  bool CXXPrecompilePreamble
2038    = options & CXTranslationUnit_CXXPrecompiledPreamble;
2039  bool CXXChainedPCH
2040    = options & CXTranslationUnit_CXXChainedPCH;
2041
2042  // Configure the diagnostics.
2043  DiagnosticOptions DiagOpts;
2044  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
2045  Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
2046
2047  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2048  for (unsigned I = 0; I != num_unsaved_files; ++I) {
2049    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2050    const llvm::MemoryBuffer *Buffer
2051      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
2052    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2053                                           Buffer));
2054  }
2055
2056  llvm::SmallVector<const char *, 16> Args;
2057
2058  // The 'source_filename' argument is optional.  If the caller does not
2059  // specify it then it is assumed that the source file is specified
2060  // in the actual argument list.
2061  if (source_filename)
2062    Args.push_back(source_filename);
2063
2064  // Since the Clang C library is primarily used by batch tools dealing with
2065  // (often very broken) source code, where spell-checking can have a
2066  // significant negative impact on performance (particularly when
2067  // precompiled headers are involved), we disable it by default.
2068  // Only do this if we haven't found a spell-checking-related argument.
2069  bool FoundSpellCheckingArgument = false;
2070  for (int I = 0; I != num_command_line_args; ++I) {
2071    if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
2072        strcmp(command_line_args[I], "-fspell-checking") == 0) {
2073      FoundSpellCheckingArgument = true;
2074      break;
2075    }
2076  }
2077  if (!FoundSpellCheckingArgument)
2078    Args.push_back("-fno-spell-checking");
2079
2080  Args.insert(Args.end(), command_line_args,
2081              command_line_args + num_command_line_args);
2082
2083  // Do we need the detailed preprocessing record?
2084  if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
2085    Args.push_back("-Xclang");
2086    Args.push_back("-detailed-preprocessing-record");
2087  }
2088
2089  unsigned NumErrors = Diags->getNumErrors();
2090  llvm::OwningPtr<ASTUnit> Unit(
2091    ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
2092                                 Diags,
2093                                 CXXIdx->getClangResourcesPath(),
2094                                 CXXIdx->getOnlyLocalDecls(),
2095                                 RemappedFiles.data(),
2096                                 RemappedFiles.size(),
2097                                 /*CaptureDiagnostics=*/true,
2098                                 PrecompilePreamble,
2099                                 CompleteTranslationUnit,
2100                                 CacheCodeCompetionResults,
2101                                 CXXPrecompilePreamble,
2102                                 CXXChainedPCH));
2103
2104  if (NumErrors != Diags->getNumErrors()) {
2105    // Make sure to check that 'Unit' is non-NULL.
2106    if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
2107      for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2108                                      DEnd = Unit->stored_diag_end();
2109           D != DEnd; ++D) {
2110        CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
2111        CXString Msg = clang_formatDiagnostic(&Diag,
2112                                    clang_defaultDiagnosticDisplayOptions());
2113        fprintf(stderr, "%s\n", clang_getCString(Msg));
2114        clang_disposeString(Msg);
2115      }
2116#ifdef LLVM_ON_WIN32
2117      // On Windows, force a flush, since there may be multiple copies of
2118      // stderr and stdout in the file system, all with different buffers
2119      // but writing to the same device.
2120      fflush(stderr);
2121#endif
2122    }
2123  }
2124
2125  PTUI->result = Unit.take();
2126}
2127CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2128                                             const char *source_filename,
2129                                         const char * const *command_line_args,
2130                                             int num_command_line_args,
2131                                             struct CXUnsavedFile *unsaved_files,
2132                                             unsigned num_unsaved_files,
2133                                             unsigned options) {
2134  ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
2135                                    num_command_line_args, unsaved_files, num_unsaved_files,
2136                                    options, 0 };
2137  llvm::CrashRecoveryContext CRC;
2138
2139  if (!CRC.RunSafely(clang_parseTranslationUnit_Impl, &PTUI)) {
2140    fprintf(stderr, "libclang: crash detected during parsing: {\n");
2141    fprintf(stderr, "  'source_filename' : '%s'\n", source_filename);
2142    fprintf(stderr, "  'command_line_args' : [");
2143    for (int i = 0; i != num_command_line_args; ++i) {
2144      if (i)
2145        fprintf(stderr, ", ");
2146      fprintf(stderr, "'%s'", command_line_args[i]);
2147    }
2148    fprintf(stderr, "],\n");
2149    fprintf(stderr, "  'unsaved_files' : [");
2150    for (unsigned i = 0; i != num_unsaved_files; ++i) {
2151      if (i)
2152        fprintf(stderr, ", ");
2153      fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2154              unsaved_files[i].Length);
2155    }
2156    fprintf(stderr, "],\n");
2157    fprintf(stderr, "  'options' : %d,\n", options);
2158    fprintf(stderr, "}\n");
2159
2160    return 0;
2161  }
2162
2163  return PTUI.result;
2164}
2165
2166unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2167  return CXSaveTranslationUnit_None;
2168}
2169
2170int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2171                              unsigned options) {
2172  if (!TU)
2173    return 1;
2174
2175  return static_cast<ASTUnit *>(TU)->Save(FileName);
2176}
2177
2178void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
2179  if (CTUnit) {
2180    // If the translation unit has been marked as unsafe to free, just discard
2181    // it.
2182    if (static_cast<ASTUnit *>(CTUnit)->isUnsafeToFree())
2183      return;
2184
2185    delete static_cast<ASTUnit *>(CTUnit);
2186  }
2187}
2188
2189unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2190  return CXReparse_None;
2191}
2192
2193struct ReparseTranslationUnitInfo {
2194  CXTranslationUnit TU;
2195  unsigned num_unsaved_files;
2196  struct CXUnsavedFile *unsaved_files;
2197  unsigned options;
2198  int result;
2199};
2200
2201static void clang_reparseTranslationUnit_Impl(void *UserData) {
2202  ReparseTranslationUnitInfo *RTUI =
2203    static_cast<ReparseTranslationUnitInfo*>(UserData);
2204  CXTranslationUnit TU = RTUI->TU;
2205  unsigned num_unsaved_files = RTUI->num_unsaved_files;
2206  struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2207  unsigned options = RTUI->options;
2208  (void) options;
2209  RTUI->result = 1;
2210
2211  if (!TU)
2212    return;
2213
2214  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2215  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2216
2217  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2218  for (unsigned I = 0; I != num_unsaved_files; ++I) {
2219    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2220    const llvm::MemoryBuffer *Buffer
2221      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
2222    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2223                                           Buffer));
2224  }
2225
2226  if (!CXXUnit->Reparse(RemappedFiles.data(), RemappedFiles.size()))
2227    RTUI->result = 0;
2228}
2229
2230int clang_reparseTranslationUnit(CXTranslationUnit TU,
2231                                 unsigned num_unsaved_files,
2232                                 struct CXUnsavedFile *unsaved_files,
2233                                 unsigned options) {
2234  ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2235                                      options, 0 };
2236  llvm::CrashRecoveryContext CRC;
2237
2238  if (!CRC.RunSafely(clang_reparseTranslationUnit_Impl, &RTUI)) {
2239    fprintf(stderr, "libclang: crash detected during reparsing\n");
2240    static_cast<ASTUnit *>(TU)->setUnsafeToFree(true);
2241    return 1;
2242  }
2243
2244
2245  return RTUI.result;
2246}
2247
2248
2249CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
2250  if (!CTUnit)
2251    return createCXString("");
2252
2253  ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
2254  return createCXString(CXXUnit->getOriginalSourceFileName(), true);
2255}
2256
2257CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
2258  CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
2259  return Result;
2260}
2261
2262} // end: extern "C"
2263
2264//===----------------------------------------------------------------------===//
2265// CXSourceLocation and CXSourceRange Operations.
2266//===----------------------------------------------------------------------===//
2267
2268extern "C" {
2269CXSourceLocation clang_getNullLocation() {
2270  CXSourceLocation Result = { { 0, 0 }, 0 };
2271  return Result;
2272}
2273
2274unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
2275  return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2276          loc1.ptr_data[1] == loc2.ptr_data[1] &&
2277          loc1.int_data == loc2.int_data);
2278}
2279
2280CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2281                                   CXFile file,
2282                                   unsigned line,
2283                                   unsigned column) {
2284  if (!tu || !file)
2285    return clang_getNullLocation();
2286
2287  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2288  SourceLocation SLoc
2289    = CXXUnit->getSourceManager().getLocation(
2290                                        static_cast<const FileEntry *>(file),
2291                                              line, column);
2292  if (SLoc.isInvalid()) return clang_getNullLocation();
2293
2294  return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2295}
2296
2297CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
2298                                            CXFile file,
2299                                            unsigned offset) {
2300  if (!tu || !file)
2301    return clang_getNullLocation();
2302
2303  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2304  SourceLocation Start
2305    = CXXUnit->getSourceManager().getLocation(
2306                                        static_cast<const FileEntry *>(file),
2307                                              1, 1);
2308  if (Start.isInvalid()) return clang_getNullLocation();
2309
2310  SourceLocation SLoc = Start.getFileLocWithOffset(offset);
2311
2312  if (SLoc.isInvalid()) return clang_getNullLocation();
2313
2314  return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2315}
2316
2317CXSourceRange clang_getNullRange() {
2318  CXSourceRange Result = { { 0, 0 }, 0, 0 };
2319  return Result;
2320}
2321
2322CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2323  if (begin.ptr_data[0] != end.ptr_data[0] ||
2324      begin.ptr_data[1] != end.ptr_data[1])
2325    return clang_getNullRange();
2326
2327  CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
2328                           begin.int_data, end.int_data };
2329  return Result;
2330}
2331
2332void clang_getInstantiationLocation(CXSourceLocation location,
2333                                    CXFile *file,
2334                                    unsigned *line,
2335                                    unsigned *column,
2336                                    unsigned *offset) {
2337  SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2338
2339  if (!location.ptr_data[0] || Loc.isInvalid()) {
2340    if (file)
2341      *file = 0;
2342    if (line)
2343      *line = 0;
2344    if (column)
2345      *column = 0;
2346    if (offset)
2347      *offset = 0;
2348    return;
2349  }
2350
2351  const SourceManager &SM =
2352    *static_cast<const SourceManager*>(location.ptr_data[0]);
2353  SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
2354
2355  if (file)
2356    *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
2357  if (line)
2358    *line = SM.getInstantiationLineNumber(InstLoc);
2359  if (column)
2360    *column = SM.getInstantiationColumnNumber(InstLoc);
2361  if (offset)
2362    *offset = SM.getDecomposedLoc(InstLoc).second;
2363}
2364
2365CXSourceLocation clang_getRangeStart(CXSourceRange range) {
2366  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
2367                              range.begin_int_data };
2368  return Result;
2369}
2370
2371CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
2372  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
2373                              range.end_int_data };
2374  return Result;
2375}
2376
2377} // end: extern "C"
2378
2379//===----------------------------------------------------------------------===//
2380// CXFile Operations.
2381//===----------------------------------------------------------------------===//
2382
2383extern "C" {
2384CXString clang_getFileName(CXFile SFile) {
2385  if (!SFile)
2386    return createCXString(NULL);
2387
2388  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2389  return createCXString(FEnt->getName());
2390}
2391
2392time_t clang_getFileTime(CXFile SFile) {
2393  if (!SFile)
2394    return 0;
2395
2396  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2397  return FEnt->getModificationTime();
2398}
2399
2400CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2401  if (!tu)
2402    return 0;
2403
2404  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2405
2406  FileManager &FMgr = CXXUnit->getFileManager();
2407  const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name));
2408  return const_cast<FileEntry *>(File);
2409}
2410
2411} // end: extern "C"
2412
2413//===----------------------------------------------------------------------===//
2414// CXCursor Operations.
2415//===----------------------------------------------------------------------===//
2416
2417static Decl *getDeclFromExpr(Stmt *E) {
2418  if (CastExpr *CE = dyn_cast<CastExpr>(E))
2419    return getDeclFromExpr(CE->getSubExpr());
2420
2421  if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
2422    return RefExpr->getDecl();
2423  if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2424    return RefExpr->getDecl();
2425  if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
2426    return ME->getMemberDecl();
2427  if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
2428    return RE->getDecl();
2429  if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E))
2430    return PRE->getProperty();
2431
2432  if (CallExpr *CE = dyn_cast<CallExpr>(E))
2433    return getDeclFromExpr(CE->getCallee());
2434  if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
2435    return OME->getMethodDecl();
2436
2437  if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
2438    return PE->getProtocol();
2439
2440  return 0;
2441}
2442
2443static SourceLocation getLocationFromExpr(Expr *E) {
2444  if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
2445    return /*FIXME:*/Msg->getLeftLoc();
2446  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
2447    return DRE->getLocation();
2448  if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2449    return RefExpr->getLocation();
2450  if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
2451    return Member->getMemberLoc();
2452  if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
2453    return Ivar->getLocation();
2454  return E->getLocStart();
2455}
2456
2457extern "C" {
2458
2459unsigned clang_visitChildren(CXCursor parent,
2460                             CXCursorVisitor visitor,
2461                             CXClientData client_data) {
2462  ASTUnit *CXXUnit = getCursorASTUnit(parent);
2463
2464  CursorVisitor CursorVis(CXXUnit, visitor, client_data,
2465                          CXXUnit->getMaxPCHLevel());
2466  return CursorVis.VisitChildren(parent);
2467}
2468
2469static CXString getDeclSpelling(Decl *D) {
2470  NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
2471  if (!ND)
2472    return createCXString("");
2473
2474  if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
2475    return createCXString(OMD->getSelector().getAsString());
2476
2477  if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
2478    // No, this isn't the same as the code below. getIdentifier() is non-virtual
2479    // and returns different names. NamedDecl returns the class name and
2480    // ObjCCategoryImplDecl returns the category name.
2481    return createCXString(CIMP->getIdentifier()->getNameStart());
2482
2483  if (isa<UsingDirectiveDecl>(D))
2484    return createCXString("");
2485
2486  llvm::SmallString<1024> S;
2487  llvm::raw_svector_ostream os(S);
2488  ND->printName(os);
2489
2490  return createCXString(os.str());
2491}
2492
2493CXString clang_getCursorSpelling(CXCursor C) {
2494  if (clang_isTranslationUnit(C.kind))
2495    return clang_getTranslationUnitSpelling(C.data[2]);
2496
2497  if (clang_isReference(C.kind)) {
2498    switch (C.kind) {
2499    case CXCursor_ObjCSuperClassRef: {
2500      ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
2501      return createCXString(Super->getIdentifier()->getNameStart());
2502    }
2503    case CXCursor_ObjCClassRef: {
2504      ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
2505      return createCXString(Class->getIdentifier()->getNameStart());
2506    }
2507    case CXCursor_ObjCProtocolRef: {
2508      ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
2509      assert(OID && "getCursorSpelling(): Missing protocol decl");
2510      return createCXString(OID->getIdentifier()->getNameStart());
2511    }
2512    case CXCursor_CXXBaseSpecifier: {
2513      CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
2514      return createCXString(B->getType().getAsString());
2515    }
2516    case CXCursor_TypeRef: {
2517      TypeDecl *Type = getCursorTypeRef(C).first;
2518      assert(Type && "Missing type decl");
2519
2520      return createCXString(getCursorContext(C).getTypeDeclType(Type).
2521                              getAsString());
2522    }
2523    case CXCursor_TemplateRef: {
2524      TemplateDecl *Template = getCursorTemplateRef(C).first;
2525      assert(Template && "Missing template decl");
2526
2527      return createCXString(Template->getNameAsString());
2528    }
2529
2530    case CXCursor_NamespaceRef: {
2531      NamedDecl *NS = getCursorNamespaceRef(C).first;
2532      assert(NS && "Missing namespace decl");
2533
2534      return createCXString(NS->getNameAsString());
2535    }
2536
2537    case CXCursor_MemberRef: {
2538      FieldDecl *Field = getCursorMemberRef(C).first;
2539      assert(Field && "Missing member decl");
2540
2541      return createCXString(Field->getNameAsString());
2542    }
2543
2544    case CXCursor_LabelRef: {
2545      LabelStmt *Label = getCursorLabelRef(C).first;
2546      assert(Label && "Missing label");
2547
2548      return createCXString(Label->getID()->getName());
2549    }
2550
2551    case CXCursor_OverloadedDeclRef: {
2552      OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
2553      if (Decl *D = Storage.dyn_cast<Decl *>()) {
2554        if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
2555          return createCXString(ND->getNameAsString());
2556        return createCXString("");
2557      }
2558      if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
2559        return createCXString(E->getName().getAsString());
2560      OverloadedTemplateStorage *Ovl
2561        = Storage.get<OverloadedTemplateStorage*>();
2562      if (Ovl->size() == 0)
2563        return createCXString("");
2564      return createCXString((*Ovl->begin())->getNameAsString());
2565    }
2566
2567    default:
2568      return createCXString("<not implemented>");
2569    }
2570  }
2571
2572  if (clang_isExpression(C.kind)) {
2573    Decl *D = getDeclFromExpr(getCursorExpr(C));
2574    if (D)
2575      return getDeclSpelling(D);
2576    return createCXString("");
2577  }
2578
2579  if (clang_isStatement(C.kind)) {
2580    Stmt *S = getCursorStmt(C);
2581    if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
2582      return createCXString(Label->getID()->getName());
2583
2584    return createCXString("");
2585  }
2586
2587  if (C.kind == CXCursor_MacroInstantiation)
2588    return createCXString(getCursorMacroInstantiation(C)->getName()
2589                                                           ->getNameStart());
2590
2591  if (C.kind == CXCursor_MacroDefinition)
2592    return createCXString(getCursorMacroDefinition(C)->getName()
2593                                                           ->getNameStart());
2594
2595  if (C.kind == CXCursor_InclusionDirective)
2596    return createCXString(getCursorInclusionDirective(C)->getFileName());
2597
2598  if (clang_isDeclaration(C.kind))
2599    return getDeclSpelling(getCursorDecl(C));
2600
2601  return createCXString("");
2602}
2603
2604CXString clang_getCursorDisplayName(CXCursor C) {
2605  if (!clang_isDeclaration(C.kind))
2606    return clang_getCursorSpelling(C);
2607
2608  Decl *D = getCursorDecl(C);
2609  if (!D)
2610    return createCXString("");
2611
2612  PrintingPolicy &Policy = getCursorContext(C).PrintingPolicy;
2613  if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
2614    D = FunTmpl->getTemplatedDecl();
2615
2616  if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
2617    llvm::SmallString<64> Str;
2618    llvm::raw_svector_ostream OS(Str);
2619    OS << Function->getNameAsString();
2620    if (Function->getPrimaryTemplate())
2621      OS << "<>";
2622    OS << "(";
2623    for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
2624      if (I)
2625        OS << ", ";
2626      OS << Function->getParamDecl(I)->getType().getAsString(Policy);
2627    }
2628
2629    if (Function->isVariadic()) {
2630      if (Function->getNumParams())
2631        OS << ", ";
2632      OS << "...";
2633    }
2634    OS << ")";
2635    return createCXString(OS.str());
2636  }
2637
2638  if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
2639    llvm::SmallString<64> Str;
2640    llvm::raw_svector_ostream OS(Str);
2641    OS << ClassTemplate->getNameAsString();
2642    OS << "<";
2643    TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
2644    for (unsigned I = 0, N = Params->size(); I != N; ++I) {
2645      if (I)
2646        OS << ", ";
2647
2648      NamedDecl *Param = Params->getParam(I);
2649      if (Param->getIdentifier()) {
2650        OS << Param->getIdentifier()->getName();
2651        continue;
2652      }
2653
2654      // There is no parameter name, which makes this tricky. Try to come up
2655      // with something useful that isn't too long.
2656      if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
2657        OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
2658      else if (NonTypeTemplateParmDecl *NTTP
2659                                    = dyn_cast<NonTypeTemplateParmDecl>(Param))
2660        OS << NTTP->getType().getAsString(Policy);
2661      else
2662        OS << "template<...> class";
2663    }
2664
2665    OS << ">";
2666    return createCXString(OS.str());
2667  }
2668
2669  if (ClassTemplateSpecializationDecl *ClassSpec
2670                              = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
2671    // If the type was explicitly written, use that.
2672    if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
2673      return createCXString(TSInfo->getType().getAsString(Policy));
2674
2675    llvm::SmallString<64> Str;
2676    llvm::raw_svector_ostream OS(Str);
2677    OS << ClassSpec->getNameAsString();
2678    OS << TemplateSpecializationType::PrintTemplateArgumentList(
2679                            ClassSpec->getTemplateArgs().getFlatArgumentList(),
2680                                      ClassSpec->getTemplateArgs().flat_size(),
2681                                                                Policy);
2682    return createCXString(OS.str());
2683  }
2684
2685  return clang_getCursorSpelling(C);
2686}
2687
2688CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
2689  switch (Kind) {
2690  case CXCursor_FunctionDecl:
2691      return createCXString("FunctionDecl");
2692  case CXCursor_TypedefDecl:
2693      return createCXString("TypedefDecl");
2694  case CXCursor_EnumDecl:
2695      return createCXString("EnumDecl");
2696  case CXCursor_EnumConstantDecl:
2697      return createCXString("EnumConstantDecl");
2698  case CXCursor_StructDecl:
2699      return createCXString("StructDecl");
2700  case CXCursor_UnionDecl:
2701      return createCXString("UnionDecl");
2702  case CXCursor_ClassDecl:
2703      return createCXString("ClassDecl");
2704  case CXCursor_FieldDecl:
2705      return createCXString("FieldDecl");
2706  case CXCursor_VarDecl:
2707      return createCXString("VarDecl");
2708  case CXCursor_ParmDecl:
2709      return createCXString("ParmDecl");
2710  case CXCursor_ObjCInterfaceDecl:
2711      return createCXString("ObjCInterfaceDecl");
2712  case CXCursor_ObjCCategoryDecl:
2713      return createCXString("ObjCCategoryDecl");
2714  case CXCursor_ObjCProtocolDecl:
2715      return createCXString("ObjCProtocolDecl");
2716  case CXCursor_ObjCPropertyDecl:
2717      return createCXString("ObjCPropertyDecl");
2718  case CXCursor_ObjCIvarDecl:
2719      return createCXString("ObjCIvarDecl");
2720  case CXCursor_ObjCInstanceMethodDecl:
2721      return createCXString("ObjCInstanceMethodDecl");
2722  case CXCursor_ObjCClassMethodDecl:
2723      return createCXString("ObjCClassMethodDecl");
2724  case CXCursor_ObjCImplementationDecl:
2725      return createCXString("ObjCImplementationDecl");
2726  case CXCursor_ObjCCategoryImplDecl:
2727      return createCXString("ObjCCategoryImplDecl");
2728  case CXCursor_CXXMethod:
2729      return createCXString("CXXMethod");
2730  case CXCursor_UnexposedDecl:
2731      return createCXString("UnexposedDecl");
2732  case CXCursor_ObjCSuperClassRef:
2733      return createCXString("ObjCSuperClassRef");
2734  case CXCursor_ObjCProtocolRef:
2735      return createCXString("ObjCProtocolRef");
2736  case CXCursor_ObjCClassRef:
2737      return createCXString("ObjCClassRef");
2738  case CXCursor_TypeRef:
2739      return createCXString("TypeRef");
2740  case CXCursor_TemplateRef:
2741      return createCXString("TemplateRef");
2742  case CXCursor_NamespaceRef:
2743    return createCXString("NamespaceRef");
2744  case CXCursor_MemberRef:
2745    return createCXString("MemberRef");
2746  case CXCursor_LabelRef:
2747    return createCXString("LabelRef");
2748  case CXCursor_OverloadedDeclRef:
2749    return createCXString("OverloadedDeclRef");
2750  case CXCursor_UnexposedExpr:
2751      return createCXString("UnexposedExpr");
2752  case CXCursor_BlockExpr:
2753      return createCXString("BlockExpr");
2754  case CXCursor_DeclRefExpr:
2755      return createCXString("DeclRefExpr");
2756  case CXCursor_MemberRefExpr:
2757      return createCXString("MemberRefExpr");
2758  case CXCursor_CallExpr:
2759      return createCXString("CallExpr");
2760  case CXCursor_ObjCMessageExpr:
2761      return createCXString("ObjCMessageExpr");
2762  case CXCursor_UnexposedStmt:
2763      return createCXString("UnexposedStmt");
2764  case CXCursor_LabelStmt:
2765      return createCXString("LabelStmt");
2766  case CXCursor_InvalidFile:
2767      return createCXString("InvalidFile");
2768  case CXCursor_InvalidCode:
2769    return createCXString("InvalidCode");
2770  case CXCursor_NoDeclFound:
2771      return createCXString("NoDeclFound");
2772  case CXCursor_NotImplemented:
2773      return createCXString("NotImplemented");
2774  case CXCursor_TranslationUnit:
2775      return createCXString("TranslationUnit");
2776  case CXCursor_UnexposedAttr:
2777      return createCXString("UnexposedAttr");
2778  case CXCursor_IBActionAttr:
2779      return createCXString("attribute(ibaction)");
2780  case CXCursor_IBOutletAttr:
2781     return createCXString("attribute(iboutlet)");
2782  case CXCursor_IBOutletCollectionAttr:
2783      return createCXString("attribute(iboutletcollection)");
2784  case CXCursor_PreprocessingDirective:
2785    return createCXString("preprocessing directive");
2786  case CXCursor_MacroDefinition:
2787    return createCXString("macro definition");
2788  case CXCursor_MacroInstantiation:
2789    return createCXString("macro instantiation");
2790  case CXCursor_InclusionDirective:
2791    return createCXString("inclusion directive");
2792  case CXCursor_Namespace:
2793    return createCXString("Namespace");
2794  case CXCursor_LinkageSpec:
2795    return createCXString("LinkageSpec");
2796  case CXCursor_CXXBaseSpecifier:
2797    return createCXString("C++ base class specifier");
2798  case CXCursor_Constructor:
2799    return createCXString("CXXConstructor");
2800  case CXCursor_Destructor:
2801    return createCXString("CXXDestructor");
2802  case CXCursor_ConversionFunction:
2803    return createCXString("CXXConversion");
2804  case CXCursor_TemplateTypeParameter:
2805    return createCXString("TemplateTypeParameter");
2806  case CXCursor_NonTypeTemplateParameter:
2807    return createCXString("NonTypeTemplateParameter");
2808  case CXCursor_TemplateTemplateParameter:
2809    return createCXString("TemplateTemplateParameter");
2810  case CXCursor_FunctionTemplate:
2811    return createCXString("FunctionTemplate");
2812  case CXCursor_ClassTemplate:
2813    return createCXString("ClassTemplate");
2814  case CXCursor_ClassTemplatePartialSpecialization:
2815    return createCXString("ClassTemplatePartialSpecialization");
2816  case CXCursor_NamespaceAlias:
2817    return createCXString("NamespaceAlias");
2818  case CXCursor_UsingDirective:
2819    return createCXString("UsingDirective");
2820  case CXCursor_UsingDeclaration:
2821    return createCXString("UsingDeclaration");
2822  }
2823
2824  llvm_unreachable("Unhandled CXCursorKind");
2825  return createCXString(NULL);
2826}
2827
2828enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
2829                                         CXCursor parent,
2830                                         CXClientData client_data) {
2831  CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
2832  *BestCursor = cursor;
2833  return CXChildVisit_Recurse;
2834}
2835
2836CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
2837  if (!TU)
2838    return clang_getNullCursor();
2839
2840  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2841  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2842
2843  // Translate the given source location to make it point at the beginning of
2844  // the token under the cursor.
2845  SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
2846
2847  // Guard against an invalid SourceLocation, or we may assert in one
2848  // of the following calls.
2849  if (SLoc.isInvalid())
2850    return clang_getNullCursor();
2851
2852  SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
2853                                    CXXUnit->getASTContext().getLangOptions());
2854
2855  CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
2856  if (SLoc.isValid()) {
2857    // FIXME: Would be great to have a "hint" cursor, then walk from that
2858    // hint cursor upward until we find a cursor whose source range encloses
2859    // the region of interest, rather than starting from the translation unit.
2860    CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit);
2861    CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result,
2862                            Decl::MaxPCHLevel, SourceLocation(SLoc));
2863    CursorVis.VisitChildren(Parent);
2864  }
2865  return Result;
2866}
2867
2868CXCursor clang_getNullCursor(void) {
2869  return MakeCXCursorInvalid(CXCursor_InvalidFile);
2870}
2871
2872unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
2873  return X == Y;
2874}
2875
2876unsigned clang_isInvalid(enum CXCursorKind K) {
2877  return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
2878}
2879
2880unsigned clang_isDeclaration(enum CXCursorKind K) {
2881  return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
2882}
2883
2884unsigned clang_isReference(enum CXCursorKind K) {
2885  return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
2886}
2887
2888unsigned clang_isExpression(enum CXCursorKind K) {
2889  return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
2890}
2891
2892unsigned clang_isStatement(enum CXCursorKind K) {
2893  return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
2894}
2895
2896unsigned clang_isTranslationUnit(enum CXCursorKind K) {
2897  return K == CXCursor_TranslationUnit;
2898}
2899
2900unsigned clang_isPreprocessing(enum CXCursorKind K) {
2901  return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
2902}
2903
2904unsigned clang_isUnexposed(enum CXCursorKind K) {
2905  switch (K) {
2906    case CXCursor_UnexposedDecl:
2907    case CXCursor_UnexposedExpr:
2908    case CXCursor_UnexposedStmt:
2909    case CXCursor_UnexposedAttr:
2910      return true;
2911    default:
2912      return false;
2913  }
2914}
2915
2916CXCursorKind clang_getCursorKind(CXCursor C) {
2917  return C.kind;
2918}
2919
2920CXSourceLocation clang_getCursorLocation(CXCursor C) {
2921  if (clang_isReference(C.kind)) {
2922    switch (C.kind) {
2923    case CXCursor_ObjCSuperClassRef: {
2924      std::pair<ObjCInterfaceDecl *, SourceLocation> P
2925        = getCursorObjCSuperClassRef(C);
2926      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2927    }
2928
2929    case CXCursor_ObjCProtocolRef: {
2930      std::pair<ObjCProtocolDecl *, SourceLocation> P
2931        = getCursorObjCProtocolRef(C);
2932      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2933    }
2934
2935    case CXCursor_ObjCClassRef: {
2936      std::pair<ObjCInterfaceDecl *, SourceLocation> P
2937        = getCursorObjCClassRef(C);
2938      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2939    }
2940
2941    case CXCursor_TypeRef: {
2942      std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
2943      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2944    }
2945
2946    case CXCursor_TemplateRef: {
2947      std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
2948      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2949    }
2950
2951    case CXCursor_NamespaceRef: {
2952      std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
2953      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2954    }
2955
2956    case CXCursor_MemberRef: {
2957      std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
2958      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2959    }
2960
2961    case CXCursor_CXXBaseSpecifier: {
2962      CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
2963      if (!BaseSpec)
2964        return clang_getNullLocation();
2965
2966      if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
2967        return cxloc::translateSourceLocation(getCursorContext(C),
2968                                            TSInfo->getTypeLoc().getBeginLoc());
2969
2970      return cxloc::translateSourceLocation(getCursorContext(C),
2971                                        BaseSpec->getSourceRange().getBegin());
2972    }
2973
2974    case CXCursor_LabelRef: {
2975      std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
2976      return cxloc::translateSourceLocation(getCursorContext(C), P.second);
2977    }
2978
2979    case CXCursor_OverloadedDeclRef:
2980      return cxloc::translateSourceLocation(getCursorContext(C),
2981                                          getCursorOverloadedDeclRef(C).second);
2982
2983    default:
2984      // FIXME: Need a way to enumerate all non-reference cases.
2985      llvm_unreachable("Missed a reference kind");
2986    }
2987  }
2988
2989  if (clang_isExpression(C.kind))
2990    return cxloc::translateSourceLocation(getCursorContext(C),
2991                                   getLocationFromExpr(getCursorExpr(C)));
2992
2993  if (clang_isStatement(C.kind))
2994    return cxloc::translateSourceLocation(getCursorContext(C),
2995                                          getCursorStmt(C)->getLocStart());
2996
2997  if (C.kind == CXCursor_PreprocessingDirective) {
2998    SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
2999    return cxloc::translateSourceLocation(getCursorContext(C), L);
3000  }
3001
3002  if (C.kind == CXCursor_MacroInstantiation) {
3003    SourceLocation L
3004      = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
3005    return cxloc::translateSourceLocation(getCursorContext(C), L);
3006  }
3007
3008  if (C.kind == CXCursor_MacroDefinition) {
3009    SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
3010    return cxloc::translateSourceLocation(getCursorContext(C), L);
3011  }
3012
3013  if (C.kind == CXCursor_InclusionDirective) {
3014    SourceLocation L
3015      = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
3016    return cxloc::translateSourceLocation(getCursorContext(C), L);
3017  }
3018
3019  if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
3020    return clang_getNullLocation();
3021
3022  Decl *D = getCursorDecl(C);
3023  SourceLocation Loc = D->getLocation();
3024  if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
3025    Loc = Class->getClassLoc();
3026  // FIXME: Multiple variables declared in a single declaration
3027  // currently lack the information needed to correctly determine their
3028  // ranges when accounting for the type-specifier.  We use context
3029  // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3030  // and if so, whether it is the first decl.
3031  if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3032    if (!cxcursor::isFirstInDeclGroup(C))
3033      Loc = VD->getLocation();
3034  }
3035
3036  return cxloc::translateSourceLocation(getCursorContext(C), Loc);
3037}
3038
3039} // end extern "C"
3040
3041static SourceRange getRawCursorExtent(CXCursor C) {
3042  if (clang_isReference(C.kind)) {
3043    switch (C.kind) {
3044    case CXCursor_ObjCSuperClassRef:
3045      return  getCursorObjCSuperClassRef(C).second;
3046
3047    case CXCursor_ObjCProtocolRef:
3048      return getCursorObjCProtocolRef(C).second;
3049
3050    case CXCursor_ObjCClassRef:
3051      return getCursorObjCClassRef(C).second;
3052
3053    case CXCursor_TypeRef:
3054      return getCursorTypeRef(C).second;
3055
3056    case CXCursor_TemplateRef:
3057      return getCursorTemplateRef(C).second;
3058
3059    case CXCursor_NamespaceRef:
3060      return getCursorNamespaceRef(C).second;
3061
3062    case CXCursor_MemberRef:
3063      return getCursorMemberRef(C).second;
3064
3065    case CXCursor_CXXBaseSpecifier:
3066      return getCursorCXXBaseSpecifier(C)->getSourceRange();
3067
3068    case CXCursor_LabelRef:
3069      return getCursorLabelRef(C).second;
3070
3071    case CXCursor_OverloadedDeclRef:
3072      return getCursorOverloadedDeclRef(C).second;
3073
3074    default:
3075      // FIXME: Need a way to enumerate all non-reference cases.
3076      llvm_unreachable("Missed a reference kind");
3077    }
3078  }
3079
3080  if (clang_isExpression(C.kind))
3081    return getCursorExpr(C)->getSourceRange();
3082
3083  if (clang_isStatement(C.kind))
3084    return getCursorStmt(C)->getSourceRange();
3085
3086  if (C.kind == CXCursor_PreprocessingDirective)
3087    return cxcursor::getCursorPreprocessingDirective(C);
3088
3089  if (C.kind == CXCursor_MacroInstantiation)
3090    return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
3091
3092  if (C.kind == CXCursor_MacroDefinition)
3093    return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
3094
3095  if (C.kind == CXCursor_InclusionDirective)
3096    return cxcursor::getCursorInclusionDirective(C)->getSourceRange();
3097
3098  if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3099    Decl *D = cxcursor::getCursorDecl(C);
3100    SourceRange R = D->getSourceRange();
3101    // FIXME: Multiple variables declared in a single declaration
3102    // currently lack the information needed to correctly determine their
3103    // ranges when accounting for the type-specifier.  We use context
3104    // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3105    // and if so, whether it is the first decl.
3106    if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3107      if (!cxcursor::isFirstInDeclGroup(C))
3108        R.setBegin(VD->getLocation());
3109    }
3110    return R;
3111  }
3112  return SourceRange();}
3113
3114extern "C" {
3115
3116CXSourceRange clang_getCursorExtent(CXCursor C) {
3117  SourceRange R = getRawCursorExtent(C);
3118  if (R.isInvalid())
3119    return clang_getNullRange();
3120
3121  return cxloc::translateSourceRange(getCursorContext(C), R);
3122}
3123
3124CXCursor clang_getCursorReferenced(CXCursor C) {
3125  if (clang_isInvalid(C.kind))
3126    return clang_getNullCursor();
3127
3128  ASTUnit *CXXUnit = getCursorASTUnit(C);
3129  if (clang_isDeclaration(C.kind)) {
3130    Decl *D = getCursorDecl(C);
3131    if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
3132      return MakeCursorOverloadedDeclRef(Using, D->getLocation(), CXXUnit);
3133    if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3134      return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), CXXUnit);
3135    if (ObjCForwardProtocolDecl *Protocols
3136                                        = dyn_cast<ObjCForwardProtocolDecl>(D))
3137      return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), CXXUnit);
3138
3139    return C;
3140  }
3141
3142  if (clang_isExpression(C.kind)) {
3143    Expr *E = getCursorExpr(C);
3144    Decl *D = getDeclFromExpr(E);
3145    if (D)
3146      return MakeCXCursor(D, CXXUnit);
3147
3148    if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
3149      return MakeCursorOverloadedDeclRef(Ovl, CXXUnit);
3150
3151    return clang_getNullCursor();
3152  }
3153
3154  if (clang_isStatement(C.kind)) {
3155    Stmt *S = getCursorStmt(C);
3156    if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
3157      return MakeCXCursor(Goto->getLabel(), getCursorDecl(C),
3158                          getCursorASTUnit(C));
3159
3160    return clang_getNullCursor();
3161  }
3162
3163  if (C.kind == CXCursor_MacroInstantiation) {
3164    if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
3165      return MakeMacroDefinitionCursor(Def, CXXUnit);
3166  }
3167
3168  if (!clang_isReference(C.kind))
3169    return clang_getNullCursor();
3170
3171  switch (C.kind) {
3172    case CXCursor_ObjCSuperClassRef:
3173      return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
3174
3175    case CXCursor_ObjCProtocolRef: {
3176      return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
3177
3178    case CXCursor_ObjCClassRef:
3179      return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
3180
3181    case CXCursor_TypeRef:
3182      return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
3183
3184    case CXCursor_TemplateRef:
3185      return MakeCXCursor(getCursorTemplateRef(C).first, CXXUnit);
3186
3187    case CXCursor_NamespaceRef:
3188      return MakeCXCursor(getCursorNamespaceRef(C).first, CXXUnit);
3189
3190    case CXCursor_MemberRef:
3191      return MakeCXCursor(getCursorMemberRef(C).first, CXXUnit);
3192
3193    case CXCursor_CXXBaseSpecifier: {
3194      CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
3195      return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
3196                                                         CXXUnit));
3197    }
3198
3199    case CXCursor_LabelRef:
3200      // FIXME: We end up faking the "parent" declaration here because we
3201      // don't want to make CXCursor larger.
3202      return MakeCXCursor(getCursorLabelRef(C).first,
3203                          CXXUnit->getASTContext().getTranslationUnitDecl(),
3204                          CXXUnit);
3205
3206    case CXCursor_OverloadedDeclRef:
3207      return C;
3208
3209    default:
3210      // We would prefer to enumerate all non-reference cursor kinds here.
3211      llvm_unreachable("Unhandled reference cursor kind");
3212      break;
3213    }
3214  }
3215
3216  return clang_getNullCursor();
3217}
3218
3219CXCursor clang_getCursorDefinition(CXCursor C) {
3220  if (clang_isInvalid(C.kind))
3221    return clang_getNullCursor();
3222
3223  ASTUnit *CXXUnit = getCursorASTUnit(C);
3224
3225  bool WasReference = false;
3226  if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
3227    C = clang_getCursorReferenced(C);
3228    WasReference = true;
3229  }
3230
3231  if (C.kind == CXCursor_MacroInstantiation)
3232    return clang_getCursorReferenced(C);
3233
3234  if (!clang_isDeclaration(C.kind))
3235    return clang_getNullCursor();
3236
3237  Decl *D = getCursorDecl(C);
3238  if (!D)
3239    return clang_getNullCursor();
3240
3241  switch (D->getKind()) {
3242  // Declaration kinds that don't really separate the notions of
3243  // declaration and definition.
3244  case Decl::Namespace:
3245  case Decl::Typedef:
3246  case Decl::TemplateTypeParm:
3247  case Decl::EnumConstant:
3248  case Decl::Field:
3249  case Decl::ObjCIvar:
3250  case Decl::ObjCAtDefsField:
3251  case Decl::ImplicitParam:
3252  case Decl::ParmVar:
3253  case Decl::NonTypeTemplateParm:
3254  case Decl::TemplateTemplateParm:
3255  case Decl::ObjCCategoryImpl:
3256  case Decl::ObjCImplementation:
3257  case Decl::AccessSpec:
3258  case Decl::LinkageSpec:
3259  case Decl::ObjCPropertyImpl:
3260  case Decl::FileScopeAsm:
3261  case Decl::StaticAssert:
3262  case Decl::Block:
3263    return C;
3264
3265  // Declaration kinds that don't make any sense here, but are
3266  // nonetheless harmless.
3267  case Decl::TranslationUnit:
3268    break;
3269
3270  // Declaration kinds for which the definition is not resolvable.
3271  case Decl::UnresolvedUsingTypename:
3272  case Decl::UnresolvedUsingValue:
3273    break;
3274
3275  case Decl::UsingDirective:
3276    return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
3277                        CXXUnit);
3278
3279  case Decl::NamespaceAlias:
3280    return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
3281
3282  case Decl::Enum:
3283  case Decl::Record:
3284  case Decl::CXXRecord:
3285  case Decl::ClassTemplateSpecialization:
3286  case Decl::ClassTemplatePartialSpecialization:
3287    if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
3288      return MakeCXCursor(Def, CXXUnit);
3289    return clang_getNullCursor();
3290
3291  case Decl::Function:
3292  case Decl::CXXMethod:
3293  case Decl::CXXConstructor:
3294  case Decl::CXXDestructor:
3295  case Decl::CXXConversion: {
3296    const FunctionDecl *Def = 0;
3297    if (cast<FunctionDecl>(D)->getBody(Def))
3298      return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
3299    return clang_getNullCursor();
3300  }
3301
3302  case Decl::Var: {
3303    // Ask the variable if it has a definition.
3304    if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
3305      return MakeCXCursor(Def, CXXUnit);
3306    return clang_getNullCursor();
3307  }
3308
3309  case Decl::FunctionTemplate: {
3310    const FunctionDecl *Def = 0;
3311    if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
3312      return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
3313    return clang_getNullCursor();
3314  }
3315
3316  case Decl::ClassTemplate: {
3317    if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
3318                                                            ->getDefinition())
3319      return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
3320                          CXXUnit);
3321    return clang_getNullCursor();
3322  }
3323
3324  case Decl::Using:
3325    return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
3326                                       D->getLocation(), CXXUnit);
3327
3328  case Decl::UsingShadow:
3329    return clang_getCursorDefinition(
3330                       MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
3331                                    CXXUnit));
3332
3333  case Decl::ObjCMethod: {
3334    ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
3335    if (Method->isThisDeclarationADefinition())
3336      return C;
3337
3338    // Dig out the method definition in the associated
3339    // @implementation, if we have it.
3340    // FIXME: The ASTs should make finding the definition easier.
3341    if (ObjCInterfaceDecl *Class
3342                       = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
3343      if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
3344        if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
3345                                                  Method->isInstanceMethod()))
3346          if (Def->isThisDeclarationADefinition())
3347            return MakeCXCursor(Def, CXXUnit);
3348
3349    return clang_getNullCursor();
3350  }
3351
3352  case Decl::ObjCCategory:
3353    if (ObjCCategoryImplDecl *Impl
3354                               = cast<ObjCCategoryDecl>(D)->getImplementation())
3355      return MakeCXCursor(Impl, CXXUnit);
3356    return clang_getNullCursor();
3357
3358  case Decl::ObjCProtocol:
3359    if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
3360      return C;
3361    return clang_getNullCursor();
3362
3363  case Decl::ObjCInterface:
3364    // There are two notions of a "definition" for an Objective-C
3365    // class: the interface and its implementation. When we resolved a
3366    // reference to an Objective-C class, produce the @interface as
3367    // the definition; when we were provided with the interface,
3368    // produce the @implementation as the definition.
3369    if (WasReference) {
3370      if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
3371        return C;
3372    } else if (ObjCImplementationDecl *Impl
3373                              = cast<ObjCInterfaceDecl>(D)->getImplementation())
3374      return MakeCXCursor(Impl, CXXUnit);
3375    return clang_getNullCursor();
3376
3377  case Decl::ObjCProperty:
3378    // FIXME: We don't really know where to find the
3379    // ObjCPropertyImplDecls that implement this property.
3380    return clang_getNullCursor();
3381
3382  case Decl::ObjCCompatibleAlias:
3383    if (ObjCInterfaceDecl *Class
3384          = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
3385      if (!Class->isForwardDecl())
3386        return MakeCXCursor(Class, CXXUnit);
3387
3388    return clang_getNullCursor();
3389
3390  case Decl::ObjCForwardProtocol:
3391    return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D),
3392                                       D->getLocation(), CXXUnit);
3393
3394  case Decl::ObjCClass:
3395    return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(),
3396                                       CXXUnit);
3397
3398  case Decl::Friend:
3399    if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
3400      return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
3401    return clang_getNullCursor();
3402
3403  case Decl::FriendTemplate:
3404    if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
3405      return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
3406    return clang_getNullCursor();
3407  }
3408
3409  return clang_getNullCursor();
3410}
3411
3412unsigned clang_isCursorDefinition(CXCursor C) {
3413  if (!clang_isDeclaration(C.kind))
3414    return 0;
3415
3416  return clang_getCursorDefinition(C) == C;
3417}
3418
3419unsigned clang_getNumOverloadedDecls(CXCursor C) {
3420  if (C.kind != CXCursor_OverloadedDeclRef)
3421    return 0;
3422
3423  OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
3424  if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3425    return E->getNumDecls();
3426
3427  if (OverloadedTemplateStorage *S
3428                              = Storage.dyn_cast<OverloadedTemplateStorage*>())
3429    return S->size();
3430
3431  Decl *D = Storage.get<Decl*>();
3432  if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
3433    return Using->getNumShadowDecls();
3434  if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3435    return Classes->size();
3436  if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D))
3437    return Protocols->protocol_size();
3438
3439  return 0;
3440}
3441
3442CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
3443  if (cursor.kind != CXCursor_OverloadedDeclRef)
3444    return clang_getNullCursor();
3445
3446  if (index >= clang_getNumOverloadedDecls(cursor))
3447    return clang_getNullCursor();
3448
3449  ASTUnit *Unit = getCursorASTUnit(cursor);
3450  OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
3451  if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3452    return MakeCXCursor(E->decls_begin()[index], Unit);
3453
3454  if (OverloadedTemplateStorage *S
3455                              = Storage.dyn_cast<OverloadedTemplateStorage*>())
3456    return MakeCXCursor(S->begin()[index], Unit);
3457
3458  Decl *D = Storage.get<Decl*>();
3459  if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
3460    // FIXME: This is, unfortunately, linear time.
3461    UsingDecl::shadow_iterator Pos = Using->shadow_begin();
3462    std::advance(Pos, index);
3463    return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), Unit);
3464  }
3465
3466  if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3467    return MakeCXCursor(Classes->begin()[index].getInterface(), Unit);
3468
3469  if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D))
3470    return MakeCXCursor(Protocols->protocol_begin()[index], Unit);
3471
3472  return clang_getNullCursor();
3473}
3474
3475void clang_getDefinitionSpellingAndExtent(CXCursor C,
3476                                          const char **startBuf,
3477                                          const char **endBuf,
3478                                          unsigned *startLine,
3479                                          unsigned *startColumn,
3480                                          unsigned *endLine,
3481                                          unsigned *endColumn) {
3482  assert(getCursorDecl(C) && "CXCursor has null decl");
3483  NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
3484  FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
3485  CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
3486
3487  SourceManager &SM = FD->getASTContext().getSourceManager();
3488  *startBuf = SM.getCharacterData(Body->getLBracLoc());
3489  *endBuf = SM.getCharacterData(Body->getRBracLoc());
3490  *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
3491  *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
3492  *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
3493  *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
3494}
3495
3496void clang_enableStackTraces(void) {
3497  llvm::sys::PrintStackTraceOnErrorSignal();
3498}
3499
3500} // end: extern "C"
3501
3502//===----------------------------------------------------------------------===//
3503// Token-based Operations.
3504//===----------------------------------------------------------------------===//
3505
3506/* CXToken layout:
3507 *   int_data[0]: a CXTokenKind
3508 *   int_data[1]: starting token location
3509 *   int_data[2]: token length
3510 *   int_data[3]: reserved
3511 *   ptr_data: for identifiers and keywords, an IdentifierInfo*.
3512 *   otherwise unused.
3513 */
3514extern "C" {
3515
3516CXTokenKind clang_getTokenKind(CXToken CXTok) {
3517  return static_cast<CXTokenKind>(CXTok.int_data[0]);
3518}
3519
3520CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
3521  switch (clang_getTokenKind(CXTok)) {
3522  case CXToken_Identifier:
3523  case CXToken_Keyword:
3524    // We know we have an IdentifierInfo*, so use that.
3525    return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
3526                            ->getNameStart());
3527
3528  case CXToken_Literal: {
3529    // We have stashed the starting pointer in the ptr_data field. Use it.
3530    const char *Text = static_cast<const char *>(CXTok.ptr_data);
3531    return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
3532  }
3533
3534  case CXToken_Punctuation:
3535  case CXToken_Comment:
3536    break;
3537  }
3538
3539  // We have to find the starting buffer pointer the hard way, by
3540  // deconstructing the source location.
3541  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3542  if (!CXXUnit)
3543    return createCXString("");
3544
3545  SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
3546  std::pair<FileID, unsigned> LocInfo
3547    = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
3548  bool Invalid = false;
3549  llvm::StringRef Buffer
3550    = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3551  if (Invalid)
3552    return createCXString("");
3553
3554  return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
3555}
3556
3557CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
3558  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3559  if (!CXXUnit)
3560    return clang_getNullLocation();
3561
3562  return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
3563                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3564}
3565
3566CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
3567  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3568  if (!CXXUnit)
3569    return clang_getNullRange();
3570
3571  return cxloc::translateSourceRange(CXXUnit->getASTContext(),
3572                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3573}
3574
3575void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
3576                    CXToken **Tokens, unsigned *NumTokens) {
3577  if (Tokens)
3578    *Tokens = 0;
3579  if (NumTokens)
3580    *NumTokens = 0;
3581
3582  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3583  if (!CXXUnit || !Tokens || !NumTokens)
3584    return;
3585
3586  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3587
3588  SourceRange R = cxloc::translateCXSourceRange(Range);
3589  if (R.isInvalid())
3590    return;
3591
3592  SourceManager &SourceMgr = CXXUnit->getSourceManager();
3593  std::pair<FileID, unsigned> BeginLocInfo
3594    = SourceMgr.getDecomposedLoc(R.getBegin());
3595  std::pair<FileID, unsigned> EndLocInfo
3596    = SourceMgr.getDecomposedLoc(R.getEnd());
3597
3598  // Cannot tokenize across files.
3599  if (BeginLocInfo.first != EndLocInfo.first)
3600    return;
3601
3602  // Create a lexer
3603  bool Invalid = false;
3604  llvm::StringRef Buffer
3605    = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
3606  if (Invalid)
3607    return;
3608
3609  Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3610            CXXUnit->getASTContext().getLangOptions(),
3611            Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
3612  Lex.SetCommentRetentionState(true);
3613
3614  // Lex tokens until we hit the end of the range.
3615  const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
3616  llvm::SmallVector<CXToken, 32> CXTokens;
3617  Token Tok;
3618  bool previousWasAt = false;
3619  do {
3620    // Lex the next token
3621    Lex.LexFromRawLexer(Tok);
3622    if (Tok.is(tok::eof))
3623      break;
3624
3625    // Initialize the CXToken.
3626    CXToken CXTok;
3627
3628    //   - Common fields
3629    CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
3630    CXTok.int_data[2] = Tok.getLength();
3631    CXTok.int_data[3] = 0;
3632
3633    //   - Kind-specific fields
3634    if (Tok.isLiteral()) {
3635      CXTok.int_data[0] = CXToken_Literal;
3636      CXTok.ptr_data = (void *)Tok.getLiteralData();
3637    } else if (Tok.is(tok::identifier)) {
3638      // Lookup the identifier to determine whether we have a keyword.
3639      std::pair<FileID, unsigned> LocInfo
3640        = SourceMgr.getDecomposedLoc(Tok.getLocation());
3641      bool Invalid = false;
3642      llvm::StringRef Buf
3643        = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3644      if (Invalid)
3645        return;
3646
3647      const char *StartPos = Buf.data() + LocInfo.second;
3648      IdentifierInfo *II
3649        = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos);
3650
3651      if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
3652        CXTok.int_data[0] = CXToken_Keyword;
3653      }
3654      else {
3655        CXTok.int_data[0] = II->getTokenID() == tok::identifier?
3656                                CXToken_Identifier
3657                              : CXToken_Keyword;
3658      }
3659      CXTok.ptr_data = II;
3660    } else if (Tok.is(tok::comment)) {
3661      CXTok.int_data[0] = CXToken_Comment;
3662      CXTok.ptr_data = 0;
3663    } else {
3664      CXTok.int_data[0] = CXToken_Punctuation;
3665      CXTok.ptr_data = 0;
3666    }
3667    CXTokens.push_back(CXTok);
3668    previousWasAt = Tok.is(tok::at);
3669  } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
3670
3671  if (CXTokens.empty())
3672    return;
3673
3674  *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
3675  memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
3676  *NumTokens = CXTokens.size();
3677}
3678
3679void clang_disposeTokens(CXTranslationUnit TU,
3680                         CXToken *Tokens, unsigned NumTokens) {
3681  free(Tokens);
3682}
3683
3684} // end: extern "C"
3685
3686//===----------------------------------------------------------------------===//
3687// Token annotation APIs.
3688//===----------------------------------------------------------------------===//
3689
3690typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
3691static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
3692                                                     CXCursor parent,
3693                                                     CXClientData client_data);
3694namespace {
3695class AnnotateTokensWorker {
3696  AnnotateTokensData &Annotated;
3697  CXToken *Tokens;
3698  CXCursor *Cursors;
3699  unsigned NumTokens;
3700  unsigned TokIdx;
3701  unsigned PreprocessingTokIdx;
3702  CursorVisitor AnnotateVis;
3703  SourceManager &SrcMgr;
3704
3705  bool MoreTokens() const { return TokIdx < NumTokens; }
3706  unsigned NextToken() const { return TokIdx; }
3707  void AdvanceToken() { ++TokIdx; }
3708  SourceLocation GetTokenLoc(unsigned tokI) {
3709    return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
3710  }
3711
3712public:
3713  AnnotateTokensWorker(AnnotateTokensData &annotated,
3714                       CXToken *tokens, CXCursor *cursors, unsigned numTokens,
3715                       ASTUnit *CXXUnit, SourceRange RegionOfInterest)
3716    : Annotated(annotated), Tokens(tokens), Cursors(cursors),
3717      NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
3718      AnnotateVis(CXXUnit, AnnotateTokensVisitor, this,
3719                  Decl::MaxPCHLevel, RegionOfInterest),
3720      SrcMgr(CXXUnit->getSourceManager()) {}
3721
3722  void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
3723  enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
3724  void AnnotateTokens(CXCursor parent);
3725};
3726}
3727
3728void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
3729  // Walk the AST within the region of interest, annotating tokens
3730  // along the way.
3731  VisitChildren(parent);
3732
3733  for (unsigned I = 0 ; I < TokIdx ; ++I) {
3734    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
3735    if (Pos != Annotated.end() &&
3736        (clang_isInvalid(Cursors[I].kind) ||
3737         Pos->second.kind != CXCursor_PreprocessingDirective))
3738      Cursors[I] = Pos->second;
3739  }
3740
3741  // Finish up annotating any tokens left.
3742  if (!MoreTokens())
3743    return;
3744
3745  const CXCursor &C = clang_getNullCursor();
3746  for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
3747    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
3748    Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
3749  }
3750}
3751
3752enum CXChildVisitResult
3753AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
3754  CXSourceLocation Loc = clang_getCursorLocation(cursor);
3755  SourceRange cursorRange = getRawCursorExtent(cursor);
3756  if (cursorRange.isInvalid())
3757    return CXChildVisit_Recurse;
3758
3759  if (clang_isPreprocessing(cursor.kind)) {
3760    // For macro instantiations, just note where the beginning of the macro
3761    // instantiation occurs.
3762    if (cursor.kind == CXCursor_MacroInstantiation) {
3763      Annotated[Loc.int_data] = cursor;
3764      return CXChildVisit_Recurse;
3765    }
3766
3767    // Items in the preprocessing record are kept separate from items in
3768    // declarations, so we keep a separate token index.
3769    unsigned SavedTokIdx = TokIdx;
3770    TokIdx = PreprocessingTokIdx;
3771
3772    // Skip tokens up until we catch up to the beginning of the preprocessing
3773    // entry.
3774    while (MoreTokens()) {
3775      const unsigned I = NextToken();
3776      SourceLocation TokLoc = GetTokenLoc(I);
3777      switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3778      case RangeBefore:
3779        AdvanceToken();
3780        continue;
3781      case RangeAfter:
3782      case RangeOverlap:
3783        break;
3784      }
3785      break;
3786    }
3787
3788    // Look at all of the tokens within this range.
3789    while (MoreTokens()) {
3790      const unsigned I = NextToken();
3791      SourceLocation TokLoc = GetTokenLoc(I);
3792      switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3793      case RangeBefore:
3794        assert(0 && "Infeasible");
3795      case RangeAfter:
3796        break;
3797      case RangeOverlap:
3798        Cursors[I] = cursor;
3799        AdvanceToken();
3800        continue;
3801      }
3802      break;
3803    }
3804
3805    // Save the preprocessing token index; restore the non-preprocessing
3806    // token index.
3807    PreprocessingTokIdx = TokIdx;
3808    TokIdx = SavedTokIdx;
3809    return CXChildVisit_Recurse;
3810  }
3811
3812  if (cursorRange.isInvalid())
3813    return CXChildVisit_Continue;
3814
3815  SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
3816
3817  // Adjust the annotated range based specific declarations.
3818  const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
3819  if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
3820    Decl *D = cxcursor::getCursorDecl(cursor);
3821    // Don't visit synthesized ObjC methods, since they have no syntatic
3822    // representation in the source.
3823    if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
3824      if (MD->isSynthesized())
3825        return CXChildVisit_Continue;
3826    }
3827    if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
3828      if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
3829        TypeLoc TL = TI->getTypeLoc();
3830        SourceLocation TLoc = TL.getSourceRange().getBegin();
3831        if (TLoc.isValid() && L.isValid() &&
3832            SrcMgr.isBeforeInTranslationUnit(TLoc, L))
3833          cursorRange.setBegin(TLoc);
3834      }
3835    }
3836  }
3837
3838  // If the location of the cursor occurs within a macro instantiation, record
3839  // the spelling location of the cursor in our annotation map.  We can then
3840  // paper over the token labelings during a post-processing step to try and
3841  // get cursor mappings for tokens that are the *arguments* of a macro
3842  // instantiation.
3843  if (L.isMacroID()) {
3844    unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
3845    // Only invalidate the old annotation if it isn't part of a preprocessing
3846    // directive.  Here we assume that the default construction of CXCursor
3847    // results in CXCursor.kind being an initialized value (i.e., 0).  If
3848    // this isn't the case, we can fix by doing lookup + insertion.
3849
3850    CXCursor &oldC = Annotated[rawEncoding];
3851    if (!clang_isPreprocessing(oldC.kind))
3852      oldC = cursor;
3853  }
3854
3855  const enum CXCursorKind K = clang_getCursorKind(parent);
3856  const CXCursor updateC =
3857    (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
3858     ? clang_getNullCursor() : parent;
3859
3860  while (MoreTokens()) {
3861    const unsigned I = NextToken();
3862    SourceLocation TokLoc = GetTokenLoc(I);
3863    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3864      case RangeBefore:
3865        Cursors[I] = updateC;
3866        AdvanceToken();
3867        continue;
3868      case RangeAfter:
3869      case RangeOverlap:
3870        break;
3871    }
3872    break;
3873  }
3874
3875  // Visit children to get their cursor information.
3876  const unsigned BeforeChildren = NextToken();
3877  VisitChildren(cursor);
3878  const unsigned AfterChildren = NextToken();
3879
3880  // Adjust 'Last' to the last token within the extent of the cursor.
3881  while (MoreTokens()) {
3882    const unsigned I = NextToken();
3883    SourceLocation TokLoc = GetTokenLoc(I);
3884    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3885      case RangeBefore:
3886        assert(0 && "Infeasible");
3887      case RangeAfter:
3888        break;
3889      case RangeOverlap:
3890        Cursors[I] = updateC;
3891        AdvanceToken();
3892        continue;
3893    }
3894    break;
3895  }
3896  const unsigned Last = NextToken();
3897
3898  // Scan the tokens that are at the beginning of the cursor, but are not
3899  // capture by the child cursors.
3900
3901  // For AST elements within macros, rely on a post-annotate pass to
3902  // to correctly annotate the tokens with cursors.  Otherwise we can
3903  // get confusing results of having tokens that map to cursors that really
3904  // are expanded by an instantiation.
3905  if (L.isMacroID())
3906    cursor = clang_getNullCursor();
3907
3908  for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
3909    if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
3910      break;
3911
3912    Cursors[I] = cursor;
3913  }
3914  // Scan the tokens that are at the end of the cursor, but are not captured
3915  // but the child cursors.
3916  for (unsigned I = AfterChildren; I != Last; ++I)
3917    Cursors[I] = cursor;
3918
3919  TokIdx = Last;
3920  return CXChildVisit_Continue;
3921}
3922
3923static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
3924                                                     CXCursor parent,
3925                                                     CXClientData client_data) {
3926  return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
3927}
3928
3929extern "C" {
3930
3931void clang_annotateTokens(CXTranslationUnit TU,
3932                          CXToken *Tokens, unsigned NumTokens,
3933                          CXCursor *Cursors) {
3934
3935  if (NumTokens == 0 || !Tokens || !Cursors)
3936    return;
3937
3938  // Any token we don't specifically annotate will have a NULL cursor.
3939  CXCursor C = clang_getNullCursor();
3940  for (unsigned I = 0; I != NumTokens; ++I)
3941    Cursors[I] = C;
3942
3943  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3944  if (!CXXUnit)
3945    return;
3946
3947  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3948
3949  // Determine the region of interest, which contains all of the tokens.
3950  SourceRange RegionOfInterest;
3951  RegionOfInterest.setBegin(cxloc::translateSourceLocation(
3952                                        clang_getTokenLocation(TU, Tokens[0])));
3953  RegionOfInterest.setEnd(cxloc::translateSourceLocation(
3954                                clang_getTokenLocation(TU,
3955                                                       Tokens[NumTokens - 1])));
3956
3957  // A mapping from the source locations found when re-lexing or traversing the
3958  // region of interest to the corresponding cursors.
3959  AnnotateTokensData Annotated;
3960
3961  // Relex the tokens within the source range to look for preprocessing
3962  // directives.
3963  SourceManager &SourceMgr = CXXUnit->getSourceManager();
3964  std::pair<FileID, unsigned> BeginLocInfo
3965    = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
3966  std::pair<FileID, unsigned> EndLocInfo
3967    = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
3968
3969  llvm::StringRef Buffer;
3970  bool Invalid = false;
3971  if (BeginLocInfo.first == EndLocInfo.first &&
3972      ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
3973      !Invalid) {
3974    Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3975              CXXUnit->getASTContext().getLangOptions(),
3976              Buffer.begin(), Buffer.data() + BeginLocInfo.second,
3977              Buffer.end());
3978    Lex.SetCommentRetentionState(true);
3979
3980    // Lex tokens in raw mode until we hit the end of the range, to avoid
3981    // entering #includes or expanding macros.
3982    while (true) {
3983      Token Tok;
3984      Lex.LexFromRawLexer(Tok);
3985
3986    reprocess:
3987      if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
3988        // We have found a preprocessing directive. Gobble it up so that we
3989        // don't see it while preprocessing these tokens later, but keep track of
3990        // all of the token locations inside this preprocessing directive so that
3991        // we can annotate them appropriately.
3992        //
3993        // FIXME: Some simple tests here could identify macro definitions and
3994        // #undefs, to provide specific cursor kinds for those.
3995        std::vector<SourceLocation> Locations;
3996        do {
3997          Locations.push_back(Tok.getLocation());
3998          Lex.LexFromRawLexer(Tok);
3999        } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
4000
4001        using namespace cxcursor;
4002        CXCursor Cursor
4003          = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
4004                                                         Locations.back()),
4005                                           CXXUnit);
4006        for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
4007          Annotated[Locations[I].getRawEncoding()] = Cursor;
4008        }
4009
4010        if (Tok.isAtStartOfLine())
4011          goto reprocess;
4012
4013        continue;
4014      }
4015
4016      if (Tok.is(tok::eof))
4017        break;
4018    }
4019  }
4020
4021  // Annotate all of the source locations in the region of interest that map to
4022  // a specific cursor.
4023  AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
4024                         CXXUnit, RegionOfInterest);
4025  W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit));
4026}
4027} // end: extern "C"
4028
4029//===----------------------------------------------------------------------===//
4030// Operations for querying linkage of a cursor.
4031//===----------------------------------------------------------------------===//
4032
4033extern "C" {
4034CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
4035  if (!clang_isDeclaration(cursor.kind))
4036    return CXLinkage_Invalid;
4037
4038  Decl *D = cxcursor::getCursorDecl(cursor);
4039  if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
4040    switch (ND->getLinkage()) {
4041      case NoLinkage: return CXLinkage_NoLinkage;
4042      case InternalLinkage: return CXLinkage_Internal;
4043      case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
4044      case ExternalLinkage: return CXLinkage_External;
4045    };
4046
4047  return CXLinkage_Invalid;
4048}
4049} // end: extern "C"
4050
4051//===----------------------------------------------------------------------===//
4052// Operations for querying language of a cursor.
4053//===----------------------------------------------------------------------===//
4054
4055static CXLanguageKind getDeclLanguage(const Decl *D) {
4056  switch (D->getKind()) {
4057    default:
4058      break;
4059    case Decl::ImplicitParam:
4060    case Decl::ObjCAtDefsField:
4061    case Decl::ObjCCategory:
4062    case Decl::ObjCCategoryImpl:
4063    case Decl::ObjCClass:
4064    case Decl::ObjCCompatibleAlias:
4065    case Decl::ObjCForwardProtocol:
4066    case Decl::ObjCImplementation:
4067    case Decl::ObjCInterface:
4068    case Decl::ObjCIvar:
4069    case Decl::ObjCMethod:
4070    case Decl::ObjCProperty:
4071    case Decl::ObjCPropertyImpl:
4072    case Decl::ObjCProtocol:
4073      return CXLanguage_ObjC;
4074    case Decl::CXXConstructor:
4075    case Decl::CXXConversion:
4076    case Decl::CXXDestructor:
4077    case Decl::CXXMethod:
4078    case Decl::CXXRecord:
4079    case Decl::ClassTemplate:
4080    case Decl::ClassTemplatePartialSpecialization:
4081    case Decl::ClassTemplateSpecialization:
4082    case Decl::Friend:
4083    case Decl::FriendTemplate:
4084    case Decl::FunctionTemplate:
4085    case Decl::LinkageSpec:
4086    case Decl::Namespace:
4087    case Decl::NamespaceAlias:
4088    case Decl::NonTypeTemplateParm:
4089    case Decl::StaticAssert:
4090    case Decl::TemplateTemplateParm:
4091    case Decl::TemplateTypeParm:
4092    case Decl::UnresolvedUsingTypename:
4093    case Decl::UnresolvedUsingValue:
4094    case Decl::Using:
4095    case Decl::UsingDirective:
4096    case Decl::UsingShadow:
4097      return CXLanguage_CPlusPlus;
4098  }
4099
4100  return CXLanguage_C;
4101}
4102
4103extern "C" {
4104
4105enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
4106  if (clang_isDeclaration(cursor.kind))
4107    if (Decl *D = cxcursor::getCursorDecl(cursor)) {
4108      if (D->hasAttr<UnavailableAttr>() ||
4109          (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted()))
4110        return CXAvailability_Available;
4111
4112      if (D->hasAttr<DeprecatedAttr>())
4113        return CXAvailability_Deprecated;
4114    }
4115
4116  return CXAvailability_Available;
4117}
4118
4119CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
4120  if (clang_isDeclaration(cursor.kind))
4121    return getDeclLanguage(cxcursor::getCursorDecl(cursor));
4122
4123  return CXLanguage_Invalid;
4124}
4125
4126CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
4127  if (clang_isDeclaration(cursor.kind)) {
4128    if (Decl *D = getCursorDecl(cursor)) {
4129      DeclContext *DC = D->getDeclContext();
4130      return MakeCXCursor(cast<Decl>(DC), getCursorASTUnit(cursor));
4131    }
4132  }
4133
4134  if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
4135    if (Decl *D = getCursorDecl(cursor))
4136      return MakeCXCursor(D, getCursorASTUnit(cursor));
4137  }
4138
4139  return clang_getNullCursor();
4140}
4141
4142CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
4143  if (clang_isDeclaration(cursor.kind)) {
4144    if (Decl *D = getCursorDecl(cursor)) {
4145      DeclContext *DC = D->getLexicalDeclContext();
4146      return MakeCXCursor(cast<Decl>(DC), getCursorASTUnit(cursor));
4147    }
4148  }
4149
4150  // FIXME: Note that we can't easily compute the lexical context of a
4151  // statement or expression, so we return nothing.
4152  return clang_getNullCursor();
4153}
4154
4155static void CollectOverriddenMethods(DeclContext *Ctx,
4156                                     ObjCMethodDecl *Method,
4157                            llvm::SmallVectorImpl<ObjCMethodDecl *> &Methods) {
4158  if (!Ctx)
4159    return;
4160
4161  // If we have a class or category implementation, jump straight to the
4162  // interface.
4163  if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx))
4164    return CollectOverriddenMethods(Impl->getClassInterface(), Method, Methods);
4165
4166  ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx);
4167  if (!Container)
4168    return;
4169
4170  // Check whether we have a matching method at this level.
4171  if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(),
4172                                                    Method->isInstanceMethod()))
4173    if (Method != Overridden) {
4174      // We found an override at this level; there is no need to look
4175      // into other protocols or categories.
4176      Methods.push_back(Overridden);
4177      return;
4178    }
4179
4180  if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) {
4181    for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(),
4182                                          PEnd = Protocol->protocol_end();
4183         P != PEnd; ++P)
4184      CollectOverriddenMethods(*P, Method, Methods);
4185  }
4186
4187  if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
4188    for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(),
4189                                          PEnd = Category->protocol_end();
4190         P != PEnd; ++P)
4191      CollectOverriddenMethods(*P, Method, Methods);
4192  }
4193
4194  if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
4195    for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(),
4196                                           PEnd = Interface->protocol_end();
4197         P != PEnd; ++P)
4198      CollectOverriddenMethods(*P, Method, Methods);
4199
4200    for (ObjCCategoryDecl *Category = Interface->getCategoryList();
4201         Category; Category = Category->getNextClassCategory())
4202      CollectOverriddenMethods(Category, Method, Methods);
4203
4204    // We only look into the superclass if we haven't found anything yet.
4205    if (Methods.empty())
4206      if (ObjCInterfaceDecl *Super = Interface->getSuperClass())
4207        return CollectOverriddenMethods(Super, Method, Methods);
4208  }
4209}
4210
4211void clang_getOverriddenCursors(CXCursor cursor,
4212                                CXCursor **overridden,
4213                                unsigned *num_overridden) {
4214  if (overridden)
4215    *overridden = 0;
4216  if (num_overridden)
4217    *num_overridden = 0;
4218  if (!overridden || !num_overridden)
4219    return;
4220
4221  if (!clang_isDeclaration(cursor.kind))
4222    return;
4223
4224  Decl *D = getCursorDecl(cursor);
4225  if (!D)
4226    return;
4227
4228  // Handle C++ member functions.
4229  ASTUnit *CXXUnit = getCursorASTUnit(cursor);
4230  if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
4231    *num_overridden = CXXMethod->size_overridden_methods();
4232    if (!*num_overridden)
4233      return;
4234
4235    *overridden = new CXCursor [*num_overridden];
4236    unsigned I = 0;
4237    for (CXXMethodDecl::method_iterator
4238              M = CXXMethod->begin_overridden_methods(),
4239           MEnd = CXXMethod->end_overridden_methods();
4240         M != MEnd; (void)++M, ++I)
4241      (*overridden)[I] = MakeCXCursor(const_cast<CXXMethodDecl*>(*M), CXXUnit);
4242    return;
4243  }
4244
4245  ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
4246  if (!Method)
4247    return;
4248
4249  // Handle Objective-C methods.
4250  llvm::SmallVector<ObjCMethodDecl *, 4> Methods;
4251  CollectOverriddenMethods(Method->getDeclContext(), Method, Methods);
4252
4253  if (Methods.empty())
4254    return;
4255
4256  *num_overridden = Methods.size();
4257  *overridden = new CXCursor [Methods.size()];
4258  for (unsigned I = 0, N = Methods.size(); I != N; ++I)
4259    (*overridden)[I] = MakeCXCursor(Methods[I], CXXUnit);
4260}
4261
4262void clang_disposeOverriddenCursors(CXCursor *overridden) {
4263  delete [] overridden;
4264}
4265
4266CXFile clang_getIncludedFile(CXCursor cursor) {
4267  if (cursor.kind != CXCursor_InclusionDirective)
4268    return 0;
4269
4270  InclusionDirective *ID = getCursorInclusionDirective(cursor);
4271  return (void *)ID->getFile();
4272}
4273
4274} // end: extern "C"
4275
4276
4277//===----------------------------------------------------------------------===//
4278// C++ AST instrospection.
4279//===----------------------------------------------------------------------===//
4280
4281extern "C" {
4282unsigned clang_CXXMethod_isStatic(CXCursor C) {
4283  if (!clang_isDeclaration(C.kind))
4284    return 0;
4285
4286  CXXMethodDecl *Method = 0;
4287  Decl *D = cxcursor::getCursorDecl(C);
4288  if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
4289    Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
4290  else
4291    Method = dyn_cast_or_null<CXXMethodDecl>(D);
4292  return (Method && Method->isStatic()) ? 1 : 0;
4293}
4294
4295} // end: extern "C"
4296
4297//===----------------------------------------------------------------------===//
4298// Attribute introspection.
4299//===----------------------------------------------------------------------===//
4300
4301extern "C" {
4302CXType clang_getIBOutletCollectionType(CXCursor C) {
4303  if (C.kind != CXCursor_IBOutletCollectionAttr)
4304    return cxtype::MakeCXType(QualType(), cxcursor::getCursorASTUnit(C));
4305
4306  IBOutletCollectionAttr *A =
4307    cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
4308
4309  return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorASTUnit(C));
4310}
4311} // end: extern "C"
4312
4313//===----------------------------------------------------------------------===//
4314// CXString Operations.
4315//===----------------------------------------------------------------------===//
4316
4317extern "C" {
4318const char *clang_getCString(CXString string) {
4319  return string.Spelling;
4320}
4321
4322void clang_disposeString(CXString string) {
4323  if (string.MustFreeString && string.Spelling)
4324    free((void*)string.Spelling);
4325}
4326
4327} // end: extern "C"
4328
4329namespace clang { namespace cxstring {
4330CXString createCXString(const char *String, bool DupString){
4331  CXString Str;
4332  if (DupString) {
4333    Str.Spelling = strdup(String);
4334    Str.MustFreeString = 1;
4335  } else {
4336    Str.Spelling = String;
4337    Str.MustFreeString = 0;
4338  }
4339  return Str;
4340}
4341
4342CXString createCXString(llvm::StringRef String, bool DupString) {
4343  CXString Result;
4344  if (DupString || (!String.empty() && String.data()[String.size()] != 0)) {
4345    char *Spelling = (char *)malloc(String.size() + 1);
4346    memmove(Spelling, String.data(), String.size());
4347    Spelling[String.size()] = 0;
4348    Result.Spelling = Spelling;
4349    Result.MustFreeString = 1;
4350  } else {
4351    Result.Spelling = String.data();
4352    Result.MustFreeString = 0;
4353  }
4354  return Result;
4355}
4356}}
4357
4358//===----------------------------------------------------------------------===//
4359// Misc. utility functions.
4360//===----------------------------------------------------------------------===//
4361
4362extern "C" {
4363
4364CXString clang_getClangVersion() {
4365  return createCXString(getClangFullVersion());
4366}
4367
4368} // end: extern "C"
4369