CIndex.cpp revision bf44c3b099602c9c967f1b20995919fb4ef39a51 
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    if (Visit(TSInfo->getTypeLoc()))
1752      return true;
1753
1754  return VisitExpr(E);
1755}
1756
1757bool CursorVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1758  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1759    return Visit(TSInfo->getTypeLoc());
1760
1761  return false;
1762}
1763
1764bool CursorVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1765  // Visit placement arguments.
1766  for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I)
1767    if (Visit(MakeCXCursor(E->getPlacementArg(I), StmtParent, TU)))
1768      return true;
1769
1770  // Visit the allocated type.
1771  if (TypeSourceInfo *TSInfo = E->getAllocatedTypeSourceInfo())
1772    if (Visit(TSInfo->getTypeLoc()))
1773      return true;
1774
1775  // Visit the array size, if any.
1776  if (E->isArray() && Visit(MakeCXCursor(E->getArraySize(), StmtParent, TU)))
1777    return true;
1778
1779  // Visit the initializer or constructor arguments.
1780  for (unsigned I = 0, N = E->getNumConstructorArgs(); I != N; ++I)
1781    if (Visit(MakeCXCursor(E->getConstructorArg(I), StmtParent, TU)))
1782      return true;
1783
1784  return false;
1785}
1786
1787bool CursorVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1788  // Visit base expression.
1789  if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1790    return true;
1791
1792  // Visit the nested-name-specifier.
1793  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1794    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1795      return true;
1796
1797  // Visit the scope type that looks disturbingly like the nested-name-specifier
1798  // but isn't.
1799  if (TypeSourceInfo *TSInfo = E->getScopeTypeInfo())
1800    if (Visit(TSInfo->getTypeLoc()))
1801      return true;
1802
1803  // Visit the name of the type being destroyed.
1804  if (TypeSourceInfo *TSInfo = E->getDestroyedTypeInfo())
1805    if (Visit(TSInfo->getTypeLoc()))
1806      return true;
1807
1808  return false;
1809}
1810
1811bool CursorVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
1812  return Visit(E->getQueriedTypeSourceInfo()->getTypeLoc());
1813}
1814
1815bool CursorVisitor::VisitOverloadExpr(OverloadExpr *E) {
1816  // Visit the nested-name-specifier.
1817  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1818    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1819      return true;
1820
1821  // Visit the declaration name.
1822  if (VisitDeclarationNameInfo(E->getNameInfo()))
1823    return true;
1824
1825  // Visit the overloaded declaration reference.
1826  if (Visit(MakeCursorOverloadedDeclRef(E, TU)))
1827    return true;
1828
1829  // Visit the explicitly-specified template arguments.
1830  if (const ExplicitTemplateArgumentList *ArgList
1831                                      = E->getOptionalExplicitTemplateArgs()) {
1832    for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1833                                *ArgEnd = Arg + ArgList->NumTemplateArgs;
1834         Arg != ArgEnd; ++Arg) {
1835      if (VisitTemplateArgumentLoc(*Arg))
1836        return true;
1837    }
1838  }
1839
1840  return false;
1841}
1842
1843bool CursorVisitor::VisitDependentScopeDeclRefExpr(
1844                                                DependentScopeDeclRefExpr *E) {
1845  // Visit the nested-name-specifier.
1846  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1847    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1848      return true;
1849
1850  // Visit the declaration name.
1851  if (VisitDeclarationNameInfo(E->getNameInfo()))
1852    return true;
1853
1854  // Visit the explicitly-specified template arguments.
1855  if (const ExplicitTemplateArgumentList *ArgList
1856      = E->getOptionalExplicitTemplateArgs()) {
1857    for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1858         *ArgEnd = Arg + ArgList->NumTemplateArgs;
1859         Arg != ArgEnd; ++Arg) {
1860      if (VisitTemplateArgumentLoc(*Arg))
1861        return true;
1862    }
1863  }
1864
1865  return false;
1866}
1867
1868bool CursorVisitor::VisitCXXUnresolvedConstructExpr(
1869                                                CXXUnresolvedConstructExpr *E) {
1870  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1871    if (Visit(TSInfo->getTypeLoc()))
1872      return true;
1873
1874  return VisitExpr(E);
1875}
1876
1877bool CursorVisitor::VisitCXXDependentScopeMemberExpr(
1878                                              CXXDependentScopeMemberExpr *E) {
1879  // Visit the base expression, if there is one.
1880  if (!E->isImplicitAccess() &&
1881      Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1882    return true;
1883
1884  // Visit the nested-name-specifier.
1885  if (NestedNameSpecifier *Qualifier = E->getQualifier())
1886    if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1887      return true;
1888
1889  // Visit the declaration name.
1890  if (VisitDeclarationNameInfo(E->getMemberNameInfo()))
1891    return true;
1892
1893  // Visit the explicitly-specified template arguments.
1894  if (const ExplicitTemplateArgumentList *ArgList
1895      = E->getOptionalExplicitTemplateArgs()) {
1896    for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1897         *ArgEnd = Arg + ArgList->NumTemplateArgs;
1898         Arg != ArgEnd; ++Arg) {
1899      if (VisitTemplateArgumentLoc(*Arg))
1900        return true;
1901    }
1902  }
1903
1904  return false;
1905}
1906
1907bool CursorVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E) {
1908  // Visit the base expression, if there is one.
1909  if (!E->isImplicitAccess() &&
1910      Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1911    return true;
1912
1913  return VisitOverloadExpr(E);
1914}
1915
1916bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) {
1917  if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo())
1918    if (Visit(TSInfo->getTypeLoc()))
1919      return true;
1920
1921  return VisitExpr(E);
1922}
1923
1924bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1925  return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc());
1926}
1927
1928
1929bool CursorVisitor::VisitAttributes(Decl *D) {
1930  for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1931       i != e; ++i)
1932    if (Visit(MakeCXCursor(*i, D, TU)))
1933        return true;
1934
1935  return false;
1936}
1937
1938static llvm::sys::Mutex EnableMultithreadingMutex;
1939static bool EnabledMultithreading;
1940
1941extern "C" {
1942CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
1943                          int displayDiagnostics) {
1944  // Disable pretty stack trace functionality, which will otherwise be a very
1945  // poor citizen of the world and set up all sorts of signal handlers.
1946  llvm::DisablePrettyStackTrace = true;
1947
1948  // We use crash recovery to make some of our APIs more reliable, implicitly
1949  // enable it.
1950  llvm::CrashRecoveryContext::Enable();
1951
1952  // Enable support for multithreading in LLVM.
1953  {
1954    llvm::sys::ScopedLock L(EnableMultithreadingMutex);
1955    if (!EnabledMultithreading) {
1956      llvm::llvm_start_multithreaded();
1957      EnabledMultithreading = true;
1958    }
1959  }
1960
1961  CIndexer *CIdxr = new CIndexer();
1962  if (excludeDeclarationsFromPCH)
1963    CIdxr->setOnlyLocalDecls();
1964  if (displayDiagnostics)
1965    CIdxr->setDisplayDiagnostics();
1966  return CIdxr;
1967}
1968
1969void clang_disposeIndex(CXIndex CIdx) {
1970  if (CIdx)
1971    delete static_cast<CIndexer *>(CIdx);
1972}
1973
1974CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
1975                                              const char *ast_filename) {
1976  if (!CIdx)
1977    return 0;
1978
1979  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1980  FileSystemOptions FileSystemOpts;
1981  FileSystemOpts.WorkingDir = CXXIdx->getWorkingDirectory();
1982
1983  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1984  return ASTUnit::LoadFromASTFile(ast_filename, Diags, FileSystemOpts,
1985                                  CXXIdx->getOnlyLocalDecls(),
1986                                  0, 0, true);
1987}
1988
1989unsigned clang_defaultEditingTranslationUnitOptions() {
1990  return CXTranslationUnit_PrecompiledPreamble |
1991         CXTranslationUnit_CacheCompletionResults |
1992         CXTranslationUnit_CXXPrecompiledPreamble;
1993}
1994
1995CXTranslationUnit
1996clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
1997                                          const char *source_filename,
1998                                          int num_command_line_args,
1999                                          const char * const *command_line_args,
2000                                          unsigned num_unsaved_files,
2001                                          struct CXUnsavedFile *unsaved_files) {
2002  return clang_parseTranslationUnit(CIdx, source_filename,
2003                                    command_line_args, num_command_line_args,
2004                                    unsaved_files, num_unsaved_files,
2005                                 CXTranslationUnit_DetailedPreprocessingRecord);
2006}
2007
2008struct ParseTranslationUnitInfo {
2009  CXIndex CIdx;
2010  const char *source_filename;
2011  const char *const *command_line_args;
2012  int num_command_line_args;
2013  struct CXUnsavedFile *unsaved_files;
2014  unsigned num_unsaved_files;
2015  unsigned options;
2016  CXTranslationUnit result;
2017};
2018static void clang_parseTranslationUnit_Impl(void *UserData) {
2019  ParseTranslationUnitInfo *PTUI =
2020    static_cast<ParseTranslationUnitInfo*>(UserData);
2021  CXIndex CIdx = PTUI->CIdx;
2022  const char *source_filename = PTUI->source_filename;
2023  const char * const *command_line_args = PTUI->command_line_args;
2024  int num_command_line_args = PTUI->num_command_line_args;
2025  struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
2026  unsigned num_unsaved_files = PTUI->num_unsaved_files;
2027  unsigned options = PTUI->options;
2028  PTUI->result = 0;
2029
2030  if (!CIdx)
2031    return;
2032
2033  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2034
2035  bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
2036  bool CompleteTranslationUnit
2037    = ((options & CXTranslationUnit_Incomplete) == 0);
2038  bool CacheCodeCompetionResults
2039    = options & CXTranslationUnit_CacheCompletionResults;
2040  bool CXXPrecompilePreamble
2041    = options & CXTranslationUnit_CXXPrecompiledPreamble;
2042  bool CXXChainedPCH
2043    = options & CXTranslationUnit_CXXChainedPCH;
2044
2045  // Configure the diagnostics.
2046  DiagnosticOptions DiagOpts;
2047  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
2048  Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
2049
2050  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2051  for (unsigned I = 0; I != num_unsaved_files; ++I) {
2052    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2053    const llvm::MemoryBuffer *Buffer
2054      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
2055    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2056                                           Buffer));
2057  }
2058
2059  llvm::SmallVector<const char *, 16> Args;
2060
2061  // The 'source_filename' argument is optional.  If the caller does not
2062  // specify it then it is assumed that the source file is specified
2063  // in the actual argument list.
2064  if (source_filename)
2065    Args.push_back(source_filename);
2066
2067  // Since the Clang C library is primarily used by batch tools dealing with
2068  // (often very broken) source code, where spell-checking can have a
2069  // significant negative impact on performance (particularly when
2070  // precompiled headers are involved), we disable it by default.
2071  // Only do this if we haven't found a spell-checking-related argument.
2072  bool FoundSpellCheckingArgument = false;
2073  for (int I = 0; I != num_command_line_args; ++I) {
2074    if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
2075        strcmp(command_line_args[I], "-fspell-checking") == 0) {
2076      FoundSpellCheckingArgument = true;
2077      break;
2078    }
2079  }
2080  if (!FoundSpellCheckingArgument)
2081    Args.push_back("-fno-spell-checking");
2082
2083  Args.insert(Args.end(), command_line_args,
2084              command_line_args + num_command_line_args);
2085
2086  // Do we need the detailed preprocessing record?
2087  if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
2088    Args.push_back("-Xclang");
2089    Args.push_back("-detailed-preprocessing-record");
2090  }
2091
2092  unsigned NumErrors = Diags->getNumErrors();
2093  llvm::OwningPtr<ASTUnit> Unit(
2094    ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
2095                                 Diags,
2096                                 CXXIdx->getClangResourcesPath(),
2097                                 CXXIdx->getOnlyLocalDecls(),
2098                                 RemappedFiles.data(),
2099                                 RemappedFiles.size(),
2100                                 /*CaptureDiagnostics=*/true,
2101                                 PrecompilePreamble,
2102                                 CompleteTranslationUnit,
2103                                 CacheCodeCompetionResults,
2104                                 CXXPrecompilePreamble,
2105                                 CXXChainedPCH));
2106
2107  if (NumErrors != Diags->getNumErrors()) {
2108    // Make sure to check that 'Unit' is non-NULL.
2109    if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
2110      for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2111                                      DEnd = Unit->stored_diag_end();
2112           D != DEnd; ++D) {
2113        CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
2114        CXString Msg = clang_formatDiagnostic(&Diag,
2115                                    clang_defaultDiagnosticDisplayOptions());
2116        fprintf(stderr, "%s\n", clang_getCString(Msg));
2117        clang_disposeString(Msg);
2118      }
2119#ifdef LLVM_ON_WIN32
2120      // On Windows, force a flush, since there may be multiple copies of
2121      // stderr and stdout in the file system, all with different buffers
2122      // but writing to the same device.
2123      fflush(stderr);
2124#endif
2125    }
2126  }
2127
2128  PTUI->result = Unit.take();
2129}
2130CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2131                                             const char *source_filename,
2132                                         const char * const *command_line_args,
2133                                             int num_command_line_args,
2134                                            struct CXUnsavedFile *unsaved_files,
2135                                             unsigned num_unsaved_files,
2136                                             unsigned options) {
2137  ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
2138                                    num_command_line_args, unsaved_files,
2139                                    num_unsaved_files, options, 0 };
2140  llvm::CrashRecoveryContext CRC;
2141
2142  if (!RunSafely(CRC, clang_parseTranslationUnit_Impl, &PTUI)) {
2143    fprintf(stderr, "libclang: crash detected during parsing: {\n");
2144    fprintf(stderr, "  'source_filename' : '%s'\n", source_filename);
2145    fprintf(stderr, "  'command_line_args' : [");
2146    for (int i = 0; i != num_command_line_args; ++i) {
2147      if (i)
2148        fprintf(stderr, ", ");
2149      fprintf(stderr, "'%s'", command_line_args[i]);
2150    }
2151    fprintf(stderr, "],\n");
2152    fprintf(stderr, "  'unsaved_files' : [");
2153    for (unsigned i = 0; i != num_unsaved_files; ++i) {
2154      if (i)
2155        fprintf(stderr, ", ");
2156      fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2157              unsaved_files[i].Length);
2158    }
2159    fprintf(stderr, "],\n");
2160    fprintf(stderr, "  'options' : %d,\n", options);
2161    fprintf(stderr, "}\n");
2162
2163    return 0;
2164  }
2165
2166  return PTUI.result;
2167}
2168
2169unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2170  return CXSaveTranslationUnit_None;
2171}
2172
2173int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2174                              unsigned options) {
2175  if (!TU)
2176    return 1;
2177
2178  return static_cast<ASTUnit *>(TU)->Save(FileName);
2179}
2180
2181void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
2182  if (CTUnit) {
2183    // If the translation unit has been marked as unsafe to free, just discard
2184    // it.
2185    if (static_cast<ASTUnit *>(CTUnit)->isUnsafeToFree())
2186      return;
2187
2188    delete static_cast<ASTUnit *>(CTUnit);
2189  }
2190}
2191
2192unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2193  return CXReparse_None;
2194}
2195
2196struct ReparseTranslationUnitInfo {
2197  CXTranslationUnit TU;
2198  unsigned num_unsaved_files;
2199  struct CXUnsavedFile *unsaved_files;
2200  unsigned options;
2201  int result;
2202};
2203
2204static void clang_reparseTranslationUnit_Impl(void *UserData) {
2205  ReparseTranslationUnitInfo *RTUI =
2206    static_cast<ReparseTranslationUnitInfo*>(UserData);
2207  CXTranslationUnit TU = RTUI->TU;
2208  unsigned num_unsaved_files = RTUI->num_unsaved_files;
2209  struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2210  unsigned options = RTUI->options;
2211  (void) options;
2212  RTUI->result = 1;
2213
2214  if (!TU)
2215    return;
2216
2217  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2218  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2219
2220  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2221  for (unsigned I = 0; I != num_unsaved_files; ++I) {
2222    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2223    const llvm::MemoryBuffer *Buffer
2224      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
2225    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2226                                           Buffer));
2227  }
2228
2229  if (!CXXUnit->Reparse(RemappedFiles.data(), RemappedFiles.size()))
2230    RTUI->result = 0;
2231}
2232
2233int clang_reparseTranslationUnit(CXTranslationUnit TU,
2234                                 unsigned num_unsaved_files,
2235                                 struct CXUnsavedFile *unsaved_files,
2236                                 unsigned options) {
2237  ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2238                                      options, 0 };
2239  llvm::CrashRecoveryContext CRC;
2240
2241  if (!RunSafely(CRC, clang_reparseTranslationUnit_Impl, &RTUI)) {
2242    fprintf(stderr, "libclang: crash detected during reparsing\n");
2243    static_cast<ASTUnit *>(TU)->setUnsafeToFree(true);
2244    return 1;
2245  }
2246
2247
2248  return RTUI.result;
2249}
2250
2251
2252CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
2253  if (!CTUnit)
2254    return createCXString("");
2255
2256  ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
2257  return createCXString(CXXUnit->getOriginalSourceFileName(), true);
2258}
2259
2260CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
2261  CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
2262  return Result;
2263}
2264
2265} // end: extern "C"
2266
2267//===----------------------------------------------------------------------===//
2268// CXSourceLocation and CXSourceRange Operations.
2269//===----------------------------------------------------------------------===//
2270
2271extern "C" {
2272CXSourceLocation clang_getNullLocation() {
2273  CXSourceLocation Result = { { 0, 0 }, 0 };
2274  return Result;
2275}
2276
2277unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
2278  return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2279          loc1.ptr_data[1] == loc2.ptr_data[1] &&
2280          loc1.int_data == loc2.int_data);
2281}
2282
2283CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2284                                   CXFile file,
2285                                   unsigned line,
2286                                   unsigned column) {
2287  if (!tu || !file)
2288    return clang_getNullLocation();
2289
2290  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2291  SourceLocation SLoc
2292    = CXXUnit->getSourceManager().getLocation(
2293                                        static_cast<const FileEntry *>(file),
2294                                              line, column);
2295  if (SLoc.isInvalid()) return clang_getNullLocation();
2296
2297  return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2298}
2299
2300CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
2301                                            CXFile file,
2302                                            unsigned offset) {
2303  if (!tu || !file)
2304    return clang_getNullLocation();
2305
2306  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2307  SourceLocation Start
2308    = CXXUnit->getSourceManager().getLocation(
2309                                        static_cast<const FileEntry *>(file),
2310                                              1, 1);
2311  if (Start.isInvalid()) return clang_getNullLocation();
2312
2313  SourceLocation SLoc = Start.getFileLocWithOffset(offset);
2314
2315  if (SLoc.isInvalid()) return clang_getNullLocation();
2316
2317  return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2318}
2319
2320CXSourceRange clang_getNullRange() {
2321  CXSourceRange Result = { { 0, 0 }, 0, 0 };
2322  return Result;
2323}
2324
2325CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2326  if (begin.ptr_data[0] != end.ptr_data[0] ||
2327      begin.ptr_data[1] != end.ptr_data[1])
2328    return clang_getNullRange();
2329
2330  CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
2331                           begin.int_data, end.int_data };
2332  return Result;
2333}
2334
2335void clang_getInstantiationLocation(CXSourceLocation location,
2336                                    CXFile *file,
2337                                    unsigned *line,
2338                                    unsigned *column,
2339                                    unsigned *offset) {
2340  SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2341
2342  if (!location.ptr_data[0] || Loc.isInvalid()) {
2343    if (file)
2344      *file = 0;
2345    if (line)
2346      *line = 0;
2347    if (column)
2348      *column = 0;
2349    if (offset)
2350      *offset = 0;
2351    return;
2352  }
2353
2354  const SourceManager &SM =
2355    *static_cast<const SourceManager*>(location.ptr_data[0]);
2356  SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
2357
2358  if (file)
2359    *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
2360  if (line)
2361    *line = SM.getInstantiationLineNumber(InstLoc);
2362  if (column)
2363    *column = SM.getInstantiationColumnNumber(InstLoc);
2364  if (offset)
2365    *offset = SM.getDecomposedLoc(InstLoc).second;
2366}
2367
2368CXSourceLocation clang_getRangeStart(CXSourceRange range) {
2369  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
2370                              range.begin_int_data };
2371  return Result;
2372}
2373
2374CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
2375  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
2376                              range.end_int_data };
2377  return Result;
2378}
2379
2380} // end: extern "C"
2381
2382//===----------------------------------------------------------------------===//
2383// CXFile Operations.
2384//===----------------------------------------------------------------------===//
2385
2386extern "C" {
2387CXString clang_getFileName(CXFile SFile) {
2388  if (!SFile)
2389    return createCXString(NULL);
2390
2391  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2392  return createCXString(FEnt->getName());
2393}
2394
2395time_t clang_getFileTime(CXFile SFile) {
2396  if (!SFile)
2397    return 0;
2398
2399  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2400  return FEnt->getModificationTime();
2401}
2402
2403CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2404  if (!tu)
2405    return 0;
2406
2407  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2408
2409  FileManager &FMgr = CXXUnit->getFileManager();
2410  const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name),
2411                                       CXXUnit->getFileSystemOpts());
2412  return const_cast<FileEntry *>(File);
2413}
2414
2415} // end: extern "C"
2416
2417//===----------------------------------------------------------------------===//
2418// CXCursor Operations.
2419//===----------------------------------------------------------------------===//
2420
2421static Decl *getDeclFromExpr(Stmt *E) {
2422  if (CastExpr *CE = dyn_cast<CastExpr>(E))
2423    return getDeclFromExpr(CE->getSubExpr());
2424
2425  if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
2426    return RefExpr->getDecl();
2427  if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2428    return RefExpr->getDecl();
2429  if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
2430    return ME->getMemberDecl();
2431  if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
2432    return RE->getDecl();
2433  if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E))
2434    return PRE->getProperty();
2435
2436  if (CallExpr *CE = dyn_cast<CallExpr>(E))
2437    return getDeclFromExpr(CE->getCallee());
2438  if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
2439    return OME->getMethodDecl();
2440
2441  if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
2442    return PE->getProtocol();
2443
2444  return 0;
2445}
2446
2447static SourceLocation getLocationFromExpr(Expr *E) {
2448  if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
2449    return /*FIXME:*/Msg->getLeftLoc();
2450  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
2451    return DRE->getLocation();
2452  if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
2453    return RefExpr->getLocation();
2454  if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
2455    return Member->getMemberLoc();
2456  if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
2457    return Ivar->getLocation();
2458  return E->getLocStart();
2459}
2460
2461extern "C" {
2462
2463unsigned clang_visitChildren(CXCursor parent,
2464                             CXCursorVisitor visitor,
2465                             CXClientData client_data) {
2466  ASTUnit *CXXUnit = getCursorASTUnit(parent);
2467
2468  CursorVisitor CursorVis(CXXUnit, visitor, client_data,
2469                          CXXUnit->getMaxPCHLevel());
2470  return CursorVis.VisitChildren(parent);
2471}
2472
2473#ifndef __has_feature
2474#define __has_feature(x) 0
2475#endif
2476#if __has_feature(blocks)
2477typedef enum CXChildVisitResult
2478     (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
2479
2480static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2481    CXClientData client_data) {
2482  CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2483  return block(cursor, parent);
2484}
2485#else
2486// If we are compiled with a compiler that doesn't have native blocks support,
2487// define and call the block manually, so the
2488typedef struct _CXChildVisitResult
2489{
2490	void *isa;
2491	int flags;
2492	int reserved;
2493	enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
2494                                         CXCursor);
2495} *CXCursorVisitorBlock;
2496
2497static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
2498    CXClientData client_data) {
2499  CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
2500  return block->invoke(block, cursor, parent);
2501}
2502#endif
2503
2504
2505unsigned clang_visitChildrenWithBlock(CXCursor parent,
2506                                      CXCursorVisitorBlock block) {
2507  return clang_visitChildren(parent, visitWithBlock, block);
2508}
2509
2510static CXString getDeclSpelling(Decl *D) {
2511  NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
2512  if (!ND)
2513    return createCXString("");
2514
2515  if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
2516    return createCXString(OMD->getSelector().getAsString());
2517
2518  if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
2519    // No, this isn't the same as the code below. getIdentifier() is non-virtual
2520    // and returns different names. NamedDecl returns the class name and
2521    // ObjCCategoryImplDecl returns the category name.
2522    return createCXString(CIMP->getIdentifier()->getNameStart());
2523
2524  if (isa<UsingDirectiveDecl>(D))
2525    return createCXString("");
2526
2527  llvm::SmallString<1024> S;
2528  llvm::raw_svector_ostream os(S);
2529  ND->printName(os);
2530
2531  return createCXString(os.str());
2532}
2533
2534CXString clang_getCursorSpelling(CXCursor C) {
2535  if (clang_isTranslationUnit(C.kind))
2536    return clang_getTranslationUnitSpelling(C.data[2]);
2537
2538  if (clang_isReference(C.kind)) {
2539    switch (C.kind) {
2540    case CXCursor_ObjCSuperClassRef: {
2541      ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
2542      return createCXString(Super->getIdentifier()->getNameStart());
2543    }
2544    case CXCursor_ObjCClassRef: {
2545      ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
2546      return createCXString(Class->getIdentifier()->getNameStart());
2547    }
2548    case CXCursor_ObjCProtocolRef: {
2549      ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
2550      assert(OID && "getCursorSpelling(): Missing protocol decl");
2551      return createCXString(OID->getIdentifier()->getNameStart());
2552    }
2553    case CXCursor_CXXBaseSpecifier: {
2554      CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
2555      return createCXString(B->getType().getAsString());
2556    }
2557    case CXCursor_TypeRef: {
2558      TypeDecl *Type = getCursorTypeRef(C).first;
2559      assert(Type && "Missing type decl");
2560
2561      return createCXString(getCursorContext(C).getTypeDeclType(Type).
2562                              getAsString());
2563    }
2564    case CXCursor_TemplateRef: {
2565      TemplateDecl *Template = getCursorTemplateRef(C).first;
2566      assert(Template && "Missing template decl");
2567
2568      return createCXString(Template->getNameAsString());
2569    }
2570
2571    case CXCursor_NamespaceRef: {
2572      NamedDecl *NS = getCursorNamespaceRef(C).first;
2573      assert(NS && "Missing namespace decl");
2574
2575      return createCXString(NS->getNameAsString());
2576    }
2577
2578    case CXCursor_MemberRef: {
2579      FieldDecl *Field = getCursorMemberRef(C).first;
2580      assert(Field && "Missing member decl");
2581
2582      return createCXString(Field->getNameAsString());
2583    }
2584
2585    case CXCursor_LabelRef: {
2586      LabelStmt *Label = getCursorLabelRef(C).first;
2587      assert(Label && "Missing label");
2588
2589      return createCXString(Label->getID()->getName());
2590    }
2591
2592    case CXCursor_OverloadedDeclRef: {
2593      OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
2594      if (Decl *D = Storage.dyn_cast<Decl *>()) {
2595        if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
2596          return createCXString(ND->getNameAsString());
2597        return createCXString("");
2598      }
2599      if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
2600        return createCXString(E->getName().getAsString());
2601      OverloadedTemplateStorage *Ovl
2602        = Storage.get<OverloadedTemplateStorage*>();
2603      if (Ovl->size() == 0)
2604        return createCXString("");
2605      return createCXString((*Ovl->begin())->getNameAsString());
2606    }
2607
2608    default:
2609      return createCXString("<not implemented>");
2610    }
2611  }
2612
2613  if (clang_isExpression(C.kind)) {
2614    Decl *D = getDeclFromExpr(getCursorExpr(C));
2615    if (D)
2616      return getDeclSpelling(D);
2617    return createCXString("");
2618  }
2619
2620  if (clang_isStatement(C.kind)) {
2621    Stmt *S = getCursorStmt(C);
2622    if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
2623      return createCXString(Label->getID()->getName());
2624
2625    return createCXString("");
2626  }
2627
2628  if (C.kind == CXCursor_MacroInstantiation)
2629    return createCXString(getCursorMacroInstantiation(C)->getName()
2630                                                           ->getNameStart());
2631
2632  if (C.kind == CXCursor_MacroDefinition)
2633    return createCXString(getCursorMacroDefinition(C)->getName()
2634                                                           ->getNameStart());
2635
2636  if (C.kind == CXCursor_InclusionDirective)
2637    return createCXString(getCursorInclusionDirective(C)->getFileName());
2638
2639  if (clang_isDeclaration(C.kind))
2640    return getDeclSpelling(getCursorDecl(C));
2641
2642  return createCXString("");
2643}
2644
2645CXString clang_getCursorDisplayName(CXCursor C) {
2646  if (!clang_isDeclaration(C.kind))
2647    return clang_getCursorSpelling(C);
2648
2649  Decl *D = getCursorDecl(C);
2650  if (!D)
2651    return createCXString("");
2652
2653  PrintingPolicy &Policy = getCursorContext(C).PrintingPolicy;
2654  if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
2655    D = FunTmpl->getTemplatedDecl();
2656
2657  if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
2658    llvm::SmallString<64> Str;
2659    llvm::raw_svector_ostream OS(Str);
2660    OS << Function->getNameAsString();
2661    if (Function->getPrimaryTemplate())
2662      OS << "<>";
2663    OS << "(";
2664    for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
2665      if (I)
2666        OS << ", ";
2667      OS << Function->getParamDecl(I)->getType().getAsString(Policy);
2668    }
2669
2670    if (Function->isVariadic()) {
2671      if (Function->getNumParams())
2672        OS << ", ";
2673      OS << "...";
2674    }
2675    OS << ")";
2676    return createCXString(OS.str());
2677  }
2678
2679  if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
2680    llvm::SmallString<64> Str;
2681    llvm::raw_svector_ostream OS(Str);
2682    OS << ClassTemplate->getNameAsString();
2683    OS << "<";
2684    TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
2685    for (unsigned I = 0, N = Params->size(); I != N; ++I) {
2686      if (I)
2687        OS << ", ";
2688
2689      NamedDecl *Param = Params->getParam(I);
2690      if (Param->getIdentifier()) {
2691        OS << Param->getIdentifier()->getName();
2692        continue;
2693      }
2694
2695      // There is no parameter name, which makes this tricky. Try to come up
2696      // with something useful that isn't too long.
2697      if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
2698        OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
2699      else if (NonTypeTemplateParmDecl *NTTP
2700                                    = dyn_cast<NonTypeTemplateParmDecl>(Param))
2701        OS << NTTP->getType().getAsString(Policy);
2702      else
2703        OS << "template<...> class";
2704    }
2705
2706    OS << ">";
2707    return createCXString(OS.str());
2708  }
2709
2710  if (ClassTemplateSpecializationDecl *ClassSpec
2711                              = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
2712    // If the type was explicitly written, use that.
2713    if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
2714      return createCXString(TSInfo->getType().getAsString(Policy));
2715
2716    llvm::SmallString<64> Str;
2717    llvm::raw_svector_ostream OS(Str);
2718    OS << ClassSpec->getNameAsString();
2719    OS << TemplateSpecializationType::PrintTemplateArgumentList(
2720                            ClassSpec->getTemplateArgs().getFlatArgumentList(),
2721                                      ClassSpec->getTemplateArgs().flat_size(),
2722                                                                Policy);
2723    return createCXString(OS.str());
2724  }
2725
2726  return clang_getCursorSpelling(C);
2727}
2728
2729CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
2730  switch (Kind) {
2731  case CXCursor_FunctionDecl:
2732      return createCXString("FunctionDecl");
2733  case CXCursor_TypedefDecl:
2734      return createCXString("TypedefDecl");
2735  case CXCursor_EnumDecl:
2736      return createCXString("EnumDecl");
2737  case CXCursor_EnumConstantDecl:
2738      return createCXString("EnumConstantDecl");
2739  case CXCursor_StructDecl:
2740      return createCXString("StructDecl");
2741  case CXCursor_UnionDecl:
2742      return createCXString("UnionDecl");
2743  case CXCursor_ClassDecl:
2744      return createCXString("ClassDecl");
2745  case CXCursor_FieldDecl:
2746      return createCXString("FieldDecl");
2747  case CXCursor_VarDecl:
2748      return createCXString("VarDecl");
2749  case CXCursor_ParmDecl:
2750      return createCXString("ParmDecl");
2751  case CXCursor_ObjCInterfaceDecl:
2752      return createCXString("ObjCInterfaceDecl");
2753  case CXCursor_ObjCCategoryDecl:
2754      return createCXString("ObjCCategoryDecl");
2755  case CXCursor_ObjCProtocolDecl:
2756      return createCXString("ObjCProtocolDecl");
2757  case CXCursor_ObjCPropertyDecl:
2758      return createCXString("ObjCPropertyDecl");
2759  case CXCursor_ObjCIvarDecl:
2760      return createCXString("ObjCIvarDecl");
2761  case CXCursor_ObjCInstanceMethodDecl:
2762      return createCXString("ObjCInstanceMethodDecl");
2763  case CXCursor_ObjCClassMethodDecl:
2764      return createCXString("ObjCClassMethodDecl");
2765  case CXCursor_ObjCImplementationDecl:
2766      return createCXString("ObjCImplementationDecl");
2767  case CXCursor_ObjCCategoryImplDecl:
2768      return createCXString("ObjCCategoryImplDecl");
2769  case CXCursor_CXXMethod:
2770      return createCXString("CXXMethod");
2771  case CXCursor_UnexposedDecl:
2772      return createCXString("UnexposedDecl");
2773  case CXCursor_ObjCSuperClassRef:
2774      return createCXString("ObjCSuperClassRef");
2775  case CXCursor_ObjCProtocolRef:
2776      return createCXString("ObjCProtocolRef");
2777  case CXCursor_ObjCClassRef:
2778      return createCXString("ObjCClassRef");
2779  case CXCursor_TypeRef:
2780      return createCXString("TypeRef");
2781  case CXCursor_TemplateRef:
2782      return createCXString("TemplateRef");
2783  case CXCursor_NamespaceRef:
2784    return createCXString("NamespaceRef");
2785  case CXCursor_MemberRef:
2786    return createCXString("MemberRef");
2787  case CXCursor_LabelRef:
2788    return createCXString("LabelRef");
2789  case CXCursor_OverloadedDeclRef:
2790    return createCXString("OverloadedDeclRef");
2791  case CXCursor_UnexposedExpr:
2792      return createCXString("UnexposedExpr");
2793  case CXCursor_BlockExpr:
2794      return createCXString("BlockExpr");
2795  case CXCursor_DeclRefExpr:
2796      return createCXString("DeclRefExpr");
2797  case CXCursor_MemberRefExpr:
2798      return createCXString("MemberRefExpr");
2799  case CXCursor_CallExpr:
2800      return createCXString("CallExpr");
2801  case CXCursor_ObjCMessageExpr:
2802      return createCXString("ObjCMessageExpr");
2803  case CXCursor_UnexposedStmt:
2804      return createCXString("UnexposedStmt");
2805  case CXCursor_LabelStmt:
2806      return createCXString("LabelStmt");
2807  case CXCursor_InvalidFile:
2808      return createCXString("InvalidFile");
2809  case CXCursor_InvalidCode:
2810    return createCXString("InvalidCode");
2811  case CXCursor_NoDeclFound:
2812      return createCXString("NoDeclFound");
2813  case CXCursor_NotImplemented:
2814      return createCXString("NotImplemented");
2815  case CXCursor_TranslationUnit:
2816      return createCXString("TranslationUnit");
2817  case CXCursor_UnexposedAttr:
2818      return createCXString("UnexposedAttr");
2819  case CXCursor_IBActionAttr:
2820      return createCXString("attribute(ibaction)");
2821  case CXCursor_IBOutletAttr:
2822     return createCXString("attribute(iboutlet)");
2823  case CXCursor_IBOutletCollectionAttr:
2824      return createCXString("attribute(iboutletcollection)");
2825  case CXCursor_PreprocessingDirective:
2826    return createCXString("preprocessing directive");
2827  case CXCursor_MacroDefinition:
2828    return createCXString("macro definition");
2829  case CXCursor_MacroInstantiation:
2830    return createCXString("macro instantiation");
2831  case CXCursor_InclusionDirective:
2832    return createCXString("inclusion directive");
2833  case CXCursor_Namespace:
2834    return createCXString("Namespace");
2835  case CXCursor_LinkageSpec:
2836    return createCXString("LinkageSpec");
2837  case CXCursor_CXXBaseSpecifier:
2838    return createCXString("C++ base class specifier");
2839  case CXCursor_Constructor:
2840    return createCXString("CXXConstructor");
2841  case CXCursor_Destructor:
2842    return createCXString("CXXDestructor");
2843  case CXCursor_ConversionFunction:
2844    return createCXString("CXXConversion");
2845  case CXCursor_TemplateTypeParameter:
2846    return createCXString("TemplateTypeParameter");
2847  case CXCursor_NonTypeTemplateParameter:
2848    return createCXString("NonTypeTemplateParameter");
2849  case CXCursor_TemplateTemplateParameter:
2850    return createCXString("TemplateTemplateParameter");
2851  case CXCursor_FunctionTemplate:
2852    return createCXString("FunctionTemplate");
2853  case CXCursor_ClassTemplate:
2854    return createCXString("ClassTemplate");
2855  case CXCursor_ClassTemplatePartialSpecialization:
2856    return createCXString("ClassTemplatePartialSpecialization");
2857  case CXCursor_NamespaceAlias:
2858    return createCXString("NamespaceAlias");
2859  case CXCursor_UsingDirective:
2860    return createCXString("UsingDirective");
2861  case CXCursor_UsingDeclaration:
2862    return createCXString("UsingDeclaration");
2863  }
2864
2865  llvm_unreachable("Unhandled CXCursorKind");
2866  return createCXString(NULL);
2867}
2868
2869enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
2870                                         CXCursor parent,
2871                                         CXClientData client_data) {
2872  CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
2873  *BestCursor = cursor;
2874  return CXChildVisit_Recurse;
2875}
2876
2877CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
2878  if (!TU)
2879    return clang_getNullCursor();
2880
2881  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2882  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2883
2884  // Translate the given source location to make it point at the beginning of
2885  // the token under the cursor.
2886  SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
2887
2888  // Guard against an invalid SourceLocation, or we may assert in one
2889  // of the following calls.
2890  if (SLoc.isInvalid())
2891    return clang_getNullCursor();
2892
2893  bool Logging = getenv("LIBCLANG_LOGGING");
2894  SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
2895                                    CXXUnit->getASTContext().getLangOptions());
2896
2897  CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
2898  if (SLoc.isValid()) {
2899    // FIXME: Would be great to have a "hint" cursor, then walk from that
2900    // hint cursor upward until we find a cursor whose source range encloses
2901    // the region of interest, rather than starting from the translation unit.
2902    CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit);
2903    CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result,
2904                            Decl::MaxPCHLevel, SourceLocation(SLoc));
2905    CursorVis.VisitChildren(Parent);
2906  }
2907
2908  if (Logging) {
2909    CXFile SearchFile;
2910    unsigned SearchLine, SearchColumn;
2911    CXFile ResultFile;
2912    unsigned ResultLine, ResultColumn;
2913    CXString SearchFileName, ResultFileName, KindSpelling;
2914    CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
2915
2916    clang_getInstantiationLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
2917                                   0);
2918    clang_getInstantiationLocation(ResultLoc, &ResultFile, &ResultLine,
2919                                   &ResultColumn, 0);
2920    SearchFileName = clang_getFileName(SearchFile);
2921    ResultFileName = clang_getFileName(ResultFile);
2922    KindSpelling = clang_getCursorKindSpelling(Result.kind);
2923    fprintf(stderr, "clang_getCursor(%s:%d:%d) = %s(%s:%d:%d)\n",
2924            clang_getCString(SearchFileName), SearchLine, SearchColumn,
2925            clang_getCString(KindSpelling),
2926            clang_getCString(ResultFileName), ResultLine, ResultColumn);
2927    clang_disposeString(SearchFileName);
2928    clang_disposeString(ResultFileName);
2929    clang_disposeString(KindSpelling);
2930  }
2931
2932  return Result;
2933}
2934
2935CXCursor clang_getNullCursor(void) {
2936  return MakeCXCursorInvalid(CXCursor_InvalidFile);
2937}
2938
2939unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
2940  return X == Y;
2941}
2942
2943unsigned clang_isInvalid(enum CXCursorKind K) {
2944  return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
2945}
2946
2947unsigned clang_isDeclaration(enum CXCursorKind K) {
2948  return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
2949}
2950
2951unsigned clang_isReference(enum CXCursorKind K) {
2952  return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
2953}
2954
2955unsigned clang_isExpression(enum CXCursorKind K) {
2956  return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
2957}
2958
2959unsigned clang_isStatement(enum CXCursorKind K) {
2960  return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
2961}
2962
2963unsigned clang_isTranslationUnit(enum CXCursorKind K) {
2964  return K == CXCursor_TranslationUnit;
2965}
2966
2967unsigned clang_isPreprocessing(enum CXCursorKind K) {
2968  return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
2969}
2970
2971unsigned clang_isUnexposed(enum CXCursorKind K) {
2972  switch (K) {
2973    case CXCursor_UnexposedDecl:
2974    case CXCursor_UnexposedExpr:
2975    case CXCursor_UnexposedStmt:
2976    case CXCursor_UnexposedAttr:
2977      return true;
2978    default:
2979      return false;
2980  }
2981}
2982
2983CXCursorKind clang_getCursorKind(CXCursor C) {
2984  return C.kind;
2985}
2986
2987CXSourceLocation clang_getCursorLocation(CXCursor C) {
2988  if (clang_isReference(C.kind)) {
2989    switch (C.kind) {
2990    case CXCursor_ObjCSuperClassRef: {
2991      std::pair<ObjCInterfaceDecl *, SourceLocation> P
2992        = getCursorObjCSuperClassRef(C);
2993      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2994    }
2995
2996    case CXCursor_ObjCProtocolRef: {
2997      std::pair<ObjCProtocolDecl *, SourceLocation> P
2998        = getCursorObjCProtocolRef(C);
2999      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3000    }
3001
3002    case CXCursor_ObjCClassRef: {
3003      std::pair<ObjCInterfaceDecl *, SourceLocation> P
3004        = getCursorObjCClassRef(C);
3005      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3006    }
3007
3008    case CXCursor_TypeRef: {
3009      std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
3010      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3011    }
3012
3013    case CXCursor_TemplateRef: {
3014      std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
3015      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3016    }
3017
3018    case CXCursor_NamespaceRef: {
3019      std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
3020      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3021    }
3022
3023    case CXCursor_MemberRef: {
3024      std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
3025      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3026    }
3027
3028    case CXCursor_CXXBaseSpecifier: {
3029      CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
3030      if (!BaseSpec)
3031        return clang_getNullLocation();
3032
3033      if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
3034        return cxloc::translateSourceLocation(getCursorContext(C),
3035                                            TSInfo->getTypeLoc().getBeginLoc());
3036
3037      return cxloc::translateSourceLocation(getCursorContext(C),
3038                                        BaseSpec->getSourceRange().getBegin());
3039    }
3040
3041    case CXCursor_LabelRef: {
3042      std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
3043      return cxloc::translateSourceLocation(getCursorContext(C), P.second);
3044    }
3045
3046    case CXCursor_OverloadedDeclRef:
3047      return cxloc::translateSourceLocation(getCursorContext(C),
3048                                          getCursorOverloadedDeclRef(C).second);
3049
3050    default:
3051      // FIXME: Need a way to enumerate all non-reference cases.
3052      llvm_unreachable("Missed a reference kind");
3053    }
3054  }
3055
3056  if (clang_isExpression(C.kind))
3057    return cxloc::translateSourceLocation(getCursorContext(C),
3058                                   getLocationFromExpr(getCursorExpr(C)));
3059
3060  if (clang_isStatement(C.kind))
3061    return cxloc::translateSourceLocation(getCursorContext(C),
3062                                          getCursorStmt(C)->getLocStart());
3063
3064  if (C.kind == CXCursor_PreprocessingDirective) {
3065    SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
3066    return cxloc::translateSourceLocation(getCursorContext(C), L);
3067  }
3068
3069  if (C.kind == CXCursor_MacroInstantiation) {
3070    SourceLocation L
3071      = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
3072    return cxloc::translateSourceLocation(getCursorContext(C), L);
3073  }
3074
3075  if (C.kind == CXCursor_MacroDefinition) {
3076    SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
3077    return cxloc::translateSourceLocation(getCursorContext(C), L);
3078  }
3079
3080  if (C.kind == CXCursor_InclusionDirective) {
3081    SourceLocation L
3082      = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
3083    return cxloc::translateSourceLocation(getCursorContext(C), L);
3084  }
3085
3086  if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
3087    return clang_getNullLocation();
3088
3089  Decl *D = getCursorDecl(C);
3090  SourceLocation Loc = D->getLocation();
3091  if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
3092    Loc = Class->getClassLoc();
3093  // FIXME: Multiple variables declared in a single declaration
3094  // currently lack the information needed to correctly determine their
3095  // ranges when accounting for the type-specifier.  We use context
3096  // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3097  // and if so, whether it is the first decl.
3098  if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3099    if (!cxcursor::isFirstInDeclGroup(C))
3100      Loc = VD->getLocation();
3101  }
3102
3103  return cxloc::translateSourceLocation(getCursorContext(C), Loc);
3104}
3105
3106} // end extern "C"
3107
3108static SourceRange getRawCursorExtent(CXCursor C) {
3109  if (clang_isReference(C.kind)) {
3110    switch (C.kind) {
3111    case CXCursor_ObjCSuperClassRef:
3112      return  getCursorObjCSuperClassRef(C).second;
3113
3114    case CXCursor_ObjCProtocolRef:
3115      return getCursorObjCProtocolRef(C).second;
3116
3117    case CXCursor_ObjCClassRef:
3118      return getCursorObjCClassRef(C).second;
3119
3120    case CXCursor_TypeRef:
3121      return getCursorTypeRef(C).second;
3122
3123    case CXCursor_TemplateRef:
3124      return getCursorTemplateRef(C).second;
3125
3126    case CXCursor_NamespaceRef:
3127      return getCursorNamespaceRef(C).second;
3128
3129    case CXCursor_MemberRef:
3130      return getCursorMemberRef(C).second;
3131
3132    case CXCursor_CXXBaseSpecifier:
3133      return getCursorCXXBaseSpecifier(C)->getSourceRange();
3134
3135    case CXCursor_LabelRef:
3136      return getCursorLabelRef(C).second;
3137
3138    case CXCursor_OverloadedDeclRef:
3139      return getCursorOverloadedDeclRef(C).second;
3140
3141    default:
3142      // FIXME: Need a way to enumerate all non-reference cases.
3143      llvm_unreachable("Missed a reference kind");
3144    }
3145  }
3146
3147  if (clang_isExpression(C.kind))
3148    return getCursorExpr(C)->getSourceRange();
3149
3150  if (clang_isStatement(C.kind))
3151    return getCursorStmt(C)->getSourceRange();
3152
3153  if (C.kind == CXCursor_PreprocessingDirective)
3154    return cxcursor::getCursorPreprocessingDirective(C);
3155
3156  if (C.kind == CXCursor_MacroInstantiation)
3157    return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
3158
3159  if (C.kind == CXCursor_MacroDefinition)
3160    return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
3161
3162  if (C.kind == CXCursor_InclusionDirective)
3163    return cxcursor::getCursorInclusionDirective(C)->getSourceRange();
3164
3165  if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
3166    Decl *D = cxcursor::getCursorDecl(C);
3167    SourceRange R = D->getSourceRange();
3168    // FIXME: Multiple variables declared in a single declaration
3169    // currently lack the information needed to correctly determine their
3170    // ranges when accounting for the type-specifier.  We use context
3171    // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3172    // and if so, whether it is the first decl.
3173    if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3174      if (!cxcursor::isFirstInDeclGroup(C))
3175        R.setBegin(VD->getLocation());
3176    }
3177    return R;
3178  }
3179  return SourceRange();}
3180
3181extern "C" {
3182
3183CXSourceRange clang_getCursorExtent(CXCursor C) {
3184  SourceRange R = getRawCursorExtent(C);
3185  if (R.isInvalid())
3186    return clang_getNullRange();
3187
3188  return cxloc::translateSourceRange(getCursorContext(C), R);
3189}
3190
3191CXCursor clang_getCursorReferenced(CXCursor C) {
3192  if (clang_isInvalid(C.kind))
3193    return clang_getNullCursor();
3194
3195  ASTUnit *CXXUnit = getCursorASTUnit(C);
3196  if (clang_isDeclaration(C.kind)) {
3197    Decl *D = getCursorDecl(C);
3198    if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
3199      return MakeCursorOverloadedDeclRef(Using, D->getLocation(), CXXUnit);
3200    if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3201      return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), CXXUnit);
3202    if (ObjCForwardProtocolDecl *Protocols
3203                                        = dyn_cast<ObjCForwardProtocolDecl>(D))
3204      return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), CXXUnit);
3205
3206    return C;
3207  }
3208
3209  if (clang_isExpression(C.kind)) {
3210    Expr *E = getCursorExpr(C);
3211    Decl *D = getDeclFromExpr(E);
3212    if (D)
3213      return MakeCXCursor(D, CXXUnit);
3214
3215    if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
3216      return MakeCursorOverloadedDeclRef(Ovl, CXXUnit);
3217
3218    return clang_getNullCursor();
3219  }
3220
3221  if (clang_isStatement(C.kind)) {
3222    Stmt *S = getCursorStmt(C);
3223    if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
3224      return MakeCXCursor(Goto->getLabel(), getCursorDecl(C),
3225                          getCursorASTUnit(C));
3226
3227    return clang_getNullCursor();
3228  }
3229
3230  if (C.kind == CXCursor_MacroInstantiation) {
3231    if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
3232      return MakeMacroDefinitionCursor(Def, CXXUnit);
3233  }
3234
3235  if (!clang_isReference(C.kind))
3236    return clang_getNullCursor();
3237
3238  switch (C.kind) {
3239    case CXCursor_ObjCSuperClassRef:
3240      return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
3241
3242    case CXCursor_ObjCProtocolRef: {
3243      return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
3244
3245    case CXCursor_ObjCClassRef:
3246      return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
3247
3248    case CXCursor_TypeRef:
3249      return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
3250
3251    case CXCursor_TemplateRef:
3252      return MakeCXCursor(getCursorTemplateRef(C).first, CXXUnit);
3253
3254    case CXCursor_NamespaceRef:
3255      return MakeCXCursor(getCursorNamespaceRef(C).first, CXXUnit);
3256
3257    case CXCursor_MemberRef:
3258      return MakeCXCursor(getCursorMemberRef(C).first, CXXUnit);
3259
3260    case CXCursor_CXXBaseSpecifier: {
3261      CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
3262      return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
3263                                                         CXXUnit));
3264    }
3265
3266    case CXCursor_LabelRef:
3267      // FIXME: We end up faking the "parent" declaration here because we
3268      // don't want to make CXCursor larger.
3269      return MakeCXCursor(getCursorLabelRef(C).first,
3270                          CXXUnit->getASTContext().getTranslationUnitDecl(),
3271                          CXXUnit);
3272
3273    case CXCursor_OverloadedDeclRef:
3274      return C;
3275
3276    default:
3277      // We would prefer to enumerate all non-reference cursor kinds here.
3278      llvm_unreachable("Unhandled reference cursor kind");
3279      break;
3280    }
3281  }
3282
3283  return clang_getNullCursor();
3284}
3285
3286CXCursor clang_getCursorDefinition(CXCursor C) {
3287  if (clang_isInvalid(C.kind))
3288    return clang_getNullCursor();
3289
3290  ASTUnit *CXXUnit = getCursorASTUnit(C);
3291
3292  bool WasReference = false;
3293  if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
3294    C = clang_getCursorReferenced(C);
3295    WasReference = true;
3296  }
3297
3298  if (C.kind == CXCursor_MacroInstantiation)
3299    return clang_getCursorReferenced(C);
3300
3301  if (!clang_isDeclaration(C.kind))
3302    return clang_getNullCursor();
3303
3304  Decl *D = getCursorDecl(C);
3305  if (!D)
3306    return clang_getNullCursor();
3307
3308  switch (D->getKind()) {
3309  // Declaration kinds that don't really separate the notions of
3310  // declaration and definition.
3311  case Decl::Namespace:
3312  case Decl::Typedef:
3313  case Decl::TemplateTypeParm:
3314  case Decl::EnumConstant:
3315  case Decl::Field:
3316  case Decl::ObjCIvar:
3317  case Decl::ObjCAtDefsField:
3318  case Decl::ImplicitParam:
3319  case Decl::ParmVar:
3320  case Decl::NonTypeTemplateParm:
3321  case Decl::TemplateTemplateParm:
3322  case Decl::ObjCCategoryImpl:
3323  case Decl::ObjCImplementation:
3324  case Decl::AccessSpec:
3325  case Decl::LinkageSpec:
3326  case Decl::ObjCPropertyImpl:
3327  case Decl::FileScopeAsm:
3328  case Decl::StaticAssert:
3329  case Decl::Block:
3330    return C;
3331
3332  // Declaration kinds that don't make any sense here, but are
3333  // nonetheless harmless.
3334  case Decl::TranslationUnit:
3335    break;
3336
3337  // Declaration kinds for which the definition is not resolvable.
3338  case Decl::UnresolvedUsingTypename:
3339  case Decl::UnresolvedUsingValue:
3340    break;
3341
3342  case Decl::UsingDirective:
3343    return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
3344                        CXXUnit);
3345
3346  case Decl::NamespaceAlias:
3347    return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
3348
3349  case Decl::Enum:
3350  case Decl::Record:
3351  case Decl::CXXRecord:
3352  case Decl::ClassTemplateSpecialization:
3353  case Decl::ClassTemplatePartialSpecialization:
3354    if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
3355      return MakeCXCursor(Def, CXXUnit);
3356    return clang_getNullCursor();
3357
3358  case Decl::Function:
3359  case Decl::CXXMethod:
3360  case Decl::CXXConstructor:
3361  case Decl::CXXDestructor:
3362  case Decl::CXXConversion: {
3363    const FunctionDecl *Def = 0;
3364    if (cast<FunctionDecl>(D)->getBody(Def))
3365      return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
3366    return clang_getNullCursor();
3367  }
3368
3369  case Decl::Var: {
3370    // Ask the variable if it has a definition.
3371    if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
3372      return MakeCXCursor(Def, CXXUnit);
3373    return clang_getNullCursor();
3374  }
3375
3376  case Decl::FunctionTemplate: {
3377    const FunctionDecl *Def = 0;
3378    if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
3379      return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
3380    return clang_getNullCursor();
3381  }
3382
3383  case Decl::ClassTemplate: {
3384    if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
3385                                                            ->getDefinition())
3386      return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
3387                          CXXUnit);
3388    return clang_getNullCursor();
3389  }
3390
3391  case Decl::Using:
3392    return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
3393                                       D->getLocation(), CXXUnit);
3394
3395  case Decl::UsingShadow:
3396    return clang_getCursorDefinition(
3397                       MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
3398                                    CXXUnit));
3399
3400  case Decl::ObjCMethod: {
3401    ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
3402    if (Method->isThisDeclarationADefinition())
3403      return C;
3404
3405    // Dig out the method definition in the associated
3406    // @implementation, if we have it.
3407    // FIXME: The ASTs should make finding the definition easier.
3408    if (ObjCInterfaceDecl *Class
3409                       = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
3410      if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
3411        if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
3412                                                  Method->isInstanceMethod()))
3413          if (Def->isThisDeclarationADefinition())
3414            return MakeCXCursor(Def, CXXUnit);
3415
3416    return clang_getNullCursor();
3417  }
3418
3419  case Decl::ObjCCategory:
3420    if (ObjCCategoryImplDecl *Impl
3421                               = cast<ObjCCategoryDecl>(D)->getImplementation())
3422      return MakeCXCursor(Impl, CXXUnit);
3423    return clang_getNullCursor();
3424
3425  case Decl::ObjCProtocol:
3426    if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
3427      return C;
3428    return clang_getNullCursor();
3429
3430  case Decl::ObjCInterface:
3431    // There are two notions of a "definition" for an Objective-C
3432    // class: the interface and its implementation. When we resolved a
3433    // reference to an Objective-C class, produce the @interface as
3434    // the definition; when we were provided with the interface,
3435    // produce the @implementation as the definition.
3436    if (WasReference) {
3437      if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
3438        return C;
3439    } else if (ObjCImplementationDecl *Impl
3440                              = cast<ObjCInterfaceDecl>(D)->getImplementation())
3441      return MakeCXCursor(Impl, CXXUnit);
3442    return clang_getNullCursor();
3443
3444  case Decl::ObjCProperty:
3445    // FIXME: We don't really know where to find the
3446    // ObjCPropertyImplDecls that implement this property.
3447    return clang_getNullCursor();
3448
3449  case Decl::ObjCCompatibleAlias:
3450    if (ObjCInterfaceDecl *Class
3451          = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
3452      if (!Class->isForwardDecl())
3453        return MakeCXCursor(Class, CXXUnit);
3454
3455    return clang_getNullCursor();
3456
3457  case Decl::ObjCForwardProtocol:
3458    return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D),
3459                                       D->getLocation(), CXXUnit);
3460
3461  case Decl::ObjCClass:
3462    return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(),
3463                                       CXXUnit);
3464
3465  case Decl::Friend:
3466    if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
3467      return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
3468    return clang_getNullCursor();
3469
3470  case Decl::FriendTemplate:
3471    if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
3472      return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
3473    return clang_getNullCursor();
3474  }
3475
3476  return clang_getNullCursor();
3477}
3478
3479unsigned clang_isCursorDefinition(CXCursor C) {
3480  if (!clang_isDeclaration(C.kind))
3481    return 0;
3482
3483  return clang_getCursorDefinition(C) == C;
3484}
3485
3486unsigned clang_getNumOverloadedDecls(CXCursor C) {
3487  if (C.kind != CXCursor_OverloadedDeclRef)
3488    return 0;
3489
3490  OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
3491  if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3492    return E->getNumDecls();
3493
3494  if (OverloadedTemplateStorage *S
3495                              = Storage.dyn_cast<OverloadedTemplateStorage*>())
3496    return S->size();
3497
3498  Decl *D = Storage.get<Decl*>();
3499  if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
3500    return Using->getNumShadowDecls();
3501  if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3502    return Classes->size();
3503  if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D))
3504    return Protocols->protocol_size();
3505
3506  return 0;
3507}
3508
3509CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
3510  if (cursor.kind != CXCursor_OverloadedDeclRef)
3511    return clang_getNullCursor();
3512
3513  if (index >= clang_getNumOverloadedDecls(cursor))
3514    return clang_getNullCursor();
3515
3516  ASTUnit *Unit = getCursorASTUnit(cursor);
3517  OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
3518  if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3519    return MakeCXCursor(E->decls_begin()[index], Unit);
3520
3521  if (OverloadedTemplateStorage *S
3522                              = Storage.dyn_cast<OverloadedTemplateStorage*>())
3523    return MakeCXCursor(S->begin()[index], Unit);
3524
3525  Decl *D = Storage.get<Decl*>();
3526  if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
3527    // FIXME: This is, unfortunately, linear time.
3528    UsingDecl::shadow_iterator Pos = Using->shadow_begin();
3529    std::advance(Pos, index);
3530    return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), Unit);
3531  }
3532
3533  if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
3534    return MakeCXCursor(Classes->begin()[index].getInterface(), Unit);
3535
3536  if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D))
3537    return MakeCXCursor(Protocols->protocol_begin()[index], Unit);
3538
3539  return clang_getNullCursor();
3540}
3541
3542void clang_getDefinitionSpellingAndExtent(CXCursor C,
3543                                          const char **startBuf,
3544                                          const char **endBuf,
3545                                          unsigned *startLine,
3546                                          unsigned *startColumn,
3547                                          unsigned *endLine,
3548                                          unsigned *endColumn) {
3549  assert(getCursorDecl(C) && "CXCursor has null decl");
3550  NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
3551  FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
3552  CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
3553
3554  SourceManager &SM = FD->getASTContext().getSourceManager();
3555  *startBuf = SM.getCharacterData(Body->getLBracLoc());
3556  *endBuf = SM.getCharacterData(Body->getRBracLoc());
3557  *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
3558  *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
3559  *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
3560  *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
3561}
3562
3563void clang_enableStackTraces(void) {
3564  llvm::sys::PrintStackTraceOnErrorSignal();
3565}
3566
3567void clang_executeOnThread(void (*fn)(void*), void *user_data,
3568                           unsigned stack_size) {
3569  llvm::llvm_execute_on_thread(fn, user_data, stack_size);
3570}
3571
3572} // end: extern "C"
3573
3574//===----------------------------------------------------------------------===//
3575// Token-based Operations.
3576//===----------------------------------------------------------------------===//
3577
3578/* CXToken layout:
3579 *   int_data[0]: a CXTokenKind
3580 *   int_data[1]: starting token location
3581 *   int_data[2]: token length
3582 *   int_data[3]: reserved
3583 *   ptr_data: for identifiers and keywords, an IdentifierInfo*.
3584 *   otherwise unused.
3585 */
3586extern "C" {
3587
3588CXTokenKind clang_getTokenKind(CXToken CXTok) {
3589  return static_cast<CXTokenKind>(CXTok.int_data[0]);
3590}
3591
3592CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
3593  switch (clang_getTokenKind(CXTok)) {
3594  case CXToken_Identifier:
3595  case CXToken_Keyword:
3596    // We know we have an IdentifierInfo*, so use that.
3597    return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
3598                            ->getNameStart());
3599
3600  case CXToken_Literal: {
3601    // We have stashed the starting pointer in the ptr_data field. Use it.
3602    const char *Text = static_cast<const char *>(CXTok.ptr_data);
3603    return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
3604  }
3605
3606  case CXToken_Punctuation:
3607  case CXToken_Comment:
3608    break;
3609  }
3610
3611  // We have to find the starting buffer pointer the hard way, by
3612  // deconstructing the source location.
3613  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3614  if (!CXXUnit)
3615    return createCXString("");
3616
3617  SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
3618  std::pair<FileID, unsigned> LocInfo
3619    = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
3620  bool Invalid = false;
3621  llvm::StringRef Buffer
3622    = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3623  if (Invalid)
3624    return createCXString("");
3625
3626  return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
3627}
3628
3629CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
3630  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3631  if (!CXXUnit)
3632    return clang_getNullLocation();
3633
3634  return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
3635                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3636}
3637
3638CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
3639  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3640  if (!CXXUnit)
3641    return clang_getNullRange();
3642
3643  return cxloc::translateSourceRange(CXXUnit->getASTContext(),
3644                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3645}
3646
3647void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
3648                    CXToken **Tokens, unsigned *NumTokens) {
3649  if (Tokens)
3650    *Tokens = 0;
3651  if (NumTokens)
3652    *NumTokens = 0;
3653
3654  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3655  if (!CXXUnit || !Tokens || !NumTokens)
3656    return;
3657
3658  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3659
3660  SourceRange R = cxloc::translateCXSourceRange(Range);
3661  if (R.isInvalid())
3662    return;
3663
3664  SourceManager &SourceMgr = CXXUnit->getSourceManager();
3665  std::pair<FileID, unsigned> BeginLocInfo
3666    = SourceMgr.getDecomposedLoc(R.getBegin());
3667  std::pair<FileID, unsigned> EndLocInfo
3668    = SourceMgr.getDecomposedLoc(R.getEnd());
3669
3670  // Cannot tokenize across files.
3671  if (BeginLocInfo.first != EndLocInfo.first)
3672    return;
3673
3674  // Create a lexer
3675  bool Invalid = false;
3676  llvm::StringRef Buffer
3677    = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
3678  if (Invalid)
3679    return;
3680
3681  Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3682            CXXUnit->getASTContext().getLangOptions(),
3683            Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
3684  Lex.SetCommentRetentionState(true);
3685
3686  // Lex tokens until we hit the end of the range.
3687  const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
3688  llvm::SmallVector<CXToken, 32> CXTokens;
3689  Token Tok;
3690  bool previousWasAt = false;
3691  do {
3692    // Lex the next token
3693    Lex.LexFromRawLexer(Tok);
3694    if (Tok.is(tok::eof))
3695      break;
3696
3697    // Initialize the CXToken.
3698    CXToken CXTok;
3699
3700    //   - Common fields
3701    CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
3702    CXTok.int_data[2] = Tok.getLength();
3703    CXTok.int_data[3] = 0;
3704
3705    //   - Kind-specific fields
3706    if (Tok.isLiteral()) {
3707      CXTok.int_data[0] = CXToken_Literal;
3708      CXTok.ptr_data = (void *)Tok.getLiteralData();
3709    } else if (Tok.is(tok::identifier)) {
3710      // Lookup the identifier to determine whether we have a keyword.
3711      std::pair<FileID, unsigned> LocInfo
3712        = SourceMgr.getDecomposedLoc(Tok.getLocation());
3713      bool Invalid = false;
3714      llvm::StringRef Buf
3715        = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3716      if (Invalid)
3717        return;
3718
3719      const char *StartPos = Buf.data() + LocInfo.second;
3720      IdentifierInfo *II
3721        = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos);
3722
3723      if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
3724        CXTok.int_data[0] = CXToken_Keyword;
3725      }
3726      else {
3727        CXTok.int_data[0] = II->getTokenID() == tok::identifier?
3728                                CXToken_Identifier
3729                              : CXToken_Keyword;
3730      }
3731      CXTok.ptr_data = II;
3732    } else if (Tok.is(tok::comment)) {
3733      CXTok.int_data[0] = CXToken_Comment;
3734      CXTok.ptr_data = 0;
3735    } else {
3736      CXTok.int_data[0] = CXToken_Punctuation;
3737      CXTok.ptr_data = 0;
3738    }
3739    CXTokens.push_back(CXTok);
3740    previousWasAt = Tok.is(tok::at);
3741  } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
3742
3743  if (CXTokens.empty())
3744    return;
3745
3746  *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
3747  memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
3748  *NumTokens = CXTokens.size();
3749}
3750
3751void clang_disposeTokens(CXTranslationUnit TU,
3752                         CXToken *Tokens, unsigned NumTokens) {
3753  free(Tokens);
3754}
3755
3756} // end: extern "C"
3757
3758//===----------------------------------------------------------------------===//
3759// Token annotation APIs.
3760//===----------------------------------------------------------------------===//
3761
3762typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
3763static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
3764                                                     CXCursor parent,
3765                                                     CXClientData client_data);
3766namespace {
3767class AnnotateTokensWorker {
3768  AnnotateTokensData &Annotated;
3769  CXToken *Tokens;
3770  CXCursor *Cursors;
3771  unsigned NumTokens;
3772  unsigned TokIdx;
3773  unsigned PreprocessingTokIdx;
3774  CursorVisitor AnnotateVis;
3775  SourceManager &SrcMgr;
3776
3777  bool MoreTokens() const { return TokIdx < NumTokens; }
3778  unsigned NextToken() const { return TokIdx; }
3779  void AdvanceToken() { ++TokIdx; }
3780  SourceLocation GetTokenLoc(unsigned tokI) {
3781    return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
3782  }
3783
3784public:
3785  AnnotateTokensWorker(AnnotateTokensData &annotated,
3786                       CXToken *tokens, CXCursor *cursors, unsigned numTokens,
3787                       ASTUnit *CXXUnit, SourceRange RegionOfInterest)
3788    : Annotated(annotated), Tokens(tokens), Cursors(cursors),
3789      NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
3790      AnnotateVis(CXXUnit, AnnotateTokensVisitor, this,
3791                  Decl::MaxPCHLevel, RegionOfInterest),
3792      SrcMgr(CXXUnit->getSourceManager()) {}
3793
3794  void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
3795  enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
3796  void AnnotateTokens(CXCursor parent);
3797};
3798}
3799
3800void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
3801  // Walk the AST within the region of interest, annotating tokens
3802  // along the way.
3803  VisitChildren(parent);
3804
3805  for (unsigned I = 0 ; I < TokIdx ; ++I) {
3806    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
3807    if (Pos != Annotated.end() &&
3808        (clang_isInvalid(Cursors[I].kind) ||
3809         Pos->second.kind != CXCursor_PreprocessingDirective))
3810      Cursors[I] = Pos->second;
3811  }
3812
3813  // Finish up annotating any tokens left.
3814  if (!MoreTokens())
3815    return;
3816
3817  const CXCursor &C = clang_getNullCursor();
3818  for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
3819    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
3820    Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
3821  }
3822}
3823
3824enum CXChildVisitResult
3825AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
3826  CXSourceLocation Loc = clang_getCursorLocation(cursor);
3827  SourceRange cursorRange = getRawCursorExtent(cursor);
3828  if (cursorRange.isInvalid())
3829    return CXChildVisit_Recurse;
3830
3831  if (clang_isPreprocessing(cursor.kind)) {
3832    // For macro instantiations, just note where the beginning of the macro
3833    // instantiation occurs.
3834    if (cursor.kind == CXCursor_MacroInstantiation) {
3835      Annotated[Loc.int_data] = cursor;
3836      return CXChildVisit_Recurse;
3837    }
3838
3839    // Items in the preprocessing record are kept separate from items in
3840    // declarations, so we keep a separate token index.
3841    unsigned SavedTokIdx = TokIdx;
3842    TokIdx = PreprocessingTokIdx;
3843
3844    // Skip tokens up until we catch up to the beginning of the preprocessing
3845    // entry.
3846    while (MoreTokens()) {
3847      const unsigned I = NextToken();
3848      SourceLocation TokLoc = GetTokenLoc(I);
3849      switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3850      case RangeBefore:
3851        AdvanceToken();
3852        continue;
3853      case RangeAfter:
3854      case RangeOverlap:
3855        break;
3856      }
3857      break;
3858    }
3859
3860    // Look at all of the tokens within this range.
3861    while (MoreTokens()) {
3862      const unsigned I = NextToken();
3863      SourceLocation TokLoc = GetTokenLoc(I);
3864      switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3865      case RangeBefore:
3866        assert(0 && "Infeasible");
3867      case RangeAfter:
3868        break;
3869      case RangeOverlap:
3870        Cursors[I] = cursor;
3871        AdvanceToken();
3872        continue;
3873      }
3874      break;
3875    }
3876
3877    // Save the preprocessing token index; restore the non-preprocessing
3878    // token index.
3879    PreprocessingTokIdx = TokIdx;
3880    TokIdx = SavedTokIdx;
3881    return CXChildVisit_Recurse;
3882  }
3883
3884  if (cursorRange.isInvalid())
3885    return CXChildVisit_Continue;
3886
3887  SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
3888
3889  // Adjust the annotated range based specific declarations.
3890  const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
3891  if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
3892    Decl *D = cxcursor::getCursorDecl(cursor);
3893    // Don't visit synthesized ObjC methods, since they have no syntatic
3894    // representation in the source.
3895    if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
3896      if (MD->isSynthesized())
3897        return CXChildVisit_Continue;
3898    }
3899    if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
3900      if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
3901        TypeLoc TL = TI->getTypeLoc();
3902        SourceLocation TLoc = TL.getSourceRange().getBegin();
3903        if (TLoc.isValid() && L.isValid() &&
3904            SrcMgr.isBeforeInTranslationUnit(TLoc, L))
3905          cursorRange.setBegin(TLoc);
3906      }
3907    }
3908  }
3909
3910  // If the location of the cursor occurs within a macro instantiation, record
3911  // the spelling location of the cursor in our annotation map.  We can then
3912  // paper over the token labelings during a post-processing step to try and
3913  // get cursor mappings for tokens that are the *arguments* of a macro
3914  // instantiation.
3915  if (L.isMacroID()) {
3916    unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
3917    // Only invalidate the old annotation if it isn't part of a preprocessing
3918    // directive.  Here we assume that the default construction of CXCursor
3919    // results in CXCursor.kind being an initialized value (i.e., 0).  If
3920    // this isn't the case, we can fix by doing lookup + insertion.
3921
3922    CXCursor &oldC = Annotated[rawEncoding];
3923    if (!clang_isPreprocessing(oldC.kind))
3924      oldC = cursor;
3925  }
3926
3927  const enum CXCursorKind K = clang_getCursorKind(parent);
3928  const CXCursor updateC =
3929    (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
3930     ? clang_getNullCursor() : parent;
3931
3932  while (MoreTokens()) {
3933    const unsigned I = NextToken();
3934    SourceLocation TokLoc = GetTokenLoc(I);
3935    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3936      case RangeBefore:
3937        Cursors[I] = updateC;
3938        AdvanceToken();
3939        continue;
3940      case RangeAfter:
3941      case RangeOverlap:
3942        break;
3943    }
3944    break;
3945  }
3946
3947  // Visit children to get their cursor information.
3948  const unsigned BeforeChildren = NextToken();
3949  VisitChildren(cursor);
3950  const unsigned AfterChildren = NextToken();
3951
3952  // Adjust 'Last' to the last token within the extent of the cursor.
3953  while (MoreTokens()) {
3954    const unsigned I = NextToken();
3955    SourceLocation TokLoc = GetTokenLoc(I);
3956    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3957      case RangeBefore:
3958        assert(0 && "Infeasible");
3959      case RangeAfter:
3960        break;
3961      case RangeOverlap:
3962        Cursors[I] = updateC;
3963        AdvanceToken();
3964        continue;
3965    }
3966    break;
3967  }
3968  const unsigned Last = NextToken();
3969
3970  // Scan the tokens that are at the beginning of the cursor, but are not
3971  // capture by the child cursors.
3972
3973  // For AST elements within macros, rely on a post-annotate pass to
3974  // to correctly annotate the tokens with cursors.  Otherwise we can
3975  // get confusing results of having tokens that map to cursors that really
3976  // are expanded by an instantiation.
3977  if (L.isMacroID())
3978    cursor = clang_getNullCursor();
3979
3980  for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
3981    if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
3982      break;
3983
3984    Cursors[I] = cursor;
3985  }
3986  // Scan the tokens that are at the end of the cursor, but are not captured
3987  // but the child cursors.
3988  for (unsigned I = AfterChildren; I != Last; ++I)
3989    Cursors[I] = cursor;
3990
3991  TokIdx = Last;
3992  return CXChildVisit_Continue;
3993}
3994
3995static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
3996                                                     CXCursor parent,
3997                                                     CXClientData client_data) {
3998  return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
3999}
4000
4001extern "C" {
4002
4003void clang_annotateTokens(CXTranslationUnit TU,
4004                          CXToken *Tokens, unsigned NumTokens,
4005                          CXCursor *Cursors) {
4006
4007  if (NumTokens == 0 || !Tokens || !Cursors)
4008    return;
4009
4010  // Any token we don't specifically annotate will have a NULL cursor.
4011  CXCursor C = clang_getNullCursor();
4012  for (unsigned I = 0; I != NumTokens; ++I)
4013    Cursors[I] = C;
4014
4015  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
4016  if (!CXXUnit)
4017    return;
4018
4019  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
4020
4021  // Determine the region of interest, which contains all of the tokens.
4022  SourceRange RegionOfInterest;
4023  RegionOfInterest.setBegin(cxloc::translateSourceLocation(
4024                                        clang_getTokenLocation(TU, Tokens[0])));
4025  RegionOfInterest.setEnd(cxloc::translateSourceLocation(
4026                                clang_getTokenLocation(TU,
4027                                                       Tokens[NumTokens - 1])));
4028
4029  // A mapping from the source locations found when re-lexing or traversing the
4030  // region of interest to the corresponding cursors.
4031  AnnotateTokensData Annotated;
4032
4033  // Relex the tokens within the source range to look for preprocessing
4034  // directives.
4035  SourceManager &SourceMgr = CXXUnit->getSourceManager();
4036  std::pair<FileID, unsigned> BeginLocInfo
4037    = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
4038  std::pair<FileID, unsigned> EndLocInfo
4039    = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
4040
4041  llvm::StringRef Buffer;
4042  bool Invalid = false;
4043  if (BeginLocInfo.first == EndLocInfo.first &&
4044      ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
4045      !Invalid) {
4046    Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
4047              CXXUnit->getASTContext().getLangOptions(),
4048              Buffer.begin(), Buffer.data() + BeginLocInfo.second,
4049              Buffer.end());
4050    Lex.SetCommentRetentionState(true);
4051
4052    // Lex tokens in raw mode until we hit the end of the range, to avoid
4053    // entering #includes or expanding macros.
4054    while (true) {
4055      Token Tok;
4056      Lex.LexFromRawLexer(Tok);
4057
4058    reprocess:
4059      if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
4060        // We have found a preprocessing directive. Gobble it up so that we
4061        // don't see it while preprocessing these tokens later, but keep track
4062        // of all of the token locations inside this preprocessing directive so
4063        // that we can annotate them appropriately.
4064        //
4065        // FIXME: Some simple tests here could identify macro definitions and
4066        // #undefs, to provide specific cursor kinds for those.
4067        std::vector<SourceLocation> Locations;
4068        do {
4069          Locations.push_back(Tok.getLocation());
4070          Lex.LexFromRawLexer(Tok);
4071        } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
4072
4073        using namespace cxcursor;
4074        CXCursor Cursor
4075          = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
4076                                                         Locations.back()),
4077                                           CXXUnit);
4078        for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
4079          Annotated[Locations[I].getRawEncoding()] = Cursor;
4080        }
4081
4082        if (Tok.isAtStartOfLine())
4083          goto reprocess;
4084
4085        continue;
4086      }
4087
4088      if (Tok.is(tok::eof))
4089        break;
4090    }
4091  }
4092
4093  // Annotate all of the source locations in the region of interest that map to
4094  // a specific cursor.
4095  AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
4096                         CXXUnit, RegionOfInterest);
4097  W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit));
4098}
4099} // end: extern "C"
4100
4101//===----------------------------------------------------------------------===//
4102// Operations for querying linkage of a cursor.
4103//===----------------------------------------------------------------------===//
4104
4105extern "C" {
4106CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
4107  if (!clang_isDeclaration(cursor.kind))
4108    return CXLinkage_Invalid;
4109
4110  Decl *D = cxcursor::getCursorDecl(cursor);
4111  if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
4112    switch (ND->getLinkage()) {
4113      case NoLinkage: return CXLinkage_NoLinkage;
4114      case InternalLinkage: return CXLinkage_Internal;
4115      case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
4116      case ExternalLinkage: return CXLinkage_External;
4117    };
4118
4119  return CXLinkage_Invalid;
4120}
4121} // end: extern "C"
4122
4123//===----------------------------------------------------------------------===//
4124// Operations for querying language of a cursor.
4125//===----------------------------------------------------------------------===//
4126
4127static CXLanguageKind getDeclLanguage(const Decl *D) {
4128  switch (D->getKind()) {
4129    default:
4130      break;
4131    case Decl::ImplicitParam:
4132    case Decl::ObjCAtDefsField:
4133    case Decl::ObjCCategory:
4134    case Decl::ObjCCategoryImpl:
4135    case Decl::ObjCClass:
4136    case Decl::ObjCCompatibleAlias:
4137    case Decl::ObjCForwardProtocol:
4138    case Decl::ObjCImplementation:
4139    case Decl::ObjCInterface:
4140    case Decl::ObjCIvar:
4141    case Decl::ObjCMethod:
4142    case Decl::ObjCProperty:
4143    case Decl::ObjCPropertyImpl:
4144    case Decl::ObjCProtocol:
4145      return CXLanguage_ObjC;
4146    case Decl::CXXConstructor:
4147    case Decl::CXXConversion:
4148    case Decl::CXXDestructor:
4149    case Decl::CXXMethod:
4150    case Decl::CXXRecord:
4151    case Decl::ClassTemplate:
4152    case Decl::ClassTemplatePartialSpecialization:
4153    case Decl::ClassTemplateSpecialization:
4154    case Decl::Friend:
4155    case Decl::FriendTemplate:
4156    case Decl::FunctionTemplate:
4157    case Decl::LinkageSpec:
4158    case Decl::Namespace:
4159    case Decl::NamespaceAlias:
4160    case Decl::NonTypeTemplateParm:
4161    case Decl::StaticAssert:
4162    case Decl::TemplateTemplateParm:
4163    case Decl::TemplateTypeParm:
4164    case Decl::UnresolvedUsingTypename:
4165    case Decl::UnresolvedUsingValue:
4166    case Decl::Using:
4167    case Decl::UsingDirective:
4168    case Decl::UsingShadow:
4169      return CXLanguage_CPlusPlus;
4170  }
4171
4172  return CXLanguage_C;
4173}
4174
4175extern "C" {
4176
4177enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
4178  if (clang_isDeclaration(cursor.kind))
4179    if (Decl *D = cxcursor::getCursorDecl(cursor)) {
4180      if (D->hasAttr<UnavailableAttr>() ||
4181          (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted()))
4182        return CXAvailability_Available;
4183
4184      if (D->hasAttr<DeprecatedAttr>())
4185        return CXAvailability_Deprecated;
4186    }
4187
4188  return CXAvailability_Available;
4189}
4190
4191CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
4192  if (clang_isDeclaration(cursor.kind))
4193    return getDeclLanguage(cxcursor::getCursorDecl(cursor));
4194
4195  return CXLanguage_Invalid;
4196}
4197
4198CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
4199  if (clang_isDeclaration(cursor.kind)) {
4200    if (Decl *D = getCursorDecl(cursor)) {
4201      DeclContext *DC = D->getDeclContext();
4202      return MakeCXCursor(cast<Decl>(DC), getCursorASTUnit(cursor));
4203    }
4204  }
4205
4206  if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
4207    if (Decl *D = getCursorDecl(cursor))
4208      return MakeCXCursor(D, getCursorASTUnit(cursor));
4209  }
4210
4211  return clang_getNullCursor();
4212}
4213
4214CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
4215  if (clang_isDeclaration(cursor.kind)) {
4216    if (Decl *D = getCursorDecl(cursor)) {
4217      DeclContext *DC = D->getLexicalDeclContext();
4218      return MakeCXCursor(cast<Decl>(DC), getCursorASTUnit(cursor));
4219    }
4220  }
4221
4222  // FIXME: Note that we can't easily compute the lexical context of a
4223  // statement or expression, so we return nothing.
4224  return clang_getNullCursor();
4225}
4226
4227static void CollectOverriddenMethods(DeclContext *Ctx,
4228                                     ObjCMethodDecl *Method,
4229                            llvm::SmallVectorImpl<ObjCMethodDecl *> &Methods) {
4230  if (!Ctx)
4231    return;
4232
4233  // If we have a class or category implementation, jump straight to the
4234  // interface.
4235  if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(Ctx))
4236    return CollectOverriddenMethods(Impl->getClassInterface(), Method, Methods);
4237
4238  ObjCContainerDecl *Container = dyn_cast<ObjCContainerDecl>(Ctx);
4239  if (!Container)
4240    return;
4241
4242  // Check whether we have a matching method at this level.
4243  if (ObjCMethodDecl *Overridden = Container->getMethod(Method->getSelector(),
4244                                                    Method->isInstanceMethod()))
4245    if (Method != Overridden) {
4246      // We found an override at this level; there is no need to look
4247      // into other protocols or categories.
4248      Methods.push_back(Overridden);
4249      return;
4250    }
4251
4252  if (ObjCProtocolDecl *Protocol = dyn_cast<ObjCProtocolDecl>(Container)) {
4253    for (ObjCProtocolDecl::protocol_iterator P = Protocol->protocol_begin(),
4254                                          PEnd = Protocol->protocol_end();
4255         P != PEnd; ++P)
4256      CollectOverriddenMethods(*P, Method, Methods);
4257  }
4258
4259  if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
4260    for (ObjCCategoryDecl::protocol_iterator P = Category->protocol_begin(),
4261                                          PEnd = Category->protocol_end();
4262         P != PEnd; ++P)
4263      CollectOverriddenMethods(*P, Method, Methods);
4264  }
4265
4266  if (ObjCInterfaceDecl *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
4267    for (ObjCInterfaceDecl::protocol_iterator P = Interface->protocol_begin(),
4268                                           PEnd = Interface->protocol_end();
4269         P != PEnd; ++P)
4270      CollectOverriddenMethods(*P, Method, Methods);
4271
4272    for (ObjCCategoryDecl *Category = Interface->getCategoryList();
4273         Category; Category = Category->getNextClassCategory())
4274      CollectOverriddenMethods(Category, Method, Methods);
4275
4276    // We only look into the superclass if we haven't found anything yet.
4277    if (Methods.empty())
4278      if (ObjCInterfaceDecl *Super = Interface->getSuperClass())
4279        return CollectOverriddenMethods(Super, Method, Methods);
4280  }
4281}
4282
4283void clang_getOverriddenCursors(CXCursor cursor,
4284                                CXCursor **overridden,
4285                                unsigned *num_overridden) {
4286  if (overridden)
4287    *overridden = 0;
4288  if (num_overridden)
4289    *num_overridden = 0;
4290  if (!overridden || !num_overridden)
4291    return;
4292
4293  if (!clang_isDeclaration(cursor.kind))
4294    return;
4295
4296  Decl *D = getCursorDecl(cursor);
4297  if (!D)
4298    return;
4299
4300  // Handle C++ member functions.
4301  ASTUnit *CXXUnit = getCursorASTUnit(cursor);
4302  if (CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
4303    *num_overridden = CXXMethod->size_overridden_methods();
4304    if (!*num_overridden)
4305      return;
4306
4307    *overridden = new CXCursor [*num_overridden];
4308    unsigned I = 0;
4309    for (CXXMethodDecl::method_iterator
4310              M = CXXMethod->begin_overridden_methods(),
4311           MEnd = CXXMethod->end_overridden_methods();
4312         M != MEnd; (void)++M, ++I)
4313      (*overridden)[I] = MakeCXCursor(const_cast<CXXMethodDecl*>(*M), CXXUnit);
4314    return;
4315  }
4316
4317  ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
4318  if (!Method)
4319    return;
4320
4321  // Handle Objective-C methods.
4322  llvm::SmallVector<ObjCMethodDecl *, 4> Methods;
4323  CollectOverriddenMethods(Method->getDeclContext(), Method, Methods);
4324
4325  if (Methods.empty())
4326    return;
4327
4328  *num_overridden = Methods.size();
4329  *overridden = new CXCursor [Methods.size()];
4330  for (unsigned I = 0, N = Methods.size(); I != N; ++I)
4331    (*overridden)[I] = MakeCXCursor(Methods[I], CXXUnit);
4332}
4333
4334void clang_disposeOverriddenCursors(CXCursor *overridden) {
4335  delete [] overridden;
4336}
4337
4338CXFile clang_getIncludedFile(CXCursor cursor) {
4339  if (cursor.kind != CXCursor_InclusionDirective)
4340    return 0;
4341
4342  InclusionDirective *ID = getCursorInclusionDirective(cursor);
4343  return (void *)ID->getFile();
4344}
4345
4346} // end: extern "C"
4347
4348
4349//===----------------------------------------------------------------------===//
4350// C++ AST instrospection.
4351//===----------------------------------------------------------------------===//
4352
4353extern "C" {
4354unsigned clang_CXXMethod_isStatic(CXCursor C) {
4355  if (!clang_isDeclaration(C.kind))
4356    return 0;
4357
4358  CXXMethodDecl *Method = 0;
4359  Decl *D = cxcursor::getCursorDecl(C);
4360  if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
4361    Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
4362  else
4363    Method = dyn_cast_or_null<CXXMethodDecl>(D);
4364  return (Method && Method->isStatic()) ? 1 : 0;
4365}
4366
4367} // end: extern "C"
4368
4369//===----------------------------------------------------------------------===//
4370// Attribute introspection.
4371//===----------------------------------------------------------------------===//
4372
4373extern "C" {
4374CXType clang_getIBOutletCollectionType(CXCursor C) {
4375  if (C.kind != CXCursor_IBOutletCollectionAttr)
4376    return cxtype::MakeCXType(QualType(), cxcursor::getCursorASTUnit(C));
4377
4378  IBOutletCollectionAttr *A =
4379    cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
4380
4381  return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorASTUnit(C));
4382}
4383} // end: extern "C"
4384
4385//===----------------------------------------------------------------------===//
4386// CXString Operations.
4387//===----------------------------------------------------------------------===//
4388
4389extern "C" {
4390const char *clang_getCString(CXString string) {
4391  return string.Spelling;
4392}
4393
4394void clang_disposeString(CXString string) {
4395  if (string.MustFreeString && string.Spelling)
4396    free((void*)string.Spelling);
4397}
4398
4399} // end: extern "C"
4400
4401namespace clang { namespace cxstring {
4402CXString createCXString(const char *String, bool DupString){
4403  CXString Str;
4404  if (DupString) {
4405    Str.Spelling = strdup(String);
4406    Str.MustFreeString = 1;
4407  } else {
4408    Str.Spelling = String;
4409    Str.MustFreeString = 0;
4410  }
4411  return Str;
4412}
4413
4414CXString createCXString(llvm::StringRef String, bool DupString) {
4415  CXString Result;
4416  if (DupString || (!String.empty() && String.data()[String.size()] != 0)) {
4417    char *Spelling = (char *)malloc(String.size() + 1);
4418    memmove(Spelling, String.data(), String.size());
4419    Spelling[String.size()] = 0;
4420    Result.Spelling = Spelling;
4421    Result.MustFreeString = 1;
4422  } else {
4423    Result.Spelling = String.data();
4424    Result.MustFreeString = 0;
4425  }
4426  return Result;
4427}
4428}}
4429
4430//===----------------------------------------------------------------------===//
4431// Misc. utility functions.
4432//===----------------------------------------------------------------------===//
4433
4434static unsigned SafetyStackThreadSize = 0;
4435
4436namespace clang {
4437
4438bool RunSafely(llvm::CrashRecoveryContext &CRC,
4439               void (*Fn)(void*), void *UserData) {
4440  if (unsigned Size = GetSafetyThreadStackSize())
4441    return CRC.RunSafelyOnThread(Fn, UserData, Size);
4442  return CRC.RunSafely(Fn, UserData);
4443}
4444
4445unsigned GetSafetyThreadStackSize() {
4446  return SafetyStackThreadSize;
4447}
4448
4449void SetSafetyThreadStackSize(unsigned Value) {
4450  SafetyStackThreadSize = Value;
4451}
4452
4453}
4454
4455extern "C" {
4456
4457CXString clang_getClangVersion() {
4458  return createCXString(getClangFullVersion());
4459}
4460
4461} // end: extern "C"
4462