CIndex.cpp revision 0a76aae8c03cb7dd7bdbe683485560afaf695959 
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 "CXSourceLocation.h"
18#include "CIndexDiagnostic.h"
19
20#include "clang/Basic/Version.h"
21
22#include "clang/AST/DeclVisitor.h"
23#include "clang/AST/StmtVisitor.h"
24#include "clang/AST/TypeLocVisitor.h"
25#include "clang/Basic/Diagnostic.h"
26#include "clang/Frontend/ASTUnit.h"
27#include "clang/Frontend/CompilerInstance.h"
28#include "clang/Frontend/FrontendDiagnostic.h"
29#include "clang/Lex/Lexer.h"
30#include "clang/Lex/PreprocessingRecord.h"
31#include "clang/Lex/Preprocessor.h"
32#include "llvm/Support/MemoryBuffer.h"
33#include "llvm/System/Program.h"
34#include "llvm/System/Signals.h"
35
36// Needed to define L_TMPNAM on some systems.
37#include <cstdio>
38
39using namespace clang;
40using namespace clang::cxcursor;
41using namespace clang::cxstring;
42
43//===----------------------------------------------------------------------===//
44// Crash Reporting.
45//===----------------------------------------------------------------------===//
46
47#ifdef USE_CRASHTRACER
48#include "clang/Analysis/Support/SaveAndRestore.h"
49// Integrate with crash reporter.
50static const char *__crashreporter_info__ = 0;
51asm(".desc ___crashreporter_info__, 0x10");
52#define NUM_CRASH_STRINGS 32
53static unsigned crashtracer_counter = 0;
54static unsigned crashtracer_counter_id[NUM_CRASH_STRINGS] = { 0 };
55static const char *crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
56static const char *agg_crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
57
58static unsigned SetCrashTracerInfo(const char *str,
59                                   llvm::SmallString<1024> &AggStr) {
60
61  unsigned slot = 0;
62  while (crashtracer_strings[slot]) {
63    if (++slot == NUM_CRASH_STRINGS)
64      slot = 0;
65  }
66  crashtracer_strings[slot] = str;
67  crashtracer_counter_id[slot] = ++crashtracer_counter;
68
69  // We need to create an aggregate string because multiple threads
70  // may be in this method at one time.  The crash reporter string
71  // will attempt to overapproximate the set of in-flight invocations
72  // of this function.  Race conditions can still cause this goal
73  // to not be achieved.
74  {
75    llvm::raw_svector_ostream Out(AggStr);
76    for (unsigned i = 0; i < NUM_CRASH_STRINGS; ++i)
77      if (crashtracer_strings[i]) Out << crashtracer_strings[i] << '\n';
78  }
79  __crashreporter_info__ = agg_crashtracer_strings[slot] =  AggStr.c_str();
80  return slot;
81}
82
83static void ResetCrashTracerInfo(unsigned slot) {
84  unsigned max_slot = 0;
85  unsigned max_value = 0;
86
87  crashtracer_strings[slot] = agg_crashtracer_strings[slot] = 0;
88
89  for (unsigned i = 0 ; i < NUM_CRASH_STRINGS; ++i)
90    if (agg_crashtracer_strings[i] &&
91        crashtracer_counter_id[i] > max_value) {
92      max_slot = i;
93      max_value = crashtracer_counter_id[i];
94    }
95
96  __crashreporter_info__ = agg_crashtracer_strings[max_slot];
97}
98
99namespace {
100class ArgsCrashTracerInfo {
101  llvm::SmallString<1024> CrashString;
102  llvm::SmallString<1024> AggregateString;
103  unsigned crashtracerSlot;
104public:
105  ArgsCrashTracerInfo(llvm::SmallVectorImpl<const char*> &Args)
106    : crashtracerSlot(0)
107  {
108    {
109      llvm::raw_svector_ostream Out(CrashString);
110      Out << "ClangCIndex [" << getClangFullVersion() << "]"
111          << "[createTranslationUnitFromSourceFile]: clang";
112      for (llvm::SmallVectorImpl<const char*>::iterator I=Args.begin(),
113           E=Args.end(); I!=E; ++I)
114        Out << ' ' << *I;
115    }
116    crashtracerSlot = SetCrashTracerInfo(CrashString.c_str(),
117                                         AggregateString);
118  }
119
120  ~ArgsCrashTracerInfo() {
121    ResetCrashTracerInfo(crashtracerSlot);
122  }
123};
124}
125#endif
126
127/// \brief The result of comparing two source ranges.
128enum RangeComparisonResult {
129  /// \brief Either the ranges overlap or one of the ranges is invalid.
130  RangeOverlap,
131
132  /// \brief The first range ends before the second range starts.
133  RangeBefore,
134
135  /// \brief The first range starts after the second range ends.
136  RangeAfter
137};
138
139/// \brief Compare two source ranges to determine their relative position in
140/// the translation unit.
141static RangeComparisonResult RangeCompare(SourceManager &SM,
142                                          SourceRange R1,
143                                          SourceRange R2) {
144  assert(R1.isValid() && "First range is invalid?");
145  assert(R2.isValid() && "Second range is invalid?");
146  if (R1.getEnd() == R2.getBegin() ||
147      SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
148    return RangeBefore;
149  if (R2.getEnd() == R1.getBegin() ||
150      SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
151    return RangeAfter;
152  return RangeOverlap;
153}
154
155/// \brief Determine if a source location falls within, before, or after a
156///   a given source range.
157static RangeComparisonResult LocationCompare(SourceManager &SM,
158                                             SourceLocation L, SourceRange R) {
159  assert(R.isValid() && "First range is invalid?");
160  assert(L.isValid() && "Second range is invalid?");
161  if (L == R.getBegin())
162    return RangeOverlap;
163  if (L == R.getEnd())
164    return RangeAfter;
165  if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
166    return RangeBefore;
167  if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
168    return RangeAfter;
169  return RangeOverlap;
170}
171
172/// \brief Translate a Clang source range into a CIndex source range.
173///
174/// Clang internally represents ranges where the end location points to the
175/// start of the token at the end. However, for external clients it is more
176/// useful to have a CXSourceRange be a proper half-open interval. This routine
177/// does the appropriate translation.
178CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
179                                          const LangOptions &LangOpts,
180                                          const CharSourceRange &R) {
181  // We want the last character in this location, so we will adjust the
182  // location accordingly.
183  // FIXME: How do do this with a macro instantiation location?
184  SourceLocation EndLoc = R.getEnd();
185  if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
186    unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
187    EndLoc = EndLoc.getFileLocWithOffset(Length);
188  }
189
190  CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
191                           R.getBegin().getRawEncoding(),
192                           EndLoc.getRawEncoding() };
193  return Result;
194}
195
196//===----------------------------------------------------------------------===//
197// Cursor visitor.
198//===----------------------------------------------------------------------===//
199
200namespace {
201
202// Cursor visitor.
203class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
204                      public TypeLocVisitor<CursorVisitor, bool>,
205                      public StmtVisitor<CursorVisitor, bool>
206{
207  /// \brief The translation unit we are traversing.
208  ASTUnit *TU;
209
210  /// \brief The parent cursor whose children we are traversing.
211  CXCursor Parent;
212
213  /// \brief The declaration that serves at the parent of any statement or
214  /// expression nodes.
215  Decl *StmtParent;
216
217  /// \brief The visitor function.
218  CXCursorVisitor Visitor;
219
220  /// \brief The opaque client data, to be passed along to the visitor.
221  CXClientData ClientData;
222
223  // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
224  // to the visitor. Declarations with a PCH level greater than this value will
225  // be suppressed.
226  unsigned MaxPCHLevel;
227
228  /// \brief When valid, a source range to which the cursor should restrict
229  /// its search.
230  SourceRange RegionOfInterest;
231
232  using DeclVisitor<CursorVisitor, bool>::Visit;
233  using TypeLocVisitor<CursorVisitor, bool>::Visit;
234  using StmtVisitor<CursorVisitor, bool>::Visit;
235
236  /// \brief Determine whether this particular source range comes before, comes
237  /// after, or overlaps the region of interest.
238  ///
239  /// \param R a half-open source range retrieved from the abstract syntax tree.
240  RangeComparisonResult CompareRegionOfInterest(SourceRange R);
241
242  class SetParentRAII {
243    CXCursor &Parent;
244    Decl *&StmtParent;
245    CXCursor OldParent;
246
247  public:
248    SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
249      : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
250    {
251      Parent = NewParent;
252      if (clang_isDeclaration(Parent.kind))
253        StmtParent = getCursorDecl(Parent);
254    }
255
256    ~SetParentRAII() {
257      Parent = OldParent;
258      if (clang_isDeclaration(Parent.kind))
259        StmtParent = getCursorDecl(Parent);
260    }
261  };
262
263public:
264  CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData,
265                unsigned MaxPCHLevel,
266                SourceRange RegionOfInterest = SourceRange())
267    : TU(TU), Visitor(Visitor), ClientData(ClientData),
268      MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest)
269  {
270    Parent.kind = CXCursor_NoDeclFound;
271    Parent.data[0] = 0;
272    Parent.data[1] = 0;
273    Parent.data[2] = 0;
274    StmtParent = 0;
275  }
276
277  bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
278
279  std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
280    getPreprocessedEntities();
281
282  bool VisitChildren(CXCursor Parent);
283
284  // Declaration visitors
285  bool VisitAttributes(Decl *D);
286  bool VisitBlockDecl(BlockDecl *B);
287  bool VisitDeclContext(DeclContext *DC);
288  bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
289  bool VisitTypedefDecl(TypedefDecl *D);
290  bool VisitTagDecl(TagDecl *D);
291  bool VisitEnumConstantDecl(EnumConstantDecl *D);
292  bool VisitDeclaratorDecl(DeclaratorDecl *DD);
293  bool VisitFunctionDecl(FunctionDecl *ND);
294  bool VisitFieldDecl(FieldDecl *D);
295  bool VisitVarDecl(VarDecl *);
296  bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
297  bool VisitObjCContainerDecl(ObjCContainerDecl *D);
298  bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
299  bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
300  bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
301  bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
302  bool VisitObjCImplDecl(ObjCImplDecl *D);
303  bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
304  bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
305  // FIXME: ObjCPropertyDecl requires TypeSourceInfo, getter/setter locations,
306  // etc.
307  // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
308  bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
309  bool VisitObjCClassDecl(ObjCClassDecl *D);
310  bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
311  bool VisitNamespaceDecl(NamespaceDecl *D);
312
313  // Type visitors
314  // FIXME: QualifiedTypeLoc doesn't provide any location information
315  bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
316  bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
317  bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
318  bool VisitTagTypeLoc(TagTypeLoc TL);
319  // FIXME: TemplateTypeParmTypeLoc doesn't provide any location information
320  bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
321  bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
322  bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
323  bool VisitPointerTypeLoc(PointerTypeLoc TL);
324  bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
325  bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
326  bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
327  bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
328  bool VisitFunctionTypeLoc(FunctionTypeLoc TL);
329  bool VisitArrayTypeLoc(ArrayTypeLoc TL);
330  // FIXME: Implement for TemplateSpecializationTypeLoc
331  // FIXME: Implement visitors here when the unimplemented TypeLocs get
332  // implemented
333  bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
334  bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
335
336  // Statement visitors
337  bool VisitStmt(Stmt *S);
338  bool VisitDeclStmt(DeclStmt *S);
339  // FIXME: LabelStmt label?
340  bool VisitIfStmt(IfStmt *S);
341  bool VisitSwitchStmt(SwitchStmt *S);
342  bool VisitCaseStmt(CaseStmt *S);
343  bool VisitWhileStmt(WhileStmt *S);
344  bool VisitForStmt(ForStmt *S);
345//  bool VisitSwitchCase(SwitchCase *S);
346
347  // Expression visitors
348  bool VisitBlockExpr(BlockExpr *B);
349  bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
350  bool VisitExplicitCastExpr(ExplicitCastExpr *E);
351  bool VisitObjCMessageExpr(ObjCMessageExpr *E);
352  bool VisitObjCEncodeExpr(ObjCEncodeExpr *E);
353  bool VisitOffsetOfExpr(OffsetOfExpr *E);
354  bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
355};
356
357} // end anonymous namespace
358
359RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
360  return RangeCompare(TU->getSourceManager(), R, RegionOfInterest);
361}
362
363/// \brief Visit the given cursor and, if requested by the visitor,
364/// its children.
365///
366/// \param Cursor the cursor to visit.
367///
368/// \param CheckRegionOfInterest if true, then the caller already checked that
369/// this cursor is within the region of interest.
370///
371/// \returns true if the visitation should be aborted, false if it
372/// should continue.
373bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
374  if (clang_isInvalid(Cursor.kind))
375    return false;
376
377  if (clang_isDeclaration(Cursor.kind)) {
378    Decl *D = getCursorDecl(Cursor);
379    assert(D && "Invalid declaration cursor");
380    if (D->getPCHLevel() > MaxPCHLevel)
381      return false;
382
383    if (D->isImplicit())
384      return false;
385  }
386
387  // If we have a range of interest, and this cursor doesn't intersect with it,
388  // we're done.
389  if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
390    SourceRange Range =
391      cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor));
392    if (Range.isInvalid() || CompareRegionOfInterest(Range))
393      return false;
394  }
395
396  switch (Visitor(Cursor, Parent, ClientData)) {
397  case CXChildVisit_Break:
398    return true;
399
400  case CXChildVisit_Continue:
401    return false;
402
403  case CXChildVisit_Recurse:
404    return VisitChildren(Cursor);
405  }
406
407  return false;
408}
409
410std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
411CursorVisitor::getPreprocessedEntities() {
412  PreprocessingRecord &PPRec
413    = *TU->getPreprocessor().getPreprocessingRecord();
414
415  bool OnlyLocalDecls
416    = !TU->isMainFileAST() && TU->getOnlyLocalDecls();
417
418  // There is no region of interest; we have to walk everything.
419  if (RegionOfInterest.isInvalid())
420    return std::make_pair(PPRec.begin(OnlyLocalDecls),
421                          PPRec.end(OnlyLocalDecls));
422
423  // Find the file in which the region of interest lands.
424  SourceManager &SM = TU->getSourceManager();
425  std::pair<FileID, unsigned> Begin
426    = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin());
427  std::pair<FileID, unsigned> End
428    = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd());
429
430  // The region of interest spans files; we have to walk everything.
431  if (Begin.first != End.first)
432    return std::make_pair(PPRec.begin(OnlyLocalDecls),
433                          PPRec.end(OnlyLocalDecls));
434
435  ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap
436    = TU->getPreprocessedEntitiesByFile();
437  if (ByFileMap.empty()) {
438    // Build the mapping from files to sets of preprocessed entities.
439    for (PreprocessingRecord::iterator E = PPRec.begin(OnlyLocalDecls),
440                                    EEnd = PPRec.end(OnlyLocalDecls);
441         E != EEnd; ++E) {
442      std::pair<FileID, unsigned> P
443        = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin());
444      ByFileMap[P.first].push_back(*E);
445    }
446  }
447
448  return std::make_pair(ByFileMap[Begin.first].begin(),
449                        ByFileMap[Begin.first].end());
450}
451
452/// \brief Visit the children of the given cursor.
453///
454/// \returns true if the visitation should be aborted, false if it
455/// should continue.
456bool CursorVisitor::VisitChildren(CXCursor Cursor) {
457  if (clang_isReference(Cursor.kind)) {
458    // By definition, references have no children.
459    return false;
460  }
461
462  // Set the Parent field to Cursor, then back to its old value once we're
463  // done.
464  SetParentRAII SetParent(Parent, StmtParent, Cursor);
465
466  if (clang_isDeclaration(Cursor.kind)) {
467    Decl *D = getCursorDecl(Cursor);
468    assert(D && "Invalid declaration cursor");
469    return VisitAttributes(D) || Visit(D);
470  }
471
472  if (clang_isStatement(Cursor.kind))
473    return Visit(getCursorStmt(Cursor));
474  if (clang_isExpression(Cursor.kind))
475    return Visit(getCursorExpr(Cursor));
476
477  if (clang_isTranslationUnit(Cursor.kind)) {
478    ASTUnit *CXXUnit = getCursorASTUnit(Cursor);
479    if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
480        RegionOfInterest.isInvalid()) {
481      const std::vector<Decl*> &TLDs = CXXUnit->getTopLevelDecls();
482      for (std::vector<Decl*>::const_iterator it = TLDs.begin(),
483           ie = TLDs.end(); it != ie; ++it) {
484        if (Visit(MakeCXCursor(*it, CXXUnit), true))
485          return true;
486      }
487    } else if (VisitDeclContext(
488                            CXXUnit->getASTContext().getTranslationUnitDecl()))
489      return true;
490
491    // Walk the preprocessing record.
492    if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
493      // FIXME: Once we have the ability to deserialize a preprocessing record,
494      // do so.
495      PreprocessingRecord::iterator E, EEnd;
496      for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) {
497        if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
498          if (Visit(MakeMacroInstantiationCursor(MI, CXXUnit)))
499            return true;
500
501          continue;
502        }
503
504        if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
505          if (Visit(MakeMacroDefinitionCursor(MD, CXXUnit)))
506            return true;
507
508          continue;
509        }
510      }
511    }
512    return false;
513  }
514
515  // Nothing to visit at the moment.
516  return false;
517}
518
519bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
520  if (Visit(B->getSignatureAsWritten()->getTypeLoc()))
521    return true;
522
523  return Visit(MakeCXCursor(B->getBody(), StmtParent, TU));
524}
525
526bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
527  for (DeclContext::decl_iterator
528       I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) {
529
530    Decl *D = *I;
531    if (D->getLexicalDeclContext() != DC)
532      continue;
533
534    CXCursor Cursor = MakeCXCursor(D, TU);
535
536    if (RegionOfInterest.isValid()) {
537      SourceRange Range =
538        cxloc::translateCXSourceRange(clang_getCursorExtent(Cursor));
539      if (Range.isInvalid())
540        continue;
541
542      switch (CompareRegionOfInterest(Range)) {
543      case RangeBefore:
544        // This declaration comes before the region of interest; skip it.
545        continue;
546
547      case RangeAfter:
548        // This declaration comes after the region of interest; we're done.
549        return false;
550
551      case RangeOverlap:
552        // This declaration overlaps the region of interest; visit it.
553        break;
554      }
555    }
556
557    if (Visit(Cursor, true))
558      return true;
559  }
560
561  return false;
562}
563
564bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
565  llvm_unreachable("Translation units are visited directly by Visit()");
566  return false;
567}
568
569bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
570  if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
571    return Visit(TSInfo->getTypeLoc());
572
573  return false;
574}
575
576bool CursorVisitor::VisitTagDecl(TagDecl *D) {
577  return VisitDeclContext(D);
578}
579
580bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
581  if (Expr *Init = D->getInitExpr())
582    return Visit(MakeCXCursor(Init, StmtParent, TU));
583  return false;
584}
585
586bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
587  if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
588    if (Visit(TSInfo->getTypeLoc()))
589      return true;
590
591  return false;
592}
593
594bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
595  if (VisitDeclaratorDecl(ND))
596    return true;
597
598  if (ND->isThisDeclarationADefinition() &&
599      Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
600    return true;
601
602  return false;
603}
604
605bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
606  if (VisitDeclaratorDecl(D))
607    return true;
608
609  if (Expr *BitWidth = D->getBitWidth())
610    return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
611
612  return false;
613}
614
615bool CursorVisitor::VisitVarDecl(VarDecl *D) {
616  if (VisitDeclaratorDecl(D))
617    return true;
618
619  if (Expr *Init = D->getInit())
620    return Visit(MakeCXCursor(Init, StmtParent, TU));
621
622  return false;
623}
624
625bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
626  if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
627    if (Visit(TSInfo->getTypeLoc()))
628      return true;
629
630  for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
631       PEnd = ND->param_end();
632       P != PEnd; ++P) {
633    if (Visit(MakeCXCursor(*P, TU)))
634      return true;
635  }
636
637  if (ND->isThisDeclarationADefinition() &&
638      Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
639    return true;
640
641  return false;
642}
643
644bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
645  return VisitDeclContext(D);
646}
647
648bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
649  if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
650                                   TU)))
651    return true;
652
653  ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
654  for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
655         E = ND->protocol_end(); I != E; ++I, ++PL)
656    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
657      return true;
658
659  return VisitObjCContainerDecl(ND);
660}
661
662bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
663  ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
664  for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
665       E = PID->protocol_end(); I != E; ++I, ++PL)
666    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
667      return true;
668
669  return VisitObjCContainerDecl(PID);
670}
671
672bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
673  if (Visit(PD->getTypeSourceInfo()->getTypeLoc()))
674    return true;
675
676  // FIXME: This implements a workaround with @property declarations also being
677  // installed in the DeclContext for the @interface.  Eventually this code
678  // should be removed.
679  ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
680  if (!CDecl || !CDecl->IsClassExtension())
681    return false;
682
683  ObjCInterfaceDecl *ID = CDecl->getClassInterface();
684  if (!ID)
685    return false;
686
687  IdentifierInfo *PropertyId = PD->getIdentifier();
688  ObjCPropertyDecl *prevDecl =
689    ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
690
691  if (!prevDecl)
692    return false;
693
694  // Visit synthesized methods since they will be skipped when visiting
695  // the @interface.
696  if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
697    if (MD->isSynthesized())
698      if (Visit(MakeCXCursor(MD, TU)))
699        return true;
700
701  if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
702    if (MD->isSynthesized())
703      if (Visit(MakeCXCursor(MD, TU)))
704        return true;
705
706  return false;
707}
708
709bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
710  // Issue callbacks for super class.
711  if (D->getSuperClass() &&
712      Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
713                                        D->getSuperClassLoc(),
714                                        TU)))
715    return true;
716
717  ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
718  for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
719         E = D->protocol_end(); I != E; ++I, ++PL)
720    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
721      return true;
722
723  return VisitObjCContainerDecl(D);
724}
725
726bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
727  return VisitObjCContainerDecl(D);
728}
729
730bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
731  // 'ID' could be null when dealing with invalid code.
732  if (ObjCInterfaceDecl *ID = D->getClassInterface())
733    if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
734      return true;
735
736  return VisitObjCImplDecl(D);
737}
738
739bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
740#if 0
741  // Issue callbacks for super class.
742  // FIXME: No source location information!
743  if (D->getSuperClass() &&
744      Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
745                                        D->getSuperClassLoc(),
746                                        TU)))
747    return true;
748#endif
749
750  return VisitObjCImplDecl(D);
751}
752
753bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
754  ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
755  for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
756                                                  E = D->protocol_end();
757       I != E; ++I, ++PL)
758    if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
759      return true;
760
761  return false;
762}
763
764bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
765  for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
766    if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
767      return true;
768
769  return false;
770}
771
772bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
773  return VisitDeclContext(D);
774}
775
776bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
777  return VisitDeclContext(D);
778}
779
780bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
781  ASTContext &Context = TU->getASTContext();
782
783  // Some builtin types (such as Objective-C's "id", "sel", and
784  // "Class") have associated declarations. Create cursors for those.
785  QualType VisitType;
786  switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
787  case BuiltinType::Void:
788  case BuiltinType::Bool:
789  case BuiltinType::Char_U:
790  case BuiltinType::UChar:
791  case BuiltinType::Char16:
792  case BuiltinType::Char32:
793  case BuiltinType::UShort:
794  case BuiltinType::UInt:
795  case BuiltinType::ULong:
796  case BuiltinType::ULongLong:
797  case BuiltinType::UInt128:
798  case BuiltinType::Char_S:
799  case BuiltinType::SChar:
800  case BuiltinType::WChar:
801  case BuiltinType::Short:
802  case BuiltinType::Int:
803  case BuiltinType::Long:
804  case BuiltinType::LongLong:
805  case BuiltinType::Int128:
806  case BuiltinType::Float:
807  case BuiltinType::Double:
808  case BuiltinType::LongDouble:
809  case BuiltinType::NullPtr:
810  case BuiltinType::Overload:
811  case BuiltinType::Dependent:
812    break;
813
814  case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
815    break;
816
817  case BuiltinType::ObjCId:
818    VisitType = Context.getObjCIdType();
819    break;
820
821  case BuiltinType::ObjCClass:
822    VisitType = Context.getObjCClassType();
823    break;
824
825  case BuiltinType::ObjCSel:
826    VisitType = Context.getObjCSelType();
827    break;
828  }
829
830  if (!VisitType.isNull()) {
831    if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
832      return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
833                                     TU));
834  }
835
836  return false;
837}
838
839bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
840  return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
841}
842
843bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
844  return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
845}
846
847bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
848  return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
849}
850
851bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
852  if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
853    return true;
854
855  return false;
856}
857
858bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
859  if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
860    return true;
861
862  for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
863    if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
864                                        TU)))
865      return true;
866  }
867
868  return false;
869}
870
871bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
872  return Visit(TL.getPointeeLoc());
873}
874
875bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
876  return Visit(TL.getPointeeLoc());
877}
878
879bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
880  return Visit(TL.getPointeeLoc());
881}
882
883bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
884  return Visit(TL.getPointeeLoc());
885}
886
887bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
888  return Visit(TL.getPointeeLoc());
889}
890
891bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
892  return Visit(TL.getPointeeLoc());
893}
894
895bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
896  if (Visit(TL.getResultLoc()))
897    return true;
898
899  for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
900    if (Decl *D = TL.getArg(I))
901      if (Visit(MakeCXCursor(D, TU)))
902        return true;
903
904  return false;
905}
906
907bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
908  if (Visit(TL.getElementLoc()))
909    return true;
910
911  if (Expr *Size = TL.getSizeExpr())
912    return Visit(MakeCXCursor(Size, StmtParent, TU));
913
914  return false;
915}
916
917bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
918  return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
919}
920
921bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
922  if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
923    return Visit(TSInfo->getTypeLoc());
924
925  return false;
926}
927
928bool CursorVisitor::VisitStmt(Stmt *S) {
929  for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
930       Child != ChildEnd; ++Child) {
931    if (Stmt *C = *Child)
932      if (Visit(MakeCXCursor(C, StmtParent, TU)))
933        return true;
934  }
935
936  return false;
937}
938
939bool CursorVisitor::VisitCaseStmt(CaseStmt *S) {
940  // Specially handle CaseStmts because they can be nested, e.g.:
941  //
942  //    case 1:
943  //    case 2:
944  //
945  // In this case the second CaseStmt is the child of the first.  Walking
946  // these recursively can blow out the stack.
947  CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
948  while (true) {
949    // Set the Parent field to Cursor, then back to its old value once we're
950    //   done.
951    SetParentRAII SetParent(Parent, StmtParent, Cursor);
952
953    if (Stmt *LHS = S->getLHS())
954      if (Visit(MakeCXCursor(LHS, StmtParent, TU)))
955        return true;
956    if (Stmt *RHS = S->getRHS())
957      if (Visit(MakeCXCursor(RHS, StmtParent, TU)))
958        return true;
959    if (Stmt *SubStmt = S->getSubStmt()) {
960      if (!isa<CaseStmt>(SubStmt))
961        return Visit(MakeCXCursor(SubStmt, StmtParent, TU));
962
963      // Specially handle 'CaseStmt' so that we don't blow out the stack.
964      CaseStmt *CS = cast<CaseStmt>(SubStmt);
965      Cursor = MakeCXCursor(CS, StmtParent, TU);
966      if (RegionOfInterest.isValid()) {
967        SourceRange Range = CS->getSourceRange();
968        if (Range.isInvalid() || CompareRegionOfInterest(Range))
969          return false;
970      }
971
972      switch (Visitor(Cursor, Parent, ClientData)) {
973        case CXChildVisit_Break: return true;
974        case CXChildVisit_Continue: return false;
975        case CXChildVisit_Recurse:
976          // Perform tail-recursion manually.
977          S = CS;
978          continue;
979      }
980    }
981    return false;
982  }
983}
984
985bool CursorVisitor::VisitDeclStmt(DeclStmt *S) {
986  for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
987       D != DEnd; ++D) {
988    if (*D && Visit(MakeCXCursor(*D, TU)))
989      return true;
990  }
991
992  return false;
993}
994
995bool CursorVisitor::VisitIfStmt(IfStmt *S) {
996  if (VarDecl *Var = S->getConditionVariable()) {
997    if (Visit(MakeCXCursor(Var, TU)))
998      return true;
999  }
1000
1001  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1002    return true;
1003  if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU)))
1004    return true;
1005  if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU)))
1006    return true;
1007
1008  return false;
1009}
1010
1011bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) {
1012  if (VarDecl *Var = S->getConditionVariable()) {
1013    if (Visit(MakeCXCursor(Var, TU)))
1014      return true;
1015  }
1016
1017  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1018    return true;
1019  if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1020    return true;
1021
1022  return false;
1023}
1024
1025bool CursorVisitor::VisitWhileStmt(WhileStmt *S) {
1026  if (VarDecl *Var = S->getConditionVariable()) {
1027    if (Visit(MakeCXCursor(Var, TU)))
1028      return true;
1029  }
1030
1031  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1032    return true;
1033  if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1034    return true;
1035
1036  return false;
1037}
1038
1039bool CursorVisitor::VisitForStmt(ForStmt *S) {
1040  if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU)))
1041    return true;
1042  if (VarDecl *Var = S->getConditionVariable()) {
1043    if (Visit(MakeCXCursor(Var, TU)))
1044      return true;
1045  }
1046
1047  if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1048    return true;
1049  if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU)))
1050    return true;
1051  if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1052    return true;
1053
1054  return false;
1055}
1056
1057bool CursorVisitor::VisitBlockExpr(BlockExpr *B) {
1058  return Visit(B->getBlockDecl());
1059}
1060
1061bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
1062  // FIXME: Visit fields as well?
1063  if (Visit(E->getTypeSourceInfo()->getTypeLoc()))
1064    return true;
1065
1066  return VisitExpr(E);
1067}
1068
1069bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1070  if (E->isArgumentType()) {
1071    if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo())
1072      return Visit(TSInfo->getTypeLoc());
1073
1074    return false;
1075  }
1076
1077  return VisitExpr(E);
1078}
1079
1080bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1081  if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten())
1082    if (Visit(TSInfo->getTypeLoc()))
1083      return true;
1084
1085  return VisitCastExpr(E);
1086}
1087
1088bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1089  if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1090    if (Visit(TSInfo->getTypeLoc()))
1091      return true;
1092
1093  return VisitExpr(E);
1094}
1095
1096bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) {
1097  if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo())
1098    if (Visit(TSInfo->getTypeLoc()))
1099      return true;
1100
1101  return VisitExpr(E);
1102}
1103
1104bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1105  return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc());
1106}
1107
1108
1109bool CursorVisitor::VisitAttributes(Decl *D) {
1110  for (const Attr *A = D->getAttrs(); A; A = A->getNext())
1111    if (Visit(MakeCXCursor(A, D, TU)))
1112        return true;
1113
1114  return false;
1115}
1116
1117extern "C" {
1118CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
1119                          int displayDiagnostics) {
1120  CIndexer *CIdxr = new CIndexer();
1121  if (excludeDeclarationsFromPCH)
1122    CIdxr->setOnlyLocalDecls();
1123  if (displayDiagnostics)
1124    CIdxr->setDisplayDiagnostics();
1125  return CIdxr;
1126}
1127
1128void clang_disposeIndex(CXIndex CIdx) {
1129  if (CIdx)
1130    delete static_cast<CIndexer *>(CIdx);
1131}
1132
1133void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) {
1134  if (CIdx) {
1135    CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1136    CXXIdx->setUseExternalASTGeneration(value);
1137  }
1138}
1139
1140CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
1141                                              const char *ast_filename) {
1142  if (!CIdx)
1143    return 0;
1144
1145  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1146
1147  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1148  return ASTUnit::LoadFromPCHFile(ast_filename, Diags,
1149                                  CXXIdx->getOnlyLocalDecls(),
1150                                  0, 0, true);
1151}
1152
1153CXTranslationUnit
1154clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
1155                                          const char *source_filename,
1156                                          int num_command_line_args,
1157                                          const char **command_line_args,
1158                                          unsigned num_unsaved_files,
1159                                          struct CXUnsavedFile *unsaved_files) {
1160  if (!CIdx)
1161    return 0;
1162
1163  CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1164
1165  // Configure the diagnostics.
1166  DiagnosticOptions DiagOpts;
1167  llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1168  Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
1169
1170  llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
1171  for (unsigned I = 0; I != num_unsaved_files; ++I) {
1172    llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
1173    const llvm::MemoryBuffer *Buffer
1174      = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
1175    RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
1176                                           Buffer));
1177  }
1178
1179  if (!CXXIdx->getUseExternalASTGeneration()) {
1180    llvm::SmallVector<const char *, 16> Args;
1181
1182    // The 'source_filename' argument is optional.  If the caller does not
1183    // specify it then it is assumed that the source file is specified
1184    // in the actual argument list.
1185    if (source_filename)
1186      Args.push_back(source_filename);
1187    Args.insert(Args.end(), command_line_args,
1188                command_line_args + num_command_line_args);
1189    Args.push_back("-Xclang");
1190    Args.push_back("-detailed-preprocessing-record");
1191    unsigned NumErrors = Diags->getNumErrors();
1192
1193#ifdef USE_CRASHTRACER
1194    ArgsCrashTracerInfo ACTI(Args);
1195#endif
1196
1197    llvm::OwningPtr<ASTUnit> Unit(
1198      ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
1199                                   Diags,
1200                                   CXXIdx->getClangResourcesPath(),
1201                                   CXXIdx->getOnlyLocalDecls(),
1202                                   RemappedFiles.data(),
1203                                   RemappedFiles.size(),
1204                                   /*CaptureDiagnostics=*/true));
1205
1206    if (NumErrors != Diags->getNumErrors()) {
1207      // Make sure to check that 'Unit' is non-NULL.
1208      if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
1209        for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
1210                                        DEnd = Unit->stored_diag_end();
1211             D != DEnd; ++D) {
1212          CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
1213          CXString Msg = clang_formatDiagnostic(&Diag,
1214                                      clang_defaultDiagnosticDisplayOptions());
1215          fprintf(stderr, "%s\n", clang_getCString(Msg));
1216          clang_disposeString(Msg);
1217        }
1218#ifdef LLVM_ON_WIN32
1219        // On Windows, force a flush, since there may be multiple copies of
1220        // stderr and stdout in the file system, all with different buffers
1221        // but writing to the same device.
1222        fflush(stderr);
1223#endif
1224      }
1225    }
1226
1227    return Unit.take();
1228  }
1229
1230  // Build up the arguments for invoking 'clang'.
1231  std::vector<const char *> argv;
1232
1233  // First add the complete path to the 'clang' executable.
1234  llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
1235  argv.push_back(ClangPath.c_str());
1236
1237  // Add the '-emit-ast' option as our execution mode for 'clang'.
1238  argv.push_back("-emit-ast");
1239
1240  // The 'source_filename' argument is optional.  If the caller does not
1241  // specify it then it is assumed that the source file is specified
1242  // in the actual argument list.
1243  if (source_filename)
1244    argv.push_back(source_filename);
1245
1246  // Generate a temporary name for the AST file.
1247  argv.push_back("-o");
1248  char astTmpFile[L_tmpnam];
1249  argv.push_back(tmpnam(astTmpFile));
1250
1251  // Remap any unsaved files to temporary files.
1252  std::vector<llvm::sys::Path> TemporaryFiles;
1253  std::vector<std::string> RemapArgs;
1254  if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles))
1255    return 0;
1256
1257  // The pointers into the elements of RemapArgs are stable because we
1258  // won't be adding anything to RemapArgs after this point.
1259  for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
1260    argv.push_back(RemapArgs[i].c_str());
1261
1262  // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
1263  for (int i = 0; i < num_command_line_args; ++i)
1264    if (const char *arg = command_line_args[i]) {
1265      if (strcmp(arg, "-o") == 0) {
1266        ++i; // Also skip the matching argument.
1267        continue;
1268      }
1269      if (strcmp(arg, "-emit-ast") == 0 ||
1270          strcmp(arg, "-c") == 0 ||
1271          strcmp(arg, "-fsyntax-only") == 0) {
1272        continue;
1273      }
1274
1275      // Keep the argument.
1276      argv.push_back(arg);
1277    }
1278
1279  // Generate a temporary name for the diagnostics file.
1280  char tmpFileResults[L_tmpnam];
1281  char *tmpResultsFileName = tmpnam(tmpFileResults);
1282  llvm::sys::Path DiagnosticsFile(tmpResultsFileName);
1283  TemporaryFiles.push_back(DiagnosticsFile);
1284  argv.push_back("-fdiagnostics-binary");
1285
1286  argv.push_back("-Xclang");
1287  argv.push_back("-detailed-preprocessing-record");
1288
1289  // Add the null terminator.
1290  argv.push_back(NULL);
1291
1292  // Invoke 'clang'.
1293  llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
1294                           // on Unix or NUL (Windows).
1295  std::string ErrMsg;
1296  const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DiagnosticsFile,
1297                                         NULL };
1298  llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
1299      /* redirects */ &Redirects[0],
1300      /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
1301
1302  if (!ErrMsg.empty()) {
1303    std::string AllArgs;
1304    for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
1305         I != E; ++I) {
1306      AllArgs += ' ';
1307      if (*I)
1308        AllArgs += *I;
1309    }
1310
1311    Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg;
1312  }
1313
1314  ASTUnit *ATU = ASTUnit::LoadFromPCHFile(astTmpFile, Diags,
1315                                          CXXIdx->getOnlyLocalDecls(),
1316                                          RemappedFiles.data(),
1317                                          RemappedFiles.size(),
1318                                          /*CaptureDiagnostics=*/true);
1319  if (ATU) {
1320    LoadSerializedDiagnostics(DiagnosticsFile,
1321                              num_unsaved_files, unsaved_files,
1322                              ATU->getFileManager(),
1323                              ATU->getSourceManager(),
1324                              ATU->getStoredDiagnostics());
1325  } else if (CXXIdx->getDisplayDiagnostics()) {
1326    // We failed to load the ASTUnit, but we can still deserialize the
1327    // diagnostics and emit them.
1328    FileManager FileMgr;
1329    Diagnostic Diag;
1330    SourceManager SourceMgr(Diag);
1331    // FIXME: Faked LangOpts!
1332    LangOptions LangOpts;
1333    llvm::SmallVector<StoredDiagnostic, 4> Diags;
1334    LoadSerializedDiagnostics(DiagnosticsFile,
1335                              num_unsaved_files, unsaved_files,
1336                              FileMgr, SourceMgr, Diags);
1337    for (llvm::SmallVector<StoredDiagnostic, 4>::iterator D = Diags.begin(),
1338                                                       DEnd = Diags.end();
1339         D != DEnd; ++D) {
1340      CXStoredDiagnostic Diag(*D, LangOpts);
1341      CXString Msg = clang_formatDiagnostic(&Diag,
1342                                      clang_defaultDiagnosticDisplayOptions());
1343      fprintf(stderr, "%s\n", clang_getCString(Msg));
1344      clang_disposeString(Msg);
1345    }
1346
1347#ifdef LLVM_ON_WIN32
1348    // On Windows, force a flush, since there may be multiple copies of
1349    // stderr and stdout in the file system, all with different buffers
1350    // but writing to the same device.
1351    fflush(stderr);
1352#endif
1353  }
1354
1355  if (ATU) {
1356    // Make the translation unit responsible for destroying all temporary files.
1357    for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1358      ATU->addTemporaryFile(TemporaryFiles[i]);
1359    ATU->addTemporaryFile(llvm::sys::Path(ATU->getPCHFileName()));
1360  } else {
1361    // Destroy all of the temporary files now; they can't be referenced any
1362    // longer.
1363    llvm::sys::Path(astTmpFile).eraseFromDisk();
1364    for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
1365      TemporaryFiles[i].eraseFromDisk();
1366  }
1367
1368  return ATU;
1369}
1370
1371void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
1372  if (CTUnit)
1373    delete static_cast<ASTUnit *>(CTUnit);
1374}
1375
1376CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
1377  if (!CTUnit)
1378    return createCXString("");
1379
1380  ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
1381  return createCXString(CXXUnit->getOriginalSourceFileName(), true);
1382}
1383
1384CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
1385  CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
1386  return Result;
1387}
1388
1389} // end: extern "C"
1390
1391//===----------------------------------------------------------------------===//
1392// CXSourceLocation and CXSourceRange Operations.
1393//===----------------------------------------------------------------------===//
1394
1395extern "C" {
1396CXSourceLocation clang_getNullLocation() {
1397  CXSourceLocation Result = { { 0, 0 }, 0 };
1398  return Result;
1399}
1400
1401unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
1402  return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
1403          loc1.ptr_data[1] == loc2.ptr_data[1] &&
1404          loc1.int_data == loc2.int_data);
1405}
1406
1407CXSourceLocation clang_getLocation(CXTranslationUnit tu,
1408                                   CXFile file,
1409                                   unsigned line,
1410                                   unsigned column) {
1411  if (!tu || !file)
1412    return clang_getNullLocation();
1413
1414  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
1415  SourceLocation SLoc
1416    = CXXUnit->getSourceManager().getLocation(
1417                                        static_cast<const FileEntry *>(file),
1418                                              line, column);
1419
1420  return SLoc.isInvalid() ?
1421           clang_getNullLocation() :
1422           cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
1423}
1424
1425CXSourceRange clang_getNullRange() {
1426  CXSourceRange Result = { { 0, 0 }, 0, 0 };
1427  return Result;
1428}
1429
1430CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
1431  if (begin.ptr_data[0] != end.ptr_data[0] ||
1432      begin.ptr_data[1] != end.ptr_data[1])
1433    return clang_getNullRange();
1434
1435  CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
1436                           begin.int_data, end.int_data };
1437  return Result;
1438}
1439
1440void clang_getInstantiationLocation(CXSourceLocation location,
1441                                    CXFile *file,
1442                                    unsigned *line,
1443                                    unsigned *column,
1444                                    unsigned *offset) {
1445  SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
1446
1447  if (!location.ptr_data[0] || Loc.isInvalid()) {
1448    if (file)
1449      *file = 0;
1450    if (line)
1451      *line = 0;
1452    if (column)
1453      *column = 0;
1454    if (offset)
1455      *offset = 0;
1456    return;
1457  }
1458
1459  const SourceManager &SM =
1460    *static_cast<const SourceManager*>(location.ptr_data[0]);
1461  SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
1462
1463  if (file)
1464    *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
1465  if (line)
1466    *line = SM.getInstantiationLineNumber(InstLoc);
1467  if (column)
1468    *column = SM.getInstantiationColumnNumber(InstLoc);
1469  if (offset)
1470    *offset = SM.getDecomposedLoc(InstLoc).second;
1471}
1472
1473CXSourceLocation clang_getRangeStart(CXSourceRange range) {
1474  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
1475                              range.begin_int_data };
1476  return Result;
1477}
1478
1479CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
1480  CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
1481                              range.end_int_data };
1482  return Result;
1483}
1484
1485} // end: extern "C"
1486
1487//===----------------------------------------------------------------------===//
1488// CXFile Operations.
1489//===----------------------------------------------------------------------===//
1490
1491extern "C" {
1492CXString clang_getFileName(CXFile SFile) {
1493  if (!SFile)
1494    return createCXString(NULL);
1495
1496  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
1497  return createCXString(FEnt->getName());
1498}
1499
1500time_t clang_getFileTime(CXFile SFile) {
1501  if (!SFile)
1502    return 0;
1503
1504  FileEntry *FEnt = static_cast<FileEntry *>(SFile);
1505  return FEnt->getModificationTime();
1506}
1507
1508CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
1509  if (!tu)
1510    return 0;
1511
1512  ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
1513
1514  FileManager &FMgr = CXXUnit->getFileManager();
1515  const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name));
1516  return const_cast<FileEntry *>(File);
1517}
1518
1519} // end: extern "C"
1520
1521//===----------------------------------------------------------------------===//
1522// CXCursor Operations.
1523//===----------------------------------------------------------------------===//
1524
1525static Decl *getDeclFromExpr(Stmt *E) {
1526  if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
1527    return RefExpr->getDecl();
1528  if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
1529    return ME->getMemberDecl();
1530  if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
1531    return RE->getDecl();
1532
1533  if (CallExpr *CE = dyn_cast<CallExpr>(E))
1534    return getDeclFromExpr(CE->getCallee());
1535  if (CastExpr *CE = dyn_cast<CastExpr>(E))
1536    return getDeclFromExpr(CE->getSubExpr());
1537  if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
1538    return OME->getMethodDecl();
1539
1540  return 0;
1541}
1542
1543static SourceLocation getLocationFromExpr(Expr *E) {
1544  if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
1545    return /*FIXME:*/Msg->getLeftLoc();
1546  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
1547    return DRE->getLocation();
1548  if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
1549    return Member->getMemberLoc();
1550  if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
1551    return Ivar->getLocation();
1552  return E->getLocStart();
1553}
1554
1555extern "C" {
1556
1557unsigned clang_visitChildren(CXCursor parent,
1558                             CXCursorVisitor visitor,
1559                             CXClientData client_data) {
1560  ASTUnit *CXXUnit = getCursorASTUnit(parent);
1561
1562  unsigned PCHLevel = Decl::MaxPCHLevel;
1563
1564  // Set the PCHLevel to filter out unwanted decls if requested.
1565  if (CXXUnit->getOnlyLocalDecls()) {
1566    PCHLevel = 0;
1567
1568    // If the main input was an AST, bump the level.
1569    if (CXXUnit->isMainFileAST())
1570      ++PCHLevel;
1571  }
1572
1573  CursorVisitor CursorVis(CXXUnit, visitor, client_data, PCHLevel);
1574  return CursorVis.VisitChildren(parent);
1575}
1576
1577static CXString getDeclSpelling(Decl *D) {
1578  NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
1579  if (!ND)
1580    return createCXString("");
1581
1582  if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
1583    return createCXString(OMD->getSelector().getAsString());
1584
1585  if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
1586    // No, this isn't the same as the code below. getIdentifier() is non-virtual
1587    // and returns different names. NamedDecl returns the class name and
1588    // ObjCCategoryImplDecl returns the category name.
1589    return createCXString(CIMP->getIdentifier()->getNameStart());
1590
1591  llvm::SmallString<1024> S;
1592  llvm::raw_svector_ostream os(S);
1593  ND->printName(os);
1594
1595  return createCXString(os.str());
1596}
1597
1598CXString clang_getCursorSpelling(CXCursor C) {
1599  if (clang_isTranslationUnit(C.kind))
1600    return clang_getTranslationUnitSpelling(C.data[2]);
1601
1602  if (clang_isReference(C.kind)) {
1603    switch (C.kind) {
1604    case CXCursor_ObjCSuperClassRef: {
1605      ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
1606      return createCXString(Super->getIdentifier()->getNameStart());
1607    }
1608    case CXCursor_ObjCClassRef: {
1609      ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
1610      return createCXString(Class->getIdentifier()->getNameStart());
1611    }
1612    case CXCursor_ObjCProtocolRef: {
1613      ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
1614      assert(OID && "getCursorSpelling(): Missing protocol decl");
1615      return createCXString(OID->getIdentifier()->getNameStart());
1616    }
1617    case CXCursor_TypeRef: {
1618      TypeDecl *Type = getCursorTypeRef(C).first;
1619      assert(Type && "Missing type decl");
1620
1621      return createCXString(getCursorContext(C).getTypeDeclType(Type).
1622                              getAsString());
1623    }
1624
1625    default:
1626      return createCXString("<not implemented>");
1627    }
1628  }
1629
1630  if (clang_isExpression(C.kind)) {
1631    Decl *D = getDeclFromExpr(getCursorExpr(C));
1632    if (D)
1633      return getDeclSpelling(D);
1634    return createCXString("");
1635  }
1636
1637  if (C.kind == CXCursor_MacroInstantiation)
1638    return createCXString(getCursorMacroInstantiation(C)->getName()
1639                                                           ->getNameStart());
1640
1641  if (C.kind == CXCursor_MacroDefinition)
1642    return createCXString(getCursorMacroDefinition(C)->getName()
1643                                                           ->getNameStart());
1644
1645  if (clang_isDeclaration(C.kind))
1646    return getDeclSpelling(getCursorDecl(C));
1647
1648  return createCXString("");
1649}
1650
1651CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
1652  switch (Kind) {
1653  case CXCursor_FunctionDecl:
1654      return createCXString("FunctionDecl");
1655  case CXCursor_TypedefDecl:
1656      return createCXString("TypedefDecl");
1657  case CXCursor_EnumDecl:
1658      return createCXString("EnumDecl");
1659  case CXCursor_EnumConstantDecl:
1660      return createCXString("EnumConstantDecl");
1661  case CXCursor_StructDecl:
1662      return createCXString("StructDecl");
1663  case CXCursor_UnionDecl:
1664      return createCXString("UnionDecl");
1665  case CXCursor_ClassDecl:
1666      return createCXString("ClassDecl");
1667  case CXCursor_FieldDecl:
1668      return createCXString("FieldDecl");
1669  case CXCursor_VarDecl:
1670      return createCXString("VarDecl");
1671  case CXCursor_ParmDecl:
1672      return createCXString("ParmDecl");
1673  case CXCursor_ObjCInterfaceDecl:
1674      return createCXString("ObjCInterfaceDecl");
1675  case CXCursor_ObjCCategoryDecl:
1676      return createCXString("ObjCCategoryDecl");
1677  case CXCursor_ObjCProtocolDecl:
1678      return createCXString("ObjCProtocolDecl");
1679  case CXCursor_ObjCPropertyDecl:
1680      return createCXString("ObjCPropertyDecl");
1681  case CXCursor_ObjCIvarDecl:
1682      return createCXString("ObjCIvarDecl");
1683  case CXCursor_ObjCInstanceMethodDecl:
1684      return createCXString("ObjCInstanceMethodDecl");
1685  case CXCursor_ObjCClassMethodDecl:
1686      return createCXString("ObjCClassMethodDecl");
1687  case CXCursor_ObjCImplementationDecl:
1688      return createCXString("ObjCImplementationDecl");
1689  case CXCursor_ObjCCategoryImplDecl:
1690      return createCXString("ObjCCategoryImplDecl");
1691  case CXCursor_CXXMethod:
1692      return createCXString("CXXMethod");
1693  case CXCursor_UnexposedDecl:
1694      return createCXString("UnexposedDecl");
1695  case CXCursor_ObjCSuperClassRef:
1696      return createCXString("ObjCSuperClassRef");
1697  case CXCursor_ObjCProtocolRef:
1698      return createCXString("ObjCProtocolRef");
1699  case CXCursor_ObjCClassRef:
1700      return createCXString("ObjCClassRef");
1701  case CXCursor_TypeRef:
1702      return createCXString("TypeRef");
1703  case CXCursor_UnexposedExpr:
1704      return createCXString("UnexposedExpr");
1705  case CXCursor_BlockExpr:
1706      return createCXString("BlockExpr");
1707  case CXCursor_DeclRefExpr:
1708      return createCXString("DeclRefExpr");
1709  case CXCursor_MemberRefExpr:
1710      return createCXString("MemberRefExpr");
1711  case CXCursor_CallExpr:
1712      return createCXString("CallExpr");
1713  case CXCursor_ObjCMessageExpr:
1714      return createCXString("ObjCMessageExpr");
1715  case CXCursor_UnexposedStmt:
1716      return createCXString("UnexposedStmt");
1717  case CXCursor_InvalidFile:
1718      return createCXString("InvalidFile");
1719  case CXCursor_InvalidCode:
1720    return createCXString("InvalidCode");
1721  case CXCursor_NoDeclFound:
1722      return createCXString("NoDeclFound");
1723  case CXCursor_NotImplemented:
1724      return createCXString("NotImplemented");
1725  case CXCursor_TranslationUnit:
1726      return createCXString("TranslationUnit");
1727  case CXCursor_UnexposedAttr:
1728      return createCXString("UnexposedAttr");
1729  case CXCursor_IBActionAttr:
1730      return createCXString("attribute(ibaction)");
1731  case CXCursor_IBOutletAttr:
1732     return createCXString("attribute(iboutlet)");
1733  case CXCursor_IBOutletCollectionAttr:
1734      return createCXString("attribute(iboutletcollection)");
1735  case CXCursor_PreprocessingDirective:
1736    return createCXString("preprocessing directive");
1737  case CXCursor_MacroDefinition:
1738    return createCXString("macro definition");
1739  case CXCursor_MacroInstantiation:
1740    return createCXString("macro instantiation");
1741  case CXCursor_Namespace:
1742    return createCXString("Namespace");
1743  case CXCursor_LinkageSpec:
1744    return createCXString("LinkageSpec");
1745  }
1746
1747  llvm_unreachable("Unhandled CXCursorKind");
1748  return createCXString(NULL);
1749}
1750
1751enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
1752                                         CXCursor parent,
1753                                         CXClientData client_data) {
1754  CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
1755  *BestCursor = cursor;
1756  return CXChildVisit_Recurse;
1757}
1758
1759CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
1760  if (!TU)
1761    return clang_getNullCursor();
1762
1763  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
1764
1765  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
1766
1767  SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
1768  CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
1769  if (SLoc.isValid()) {
1770    SourceRange RegionOfInterest(SLoc, SLoc.getFileLocWithOffset(1));
1771
1772    // FIXME: Would be great to have a "hint" cursor, then walk from that
1773    // hint cursor upward until we find a cursor whose source range encloses
1774    // the region of interest, rather than starting from the translation unit.
1775    CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit);
1776    CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result,
1777                            Decl::MaxPCHLevel, RegionOfInterest);
1778    CursorVis.VisitChildren(Parent);
1779  }
1780  return Result;
1781}
1782
1783CXCursor clang_getNullCursor(void) {
1784  return MakeCXCursorInvalid(CXCursor_InvalidFile);
1785}
1786
1787unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
1788  return X == Y;
1789}
1790
1791unsigned clang_isInvalid(enum CXCursorKind K) {
1792  return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
1793}
1794
1795unsigned clang_isDeclaration(enum CXCursorKind K) {
1796  return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
1797}
1798
1799unsigned clang_isReference(enum CXCursorKind K) {
1800  return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
1801}
1802
1803unsigned clang_isExpression(enum CXCursorKind K) {
1804  return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
1805}
1806
1807unsigned clang_isStatement(enum CXCursorKind K) {
1808  return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
1809}
1810
1811unsigned clang_isTranslationUnit(enum CXCursorKind K) {
1812  return K == CXCursor_TranslationUnit;
1813}
1814
1815unsigned clang_isPreprocessing(enum CXCursorKind K) {
1816  return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
1817}
1818
1819unsigned clang_isUnexposed(enum CXCursorKind K) {
1820  switch (K) {
1821    case CXCursor_UnexposedDecl:
1822    case CXCursor_UnexposedExpr:
1823    case CXCursor_UnexposedStmt:
1824    case CXCursor_UnexposedAttr:
1825      return true;
1826    default:
1827      return false;
1828  }
1829}
1830
1831CXCursorKind clang_getCursorKind(CXCursor C) {
1832  return C.kind;
1833}
1834
1835CXSourceLocation clang_getCursorLocation(CXCursor C) {
1836  if (clang_isReference(C.kind)) {
1837    switch (C.kind) {
1838    case CXCursor_ObjCSuperClassRef: {
1839      std::pair<ObjCInterfaceDecl *, SourceLocation> P
1840        = getCursorObjCSuperClassRef(C);
1841      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
1842    }
1843
1844    case CXCursor_ObjCProtocolRef: {
1845      std::pair<ObjCProtocolDecl *, SourceLocation> P
1846        = getCursorObjCProtocolRef(C);
1847      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
1848    }
1849
1850    case CXCursor_ObjCClassRef: {
1851      std::pair<ObjCInterfaceDecl *, SourceLocation> P
1852        = getCursorObjCClassRef(C);
1853      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
1854    }
1855
1856    case CXCursor_TypeRef: {
1857      std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
1858      return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
1859    }
1860
1861    default:
1862      // FIXME: Need a way to enumerate all non-reference cases.
1863      llvm_unreachable("Missed a reference kind");
1864    }
1865  }
1866
1867  if (clang_isExpression(C.kind))
1868    return cxloc::translateSourceLocation(getCursorContext(C),
1869                                   getLocationFromExpr(getCursorExpr(C)));
1870
1871  if (C.kind == CXCursor_PreprocessingDirective) {
1872    SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
1873    return cxloc::translateSourceLocation(getCursorContext(C), L);
1874  }
1875
1876  if (C.kind == CXCursor_MacroInstantiation) {
1877    SourceLocation L
1878      = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
1879    return cxloc::translateSourceLocation(getCursorContext(C), L);
1880  }
1881
1882  if (C.kind == CXCursor_MacroDefinition) {
1883    SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
1884    return cxloc::translateSourceLocation(getCursorContext(C), L);
1885  }
1886
1887  if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
1888    return clang_getNullLocation();
1889
1890  Decl *D = getCursorDecl(C);
1891  SourceLocation Loc = D->getLocation();
1892  if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
1893    Loc = Class->getClassLoc();
1894  return cxloc::translateSourceLocation(getCursorContext(C), Loc);
1895}
1896
1897CXSourceRange clang_getCursorExtent(CXCursor C) {
1898  if (clang_isReference(C.kind)) {
1899    switch (C.kind) {
1900      case CXCursor_ObjCSuperClassRef: {
1901        std::pair<ObjCInterfaceDecl *, SourceLocation> P
1902          = getCursorObjCSuperClassRef(C);
1903        return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
1904      }
1905
1906      case CXCursor_ObjCProtocolRef: {
1907        std::pair<ObjCProtocolDecl *, SourceLocation> P
1908          = getCursorObjCProtocolRef(C);
1909        return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
1910      }
1911
1912      case CXCursor_ObjCClassRef: {
1913        std::pair<ObjCInterfaceDecl *, SourceLocation> P
1914          = getCursorObjCClassRef(C);
1915
1916        return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
1917      }
1918
1919      case CXCursor_TypeRef: {
1920        std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
1921        return cxloc::translateSourceRange(P.first->getASTContext(), P.second);
1922      }
1923
1924      default:
1925        // FIXME: Need a way to enumerate all non-reference cases.
1926        llvm_unreachable("Missed a reference kind");
1927    }
1928  }
1929
1930  if (clang_isExpression(C.kind))
1931    return cxloc::translateSourceRange(getCursorContext(C),
1932                                getCursorExpr(C)->getSourceRange());
1933
1934  if (clang_isStatement(C.kind))
1935    return cxloc::translateSourceRange(getCursorContext(C),
1936                                getCursorStmt(C)->getSourceRange());
1937
1938  if (C.kind == CXCursor_PreprocessingDirective) {
1939    SourceRange R = cxcursor::getCursorPreprocessingDirective(C);
1940    return cxloc::translateSourceRange(getCursorContext(C), R);
1941  }
1942
1943  if (C.kind == CXCursor_MacroInstantiation) {
1944    SourceRange R = cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
1945    return cxloc::translateSourceRange(getCursorContext(C), R);
1946  }
1947
1948  if (C.kind == CXCursor_MacroDefinition) {
1949    SourceRange R = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
1950    return cxloc::translateSourceRange(getCursorContext(C), R);
1951  }
1952
1953  if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
1954    return clang_getNullRange();
1955
1956  Decl *D = getCursorDecl(C);
1957  return cxloc::translateSourceRange(getCursorContext(C), D->getSourceRange());
1958}
1959
1960CXCursor clang_getCursorReferenced(CXCursor C) {
1961  if (clang_isInvalid(C.kind))
1962    return clang_getNullCursor();
1963
1964  ASTUnit *CXXUnit = getCursorASTUnit(C);
1965  if (clang_isDeclaration(C.kind))
1966    return C;
1967
1968  if (clang_isExpression(C.kind)) {
1969    Decl *D = getDeclFromExpr(getCursorExpr(C));
1970    if (D)
1971      return MakeCXCursor(D, CXXUnit);
1972    return clang_getNullCursor();
1973  }
1974
1975  if (C.kind == CXCursor_MacroInstantiation) {
1976    if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
1977      return MakeMacroDefinitionCursor(Def, CXXUnit);
1978  }
1979
1980  if (!clang_isReference(C.kind))
1981    return clang_getNullCursor();
1982
1983  switch (C.kind) {
1984    case CXCursor_ObjCSuperClassRef:
1985      return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
1986
1987    case CXCursor_ObjCProtocolRef: {
1988      return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
1989
1990    case CXCursor_ObjCClassRef:
1991      return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
1992
1993    case CXCursor_TypeRef:
1994      return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
1995
1996    default:
1997      // We would prefer to enumerate all non-reference cursor kinds here.
1998      llvm_unreachable("Unhandled reference cursor kind");
1999      break;
2000    }
2001  }
2002
2003  return clang_getNullCursor();
2004}
2005
2006CXCursor clang_getCursorDefinition(CXCursor C) {
2007  if (clang_isInvalid(C.kind))
2008    return clang_getNullCursor();
2009
2010  ASTUnit *CXXUnit = getCursorASTUnit(C);
2011
2012  bool WasReference = false;
2013  if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
2014    C = clang_getCursorReferenced(C);
2015    WasReference = true;
2016  }
2017
2018  if (C.kind == CXCursor_MacroInstantiation)
2019    return clang_getCursorReferenced(C);
2020
2021  if (!clang_isDeclaration(C.kind))
2022    return clang_getNullCursor();
2023
2024  Decl *D = getCursorDecl(C);
2025  if (!D)
2026    return clang_getNullCursor();
2027
2028  switch (D->getKind()) {
2029  // Declaration kinds that don't really separate the notions of
2030  // declaration and definition.
2031  case Decl::Namespace:
2032  case Decl::Typedef:
2033  case Decl::TemplateTypeParm:
2034  case Decl::EnumConstant:
2035  case Decl::Field:
2036  case Decl::ObjCIvar:
2037  case Decl::ObjCAtDefsField:
2038  case Decl::ImplicitParam:
2039  case Decl::ParmVar:
2040  case Decl::NonTypeTemplateParm:
2041  case Decl::TemplateTemplateParm:
2042  case Decl::ObjCCategoryImpl:
2043  case Decl::ObjCImplementation:
2044  case Decl::AccessSpec:
2045  case Decl::LinkageSpec:
2046  case Decl::ObjCPropertyImpl:
2047  case Decl::FileScopeAsm:
2048  case Decl::StaticAssert:
2049  case Decl::Block:
2050    return C;
2051
2052  // Declaration kinds that don't make any sense here, but are
2053  // nonetheless harmless.
2054  case Decl::TranslationUnit:
2055    break;
2056
2057  // Declaration kinds for which the definition is not resolvable.
2058  case Decl::UnresolvedUsingTypename:
2059  case Decl::UnresolvedUsingValue:
2060    break;
2061
2062  case Decl::UsingDirective:
2063    return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
2064                        CXXUnit);
2065
2066  case Decl::NamespaceAlias:
2067    return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
2068
2069  case Decl::Enum:
2070  case Decl::Record:
2071  case Decl::CXXRecord:
2072  case Decl::ClassTemplateSpecialization:
2073  case Decl::ClassTemplatePartialSpecialization:
2074    if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
2075      return MakeCXCursor(Def, CXXUnit);
2076    return clang_getNullCursor();
2077
2078  case Decl::Function:
2079  case Decl::CXXMethod:
2080  case Decl::CXXConstructor:
2081  case Decl::CXXDestructor:
2082  case Decl::CXXConversion: {
2083    const FunctionDecl *Def = 0;
2084    if (cast<FunctionDecl>(D)->getBody(Def))
2085      return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
2086    return clang_getNullCursor();
2087  }
2088
2089  case Decl::Var: {
2090    // Ask the variable if it has a definition.
2091    if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
2092      return MakeCXCursor(Def, CXXUnit);
2093    return clang_getNullCursor();
2094  }
2095
2096  case Decl::FunctionTemplate: {
2097    const FunctionDecl *Def = 0;
2098    if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
2099      return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
2100    return clang_getNullCursor();
2101  }
2102
2103  case Decl::ClassTemplate: {
2104    if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
2105                                                            ->getDefinition())
2106      return MakeCXCursor(
2107                         cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
2108                          CXXUnit);
2109    return clang_getNullCursor();
2110  }
2111
2112  case Decl::Using: {
2113    UsingDecl *Using = cast<UsingDecl>(D);
2114    CXCursor Def = clang_getNullCursor();
2115    for (UsingDecl::shadow_iterator S = Using->shadow_begin(),
2116                                 SEnd = Using->shadow_end();
2117         S != SEnd; ++S) {
2118      if (Def != clang_getNullCursor()) {
2119        // FIXME: We have no way to return multiple results.
2120        return clang_getNullCursor();
2121      }
2122
2123      Def = clang_getCursorDefinition(MakeCXCursor((*S)->getTargetDecl(),
2124                                                   CXXUnit));
2125    }
2126
2127    return Def;
2128  }
2129
2130  case Decl::UsingShadow:
2131    return clang_getCursorDefinition(
2132                       MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
2133                                    CXXUnit));
2134
2135  case Decl::ObjCMethod: {
2136    ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
2137    if (Method->isThisDeclarationADefinition())
2138      return C;
2139
2140    // Dig out the method definition in the associated
2141    // @implementation, if we have it.
2142    // FIXME: The ASTs should make finding the definition easier.
2143    if (ObjCInterfaceDecl *Class
2144                       = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
2145      if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
2146        if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
2147                                                  Method->isInstanceMethod()))
2148          if (Def->isThisDeclarationADefinition())
2149            return MakeCXCursor(Def, CXXUnit);
2150
2151    return clang_getNullCursor();
2152  }
2153
2154  case Decl::ObjCCategory:
2155    if (ObjCCategoryImplDecl *Impl
2156                               = cast<ObjCCategoryDecl>(D)->getImplementation())
2157      return MakeCXCursor(Impl, CXXUnit);
2158    return clang_getNullCursor();
2159
2160  case Decl::ObjCProtocol:
2161    if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
2162      return C;
2163    return clang_getNullCursor();
2164
2165  case Decl::ObjCInterface:
2166    // There are two notions of a "definition" for an Objective-C
2167    // class: the interface and its implementation. When we resolved a
2168    // reference to an Objective-C class, produce the @interface as
2169    // the definition; when we were provided with the interface,
2170    // produce the @implementation as the definition.
2171    if (WasReference) {
2172      if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
2173        return C;
2174    } else if (ObjCImplementationDecl *Impl
2175                              = cast<ObjCInterfaceDecl>(D)->getImplementation())
2176      return MakeCXCursor(Impl, CXXUnit);
2177    return clang_getNullCursor();
2178
2179  case Decl::ObjCProperty:
2180    // FIXME: We don't really know where to find the
2181    // ObjCPropertyImplDecls that implement this property.
2182    return clang_getNullCursor();
2183
2184  case Decl::ObjCCompatibleAlias:
2185    if (ObjCInterfaceDecl *Class
2186          = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
2187      if (!Class->isForwardDecl())
2188        return MakeCXCursor(Class, CXXUnit);
2189
2190    return clang_getNullCursor();
2191
2192  case Decl::ObjCForwardProtocol: {
2193    ObjCForwardProtocolDecl *Forward = cast<ObjCForwardProtocolDecl>(D);
2194    if (Forward->protocol_size() == 1)
2195      return clang_getCursorDefinition(
2196                                     MakeCXCursor(*Forward->protocol_begin(),
2197                                                  CXXUnit));
2198
2199    // FIXME: Cannot return multiple definitions.
2200    return clang_getNullCursor();
2201  }
2202
2203  case Decl::ObjCClass: {
2204    ObjCClassDecl *Class = cast<ObjCClassDecl>(D);
2205    if (Class->size() == 1) {
2206      ObjCInterfaceDecl *IFace = Class->begin()->getInterface();
2207      if (!IFace->isForwardDecl())
2208        return MakeCXCursor(IFace, CXXUnit);
2209      return clang_getNullCursor();
2210    }
2211
2212    // FIXME: Cannot return multiple definitions.
2213    return clang_getNullCursor();
2214  }
2215
2216  case Decl::Friend:
2217    if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
2218      return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
2219    return clang_getNullCursor();
2220
2221  case Decl::FriendTemplate:
2222    if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
2223      return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
2224    return clang_getNullCursor();
2225  }
2226
2227  return clang_getNullCursor();
2228}
2229
2230unsigned clang_isCursorDefinition(CXCursor C) {
2231  if (!clang_isDeclaration(C.kind))
2232    return 0;
2233
2234  return clang_getCursorDefinition(C) == C;
2235}
2236
2237void clang_getDefinitionSpellingAndExtent(CXCursor C,
2238                                          const char **startBuf,
2239                                          const char **endBuf,
2240                                          unsigned *startLine,
2241                                          unsigned *startColumn,
2242                                          unsigned *endLine,
2243                                          unsigned *endColumn) {
2244  assert(getCursorDecl(C) && "CXCursor has null decl");
2245  NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
2246  FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
2247  CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
2248
2249  SourceManager &SM = FD->getASTContext().getSourceManager();
2250  *startBuf = SM.getCharacterData(Body->getLBracLoc());
2251  *endBuf = SM.getCharacterData(Body->getRBracLoc());
2252  *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
2253  *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
2254  *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
2255  *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
2256}
2257
2258void clang_enableStackTraces(void) {
2259  llvm::sys::PrintStackTraceOnErrorSignal();
2260}
2261
2262} // end: extern "C"
2263
2264//===----------------------------------------------------------------------===//
2265// Token-based Operations.
2266//===----------------------------------------------------------------------===//
2267
2268/* CXToken layout:
2269 *   int_data[0]: a CXTokenKind
2270 *   int_data[1]: starting token location
2271 *   int_data[2]: token length
2272 *   int_data[3]: reserved
2273 *   ptr_data: for identifiers and keywords, an IdentifierInfo*.
2274 *   otherwise unused.
2275 */
2276extern "C" {
2277
2278CXTokenKind clang_getTokenKind(CXToken CXTok) {
2279  return static_cast<CXTokenKind>(CXTok.int_data[0]);
2280}
2281
2282CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
2283  switch (clang_getTokenKind(CXTok)) {
2284  case CXToken_Identifier:
2285  case CXToken_Keyword:
2286    // We know we have an IdentifierInfo*, so use that.
2287    return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
2288                            ->getNameStart());
2289
2290  case CXToken_Literal: {
2291    // We have stashed the starting pointer in the ptr_data field. Use it.
2292    const char *Text = static_cast<const char *>(CXTok.ptr_data);
2293    return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
2294  }
2295
2296  case CXToken_Punctuation:
2297  case CXToken_Comment:
2298    break;
2299  }
2300
2301  // We have to find the starting buffer pointer the hard way, by
2302  // deconstructing the source location.
2303  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2304  if (!CXXUnit)
2305    return createCXString("");
2306
2307  SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
2308  std::pair<FileID, unsigned> LocInfo
2309    = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
2310  bool Invalid = false;
2311  llvm::StringRef Buffer
2312    = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
2313  if (Invalid)
2314    return createCXString("");
2315
2316  return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
2317}
2318
2319CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
2320  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2321  if (!CXXUnit)
2322    return clang_getNullLocation();
2323
2324  return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
2325                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
2326}
2327
2328CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
2329  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2330  if (!CXXUnit)
2331    return clang_getNullRange();
2332
2333  return cxloc::translateSourceRange(CXXUnit->getASTContext(),
2334                        SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
2335}
2336
2337void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
2338                    CXToken **Tokens, unsigned *NumTokens) {
2339  if (Tokens)
2340    *Tokens = 0;
2341  if (NumTokens)
2342    *NumTokens = 0;
2343
2344  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2345  if (!CXXUnit || !Tokens || !NumTokens)
2346    return;
2347
2348  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2349
2350  SourceRange R = cxloc::translateCXSourceRange(Range);
2351  if (R.isInvalid())
2352    return;
2353
2354  SourceManager &SourceMgr = CXXUnit->getSourceManager();
2355  std::pair<FileID, unsigned> BeginLocInfo
2356    = SourceMgr.getDecomposedLoc(R.getBegin());
2357  std::pair<FileID, unsigned> EndLocInfo
2358    = SourceMgr.getDecomposedLoc(R.getEnd());
2359
2360  // Cannot tokenize across files.
2361  if (BeginLocInfo.first != EndLocInfo.first)
2362    return;
2363
2364  // Create a lexer
2365  bool Invalid = false;
2366  llvm::StringRef Buffer
2367    = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
2368  if (Invalid)
2369    return;
2370
2371  Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
2372            CXXUnit->getASTContext().getLangOptions(),
2373            Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
2374  Lex.SetCommentRetentionState(true);
2375
2376  // Lex tokens until we hit the end of the range.
2377  const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
2378  llvm::SmallVector<CXToken, 32> CXTokens;
2379  Token Tok;
2380  do {
2381    // Lex the next token
2382    Lex.LexFromRawLexer(Tok);
2383    if (Tok.is(tok::eof))
2384      break;
2385
2386    // Initialize the CXToken.
2387    CXToken CXTok;
2388
2389    //   - Common fields
2390    CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
2391    CXTok.int_data[2] = Tok.getLength();
2392    CXTok.int_data[3] = 0;
2393
2394    //   - Kind-specific fields
2395    if (Tok.isLiteral()) {
2396      CXTok.int_data[0] = CXToken_Literal;
2397      CXTok.ptr_data = (void *)Tok.getLiteralData();
2398    } else if (Tok.is(tok::identifier)) {
2399      // Lookup the identifier to determine whether we have a keyword.
2400      std::pair<FileID, unsigned> LocInfo
2401        = SourceMgr.getDecomposedLoc(Tok.getLocation());
2402      bool Invalid = false;
2403      llvm::StringRef Buf
2404        = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
2405      if (Invalid)
2406        return;
2407
2408      const char *StartPos = Buf.data() + LocInfo.second;
2409      IdentifierInfo *II
2410        = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos);
2411
2412      if (II->getObjCKeywordID() != tok::objc_not_keyword) {
2413        CXTok.int_data[0] = CXToken_Keyword;
2414      }
2415      else {
2416        CXTok.int_data[0] = II->getTokenID() == tok::identifier?
2417                                CXToken_Identifier
2418                              : CXToken_Keyword;
2419      }
2420      CXTok.ptr_data = II;
2421    } else if (Tok.is(tok::comment)) {
2422      CXTok.int_data[0] = CXToken_Comment;
2423      CXTok.ptr_data = 0;
2424    } else {
2425      CXTok.int_data[0] = CXToken_Punctuation;
2426      CXTok.ptr_data = 0;
2427    }
2428    CXTokens.push_back(CXTok);
2429  } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
2430
2431  if (CXTokens.empty())
2432    return;
2433
2434  *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
2435  memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
2436  *NumTokens = CXTokens.size();
2437}
2438
2439void clang_disposeTokens(CXTranslationUnit TU,
2440                         CXToken *Tokens, unsigned NumTokens) {
2441  free(Tokens);
2442}
2443
2444} // end: extern "C"
2445
2446//===----------------------------------------------------------------------===//
2447// Token annotation APIs.
2448//===----------------------------------------------------------------------===//
2449
2450typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
2451static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
2452                                                     CXCursor parent,
2453                                                     CXClientData client_data);
2454namespace {
2455class AnnotateTokensWorker {
2456  AnnotateTokensData &Annotated;
2457  CXToken *Tokens;
2458  CXCursor *Cursors;
2459  unsigned NumTokens;
2460  unsigned TokIdx;
2461  CursorVisitor AnnotateVis;
2462  SourceManager &SrcMgr;
2463
2464  bool MoreTokens() const { return TokIdx < NumTokens; }
2465  unsigned NextToken() const { return TokIdx; }
2466  void AdvanceToken() { ++TokIdx; }
2467  SourceLocation GetTokenLoc(unsigned tokI) {
2468    return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
2469  }
2470
2471public:
2472  AnnotateTokensWorker(AnnotateTokensData &annotated,
2473                       CXToken *tokens, CXCursor *cursors, unsigned numTokens,
2474                       ASTUnit *CXXUnit, SourceRange RegionOfInterest)
2475    : Annotated(annotated), Tokens(tokens), Cursors(cursors),
2476      NumTokens(numTokens), TokIdx(0),
2477      AnnotateVis(CXXUnit, AnnotateTokensVisitor, this,
2478                  Decl::MaxPCHLevel, RegionOfInterest),
2479      SrcMgr(CXXUnit->getSourceManager()) {}
2480
2481  void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
2482  enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
2483  void AnnotateTokens(CXCursor parent);
2484};
2485}
2486
2487void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
2488  // Walk the AST within the region of interest, annotating tokens
2489  // along the way.
2490  VisitChildren(parent);
2491
2492  for (unsigned I = 0 ; I < TokIdx ; ++I) {
2493    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
2494    if (Pos != Annotated.end())
2495      Cursors[I] = Pos->second;
2496  }
2497
2498  // Finish up annotating any tokens left.
2499  if (!MoreTokens())
2500    return;
2501
2502  const CXCursor &C = clang_getNullCursor();
2503  for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
2504    AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
2505    Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
2506  }
2507}
2508
2509enum CXChildVisitResult
2510AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
2511  CXSourceLocation Loc = clang_getCursorLocation(cursor);
2512  // We can always annotate a preprocessing directive/macro instantiation.
2513  if (clang_isPreprocessing(cursor.kind)) {
2514    Annotated[Loc.int_data] = cursor;
2515    return CXChildVisit_Recurse;
2516  }
2517
2518  CXSourceRange cursorExtent = clang_getCursorExtent(cursor);
2519  SourceRange cursorRange = cxloc::translateCXSourceRange(cursorExtent);
2520
2521  if (cursorRange.isInvalid())
2522    return CXChildVisit_Continue;
2523
2524  SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
2525
2526  // Adjust the annotated range based specific declarations.
2527  const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
2528  if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
2529    Decl *D = cxcursor::getCursorDecl(cursor);
2530    // Don't visit synthesized ObjC methods, since they have no syntatic
2531    // representation in the source.
2532    if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
2533      if (MD->isSynthesized())
2534        return CXChildVisit_Continue;
2535    }
2536    if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
2537      if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
2538        TypeLoc TL = TI->getTypeLoc();
2539        SourceLocation TLoc = TL.getSourceRange().getBegin();
2540        if (TLoc.isValid() &&
2541            SrcMgr.isBeforeInTranslationUnit(TLoc, L))
2542          cursorRange.setBegin(TLoc);
2543      }
2544    }
2545  }
2546
2547  const enum CXCursorKind K = clang_getCursorKind(parent);
2548  const CXCursor updateC =
2549    (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
2550     L.isMacroID())
2551    ? clang_getNullCursor() : parent;
2552
2553  while (MoreTokens()) {
2554    const unsigned I = NextToken();
2555    SourceLocation TokLoc = GetTokenLoc(I);
2556    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
2557      case RangeBefore:
2558        Cursors[I] = updateC;
2559        AdvanceToken();
2560        continue;
2561      case RangeAfter:
2562        return CXChildVisit_Continue;
2563      case RangeOverlap:
2564        break;
2565    }
2566    break;
2567  }
2568
2569  // Visit children to get their cursor information.
2570  const unsigned BeforeChildren = NextToken();
2571  VisitChildren(cursor);
2572  const unsigned AfterChildren = NextToken();
2573
2574  // Adjust 'Last' to the last token within the extent of the cursor.
2575  while (MoreTokens()) {
2576    const unsigned I = NextToken();
2577    SourceLocation TokLoc = GetTokenLoc(I);
2578    switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
2579      case RangeBefore:
2580        assert(0 && "Infeasible");
2581      case RangeAfter:
2582        break;
2583      case RangeOverlap:
2584        Cursors[I] = updateC;
2585        AdvanceToken();
2586        continue;
2587    }
2588    break;
2589  }
2590  const unsigned Last = NextToken();
2591
2592  // Scan the tokens that are at the beginning of the cursor, but are not
2593  // capture by the child cursors.
2594
2595  // For AST elements within macros, rely on a post-annotate pass to
2596  // to correctly annotate the tokens with cursors.  Otherwise we can
2597  // get confusing results of having tokens that map to cursors that really
2598  // are expanded by an instantiation.
2599  if (L.isMacroID())
2600    cursor = clang_getNullCursor();
2601
2602  for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
2603    if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
2604      break;
2605    Cursors[I] = cursor;
2606  }
2607  // Scan the tokens that are at the end of the cursor, but are not captured
2608  // but the child cursors.
2609  for (unsigned I = AfterChildren; I != Last; ++I)
2610    Cursors[I] = cursor;
2611
2612  TokIdx = Last;
2613  return CXChildVisit_Continue;
2614}
2615
2616static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
2617                                                     CXCursor parent,
2618                                                     CXClientData client_data) {
2619  return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
2620}
2621
2622extern "C" {
2623
2624void clang_annotateTokens(CXTranslationUnit TU,
2625                          CXToken *Tokens, unsigned NumTokens,
2626                          CXCursor *Cursors) {
2627
2628  if (NumTokens == 0 || !Tokens || !Cursors)
2629    return;
2630
2631  ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
2632  if (!CXXUnit) {
2633    // Any token we don't specifically annotate will have a NULL cursor.
2634    const CXCursor &C = clang_getNullCursor();
2635    for (unsigned I = 0; I != NumTokens; ++I)
2636      Cursors[I] = C;
2637    return;
2638  }
2639
2640  ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2641
2642  // Determine the region of interest, which contains all of the tokens.
2643  SourceRange RegionOfInterest;
2644  RegionOfInterest.setBegin(cxloc::translateSourceLocation(
2645                                        clang_getTokenLocation(TU, Tokens[0])));
2646
2647  SourceLocation End
2648    = cxloc::translateSourceLocation(clang_getTokenLocation(TU,
2649                                                        Tokens[NumTokens - 1]));
2650  RegionOfInterest.setEnd(CXXUnit->getPreprocessor().getLocForEndOfToken(End));
2651
2652  // A mapping from the source locations found when re-lexing or traversing the
2653  // region of interest to the corresponding cursors.
2654  AnnotateTokensData Annotated;
2655
2656  // Relex the tokens within the source range to look for preprocessing
2657  // directives.
2658  SourceManager &SourceMgr = CXXUnit->getSourceManager();
2659  std::pair<FileID, unsigned> BeginLocInfo
2660    = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
2661  std::pair<FileID, unsigned> EndLocInfo
2662    = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
2663
2664  llvm::StringRef Buffer;
2665  bool Invalid = false;
2666  if (BeginLocInfo.first == EndLocInfo.first &&
2667      ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
2668      !Invalid) {
2669    Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
2670              CXXUnit->getASTContext().getLangOptions(),
2671              Buffer.begin(), Buffer.data() + BeginLocInfo.second,
2672              Buffer.end());
2673    Lex.SetCommentRetentionState(true);
2674
2675    // Lex tokens in raw mode until we hit the end of the range, to avoid
2676    // entering #includes or expanding macros.
2677    while (true) {
2678      Token Tok;
2679      Lex.LexFromRawLexer(Tok);
2680
2681    reprocess:
2682      if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
2683        // We have found a preprocessing directive. Gobble it up so that we
2684        // don't see it while preprocessing these tokens later, but keep track of
2685        // all of the token locations inside this preprocessing directive so that
2686        // we can annotate them appropriately.
2687        //
2688        // FIXME: Some simple tests here could identify macro definitions and
2689        // #undefs, to provide specific cursor kinds for those.
2690        std::vector<SourceLocation> Locations;
2691        do {
2692          Locations.push_back(Tok.getLocation());
2693          Lex.LexFromRawLexer(Tok);
2694        } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
2695
2696        using namespace cxcursor;
2697        CXCursor Cursor
2698          = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
2699                                                         Locations.back()),
2700                                           CXXUnit);
2701        for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
2702          Annotated[Locations[I].getRawEncoding()] = Cursor;
2703        }
2704
2705        if (Tok.isAtStartOfLine())
2706          goto reprocess;
2707
2708        continue;
2709      }
2710
2711      if (Tok.is(tok::eof))
2712        break;
2713    }
2714  }
2715
2716  // Annotate all of the source locations in the region of interest that map to
2717  // a specific cursor.
2718  AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
2719                         CXXUnit, RegionOfInterest);
2720  W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit));
2721}
2722} // end: extern "C"
2723
2724//===----------------------------------------------------------------------===//
2725// Operations for querying linkage of a cursor.
2726//===----------------------------------------------------------------------===//
2727
2728extern "C" {
2729CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
2730  if (!clang_isDeclaration(cursor.kind))
2731    return CXLinkage_Invalid;
2732
2733  Decl *D = cxcursor::getCursorDecl(cursor);
2734  if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
2735    switch (ND->getLinkage()) {
2736      case NoLinkage: return CXLinkage_NoLinkage;
2737      case InternalLinkage: return CXLinkage_Internal;
2738      case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
2739      case ExternalLinkage: return CXLinkage_External;
2740    };
2741
2742  return CXLinkage_Invalid;
2743}
2744} // end: extern "C"
2745
2746//===----------------------------------------------------------------------===//
2747// Operations for querying language of a cursor.
2748//===----------------------------------------------------------------------===//
2749
2750static CXLanguageKind getDeclLanguage(const Decl *D) {
2751  switch (D->getKind()) {
2752    default:
2753      break;
2754    case Decl::ImplicitParam:
2755    case Decl::ObjCAtDefsField:
2756    case Decl::ObjCCategory:
2757    case Decl::ObjCCategoryImpl:
2758    case Decl::ObjCClass:
2759    case Decl::ObjCCompatibleAlias:
2760    case Decl::ObjCForwardProtocol:
2761    case Decl::ObjCImplementation:
2762    case Decl::ObjCInterface:
2763    case Decl::ObjCIvar:
2764    case Decl::ObjCMethod:
2765    case Decl::ObjCProperty:
2766    case Decl::ObjCPropertyImpl:
2767    case Decl::ObjCProtocol:
2768      return CXLanguage_ObjC;
2769    case Decl::CXXConstructor:
2770    case Decl::CXXConversion:
2771    case Decl::CXXDestructor:
2772    case Decl::CXXMethod:
2773    case Decl::CXXRecord:
2774    case Decl::ClassTemplate:
2775    case Decl::ClassTemplatePartialSpecialization:
2776    case Decl::ClassTemplateSpecialization:
2777    case Decl::Friend:
2778    case Decl::FriendTemplate:
2779    case Decl::FunctionTemplate:
2780    case Decl::LinkageSpec:
2781    case Decl::Namespace:
2782    case Decl::NamespaceAlias:
2783    case Decl::NonTypeTemplateParm:
2784    case Decl::StaticAssert:
2785    case Decl::TemplateTemplateParm:
2786    case Decl::TemplateTypeParm:
2787    case Decl::UnresolvedUsingTypename:
2788    case Decl::UnresolvedUsingValue:
2789    case Decl::Using:
2790    case Decl::UsingDirective:
2791    case Decl::UsingShadow:
2792      return CXLanguage_CPlusPlus;
2793  }
2794
2795  return CXLanguage_C;
2796}
2797
2798extern "C" {
2799CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
2800  if (clang_isDeclaration(cursor.kind))
2801    return getDeclLanguage(cxcursor::getCursorDecl(cursor));
2802
2803  return CXLanguage_Invalid;
2804}
2805} // end: extern "C"
2806
2807
2808//===----------------------------------------------------------------------===//
2809// C++ AST instrospection.
2810//===----------------------------------------------------------------------===//
2811
2812extern "C" {
2813unsigned clang_CXXMethod_isStatic(CXCursor C) {
2814  if (!clang_isDeclaration(C.kind))
2815    return 0;
2816  CXXMethodDecl *D = dyn_cast<CXXMethodDecl>(cxcursor::getCursorDecl(C));
2817  return (D && D->isStatic()) ? 1 : 0;
2818}
2819
2820} // end: extern "C"
2821
2822//===----------------------------------------------------------------------===//
2823// CXString Operations.
2824//===----------------------------------------------------------------------===//
2825
2826extern "C" {
2827const char *clang_getCString(CXString string) {
2828  return string.Spelling;
2829}
2830
2831void clang_disposeString(CXString string) {
2832  if (string.MustFreeString && string.Spelling)
2833    free((void*)string.Spelling);
2834}
2835
2836} // end: extern "C"
2837
2838namespace clang { namespace cxstring {
2839CXString createCXString(const char *String, bool DupString){
2840  CXString Str;
2841  if (DupString) {
2842    Str.Spelling = strdup(String);
2843    Str.MustFreeString = 1;
2844  } else {
2845    Str.Spelling = String;
2846    Str.MustFreeString = 0;
2847  }
2848  return Str;
2849}
2850
2851CXString createCXString(llvm::StringRef String, bool DupString) {
2852  CXString Result;
2853  if (DupString || (!String.empty() && String.data()[String.size()] != 0)) {
2854    char *Spelling = (char *)malloc(String.size() + 1);
2855    memmove(Spelling, String.data(), String.size());
2856    Spelling[String.size()] = 0;
2857    Result.Spelling = Spelling;
2858    Result.MustFreeString = 1;
2859  } else {
2860    Result.Spelling = String.data();
2861    Result.MustFreeString = 0;
2862  }
2863  return Result;
2864}
2865}}
2866
2867//===----------------------------------------------------------------------===//
2868// Misc. utility functions.
2869//===----------------------------------------------------------------------===//
2870
2871extern "C" {
2872
2873CXString clang_getClangVersion() {
2874  return createCXString(getClangFullVersion());
2875}
2876
2877} // end: extern "C"
2878