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