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