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